1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator.
133 Calls to get_next_display_element fill the iterator structure with
134 relevant information about the next thing to display. Calls to
135 set_iterator_to_next move the iterator to the next thing.
137 Besides this, an iterator also contains information about the
138 display environment in which glyphs for display elements are to be
139 produced. It has fields for the width and height of the display,
140 the information whether long lines are truncated or continued, a
141 current X and Y position, and lots of other stuff you can better
144 Glyphs in a desired matrix are normally constructed in a loop
145 calling get_next_display_element and then PRODUCE_GLYPHS. The call
146 to PRODUCE_GLYPHS will fill the iterator structure with pixel
147 information about the element being displayed and at the same time
148 produce glyphs for it. If the display element fits on the line
149 being displayed, set_iterator_to_next is called next, otherwise the
150 glyphs produced are discarded. The function display_line is the
151 workhorse of filling glyph rows in the desired matrix with glyphs.
152 In addition to producing glyphs, it also handles line truncation
153 and continuation, word wrap, and cursor positioning (for the
154 latter, see also set_cursor_from_row).
158 That just couldn't be all, could it? What about terminal types not
159 supporting operations on sub-windows of the screen? To update the
160 display on such a terminal, window-based glyph matrices are not
161 well suited. To be able to reuse part of the display (scrolling
162 lines up and down), we must instead have a view of the whole
163 screen. This is what `frame matrices' are for. They are a trick.
165 Frames on terminals like above have a glyph pool. Windows on such
166 a frame sub-allocate their glyph memory from their frame's glyph
167 pool. The frame itself is given its own glyph matrices. By
168 coincidence---or maybe something else---rows in window glyph
169 matrices are slices of corresponding rows in frame matrices. Thus
170 writing to window matrices implicitly updates a frame matrix which
171 provides us with the view of the whole screen that we originally
172 wanted to have without having to move many bytes around. To be
173 honest, there is a little bit more done, but not much more. If you
174 plan to extend that code, take a look at dispnew.c. The function
175 build_frame_matrix is a good starting point.
177 Bidirectional display.
179 Bidirectional display adds quite some hair to this already complex
180 design. The good news are that a large portion of that hairy stuff
181 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
182 reordering engine which is called by set_iterator_to_next and
183 returns the next character to display in the visual order. See
184 commentary on bidi.c for more details. As far as redisplay is
185 concerned, the effect of calling bidi_move_to_visually_next, the
186 main interface of the reordering engine, is that the iterator gets
187 magically placed on the buffer or string position that is to be
188 displayed next. In other words, a linear iteration through the
189 buffer/string is replaced with a non-linear one. All the rest of
190 the redisplay is oblivious to the bidi reordering.
192 Well, almost oblivious---there are still complications, most of
193 them due to the fact that buffer and string positions no longer
194 change monotonously with glyph indices in a glyph row. Moreover,
195 for continued lines, the buffer positions may not even be
196 monotonously changing with vertical positions. Also, accounting
197 for face changes, overlays, etc. becomes more complex because
198 non-linear iteration could potentially skip many positions with
199 changes, and then cross them again on the way back...
201 One other prominent effect of bidirectional display is that some
202 paragraphs of text need to be displayed starting at the right
203 margin of the window---the so-called right-to-left, or R2L
204 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
205 which have their reversed_p flag set. The bidi reordering engine
206 produces characters in such rows starting from the character which
207 should be the rightmost on display. PRODUCE_GLYPHS then reverses
208 the order, when it fills up the glyph row whose reversed_p flag is
209 set, by prepending each new glyph to what is already there, instead
210 of appending it. When the glyph row is complete, the function
211 extend_face_to_end_of_line fills the empty space to the left of the
212 leftmost character with special glyphs, which will display as,
213 well, empty. On text terminals, these special glyphs are simply
214 blank characters. On graphics terminals, there's a single stretch
215 glyph of a suitably computed width. Both the blanks and the
216 stretch glyph are given the face of the background of the line.
217 This way, the terminal-specific back-end can still draw the glyphs
218 left to right, even for R2L lines.
220 Bidirectional display and character compositions
222 Some scripts cannot be displayed by drawing each character
223 individually, because adjacent characters change each other's shape
224 on display. For example, Arabic and Indic scripts belong to this
227 Emacs display supports this by providing "character compositions",
228 most of which is implemented in composite.c. During the buffer
229 scan that delivers characters to PRODUCE_GLYPHS, if the next
230 character to be delivered is a composed character, the iteration
231 calls composition_reseat_it and next_element_from_composition. If
232 they succeed to compose the character with one or more of the
233 following characters, the whole sequence of characters that where
234 composed is recorded in the `struct composition_it' object that is
235 part of the buffer iterator. The composed sequence could produce
236 one or more font glyphs (called "grapheme clusters") on the screen.
237 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
238 in the direction corresponding to the current bidi scan direction
239 (recorded in the scan_dir member of the `struct bidi_it' object
240 that is part of the buffer iterator). In particular, if the bidi
241 iterator currently scans the buffer backwards, the grapheme
242 clusters are delivered back to front. This reorders the grapheme
243 clusters as appropriate for the current bidi context. Note that
244 this means that the grapheme clusters are always stored in the
245 LGSTRING object (see composite.c) in the logical order.
247 Moving an iterator in bidirectional text
248 without producing glyphs
250 Note one important detail mentioned above: that the bidi reordering
251 engine, driven by the iterator, produces characters in R2L rows
252 starting at the character that will be the rightmost on display.
253 As far as the iterator is concerned, the geometry of such rows is
254 still left to right, i.e. the iterator "thinks" the first character
255 is at the leftmost pixel position. The iterator does not know that
256 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
257 delivers. This is important when functions from the the move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 static Lisp_Object Qwindow_text_change_functions
;
322 static Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 static Lisp_Object QCeval
, QCpropertize
;
325 Lisp_Object QCfile
, QCdata
;
326 static Lisp_Object Qfontified
;
327 static Lisp_Object Qgrow_only
;
328 static Lisp_Object Qinhibit_eval_during_redisplay
;
329 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
330 static Lisp_Object Qright_to_left
, Qleft_to_right
;
333 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
336 static Lisp_Object Qarrow
, Qhand
;
339 /* Holds the list (error). */
340 static Lisp_Object list_of_error
;
342 static Lisp_Object Qfontification_functions
;
344 static Lisp_Object Qwrap_prefix
;
345 static Lisp_Object Qline_prefix
;
347 /* Non-nil means don't actually do any redisplay. */
349 Lisp_Object Qinhibit_redisplay
;
351 /* Names of text properties relevant for redisplay. */
353 Lisp_Object Qdisplay
;
355 Lisp_Object Qspace
, QCalign_to
;
356 static Lisp_Object QCrelative_width
, QCrelative_height
;
357 Lisp_Object Qleft_margin
, Qright_margin
;
358 static Lisp_Object Qspace_width
, Qraise
;
359 static Lisp_Object Qslice
;
361 static Lisp_Object Qmargin
, Qpointer
;
362 static Lisp_Object Qline_height
;
364 #ifdef HAVE_WINDOW_SYSTEM
366 /* Test if overflow newline into fringe. Called with iterator IT
367 at or past right window margin, and with IT->current_x set. */
369 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
370 (!NILP (Voverflow_newline_into_fringe) \
371 && FRAME_WINDOW_P ((IT)->f) \
372 && ((IT)->bidi_it.paragraph_dir == R2L \
373 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
374 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
375 && (IT)->current_x == (IT)->last_visible_x \
376 && (IT)->line_wrap != WORD_WRAP)
378 #else /* !HAVE_WINDOW_SYSTEM */
379 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
380 #endif /* HAVE_WINDOW_SYSTEM */
382 /* Test if the display element loaded in IT is a space or tab
383 character. This is used to determine word wrapping. */
385 #define IT_DISPLAYING_WHITESPACE(it) \
386 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
388 /* Name of the face used to highlight trailing whitespace. */
390 static Lisp_Object Qtrailing_whitespace
;
392 /* Name and number of the face used to highlight escape glyphs. */
394 static Lisp_Object Qescape_glyph
;
396 /* Name and number of the face used to highlight non-breaking spaces. */
398 static Lisp_Object Qnobreak_space
;
400 /* The symbol `image' which is the car of the lists used to represent
401 images in Lisp. Also a tool bar style. */
405 /* The image map types. */
407 static Lisp_Object QCpointer
;
408 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
410 /* Tool bar styles */
411 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
413 /* Non-zero means print newline to stdout before next mini-buffer
416 int noninteractive_need_newline
;
418 /* Non-zero means print newline to message log before next message. */
420 static int message_log_need_newline
;
422 /* Three markers that message_dolog uses.
423 It could allocate them itself, but that causes trouble
424 in handling memory-full errors. */
425 static Lisp_Object message_dolog_marker1
;
426 static Lisp_Object message_dolog_marker2
;
427 static Lisp_Object message_dolog_marker3
;
429 /* The buffer position of the first character appearing entirely or
430 partially on the line of the selected window which contains the
431 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
432 redisplay optimization in redisplay_internal. */
434 static struct text_pos this_line_start_pos
;
436 /* Number of characters past the end of the line above, including the
437 terminating newline. */
439 static struct text_pos this_line_end_pos
;
441 /* The vertical positions and the height of this line. */
443 static int this_line_vpos
;
444 static int this_line_y
;
445 static int this_line_pixel_height
;
447 /* X position at which this display line starts. Usually zero;
448 negative if first character is partially visible. */
450 static int this_line_start_x
;
452 /* The smallest character position seen by move_it_* functions as they
453 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
454 hscrolled lines, see display_line. */
456 static struct text_pos this_line_min_pos
;
458 /* Buffer that this_line_.* variables are referring to. */
460 static struct buffer
*this_line_buffer
;
463 /* Values of those variables at last redisplay are stored as
464 properties on `overlay-arrow-position' symbol. However, if
465 Voverlay_arrow_position is a marker, last-arrow-position is its
466 numerical position. */
468 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
470 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
471 properties on a symbol in overlay-arrow-variable-list. */
473 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
475 Lisp_Object Qmenu_bar_update_hook
;
477 /* Nonzero if an overlay arrow has been displayed in this window. */
479 static int overlay_arrow_seen
;
481 /* Number of windows showing the buffer of the selected window (or
482 another buffer with the same base buffer). keyboard.c refers to
487 /* Vector containing glyphs for an ellipsis `...'. */
489 static Lisp_Object default_invis_vector
[3];
491 /* This is the window where the echo area message was displayed. It
492 is always a mini-buffer window, but it may not be the same window
493 currently active as a mini-buffer. */
495 Lisp_Object echo_area_window
;
497 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
498 pushes the current message and the value of
499 message_enable_multibyte on the stack, the function restore_message
500 pops the stack and displays MESSAGE again. */
502 static Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 static int message_enable_multibyte
;
509 /* Nonzero if we should redraw the mode lines on the next redisplay. */
511 int update_mode_lines
;
513 /* Nonzero if window sizes or contents have changed since last
514 redisplay that finished. */
516 int windows_or_buffers_changed
;
518 /* Nonzero means a frame's cursor type has been changed. */
520 int cursor_type_changed
;
522 /* Nonzero after display_mode_line if %l was used and it displayed a
525 static int line_number_displayed
;
527 /* The name of the *Messages* buffer, a string. */
529 static Lisp_Object Vmessages_buffer_name
;
531 /* Current, index 0, and last displayed echo area message. Either
532 buffers from echo_buffers, or nil to indicate no message. */
534 Lisp_Object echo_area_buffer
[2];
536 /* The buffers referenced from echo_area_buffer. */
538 static Lisp_Object echo_buffer
[2];
540 /* A vector saved used in with_area_buffer to reduce consing. */
542 static Lisp_Object Vwith_echo_area_save_vector
;
544 /* Non-zero means display_echo_area should display the last echo area
545 message again. Set by redisplay_preserve_echo_area. */
547 static int display_last_displayed_message_p
;
549 /* Nonzero if echo area is being used by print; zero if being used by
552 static int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 static Lisp_Object Qinhibit_menubar_update
;
557 static Lisp_Object Qmessage_truncate_lines
;
559 /* Set to 1 in clear_message to make redisplay_internal aware
560 of an emptied echo area. */
562 static int message_cleared_p
;
564 /* A scratch glyph row with contents used for generating truncation
565 glyphs. Also used in direct_output_for_insert. */
567 #define MAX_SCRATCH_GLYPHS 100
568 static struct glyph_row scratch_glyph_row
;
569 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
571 /* Ascent and height of the last line processed by move_it_to. */
573 static int last_max_ascent
, last_height
;
575 /* Non-zero if there's a help-echo in the echo area. */
577 int help_echo_showing_p
;
579 /* If >= 0, computed, exact values of mode-line and header-line height
580 to use in the macros CURRENT_MODE_LINE_HEIGHT and
581 CURRENT_HEADER_LINE_HEIGHT. */
583 int current_mode_line_height
, current_header_line_height
;
585 /* The maximum distance to look ahead for text properties. Values
586 that are too small let us call compute_char_face and similar
587 functions too often which is expensive. Values that are too large
588 let us call compute_char_face and alike too often because we
589 might not be interested in text properties that far away. */
591 #define TEXT_PROP_DISTANCE_LIMIT 100
595 /* Non-zero means print traces of redisplay if compiled with
598 int trace_redisplay_p
;
600 #endif /* GLYPH_DEBUG */
602 #ifdef DEBUG_TRACE_MOVE
603 /* Non-zero means trace with TRACE_MOVE to stderr. */
606 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
608 #define TRACE_MOVE(x) (void) 0
611 static Lisp_Object Qauto_hscroll_mode
;
613 /* Buffer being redisplayed -- for redisplay_window_error. */
615 static struct buffer
*displayed_buffer
;
617 /* Value returned from text property handlers (see below). */
622 HANDLED_RECOMPUTE_PROPS
,
623 HANDLED_OVERLAY_STRING_CONSUMED
,
627 /* A description of text properties that redisplay is interested
632 /* The name of the property. */
635 /* A unique index for the property. */
638 /* A handler function called to set up iterator IT from the property
639 at IT's current position. Value is used to steer handle_stop. */
640 enum prop_handled (*handler
) (struct it
*it
);
643 static enum prop_handled
handle_face_prop (struct it
*);
644 static enum prop_handled
handle_invisible_prop (struct it
*);
645 static enum prop_handled
handle_display_prop (struct it
*);
646 static enum prop_handled
handle_composition_prop (struct it
*);
647 static enum prop_handled
handle_overlay_change (struct it
*);
648 static enum prop_handled
handle_fontified_prop (struct it
*);
650 /* Properties handled by iterators. */
652 static struct props it_props
[] =
654 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
655 /* Handle `face' before `display' because some sub-properties of
656 `display' need to know the face. */
657 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
658 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
659 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
660 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
664 /* Value is the position described by X. If X is a marker, value is
665 the marker_position of X. Otherwise, value is X. */
667 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
669 /* Enumeration returned by some move_it_.* functions internally. */
673 /* Not used. Undefined value. */
676 /* Move ended at the requested buffer position or ZV. */
677 MOVE_POS_MATCH_OR_ZV
,
679 /* Move ended at the requested X pixel position. */
682 /* Move within a line ended at the end of a line that must be
686 /* Move within a line ended at the end of a line that would
687 be displayed truncated. */
690 /* Move within a line ended at a line end. */
694 /* This counter is used to clear the face cache every once in a while
695 in redisplay_internal. It is incremented for each redisplay.
696 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
699 #define CLEAR_FACE_CACHE_COUNT 500
700 static int clear_face_cache_count
;
702 /* Similarly for the image cache. */
704 #ifdef HAVE_WINDOW_SYSTEM
705 #define CLEAR_IMAGE_CACHE_COUNT 101
706 static int clear_image_cache_count
;
708 /* Null glyph slice */
709 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
712 /* Non-zero while redisplay_internal is in progress. */
716 static Lisp_Object Qinhibit_free_realized_faces
;
718 /* If a string, XTread_socket generates an event to display that string.
719 (The display is done in read_char.) */
721 Lisp_Object help_echo_string
;
722 Lisp_Object help_echo_window
;
723 Lisp_Object help_echo_object
;
724 EMACS_INT help_echo_pos
;
726 /* Temporary variable for XTread_socket. */
728 Lisp_Object previous_help_echo_string
;
730 /* Platform-independent portion of hourglass implementation. */
732 /* Non-zero means an hourglass cursor is currently shown. */
733 int hourglass_shown_p
;
735 /* If non-null, an asynchronous timer that, when it expires, displays
736 an hourglass cursor on all frames. */
737 struct atimer
*hourglass_atimer
;
739 /* Name of the face used to display glyphless characters. */
740 Lisp_Object Qglyphless_char
;
742 /* Symbol for the purpose of Vglyphless_char_display. */
743 static Lisp_Object Qglyphless_char_display
;
745 /* Method symbols for Vglyphless_char_display. */
746 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
748 /* Default pixel width of `thin-space' display method. */
749 #define THIN_SPACE_WIDTH 1
751 /* Default number of seconds to wait before displaying an hourglass
753 #define DEFAULT_HOURGLASS_DELAY 1
756 /* Function prototypes. */
758 static void setup_for_ellipsis (struct it
*, int);
759 static void set_iterator_to_next (struct it
*, int);
760 static void mark_window_display_accurate_1 (struct window
*, int);
761 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
762 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
763 static int cursor_row_p (struct glyph_row
*);
764 static int redisplay_mode_lines (Lisp_Object
, int);
765 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
767 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
769 static void handle_line_prefix (struct it
*);
771 static void pint2str (char *, int, EMACS_INT
);
772 static void pint2hrstr (char *, int, EMACS_INT
);
773 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
775 static void reconsider_clip_changes (struct window
*, struct buffer
*);
776 static int text_outside_line_unchanged_p (struct window
*,
777 EMACS_INT
, EMACS_INT
);
778 static void store_mode_line_noprop_char (char);
779 static int store_mode_line_noprop (const char *, int, int);
780 static void handle_stop (struct it
*);
781 static void handle_stop_backwards (struct it
*, EMACS_INT
);
782 static int single_display_spec_intangible_p (Lisp_Object
);
783 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
784 static void ensure_echo_area_buffers (void);
785 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
786 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
787 static int with_echo_area_buffer (struct window
*, int,
788 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
789 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static void clear_garbaged_frames (void);
791 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static void pop_message (void);
793 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
795 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static int display_echo_area (struct window
*);
797 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
799 static Lisp_Object
unwind_redisplay (Lisp_Object
);
800 static int string_char_and_length (const unsigned char *, int *);
801 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
803 static int compute_window_start_on_continuation_line (struct window
*);
804 static Lisp_Object
safe_eval_handler (Lisp_Object
);
805 static void insert_left_trunc_glyphs (struct it
*);
806 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
808 static void extend_face_to_end_of_line (struct it
*);
809 static int append_space_for_newline (struct it
*, int);
810 static int cursor_row_fully_visible_p (struct window
*, int, int);
811 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
812 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
813 static int trailing_whitespace_p (EMACS_INT
);
814 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
815 static void push_it (struct it
*);
816 static void pop_it (struct it
*);
817 static void sync_frame_with_window_matrix_rows (struct window
*);
818 static void select_frame_for_redisplay (Lisp_Object
);
819 static void redisplay_internal (void);
820 static int echo_area_display (int);
821 static void redisplay_windows (Lisp_Object
);
822 static void redisplay_window (Lisp_Object
, int);
823 static Lisp_Object
redisplay_window_error (Lisp_Object
);
824 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
825 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
826 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
827 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
829 static int update_menu_bar (struct frame
*, int, int);
830 static int try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static int display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
836 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
837 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
838 static void display_menu_bar (struct window
*);
839 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
841 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
842 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
843 static void compute_line_metrics (struct it
*);
844 static void run_redisplay_end_trigger_hook (struct it
*);
845 static int get_overlay_strings (struct it
*, EMACS_INT
);
846 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
847 static void next_overlay_string (struct it
*);
848 static void reseat (struct it
*, struct text_pos
, int);
849 static void reseat_1 (struct it
*, struct text_pos
, int);
850 static void back_to_previous_visible_line_start (struct it
*);
851 void reseat_at_previous_visible_line_start (struct it
*);
852 static void reseat_at_next_visible_line_start (struct it
*, int);
853 static int next_element_from_ellipsis (struct it
*);
854 static int next_element_from_display_vector (struct it
*);
855 static int next_element_from_string (struct it
*);
856 static int next_element_from_c_string (struct it
*);
857 static int next_element_from_buffer (struct it
*);
858 static int next_element_from_composition (struct it
*);
859 static int next_element_from_image (struct it
*);
860 static int next_element_from_stretch (struct it
*);
861 static void load_overlay_strings (struct it
*, EMACS_INT
);
862 static int init_from_display_pos (struct it
*, struct window
*,
863 struct display_pos
*);
864 static void reseat_to_string (struct it
*, const char *,
865 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
866 static int get_next_display_element (struct it
*);
867 static enum move_it_result
868 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
869 enum move_operation_enum
);
870 void move_it_vertically_backward (struct it
*, int);
871 static void init_to_row_start (struct it
*, struct window
*,
873 static int init_to_row_end (struct it
*, struct window
*,
875 static void back_to_previous_line_start (struct it
*);
876 static int forward_to_next_line_start (struct it
*, int *);
877 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
878 Lisp_Object
, EMACS_INT
);
879 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
880 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
881 static EMACS_INT
number_of_chars (const char *, int);
882 static void compute_stop_pos (struct it
*);
883 static void compute_string_pos (struct text_pos
*, struct text_pos
,
885 static int face_before_or_after_it_pos (struct it
*, int);
886 static EMACS_INT
next_overlay_change (EMACS_INT
);
887 static int handle_single_display_spec (struct it
*, Lisp_Object
,
888 Lisp_Object
, Lisp_Object
,
889 struct text_pos
*, int);
890 static int underlying_face_id (struct it
*);
891 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
894 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
895 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
897 #ifdef HAVE_WINDOW_SYSTEM
899 static void x_consider_frame_title (Lisp_Object
);
900 static int tool_bar_lines_needed (struct frame
*, int *);
901 static void update_tool_bar (struct frame
*, int);
902 static void build_desired_tool_bar_string (struct frame
*f
);
903 static int redisplay_tool_bar (struct frame
*);
904 static void display_tool_bar_line (struct it
*, int);
905 static void notice_overwritten_cursor (struct window
*,
908 static void append_stretch_glyph (struct it
*, Lisp_Object
,
912 #endif /* HAVE_WINDOW_SYSTEM */
914 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
915 static int coords_in_mouse_face_p (struct window
*, int, int);
919 /***********************************************************************
920 Window display dimensions
921 ***********************************************************************/
923 /* Return the bottom boundary y-position for text lines in window W.
924 This is the first y position at which a line cannot start.
925 It is relative to the top of the window.
927 This is the height of W minus the height of a mode line, if any. */
930 window_text_bottom_y (struct window
*w
)
932 int height
= WINDOW_TOTAL_HEIGHT (w
);
934 if (WINDOW_WANTS_MODELINE_P (w
))
935 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
939 /* Return the pixel width of display area AREA of window W. AREA < 0
940 means return the total width of W, not including fringes to
941 the left and right of the window. */
944 window_box_width (struct window
*w
, int area
)
946 int cols
= XFASTINT (w
->total_cols
);
949 if (!w
->pseudo_window_p
)
951 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
953 if (area
== TEXT_AREA
)
955 if (INTEGERP (w
->left_margin_cols
))
956 cols
-= XFASTINT (w
->left_margin_cols
);
957 if (INTEGERP (w
->right_margin_cols
))
958 cols
-= XFASTINT (w
->right_margin_cols
);
959 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
961 else if (area
== LEFT_MARGIN_AREA
)
963 cols
= (INTEGERP (w
->left_margin_cols
)
964 ? XFASTINT (w
->left_margin_cols
) : 0);
967 else if (area
== RIGHT_MARGIN_AREA
)
969 cols
= (INTEGERP (w
->right_margin_cols
)
970 ? XFASTINT (w
->right_margin_cols
) : 0);
975 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
979 /* Return the pixel height of the display area of window W, not
980 including mode lines of W, if any. */
983 window_box_height (struct window
*w
)
985 struct frame
*f
= XFRAME (w
->frame
);
986 int height
= WINDOW_TOTAL_HEIGHT (w
);
988 xassert (height
>= 0);
990 /* Note: the code below that determines the mode-line/header-line
991 height is essentially the same as that contained in the macro
992 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
993 the appropriate glyph row has its `mode_line_p' flag set,
994 and if it doesn't, uses estimate_mode_line_height instead. */
996 if (WINDOW_WANTS_MODELINE_P (w
))
998 struct glyph_row
*ml_row
999 = (w
->current_matrix
&& w
->current_matrix
->rows
1000 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1002 if (ml_row
&& ml_row
->mode_line_p
)
1003 height
-= ml_row
->height
;
1005 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1008 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1010 struct glyph_row
*hl_row
1011 = (w
->current_matrix
&& w
->current_matrix
->rows
1012 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1014 if (hl_row
&& hl_row
->mode_line_p
)
1015 height
-= hl_row
->height
;
1017 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1020 /* With a very small font and a mode-line that's taller than
1021 default, we might end up with a negative height. */
1022 return max (0, height
);
1025 /* Return the window-relative coordinate of the left edge of display
1026 area AREA of window W. AREA < 0 means return the left edge of the
1027 whole window, to the right of the left fringe of W. */
1030 window_box_left_offset (struct window
*w
, int area
)
1034 if (w
->pseudo_window_p
)
1037 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1039 if (area
== TEXT_AREA
)
1040 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1041 + window_box_width (w
, LEFT_MARGIN_AREA
));
1042 else if (area
== RIGHT_MARGIN_AREA
)
1043 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1044 + window_box_width (w
, LEFT_MARGIN_AREA
)
1045 + window_box_width (w
, TEXT_AREA
)
1046 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1048 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1049 else if (area
== LEFT_MARGIN_AREA
1050 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1051 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1057 /* Return the window-relative coordinate of the right edge of display
1058 area AREA of window W. AREA < 0 means return the right edge of the
1059 whole window, to the left of the right fringe of W. */
1062 window_box_right_offset (struct window
*w
, int area
)
1064 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1067 /* Return the frame-relative coordinate of the left edge of display
1068 area AREA of window W. AREA < 0 means return the left edge of the
1069 whole window, to the right of the left fringe of W. */
1072 window_box_left (struct window
*w
, int area
)
1074 struct frame
*f
= XFRAME (w
->frame
);
1077 if (w
->pseudo_window_p
)
1078 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1080 x
= (WINDOW_LEFT_EDGE_X (w
)
1081 + window_box_left_offset (w
, area
));
1087 /* Return the frame-relative coordinate of the right edge of display
1088 area AREA of window W. AREA < 0 means return the right edge of the
1089 whole window, to the left of the right fringe of W. */
1092 window_box_right (struct window
*w
, int area
)
1094 return window_box_left (w
, area
) + window_box_width (w
, area
);
1097 /* Get the bounding box of the display area AREA of window W, without
1098 mode lines, in frame-relative coordinates. AREA < 0 means the
1099 whole window, not including the left and right fringes of
1100 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1101 coordinates of the upper-left corner of the box. Return in
1102 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1105 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1106 int *box_width
, int *box_height
)
1109 *box_width
= window_box_width (w
, area
);
1111 *box_height
= window_box_height (w
);
1113 *box_x
= window_box_left (w
, area
);
1116 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1117 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1118 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1123 /* Get the bounding box of the display area AREA of window W, without
1124 mode lines. AREA < 0 means the whole window, not including the
1125 left and right fringe of the window. Return in *TOP_LEFT_X
1126 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1127 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1128 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1132 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1133 int *bottom_right_x
, int *bottom_right_y
)
1135 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1137 *bottom_right_x
+= *top_left_x
;
1138 *bottom_right_y
+= *top_left_y
;
1143 /***********************************************************************
1145 ***********************************************************************/
1147 /* Return the bottom y-position of the line the iterator IT is in.
1148 This can modify IT's settings. */
1151 line_bottom_y (struct it
*it
)
1153 int line_height
= it
->max_ascent
+ it
->max_descent
;
1154 int line_top_y
= it
->current_y
;
1156 if (line_height
== 0)
1159 line_height
= last_height
;
1160 else if (IT_CHARPOS (*it
) < ZV
)
1162 move_it_by_lines (it
, 1);
1163 line_height
= (it
->max_ascent
|| it
->max_descent
1164 ? it
->max_ascent
+ it
->max_descent
1169 struct glyph_row
*row
= it
->glyph_row
;
1171 /* Use the default character height. */
1172 it
->glyph_row
= NULL
;
1173 it
->what
= IT_CHARACTER
;
1176 PRODUCE_GLYPHS (it
);
1177 line_height
= it
->ascent
+ it
->descent
;
1178 it
->glyph_row
= row
;
1182 return line_top_y
+ line_height
;
1186 /* Return 1 if position CHARPOS is visible in window W.
1187 CHARPOS < 0 means return info about WINDOW_END position.
1188 If visible, set *X and *Y to pixel coordinates of top left corner.
1189 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1190 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1193 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1194 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1197 struct text_pos top
;
1199 struct buffer
*old_buffer
= NULL
;
1201 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1204 if (XBUFFER (w
->buffer
) != current_buffer
)
1206 old_buffer
= current_buffer
;
1207 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1210 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1212 /* Compute exact mode line heights. */
1213 if (WINDOW_WANTS_MODELINE_P (w
))
1214 current_mode_line_height
1215 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1216 BVAR (current_buffer
, mode_line_format
));
1218 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1219 current_header_line_height
1220 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1221 BVAR (current_buffer
, header_line_format
));
1223 start_display (&it
, w
, top
);
1224 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1225 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1227 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1229 /* We have reached CHARPOS, or passed it. How the call to
1230 move_it_to can overshoot: (i) If CHARPOS is on invisible
1231 text, move_it_to stops at the end of the invisible text,
1232 after CHARPOS. (ii) If CHARPOS is in a display vector,
1233 move_it_to stops on its last glyph. */
1234 int top_x
= it
.current_x
;
1235 int top_y
= it
.current_y
;
1236 enum it_method it_method
= it
.method
;
1237 /* Calling line_bottom_y may change it.method, it.position, etc. */
1238 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1239 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1241 if (top_y
< window_top_y
)
1242 visible_p
= bottom_y
> window_top_y
;
1243 else if (top_y
< it
.last_visible_y
)
1247 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1249 /* We stopped on the last glyph of a display vector.
1250 Try and recompute. Hack alert! */
1251 if (charpos
< 2 || top
.charpos
>= charpos
)
1252 top_x
= it
.glyph_row
->x
;
1256 start_display (&it2
, w
, top
);
1257 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1258 get_next_display_element (&it2
);
1259 PRODUCE_GLYPHS (&it2
);
1260 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1261 || it2
.current_x
> it2
.last_visible_x
)
1262 top_x
= it
.glyph_row
->x
;
1265 top_x
= it2
.current_x
;
1266 top_y
= it2
.current_y
;
1272 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1273 *rtop
= max (0, window_top_y
- top_y
);
1274 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1275 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1276 - max (top_y
, window_top_y
)));
1285 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1286 move_it_by_lines (&it
, 1);
1287 if (charpos
< IT_CHARPOS (it
)
1288 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1291 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1293 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1294 *rtop
= max (0, -it2
.current_y
);
1295 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1296 - it
.last_visible_y
));
1297 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1299 - max (it2
.current_y
,
1300 WINDOW_HEADER_LINE_HEIGHT (w
))));
1306 set_buffer_internal_1 (old_buffer
);
1308 current_header_line_height
= current_mode_line_height
= -1;
1310 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1311 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1314 /* Debugging code. */
1316 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1317 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1319 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1326 /* Return the next character from STR. Return in *LEN the length of
1327 the character. This is like STRING_CHAR_AND_LENGTH but never
1328 returns an invalid character. If we find one, we return a `?', but
1329 with the length of the invalid character. */
1332 string_char_and_length (const unsigned char *str
, int *len
)
1336 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1337 if (!CHAR_VALID_P (c
, 1))
1338 /* We may not change the length here because other places in Emacs
1339 don't use this function, i.e. they silently accept invalid
1348 /* Given a position POS containing a valid character and byte position
1349 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1351 static struct text_pos
1352 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1354 xassert (STRINGP (string
) && nchars
>= 0);
1356 if (STRING_MULTIBYTE (string
))
1358 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1363 string_char_and_length (p
, &len
);
1366 BYTEPOS (pos
) += len
;
1370 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1376 /* Value is the text position, i.e. character and byte position,
1377 for character position CHARPOS in STRING. */
1379 static INLINE
struct text_pos
1380 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1382 struct text_pos pos
;
1383 xassert (STRINGP (string
));
1384 xassert (charpos
>= 0);
1385 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1390 /* Value is a text position, i.e. character and byte position, for
1391 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1392 means recognize multibyte characters. */
1394 static struct text_pos
1395 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1397 struct text_pos pos
;
1399 xassert (s
!= NULL
);
1400 xassert (charpos
>= 0);
1406 SET_TEXT_POS (pos
, 0, 0);
1409 string_char_and_length ((const unsigned char *) s
, &len
);
1412 BYTEPOS (pos
) += len
;
1416 SET_TEXT_POS (pos
, charpos
, charpos
);
1422 /* Value is the number of characters in C string S. MULTIBYTE_P
1423 non-zero means recognize multibyte characters. */
1426 number_of_chars (const char *s
, int multibyte_p
)
1432 EMACS_INT rest
= strlen (s
);
1434 const unsigned char *p
= (const unsigned char *) s
;
1436 for (nchars
= 0; rest
> 0; ++nchars
)
1438 string_char_and_length (p
, &len
);
1439 rest
-= len
, p
+= len
;
1443 nchars
= strlen (s
);
1449 /* Compute byte position NEWPOS->bytepos corresponding to
1450 NEWPOS->charpos. POS is a known position in string STRING.
1451 NEWPOS->charpos must be >= POS.charpos. */
1454 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1456 xassert (STRINGP (string
));
1457 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1459 if (STRING_MULTIBYTE (string
))
1460 *newpos
= string_pos_nchars_ahead (pos
, string
,
1461 CHARPOS (*newpos
) - CHARPOS (pos
));
1463 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1467 Return an estimation of the pixel height of mode or header lines on
1468 frame F. FACE_ID specifies what line's height to estimate. */
1471 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1473 #ifdef HAVE_WINDOW_SYSTEM
1474 if (FRAME_WINDOW_P (f
))
1476 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1478 /* This function is called so early when Emacs starts that the face
1479 cache and mode line face are not yet initialized. */
1480 if (FRAME_FACE_CACHE (f
))
1482 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1486 height
= FONT_HEIGHT (face
->font
);
1487 if (face
->box_line_width
> 0)
1488 height
+= 2 * face
->box_line_width
;
1499 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1500 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1501 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1502 not force the value into range. */
1505 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1506 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1509 #ifdef HAVE_WINDOW_SYSTEM
1510 if (FRAME_WINDOW_P (f
))
1512 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1513 even for negative values. */
1515 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1517 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1519 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1520 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1523 STORE_NATIVE_RECT (*bounds
,
1524 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1525 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1526 FRAME_COLUMN_WIDTH (f
) - 1,
1527 FRAME_LINE_HEIGHT (f
) - 1);
1533 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1534 pix_x
= FRAME_TOTAL_COLS (f
);
1538 else if (pix_y
> FRAME_LINES (f
))
1539 pix_y
= FRAME_LINES (f
);
1549 /* Find the glyph under window-relative coordinates X/Y in window W.
1550 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1551 strings. Return in *HPOS and *VPOS the row and column number of
1552 the glyph found. Return in *AREA the glyph area containing X.
1553 Value is a pointer to the glyph found or null if X/Y is not on
1554 text, or we can't tell because W's current matrix is not up to
1559 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1560 int *dx
, int *dy
, int *area
)
1562 struct glyph
*glyph
, *end
;
1563 struct glyph_row
*row
= NULL
;
1566 /* Find row containing Y. Give up if some row is not enabled. */
1567 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1569 row
= MATRIX_ROW (w
->current_matrix
, i
);
1570 if (!row
->enabled_p
)
1572 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1579 /* Give up if Y is not in the window. */
1580 if (i
== w
->current_matrix
->nrows
)
1583 /* Get the glyph area containing X. */
1584 if (w
->pseudo_window_p
)
1591 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1593 *area
= LEFT_MARGIN_AREA
;
1594 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1596 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1599 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1603 *area
= RIGHT_MARGIN_AREA
;
1604 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1608 /* Find glyph containing X. */
1609 glyph
= row
->glyphs
[*area
];
1610 end
= glyph
+ row
->used
[*area
];
1612 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1614 x
-= glyph
->pixel_width
;
1624 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1627 *hpos
= glyph
- row
->glyphs
[*area
];
1631 /* Convert frame-relative x/y to coordinates relative to window W.
1632 Takes pseudo-windows into account. */
1635 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1637 if (w
->pseudo_window_p
)
1639 /* A pseudo-window is always full-width, and starts at the
1640 left edge of the frame, plus a frame border. */
1641 struct frame
*f
= XFRAME (w
->frame
);
1642 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1643 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1647 *x
-= WINDOW_LEFT_EDGE_X (w
);
1648 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1652 #ifdef HAVE_WINDOW_SYSTEM
1655 Return in RECTS[] at most N clipping rectangles for glyph string S.
1656 Return the number of stored rectangles. */
1659 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1666 if (s
->row
->full_width_p
)
1668 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1669 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1670 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1672 /* Unless displaying a mode or menu bar line, which are always
1673 fully visible, clip to the visible part of the row. */
1674 if (s
->w
->pseudo_window_p
)
1675 r
.height
= s
->row
->visible_height
;
1677 r
.height
= s
->height
;
1681 /* This is a text line that may be partially visible. */
1682 r
.x
= window_box_left (s
->w
, s
->area
);
1683 r
.width
= window_box_width (s
->w
, s
->area
);
1684 r
.height
= s
->row
->visible_height
;
1688 if (r
.x
< s
->clip_head
->x
)
1690 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1691 r
.width
-= s
->clip_head
->x
- r
.x
;
1694 r
.x
= s
->clip_head
->x
;
1697 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1699 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1700 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1705 /* If S draws overlapping rows, it's sufficient to use the top and
1706 bottom of the window for clipping because this glyph string
1707 intentionally draws over other lines. */
1708 if (s
->for_overlaps
)
1710 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1711 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1713 /* Alas, the above simple strategy does not work for the
1714 environments with anti-aliased text: if the same text is
1715 drawn onto the same place multiple times, it gets thicker.
1716 If the overlap we are processing is for the erased cursor, we
1717 take the intersection with the rectagle of the cursor. */
1718 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1720 XRectangle rc
, r_save
= r
;
1722 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1723 rc
.y
= s
->w
->phys_cursor
.y
;
1724 rc
.width
= s
->w
->phys_cursor_width
;
1725 rc
.height
= s
->w
->phys_cursor_height
;
1727 x_intersect_rectangles (&r_save
, &rc
, &r
);
1732 /* Don't use S->y for clipping because it doesn't take partially
1733 visible lines into account. For example, it can be negative for
1734 partially visible lines at the top of a window. */
1735 if (!s
->row
->full_width_p
1736 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1737 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1739 r
.y
= max (0, s
->row
->y
);
1742 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1744 /* If drawing the cursor, don't let glyph draw outside its
1745 advertised boundaries. Cleartype does this under some circumstances. */
1746 if (s
->hl
== DRAW_CURSOR
)
1748 struct glyph
*glyph
= s
->first_glyph
;
1753 r
.width
-= s
->x
- r
.x
;
1756 r
.width
= min (r
.width
, glyph
->pixel_width
);
1758 /* If r.y is below window bottom, ensure that we still see a cursor. */
1759 height
= min (glyph
->ascent
+ glyph
->descent
,
1760 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1761 max_y
= window_text_bottom_y (s
->w
) - height
;
1762 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1763 if (s
->ybase
- glyph
->ascent
> max_y
)
1770 /* Don't draw cursor glyph taller than our actual glyph. */
1771 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1772 if (height
< r
.height
)
1774 max_y
= r
.y
+ r
.height
;
1775 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1776 r
.height
= min (max_y
- r
.y
, height
);
1783 XRectangle r_save
= r
;
1785 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1789 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1790 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1792 #ifdef CONVERT_FROM_XRECT
1793 CONVERT_FROM_XRECT (r
, *rects
);
1801 /* If we are processing overlapping and allowed to return
1802 multiple clipping rectangles, we exclude the row of the glyph
1803 string from the clipping rectangle. This is to avoid drawing
1804 the same text on the environment with anti-aliasing. */
1805 #ifdef CONVERT_FROM_XRECT
1808 XRectangle
*rs
= rects
;
1810 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1812 if (s
->for_overlaps
& OVERLAPS_PRED
)
1815 if (r
.y
+ r
.height
> row_y
)
1818 rs
[i
].height
= row_y
- r
.y
;
1824 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1827 if (r
.y
< row_y
+ s
->row
->visible_height
)
1829 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1831 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1832 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1841 #ifdef CONVERT_FROM_XRECT
1842 for (i
= 0; i
< n
; i
++)
1843 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1850 Return in *NR the clipping rectangle for glyph string S. */
1853 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1855 get_glyph_string_clip_rects (s
, nr
, 1);
1860 Return the position and height of the phys cursor in window W.
1861 Set w->phys_cursor_width to width of phys cursor.
1865 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1866 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1868 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1869 int x
, y
, wd
, h
, h0
, y0
;
1871 /* Compute the width of the rectangle to draw. If on a stretch
1872 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1873 rectangle as wide as the glyph, but use a canonical character
1875 wd
= glyph
->pixel_width
- 1;
1876 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1880 x
= w
->phys_cursor
.x
;
1887 if (glyph
->type
== STRETCH_GLYPH
1888 && !x_stretch_cursor_p
)
1889 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1890 w
->phys_cursor_width
= wd
;
1892 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1894 /* If y is below window bottom, ensure that we still see a cursor. */
1895 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1897 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1898 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1900 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1903 h
= max (h
- (y0
- y
) + 1, h0
);
1908 y0
= window_text_bottom_y (w
) - h0
;
1916 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1917 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1922 * Remember which glyph the mouse is over.
1926 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1930 struct glyph_row
*r
, *gr
, *end_row
;
1931 enum window_part part
;
1932 enum glyph_row_area area
;
1933 int x
, y
, width
, height
;
1935 /* Try to determine frame pixel position and size of the glyph under
1936 frame pixel coordinates X/Y on frame F. */
1938 if (!f
->glyphs_initialized_p
1939 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1942 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1943 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1947 w
= XWINDOW (window
);
1948 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1949 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1951 x
= window_relative_x_coord (w
, part
, gx
);
1952 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1954 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1955 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1957 if (w
->pseudo_window_p
)
1960 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1966 case ON_LEFT_MARGIN
:
1967 area
= LEFT_MARGIN_AREA
;
1970 case ON_RIGHT_MARGIN
:
1971 area
= RIGHT_MARGIN_AREA
;
1974 case ON_HEADER_LINE
:
1976 gr
= (part
== ON_HEADER_LINE
1977 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1978 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1981 goto text_glyph_row_found
;
1988 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1989 if (r
->y
+ r
->height
> y
)
1995 text_glyph_row_found
:
1998 struct glyph
*g
= gr
->glyphs
[area
];
1999 struct glyph
*end
= g
+ gr
->used
[area
];
2001 height
= gr
->height
;
2002 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2003 if (gx
+ g
->pixel_width
> x
)
2008 if (g
->type
== IMAGE_GLYPH
)
2010 /* Don't remember when mouse is over image, as
2011 image may have hot-spots. */
2012 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2015 width
= g
->pixel_width
;
2019 /* Use nominal char spacing at end of line. */
2021 gx
+= (x
/ width
) * width
;
2024 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2025 gx
+= window_box_left_offset (w
, area
);
2029 /* Use nominal line height at end of window. */
2030 gx
= (x
/ width
) * width
;
2032 gy
+= (y
/ height
) * height
;
2036 case ON_LEFT_FRINGE
:
2037 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2038 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2039 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2040 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2043 case ON_RIGHT_FRINGE
:
2044 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2045 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2046 : window_box_right_offset (w
, TEXT_AREA
));
2047 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2051 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2053 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2054 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2055 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2057 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2061 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2062 if (r
->y
+ r
->height
> y
)
2069 height
= gr
->height
;
2072 /* Use nominal line height at end of window. */
2074 gy
+= (y
/ height
) * height
;
2081 /* If there is no glyph under the mouse, then we divide the screen
2082 into a grid of the smallest glyph in the frame, and use that
2085 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2086 round down even for negative values. */
2092 gx
= (gx
/ width
) * width
;
2093 gy
= (gy
/ height
) * height
;
2098 gx
+= WINDOW_LEFT_EDGE_X (w
);
2099 gy
+= WINDOW_TOP_EDGE_Y (w
);
2102 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2104 /* Visible feedback for debugging. */
2107 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2108 f
->output_data
.x
->normal_gc
,
2109 gx
, gy
, width
, height
);
2115 #endif /* HAVE_WINDOW_SYSTEM */
2118 /***********************************************************************
2119 Lisp form evaluation
2120 ***********************************************************************/
2122 /* Error handler for safe_eval and safe_call. */
2125 safe_eval_handler (Lisp_Object arg
)
2127 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2132 /* Evaluate SEXPR and return the result, or nil if something went
2133 wrong. Prevent redisplay during the evaluation. */
2135 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2136 Return the result, or nil if something went wrong. Prevent
2137 redisplay during the evaluation. */
2140 safe_call (size_t nargs
, Lisp_Object
*args
)
2144 if (inhibit_eval_during_redisplay
)
2148 int count
= SPECPDL_INDEX ();
2149 struct gcpro gcpro1
;
2152 gcpro1
.nvars
= nargs
;
2153 specbind (Qinhibit_redisplay
, Qt
);
2154 /* Use Qt to ensure debugger does not run,
2155 so there is no possibility of wanting to redisplay. */
2156 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2159 val
= unbind_to (count
, val
);
2166 /* Call function FN with one argument ARG.
2167 Return the result, or nil if something went wrong. */
2170 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2172 Lisp_Object args
[2];
2175 return safe_call (2, args
);
2178 static Lisp_Object Qeval
;
2181 safe_eval (Lisp_Object sexpr
)
2183 return safe_call1 (Qeval
, sexpr
);
2186 /* Call function FN with one argument ARG.
2187 Return the result, or nil if something went wrong. */
2190 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2192 Lisp_Object args
[3];
2196 return safe_call (3, args
);
2201 /***********************************************************************
2203 ***********************************************************************/
2207 /* Define CHECK_IT to perform sanity checks on iterators.
2208 This is for debugging. It is too slow to do unconditionally. */
2214 if (it
->method
== GET_FROM_STRING
)
2216 xassert (STRINGP (it
->string
));
2217 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2221 xassert (IT_STRING_CHARPOS (*it
) < 0);
2222 if (it
->method
== GET_FROM_BUFFER
)
2224 /* Check that character and byte positions agree. */
2225 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2230 xassert (it
->current
.dpvec_index
>= 0);
2232 xassert (it
->current
.dpvec_index
< 0);
2235 #define CHECK_IT(IT) check_it ((IT))
2239 #define CHECK_IT(IT) (void) 0
2246 /* Check that the window end of window W is what we expect it
2247 to be---the last row in the current matrix displaying text. */
2250 check_window_end (w
)
2253 if (!MINI_WINDOW_P (w
)
2254 && !NILP (w
->window_end_valid
))
2256 struct glyph_row
*row
;
2257 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2258 XFASTINT (w
->window_end_vpos
)),
2260 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2261 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2265 #define CHECK_WINDOW_END(W) check_window_end ((W))
2267 #else /* not GLYPH_DEBUG */
2269 #define CHECK_WINDOW_END(W) (void) 0
2271 #endif /* not GLYPH_DEBUG */
2275 /***********************************************************************
2276 Iterator initialization
2277 ***********************************************************************/
2279 /* Initialize IT for displaying current_buffer in window W, starting
2280 at character position CHARPOS. CHARPOS < 0 means that no buffer
2281 position is specified which is useful when the iterator is assigned
2282 a position later. BYTEPOS is the byte position corresponding to
2283 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2285 If ROW is not null, calls to produce_glyphs with IT as parameter
2286 will produce glyphs in that row.
2288 BASE_FACE_ID is the id of a base face to use. It must be one of
2289 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2290 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2291 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2293 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2294 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2295 will be initialized to use the corresponding mode line glyph row of
2296 the desired matrix of W. */
2299 init_iterator (struct it
*it
, struct window
*w
,
2300 EMACS_INT charpos
, EMACS_INT bytepos
,
2301 struct glyph_row
*row
, enum face_id base_face_id
)
2303 int highlight_region_p
;
2304 enum face_id remapped_base_face_id
= base_face_id
;
2306 /* Some precondition checks. */
2307 xassert (w
!= NULL
&& it
!= NULL
);
2308 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2311 /* If face attributes have been changed since the last redisplay,
2312 free realized faces now because they depend on face definitions
2313 that might have changed. Don't free faces while there might be
2314 desired matrices pending which reference these faces. */
2315 if (face_change_count
&& !inhibit_free_realized_faces
)
2317 face_change_count
= 0;
2318 free_all_realized_faces (Qnil
);
2321 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2322 if (! NILP (Vface_remapping_alist
))
2323 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2325 /* Use one of the mode line rows of W's desired matrix if
2329 if (base_face_id
== MODE_LINE_FACE_ID
2330 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2331 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2332 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2333 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2337 memset (it
, 0, sizeof *it
);
2338 it
->current
.overlay_string_index
= -1;
2339 it
->current
.dpvec_index
= -1;
2340 it
->base_face_id
= remapped_base_face_id
;
2342 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2344 /* The window in which we iterate over current_buffer: */
2345 XSETWINDOW (it
->window
, w
);
2347 it
->f
= XFRAME (w
->frame
);
2351 /* Extra space between lines (on window systems only). */
2352 if (base_face_id
== DEFAULT_FACE_ID
2353 && FRAME_WINDOW_P (it
->f
))
2355 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2356 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2357 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2358 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2359 * FRAME_LINE_HEIGHT (it
->f
));
2360 else if (it
->f
->extra_line_spacing
> 0)
2361 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2362 it
->max_extra_line_spacing
= 0;
2365 /* If realized faces have been removed, e.g. because of face
2366 attribute changes of named faces, recompute them. When running
2367 in batch mode, the face cache of the initial frame is null. If
2368 we happen to get called, make a dummy face cache. */
2369 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2370 init_frame_faces (it
->f
);
2371 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2372 recompute_basic_faces (it
->f
);
2374 /* Current value of the `slice', `space-width', and 'height' properties. */
2375 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2376 it
->space_width
= Qnil
;
2377 it
->font_height
= Qnil
;
2378 it
->override_ascent
= -1;
2380 /* Are control characters displayed as `^C'? */
2381 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2383 /* -1 means everything between a CR and the following line end
2384 is invisible. >0 means lines indented more than this value are
2386 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2387 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2388 : (!NILP (BVAR (current_buffer
, selective_display
))
2390 it
->selective_display_ellipsis_p
2391 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2393 /* Display table to use. */
2394 it
->dp
= window_display_table (w
);
2396 /* Are multibyte characters enabled in current_buffer? */
2397 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2399 /* Do we need to reorder bidirectional text? Not if this is a
2400 unibyte buffer: by definition, none of the single-byte characters
2401 are strong R2L, so no reordering is needed. And bidi.c doesn't
2402 support unibyte buffers anyway. */
2404 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2406 /* Non-zero if we should highlight the region. */
2408 = (!NILP (Vtransient_mark_mode
)
2409 && !NILP (BVAR (current_buffer
, mark_active
))
2410 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2412 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2413 start and end of a visible region in window IT->w. Set both to
2414 -1 to indicate no region. */
2415 if (highlight_region_p
2416 /* Maybe highlight only in selected window. */
2417 && (/* Either show region everywhere. */
2418 highlight_nonselected_windows
2419 /* Or show region in the selected window. */
2420 || w
== XWINDOW (selected_window
)
2421 /* Or show the region if we are in the mini-buffer and W is
2422 the window the mini-buffer refers to. */
2423 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2424 && WINDOWP (minibuf_selected_window
)
2425 && w
== XWINDOW (minibuf_selected_window
))))
2427 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2428 it
->region_beg_charpos
= min (PT
, markpos
);
2429 it
->region_end_charpos
= max (PT
, markpos
);
2432 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2434 /* Get the position at which the redisplay_end_trigger hook should
2435 be run, if it is to be run at all. */
2436 if (MARKERP (w
->redisplay_end_trigger
)
2437 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2438 it
->redisplay_end_trigger_charpos
2439 = marker_position (w
->redisplay_end_trigger
);
2440 else if (INTEGERP (w
->redisplay_end_trigger
))
2441 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2443 /* Correct bogus values of tab_width. */
2444 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2445 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2448 /* Are lines in the display truncated? */
2449 if (base_face_id
!= DEFAULT_FACE_ID
2450 || XINT (it
->w
->hscroll
)
2451 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2452 && ((!NILP (Vtruncate_partial_width_windows
)
2453 && !INTEGERP (Vtruncate_partial_width_windows
))
2454 || (INTEGERP (Vtruncate_partial_width_windows
)
2455 && (WINDOW_TOTAL_COLS (it
->w
)
2456 < XINT (Vtruncate_partial_width_windows
))))))
2457 it
->line_wrap
= TRUNCATE
;
2458 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2459 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2460 ? WINDOW_WRAP
: WORD_WRAP
;
2462 it
->line_wrap
= TRUNCATE
;
2464 /* Get dimensions of truncation and continuation glyphs. These are
2465 displayed as fringe bitmaps under X, so we don't need them for such
2467 if (!FRAME_WINDOW_P (it
->f
))
2469 if (it
->line_wrap
== TRUNCATE
)
2471 /* We will need the truncation glyph. */
2472 xassert (it
->glyph_row
== NULL
);
2473 produce_special_glyphs (it
, IT_TRUNCATION
);
2474 it
->truncation_pixel_width
= it
->pixel_width
;
2478 /* We will need the continuation glyph. */
2479 xassert (it
->glyph_row
== NULL
);
2480 produce_special_glyphs (it
, IT_CONTINUATION
);
2481 it
->continuation_pixel_width
= it
->pixel_width
;
2484 /* Reset these values to zero because the produce_special_glyphs
2485 above has changed them. */
2486 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2487 it
->phys_ascent
= it
->phys_descent
= 0;
2490 /* Set this after getting the dimensions of truncation and
2491 continuation glyphs, so that we don't produce glyphs when calling
2492 produce_special_glyphs, above. */
2493 it
->glyph_row
= row
;
2494 it
->area
= TEXT_AREA
;
2496 /* Forget any previous info about this row being reversed. */
2498 it
->glyph_row
->reversed_p
= 0;
2500 /* Get the dimensions of the display area. The display area
2501 consists of the visible window area plus a horizontally scrolled
2502 part to the left of the window. All x-values are relative to the
2503 start of this total display area. */
2504 if (base_face_id
!= DEFAULT_FACE_ID
)
2506 /* Mode lines, menu bar in terminal frames. */
2507 it
->first_visible_x
= 0;
2508 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2513 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2514 it
->last_visible_x
= (it
->first_visible_x
2515 + window_box_width (w
, TEXT_AREA
));
2517 /* If we truncate lines, leave room for the truncator glyph(s) at
2518 the right margin. Otherwise, leave room for the continuation
2519 glyph(s). Truncation and continuation glyphs are not inserted
2520 for window-based redisplay. */
2521 if (!FRAME_WINDOW_P (it
->f
))
2523 if (it
->line_wrap
== TRUNCATE
)
2524 it
->last_visible_x
-= it
->truncation_pixel_width
;
2526 it
->last_visible_x
-= it
->continuation_pixel_width
;
2529 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2530 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2533 /* Leave room for a border glyph. */
2534 if (!FRAME_WINDOW_P (it
->f
)
2535 && !WINDOW_RIGHTMOST_P (it
->w
))
2536 it
->last_visible_x
-= 1;
2538 it
->last_visible_y
= window_text_bottom_y (w
);
2540 /* For mode lines and alike, arrange for the first glyph having a
2541 left box line if the face specifies a box. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2546 it
->face_id
= remapped_base_face_id
;
2548 /* If we have a boxed mode line, make the first character appear
2549 with a left box line. */
2550 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2551 if (face
->box
!= FACE_NO_BOX
)
2552 it
->start_of_box_run_p
= 1;
2555 /* If we are to reorder bidirectional text, init the bidi
2559 /* Note the paragraph direction that this buffer wants to
2561 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2562 it
->paragraph_embedding
= L2R
;
2563 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2564 it
->paragraph_embedding
= R2L
;
2566 it
->paragraph_embedding
= NEUTRAL_DIR
;
2567 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2570 /* If a buffer position was specified, set the iterator there,
2571 getting overlays and face properties from that position. */
2572 if (charpos
>= BUF_BEG (current_buffer
))
2574 it
->end_charpos
= ZV
;
2576 IT_CHARPOS (*it
) = charpos
;
2578 /* Compute byte position if not specified. */
2579 if (bytepos
< charpos
)
2580 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2582 IT_BYTEPOS (*it
) = bytepos
;
2584 it
->start
= it
->current
;
2586 /* Compute faces etc. */
2587 reseat (it
, it
->current
.pos
, 1);
2594 /* Initialize IT for the display of window W with window start POS. */
2597 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2599 struct glyph_row
*row
;
2600 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2602 row
= w
->desired_matrix
->rows
+ first_vpos
;
2603 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2604 it
->first_vpos
= first_vpos
;
2606 /* Don't reseat to previous visible line start if current start
2607 position is in a string or image. */
2608 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2610 int start_at_line_beg_p
;
2611 int first_y
= it
->current_y
;
2613 /* If window start is not at a line start, skip forward to POS to
2614 get the correct continuation lines width. */
2615 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2616 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2617 if (!start_at_line_beg_p
)
2621 reseat_at_previous_visible_line_start (it
);
2622 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2624 new_x
= it
->current_x
+ it
->pixel_width
;
2626 /* If lines are continued, this line may end in the middle
2627 of a multi-glyph character (e.g. a control character
2628 displayed as \003, or in the middle of an overlay
2629 string). In this case move_it_to above will not have
2630 taken us to the start of the continuation line but to the
2631 end of the continued line. */
2632 if (it
->current_x
> 0
2633 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2634 && (/* And glyph doesn't fit on the line. */
2635 new_x
> it
->last_visible_x
2636 /* Or it fits exactly and we're on a window
2638 || (new_x
== it
->last_visible_x
2639 && FRAME_WINDOW_P (it
->f
))))
2641 if (it
->current
.dpvec_index
>= 0
2642 || it
->current
.overlay_string_index
>= 0)
2644 set_iterator_to_next (it
, 1);
2645 move_it_in_display_line_to (it
, -1, -1, 0);
2648 it
->continuation_lines_width
+= it
->current_x
;
2651 /* We're starting a new display line, not affected by the
2652 height of the continued line, so clear the appropriate
2653 fields in the iterator structure. */
2654 it
->max_ascent
= it
->max_descent
= 0;
2655 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2657 it
->current_y
= first_y
;
2659 it
->current_x
= it
->hpos
= 0;
2665 /* Return 1 if POS is a position in ellipses displayed for invisible
2666 text. W is the window we display, for text property lookup. */
2669 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2671 Lisp_Object prop
, window
;
2673 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2675 /* If POS specifies a position in a display vector, this might
2676 be for an ellipsis displayed for invisible text. We won't
2677 get the iterator set up for delivering that ellipsis unless
2678 we make sure that it gets aware of the invisible text. */
2679 if (pos
->dpvec_index
>= 0
2680 && pos
->overlay_string_index
< 0
2681 && CHARPOS (pos
->string_pos
) < 0
2683 && (XSETWINDOW (window
, w
),
2684 prop
= Fget_char_property (make_number (charpos
),
2685 Qinvisible
, window
),
2686 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2688 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2690 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2697 /* Initialize IT for stepping through current_buffer in window W,
2698 starting at position POS that includes overlay string and display
2699 vector/ control character translation position information. Value
2700 is zero if there are overlay strings with newlines at POS. */
2703 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2705 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2706 int i
, overlay_strings_with_newlines
= 0;
2708 /* If POS specifies a position in a display vector, this might
2709 be for an ellipsis displayed for invisible text. We won't
2710 get the iterator set up for delivering that ellipsis unless
2711 we make sure that it gets aware of the invisible text. */
2712 if (in_ellipses_for_invisible_text_p (pos
, w
))
2718 /* Keep in mind: the call to reseat in init_iterator skips invisible
2719 text, so we might end up at a position different from POS. This
2720 is only a problem when POS is a row start after a newline and an
2721 overlay starts there with an after-string, and the overlay has an
2722 invisible property. Since we don't skip invisible text in
2723 display_line and elsewhere immediately after consuming the
2724 newline before the row start, such a POS will not be in a string,
2725 but the call to init_iterator below will move us to the
2727 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2729 /* This only scans the current chunk -- it should scan all chunks.
2730 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2731 to 16 in 22.1 to make this a lesser problem. */
2732 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2734 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2735 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2737 while (s
< e
&& *s
!= '\n')
2742 overlay_strings_with_newlines
= 1;
2747 /* If position is within an overlay string, set up IT to the right
2749 if (pos
->overlay_string_index
>= 0)
2753 /* If the first overlay string happens to have a `display'
2754 property for an image, the iterator will be set up for that
2755 image, and we have to undo that setup first before we can
2756 correct the overlay string index. */
2757 if (it
->method
== GET_FROM_IMAGE
)
2760 /* We already have the first chunk of overlay strings in
2761 IT->overlay_strings. Load more until the one for
2762 pos->overlay_string_index is in IT->overlay_strings. */
2763 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2765 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2766 it
->current
.overlay_string_index
= 0;
2769 load_overlay_strings (it
, 0);
2770 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2774 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2775 relative_index
= (it
->current
.overlay_string_index
2776 % OVERLAY_STRING_CHUNK_SIZE
);
2777 it
->string
= it
->overlay_strings
[relative_index
];
2778 xassert (STRINGP (it
->string
));
2779 it
->current
.string_pos
= pos
->string_pos
;
2780 it
->method
= GET_FROM_STRING
;
2783 if (CHARPOS (pos
->string_pos
) >= 0)
2785 /* Recorded position is not in an overlay string, but in another
2786 string. This can only be a string from a `display' property.
2787 IT should already be filled with that string. */
2788 it
->current
.string_pos
= pos
->string_pos
;
2789 xassert (STRINGP (it
->string
));
2792 /* Restore position in display vector translations, control
2793 character translations or ellipses. */
2794 if (pos
->dpvec_index
>= 0)
2796 if (it
->dpvec
== NULL
)
2797 get_next_display_element (it
);
2798 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2799 it
->current
.dpvec_index
= pos
->dpvec_index
;
2803 return !overlay_strings_with_newlines
;
2807 /* Initialize IT for stepping through current_buffer in window W
2808 starting at ROW->start. */
2811 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2813 init_from_display_pos (it
, w
, &row
->start
);
2814 it
->start
= row
->start
;
2815 it
->continuation_lines_width
= row
->continuation_lines_width
;
2820 /* Initialize IT for stepping through current_buffer in window W
2821 starting in the line following ROW, i.e. starting at ROW->end.
2822 Value is zero if there are overlay strings with newlines at ROW's
2826 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2830 if (init_from_display_pos (it
, w
, &row
->end
))
2832 if (row
->continued_p
)
2833 it
->continuation_lines_width
2834 = row
->continuation_lines_width
+ row
->pixel_width
;
2845 /***********************************************************************
2847 ***********************************************************************/
2849 /* Called when IT reaches IT->stop_charpos. Handle text property and
2850 overlay changes. Set IT->stop_charpos to the next position where
2854 handle_stop (struct it
*it
)
2856 enum prop_handled handled
;
2857 int handle_overlay_change_p
;
2861 it
->current
.dpvec_index
= -1;
2862 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2863 it
->ignore_overlay_strings_at_pos_p
= 0;
2866 /* Use face of preceding text for ellipsis (if invisible) */
2867 if (it
->selective_display_ellipsis_p
)
2868 it
->saved_face_id
= it
->face_id
;
2872 handled
= HANDLED_NORMALLY
;
2874 /* Call text property handlers. */
2875 for (p
= it_props
; p
->handler
; ++p
)
2877 handled
= p
->handler (it
);
2879 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2881 else if (handled
== HANDLED_RETURN
)
2883 /* We still want to show before and after strings from
2884 overlays even if the actual buffer text is replaced. */
2885 if (!handle_overlay_change_p
2887 || !get_overlay_strings_1 (it
, 0, 0))
2890 setup_for_ellipsis (it
, 0);
2891 /* When handling a display spec, we might load an
2892 empty string. In that case, discard it here. We
2893 used to discard it in handle_single_display_spec,
2894 but that causes get_overlay_strings_1, above, to
2895 ignore overlay strings that we must check. */
2896 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2900 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2904 it
->ignore_overlay_strings_at_pos_p
= 1;
2905 it
->string_from_display_prop_p
= 0;
2906 handle_overlay_change_p
= 0;
2908 handled
= HANDLED_RECOMPUTE_PROPS
;
2911 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2912 handle_overlay_change_p
= 0;
2915 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2917 /* Don't check for overlay strings below when set to deliver
2918 characters from a display vector. */
2919 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2920 handle_overlay_change_p
= 0;
2922 /* Handle overlay changes.
2923 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2924 if it finds overlays. */
2925 if (handle_overlay_change_p
)
2926 handled
= handle_overlay_change (it
);
2931 setup_for_ellipsis (it
, 0);
2935 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2937 /* Determine where to stop next. */
2938 if (handled
== HANDLED_NORMALLY
)
2939 compute_stop_pos (it
);
2943 /* Compute IT->stop_charpos from text property and overlay change
2944 information for IT's current position. */
2947 compute_stop_pos (struct it
*it
)
2949 register INTERVAL iv
, next_iv
;
2950 Lisp_Object object
, limit
, position
;
2951 EMACS_INT charpos
, bytepos
;
2953 /* If nowhere else, stop at the end. */
2954 it
->stop_charpos
= it
->end_charpos
;
2956 if (STRINGP (it
->string
))
2958 /* Strings are usually short, so don't limit the search for
2960 object
= it
->string
;
2962 charpos
= IT_STRING_CHARPOS (*it
);
2963 bytepos
= IT_STRING_BYTEPOS (*it
);
2969 /* If next overlay change is in front of the current stop pos
2970 (which is IT->end_charpos), stop there. Note: value of
2971 next_overlay_change is point-max if no overlay change
2973 charpos
= IT_CHARPOS (*it
);
2974 bytepos
= IT_BYTEPOS (*it
);
2975 pos
= next_overlay_change (charpos
);
2976 if (pos
< it
->stop_charpos
)
2977 it
->stop_charpos
= pos
;
2979 /* If showing the region, we have to stop at the region
2980 start or end because the face might change there. */
2981 if (it
->region_beg_charpos
> 0)
2983 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2984 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2985 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2986 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2989 /* Set up variables for computing the stop position from text
2990 property changes. */
2991 XSETBUFFER (object
, current_buffer
);
2992 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2995 /* Get the interval containing IT's position. Value is a null
2996 interval if there isn't such an interval. */
2997 position
= make_number (charpos
);
2998 iv
= validate_interval_range (object
, &position
, &position
, 0);
2999 if (!NULL_INTERVAL_P (iv
))
3001 Lisp_Object values_here
[LAST_PROP_IDX
];
3004 /* Get properties here. */
3005 for (p
= it_props
; p
->handler
; ++p
)
3006 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3008 /* Look for an interval following iv that has different
3010 for (next_iv
= next_interval (iv
);
3011 (!NULL_INTERVAL_P (next_iv
)
3013 || XFASTINT (limit
) > next_iv
->position
));
3014 next_iv
= next_interval (next_iv
))
3016 for (p
= it_props
; p
->handler
; ++p
)
3018 Lisp_Object new_value
;
3020 new_value
= textget (next_iv
->plist
, *p
->name
);
3021 if (!EQ (values_here
[p
->idx
], new_value
))
3029 if (!NULL_INTERVAL_P (next_iv
))
3031 if (INTEGERP (limit
)
3032 && next_iv
->position
>= XFASTINT (limit
))
3033 /* No text property change up to limit. */
3034 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3036 /* Text properties change in next_iv. */
3037 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3041 if (it
->cmp_it
.id
< 0)
3043 EMACS_INT stoppos
= it
->end_charpos
;
3045 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3047 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3048 stoppos
, it
->string
);
3051 xassert (STRINGP (it
->string
)
3052 || (it
->stop_charpos
>= BEGV
3053 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3057 /* Return the position of the next overlay change after POS in
3058 current_buffer. Value is point-max if no overlay change
3059 follows. This is like `next-overlay-change' but doesn't use
3063 next_overlay_change (EMACS_INT pos
)
3067 Lisp_Object
*overlays
;
3070 /* Get all overlays at the given position. */
3071 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3073 /* If any of these overlays ends before endpos,
3074 use its ending point instead. */
3075 for (i
= 0; i
< noverlays
; ++i
)
3080 oend
= OVERLAY_END (overlays
[i
]);
3081 oendpos
= OVERLAY_POSITION (oend
);
3082 endpos
= min (endpos
, oendpos
);
3090 /***********************************************************************
3092 ***********************************************************************/
3094 /* Handle changes in the `fontified' property of the current buffer by
3095 calling hook functions from Qfontification_functions to fontify
3098 static enum prop_handled
3099 handle_fontified_prop (struct it
*it
)
3101 Lisp_Object prop
, pos
;
3102 enum prop_handled handled
= HANDLED_NORMALLY
;
3104 if (!NILP (Vmemory_full
))
3107 /* Get the value of the `fontified' property at IT's current buffer
3108 position. (The `fontified' property doesn't have a special
3109 meaning in strings.) If the value is nil, call functions from
3110 Qfontification_functions. */
3111 if (!STRINGP (it
->string
)
3113 && !NILP (Vfontification_functions
)
3114 && !NILP (Vrun_hooks
)
3115 && (pos
= make_number (IT_CHARPOS (*it
)),
3116 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3117 /* Ignore the special cased nil value always present at EOB since
3118 no amount of fontifying will be able to change it. */
3119 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3121 int count
= SPECPDL_INDEX ();
3123 struct buffer
*obuf
= current_buffer
;
3124 int begv
= BEGV
, zv
= ZV
;
3125 int old_clip_changed
= current_buffer
->clip_changed
;
3127 val
= Vfontification_functions
;
3128 specbind (Qfontification_functions
, Qnil
);
3130 xassert (it
->end_charpos
== ZV
);
3132 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3133 safe_call1 (val
, pos
);
3136 Lisp_Object fns
, fn
;
3137 struct gcpro gcpro1
, gcpro2
;
3142 for (; CONSP (val
); val
= XCDR (val
))
3148 /* A value of t indicates this hook has a local
3149 binding; it means to run the global binding too.
3150 In a global value, t should not occur. If it
3151 does, we must ignore it to avoid an endless
3153 for (fns
= Fdefault_value (Qfontification_functions
);
3159 safe_call1 (fn
, pos
);
3163 safe_call1 (fn
, pos
);
3169 unbind_to (count
, Qnil
);
3171 /* Fontification functions routinely call `save-restriction'.
3172 Normally, this tags clip_changed, which can confuse redisplay
3173 (see discussion in Bug#6671). Since we don't perform any
3174 special handling of fontification changes in the case where
3175 `save-restriction' isn't called, there's no point doing so in
3176 this case either. So, if the buffer's restrictions are
3177 actually left unchanged, reset clip_changed. */
3178 if (obuf
== current_buffer
)
3180 if (begv
== BEGV
&& zv
== ZV
)
3181 current_buffer
->clip_changed
= old_clip_changed
;
3183 /* There isn't much we can reasonably do to protect against
3184 misbehaving fontification, but here's a fig leaf. */
3185 else if (!NILP (BVAR (obuf
, name
)))
3186 set_buffer_internal_1 (obuf
);
3188 /* The fontification code may have added/removed text.
3189 It could do even a lot worse, but let's at least protect against
3190 the most obvious case where only the text past `pos' gets changed',
3191 as is/was done in grep.el where some escapes sequences are turned
3192 into face properties (bug#7876). */
3193 it
->end_charpos
= ZV
;
3195 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3196 something. This avoids an endless loop if they failed to
3197 fontify the text for which reason ever. */
3198 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3199 handled
= HANDLED_RECOMPUTE_PROPS
;
3207 /***********************************************************************
3209 ***********************************************************************/
3211 /* Set up iterator IT from face properties at its current position.
3212 Called from handle_stop. */
3214 static enum prop_handled
3215 handle_face_prop (struct it
*it
)
3218 EMACS_INT next_stop
;
3220 if (!STRINGP (it
->string
))
3223 = face_at_buffer_position (it
->w
,
3225 it
->region_beg_charpos
,
3226 it
->region_end_charpos
,
3229 + TEXT_PROP_DISTANCE_LIMIT
),
3230 0, it
->base_face_id
);
3232 /* Is this a start of a run of characters with box face?
3233 Caveat: this can be called for a freshly initialized
3234 iterator; face_id is -1 in this case. We know that the new
3235 face will not change until limit, i.e. if the new face has a
3236 box, all characters up to limit will have one. But, as
3237 usual, we don't know whether limit is really the end. */
3238 if (new_face_id
!= it
->face_id
)
3240 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3242 /* If new face has a box but old face has not, this is
3243 the start of a run of characters with box, i.e. it has
3244 a shadow on the left side. The value of face_id of the
3245 iterator will be -1 if this is the initial call that gets
3246 the face. In this case, we have to look in front of IT's
3247 position and see whether there is a face != new_face_id. */
3248 it
->start_of_box_run_p
3249 = (new_face
->box
!= FACE_NO_BOX
3250 && (it
->face_id
>= 0
3251 || IT_CHARPOS (*it
) == BEG
3252 || new_face_id
!= face_before_it_pos (it
)));
3253 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3261 Lisp_Object from_overlay
3262 = (it
->current
.overlay_string_index
>= 0
3263 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3266 /* See if we got to this string directly or indirectly from
3267 an overlay property. That includes the before-string or
3268 after-string of an overlay, strings in display properties
3269 provided by an overlay, their text properties, etc.
3271 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3272 if (! NILP (from_overlay
))
3273 for (i
= it
->sp
- 1; i
>= 0; i
--)
3275 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3277 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3278 else if (! NILP (it
->stack
[i
].from_overlay
))
3279 from_overlay
= it
->stack
[i
].from_overlay
;
3281 if (!NILP (from_overlay
))
3285 if (! NILP (from_overlay
))
3287 bufpos
= IT_CHARPOS (*it
);
3288 /* For a string from an overlay, the base face depends
3289 only on text properties and ignores overlays. */
3291 = face_for_overlay_string (it
->w
,
3293 it
->region_beg_charpos
,
3294 it
->region_end_charpos
,
3297 + TEXT_PROP_DISTANCE_LIMIT
),
3305 /* For strings from a `display' property, use the face at
3306 IT's current buffer position as the base face to merge
3307 with, so that overlay strings appear in the same face as
3308 surrounding text, unless they specify their own
3310 base_face_id
= underlying_face_id (it
);
3313 new_face_id
= face_at_string_position (it
->w
,
3315 IT_STRING_CHARPOS (*it
),
3317 it
->region_beg_charpos
,
3318 it
->region_end_charpos
,
3322 /* Is this a start of a run of characters with box? Caveat:
3323 this can be called for a freshly allocated iterator; face_id
3324 is -1 is this case. We know that the new face will not
3325 change until the next check pos, i.e. if the new face has a
3326 box, all characters up to that position will have a
3327 box. But, as usual, we don't know whether that position
3328 is really the end. */
3329 if (new_face_id
!= it
->face_id
)
3331 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3332 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3334 /* If new face has a box but old face hasn't, this is the
3335 start of a run of characters with box, i.e. it has a
3336 shadow on the left side. */
3337 it
->start_of_box_run_p
3338 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3339 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3343 it
->face_id
= new_face_id
;
3344 return HANDLED_NORMALLY
;
3348 /* Return the ID of the face ``underlying'' IT's current position,
3349 which is in a string. If the iterator is associated with a
3350 buffer, return the face at IT's current buffer position.
3351 Otherwise, use the iterator's base_face_id. */
3354 underlying_face_id (struct it
*it
)
3356 int face_id
= it
->base_face_id
, i
;
3358 xassert (STRINGP (it
->string
));
3360 for (i
= it
->sp
- 1; i
>= 0; --i
)
3361 if (NILP (it
->stack
[i
].string
))
3362 face_id
= it
->stack
[i
].face_id
;
3368 /* Compute the face one character before or after the current position
3369 of IT. BEFORE_P non-zero means get the face in front of IT's
3370 position. Value is the id of the face. */
3373 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3376 EMACS_INT next_check_charpos
;
3377 struct text_pos pos
;
3379 xassert (it
->s
== NULL
);
3381 if (STRINGP (it
->string
))
3386 /* No face change past the end of the string (for the case
3387 we are padding with spaces). No face change before the
3389 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3390 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3393 /* Set pos to the position before or after IT's current position. */
3395 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3397 /* For composition, we must check the character after the
3399 pos
= (it
->what
== IT_COMPOSITION
3400 ? string_pos (IT_STRING_CHARPOS (*it
)
3401 + it
->cmp_it
.nchars
, it
->string
)
3402 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3404 if (it
->current
.overlay_string_index
>= 0)
3405 bufpos
= IT_CHARPOS (*it
);
3409 base_face_id
= underlying_face_id (it
);
3411 /* Get the face for ASCII, or unibyte. */
3412 face_id
= face_at_string_position (it
->w
,
3416 it
->region_beg_charpos
,
3417 it
->region_end_charpos
,
3418 &next_check_charpos
,
3421 /* Correct the face for charsets different from ASCII. Do it
3422 for the multibyte case only. The face returned above is
3423 suitable for unibyte text if IT->string is unibyte. */
3424 if (STRING_MULTIBYTE (it
->string
))
3426 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3428 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3430 c
= string_char_and_length (p
, &len
);
3431 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3436 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3437 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3440 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3441 pos
= it
->current
.pos
;
3444 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3447 if (it
->what
== IT_COMPOSITION
)
3448 /* For composition, we must check the position after the
3450 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3452 INC_TEXT_POS (pos
, it
->multibyte_p
);
3455 /* Determine face for CHARSET_ASCII, or unibyte. */
3456 face_id
= face_at_buffer_position (it
->w
,
3458 it
->region_beg_charpos
,
3459 it
->region_end_charpos
,
3460 &next_check_charpos
,
3463 /* Correct the face for charsets different from ASCII. Do it
3464 for the multibyte case only. The face returned above is
3465 suitable for unibyte text if current_buffer is unibyte. */
3466 if (it
->multibyte_p
)
3468 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3469 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3470 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3479 /***********************************************************************
3481 ***********************************************************************/
3483 /* Set up iterator IT from invisible properties at its current
3484 position. Called from handle_stop. */
3486 static enum prop_handled
3487 handle_invisible_prop (struct it
*it
)
3489 enum prop_handled handled
= HANDLED_NORMALLY
;
3491 if (STRINGP (it
->string
))
3493 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3495 /* Get the value of the invisible text property at the
3496 current position. Value will be nil if there is no such
3498 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3499 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3502 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3504 handled
= HANDLED_RECOMPUTE_PROPS
;
3506 /* Get the position at which the next change of the
3507 invisible text property can be found in IT->string.
3508 Value will be nil if the property value is the same for
3509 all the rest of IT->string. */
3510 XSETINT (limit
, SCHARS (it
->string
));
3511 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3514 /* Text at current position is invisible. The next
3515 change in the property is at position end_charpos.
3516 Move IT's current position to that position. */
3517 if (INTEGERP (end_charpos
)
3518 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3520 struct text_pos old
;
3521 old
= it
->current
.string_pos
;
3522 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3523 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3527 /* The rest of the string is invisible. If this is an
3528 overlay string, proceed with the next overlay string
3529 or whatever comes and return a character from there. */
3530 if (it
->current
.overlay_string_index
>= 0)
3532 next_overlay_string (it
);
3533 /* Don't check for overlay strings when we just
3534 finished processing them. */
3535 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3539 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3540 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3548 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3549 Lisp_Object pos
, prop
, overlay
;
3551 /* First of all, is there invisible text at this position? */
3552 tem
= start_charpos
= IT_CHARPOS (*it
);
3553 pos
= make_number (tem
);
3554 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3556 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3558 /* If we are on invisible text, skip over it. */
3559 if (invis_p
&& start_charpos
< it
->end_charpos
)
3561 /* Record whether we have to display an ellipsis for the
3563 int display_ellipsis_p
= invis_p
== 2;
3565 handled
= HANDLED_RECOMPUTE_PROPS
;
3567 /* Loop skipping over invisible text. The loop is left at
3568 ZV or with IT on the first char being visible again. */
3571 /* Try to skip some invisible text. Return value is the
3572 position reached which can be equal to where we start
3573 if there is nothing invisible there. This skips both
3574 over invisible text properties and overlays with
3575 invisible property. */
3576 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3578 /* If we skipped nothing at all we weren't at invisible
3579 text in the first place. If everything to the end of
3580 the buffer was skipped, end the loop. */
3581 if (newpos
== tem
|| newpos
>= ZV
)
3585 /* We skipped some characters but not necessarily
3586 all there are. Check if we ended up on visible
3587 text. Fget_char_property returns the property of
3588 the char before the given position, i.e. if we
3589 get invis_p = 0, this means that the char at
3590 newpos is visible. */
3591 pos
= make_number (newpos
);
3592 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3593 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3596 /* If we ended up on invisible text, proceed to
3597 skip starting with next_stop. */
3601 /* If there are adjacent invisible texts, don't lose the
3602 second one's ellipsis. */
3604 display_ellipsis_p
= 1;
3608 /* The position newpos is now either ZV or on visible text. */
3609 if (it
->bidi_p
&& newpos
< ZV
)
3611 /* With bidi iteration, the region of invisible text
3612 could start and/or end in the middle of a non-base
3613 embedding level. Therefore, we need to skip
3614 invisible text using the bidi iterator, starting at
3615 IT's current position, until we find ourselves
3616 outside the invisible text. Skipping invisible text
3617 _after_ bidi iteration avoids affecting the visual
3618 order of the displayed text when invisible properties
3619 are added or removed. */
3620 if (it
->bidi_it
.first_elt
)
3622 /* If we were `reseat'ed to a new paragraph,
3623 determine the paragraph base direction. We need
3624 to do it now because next_element_from_buffer may
3625 not have a chance to do it, if we are going to
3626 skip any text at the beginning, which resets the
3628 bidi_paragraph_init (it
->paragraph_embedding
,
3633 bidi_move_to_visually_next (&it
->bidi_it
);
3635 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3636 && it
->bidi_it
.charpos
< newpos
);
3637 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3638 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3639 /* If we overstepped NEWPOS, record its position in the
3640 iterator, so that we skip invisible text if later the
3641 bidi iteration lands us in the invisible region
3643 if (IT_CHARPOS (*it
) >= newpos
)
3644 it
->prev_stop
= newpos
;
3648 IT_CHARPOS (*it
) = newpos
;
3649 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3652 /* If there are before-strings at the start of invisible
3653 text, and the text is invisible because of a text
3654 property, arrange to show before-strings because 20.x did
3655 it that way. (If the text is invisible because of an
3656 overlay property instead of a text property, this is
3657 already handled in the overlay code.) */
3659 && get_overlay_strings (it
, it
->stop_charpos
))
3661 handled
= HANDLED_RECOMPUTE_PROPS
;
3662 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3664 else if (display_ellipsis_p
)
3666 /* Make sure that the glyphs of the ellipsis will get
3667 correct `charpos' values. If we would not update
3668 it->position here, the glyphs would belong to the
3669 last visible character _before_ the invisible
3670 text, which confuses `set_cursor_from_row'.
3672 We use the last invisible position instead of the
3673 first because this way the cursor is always drawn on
3674 the first "." of the ellipsis, whenever PT is inside
3675 the invisible text. Otherwise the cursor would be
3676 placed _after_ the ellipsis when the point is after the
3677 first invisible character. */
3678 if (!STRINGP (it
->object
))
3680 it
->position
.charpos
= newpos
- 1;
3681 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3684 /* Let the ellipsis display before
3685 considering any properties of the following char.
3686 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3687 handled
= HANDLED_RETURN
;
3696 /* Make iterator IT return `...' next.
3697 Replaces LEN characters from buffer. */
3700 setup_for_ellipsis (struct it
*it
, int len
)
3702 /* Use the display table definition for `...'. Invalid glyphs
3703 will be handled by the method returning elements from dpvec. */
3704 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3706 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3707 it
->dpvec
= v
->contents
;
3708 it
->dpend
= v
->contents
+ v
->size
;
3712 /* Default `...'. */
3713 it
->dpvec
= default_invis_vector
;
3714 it
->dpend
= default_invis_vector
+ 3;
3717 it
->dpvec_char_len
= len
;
3718 it
->current
.dpvec_index
= 0;
3719 it
->dpvec_face_id
= -1;
3721 /* Remember the current face id in case glyphs specify faces.
3722 IT's face is restored in set_iterator_to_next.
3723 saved_face_id was set to preceding char's face in handle_stop. */
3724 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3725 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3727 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3733 /***********************************************************************
3735 ***********************************************************************/
3737 /* Set up iterator IT from `display' property at its current position.
3738 Called from handle_stop.
3739 We return HANDLED_RETURN if some part of the display property
3740 overrides the display of the buffer text itself.
3741 Otherwise we return HANDLED_NORMALLY. */
3743 static enum prop_handled
3744 handle_display_prop (struct it
*it
)
3746 Lisp_Object prop
, object
, overlay
;
3747 struct text_pos
*position
;
3748 /* Nonzero if some property replaces the display of the text itself. */
3749 int display_replaced_p
= 0;
3751 if (STRINGP (it
->string
))
3753 object
= it
->string
;
3754 position
= &it
->current
.string_pos
;
3758 XSETWINDOW (object
, it
->w
);
3759 position
= &it
->current
.pos
;
3762 /* Reset those iterator values set from display property values. */
3763 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3764 it
->space_width
= Qnil
;
3765 it
->font_height
= Qnil
;
3768 /* We don't support recursive `display' properties, i.e. string
3769 values that have a string `display' property, that have a string
3770 `display' property etc. */
3771 if (!it
->string_from_display_prop_p
)
3772 it
->area
= TEXT_AREA
;
3774 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3775 Qdisplay
, object
, &overlay
);
3777 return HANDLED_NORMALLY
;
3778 /* Now OVERLAY is the overlay that gave us this property, or nil
3779 if it was a text property. */
3781 if (!STRINGP (it
->string
))
3782 object
= it
->w
->buffer
;
3785 /* Simple properties. */
3786 && !EQ (XCAR (prop
), Qimage
)
3787 && !EQ (XCAR (prop
), Qspace
)
3788 && !EQ (XCAR (prop
), Qwhen
)
3789 && !EQ (XCAR (prop
), Qslice
)
3790 && !EQ (XCAR (prop
), Qspace_width
)
3791 && !EQ (XCAR (prop
), Qheight
)
3792 && !EQ (XCAR (prop
), Qraise
)
3793 /* Marginal area specifications. */
3794 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3795 && !EQ (XCAR (prop
), Qleft_fringe
)
3796 && !EQ (XCAR (prop
), Qright_fringe
)
3797 && !NILP (XCAR (prop
)))
3799 for (; CONSP (prop
); prop
= XCDR (prop
))
3801 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3802 position
, display_replaced_p
))
3804 display_replaced_p
= 1;
3805 /* If some text in a string is replaced, `position' no
3806 longer points to the position of `object'. */
3807 if (STRINGP (object
))
3812 else if (VECTORP (prop
))
3815 for (i
= 0; i
< ASIZE (prop
); ++i
)
3816 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3817 position
, display_replaced_p
))
3819 display_replaced_p
= 1;
3820 /* If some text in a string is replaced, `position' no
3821 longer points to the position of `object'. */
3822 if (STRINGP (object
))
3828 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3830 display_replaced_p
= 1;
3833 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3837 /* Value is the position of the end of the `display' property starting
3838 at START_POS in OBJECT. */
3840 static struct text_pos
3841 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3844 struct text_pos end_pos
;
3846 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3847 Qdisplay
, object
, Qnil
);
3848 CHARPOS (end_pos
) = XFASTINT (end
);
3849 if (STRINGP (object
))
3850 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3852 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3858 /* Set up IT from a single `display' specification PROP. OBJECT
3859 is the object in which the `display' property was found. *POSITION
3860 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3861 means that we previously saw a display specification which already
3862 replaced text display with something else, for example an image;
3863 we ignore such properties after the first one has been processed.
3865 OVERLAY is the overlay this `display' property came from,
3866 or nil if it was a text property.
3868 If PROP is a `space' or `image' specification, and in some other
3869 cases too, set *POSITION to the position where the `display'
3872 Value is non-zero if something was found which replaces the display
3873 of buffer or string text. */
3876 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3877 Lisp_Object overlay
, struct text_pos
*position
,
3878 int display_replaced_before_p
)
3881 Lisp_Object location
, value
;
3882 struct text_pos start_pos
, save_pos
;
3885 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3886 If the result is non-nil, use VALUE instead of SPEC. */
3888 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3897 if (!NILP (form
) && !EQ (form
, Qt
))
3899 int count
= SPECPDL_INDEX ();
3900 struct gcpro gcpro1
;
3902 /* Bind `object' to the object having the `display' property, a
3903 buffer or string. Bind `position' to the position in the
3904 object where the property was found, and `buffer-position'
3905 to the current position in the buffer. */
3906 specbind (Qobject
, object
);
3907 specbind (Qposition
, make_number (CHARPOS (*position
)));
3908 specbind (Qbuffer_position
,
3909 make_number (STRINGP (object
)
3910 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3912 form
= safe_eval (form
);
3914 unbind_to (count
, Qnil
);
3920 /* Handle `(height HEIGHT)' specifications. */
3922 && EQ (XCAR (spec
), Qheight
)
3923 && CONSP (XCDR (spec
)))
3925 if (!FRAME_WINDOW_P (it
->f
))
3928 it
->font_height
= XCAR (XCDR (spec
));
3929 if (!NILP (it
->font_height
))
3931 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3932 int new_height
= -1;
3934 if (CONSP (it
->font_height
)
3935 && (EQ (XCAR (it
->font_height
), Qplus
)
3936 || EQ (XCAR (it
->font_height
), Qminus
))
3937 && CONSP (XCDR (it
->font_height
))
3938 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3940 /* `(+ N)' or `(- N)' where N is an integer. */
3941 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3942 if (EQ (XCAR (it
->font_height
), Qplus
))
3944 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3946 else if (FUNCTIONP (it
->font_height
))
3948 /* Call function with current height as argument.
3949 Value is the new height. */
3951 height
= safe_call1 (it
->font_height
,
3952 face
->lface
[LFACE_HEIGHT_INDEX
]);
3953 if (NUMBERP (height
))
3954 new_height
= XFLOATINT (height
);
3956 else if (NUMBERP (it
->font_height
))
3958 /* Value is a multiple of the canonical char height. */
3961 f
= FACE_FROM_ID (it
->f
,
3962 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3963 new_height
= (XFLOATINT (it
->font_height
)
3964 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
3968 /* Evaluate IT->font_height with `height' bound to the
3969 current specified height to get the new height. */
3970 int count
= SPECPDL_INDEX ();
3972 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3973 value
= safe_eval (it
->font_height
);
3974 unbind_to (count
, Qnil
);
3976 if (NUMBERP (value
))
3977 new_height
= XFLOATINT (value
);
3981 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
3987 /* Handle `(space-width WIDTH)'. */
3989 && EQ (XCAR (spec
), Qspace_width
)
3990 && CONSP (XCDR (spec
)))
3992 if (!FRAME_WINDOW_P (it
->f
))
3995 value
= XCAR (XCDR (spec
));
3996 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
3997 it
->space_width
= value
;
4002 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4004 && EQ (XCAR (spec
), Qslice
))
4008 if (!FRAME_WINDOW_P (it
->f
))
4011 if (tem
= XCDR (spec
), CONSP (tem
))
4013 it
->slice
.x
= XCAR (tem
);
4014 if (tem
= XCDR (tem
), CONSP (tem
))
4016 it
->slice
.y
= XCAR (tem
);
4017 if (tem
= XCDR (tem
), CONSP (tem
))
4019 it
->slice
.width
= XCAR (tem
);
4020 if (tem
= XCDR (tem
), CONSP (tem
))
4021 it
->slice
.height
= XCAR (tem
);
4029 /* Handle `(raise FACTOR)'. */
4031 && EQ (XCAR (spec
), Qraise
)
4032 && CONSP (XCDR (spec
)))
4034 if (!FRAME_WINDOW_P (it
->f
))
4037 #ifdef HAVE_WINDOW_SYSTEM
4038 value
= XCAR (XCDR (spec
));
4039 if (NUMBERP (value
))
4041 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4042 it
->voffset
= - (XFLOATINT (value
)
4043 * (FONT_HEIGHT (face
->font
)));
4045 #endif /* HAVE_WINDOW_SYSTEM */
4050 /* Don't handle the other kinds of display specifications
4051 inside a string that we got from a `display' property. */
4052 if (it
->string_from_display_prop_p
)
4055 /* Characters having this form of property are not displayed, so
4056 we have to find the end of the property. */
4057 start_pos
= *position
;
4058 *position
= display_prop_end (it
, object
, start_pos
);
4061 /* Stop the scan at that end position--we assume that all
4062 text properties change there. */
4063 it
->stop_charpos
= position
->charpos
;
4065 /* Handle `(left-fringe BITMAP [FACE])'
4066 and `(right-fringe BITMAP [FACE])'. */
4068 && (EQ (XCAR (spec
), Qleft_fringe
)
4069 || EQ (XCAR (spec
), Qright_fringe
))
4070 && CONSP (XCDR (spec
)))
4072 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4075 if (!FRAME_WINDOW_P (it
->f
))
4076 /* If we return here, POSITION has been advanced
4077 across the text with this property. */
4080 #ifdef HAVE_WINDOW_SYSTEM
4081 value
= XCAR (XCDR (spec
));
4082 if (!SYMBOLP (value
)
4083 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4084 /* If we return here, POSITION has been advanced
4085 across the text with this property. */
4088 if (CONSP (XCDR (XCDR (spec
))))
4090 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4091 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4097 /* Save current settings of IT so that we can restore them
4098 when we are finished with the glyph property value. */
4100 save_pos
= it
->position
;
4101 it
->position
= *position
;
4103 it
->position
= save_pos
;
4105 it
->area
= TEXT_AREA
;
4106 it
->what
= IT_IMAGE
;
4107 it
->image_id
= -1; /* no image */
4108 it
->position
= start_pos
;
4109 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4110 it
->method
= GET_FROM_IMAGE
;
4111 it
->from_overlay
= Qnil
;
4112 it
->face_id
= face_id
;
4114 /* Say that we haven't consumed the characters with
4115 `display' property yet. The call to pop_it in
4116 set_iterator_to_next will clean this up. */
4117 *position
= start_pos
;
4119 if (EQ (XCAR (spec
), Qleft_fringe
))
4121 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4122 it
->left_user_fringe_face_id
= face_id
;
4126 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4127 it
->right_user_fringe_face_id
= face_id
;
4129 #endif /* HAVE_WINDOW_SYSTEM */
4133 /* Prepare to handle `((margin left-margin) ...)',
4134 `((margin right-margin) ...)' and `((margin nil) ...)'
4135 prefixes for display specifications. */
4136 location
= Qunbound
;
4137 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4141 value
= XCDR (spec
);
4143 value
= XCAR (value
);
4146 if (EQ (XCAR (tem
), Qmargin
)
4147 && (tem
= XCDR (tem
),
4148 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4150 || EQ (tem
, Qleft_margin
)
4151 || EQ (tem
, Qright_margin
))))
4155 if (EQ (location
, Qunbound
))
4161 /* After this point, VALUE is the property after any
4162 margin prefix has been stripped. It must be a string,
4163 an image specification, or `(space ...)'.
4165 LOCATION specifies where to display: `left-margin',
4166 `right-margin' or nil. */
4168 valid_p
= (STRINGP (value
)
4169 #ifdef HAVE_WINDOW_SYSTEM
4170 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4171 #endif /* not HAVE_WINDOW_SYSTEM */
4172 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4174 if (valid_p
&& !display_replaced_before_p
)
4176 /* Save current settings of IT so that we can restore them
4177 when we are finished with the glyph property value. */
4178 save_pos
= it
->position
;
4179 it
->position
= *position
;
4181 it
->position
= save_pos
;
4182 it
->from_overlay
= overlay
;
4184 if (NILP (location
))
4185 it
->area
= TEXT_AREA
;
4186 else if (EQ (location
, Qleft_margin
))
4187 it
->area
= LEFT_MARGIN_AREA
;
4189 it
->area
= RIGHT_MARGIN_AREA
;
4191 if (STRINGP (value
))
4194 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4195 it
->current
.overlay_string_index
= -1;
4196 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4197 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4198 it
->method
= GET_FROM_STRING
;
4199 it
->stop_charpos
= 0;
4200 it
->string_from_display_prop_p
= 1;
4201 /* Say that we haven't consumed the characters with
4202 `display' property yet. The call to pop_it in
4203 set_iterator_to_next will clean this up. */
4204 if (BUFFERP (object
))
4205 *position
= start_pos
;
4207 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4209 it
->method
= GET_FROM_STRETCH
;
4211 *position
= it
->position
= start_pos
;
4213 #ifdef HAVE_WINDOW_SYSTEM
4216 it
->what
= IT_IMAGE
;
4217 it
->image_id
= lookup_image (it
->f
, value
);
4218 it
->position
= start_pos
;
4219 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4220 it
->method
= GET_FROM_IMAGE
;
4222 /* Say that we haven't consumed the characters with
4223 `display' property yet. The call to pop_it in
4224 set_iterator_to_next will clean this up. */
4225 *position
= start_pos
;
4227 #endif /* HAVE_WINDOW_SYSTEM */
4232 /* Invalid property or property not supported. Restore
4233 POSITION to what it was before. */
4234 *position
= start_pos
;
4239 /* Check if SPEC is a display sub-property value whose text should be
4240 treated as intangible. */
4243 single_display_spec_intangible_p (Lisp_Object prop
)
4245 /* Skip over `when FORM'. */
4246 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4260 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4261 we don't need to treat text as intangible. */
4262 if (EQ (XCAR (prop
), Qmargin
))
4270 || EQ (XCAR (prop
), Qleft_margin
)
4271 || EQ (XCAR (prop
), Qright_margin
))
4275 return (CONSP (prop
)
4276 && (EQ (XCAR (prop
), Qimage
)
4277 || EQ (XCAR (prop
), Qspace
)));
4281 /* Check if PROP is a display property value whose text should be
4282 treated as intangible. */
4285 display_prop_intangible_p (Lisp_Object prop
)
4288 && CONSP (XCAR (prop
))
4289 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4291 /* A list of sub-properties. */
4292 while (CONSP (prop
))
4294 if (single_display_spec_intangible_p (XCAR (prop
)))
4299 else if (VECTORP (prop
))
4301 /* A vector of sub-properties. */
4303 for (i
= 0; i
< ASIZE (prop
); ++i
)
4304 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4308 return single_display_spec_intangible_p (prop
);
4314 /* Return 1 if PROP is a display sub-property value containing STRING. */
4317 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4319 if (EQ (string
, prop
))
4322 /* Skip over `when FORM'. */
4323 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4332 /* Skip over `margin LOCATION'. */
4333 if (EQ (XCAR (prop
), Qmargin
))
4344 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4348 /* Return 1 if STRING appears in the `display' property PROP. */
4351 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4354 && CONSP (XCAR (prop
))
4355 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4357 /* A list of sub-properties. */
4358 while (CONSP (prop
))
4360 if (single_display_spec_string_p (XCAR (prop
), string
))
4365 else if (VECTORP (prop
))
4367 /* A vector of sub-properties. */
4369 for (i
= 0; i
< ASIZE (prop
); ++i
)
4370 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4374 return single_display_spec_string_p (prop
, string
);
4379 /* Look for STRING in overlays and text properties in the current
4380 buffer, between character positions FROM and TO (excluding TO).
4381 BACK_P non-zero means look back (in this case, TO is supposed to be
4383 Value is the first character position where STRING was found, or
4384 zero if it wasn't found before hitting TO.
4386 This function may only use code that doesn't eval because it is
4387 called asynchronously from note_mouse_highlight. */
4390 string_buffer_position_lim (Lisp_Object string
,
4391 EMACS_INT from
, EMACS_INT to
, int back_p
)
4393 Lisp_Object limit
, prop
, pos
;
4396 pos
= make_number (from
);
4398 if (!back_p
) /* looking forward */
4400 limit
= make_number (min (to
, ZV
));
4401 while (!found
&& !EQ (pos
, limit
))
4403 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4404 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4407 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4411 else /* looking back */
4413 limit
= make_number (max (to
, BEGV
));
4414 while (!found
&& !EQ (pos
, limit
))
4416 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4417 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4420 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4425 return found
? XINT (pos
) : 0;
4428 /* Determine which buffer position in current buffer STRING comes from.
4429 AROUND_CHARPOS is an approximate position where it could come from.
4430 Value is the buffer position or 0 if it couldn't be determined.
4432 This function is necessary because we don't record buffer positions
4433 in glyphs generated from strings (to keep struct glyph small).
4434 This function may only use code that doesn't eval because it is
4435 called asynchronously from note_mouse_highlight. */
4438 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4440 const int MAX_DISTANCE
= 1000;
4441 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4442 around_charpos
+ MAX_DISTANCE
,
4446 found
= string_buffer_position_lim (string
, around_charpos
,
4447 around_charpos
- MAX_DISTANCE
, 1);
4453 /***********************************************************************
4454 `composition' property
4455 ***********************************************************************/
4457 /* Set up iterator IT from `composition' property at its current
4458 position. Called from handle_stop. */
4460 static enum prop_handled
4461 handle_composition_prop (struct it
*it
)
4463 Lisp_Object prop
, string
;
4464 EMACS_INT pos
, pos_byte
, start
, end
;
4466 if (STRINGP (it
->string
))
4470 pos
= IT_STRING_CHARPOS (*it
);
4471 pos_byte
= IT_STRING_BYTEPOS (*it
);
4472 string
= it
->string
;
4473 s
= SDATA (string
) + pos_byte
;
4474 it
->c
= STRING_CHAR (s
);
4478 pos
= IT_CHARPOS (*it
);
4479 pos_byte
= IT_BYTEPOS (*it
);
4481 it
->c
= FETCH_CHAR (pos_byte
);
4484 /* If there's a valid composition and point is not inside of the
4485 composition (in the case that the composition is from the current
4486 buffer), draw a glyph composed from the composition components. */
4487 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4488 && COMPOSITION_VALID_P (start
, end
, prop
)
4489 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4493 if (STRINGP (it
->string
))
4494 pos_byte
= string_char_to_byte (it
->string
, start
);
4496 pos_byte
= CHAR_TO_BYTE (start
);
4498 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4501 if (it
->cmp_it
.id
>= 0)
4504 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4505 it
->cmp_it
.nglyphs
= -1;
4509 return HANDLED_NORMALLY
;
4514 /***********************************************************************
4516 ***********************************************************************/
4518 /* The following structure is used to record overlay strings for
4519 later sorting in load_overlay_strings. */
4521 struct overlay_entry
4523 Lisp_Object overlay
;
4530 /* Set up iterator IT from overlay strings at its current position.
4531 Called from handle_stop. */
4533 static enum prop_handled
4534 handle_overlay_change (struct it
*it
)
4536 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4537 return HANDLED_RECOMPUTE_PROPS
;
4539 return HANDLED_NORMALLY
;
4543 /* Set up the next overlay string for delivery by IT, if there is an
4544 overlay string to deliver. Called by set_iterator_to_next when the
4545 end of the current overlay string is reached. If there are more
4546 overlay strings to display, IT->string and
4547 IT->current.overlay_string_index are set appropriately here.
4548 Otherwise IT->string is set to nil. */
4551 next_overlay_string (struct it
*it
)
4553 ++it
->current
.overlay_string_index
;
4554 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4556 /* No more overlay strings. Restore IT's settings to what
4557 they were before overlay strings were processed, and
4558 continue to deliver from current_buffer. */
4560 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4563 || (NILP (it
->string
)
4564 && it
->method
== GET_FROM_BUFFER
4565 && it
->stop_charpos
>= BEGV
4566 && it
->stop_charpos
<= it
->end_charpos
));
4567 it
->current
.overlay_string_index
= -1;
4568 it
->n_overlay_strings
= 0;
4569 it
->overlay_strings_charpos
= -1;
4571 /* If we're at the end of the buffer, record that we have
4572 processed the overlay strings there already, so that
4573 next_element_from_buffer doesn't try it again. */
4574 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4575 it
->overlay_strings_at_end_processed_p
= 1;
4579 /* There are more overlay strings to process. If
4580 IT->current.overlay_string_index has advanced to a position
4581 where we must load IT->overlay_strings with more strings, do
4582 it. We must load at the IT->overlay_strings_charpos where
4583 IT->n_overlay_strings was originally computed; when invisible
4584 text is present, this might not be IT_CHARPOS (Bug#7016). */
4585 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4587 if (it
->current
.overlay_string_index
&& i
== 0)
4588 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4590 /* Initialize IT to deliver display elements from the overlay
4592 it
->string
= it
->overlay_strings
[i
];
4593 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4594 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4595 it
->method
= GET_FROM_STRING
;
4596 it
->stop_charpos
= 0;
4597 if (it
->cmp_it
.stop_pos
>= 0)
4598 it
->cmp_it
.stop_pos
= 0;
4605 /* Compare two overlay_entry structures E1 and E2. Used as a
4606 comparison function for qsort in load_overlay_strings. Overlay
4607 strings for the same position are sorted so that
4609 1. All after-strings come in front of before-strings, except
4610 when they come from the same overlay.
4612 2. Within after-strings, strings are sorted so that overlay strings
4613 from overlays with higher priorities come first.
4615 2. Within before-strings, strings are sorted so that overlay
4616 strings from overlays with higher priorities come last.
4618 Value is analogous to strcmp. */
4622 compare_overlay_entries (const void *e1
, const void *e2
)
4624 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4625 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4628 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4630 /* Let after-strings appear in front of before-strings if
4631 they come from different overlays. */
4632 if (EQ (entry1
->overlay
, entry2
->overlay
))
4633 result
= entry1
->after_string_p
? 1 : -1;
4635 result
= entry1
->after_string_p
? -1 : 1;
4637 else if (entry1
->after_string_p
)
4638 /* After-strings sorted in order of decreasing priority. */
4639 result
= entry2
->priority
- entry1
->priority
;
4641 /* Before-strings sorted in order of increasing priority. */
4642 result
= entry1
->priority
- entry2
->priority
;
4648 /* Load the vector IT->overlay_strings with overlay strings from IT's
4649 current buffer position, or from CHARPOS if that is > 0. Set
4650 IT->n_overlays to the total number of overlay strings found.
4652 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4653 a time. On entry into load_overlay_strings,
4654 IT->current.overlay_string_index gives the number of overlay
4655 strings that have already been loaded by previous calls to this
4658 IT->add_overlay_start contains an additional overlay start
4659 position to consider for taking overlay strings from, if non-zero.
4660 This position comes into play when the overlay has an `invisible'
4661 property, and both before and after-strings. When we've skipped to
4662 the end of the overlay, because of its `invisible' property, we
4663 nevertheless want its before-string to appear.
4664 IT->add_overlay_start will contain the overlay start position
4667 Overlay strings are sorted so that after-string strings come in
4668 front of before-string strings. Within before and after-strings,
4669 strings are sorted by overlay priority. See also function
4670 compare_overlay_entries. */
4673 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4675 Lisp_Object overlay
, window
, str
, invisible
;
4676 struct Lisp_Overlay
*ov
;
4677 EMACS_INT start
, end
;
4679 int n
= 0, i
, j
, invis_p
;
4680 struct overlay_entry
*entries
4681 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4684 charpos
= IT_CHARPOS (*it
);
4686 /* Append the overlay string STRING of overlay OVERLAY to vector
4687 `entries' which has size `size' and currently contains `n'
4688 elements. AFTER_P non-zero means STRING is an after-string of
4690 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4693 Lisp_Object priority; \
4697 int new_size = 2 * size; \
4698 struct overlay_entry *old = entries; \
4700 (struct overlay_entry *) alloca (new_size \
4701 * sizeof *entries); \
4702 memcpy (entries, old, size * sizeof *entries); \
4706 entries[n].string = (STRING); \
4707 entries[n].overlay = (OVERLAY); \
4708 priority = Foverlay_get ((OVERLAY), Qpriority); \
4709 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4710 entries[n].after_string_p = (AFTER_P); \
4715 /* Process overlay before the overlay center. */
4716 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4718 XSETMISC (overlay
, ov
);
4719 xassert (OVERLAYP (overlay
));
4720 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4721 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4726 /* Skip this overlay if it doesn't start or end at IT's current
4728 if (end
!= charpos
&& start
!= charpos
)
4731 /* Skip this overlay if it doesn't apply to IT->w. */
4732 window
= Foverlay_get (overlay
, Qwindow
);
4733 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4736 /* If the text ``under'' the overlay is invisible, both before-
4737 and after-strings from this overlay are visible; start and
4738 end position are indistinguishable. */
4739 invisible
= Foverlay_get (overlay
, Qinvisible
);
4740 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4742 /* If overlay has a non-empty before-string, record it. */
4743 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4744 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4746 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4748 /* If overlay has a non-empty after-string, record it. */
4749 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4750 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4752 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4755 /* Process overlays after the overlay center. */
4756 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4758 XSETMISC (overlay
, ov
);
4759 xassert (OVERLAYP (overlay
));
4760 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4761 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4763 if (start
> charpos
)
4766 /* Skip this overlay if it doesn't start or end at IT's current
4768 if (end
!= charpos
&& start
!= charpos
)
4771 /* Skip this overlay if it doesn't apply to IT->w. */
4772 window
= Foverlay_get (overlay
, Qwindow
);
4773 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4776 /* If the text ``under'' the overlay is invisible, it has a zero
4777 dimension, and both before- and after-strings apply. */
4778 invisible
= Foverlay_get (overlay
, Qinvisible
);
4779 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4781 /* If overlay has a non-empty before-string, record it. */
4782 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4783 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4785 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4787 /* If overlay has a non-empty after-string, record it. */
4788 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4789 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4791 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4794 #undef RECORD_OVERLAY_STRING
4798 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4800 /* Record number of overlay strings, and where we computed it. */
4801 it
->n_overlay_strings
= n
;
4802 it
->overlay_strings_charpos
= charpos
;
4804 /* IT->current.overlay_string_index is the number of overlay strings
4805 that have already been consumed by IT. Copy some of the
4806 remaining overlay strings to IT->overlay_strings. */
4808 j
= it
->current
.overlay_string_index
;
4809 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4811 it
->overlay_strings
[i
] = entries
[j
].string
;
4812 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4819 /* Get the first chunk of overlay strings at IT's current buffer
4820 position, or at CHARPOS if that is > 0. Value is non-zero if at
4821 least one overlay string was found. */
4824 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4826 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4827 process. This fills IT->overlay_strings with strings, and sets
4828 IT->n_overlay_strings to the total number of strings to process.
4829 IT->pos.overlay_string_index has to be set temporarily to zero
4830 because load_overlay_strings needs this; it must be set to -1
4831 when no overlay strings are found because a zero value would
4832 indicate a position in the first overlay string. */
4833 it
->current
.overlay_string_index
= 0;
4834 load_overlay_strings (it
, charpos
);
4836 /* If we found overlay strings, set up IT to deliver display
4837 elements from the first one. Otherwise set up IT to deliver
4838 from current_buffer. */
4839 if (it
->n_overlay_strings
)
4841 /* Make sure we know settings in current_buffer, so that we can
4842 restore meaningful values when we're done with the overlay
4845 compute_stop_pos (it
);
4846 xassert (it
->face_id
>= 0);
4848 /* Save IT's settings. They are restored after all overlay
4849 strings have been processed. */
4850 xassert (!compute_stop_p
|| it
->sp
== 0);
4852 /* When called from handle_stop, there might be an empty display
4853 string loaded. In that case, don't bother saving it. */
4854 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4857 /* Set up IT to deliver display elements from the first overlay
4859 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4860 it
->string
= it
->overlay_strings
[0];
4861 it
->from_overlay
= Qnil
;
4862 it
->stop_charpos
= 0;
4863 xassert (STRINGP (it
->string
));
4864 it
->end_charpos
= SCHARS (it
->string
);
4865 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4866 it
->method
= GET_FROM_STRING
;
4870 it
->current
.overlay_string_index
= -1;
4875 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4878 it
->method
= GET_FROM_BUFFER
;
4880 (void) get_overlay_strings_1 (it
, charpos
, 1);
4884 /* Value is non-zero if we found at least one overlay string. */
4885 return STRINGP (it
->string
);
4890 /***********************************************************************
4891 Saving and restoring state
4892 ***********************************************************************/
4894 /* Save current settings of IT on IT->stack. Called, for example,
4895 before setting up IT for an overlay string, to be able to restore
4896 IT's settings to what they were after the overlay string has been
4900 push_it (struct it
*it
)
4902 struct iterator_stack_entry
*p
;
4904 xassert (it
->sp
< IT_STACK_SIZE
);
4905 p
= it
->stack
+ it
->sp
;
4907 p
->stop_charpos
= it
->stop_charpos
;
4908 p
->prev_stop
= it
->prev_stop
;
4909 p
->base_level_stop
= it
->base_level_stop
;
4910 p
->cmp_it
= it
->cmp_it
;
4911 xassert (it
->face_id
>= 0);
4912 p
->face_id
= it
->face_id
;
4913 p
->string
= it
->string
;
4914 p
->method
= it
->method
;
4915 p
->from_overlay
= it
->from_overlay
;
4918 case GET_FROM_IMAGE
:
4919 p
->u
.image
.object
= it
->object
;
4920 p
->u
.image
.image_id
= it
->image_id
;
4921 p
->u
.image
.slice
= it
->slice
;
4923 case GET_FROM_STRETCH
:
4924 p
->u
.stretch
.object
= it
->object
;
4927 p
->position
= it
->position
;
4928 p
->current
= it
->current
;
4929 p
->end_charpos
= it
->end_charpos
;
4930 p
->string_nchars
= it
->string_nchars
;
4932 p
->multibyte_p
= it
->multibyte_p
;
4933 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4934 p
->space_width
= it
->space_width
;
4935 p
->font_height
= it
->font_height
;
4936 p
->voffset
= it
->voffset
;
4937 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4938 p
->display_ellipsis_p
= 0;
4939 p
->line_wrap
= it
->line_wrap
;
4944 iterate_out_of_display_property (struct it
*it
)
4946 /* Maybe initialize paragraph direction. If we are at the beginning
4947 of a new paragraph, next_element_from_buffer may not have a
4948 chance to do that. */
4949 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4950 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4951 /* prev_stop can be zero, so check against BEGV as well. */
4952 while (it
->bidi_it
.charpos
>= BEGV
4953 && it
->prev_stop
<= it
->bidi_it
.charpos
4954 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4955 bidi_move_to_visually_next (&it
->bidi_it
);
4956 /* Record the stop_pos we just crossed, for when we cross it
4958 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4959 it
->prev_stop
= CHARPOS (it
->position
);
4960 /* If we ended up not where pop_it put us, resync IT's
4961 positional members with the bidi iterator. */
4962 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4964 SET_TEXT_POS (it
->position
,
4965 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4966 it
->current
.pos
= it
->position
;
4970 /* Restore IT's settings from IT->stack. Called, for example, when no
4971 more overlay strings must be processed, and we return to delivering
4972 display elements from a buffer, or when the end of a string from a
4973 `display' property is reached and we return to delivering display
4974 elements from an overlay string, or from a buffer. */
4977 pop_it (struct it
*it
)
4979 struct iterator_stack_entry
*p
;
4981 xassert (it
->sp
> 0);
4983 p
= it
->stack
+ it
->sp
;
4984 it
->stop_charpos
= p
->stop_charpos
;
4985 it
->prev_stop
= p
->prev_stop
;
4986 it
->base_level_stop
= p
->base_level_stop
;
4987 it
->cmp_it
= p
->cmp_it
;
4988 it
->face_id
= p
->face_id
;
4989 it
->current
= p
->current
;
4990 it
->position
= p
->position
;
4991 it
->string
= p
->string
;
4992 it
->from_overlay
= p
->from_overlay
;
4993 if (NILP (it
->string
))
4994 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
4995 it
->method
= p
->method
;
4998 case GET_FROM_IMAGE
:
4999 it
->image_id
= p
->u
.image
.image_id
;
5000 it
->object
= p
->u
.image
.object
;
5001 it
->slice
= p
->u
.image
.slice
;
5003 case GET_FROM_STRETCH
:
5004 it
->object
= p
->u
.comp
.object
;
5006 case GET_FROM_BUFFER
:
5007 it
->object
= it
->w
->buffer
;
5010 /* Bidi-iterate until we get out of the portion of text, if
5011 any, covered by a `display' text property or an overlay
5012 with `display' property. (We cannot just jump there,
5013 because the internal coherency of the bidi iterator state
5014 can not be preserved across such jumps.) We also must
5015 determine the paragraph base direction if the overlay we
5016 just processed is at the beginning of a new
5018 iterate_out_of_display_property (it
);
5021 case GET_FROM_STRING
:
5022 it
->object
= it
->string
;
5024 case GET_FROM_DISPLAY_VECTOR
:
5026 it
->method
= GET_FROM_C_STRING
;
5027 else if (STRINGP (it
->string
))
5028 it
->method
= GET_FROM_STRING
;
5031 it
->method
= GET_FROM_BUFFER
;
5032 it
->object
= it
->w
->buffer
;
5035 it
->end_charpos
= p
->end_charpos
;
5036 it
->string_nchars
= p
->string_nchars
;
5038 it
->multibyte_p
= p
->multibyte_p
;
5039 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5040 it
->space_width
= p
->space_width
;
5041 it
->font_height
= p
->font_height
;
5042 it
->voffset
= p
->voffset
;
5043 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5044 it
->line_wrap
= p
->line_wrap
;
5049 /***********************************************************************
5051 ***********************************************************************/
5053 /* Set IT's current position to the previous line start. */
5056 back_to_previous_line_start (struct it
*it
)
5058 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5059 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5063 /* Move IT to the next line start.
5065 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5066 we skipped over part of the text (as opposed to moving the iterator
5067 continuously over the text). Otherwise, don't change the value
5070 Newlines may come from buffer text, overlay strings, or strings
5071 displayed via the `display' property. That's the reason we can't
5072 simply use find_next_newline_no_quit.
5074 Note that this function may not skip over invisible text that is so
5075 because of text properties and immediately follows a newline. If
5076 it would, function reseat_at_next_visible_line_start, when called
5077 from set_iterator_to_next, would effectively make invisible
5078 characters following a newline part of the wrong glyph row, which
5079 leads to wrong cursor motion. */
5082 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5084 int old_selective
, newline_found_p
, n
;
5085 const int MAX_NEWLINE_DISTANCE
= 500;
5087 /* If already on a newline, just consume it to avoid unintended
5088 skipping over invisible text below. */
5089 if (it
->what
== IT_CHARACTER
5091 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5093 set_iterator_to_next (it
, 0);
5098 /* Don't handle selective display in the following. It's (a)
5099 unnecessary because it's done by the caller, and (b) leads to an
5100 infinite recursion because next_element_from_ellipsis indirectly
5101 calls this function. */
5102 old_selective
= it
->selective
;
5105 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5106 from buffer text. */
5107 for (n
= newline_found_p
= 0;
5108 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5109 n
+= STRINGP (it
->string
) ? 0 : 1)
5111 if (!get_next_display_element (it
))
5113 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5114 set_iterator_to_next (it
, 0);
5117 /* If we didn't find a newline near enough, see if we can use a
5119 if (!newline_found_p
)
5121 EMACS_INT start
= IT_CHARPOS (*it
);
5122 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5125 xassert (!STRINGP (it
->string
));
5127 /* If there isn't any `display' property in sight, and no
5128 overlays, we can just use the position of the newline in
5130 if (it
->stop_charpos
>= limit
5131 || ((pos
= Fnext_single_property_change (make_number (start
),
5133 Qnil
, make_number (limit
)),
5135 && next_overlay_change (start
) == ZV
))
5137 IT_CHARPOS (*it
) = limit
;
5138 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5139 *skipped_p
= newline_found_p
= 1;
5143 while (get_next_display_element (it
)
5144 && !newline_found_p
)
5146 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5147 set_iterator_to_next (it
, 0);
5152 it
->selective
= old_selective
;
5153 return newline_found_p
;
5157 /* Set IT's current position to the previous visible line start. Skip
5158 invisible text that is so either due to text properties or due to
5159 selective display. Caution: this does not change IT->current_x and
5163 back_to_previous_visible_line_start (struct it
*it
)
5165 while (IT_CHARPOS (*it
) > BEGV
)
5167 back_to_previous_line_start (it
);
5169 if (IT_CHARPOS (*it
) <= BEGV
)
5172 /* If selective > 0, then lines indented more than its value are
5174 if (it
->selective
> 0
5175 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5176 (double) it
->selective
)) /* iftc */
5179 /* Check the newline before point for invisibility. */
5182 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5183 Qinvisible
, it
->window
);
5184 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5188 if (IT_CHARPOS (*it
) <= BEGV
)
5195 Lisp_Object val
, overlay
;
5197 /* If newline is part of a composition, continue from start of composition */
5198 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5199 && beg
< IT_CHARPOS (*it
))
5202 /* If newline is replaced by a display property, find start of overlay
5203 or interval and continue search from that point. */
5205 pos
= --IT_CHARPOS (it2
);
5208 it2
.string_from_display_prop_p
= 0;
5209 if (handle_display_prop (&it2
) == HANDLED_RETURN
5210 && !NILP (val
= get_char_property_and_overlay
5211 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5212 && (OVERLAYP (overlay
)
5213 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5214 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5217 /* Newline is not replaced by anything -- so we are done. */
5223 IT_CHARPOS (*it
) = beg
;
5224 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5228 it
->continuation_lines_width
= 0;
5230 xassert (IT_CHARPOS (*it
) >= BEGV
);
5231 xassert (IT_CHARPOS (*it
) == BEGV
5232 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5237 /* Reseat iterator IT at the previous visible line start. Skip
5238 invisible text that is so either due to text properties or due to
5239 selective display. At the end, update IT's overlay information,
5240 face information etc. */
5243 reseat_at_previous_visible_line_start (struct it
*it
)
5245 back_to_previous_visible_line_start (it
);
5246 reseat (it
, it
->current
.pos
, 1);
5251 /* Reseat iterator IT on the next visible line start in the current
5252 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5253 preceding the line start. Skip over invisible text that is so
5254 because of selective display. Compute faces, overlays etc at the
5255 new position. Note that this function does not skip over text that
5256 is invisible because of text properties. */
5259 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5261 int newline_found_p
, skipped_p
= 0;
5263 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5265 /* Skip over lines that are invisible because they are indented
5266 more than the value of IT->selective. */
5267 if (it
->selective
> 0)
5268 while (IT_CHARPOS (*it
) < ZV
5269 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5270 (double) it
->selective
)) /* iftc */
5272 xassert (IT_BYTEPOS (*it
) == BEGV
5273 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5274 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5277 /* Position on the newline if that's what's requested. */
5278 if (on_newline_p
&& newline_found_p
)
5280 if (STRINGP (it
->string
))
5282 if (IT_STRING_CHARPOS (*it
) > 0)
5284 --IT_STRING_CHARPOS (*it
);
5285 --IT_STRING_BYTEPOS (*it
);
5288 else if (IT_CHARPOS (*it
) > BEGV
)
5292 reseat (it
, it
->current
.pos
, 0);
5296 reseat (it
, it
->current
.pos
, 0);
5303 /***********************************************************************
5304 Changing an iterator's position
5305 ***********************************************************************/
5307 /* Change IT's current position to POS in current_buffer. If FORCE_P
5308 is non-zero, always check for text properties at the new position.
5309 Otherwise, text properties are only looked up if POS >=
5310 IT->check_charpos of a property. */
5313 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5315 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5317 reseat_1 (it
, pos
, 0);
5319 /* Determine where to check text properties. Avoid doing it
5320 where possible because text property lookup is very expensive. */
5322 || CHARPOS (pos
) > it
->stop_charpos
5323 || CHARPOS (pos
) < original_pos
)
5327 /* For bidi iteration, we need to prime prev_stop and
5328 base_level_stop with our best estimations. */
5329 if (CHARPOS (pos
) < it
->prev_stop
)
5331 handle_stop_backwards (it
, BEGV
);
5332 if (CHARPOS (pos
) < it
->base_level_stop
)
5333 it
->base_level_stop
= 0;
5335 else if (CHARPOS (pos
) > it
->stop_charpos
5336 && it
->stop_charpos
>= BEGV
)
5337 handle_stop_backwards (it
, it
->stop_charpos
);
5344 it
->prev_stop
= it
->base_level_stop
= 0;
5353 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5354 IT->stop_pos to POS, also. */
5357 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5359 /* Don't call this function when scanning a C string. */
5360 xassert (it
->s
== NULL
);
5362 /* POS must be a reasonable value. */
5363 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5365 it
->current
.pos
= it
->position
= pos
;
5366 it
->end_charpos
= ZV
;
5368 it
->current
.dpvec_index
= -1;
5369 it
->current
.overlay_string_index
= -1;
5370 IT_STRING_CHARPOS (*it
) = -1;
5371 IT_STRING_BYTEPOS (*it
) = -1;
5373 it
->string_from_display_prop_p
= 0;
5374 it
->method
= GET_FROM_BUFFER
;
5375 it
->object
= it
->w
->buffer
;
5376 it
->area
= TEXT_AREA
;
5377 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5379 it
->string_from_display_prop_p
= 0;
5380 it
->face_before_selective_p
= 0;
5383 it
->bidi_it
.first_elt
= 1;
5384 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5389 it
->stop_charpos
= CHARPOS (pos
);
5390 it
->base_level_stop
= CHARPOS (pos
);
5395 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5396 If S is non-null, it is a C string to iterate over. Otherwise,
5397 STRING gives a Lisp string to iterate over.
5399 If PRECISION > 0, don't return more then PRECISION number of
5400 characters from the string.
5402 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5403 characters have been returned. FIELD_WIDTH < 0 means an infinite
5406 MULTIBYTE = 0 means disable processing of multibyte characters,
5407 MULTIBYTE > 0 means enable it,
5408 MULTIBYTE < 0 means use IT->multibyte_p.
5410 IT must be initialized via a prior call to init_iterator before
5411 calling this function. */
5414 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5415 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5418 /* No region in strings. */
5419 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5421 /* No text property checks performed by default, but see below. */
5422 it
->stop_charpos
= -1;
5424 /* Set iterator position and end position. */
5425 memset (&it
->current
, 0, sizeof it
->current
);
5426 it
->current
.overlay_string_index
= -1;
5427 it
->current
.dpvec_index
= -1;
5428 xassert (charpos
>= 0);
5430 /* If STRING is specified, use its multibyteness, otherwise use the
5431 setting of MULTIBYTE, if specified. */
5433 it
->multibyte_p
= multibyte
> 0;
5437 xassert (STRINGP (string
));
5438 it
->string
= string
;
5440 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5441 it
->method
= GET_FROM_STRING
;
5442 it
->current
.string_pos
= string_pos (charpos
, string
);
5446 it
->s
= (const unsigned char *) s
;
5449 /* Note that we use IT->current.pos, not it->current.string_pos,
5450 for displaying C strings. */
5451 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5452 if (it
->multibyte_p
)
5454 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5455 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5459 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5460 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5463 it
->method
= GET_FROM_C_STRING
;
5466 /* PRECISION > 0 means don't return more than PRECISION characters
5468 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5469 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5471 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5472 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5473 FIELD_WIDTH < 0 means infinite field width. This is useful for
5474 padding with `-' at the end of a mode line. */
5475 if (field_width
< 0)
5476 field_width
= INFINITY
;
5477 if (field_width
> it
->end_charpos
- charpos
)
5478 it
->end_charpos
= charpos
+ field_width
;
5480 /* Use the standard display table for displaying strings. */
5481 if (DISP_TABLE_P (Vstandard_display_table
))
5482 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5484 it
->stop_charpos
= charpos
;
5485 if (s
== NULL
&& it
->multibyte_p
)
5487 EMACS_INT endpos
= SCHARS (it
->string
);
5488 if (endpos
> it
->end_charpos
)
5489 endpos
= it
->end_charpos
;
5490 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5498 /***********************************************************************
5500 ***********************************************************************/
5502 /* Map enum it_method value to corresponding next_element_from_* function. */
5504 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5506 next_element_from_buffer
,
5507 next_element_from_display_vector
,
5508 next_element_from_string
,
5509 next_element_from_c_string
,
5510 next_element_from_image
,
5511 next_element_from_stretch
5514 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5517 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5518 (possibly with the following characters). */
5520 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5521 ((IT)->cmp_it.id >= 0 \
5522 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5523 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5524 END_CHARPOS, (IT)->w, \
5525 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5529 /* Lookup the char-table Vglyphless_char_display for character C (-1
5530 if we want information for no-font case), and return the display
5531 method symbol. By side-effect, update it->what and
5532 it->glyphless_method. This function is called from
5533 get_next_display_element for each character element, and from
5534 x_produce_glyphs when no suitable font was found. */
5537 lookup_glyphless_char_display (int c
, struct it
*it
)
5539 Lisp_Object glyphless_method
= Qnil
;
5541 if (CHAR_TABLE_P (Vglyphless_char_display
)
5542 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5543 glyphless_method
= (c
>= 0
5544 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5545 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5547 if (NILP (glyphless_method
))
5550 /* The default is to display the character by a proper font. */
5552 /* The default for the no-font case is to display an empty box. */
5553 glyphless_method
= Qempty_box
;
5555 if (EQ (glyphless_method
, Qzero_width
))
5558 return glyphless_method
;
5559 /* This method can't be used for the no-font case. */
5560 glyphless_method
= Qempty_box
;
5562 if (EQ (glyphless_method
, Qthin_space
))
5563 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5564 else if (EQ (glyphless_method
, Qempty_box
))
5565 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5566 else if (EQ (glyphless_method
, Qhex_code
))
5567 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5568 else if (STRINGP (glyphless_method
))
5569 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5572 /* Invalid value. We use the default method. */
5573 glyphless_method
= Qnil
;
5576 it
->what
= IT_GLYPHLESS
;
5577 return glyphless_method
;
5580 /* Load IT's display element fields with information about the next
5581 display element from the current position of IT. Value is zero if
5582 end of buffer (or C string) is reached. */
5584 static struct frame
*last_escape_glyph_frame
= NULL
;
5585 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5586 static int last_escape_glyph_merged_face_id
= 0;
5588 struct frame
*last_glyphless_glyph_frame
= NULL
;
5589 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5590 int last_glyphless_glyph_merged_face_id
= 0;
5593 get_next_display_element (struct it
*it
)
5595 /* Non-zero means that we found a display element. Zero means that
5596 we hit the end of what we iterate over. Performance note: the
5597 function pointer `method' used here turns out to be faster than
5598 using a sequence of if-statements. */
5602 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5604 if (it
->what
== IT_CHARACTER
)
5606 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5607 and only if (a) the resolved directionality of that character
5609 /* FIXME: Do we need an exception for characters from display
5611 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5612 it
->c
= bidi_mirror_char (it
->c
);
5613 /* Map via display table or translate control characters.
5614 IT->c, IT->len etc. have been set to the next character by
5615 the function call above. If we have a display table, and it
5616 contains an entry for IT->c, translate it. Don't do this if
5617 IT->c itself comes from a display table, otherwise we could
5618 end up in an infinite recursion. (An alternative could be to
5619 count the recursion depth of this function and signal an
5620 error when a certain maximum depth is reached.) Is it worth
5622 if (success_p
&& it
->dpvec
== NULL
)
5625 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5626 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5627 nbsp_or_shy
= char_is_other
;
5628 int c
= it
->c
; /* This is the character to display. */
5630 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5632 xassert (SINGLE_BYTE_CHAR_P (c
));
5633 if (unibyte_display_via_language_environment
)
5635 c
= DECODE_CHAR (unibyte
, c
);
5637 c
= BYTE8_TO_CHAR (it
->c
);
5640 c
= BYTE8_TO_CHAR (it
->c
);
5644 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5647 struct Lisp_Vector
*v
= XVECTOR (dv
);
5649 /* Return the first character from the display table
5650 entry, if not empty. If empty, don't display the
5651 current character. */
5654 it
->dpvec_char_len
= it
->len
;
5655 it
->dpvec
= v
->contents
;
5656 it
->dpend
= v
->contents
+ v
->size
;
5657 it
->current
.dpvec_index
= 0;
5658 it
->dpvec_face_id
= -1;
5659 it
->saved_face_id
= it
->face_id
;
5660 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5665 set_iterator_to_next (it
, 0);
5670 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5672 if (it
->what
== IT_GLYPHLESS
)
5674 /* Don't display this character. */
5675 set_iterator_to_next (it
, 0);
5679 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5680 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5681 : c
== 0xAD ? char_is_soft_hyphen
5684 /* Translate control characters into `\003' or `^C' form.
5685 Control characters coming from a display table entry are
5686 currently not translated because we use IT->dpvec to hold
5687 the translation. This could easily be changed but I
5688 don't believe that it is worth doing.
5690 NBSP and SOFT-HYPEN are property translated too.
5692 Non-printable characters and raw-byte characters are also
5693 translated to octal form. */
5694 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5695 ? (it
->area
!= TEXT_AREA
5696 /* In mode line, treat \n, \t like other crl chars. */
5699 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5700 || (c
!= '\n' && c
!= '\t'))
5703 || ! CHAR_PRINTABLE_P (c
))))
5705 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5706 or a non-printable character which must be displayed
5707 either as '\003' or as `^C' where the '\\' and '^'
5708 can be defined in the display table. Fill
5709 IT->ctl_chars with glyphs for what we have to
5710 display. Then, set IT->dpvec to these glyphs. */
5713 int face_id
, lface_id
= 0 ;
5716 /* Handle control characters with ^. */
5718 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5722 g
= '^'; /* default glyph for Control */
5723 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5725 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5726 && GLYPH_CODE_CHAR_VALID_P (gc
))
5728 g
= GLYPH_CODE_CHAR (gc
);
5729 lface_id
= GLYPH_CODE_FACE (gc
);
5733 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5735 else if (it
->f
== last_escape_glyph_frame
5736 && it
->face_id
== last_escape_glyph_face_id
)
5738 face_id
= last_escape_glyph_merged_face_id
;
5742 /* Merge the escape-glyph face into the current face. */
5743 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5745 last_escape_glyph_frame
= it
->f
;
5746 last_escape_glyph_face_id
= it
->face_id
;
5747 last_escape_glyph_merged_face_id
= face_id
;
5750 XSETINT (it
->ctl_chars
[0], g
);
5751 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5753 goto display_control
;
5756 /* Handle non-break space in the mode where it only gets
5759 if (EQ (Vnobreak_char_display
, Qt
)
5760 && nbsp_or_shy
== char_is_nbsp
)
5762 /* Merge the no-break-space face into the current face. */
5763 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5767 XSETINT (it
->ctl_chars
[0], ' ');
5769 goto display_control
;
5772 /* Handle sequences that start with the "escape glyph". */
5774 /* the default escape glyph is \. */
5775 escape_glyph
= '\\';
5778 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5779 && GLYPH_CODE_CHAR_VALID_P (gc
))
5781 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5782 lface_id
= GLYPH_CODE_FACE (gc
);
5786 /* The display table specified a face.
5787 Merge it into face_id and also into escape_glyph. */
5788 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5791 else if (it
->f
== last_escape_glyph_frame
5792 && it
->face_id
== last_escape_glyph_face_id
)
5794 face_id
= last_escape_glyph_merged_face_id
;
5798 /* Merge the escape-glyph face into the current face. */
5799 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5801 last_escape_glyph_frame
= it
->f
;
5802 last_escape_glyph_face_id
= it
->face_id
;
5803 last_escape_glyph_merged_face_id
= face_id
;
5806 /* Handle soft hyphens in the mode where they only get
5809 if (EQ (Vnobreak_char_display
, Qt
)
5810 && nbsp_or_shy
== char_is_soft_hyphen
)
5812 XSETINT (it
->ctl_chars
[0], '-');
5814 goto display_control
;
5817 /* Handle non-break space and soft hyphen
5818 with the escape glyph. */
5822 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5823 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5824 XSETINT (it
->ctl_chars
[1], c
);
5826 goto display_control
;
5833 if (CHAR_BYTE8_P (c
))
5834 /* Display \200 instead of \17777600. */
5835 c
= CHAR_TO_BYTE8 (c
);
5836 len
= sprintf (str
, "%03o", c
);
5838 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5839 for (i
= 0; i
< len
; i
++)
5840 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5845 /* Set up IT->dpvec and return first character from it. */
5846 it
->dpvec_char_len
= it
->len
;
5847 it
->dpvec
= it
->ctl_chars
;
5848 it
->dpend
= it
->dpvec
+ ctl_len
;
5849 it
->current
.dpvec_index
= 0;
5850 it
->dpvec_face_id
= face_id
;
5851 it
->saved_face_id
= it
->face_id
;
5852 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5856 it
->char_to_display
= c
;
5860 it
->char_to_display
= it
->c
;
5864 #ifdef HAVE_WINDOW_SYSTEM
5865 /* Adjust face id for a multibyte character. There are no multibyte
5866 character in unibyte text. */
5867 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5870 && FRAME_WINDOW_P (it
->f
))
5872 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5874 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5876 /* Automatic composition with glyph-string. */
5877 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5879 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5883 EMACS_INT pos
= (it
->s
? -1
5884 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5885 : IT_CHARPOS (*it
));
5887 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5894 /* Is this character the last one of a run of characters with
5895 box? If yes, set IT->end_of_box_run_p to 1. */
5899 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5901 int face_id
= underlying_face_id (it
);
5902 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5906 if (face
->box
== FACE_NO_BOX
)
5908 /* If the box comes from face properties in a
5909 display string, check faces in that string. */
5910 int string_face_id
= face_after_it_pos (it
);
5911 it
->end_of_box_run_p
5912 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5915 /* Otherwise, the box comes from the underlying face.
5916 If this is the last string character displayed, check
5917 the next buffer location. */
5918 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5919 && (it
->current
.overlay_string_index
5920 == it
->n_overlay_strings
- 1))
5924 struct text_pos pos
= it
->current
.pos
;
5925 INC_TEXT_POS (pos
, it
->multibyte_p
);
5927 next_face_id
= face_at_buffer_position
5928 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5929 it
->region_end_charpos
, &ignore
,
5930 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5932 it
->end_of_box_run_p
5933 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5940 int face_id
= face_after_it_pos (it
);
5941 it
->end_of_box_run_p
5942 = (face_id
!= it
->face_id
5943 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5947 /* Value is 0 if end of buffer or string reached. */
5952 /* Move IT to the next display element.
5954 RESEAT_P non-zero means if called on a newline in buffer text,
5955 skip to the next visible line start.
5957 Functions get_next_display_element and set_iterator_to_next are
5958 separate because I find this arrangement easier to handle than a
5959 get_next_display_element function that also increments IT's
5960 position. The way it is we can first look at an iterator's current
5961 display element, decide whether it fits on a line, and if it does,
5962 increment the iterator position. The other way around we probably
5963 would either need a flag indicating whether the iterator has to be
5964 incremented the next time, or we would have to implement a
5965 decrement position function which would not be easy to write. */
5968 set_iterator_to_next (struct it
*it
, int reseat_p
)
5970 /* Reset flags indicating start and end of a sequence of characters
5971 with box. Reset them at the start of this function because
5972 moving the iterator to a new position might set them. */
5973 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5977 case GET_FROM_BUFFER
:
5978 /* The current display element of IT is a character from
5979 current_buffer. Advance in the buffer, and maybe skip over
5980 invisible lines that are so because of selective display. */
5981 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5982 reseat_at_next_visible_line_start (it
, 0);
5983 else if (it
->cmp_it
.id
>= 0)
5985 /* We are currently getting glyphs from a composition. */
5990 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
5991 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
5992 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
5994 it
->cmp_it
.from
= it
->cmp_it
.to
;
5999 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6001 it
->end_charpos
, Qnil
);
6004 else if (! it
->cmp_it
.reversed_p
)
6006 /* Composition created while scanning forward. */
6007 /* Update IT's char/byte positions to point to the first
6008 character of the next grapheme cluster, or to the
6009 character visually after the current composition. */
6010 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6011 bidi_move_to_visually_next (&it
->bidi_it
);
6012 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6013 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6015 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6017 /* Proceed to the next grapheme cluster. */
6018 it
->cmp_it
.from
= it
->cmp_it
.to
;
6022 /* No more grapheme clusters in this composition.
6023 Find the next stop position. */
6024 EMACS_INT stop
= it
->end_charpos
;
6025 if (it
->bidi_it
.scan_dir
< 0)
6026 /* Now we are scanning backward and don't know
6029 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6030 IT_BYTEPOS (*it
), stop
, Qnil
);
6035 /* Composition created while scanning backward. */
6036 /* Update IT's char/byte positions to point to the last
6037 character of the previous grapheme cluster, or the
6038 character visually after the current composition. */
6039 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6040 bidi_move_to_visually_next (&it
->bidi_it
);
6041 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6042 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6043 if (it
->cmp_it
.from
> 0)
6045 /* Proceed to the previous grapheme cluster. */
6046 it
->cmp_it
.to
= it
->cmp_it
.from
;
6050 /* No more grapheme clusters in this composition.
6051 Find the next stop position. */
6052 EMACS_INT stop
= it
->end_charpos
;
6053 if (it
->bidi_it
.scan_dir
< 0)
6054 /* Now we are scanning backward and don't know
6057 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6058 IT_BYTEPOS (*it
), stop
, Qnil
);
6064 xassert (it
->len
!= 0);
6068 IT_BYTEPOS (*it
) += it
->len
;
6069 IT_CHARPOS (*it
) += 1;
6073 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6074 /* If this is a new paragraph, determine its base
6075 direction (a.k.a. its base embedding level). */
6076 if (it
->bidi_it
.new_paragraph
)
6077 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6078 bidi_move_to_visually_next (&it
->bidi_it
);
6079 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6080 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6081 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6083 /* As the scan direction was changed, we must
6084 re-compute the stop position for composition. */
6085 EMACS_INT stop
= it
->end_charpos
;
6086 if (it
->bidi_it
.scan_dir
< 0)
6088 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6089 IT_BYTEPOS (*it
), stop
, Qnil
);
6092 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6096 case GET_FROM_C_STRING
:
6097 /* Current display element of IT is from a C string. */
6098 IT_BYTEPOS (*it
) += it
->len
;
6099 IT_CHARPOS (*it
) += 1;
6102 case GET_FROM_DISPLAY_VECTOR
:
6103 /* Current display element of IT is from a display table entry.
6104 Advance in the display table definition. Reset it to null if
6105 end reached, and continue with characters from buffers/
6107 ++it
->current
.dpvec_index
;
6109 /* Restore face of the iterator to what they were before the
6110 display vector entry (these entries may contain faces). */
6111 it
->face_id
= it
->saved_face_id
;
6113 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6115 int recheck_faces
= it
->ellipsis_p
;
6118 it
->method
= GET_FROM_C_STRING
;
6119 else if (STRINGP (it
->string
))
6120 it
->method
= GET_FROM_STRING
;
6123 it
->method
= GET_FROM_BUFFER
;
6124 it
->object
= it
->w
->buffer
;
6128 it
->current
.dpvec_index
= -1;
6130 /* Skip over characters which were displayed via IT->dpvec. */
6131 if (it
->dpvec_char_len
< 0)
6132 reseat_at_next_visible_line_start (it
, 1);
6133 else if (it
->dpvec_char_len
> 0)
6135 if (it
->method
== GET_FROM_STRING
6136 && it
->n_overlay_strings
> 0)
6137 it
->ignore_overlay_strings_at_pos_p
= 1;
6138 it
->len
= it
->dpvec_char_len
;
6139 set_iterator_to_next (it
, reseat_p
);
6142 /* Maybe recheck faces after display vector */
6144 it
->stop_charpos
= IT_CHARPOS (*it
);
6148 case GET_FROM_STRING
:
6149 /* Current display element is a character from a Lisp string. */
6150 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6151 if (it
->cmp_it
.id
>= 0)
6153 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6154 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6155 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6156 it
->cmp_it
.from
= it
->cmp_it
.to
;
6160 composition_compute_stop_pos (&it
->cmp_it
,
6161 IT_STRING_CHARPOS (*it
),
6162 IT_STRING_BYTEPOS (*it
),
6163 it
->end_charpos
, it
->string
);
6168 IT_STRING_BYTEPOS (*it
) += it
->len
;
6169 IT_STRING_CHARPOS (*it
) += 1;
6172 consider_string_end
:
6174 if (it
->current
.overlay_string_index
>= 0)
6176 /* IT->string is an overlay string. Advance to the
6177 next, if there is one. */
6178 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6181 next_overlay_string (it
);
6183 setup_for_ellipsis (it
, 0);
6188 /* IT->string is not an overlay string. If we reached
6189 its end, and there is something on IT->stack, proceed
6190 with what is on the stack. This can be either another
6191 string, this time an overlay string, or a buffer. */
6192 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6196 if (it
->method
== GET_FROM_STRING
)
6197 goto consider_string_end
;
6202 case GET_FROM_IMAGE
:
6203 case GET_FROM_STRETCH
:
6204 /* The position etc with which we have to proceed are on
6205 the stack. The position may be at the end of a string,
6206 if the `display' property takes up the whole string. */
6207 xassert (it
->sp
> 0);
6209 if (it
->method
== GET_FROM_STRING
)
6210 goto consider_string_end
;
6214 /* There are no other methods defined, so this should be a bug. */
6218 xassert (it
->method
!= GET_FROM_STRING
6219 || (STRINGP (it
->string
)
6220 && IT_STRING_CHARPOS (*it
) >= 0));
6223 /* Load IT's display element fields with information about the next
6224 display element which comes from a display table entry or from the
6225 result of translating a control character to one of the forms `^C'
6228 IT->dpvec holds the glyphs to return as characters.
6229 IT->saved_face_id holds the face id before the display vector--it
6230 is restored into IT->face_id in set_iterator_to_next. */
6233 next_element_from_display_vector (struct it
*it
)
6238 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6240 it
->face_id
= it
->saved_face_id
;
6242 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6243 That seemed totally bogus - so I changed it... */
6244 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6246 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6248 it
->c
= GLYPH_CODE_CHAR (gc
);
6249 it
->len
= CHAR_BYTES (it
->c
);
6251 /* The entry may contain a face id to use. Such a face id is
6252 the id of a Lisp face, not a realized face. A face id of
6253 zero means no face is specified. */
6254 if (it
->dpvec_face_id
>= 0)
6255 it
->face_id
= it
->dpvec_face_id
;
6258 int lface_id
= GLYPH_CODE_FACE (gc
);
6260 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6265 /* Display table entry is invalid. Return a space. */
6266 it
->c
= ' ', it
->len
= 1;
6268 /* Don't change position and object of the iterator here. They are
6269 still the values of the character that had this display table
6270 entry or was translated, and that's what we want. */
6271 it
->what
= IT_CHARACTER
;
6276 /* Load IT with the next display element from Lisp string IT->string.
6277 IT->current.string_pos is the current position within the string.
6278 If IT->current.overlay_string_index >= 0, the Lisp string is an
6282 next_element_from_string (struct it
*it
)
6284 struct text_pos position
;
6286 xassert (STRINGP (it
->string
));
6287 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6288 position
= it
->current
.string_pos
;
6290 /* Time to check for invisible text? */
6291 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6292 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6296 /* Since a handler may have changed IT->method, we must
6298 return GET_NEXT_DISPLAY_ELEMENT (it
);
6301 if (it
->current
.overlay_string_index
>= 0)
6303 /* Get the next character from an overlay string. In overlay
6304 strings, There is no field width or padding with spaces to
6306 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6311 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6312 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6313 && next_element_from_composition (it
))
6317 else if (STRING_MULTIBYTE (it
->string
))
6319 const unsigned char *s
= (SDATA (it
->string
)
6320 + IT_STRING_BYTEPOS (*it
));
6321 it
->c
= string_char_and_length (s
, &it
->len
);
6325 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6331 /* Get the next character from a Lisp string that is not an
6332 overlay string. Such strings come from the mode line, for
6333 example. We may have to pad with spaces, or truncate the
6334 string. See also next_element_from_c_string. */
6335 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6340 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6342 /* Pad with spaces. */
6343 it
->c
= ' ', it
->len
= 1;
6344 CHARPOS (position
) = BYTEPOS (position
) = -1;
6346 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6347 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6348 && next_element_from_composition (it
))
6352 else if (STRING_MULTIBYTE (it
->string
))
6354 const unsigned char *s
= (SDATA (it
->string
)
6355 + IT_STRING_BYTEPOS (*it
));
6356 it
->c
= string_char_and_length (s
, &it
->len
);
6360 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6365 /* Record what we have and where it came from. */
6366 it
->what
= IT_CHARACTER
;
6367 it
->object
= it
->string
;
6368 it
->position
= position
;
6373 /* Load IT with next display element from C string IT->s.
6374 IT->string_nchars is the maximum number of characters to return
6375 from the string. IT->end_charpos may be greater than
6376 IT->string_nchars when this function is called, in which case we
6377 may have to return padding spaces. Value is zero if end of string
6378 reached, including padding spaces. */
6381 next_element_from_c_string (struct it
*it
)
6386 it
->what
= IT_CHARACTER
;
6387 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6390 /* IT's position can be greater IT->string_nchars in case a field
6391 width or precision has been specified when the iterator was
6393 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6395 /* End of the game. */
6399 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6401 /* Pad with spaces. */
6402 it
->c
= ' ', it
->len
= 1;
6403 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6405 else if (it
->multibyte_p
)
6406 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6408 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6414 /* Set up IT to return characters from an ellipsis, if appropriate.
6415 The definition of the ellipsis glyphs may come from a display table
6416 entry. This function fills IT with the first glyph from the
6417 ellipsis if an ellipsis is to be displayed. */
6420 next_element_from_ellipsis (struct it
*it
)
6422 if (it
->selective_display_ellipsis_p
)
6423 setup_for_ellipsis (it
, it
->len
);
6426 /* The face at the current position may be different from the
6427 face we find after the invisible text. Remember what it
6428 was in IT->saved_face_id, and signal that it's there by
6429 setting face_before_selective_p. */
6430 it
->saved_face_id
= it
->face_id
;
6431 it
->method
= GET_FROM_BUFFER
;
6432 it
->object
= it
->w
->buffer
;
6433 reseat_at_next_visible_line_start (it
, 1);
6434 it
->face_before_selective_p
= 1;
6437 return GET_NEXT_DISPLAY_ELEMENT (it
);
6441 /* Deliver an image display element. The iterator IT is already
6442 filled with image information (done in handle_display_prop). Value
6447 next_element_from_image (struct it
*it
)
6449 it
->what
= IT_IMAGE
;
6450 it
->ignore_overlay_strings_at_pos_p
= 0;
6455 /* Fill iterator IT with next display element from a stretch glyph
6456 property. IT->object is the value of the text property. Value is
6460 next_element_from_stretch (struct it
*it
)
6462 it
->what
= IT_STRETCH
;
6466 /* Scan forward from CHARPOS in the current buffer, until we find a
6467 stop position > current IT's position. Then handle the stop
6468 position before that. This is called when we bump into a stop
6469 position while reordering bidirectional text. CHARPOS should be
6470 the last previously processed stop_pos (or BEGV, if none were
6471 processed yet) whose position is less that IT's current
6475 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6477 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6478 struct display_pos save_current
= it
->current
;
6479 struct text_pos save_position
= it
->position
;
6480 struct text_pos pos1
;
6481 EMACS_INT next_stop
;
6483 /* Scan in strict logical order. */
6487 it
->prev_stop
= charpos
;
6488 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6489 reseat_1 (it
, pos1
, 0);
6490 compute_stop_pos (it
);
6491 /* We must advance forward, right? */
6492 if (it
->stop_charpos
<= it
->prev_stop
)
6494 charpos
= it
->stop_charpos
;
6496 while (charpos
<= where_we_are
);
6498 next_stop
= it
->stop_charpos
;
6499 it
->stop_charpos
= it
->prev_stop
;
6501 it
->current
= save_current
;
6502 it
->position
= save_position
;
6504 it
->stop_charpos
= next_stop
;
6507 /* Load IT with the next display element from current_buffer. Value
6508 is zero if end of buffer reached. IT->stop_charpos is the next
6509 position at which to stop and check for text properties or buffer
6513 next_element_from_buffer (struct it
*it
)
6517 xassert (IT_CHARPOS (*it
) >= BEGV
);
6519 /* With bidi reordering, the character to display might not be the
6520 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6521 we were reseat()ed to a new buffer position, which is potentially
6522 a different paragraph. */
6523 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6525 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6526 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6527 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6529 /* Nothing to do, but reset the FIRST_ELT flag, like
6530 bidi_paragraph_init does, because we are not going to
6532 it
->bidi_it
.first_elt
= 0;
6534 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6535 /* FIXME: Should support all Unicode line separators. */
6536 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6537 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6539 /* If we are at the beginning of a line, we can produce the
6540 next element right away. */
6541 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6542 bidi_move_to_visually_next (&it
->bidi_it
);
6546 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6548 /* We need to prime the bidi iterator starting at the line's
6549 beginning, before we will be able to produce the next
6551 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6552 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6553 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6554 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6555 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6558 /* Now return to buffer position where we were asked to
6559 get the next display element, and produce that. */
6560 bidi_move_to_visually_next (&it
->bidi_it
);
6562 while (it
->bidi_it
.bytepos
!= orig_bytepos
6563 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6566 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6567 /* Adjust IT's position information to where we ended up. */
6568 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6569 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6570 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6572 EMACS_INT stop
= it
->end_charpos
;
6573 if (it
->bidi_it
.scan_dir
< 0)
6575 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6576 IT_BYTEPOS (*it
), stop
, Qnil
);
6580 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6582 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6584 int overlay_strings_follow_p
;
6586 /* End of the game, except when overlay strings follow that
6587 haven't been returned yet. */
6588 if (it
->overlay_strings_at_end_processed_p
)
6589 overlay_strings_follow_p
= 0;
6592 it
->overlay_strings_at_end_processed_p
= 1;
6593 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6596 if (overlay_strings_follow_p
)
6597 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6601 it
->position
= it
->current
.pos
;
6605 else if (!(!it
->bidi_p
6606 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6607 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6609 /* With bidi non-linear iteration, we could find ourselves
6610 far beyond the last computed stop_charpos, with several
6611 other stop positions in between that we missed. Scan
6612 them all now, in buffer's logical order, until we find
6613 and handle the last stop_charpos that precedes our
6614 current position. */
6615 handle_stop_backwards (it
, it
->stop_charpos
);
6616 return GET_NEXT_DISPLAY_ELEMENT (it
);
6622 /* Take note of the stop position we just moved across,
6623 for when we will move back across it. */
6624 it
->prev_stop
= it
->stop_charpos
;
6625 /* If we are at base paragraph embedding level, take
6626 note of the last stop position seen at this
6628 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6629 it
->base_level_stop
= it
->stop_charpos
;
6632 return GET_NEXT_DISPLAY_ELEMENT (it
);
6636 /* We can sometimes back up for reasons that have nothing
6637 to do with bidi reordering. E.g., compositions. The
6638 code below is only needed when we are above the base
6639 embedding level, so test for that explicitly. */
6640 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6641 && IT_CHARPOS (*it
) < it
->prev_stop
)
6643 if (it
->base_level_stop
<= 0)
6644 it
->base_level_stop
= BEGV
;
6645 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6647 handle_stop_backwards (it
, it
->base_level_stop
);
6648 return GET_NEXT_DISPLAY_ELEMENT (it
);
6652 /* No face changes, overlays etc. in sight, so just return a
6653 character from current_buffer. */
6657 /* Maybe run the redisplay end trigger hook. Performance note:
6658 This doesn't seem to cost measurable time. */
6659 if (it
->redisplay_end_trigger_charpos
6661 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6662 run_redisplay_end_trigger_hook (it
);
6664 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6665 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6667 && next_element_from_composition (it
))
6672 /* Get the next character, maybe multibyte. */
6673 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6674 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6675 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6677 it
->c
= *p
, it
->len
= 1;
6679 /* Record what we have and where it came from. */
6680 it
->what
= IT_CHARACTER
;
6681 it
->object
= it
->w
->buffer
;
6682 it
->position
= it
->current
.pos
;
6684 /* Normally we return the character found above, except when we
6685 really want to return an ellipsis for selective display. */
6690 /* A value of selective > 0 means hide lines indented more
6691 than that number of columns. */
6692 if (it
->selective
> 0
6693 && IT_CHARPOS (*it
) + 1 < ZV
6694 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6695 IT_BYTEPOS (*it
) + 1,
6696 (double) it
->selective
)) /* iftc */
6698 success_p
= next_element_from_ellipsis (it
);
6699 it
->dpvec_char_len
= -1;
6702 else if (it
->c
== '\r' && it
->selective
== -1)
6704 /* A value of selective == -1 means that everything from the
6705 CR to the end of the line is invisible, with maybe an
6706 ellipsis displayed for it. */
6707 success_p
= next_element_from_ellipsis (it
);
6708 it
->dpvec_char_len
= -1;
6713 /* Value is zero if end of buffer reached. */
6714 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6719 /* Run the redisplay end trigger hook for IT. */
6722 run_redisplay_end_trigger_hook (struct it
*it
)
6724 Lisp_Object args
[3];
6726 /* IT->glyph_row should be non-null, i.e. we should be actually
6727 displaying something, or otherwise we should not run the hook. */
6728 xassert (it
->glyph_row
);
6730 /* Set up hook arguments. */
6731 args
[0] = Qredisplay_end_trigger_functions
;
6732 args
[1] = it
->window
;
6733 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6734 it
->redisplay_end_trigger_charpos
= 0;
6736 /* Since we are *trying* to run these functions, don't try to run
6737 them again, even if they get an error. */
6738 it
->w
->redisplay_end_trigger
= Qnil
;
6739 Frun_hook_with_args (3, args
);
6741 /* Notice if it changed the face of the character we are on. */
6742 handle_face_prop (it
);
6746 /* Deliver a composition display element. Unlike the other
6747 next_element_from_XXX, this function is not registered in the array
6748 get_next_element[]. It is called from next_element_from_buffer and
6749 next_element_from_string when necessary. */
6752 next_element_from_composition (struct it
*it
)
6754 it
->what
= IT_COMPOSITION
;
6755 it
->len
= it
->cmp_it
.nbytes
;
6756 if (STRINGP (it
->string
))
6760 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6761 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6764 it
->position
= it
->current
.string_pos
;
6765 it
->object
= it
->string
;
6766 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6767 IT_STRING_BYTEPOS (*it
), it
->string
);
6773 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6774 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6777 if (it
->bidi_it
.new_paragraph
)
6778 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6779 /* Resync the bidi iterator with IT's new position.
6780 FIXME: this doesn't support bidirectional text. */
6781 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6782 bidi_move_to_visually_next (&it
->bidi_it
);
6786 it
->position
= it
->current
.pos
;
6787 it
->object
= it
->w
->buffer
;
6788 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6789 IT_BYTEPOS (*it
), Qnil
);
6796 /***********************************************************************
6797 Moving an iterator without producing glyphs
6798 ***********************************************************************/
6800 /* Check if iterator is at a position corresponding to a valid buffer
6801 position after some move_it_ call. */
6803 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6804 ((it)->method == GET_FROM_STRING \
6805 ? IT_STRING_CHARPOS (*it) == 0 \
6809 /* Move iterator IT to a specified buffer or X position within one
6810 line on the display without producing glyphs.
6812 OP should be a bit mask including some or all of these bits:
6813 MOVE_TO_X: Stop upon reaching x-position TO_X.
6814 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6815 Regardless of OP's value, stop upon reaching the end of the display line.
6817 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6818 This means, in particular, that TO_X includes window's horizontal
6821 The return value has several possible values that
6822 say what condition caused the scan to stop:
6824 MOVE_POS_MATCH_OR_ZV
6825 - when TO_POS or ZV was reached.
6828 -when TO_X was reached before TO_POS or ZV were reached.
6831 - when we reached the end of the display area and the line must
6835 - when we reached the end of the display area and the line is
6839 - when we stopped at a line end, i.e. a newline or a CR and selective
6842 static enum move_it_result
6843 move_it_in_display_line_to (struct it
*it
,
6844 EMACS_INT to_charpos
, int to_x
,
6845 enum move_operation_enum op
)
6847 enum move_it_result result
= MOVE_UNDEFINED
;
6848 struct glyph_row
*saved_glyph_row
;
6849 struct it wrap_it
, atpos_it
, atx_it
;
6851 enum it_method prev_method
= it
->method
;
6852 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6854 /* Don't produce glyphs in produce_glyphs. */
6855 saved_glyph_row
= it
->glyph_row
;
6856 it
->glyph_row
= NULL
;
6858 /* Use wrap_it to save a copy of IT wherever a word wrap could
6859 occur. Use atpos_it to save a copy of IT at the desired buffer
6860 position, if found, so that we can scan ahead and check if the
6861 word later overshoots the window edge. Use atx_it similarly, for
6867 #define BUFFER_POS_REACHED_P() \
6868 ((op & MOVE_TO_POS) != 0 \
6869 && BUFFERP (it->object) \
6870 && (IT_CHARPOS (*it) == to_charpos \
6871 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6872 && (it->method == GET_FROM_BUFFER \
6873 || (it->method == GET_FROM_DISPLAY_VECTOR \
6874 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6876 /* If there's a line-/wrap-prefix, handle it. */
6877 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6878 && it
->current_y
< it
->last_visible_y
)
6879 handle_line_prefix (it
);
6881 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6882 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6886 int x
, i
, ascent
= 0, descent
= 0;
6888 /* Utility macro to reset an iterator with x, ascent, and descent. */
6889 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6890 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6891 (IT)->max_descent = descent)
6893 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6895 if ((op
& MOVE_TO_POS
) != 0
6896 && BUFFERP (it
->object
)
6897 && it
->method
== GET_FROM_BUFFER
6898 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6900 && (prev_method
== GET_FROM_IMAGE
6901 || prev_method
== GET_FROM_STRETCH
)
6902 /* Passed TO_CHARPOS from left to right. */
6903 && ((prev_pos
< to_charpos
6904 && IT_CHARPOS (*it
) > to_charpos
)
6905 /* Passed TO_CHARPOS from right to left. */
6906 || (prev_pos
> to_charpos
6907 && IT_CHARPOS (*it
) < to_charpos
)))))
6909 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6911 result
= MOVE_POS_MATCH_OR_ZV
;
6914 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6915 /* If wrap_it is valid, the current position might be in a
6916 word that is wrapped. So, save the iterator in
6917 atpos_it and continue to see if wrapping happens. */
6921 prev_method
= it
->method
;
6922 if (it
->method
== GET_FROM_BUFFER
)
6923 prev_pos
= IT_CHARPOS (*it
);
6924 /* Stop when ZV reached.
6925 We used to stop here when TO_CHARPOS reached as well, but that is
6926 too soon if this glyph does not fit on this line. So we handle it
6927 explicitly below. */
6928 if (!get_next_display_element (it
))
6930 result
= MOVE_POS_MATCH_OR_ZV
;
6934 if (it
->line_wrap
== TRUNCATE
)
6936 if (BUFFER_POS_REACHED_P ())
6938 result
= MOVE_POS_MATCH_OR_ZV
;
6944 if (it
->line_wrap
== WORD_WRAP
)
6946 if (IT_DISPLAYING_WHITESPACE (it
))
6950 /* We have reached a glyph that follows one or more
6951 whitespace characters. If the position is
6952 already found, we are done. */
6953 if (atpos_it
.sp
>= 0)
6956 result
= MOVE_POS_MATCH_OR_ZV
;
6962 result
= MOVE_X_REACHED
;
6965 /* Otherwise, we can wrap here. */
6972 /* Remember the line height for the current line, in case
6973 the next element doesn't fit on the line. */
6974 ascent
= it
->max_ascent
;
6975 descent
= it
->max_descent
;
6977 /* The call to produce_glyphs will get the metrics of the
6978 display element IT is loaded with. Record the x-position
6979 before this display element, in case it doesn't fit on the
6983 PRODUCE_GLYPHS (it
);
6985 if (it
->area
!= TEXT_AREA
)
6987 set_iterator_to_next (it
, 1);
6988 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6989 SET_TEXT_POS (this_line_min_pos
,
6990 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6994 /* The number of glyphs we get back in IT->nglyphs will normally
6995 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6996 character on a terminal frame, or (iii) a line end. For the
6997 second case, IT->nglyphs - 1 padding glyphs will be present.
6998 (On X frames, there is only one glyph produced for a
6999 composite character.)
7001 The behavior implemented below means, for continuation lines,
7002 that as many spaces of a TAB as fit on the current line are
7003 displayed there. For terminal frames, as many glyphs of a
7004 multi-glyph character are displayed in the current line, too.
7005 This is what the old redisplay code did, and we keep it that
7006 way. Under X, the whole shape of a complex character must
7007 fit on the line or it will be completely displayed in the
7010 Note that both for tabs and padding glyphs, all glyphs have
7014 /* More than one glyph or glyph doesn't fit on line. All
7015 glyphs have the same width. */
7016 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7018 int x_before_this_char
= x
;
7019 int hpos_before_this_char
= it
->hpos
;
7021 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7023 new_x
= x
+ single_glyph_width
;
7025 /* We want to leave anything reaching TO_X to the caller. */
7026 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7028 if (BUFFER_POS_REACHED_P ())
7030 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7031 goto buffer_pos_reached
;
7032 if (atpos_it
.sp
< 0)
7035 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7040 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7043 result
= MOVE_X_REACHED
;
7049 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7054 if (/* Lines are continued. */
7055 it
->line_wrap
!= TRUNCATE
7056 && (/* And glyph doesn't fit on the line. */
7057 new_x
> it
->last_visible_x
7058 /* Or it fits exactly and we're on a window
7060 || (new_x
== it
->last_visible_x
7061 && FRAME_WINDOW_P (it
->f
))))
7063 if (/* IT->hpos == 0 means the very first glyph
7064 doesn't fit on the line, e.g. a wide image. */
7066 || (new_x
== it
->last_visible_x
7067 && FRAME_WINDOW_P (it
->f
)))
7070 it
->current_x
= new_x
;
7072 /* The character's last glyph just barely fits
7074 if (i
== it
->nglyphs
- 1)
7076 /* If this is the destination position,
7077 return a position *before* it in this row,
7078 now that we know it fits in this row. */
7079 if (BUFFER_POS_REACHED_P ())
7081 if (it
->line_wrap
!= WORD_WRAP
7084 it
->hpos
= hpos_before_this_char
;
7085 it
->current_x
= x_before_this_char
;
7086 result
= MOVE_POS_MATCH_OR_ZV
;
7089 if (it
->line_wrap
== WORD_WRAP
7093 atpos_it
.current_x
= x_before_this_char
;
7094 atpos_it
.hpos
= hpos_before_this_char
;
7098 set_iterator_to_next (it
, 1);
7099 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7100 SET_TEXT_POS (this_line_min_pos
,
7101 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7102 /* On graphical terminals, newlines may
7103 "overflow" into the fringe if
7104 overflow-newline-into-fringe is non-nil.
7105 On text-only terminals, newlines may
7106 overflow into the last glyph on the
7108 if (!FRAME_WINDOW_P (it
->f
)
7109 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7111 if (!get_next_display_element (it
))
7113 result
= MOVE_POS_MATCH_OR_ZV
;
7116 if (BUFFER_POS_REACHED_P ())
7118 if (ITERATOR_AT_END_OF_LINE_P (it
))
7119 result
= MOVE_POS_MATCH_OR_ZV
;
7121 result
= MOVE_LINE_CONTINUED
;
7124 if (ITERATOR_AT_END_OF_LINE_P (it
))
7126 result
= MOVE_NEWLINE_OR_CR
;
7133 IT_RESET_X_ASCENT_DESCENT (it
);
7135 if (wrap_it
.sp
>= 0)
7142 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7144 result
= MOVE_LINE_CONTINUED
;
7148 if (BUFFER_POS_REACHED_P ())
7150 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7151 goto buffer_pos_reached
;
7152 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7155 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7159 if (new_x
> it
->first_visible_x
)
7161 /* Glyph is visible. Increment number of glyphs that
7162 would be displayed. */
7167 if (result
!= MOVE_UNDEFINED
)
7170 else if (BUFFER_POS_REACHED_P ())
7173 IT_RESET_X_ASCENT_DESCENT (it
);
7174 result
= MOVE_POS_MATCH_OR_ZV
;
7177 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7179 /* Stop when TO_X specified and reached. This check is
7180 necessary here because of lines consisting of a line end,
7181 only. The line end will not produce any glyphs and we
7182 would never get MOVE_X_REACHED. */
7183 xassert (it
->nglyphs
== 0);
7184 result
= MOVE_X_REACHED
;
7188 /* Is this a line end? If yes, we're done. */
7189 if (ITERATOR_AT_END_OF_LINE_P (it
))
7191 result
= MOVE_NEWLINE_OR_CR
;
7195 if (it
->method
== GET_FROM_BUFFER
)
7196 prev_pos
= IT_CHARPOS (*it
);
7197 /* The current display element has been consumed. Advance
7199 set_iterator_to_next (it
, 1);
7200 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7201 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7203 /* Stop if lines are truncated and IT's current x-position is
7204 past the right edge of the window now. */
7205 if (it
->line_wrap
== TRUNCATE
7206 && it
->current_x
>= it
->last_visible_x
)
7208 if (!FRAME_WINDOW_P (it
->f
)
7209 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7211 if (!get_next_display_element (it
)
7212 || BUFFER_POS_REACHED_P ())
7214 result
= MOVE_POS_MATCH_OR_ZV
;
7217 if (ITERATOR_AT_END_OF_LINE_P (it
))
7219 result
= MOVE_NEWLINE_OR_CR
;
7223 result
= MOVE_LINE_TRUNCATED
;
7226 #undef IT_RESET_X_ASCENT_DESCENT
7229 #undef BUFFER_POS_REACHED_P
7231 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7232 restore the saved iterator. */
7233 if (atpos_it
.sp
>= 0)
7235 else if (atx_it
.sp
>= 0)
7240 /* Restore the iterator settings altered at the beginning of this
7242 it
->glyph_row
= saved_glyph_row
;
7246 /* For external use. */
7248 move_it_in_display_line (struct it
*it
,
7249 EMACS_INT to_charpos
, int to_x
,
7250 enum move_operation_enum op
)
7252 if (it
->line_wrap
== WORD_WRAP
7253 && (op
& MOVE_TO_X
))
7255 struct it save_it
= *it
;
7256 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7257 /* When word-wrap is on, TO_X may lie past the end
7258 of a wrapped line. Then it->current is the
7259 character on the next line, so backtrack to the
7260 space before the wrap point. */
7261 if (skip
== MOVE_LINE_CONTINUED
)
7263 int prev_x
= max (it
->current_x
- 1, 0);
7265 move_it_in_display_line_to
7266 (it
, -1, prev_x
, MOVE_TO_X
);
7270 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7274 /* Move IT forward until it satisfies one or more of the criteria in
7275 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7277 OP is a bit-mask that specifies where to stop, and in particular,
7278 which of those four position arguments makes a difference. See the
7279 description of enum move_operation_enum.
7281 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7282 screen line, this function will set IT to the next position >
7286 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7288 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7289 int line_height
, line_start_x
= 0, reached
= 0;
7293 if (op
& MOVE_TO_VPOS
)
7295 /* If no TO_CHARPOS and no TO_X specified, stop at the
7296 start of the line TO_VPOS. */
7297 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7299 if (it
->vpos
== to_vpos
)
7305 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7309 /* TO_VPOS >= 0 means stop at TO_X in the line at
7310 TO_VPOS, or at TO_POS, whichever comes first. */
7311 if (it
->vpos
== to_vpos
)
7317 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7319 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7324 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7326 /* We have reached TO_X but not in the line we want. */
7327 skip
= move_it_in_display_line_to (it
, to_charpos
,
7329 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7337 else if (op
& MOVE_TO_Y
)
7339 struct it it_backup
;
7341 if (it
->line_wrap
== WORD_WRAP
)
7344 /* TO_Y specified means stop at TO_X in the line containing
7345 TO_Y---or at TO_CHARPOS if this is reached first. The
7346 problem is that we can't really tell whether the line
7347 contains TO_Y before we have completely scanned it, and
7348 this may skip past TO_X. What we do is to first scan to
7351 If TO_X is not specified, use a TO_X of zero. The reason
7352 is to make the outcome of this function more predictable.
7353 If we didn't use TO_X == 0, we would stop at the end of
7354 the line which is probably not what a caller would expect
7356 skip
= move_it_in_display_line_to
7357 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7358 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7360 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7361 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7363 else if (skip
== MOVE_X_REACHED
)
7365 /* If TO_X was reached, we want to know whether TO_Y is
7366 in the line. We know this is the case if the already
7367 scanned glyphs make the line tall enough. Otherwise,
7368 we must check by scanning the rest of the line. */
7369 line_height
= it
->max_ascent
+ it
->max_descent
;
7370 if (to_y
>= it
->current_y
7371 && to_y
< it
->current_y
+ line_height
)
7377 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7378 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7380 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7381 line_height
= it
->max_ascent
+ it
->max_descent
;
7382 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7384 if (to_y
>= it
->current_y
7385 && to_y
< it
->current_y
+ line_height
)
7387 /* If TO_Y is in this line and TO_X was reached
7388 above, we scanned too far. We have to restore
7389 IT's settings to the ones before skipping. */
7396 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7402 /* Check whether TO_Y is in this line. */
7403 line_height
= it
->max_ascent
+ it
->max_descent
;
7404 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7406 if (to_y
>= it
->current_y
7407 && to_y
< it
->current_y
+ line_height
)
7409 /* When word-wrap is on, TO_X may lie past the end
7410 of a wrapped line. Then it->current is the
7411 character on the next line, so backtrack to the
7412 space before the wrap point. */
7413 if (skip
== MOVE_LINE_CONTINUED
7414 && it
->line_wrap
== WORD_WRAP
)
7416 int prev_x
= max (it
->current_x
- 1, 0);
7418 skip
= move_it_in_display_line_to
7419 (it
, -1, prev_x
, MOVE_TO_X
);
7428 else if (BUFFERP (it
->object
)
7429 && (it
->method
== GET_FROM_BUFFER
7430 || it
->method
== GET_FROM_STRETCH
)
7431 && IT_CHARPOS (*it
) >= to_charpos
)
7432 skip
= MOVE_POS_MATCH_OR_ZV
;
7434 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7438 case MOVE_POS_MATCH_OR_ZV
:
7442 case MOVE_NEWLINE_OR_CR
:
7443 set_iterator_to_next (it
, 1);
7444 it
->continuation_lines_width
= 0;
7447 case MOVE_LINE_TRUNCATED
:
7448 it
->continuation_lines_width
= 0;
7449 reseat_at_next_visible_line_start (it
, 0);
7450 if ((op
& MOVE_TO_POS
) != 0
7451 && IT_CHARPOS (*it
) > to_charpos
)
7458 case MOVE_LINE_CONTINUED
:
7459 /* For continued lines ending in a tab, some of the glyphs
7460 associated with the tab are displayed on the current
7461 line. Since it->current_x does not include these glyphs,
7462 we use it->last_visible_x instead. */
7465 it
->continuation_lines_width
+= it
->last_visible_x
;
7466 /* When moving by vpos, ensure that the iterator really
7467 advances to the next line (bug#847, bug#969). Fixme:
7468 do we need to do this in other circumstances? */
7469 if (it
->current_x
!= it
->last_visible_x
7470 && (op
& MOVE_TO_VPOS
)
7471 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7473 line_start_x
= it
->current_x
+ it
->pixel_width
7474 - it
->last_visible_x
;
7475 set_iterator_to_next (it
, 0);
7479 it
->continuation_lines_width
+= it
->current_x
;
7486 /* Reset/increment for the next run. */
7487 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7488 it
->current_x
= line_start_x
;
7491 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7493 last_height
= it
->max_ascent
+ it
->max_descent
;
7494 last_max_ascent
= it
->max_ascent
;
7495 it
->max_ascent
= it
->max_descent
= 0;
7500 /* On text terminals, we may stop at the end of a line in the middle
7501 of a multi-character glyph. If the glyph itself is continued,
7502 i.e. it is actually displayed on the next line, don't treat this
7503 stopping point as valid; move to the next line instead (unless
7504 that brings us offscreen). */
7505 if (!FRAME_WINDOW_P (it
->f
)
7507 && IT_CHARPOS (*it
) == to_charpos
7508 && it
->what
== IT_CHARACTER
7510 && it
->line_wrap
== WINDOW_WRAP
7511 && it
->current_x
== it
->last_visible_x
- 1
7514 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7516 it
->continuation_lines_width
+= it
->current_x
;
7517 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7518 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7520 last_height
= it
->max_ascent
+ it
->max_descent
;
7521 last_max_ascent
= it
->max_ascent
;
7524 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7528 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7530 If DY > 0, move IT backward at least that many pixels. DY = 0
7531 means move IT backward to the preceding line start or BEGV. This
7532 function may move over more than DY pixels if IT->current_y - DY
7533 ends up in the middle of a line; in this case IT->current_y will be
7534 set to the top of the line moved to. */
7537 move_it_vertically_backward (struct it
*it
, int dy
)
7541 EMACS_INT start_pos
;
7546 start_pos
= IT_CHARPOS (*it
);
7548 /* Estimate how many newlines we must move back. */
7549 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7551 /* Set the iterator's position that many lines back. */
7552 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7553 back_to_previous_visible_line_start (it
);
7555 /* Reseat the iterator here. When moving backward, we don't want
7556 reseat to skip forward over invisible text, set up the iterator
7557 to deliver from overlay strings at the new position etc. So,
7558 use reseat_1 here. */
7559 reseat_1 (it
, it
->current
.pos
, 1);
7561 /* We are now surely at a line start. */
7562 it
->current_x
= it
->hpos
= 0;
7563 it
->continuation_lines_width
= 0;
7565 /* Move forward and see what y-distance we moved. First move to the
7566 start of the next line so that we get its height. We need this
7567 height to be able to tell whether we reached the specified
7570 it2
.max_ascent
= it2
.max_descent
= 0;
7573 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7574 MOVE_TO_POS
| MOVE_TO_VPOS
);
7576 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7577 xassert (IT_CHARPOS (*it
) >= BEGV
);
7580 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7581 xassert (IT_CHARPOS (*it
) >= BEGV
);
7582 /* H is the actual vertical distance from the position in *IT
7583 and the starting position. */
7584 h
= it2
.current_y
- it
->current_y
;
7585 /* NLINES is the distance in number of lines. */
7586 nlines
= it2
.vpos
- it
->vpos
;
7588 /* Correct IT's y and vpos position
7589 so that they are relative to the starting point. */
7595 /* DY == 0 means move to the start of the screen line. The
7596 value of nlines is > 0 if continuation lines were involved. */
7598 move_it_by_lines (it
, nlines
);
7602 /* The y-position we try to reach, relative to *IT.
7603 Note that H has been subtracted in front of the if-statement. */
7604 int target_y
= it
->current_y
+ h
- dy
;
7605 int y0
= it3
.current_y
;
7606 int y1
= line_bottom_y (&it3
);
7607 int line_height
= y1
- y0
;
7609 /* If we did not reach target_y, try to move further backward if
7610 we can. If we moved too far backward, try to move forward. */
7611 if (target_y
< it
->current_y
7612 /* This is heuristic. In a window that's 3 lines high, with
7613 a line height of 13 pixels each, recentering with point
7614 on the bottom line will try to move -39/2 = 19 pixels
7615 backward. Try to avoid moving into the first line. */
7616 && (it
->current_y
- target_y
7617 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7618 && IT_CHARPOS (*it
) > BEGV
)
7620 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7621 target_y
- it
->current_y
));
7622 dy
= it
->current_y
- target_y
;
7623 goto move_further_back
;
7625 else if (target_y
>= it
->current_y
+ line_height
7626 && IT_CHARPOS (*it
) < ZV
)
7628 /* Should move forward by at least one line, maybe more.
7630 Note: Calling move_it_by_lines can be expensive on
7631 terminal frames, where compute_motion is used (via
7632 vmotion) to do the job, when there are very long lines
7633 and truncate-lines is nil. That's the reason for
7634 treating terminal frames specially here. */
7636 if (!FRAME_WINDOW_P (it
->f
))
7637 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7642 move_it_by_lines (it
, 1);
7644 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7651 /* Move IT by a specified amount of pixel lines DY. DY negative means
7652 move backwards. DY = 0 means move to start of screen line. At the
7653 end, IT will be on the start of a screen line. */
7656 move_it_vertically (struct it
*it
, int dy
)
7659 move_it_vertically_backward (it
, -dy
);
7662 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7663 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7664 MOVE_TO_POS
| MOVE_TO_Y
);
7665 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7667 /* If buffer ends in ZV without a newline, move to the start of
7668 the line to satisfy the post-condition. */
7669 if (IT_CHARPOS (*it
) == ZV
7671 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7672 move_it_by_lines (it
, 0);
7677 /* Move iterator IT past the end of the text line it is in. */
7680 move_it_past_eol (struct it
*it
)
7682 enum move_it_result rc
;
7684 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7685 if (rc
== MOVE_NEWLINE_OR_CR
)
7686 set_iterator_to_next (it
, 0);
7690 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7691 negative means move up. DVPOS == 0 means move to the start of the
7694 Optimization idea: If we would know that IT->f doesn't use
7695 a face with proportional font, we could be faster for
7696 truncate-lines nil. */
7699 move_it_by_lines (struct it
*it
, int dvpos
)
7702 /* The commented-out optimization uses vmotion on terminals. This
7703 gives bad results, because elements like it->what, on which
7704 callers such as pos_visible_p rely, aren't updated. */
7705 /* struct position pos;
7706 if (!FRAME_WINDOW_P (it->f))
7708 struct text_pos textpos;
7710 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7711 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7712 reseat (it, textpos, 1);
7713 it->vpos += pos.vpos;
7714 it->current_y += pos.vpos;
7720 /* DVPOS == 0 means move to the start of the screen line. */
7721 move_it_vertically_backward (it
, 0);
7722 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7723 /* Let next call to line_bottom_y calculate real line height */
7728 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7729 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7730 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7735 EMACS_INT start_charpos
, i
;
7737 /* Start at the beginning of the screen line containing IT's
7738 position. This may actually move vertically backwards,
7739 in case of overlays, so adjust dvpos accordingly. */
7741 move_it_vertically_backward (it
, 0);
7744 /* Go back -DVPOS visible lines and reseat the iterator there. */
7745 start_charpos
= IT_CHARPOS (*it
);
7746 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7747 back_to_previous_visible_line_start (it
);
7748 reseat (it
, it
->current
.pos
, 1);
7750 /* Move further back if we end up in a string or an image. */
7751 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7753 /* First try to move to start of display line. */
7755 move_it_vertically_backward (it
, 0);
7757 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7759 /* If start of line is still in string or image,
7760 move further back. */
7761 back_to_previous_visible_line_start (it
);
7762 reseat (it
, it
->current
.pos
, 1);
7766 it
->current_x
= it
->hpos
= 0;
7768 /* Above call may have moved too far if continuation lines
7769 are involved. Scan forward and see if it did. */
7771 it2
.vpos
= it2
.current_y
= 0;
7772 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7773 it
->vpos
-= it2
.vpos
;
7774 it
->current_y
-= it2
.current_y
;
7775 it
->current_x
= it
->hpos
= 0;
7777 /* If we moved too far back, move IT some lines forward. */
7778 if (it2
.vpos
> -dvpos
)
7780 int delta
= it2
.vpos
+ dvpos
;
7782 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7783 /* Move back again if we got too far ahead. */
7784 if (IT_CHARPOS (*it
) >= start_charpos
)
7790 /* Return 1 if IT points into the middle of a display vector. */
7793 in_display_vector_p (struct it
*it
)
7795 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7796 && it
->current
.dpvec_index
> 0
7797 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7801 /***********************************************************************
7803 ***********************************************************************/
7806 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7810 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7812 Lisp_Object args
[3];
7813 Lisp_Object msg
, fmt
;
7816 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7819 /* Do nothing if called asynchronously. Inserting text into
7820 a buffer may call after-change-functions and alike and
7821 that would means running Lisp asynchronously. */
7822 if (handling_signal
)
7826 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7828 args
[0] = fmt
= build_string (format
);
7831 msg
= Fformat (3, args
);
7833 len
= SBYTES (msg
) + 1;
7834 SAFE_ALLOCA (buffer
, char *, len
);
7835 memcpy (buffer
, SDATA (msg
), len
);
7837 message_dolog (buffer
, len
- 1, 1, 0);
7844 /* Output a newline in the *Messages* buffer if "needs" one. */
7847 message_log_maybe_newline (void)
7849 if (message_log_need_newline
)
7850 message_dolog ("", 0, 1, 0);
7854 /* Add a string M of length NBYTES to the message log, optionally
7855 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7856 nonzero, means interpret the contents of M as multibyte. This
7857 function calls low-level routines in order to bypass text property
7858 hooks, etc. which might not be safe to run.
7860 This may GC (insert may run before/after change hooks),
7861 so the buffer M must NOT point to a Lisp string. */
7864 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7866 const unsigned char *msg
= (const unsigned char *) m
;
7868 if (!NILP (Vmemory_full
))
7871 if (!NILP (Vmessage_log_max
))
7873 struct buffer
*oldbuf
;
7874 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7875 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7876 EMACS_INT point_at_end
= 0;
7877 EMACS_INT zv_at_end
= 0;
7878 Lisp_Object old_deactivate_mark
, tem
;
7879 struct gcpro gcpro1
;
7881 old_deactivate_mark
= Vdeactivate_mark
;
7882 oldbuf
= current_buffer
;
7883 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7884 BVAR (current_buffer
, undo_list
) = Qt
;
7886 oldpoint
= message_dolog_marker1
;
7887 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7888 oldbegv
= message_dolog_marker2
;
7889 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7890 oldzv
= message_dolog_marker3
;
7891 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7892 GCPRO1 (old_deactivate_mark
);
7900 BEGV_BYTE
= BEG_BYTE
;
7903 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7905 /* Insert the string--maybe converting multibyte to single byte
7906 or vice versa, so that all the text fits the buffer. */
7908 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7914 /* Convert a multibyte string to single-byte
7915 for the *Message* buffer. */
7916 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7918 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7919 work
[0] = (ASCII_CHAR_P (c
)
7921 : multibyte_char_to_unibyte (c
));
7922 insert_1_both (work
, 1, 1, 1, 0, 0);
7925 else if (! multibyte
7926 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7930 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7931 /* Convert a single-byte string to multibyte
7932 for the *Message* buffer. */
7933 for (i
= 0; i
< nbytes
; i
++)
7936 MAKE_CHAR_MULTIBYTE (c
);
7937 char_bytes
= CHAR_STRING (c
, str
);
7938 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7942 insert_1 (m
, nbytes
, 1, 0, 0);
7946 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7947 unsigned long int dups
;
7948 insert_1 ("\n", 1, 1, 0, 0);
7950 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7952 this_bol_byte
= PT_BYTE
;
7954 /* See if this line duplicates the previous one.
7955 If so, combine duplicates. */
7958 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7960 prev_bol_byte
= PT_BYTE
;
7962 dups
= message_log_check_duplicate (prev_bol_byte
,
7966 del_range_both (prev_bol
, prev_bol_byte
,
7967 this_bol
, this_bol_byte
, 0);
7973 /* If you change this format, don't forget to also
7974 change message_log_check_duplicate. */
7975 sprintf (dupstr
, " [%lu times]", dups
);
7976 duplen
= strlen (dupstr
);
7977 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7978 insert_1 (dupstr
, duplen
, 1, 0, 1);
7983 /* If we have more than the desired maximum number of lines
7984 in the *Messages* buffer now, delete the oldest ones.
7985 This is safe because we don't have undo in this buffer. */
7987 if (NATNUMP (Vmessage_log_max
))
7989 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7990 -XFASTINT (Vmessage_log_max
) - 1, 0);
7991 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7994 BEGV
= XMARKER (oldbegv
)->charpos
;
7995 BEGV_BYTE
= marker_byte_position (oldbegv
);
8004 ZV
= XMARKER (oldzv
)->charpos
;
8005 ZV_BYTE
= marker_byte_position (oldzv
);
8009 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8011 /* We can't do Fgoto_char (oldpoint) because it will run some
8013 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8014 XMARKER (oldpoint
)->bytepos
);
8017 unchain_marker (XMARKER (oldpoint
));
8018 unchain_marker (XMARKER (oldbegv
));
8019 unchain_marker (XMARKER (oldzv
));
8021 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8022 set_buffer_internal (oldbuf
);
8024 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8025 message_log_need_newline
= !nlflag
;
8026 Vdeactivate_mark
= old_deactivate_mark
;
8031 /* We are at the end of the buffer after just having inserted a newline.
8032 (Note: We depend on the fact we won't be crossing the gap.)
8033 Check to see if the most recent message looks a lot like the previous one.
8034 Return 0 if different, 1 if the new one should just replace it, or a
8035 value N > 1 if we should also append " [N times]". */
8037 static unsigned long int
8038 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8041 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8043 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8044 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8046 for (i
= 0; i
< len
; i
++)
8048 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8056 if (*p1
++ == ' ' && *p1
++ == '[')
8059 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8060 if (strncmp (pend
, " times]\n", 8) == 0)
8067 /* Display an echo area message M with a specified length of NBYTES
8068 bytes. The string may include null characters. If M is 0, clear
8069 out any existing message, and let the mini-buffer text show
8072 This may GC, so the buffer M must NOT point to a Lisp string. */
8075 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8077 /* First flush out any partial line written with print. */
8078 message_log_maybe_newline ();
8080 message_dolog (m
, nbytes
, 1, multibyte
);
8081 message2_nolog (m
, nbytes
, multibyte
);
8085 /* The non-logging counterpart of message2. */
8088 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8090 struct frame
*sf
= SELECTED_FRAME ();
8091 message_enable_multibyte
= multibyte
;
8093 if (FRAME_INITIAL_P (sf
))
8095 if (noninteractive_need_newline
)
8096 putc ('\n', stderr
);
8097 noninteractive_need_newline
= 0;
8099 fwrite (m
, nbytes
, 1, stderr
);
8100 if (cursor_in_echo_area
== 0)
8101 fprintf (stderr
, "\n");
8104 /* A null message buffer means that the frame hasn't really been
8105 initialized yet. Error messages get reported properly by
8106 cmd_error, so this must be just an informative message; toss it. */
8107 else if (INTERACTIVE
8108 && sf
->glyphs_initialized_p
8109 && FRAME_MESSAGE_BUF (sf
))
8111 Lisp_Object mini_window
;
8114 /* Get the frame containing the mini-buffer
8115 that the selected frame is using. */
8116 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8117 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8119 FRAME_SAMPLE_VISIBILITY (f
);
8120 if (FRAME_VISIBLE_P (sf
)
8121 && ! FRAME_VISIBLE_P (f
))
8122 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8126 set_message (m
, Qnil
, nbytes
, multibyte
);
8127 if (minibuffer_auto_raise
)
8128 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8131 clear_message (1, 1);
8133 do_pending_window_change (0);
8134 echo_area_display (1);
8135 do_pending_window_change (0);
8136 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8137 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8142 /* Display an echo area message M with a specified length of NBYTES
8143 bytes. The string may include null characters. If M is not a
8144 string, clear out any existing message, and let the mini-buffer
8147 This function cancels echoing. */
8150 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8152 struct gcpro gcpro1
;
8155 clear_message (1,1);
8158 /* First flush out any partial line written with print. */
8159 message_log_maybe_newline ();
8165 SAFE_ALLOCA (buffer
, char *, nbytes
);
8166 memcpy (buffer
, SDATA (m
), nbytes
);
8167 message_dolog (buffer
, nbytes
, 1, multibyte
);
8170 message3_nolog (m
, nbytes
, multibyte
);
8176 /* The non-logging version of message3.
8177 This does not cancel echoing, because it is used for echoing.
8178 Perhaps we need to make a separate function for echoing
8179 and make this cancel echoing. */
8182 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8184 struct frame
*sf
= SELECTED_FRAME ();
8185 message_enable_multibyte
= multibyte
;
8187 if (FRAME_INITIAL_P (sf
))
8189 if (noninteractive_need_newline
)
8190 putc ('\n', stderr
);
8191 noninteractive_need_newline
= 0;
8193 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8194 if (cursor_in_echo_area
== 0)
8195 fprintf (stderr
, "\n");
8198 /* A null message buffer means that the frame hasn't really been
8199 initialized yet. Error messages get reported properly by
8200 cmd_error, so this must be just an informative message; toss it. */
8201 else if (INTERACTIVE
8202 && sf
->glyphs_initialized_p
8203 && FRAME_MESSAGE_BUF (sf
))
8205 Lisp_Object mini_window
;
8209 /* Get the frame containing the mini-buffer
8210 that the selected frame is using. */
8211 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8212 frame
= XWINDOW (mini_window
)->frame
;
8215 FRAME_SAMPLE_VISIBILITY (f
);
8216 if (FRAME_VISIBLE_P (sf
)
8217 && !FRAME_VISIBLE_P (f
))
8218 Fmake_frame_visible (frame
);
8220 if (STRINGP (m
) && SCHARS (m
) > 0)
8222 set_message (NULL
, m
, nbytes
, multibyte
);
8223 if (minibuffer_auto_raise
)
8224 Fraise_frame (frame
);
8225 /* Assume we are not echoing.
8226 (If we are, echo_now will override this.) */
8227 echo_message_buffer
= Qnil
;
8230 clear_message (1, 1);
8232 do_pending_window_change (0);
8233 echo_area_display (1);
8234 do_pending_window_change (0);
8235 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8236 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8241 /* Display a null-terminated echo area message M. If M is 0, clear
8242 out any existing message, and let the mini-buffer text show through.
8244 The buffer M must continue to exist until after the echo area gets
8245 cleared or some other message gets displayed there. Do not pass
8246 text that is stored in a Lisp string. Do not pass text in a buffer
8247 that was alloca'd. */
8250 message1 (const char *m
)
8252 message2 (m
, (m
? strlen (m
) : 0), 0);
8256 /* The non-logging counterpart of message1. */
8259 message1_nolog (const char *m
)
8261 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8264 /* Display a message M which contains a single %s
8265 which gets replaced with STRING. */
8268 message_with_string (const char *m
, Lisp_Object string
, int log
)
8270 CHECK_STRING (string
);
8276 if (noninteractive_need_newline
)
8277 putc ('\n', stderr
);
8278 noninteractive_need_newline
= 0;
8279 fprintf (stderr
, m
, SDATA (string
));
8280 if (!cursor_in_echo_area
)
8281 fprintf (stderr
, "\n");
8285 else if (INTERACTIVE
)
8287 /* The frame whose minibuffer we're going to display the message on.
8288 It may be larger than the selected frame, so we need
8289 to use its buffer, not the selected frame's buffer. */
8290 Lisp_Object mini_window
;
8291 struct frame
*f
, *sf
= SELECTED_FRAME ();
8293 /* Get the frame containing the minibuffer
8294 that the selected frame is using. */
8295 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8296 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8298 /* A null message buffer means that the frame hasn't really been
8299 initialized yet. Error messages get reported properly by
8300 cmd_error, so this must be just an informative message; toss it. */
8301 if (FRAME_MESSAGE_BUF (f
))
8303 Lisp_Object args
[2], msg
;
8304 struct gcpro gcpro1
, gcpro2
;
8306 args
[0] = build_string (m
);
8307 args
[1] = msg
= string
;
8308 GCPRO2 (args
[0], msg
);
8311 msg
= Fformat (2, args
);
8314 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8316 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8320 /* Print should start at the beginning of the message
8321 buffer next time. */
8322 message_buf_print
= 0;
8328 /* Dump an informative message to the minibuf. If M is 0, clear out
8329 any existing message, and let the mini-buffer text show through. */
8332 vmessage (const char *m
, va_list ap
)
8338 if (noninteractive_need_newline
)
8339 putc ('\n', stderr
);
8340 noninteractive_need_newline
= 0;
8341 vfprintf (stderr
, m
, ap
);
8342 if (cursor_in_echo_area
== 0)
8343 fprintf (stderr
, "\n");
8347 else if (INTERACTIVE
)
8349 /* The frame whose mini-buffer we're going to display the message
8350 on. It may be larger than the selected frame, so we need to
8351 use its buffer, not the selected frame's buffer. */
8352 Lisp_Object mini_window
;
8353 struct frame
*f
, *sf
= SELECTED_FRAME ();
8355 /* Get the frame containing the mini-buffer
8356 that the selected frame is using. */
8357 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8358 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8360 /* A null message buffer means that the frame hasn't really been
8361 initialized yet. Error messages get reported properly by
8362 cmd_error, so this must be just an informative message; toss
8364 if (FRAME_MESSAGE_BUF (f
))
8368 char *buf
= FRAME_MESSAGE_BUF (f
);
8369 size_t bufsize
= FRAME_MESSAGE_BUF_SIZE (f
);
8372 memset (buf
, 0, bufsize
);
8373 len
= vsnprintf (buf
, bufsize
, m
, ap
);
8375 /* Do any truncation at a character boundary. */
8376 if (! (0 <= len
&& len
< bufsize
))
8377 for (len
= strnlen (buf
, bufsize
);
8378 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8382 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8387 /* Print should start at the beginning of the message
8388 buffer next time. */
8389 message_buf_print
= 0;
8395 message (const char *m
, ...)
8405 /* The non-logging version of message. */
8408 message_nolog (const char *m
, ...)
8410 Lisp_Object old_log_max
;
8413 old_log_max
= Vmessage_log_max
;
8414 Vmessage_log_max
= Qnil
;
8416 Vmessage_log_max
= old_log_max
;
8422 /* Display the current message in the current mini-buffer. This is
8423 only called from error handlers in process.c, and is not time
8427 update_echo_area (void)
8429 if (!NILP (echo_area_buffer
[0]))
8432 string
= Fcurrent_message ();
8433 message3 (string
, SBYTES (string
),
8434 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8439 /* Make sure echo area buffers in `echo_buffers' are live.
8440 If they aren't, make new ones. */
8443 ensure_echo_area_buffers (void)
8447 for (i
= 0; i
< 2; ++i
)
8448 if (!BUFFERP (echo_buffer
[i
])
8449 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8452 Lisp_Object old_buffer
;
8455 old_buffer
= echo_buffer
[i
];
8456 sprintf (name
, " *Echo Area %d*", i
);
8457 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8458 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8459 /* to force word wrap in echo area -
8460 it was decided to postpone this*/
8461 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8463 for (j
= 0; j
< 2; ++j
)
8464 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8465 echo_area_buffer
[j
] = echo_buffer
[i
];
8470 /* Call FN with args A1..A4 with either the current or last displayed
8471 echo_area_buffer as current buffer.
8473 WHICH zero means use the current message buffer
8474 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8475 from echo_buffer[] and clear it.
8477 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8478 suitable buffer from echo_buffer[] and clear it.
8480 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8481 that the current message becomes the last displayed one, make
8482 choose a suitable buffer for echo_area_buffer[0], and clear it.
8484 Value is what FN returns. */
8487 with_echo_area_buffer (struct window
*w
, int which
,
8488 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8489 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8492 int this_one
, the_other
, clear_buffer_p
, rc
;
8493 int count
= SPECPDL_INDEX ();
8495 /* If buffers aren't live, make new ones. */
8496 ensure_echo_area_buffers ();
8501 this_one
= 0, the_other
= 1;
8503 this_one
= 1, the_other
= 0;
8506 this_one
= 0, the_other
= 1;
8509 /* We need a fresh one in case the current echo buffer equals
8510 the one containing the last displayed echo area message. */
8511 if (!NILP (echo_area_buffer
[this_one
])
8512 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8513 echo_area_buffer
[this_one
] = Qnil
;
8516 /* Choose a suitable buffer from echo_buffer[] is we don't
8518 if (NILP (echo_area_buffer
[this_one
]))
8520 echo_area_buffer
[this_one
]
8521 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8522 ? echo_buffer
[the_other
]
8523 : echo_buffer
[this_one
]);
8527 buffer
= echo_area_buffer
[this_one
];
8529 /* Don't get confused by reusing the buffer used for echoing
8530 for a different purpose. */
8531 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8534 record_unwind_protect (unwind_with_echo_area_buffer
,
8535 with_echo_area_buffer_unwind_data (w
));
8537 /* Make the echo area buffer current. Note that for display
8538 purposes, it is not necessary that the displayed window's buffer
8539 == current_buffer, except for text property lookup. So, let's
8540 only set that buffer temporarily here without doing a full
8541 Fset_window_buffer. We must also change w->pointm, though,
8542 because otherwise an assertions in unshow_buffer fails, and Emacs
8544 set_buffer_internal_1 (XBUFFER (buffer
));
8548 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8551 BVAR (current_buffer
, undo_list
) = Qt
;
8552 BVAR (current_buffer
, read_only
) = Qnil
;
8553 specbind (Qinhibit_read_only
, Qt
);
8554 specbind (Qinhibit_modification_hooks
, Qt
);
8556 if (clear_buffer_p
&& Z
> BEG
)
8559 xassert (BEGV
>= BEG
);
8560 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8562 rc
= fn (a1
, a2
, a3
, a4
);
8564 xassert (BEGV
>= BEG
);
8565 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8567 unbind_to (count
, Qnil
);
8572 /* Save state that should be preserved around the call to the function
8573 FN called in with_echo_area_buffer. */
8576 with_echo_area_buffer_unwind_data (struct window
*w
)
8579 Lisp_Object vector
, tmp
;
8581 /* Reduce consing by keeping one vector in
8582 Vwith_echo_area_save_vector. */
8583 vector
= Vwith_echo_area_save_vector
;
8584 Vwith_echo_area_save_vector
= Qnil
;
8587 vector
= Fmake_vector (make_number (7), Qnil
);
8589 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8590 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8591 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8595 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8596 ASET (vector
, i
, w
->buffer
); ++i
;
8597 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8598 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8603 for (; i
< end
; ++i
)
8604 ASET (vector
, i
, Qnil
);
8607 xassert (i
== ASIZE (vector
));
8612 /* Restore global state from VECTOR which was created by
8613 with_echo_area_buffer_unwind_data. */
8616 unwind_with_echo_area_buffer (Lisp_Object vector
)
8618 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8619 Vdeactivate_mark
= AREF (vector
, 1);
8620 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8622 if (WINDOWP (AREF (vector
, 3)))
8625 Lisp_Object buffer
, charpos
, bytepos
;
8627 w
= XWINDOW (AREF (vector
, 3));
8628 buffer
= AREF (vector
, 4);
8629 charpos
= AREF (vector
, 5);
8630 bytepos
= AREF (vector
, 6);
8633 set_marker_both (w
->pointm
, buffer
,
8634 XFASTINT (charpos
), XFASTINT (bytepos
));
8637 Vwith_echo_area_save_vector
= vector
;
8642 /* Set up the echo area for use by print functions. MULTIBYTE_P
8643 non-zero means we will print multibyte. */
8646 setup_echo_area_for_printing (int multibyte_p
)
8648 /* If we can't find an echo area any more, exit. */
8649 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8652 ensure_echo_area_buffers ();
8654 if (!message_buf_print
)
8656 /* A message has been output since the last time we printed.
8657 Choose a fresh echo area buffer. */
8658 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8659 echo_area_buffer
[0] = echo_buffer
[1];
8661 echo_area_buffer
[0] = echo_buffer
[0];
8663 /* Switch to that buffer and clear it. */
8664 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8665 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8669 int count
= SPECPDL_INDEX ();
8670 specbind (Qinhibit_read_only
, Qt
);
8671 /* Note that undo recording is always disabled. */
8673 unbind_to (count
, Qnil
);
8675 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8677 /* Set up the buffer for the multibyteness we need. */
8679 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8680 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8682 /* Raise the frame containing the echo area. */
8683 if (minibuffer_auto_raise
)
8685 struct frame
*sf
= SELECTED_FRAME ();
8686 Lisp_Object mini_window
;
8687 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8688 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8691 message_log_maybe_newline ();
8692 message_buf_print
= 1;
8696 if (NILP (echo_area_buffer
[0]))
8698 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8699 echo_area_buffer
[0] = echo_buffer
[1];
8701 echo_area_buffer
[0] = echo_buffer
[0];
8704 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8706 /* Someone switched buffers between print requests. */
8707 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8708 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8714 /* Display an echo area message in window W. Value is non-zero if W's
8715 height is changed. If display_last_displayed_message_p is
8716 non-zero, display the message that was last displayed, otherwise
8717 display the current message. */
8720 display_echo_area (struct window
*w
)
8722 int i
, no_message_p
, window_height_changed_p
, count
;
8724 /* Temporarily disable garbage collections while displaying the echo
8725 area. This is done because a GC can print a message itself.
8726 That message would modify the echo area buffer's contents while a
8727 redisplay of the buffer is going on, and seriously confuse
8729 count
= inhibit_garbage_collection ();
8731 /* If there is no message, we must call display_echo_area_1
8732 nevertheless because it resizes the window. But we will have to
8733 reset the echo_area_buffer in question to nil at the end because
8734 with_echo_area_buffer will sets it to an empty buffer. */
8735 i
= display_last_displayed_message_p
? 1 : 0;
8736 no_message_p
= NILP (echo_area_buffer
[i
]);
8738 window_height_changed_p
8739 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8740 display_echo_area_1
,
8741 (EMACS_INT
) w
, Qnil
, 0, 0);
8744 echo_area_buffer
[i
] = Qnil
;
8746 unbind_to (count
, Qnil
);
8747 return window_height_changed_p
;
8751 /* Helper for display_echo_area. Display the current buffer which
8752 contains the current echo area message in window W, a mini-window,
8753 a pointer to which is passed in A1. A2..A4 are currently not used.
8754 Change the height of W so that all of the message is displayed.
8755 Value is non-zero if height of W was changed. */
8758 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8760 struct window
*w
= (struct window
*) a1
;
8762 struct text_pos start
;
8763 int window_height_changed_p
= 0;
8765 /* Do this before displaying, so that we have a large enough glyph
8766 matrix for the display. If we can't get enough space for the
8767 whole text, display the last N lines. That works by setting w->start. */
8768 window_height_changed_p
= resize_mini_window (w
, 0);
8770 /* Use the starting position chosen by resize_mini_window. */
8771 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8774 clear_glyph_matrix (w
->desired_matrix
);
8775 XSETWINDOW (window
, w
);
8776 try_window (window
, start
, 0);
8778 return window_height_changed_p
;
8782 /* Resize the echo area window to exactly the size needed for the
8783 currently displayed message, if there is one. If a mini-buffer
8784 is active, don't shrink it. */
8787 resize_echo_area_exactly (void)
8789 if (BUFFERP (echo_area_buffer
[0])
8790 && WINDOWP (echo_area_window
))
8792 struct window
*w
= XWINDOW (echo_area_window
);
8794 Lisp_Object resize_exactly
;
8796 if (minibuf_level
== 0)
8797 resize_exactly
= Qt
;
8799 resize_exactly
= Qnil
;
8801 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8802 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8805 ++windows_or_buffers_changed
;
8806 ++update_mode_lines
;
8807 redisplay_internal ();
8813 /* Callback function for with_echo_area_buffer, when used from
8814 resize_echo_area_exactly. A1 contains a pointer to the window to
8815 resize, EXACTLY non-nil means resize the mini-window exactly to the
8816 size of the text displayed. A3 and A4 are not used. Value is what
8817 resize_mini_window returns. */
8820 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8822 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8826 /* Resize mini-window W to fit the size of its contents. EXACT_P
8827 means size the window exactly to the size needed. Otherwise, it's
8828 only enlarged until W's buffer is empty.
8830 Set W->start to the right place to begin display. If the whole
8831 contents fit, start at the beginning. Otherwise, start so as
8832 to make the end of the contents appear. This is particularly
8833 important for y-or-n-p, but seems desirable generally.
8835 Value is non-zero if the window height has been changed. */
8838 resize_mini_window (struct window
*w
, int exact_p
)
8840 struct frame
*f
= XFRAME (w
->frame
);
8841 int window_height_changed_p
= 0;
8843 xassert (MINI_WINDOW_P (w
));
8845 /* By default, start display at the beginning. */
8846 set_marker_both (w
->start
, w
->buffer
,
8847 BUF_BEGV (XBUFFER (w
->buffer
)),
8848 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8850 /* Don't resize windows while redisplaying a window; it would
8851 confuse redisplay functions when the size of the window they are
8852 displaying changes from under them. Such a resizing can happen,
8853 for instance, when which-func prints a long message while
8854 we are running fontification-functions. We're running these
8855 functions with safe_call which binds inhibit-redisplay to t. */
8856 if (!NILP (Vinhibit_redisplay
))
8859 /* Nil means don't try to resize. */
8860 if (NILP (Vresize_mini_windows
)
8861 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8864 if (!FRAME_MINIBUF_ONLY_P (f
))
8867 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8868 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8869 int height
, max_height
;
8870 int unit
= FRAME_LINE_HEIGHT (f
);
8871 struct text_pos start
;
8872 struct buffer
*old_current_buffer
= NULL
;
8874 if (current_buffer
!= XBUFFER (w
->buffer
))
8876 old_current_buffer
= current_buffer
;
8877 set_buffer_internal (XBUFFER (w
->buffer
));
8880 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8882 /* Compute the max. number of lines specified by the user. */
8883 if (FLOATP (Vmax_mini_window_height
))
8884 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8885 else if (INTEGERP (Vmax_mini_window_height
))
8886 max_height
= XINT (Vmax_mini_window_height
);
8888 max_height
= total_height
/ 4;
8890 /* Correct that max. height if it's bogus. */
8891 max_height
= max (1, max_height
);
8892 max_height
= min (total_height
, max_height
);
8894 /* Find out the height of the text in the window. */
8895 if (it
.line_wrap
== TRUNCATE
)
8900 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8901 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8902 height
= it
.current_y
+ last_height
;
8904 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8905 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8906 height
= (height
+ unit
- 1) / unit
;
8909 /* Compute a suitable window start. */
8910 if (height
> max_height
)
8912 height
= max_height
;
8913 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8914 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8915 start
= it
.current
.pos
;
8918 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8919 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8921 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8923 /* Let it grow only, until we display an empty message, in which
8924 case the window shrinks again. */
8925 if (height
> WINDOW_TOTAL_LINES (w
))
8927 int old_height
= WINDOW_TOTAL_LINES (w
);
8928 freeze_window_starts (f
, 1);
8929 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8930 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8932 else if (height
< WINDOW_TOTAL_LINES (w
)
8933 && (exact_p
|| BEGV
== ZV
))
8935 int old_height
= WINDOW_TOTAL_LINES (w
);
8936 freeze_window_starts (f
, 0);
8937 shrink_mini_window (w
);
8938 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8943 /* Always resize to exact size needed. */
8944 if (height
> WINDOW_TOTAL_LINES (w
))
8946 int old_height
= WINDOW_TOTAL_LINES (w
);
8947 freeze_window_starts (f
, 1);
8948 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8949 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8951 else if (height
< WINDOW_TOTAL_LINES (w
))
8953 int old_height
= WINDOW_TOTAL_LINES (w
);
8954 freeze_window_starts (f
, 0);
8955 shrink_mini_window (w
);
8959 freeze_window_starts (f
, 1);
8960 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8963 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8967 if (old_current_buffer
)
8968 set_buffer_internal (old_current_buffer
);
8971 return window_height_changed_p
;
8975 /* Value is the current message, a string, or nil if there is no
8979 current_message (void)
8983 if (!BUFFERP (echo_area_buffer
[0]))
8987 with_echo_area_buffer (0, 0, current_message_1
,
8988 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8990 echo_area_buffer
[0] = Qnil
;
8998 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9000 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9003 *msg
= make_buffer_string (BEG
, Z
, 1);
9010 /* Push the current message on Vmessage_stack for later restauration
9011 by restore_message. Value is non-zero if the current message isn't
9012 empty. This is a relatively infrequent operation, so it's not
9013 worth optimizing. */
9019 msg
= current_message ();
9020 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9021 return STRINGP (msg
);
9025 /* Restore message display from the top of Vmessage_stack. */
9028 restore_message (void)
9032 xassert (CONSP (Vmessage_stack
));
9033 msg
= XCAR (Vmessage_stack
);
9035 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9037 message3_nolog (msg
, 0, 0);
9041 /* Handler for record_unwind_protect calling pop_message. */
9044 pop_message_unwind (Lisp_Object dummy
)
9050 /* Pop the top-most entry off Vmessage_stack. */
9055 xassert (CONSP (Vmessage_stack
));
9056 Vmessage_stack
= XCDR (Vmessage_stack
);
9060 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9061 exits. If the stack is not empty, we have a missing pop_message
9065 check_message_stack (void)
9067 if (!NILP (Vmessage_stack
))
9072 /* Truncate to NCHARS what will be displayed in the echo area the next
9073 time we display it---but don't redisplay it now. */
9076 truncate_echo_area (EMACS_INT nchars
)
9079 echo_area_buffer
[0] = Qnil
;
9080 /* A null message buffer means that the frame hasn't really been
9081 initialized yet. Error messages get reported properly by
9082 cmd_error, so this must be just an informative message; toss it. */
9083 else if (!noninteractive
9085 && !NILP (echo_area_buffer
[0]))
9087 struct frame
*sf
= SELECTED_FRAME ();
9088 if (FRAME_MESSAGE_BUF (sf
))
9089 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9094 /* Helper function for truncate_echo_area. Truncate the current
9095 message to at most NCHARS characters. */
9098 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9100 if (BEG
+ nchars
< Z
)
9101 del_range (BEG
+ nchars
, Z
);
9103 echo_area_buffer
[0] = Qnil
;
9108 /* Set the current message to a substring of S or STRING.
9110 If STRING is a Lisp string, set the message to the first NBYTES
9111 bytes from STRING. NBYTES zero means use the whole string. If
9112 STRING is multibyte, the message will be displayed multibyte.
9114 If S is not null, set the message to the first LEN bytes of S. LEN
9115 zero means use the whole string. MULTIBYTE_P non-zero means S is
9116 multibyte. Display the message multibyte in that case.
9118 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9119 to t before calling set_message_1 (which calls insert).
9123 set_message (const char *s
, Lisp_Object string
,
9124 EMACS_INT nbytes
, int multibyte_p
)
9126 message_enable_multibyte
9127 = ((s
&& multibyte_p
)
9128 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9130 with_echo_area_buffer (0, -1, set_message_1
,
9131 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9132 message_buf_print
= 0;
9133 help_echo_showing_p
= 0;
9137 /* Helper function for set_message. Arguments have the same meaning
9138 as there, with A1 corresponding to S and A2 corresponding to STRING
9139 This function is called with the echo area buffer being
9143 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9145 const char *s
= (const char *) a1
;
9146 const unsigned char *msg
= (const unsigned char *) s
;
9147 Lisp_Object string
= a2
;
9149 /* Change multibyteness of the echo buffer appropriately. */
9150 if (message_enable_multibyte
9151 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9152 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9154 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9155 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9156 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9158 /* Insert new message at BEG. */
9159 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9161 if (STRINGP (string
))
9166 nbytes
= SBYTES (string
);
9167 nchars
= string_byte_to_char (string
, nbytes
);
9169 /* This function takes care of single/multibyte conversion. We
9170 just have to ensure that the echo area buffer has the right
9171 setting of enable_multibyte_characters. */
9172 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9177 nbytes
= strlen (s
);
9179 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9181 /* Convert from multi-byte to single-byte. */
9186 /* Convert a multibyte string to single-byte. */
9187 for (i
= 0; i
< nbytes
; i
+= n
)
9189 c
= string_char_and_length (msg
+ i
, &n
);
9190 work
[0] = (ASCII_CHAR_P (c
)
9192 : multibyte_char_to_unibyte (c
));
9193 insert_1_both (work
, 1, 1, 1, 0, 0);
9196 else if (!multibyte_p
9197 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9199 /* Convert from single-byte to multi-byte. */
9202 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9204 /* Convert a single-byte string to multibyte. */
9205 for (i
= 0; i
< nbytes
; i
++)
9208 MAKE_CHAR_MULTIBYTE (c
);
9209 n
= CHAR_STRING (c
, str
);
9210 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9214 insert_1 (s
, nbytes
, 1, 0, 0);
9221 /* Clear messages. CURRENT_P non-zero means clear the current
9222 message. LAST_DISPLAYED_P non-zero means clear the message
9226 clear_message (int current_p
, int last_displayed_p
)
9230 echo_area_buffer
[0] = Qnil
;
9231 message_cleared_p
= 1;
9234 if (last_displayed_p
)
9235 echo_area_buffer
[1] = Qnil
;
9237 message_buf_print
= 0;
9240 /* Clear garbaged frames.
9242 This function is used where the old redisplay called
9243 redraw_garbaged_frames which in turn called redraw_frame which in
9244 turn called clear_frame. The call to clear_frame was a source of
9245 flickering. I believe a clear_frame is not necessary. It should
9246 suffice in the new redisplay to invalidate all current matrices,
9247 and ensure a complete redisplay of all windows. */
9250 clear_garbaged_frames (void)
9254 Lisp_Object tail
, frame
;
9255 int changed_count
= 0;
9257 FOR_EACH_FRAME (tail
, frame
)
9259 struct frame
*f
= XFRAME (frame
);
9261 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9265 Fredraw_frame (frame
);
9266 f
->force_flush_display_p
= 1;
9268 clear_current_matrices (f
);
9277 ++windows_or_buffers_changed
;
9282 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9283 is non-zero update selected_frame. Value is non-zero if the
9284 mini-windows height has been changed. */
9287 echo_area_display (int update_frame_p
)
9289 Lisp_Object mini_window
;
9292 int window_height_changed_p
= 0;
9293 struct frame
*sf
= SELECTED_FRAME ();
9295 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9296 w
= XWINDOW (mini_window
);
9297 f
= XFRAME (WINDOW_FRAME (w
));
9299 /* Don't display if frame is invisible or not yet initialized. */
9300 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9303 #ifdef HAVE_WINDOW_SYSTEM
9304 /* When Emacs starts, selected_frame may be the initial terminal
9305 frame. If we let this through, a message would be displayed on
9307 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9309 #endif /* HAVE_WINDOW_SYSTEM */
9311 /* Redraw garbaged frames. */
9313 clear_garbaged_frames ();
9315 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9317 echo_area_window
= mini_window
;
9318 window_height_changed_p
= display_echo_area (w
);
9319 w
->must_be_updated_p
= 1;
9321 /* Update the display, unless called from redisplay_internal.
9322 Also don't update the screen during redisplay itself. The
9323 update will happen at the end of redisplay, and an update
9324 here could cause confusion. */
9325 if (update_frame_p
&& !redisplaying_p
)
9329 /* If the display update has been interrupted by pending
9330 input, update mode lines in the frame. Due to the
9331 pending input, it might have been that redisplay hasn't
9332 been called, so that mode lines above the echo area are
9333 garbaged. This looks odd, so we prevent it here. */
9334 if (!display_completed
)
9335 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9337 if (window_height_changed_p
9338 /* Don't do this if Emacs is shutting down. Redisplay
9339 needs to run hooks. */
9340 && !NILP (Vrun_hooks
))
9342 /* Must update other windows. Likewise as in other
9343 cases, don't let this update be interrupted by
9345 int count
= SPECPDL_INDEX ();
9346 specbind (Qredisplay_dont_pause
, Qt
);
9347 windows_or_buffers_changed
= 1;
9348 redisplay_internal ();
9349 unbind_to (count
, Qnil
);
9351 else if (FRAME_WINDOW_P (f
) && n
== 0)
9353 /* Window configuration is the same as before.
9354 Can do with a display update of the echo area,
9355 unless we displayed some mode lines. */
9356 update_single_window (w
, 1);
9357 FRAME_RIF (f
)->flush_display (f
);
9360 update_frame (f
, 1, 1);
9362 /* If cursor is in the echo area, make sure that the next
9363 redisplay displays the minibuffer, so that the cursor will
9364 be replaced with what the minibuffer wants. */
9365 if (cursor_in_echo_area
)
9366 ++windows_or_buffers_changed
;
9369 else if (!EQ (mini_window
, selected_window
))
9370 windows_or_buffers_changed
++;
9372 /* Last displayed message is now the current message. */
9373 echo_area_buffer
[1] = echo_area_buffer
[0];
9374 /* Inform read_char that we're not echoing. */
9375 echo_message_buffer
= Qnil
;
9377 /* Prevent redisplay optimization in redisplay_internal by resetting
9378 this_line_start_pos. This is done because the mini-buffer now
9379 displays the message instead of its buffer text. */
9380 if (EQ (mini_window
, selected_window
))
9381 CHARPOS (this_line_start_pos
) = 0;
9383 return window_height_changed_p
;
9388 /***********************************************************************
9389 Mode Lines and Frame Titles
9390 ***********************************************************************/
9392 /* A buffer for constructing non-propertized mode-line strings and
9393 frame titles in it; allocated from the heap in init_xdisp and
9394 resized as needed in store_mode_line_noprop_char. */
9396 static char *mode_line_noprop_buf
;
9398 /* The buffer's end, and a current output position in it. */
9400 static char *mode_line_noprop_buf_end
;
9401 static char *mode_line_noprop_ptr
;
9403 #define MODE_LINE_NOPROP_LEN(start) \
9404 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9407 MODE_LINE_DISPLAY
= 0,
9413 /* Alist that caches the results of :propertize.
9414 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9415 static Lisp_Object mode_line_proptrans_alist
;
9417 /* List of strings making up the mode-line. */
9418 static Lisp_Object mode_line_string_list
;
9420 /* Base face property when building propertized mode line string. */
9421 static Lisp_Object mode_line_string_face
;
9422 static Lisp_Object mode_line_string_face_prop
;
9425 /* Unwind data for mode line strings */
9427 static Lisp_Object Vmode_line_unwind_vector
;
9430 format_mode_line_unwind_data (struct buffer
*obuf
,
9434 Lisp_Object vector
, tmp
;
9436 /* Reduce consing by keeping one vector in
9437 Vwith_echo_area_save_vector. */
9438 vector
= Vmode_line_unwind_vector
;
9439 Vmode_line_unwind_vector
= Qnil
;
9442 vector
= Fmake_vector (make_number (8), Qnil
);
9444 ASET (vector
, 0, make_number (mode_line_target
));
9445 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9446 ASET (vector
, 2, mode_line_string_list
);
9447 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9448 ASET (vector
, 4, mode_line_string_face
);
9449 ASET (vector
, 5, mode_line_string_face_prop
);
9452 XSETBUFFER (tmp
, obuf
);
9455 ASET (vector
, 6, tmp
);
9456 ASET (vector
, 7, owin
);
9462 unwind_format_mode_line (Lisp_Object vector
)
9464 mode_line_target
= XINT (AREF (vector
, 0));
9465 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9466 mode_line_string_list
= AREF (vector
, 2);
9467 if (! EQ (AREF (vector
, 3), Qt
))
9468 mode_line_proptrans_alist
= AREF (vector
, 3);
9469 mode_line_string_face
= AREF (vector
, 4);
9470 mode_line_string_face_prop
= AREF (vector
, 5);
9472 if (!NILP (AREF (vector
, 7)))
9473 /* Select window before buffer, since it may change the buffer. */
9474 Fselect_window (AREF (vector
, 7), Qt
);
9476 if (!NILP (AREF (vector
, 6)))
9478 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9479 ASET (vector
, 6, Qnil
);
9482 Vmode_line_unwind_vector
= vector
;
9487 /* Store a single character C for the frame title in mode_line_noprop_buf.
9488 Re-allocate mode_line_noprop_buf if necessary. */
9491 store_mode_line_noprop_char (char c
)
9493 /* If output position has reached the end of the allocated buffer,
9494 double the buffer's size. */
9495 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9497 int len
= MODE_LINE_NOPROP_LEN (0);
9498 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9499 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9500 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9501 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9504 *mode_line_noprop_ptr
++ = c
;
9508 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9509 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9510 characters that yield more columns than PRECISION; PRECISION <= 0
9511 means copy the whole string. Pad with spaces until FIELD_WIDTH
9512 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9513 pad. Called from display_mode_element when it is used to build a
9517 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9519 const unsigned char *str
= (const unsigned char *) string
;
9521 EMACS_INT dummy
, nbytes
;
9523 /* Copy at most PRECISION chars from STR. */
9524 nbytes
= strlen (string
);
9525 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9527 store_mode_line_noprop_char (*str
++);
9529 /* Fill up with spaces until FIELD_WIDTH reached. */
9530 while (field_width
> 0
9533 store_mode_line_noprop_char (' ');
9540 /***********************************************************************
9542 ***********************************************************************/
9544 #ifdef HAVE_WINDOW_SYSTEM
9546 /* Set the title of FRAME, if it has changed. The title format is
9547 Vicon_title_format if FRAME is iconified, otherwise it is
9548 frame_title_format. */
9551 x_consider_frame_title (Lisp_Object frame
)
9553 struct frame
*f
= XFRAME (frame
);
9555 if (FRAME_WINDOW_P (f
)
9556 || FRAME_MINIBUF_ONLY_P (f
)
9557 || f
->explicit_name
)
9559 /* Do we have more than one visible frame on this X display? */
9566 int count
= SPECPDL_INDEX ();
9568 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9570 Lisp_Object other_frame
= XCAR (tail
);
9571 struct frame
*tf
= XFRAME (other_frame
);
9574 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9575 && !FRAME_MINIBUF_ONLY_P (tf
)
9576 && !EQ (other_frame
, tip_frame
)
9577 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9581 /* Set global variable indicating that multiple frames exist. */
9582 multiple_frames
= CONSP (tail
);
9584 /* Switch to the buffer of selected window of the frame. Set up
9585 mode_line_target so that display_mode_element will output into
9586 mode_line_noprop_buf; then display the title. */
9587 record_unwind_protect (unwind_format_mode_line
,
9588 format_mode_line_unwind_data
9589 (current_buffer
, selected_window
, 0));
9591 Fselect_window (f
->selected_window
, Qt
);
9592 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9593 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9595 mode_line_target
= MODE_LINE_TITLE
;
9596 title_start
= MODE_LINE_NOPROP_LEN (0);
9597 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9598 NULL
, DEFAULT_FACE_ID
);
9599 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9600 len
= MODE_LINE_NOPROP_LEN (title_start
);
9601 title
= mode_line_noprop_buf
+ title_start
;
9602 unbind_to (count
, Qnil
);
9604 /* Set the title only if it's changed. This avoids consing in
9605 the common case where it hasn't. (If it turns out that we've
9606 already wasted too much time by walking through the list with
9607 display_mode_element, then we might need to optimize at a
9608 higher level than this.) */
9609 if (! STRINGP (f
->name
)
9610 || SBYTES (f
->name
) != len
9611 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9612 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9616 #endif /* not HAVE_WINDOW_SYSTEM */
9621 /***********************************************************************
9623 ***********************************************************************/
9626 /* Prepare for redisplay by updating menu-bar item lists when
9627 appropriate. This can call eval. */
9630 prepare_menu_bars (void)
9633 struct gcpro gcpro1
, gcpro2
;
9635 Lisp_Object tooltip_frame
;
9637 #ifdef HAVE_WINDOW_SYSTEM
9638 tooltip_frame
= tip_frame
;
9640 tooltip_frame
= Qnil
;
9643 /* Update all frame titles based on their buffer names, etc. We do
9644 this before the menu bars so that the buffer-menu will show the
9645 up-to-date frame titles. */
9646 #ifdef HAVE_WINDOW_SYSTEM
9647 if (windows_or_buffers_changed
|| update_mode_lines
)
9649 Lisp_Object tail
, frame
;
9651 FOR_EACH_FRAME (tail
, frame
)
9654 if (!EQ (frame
, tooltip_frame
)
9655 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9656 x_consider_frame_title (frame
);
9659 #endif /* HAVE_WINDOW_SYSTEM */
9661 /* Update the menu bar item lists, if appropriate. This has to be
9662 done before any actual redisplay or generation of display lines. */
9663 all_windows
= (update_mode_lines
9664 || buffer_shared
> 1
9665 || windows_or_buffers_changed
);
9668 Lisp_Object tail
, frame
;
9669 int count
= SPECPDL_INDEX ();
9670 /* 1 means that update_menu_bar has run its hooks
9671 so any further calls to update_menu_bar shouldn't do so again. */
9672 int menu_bar_hooks_run
= 0;
9674 record_unwind_save_match_data ();
9676 FOR_EACH_FRAME (tail
, frame
)
9680 /* Ignore tooltip frame. */
9681 if (EQ (frame
, tooltip_frame
))
9684 /* If a window on this frame changed size, report that to
9685 the user and clear the size-change flag. */
9686 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9688 Lisp_Object functions
;
9690 /* Clear flag first in case we get an error below. */
9691 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9692 functions
= Vwindow_size_change_functions
;
9693 GCPRO2 (tail
, functions
);
9695 while (CONSP (functions
))
9697 if (!EQ (XCAR (functions
), Qt
))
9698 call1 (XCAR (functions
), frame
);
9699 functions
= XCDR (functions
);
9705 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9706 #ifdef HAVE_WINDOW_SYSTEM
9707 update_tool_bar (f
, 0);
9710 if (windows_or_buffers_changed
9712 ns_set_doc_edited (f
, Fbuffer_modified_p
9713 (XWINDOW (f
->selected_window
)->buffer
));
9718 unbind_to (count
, Qnil
);
9722 struct frame
*sf
= SELECTED_FRAME ();
9723 update_menu_bar (sf
, 1, 0);
9724 #ifdef HAVE_WINDOW_SYSTEM
9725 update_tool_bar (sf
, 1);
9731 /* Update the menu bar item list for frame F. This has to be done
9732 before we start to fill in any display lines, because it can call
9735 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9737 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9738 already ran the menu bar hooks for this redisplay, so there
9739 is no need to run them again. The return value is the
9740 updated value of this flag, to pass to the next call. */
9743 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9746 register struct window
*w
;
9748 /* If called recursively during a menu update, do nothing. This can
9749 happen when, for instance, an activate-menubar-hook causes a
9751 if (inhibit_menubar_update
)
9754 window
= FRAME_SELECTED_WINDOW (f
);
9755 w
= XWINDOW (window
);
9757 if (FRAME_WINDOW_P (f
)
9759 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9760 || defined (HAVE_NS) || defined (USE_GTK)
9761 FRAME_EXTERNAL_MENU_BAR (f
)
9763 FRAME_MENU_BAR_LINES (f
) > 0
9765 : FRAME_MENU_BAR_LINES (f
) > 0)
9767 /* If the user has switched buffers or windows, we need to
9768 recompute to reflect the new bindings. But we'll
9769 recompute when update_mode_lines is set too; that means
9770 that people can use force-mode-line-update to request
9771 that the menu bar be recomputed. The adverse effect on
9772 the rest of the redisplay algorithm is about the same as
9773 windows_or_buffers_changed anyway. */
9774 if (windows_or_buffers_changed
9775 /* This used to test w->update_mode_line, but we believe
9776 there is no need to recompute the menu in that case. */
9777 || update_mode_lines
9778 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9779 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9780 != !NILP (w
->last_had_star
))
9781 || ((!NILP (Vtransient_mark_mode
)
9782 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9783 != !NILP (w
->region_showing
)))
9785 struct buffer
*prev
= current_buffer
;
9786 int count
= SPECPDL_INDEX ();
9788 specbind (Qinhibit_menubar_update
, Qt
);
9790 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9791 if (save_match_data
)
9792 record_unwind_save_match_data ();
9793 if (NILP (Voverriding_local_map_menu_flag
))
9795 specbind (Qoverriding_terminal_local_map
, Qnil
);
9796 specbind (Qoverriding_local_map
, Qnil
);
9801 /* Run the Lucid hook. */
9802 safe_run_hooks (Qactivate_menubar_hook
);
9804 /* If it has changed current-menubar from previous value,
9805 really recompute the menu-bar from the value. */
9806 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9807 call0 (Qrecompute_lucid_menubar
);
9809 safe_run_hooks (Qmenu_bar_update_hook
);
9814 XSETFRAME (Vmenu_updating_frame
, f
);
9815 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9817 /* Redisplay the menu bar in case we changed it. */
9818 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9819 || defined (HAVE_NS) || defined (USE_GTK)
9820 if (FRAME_WINDOW_P (f
))
9822 #if defined (HAVE_NS)
9823 /* All frames on Mac OS share the same menubar. So only
9824 the selected frame should be allowed to set it. */
9825 if (f
== SELECTED_FRAME ())
9827 set_frame_menubar (f
, 0, 0);
9830 /* On a terminal screen, the menu bar is an ordinary screen
9831 line, and this makes it get updated. */
9832 w
->update_mode_line
= Qt
;
9833 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9834 /* In the non-toolkit version, the menu bar is an ordinary screen
9835 line, and this makes it get updated. */
9836 w
->update_mode_line
= Qt
;
9837 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9839 unbind_to (count
, Qnil
);
9840 set_buffer_internal_1 (prev
);
9849 /***********************************************************************
9851 ***********************************************************************/
9853 #ifdef HAVE_WINDOW_SYSTEM
9856 Nominal cursor position -- where to draw output.
9857 HPOS and VPOS are window relative glyph matrix coordinates.
9858 X and Y are window relative pixel coordinates. */
9860 struct cursor_pos output_cursor
;
9864 Set the global variable output_cursor to CURSOR. All cursor
9865 positions are relative to updated_window. */
9868 set_output_cursor (struct cursor_pos
*cursor
)
9870 output_cursor
.hpos
= cursor
->hpos
;
9871 output_cursor
.vpos
= cursor
->vpos
;
9872 output_cursor
.x
= cursor
->x
;
9873 output_cursor
.y
= cursor
->y
;
9878 Set a nominal cursor position.
9880 HPOS and VPOS are column/row positions in a window glyph matrix. X
9881 and Y are window text area relative pixel positions.
9883 If this is done during an update, updated_window will contain the
9884 window that is being updated and the position is the future output
9885 cursor position for that window. If updated_window is null, use
9886 selected_window and display the cursor at the given position. */
9889 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9893 /* If updated_window is not set, work on selected_window. */
9897 w
= XWINDOW (selected_window
);
9899 /* Set the output cursor. */
9900 output_cursor
.hpos
= hpos
;
9901 output_cursor
.vpos
= vpos
;
9902 output_cursor
.x
= x
;
9903 output_cursor
.y
= y
;
9905 /* If not called as part of an update, really display the cursor.
9906 This will also set the cursor position of W. */
9907 if (updated_window
== NULL
)
9910 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9911 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9912 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9917 #endif /* HAVE_WINDOW_SYSTEM */
9920 /***********************************************************************
9922 ***********************************************************************/
9924 #ifdef HAVE_WINDOW_SYSTEM
9926 /* Where the mouse was last time we reported a mouse event. */
9928 FRAME_PTR last_mouse_frame
;
9930 /* Tool-bar item index of the item on which a mouse button was pressed
9933 int last_tool_bar_item
;
9937 update_tool_bar_unwind (Lisp_Object frame
)
9939 selected_frame
= frame
;
9943 /* Update the tool-bar item list for frame F. This has to be done
9944 before we start to fill in any display lines. Called from
9945 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9946 and restore it here. */
9949 update_tool_bar (struct frame
*f
, int save_match_data
)
9951 #if defined (USE_GTK) || defined (HAVE_NS)
9952 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9954 int do_update
= WINDOWP (f
->tool_bar_window
)
9955 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9963 window
= FRAME_SELECTED_WINDOW (f
);
9964 w
= XWINDOW (window
);
9966 /* If the user has switched buffers or windows, we need to
9967 recompute to reflect the new bindings. But we'll
9968 recompute when update_mode_lines is set too; that means
9969 that people can use force-mode-line-update to request
9970 that the menu bar be recomputed. The adverse effect on
9971 the rest of the redisplay algorithm is about the same as
9972 windows_or_buffers_changed anyway. */
9973 if (windows_or_buffers_changed
9974 || !NILP (w
->update_mode_line
)
9975 || update_mode_lines
9976 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9977 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9978 != !NILP (w
->last_had_star
))
9979 || ((!NILP (Vtransient_mark_mode
)
9980 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9981 != !NILP (w
->region_showing
)))
9983 struct buffer
*prev
= current_buffer
;
9984 int count
= SPECPDL_INDEX ();
9985 Lisp_Object frame
, new_tool_bar
;
9987 struct gcpro gcpro1
;
9989 /* Set current_buffer to the buffer of the selected
9990 window of the frame, so that we get the right local
9992 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9994 /* Save match data, if we must. */
9995 if (save_match_data
)
9996 record_unwind_save_match_data ();
9998 /* Make sure that we don't accidentally use bogus keymaps. */
9999 if (NILP (Voverriding_local_map_menu_flag
))
10001 specbind (Qoverriding_terminal_local_map
, Qnil
);
10002 specbind (Qoverriding_local_map
, Qnil
);
10005 GCPRO1 (new_tool_bar
);
10007 /* We must temporarily set the selected frame to this frame
10008 before calling tool_bar_items, because the calculation of
10009 the tool-bar keymap uses the selected frame (see
10010 `tool-bar-make-keymap' in tool-bar.el). */
10011 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10012 XSETFRAME (frame
, f
);
10013 selected_frame
= frame
;
10015 /* Build desired tool-bar items from keymaps. */
10016 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10019 /* Redisplay the tool-bar if we changed it. */
10020 if (new_n_tool_bar
!= f
->n_tool_bar_items
10021 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10023 /* Redisplay that happens asynchronously due to an expose event
10024 may access f->tool_bar_items. Make sure we update both
10025 variables within BLOCK_INPUT so no such event interrupts. */
10027 f
->tool_bar_items
= new_tool_bar
;
10028 f
->n_tool_bar_items
= new_n_tool_bar
;
10029 w
->update_mode_line
= Qt
;
10035 unbind_to (count
, Qnil
);
10036 set_buffer_internal_1 (prev
);
10042 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10043 F's desired tool-bar contents. F->tool_bar_items must have
10044 been set up previously by calling prepare_menu_bars. */
10047 build_desired_tool_bar_string (struct frame
*f
)
10049 int i
, size
, size_needed
;
10050 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10051 Lisp_Object image
, plist
, props
;
10053 image
= plist
= props
= Qnil
;
10054 GCPRO3 (image
, plist
, props
);
10056 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10057 Otherwise, make a new string. */
10059 /* The size of the string we might be able to reuse. */
10060 size
= (STRINGP (f
->desired_tool_bar_string
)
10061 ? SCHARS (f
->desired_tool_bar_string
)
10064 /* We need one space in the string for each image. */
10065 size_needed
= f
->n_tool_bar_items
;
10067 /* Reuse f->desired_tool_bar_string, if possible. */
10068 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10069 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10070 make_number (' '));
10073 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10074 Fremove_text_properties (make_number (0), make_number (size
),
10075 props
, f
->desired_tool_bar_string
);
10078 /* Put a `display' property on the string for the images to display,
10079 put a `menu_item' property on tool-bar items with a value that
10080 is the index of the item in F's tool-bar item vector. */
10081 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10083 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10085 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10086 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10087 int hmargin
, vmargin
, relief
, idx
, end
;
10089 /* If image is a vector, choose the image according to the
10091 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10092 if (VECTORP (image
))
10096 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10097 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10100 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10101 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10103 xassert (ASIZE (image
) >= idx
);
10104 image
= AREF (image
, idx
);
10109 /* Ignore invalid image specifications. */
10110 if (!valid_image_p (image
))
10113 /* Display the tool-bar button pressed, or depressed. */
10114 plist
= Fcopy_sequence (XCDR (image
));
10116 /* Compute margin and relief to draw. */
10117 relief
= (tool_bar_button_relief
>= 0
10118 ? tool_bar_button_relief
10119 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10120 hmargin
= vmargin
= relief
;
10122 if (INTEGERP (Vtool_bar_button_margin
)
10123 && XINT (Vtool_bar_button_margin
) > 0)
10125 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10126 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10128 else if (CONSP (Vtool_bar_button_margin
))
10130 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10131 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10132 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10134 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10135 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10136 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10139 if (auto_raise_tool_bar_buttons_p
)
10141 /* Add a `:relief' property to the image spec if the item is
10145 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10152 /* If image is selected, display it pressed, i.e. with a
10153 negative relief. If it's not selected, display it with a
10155 plist
= Fplist_put (plist
, QCrelief
,
10157 ? make_number (-relief
)
10158 : make_number (relief
)));
10163 /* Put a margin around the image. */
10164 if (hmargin
|| vmargin
)
10166 if (hmargin
== vmargin
)
10167 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10169 plist
= Fplist_put (plist
, QCmargin
,
10170 Fcons (make_number (hmargin
),
10171 make_number (vmargin
)));
10174 /* If button is not enabled, and we don't have special images
10175 for the disabled state, make the image appear disabled by
10176 applying an appropriate algorithm to it. */
10177 if (!enabled_p
&& idx
< 0)
10178 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10180 /* Put a `display' text property on the string for the image to
10181 display. Put a `menu-item' property on the string that gives
10182 the start of this item's properties in the tool-bar items
10184 image
= Fcons (Qimage
, plist
);
10185 props
= list4 (Qdisplay
, image
,
10186 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10188 /* Let the last image hide all remaining spaces in the tool bar
10189 string. The string can be longer than needed when we reuse a
10190 previous string. */
10191 if (i
+ 1 == f
->n_tool_bar_items
)
10192 end
= SCHARS (f
->desired_tool_bar_string
);
10195 Fadd_text_properties (make_number (i
), make_number (end
),
10196 props
, f
->desired_tool_bar_string
);
10204 /* Display one line of the tool-bar of frame IT->f.
10206 HEIGHT specifies the desired height of the tool-bar line.
10207 If the actual height of the glyph row is less than HEIGHT, the
10208 row's height is increased to HEIGHT, and the icons are centered
10209 vertically in the new height.
10211 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10212 count a final empty row in case the tool-bar width exactly matches
10217 display_tool_bar_line (struct it
*it
, int height
)
10219 struct glyph_row
*row
= it
->glyph_row
;
10220 int max_x
= it
->last_visible_x
;
10221 struct glyph
*last
;
10223 prepare_desired_row (row
);
10224 row
->y
= it
->current_y
;
10226 /* Note that this isn't made use of if the face hasn't a box,
10227 so there's no need to check the face here. */
10228 it
->start_of_box_run_p
= 1;
10230 while (it
->current_x
< max_x
)
10232 int x
, n_glyphs_before
, i
, nglyphs
;
10233 struct it it_before
;
10235 /* Get the next display element. */
10236 if (!get_next_display_element (it
))
10238 /* Don't count empty row if we are counting needed tool-bar lines. */
10239 if (height
< 0 && !it
->hpos
)
10244 /* Produce glyphs. */
10245 n_glyphs_before
= row
->used
[TEXT_AREA
];
10248 PRODUCE_GLYPHS (it
);
10250 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10252 x
= it_before
.current_x
;
10253 while (i
< nglyphs
)
10255 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10257 if (x
+ glyph
->pixel_width
> max_x
)
10259 /* Glyph doesn't fit on line. Backtrack. */
10260 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10262 /* If this is the only glyph on this line, it will never fit on the
10263 tool-bar, so skip it. But ensure there is at least one glyph,
10264 so we don't accidentally disable the tool-bar. */
10265 if (n_glyphs_before
== 0
10266 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10272 x
+= glyph
->pixel_width
;
10276 /* Stop at line ends. */
10277 if (ITERATOR_AT_END_OF_LINE_P (it
))
10280 set_iterator_to_next (it
, 1);
10285 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10287 /* Use default face for the border below the tool bar.
10289 FIXME: When auto-resize-tool-bars is grow-only, there is
10290 no additional border below the possibly empty tool-bar lines.
10291 So to make the extra empty lines look "normal", we have to
10292 use the tool-bar face for the border too. */
10293 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10294 it
->face_id
= DEFAULT_FACE_ID
;
10296 extend_face_to_end_of_line (it
);
10297 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10298 last
->right_box_line_p
= 1;
10299 if (last
== row
->glyphs
[TEXT_AREA
])
10300 last
->left_box_line_p
= 1;
10302 /* Make line the desired height and center it vertically. */
10303 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10305 /* Don't add more than one line height. */
10306 height
%= FRAME_LINE_HEIGHT (it
->f
);
10307 it
->max_ascent
+= height
/ 2;
10308 it
->max_descent
+= (height
+ 1) / 2;
10311 compute_line_metrics (it
);
10313 /* If line is empty, make it occupy the rest of the tool-bar. */
10314 if (!row
->displays_text_p
)
10316 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10317 row
->visible_height
= row
->height
;
10318 row
->ascent
= row
->phys_ascent
= 0;
10319 row
->extra_line_spacing
= 0;
10322 row
->full_width_p
= 1;
10323 row
->continued_p
= 0;
10324 row
->truncated_on_left_p
= 0;
10325 row
->truncated_on_right_p
= 0;
10327 it
->current_x
= it
->hpos
= 0;
10328 it
->current_y
+= row
->height
;
10334 /* Max tool-bar height. */
10336 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10337 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10339 /* Value is the number of screen lines needed to make all tool-bar
10340 items of frame F visible. The number of actual rows needed is
10341 returned in *N_ROWS if non-NULL. */
10344 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10346 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10348 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10349 the desired matrix, so use (unused) mode-line row as temporary row to
10350 avoid destroying the first tool-bar row. */
10351 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10353 /* Initialize an iterator for iteration over
10354 F->desired_tool_bar_string in the tool-bar window of frame F. */
10355 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10356 it
.first_visible_x
= 0;
10357 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10358 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10360 while (!ITERATOR_AT_END_P (&it
))
10362 clear_glyph_row (temp_row
);
10363 it
.glyph_row
= temp_row
;
10364 display_tool_bar_line (&it
, -1);
10366 clear_glyph_row (temp_row
);
10368 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10370 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10372 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10376 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10378 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10379 (Lisp_Object frame
)
10386 frame
= selected_frame
;
10388 CHECK_FRAME (frame
);
10389 f
= XFRAME (frame
);
10391 if (WINDOWP (f
->tool_bar_window
)
10392 || (w
= XWINDOW (f
->tool_bar_window
),
10393 WINDOW_TOTAL_LINES (w
) > 0))
10395 update_tool_bar (f
, 1);
10396 if (f
->n_tool_bar_items
)
10398 build_desired_tool_bar_string (f
);
10399 nlines
= tool_bar_lines_needed (f
, NULL
);
10403 return make_number (nlines
);
10407 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10408 height should be changed. */
10411 redisplay_tool_bar (struct frame
*f
)
10415 struct glyph_row
*row
;
10417 #if defined (USE_GTK) || defined (HAVE_NS)
10418 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10419 update_frame_tool_bar (f
);
10423 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10424 do anything. This means you must start with tool-bar-lines
10425 non-zero to get the auto-sizing effect. Or in other words, you
10426 can turn off tool-bars by specifying tool-bar-lines zero. */
10427 if (!WINDOWP (f
->tool_bar_window
)
10428 || (w
= XWINDOW (f
->tool_bar_window
),
10429 WINDOW_TOTAL_LINES (w
) == 0))
10432 /* Set up an iterator for the tool-bar window. */
10433 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10434 it
.first_visible_x
= 0;
10435 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10436 row
= it
.glyph_row
;
10438 /* Build a string that represents the contents of the tool-bar. */
10439 build_desired_tool_bar_string (f
);
10440 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10442 if (f
->n_tool_bar_rows
== 0)
10446 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10447 nlines
!= WINDOW_TOTAL_LINES (w
)))
10450 int old_height
= WINDOW_TOTAL_LINES (w
);
10452 XSETFRAME (frame
, f
);
10453 Fmodify_frame_parameters (frame
,
10454 Fcons (Fcons (Qtool_bar_lines
,
10455 make_number (nlines
)),
10457 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10459 clear_glyph_matrix (w
->desired_matrix
);
10460 fonts_changed_p
= 1;
10466 /* Display as many lines as needed to display all tool-bar items. */
10468 if (f
->n_tool_bar_rows
> 0)
10470 int border
, rows
, height
, extra
;
10472 if (INTEGERP (Vtool_bar_border
))
10473 border
= XINT (Vtool_bar_border
);
10474 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10475 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10476 else if (EQ (Vtool_bar_border
, Qborder_width
))
10477 border
= f
->border_width
;
10483 rows
= f
->n_tool_bar_rows
;
10484 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10485 extra
= it
.last_visible_y
- border
- height
* rows
;
10487 while (it
.current_y
< it
.last_visible_y
)
10490 if (extra
> 0 && rows
-- > 0)
10492 h
= (extra
+ rows
- 1) / rows
;
10495 display_tool_bar_line (&it
, height
+ h
);
10500 while (it
.current_y
< it
.last_visible_y
)
10501 display_tool_bar_line (&it
, 0);
10504 /* It doesn't make much sense to try scrolling in the tool-bar
10505 window, so don't do it. */
10506 w
->desired_matrix
->no_scrolling_p
= 1;
10507 w
->must_be_updated_p
= 1;
10509 if (!NILP (Vauto_resize_tool_bars
))
10511 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10512 int change_height_p
= 0;
10514 /* If we couldn't display everything, change the tool-bar's
10515 height if there is room for more. */
10516 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10517 && it
.current_y
< max_tool_bar_height
)
10518 change_height_p
= 1;
10520 row
= it
.glyph_row
- 1;
10522 /* If there are blank lines at the end, except for a partially
10523 visible blank line at the end that is smaller than
10524 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10525 if (!row
->displays_text_p
10526 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10527 change_height_p
= 1;
10529 /* If row displays tool-bar items, but is partially visible,
10530 change the tool-bar's height. */
10531 if (row
->displays_text_p
10532 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10533 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10534 change_height_p
= 1;
10536 /* Resize windows as needed by changing the `tool-bar-lines'
10537 frame parameter. */
10538 if (change_height_p
)
10541 int old_height
= WINDOW_TOTAL_LINES (w
);
10543 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10545 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10546 && !f
->minimize_tool_bar_window_p
)
10547 ? (nlines
> old_height
)
10548 : (nlines
!= old_height
));
10549 f
->minimize_tool_bar_window_p
= 0;
10551 if (change_height_p
)
10553 XSETFRAME (frame
, f
);
10554 Fmodify_frame_parameters (frame
,
10555 Fcons (Fcons (Qtool_bar_lines
,
10556 make_number (nlines
)),
10558 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10560 clear_glyph_matrix (w
->desired_matrix
);
10561 f
->n_tool_bar_rows
= nrows
;
10562 fonts_changed_p
= 1;
10569 f
->minimize_tool_bar_window_p
= 0;
10574 /* Get information about the tool-bar item which is displayed in GLYPH
10575 on frame F. Return in *PROP_IDX the index where tool-bar item
10576 properties start in F->tool_bar_items. Value is zero if
10577 GLYPH doesn't display a tool-bar item. */
10580 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10586 /* This function can be called asynchronously, which means we must
10587 exclude any possibility that Fget_text_property signals an
10589 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10590 charpos
= max (0, charpos
);
10592 /* Get the text property `menu-item' at pos. The value of that
10593 property is the start index of this item's properties in
10594 F->tool_bar_items. */
10595 prop
= Fget_text_property (make_number (charpos
),
10596 Qmenu_item
, f
->current_tool_bar_string
);
10597 if (INTEGERP (prop
))
10599 *prop_idx
= XINT (prop
);
10609 /* Get information about the tool-bar item at position X/Y on frame F.
10610 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10611 the current matrix of the tool-bar window of F, or NULL if not
10612 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10613 item in F->tool_bar_items. Value is
10615 -1 if X/Y is not on a tool-bar item
10616 0 if X/Y is on the same item that was highlighted before.
10620 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10621 int *hpos
, int *vpos
, int *prop_idx
)
10623 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10624 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10627 /* Find the glyph under X/Y. */
10628 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10629 if (*glyph
== NULL
)
10632 /* Get the start of this tool-bar item's properties in
10633 f->tool_bar_items. */
10634 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10637 /* Is mouse on the highlighted item? */
10638 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10639 && *vpos
>= hlinfo
->mouse_face_beg_row
10640 && *vpos
<= hlinfo
->mouse_face_end_row
10641 && (*vpos
> hlinfo
->mouse_face_beg_row
10642 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10643 && (*vpos
< hlinfo
->mouse_face_end_row
10644 || *hpos
< hlinfo
->mouse_face_end_col
10645 || hlinfo
->mouse_face_past_end
))
10653 Handle mouse button event on the tool-bar of frame F, at
10654 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10655 0 for button release. MODIFIERS is event modifiers for button
10659 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10660 unsigned int modifiers
)
10662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10663 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10664 int hpos
, vpos
, prop_idx
;
10665 struct glyph
*glyph
;
10666 Lisp_Object enabled_p
;
10668 /* If not on the highlighted tool-bar item, return. */
10669 frame_to_window_pixel_xy (w
, &x
, &y
);
10670 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10673 /* If item is disabled, do nothing. */
10674 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10675 if (NILP (enabled_p
))
10680 /* Show item in pressed state. */
10681 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10682 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10683 last_tool_bar_item
= prop_idx
;
10687 Lisp_Object key
, frame
;
10688 struct input_event event
;
10689 EVENT_INIT (event
);
10691 /* Show item in released state. */
10692 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10693 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10695 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10697 XSETFRAME (frame
, f
);
10698 event
.kind
= TOOL_BAR_EVENT
;
10699 event
.frame_or_window
= frame
;
10701 kbd_buffer_store_event (&event
);
10703 event
.kind
= TOOL_BAR_EVENT
;
10704 event
.frame_or_window
= frame
;
10706 event
.modifiers
= modifiers
;
10707 kbd_buffer_store_event (&event
);
10708 last_tool_bar_item
= -1;
10713 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10714 tool-bar window-relative coordinates X/Y. Called from
10715 note_mouse_highlight. */
10718 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10720 Lisp_Object window
= f
->tool_bar_window
;
10721 struct window
*w
= XWINDOW (window
);
10722 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10723 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10725 struct glyph
*glyph
;
10726 struct glyph_row
*row
;
10728 Lisp_Object enabled_p
;
10730 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10731 int mouse_down_p
, rc
;
10733 /* Function note_mouse_highlight is called with negative X/Y
10734 values when mouse moves outside of the frame. */
10735 if (x
<= 0 || y
<= 0)
10737 clear_mouse_face (hlinfo
);
10741 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10744 /* Not on tool-bar item. */
10745 clear_mouse_face (hlinfo
);
10749 /* On same tool-bar item as before. */
10750 goto set_help_echo
;
10752 clear_mouse_face (hlinfo
);
10754 /* Mouse is down, but on different tool-bar item? */
10755 mouse_down_p
= (dpyinfo
->grabbed
10756 && f
== last_mouse_frame
10757 && FRAME_LIVE_P (f
));
10759 && last_tool_bar_item
!= prop_idx
)
10762 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10763 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10765 /* If tool-bar item is not enabled, don't highlight it. */
10766 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10767 if (!NILP (enabled_p
))
10769 /* Compute the x-position of the glyph. In front and past the
10770 image is a space. We include this in the highlighted area. */
10771 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10772 for (i
= x
= 0; i
< hpos
; ++i
)
10773 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10775 /* Record this as the current active region. */
10776 hlinfo
->mouse_face_beg_col
= hpos
;
10777 hlinfo
->mouse_face_beg_row
= vpos
;
10778 hlinfo
->mouse_face_beg_x
= x
;
10779 hlinfo
->mouse_face_beg_y
= row
->y
;
10780 hlinfo
->mouse_face_past_end
= 0;
10782 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10783 hlinfo
->mouse_face_end_row
= vpos
;
10784 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10785 hlinfo
->mouse_face_end_y
= row
->y
;
10786 hlinfo
->mouse_face_window
= window
;
10787 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10789 /* Display it as active. */
10790 show_mouse_face (hlinfo
, draw
);
10791 hlinfo
->mouse_face_image_state
= draw
;
10796 /* Set help_echo_string to a help string to display for this tool-bar item.
10797 XTread_socket does the rest. */
10798 help_echo_object
= help_echo_window
= Qnil
;
10799 help_echo_pos
= -1;
10800 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10801 if (NILP (help_echo_string
))
10802 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10805 #endif /* HAVE_WINDOW_SYSTEM */
10809 /************************************************************************
10810 Horizontal scrolling
10811 ************************************************************************/
10813 static int hscroll_window_tree (Lisp_Object
);
10814 static int hscroll_windows (Lisp_Object
);
10816 /* For all leaf windows in the window tree rooted at WINDOW, set their
10817 hscroll value so that PT is (i) visible in the window, and (ii) so
10818 that it is not within a certain margin at the window's left and
10819 right border. Value is non-zero if any window's hscroll has been
10823 hscroll_window_tree (Lisp_Object window
)
10825 int hscrolled_p
= 0;
10826 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10827 int hscroll_step_abs
= 0;
10828 double hscroll_step_rel
= 0;
10830 if (hscroll_relative_p
)
10832 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10833 if (hscroll_step_rel
< 0)
10835 hscroll_relative_p
= 0;
10836 hscroll_step_abs
= 0;
10839 else if (INTEGERP (Vhscroll_step
))
10841 hscroll_step_abs
= XINT (Vhscroll_step
);
10842 if (hscroll_step_abs
< 0)
10843 hscroll_step_abs
= 0;
10846 hscroll_step_abs
= 0;
10848 while (WINDOWP (window
))
10850 struct window
*w
= XWINDOW (window
);
10852 if (WINDOWP (w
->hchild
))
10853 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10854 else if (WINDOWP (w
->vchild
))
10855 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10856 else if (w
->cursor
.vpos
>= 0)
10859 int text_area_width
;
10860 struct glyph_row
*current_cursor_row
10861 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10862 struct glyph_row
*desired_cursor_row
10863 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10864 struct glyph_row
*cursor_row
10865 = (desired_cursor_row
->enabled_p
10866 ? desired_cursor_row
10867 : current_cursor_row
);
10869 text_area_width
= window_box_width (w
, TEXT_AREA
);
10871 /* Scroll when cursor is inside this scroll margin. */
10872 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10874 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10875 && ((XFASTINT (w
->hscroll
)
10876 && w
->cursor
.x
<= h_margin
)
10877 || (cursor_row
->enabled_p
10878 && cursor_row
->truncated_on_right_p
10879 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10883 struct buffer
*saved_current_buffer
;
10887 /* Find point in a display of infinite width. */
10888 saved_current_buffer
= current_buffer
;
10889 current_buffer
= XBUFFER (w
->buffer
);
10891 if (w
== XWINDOW (selected_window
))
10895 pt
= marker_position (w
->pointm
);
10896 pt
= max (BEGV
, pt
);
10900 /* Move iterator to pt starting at cursor_row->start in
10901 a line with infinite width. */
10902 init_to_row_start (&it
, w
, cursor_row
);
10903 it
.last_visible_x
= INFINITY
;
10904 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10905 current_buffer
= saved_current_buffer
;
10907 /* Position cursor in window. */
10908 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10909 hscroll
= max (0, (it
.current_x
10910 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10911 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10912 : (text_area_width
/ 2))))
10913 / FRAME_COLUMN_WIDTH (it
.f
);
10914 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10916 if (hscroll_relative_p
)
10917 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10920 wanted_x
= text_area_width
10921 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10924 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10928 if (hscroll_relative_p
)
10929 wanted_x
= text_area_width
* hscroll_step_rel
10932 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10935 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10937 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10939 /* Don't call Fset_window_hscroll if value hasn't
10940 changed because it will prevent redisplay
10942 if (XFASTINT (w
->hscroll
) != hscroll
)
10944 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10945 w
->hscroll
= make_number (hscroll
);
10954 /* Value is non-zero if hscroll of any leaf window has been changed. */
10955 return hscrolled_p
;
10959 /* Set hscroll so that cursor is visible and not inside horizontal
10960 scroll margins for all windows in the tree rooted at WINDOW. See
10961 also hscroll_window_tree above. Value is non-zero if any window's
10962 hscroll has been changed. If it has, desired matrices on the frame
10963 of WINDOW are cleared. */
10966 hscroll_windows (Lisp_Object window
)
10968 int hscrolled_p
= hscroll_window_tree (window
);
10970 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10971 return hscrolled_p
;
10976 /************************************************************************
10978 ************************************************************************/
10980 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10981 to a non-zero value. This is sometimes handy to have in a debugger
10986 /* First and last unchanged row for try_window_id. */
10988 int debug_first_unchanged_at_end_vpos
;
10989 int debug_last_unchanged_at_beg_vpos
;
10991 /* Delta vpos and y. */
10993 int debug_dvpos
, debug_dy
;
10995 /* Delta in characters and bytes for try_window_id. */
10997 EMACS_INT debug_delta
, debug_delta_bytes
;
10999 /* Values of window_end_pos and window_end_vpos at the end of
11002 EMACS_INT debug_end_vpos
;
11004 /* Append a string to W->desired_matrix->method. FMT is a printf
11005 format string. A1...A9 are a supplement for a variable-length
11006 argument list. If trace_redisplay_p is non-zero also printf the
11007 resulting string to stderr. */
11010 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11013 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11016 char *method
= w
->desired_matrix
->method
;
11017 int len
= strlen (method
);
11018 int size
= sizeof w
->desired_matrix
->method
;
11019 int remaining
= size
- len
- 1;
11021 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11022 if (len
&& remaining
)
11025 --remaining
, ++len
;
11028 strncpy (method
+ len
, buffer
, remaining
);
11030 if (trace_redisplay_p
)
11031 fprintf (stderr
, "%p (%s): %s\n",
11033 ((BUFFERP (w
->buffer
)
11034 && STRINGP (XBUFFER (w
->buffer
)->name
))
11035 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11040 #endif /* GLYPH_DEBUG */
11043 /* Value is non-zero if all changes in window W, which displays
11044 current_buffer, are in the text between START and END. START is a
11045 buffer position, END is given as a distance from Z. Used in
11046 redisplay_internal for display optimization. */
11049 text_outside_line_unchanged_p (struct window
*w
,
11050 EMACS_INT start
, EMACS_INT end
)
11052 int unchanged_p
= 1;
11054 /* If text or overlays have changed, see where. */
11055 if (XFASTINT (w
->last_modified
) < MODIFF
11056 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11058 /* Gap in the line? */
11059 if (GPT
< start
|| Z
- GPT
< end
)
11062 /* Changes start in front of the line, or end after it? */
11064 && (BEG_UNCHANGED
< start
- 1
11065 || END_UNCHANGED
< end
))
11068 /* If selective display, can't optimize if changes start at the
11069 beginning of the line. */
11071 && INTEGERP (BVAR (current_buffer
, selective_display
))
11072 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11073 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11076 /* If there are overlays at the start or end of the line, these
11077 may have overlay strings with newlines in them. A change at
11078 START, for instance, may actually concern the display of such
11079 overlay strings as well, and they are displayed on different
11080 lines. So, quickly rule out this case. (For the future, it
11081 might be desirable to implement something more telling than
11082 just BEG/END_UNCHANGED.) */
11085 if (BEG
+ BEG_UNCHANGED
== start
11086 && overlay_touches_p (start
))
11088 if (END_UNCHANGED
== end
11089 && overlay_touches_p (Z
- end
))
11093 /* Under bidi reordering, adding or deleting a character in the
11094 beginning of a paragraph, before the first strong directional
11095 character, can change the base direction of the paragraph (unless
11096 the buffer specifies a fixed paragraph direction), which will
11097 require to redisplay the whole paragraph. It might be worthwhile
11098 to find the paragraph limits and widen the range of redisplayed
11099 lines to that, but for now just give up this optimization. */
11100 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11101 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11105 return unchanged_p
;
11109 /* Do a frame update, taking possible shortcuts into account. This is
11110 the main external entry point for redisplay.
11112 If the last redisplay displayed an echo area message and that message
11113 is no longer requested, we clear the echo area or bring back the
11114 mini-buffer if that is in use. */
11119 redisplay_internal ();
11124 overlay_arrow_string_or_property (Lisp_Object var
)
11128 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11131 return Voverlay_arrow_string
;
11134 /* Return 1 if there are any overlay-arrows in current_buffer. */
11136 overlay_arrow_in_current_buffer_p (void)
11140 for (vlist
= Voverlay_arrow_variable_list
;
11142 vlist
= XCDR (vlist
))
11144 Lisp_Object var
= XCAR (vlist
);
11147 if (!SYMBOLP (var
))
11149 val
= find_symbol_value (var
);
11151 && current_buffer
== XMARKER (val
)->buffer
)
11158 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11162 overlay_arrows_changed_p (void)
11166 for (vlist
= Voverlay_arrow_variable_list
;
11168 vlist
= XCDR (vlist
))
11170 Lisp_Object var
= XCAR (vlist
);
11171 Lisp_Object val
, pstr
;
11173 if (!SYMBOLP (var
))
11175 val
= find_symbol_value (var
);
11176 if (!MARKERP (val
))
11178 if (! EQ (COERCE_MARKER (val
),
11179 Fget (var
, Qlast_arrow_position
))
11180 || ! (pstr
= overlay_arrow_string_or_property (var
),
11181 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11187 /* Mark overlay arrows to be updated on next redisplay. */
11190 update_overlay_arrows (int up_to_date
)
11194 for (vlist
= Voverlay_arrow_variable_list
;
11196 vlist
= XCDR (vlist
))
11198 Lisp_Object var
= XCAR (vlist
);
11200 if (!SYMBOLP (var
))
11203 if (up_to_date
> 0)
11205 Lisp_Object val
= find_symbol_value (var
);
11206 Fput (var
, Qlast_arrow_position
,
11207 COERCE_MARKER (val
));
11208 Fput (var
, Qlast_arrow_string
,
11209 overlay_arrow_string_or_property (var
));
11211 else if (up_to_date
< 0
11212 || !NILP (Fget (var
, Qlast_arrow_position
)))
11214 Fput (var
, Qlast_arrow_position
, Qt
);
11215 Fput (var
, Qlast_arrow_string
, Qt
);
11221 /* Return overlay arrow string to display at row.
11222 Return integer (bitmap number) for arrow bitmap in left fringe.
11223 Return nil if no overlay arrow. */
11226 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11230 for (vlist
= Voverlay_arrow_variable_list
;
11232 vlist
= XCDR (vlist
))
11234 Lisp_Object var
= XCAR (vlist
);
11237 if (!SYMBOLP (var
))
11240 val
= find_symbol_value (var
);
11243 && current_buffer
== XMARKER (val
)->buffer
11244 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11246 if (FRAME_WINDOW_P (it
->f
)
11247 /* FIXME: if ROW->reversed_p is set, this should test
11248 the right fringe, not the left one. */
11249 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11251 #ifdef HAVE_WINDOW_SYSTEM
11252 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11255 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11256 return make_number (fringe_bitmap
);
11259 return make_number (-1); /* Use default arrow bitmap */
11261 return overlay_arrow_string_or_property (var
);
11268 /* Return 1 if point moved out of or into a composition. Otherwise
11269 return 0. PREV_BUF and PREV_PT are the last point buffer and
11270 position. BUF and PT are the current point buffer and position. */
11273 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11274 struct buffer
*buf
, EMACS_INT pt
)
11276 EMACS_INT start
, end
;
11278 Lisp_Object buffer
;
11280 XSETBUFFER (buffer
, buf
);
11281 /* Check a composition at the last point if point moved within the
11283 if (prev_buf
== buf
)
11286 /* Point didn't move. */
11289 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11290 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11291 && COMPOSITION_VALID_P (start
, end
, prop
)
11292 && start
< prev_pt
&& end
> prev_pt
)
11293 /* The last point was within the composition. Return 1 iff
11294 point moved out of the composition. */
11295 return (pt
<= start
|| pt
>= end
);
11298 /* Check a composition at the current point. */
11299 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11300 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11301 && COMPOSITION_VALID_P (start
, end
, prop
)
11302 && start
< pt
&& end
> pt
);
11306 /* Reconsider the setting of B->clip_changed which is displayed
11310 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11312 if (b
->clip_changed
11313 && !NILP (w
->window_end_valid
)
11314 && w
->current_matrix
->buffer
== b
11315 && w
->current_matrix
->zv
== BUF_ZV (b
)
11316 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11317 b
->clip_changed
= 0;
11319 /* If display wasn't paused, and W is not a tool bar window, see if
11320 point has been moved into or out of a composition. In that case,
11321 we set b->clip_changed to 1 to force updating the screen. If
11322 b->clip_changed has already been set to 1, we can skip this
11324 if (!b
->clip_changed
11325 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11329 if (w
== XWINDOW (selected_window
))
11332 pt
= marker_position (w
->pointm
);
11334 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11335 || pt
!= XINT (w
->last_point
))
11336 && check_point_in_composition (w
->current_matrix
->buffer
,
11337 XINT (w
->last_point
),
11338 XBUFFER (w
->buffer
), pt
))
11339 b
->clip_changed
= 1;
11344 /* Select FRAME to forward the values of frame-local variables into C
11345 variables so that the redisplay routines can access those values
11349 select_frame_for_redisplay (Lisp_Object frame
)
11351 Lisp_Object tail
, tem
;
11352 Lisp_Object old
= selected_frame
;
11353 struct Lisp_Symbol
*sym
;
11355 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11357 selected_frame
= frame
;
11360 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11361 if (CONSP (XCAR (tail
))
11362 && (tem
= XCAR (XCAR (tail
)),
11364 && (sym
= indirect_variable (XSYMBOL (tem
)),
11365 sym
->redirect
== SYMBOL_LOCALIZED
)
11366 && sym
->val
.blv
->frame_local
)
11367 /* Use find_symbol_value rather than Fsymbol_value
11368 to avoid an error if it is void. */
11369 find_symbol_value (tem
);
11370 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11374 #define STOP_POLLING \
11375 do { if (! polling_stopped_here) stop_polling (); \
11376 polling_stopped_here = 1; } while (0)
11378 #define RESUME_POLLING \
11379 do { if (polling_stopped_here) start_polling (); \
11380 polling_stopped_here = 0; } while (0)
11383 /* Perhaps in the future avoid recentering windows if it
11384 is not necessary; currently that causes some problems. */
11387 redisplay_internal (void)
11389 struct window
*w
= XWINDOW (selected_window
);
11393 int must_finish
= 0;
11394 struct text_pos tlbufpos
, tlendpos
;
11395 int number_of_visible_frames
;
11398 int polling_stopped_here
= 0;
11399 Lisp_Object old_frame
= selected_frame
;
11401 /* Non-zero means redisplay has to consider all windows on all
11402 frames. Zero means, only selected_window is considered. */
11403 int consider_all_windows_p
;
11405 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11407 /* No redisplay if running in batch mode or frame is not yet fully
11408 initialized, or redisplay is explicitly turned off by setting
11409 Vinhibit_redisplay. */
11410 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11411 || !NILP (Vinhibit_redisplay
))
11414 /* Don't examine these until after testing Vinhibit_redisplay.
11415 When Emacs is shutting down, perhaps because its connection to
11416 X has dropped, we should not look at them at all. */
11417 fr
= XFRAME (w
->frame
);
11418 sf
= SELECTED_FRAME ();
11420 if (!fr
->glyphs_initialized_p
)
11423 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11424 if (popup_activated ())
11428 /* I don't think this happens but let's be paranoid. */
11429 if (redisplaying_p
)
11432 /* Record a function that resets redisplaying_p to its old value
11433 when we leave this function. */
11434 count
= SPECPDL_INDEX ();
11435 record_unwind_protect (unwind_redisplay
,
11436 Fcons (make_number (redisplaying_p
), selected_frame
));
11438 specbind (Qinhibit_free_realized_faces
, Qnil
);
11441 Lisp_Object tail
, frame
;
11443 FOR_EACH_FRAME (tail
, frame
)
11445 struct frame
*f
= XFRAME (frame
);
11446 f
->already_hscrolled_p
= 0;
11451 /* Remember the currently selected window. */
11454 if (!EQ (old_frame
, selected_frame
)
11455 && FRAME_LIVE_P (XFRAME (old_frame
)))
11456 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11457 selected_frame and selected_window to be temporarily out-of-sync so
11458 when we come back here via `goto retry', we need to resync because we
11459 may need to run Elisp code (via prepare_menu_bars). */
11460 select_frame_for_redisplay (old_frame
);
11463 reconsider_clip_changes (w
, current_buffer
);
11464 last_escape_glyph_frame
= NULL
;
11465 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11466 last_glyphless_glyph_frame
= NULL
;
11467 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11469 /* If new fonts have been loaded that make a glyph matrix adjustment
11470 necessary, do it. */
11471 if (fonts_changed_p
)
11473 adjust_glyphs (NULL
);
11474 ++windows_or_buffers_changed
;
11475 fonts_changed_p
= 0;
11478 /* If face_change_count is non-zero, init_iterator will free all
11479 realized faces, which includes the faces referenced from current
11480 matrices. So, we can't reuse current matrices in this case. */
11481 if (face_change_count
)
11482 ++windows_or_buffers_changed
;
11484 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11485 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11487 /* Since frames on a single ASCII terminal share the same
11488 display area, displaying a different frame means redisplay
11489 the whole thing. */
11490 windows_or_buffers_changed
++;
11491 SET_FRAME_GARBAGED (sf
);
11493 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11495 FRAME_TTY (sf
)->previous_frame
= sf
;
11498 /* Set the visible flags for all frames. Do this before checking
11499 for resized or garbaged frames; they want to know if their frames
11500 are visible. See the comment in frame.h for
11501 FRAME_SAMPLE_VISIBILITY. */
11503 Lisp_Object tail
, frame
;
11505 number_of_visible_frames
= 0;
11507 FOR_EACH_FRAME (tail
, frame
)
11509 struct frame
*f
= XFRAME (frame
);
11511 FRAME_SAMPLE_VISIBILITY (f
);
11512 if (FRAME_VISIBLE_P (f
))
11513 ++number_of_visible_frames
;
11514 clear_desired_matrices (f
);
11518 /* Notice any pending interrupt request to change frame size. */
11519 do_pending_window_change (1);
11521 /* do_pending_window_change could change the selected_window due to
11522 frame resizing which makes the selected window too small. */
11523 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11526 reconsider_clip_changes (w
, current_buffer
);
11529 /* Clear frames marked as garbaged. */
11530 if (frame_garbaged
)
11531 clear_garbaged_frames ();
11533 /* Build menubar and tool-bar items. */
11534 if (NILP (Vmemory_full
))
11535 prepare_menu_bars ();
11537 if (windows_or_buffers_changed
)
11538 update_mode_lines
++;
11540 /* Detect case that we need to write or remove a star in the mode line. */
11541 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11543 w
->update_mode_line
= Qt
;
11544 if (buffer_shared
> 1)
11545 update_mode_lines
++;
11548 /* Avoid invocation of point motion hooks by `current_column' below. */
11549 count1
= SPECPDL_INDEX ();
11550 specbind (Qinhibit_point_motion_hooks
, Qt
);
11552 /* If %c is in the mode line, update it if needed. */
11553 if (!NILP (w
->column_number_displayed
)
11554 /* This alternative quickly identifies a common case
11555 where no change is needed. */
11556 && !(PT
== XFASTINT (w
->last_point
)
11557 && XFASTINT (w
->last_modified
) >= MODIFF
11558 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11559 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11560 w
->update_mode_line
= Qt
;
11562 unbind_to (count1
, Qnil
);
11564 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11566 /* The variable buffer_shared is set in redisplay_window and
11567 indicates that we redisplay a buffer in different windows. See
11569 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11570 || cursor_type_changed
);
11572 /* If specs for an arrow have changed, do thorough redisplay
11573 to ensure we remove any arrow that should no longer exist. */
11574 if (overlay_arrows_changed_p ())
11575 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11577 /* Normally the message* functions will have already displayed and
11578 updated the echo area, but the frame may have been trashed, or
11579 the update may have been preempted, so display the echo area
11580 again here. Checking message_cleared_p captures the case that
11581 the echo area should be cleared. */
11582 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11583 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11584 || (message_cleared_p
11585 && minibuf_level
== 0
11586 /* If the mini-window is currently selected, this means the
11587 echo-area doesn't show through. */
11588 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11590 int window_height_changed_p
= echo_area_display (0);
11593 /* If we don't display the current message, don't clear the
11594 message_cleared_p flag, because, if we did, we wouldn't clear
11595 the echo area in the next redisplay which doesn't preserve
11597 if (!display_last_displayed_message_p
)
11598 message_cleared_p
= 0;
11600 if (fonts_changed_p
)
11602 else if (window_height_changed_p
)
11604 consider_all_windows_p
= 1;
11605 ++update_mode_lines
;
11606 ++windows_or_buffers_changed
;
11608 /* If window configuration was changed, frames may have been
11609 marked garbaged. Clear them or we will experience
11610 surprises wrt scrolling. */
11611 if (frame_garbaged
)
11612 clear_garbaged_frames ();
11615 else if (EQ (selected_window
, minibuf_window
)
11616 && (current_buffer
->clip_changed
11617 || XFASTINT (w
->last_modified
) < MODIFF
11618 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11619 && resize_mini_window (w
, 0))
11621 /* Resized active mini-window to fit the size of what it is
11622 showing if its contents might have changed. */
11624 /* FIXME: this causes all frames to be updated, which seems unnecessary
11625 since only the current frame needs to be considered. This function needs
11626 to be rewritten with two variables, consider_all_windows and
11627 consider_all_frames. */
11628 consider_all_windows_p
= 1;
11629 ++windows_or_buffers_changed
;
11630 ++update_mode_lines
;
11632 /* If window configuration was changed, frames may have been
11633 marked garbaged. Clear them or we will experience
11634 surprises wrt scrolling. */
11635 if (frame_garbaged
)
11636 clear_garbaged_frames ();
11640 /* If showing the region, and mark has changed, we must redisplay
11641 the whole window. The assignment to this_line_start_pos prevents
11642 the optimization directly below this if-statement. */
11643 if (((!NILP (Vtransient_mark_mode
)
11644 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11645 != !NILP (w
->region_showing
))
11646 || (!NILP (w
->region_showing
)
11647 && !EQ (w
->region_showing
,
11648 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11649 CHARPOS (this_line_start_pos
) = 0;
11651 /* Optimize the case that only the line containing the cursor in the
11652 selected window has changed. Variables starting with this_ are
11653 set in display_line and record information about the line
11654 containing the cursor. */
11655 tlbufpos
= this_line_start_pos
;
11656 tlendpos
= this_line_end_pos
;
11657 if (!consider_all_windows_p
11658 && CHARPOS (tlbufpos
) > 0
11659 && NILP (w
->update_mode_line
)
11660 && !current_buffer
->clip_changed
11661 && !current_buffer
->prevent_redisplay_optimizations_p
11662 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11663 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11664 /* Make sure recorded data applies to current buffer, etc. */
11665 && this_line_buffer
== current_buffer
11666 && current_buffer
== XBUFFER (w
->buffer
)
11667 && NILP (w
->force_start
)
11668 && NILP (w
->optional_new_start
)
11669 /* Point must be on the line that we have info recorded about. */
11670 && PT
>= CHARPOS (tlbufpos
)
11671 && PT
<= Z
- CHARPOS (tlendpos
)
11672 /* All text outside that line, including its final newline,
11673 must be unchanged. */
11674 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11675 CHARPOS (tlendpos
)))
11677 if (CHARPOS (tlbufpos
) > BEGV
11678 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11679 && (CHARPOS (tlbufpos
) == ZV
11680 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11681 /* Former continuation line has disappeared by becoming empty. */
11683 else if (XFASTINT (w
->last_modified
) < MODIFF
11684 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11685 || MINI_WINDOW_P (w
))
11687 /* We have to handle the case of continuation around a
11688 wide-column character (see the comment in indent.c around
11691 For instance, in the following case:
11693 -------- Insert --------
11694 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11695 J_I_ ==> J_I_ `^^' are cursors.
11699 As we have to redraw the line above, we cannot use this
11703 int line_height_before
= this_line_pixel_height
;
11705 /* Note that start_display will handle the case that the
11706 line starting at tlbufpos is a continuation line. */
11707 start_display (&it
, w
, tlbufpos
);
11709 /* Implementation note: It this still necessary? */
11710 if (it
.current_x
!= this_line_start_x
)
11713 TRACE ((stderr
, "trying display optimization 1\n"));
11714 w
->cursor
.vpos
= -1;
11715 overlay_arrow_seen
= 0;
11716 it
.vpos
= this_line_vpos
;
11717 it
.current_y
= this_line_y
;
11718 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11719 display_line (&it
);
11721 /* If line contains point, is not continued,
11722 and ends at same distance from eob as before, we win. */
11723 if (w
->cursor
.vpos
>= 0
11724 /* Line is not continued, otherwise this_line_start_pos
11725 would have been set to 0 in display_line. */
11726 && CHARPOS (this_line_start_pos
)
11727 /* Line ends as before. */
11728 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11729 /* Line has same height as before. Otherwise other lines
11730 would have to be shifted up or down. */
11731 && this_line_pixel_height
== line_height_before
)
11733 /* If this is not the window's last line, we must adjust
11734 the charstarts of the lines below. */
11735 if (it
.current_y
< it
.last_visible_y
)
11737 struct glyph_row
*row
11738 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11739 EMACS_INT delta
, delta_bytes
;
11741 /* We used to distinguish between two cases here,
11742 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11743 when the line ends in a newline or the end of the
11744 buffer's accessible portion. But both cases did
11745 the same, so they were collapsed. */
11747 - CHARPOS (tlendpos
)
11748 - MATRIX_ROW_START_CHARPOS (row
));
11749 delta_bytes
= (Z_BYTE
11750 - BYTEPOS (tlendpos
)
11751 - MATRIX_ROW_START_BYTEPOS (row
));
11753 increment_matrix_positions (w
->current_matrix
,
11754 this_line_vpos
+ 1,
11755 w
->current_matrix
->nrows
,
11756 delta
, delta_bytes
);
11759 /* If this row displays text now but previously didn't,
11760 or vice versa, w->window_end_vpos may have to be
11762 if ((it
.glyph_row
- 1)->displays_text_p
)
11764 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11765 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11767 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11768 && this_line_vpos
> 0)
11769 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11770 w
->window_end_valid
= Qnil
;
11772 /* Update hint: No need to try to scroll in update_window. */
11773 w
->desired_matrix
->no_scrolling_p
= 1;
11776 *w
->desired_matrix
->method
= 0;
11777 debug_method_add (w
, "optimization 1");
11779 #ifdef HAVE_WINDOW_SYSTEM
11780 update_window_fringes (w
, 0);
11787 else if (/* Cursor position hasn't changed. */
11788 PT
== XFASTINT (w
->last_point
)
11789 /* Make sure the cursor was last displayed
11790 in this window. Otherwise we have to reposition it. */
11791 && 0 <= w
->cursor
.vpos
11792 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11796 do_pending_window_change (1);
11797 /* If selected_window changed, redisplay again. */
11798 if (WINDOWP (selected_window
)
11799 && (w
= XWINDOW (selected_window
)) != sw
)
11802 /* We used to always goto end_of_redisplay here, but this
11803 isn't enough if we have a blinking cursor. */
11804 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11805 goto end_of_redisplay
;
11809 /* If highlighting the region, or if the cursor is in the echo area,
11810 then we can't just move the cursor. */
11811 else if (! (!NILP (Vtransient_mark_mode
)
11812 && !NILP (BVAR (current_buffer
, mark_active
)))
11813 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11814 || highlight_nonselected_windows
)
11815 && NILP (w
->region_showing
)
11816 && NILP (Vshow_trailing_whitespace
)
11817 && !cursor_in_echo_area
)
11820 struct glyph_row
*row
;
11822 /* Skip from tlbufpos to PT and see where it is. Note that
11823 PT may be in invisible text. If so, we will end at the
11824 next visible position. */
11825 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11826 NULL
, DEFAULT_FACE_ID
);
11827 it
.current_x
= this_line_start_x
;
11828 it
.current_y
= this_line_y
;
11829 it
.vpos
= this_line_vpos
;
11831 /* The call to move_it_to stops in front of PT, but
11832 moves over before-strings. */
11833 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11835 if (it
.vpos
== this_line_vpos
11836 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11839 xassert (this_line_vpos
== it
.vpos
);
11840 xassert (this_line_y
== it
.current_y
);
11841 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11843 *w
->desired_matrix
->method
= 0;
11844 debug_method_add (w
, "optimization 3");
11853 /* Text changed drastically or point moved off of line. */
11854 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11857 CHARPOS (this_line_start_pos
) = 0;
11858 consider_all_windows_p
|= buffer_shared
> 1;
11859 ++clear_face_cache_count
;
11860 #ifdef HAVE_WINDOW_SYSTEM
11861 ++clear_image_cache_count
;
11864 /* Build desired matrices, and update the display. If
11865 consider_all_windows_p is non-zero, do it for all windows on all
11866 frames. Otherwise do it for selected_window, only. */
11868 if (consider_all_windows_p
)
11870 Lisp_Object tail
, frame
;
11872 FOR_EACH_FRAME (tail
, frame
)
11873 XFRAME (frame
)->updated_p
= 0;
11875 /* Recompute # windows showing selected buffer. This will be
11876 incremented each time such a window is displayed. */
11879 FOR_EACH_FRAME (tail
, frame
)
11881 struct frame
*f
= XFRAME (frame
);
11883 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11885 if (! EQ (frame
, selected_frame
))
11886 /* Select the frame, for the sake of frame-local
11888 select_frame_for_redisplay (frame
);
11890 /* Mark all the scroll bars to be removed; we'll redeem
11891 the ones we want when we redisplay their windows. */
11892 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11893 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11895 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11896 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11898 /* The X error handler may have deleted that frame. */
11899 if (!FRAME_LIVE_P (f
))
11902 /* Any scroll bars which redisplay_windows should have
11903 nuked should now go away. */
11904 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11905 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11907 /* If fonts changed, display again. */
11908 /* ??? rms: I suspect it is a mistake to jump all the way
11909 back to retry here. It should just retry this frame. */
11910 if (fonts_changed_p
)
11913 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11915 /* See if we have to hscroll. */
11916 if (!f
->already_hscrolled_p
)
11918 f
->already_hscrolled_p
= 1;
11919 if (hscroll_windows (f
->root_window
))
11923 /* Prevent various kinds of signals during display
11924 update. stdio is not robust about handling
11925 signals, which can cause an apparent I/O
11927 if (interrupt_input
)
11928 unrequest_sigio ();
11931 /* Update the display. */
11932 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11933 pending
|= update_frame (f
, 0, 0);
11939 if (!EQ (old_frame
, selected_frame
)
11940 && FRAME_LIVE_P (XFRAME (old_frame
)))
11941 /* We played a bit fast-and-loose above and allowed selected_frame
11942 and selected_window to be temporarily out-of-sync but let's make
11943 sure this stays contained. */
11944 select_frame_for_redisplay (old_frame
);
11945 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11949 /* Do the mark_window_display_accurate after all windows have
11950 been redisplayed because this call resets flags in buffers
11951 which are needed for proper redisplay. */
11952 FOR_EACH_FRAME (tail
, frame
)
11954 struct frame
*f
= XFRAME (frame
);
11957 mark_window_display_accurate (f
->root_window
, 1);
11958 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11959 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11964 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11966 Lisp_Object mini_window
;
11967 struct frame
*mini_frame
;
11969 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11970 /* Use list_of_error, not Qerror, so that
11971 we catch only errors and don't run the debugger. */
11972 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11974 redisplay_window_error
);
11976 /* Compare desired and current matrices, perform output. */
11979 /* If fonts changed, display again. */
11980 if (fonts_changed_p
)
11983 /* Prevent various kinds of signals during display update.
11984 stdio is not robust about handling signals,
11985 which can cause an apparent I/O error. */
11986 if (interrupt_input
)
11987 unrequest_sigio ();
11990 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11992 if (hscroll_windows (selected_window
))
11995 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11996 pending
= update_frame (sf
, 0, 0);
11999 /* We may have called echo_area_display at the top of this
12000 function. If the echo area is on another frame, that may
12001 have put text on a frame other than the selected one, so the
12002 above call to update_frame would not have caught it. Catch
12004 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12005 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12007 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12009 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12010 pending
|= update_frame (mini_frame
, 0, 0);
12011 if (!pending
&& hscroll_windows (mini_window
))
12016 /* If display was paused because of pending input, make sure we do a
12017 thorough update the next time. */
12020 /* Prevent the optimization at the beginning of
12021 redisplay_internal that tries a single-line update of the
12022 line containing the cursor in the selected window. */
12023 CHARPOS (this_line_start_pos
) = 0;
12025 /* Let the overlay arrow be updated the next time. */
12026 update_overlay_arrows (0);
12028 /* If we pause after scrolling, some rows in the current
12029 matrices of some windows are not valid. */
12030 if (!WINDOW_FULL_WIDTH_P (w
)
12031 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12032 update_mode_lines
= 1;
12036 if (!consider_all_windows_p
)
12038 /* This has already been done above if
12039 consider_all_windows_p is set. */
12040 mark_window_display_accurate_1 (w
, 1);
12042 /* Say overlay arrows are up to date. */
12043 update_overlay_arrows (1);
12045 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12046 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12049 update_mode_lines
= 0;
12050 windows_or_buffers_changed
= 0;
12051 cursor_type_changed
= 0;
12054 /* Start SIGIO interrupts coming again. Having them off during the
12055 code above makes it less likely one will discard output, but not
12056 impossible, since there might be stuff in the system buffer here.
12057 But it is much hairier to try to do anything about that. */
12058 if (interrupt_input
)
12062 /* If a frame has become visible which was not before, redisplay
12063 again, so that we display it. Expose events for such a frame
12064 (which it gets when becoming visible) don't call the parts of
12065 redisplay constructing glyphs, so simply exposing a frame won't
12066 display anything in this case. So, we have to display these
12067 frames here explicitly. */
12070 Lisp_Object tail
, frame
;
12073 FOR_EACH_FRAME (tail
, frame
)
12075 int this_is_visible
= 0;
12077 if (XFRAME (frame
)->visible
)
12078 this_is_visible
= 1;
12079 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12080 if (XFRAME (frame
)->visible
)
12081 this_is_visible
= 1;
12083 if (this_is_visible
)
12087 if (new_count
!= number_of_visible_frames
)
12088 windows_or_buffers_changed
++;
12091 /* Change frame size now if a change is pending. */
12092 do_pending_window_change (1);
12094 /* If we just did a pending size change, or have additional
12095 visible frames, or selected_window changed, redisplay again. */
12096 if ((windows_or_buffers_changed
&& !pending
)
12097 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12100 /* Clear the face and image caches.
12102 We used to do this only if consider_all_windows_p. But the cache
12103 needs to be cleared if a timer creates images in the current
12104 buffer (e.g. the test case in Bug#6230). */
12106 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12108 clear_face_cache (0);
12109 clear_face_cache_count
= 0;
12112 #ifdef HAVE_WINDOW_SYSTEM
12113 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12115 clear_image_caches (Qnil
);
12116 clear_image_cache_count
= 0;
12118 #endif /* HAVE_WINDOW_SYSTEM */
12121 unbind_to (count
, Qnil
);
12126 /* Redisplay, but leave alone any recent echo area message unless
12127 another message has been requested in its place.
12129 This is useful in situations where you need to redisplay but no
12130 user action has occurred, making it inappropriate for the message
12131 area to be cleared. See tracking_off and
12132 wait_reading_process_output for examples of these situations.
12134 FROM_WHERE is an integer saying from where this function was
12135 called. This is useful for debugging. */
12138 redisplay_preserve_echo_area (int from_where
)
12140 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12142 if (!NILP (echo_area_buffer
[1]))
12144 /* We have a previously displayed message, but no current
12145 message. Redisplay the previous message. */
12146 display_last_displayed_message_p
= 1;
12147 redisplay_internal ();
12148 display_last_displayed_message_p
= 0;
12151 redisplay_internal ();
12153 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12154 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12155 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12159 /* Function registered with record_unwind_protect in
12160 redisplay_internal. Reset redisplaying_p to the value it had
12161 before redisplay_internal was called, and clear
12162 prevent_freeing_realized_faces_p. It also selects the previously
12163 selected frame, unless it has been deleted (by an X connection
12164 failure during redisplay, for example). */
12167 unwind_redisplay (Lisp_Object val
)
12169 Lisp_Object old_redisplaying_p
, old_frame
;
12171 old_redisplaying_p
= XCAR (val
);
12172 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12173 old_frame
= XCDR (val
);
12174 if (! EQ (old_frame
, selected_frame
)
12175 && FRAME_LIVE_P (XFRAME (old_frame
)))
12176 select_frame_for_redisplay (old_frame
);
12181 /* Mark the display of window W as accurate or inaccurate. If
12182 ACCURATE_P is non-zero mark display of W as accurate. If
12183 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12184 redisplay_internal is called. */
12187 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12189 if (BUFFERP (w
->buffer
))
12191 struct buffer
*b
= XBUFFER (w
->buffer
);
12194 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12195 w
->last_overlay_modified
12196 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12198 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12202 b
->clip_changed
= 0;
12203 b
->prevent_redisplay_optimizations_p
= 0;
12205 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12206 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12207 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12208 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12210 w
->current_matrix
->buffer
= b
;
12211 w
->current_matrix
->begv
= BUF_BEGV (b
);
12212 w
->current_matrix
->zv
= BUF_ZV (b
);
12214 w
->last_cursor
= w
->cursor
;
12215 w
->last_cursor_off_p
= w
->cursor_off_p
;
12217 if (w
== XWINDOW (selected_window
))
12218 w
->last_point
= make_number (BUF_PT (b
));
12220 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12226 w
->window_end_valid
= w
->buffer
;
12227 w
->update_mode_line
= Qnil
;
12232 /* Mark the display of windows in the window tree rooted at WINDOW as
12233 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12234 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12235 be redisplayed the next time redisplay_internal is called. */
12238 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12242 for (; !NILP (window
); window
= w
->next
)
12244 w
= XWINDOW (window
);
12245 mark_window_display_accurate_1 (w
, accurate_p
);
12247 if (!NILP (w
->vchild
))
12248 mark_window_display_accurate (w
->vchild
, accurate_p
);
12249 if (!NILP (w
->hchild
))
12250 mark_window_display_accurate (w
->hchild
, accurate_p
);
12255 update_overlay_arrows (1);
12259 /* Force a thorough redisplay the next time by setting
12260 last_arrow_position and last_arrow_string to t, which is
12261 unequal to any useful value of Voverlay_arrow_... */
12262 update_overlay_arrows (-1);
12267 /* Return value in display table DP (Lisp_Char_Table *) for character
12268 C. Since a display table doesn't have any parent, we don't have to
12269 follow parent. Do not call this function directly but use the
12270 macro DISP_CHAR_VECTOR. */
12273 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12277 if (ASCII_CHAR_P (c
))
12280 if (SUB_CHAR_TABLE_P (val
))
12281 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12287 XSETCHAR_TABLE (table
, dp
);
12288 val
= char_table_ref (table
, c
);
12297 /***********************************************************************
12299 ***********************************************************************/
12301 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12304 redisplay_windows (Lisp_Object window
)
12306 while (!NILP (window
))
12308 struct window
*w
= XWINDOW (window
);
12310 if (!NILP (w
->hchild
))
12311 redisplay_windows (w
->hchild
);
12312 else if (!NILP (w
->vchild
))
12313 redisplay_windows (w
->vchild
);
12314 else if (!NILP (w
->buffer
))
12316 displayed_buffer
= XBUFFER (w
->buffer
);
12317 /* Use list_of_error, not Qerror, so that
12318 we catch only errors and don't run the debugger. */
12319 internal_condition_case_1 (redisplay_window_0
, window
,
12321 redisplay_window_error
);
12329 redisplay_window_error (Lisp_Object ignore
)
12331 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12336 redisplay_window_0 (Lisp_Object window
)
12338 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12339 redisplay_window (window
, 0);
12344 redisplay_window_1 (Lisp_Object window
)
12346 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12347 redisplay_window (window
, 1);
12352 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12353 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12354 which positions recorded in ROW differ from current buffer
12357 Return 0 if cursor is not on this row, 1 otherwise. */
12360 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12361 struct glyph_matrix
*matrix
,
12362 EMACS_INT delta
, EMACS_INT delta_bytes
,
12365 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12366 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12367 struct glyph
*cursor
= NULL
;
12368 /* The last known character position in row. */
12369 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12371 EMACS_INT pt_old
= PT
- delta
;
12372 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12373 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12374 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12375 /* A glyph beyond the edge of TEXT_AREA which we should never
12377 struct glyph
*glyphs_end
= end
;
12378 /* Non-zero means we've found a match for cursor position, but that
12379 glyph has the avoid_cursor_p flag set. */
12380 int match_with_avoid_cursor
= 0;
12381 /* Non-zero means we've seen at least one glyph that came from a
12383 int string_seen
= 0;
12384 /* Largest and smalles buffer positions seen so far during scan of
12386 EMACS_INT bpos_max
= pos_before
;
12387 EMACS_INT bpos_min
= pos_after
;
12388 /* Last buffer position covered by an overlay string with an integer
12389 `cursor' property. */
12390 EMACS_INT bpos_covered
= 0;
12392 /* Skip over glyphs not having an object at the start and the end of
12393 the row. These are special glyphs like truncation marks on
12394 terminal frames. */
12395 if (row
->displays_text_p
)
12397 if (!row
->reversed_p
)
12400 && INTEGERP (glyph
->object
)
12401 && glyph
->charpos
< 0)
12403 x
+= glyph
->pixel_width
;
12407 && INTEGERP ((end
- 1)->object
)
12408 /* CHARPOS is zero for blanks and stretch glyphs
12409 inserted by extend_face_to_end_of_line. */
12410 && (end
- 1)->charpos
<= 0)
12412 glyph_before
= glyph
- 1;
12419 /* If the glyph row is reversed, we need to process it from back
12420 to front, so swap the edge pointers. */
12421 glyphs_end
= end
= glyph
- 1;
12422 glyph
+= row
->used
[TEXT_AREA
] - 1;
12424 while (glyph
> end
+ 1
12425 && INTEGERP (glyph
->object
)
12426 && glyph
->charpos
< 0)
12429 x
-= glyph
->pixel_width
;
12431 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12433 /* By default, in reversed rows we put the cursor on the
12434 rightmost (first in the reading order) glyph. */
12435 for (g
= end
+ 1; g
< glyph
; g
++)
12436 x
+= g
->pixel_width
;
12438 && INTEGERP ((end
+ 1)->object
)
12439 && (end
+ 1)->charpos
<= 0)
12441 glyph_before
= glyph
+ 1;
12445 else if (row
->reversed_p
)
12447 /* In R2L rows that don't display text, put the cursor on the
12448 rightmost glyph. Case in point: an empty last line that is
12449 part of an R2L paragraph. */
12451 /* Avoid placing the cursor on the last glyph of the row, where
12452 on terminal frames we hold the vertical border between
12453 adjacent windows. */
12454 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12455 && !WINDOW_RIGHTMOST_P (w
)
12456 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12458 x
= -1; /* will be computed below, at label compute_x */
12461 /* Step 1: Try to find the glyph whose character position
12462 corresponds to point. If that's not possible, find 2 glyphs
12463 whose character positions are the closest to point, one before
12464 point, the other after it. */
12465 if (!row
->reversed_p
)
12466 while (/* not marched to end of glyph row */
12468 /* glyph was not inserted by redisplay for internal purposes */
12469 && !INTEGERP (glyph
->object
))
12471 if (BUFFERP (glyph
->object
))
12473 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12475 if (glyph
->charpos
> bpos_max
)
12476 bpos_max
= glyph
->charpos
;
12477 if (glyph
->charpos
< bpos_min
)
12478 bpos_min
= glyph
->charpos
;
12479 if (!glyph
->avoid_cursor_p
)
12481 /* If we hit point, we've found the glyph on which to
12482 display the cursor. */
12485 match_with_avoid_cursor
= 0;
12488 /* See if we've found a better approximation to
12489 POS_BEFORE or to POS_AFTER. Note that we want the
12490 first (leftmost) glyph of all those that are the
12491 closest from below, and the last (rightmost) of all
12492 those from above. */
12493 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12495 pos_before
= glyph
->charpos
;
12496 glyph_before
= glyph
;
12498 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12500 pos_after
= glyph
->charpos
;
12501 glyph_after
= glyph
;
12504 else if (dpos
== 0)
12505 match_with_avoid_cursor
= 1;
12507 else if (STRINGP (glyph
->object
))
12509 Lisp_Object chprop
;
12510 EMACS_INT glyph_pos
= glyph
->charpos
;
12512 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12514 if (INTEGERP (chprop
))
12516 bpos_covered
= bpos_max
+ XINT (chprop
);
12517 /* If the `cursor' property covers buffer positions up
12518 to and including point, we should display cursor on
12519 this glyph. Note that overlays and text properties
12520 with string values stop bidi reordering, so every
12521 buffer position to the left of the string is always
12522 smaller than any position to the right of the
12523 string. Therefore, if a `cursor' property on one
12524 of the string's characters has an integer value, we
12525 will break out of the loop below _before_ we get to
12526 the position match above. IOW, integer values of
12527 the `cursor' property override the "exact match for
12528 point" strategy of positioning the cursor. */
12529 /* Implementation note: bpos_max == pt_old when, e.g.,
12530 we are in an empty line, where bpos_max is set to
12531 MATRIX_ROW_START_CHARPOS, see above. */
12532 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12541 x
+= glyph
->pixel_width
;
12544 else if (glyph
> end
) /* row is reversed */
12545 while (!INTEGERP (glyph
->object
))
12547 if (BUFFERP (glyph
->object
))
12549 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12551 if (glyph
->charpos
> bpos_max
)
12552 bpos_max
= glyph
->charpos
;
12553 if (glyph
->charpos
< bpos_min
)
12554 bpos_min
= glyph
->charpos
;
12555 if (!glyph
->avoid_cursor_p
)
12559 match_with_avoid_cursor
= 0;
12562 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12564 pos_before
= glyph
->charpos
;
12565 glyph_before
= glyph
;
12567 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12569 pos_after
= glyph
->charpos
;
12570 glyph_after
= glyph
;
12573 else if (dpos
== 0)
12574 match_with_avoid_cursor
= 1;
12576 else if (STRINGP (glyph
->object
))
12578 Lisp_Object chprop
;
12579 EMACS_INT glyph_pos
= glyph
->charpos
;
12581 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12583 if (INTEGERP (chprop
))
12585 bpos_covered
= bpos_max
+ XINT (chprop
);
12586 /* If the `cursor' property covers buffer positions up
12587 to and including point, we should display cursor on
12589 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12598 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12600 x
--; /* can't use any pixel_width */
12603 x
-= glyph
->pixel_width
;
12606 /* Step 2: If we didn't find an exact match for point, we need to
12607 look for a proper place to put the cursor among glyphs between
12608 GLYPH_BEFORE and GLYPH_AFTER. */
12609 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12610 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12611 && bpos_covered
< pt_old
)
12613 /* An empty line has a single glyph whose OBJECT is zero and
12614 whose CHARPOS is the position of a newline on that line.
12615 Note that on a TTY, there are more glyphs after that, which
12616 were produced by extend_face_to_end_of_line, but their
12617 CHARPOS is zero or negative. */
12619 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12620 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12622 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12624 EMACS_INT ellipsis_pos
;
12626 /* Scan back over the ellipsis glyphs. */
12627 if (!row
->reversed_p
)
12629 ellipsis_pos
= (glyph
- 1)->charpos
;
12630 while (glyph
> row
->glyphs
[TEXT_AREA
]
12631 && (glyph
- 1)->charpos
== ellipsis_pos
)
12632 glyph
--, x
-= glyph
->pixel_width
;
12633 /* That loop always goes one position too far, including
12634 the glyph before the ellipsis. So scan forward over
12636 x
+= glyph
->pixel_width
;
12639 else /* row is reversed */
12641 ellipsis_pos
= (glyph
+ 1)->charpos
;
12642 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12643 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12644 glyph
++, x
+= glyph
->pixel_width
;
12645 x
-= glyph
->pixel_width
;
12649 else if (match_with_avoid_cursor
12650 /* A truncated row may not include PT among its
12651 character positions. Setting the cursor inside the
12652 scroll margin will trigger recalculation of hscroll
12653 in hscroll_window_tree. */
12654 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12655 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12656 /* Zero-width characters produce no glyphs. */
12659 && (row
->reversed_p
12660 ? glyph_after
> glyphs_end
12661 : glyph_after
< glyphs_end
)))
12663 cursor
= glyph_after
;
12666 else if (string_seen
)
12668 int incr
= row
->reversed_p
? -1 : +1;
12670 /* Need to find the glyph that came out of a string which is
12671 present at point. That glyph is somewhere between
12672 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12673 positioned between POS_BEFORE and POS_AFTER in the
12675 struct glyph
*stop
= glyph_after
;
12676 EMACS_INT pos
= pos_before
;
12679 for (glyph
= glyph_before
+ incr
;
12680 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12683 /* Any glyphs that come from the buffer are here because
12684 of bidi reordering. Skip them, and only pay
12685 attention to glyphs that came from some string. */
12686 if (STRINGP (glyph
->object
))
12691 str
= glyph
->object
;
12692 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12693 if (tem
== 0 /* from overlay */
12696 /* If the string from which this glyph came is
12697 found in the buffer at point, then we've
12698 found the glyph we've been looking for. If
12699 it comes from an overlay (tem == 0), and it
12700 has the `cursor' property on one of its
12701 glyphs, record that glyph as a candidate for
12702 displaying the cursor. (As in the
12703 unidirectional version, we will display the
12704 cursor on the last candidate we find.) */
12705 if (tem
== 0 || tem
== pt_old
)
12707 /* The glyphs from this string could have
12708 been reordered. Find the one with the
12709 smallest string position. Or there could
12710 be a character in the string with the
12711 `cursor' property, which means display
12712 cursor on that character's glyph. */
12713 EMACS_INT strpos
= glyph
->charpos
;
12718 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12719 && EQ (glyph
->object
, str
);
12723 EMACS_INT gpos
= glyph
->charpos
;
12725 cprop
= Fget_char_property (make_number (gpos
),
12733 if (tem
&& glyph
->charpos
< strpos
)
12735 strpos
= glyph
->charpos
;
12744 pos
= tem
+ 1; /* don't find previous instances */
12746 /* This string is not what we want; skip all of the
12747 glyphs that came from it. */
12748 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12749 && EQ (glyph
->object
, str
))
12756 /* If we reached the end of the line, and END was from a string,
12757 the cursor is not on this line. */
12759 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12760 && STRINGP (end
->object
)
12761 && row
->continued_p
)
12767 if (cursor
!= NULL
)
12773 /* Need to compute x that corresponds to GLYPH. */
12774 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12776 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12778 x
+= g
->pixel_width
;
12782 /* ROW could be part of a continued line, which, under bidi
12783 reordering, might have other rows whose start and end charpos
12784 occlude point. Only set w->cursor if we found a better
12785 approximation to the cursor position than we have from previously
12786 examined candidate rows belonging to the same continued line. */
12787 if (/* we already have a candidate row */
12788 w
->cursor
.vpos
>= 0
12789 /* that candidate is not the row we are processing */
12790 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12791 /* the row we are processing is part of a continued line */
12792 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12793 /* Make sure cursor.vpos specifies a row whose start and end
12794 charpos occlude point. This is because some callers of this
12795 function leave cursor.vpos at the row where the cursor was
12796 displayed during the last redisplay cycle. */
12797 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12798 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12801 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12803 /* Don't consider glyphs that are outside TEXT_AREA. */
12804 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12806 /* Keep the candidate whose buffer position is the closest to
12808 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12809 w
->cursor
.hpos
>= 0
12810 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12811 && BUFFERP (g1
->object
)
12812 && (g1
->charpos
== pt_old
/* an exact match always wins */
12813 || (BUFFERP (glyph
->object
)
12814 && eabs (g1
->charpos
- pt_old
)
12815 < eabs (glyph
->charpos
- pt_old
))))
12817 /* If this candidate gives an exact match, use that. */
12818 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12819 /* Otherwise, keep the candidate that comes from a row
12820 spanning less buffer positions. This may win when one or
12821 both candidate positions are on glyphs that came from
12822 display strings, for which we cannot compare buffer
12824 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12825 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12826 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12829 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12831 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12832 w
->cursor
.y
= row
->y
+ dy
;
12834 if (w
== XWINDOW (selected_window
))
12836 if (!row
->continued_p
12837 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12840 this_line_buffer
= XBUFFER (w
->buffer
);
12842 CHARPOS (this_line_start_pos
)
12843 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12844 BYTEPOS (this_line_start_pos
)
12845 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12847 CHARPOS (this_line_end_pos
)
12848 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12849 BYTEPOS (this_line_end_pos
)
12850 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12852 this_line_y
= w
->cursor
.y
;
12853 this_line_pixel_height
= row
->height
;
12854 this_line_vpos
= w
->cursor
.vpos
;
12855 this_line_start_x
= row
->x
;
12858 CHARPOS (this_line_start_pos
) = 0;
12865 /* Run window scroll functions, if any, for WINDOW with new window
12866 start STARTP. Sets the window start of WINDOW to that position.
12868 We assume that the window's buffer is really current. */
12870 static INLINE
struct text_pos
12871 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12873 struct window
*w
= XWINDOW (window
);
12874 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12876 if (current_buffer
!= XBUFFER (w
->buffer
))
12879 if (!NILP (Vwindow_scroll_functions
))
12881 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12882 make_number (CHARPOS (startp
)));
12883 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12884 /* In case the hook functions switch buffers. */
12885 if (current_buffer
!= XBUFFER (w
->buffer
))
12886 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12893 /* Make sure the line containing the cursor is fully visible.
12894 A value of 1 means there is nothing to be done.
12895 (Either the line is fully visible, or it cannot be made so,
12896 or we cannot tell.)
12898 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12899 is higher than window.
12901 A value of 0 means the caller should do scrolling
12902 as if point had gone off the screen. */
12905 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12907 struct glyph_matrix
*matrix
;
12908 struct glyph_row
*row
;
12911 if (!make_cursor_line_fully_visible_p
)
12914 /* It's not always possible to find the cursor, e.g, when a window
12915 is full of overlay strings. Don't do anything in that case. */
12916 if (w
->cursor
.vpos
< 0)
12919 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12920 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12922 /* If the cursor row is not partially visible, there's nothing to do. */
12923 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12926 /* If the row the cursor is in is taller than the window's height,
12927 it's not clear what to do, so do nothing. */
12928 window_height
= window_box_height (w
);
12929 if (row
->height
>= window_height
)
12931 if (!force_p
|| MINI_WINDOW_P (w
)
12932 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12939 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12940 non-zero means only WINDOW is redisplayed in redisplay_internal.
12941 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12942 in redisplay_window to bring a partially visible line into view in
12943 the case that only the cursor has moved.
12945 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12946 last screen line's vertical height extends past the end of the screen.
12950 1 if scrolling succeeded
12952 0 if scrolling didn't find point.
12954 -1 if new fonts have been loaded so that we must interrupt
12955 redisplay, adjust glyph matrices, and try again. */
12961 SCROLLING_NEED_LARGER_MATRICES
12964 /* If scroll-conservatively is more than this, never recenter.
12966 If you change this, don't forget to update the doc string of
12967 `scroll-conservatively' and the Emacs manual. */
12968 #define SCROLL_LIMIT 100
12971 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12972 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12973 int temp_scroll_step
, int last_line_misfit
)
12975 struct window
*w
= XWINDOW (window
);
12976 struct frame
*f
= XFRAME (w
->frame
);
12977 struct text_pos pos
, startp
;
12979 int this_scroll_margin
, scroll_max
, rc
, height
;
12980 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12981 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12982 Lisp_Object aggressive
;
12983 /* We will never try scrolling more than this number of lines. */
12984 int scroll_limit
= SCROLL_LIMIT
;
12987 debug_method_add (w
, "try_scrolling");
12990 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12992 /* Compute scroll margin height in pixels. We scroll when point is
12993 within this distance from the top or bottom of the window. */
12994 if (scroll_margin
> 0)
12995 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12996 * FRAME_LINE_HEIGHT (f
);
12998 this_scroll_margin
= 0;
13000 /* Force arg_scroll_conservatively to have a reasonable value, to
13001 avoid scrolling too far away with slow move_it_* functions. Note
13002 that the user can supply scroll-conservatively equal to
13003 `most-positive-fixnum', which can be larger than INT_MAX. */
13004 if (arg_scroll_conservatively
> scroll_limit
)
13006 arg_scroll_conservatively
= scroll_limit
+ 1;
13007 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13009 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13010 /* Compute how much we should try to scroll maximally to bring
13011 point into view. */
13012 scroll_max
= (max (scroll_step
,
13013 max (arg_scroll_conservatively
, temp_scroll_step
))
13014 * FRAME_LINE_HEIGHT (f
));
13015 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13016 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13017 /* We're trying to scroll because of aggressive scrolling but no
13018 scroll_step is set. Choose an arbitrary one. */
13019 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13025 /* Decide whether to scroll down. */
13026 if (PT
> CHARPOS (startp
))
13028 int scroll_margin_y
;
13030 /* Compute the pixel ypos of the scroll margin, then move it to
13031 either that ypos or PT, whichever comes first. */
13032 start_display (&it
, w
, startp
);
13033 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13034 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13035 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13036 (MOVE_TO_POS
| MOVE_TO_Y
));
13038 if (PT
> CHARPOS (it
.current
.pos
))
13040 int y0
= line_bottom_y (&it
);
13041 /* Compute how many pixels below window bottom to stop searching
13042 for PT. This avoids costly search for PT that is far away if
13043 the user limited scrolling by a small number of lines, but
13044 always finds PT if scroll_conservatively is set to a large
13045 number, such as most-positive-fixnum. */
13046 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13047 int y_to_move
= it
.last_visible_y
+ slack
;
13049 /* Compute the distance from the scroll margin to PT or to
13050 the scroll limit, whichever comes first. This should
13051 include the height of the cursor line, to make that line
13053 move_it_to (&it
, PT
, -1, y_to_move
,
13054 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13055 dy
= line_bottom_y (&it
) - y0
;
13057 if (dy
> scroll_max
)
13058 return SCROLLING_FAILED
;
13066 /* Point is in or below the bottom scroll margin, so move the
13067 window start down. If scrolling conservatively, move it just
13068 enough down to make point visible. If scroll_step is set,
13069 move it down by scroll_step. */
13070 if (arg_scroll_conservatively
)
13072 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13073 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13074 else if (scroll_step
|| temp_scroll_step
)
13075 amount_to_scroll
= scroll_max
;
13078 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13079 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13080 if (NUMBERP (aggressive
))
13082 double float_amount
= XFLOATINT (aggressive
) * height
;
13083 amount_to_scroll
= float_amount
;
13084 if (amount_to_scroll
== 0 && float_amount
> 0)
13085 amount_to_scroll
= 1;
13086 /* Don't let point enter the scroll margin near top of
13088 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13089 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13093 if (amount_to_scroll
<= 0)
13094 return SCROLLING_FAILED
;
13096 start_display (&it
, w
, startp
);
13097 if (arg_scroll_conservatively
<= scroll_limit
)
13098 move_it_vertically (&it
, amount_to_scroll
);
13101 /* Extra precision for users who set scroll-conservatively
13102 to a large number: make sure the amount we scroll
13103 the window start is never less than amount_to_scroll,
13104 which was computed as distance from window bottom to
13105 point. This matters when lines at window top and lines
13106 below window bottom have different height. */
13107 struct it it1
= it
;
13108 /* We use a temporary it1 because line_bottom_y can modify
13109 its argument, if it moves one line down; see there. */
13110 int start_y
= line_bottom_y (&it1
);
13113 move_it_by_lines (&it
, 1);
13115 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13118 /* If STARTP is unchanged, move it down another screen line. */
13119 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13120 move_it_by_lines (&it
, 1);
13121 startp
= it
.current
.pos
;
13125 struct text_pos scroll_margin_pos
= startp
;
13127 /* See if point is inside the scroll margin at the top of the
13129 if (this_scroll_margin
)
13131 start_display (&it
, w
, startp
);
13132 move_it_vertically (&it
, this_scroll_margin
);
13133 scroll_margin_pos
= it
.current
.pos
;
13136 if (PT
< CHARPOS (scroll_margin_pos
))
13138 /* Point is in the scroll margin at the top of the window or
13139 above what is displayed in the window. */
13142 /* Compute the vertical distance from PT to the scroll
13143 margin position. Move as far as scroll_max allows, or
13144 one screenful, or 10 screen lines, whichever is largest.
13145 Give up if distance is greater than scroll_max. */
13146 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13147 start_display (&it
, w
, pos
);
13149 y_to_move
= max (it
.last_visible_y
,
13150 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13151 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13153 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13154 dy
= it
.current_y
- y0
;
13155 if (dy
> scroll_max
)
13156 return SCROLLING_FAILED
;
13158 /* Compute new window start. */
13159 start_display (&it
, w
, startp
);
13161 if (arg_scroll_conservatively
)
13162 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13163 max (scroll_step
, temp_scroll_step
));
13164 else if (scroll_step
|| temp_scroll_step
)
13165 amount_to_scroll
= scroll_max
;
13168 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13169 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13170 if (NUMBERP (aggressive
))
13172 double float_amount
= XFLOATINT (aggressive
) * height
;
13173 amount_to_scroll
= float_amount
;
13174 if (amount_to_scroll
== 0 && float_amount
> 0)
13175 amount_to_scroll
= 1;
13176 amount_to_scroll
-=
13177 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13178 /* Don't let point enter the scroll margin near
13179 bottom of the window. */
13180 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13181 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13185 if (amount_to_scroll
<= 0)
13186 return SCROLLING_FAILED
;
13188 move_it_vertically_backward (&it
, amount_to_scroll
);
13189 startp
= it
.current
.pos
;
13193 /* Run window scroll functions. */
13194 startp
= run_window_scroll_functions (window
, startp
);
13196 /* Display the window. Give up if new fonts are loaded, or if point
13198 if (!try_window (window
, startp
, 0))
13199 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13200 else if (w
->cursor
.vpos
< 0)
13202 clear_glyph_matrix (w
->desired_matrix
);
13203 rc
= SCROLLING_FAILED
;
13207 /* Maybe forget recorded base line for line number display. */
13208 if (!just_this_one_p
13209 || current_buffer
->clip_changed
13210 || BEG_UNCHANGED
< CHARPOS (startp
))
13211 w
->base_line_number
= Qnil
;
13213 /* If cursor ends up on a partially visible line,
13214 treat that as being off the bottom of the screen. */
13215 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13216 /* It's possible that the cursor is on the first line of the
13217 buffer, which is partially obscured due to a vscroll
13218 (Bug#7537). In that case, avoid looping forever . */
13219 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13221 clear_glyph_matrix (w
->desired_matrix
);
13222 ++extra_scroll_margin_lines
;
13225 rc
= SCROLLING_SUCCESS
;
13232 /* Compute a suitable window start for window W if display of W starts
13233 on a continuation line. Value is non-zero if a new window start
13236 The new window start will be computed, based on W's width, starting
13237 from the start of the continued line. It is the start of the
13238 screen line with the minimum distance from the old start W->start. */
13241 compute_window_start_on_continuation_line (struct window
*w
)
13243 struct text_pos pos
, start_pos
;
13244 int window_start_changed_p
= 0;
13246 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13248 /* If window start is on a continuation line... Window start may be
13249 < BEGV in case there's invisible text at the start of the
13250 buffer (M-x rmail, for example). */
13251 if (CHARPOS (start_pos
) > BEGV
13252 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13255 struct glyph_row
*row
;
13257 /* Handle the case that the window start is out of range. */
13258 if (CHARPOS (start_pos
) < BEGV
)
13259 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13260 else if (CHARPOS (start_pos
) > ZV
)
13261 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13263 /* Find the start of the continued line. This should be fast
13264 because scan_buffer is fast (newline cache). */
13265 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13266 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13267 row
, DEFAULT_FACE_ID
);
13268 reseat_at_previous_visible_line_start (&it
);
13270 /* If the line start is "too far" away from the window start,
13271 say it takes too much time to compute a new window start. */
13272 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13273 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13275 int min_distance
, distance
;
13277 /* Move forward by display lines to find the new window
13278 start. If window width was enlarged, the new start can
13279 be expected to be > the old start. If window width was
13280 decreased, the new window start will be < the old start.
13281 So, we're looking for the display line start with the
13282 minimum distance from the old window start. */
13283 pos
= it
.current
.pos
;
13284 min_distance
= INFINITY
;
13285 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13286 distance
< min_distance
)
13288 min_distance
= distance
;
13289 pos
= it
.current
.pos
;
13290 move_it_by_lines (&it
, 1);
13293 /* Set the window start there. */
13294 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13295 window_start_changed_p
= 1;
13299 return window_start_changed_p
;
13303 /* Try cursor movement in case text has not changed in window WINDOW,
13304 with window start STARTP. Value is
13306 CURSOR_MOVEMENT_SUCCESS if successful
13308 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13310 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13311 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13312 we want to scroll as if scroll-step were set to 1. See the code.
13314 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13315 which case we have to abort this redisplay, and adjust matrices
13320 CURSOR_MOVEMENT_SUCCESS
,
13321 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13322 CURSOR_MOVEMENT_MUST_SCROLL
,
13323 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13327 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13329 struct window
*w
= XWINDOW (window
);
13330 struct frame
*f
= XFRAME (w
->frame
);
13331 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13334 if (inhibit_try_cursor_movement
)
13338 /* Handle case where text has not changed, only point, and it has
13339 not moved off the frame. */
13340 if (/* Point may be in this window. */
13341 PT
>= CHARPOS (startp
)
13342 /* Selective display hasn't changed. */
13343 && !current_buffer
->clip_changed
13344 /* Function force-mode-line-update is used to force a thorough
13345 redisplay. It sets either windows_or_buffers_changed or
13346 update_mode_lines. So don't take a shortcut here for these
13348 && !update_mode_lines
13349 && !windows_or_buffers_changed
13350 && !cursor_type_changed
13351 /* Can't use this case if highlighting a region. When a
13352 region exists, cursor movement has to do more than just
13354 && !(!NILP (Vtransient_mark_mode
)
13355 && !NILP (BVAR (current_buffer
, mark_active
)))
13356 && NILP (w
->region_showing
)
13357 && NILP (Vshow_trailing_whitespace
)
13358 /* Right after splitting windows, last_point may be nil. */
13359 && INTEGERP (w
->last_point
)
13360 /* This code is not used for mini-buffer for the sake of the case
13361 of redisplaying to replace an echo area message; since in
13362 that case the mini-buffer contents per se are usually
13363 unchanged. This code is of no real use in the mini-buffer
13364 since the handling of this_line_start_pos, etc., in redisplay
13365 handles the same cases. */
13366 && !EQ (window
, minibuf_window
)
13367 /* When splitting windows or for new windows, it happens that
13368 redisplay is called with a nil window_end_vpos or one being
13369 larger than the window. This should really be fixed in
13370 window.c. I don't have this on my list, now, so we do
13371 approximately the same as the old redisplay code. --gerd. */
13372 && INTEGERP (w
->window_end_vpos
)
13373 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13374 && (FRAME_WINDOW_P (f
)
13375 || !overlay_arrow_in_current_buffer_p ()))
13377 int this_scroll_margin
, top_scroll_margin
;
13378 struct glyph_row
*row
= NULL
;
13381 debug_method_add (w
, "cursor movement");
13384 /* Scroll if point within this distance from the top or bottom
13385 of the window. This is a pixel value. */
13386 if (scroll_margin
> 0)
13388 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13389 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13392 this_scroll_margin
= 0;
13394 top_scroll_margin
= this_scroll_margin
;
13395 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13396 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13398 /* Start with the row the cursor was displayed during the last
13399 not paused redisplay. Give up if that row is not valid. */
13400 if (w
->last_cursor
.vpos
< 0
13401 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13402 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13405 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13406 if (row
->mode_line_p
)
13408 if (!row
->enabled_p
)
13409 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13412 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13414 int scroll_p
= 0, must_scroll
= 0;
13415 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13417 if (PT
> XFASTINT (w
->last_point
))
13419 /* Point has moved forward. */
13420 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13421 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13423 xassert (row
->enabled_p
);
13427 /* If the end position of a row equals the start
13428 position of the next row, and PT is at that position,
13429 we would rather display cursor in the next line. */
13430 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13431 && MATRIX_ROW_END_CHARPOS (row
) == PT
13432 && row
< w
->current_matrix
->rows
13433 + w
->current_matrix
->nrows
- 1
13434 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13435 && !cursor_row_p (row
))
13438 /* If within the scroll margin, scroll. Note that
13439 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13440 the next line would be drawn, and that
13441 this_scroll_margin can be zero. */
13442 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13443 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13444 /* Line is completely visible last line in window
13445 and PT is to be set in the next line. */
13446 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13447 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13448 && !row
->ends_at_zv_p
13449 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13452 else if (PT
< XFASTINT (w
->last_point
))
13454 /* Cursor has to be moved backward. Note that PT >=
13455 CHARPOS (startp) because of the outer if-statement. */
13456 while (!row
->mode_line_p
13457 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13458 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13459 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13460 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13461 row
> w
->current_matrix
->rows
13462 && (row
-1)->ends_in_newline_from_string_p
))))
13463 && (row
->y
> top_scroll_margin
13464 || CHARPOS (startp
) == BEGV
))
13466 xassert (row
->enabled_p
);
13470 /* Consider the following case: Window starts at BEGV,
13471 there is invisible, intangible text at BEGV, so that
13472 display starts at some point START > BEGV. It can
13473 happen that we are called with PT somewhere between
13474 BEGV and START. Try to handle that case. */
13475 if (row
< w
->current_matrix
->rows
13476 || row
->mode_line_p
)
13478 row
= w
->current_matrix
->rows
;
13479 if (row
->mode_line_p
)
13483 /* Due to newlines in overlay strings, we may have to
13484 skip forward over overlay strings. */
13485 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13486 && MATRIX_ROW_END_CHARPOS (row
) == PT
13487 && !cursor_row_p (row
))
13490 /* If within the scroll margin, scroll. */
13491 if (row
->y
< top_scroll_margin
13492 && CHARPOS (startp
) != BEGV
)
13497 /* Cursor did not move. So don't scroll even if cursor line
13498 is partially visible, as it was so before. */
13499 rc
= CURSOR_MOVEMENT_SUCCESS
;
13502 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13503 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13505 /* if PT is not in the glyph row, give up. */
13506 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13509 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13510 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13512 /* If rows are bidi-reordered and point moved, back up
13513 until we find a row that does not belong to a
13514 continuation line. This is because we must consider
13515 all rows of a continued line as candidates for the
13516 new cursor positioning, since row start and end
13517 positions change non-linearly with vertical position
13519 /* FIXME: Revisit this when glyph ``spilling'' in
13520 continuation lines' rows is implemented for
13521 bidi-reordered rows. */
13522 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13524 xassert (row
->enabled_p
);
13526 /* If we hit the beginning of the displayed portion
13527 without finding the first row of a continued
13529 if (row
<= w
->current_matrix
->rows
)
13531 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13539 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13540 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13541 && make_cursor_line_fully_visible_p
)
13543 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13544 && !row
->ends_at_zv_p
13545 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13546 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13547 else if (row
->height
> window_box_height (w
))
13549 /* If we end up in a partially visible line, let's
13550 make it fully visible, except when it's taller
13551 than the window, in which case we can't do much
13554 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13558 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13559 if (!cursor_row_fully_visible_p (w
, 0, 1))
13560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13562 rc
= CURSOR_MOVEMENT_SUCCESS
;
13566 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13567 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13568 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13570 /* With bidi-reordered rows, there could be more than
13571 one candidate row whose start and end positions
13572 occlude point. We need to let set_cursor_from_row
13573 find the best candidate. */
13574 /* FIXME: Revisit this when glyph ``spilling'' in
13575 continuation lines' rows is implemented for
13576 bidi-reordered rows. */
13581 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13582 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13583 && cursor_row_p (row
))
13584 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13586 /* As soon as we've found the first suitable row
13587 whose ends_at_zv_p flag is set, we are done. */
13589 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13591 rc
= CURSOR_MOVEMENT_SUCCESS
;
13596 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13597 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13598 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13599 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13600 /* If we didn't find any candidate rows, or exited the
13601 loop before all the candidates were examined, signal
13602 to the caller that this method failed. */
13603 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13604 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13605 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13607 rc
= CURSOR_MOVEMENT_SUCCESS
;
13613 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13615 rc
= CURSOR_MOVEMENT_SUCCESS
;
13620 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13621 && MATRIX_ROW_START_CHARPOS (row
) == PT
13622 && cursor_row_p (row
));
13631 set_vertical_scroll_bar (struct window
*w
)
13633 EMACS_INT start
, end
, whole
;
13635 /* Calculate the start and end positions for the current window.
13636 At some point, it would be nice to choose between scrollbars
13637 which reflect the whole buffer size, with special markers
13638 indicating narrowing, and scrollbars which reflect only the
13641 Note that mini-buffers sometimes aren't displaying any text. */
13642 if (!MINI_WINDOW_P (w
)
13643 || (w
== XWINDOW (minibuf_window
)
13644 && NILP (echo_area_buffer
[0])))
13646 struct buffer
*buf
= XBUFFER (w
->buffer
);
13647 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13648 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13649 /* I don't think this is guaranteed to be right. For the
13650 moment, we'll pretend it is. */
13651 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13655 if (whole
< (end
- start
))
13656 whole
= end
- start
;
13659 start
= end
= whole
= 0;
13661 /* Indicate what this scroll bar ought to be displaying now. */
13662 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13663 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13664 (w
, end
- start
, whole
, start
);
13668 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13669 selected_window is redisplayed.
13671 We can return without actually redisplaying the window if
13672 fonts_changed_p is nonzero. In that case, redisplay_internal will
13676 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13678 struct window
*w
= XWINDOW (window
);
13679 struct frame
*f
= XFRAME (w
->frame
);
13680 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13681 struct buffer
*old
= current_buffer
;
13682 struct text_pos lpoint
, opoint
, startp
;
13683 int update_mode_line
;
13686 /* Record it now because it's overwritten. */
13687 int current_matrix_up_to_date_p
= 0;
13688 int used_current_matrix_p
= 0;
13689 /* This is less strict than current_matrix_up_to_date_p.
13690 It indictes that the buffer contents and narrowing are unchanged. */
13691 int buffer_unchanged_p
= 0;
13692 int temp_scroll_step
= 0;
13693 int count
= SPECPDL_INDEX ();
13695 int centering_position
= -1;
13696 int last_line_misfit
= 0;
13697 EMACS_INT beg_unchanged
, end_unchanged
;
13699 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13702 /* W must be a leaf window here. */
13703 xassert (!NILP (w
->buffer
));
13705 *w
->desired_matrix
->method
= 0;
13709 reconsider_clip_changes (w
, buffer
);
13711 /* Has the mode line to be updated? */
13712 update_mode_line
= (!NILP (w
->update_mode_line
)
13713 || update_mode_lines
13714 || buffer
->clip_changed
13715 || buffer
->prevent_redisplay_optimizations_p
);
13717 if (MINI_WINDOW_P (w
))
13719 if (w
== XWINDOW (echo_area_window
)
13720 && !NILP (echo_area_buffer
[0]))
13722 if (update_mode_line
)
13723 /* We may have to update a tty frame's menu bar or a
13724 tool-bar. Example `M-x C-h C-h C-g'. */
13725 goto finish_menu_bars
;
13727 /* We've already displayed the echo area glyphs in this window. */
13728 goto finish_scroll_bars
;
13730 else if ((w
!= XWINDOW (minibuf_window
)
13731 || minibuf_level
== 0)
13732 /* When buffer is nonempty, redisplay window normally. */
13733 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13734 /* Quail displays non-mini buffers in minibuffer window.
13735 In that case, redisplay the window normally. */
13736 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13738 /* W is a mini-buffer window, but it's not active, so clear
13740 int yb
= window_text_bottom_y (w
);
13741 struct glyph_row
*row
;
13744 for (y
= 0, row
= w
->desired_matrix
->rows
;
13746 y
+= row
->height
, ++row
)
13747 blank_row (w
, row
, y
);
13748 goto finish_scroll_bars
;
13751 clear_glyph_matrix (w
->desired_matrix
);
13754 /* Otherwise set up data on this window; select its buffer and point
13756 /* Really select the buffer, for the sake of buffer-local
13758 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13760 current_matrix_up_to_date_p
13761 = (!NILP (w
->window_end_valid
)
13762 && !current_buffer
->clip_changed
13763 && !current_buffer
->prevent_redisplay_optimizations_p
13764 && XFASTINT (w
->last_modified
) >= MODIFF
13765 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13767 /* Run the window-bottom-change-functions
13768 if it is possible that the text on the screen has changed
13769 (either due to modification of the text, or any other reason). */
13770 if (!current_matrix_up_to_date_p
13771 && !NILP (Vwindow_text_change_functions
))
13773 safe_run_hooks (Qwindow_text_change_functions
);
13777 beg_unchanged
= BEG_UNCHANGED
;
13778 end_unchanged
= END_UNCHANGED
;
13780 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13782 specbind (Qinhibit_point_motion_hooks
, Qt
);
13785 = (!NILP (w
->window_end_valid
)
13786 && !current_buffer
->clip_changed
13787 && XFASTINT (w
->last_modified
) >= MODIFF
13788 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13790 /* When windows_or_buffers_changed is non-zero, we can't rely on
13791 the window end being valid, so set it to nil there. */
13792 if (windows_or_buffers_changed
)
13794 /* If window starts on a continuation line, maybe adjust the
13795 window start in case the window's width changed. */
13796 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13797 compute_window_start_on_continuation_line (w
);
13799 w
->window_end_valid
= Qnil
;
13802 /* Some sanity checks. */
13803 CHECK_WINDOW_END (w
);
13804 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13806 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13809 /* If %c is in mode line, update it if needed. */
13810 if (!NILP (w
->column_number_displayed
)
13811 /* This alternative quickly identifies a common case
13812 where no change is needed. */
13813 && !(PT
== XFASTINT (w
->last_point
)
13814 && XFASTINT (w
->last_modified
) >= MODIFF
13815 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13816 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13817 update_mode_line
= 1;
13819 /* Count number of windows showing the selected buffer. An indirect
13820 buffer counts as its base buffer. */
13821 if (!just_this_one_p
)
13823 struct buffer
*current_base
, *window_base
;
13824 current_base
= current_buffer
;
13825 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13826 if (current_base
->base_buffer
)
13827 current_base
= current_base
->base_buffer
;
13828 if (window_base
->base_buffer
)
13829 window_base
= window_base
->base_buffer
;
13830 if (current_base
== window_base
)
13834 /* Point refers normally to the selected window. For any other
13835 window, set up appropriate value. */
13836 if (!EQ (window
, selected_window
))
13838 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13839 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13843 new_pt_byte
= BEGV_BYTE
;
13844 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13846 else if (new_pt
> (ZV
- 1))
13849 new_pt_byte
= ZV_BYTE
;
13850 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13853 /* We don't use SET_PT so that the point-motion hooks don't run. */
13854 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13857 /* If any of the character widths specified in the display table
13858 have changed, invalidate the width run cache. It's true that
13859 this may be a bit late to catch such changes, but the rest of
13860 redisplay goes (non-fatally) haywire when the display table is
13861 changed, so why should we worry about doing any better? */
13862 if (current_buffer
->width_run_cache
)
13864 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13866 if (! disptab_matches_widthtab (disptab
,
13867 XVECTOR (BVAR (current_buffer
, width_table
))))
13869 invalidate_region_cache (current_buffer
,
13870 current_buffer
->width_run_cache
,
13872 recompute_width_table (current_buffer
, disptab
);
13876 /* If window-start is screwed up, choose a new one. */
13877 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13880 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13882 /* If someone specified a new starting point but did not insist,
13883 check whether it can be used. */
13884 if (!NILP (w
->optional_new_start
)
13885 && CHARPOS (startp
) >= BEGV
13886 && CHARPOS (startp
) <= ZV
)
13888 w
->optional_new_start
= Qnil
;
13889 start_display (&it
, w
, startp
);
13890 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13891 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13892 if (IT_CHARPOS (it
) == PT
)
13893 w
->force_start
= Qt
;
13894 /* IT may overshoot PT if text at PT is invisible. */
13895 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13896 w
->force_start
= Qt
;
13901 /* Handle case where place to start displaying has been specified,
13902 unless the specified location is outside the accessible range. */
13903 if (!NILP (w
->force_start
)
13904 || w
->frozen_window_start_p
)
13906 /* We set this later on if we have to adjust point. */
13909 w
->force_start
= Qnil
;
13911 w
->window_end_valid
= Qnil
;
13913 /* Forget any recorded base line for line number display. */
13914 if (!buffer_unchanged_p
)
13915 w
->base_line_number
= Qnil
;
13917 /* Redisplay the mode line. Select the buffer properly for that.
13918 Also, run the hook window-scroll-functions
13919 because we have scrolled. */
13920 /* Note, we do this after clearing force_start because
13921 if there's an error, it is better to forget about force_start
13922 than to get into an infinite loop calling the hook functions
13923 and having them get more errors. */
13924 if (!update_mode_line
13925 || ! NILP (Vwindow_scroll_functions
))
13927 update_mode_line
= 1;
13928 w
->update_mode_line
= Qt
;
13929 startp
= run_window_scroll_functions (window
, startp
);
13932 w
->last_modified
= make_number (0);
13933 w
->last_overlay_modified
= make_number (0);
13934 if (CHARPOS (startp
) < BEGV
)
13935 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13936 else if (CHARPOS (startp
) > ZV
)
13937 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13939 /* Redisplay, then check if cursor has been set during the
13940 redisplay. Give up if new fonts were loaded. */
13941 /* We used to issue a CHECK_MARGINS argument to try_window here,
13942 but this causes scrolling to fail when point begins inside
13943 the scroll margin (bug#148) -- cyd */
13944 if (!try_window (window
, startp
, 0))
13946 w
->force_start
= Qt
;
13947 clear_glyph_matrix (w
->desired_matrix
);
13948 goto need_larger_matrices
;
13951 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13953 /* If point does not appear, try to move point so it does
13954 appear. The desired matrix has been built above, so we
13955 can use it here. */
13956 new_vpos
= window_box_height (w
) / 2;
13959 if (!cursor_row_fully_visible_p (w
, 0, 0))
13961 /* Point does appear, but on a line partly visible at end of window.
13962 Move it back to a fully-visible line. */
13963 new_vpos
= window_box_height (w
);
13966 /* If we need to move point for either of the above reasons,
13967 now actually do it. */
13970 struct glyph_row
*row
;
13972 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13973 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13976 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13977 MATRIX_ROW_START_BYTEPOS (row
));
13979 if (w
!= XWINDOW (selected_window
))
13980 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13981 else if (current_buffer
== old
)
13982 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13984 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13986 /* If we are highlighting the region, then we just changed
13987 the region, so redisplay to show it. */
13988 if (!NILP (Vtransient_mark_mode
)
13989 && !NILP (BVAR (current_buffer
, mark_active
)))
13991 clear_glyph_matrix (w
->desired_matrix
);
13992 if (!try_window (window
, startp
, 0))
13993 goto need_larger_matrices
;
13998 debug_method_add (w
, "forced window start");
14003 /* Handle case where text has not changed, only point, and it has
14004 not moved off the frame, and we are not retrying after hscroll.
14005 (current_matrix_up_to_date_p is nonzero when retrying.) */
14006 if (current_matrix_up_to_date_p
14007 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14008 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14012 case CURSOR_MOVEMENT_SUCCESS
:
14013 used_current_matrix_p
= 1;
14016 case CURSOR_MOVEMENT_MUST_SCROLL
:
14017 goto try_to_scroll
;
14023 /* If current starting point was originally the beginning of a line
14024 but no longer is, find a new starting point. */
14025 else if (!NILP (w
->start_at_line_beg
)
14026 && !(CHARPOS (startp
) <= BEGV
14027 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14030 debug_method_add (w
, "recenter 1");
14035 /* Try scrolling with try_window_id. Value is > 0 if update has
14036 been done, it is -1 if we know that the same window start will
14037 not work. It is 0 if unsuccessful for some other reason. */
14038 else if ((tem
= try_window_id (w
)) != 0)
14041 debug_method_add (w
, "try_window_id %d", tem
);
14044 if (fonts_changed_p
)
14045 goto need_larger_matrices
;
14049 /* Otherwise try_window_id has returned -1 which means that we
14050 don't want the alternative below this comment to execute. */
14052 else if (CHARPOS (startp
) >= BEGV
14053 && CHARPOS (startp
) <= ZV
14054 && PT
>= CHARPOS (startp
)
14055 && (CHARPOS (startp
) < ZV
14056 /* Avoid starting at end of buffer. */
14057 || CHARPOS (startp
) == BEGV
14058 || (XFASTINT (w
->last_modified
) >= MODIFF
14059 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14062 /* If first window line is a continuation line, and window start
14063 is inside the modified region, but the first change is before
14064 current window start, we must select a new window start.
14066 However, if this is the result of a down-mouse event (e.g. by
14067 extending the mouse-drag-overlay), we don't want to select a
14068 new window start, since that would change the position under
14069 the mouse, resulting in an unwanted mouse-movement rather
14070 than a simple mouse-click. */
14071 if (NILP (w
->start_at_line_beg
)
14072 && NILP (do_mouse_tracking
)
14073 && CHARPOS (startp
) > BEGV
14074 && CHARPOS (startp
) > BEG
+ beg_unchanged
14075 && CHARPOS (startp
) <= Z
- end_unchanged
14076 /* Even if w->start_at_line_beg is nil, a new window may
14077 start at a line_beg, since that's how set_buffer_window
14078 sets it. So, we need to check the return value of
14079 compute_window_start_on_continuation_line. (See also
14081 && XMARKER (w
->start
)->buffer
== current_buffer
14082 && compute_window_start_on_continuation_line (w
))
14084 w
->force_start
= Qt
;
14085 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14090 debug_method_add (w
, "same window start");
14093 /* Try to redisplay starting at same place as before.
14094 If point has not moved off frame, accept the results. */
14095 if (!current_matrix_up_to_date_p
14096 /* Don't use try_window_reusing_current_matrix in this case
14097 because a window scroll function can have changed the
14099 || !NILP (Vwindow_scroll_functions
)
14100 || MINI_WINDOW_P (w
)
14101 || !(used_current_matrix_p
14102 = try_window_reusing_current_matrix (w
)))
14104 IF_DEBUG (debug_method_add (w
, "1"));
14105 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14106 /* -1 means we need to scroll.
14107 0 means we need new matrices, but fonts_changed_p
14108 is set in that case, so we will detect it below. */
14109 goto try_to_scroll
;
14112 if (fonts_changed_p
)
14113 goto need_larger_matrices
;
14115 if (w
->cursor
.vpos
>= 0)
14117 if (!just_this_one_p
14118 || current_buffer
->clip_changed
14119 || BEG_UNCHANGED
< CHARPOS (startp
))
14120 /* Forget any recorded base line for line number display. */
14121 w
->base_line_number
= Qnil
;
14123 if (!cursor_row_fully_visible_p (w
, 1, 0))
14125 clear_glyph_matrix (w
->desired_matrix
);
14126 last_line_misfit
= 1;
14128 /* Drop through and scroll. */
14133 clear_glyph_matrix (w
->desired_matrix
);
14138 w
->last_modified
= make_number (0);
14139 w
->last_overlay_modified
= make_number (0);
14141 /* Redisplay the mode line. Select the buffer properly for that. */
14142 if (!update_mode_line
)
14144 update_mode_line
= 1;
14145 w
->update_mode_line
= Qt
;
14148 /* Try to scroll by specified few lines. */
14149 if ((scroll_conservatively
14150 || emacs_scroll_step
14151 || temp_scroll_step
14152 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14153 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14154 && CHARPOS (startp
) >= BEGV
14155 && CHARPOS (startp
) <= ZV
)
14157 /* The function returns -1 if new fonts were loaded, 1 if
14158 successful, 0 if not successful. */
14159 int ss
= try_scrolling (window
, just_this_one_p
,
14160 scroll_conservatively
,
14162 temp_scroll_step
, last_line_misfit
);
14165 case SCROLLING_SUCCESS
:
14168 case SCROLLING_NEED_LARGER_MATRICES
:
14169 goto need_larger_matrices
;
14171 case SCROLLING_FAILED
:
14179 /* Finally, just choose a place to start which positions point
14180 according to user preferences. */
14185 debug_method_add (w
, "recenter");
14188 /* w->vscroll = 0; */
14190 /* Forget any previously recorded base line for line number display. */
14191 if (!buffer_unchanged_p
)
14192 w
->base_line_number
= Qnil
;
14194 /* Determine the window start relative to point. */
14195 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14196 it
.current_y
= it
.last_visible_y
;
14197 if (centering_position
< 0)
14201 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14203 EMACS_INT margin_pos
= CHARPOS (startp
);
14205 Lisp_Object aggressive
;
14207 /* If there is a scroll margin at the top of the window, find
14208 its character position. */
14213 start_display (&it1
, w
, startp
);
14214 move_it_vertically (&it1
, margin
);
14215 margin_pos
= IT_CHARPOS (it1
);
14217 scrolling_up
= PT
> margin_pos
;
14220 ? BVAR (current_buffer
, scroll_up_aggressively
)
14221 : BVAR (current_buffer
, scroll_down_aggressively
);
14223 if (!MINI_WINDOW_P (w
)
14224 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14228 /* Setting scroll-conservatively overrides
14229 scroll-*-aggressively. */
14230 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14232 double float_amount
= XFLOATINT (aggressive
);
14234 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14235 if (pt_offset
== 0 && float_amount
> 0)
14240 /* Compute how much to move the window start backward from
14241 point so that point will be displayed where the user
14245 centering_position
= it
.last_visible_y
;
14247 centering_position
-= pt_offset
;
14248 centering_position
-=
14249 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14250 /* Don't let point enter the scroll margin near top of
14252 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14253 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14256 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14259 /* Set the window start half the height of the window backward
14261 centering_position
= window_box_height (w
) / 2;
14263 move_it_vertically_backward (&it
, centering_position
);
14265 xassert (IT_CHARPOS (it
) >= BEGV
);
14267 /* The function move_it_vertically_backward may move over more
14268 than the specified y-distance. If it->w is small, e.g. a
14269 mini-buffer window, we may end up in front of the window's
14270 display area. Start displaying at the start of the line
14271 containing PT in this case. */
14272 if (it
.current_y
<= 0)
14274 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14275 move_it_vertically_backward (&it
, 0);
14279 it
.current_x
= it
.hpos
= 0;
14281 /* Set the window start position here explicitly, to avoid an
14282 infinite loop in case the functions in window-scroll-functions
14284 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14286 /* Run scroll hooks. */
14287 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14289 /* Redisplay the window. */
14290 if (!current_matrix_up_to_date_p
14291 || windows_or_buffers_changed
14292 || cursor_type_changed
14293 /* Don't use try_window_reusing_current_matrix in this case
14294 because it can have changed the buffer. */
14295 || !NILP (Vwindow_scroll_functions
)
14296 || !just_this_one_p
14297 || MINI_WINDOW_P (w
)
14298 || !(used_current_matrix_p
14299 = try_window_reusing_current_matrix (w
)))
14300 try_window (window
, startp
, 0);
14302 /* If new fonts have been loaded (due to fontsets), give up. We
14303 have to start a new redisplay since we need to re-adjust glyph
14305 if (fonts_changed_p
)
14306 goto need_larger_matrices
;
14308 /* If cursor did not appear assume that the middle of the window is
14309 in the first line of the window. Do it again with the next line.
14310 (Imagine a window of height 100, displaying two lines of height
14311 60. Moving back 50 from it->last_visible_y will end in the first
14313 if (w
->cursor
.vpos
< 0)
14315 if (!NILP (w
->window_end_valid
)
14316 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14318 clear_glyph_matrix (w
->desired_matrix
);
14319 move_it_by_lines (&it
, 1);
14320 try_window (window
, it
.current
.pos
, 0);
14322 else if (PT
< IT_CHARPOS (it
))
14324 clear_glyph_matrix (w
->desired_matrix
);
14325 move_it_by_lines (&it
, -1);
14326 try_window (window
, it
.current
.pos
, 0);
14330 /* Not much we can do about it. */
14334 /* Consider the following case: Window starts at BEGV, there is
14335 invisible, intangible text at BEGV, so that display starts at
14336 some point START > BEGV. It can happen that we are called with
14337 PT somewhere between BEGV and START. Try to handle that case. */
14338 if (w
->cursor
.vpos
< 0)
14340 struct glyph_row
*row
= w
->current_matrix
->rows
;
14341 if (row
->mode_line_p
)
14343 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14346 if (!cursor_row_fully_visible_p (w
, 0, 0))
14348 /* If vscroll is enabled, disable it and try again. */
14352 clear_glyph_matrix (w
->desired_matrix
);
14356 /* If centering point failed to make the whole line visible,
14357 put point at the top instead. That has to make the whole line
14358 visible, if it can be done. */
14359 if (centering_position
== 0)
14362 clear_glyph_matrix (w
->desired_matrix
);
14363 centering_position
= 0;
14369 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14370 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14371 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14374 /* Display the mode line, if we must. */
14375 if ((update_mode_line
14376 /* If window not full width, must redo its mode line
14377 if (a) the window to its side is being redone and
14378 (b) we do a frame-based redisplay. This is a consequence
14379 of how inverted lines are drawn in frame-based redisplay. */
14380 || (!just_this_one_p
14381 && !FRAME_WINDOW_P (f
)
14382 && !WINDOW_FULL_WIDTH_P (w
))
14383 /* Line number to display. */
14384 || INTEGERP (w
->base_line_pos
)
14385 /* Column number is displayed and different from the one displayed. */
14386 || (!NILP (w
->column_number_displayed
)
14387 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14388 /* This means that the window has a mode line. */
14389 && (WINDOW_WANTS_MODELINE_P (w
)
14390 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14392 display_mode_lines (w
);
14394 /* If mode line height has changed, arrange for a thorough
14395 immediate redisplay using the correct mode line height. */
14396 if (WINDOW_WANTS_MODELINE_P (w
)
14397 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14399 fonts_changed_p
= 1;
14400 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14401 = DESIRED_MODE_LINE_HEIGHT (w
);
14404 /* If header line height has changed, arrange for a thorough
14405 immediate redisplay using the correct header line height. */
14406 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14407 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14409 fonts_changed_p
= 1;
14410 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14411 = DESIRED_HEADER_LINE_HEIGHT (w
);
14414 if (fonts_changed_p
)
14415 goto need_larger_matrices
;
14418 if (!line_number_displayed
14419 && !BUFFERP (w
->base_line_pos
))
14421 w
->base_line_pos
= Qnil
;
14422 w
->base_line_number
= Qnil
;
14427 /* When we reach a frame's selected window, redo the frame's menu bar. */
14428 if (update_mode_line
14429 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14431 int redisplay_menu_p
= 0;
14432 int redisplay_tool_bar_p
= 0;
14434 if (FRAME_WINDOW_P (f
))
14436 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14437 || defined (HAVE_NS) || defined (USE_GTK)
14438 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14440 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14444 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14446 if (redisplay_menu_p
)
14447 display_menu_bar (w
);
14449 #ifdef HAVE_WINDOW_SYSTEM
14450 if (FRAME_WINDOW_P (f
))
14452 #if defined (USE_GTK) || defined (HAVE_NS)
14453 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14455 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14456 && (FRAME_TOOL_BAR_LINES (f
) > 0
14457 || !NILP (Vauto_resize_tool_bars
));
14460 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14462 ignore_mouse_drag_p
= 1;
14468 #ifdef HAVE_WINDOW_SYSTEM
14469 if (FRAME_WINDOW_P (f
)
14470 && update_window_fringes (w
, (just_this_one_p
14471 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14472 || w
->pseudo_window_p
)))
14476 if (draw_window_fringes (w
, 1))
14477 x_draw_vertical_border (w
);
14481 #endif /* HAVE_WINDOW_SYSTEM */
14483 /* We go to this label, with fonts_changed_p nonzero,
14484 if it is necessary to try again using larger glyph matrices.
14485 We have to redeem the scroll bar even in this case,
14486 because the loop in redisplay_internal expects that. */
14487 need_larger_matrices
:
14489 finish_scroll_bars
:
14491 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14493 /* Set the thumb's position and size. */
14494 set_vertical_scroll_bar (w
);
14496 /* Note that we actually used the scroll bar attached to this
14497 window, so it shouldn't be deleted at the end of redisplay. */
14498 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14499 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14502 /* Restore current_buffer and value of point in it. The window
14503 update may have changed the buffer, so first make sure `opoint'
14504 is still valid (Bug#6177). */
14505 if (CHARPOS (opoint
) < BEGV
)
14506 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14507 else if (CHARPOS (opoint
) > ZV
)
14508 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14510 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14512 set_buffer_internal_1 (old
);
14513 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14514 shorter. This can be caused by log truncation in *Messages*. */
14515 if (CHARPOS (lpoint
) <= ZV
)
14516 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14518 unbind_to (count
, Qnil
);
14522 /* Build the complete desired matrix of WINDOW with a window start
14523 buffer position POS.
14525 Value is 1 if successful. It is zero if fonts were loaded during
14526 redisplay which makes re-adjusting glyph matrices necessary, and -1
14527 if point would appear in the scroll margins.
14528 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14529 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14533 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14535 struct window
*w
= XWINDOW (window
);
14537 struct glyph_row
*last_text_row
= NULL
;
14538 struct frame
*f
= XFRAME (w
->frame
);
14540 /* Make POS the new window start. */
14541 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14543 /* Mark cursor position as unknown. No overlay arrow seen. */
14544 w
->cursor
.vpos
= -1;
14545 overlay_arrow_seen
= 0;
14547 /* Initialize iterator and info to start at POS. */
14548 start_display (&it
, w
, pos
);
14550 /* Display all lines of W. */
14551 while (it
.current_y
< it
.last_visible_y
)
14553 if (display_line (&it
))
14554 last_text_row
= it
.glyph_row
- 1;
14555 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14559 /* Don't let the cursor end in the scroll margins. */
14560 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14561 && !MINI_WINDOW_P (w
))
14563 int this_scroll_margin
;
14565 if (scroll_margin
> 0)
14567 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14568 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14571 this_scroll_margin
= 0;
14573 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14574 && w
->cursor
.y
< this_scroll_margin
14575 && CHARPOS (pos
) > BEGV
14576 && IT_CHARPOS (it
) < ZV
)
14577 /* rms: considering make_cursor_line_fully_visible_p here
14578 seems to give wrong results. We don't want to recenter
14579 when the last line is partly visible, we want to allow
14580 that case to be handled in the usual way. */
14581 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14583 w
->cursor
.vpos
= -1;
14584 clear_glyph_matrix (w
->desired_matrix
);
14589 /* If bottom moved off end of frame, change mode line percentage. */
14590 if (XFASTINT (w
->window_end_pos
) <= 0
14591 && Z
!= IT_CHARPOS (it
))
14592 w
->update_mode_line
= Qt
;
14594 /* Set window_end_pos to the offset of the last character displayed
14595 on the window from the end of current_buffer. Set
14596 window_end_vpos to its row number. */
14599 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14600 w
->window_end_bytepos
14601 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14603 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14605 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14606 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14607 ->displays_text_p
);
14611 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14612 w
->window_end_pos
= make_number (Z
- ZV
);
14613 w
->window_end_vpos
= make_number (0);
14616 /* But that is not valid info until redisplay finishes. */
14617 w
->window_end_valid
= Qnil
;
14623 /************************************************************************
14624 Window redisplay reusing current matrix when buffer has not changed
14625 ************************************************************************/
14627 /* Try redisplay of window W showing an unchanged buffer with a
14628 different window start than the last time it was displayed by
14629 reusing its current matrix. Value is non-zero if successful.
14630 W->start is the new window start. */
14633 try_window_reusing_current_matrix (struct window
*w
)
14635 struct frame
*f
= XFRAME (w
->frame
);
14636 struct glyph_row
*bottom_row
;
14639 struct text_pos start
, new_start
;
14640 int nrows_scrolled
, i
;
14641 struct glyph_row
*last_text_row
;
14642 struct glyph_row
*last_reused_text_row
;
14643 struct glyph_row
*start_row
;
14644 int start_vpos
, min_y
, max_y
;
14647 if (inhibit_try_window_reusing
)
14651 if (/* This function doesn't handle terminal frames. */
14652 !FRAME_WINDOW_P (f
)
14653 /* Don't try to reuse the display if windows have been split
14655 || windows_or_buffers_changed
14656 || cursor_type_changed
)
14659 /* Can't do this if region may have changed. */
14660 if ((!NILP (Vtransient_mark_mode
)
14661 && !NILP (BVAR (current_buffer
, mark_active
)))
14662 || !NILP (w
->region_showing
)
14663 || !NILP (Vshow_trailing_whitespace
))
14666 /* If top-line visibility has changed, give up. */
14667 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14668 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14671 /* Give up if old or new display is scrolled vertically. We could
14672 make this function handle this, but right now it doesn't. */
14673 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14674 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14677 /* The variable new_start now holds the new window start. The old
14678 start `start' can be determined from the current matrix. */
14679 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14680 start
= start_row
->minpos
;
14681 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14683 /* Clear the desired matrix for the display below. */
14684 clear_glyph_matrix (w
->desired_matrix
);
14686 if (CHARPOS (new_start
) <= CHARPOS (start
))
14688 /* Don't use this method if the display starts with an ellipsis
14689 displayed for invisible text. It's not easy to handle that case
14690 below, and it's certainly not worth the effort since this is
14691 not a frequent case. */
14692 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14695 IF_DEBUG (debug_method_add (w
, "twu1"));
14697 /* Display up to a row that can be reused. The variable
14698 last_text_row is set to the last row displayed that displays
14699 text. Note that it.vpos == 0 if or if not there is a
14700 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14701 start_display (&it
, w
, new_start
);
14702 w
->cursor
.vpos
= -1;
14703 last_text_row
= last_reused_text_row
= NULL
;
14705 while (it
.current_y
< it
.last_visible_y
14706 && !fonts_changed_p
)
14708 /* If we have reached into the characters in the START row,
14709 that means the line boundaries have changed. So we
14710 can't start copying with the row START. Maybe it will
14711 work to start copying with the following row. */
14712 while (IT_CHARPOS (it
) > CHARPOS (start
))
14714 /* Advance to the next row as the "start". */
14716 start
= start_row
->minpos
;
14717 /* If there are no more rows to try, or just one, give up. */
14718 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14719 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14720 || CHARPOS (start
) == ZV
)
14722 clear_glyph_matrix (w
->desired_matrix
);
14726 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14728 /* If we have reached alignment,
14729 we can copy the rest of the rows. */
14730 if (IT_CHARPOS (it
) == CHARPOS (start
))
14733 if (display_line (&it
))
14734 last_text_row
= it
.glyph_row
- 1;
14737 /* A value of current_y < last_visible_y means that we stopped
14738 at the previous window start, which in turn means that we
14739 have at least one reusable row. */
14740 if (it
.current_y
< it
.last_visible_y
)
14742 struct glyph_row
*row
;
14744 /* IT.vpos always starts from 0; it counts text lines. */
14745 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14747 /* Find PT if not already found in the lines displayed. */
14748 if (w
->cursor
.vpos
< 0)
14750 int dy
= it
.current_y
- start_row
->y
;
14752 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14753 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14755 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14756 dy
, nrows_scrolled
);
14759 clear_glyph_matrix (w
->desired_matrix
);
14764 /* Scroll the display. Do it before the current matrix is
14765 changed. The problem here is that update has not yet
14766 run, i.e. part of the current matrix is not up to date.
14767 scroll_run_hook will clear the cursor, and use the
14768 current matrix to get the height of the row the cursor is
14770 run
.current_y
= start_row
->y
;
14771 run
.desired_y
= it
.current_y
;
14772 run
.height
= it
.last_visible_y
- it
.current_y
;
14774 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14777 FRAME_RIF (f
)->update_window_begin_hook (w
);
14778 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14779 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14780 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14784 /* Shift current matrix down by nrows_scrolled lines. */
14785 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14786 rotate_matrix (w
->current_matrix
,
14788 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14791 /* Disable lines that must be updated. */
14792 for (i
= 0; i
< nrows_scrolled
; ++i
)
14793 (start_row
+ i
)->enabled_p
= 0;
14795 /* Re-compute Y positions. */
14796 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14797 max_y
= it
.last_visible_y
;
14798 for (row
= start_row
+ nrows_scrolled
;
14802 row
->y
= it
.current_y
;
14803 row
->visible_height
= row
->height
;
14805 if (row
->y
< min_y
)
14806 row
->visible_height
-= min_y
- row
->y
;
14807 if (row
->y
+ row
->height
> max_y
)
14808 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14809 row
->redraw_fringe_bitmaps_p
= 1;
14811 it
.current_y
+= row
->height
;
14813 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14814 last_reused_text_row
= row
;
14815 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14819 /* Disable lines in the current matrix which are now
14820 below the window. */
14821 for (++row
; row
< bottom_row
; ++row
)
14822 row
->enabled_p
= row
->mode_line_p
= 0;
14825 /* Update window_end_pos etc.; last_reused_text_row is the last
14826 reused row from the current matrix containing text, if any.
14827 The value of last_text_row is the last displayed line
14828 containing text. */
14829 if (last_reused_text_row
)
14831 w
->window_end_bytepos
14832 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14834 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14836 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14837 w
->current_matrix
));
14839 else if (last_text_row
)
14841 w
->window_end_bytepos
14842 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14844 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14846 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14850 /* This window must be completely empty. */
14851 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14852 w
->window_end_pos
= make_number (Z
- ZV
);
14853 w
->window_end_vpos
= make_number (0);
14855 w
->window_end_valid
= Qnil
;
14857 /* Update hint: don't try scrolling again in update_window. */
14858 w
->desired_matrix
->no_scrolling_p
= 1;
14861 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14865 else if (CHARPOS (new_start
) > CHARPOS (start
))
14867 struct glyph_row
*pt_row
, *row
;
14868 struct glyph_row
*first_reusable_row
;
14869 struct glyph_row
*first_row_to_display
;
14871 int yb
= window_text_bottom_y (w
);
14873 /* Find the row starting at new_start, if there is one. Don't
14874 reuse a partially visible line at the end. */
14875 first_reusable_row
= start_row
;
14876 while (first_reusable_row
->enabled_p
14877 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14878 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14879 < CHARPOS (new_start
)))
14880 ++first_reusable_row
;
14882 /* Give up if there is no row to reuse. */
14883 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14884 || !first_reusable_row
->enabled_p
14885 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14886 != CHARPOS (new_start
)))
14889 /* We can reuse fully visible rows beginning with
14890 first_reusable_row to the end of the window. Set
14891 first_row_to_display to the first row that cannot be reused.
14892 Set pt_row to the row containing point, if there is any. */
14894 for (first_row_to_display
= first_reusable_row
;
14895 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14896 ++first_row_to_display
)
14898 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14899 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14900 pt_row
= first_row_to_display
;
14903 /* Start displaying at the start of first_row_to_display. */
14904 xassert (first_row_to_display
->y
< yb
);
14905 init_to_row_start (&it
, w
, first_row_to_display
);
14907 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14909 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14911 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14912 + WINDOW_HEADER_LINE_HEIGHT (w
));
14914 /* Display lines beginning with first_row_to_display in the
14915 desired matrix. Set last_text_row to the last row displayed
14916 that displays text. */
14917 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14918 if (pt_row
== NULL
)
14919 w
->cursor
.vpos
= -1;
14920 last_text_row
= NULL
;
14921 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14922 if (display_line (&it
))
14923 last_text_row
= it
.glyph_row
- 1;
14925 /* If point is in a reused row, adjust y and vpos of the cursor
14929 w
->cursor
.vpos
-= nrows_scrolled
;
14930 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14933 /* Give up if point isn't in a row displayed or reused. (This
14934 also handles the case where w->cursor.vpos < nrows_scrolled
14935 after the calls to display_line, which can happen with scroll
14936 margins. See bug#1295.) */
14937 if (w
->cursor
.vpos
< 0)
14939 clear_glyph_matrix (w
->desired_matrix
);
14943 /* Scroll the display. */
14944 run
.current_y
= first_reusable_row
->y
;
14945 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14946 run
.height
= it
.last_visible_y
- run
.current_y
;
14947 dy
= run
.current_y
- run
.desired_y
;
14952 FRAME_RIF (f
)->update_window_begin_hook (w
);
14953 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14954 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14955 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14959 /* Adjust Y positions of reused rows. */
14960 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14961 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14962 max_y
= it
.last_visible_y
;
14963 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14966 row
->visible_height
= row
->height
;
14967 if (row
->y
< min_y
)
14968 row
->visible_height
-= min_y
- row
->y
;
14969 if (row
->y
+ row
->height
> max_y
)
14970 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14971 row
->redraw_fringe_bitmaps_p
= 1;
14974 /* Scroll the current matrix. */
14975 xassert (nrows_scrolled
> 0);
14976 rotate_matrix (w
->current_matrix
,
14978 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14981 /* Disable rows not reused. */
14982 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14983 row
->enabled_p
= 0;
14985 /* Point may have moved to a different line, so we cannot assume that
14986 the previous cursor position is valid; locate the correct row. */
14989 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14990 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14994 w
->cursor
.y
= row
->y
;
14996 if (row
< bottom_row
)
14998 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14999 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15001 /* Can't use this optimization with bidi-reordered glyph
15002 rows, unless cursor is already at point. */
15003 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15005 if (!(w
->cursor
.hpos
>= 0
15006 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15007 && BUFFERP (glyph
->object
)
15008 && glyph
->charpos
== PT
))
15013 && (!BUFFERP (glyph
->object
)
15014 || glyph
->charpos
< PT
);
15018 w
->cursor
.x
+= glyph
->pixel_width
;
15023 /* Adjust window end. A null value of last_text_row means that
15024 the window end is in reused rows which in turn means that
15025 only its vpos can have changed. */
15028 w
->window_end_bytepos
15029 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15031 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15033 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15038 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15041 w
->window_end_valid
= Qnil
;
15042 w
->desired_matrix
->no_scrolling_p
= 1;
15045 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15055 /************************************************************************
15056 Window redisplay reusing current matrix when buffer has changed
15057 ************************************************************************/
15059 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15060 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15061 EMACS_INT
*, EMACS_INT
*);
15062 static struct glyph_row
*
15063 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15064 struct glyph_row
*);
15067 /* Return the last row in MATRIX displaying text. If row START is
15068 non-null, start searching with that row. IT gives the dimensions
15069 of the display. Value is null if matrix is empty; otherwise it is
15070 a pointer to the row found. */
15072 static struct glyph_row
*
15073 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15074 struct glyph_row
*start
)
15076 struct glyph_row
*row
, *row_found
;
15078 /* Set row_found to the last row in IT->w's current matrix
15079 displaying text. The loop looks funny but think of partially
15082 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15083 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15085 xassert (row
->enabled_p
);
15087 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15096 /* Return the last row in the current matrix of W that is not affected
15097 by changes at the start of current_buffer that occurred since W's
15098 current matrix was built. Value is null if no such row exists.
15100 BEG_UNCHANGED us the number of characters unchanged at the start of
15101 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15102 first changed character in current_buffer. Characters at positions <
15103 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15104 when the current matrix was built. */
15106 static struct glyph_row
*
15107 find_last_unchanged_at_beg_row (struct window
*w
)
15109 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15110 struct glyph_row
*row
;
15111 struct glyph_row
*row_found
= NULL
;
15112 int yb
= window_text_bottom_y (w
);
15114 /* Find the last row displaying unchanged text. */
15115 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15116 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15117 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15120 if (/* If row ends before first_changed_pos, it is unchanged,
15121 except in some case. */
15122 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15123 /* When row ends in ZV and we write at ZV it is not
15125 && !row
->ends_at_zv_p
15126 /* When first_changed_pos is the end of a continued line,
15127 row is not unchanged because it may be no longer
15129 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15130 && (row
->continued_p
15131 || row
->exact_window_width_line_p
)))
15134 /* Stop if last visible row. */
15135 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15143 /* Find the first glyph row in the current matrix of W that is not
15144 affected by changes at the end of current_buffer since the
15145 time W's current matrix was built.
15147 Return in *DELTA the number of chars by which buffer positions in
15148 unchanged text at the end of current_buffer must be adjusted.
15150 Return in *DELTA_BYTES the corresponding number of bytes.
15152 Value is null if no such row exists, i.e. all rows are affected by
15155 static struct glyph_row
*
15156 find_first_unchanged_at_end_row (struct window
*w
,
15157 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15159 struct glyph_row
*row
;
15160 struct glyph_row
*row_found
= NULL
;
15162 *delta
= *delta_bytes
= 0;
15164 /* Display must not have been paused, otherwise the current matrix
15165 is not up to date. */
15166 eassert (!NILP (w
->window_end_valid
));
15168 /* A value of window_end_pos >= END_UNCHANGED means that the window
15169 end is in the range of changed text. If so, there is no
15170 unchanged row at the end of W's current matrix. */
15171 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15174 /* Set row to the last row in W's current matrix displaying text. */
15175 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15177 /* If matrix is entirely empty, no unchanged row exists. */
15178 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15180 /* The value of row is the last glyph row in the matrix having a
15181 meaningful buffer position in it. The end position of row
15182 corresponds to window_end_pos. This allows us to translate
15183 buffer positions in the current matrix to current buffer
15184 positions for characters not in changed text. */
15186 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15187 EMACS_INT Z_BYTE_old
=
15188 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15189 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15190 struct glyph_row
*first_text_row
15191 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15193 *delta
= Z
- Z_old
;
15194 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15196 /* Set last_unchanged_pos to the buffer position of the last
15197 character in the buffer that has not been changed. Z is the
15198 index + 1 of the last character in current_buffer, i.e. by
15199 subtracting END_UNCHANGED we get the index of the last
15200 unchanged character, and we have to add BEG to get its buffer
15202 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15203 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15205 /* Search backward from ROW for a row displaying a line that
15206 starts at a minimum position >= last_unchanged_pos_old. */
15207 for (; row
> first_text_row
; --row
)
15209 /* This used to abort, but it can happen.
15210 It is ok to just stop the search instead here. KFS. */
15211 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15214 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15219 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15225 /* Make sure that glyph rows in the current matrix of window W
15226 reference the same glyph memory as corresponding rows in the
15227 frame's frame matrix. This function is called after scrolling W's
15228 current matrix on a terminal frame in try_window_id and
15229 try_window_reusing_current_matrix. */
15232 sync_frame_with_window_matrix_rows (struct window
*w
)
15234 struct frame
*f
= XFRAME (w
->frame
);
15235 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15237 /* Preconditions: W must be a leaf window and full-width. Its frame
15238 must have a frame matrix. */
15239 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15240 xassert (WINDOW_FULL_WIDTH_P (w
));
15241 xassert (!FRAME_WINDOW_P (f
));
15243 /* If W is a full-width window, glyph pointers in W's current matrix
15244 have, by definition, to be the same as glyph pointers in the
15245 corresponding frame matrix. Note that frame matrices have no
15246 marginal areas (see build_frame_matrix). */
15247 window_row
= w
->current_matrix
->rows
;
15248 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15249 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15250 while (window_row
< window_row_end
)
15252 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15253 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15255 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15256 frame_row
->glyphs
[TEXT_AREA
] = start
;
15257 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15258 frame_row
->glyphs
[LAST_AREA
] = end
;
15260 /* Disable frame rows whose corresponding window rows have
15261 been disabled in try_window_id. */
15262 if (!window_row
->enabled_p
)
15263 frame_row
->enabled_p
= 0;
15265 ++window_row
, ++frame_row
;
15270 /* Find the glyph row in window W containing CHARPOS. Consider all
15271 rows between START and END (not inclusive). END null means search
15272 all rows to the end of the display area of W. Value is the row
15273 containing CHARPOS or null. */
15276 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15277 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15279 struct glyph_row
*row
= start
;
15280 struct glyph_row
*best_row
= NULL
;
15281 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15284 /* If we happen to start on a header-line, skip that. */
15285 if (row
->mode_line_p
)
15288 if ((end
&& row
>= end
) || !row
->enabled_p
)
15291 last_y
= window_text_bottom_y (w
) - dy
;
15295 /* Give up if we have gone too far. */
15296 if (end
&& row
>= end
)
15298 /* This formerly returned if they were equal.
15299 I think that both quantities are of a "last plus one" type;
15300 if so, when they are equal, the row is within the screen. -- rms. */
15301 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15304 /* If it is in this row, return this row. */
15305 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15306 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15307 /* The end position of a row equals the start
15308 position of the next row. If CHARPOS is there, we
15309 would rather display it in the next line, except
15310 when this line ends in ZV. */
15311 && !row
->ends_at_zv_p
15312 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15313 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15317 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15318 || (!best_row
&& !row
->continued_p
))
15320 /* In bidi-reordered rows, there could be several rows
15321 occluding point, all of them belonging to the same
15322 continued line. We need to find the row which fits
15323 CHARPOS the best. */
15324 for (g
= row
->glyphs
[TEXT_AREA
];
15325 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15328 if (!STRINGP (g
->object
))
15330 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15332 mindif
= eabs (g
->charpos
- charpos
);
15334 /* Exact match always wins. */
15341 else if (best_row
&& !row
->continued_p
)
15348 /* Try to redisplay window W by reusing its existing display. W's
15349 current matrix must be up to date when this function is called,
15350 i.e. window_end_valid must not be nil.
15354 1 if display has been updated
15355 0 if otherwise unsuccessful
15356 -1 if redisplay with same window start is known not to succeed
15358 The following steps are performed:
15360 1. Find the last row in the current matrix of W that is not
15361 affected by changes at the start of current_buffer. If no such row
15364 2. Find the first row in W's current matrix that is not affected by
15365 changes at the end of current_buffer. Maybe there is no such row.
15367 3. Display lines beginning with the row + 1 found in step 1 to the
15368 row found in step 2 or, if step 2 didn't find a row, to the end of
15371 4. If cursor is not known to appear on the window, give up.
15373 5. If display stopped at the row found in step 2, scroll the
15374 display and current matrix as needed.
15376 6. Maybe display some lines at the end of W, if we must. This can
15377 happen under various circumstances, like a partially visible line
15378 becoming fully visible, or because newly displayed lines are displayed
15379 in smaller font sizes.
15381 7. Update W's window end information. */
15384 try_window_id (struct window
*w
)
15386 struct frame
*f
= XFRAME (w
->frame
);
15387 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15388 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15389 struct glyph_row
*last_unchanged_at_beg_row
;
15390 struct glyph_row
*first_unchanged_at_end_row
;
15391 struct glyph_row
*row
;
15392 struct glyph_row
*bottom_row
;
15395 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15397 struct text_pos start_pos
;
15399 int first_unchanged_at_end_vpos
= 0;
15400 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15401 struct text_pos start
;
15402 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15405 if (inhibit_try_window_id
)
15409 /* This is handy for debugging. */
15411 #define GIVE_UP(X) \
15413 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15417 #define GIVE_UP(X) return 0
15420 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15422 /* Don't use this for mini-windows because these can show
15423 messages and mini-buffers, and we don't handle that here. */
15424 if (MINI_WINDOW_P (w
))
15427 /* This flag is used to prevent redisplay optimizations. */
15428 if (windows_or_buffers_changed
|| cursor_type_changed
)
15431 /* Verify that narrowing has not changed.
15432 Also verify that we were not told to prevent redisplay optimizations.
15433 It would be nice to further
15434 reduce the number of cases where this prevents try_window_id. */
15435 if (current_buffer
->clip_changed
15436 || current_buffer
->prevent_redisplay_optimizations_p
)
15439 /* Window must either use window-based redisplay or be full width. */
15440 if (!FRAME_WINDOW_P (f
)
15441 && (!FRAME_LINE_INS_DEL_OK (f
)
15442 || !WINDOW_FULL_WIDTH_P (w
)))
15445 /* Give up if point is known NOT to appear in W. */
15446 if (PT
< CHARPOS (start
))
15449 /* Another way to prevent redisplay optimizations. */
15450 if (XFASTINT (w
->last_modified
) == 0)
15453 /* Verify that window is not hscrolled. */
15454 if (XFASTINT (w
->hscroll
) != 0)
15457 /* Verify that display wasn't paused. */
15458 if (NILP (w
->window_end_valid
))
15461 /* Can't use this if highlighting a region because a cursor movement
15462 will do more than just set the cursor. */
15463 if (!NILP (Vtransient_mark_mode
)
15464 && !NILP (BVAR (current_buffer
, mark_active
)))
15467 /* Likewise if highlighting trailing whitespace. */
15468 if (!NILP (Vshow_trailing_whitespace
))
15471 /* Likewise if showing a region. */
15472 if (!NILP (w
->region_showing
))
15475 /* Can't use this if overlay arrow position and/or string have
15477 if (overlay_arrows_changed_p ())
15480 /* When word-wrap is on, adding a space to the first word of a
15481 wrapped line can change the wrap position, altering the line
15482 above it. It might be worthwhile to handle this more
15483 intelligently, but for now just redisplay from scratch. */
15484 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15487 /* Under bidi reordering, adding or deleting a character in the
15488 beginning of a paragraph, before the first strong directional
15489 character, can change the base direction of the paragraph (unless
15490 the buffer specifies a fixed paragraph direction), which will
15491 require to redisplay the whole paragraph. It might be worthwhile
15492 to find the paragraph limits and widen the range of redisplayed
15493 lines to that, but for now just give up this optimization and
15494 redisplay from scratch. */
15495 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15496 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15499 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15500 only if buffer has really changed. The reason is that the gap is
15501 initially at Z for freshly visited files. The code below would
15502 set end_unchanged to 0 in that case. */
15503 if (MODIFF
> SAVE_MODIFF
15504 /* This seems to happen sometimes after saving a buffer. */
15505 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15507 if (GPT
- BEG
< BEG_UNCHANGED
)
15508 BEG_UNCHANGED
= GPT
- BEG
;
15509 if (Z
- GPT
< END_UNCHANGED
)
15510 END_UNCHANGED
= Z
- GPT
;
15513 /* The position of the first and last character that has been changed. */
15514 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15515 last_changed_charpos
= Z
- END_UNCHANGED
;
15517 /* If window starts after a line end, and the last change is in
15518 front of that newline, then changes don't affect the display.
15519 This case happens with stealth-fontification. Note that although
15520 the display is unchanged, glyph positions in the matrix have to
15521 be adjusted, of course. */
15522 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15523 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15524 && ((last_changed_charpos
< CHARPOS (start
)
15525 && CHARPOS (start
) == BEGV
)
15526 || (last_changed_charpos
< CHARPOS (start
) - 1
15527 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15529 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15530 struct glyph_row
*r0
;
15532 /* Compute how many chars/bytes have been added to or removed
15533 from the buffer. */
15534 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15535 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15536 Z_delta
= Z
- Z_old
;
15537 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15539 /* Give up if PT is not in the window. Note that it already has
15540 been checked at the start of try_window_id that PT is not in
15541 front of the window start. */
15542 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15545 /* If window start is unchanged, we can reuse the whole matrix
15546 as is, after adjusting glyph positions. No need to compute
15547 the window end again, since its offset from Z hasn't changed. */
15548 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15549 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15550 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15551 /* PT must not be in a partially visible line. */
15552 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15553 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15555 /* Adjust positions in the glyph matrix. */
15556 if (Z_delta
|| Z_delta_bytes
)
15558 struct glyph_row
*r1
15559 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15560 increment_matrix_positions (w
->current_matrix
,
15561 MATRIX_ROW_VPOS (r0
, current_matrix
),
15562 MATRIX_ROW_VPOS (r1
, current_matrix
),
15563 Z_delta
, Z_delta_bytes
);
15566 /* Set the cursor. */
15567 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15569 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15576 /* Handle the case that changes are all below what is displayed in
15577 the window, and that PT is in the window. This shortcut cannot
15578 be taken if ZV is visible in the window, and text has been added
15579 there that is visible in the window. */
15580 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15581 /* ZV is not visible in the window, or there are no
15582 changes at ZV, actually. */
15583 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15584 || first_changed_charpos
== last_changed_charpos
))
15586 struct glyph_row
*r0
;
15588 /* Give up if PT is not in the window. Note that it already has
15589 been checked at the start of try_window_id that PT is not in
15590 front of the window start. */
15591 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15594 /* If window start is unchanged, we can reuse the whole matrix
15595 as is, without changing glyph positions since no text has
15596 been added/removed in front of the window end. */
15597 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15598 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15599 /* PT must not be in a partially visible line. */
15600 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15601 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15603 /* We have to compute the window end anew since text
15604 could have been added/removed after it. */
15606 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15607 w
->window_end_bytepos
15608 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15610 /* Set the cursor. */
15611 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15613 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15620 /* Give up if window start is in the changed area.
15622 The condition used to read
15624 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15626 but why that was tested escapes me at the moment. */
15627 if (CHARPOS (start
) >= first_changed_charpos
15628 && CHARPOS (start
) <= last_changed_charpos
)
15631 /* Check that window start agrees with the start of the first glyph
15632 row in its current matrix. Check this after we know the window
15633 start is not in changed text, otherwise positions would not be
15635 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15636 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15639 /* Give up if the window ends in strings. Overlay strings
15640 at the end are difficult to handle, so don't try. */
15641 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15642 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15645 /* Compute the position at which we have to start displaying new
15646 lines. Some of the lines at the top of the window might be
15647 reusable because they are not displaying changed text. Find the
15648 last row in W's current matrix not affected by changes at the
15649 start of current_buffer. Value is null if changes start in the
15650 first line of window. */
15651 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15652 if (last_unchanged_at_beg_row
)
15654 /* Avoid starting to display in the moddle of a character, a TAB
15655 for instance. This is easier than to set up the iterator
15656 exactly, and it's not a frequent case, so the additional
15657 effort wouldn't really pay off. */
15658 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15659 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15660 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15661 --last_unchanged_at_beg_row
;
15663 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15666 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15668 start_pos
= it
.current
.pos
;
15670 /* Start displaying new lines in the desired matrix at the same
15671 vpos we would use in the current matrix, i.e. below
15672 last_unchanged_at_beg_row. */
15673 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15675 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15676 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15678 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15682 /* There are no reusable lines at the start of the window.
15683 Start displaying in the first text line. */
15684 start_display (&it
, w
, start
);
15685 it
.vpos
= it
.first_vpos
;
15686 start_pos
= it
.current
.pos
;
15689 /* Find the first row that is not affected by changes at the end of
15690 the buffer. Value will be null if there is no unchanged row, in
15691 which case we must redisplay to the end of the window. delta
15692 will be set to the value by which buffer positions beginning with
15693 first_unchanged_at_end_row have to be adjusted due to text
15695 first_unchanged_at_end_row
15696 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15697 IF_DEBUG (debug_delta
= delta
);
15698 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15700 /* Set stop_pos to the buffer position up to which we will have to
15701 display new lines. If first_unchanged_at_end_row != NULL, this
15702 is the buffer position of the start of the line displayed in that
15703 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15704 that we don't stop at a buffer position. */
15706 if (first_unchanged_at_end_row
)
15708 xassert (last_unchanged_at_beg_row
== NULL
15709 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15711 /* If this is a continuation line, move forward to the next one
15712 that isn't. Changes in lines above affect this line.
15713 Caution: this may move first_unchanged_at_end_row to a row
15714 not displaying text. */
15715 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15716 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15717 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15718 < it
.last_visible_y
))
15719 ++first_unchanged_at_end_row
;
15721 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15722 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15723 >= it
.last_visible_y
))
15724 first_unchanged_at_end_row
= NULL
;
15727 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15729 first_unchanged_at_end_vpos
15730 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15731 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15734 else if (last_unchanged_at_beg_row
== NULL
)
15740 /* Either there is no unchanged row at the end, or the one we have
15741 now displays text. This is a necessary condition for the window
15742 end pos calculation at the end of this function. */
15743 xassert (first_unchanged_at_end_row
== NULL
15744 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15746 debug_last_unchanged_at_beg_vpos
15747 = (last_unchanged_at_beg_row
15748 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15750 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15752 #endif /* GLYPH_DEBUG != 0 */
15755 /* Display new lines. Set last_text_row to the last new line
15756 displayed which has text on it, i.e. might end up as being the
15757 line where the window_end_vpos is. */
15758 w
->cursor
.vpos
= -1;
15759 last_text_row
= NULL
;
15760 overlay_arrow_seen
= 0;
15761 while (it
.current_y
< it
.last_visible_y
15762 && !fonts_changed_p
15763 && (first_unchanged_at_end_row
== NULL
15764 || IT_CHARPOS (it
) < stop_pos
))
15766 if (display_line (&it
))
15767 last_text_row
= it
.glyph_row
- 1;
15770 if (fonts_changed_p
)
15774 /* Compute differences in buffer positions, y-positions etc. for
15775 lines reused at the bottom of the window. Compute what we can
15777 if (first_unchanged_at_end_row
15778 /* No lines reused because we displayed everything up to the
15779 bottom of the window. */
15780 && it
.current_y
< it
.last_visible_y
)
15783 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15785 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15786 run
.current_y
= first_unchanged_at_end_row
->y
;
15787 run
.desired_y
= run
.current_y
+ dy
;
15788 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15792 delta
= delta_bytes
= dvpos
= dy
15793 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15794 first_unchanged_at_end_row
= NULL
;
15796 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15799 /* Find the cursor if not already found. We have to decide whether
15800 PT will appear on this window (it sometimes doesn't, but this is
15801 not a very frequent case.) This decision has to be made before
15802 the current matrix is altered. A value of cursor.vpos < 0 means
15803 that PT is either in one of the lines beginning at
15804 first_unchanged_at_end_row or below the window. Don't care for
15805 lines that might be displayed later at the window end; as
15806 mentioned, this is not a frequent case. */
15807 if (w
->cursor
.vpos
< 0)
15809 /* Cursor in unchanged rows at the top? */
15810 if (PT
< CHARPOS (start_pos
)
15811 && last_unchanged_at_beg_row
)
15813 row
= row_containing_pos (w
, PT
,
15814 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15815 last_unchanged_at_beg_row
+ 1, 0);
15817 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15820 /* Start from first_unchanged_at_end_row looking for PT. */
15821 else if (first_unchanged_at_end_row
)
15823 row
= row_containing_pos (w
, PT
- delta
,
15824 first_unchanged_at_end_row
, NULL
, 0);
15826 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15827 delta_bytes
, dy
, dvpos
);
15830 /* Give up if cursor was not found. */
15831 if (w
->cursor
.vpos
< 0)
15833 clear_glyph_matrix (w
->desired_matrix
);
15838 /* Don't let the cursor end in the scroll margins. */
15840 int this_scroll_margin
, cursor_height
;
15842 this_scroll_margin
= max (0, scroll_margin
);
15843 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15844 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15845 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15847 if ((w
->cursor
.y
< this_scroll_margin
15848 && CHARPOS (start
) > BEGV
)
15849 /* Old redisplay didn't take scroll margin into account at the bottom,
15850 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15851 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15852 ? cursor_height
+ this_scroll_margin
15853 : 1)) > it
.last_visible_y
)
15855 w
->cursor
.vpos
= -1;
15856 clear_glyph_matrix (w
->desired_matrix
);
15861 /* Scroll the display. Do it before changing the current matrix so
15862 that xterm.c doesn't get confused about where the cursor glyph is
15864 if (dy
&& run
.height
)
15868 if (FRAME_WINDOW_P (f
))
15870 FRAME_RIF (f
)->update_window_begin_hook (w
);
15871 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15872 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15873 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15877 /* Terminal frame. In this case, dvpos gives the number of
15878 lines to scroll by; dvpos < 0 means scroll up. */
15880 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15881 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15882 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15883 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15884 + window_internal_height (w
));
15886 #if defined (HAVE_GPM) || defined (MSDOS)
15887 x_clear_window_mouse_face (w
);
15889 /* Perform the operation on the screen. */
15892 /* Scroll last_unchanged_at_beg_row to the end of the
15893 window down dvpos lines. */
15894 set_terminal_window (f
, end
);
15896 /* On dumb terminals delete dvpos lines at the end
15897 before inserting dvpos empty lines. */
15898 if (!FRAME_SCROLL_REGION_OK (f
))
15899 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15901 /* Insert dvpos empty lines in front of
15902 last_unchanged_at_beg_row. */
15903 ins_del_lines (f
, from
, dvpos
);
15905 else if (dvpos
< 0)
15907 /* Scroll up last_unchanged_at_beg_vpos to the end of
15908 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15909 set_terminal_window (f
, end
);
15911 /* Delete dvpos lines in front of
15912 last_unchanged_at_beg_vpos. ins_del_lines will set
15913 the cursor to the given vpos and emit |dvpos| delete
15915 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15917 /* On a dumb terminal insert dvpos empty lines at the
15919 if (!FRAME_SCROLL_REGION_OK (f
))
15920 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15923 set_terminal_window (f
, 0);
15929 /* Shift reused rows of the current matrix to the right position.
15930 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15932 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15933 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15936 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15937 bottom_vpos
, dvpos
);
15938 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15941 else if (dvpos
> 0)
15943 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15944 bottom_vpos
, dvpos
);
15945 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15946 first_unchanged_at_end_vpos
+ dvpos
, 0);
15949 /* For frame-based redisplay, make sure that current frame and window
15950 matrix are in sync with respect to glyph memory. */
15951 if (!FRAME_WINDOW_P (f
))
15952 sync_frame_with_window_matrix_rows (w
);
15954 /* Adjust buffer positions in reused rows. */
15955 if (delta
|| delta_bytes
)
15956 increment_matrix_positions (current_matrix
,
15957 first_unchanged_at_end_vpos
+ dvpos
,
15958 bottom_vpos
, delta
, delta_bytes
);
15960 /* Adjust Y positions. */
15962 shift_glyph_matrix (w
, current_matrix
,
15963 first_unchanged_at_end_vpos
+ dvpos
,
15966 if (first_unchanged_at_end_row
)
15968 first_unchanged_at_end_row
+= dvpos
;
15969 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15970 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15971 first_unchanged_at_end_row
= NULL
;
15974 /* If scrolling up, there may be some lines to display at the end of
15976 last_text_row_at_end
= NULL
;
15979 /* Scrolling up can leave for example a partially visible line
15980 at the end of the window to be redisplayed. */
15981 /* Set last_row to the glyph row in the current matrix where the
15982 window end line is found. It has been moved up or down in
15983 the matrix by dvpos. */
15984 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15985 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15987 /* If last_row is the window end line, it should display text. */
15988 xassert (last_row
->displays_text_p
);
15990 /* If window end line was partially visible before, begin
15991 displaying at that line. Otherwise begin displaying with the
15992 line following it. */
15993 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15995 init_to_row_start (&it
, w
, last_row
);
15996 it
.vpos
= last_vpos
;
15997 it
.current_y
= last_row
->y
;
16001 init_to_row_end (&it
, w
, last_row
);
16002 it
.vpos
= 1 + last_vpos
;
16003 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16007 /* We may start in a continuation line. If so, we have to
16008 get the right continuation_lines_width and current_x. */
16009 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16010 it
.hpos
= it
.current_x
= 0;
16012 /* Display the rest of the lines at the window end. */
16013 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16014 while (it
.current_y
< it
.last_visible_y
16015 && !fonts_changed_p
)
16017 /* Is it always sure that the display agrees with lines in
16018 the current matrix? I don't think so, so we mark rows
16019 displayed invalid in the current matrix by setting their
16020 enabled_p flag to zero. */
16021 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16022 if (display_line (&it
))
16023 last_text_row_at_end
= it
.glyph_row
- 1;
16027 /* Update window_end_pos and window_end_vpos. */
16028 if (first_unchanged_at_end_row
16029 && !last_text_row_at_end
)
16031 /* Window end line if one of the preserved rows from the current
16032 matrix. Set row to the last row displaying text in current
16033 matrix starting at first_unchanged_at_end_row, after
16035 xassert (first_unchanged_at_end_row
->displays_text_p
);
16036 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16037 first_unchanged_at_end_row
);
16038 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16040 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16041 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16043 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16044 xassert (w
->window_end_bytepos
>= 0);
16045 IF_DEBUG (debug_method_add (w
, "A"));
16047 else if (last_text_row_at_end
)
16050 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16051 w
->window_end_bytepos
16052 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16054 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16055 xassert (w
->window_end_bytepos
>= 0);
16056 IF_DEBUG (debug_method_add (w
, "B"));
16058 else if (last_text_row
)
16060 /* We have displayed either to the end of the window or at the
16061 end of the window, i.e. the last row with text is to be found
16062 in the desired matrix. */
16064 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16065 w
->window_end_bytepos
16066 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16068 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16069 xassert (w
->window_end_bytepos
>= 0);
16071 else if (first_unchanged_at_end_row
== NULL
16072 && last_text_row
== NULL
16073 && last_text_row_at_end
== NULL
)
16075 /* Displayed to end of window, but no line containing text was
16076 displayed. Lines were deleted at the end of the window. */
16077 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16078 int vpos
= XFASTINT (w
->window_end_vpos
);
16079 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16080 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16083 row
== NULL
&& vpos
>= first_vpos
;
16084 --vpos
, --current_row
, --desired_row
)
16086 if (desired_row
->enabled_p
)
16088 if (desired_row
->displays_text_p
)
16091 else if (current_row
->displays_text_p
)
16095 xassert (row
!= NULL
);
16096 w
->window_end_vpos
= make_number (vpos
+ 1);
16097 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16098 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16099 xassert (w
->window_end_bytepos
>= 0);
16100 IF_DEBUG (debug_method_add (w
, "C"));
16105 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16106 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16108 /* Record that display has not been completed. */
16109 w
->window_end_valid
= Qnil
;
16110 w
->desired_matrix
->no_scrolling_p
= 1;
16118 /***********************************************************************
16119 More debugging support
16120 ***********************************************************************/
16124 void dump_glyph_row (struct glyph_row
*, int, int);
16125 void dump_glyph_matrix (struct glyph_matrix
*, int);
16126 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16129 /* Dump the contents of glyph matrix MATRIX on stderr.
16131 GLYPHS 0 means don't show glyph contents.
16132 GLYPHS 1 means show glyphs in short form
16133 GLYPHS > 1 means show glyphs in long form. */
16136 dump_glyph_matrix (matrix
, glyphs
)
16137 struct glyph_matrix
*matrix
;
16141 for (i
= 0; i
< matrix
->nrows
; ++i
)
16142 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16146 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16147 the glyph row and area where the glyph comes from. */
16150 dump_glyph (row
, glyph
, area
)
16151 struct glyph_row
*row
;
16152 struct glyph
*glyph
;
16155 if (glyph
->type
== CHAR_GLYPH
)
16158 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16159 glyph
- row
->glyphs
[TEXT_AREA
],
16162 (BUFFERP (glyph
->object
)
16164 : (STRINGP (glyph
->object
)
16167 glyph
->pixel_width
,
16169 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16173 glyph
->left_box_line_p
,
16174 glyph
->right_box_line_p
);
16176 else if (glyph
->type
== STRETCH_GLYPH
)
16179 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16180 glyph
- row
->glyphs
[TEXT_AREA
],
16183 (BUFFERP (glyph
->object
)
16185 : (STRINGP (glyph
->object
)
16188 glyph
->pixel_width
,
16192 glyph
->left_box_line_p
,
16193 glyph
->right_box_line_p
);
16195 else if (glyph
->type
== IMAGE_GLYPH
)
16198 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16199 glyph
- row
->glyphs
[TEXT_AREA
],
16202 (BUFFERP (glyph
->object
)
16204 : (STRINGP (glyph
->object
)
16207 glyph
->pixel_width
,
16211 glyph
->left_box_line_p
,
16212 glyph
->right_box_line_p
);
16214 else if (glyph
->type
== COMPOSITE_GLYPH
)
16217 " %5d %4c %6d %c %3d 0x%05x",
16218 glyph
- row
->glyphs
[TEXT_AREA
],
16221 (BUFFERP (glyph
->object
)
16223 : (STRINGP (glyph
->object
)
16226 glyph
->pixel_width
,
16228 if (glyph
->u
.cmp
.automatic
)
16231 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16232 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16234 glyph
->left_box_line_p
,
16235 glyph
->right_box_line_p
);
16240 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16241 GLYPHS 0 means don't show glyph contents.
16242 GLYPHS 1 means show glyphs in short form
16243 GLYPHS > 1 means show glyphs in long form. */
16246 dump_glyph_row (row
, vpos
, glyphs
)
16247 struct glyph_row
*row
;
16252 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16253 fprintf (stderr
, "======================================================================\n");
16255 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16256 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16258 MATRIX_ROW_START_CHARPOS (row
),
16259 MATRIX_ROW_END_CHARPOS (row
),
16260 row
->used
[TEXT_AREA
],
16261 row
->contains_overlapping_glyphs_p
,
16263 row
->truncated_on_left_p
,
16264 row
->truncated_on_right_p
,
16266 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16267 row
->displays_text_p
,
16270 row
->ends_in_middle_of_char_p
,
16271 row
->starts_in_middle_of_char_p
,
16277 row
->visible_height
,
16280 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16281 row
->end
.overlay_string_index
,
16282 row
->continuation_lines_width
);
16283 fprintf (stderr
, "%9d %5d\n",
16284 CHARPOS (row
->start
.string_pos
),
16285 CHARPOS (row
->end
.string_pos
));
16286 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16287 row
->end
.dpvec_index
);
16294 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16296 struct glyph
*glyph
= row
->glyphs
[area
];
16297 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16299 /* Glyph for a line end in text. */
16300 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16303 if (glyph
< glyph_end
)
16304 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16306 for (; glyph
< glyph_end
; ++glyph
)
16307 dump_glyph (row
, glyph
, area
);
16310 else if (glyphs
== 1)
16314 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16316 char *s
= (char *) alloca (row
->used
[area
] + 1);
16319 for (i
= 0; i
< row
->used
[area
]; ++i
)
16321 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16322 if (glyph
->type
== CHAR_GLYPH
16323 && glyph
->u
.ch
< 0x80
16324 && glyph
->u
.ch
>= ' ')
16325 s
[i
] = glyph
->u
.ch
;
16331 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16337 DEFUE ("dump-glyph-matrix", Fdump_glyph_matrix
,
16338 Sdump_glyph_matrix
, 0, 1, "p",
16339 doc
: /* Dump the current matrix of the selected window to stderr.
16340 Shows contents of glyph row structures. With non-nil
16341 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16342 glyphs in short form, otherwise show glyphs in long form. */)
16343 (Lisp_Object glyphs
)
16345 struct window
*w
= XWINDOW (selected_window
);
16346 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16348 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16349 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16350 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16351 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16352 fprintf (stderr
, "=============================================\n");
16353 dump_glyph_matrix (w
->current_matrix
,
16354 NILP (glyphs
) ? 0 : XINT (glyphs
));
16359 DEFUE ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16360 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16363 struct frame
*f
= XFRAME (selected_frame
);
16364 dump_glyph_matrix (f
->current_matrix
, 1);
16369 DEFUE ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16370 doc
: /* Dump glyph row ROW to stderr.
16371 GLYPH 0 means don't dump glyphs.
16372 GLYPH 1 means dump glyphs in short form.
16373 GLYPH > 1 or omitted means dump glyphs in long form. */)
16374 (Lisp_Object row
, Lisp_Object glyphs
)
16376 struct glyph_matrix
*matrix
;
16379 CHECK_NUMBER (row
);
16380 matrix
= XWINDOW (selected_window
)->current_matrix
;
16382 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16383 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16385 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16390 DEFUE ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16391 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16392 GLYPH 0 means don't dump glyphs.
16393 GLYPH 1 means dump glyphs in short form.
16394 GLYPH > 1 or omitted means dump glyphs in long form. */)
16395 (Lisp_Object row
, Lisp_Object glyphs
)
16397 struct frame
*sf
= SELECTED_FRAME ();
16398 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16401 CHECK_NUMBER (row
);
16403 if (vpos
>= 0 && vpos
< m
->nrows
)
16404 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16405 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16410 DEFUE ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16411 doc
: /* Toggle tracing of redisplay.
16412 With ARG, turn tracing on if and only if ARG is positive. */)
16416 trace_redisplay_p
= !trace_redisplay_p
;
16419 arg
= Fprefix_numeric_value (arg
);
16420 trace_redisplay_p
= XINT (arg
) > 0;
16427 DEFUE ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16428 doc
: /* Like `format', but print result to stderr.
16429 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16430 (size_t nargs
, Lisp_Object
*args
)
16432 Lisp_Object s
= Fformat (nargs
, args
);
16433 fprintf (stderr
, "%s", SDATA (s
));
16437 #endif /* GLYPH_DEBUG */
16441 /***********************************************************************
16442 Building Desired Matrix Rows
16443 ***********************************************************************/
16445 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16446 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16448 static struct glyph_row
*
16449 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16451 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16452 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16453 struct buffer
*old
= current_buffer
;
16454 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16455 int arrow_len
= SCHARS (overlay_arrow_string
);
16456 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16457 const unsigned char *p
;
16460 int n_glyphs_before
;
16462 set_buffer_temp (buffer
);
16463 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16464 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16465 SET_TEXT_POS (it
.position
, 0, 0);
16467 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16469 while (p
< arrow_end
)
16471 Lisp_Object face
, ilisp
;
16473 /* Get the next character. */
16475 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16478 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16479 if (! ASCII_CHAR_P (it
.c
))
16480 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16484 /* Get its face. */
16485 ilisp
= make_number (p
- arrow_string
);
16486 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16487 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16489 /* Compute its width, get its glyphs. */
16490 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16491 SET_TEXT_POS (it
.position
, -1, -1);
16492 PRODUCE_GLYPHS (&it
);
16494 /* If this character doesn't fit any more in the line, we have
16495 to remove some glyphs. */
16496 if (it
.current_x
> it
.last_visible_x
)
16498 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16503 set_buffer_temp (old
);
16504 return it
.glyph_row
;
16508 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16509 glyphs are only inserted for terminal frames since we can't really
16510 win with truncation glyphs when partially visible glyphs are
16511 involved. Which glyphs to insert is determined by
16512 produce_special_glyphs. */
16515 insert_left_trunc_glyphs (struct it
*it
)
16517 struct it truncate_it
;
16518 struct glyph
*from
, *end
, *to
, *toend
;
16520 xassert (!FRAME_WINDOW_P (it
->f
));
16522 /* Get the truncation glyphs. */
16524 truncate_it
.current_x
= 0;
16525 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16526 truncate_it
.glyph_row
= &scratch_glyph_row
;
16527 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16528 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16529 truncate_it
.object
= make_number (0);
16530 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16532 /* Overwrite glyphs from IT with truncation glyphs. */
16533 if (!it
->glyph_row
->reversed_p
)
16535 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16536 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16537 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16538 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16543 /* There may be padding glyphs left over. Overwrite them too. */
16544 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16546 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16552 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16556 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16557 that back to front. */
16558 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16559 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16560 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16561 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16563 while (from
>= end
&& to
>= toend
)
16565 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16568 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16569 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16570 while (from
>= end
&& to
>= toend
)
16575 /* Need to free some room before prepending additional
16577 int move_by
= from
- end
+ 1;
16578 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16579 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16581 for ( ; g
>= g0
; g
--)
16583 while (from
>= end
)
16585 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16591 /* Compute the pixel height and width of IT->glyph_row.
16593 Most of the time, ascent and height of a display line will be equal
16594 to the max_ascent and max_height values of the display iterator
16595 structure. This is not the case if
16597 1. We hit ZV without displaying anything. In this case, max_ascent
16598 and max_height will be zero.
16600 2. We have some glyphs that don't contribute to the line height.
16601 (The glyph row flag contributes_to_line_height_p is for future
16602 pixmap extensions).
16604 The first case is easily covered by using default values because in
16605 these cases, the line height does not really matter, except that it
16606 must not be zero. */
16609 compute_line_metrics (struct it
*it
)
16611 struct glyph_row
*row
= it
->glyph_row
;
16613 if (FRAME_WINDOW_P (it
->f
))
16615 int i
, min_y
, max_y
;
16617 /* The line may consist of one space only, that was added to
16618 place the cursor on it. If so, the row's height hasn't been
16620 if (row
->height
== 0)
16622 if (it
->max_ascent
+ it
->max_descent
== 0)
16623 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16624 row
->ascent
= it
->max_ascent
;
16625 row
->height
= it
->max_ascent
+ it
->max_descent
;
16626 row
->phys_ascent
= it
->max_phys_ascent
;
16627 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16628 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16631 /* Compute the width of this line. */
16632 row
->pixel_width
= row
->x
;
16633 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16634 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16636 xassert (row
->pixel_width
>= 0);
16637 xassert (row
->ascent
>= 0 && row
->height
> 0);
16639 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16640 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16642 /* If first line's physical ascent is larger than its logical
16643 ascent, use the physical ascent, and make the row taller.
16644 This makes accented characters fully visible. */
16645 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16646 && row
->phys_ascent
> row
->ascent
)
16648 row
->height
+= row
->phys_ascent
- row
->ascent
;
16649 row
->ascent
= row
->phys_ascent
;
16652 /* Compute how much of the line is visible. */
16653 row
->visible_height
= row
->height
;
16655 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16656 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16658 if (row
->y
< min_y
)
16659 row
->visible_height
-= min_y
- row
->y
;
16660 if (row
->y
+ row
->height
> max_y
)
16661 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16665 row
->pixel_width
= row
->used
[TEXT_AREA
];
16666 if (row
->continued_p
)
16667 row
->pixel_width
-= it
->continuation_pixel_width
;
16668 else if (row
->truncated_on_right_p
)
16669 row
->pixel_width
-= it
->truncation_pixel_width
;
16670 row
->ascent
= row
->phys_ascent
= 0;
16671 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16672 row
->extra_line_spacing
= 0;
16675 /* Compute a hash code for this row. */
16679 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16680 for (i
= 0; i
< row
->used
[area
]; ++i
)
16681 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16682 + row
->glyphs
[area
][i
].u
.val
16683 + row
->glyphs
[area
][i
].face_id
16684 + row
->glyphs
[area
][i
].padding_p
16685 + (row
->glyphs
[area
][i
].type
<< 2));
16688 it
->max_ascent
= it
->max_descent
= 0;
16689 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16693 /* Append one space to the glyph row of iterator IT if doing a
16694 window-based redisplay. The space has the same face as
16695 IT->face_id. Value is non-zero if a space was added.
16697 This function is called to make sure that there is always one glyph
16698 at the end of a glyph row that the cursor can be set on under
16699 window-systems. (If there weren't such a glyph we would not know
16700 how wide and tall a box cursor should be displayed).
16702 At the same time this space let's a nicely handle clearing to the
16703 end of the line if the row ends in italic text. */
16706 append_space_for_newline (struct it
*it
, int default_face_p
)
16708 if (FRAME_WINDOW_P (it
->f
))
16710 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16712 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16713 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16715 /* Save some values that must not be changed.
16716 Must save IT->c and IT->len because otherwise
16717 ITERATOR_AT_END_P wouldn't work anymore after
16718 append_space_for_newline has been called. */
16719 enum display_element_type saved_what
= it
->what
;
16720 int saved_c
= it
->c
, saved_len
= it
->len
;
16721 int saved_char_to_display
= it
->char_to_display
;
16722 int saved_x
= it
->current_x
;
16723 int saved_face_id
= it
->face_id
;
16724 struct text_pos saved_pos
;
16725 Lisp_Object saved_object
;
16728 saved_object
= it
->object
;
16729 saved_pos
= it
->position
;
16731 it
->what
= IT_CHARACTER
;
16732 memset (&it
->position
, 0, sizeof it
->position
);
16733 it
->object
= make_number (0);
16734 it
->c
= it
->char_to_display
= ' ';
16737 if (default_face_p
)
16738 it
->face_id
= DEFAULT_FACE_ID
;
16739 else if (it
->face_before_selective_p
)
16740 it
->face_id
= it
->saved_face_id
;
16741 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16742 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16744 PRODUCE_GLYPHS (it
);
16746 it
->override_ascent
= -1;
16747 it
->constrain_row_ascent_descent_p
= 0;
16748 it
->current_x
= saved_x
;
16749 it
->object
= saved_object
;
16750 it
->position
= saved_pos
;
16751 it
->what
= saved_what
;
16752 it
->face_id
= saved_face_id
;
16753 it
->len
= saved_len
;
16755 it
->char_to_display
= saved_char_to_display
;
16764 /* Extend the face of the last glyph in the text area of IT->glyph_row
16765 to the end of the display line. Called from display_line. If the
16766 glyph row is empty, add a space glyph to it so that we know the
16767 face to draw. Set the glyph row flag fill_line_p. If the glyph
16768 row is R2L, prepend a stretch glyph to cover the empty space to the
16769 left of the leftmost glyph. */
16772 extend_face_to_end_of_line (struct it
*it
)
16775 struct frame
*f
= it
->f
;
16777 /* If line is already filled, do nothing. Non window-system frames
16778 get a grace of one more ``pixel'' because their characters are
16779 1-``pixel'' wide, so they hit the equality too early. This grace
16780 is needed only for R2L rows that are not continued, to produce
16781 one extra blank where we could display the cursor. */
16782 if (it
->current_x
>= it
->last_visible_x
16783 + (!FRAME_WINDOW_P (f
)
16784 && it
->glyph_row
->reversed_p
16785 && !it
->glyph_row
->continued_p
))
16788 /* Face extension extends the background and box of IT->face_id
16789 to the end of the line. If the background equals the background
16790 of the frame, we don't have to do anything. */
16791 if (it
->face_before_selective_p
)
16792 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16794 face
= FACE_FROM_ID (f
, it
->face_id
);
16796 if (FRAME_WINDOW_P (f
)
16797 && it
->glyph_row
->displays_text_p
16798 && face
->box
== FACE_NO_BOX
16799 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16801 && !it
->glyph_row
->reversed_p
)
16804 /* Set the glyph row flag indicating that the face of the last glyph
16805 in the text area has to be drawn to the end of the text area. */
16806 it
->glyph_row
->fill_line_p
= 1;
16808 /* If current character of IT is not ASCII, make sure we have the
16809 ASCII face. This will be automatically undone the next time
16810 get_next_display_element returns a multibyte character. Note
16811 that the character will always be single byte in unibyte
16813 if (!ASCII_CHAR_P (it
->c
))
16815 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16818 if (FRAME_WINDOW_P (f
))
16820 /* If the row is empty, add a space with the current face of IT,
16821 so that we know which face to draw. */
16822 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16824 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16825 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16826 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16828 #ifdef HAVE_WINDOW_SYSTEM
16829 if (it
->glyph_row
->reversed_p
)
16831 /* Prepend a stretch glyph to the row, such that the
16832 rightmost glyph will be drawn flushed all the way to the
16833 right margin of the window. The stretch glyph that will
16834 occupy the empty space, if any, to the left of the
16836 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16837 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16838 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16840 int row_width
, stretch_ascent
, stretch_width
;
16841 struct text_pos saved_pos
;
16842 int saved_face_id
, saved_avoid_cursor
;
16844 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16845 row_width
+= g
->pixel_width
;
16846 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16847 if (stretch_width
> 0)
16850 (((it
->ascent
+ it
->descent
)
16851 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16852 saved_pos
= it
->position
;
16853 memset (&it
->position
, 0, sizeof it
->position
);
16854 saved_avoid_cursor
= it
->avoid_cursor_p
;
16855 it
->avoid_cursor_p
= 1;
16856 saved_face_id
= it
->face_id
;
16857 /* The last row's stretch glyph should get the default
16858 face, to avoid painting the rest of the window with
16859 the region face, if the region ends at ZV. */
16860 if (it
->glyph_row
->ends_at_zv_p
)
16861 it
->face_id
= DEFAULT_FACE_ID
;
16863 it
->face_id
= face
->id
;
16864 append_stretch_glyph (it
, make_number (0), stretch_width
,
16865 it
->ascent
+ it
->descent
, stretch_ascent
);
16866 it
->position
= saved_pos
;
16867 it
->avoid_cursor_p
= saved_avoid_cursor
;
16868 it
->face_id
= saved_face_id
;
16871 #endif /* HAVE_WINDOW_SYSTEM */
16875 /* Save some values that must not be changed. */
16876 int saved_x
= it
->current_x
;
16877 struct text_pos saved_pos
;
16878 Lisp_Object saved_object
;
16879 enum display_element_type saved_what
= it
->what
;
16880 int saved_face_id
= it
->face_id
;
16882 saved_object
= it
->object
;
16883 saved_pos
= it
->position
;
16885 it
->what
= IT_CHARACTER
;
16886 memset (&it
->position
, 0, sizeof it
->position
);
16887 it
->object
= make_number (0);
16888 it
->c
= it
->char_to_display
= ' ';
16890 /* The last row's blank glyphs should get the default face, to
16891 avoid painting the rest of the window with the region face,
16892 if the region ends at ZV. */
16893 if (it
->glyph_row
->ends_at_zv_p
)
16894 it
->face_id
= DEFAULT_FACE_ID
;
16896 it
->face_id
= face
->id
;
16898 PRODUCE_GLYPHS (it
);
16900 while (it
->current_x
<= it
->last_visible_x
)
16901 PRODUCE_GLYPHS (it
);
16903 /* Don't count these blanks really. It would let us insert a left
16904 truncation glyph below and make us set the cursor on them, maybe. */
16905 it
->current_x
= saved_x
;
16906 it
->object
= saved_object
;
16907 it
->position
= saved_pos
;
16908 it
->what
= saved_what
;
16909 it
->face_id
= saved_face_id
;
16914 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16915 trailing whitespace. */
16918 trailing_whitespace_p (EMACS_INT charpos
)
16920 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16923 while (bytepos
< ZV_BYTE
16924 && (c
= FETCH_CHAR (bytepos
),
16925 c
== ' ' || c
== '\t'))
16928 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16930 if (bytepos
!= PT_BYTE
)
16937 /* Highlight trailing whitespace, if any, in ROW. */
16940 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16942 int used
= row
->used
[TEXT_AREA
];
16946 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16947 struct glyph
*glyph
= start
+ used
- 1;
16949 if (row
->reversed_p
)
16951 /* Right-to-left rows need to be processed in the opposite
16952 direction, so swap the edge pointers. */
16954 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16957 /* Skip over glyphs inserted to display the cursor at the
16958 end of a line, for extending the face of the last glyph
16959 to the end of the line on terminals, and for truncation
16960 and continuation glyphs. */
16961 if (!row
->reversed_p
)
16963 while (glyph
>= start
16964 && glyph
->type
== CHAR_GLYPH
16965 && INTEGERP (glyph
->object
))
16970 while (glyph
<= start
16971 && glyph
->type
== CHAR_GLYPH
16972 && INTEGERP (glyph
->object
))
16976 /* If last glyph is a space or stretch, and it's trailing
16977 whitespace, set the face of all trailing whitespace glyphs in
16978 IT->glyph_row to `trailing-whitespace'. */
16979 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16980 && BUFFERP (glyph
->object
)
16981 && (glyph
->type
== STRETCH_GLYPH
16982 || (glyph
->type
== CHAR_GLYPH
16983 && glyph
->u
.ch
== ' '))
16984 && trailing_whitespace_p (glyph
->charpos
))
16986 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16990 if (!row
->reversed_p
)
16992 while (glyph
>= start
16993 && BUFFERP (glyph
->object
)
16994 && (glyph
->type
== STRETCH_GLYPH
16995 || (glyph
->type
== CHAR_GLYPH
16996 && glyph
->u
.ch
== ' ')))
16997 (glyph
--)->face_id
= face_id
;
17001 while (glyph
<= start
17002 && BUFFERP (glyph
->object
)
17003 && (glyph
->type
== STRETCH_GLYPH
17004 || (glyph
->type
== CHAR_GLYPH
17005 && glyph
->u
.ch
== ' ')))
17006 (glyph
++)->face_id
= face_id
;
17013 /* Value is non-zero if glyph row ROW should be
17014 used to hold the cursor. */
17017 cursor_row_p (struct glyph_row
*row
)
17021 if (PT
== CHARPOS (row
->end
.pos
))
17023 /* Suppose the row ends on a string.
17024 Unless the row is continued, that means it ends on a newline
17025 in the string. If it's anything other than a display string
17026 (e.g. a before-string from an overlay), we don't want the
17027 cursor there. (This heuristic seems to give the optimal
17028 behavior for the various types of multi-line strings.) */
17029 if (CHARPOS (row
->end
.string_pos
) >= 0)
17031 if (row
->continued_p
)
17035 /* Check for `display' property. */
17036 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17037 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17038 struct glyph
*glyph
;
17041 for (glyph
= end
; glyph
>= beg
; --glyph
)
17042 if (STRINGP (glyph
->object
))
17045 = Fget_char_property (make_number (PT
),
17049 && display_prop_string_p (prop
, glyph
->object
));
17054 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17056 /* If the row ends in middle of a real character,
17057 and the line is continued, we want the cursor here.
17058 That's because CHARPOS (ROW->end.pos) would equal
17059 PT if PT is before the character. */
17060 if (!row
->ends_in_ellipsis_p
)
17061 result
= row
->continued_p
;
17063 /* If the row ends in an ellipsis, then
17064 CHARPOS (ROW->end.pos) will equal point after the
17065 invisible text. We want that position to be displayed
17066 after the ellipsis. */
17069 /* If the row ends at ZV, display the cursor at the end of that
17070 row instead of at the start of the row below. */
17071 else if (row
->ends_at_zv_p
)
17082 /* Push the display property PROP so that it will be rendered at the
17083 current position in IT. Return 1 if PROP was successfully pushed,
17087 push_display_prop (struct it
*it
, Lisp_Object prop
)
17091 if (STRINGP (prop
))
17093 if (SCHARS (prop
) == 0)
17100 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17101 it
->current
.overlay_string_index
= -1;
17102 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17103 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17104 it
->method
= GET_FROM_STRING
;
17105 it
->stop_charpos
= 0;
17107 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17109 it
->method
= GET_FROM_STRETCH
;
17112 #ifdef HAVE_WINDOW_SYSTEM
17113 else if (IMAGEP (prop
))
17115 it
->what
= IT_IMAGE
;
17116 it
->image_id
= lookup_image (it
->f
, prop
);
17117 it
->method
= GET_FROM_IMAGE
;
17119 #endif /* HAVE_WINDOW_SYSTEM */
17122 pop_it (it
); /* bogus display property, give up */
17129 /* Return the character-property PROP at the current position in IT. */
17132 get_it_property (struct it
*it
, Lisp_Object prop
)
17134 Lisp_Object position
;
17136 if (STRINGP (it
->object
))
17137 position
= make_number (IT_STRING_CHARPOS (*it
));
17138 else if (BUFFERP (it
->object
))
17139 position
= make_number (IT_CHARPOS (*it
));
17143 return Fget_char_property (position
, prop
, it
->object
);
17146 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17149 handle_line_prefix (struct it
*it
)
17151 Lisp_Object prefix
;
17152 if (it
->continuation_lines_width
> 0)
17154 prefix
= get_it_property (it
, Qwrap_prefix
);
17156 prefix
= Vwrap_prefix
;
17160 prefix
= get_it_property (it
, Qline_prefix
);
17162 prefix
= Vline_prefix
;
17164 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17166 /* If the prefix is wider than the window, and we try to wrap
17167 it, it would acquire its own wrap prefix, and so on till the
17168 iterator stack overflows. So, don't wrap the prefix. */
17169 it
->line_wrap
= TRUNCATE
;
17170 it
->avoid_cursor_p
= 1;
17176 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17177 only for R2L lines from display_line, when it decides that too many
17178 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17181 unproduce_glyphs (struct it
*it
, int n
)
17183 struct glyph
*glyph
, *end
;
17185 xassert (it
->glyph_row
);
17186 xassert (it
->glyph_row
->reversed_p
);
17187 xassert (it
->area
== TEXT_AREA
);
17188 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17190 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17191 n
= it
->glyph_row
->used
[TEXT_AREA
];
17192 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17193 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17194 for ( ; glyph
< end
; glyph
++)
17195 glyph
[-n
] = *glyph
;
17198 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17199 and ROW->maxpos. */
17201 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17202 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17203 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17205 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17206 lines' rows is implemented for bidi-reordered rows. */
17208 /* ROW->minpos is the value of min_pos, the minimal buffer position
17211 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17213 /* We didn't find _any_ valid buffer positions in any of the
17214 glyphs, so we must trust the iterator's computed positions. */
17215 row
->minpos
= row
->start
.pos
;
17218 max_pos
= CHARPOS (it
->current
.pos
);
17219 max_bpos
= BYTEPOS (it
->current
.pos
);
17222 /* Here are the various use-cases for ending the row, and the
17223 corresponding values for ROW->maxpos:
17225 Line ends in a newline from buffer eol_pos + 1
17226 Line is continued from buffer max_pos + 1
17227 Line is truncated on right it->current.pos
17228 Line ends in a newline from string max_pos
17229 Line is continued from string max_pos
17230 Line is continued from display vector max_pos
17231 Line is entirely from a string min_pos == max_pos
17232 Line is entirely from a display vector min_pos == max_pos
17233 Line that ends at ZV ZV
17235 If you discover other use-cases, please add them here as
17237 if (row
->ends_at_zv_p
)
17238 row
->maxpos
= it
->current
.pos
;
17239 else if (row
->used
[TEXT_AREA
])
17241 if (row
->ends_in_newline_from_string_p
)
17242 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17243 else if (CHARPOS (it
->eol_pos
) > 0)
17244 SET_TEXT_POS (row
->maxpos
,
17245 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17246 else if (row
->continued_p
)
17248 /* If max_pos is different from IT's current position, it
17249 means IT->method does not belong to the display element
17250 at max_pos. However, it also means that the display
17251 element at max_pos was displayed in its entirety on this
17252 line, which is equivalent to saying that the next line
17253 starts at the next buffer position. */
17254 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17255 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17258 INC_BOTH (max_pos
, max_bpos
);
17259 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17262 else if (row
->truncated_on_right_p
)
17263 /* display_line already called reseat_at_next_visible_line_start,
17264 which puts the iterator at the beginning of the next line, in
17265 the logical order. */
17266 row
->maxpos
= it
->current
.pos
;
17267 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17268 /* A line that is entirely from a string/image/stretch... */
17269 row
->maxpos
= row
->minpos
;
17274 row
->maxpos
= it
->current
.pos
;
17277 /* Construct the glyph row IT->glyph_row in the desired matrix of
17278 IT->w from text at the current position of IT. See dispextern.h
17279 for an overview of struct it. Value is non-zero if
17280 IT->glyph_row displays text, as opposed to a line displaying ZV
17284 display_line (struct it
*it
)
17286 struct glyph_row
*row
= it
->glyph_row
;
17287 Lisp_Object overlay_arrow_string
;
17289 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17290 int wrap_row_used
= -1;
17291 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17292 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17293 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17294 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17295 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17297 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17298 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17300 /* We always start displaying at hpos zero even if hscrolled. */
17301 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17303 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17304 >= it
->w
->desired_matrix
->nrows
)
17306 it
->w
->nrows_scale_factor
++;
17307 fonts_changed_p
= 1;
17311 /* Is IT->w showing the region? */
17312 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17314 /* Clear the result glyph row and enable it. */
17315 prepare_desired_row (row
);
17317 row
->y
= it
->current_y
;
17318 row
->start
= it
->start
;
17319 row
->continuation_lines_width
= it
->continuation_lines_width
;
17320 row
->displays_text_p
= 1;
17321 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17322 it
->starts_in_middle_of_char_p
= 0;
17324 /* Arrange the overlays nicely for our purposes. Usually, we call
17325 display_line on only one line at a time, in which case this
17326 can't really hurt too much, or we call it on lines which appear
17327 one after another in the buffer, in which case all calls to
17328 recenter_overlay_lists but the first will be pretty cheap. */
17329 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17331 /* Move over display elements that are not visible because we are
17332 hscrolled. This may stop at an x-position < IT->first_visible_x
17333 if the first glyph is partially visible or if we hit a line end. */
17334 if (it
->current_x
< it
->first_visible_x
)
17336 this_line_min_pos
= row
->start
.pos
;
17337 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17338 MOVE_TO_POS
| MOVE_TO_X
);
17339 /* Record the smallest positions seen while we moved over
17340 display elements that are not visible. This is needed by
17341 redisplay_internal for optimizing the case where the cursor
17342 stays inside the same line. The rest of this function only
17343 considers positions that are actually displayed, so
17344 RECORD_MAX_MIN_POS will not otherwise record positions that
17345 are hscrolled to the left of the left edge of the window. */
17346 min_pos
= CHARPOS (this_line_min_pos
);
17347 min_bpos
= BYTEPOS (this_line_min_pos
);
17351 /* We only do this when not calling `move_it_in_display_line_to'
17352 above, because move_it_in_display_line_to calls
17353 handle_line_prefix itself. */
17354 handle_line_prefix (it
);
17357 /* Get the initial row height. This is either the height of the
17358 text hscrolled, if there is any, or zero. */
17359 row
->ascent
= it
->max_ascent
;
17360 row
->height
= it
->max_ascent
+ it
->max_descent
;
17361 row
->phys_ascent
= it
->max_phys_ascent
;
17362 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17363 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17365 /* Utility macro to record max and min buffer positions seen until now. */
17366 #define RECORD_MAX_MIN_POS(IT) \
17369 if (IT_CHARPOS (*(IT)) < min_pos) \
17371 min_pos = IT_CHARPOS (*(IT)); \
17372 min_bpos = IT_BYTEPOS (*(IT)); \
17374 if (IT_CHARPOS (*(IT)) > max_pos) \
17376 max_pos = IT_CHARPOS (*(IT)); \
17377 max_bpos = IT_BYTEPOS (*(IT)); \
17382 /* Loop generating characters. The loop is left with IT on the next
17383 character to display. */
17386 int n_glyphs_before
, hpos_before
, x_before
;
17388 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17390 /* Retrieve the next thing to display. Value is zero if end of
17392 if (!get_next_display_element (it
))
17394 /* Maybe add a space at the end of this line that is used to
17395 display the cursor there under X. Set the charpos of the
17396 first glyph of blank lines not corresponding to any text
17398 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17399 row
->exact_window_width_line_p
= 1;
17400 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17401 || row
->used
[TEXT_AREA
] == 0)
17403 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17404 row
->displays_text_p
= 0;
17406 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17407 && (!MINI_WINDOW_P (it
->w
)
17408 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17409 row
->indicate_empty_line_p
= 1;
17412 it
->continuation_lines_width
= 0;
17413 row
->ends_at_zv_p
= 1;
17414 /* A row that displays right-to-left text must always have
17415 its last face extended all the way to the end of line,
17416 even if this row ends in ZV, because we still write to
17417 the screen left to right. */
17418 if (row
->reversed_p
)
17419 extend_face_to_end_of_line (it
);
17423 /* Now, get the metrics of what we want to display. This also
17424 generates glyphs in `row' (which is IT->glyph_row). */
17425 n_glyphs_before
= row
->used
[TEXT_AREA
];
17428 /* Remember the line height so far in case the next element doesn't
17429 fit on the line. */
17430 if (it
->line_wrap
!= TRUNCATE
)
17432 ascent
= it
->max_ascent
;
17433 descent
= it
->max_descent
;
17434 phys_ascent
= it
->max_phys_ascent
;
17435 phys_descent
= it
->max_phys_descent
;
17437 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17439 if (IT_DISPLAYING_WHITESPACE (it
))
17445 wrap_row_used
= row
->used
[TEXT_AREA
];
17446 wrap_row_ascent
= row
->ascent
;
17447 wrap_row_height
= row
->height
;
17448 wrap_row_phys_ascent
= row
->phys_ascent
;
17449 wrap_row_phys_height
= row
->phys_height
;
17450 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17451 wrap_row_min_pos
= min_pos
;
17452 wrap_row_min_bpos
= min_bpos
;
17453 wrap_row_max_pos
= max_pos
;
17454 wrap_row_max_bpos
= max_bpos
;
17460 PRODUCE_GLYPHS (it
);
17462 /* If this display element was in marginal areas, continue with
17464 if (it
->area
!= TEXT_AREA
)
17466 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17467 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17468 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17469 row
->phys_height
= max (row
->phys_height
,
17470 it
->max_phys_ascent
+ it
->max_phys_descent
);
17471 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17472 it
->max_extra_line_spacing
);
17473 set_iterator_to_next (it
, 1);
17477 /* Does the display element fit on the line? If we truncate
17478 lines, we should draw past the right edge of the window. If
17479 we don't truncate, we want to stop so that we can display the
17480 continuation glyph before the right margin. If lines are
17481 continued, there are two possible strategies for characters
17482 resulting in more than 1 glyph (e.g. tabs): Display as many
17483 glyphs as possible in this line and leave the rest for the
17484 continuation line, or display the whole element in the next
17485 line. Original redisplay did the former, so we do it also. */
17486 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17487 hpos_before
= it
->hpos
;
17490 if (/* Not a newline. */
17492 /* Glyphs produced fit entirely in the line. */
17493 && it
->current_x
< it
->last_visible_x
)
17495 it
->hpos
+= nglyphs
;
17496 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17497 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17498 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17499 row
->phys_height
= max (row
->phys_height
,
17500 it
->max_phys_ascent
+ it
->max_phys_descent
);
17501 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17502 it
->max_extra_line_spacing
);
17503 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17504 row
->x
= x
- it
->first_visible_x
;
17505 /* Record the maximum and minimum buffer positions seen so
17506 far in glyphs that will be displayed by this row. */
17508 RECORD_MAX_MIN_POS (it
);
17513 struct glyph
*glyph
;
17515 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17517 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17518 new_x
= x
+ glyph
->pixel_width
;
17520 if (/* Lines are continued. */
17521 it
->line_wrap
!= TRUNCATE
17522 && (/* Glyph doesn't fit on the line. */
17523 new_x
> it
->last_visible_x
17524 /* Or it fits exactly on a window system frame. */
17525 || (new_x
== it
->last_visible_x
17526 && FRAME_WINDOW_P (it
->f
))))
17528 /* End of a continued line. */
17531 || (new_x
== it
->last_visible_x
17532 && FRAME_WINDOW_P (it
->f
)))
17534 /* Current glyph is the only one on the line or
17535 fits exactly on the line. We must continue
17536 the line because we can't draw the cursor
17537 after the glyph. */
17538 row
->continued_p
= 1;
17539 it
->current_x
= new_x
;
17540 it
->continuation_lines_width
+= new_x
;
17542 /* Record the maximum and minimum buffer
17543 positions seen so far in glyphs that will be
17544 displayed by this row. */
17546 RECORD_MAX_MIN_POS (it
);
17547 if (i
== nglyphs
- 1)
17549 /* If line-wrap is on, check if a previous
17550 wrap point was found. */
17551 if (wrap_row_used
> 0
17552 /* Even if there is a previous wrap
17553 point, continue the line here as
17554 usual, if (i) the previous character
17555 was a space or tab AND (ii) the
17556 current character is not. */
17558 || IT_DISPLAYING_WHITESPACE (it
)))
17561 set_iterator_to_next (it
, 1);
17562 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17564 if (!get_next_display_element (it
))
17566 row
->exact_window_width_line_p
= 1;
17567 it
->continuation_lines_width
= 0;
17568 row
->continued_p
= 0;
17569 row
->ends_at_zv_p
= 1;
17571 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17573 row
->continued_p
= 0;
17574 row
->exact_window_width_line_p
= 1;
17579 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17580 && !FRAME_WINDOW_P (it
->f
))
17582 /* A padding glyph that doesn't fit on this line.
17583 This means the whole character doesn't fit
17585 if (row
->reversed_p
)
17586 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17587 - n_glyphs_before
);
17588 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17590 /* Fill the rest of the row with continuation
17591 glyphs like in 20.x. */
17592 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17593 < row
->glyphs
[1 + TEXT_AREA
])
17594 produce_special_glyphs (it
, IT_CONTINUATION
);
17596 row
->continued_p
= 1;
17597 it
->current_x
= x_before
;
17598 it
->continuation_lines_width
+= x_before
;
17600 /* Restore the height to what it was before the
17601 element not fitting on the line. */
17602 it
->max_ascent
= ascent
;
17603 it
->max_descent
= descent
;
17604 it
->max_phys_ascent
= phys_ascent
;
17605 it
->max_phys_descent
= phys_descent
;
17607 else if (wrap_row_used
> 0)
17610 if (row
->reversed_p
)
17611 unproduce_glyphs (it
,
17612 row
->used
[TEXT_AREA
] - wrap_row_used
);
17614 it
->continuation_lines_width
+= wrap_x
;
17615 row
->used
[TEXT_AREA
] = wrap_row_used
;
17616 row
->ascent
= wrap_row_ascent
;
17617 row
->height
= wrap_row_height
;
17618 row
->phys_ascent
= wrap_row_phys_ascent
;
17619 row
->phys_height
= wrap_row_phys_height
;
17620 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17621 min_pos
= wrap_row_min_pos
;
17622 min_bpos
= wrap_row_min_bpos
;
17623 max_pos
= wrap_row_max_pos
;
17624 max_bpos
= wrap_row_max_bpos
;
17625 row
->continued_p
= 1;
17626 row
->ends_at_zv_p
= 0;
17627 row
->exact_window_width_line_p
= 0;
17628 it
->continuation_lines_width
+= x
;
17630 /* Make sure that a non-default face is extended
17631 up to the right margin of the window. */
17632 extend_face_to_end_of_line (it
);
17634 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17636 /* A TAB that extends past the right edge of the
17637 window. This produces a single glyph on
17638 window system frames. We leave the glyph in
17639 this row and let it fill the row, but don't
17640 consume the TAB. */
17641 it
->continuation_lines_width
+= it
->last_visible_x
;
17642 row
->ends_in_middle_of_char_p
= 1;
17643 row
->continued_p
= 1;
17644 glyph
->pixel_width
= it
->last_visible_x
- x
;
17645 it
->starts_in_middle_of_char_p
= 1;
17649 /* Something other than a TAB that draws past
17650 the right edge of the window. Restore
17651 positions to values before the element. */
17652 if (row
->reversed_p
)
17653 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17654 - (n_glyphs_before
+ i
));
17655 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17657 /* Display continuation glyphs. */
17658 if (!FRAME_WINDOW_P (it
->f
))
17659 produce_special_glyphs (it
, IT_CONTINUATION
);
17660 row
->continued_p
= 1;
17662 it
->current_x
= x_before
;
17663 it
->continuation_lines_width
+= x
;
17664 extend_face_to_end_of_line (it
);
17666 if (nglyphs
> 1 && i
> 0)
17668 row
->ends_in_middle_of_char_p
= 1;
17669 it
->starts_in_middle_of_char_p
= 1;
17672 /* Restore the height to what it was before the
17673 element not fitting on the line. */
17674 it
->max_ascent
= ascent
;
17675 it
->max_descent
= descent
;
17676 it
->max_phys_ascent
= phys_ascent
;
17677 it
->max_phys_descent
= phys_descent
;
17682 else if (new_x
> it
->first_visible_x
)
17684 /* Increment number of glyphs actually displayed. */
17687 /* Record the maximum and minimum buffer positions
17688 seen so far in glyphs that will be displayed by
17691 RECORD_MAX_MIN_POS (it
);
17693 if (x
< it
->first_visible_x
)
17694 /* Glyph is partially visible, i.e. row starts at
17695 negative X position. */
17696 row
->x
= x
- it
->first_visible_x
;
17700 /* Glyph is completely off the left margin of the
17701 window. This should not happen because of the
17702 move_it_in_display_line at the start of this
17703 function, unless the text display area of the
17704 window is empty. */
17705 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17709 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17710 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17711 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17712 row
->phys_height
= max (row
->phys_height
,
17713 it
->max_phys_ascent
+ it
->max_phys_descent
);
17714 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17715 it
->max_extra_line_spacing
);
17717 /* End of this display line if row is continued. */
17718 if (row
->continued_p
|| row
->ends_at_zv_p
)
17723 /* Is this a line end? If yes, we're also done, after making
17724 sure that a non-default face is extended up to the right
17725 margin of the window. */
17726 if (ITERATOR_AT_END_OF_LINE_P (it
))
17728 int used_before
= row
->used
[TEXT_AREA
];
17730 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17732 /* Add a space at the end of the line that is used to
17733 display the cursor there. */
17734 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17735 append_space_for_newline (it
, 0);
17737 /* Extend the face to the end of the line. */
17738 extend_face_to_end_of_line (it
);
17740 /* Make sure we have the position. */
17741 if (used_before
== 0)
17742 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17744 /* Record the position of the newline, for use in
17746 it
->eol_pos
= it
->current
.pos
;
17748 /* Consume the line end. This skips over invisible lines. */
17749 set_iterator_to_next (it
, 1);
17750 it
->continuation_lines_width
= 0;
17754 /* Proceed with next display element. Note that this skips
17755 over lines invisible because of selective display. */
17756 set_iterator_to_next (it
, 1);
17758 /* If we truncate lines, we are done when the last displayed
17759 glyphs reach past the right margin of the window. */
17760 if (it
->line_wrap
== TRUNCATE
17761 && (FRAME_WINDOW_P (it
->f
)
17762 ? (it
->current_x
>= it
->last_visible_x
)
17763 : (it
->current_x
> it
->last_visible_x
)))
17765 /* Maybe add truncation glyphs. */
17766 if (!FRAME_WINDOW_P (it
->f
))
17770 if (!row
->reversed_p
)
17772 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17773 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17778 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17779 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17781 /* Remove any padding glyphs at the front of ROW, to
17782 make room for the truncation glyphs we will be
17783 adding below. The loop below always inserts at
17784 least one truncation glyph, so also remove the
17785 last glyph added to ROW. */
17786 unproduce_glyphs (it
, i
+ 1);
17787 /* Adjust i for the loop below. */
17788 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17791 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17793 row
->used
[TEXT_AREA
] = i
;
17794 produce_special_glyphs (it
, IT_TRUNCATION
);
17797 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17799 /* Don't truncate if we can overflow newline into fringe. */
17800 if (!get_next_display_element (it
))
17802 it
->continuation_lines_width
= 0;
17803 row
->ends_at_zv_p
= 1;
17804 row
->exact_window_width_line_p
= 1;
17807 if (ITERATOR_AT_END_OF_LINE_P (it
))
17809 row
->exact_window_width_line_p
= 1;
17810 goto at_end_of_line
;
17814 row
->truncated_on_right_p
= 1;
17815 it
->continuation_lines_width
= 0;
17816 reseat_at_next_visible_line_start (it
, 0);
17817 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17818 it
->hpos
= hpos_before
;
17819 it
->current_x
= x_before
;
17824 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17825 at the left window margin. */
17826 if (it
->first_visible_x
17827 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17829 if (!FRAME_WINDOW_P (it
->f
))
17830 insert_left_trunc_glyphs (it
);
17831 row
->truncated_on_left_p
= 1;
17834 /* Remember the position at which this line ends.
17836 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17837 cannot be before the call to find_row_edges below, since that is
17838 where these positions are determined. */
17839 row
->end
= it
->current
;
17842 row
->minpos
= row
->start
.pos
;
17843 row
->maxpos
= row
->end
.pos
;
17847 /* ROW->minpos and ROW->maxpos must be the smallest and
17848 `1 + the largest' buffer positions in ROW. But if ROW was
17849 bidi-reordered, these two positions can be anywhere in the
17850 row, so we must determine them now. */
17851 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17854 /* If the start of this line is the overlay arrow-position, then
17855 mark this glyph row as the one containing the overlay arrow.
17856 This is clearly a mess with variable size fonts. It would be
17857 better to let it be displayed like cursors under X. */
17858 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17859 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17860 !NILP (overlay_arrow_string
)))
17862 /* Overlay arrow in window redisplay is a fringe bitmap. */
17863 if (STRINGP (overlay_arrow_string
))
17865 struct glyph_row
*arrow_row
17866 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17867 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17868 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17869 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17870 struct glyph
*p2
, *end
;
17872 /* Copy the arrow glyphs. */
17873 while (glyph
< arrow_end
)
17876 /* Throw away padding glyphs. */
17878 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17879 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17885 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17890 xassert (INTEGERP (overlay_arrow_string
));
17891 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17893 overlay_arrow_seen
= 1;
17896 /* Compute pixel dimensions of this line. */
17897 compute_line_metrics (it
);
17899 /* Record whether this row ends inside an ellipsis. */
17900 row
->ends_in_ellipsis_p
17901 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17902 && it
->ellipsis_p
);
17904 /* Save fringe bitmaps in this row. */
17905 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17906 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17907 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17908 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17910 it
->left_user_fringe_bitmap
= 0;
17911 it
->left_user_fringe_face_id
= 0;
17912 it
->right_user_fringe_bitmap
= 0;
17913 it
->right_user_fringe_face_id
= 0;
17915 /* Maybe set the cursor. */
17916 cvpos
= it
->w
->cursor
.vpos
;
17918 /* In bidi-reordered rows, keep checking for proper cursor
17919 position even if one has been found already, because buffer
17920 positions in such rows change non-linearly with ROW->VPOS,
17921 when a line is continued. One exception: when we are at ZV,
17922 display cursor on the first suitable glyph row, since all
17923 the empty rows after that also have their position set to ZV. */
17924 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17925 lines' rows is implemented for bidi-reordered rows. */
17927 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17928 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17929 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17930 && cursor_row_p (row
))
17931 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17933 /* Highlight trailing whitespace. */
17934 if (!NILP (Vshow_trailing_whitespace
))
17935 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17937 /* Prepare for the next line. This line starts horizontally at (X
17938 HPOS) = (0 0). Vertical positions are incremented. As a
17939 convenience for the caller, IT->glyph_row is set to the next
17941 it
->current_x
= it
->hpos
= 0;
17942 it
->current_y
+= row
->height
;
17943 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17946 /* The next row should by default use the same value of the
17947 reversed_p flag as this one. set_iterator_to_next decides when
17948 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17949 the flag accordingly. */
17950 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17951 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17952 it
->start
= row
->end
;
17953 return row
->displays_text_p
;
17955 #undef RECORD_MAX_MIN_POS
17958 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17959 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17960 doc
: /* Return paragraph direction at point in BUFFER.
17961 Value is either `left-to-right' or `right-to-left'.
17962 If BUFFER is omitted or nil, it defaults to the current buffer.
17964 Paragraph direction determines how the text in the paragraph is displayed.
17965 In left-to-right paragraphs, text begins at the left margin of the window
17966 and the reading direction is generally left to right. In right-to-left
17967 paragraphs, text begins at the right margin and is read from right to left.
17969 See also `bidi-paragraph-direction'. */)
17970 (Lisp_Object buffer
)
17972 struct buffer
*buf
= current_buffer
;
17973 struct buffer
*old
= buf
;
17975 if (! NILP (buffer
))
17977 CHECK_BUFFER (buffer
);
17978 buf
= XBUFFER (buffer
);
17981 if (NILP (BVAR (buf
, bidi_display_reordering
)))
17982 return Qleft_to_right
;
17983 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
17984 return BVAR (buf
, bidi_paragraph_direction
);
17987 /* Determine the direction from buffer text. We could try to
17988 use current_matrix if it is up to date, but this seems fast
17989 enough as it is. */
17990 struct bidi_it itb
;
17991 EMACS_INT pos
= BUF_PT (buf
);
17992 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17995 set_buffer_temp (buf
);
17996 /* bidi_paragraph_init finds the base direction of the paragraph
17997 by searching forward from paragraph start. We need the base
17998 direction of the current or _previous_ paragraph, so we need
17999 to make sure we are within that paragraph. To that end, find
18000 the previous non-empty line. */
18001 if (pos
>= ZV
&& pos
> BEGV
)
18004 bytepos
= CHAR_TO_BYTE (pos
);
18006 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18007 || c
== ' ' || c
== '\t' || c
== '\f')
18009 if (bytepos
<= BEGV_BYTE
)
18014 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18017 itb
.bytepos
= bytepos
;
18019 itb
.separator_limit
= -1;
18020 itb
.paragraph_dir
= NEUTRAL_DIR
;
18022 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18023 set_buffer_temp (old
);
18024 switch (itb
.paragraph_dir
)
18027 return Qleft_to_right
;
18030 return Qright_to_left
;
18040 /***********************************************************************
18042 ***********************************************************************/
18044 /* Redisplay the menu bar in the frame for window W.
18046 The menu bar of X frames that don't have X toolkit support is
18047 displayed in a special window W->frame->menu_bar_window.
18049 The menu bar of terminal frames is treated specially as far as
18050 glyph matrices are concerned. Menu bar lines are not part of
18051 windows, so the update is done directly on the frame matrix rows
18052 for the menu bar. */
18055 display_menu_bar (struct window
*w
)
18057 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18062 /* Don't do all this for graphical frames. */
18064 if (FRAME_W32_P (f
))
18067 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18073 if (FRAME_NS_P (f
))
18075 #endif /* HAVE_NS */
18077 #ifdef USE_X_TOOLKIT
18078 xassert (!FRAME_WINDOW_P (f
));
18079 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18080 it
.first_visible_x
= 0;
18081 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18082 #else /* not USE_X_TOOLKIT */
18083 if (FRAME_WINDOW_P (f
))
18085 /* Menu bar lines are displayed in the desired matrix of the
18086 dummy window menu_bar_window. */
18087 struct window
*menu_w
;
18088 xassert (WINDOWP (f
->menu_bar_window
));
18089 menu_w
= XWINDOW (f
->menu_bar_window
);
18090 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18092 it
.first_visible_x
= 0;
18093 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18097 /* This is a TTY frame, i.e. character hpos/vpos are used as
18099 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18101 it
.first_visible_x
= 0;
18102 it
.last_visible_x
= FRAME_COLS (f
);
18104 #endif /* not USE_X_TOOLKIT */
18106 if (! mode_line_inverse_video
)
18107 /* Force the menu-bar to be displayed in the default face. */
18108 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18110 /* Clear all rows of the menu bar. */
18111 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18113 struct glyph_row
*row
= it
.glyph_row
+ i
;
18114 clear_glyph_row (row
);
18115 row
->enabled_p
= 1;
18116 row
->full_width_p
= 1;
18119 /* Display all items of the menu bar. */
18120 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18121 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18123 Lisp_Object string
;
18125 /* Stop at nil string. */
18126 string
= AREF (items
, i
+ 1);
18130 /* Remember where item was displayed. */
18131 ASET (items
, i
+ 3, make_number (it
.hpos
));
18133 /* Display the item, pad with one space. */
18134 if (it
.current_x
< it
.last_visible_x
)
18135 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18136 SCHARS (string
) + 1, 0, 0, -1);
18139 /* Fill out the line with spaces. */
18140 if (it
.current_x
< it
.last_visible_x
)
18141 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18143 /* Compute the total height of the lines. */
18144 compute_line_metrics (&it
);
18149 /***********************************************************************
18151 ***********************************************************************/
18153 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18154 FORCE is non-zero, redisplay mode lines unconditionally.
18155 Otherwise, redisplay only mode lines that are garbaged. Value is
18156 the number of windows whose mode lines were redisplayed. */
18159 redisplay_mode_lines (Lisp_Object window
, int force
)
18163 while (!NILP (window
))
18165 struct window
*w
= XWINDOW (window
);
18167 if (WINDOWP (w
->hchild
))
18168 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18169 else if (WINDOWP (w
->vchild
))
18170 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18172 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18173 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18175 struct text_pos lpoint
;
18176 struct buffer
*old
= current_buffer
;
18178 /* Set the window's buffer for the mode line display. */
18179 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18180 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18182 /* Point refers normally to the selected window. For any
18183 other window, set up appropriate value. */
18184 if (!EQ (window
, selected_window
))
18186 struct text_pos pt
;
18188 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18189 if (CHARPOS (pt
) < BEGV
)
18190 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18191 else if (CHARPOS (pt
) > (ZV
- 1))
18192 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18194 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18197 /* Display mode lines. */
18198 clear_glyph_matrix (w
->desired_matrix
);
18199 if (display_mode_lines (w
))
18202 w
->must_be_updated_p
= 1;
18205 /* Restore old settings. */
18206 set_buffer_internal_1 (old
);
18207 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18217 /* Display the mode and/or header line of window W. Value is the
18218 sum number of mode lines and header lines displayed. */
18221 display_mode_lines (struct window
*w
)
18223 Lisp_Object old_selected_window
, old_selected_frame
;
18226 old_selected_frame
= selected_frame
;
18227 selected_frame
= w
->frame
;
18228 old_selected_window
= selected_window
;
18229 XSETWINDOW (selected_window
, w
);
18231 /* These will be set while the mode line specs are processed. */
18232 line_number_displayed
= 0;
18233 w
->column_number_displayed
= Qnil
;
18235 if (WINDOW_WANTS_MODELINE_P (w
))
18237 struct window
*sel_w
= XWINDOW (old_selected_window
);
18239 /* Select mode line face based on the real selected window. */
18240 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18241 BVAR (current_buffer
, mode_line_format
));
18245 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18247 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18248 BVAR (current_buffer
, header_line_format
));
18252 selected_frame
= old_selected_frame
;
18253 selected_window
= old_selected_window
;
18258 /* Display mode or header line of window W. FACE_ID specifies which
18259 line to display; it is either MODE_LINE_FACE_ID or
18260 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18261 display. Value is the pixel height of the mode/header line
18265 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18269 int count
= SPECPDL_INDEX ();
18271 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18272 /* Don't extend on a previously drawn mode-line.
18273 This may happen if called from pos_visible_p. */
18274 it
.glyph_row
->enabled_p
= 0;
18275 prepare_desired_row (it
.glyph_row
);
18277 it
.glyph_row
->mode_line_p
= 1;
18279 if (! mode_line_inverse_video
)
18280 /* Force the mode-line to be displayed in the default face. */
18281 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18283 record_unwind_protect (unwind_format_mode_line
,
18284 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18286 mode_line_target
= MODE_LINE_DISPLAY
;
18288 /* Temporarily make frame's keyboard the current kboard so that
18289 kboard-local variables in the mode_line_format will get the right
18291 push_kboard (FRAME_KBOARD (it
.f
));
18292 record_unwind_save_match_data ();
18293 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18296 unbind_to (count
, Qnil
);
18298 /* Fill up with spaces. */
18299 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18301 compute_line_metrics (&it
);
18302 it
.glyph_row
->full_width_p
= 1;
18303 it
.glyph_row
->continued_p
= 0;
18304 it
.glyph_row
->truncated_on_left_p
= 0;
18305 it
.glyph_row
->truncated_on_right_p
= 0;
18307 /* Make a 3D mode-line have a shadow at its right end. */
18308 face
= FACE_FROM_ID (it
.f
, face_id
);
18309 extend_face_to_end_of_line (&it
);
18310 if (face
->box
!= FACE_NO_BOX
)
18312 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18313 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18314 last
->right_box_line_p
= 1;
18317 return it
.glyph_row
->height
;
18320 /* Move element ELT in LIST to the front of LIST.
18321 Return the updated list. */
18324 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18326 register Lisp_Object tail
, prev
;
18327 register Lisp_Object tem
;
18331 while (CONSP (tail
))
18337 /* Splice out the link TAIL. */
18339 list
= XCDR (tail
);
18341 Fsetcdr (prev
, XCDR (tail
));
18343 /* Now make it the first. */
18344 Fsetcdr (tail
, list
);
18349 tail
= XCDR (tail
);
18353 /* Not found--return unchanged LIST. */
18357 /* Contribute ELT to the mode line for window IT->w. How it
18358 translates into text depends on its data type.
18360 IT describes the display environment in which we display, as usual.
18362 DEPTH is the depth in recursion. It is used to prevent
18363 infinite recursion here.
18365 FIELD_WIDTH is the number of characters the display of ELT should
18366 occupy in the mode line, and PRECISION is the maximum number of
18367 characters to display from ELT's representation. See
18368 display_string for details.
18370 Returns the hpos of the end of the text generated by ELT.
18372 PROPS is a property list to add to any string we encounter.
18374 If RISKY is nonzero, remove (disregard) any properties in any string
18375 we encounter, and ignore :eval and :propertize.
18377 The global variable `mode_line_target' determines whether the
18378 output is passed to `store_mode_line_noprop',
18379 `store_mode_line_string', or `display_string'. */
18382 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18383 Lisp_Object elt
, Lisp_Object props
, int risky
)
18385 int n
= 0, field
, prec
;
18390 elt
= build_string ("*too-deep*");
18394 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18398 /* A string: output it and check for %-constructs within it. */
18400 EMACS_INT offset
= 0;
18402 if (SCHARS (elt
) > 0
18403 && (!NILP (props
) || risky
))
18405 Lisp_Object oprops
, aelt
;
18406 oprops
= Ftext_properties_at (make_number (0), elt
);
18408 /* If the starting string's properties are not what
18409 we want, translate the string. Also, if the string
18410 is risky, do that anyway. */
18412 if (NILP (Fequal (props
, oprops
)) || risky
)
18414 /* If the starting string has properties,
18415 merge the specified ones onto the existing ones. */
18416 if (! NILP (oprops
) && !risky
)
18420 oprops
= Fcopy_sequence (oprops
);
18422 while (CONSP (tem
))
18424 oprops
= Fplist_put (oprops
, XCAR (tem
),
18425 XCAR (XCDR (tem
)));
18426 tem
= XCDR (XCDR (tem
));
18431 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18432 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18434 /* AELT is what we want. Move it to the front
18435 without consing. */
18437 mode_line_proptrans_alist
18438 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18444 /* If AELT has the wrong props, it is useless.
18445 so get rid of it. */
18447 mode_line_proptrans_alist
18448 = Fdelq (aelt
, mode_line_proptrans_alist
);
18450 elt
= Fcopy_sequence (elt
);
18451 Fset_text_properties (make_number (0), Flength (elt
),
18453 /* Add this item to mode_line_proptrans_alist. */
18454 mode_line_proptrans_alist
18455 = Fcons (Fcons (elt
, props
),
18456 mode_line_proptrans_alist
);
18457 /* Truncate mode_line_proptrans_alist
18458 to at most 50 elements. */
18459 tem
= Fnthcdr (make_number (50),
18460 mode_line_proptrans_alist
);
18462 XSETCDR (tem
, Qnil
);
18471 prec
= precision
- n
;
18472 switch (mode_line_target
)
18474 case MODE_LINE_NOPROP
:
18475 case MODE_LINE_TITLE
:
18476 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18478 case MODE_LINE_STRING
:
18479 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18481 case MODE_LINE_DISPLAY
:
18482 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18483 0, prec
, 0, STRING_MULTIBYTE (elt
));
18490 /* Handle the non-literal case. */
18492 while ((precision
<= 0 || n
< precision
)
18493 && SREF (elt
, offset
) != 0
18494 && (mode_line_target
!= MODE_LINE_DISPLAY
18495 || it
->current_x
< it
->last_visible_x
))
18497 EMACS_INT last_offset
= offset
;
18499 /* Advance to end of string or next format specifier. */
18500 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18503 if (offset
- 1 != last_offset
)
18505 EMACS_INT nchars
, nbytes
;
18507 /* Output to end of string or up to '%'. Field width
18508 is length of string. Don't output more than
18509 PRECISION allows us. */
18512 prec
= c_string_width (SDATA (elt
) + last_offset
,
18513 offset
- last_offset
, precision
- n
,
18516 switch (mode_line_target
)
18518 case MODE_LINE_NOPROP
:
18519 case MODE_LINE_TITLE
:
18520 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18522 case MODE_LINE_STRING
:
18524 EMACS_INT bytepos
= last_offset
;
18525 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18526 EMACS_INT endpos
= (precision
<= 0
18527 ? string_byte_to_char (elt
, offset
)
18528 : charpos
+ nchars
);
18530 n
+= store_mode_line_string (NULL
,
18531 Fsubstring (elt
, make_number (charpos
),
18532 make_number (endpos
)),
18536 case MODE_LINE_DISPLAY
:
18538 EMACS_INT bytepos
= last_offset
;
18539 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18541 if (precision
<= 0)
18542 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18543 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18545 STRING_MULTIBYTE (elt
));
18550 else /* c == '%' */
18552 EMACS_INT percent_position
= offset
;
18554 /* Get the specified minimum width. Zero means
18557 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18558 field
= field
* 10 + c
- '0';
18560 /* Don't pad beyond the total padding allowed. */
18561 if (field_width
- n
> 0 && field
> field_width
- n
)
18562 field
= field_width
- n
;
18564 /* Note that either PRECISION <= 0 or N < PRECISION. */
18565 prec
= precision
- n
;
18568 n
+= display_mode_element (it
, depth
, field
, prec
,
18569 Vglobal_mode_string
, props
,
18574 EMACS_INT bytepos
, charpos
;
18576 Lisp_Object string
;
18578 bytepos
= percent_position
;
18579 charpos
= (STRING_MULTIBYTE (elt
)
18580 ? string_byte_to_char (elt
, bytepos
)
18582 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18583 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18585 switch (mode_line_target
)
18587 case MODE_LINE_NOPROP
:
18588 case MODE_LINE_TITLE
:
18589 n
+= store_mode_line_noprop (spec
, field
, prec
);
18591 case MODE_LINE_STRING
:
18593 int len
= strlen (spec
);
18594 Lisp_Object tem
= make_string (spec
, len
);
18595 props
= Ftext_properties_at (make_number (charpos
), elt
);
18596 /* Should only keep face property in props */
18597 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18600 case MODE_LINE_DISPLAY
:
18602 int nglyphs_before
, nwritten
;
18604 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18605 nwritten
= display_string (spec
, string
, elt
,
18610 /* Assign to the glyphs written above the
18611 string where the `%x' came from, position
18615 struct glyph
*glyph
18616 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18620 for (i
= 0; i
< nwritten
; ++i
)
18622 glyph
[i
].object
= elt
;
18623 glyph
[i
].charpos
= charpos
;
18640 /* A symbol: process the value of the symbol recursively
18641 as if it appeared here directly. Avoid error if symbol void.
18642 Special case: if value of symbol is a string, output the string
18645 register Lisp_Object tem
;
18647 /* If the variable is not marked as risky to set
18648 then its contents are risky to use. */
18649 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18652 tem
= Fboundp (elt
);
18655 tem
= Fsymbol_value (elt
);
18656 /* If value is a string, output that string literally:
18657 don't check for % within it. */
18661 if (!EQ (tem
, elt
))
18663 /* Give up right away for nil or t. */
18673 register Lisp_Object car
, tem
;
18675 /* A cons cell: five distinct cases.
18676 If first element is :eval or :propertize, do something special.
18677 If first element is a string or a cons, process all the elements
18678 and effectively concatenate them.
18679 If first element is a negative number, truncate displaying cdr to
18680 at most that many characters. If positive, pad (with spaces)
18681 to at least that many characters.
18682 If first element is a symbol, process the cadr or caddr recursively
18683 according to whether the symbol's value is non-nil or nil. */
18685 if (EQ (car
, QCeval
))
18687 /* An element of the form (:eval FORM) means evaluate FORM
18688 and use the result as mode line elements. */
18693 if (CONSP (XCDR (elt
)))
18696 spec
= safe_eval (XCAR (XCDR (elt
)));
18697 n
+= display_mode_element (it
, depth
, field_width
- n
,
18698 precision
- n
, spec
, props
,
18702 else if (EQ (car
, QCpropertize
))
18704 /* An element of the form (:propertize ELT PROPS...)
18705 means display ELT but applying properties PROPS. */
18710 if (CONSP (XCDR (elt
)))
18711 n
+= display_mode_element (it
, depth
, field_width
- n
,
18712 precision
- n
, XCAR (XCDR (elt
)),
18713 XCDR (XCDR (elt
)), risky
);
18715 else if (SYMBOLP (car
))
18717 tem
= Fboundp (car
);
18721 /* elt is now the cdr, and we know it is a cons cell.
18722 Use its car if CAR has a non-nil value. */
18725 tem
= Fsymbol_value (car
);
18732 /* Symbol's value is nil (or symbol is unbound)
18733 Get the cddr of the original list
18734 and if possible find the caddr and use that. */
18738 else if (!CONSP (elt
))
18743 else if (INTEGERP (car
))
18745 register int lim
= XINT (car
);
18749 /* Negative int means reduce maximum width. */
18750 if (precision
<= 0)
18753 precision
= min (precision
, -lim
);
18757 /* Padding specified. Don't let it be more than
18758 current maximum. */
18760 lim
= min (precision
, lim
);
18762 /* If that's more padding than already wanted, queue it.
18763 But don't reduce padding already specified even if
18764 that is beyond the current truncation point. */
18765 field_width
= max (lim
, field_width
);
18769 else if (STRINGP (car
) || CONSP (car
))
18771 Lisp_Object halftail
= elt
;
18775 && (precision
<= 0 || n
< precision
))
18777 n
+= display_mode_element (it
, depth
,
18778 /* Do padding only after the last
18779 element in the list. */
18780 (! CONSP (XCDR (elt
))
18783 precision
- n
, XCAR (elt
),
18787 if ((len
& 1) == 0)
18788 halftail
= XCDR (halftail
);
18789 /* Check for cycle. */
18790 if (EQ (halftail
, elt
))
18799 elt
= build_string ("*invalid*");
18803 /* Pad to FIELD_WIDTH. */
18804 if (field_width
> 0 && n
< field_width
)
18806 switch (mode_line_target
)
18808 case MODE_LINE_NOPROP
:
18809 case MODE_LINE_TITLE
:
18810 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18812 case MODE_LINE_STRING
:
18813 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18815 case MODE_LINE_DISPLAY
:
18816 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18825 /* Store a mode-line string element in mode_line_string_list.
18827 If STRING is non-null, display that C string. Otherwise, the Lisp
18828 string LISP_STRING is displayed.
18830 FIELD_WIDTH is the minimum number of output glyphs to produce.
18831 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18832 with spaces. FIELD_WIDTH <= 0 means don't pad.
18834 PRECISION is the maximum number of characters to output from
18835 STRING. PRECISION <= 0 means don't truncate the string.
18837 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18838 properties to the string.
18840 PROPS are the properties to add to the string.
18841 The mode_line_string_face face property is always added to the string.
18845 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18846 int field_width
, int precision
, Lisp_Object props
)
18851 if (string
!= NULL
)
18853 len
= strlen (string
);
18854 if (precision
> 0 && len
> precision
)
18856 lisp_string
= make_string (string
, len
);
18858 props
= mode_line_string_face_prop
;
18859 else if (!NILP (mode_line_string_face
))
18861 Lisp_Object face
= Fplist_get (props
, Qface
);
18862 props
= Fcopy_sequence (props
);
18864 face
= mode_line_string_face
;
18866 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18867 props
= Fplist_put (props
, Qface
, face
);
18869 Fadd_text_properties (make_number (0), make_number (len
),
18870 props
, lisp_string
);
18874 len
= XFASTINT (Flength (lisp_string
));
18875 if (precision
> 0 && len
> precision
)
18878 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18881 if (!NILP (mode_line_string_face
))
18885 props
= Ftext_properties_at (make_number (0), lisp_string
);
18886 face
= Fplist_get (props
, Qface
);
18888 face
= mode_line_string_face
;
18890 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18891 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18893 lisp_string
= Fcopy_sequence (lisp_string
);
18896 Fadd_text_properties (make_number (0), make_number (len
),
18897 props
, lisp_string
);
18902 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18906 if (field_width
> len
)
18908 field_width
-= len
;
18909 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18911 Fadd_text_properties (make_number (0), make_number (field_width
),
18912 props
, lisp_string
);
18913 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18921 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18923 doc
: /* Format a string out of a mode line format specification.
18924 First arg FORMAT specifies the mode line format (see `mode-line-format'
18925 for details) to use.
18927 By default, the format is evaluated for the currently selected window.
18929 Optional second arg FACE specifies the face property to put on all
18930 characters for which no face is specified. The value nil means the
18931 default face. The value t means whatever face the window's mode line
18932 currently uses (either `mode-line' or `mode-line-inactive',
18933 depending on whether the window is the selected window or not).
18934 An integer value means the value string has no text
18937 Optional third and fourth args WINDOW and BUFFER specify the window
18938 and buffer to use as the context for the formatting (defaults
18939 are the selected window and the WINDOW's buffer). */)
18940 (Lisp_Object format
, Lisp_Object face
,
18941 Lisp_Object window
, Lisp_Object buffer
)
18946 struct buffer
*old_buffer
= NULL
;
18948 int no_props
= INTEGERP (face
);
18949 int count
= SPECPDL_INDEX ();
18951 int string_start
= 0;
18954 window
= selected_window
;
18955 CHECK_WINDOW (window
);
18956 w
= XWINDOW (window
);
18959 buffer
= w
->buffer
;
18960 CHECK_BUFFER (buffer
);
18962 /* Make formatting the modeline a non-op when noninteractive, otherwise
18963 there will be problems later caused by a partially initialized frame. */
18964 if (NILP (format
) || noninteractive
)
18965 return empty_unibyte_string
;
18970 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18971 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18972 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18973 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18974 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18975 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18976 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18979 if (XBUFFER (buffer
) != current_buffer
)
18980 old_buffer
= current_buffer
;
18982 /* Save things including mode_line_proptrans_alist,
18983 and set that to nil so that we don't alter the outer value. */
18984 record_unwind_protect (unwind_format_mode_line
,
18985 format_mode_line_unwind_data
18986 (old_buffer
, selected_window
, 1));
18987 mode_line_proptrans_alist
= Qnil
;
18989 Fselect_window (window
, Qt
);
18991 set_buffer_internal_1 (XBUFFER (buffer
));
18993 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18997 mode_line_target
= MODE_LINE_NOPROP
;
18998 mode_line_string_face_prop
= Qnil
;
18999 mode_line_string_list
= Qnil
;
19000 string_start
= MODE_LINE_NOPROP_LEN (0);
19004 mode_line_target
= MODE_LINE_STRING
;
19005 mode_line_string_list
= Qnil
;
19006 mode_line_string_face
= face
;
19007 mode_line_string_face_prop
19008 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19011 push_kboard (FRAME_KBOARD (it
.f
));
19012 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19017 len
= MODE_LINE_NOPROP_LEN (string_start
);
19018 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19022 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19023 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19024 empty_unibyte_string
);
19027 unbind_to (count
, Qnil
);
19031 /* Write a null-terminated, right justified decimal representation of
19032 the positive integer D to BUF using a minimal field width WIDTH. */
19035 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19037 register char *p
= buf
;
19045 *p
++ = d
% 10 + '0';
19050 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19061 /* Write a null-terminated, right justified decimal and "human
19062 readable" representation of the nonnegative integer D to BUF using
19063 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19065 static const char power_letter
[] =
19079 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19081 /* We aim to represent the nonnegative integer D as
19082 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19083 EMACS_INT quotient
= d
;
19085 /* -1 means: do not use TENTHS. */
19089 /* Length of QUOTIENT.TENTHS as a string. */
19095 if (1000 <= quotient
)
19097 /* Scale to the appropriate EXPONENT. */
19100 remainder
= quotient
% 1000;
19104 while (1000 <= quotient
);
19106 /* Round to nearest and decide whether to use TENTHS or not. */
19109 tenths
= remainder
/ 100;
19110 if (50 <= remainder
% 100)
19117 if (quotient
== 10)
19125 if (500 <= remainder
)
19127 if (quotient
< 999)
19138 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19139 if (tenths
== -1 && quotient
<= 99)
19146 p
= psuffix
= buf
+ max (width
, length
);
19148 /* Print EXPONENT. */
19149 *psuffix
++ = power_letter
[exponent
];
19152 /* Print TENTHS. */
19155 *--p
= '0' + tenths
;
19159 /* Print QUOTIENT. */
19162 int digit
= quotient
% 10;
19163 *--p
= '0' + digit
;
19165 while ((quotient
/= 10) != 0);
19167 /* Print leading spaces. */
19172 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19173 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19174 type of CODING_SYSTEM. Return updated pointer into BUF. */
19176 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19179 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19182 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19183 const unsigned char *eol_str
;
19185 /* The EOL conversion we are using. */
19186 Lisp_Object eoltype
;
19188 val
= CODING_SYSTEM_SPEC (coding_system
);
19191 if (!VECTORP (val
)) /* Not yet decided. */
19196 eoltype
= eol_mnemonic_undecided
;
19197 /* Don't mention EOL conversion if it isn't decided. */
19202 Lisp_Object eolvalue
;
19204 attrs
= AREF (val
, 0);
19205 eolvalue
= AREF (val
, 2);
19208 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19212 /* The EOL conversion that is normal on this system. */
19214 if (NILP (eolvalue
)) /* Not yet decided. */
19215 eoltype
= eol_mnemonic_undecided
;
19216 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19217 eoltype
= eol_mnemonic_undecided
;
19218 else /* eolvalue is Qunix, Qdos, or Qmac. */
19219 eoltype
= (EQ (eolvalue
, Qunix
)
19220 ? eol_mnemonic_unix
19221 : (EQ (eolvalue
, Qdos
) == 1
19222 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19228 /* Mention the EOL conversion if it is not the usual one. */
19229 if (STRINGP (eoltype
))
19231 eol_str
= SDATA (eoltype
);
19232 eol_str_len
= SBYTES (eoltype
);
19234 else if (CHARACTERP (eoltype
))
19236 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19237 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19242 eol_str
= invalid_eol_type
;
19243 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19245 memcpy (buf
, eol_str
, eol_str_len
);
19246 buf
+= eol_str_len
;
19252 /* Return a string for the output of a mode line %-spec for window W,
19253 generated by character C. FIELD_WIDTH > 0 means pad the string
19254 returned with spaces to that value. Return a Lisp string in
19255 *STRING if the resulting string is taken from that Lisp string.
19257 Note we operate on the current buffer for most purposes,
19258 the exception being w->base_line_pos. */
19260 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19262 static const char *
19263 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19264 Lisp_Object
*string
)
19267 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19268 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19269 struct buffer
*b
= current_buffer
;
19277 if (!NILP (BVAR (b
, read_only
)))
19279 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19284 /* This differs from %* only for a modified read-only buffer. */
19285 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19287 if (!NILP (BVAR (b
, read_only
)))
19292 /* This differs from %* in ignoring read-only-ness. */
19293 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19305 if (command_loop_level
> 5)
19307 p
= decode_mode_spec_buf
;
19308 for (i
= 0; i
< command_loop_level
; i
++)
19311 return decode_mode_spec_buf
;
19319 if (command_loop_level
> 5)
19321 p
= decode_mode_spec_buf
;
19322 for (i
= 0; i
< command_loop_level
; i
++)
19325 return decode_mode_spec_buf
;
19332 /* Let lots_of_dashes be a string of infinite length. */
19333 if (mode_line_target
== MODE_LINE_NOPROP
||
19334 mode_line_target
== MODE_LINE_STRING
)
19336 if (field_width
<= 0
19337 || field_width
> sizeof (lots_of_dashes
))
19339 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19340 decode_mode_spec_buf
[i
] = '-';
19341 decode_mode_spec_buf
[i
] = '\0';
19342 return decode_mode_spec_buf
;
19345 return lots_of_dashes
;
19349 obj
= BVAR (b
, name
);
19353 /* %c and %l are ignored in `frame-title-format'.
19354 (In redisplay_internal, the frame title is drawn _before_ the
19355 windows are updated, so the stuff which depends on actual
19356 window contents (such as %l) may fail to render properly, or
19357 even crash emacs.) */
19358 if (mode_line_target
== MODE_LINE_TITLE
)
19362 EMACS_INT col
= current_column ();
19363 w
->column_number_displayed
= make_number (col
);
19364 pint2str (decode_mode_spec_buf
, field_width
, col
);
19365 return decode_mode_spec_buf
;
19369 #ifndef SYSTEM_MALLOC
19371 if (NILP (Vmemory_full
))
19374 return "!MEM FULL! ";
19381 /* %F displays the frame name. */
19382 if (!NILP (f
->title
))
19383 return SSDATA (f
->title
);
19384 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19385 return SSDATA (f
->name
);
19389 obj
= BVAR (b
, filename
);
19394 EMACS_INT size
= ZV
- BEGV
;
19395 pint2str (decode_mode_spec_buf
, field_width
, size
);
19396 return decode_mode_spec_buf
;
19401 EMACS_INT size
= ZV
- BEGV
;
19402 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19403 return decode_mode_spec_buf
;
19408 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19409 EMACS_INT topline
, nlines
, height
;
19412 /* %c and %l are ignored in `frame-title-format'. */
19413 if (mode_line_target
== MODE_LINE_TITLE
)
19416 startpos
= XMARKER (w
->start
)->charpos
;
19417 startpos_byte
= marker_byte_position (w
->start
);
19418 height
= WINDOW_TOTAL_LINES (w
);
19420 /* If we decided that this buffer isn't suitable for line numbers,
19421 don't forget that too fast. */
19422 if (EQ (w
->base_line_pos
, w
->buffer
))
19424 /* But do forget it, if the window shows a different buffer now. */
19425 else if (BUFFERP (w
->base_line_pos
))
19426 w
->base_line_pos
= Qnil
;
19428 /* If the buffer is very big, don't waste time. */
19429 if (INTEGERP (Vline_number_display_limit
)
19430 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19432 w
->base_line_pos
= Qnil
;
19433 w
->base_line_number
= Qnil
;
19437 if (INTEGERP (w
->base_line_number
)
19438 && INTEGERP (w
->base_line_pos
)
19439 && XFASTINT (w
->base_line_pos
) <= startpos
)
19441 line
= XFASTINT (w
->base_line_number
);
19442 linepos
= XFASTINT (w
->base_line_pos
);
19443 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19448 linepos
= BUF_BEGV (b
);
19449 linepos_byte
= BUF_BEGV_BYTE (b
);
19452 /* Count lines from base line to window start position. */
19453 nlines
= display_count_lines (linepos_byte
,
19457 topline
= nlines
+ line
;
19459 /* Determine a new base line, if the old one is too close
19460 or too far away, or if we did not have one.
19461 "Too close" means it's plausible a scroll-down would
19462 go back past it. */
19463 if (startpos
== BUF_BEGV (b
))
19465 w
->base_line_number
= make_number (topline
);
19466 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19468 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19469 || linepos
== BUF_BEGV (b
))
19471 EMACS_INT limit
= BUF_BEGV (b
);
19472 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19473 EMACS_INT position
;
19474 EMACS_INT distance
=
19475 (height
* 2 + 30) * line_number_display_limit_width
;
19477 if (startpos
- distance
> limit
)
19479 limit
= startpos
- distance
;
19480 limit_byte
= CHAR_TO_BYTE (limit
);
19483 nlines
= display_count_lines (startpos_byte
,
19485 - (height
* 2 + 30),
19487 /* If we couldn't find the lines we wanted within
19488 line_number_display_limit_width chars per line,
19489 give up on line numbers for this window. */
19490 if (position
== limit_byte
&& limit
== startpos
- distance
)
19492 w
->base_line_pos
= w
->buffer
;
19493 w
->base_line_number
= Qnil
;
19497 w
->base_line_number
= make_number (topline
- nlines
);
19498 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19501 /* Now count lines from the start pos to point. */
19502 nlines
= display_count_lines (startpos_byte
,
19503 PT_BYTE
, PT
, &junk
);
19505 /* Record that we did display the line number. */
19506 line_number_displayed
= 1;
19508 /* Make the string to show. */
19509 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19510 return decode_mode_spec_buf
;
19513 char* p
= decode_mode_spec_buf
;
19514 int pad
= field_width
- 2;
19520 return decode_mode_spec_buf
;
19526 obj
= BVAR (b
, mode_name
);
19530 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19536 EMACS_INT pos
= marker_position (w
->start
);
19537 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19539 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19541 if (pos
<= BUF_BEGV (b
))
19546 else if (pos
<= BUF_BEGV (b
))
19550 if (total
> 1000000)
19551 /* Do it differently for a large value, to avoid overflow. */
19552 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19554 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19555 /* We can't normally display a 3-digit number,
19556 so get us a 2-digit number that is close. */
19559 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19560 return decode_mode_spec_buf
;
19564 /* Display percentage of size above the bottom of the screen. */
19567 EMACS_INT toppos
= marker_position (w
->start
);
19568 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19569 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19571 if (botpos
>= BUF_ZV (b
))
19573 if (toppos
<= BUF_BEGV (b
))
19580 if (total
> 1000000)
19581 /* Do it differently for a large value, to avoid overflow. */
19582 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19584 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19585 /* We can't normally display a 3-digit number,
19586 so get us a 2-digit number that is close. */
19589 if (toppos
<= BUF_BEGV (b
))
19590 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19592 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19593 return decode_mode_spec_buf
;
19598 /* status of process */
19599 obj
= Fget_buffer_process (Fcurrent_buffer ());
19601 return "no process";
19603 obj
= Fsymbol_name (Fprocess_status (obj
));
19609 int count
= inhibit_garbage_collection ();
19610 Lisp_Object val
= call1 (intern ("file-remote-p"),
19611 BVAR (current_buffer
, directory
));
19612 unbind_to (count
, Qnil
);
19620 case 't': /* indicate TEXT or BINARY */
19624 /* coding-system (not including end-of-line format) */
19626 /* coding-system (including end-of-line type) */
19628 int eol_flag
= (c
== 'Z');
19629 char *p
= decode_mode_spec_buf
;
19631 if (! FRAME_WINDOW_P (f
))
19633 /* No need to mention EOL here--the terminal never needs
19634 to do EOL conversion. */
19635 p
= decode_mode_spec_coding (CODING_ID_NAME
19636 (FRAME_KEYBOARD_CODING (f
)->id
),
19638 p
= decode_mode_spec_coding (CODING_ID_NAME
19639 (FRAME_TERMINAL_CODING (f
)->id
),
19642 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19645 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19646 #ifdef subprocesses
19647 obj
= Fget_buffer_process (Fcurrent_buffer ());
19648 if (PROCESSP (obj
))
19650 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19652 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19655 #endif /* subprocesses */
19658 return decode_mode_spec_buf
;
19665 return SSDATA (obj
);
19672 /* Count up to COUNT lines starting from START_BYTE.
19673 But don't go beyond LIMIT_BYTE.
19674 Return the number of lines thus found (always nonnegative).
19676 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19679 display_count_lines (EMACS_INT start_byte
,
19680 EMACS_INT limit_byte
, EMACS_INT count
,
19681 EMACS_INT
*byte_pos_ptr
)
19683 register unsigned char *cursor
;
19684 unsigned char *base
;
19686 register EMACS_INT ceiling
;
19687 register unsigned char *ceiling_addr
;
19688 EMACS_INT orig_count
= count
;
19690 /* If we are not in selective display mode,
19691 check only for newlines. */
19692 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19693 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19697 while (start_byte
< limit_byte
)
19699 ceiling
= BUFFER_CEILING_OF (start_byte
);
19700 ceiling
= min (limit_byte
- 1, ceiling
);
19701 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19702 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19705 if (selective_display
)
19706 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19709 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19712 if (cursor
!= ceiling_addr
)
19716 start_byte
+= cursor
- base
+ 1;
19717 *byte_pos_ptr
= start_byte
;
19721 if (++cursor
== ceiling_addr
)
19727 start_byte
+= cursor
- base
;
19732 while (start_byte
> limit_byte
)
19734 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19735 ceiling
= max (limit_byte
, ceiling
);
19736 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19737 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19740 if (selective_display
)
19741 while (--cursor
!= ceiling_addr
19742 && *cursor
!= '\n' && *cursor
!= 015)
19745 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19748 if (cursor
!= ceiling_addr
)
19752 start_byte
+= cursor
- base
+ 1;
19753 *byte_pos_ptr
= start_byte
;
19754 /* When scanning backwards, we should
19755 not count the newline posterior to which we stop. */
19756 return - orig_count
- 1;
19762 /* Here we add 1 to compensate for the last decrement
19763 of CURSOR, which took it past the valid range. */
19764 start_byte
+= cursor
- base
+ 1;
19768 *byte_pos_ptr
= limit_byte
;
19771 return - orig_count
+ count
;
19772 return orig_count
- count
;
19778 /***********************************************************************
19780 ***********************************************************************/
19782 /* Display a NUL-terminated string, starting with index START.
19784 If STRING is non-null, display that C string. Otherwise, the Lisp
19785 string LISP_STRING is displayed. There's a case that STRING is
19786 non-null and LISP_STRING is not nil. It means STRING is a string
19787 data of LISP_STRING. In that case, we display LISP_STRING while
19788 ignoring its text properties.
19790 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19791 FACE_STRING. Display STRING or LISP_STRING with the face at
19792 FACE_STRING_POS in FACE_STRING:
19794 Display the string in the environment given by IT, but use the
19795 standard display table, temporarily.
19797 FIELD_WIDTH is the minimum number of output glyphs to produce.
19798 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19799 with spaces. If STRING has more characters, more than FIELD_WIDTH
19800 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19802 PRECISION is the maximum number of characters to output from
19803 STRING. PRECISION < 0 means don't truncate the string.
19805 This is roughly equivalent to printf format specifiers:
19807 FIELD_WIDTH PRECISION PRINTF
19808 ----------------------------------------
19814 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19815 display them, and < 0 means obey the current buffer's value of
19816 enable_multibyte_characters.
19818 Value is the number of columns displayed. */
19821 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19822 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19823 int field_width
, int precision
, int max_x
, int multibyte
)
19825 int hpos_at_start
= it
->hpos
;
19826 int saved_face_id
= it
->face_id
;
19827 struct glyph_row
*row
= it
->glyph_row
;
19829 /* Initialize the iterator IT for iteration over STRING beginning
19830 with index START. */
19831 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19832 precision
, field_width
, multibyte
);
19833 if (string
&& STRINGP (lisp_string
))
19834 /* LISP_STRING is the one returned by decode_mode_spec. We should
19835 ignore its text properties. */
19836 it
->stop_charpos
= -1;
19838 /* If displaying STRING, set up the face of the iterator
19839 from LISP_STRING, if that's given. */
19840 if (STRINGP (face_string
))
19846 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19847 0, it
->region_beg_charpos
,
19848 it
->region_end_charpos
,
19849 &endptr
, it
->base_face_id
, 0);
19850 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19851 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19854 /* Set max_x to the maximum allowed X position. Don't let it go
19855 beyond the right edge of the window. */
19857 max_x
= it
->last_visible_x
;
19859 max_x
= min (max_x
, it
->last_visible_x
);
19861 /* Skip over display elements that are not visible. because IT->w is
19863 if (it
->current_x
< it
->first_visible_x
)
19864 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19865 MOVE_TO_POS
| MOVE_TO_X
);
19867 row
->ascent
= it
->max_ascent
;
19868 row
->height
= it
->max_ascent
+ it
->max_descent
;
19869 row
->phys_ascent
= it
->max_phys_ascent
;
19870 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19871 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19873 /* This condition is for the case that we are called with current_x
19874 past last_visible_x. */
19875 while (it
->current_x
< max_x
)
19877 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19879 /* Get the next display element. */
19880 if (!get_next_display_element (it
))
19883 /* Produce glyphs. */
19884 x_before
= it
->current_x
;
19885 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19886 PRODUCE_GLYPHS (it
);
19888 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19891 while (i
< nglyphs
)
19893 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19895 if (it
->line_wrap
!= TRUNCATE
19896 && x
+ glyph
->pixel_width
> max_x
)
19898 /* End of continued line or max_x reached. */
19899 if (CHAR_GLYPH_PADDING_P (*glyph
))
19901 /* A wide character is unbreakable. */
19902 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19903 it
->current_x
= x_before
;
19907 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19912 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19914 /* Glyph is at least partially visible. */
19916 if (x
< it
->first_visible_x
)
19917 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19921 /* Glyph is off the left margin of the display area.
19922 Should not happen. */
19926 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19927 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19928 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19929 row
->phys_height
= max (row
->phys_height
,
19930 it
->max_phys_ascent
+ it
->max_phys_descent
);
19931 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19932 it
->max_extra_line_spacing
);
19933 x
+= glyph
->pixel_width
;
19937 /* Stop if max_x reached. */
19941 /* Stop at line ends. */
19942 if (ITERATOR_AT_END_OF_LINE_P (it
))
19944 it
->continuation_lines_width
= 0;
19948 set_iterator_to_next (it
, 1);
19950 /* Stop if truncating at the right edge. */
19951 if (it
->line_wrap
== TRUNCATE
19952 && it
->current_x
>= it
->last_visible_x
)
19954 /* Add truncation mark, but don't do it if the line is
19955 truncated at a padding space. */
19956 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19958 if (!FRAME_WINDOW_P (it
->f
))
19962 if (it
->current_x
> it
->last_visible_x
)
19964 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
19965 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
19967 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
19969 row
->used
[TEXT_AREA
] = ii
;
19970 produce_special_glyphs (it
, IT_TRUNCATION
);
19973 produce_special_glyphs (it
, IT_TRUNCATION
);
19975 it
->glyph_row
->truncated_on_right_p
= 1;
19981 /* Maybe insert a truncation at the left. */
19982 if (it
->first_visible_x
19983 && IT_CHARPOS (*it
) > 0)
19985 if (!FRAME_WINDOW_P (it
->f
))
19986 insert_left_trunc_glyphs (it
);
19987 it
->glyph_row
->truncated_on_left_p
= 1;
19990 it
->face_id
= saved_face_id
;
19992 /* Value is number of columns displayed. */
19993 return it
->hpos
- hpos_at_start
;
19998 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19999 appears as an element of LIST or as the car of an element of LIST.
20000 If PROPVAL is a list, compare each element against LIST in that
20001 way, and return 1/2 if any element of PROPVAL is found in LIST.
20002 Otherwise return 0. This function cannot quit.
20003 The return value is 2 if the text is invisible but with an ellipsis
20004 and 1 if it's invisible and without an ellipsis. */
20007 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20009 register Lisp_Object tail
, proptail
;
20011 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20013 register Lisp_Object tem
;
20015 if (EQ (propval
, tem
))
20017 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20018 return NILP (XCDR (tem
)) ? 1 : 2;
20021 if (CONSP (propval
))
20023 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20025 Lisp_Object propelt
;
20026 propelt
= XCAR (proptail
);
20027 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20029 register Lisp_Object tem
;
20031 if (EQ (propelt
, tem
))
20033 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20034 return NILP (XCDR (tem
)) ? 1 : 2;
20042 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20043 doc
: /* Non-nil if the property makes the text invisible.
20044 POS-OR-PROP can be a marker or number, in which case it is taken to be
20045 a position in the current buffer and the value of the `invisible' property
20046 is checked; or it can be some other value, which is then presumed to be the
20047 value of the `invisible' property of the text of interest.
20048 The non-nil value returned can be t for truly invisible text or something
20049 else if the text is replaced by an ellipsis. */)
20050 (Lisp_Object pos_or_prop
)
20053 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20054 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20056 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20057 return (invis
== 0 ? Qnil
20059 : make_number (invis
));
20062 /* Calculate a width or height in pixels from a specification using
20063 the following elements:
20066 NUM - a (fractional) multiple of the default font width/height
20067 (NUM) - specifies exactly NUM pixels
20068 UNIT - a fixed number of pixels, see below.
20069 ELEMENT - size of a display element in pixels, see below.
20070 (NUM . SPEC) - equals NUM * SPEC
20071 (+ SPEC SPEC ...) - add pixel values
20072 (- SPEC SPEC ...) - subtract pixel values
20073 (- SPEC) - negate pixel value
20076 INT or FLOAT - a number constant
20077 SYMBOL - use symbol's (buffer local) variable binding.
20080 in - pixels per inch *)
20081 mm - pixels per 1/1000 meter *)
20082 cm - pixels per 1/100 meter *)
20083 width - width of current font in pixels.
20084 height - height of current font in pixels.
20086 *) using the ratio(s) defined in display-pixels-per-inch.
20090 left-fringe - left fringe width in pixels
20091 right-fringe - right fringe width in pixels
20093 left-margin - left margin width in pixels
20094 right-margin - right margin width in pixels
20096 scroll-bar - scroll-bar area width in pixels
20100 Pixels corresponding to 5 inches:
20103 Total width of non-text areas on left side of window (if scroll-bar is on left):
20104 '(space :width (+ left-fringe left-margin scroll-bar))
20106 Align to first text column (in header line):
20107 '(space :align-to 0)
20109 Align to middle of text area minus half the width of variable `my-image'
20110 containing a loaded image:
20111 '(space :align-to (0.5 . (- text my-image)))
20113 Width of left margin minus width of 1 character in the default font:
20114 '(space :width (- left-margin 1))
20116 Width of left margin minus width of 2 characters in the current font:
20117 '(space :width (- left-margin (2 . width)))
20119 Center 1 character over left-margin (in header line):
20120 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20122 Different ways to express width of left fringe plus left margin minus one pixel:
20123 '(space :width (- (+ left-fringe left-margin) (1)))
20124 '(space :width (+ left-fringe left-margin (- (1))))
20125 '(space :width (+ left-fringe left-margin (-1)))
20129 #define NUMVAL(X) \
20130 ((INTEGERP (X) || FLOATP (X)) \
20135 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20136 struct font
*font
, int width_p
, int *align_to
)
20140 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20141 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20144 return OK_PIXELS (0);
20146 xassert (FRAME_LIVE_P (it
->f
));
20148 if (SYMBOLP (prop
))
20150 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20152 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20154 if (unit
[0] == 'i' && unit
[1] == 'n')
20156 else if (unit
[0] == 'm' && unit
[1] == 'm')
20158 else if (unit
[0] == 'c' && unit
[1] == 'm')
20165 #ifdef HAVE_WINDOW_SYSTEM
20166 if (FRAME_WINDOW_P (it
->f
)
20168 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20169 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20171 return OK_PIXELS (ppi
/ pixels
);
20174 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20175 || (CONSP (Vdisplay_pixels_per_inch
)
20177 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20178 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20180 return OK_PIXELS (ppi
/ pixels
);
20186 #ifdef HAVE_WINDOW_SYSTEM
20187 if (EQ (prop
, Qheight
))
20188 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20189 if (EQ (prop
, Qwidth
))
20190 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20192 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20193 return OK_PIXELS (1);
20196 if (EQ (prop
, Qtext
))
20197 return OK_PIXELS (width_p
20198 ? window_box_width (it
->w
, TEXT_AREA
)
20199 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20201 if (align_to
&& *align_to
< 0)
20204 if (EQ (prop
, Qleft
))
20205 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20206 if (EQ (prop
, Qright
))
20207 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20208 if (EQ (prop
, Qcenter
))
20209 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20210 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20211 if (EQ (prop
, Qleft_fringe
))
20212 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20213 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20214 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20215 if (EQ (prop
, Qright_fringe
))
20216 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20217 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20218 : window_box_right_offset (it
->w
, TEXT_AREA
));
20219 if (EQ (prop
, Qleft_margin
))
20220 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20221 if (EQ (prop
, Qright_margin
))
20222 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20223 if (EQ (prop
, Qscroll_bar
))
20224 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20226 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20227 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20228 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20233 if (EQ (prop
, Qleft_fringe
))
20234 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20235 if (EQ (prop
, Qright_fringe
))
20236 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20237 if (EQ (prop
, Qleft_margin
))
20238 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20239 if (EQ (prop
, Qright_margin
))
20240 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20241 if (EQ (prop
, Qscroll_bar
))
20242 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20245 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20248 if (INTEGERP (prop
) || FLOATP (prop
))
20250 int base_unit
= (width_p
20251 ? FRAME_COLUMN_WIDTH (it
->f
)
20252 : FRAME_LINE_HEIGHT (it
->f
));
20253 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20258 Lisp_Object car
= XCAR (prop
);
20259 Lisp_Object cdr
= XCDR (prop
);
20263 #ifdef HAVE_WINDOW_SYSTEM
20264 if (FRAME_WINDOW_P (it
->f
)
20265 && valid_image_p (prop
))
20267 int id
= lookup_image (it
->f
, prop
);
20268 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20270 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20273 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20279 while (CONSP (cdr
))
20281 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20282 font
, width_p
, align_to
))
20285 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20290 if (EQ (car
, Qminus
))
20292 return OK_PIXELS (pixels
);
20295 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20298 if (INTEGERP (car
) || FLOATP (car
))
20301 pixels
= XFLOATINT (car
);
20303 return OK_PIXELS (pixels
);
20304 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20305 font
, width_p
, align_to
))
20306 return OK_PIXELS (pixels
* fact
);
20317 /***********************************************************************
20319 ***********************************************************************/
20321 #ifdef HAVE_WINDOW_SYSTEM
20326 dump_glyph_string (s
)
20327 struct glyph_string
*s
;
20329 fprintf (stderr
, "glyph string\n");
20330 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20331 s
->x
, s
->y
, s
->width
, s
->height
);
20332 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20333 fprintf (stderr
, " hl = %d\n", s
->hl
);
20334 fprintf (stderr
, " left overhang = %d, right = %d\n",
20335 s
->left_overhang
, s
->right_overhang
);
20336 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20337 fprintf (stderr
, " extends to end of line = %d\n",
20338 s
->extends_to_end_of_line_p
);
20339 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20340 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20343 #endif /* GLYPH_DEBUG */
20345 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20346 of XChar2b structures for S; it can't be allocated in
20347 init_glyph_string because it must be allocated via `alloca'. W
20348 is the window on which S is drawn. ROW and AREA are the glyph row
20349 and area within the row from which S is constructed. START is the
20350 index of the first glyph structure covered by S. HL is a
20351 face-override for drawing S. */
20354 #define OPTIONAL_HDC(hdc) HDC hdc,
20355 #define DECLARE_HDC(hdc) HDC hdc;
20356 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20357 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20360 #ifndef OPTIONAL_HDC
20361 #define OPTIONAL_HDC(hdc)
20362 #define DECLARE_HDC(hdc)
20363 #define ALLOCATE_HDC(hdc, f)
20364 #define RELEASE_HDC(hdc, f)
20368 init_glyph_string (struct glyph_string
*s
,
20370 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20371 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20373 memset (s
, 0, sizeof *s
);
20375 s
->f
= XFRAME (w
->frame
);
20379 s
->display
= FRAME_X_DISPLAY (s
->f
);
20380 s
->window
= FRAME_X_WINDOW (s
->f
);
20381 s
->char2b
= char2b
;
20385 s
->first_glyph
= row
->glyphs
[area
] + start
;
20386 s
->height
= row
->height
;
20387 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20388 s
->ybase
= s
->y
+ row
->ascent
;
20392 /* Append the list of glyph strings with head H and tail T to the list
20393 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20396 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20397 struct glyph_string
*h
, struct glyph_string
*t
)
20411 /* Prepend the list of glyph strings with head H and tail T to the
20412 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20416 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20417 struct glyph_string
*h
, struct glyph_string
*t
)
20431 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20432 Set *HEAD and *TAIL to the resulting list. */
20435 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20436 struct glyph_string
*s
)
20438 s
->next
= s
->prev
= NULL
;
20439 append_glyph_string_lists (head
, tail
, s
, s
);
20443 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20444 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20445 make sure that X resources for the face returned are allocated.
20446 Value is a pointer to a realized face that is ready for display if
20447 DISPLAY_P is non-zero. */
20449 static INLINE
struct face
*
20450 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20451 XChar2b
*char2b
, int display_p
)
20453 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20457 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20459 if (code
!= FONT_INVALID_CODE
)
20460 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20462 STORE_XCHAR2B (char2b
, 0, 0);
20465 /* Make sure X resources of the face are allocated. */
20466 #ifdef HAVE_X_WINDOWS
20470 xassert (face
!= NULL
);
20471 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20478 /* Get face and two-byte form of character glyph GLYPH on frame F.
20479 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20480 a pointer to a realized face that is ready for display. */
20482 static INLINE
struct face
*
20483 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20484 XChar2b
*char2b
, int *two_byte_p
)
20488 xassert (glyph
->type
== CHAR_GLYPH
);
20489 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20498 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20499 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20501 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20503 if (code
!= FONT_INVALID_CODE
)
20504 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20506 STORE_XCHAR2B (char2b
, 0, 0);
20509 /* Make sure X resources of the face are allocated. */
20510 xassert (face
!= NULL
);
20511 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20516 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20517 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20520 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20524 if (CHAR_BYTE8_P (c
))
20525 code
= CHAR_TO_BYTE8 (c
);
20527 code
= font
->driver
->encode_char (font
, c
);
20529 if (code
== FONT_INVALID_CODE
)
20531 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20536 /* Fill glyph string S with composition components specified by S->cmp.
20538 BASE_FACE is the base face of the composition.
20539 S->cmp_from is the index of the first component for S.
20541 OVERLAPS non-zero means S should draw the foreground only, and use
20542 its physical height for clipping. See also draw_glyphs.
20544 Value is the index of a component not in S. */
20547 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20551 /* For all glyphs of this composition, starting at the offset
20552 S->cmp_from, until we reach the end of the definition or encounter a
20553 glyph that requires the different face, add it to S. */
20558 s
->for_overlaps
= overlaps
;
20561 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20563 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20567 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20570 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20577 s
->font
= s
->face
->font
;
20579 else if (s
->face
!= face
)
20587 /* All glyph strings for the same composition has the same width,
20588 i.e. the width set for the first component of the composition. */
20589 s
->width
= s
->first_glyph
->pixel_width
;
20591 /* If the specified font could not be loaded, use the frame's
20592 default font, but record the fact that we couldn't load it in
20593 the glyph string so that we can draw rectangles for the
20594 characters of the glyph string. */
20595 if (s
->font
== NULL
)
20597 s
->font_not_found_p
= 1;
20598 s
->font
= FRAME_FONT (s
->f
);
20601 /* Adjust base line for subscript/superscript text. */
20602 s
->ybase
+= s
->first_glyph
->voffset
;
20604 /* This glyph string must always be drawn with 16-bit functions. */
20611 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20612 int start
, int end
, int overlaps
)
20614 struct glyph
*glyph
, *last
;
20615 Lisp_Object lgstring
;
20618 s
->for_overlaps
= overlaps
;
20619 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20620 last
= s
->row
->glyphs
[s
->area
] + end
;
20621 s
->cmp_id
= glyph
->u
.cmp
.id
;
20622 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20623 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20624 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20625 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20626 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20628 while (glyph
< last
20629 && glyph
->u
.cmp
.automatic
20630 && glyph
->u
.cmp
.id
== s
->cmp_id
20631 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20632 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20634 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20636 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20637 unsigned code
= LGLYPH_CODE (lglyph
);
20639 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20641 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20642 return glyph
- s
->row
->glyphs
[s
->area
];
20646 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20647 See the comment of fill_glyph_string for arguments.
20648 Value is the index of the first glyph not in S. */
20652 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20653 int start
, int end
, int overlaps
)
20655 struct glyph
*glyph
, *last
;
20658 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20659 s
->for_overlaps
= overlaps
;
20660 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20661 last
= s
->row
->glyphs
[s
->area
] + end
;
20662 voffset
= glyph
->voffset
;
20663 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20664 s
->font
= s
->face
->font
;
20666 s
->width
= glyph
->pixel_width
;
20668 while (glyph
< last
20669 && glyph
->type
== GLYPHLESS_GLYPH
20670 && glyph
->voffset
== voffset
20671 && glyph
->face_id
== face_id
)
20674 s
->width
+= glyph
->pixel_width
;
20677 s
->ybase
+= voffset
;
20678 return glyph
- s
->row
->glyphs
[s
->area
];
20682 /* Fill glyph string S from a sequence of character glyphs.
20684 FACE_ID is the face id of the string. START is the index of the
20685 first glyph to consider, END is the index of the last + 1.
20686 OVERLAPS non-zero means S should draw the foreground only, and use
20687 its physical height for clipping. See also draw_glyphs.
20689 Value is the index of the first glyph not in S. */
20692 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20693 int start
, int end
, int overlaps
)
20695 struct glyph
*glyph
, *last
;
20697 int glyph_not_available_p
;
20699 xassert (s
->f
== XFRAME (s
->w
->frame
));
20700 xassert (s
->nchars
== 0);
20701 xassert (start
>= 0 && end
> start
);
20703 s
->for_overlaps
= overlaps
;
20704 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20705 last
= s
->row
->glyphs
[s
->area
] + end
;
20706 voffset
= glyph
->voffset
;
20707 s
->padding_p
= glyph
->padding_p
;
20708 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20710 while (glyph
< last
20711 && glyph
->type
== CHAR_GLYPH
20712 && glyph
->voffset
== voffset
20713 /* Same face id implies same font, nowadays. */
20714 && glyph
->face_id
== face_id
20715 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20719 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20720 s
->char2b
+ s
->nchars
,
20722 s
->two_byte_p
= two_byte_p
;
20724 xassert (s
->nchars
<= end
- start
);
20725 s
->width
+= glyph
->pixel_width
;
20726 if (glyph
++->padding_p
!= s
->padding_p
)
20730 s
->font
= s
->face
->font
;
20732 /* If the specified font could not be loaded, use the frame's font,
20733 but record the fact that we couldn't load it in
20734 S->font_not_found_p so that we can draw rectangles for the
20735 characters of the glyph string. */
20736 if (s
->font
== NULL
|| glyph_not_available_p
)
20738 s
->font_not_found_p
= 1;
20739 s
->font
= FRAME_FONT (s
->f
);
20742 /* Adjust base line for subscript/superscript text. */
20743 s
->ybase
+= voffset
;
20745 xassert (s
->face
&& s
->face
->gc
);
20746 return glyph
- s
->row
->glyphs
[s
->area
];
20750 /* Fill glyph string S from image glyph S->first_glyph. */
20753 fill_image_glyph_string (struct glyph_string
*s
)
20755 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20756 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20758 s
->slice
= s
->first_glyph
->slice
.img
;
20759 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20760 s
->font
= s
->face
->font
;
20761 s
->width
= s
->first_glyph
->pixel_width
;
20763 /* Adjust base line for subscript/superscript text. */
20764 s
->ybase
+= s
->first_glyph
->voffset
;
20768 /* Fill glyph string S from a sequence of stretch glyphs.
20770 START is the index of the first glyph to consider,
20771 END is the index of the last + 1.
20773 Value is the index of the first glyph not in S. */
20776 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20778 struct glyph
*glyph
, *last
;
20779 int voffset
, face_id
;
20781 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20783 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20784 last
= s
->row
->glyphs
[s
->area
] + end
;
20785 face_id
= glyph
->face_id
;
20786 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20787 s
->font
= s
->face
->font
;
20788 s
->width
= glyph
->pixel_width
;
20790 voffset
= glyph
->voffset
;
20794 && glyph
->type
== STRETCH_GLYPH
20795 && glyph
->voffset
== voffset
20796 && glyph
->face_id
== face_id
);
20798 s
->width
+= glyph
->pixel_width
;
20800 /* Adjust base line for subscript/superscript text. */
20801 s
->ybase
+= voffset
;
20803 /* The case that face->gc == 0 is handled when drawing the glyph
20804 string by calling PREPARE_FACE_FOR_DISPLAY. */
20806 return glyph
- s
->row
->glyphs
[s
->area
];
20809 static struct font_metrics
*
20810 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20812 static struct font_metrics metrics
;
20813 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20815 if (! font
|| code
== FONT_INVALID_CODE
)
20817 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20822 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20823 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20824 assumed to be zero. */
20827 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20829 *left
= *right
= 0;
20831 if (glyph
->type
== CHAR_GLYPH
)
20835 struct font_metrics
*pcm
;
20837 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20838 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20840 if (pcm
->rbearing
> pcm
->width
)
20841 *right
= pcm
->rbearing
- pcm
->width
;
20842 if (pcm
->lbearing
< 0)
20843 *left
= -pcm
->lbearing
;
20846 else if (glyph
->type
== COMPOSITE_GLYPH
)
20848 if (! glyph
->u
.cmp
.automatic
)
20850 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20852 if (cmp
->rbearing
> cmp
->pixel_width
)
20853 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20854 if (cmp
->lbearing
< 0)
20855 *left
= - cmp
->lbearing
;
20859 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20860 struct font_metrics metrics
;
20862 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20863 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20864 if (metrics
.rbearing
> metrics
.width
)
20865 *right
= metrics
.rbearing
- metrics
.width
;
20866 if (metrics
.lbearing
< 0)
20867 *left
= - metrics
.lbearing
;
20873 /* Return the index of the first glyph preceding glyph string S that
20874 is overwritten by S because of S's left overhang. Value is -1
20875 if no glyphs are overwritten. */
20878 left_overwritten (struct glyph_string
*s
)
20882 if (s
->left_overhang
)
20885 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20886 int first
= s
->first_glyph
- glyphs
;
20888 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20889 x
-= glyphs
[i
].pixel_width
;
20900 /* Return the index of the first glyph preceding glyph string S that
20901 is overwriting S because of its right overhang. Value is -1 if no
20902 glyph in front of S overwrites S. */
20905 left_overwriting (struct glyph_string
*s
)
20908 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20909 int first
= s
->first_glyph
- glyphs
;
20913 for (i
= first
- 1; i
>= 0; --i
)
20916 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20919 x
-= glyphs
[i
].pixel_width
;
20926 /* Return the index of the last glyph following glyph string S that is
20927 overwritten by S because of S's right overhang. Value is -1 if
20928 no such glyph is found. */
20931 right_overwritten (struct glyph_string
*s
)
20935 if (s
->right_overhang
)
20938 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20939 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20940 int end
= s
->row
->used
[s
->area
];
20942 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20943 x
+= glyphs
[i
].pixel_width
;
20952 /* Return the index of the last glyph following glyph string S that
20953 overwrites S because of its left overhang. Value is negative
20954 if no such glyph is found. */
20957 right_overwriting (struct glyph_string
*s
)
20960 int end
= s
->row
->used
[s
->area
];
20961 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20962 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20966 for (i
= first
; i
< end
; ++i
)
20969 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20972 x
+= glyphs
[i
].pixel_width
;
20979 /* Set background width of glyph string S. START is the index of the
20980 first glyph following S. LAST_X is the right-most x-position + 1
20981 in the drawing area. */
20984 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20986 /* If the face of this glyph string has to be drawn to the end of
20987 the drawing area, set S->extends_to_end_of_line_p. */
20989 if (start
== s
->row
->used
[s
->area
]
20990 && s
->area
== TEXT_AREA
20991 && ((s
->row
->fill_line_p
20992 && (s
->hl
== DRAW_NORMAL_TEXT
20993 || s
->hl
== DRAW_IMAGE_RAISED
20994 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20995 || s
->hl
== DRAW_MOUSE_FACE
))
20996 s
->extends_to_end_of_line_p
= 1;
20998 /* If S extends its face to the end of the line, set its
20999 background_width to the distance to the right edge of the drawing
21001 if (s
->extends_to_end_of_line_p
)
21002 s
->background_width
= last_x
- s
->x
+ 1;
21004 s
->background_width
= s
->width
;
21008 /* Compute overhangs and x-positions for glyph string S and its
21009 predecessors, or successors. X is the starting x-position for S.
21010 BACKWARD_P non-zero means process predecessors. */
21013 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21019 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21020 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21030 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21031 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21041 /* The following macros are only called from draw_glyphs below.
21042 They reference the following parameters of that function directly:
21043 `w', `row', `area', and `overlap_p'
21044 as well as the following local variables:
21045 `s', `f', and `hdc' (in W32) */
21048 /* On W32, silently add local `hdc' variable to argument list of
21049 init_glyph_string. */
21050 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21051 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21053 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21054 init_glyph_string (s, char2b, w, row, area, start, hl)
21057 /* Add a glyph string for a stretch glyph to the list of strings
21058 between HEAD and TAIL. START is the index of the stretch glyph in
21059 row area AREA of glyph row ROW. END is the index of the last glyph
21060 in that glyph row area. X is the current output position assigned
21061 to the new glyph string constructed. HL overrides that face of the
21062 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21063 is the right-most x-position of the drawing area. */
21065 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21066 and below -- keep them on one line. */
21067 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21070 s = (struct glyph_string *) alloca (sizeof *s); \
21071 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21072 START = fill_stretch_glyph_string (s, START, END); \
21073 append_glyph_string (&HEAD, &TAIL, s); \
21079 /* Add a glyph string for an image glyph to the list of strings
21080 between HEAD and TAIL. START is the index of the image glyph in
21081 row area AREA of glyph row ROW. END is the index of the last glyph
21082 in that glyph row area. X is the current output position assigned
21083 to the new glyph string constructed. HL overrides that face of the
21084 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21085 is the right-most x-position of the drawing area. */
21087 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21090 s = (struct glyph_string *) alloca (sizeof *s); \
21091 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21092 fill_image_glyph_string (s); \
21093 append_glyph_string (&HEAD, &TAIL, s); \
21100 /* Add a glyph string for a sequence of character glyphs to the list
21101 of strings between HEAD and TAIL. START is the index of the first
21102 glyph in row area AREA of glyph row ROW that is part of the new
21103 glyph string. END is the index of the last glyph in that glyph row
21104 area. X is the current output position assigned to the new glyph
21105 string constructed. HL overrides that face of the glyph; e.g. it
21106 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21107 right-most x-position of the drawing area. */
21109 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21115 face_id = (row)->glyphs[area][START].face_id; \
21117 s = (struct glyph_string *) alloca (sizeof *s); \
21118 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21119 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21120 append_glyph_string (&HEAD, &TAIL, s); \
21122 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21127 /* Add a glyph string for a composite sequence to the list of strings
21128 between HEAD and TAIL. START is the index of the first glyph in
21129 row area AREA of glyph row ROW that is part of the new glyph
21130 string. END is the index of the last glyph in that glyph row area.
21131 X is the current output position assigned to the new glyph string
21132 constructed. HL overrides that face of the glyph; e.g. it is
21133 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21134 x-position of the drawing area. */
21136 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21138 int face_id = (row)->glyphs[area][START].face_id; \
21139 struct face *base_face = FACE_FROM_ID (f, face_id); \
21140 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21141 struct composition *cmp = composition_table[cmp_id]; \
21143 struct glyph_string *first_s IF_LINT (= NULL); \
21146 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21148 /* Make glyph_strings for each glyph sequence that is drawable by \
21149 the same face, and append them to HEAD/TAIL. */ \
21150 for (n = 0; n < cmp->glyph_len;) \
21152 s = (struct glyph_string *) alloca (sizeof *s); \
21153 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21154 append_glyph_string (&(HEAD), &(TAIL), s); \
21160 n = fill_composite_glyph_string (s, base_face, overlaps); \
21168 /* Add a glyph string for a glyph-string sequence to the list of strings
21169 between HEAD and TAIL. */
21171 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21175 Lisp_Object gstring; \
21177 face_id = (row)->glyphs[area][START].face_id; \
21178 gstring = (composition_gstring_from_id \
21179 ((row)->glyphs[area][START].u.cmp.id)); \
21180 s = (struct glyph_string *) alloca (sizeof *s); \
21181 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21182 * LGSTRING_GLYPH_LEN (gstring)); \
21183 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21184 append_glyph_string (&(HEAD), &(TAIL), s); \
21186 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21190 /* Add a glyph string for a sequence of glyphless character's glyphs
21191 to the list of strings between HEAD and TAIL. The meanings of
21192 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21194 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21199 face_id = (row)->glyphs[area][START].face_id; \
21201 s = (struct glyph_string *) alloca (sizeof *s); \
21202 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21203 append_glyph_string (&HEAD, &TAIL, s); \
21205 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21211 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21212 of AREA of glyph row ROW on window W between indices START and END.
21213 HL overrides the face for drawing glyph strings, e.g. it is
21214 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21215 x-positions of the drawing area.
21217 This is an ugly monster macro construct because we must use alloca
21218 to allocate glyph strings (because draw_glyphs can be called
21219 asynchronously). */
21221 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21224 HEAD = TAIL = NULL; \
21225 while (START < END) \
21227 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21228 switch (first_glyph->type) \
21231 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21235 case COMPOSITE_GLYPH: \
21236 if (first_glyph->u.cmp.automatic) \
21237 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21240 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21244 case STRETCH_GLYPH: \
21245 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21249 case IMAGE_GLYPH: \
21250 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21254 case GLYPHLESS_GLYPH: \
21255 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21265 set_glyph_string_background_width (s, START, LAST_X); \
21272 /* Draw glyphs between START and END in AREA of ROW on window W,
21273 starting at x-position X. X is relative to AREA in W. HL is a
21274 face-override with the following meaning:
21276 DRAW_NORMAL_TEXT draw normally
21277 DRAW_CURSOR draw in cursor face
21278 DRAW_MOUSE_FACE draw in mouse face.
21279 DRAW_INVERSE_VIDEO draw in mode line face
21280 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21281 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21283 If OVERLAPS is non-zero, draw only the foreground of characters and
21284 clip to the physical height of ROW. Non-zero value also defines
21285 the overlapping part to be drawn:
21287 OVERLAPS_PRED overlap with preceding rows
21288 OVERLAPS_SUCC overlap with succeeding rows
21289 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21290 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21292 Value is the x-position reached, relative to AREA of W. */
21295 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21296 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21297 enum draw_glyphs_face hl
, int overlaps
)
21299 struct glyph_string
*head
, *tail
;
21300 struct glyph_string
*s
;
21301 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21302 int i
, j
, x_reached
, last_x
, area_left
= 0;
21303 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21306 ALLOCATE_HDC (hdc
, f
);
21308 /* Let's rather be paranoid than getting a SEGV. */
21309 end
= min (end
, row
->used
[area
]);
21310 start
= max (0, start
);
21311 start
= min (end
, start
);
21313 /* Translate X to frame coordinates. Set last_x to the right
21314 end of the drawing area. */
21315 if (row
->full_width_p
)
21317 /* X is relative to the left edge of W, without scroll bars
21319 area_left
= WINDOW_LEFT_EDGE_X (w
);
21320 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21324 area_left
= window_box_left (w
, area
);
21325 last_x
= area_left
+ window_box_width (w
, area
);
21329 /* Build a doubly-linked list of glyph_string structures between
21330 head and tail from what we have to draw. Note that the macro
21331 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21332 the reason we use a separate variable `i'. */
21334 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21336 x_reached
= tail
->x
+ tail
->background_width
;
21340 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21341 the row, redraw some glyphs in front or following the glyph
21342 strings built above. */
21343 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21345 struct glyph_string
*h
, *t
;
21346 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21347 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21348 int check_mouse_face
= 0;
21351 /* If mouse highlighting is on, we may need to draw adjacent
21352 glyphs using mouse-face highlighting. */
21353 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21355 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21357 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21358 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21360 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21362 check_mouse_face
= 1;
21363 mouse_beg_col
= (row
== mouse_beg_row
)
21364 ? hlinfo
->mouse_face_beg_col
: 0;
21365 mouse_end_col
= (row
== mouse_end_row
)
21366 ? hlinfo
->mouse_face_end_col
21367 : row
->used
[TEXT_AREA
];
21371 /* Compute overhangs for all glyph strings. */
21372 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21373 for (s
= head
; s
; s
= s
->next
)
21374 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21376 /* Prepend glyph strings for glyphs in front of the first glyph
21377 string that are overwritten because of the first glyph
21378 string's left overhang. The background of all strings
21379 prepended must be drawn because the first glyph string
21381 i
= left_overwritten (head
);
21384 enum draw_glyphs_face overlap_hl
;
21386 /* If this row contains mouse highlighting, attempt to draw
21387 the overlapped glyphs with the correct highlight. This
21388 code fails if the overlap encompasses more than one glyph
21389 and mouse-highlight spans only some of these glyphs.
21390 However, making it work perfectly involves a lot more
21391 code, and I don't know if the pathological case occurs in
21392 practice, so we'll stick to this for now. --- cyd */
21393 if (check_mouse_face
21394 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21395 overlap_hl
= DRAW_MOUSE_FACE
;
21397 overlap_hl
= DRAW_NORMAL_TEXT
;
21400 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21401 overlap_hl
, dummy_x
, last_x
);
21403 compute_overhangs_and_x (t
, head
->x
, 1);
21404 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21408 /* Prepend glyph strings for glyphs in front of the first glyph
21409 string that overwrite that glyph string because of their
21410 right overhang. For these strings, only the foreground must
21411 be drawn, because it draws over the glyph string at `head'.
21412 The background must not be drawn because this would overwrite
21413 right overhangs of preceding glyphs for which no glyph
21415 i
= left_overwriting (head
);
21418 enum draw_glyphs_face overlap_hl
;
21420 if (check_mouse_face
21421 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21422 overlap_hl
= DRAW_MOUSE_FACE
;
21424 overlap_hl
= DRAW_NORMAL_TEXT
;
21427 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21428 overlap_hl
, dummy_x
, last_x
);
21429 for (s
= h
; s
; s
= s
->next
)
21430 s
->background_filled_p
= 1;
21431 compute_overhangs_and_x (t
, head
->x
, 1);
21432 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21435 /* Append glyphs strings for glyphs following the last glyph
21436 string tail that are overwritten by tail. The background of
21437 these strings has to be drawn because tail's foreground draws
21439 i
= right_overwritten (tail
);
21442 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
;
21450 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21451 overlap_hl
, x
, last_x
);
21452 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21453 we don't have `end = i;' here. */
21454 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21455 append_glyph_string_lists (&head
, &tail
, h
, t
);
21459 /* Append glyph strings for glyphs following the last glyph
21460 string tail that overwrite tail. The foreground of such
21461 glyphs has to be drawn because it writes into the background
21462 of tail. The background must not be drawn because it could
21463 paint over the foreground of following glyphs. */
21464 i
= right_overwriting (tail
);
21467 enum draw_glyphs_face overlap_hl
;
21468 if (check_mouse_face
21469 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21470 overlap_hl
= DRAW_MOUSE_FACE
;
21472 overlap_hl
= DRAW_NORMAL_TEXT
;
21475 i
++; /* We must include the Ith glyph. */
21476 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21477 overlap_hl
, x
, last_x
);
21478 for (s
= h
; s
; s
= s
->next
)
21479 s
->background_filled_p
= 1;
21480 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21481 append_glyph_string_lists (&head
, &tail
, h
, t
);
21483 if (clip_head
|| clip_tail
)
21484 for (s
= head
; s
; s
= s
->next
)
21486 s
->clip_head
= clip_head
;
21487 s
->clip_tail
= clip_tail
;
21491 /* Draw all strings. */
21492 for (s
= head
; s
; s
= s
->next
)
21493 FRAME_RIF (f
)->draw_glyph_string (s
);
21496 /* When focus a sole frame and move horizontally, this sets on_p to 0
21497 causing a failure to erase prev cursor position. */
21498 if (area
== TEXT_AREA
21499 && !row
->full_width_p
21500 /* When drawing overlapping rows, only the glyph strings'
21501 foreground is drawn, which doesn't erase a cursor
21505 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21506 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21507 : (tail
? tail
->x
+ tail
->background_width
: x
));
21511 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21512 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21516 /* Value is the x-position up to which drawn, relative to AREA of W.
21517 This doesn't include parts drawn because of overhangs. */
21518 if (row
->full_width_p
)
21519 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21521 x_reached
-= area_left
;
21523 RELEASE_HDC (hdc
, f
);
21528 /* Expand row matrix if too narrow. Don't expand if area
21531 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21533 if (!fonts_changed_p \
21534 && (it->glyph_row->glyphs[area] \
21535 < it->glyph_row->glyphs[area + 1])) \
21537 it->w->ncols_scale_factor++; \
21538 fonts_changed_p = 1; \
21542 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21543 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21546 append_glyph (struct it
*it
)
21548 struct glyph
*glyph
;
21549 enum glyph_row_area area
= it
->area
;
21551 xassert (it
->glyph_row
);
21552 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21554 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21555 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21557 /* If the glyph row is reversed, we need to prepend the glyph
21558 rather than append it. */
21559 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21563 /* Make room for the additional glyph. */
21564 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21566 glyph
= it
->glyph_row
->glyphs
[area
];
21568 glyph
->charpos
= CHARPOS (it
->position
);
21569 glyph
->object
= it
->object
;
21570 if (it
->pixel_width
> 0)
21572 glyph
->pixel_width
= it
->pixel_width
;
21573 glyph
->padding_p
= 0;
21577 /* Assure at least 1-pixel width. Otherwise, cursor can't
21578 be displayed correctly. */
21579 glyph
->pixel_width
= 1;
21580 glyph
->padding_p
= 1;
21582 glyph
->ascent
= it
->ascent
;
21583 glyph
->descent
= it
->descent
;
21584 glyph
->voffset
= it
->voffset
;
21585 glyph
->type
= CHAR_GLYPH
;
21586 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21587 glyph
->multibyte_p
= it
->multibyte_p
;
21588 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21589 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21590 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21591 || it
->phys_descent
> it
->descent
);
21592 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21593 glyph
->face_id
= it
->face_id
;
21594 glyph
->u
.ch
= it
->char_to_display
;
21595 glyph
->slice
.img
= null_glyph_slice
;
21596 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21599 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21600 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21602 glyph
->bidi_type
= it
->bidi_it
.type
;
21606 glyph
->resolved_level
= 0;
21607 glyph
->bidi_type
= UNKNOWN_BT
;
21609 ++it
->glyph_row
->used
[area
];
21612 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21615 /* Store one glyph for the composition IT->cmp_it.id in
21616 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21620 append_composite_glyph (struct it
*it
)
21622 struct glyph
*glyph
;
21623 enum glyph_row_area area
= it
->area
;
21625 xassert (it
->glyph_row
);
21627 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21628 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21630 /* If the glyph row is reversed, we need to prepend the glyph
21631 rather than append it. */
21632 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21636 /* Make room for the new glyph. */
21637 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21639 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21641 glyph
->charpos
= it
->cmp_it
.charpos
;
21642 glyph
->object
= it
->object
;
21643 glyph
->pixel_width
= it
->pixel_width
;
21644 glyph
->ascent
= it
->ascent
;
21645 glyph
->descent
= it
->descent
;
21646 glyph
->voffset
= it
->voffset
;
21647 glyph
->type
= COMPOSITE_GLYPH
;
21648 if (it
->cmp_it
.ch
< 0)
21650 glyph
->u
.cmp
.automatic
= 0;
21651 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21652 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21656 glyph
->u
.cmp
.automatic
= 1;
21657 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21658 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21659 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21661 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21662 glyph
->multibyte_p
= it
->multibyte_p
;
21663 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21664 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21665 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21666 || it
->phys_descent
> it
->descent
);
21667 glyph
->padding_p
= 0;
21668 glyph
->glyph_not_available_p
= 0;
21669 glyph
->face_id
= it
->face_id
;
21670 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21673 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21674 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21676 glyph
->bidi_type
= it
->bidi_it
.type
;
21678 ++it
->glyph_row
->used
[area
];
21681 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21685 /* Change IT->ascent and IT->height according to the setting of
21689 take_vertical_position_into_account (struct it
*it
)
21693 if (it
->voffset
< 0)
21694 /* Increase the ascent so that we can display the text higher
21696 it
->ascent
-= it
->voffset
;
21698 /* Increase the descent so that we can display the text lower
21700 it
->descent
+= it
->voffset
;
21705 /* Produce glyphs/get display metrics for the image IT is loaded with.
21706 See the description of struct display_iterator in dispextern.h for
21707 an overview of struct display_iterator. */
21710 produce_image_glyph (struct it
*it
)
21714 int glyph_ascent
, crop
;
21715 struct glyph_slice slice
;
21717 xassert (it
->what
== IT_IMAGE
);
21719 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21721 /* Make sure X resources of the face is loaded. */
21722 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21724 if (it
->image_id
< 0)
21726 /* Fringe bitmap. */
21727 it
->ascent
= it
->phys_ascent
= 0;
21728 it
->descent
= it
->phys_descent
= 0;
21729 it
->pixel_width
= 0;
21734 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21736 /* Make sure X resources of the image is loaded. */
21737 prepare_image_for_display (it
->f
, img
);
21739 slice
.x
= slice
.y
= 0;
21740 slice
.width
= img
->width
;
21741 slice
.height
= img
->height
;
21743 if (INTEGERP (it
->slice
.x
))
21744 slice
.x
= XINT (it
->slice
.x
);
21745 else if (FLOATP (it
->slice
.x
))
21746 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21748 if (INTEGERP (it
->slice
.y
))
21749 slice
.y
= XINT (it
->slice
.y
);
21750 else if (FLOATP (it
->slice
.y
))
21751 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21753 if (INTEGERP (it
->slice
.width
))
21754 slice
.width
= XINT (it
->slice
.width
);
21755 else if (FLOATP (it
->slice
.width
))
21756 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21758 if (INTEGERP (it
->slice
.height
))
21759 slice
.height
= XINT (it
->slice
.height
);
21760 else if (FLOATP (it
->slice
.height
))
21761 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21763 if (slice
.x
>= img
->width
)
21764 slice
.x
= img
->width
;
21765 if (slice
.y
>= img
->height
)
21766 slice
.y
= img
->height
;
21767 if (slice
.x
+ slice
.width
>= img
->width
)
21768 slice
.width
= img
->width
- slice
.x
;
21769 if (slice
.y
+ slice
.height
> img
->height
)
21770 slice
.height
= img
->height
- slice
.y
;
21772 if (slice
.width
== 0 || slice
.height
== 0)
21775 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21777 it
->descent
= slice
.height
- glyph_ascent
;
21779 it
->descent
+= img
->vmargin
;
21780 if (slice
.y
+ slice
.height
== img
->height
)
21781 it
->descent
+= img
->vmargin
;
21782 it
->phys_descent
= it
->descent
;
21784 it
->pixel_width
= slice
.width
;
21786 it
->pixel_width
+= img
->hmargin
;
21787 if (slice
.x
+ slice
.width
== img
->width
)
21788 it
->pixel_width
+= img
->hmargin
;
21790 /* It's quite possible for images to have an ascent greater than
21791 their height, so don't get confused in that case. */
21792 if (it
->descent
< 0)
21797 if (face
->box
!= FACE_NO_BOX
)
21799 if (face
->box_line_width
> 0)
21802 it
->ascent
+= face
->box_line_width
;
21803 if (slice
.y
+ slice
.height
== img
->height
)
21804 it
->descent
+= face
->box_line_width
;
21807 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21808 it
->pixel_width
+= eabs (face
->box_line_width
);
21809 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21810 it
->pixel_width
+= eabs (face
->box_line_width
);
21813 take_vertical_position_into_account (it
);
21815 /* Automatically crop wide image glyphs at right edge so we can
21816 draw the cursor on same display row. */
21817 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21818 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21820 it
->pixel_width
-= crop
;
21821 slice
.width
-= crop
;
21826 struct glyph
*glyph
;
21827 enum glyph_row_area area
= it
->area
;
21829 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21830 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21832 glyph
->charpos
= CHARPOS (it
->position
);
21833 glyph
->object
= it
->object
;
21834 glyph
->pixel_width
= it
->pixel_width
;
21835 glyph
->ascent
= glyph_ascent
;
21836 glyph
->descent
= it
->descent
;
21837 glyph
->voffset
= it
->voffset
;
21838 glyph
->type
= IMAGE_GLYPH
;
21839 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21840 glyph
->multibyte_p
= it
->multibyte_p
;
21841 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21842 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21843 glyph
->overlaps_vertically_p
= 0;
21844 glyph
->padding_p
= 0;
21845 glyph
->glyph_not_available_p
= 0;
21846 glyph
->face_id
= it
->face_id
;
21847 glyph
->u
.img_id
= img
->id
;
21848 glyph
->slice
.img
= slice
;
21849 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21852 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21853 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21855 glyph
->bidi_type
= it
->bidi_it
.type
;
21857 ++it
->glyph_row
->used
[area
];
21860 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21865 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21866 of the glyph, WIDTH and HEIGHT are the width and height of the
21867 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21870 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21871 int width
, int height
, int ascent
)
21873 struct glyph
*glyph
;
21874 enum glyph_row_area area
= it
->area
;
21876 xassert (ascent
>= 0 && ascent
<= height
);
21878 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21879 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21881 /* If the glyph row is reversed, we need to prepend the glyph
21882 rather than append it. */
21883 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21887 /* Make room for the additional glyph. */
21888 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21890 glyph
= it
->glyph_row
->glyphs
[area
];
21892 glyph
->charpos
= CHARPOS (it
->position
);
21893 glyph
->object
= object
;
21894 glyph
->pixel_width
= width
;
21895 glyph
->ascent
= ascent
;
21896 glyph
->descent
= height
- ascent
;
21897 glyph
->voffset
= it
->voffset
;
21898 glyph
->type
= STRETCH_GLYPH
;
21899 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21900 glyph
->multibyte_p
= it
->multibyte_p
;
21901 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21902 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21903 glyph
->overlaps_vertically_p
= 0;
21904 glyph
->padding_p
= 0;
21905 glyph
->glyph_not_available_p
= 0;
21906 glyph
->face_id
= it
->face_id
;
21907 glyph
->u
.stretch
.ascent
= ascent
;
21908 glyph
->u
.stretch
.height
= height
;
21909 glyph
->slice
.img
= null_glyph_slice
;
21910 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21913 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21914 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21916 glyph
->bidi_type
= it
->bidi_it
.type
;
21920 glyph
->resolved_level
= 0;
21921 glyph
->bidi_type
= UNKNOWN_BT
;
21923 ++it
->glyph_row
->used
[area
];
21926 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21930 /* Produce a stretch glyph for iterator IT. IT->object is the value
21931 of the glyph property displayed. The value must be a list
21932 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21935 1. `:width WIDTH' specifies that the space should be WIDTH *
21936 canonical char width wide. WIDTH may be an integer or floating
21939 2. `:relative-width FACTOR' specifies that the width of the stretch
21940 should be computed from the width of the first character having the
21941 `glyph' property, and should be FACTOR times that width.
21943 3. `:align-to HPOS' specifies that the space should be wide enough
21944 to reach HPOS, a value in canonical character units.
21946 Exactly one of the above pairs must be present.
21948 4. `:height HEIGHT' specifies that the height of the stretch produced
21949 should be HEIGHT, measured in canonical character units.
21951 5. `:relative-height FACTOR' specifies that the height of the
21952 stretch should be FACTOR times the height of the characters having
21953 the glyph property.
21955 Either none or exactly one of 4 or 5 must be present.
21957 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21958 of the stretch should be used for the ascent of the stretch.
21959 ASCENT must be in the range 0 <= ASCENT <= 100. */
21962 produce_stretch_glyph (struct it
*it
)
21964 /* (space :width WIDTH :height HEIGHT ...) */
21965 Lisp_Object prop
, plist
;
21966 int width
= 0, height
= 0, align_to
= -1;
21967 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21970 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21971 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21973 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21975 /* List should start with `space'. */
21976 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21977 plist
= XCDR (it
->object
);
21979 /* Compute the width of the stretch. */
21980 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21981 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21983 /* Absolute width `:width WIDTH' specified and valid. */
21984 zero_width_ok_p
= 1;
21987 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21990 /* Relative width `:relative-width FACTOR' specified and valid.
21991 Compute the width of the characters having the `glyph'
21994 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21997 if (it
->multibyte_p
)
21998 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22001 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22002 if (! ASCII_CHAR_P (it2
.c
))
22003 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22006 it2
.glyph_row
= NULL
;
22007 it2
.what
= IT_CHARACTER
;
22008 x_produce_glyphs (&it2
);
22009 width
= NUMVAL (prop
) * it2
.pixel_width
;
22011 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22012 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22014 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22015 align_to
= (align_to
< 0
22017 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22018 else if (align_to
< 0)
22019 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22020 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22021 zero_width_ok_p
= 1;
22024 /* Nothing specified -> width defaults to canonical char width. */
22025 width
= FRAME_COLUMN_WIDTH (it
->f
);
22027 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22030 /* Compute height. */
22031 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22032 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22035 zero_height_ok_p
= 1;
22037 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22039 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22041 height
= FONT_HEIGHT (font
);
22043 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22046 /* Compute percentage of height used for ascent. If
22047 `:ascent ASCENT' is present and valid, use that. Otherwise,
22048 derive the ascent from the font in use. */
22049 if (prop
= Fplist_get (plist
, QCascent
),
22050 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22051 ascent
= height
* NUMVAL (prop
) / 100.0;
22052 else if (!NILP (prop
)
22053 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22054 ascent
= min (max (0, (int)tem
), height
);
22056 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22058 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22059 && it
->current_x
+ width
> it
->last_visible_x
)
22060 width
= it
->last_visible_x
- it
->current_x
- 1;
22062 if (width
> 0 && height
> 0 && it
->glyph_row
)
22064 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22065 if (!STRINGP (object
))
22066 object
= it
->w
->buffer
;
22067 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22070 it
->pixel_width
= width
;
22071 it
->ascent
= it
->phys_ascent
= ascent
;
22072 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22073 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22075 take_vertical_position_into_account (it
);
22078 /* Calculate line-height and line-spacing properties.
22079 An integer value specifies explicit pixel value.
22080 A float value specifies relative value to current face height.
22081 A cons (float . face-name) specifies relative value to
22082 height of specified face font.
22084 Returns height in pixels, or nil. */
22088 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22089 int boff
, int override
)
22091 Lisp_Object face_name
= Qnil
;
22092 int ascent
, descent
, height
;
22094 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22099 face_name
= XCAR (val
);
22101 if (!NUMBERP (val
))
22102 val
= make_number (1);
22103 if (NILP (face_name
))
22105 height
= it
->ascent
+ it
->descent
;
22110 if (NILP (face_name
))
22112 font
= FRAME_FONT (it
->f
);
22113 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22115 else if (EQ (face_name
, Qt
))
22124 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22126 return make_number (-1);
22128 face
= FACE_FROM_ID (it
->f
, face_id
);
22131 return make_number (-1);
22132 boff
= font
->baseline_offset
;
22133 if (font
->vertical_centering
)
22134 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22137 ascent
= FONT_BASE (font
) + boff
;
22138 descent
= FONT_DESCENT (font
) - boff
;
22142 it
->override_ascent
= ascent
;
22143 it
->override_descent
= descent
;
22144 it
->override_boff
= boff
;
22147 height
= ascent
+ descent
;
22151 height
= (int)(XFLOAT_DATA (val
) * height
);
22152 else if (INTEGERP (val
))
22153 height
*= XINT (val
);
22155 return make_number (height
);
22159 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22160 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22161 and only if this is for a character for which no font was found.
22163 If the display method (it->glyphless_method) is
22164 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22165 length of the acronym or the hexadecimal string, UPPER_XOFF and
22166 UPPER_YOFF are pixel offsets for the upper part of the string,
22167 LOWER_XOFF and LOWER_YOFF are for the lower part.
22169 For the other display methods, LEN through LOWER_YOFF are zero. */
22172 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22173 short upper_xoff
, short upper_yoff
,
22174 short lower_xoff
, short lower_yoff
)
22176 struct glyph
*glyph
;
22177 enum glyph_row_area area
= it
->area
;
22179 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22180 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22182 /* If the glyph row is reversed, we need to prepend the glyph
22183 rather than append it. */
22184 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22188 /* Make room for the additional glyph. */
22189 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22191 glyph
= it
->glyph_row
->glyphs
[area
];
22193 glyph
->charpos
= CHARPOS (it
->position
);
22194 glyph
->object
= it
->object
;
22195 glyph
->pixel_width
= it
->pixel_width
;
22196 glyph
->ascent
= it
->ascent
;
22197 glyph
->descent
= it
->descent
;
22198 glyph
->voffset
= it
->voffset
;
22199 glyph
->type
= GLYPHLESS_GLYPH
;
22200 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22201 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22202 glyph
->u
.glyphless
.len
= len
;
22203 glyph
->u
.glyphless
.ch
= it
->c
;
22204 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22205 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22206 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22207 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22208 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22209 glyph
->multibyte_p
= it
->multibyte_p
;
22210 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22211 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22212 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22213 || it
->phys_descent
> it
->descent
);
22214 glyph
->padding_p
= 0;
22215 glyph
->glyph_not_available_p
= 0;
22216 glyph
->face_id
= face_id
;
22217 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22220 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22221 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22223 glyph
->bidi_type
= it
->bidi_it
.type
;
22225 ++it
->glyph_row
->used
[area
];
22228 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22232 /* Produce a glyph for a glyphless character for iterator IT.
22233 IT->glyphless_method specifies which method to use for displaying
22234 the character. See the description of enum
22235 glyphless_display_method in dispextern.h for the detail.
22237 FOR_NO_FONT is nonzero if and only if this is for a character for
22238 which no font was found. ACRONYM, if non-nil, is an acronym string
22239 for the character. */
22242 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22247 int base_width
, base_height
, width
, height
;
22248 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22251 /* Get the metrics of the base font. We always refer to the current
22253 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22254 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22255 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22256 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22257 base_height
= it
->ascent
+ it
->descent
;
22258 base_width
= font
->average_width
;
22260 /* Get a face ID for the glyph by utilizing a cache (the same way as
22261 doen for `escape-glyph' in get_next_display_element). */
22262 if (it
->f
== last_glyphless_glyph_frame
22263 && it
->face_id
== last_glyphless_glyph_face_id
)
22265 face_id
= last_glyphless_glyph_merged_face_id
;
22269 /* Merge the `glyphless-char' face into the current face. */
22270 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22271 last_glyphless_glyph_frame
= it
->f
;
22272 last_glyphless_glyph_face_id
= it
->face_id
;
22273 last_glyphless_glyph_merged_face_id
= face_id
;
22276 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22278 it
->pixel_width
= THIN_SPACE_WIDTH
;
22280 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22282 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22284 width
= CHAR_WIDTH (it
->c
);
22287 else if (width
> 4)
22289 it
->pixel_width
= base_width
* width
;
22291 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22297 unsigned int code
[6];
22299 int ascent
, descent
;
22300 struct font_metrics metrics_upper
, metrics_lower
;
22302 face
= FACE_FROM_ID (it
->f
, face_id
);
22303 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22304 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22306 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22308 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22309 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22310 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22314 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22315 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22318 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22319 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22320 upper_len
= (len
+ 1) / 2;
22321 font
->driver
->text_extents (font
, code
, upper_len
,
22323 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22328 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22329 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22330 upper_xoff
= upper_yoff
= 2; /* the typical case */
22331 if (base_width
>= width
)
22333 /* Align the upper to the left, the lower to the right. */
22334 it
->pixel_width
= base_width
;
22335 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22339 /* Center the shorter one. */
22340 it
->pixel_width
= width
;
22341 if (metrics_upper
.width
>= metrics_lower
.width
)
22342 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22345 /* FIXME: This code doesn't look right. It formerly was
22346 missing the "lower_xoff = 0;", which couldn't have
22347 been right since it left lower_xoff uninitialized. */
22349 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22353 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22354 top, bottom, and between upper and lower strings. */
22355 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22356 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22357 /* Center vertically.
22358 H:base_height, D:base_descent
22359 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22361 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22362 descent = D - H/2 + h/2;
22363 lower_yoff = descent - 2 - ld;
22364 upper_yoff = lower_yoff - la - 1 - ud; */
22365 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22366 descent
= it
->descent
- (base_height
- height
) / 2;
22367 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22368 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22369 - metrics_upper
.descent
);
22370 /* Don't make the height shorter than the base height. */
22371 if (height
> base_height
)
22373 it
->ascent
= ascent
;
22374 it
->descent
= descent
;
22378 it
->phys_ascent
= it
->ascent
;
22379 it
->phys_descent
= it
->descent
;
22381 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22382 upper_xoff
, upper_yoff
,
22383 lower_xoff
, lower_yoff
);
22385 take_vertical_position_into_account (it
);
22390 Produce glyphs/get display metrics for the display element IT is
22391 loaded with. See the description of struct it in dispextern.h
22392 for an overview of struct it. */
22395 x_produce_glyphs (struct it
*it
)
22397 int extra_line_spacing
= it
->extra_line_spacing
;
22399 it
->glyph_not_available_p
= 0;
22401 if (it
->what
== IT_CHARACTER
)
22404 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22405 struct font
*font
= face
->font
;
22406 struct font_metrics
*pcm
= NULL
;
22407 int boff
; /* baseline offset */
22411 /* When no suitable font is found, display this character by
22412 the method specified in the first extra slot of
22413 Vglyphless_char_display. */
22414 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22416 xassert (it
->what
== IT_GLYPHLESS
);
22417 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22421 boff
= font
->baseline_offset
;
22422 if (font
->vertical_centering
)
22423 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22425 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22431 if (it
->override_ascent
>= 0)
22433 it
->ascent
= it
->override_ascent
;
22434 it
->descent
= it
->override_descent
;
22435 boff
= it
->override_boff
;
22439 it
->ascent
= FONT_BASE (font
) + boff
;
22440 it
->descent
= FONT_DESCENT (font
) - boff
;
22443 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22445 pcm
= get_per_char_metric (font
, &char2b
);
22446 if (pcm
->width
== 0
22447 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22453 it
->phys_ascent
= pcm
->ascent
+ boff
;
22454 it
->phys_descent
= pcm
->descent
- boff
;
22455 it
->pixel_width
= pcm
->width
;
22459 it
->glyph_not_available_p
= 1;
22460 it
->phys_ascent
= it
->ascent
;
22461 it
->phys_descent
= it
->descent
;
22462 it
->pixel_width
= font
->space_width
;
22465 if (it
->constrain_row_ascent_descent_p
)
22467 if (it
->descent
> it
->max_descent
)
22469 it
->ascent
+= it
->descent
- it
->max_descent
;
22470 it
->descent
= it
->max_descent
;
22472 if (it
->ascent
> it
->max_ascent
)
22474 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22475 it
->ascent
= it
->max_ascent
;
22477 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22478 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22479 extra_line_spacing
= 0;
22482 /* If this is a space inside a region of text with
22483 `space-width' property, change its width. */
22484 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22486 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22488 /* If face has a box, add the box thickness to the character
22489 height. If character has a box line to the left and/or
22490 right, add the box line width to the character's width. */
22491 if (face
->box
!= FACE_NO_BOX
)
22493 int thick
= face
->box_line_width
;
22497 it
->ascent
+= thick
;
22498 it
->descent
+= thick
;
22503 if (it
->start_of_box_run_p
)
22504 it
->pixel_width
+= thick
;
22505 if (it
->end_of_box_run_p
)
22506 it
->pixel_width
+= thick
;
22509 /* If face has an overline, add the height of the overline
22510 (1 pixel) and a 1 pixel margin to the character height. */
22511 if (face
->overline_p
)
22512 it
->ascent
+= overline_margin
;
22514 if (it
->constrain_row_ascent_descent_p
)
22516 if (it
->ascent
> it
->max_ascent
)
22517 it
->ascent
= it
->max_ascent
;
22518 if (it
->descent
> it
->max_descent
)
22519 it
->descent
= it
->max_descent
;
22522 take_vertical_position_into_account (it
);
22524 /* If we have to actually produce glyphs, do it. */
22529 /* Translate a space with a `space-width' property
22530 into a stretch glyph. */
22531 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22532 / FONT_HEIGHT (font
));
22533 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22534 it
->ascent
+ it
->descent
, ascent
);
22539 /* If characters with lbearing or rbearing are displayed
22540 in this line, record that fact in a flag of the
22541 glyph row. This is used to optimize X output code. */
22542 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22543 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22545 if (! stretched_p
&& it
->pixel_width
== 0)
22546 /* We assure that all visible glyphs have at least 1-pixel
22548 it
->pixel_width
= 1;
22550 else if (it
->char_to_display
== '\n')
22552 /* A newline has no width, but we need the height of the
22553 line. But if previous part of the line sets a height,
22554 don't increase that height */
22556 Lisp_Object height
;
22557 Lisp_Object total_height
= Qnil
;
22559 it
->override_ascent
= -1;
22560 it
->pixel_width
= 0;
22563 height
= get_it_property (it
, Qline_height
);
22564 /* Split (line-height total-height) list */
22566 && CONSP (XCDR (height
))
22567 && NILP (XCDR (XCDR (height
))))
22569 total_height
= XCAR (XCDR (height
));
22570 height
= XCAR (height
);
22572 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22574 if (it
->override_ascent
>= 0)
22576 it
->ascent
= it
->override_ascent
;
22577 it
->descent
= it
->override_descent
;
22578 boff
= it
->override_boff
;
22582 it
->ascent
= FONT_BASE (font
) + boff
;
22583 it
->descent
= FONT_DESCENT (font
) - boff
;
22586 if (EQ (height
, Qt
))
22588 if (it
->descent
> it
->max_descent
)
22590 it
->ascent
+= it
->descent
- it
->max_descent
;
22591 it
->descent
= it
->max_descent
;
22593 if (it
->ascent
> it
->max_ascent
)
22595 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22596 it
->ascent
= it
->max_ascent
;
22598 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22599 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22600 it
->constrain_row_ascent_descent_p
= 1;
22601 extra_line_spacing
= 0;
22605 Lisp_Object spacing
;
22607 it
->phys_ascent
= it
->ascent
;
22608 it
->phys_descent
= it
->descent
;
22610 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22611 && face
->box
!= FACE_NO_BOX
22612 && face
->box_line_width
> 0)
22614 it
->ascent
+= face
->box_line_width
;
22615 it
->descent
+= face
->box_line_width
;
22618 && XINT (height
) > it
->ascent
+ it
->descent
)
22619 it
->ascent
= XINT (height
) - it
->descent
;
22621 if (!NILP (total_height
))
22622 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22625 spacing
= get_it_property (it
, Qline_spacing
);
22626 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22628 if (INTEGERP (spacing
))
22630 extra_line_spacing
= XINT (spacing
);
22631 if (!NILP (total_height
))
22632 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22636 else /* i.e. (it->char_to_display == '\t') */
22638 if (font
->space_width
> 0)
22640 int tab_width
= it
->tab_width
* font
->space_width
;
22641 int x
= it
->current_x
+ it
->continuation_lines_width
;
22642 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22644 /* If the distance from the current position to the next tab
22645 stop is less than a space character width, use the
22646 tab stop after that. */
22647 if (next_tab_x
- x
< font
->space_width
)
22648 next_tab_x
+= tab_width
;
22650 it
->pixel_width
= next_tab_x
- x
;
22652 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22653 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22657 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22658 it
->ascent
+ it
->descent
, it
->ascent
);
22663 it
->pixel_width
= 0;
22668 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22670 /* A static composition.
22672 Note: A composition is represented as one glyph in the
22673 glyph matrix. There are no padding glyphs.
22675 Important note: pixel_width, ascent, and descent are the
22676 values of what is drawn by draw_glyphs (i.e. the values of
22677 the overall glyphs composed). */
22678 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22679 int boff
; /* baseline offset */
22680 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22681 int glyph_len
= cmp
->glyph_len
;
22682 struct font
*font
= face
->font
;
22686 /* If we have not yet calculated pixel size data of glyphs of
22687 the composition for the current face font, calculate them
22688 now. Theoretically, we have to check all fonts for the
22689 glyphs, but that requires much time and memory space. So,
22690 here we check only the font of the first glyph. This may
22691 lead to incorrect display, but it's very rare, and C-l
22692 (recenter-top-bottom) can correct the display anyway. */
22693 if (! cmp
->font
|| cmp
->font
!= font
)
22695 /* Ascent and descent of the font of the first character
22696 of this composition (adjusted by baseline offset).
22697 Ascent and descent of overall glyphs should not be less
22698 than these, respectively. */
22699 int font_ascent
, font_descent
, font_height
;
22700 /* Bounding box of the overall glyphs. */
22701 int leftmost
, rightmost
, lowest
, highest
;
22702 int lbearing
, rbearing
;
22703 int i
, width
, ascent
, descent
;
22704 int left_padded
= 0, right_padded
= 0;
22707 struct font_metrics
*pcm
;
22708 int font_not_found_p
;
22711 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22712 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22714 if (glyph_len
< cmp
->glyph_len
)
22716 for (i
= 0; i
< glyph_len
; i
++)
22718 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22720 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22725 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22726 : IT_CHARPOS (*it
));
22727 /* If no suitable font is found, use the default font. */
22728 font_not_found_p
= font
== NULL
;
22729 if (font_not_found_p
)
22731 face
= face
->ascii_face
;
22734 boff
= font
->baseline_offset
;
22735 if (font
->vertical_centering
)
22736 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22737 font_ascent
= FONT_BASE (font
) + boff
;
22738 font_descent
= FONT_DESCENT (font
) - boff
;
22739 font_height
= FONT_HEIGHT (font
);
22741 cmp
->font
= (void *) font
;
22744 if (! font_not_found_p
)
22746 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22748 pcm
= get_per_char_metric (font
, &char2b
);
22751 /* Initialize the bounding box. */
22754 width
= pcm
->width
;
22755 ascent
= pcm
->ascent
;
22756 descent
= pcm
->descent
;
22757 lbearing
= pcm
->lbearing
;
22758 rbearing
= pcm
->rbearing
;
22762 width
= font
->space_width
;
22763 ascent
= FONT_BASE (font
);
22764 descent
= FONT_DESCENT (font
);
22771 lowest
= - descent
+ boff
;
22772 highest
= ascent
+ boff
;
22774 if (! font_not_found_p
22775 && font
->default_ascent
22776 && CHAR_TABLE_P (Vuse_default_ascent
)
22777 && !NILP (Faref (Vuse_default_ascent
,
22778 make_number (it
->char_to_display
))))
22779 highest
= font
->default_ascent
+ boff
;
22781 /* Draw the first glyph at the normal position. It may be
22782 shifted to right later if some other glyphs are drawn
22784 cmp
->offsets
[i
* 2] = 0;
22785 cmp
->offsets
[i
* 2 + 1] = boff
;
22786 cmp
->lbearing
= lbearing
;
22787 cmp
->rbearing
= rbearing
;
22789 /* Set cmp->offsets for the remaining glyphs. */
22790 for (i
++; i
< glyph_len
; i
++)
22792 int left
, right
, btm
, top
;
22793 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22795 struct face
*this_face
;
22799 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22800 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22801 font
= this_face
->font
;
22807 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22809 pcm
= get_per_char_metric (font
, &char2b
);
22812 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22815 width
= pcm
->width
;
22816 ascent
= pcm
->ascent
;
22817 descent
= pcm
->descent
;
22818 lbearing
= pcm
->lbearing
;
22819 rbearing
= pcm
->rbearing
;
22820 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22822 /* Relative composition with or without
22823 alternate chars. */
22824 left
= (leftmost
+ rightmost
- width
) / 2;
22825 btm
= - descent
+ boff
;
22826 if (font
->relative_compose
22827 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22828 || NILP (Faref (Vignore_relative_composition
,
22829 make_number (ch
)))))
22832 if (- descent
>= font
->relative_compose
)
22833 /* One extra pixel between two glyphs. */
22835 else if (ascent
<= 0)
22836 /* One extra pixel between two glyphs. */
22837 btm
= lowest
- 1 - ascent
- descent
;
22842 /* A composition rule is specified by an integer
22843 value that encodes global and new reference
22844 points (GREF and NREF). GREF and NREF are
22845 specified by numbers as below:
22847 0---1---2 -- ascent
22851 9--10--11 -- center
22853 ---3---4---5--- baseline
22855 6---7---8 -- descent
22857 int rule
= COMPOSITION_RULE (cmp
, i
);
22858 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22860 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22861 grefx
= gref
% 3, nrefx
= nref
% 3;
22862 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22864 xoff
= font_height
* (xoff
- 128) / 256;
22866 yoff
= font_height
* (yoff
- 128) / 256;
22869 + grefx
* (rightmost
- leftmost
) / 2
22870 - nrefx
* width
/ 2
22873 btm
= ((grefy
== 0 ? highest
22875 : grefy
== 2 ? lowest
22876 : (highest
+ lowest
) / 2)
22877 - (nrefy
== 0 ? ascent
+ descent
22878 : nrefy
== 1 ? descent
- boff
22880 : (ascent
+ descent
) / 2)
22884 cmp
->offsets
[i
* 2] = left
;
22885 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22887 /* Update the bounding box of the overall glyphs. */
22890 right
= left
+ width
;
22891 if (left
< leftmost
)
22893 if (right
> rightmost
)
22896 top
= btm
+ descent
+ ascent
;
22902 if (cmp
->lbearing
> left
+ lbearing
)
22903 cmp
->lbearing
= left
+ lbearing
;
22904 if (cmp
->rbearing
< left
+ rbearing
)
22905 cmp
->rbearing
= left
+ rbearing
;
22909 /* If there are glyphs whose x-offsets are negative,
22910 shift all glyphs to the right and make all x-offsets
22914 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22915 cmp
->offsets
[i
* 2] -= leftmost
;
22916 rightmost
-= leftmost
;
22917 cmp
->lbearing
-= leftmost
;
22918 cmp
->rbearing
-= leftmost
;
22921 if (left_padded
&& cmp
->lbearing
< 0)
22923 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22924 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22925 rightmost
-= cmp
->lbearing
;
22926 cmp
->rbearing
-= cmp
->lbearing
;
22929 if (right_padded
&& rightmost
< cmp
->rbearing
)
22931 rightmost
= cmp
->rbearing
;
22934 cmp
->pixel_width
= rightmost
;
22935 cmp
->ascent
= highest
;
22936 cmp
->descent
= - lowest
;
22937 if (cmp
->ascent
< font_ascent
)
22938 cmp
->ascent
= font_ascent
;
22939 if (cmp
->descent
< font_descent
)
22940 cmp
->descent
= font_descent
;
22944 && (cmp
->lbearing
< 0
22945 || cmp
->rbearing
> cmp
->pixel_width
))
22946 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22948 it
->pixel_width
= cmp
->pixel_width
;
22949 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22950 it
->descent
= it
->phys_descent
= cmp
->descent
;
22951 if (face
->box
!= FACE_NO_BOX
)
22953 int thick
= face
->box_line_width
;
22957 it
->ascent
+= thick
;
22958 it
->descent
+= thick
;
22963 if (it
->start_of_box_run_p
)
22964 it
->pixel_width
+= thick
;
22965 if (it
->end_of_box_run_p
)
22966 it
->pixel_width
+= thick
;
22969 /* If face has an overline, add the height of the overline
22970 (1 pixel) and a 1 pixel margin to the character height. */
22971 if (face
->overline_p
)
22972 it
->ascent
+= overline_margin
;
22974 take_vertical_position_into_account (it
);
22975 if (it
->ascent
< 0)
22977 if (it
->descent
< 0)
22981 append_composite_glyph (it
);
22983 else if (it
->what
== IT_COMPOSITION
)
22985 /* A dynamic (automatic) composition. */
22986 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22987 Lisp_Object gstring
;
22988 struct font_metrics metrics
;
22990 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22992 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22995 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22996 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22997 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22998 it
->descent
= it
->phys_descent
= metrics
.descent
;
22999 if (face
->box
!= FACE_NO_BOX
)
23001 int thick
= face
->box_line_width
;
23005 it
->ascent
+= thick
;
23006 it
->descent
+= thick
;
23011 if (it
->start_of_box_run_p
)
23012 it
->pixel_width
+= thick
;
23013 if (it
->end_of_box_run_p
)
23014 it
->pixel_width
+= thick
;
23016 /* If face has an overline, add the height of the overline
23017 (1 pixel) and a 1 pixel margin to the character height. */
23018 if (face
->overline_p
)
23019 it
->ascent
+= overline_margin
;
23020 take_vertical_position_into_account (it
);
23021 if (it
->ascent
< 0)
23023 if (it
->descent
< 0)
23027 append_composite_glyph (it
);
23029 else if (it
->what
== IT_GLYPHLESS
)
23030 produce_glyphless_glyph (it
, 0, Qnil
);
23031 else if (it
->what
== IT_IMAGE
)
23032 produce_image_glyph (it
);
23033 else if (it
->what
== IT_STRETCH
)
23034 produce_stretch_glyph (it
);
23037 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23038 because this isn't true for images with `:ascent 100'. */
23039 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23040 if (it
->area
== TEXT_AREA
)
23041 it
->current_x
+= it
->pixel_width
;
23043 if (extra_line_spacing
> 0)
23045 it
->descent
+= extra_line_spacing
;
23046 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23047 it
->max_extra_line_spacing
= extra_line_spacing
;
23050 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23051 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23052 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23053 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23057 Output LEN glyphs starting at START at the nominal cursor position.
23058 Advance the nominal cursor over the text. The global variable
23059 updated_window contains the window being updated, updated_row is
23060 the glyph row being updated, and updated_area is the area of that
23061 row being updated. */
23064 x_write_glyphs (struct glyph
*start
, int len
)
23068 xassert (updated_window
&& updated_row
);
23071 /* Write glyphs. */
23073 hpos
= start
- updated_row
->glyphs
[updated_area
];
23074 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23075 updated_row
, updated_area
,
23077 DRAW_NORMAL_TEXT
, 0);
23079 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23080 if (updated_area
== TEXT_AREA
23081 && updated_window
->phys_cursor_on_p
23082 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23083 && updated_window
->phys_cursor
.hpos
>= hpos
23084 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23085 updated_window
->phys_cursor_on_p
= 0;
23089 /* Advance the output cursor. */
23090 output_cursor
.hpos
+= len
;
23091 output_cursor
.x
= x
;
23096 Insert LEN glyphs from START at the nominal cursor position. */
23099 x_insert_glyphs (struct glyph
*start
, int len
)
23103 int line_height
, shift_by_width
, shifted_region_width
;
23104 struct glyph_row
*row
;
23105 struct glyph
*glyph
;
23106 int frame_x
, frame_y
;
23109 xassert (updated_window
&& updated_row
);
23111 w
= updated_window
;
23112 f
= XFRAME (WINDOW_FRAME (w
));
23114 /* Get the height of the line we are in. */
23116 line_height
= row
->height
;
23118 /* Get the width of the glyphs to insert. */
23119 shift_by_width
= 0;
23120 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23121 shift_by_width
+= glyph
->pixel_width
;
23123 /* Get the width of the region to shift right. */
23124 shifted_region_width
= (window_box_width (w
, updated_area
)
23129 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23130 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23132 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23133 line_height
, shift_by_width
);
23135 /* Write the glyphs. */
23136 hpos
= start
- row
->glyphs
[updated_area
];
23137 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23139 DRAW_NORMAL_TEXT
, 0);
23141 /* Advance the output cursor. */
23142 output_cursor
.hpos
+= len
;
23143 output_cursor
.x
+= shift_by_width
;
23149 Erase the current text line from the nominal cursor position
23150 (inclusive) to pixel column TO_X (exclusive). The idea is that
23151 everything from TO_X onward is already erased.
23153 TO_X is a pixel position relative to updated_area of
23154 updated_window. TO_X == -1 means clear to the end of this area. */
23157 x_clear_end_of_line (int to_x
)
23160 struct window
*w
= updated_window
;
23161 int max_x
, min_y
, max_y
;
23162 int from_x
, from_y
, to_y
;
23164 xassert (updated_window
&& updated_row
);
23165 f
= XFRAME (w
->frame
);
23167 if (updated_row
->full_width_p
)
23168 max_x
= WINDOW_TOTAL_WIDTH (w
);
23170 max_x
= window_box_width (w
, updated_area
);
23171 max_y
= window_text_bottom_y (w
);
23173 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23174 of window. For TO_X > 0, truncate to end of drawing area. */
23180 to_x
= min (to_x
, max_x
);
23182 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23184 /* Notice if the cursor will be cleared by this operation. */
23185 if (!updated_row
->full_width_p
)
23186 notice_overwritten_cursor (w
, updated_area
,
23187 output_cursor
.x
, -1,
23189 MATRIX_ROW_BOTTOM_Y (updated_row
));
23191 from_x
= output_cursor
.x
;
23193 /* Translate to frame coordinates. */
23194 if (updated_row
->full_width_p
)
23196 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23197 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23201 int area_left
= window_box_left (w
, updated_area
);
23202 from_x
+= area_left
;
23206 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23207 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23208 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23210 /* Prevent inadvertently clearing to end of the X window. */
23211 if (to_x
> from_x
&& to_y
> from_y
)
23214 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23215 to_x
- from_x
, to_y
- from_y
);
23220 #endif /* HAVE_WINDOW_SYSTEM */
23224 /***********************************************************************
23226 ***********************************************************************/
23228 /* Value is the internal representation of the specified cursor type
23229 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23230 of the bar cursor. */
23232 static enum text_cursor_kinds
23233 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23235 enum text_cursor_kinds type
;
23240 if (EQ (arg
, Qbox
))
23241 return FILLED_BOX_CURSOR
;
23243 if (EQ (arg
, Qhollow
))
23244 return HOLLOW_BOX_CURSOR
;
23246 if (EQ (arg
, Qbar
))
23253 && EQ (XCAR (arg
), Qbar
)
23254 && INTEGERP (XCDR (arg
))
23255 && XINT (XCDR (arg
)) >= 0)
23257 *width
= XINT (XCDR (arg
));
23261 if (EQ (arg
, Qhbar
))
23264 return HBAR_CURSOR
;
23268 && EQ (XCAR (arg
), Qhbar
)
23269 && INTEGERP (XCDR (arg
))
23270 && XINT (XCDR (arg
)) >= 0)
23272 *width
= XINT (XCDR (arg
));
23273 return HBAR_CURSOR
;
23276 /* Treat anything unknown as "hollow box cursor".
23277 It was bad to signal an error; people have trouble fixing
23278 .Xdefaults with Emacs, when it has something bad in it. */
23279 type
= HOLLOW_BOX_CURSOR
;
23284 /* Set the default cursor types for specified frame. */
23286 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23291 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23292 FRAME_CURSOR_WIDTH (f
) = width
;
23294 /* By default, set up the blink-off state depending on the on-state. */
23296 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23299 FRAME_BLINK_OFF_CURSOR (f
)
23300 = get_specified_cursor_type (XCDR (tem
), &width
);
23301 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23304 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23308 #ifdef HAVE_WINDOW_SYSTEM
23310 /* Return the cursor we want to be displayed in window W. Return
23311 width of bar/hbar cursor through WIDTH arg. Return with
23312 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23313 (i.e. if the `system caret' should track this cursor).
23315 In a mini-buffer window, we want the cursor only to appear if we
23316 are reading input from this window. For the selected window, we
23317 want the cursor type given by the frame parameter or buffer local
23318 setting of cursor-type. If explicitly marked off, draw no cursor.
23319 In all other cases, we want a hollow box cursor. */
23321 static enum text_cursor_kinds
23322 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23323 int *active_cursor
)
23325 struct frame
*f
= XFRAME (w
->frame
);
23326 struct buffer
*b
= XBUFFER (w
->buffer
);
23327 int cursor_type
= DEFAULT_CURSOR
;
23328 Lisp_Object alt_cursor
;
23329 int non_selected
= 0;
23331 *active_cursor
= 1;
23334 if (cursor_in_echo_area
23335 && FRAME_HAS_MINIBUF_P (f
)
23336 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23338 if (w
== XWINDOW (echo_area_window
))
23340 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23342 *width
= FRAME_CURSOR_WIDTH (f
);
23343 return FRAME_DESIRED_CURSOR (f
);
23346 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23349 *active_cursor
= 0;
23353 /* Detect a nonselected window or nonselected frame. */
23354 else if (w
!= XWINDOW (f
->selected_window
)
23355 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23357 *active_cursor
= 0;
23359 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23365 /* Never display a cursor in a window in which cursor-type is nil. */
23366 if (NILP (BVAR (b
, cursor_type
)))
23369 /* Get the normal cursor type for this window. */
23370 if (EQ (BVAR (b
, cursor_type
), Qt
))
23372 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23373 *width
= FRAME_CURSOR_WIDTH (f
);
23376 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23378 /* Use cursor-in-non-selected-windows instead
23379 for non-selected window or frame. */
23382 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23383 if (!EQ (Qt
, alt_cursor
))
23384 return get_specified_cursor_type (alt_cursor
, width
);
23385 /* t means modify the normal cursor type. */
23386 if (cursor_type
== FILLED_BOX_CURSOR
)
23387 cursor_type
= HOLLOW_BOX_CURSOR
;
23388 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23390 return cursor_type
;
23393 /* Use normal cursor if not blinked off. */
23394 if (!w
->cursor_off_p
)
23396 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23398 if (cursor_type
== FILLED_BOX_CURSOR
)
23400 /* Using a block cursor on large images can be very annoying.
23401 So use a hollow cursor for "large" images.
23402 If image is not transparent (no mask), also use hollow cursor. */
23403 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23404 if (img
!= NULL
&& IMAGEP (img
->spec
))
23406 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23407 where N = size of default frame font size.
23408 This should cover most of the "tiny" icons people may use. */
23410 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23411 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23412 cursor_type
= HOLLOW_BOX_CURSOR
;
23415 else if (cursor_type
!= NO_CURSOR
)
23417 /* Display current only supports BOX and HOLLOW cursors for images.
23418 So for now, unconditionally use a HOLLOW cursor when cursor is
23419 not a solid box cursor. */
23420 cursor_type
= HOLLOW_BOX_CURSOR
;
23423 return cursor_type
;
23426 /* Cursor is blinked off, so determine how to "toggle" it. */
23428 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23429 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23430 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23432 /* Then see if frame has specified a specific blink off cursor type. */
23433 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23435 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23436 return FRAME_BLINK_OFF_CURSOR (f
);
23440 /* Some people liked having a permanently visible blinking cursor,
23441 while others had very strong opinions against it. So it was
23442 decided to remove it. KFS 2003-09-03 */
23444 /* Finally perform built-in cursor blinking:
23445 filled box <-> hollow box
23446 wide [h]bar <-> narrow [h]bar
23447 narrow [h]bar <-> no cursor
23448 other type <-> no cursor */
23450 if (cursor_type
== FILLED_BOX_CURSOR
)
23451 return HOLLOW_BOX_CURSOR
;
23453 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23456 return cursor_type
;
23464 /* Notice when the text cursor of window W has been completely
23465 overwritten by a drawing operation that outputs glyphs in AREA
23466 starting at X0 and ending at X1 in the line starting at Y0 and
23467 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23468 the rest of the line after X0 has been written. Y coordinates
23469 are window-relative. */
23472 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23473 int x0
, int x1
, int y0
, int y1
)
23475 int cx0
, cx1
, cy0
, cy1
;
23476 struct glyph_row
*row
;
23478 if (!w
->phys_cursor_on_p
)
23480 if (area
!= TEXT_AREA
)
23483 if (w
->phys_cursor
.vpos
< 0
23484 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23485 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23486 !(row
->enabled_p
&& row
->displays_text_p
)))
23489 if (row
->cursor_in_fringe_p
)
23491 row
->cursor_in_fringe_p
= 0;
23492 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23493 w
->phys_cursor_on_p
= 0;
23497 cx0
= w
->phys_cursor
.x
;
23498 cx1
= cx0
+ w
->phys_cursor_width
;
23499 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23502 /* The cursor image will be completely removed from the
23503 screen if the output area intersects the cursor area in
23504 y-direction. When we draw in [y0 y1[, and some part of
23505 the cursor is at y < y0, that part must have been drawn
23506 before. When scrolling, the cursor is erased before
23507 actually scrolling, so we don't come here. When not
23508 scrolling, the rows above the old cursor row must have
23509 changed, and in this case these rows must have written
23510 over the cursor image.
23512 Likewise if part of the cursor is below y1, with the
23513 exception of the cursor being in the first blank row at
23514 the buffer and window end because update_text_area
23515 doesn't draw that row. (Except when it does, but
23516 that's handled in update_text_area.) */
23518 cy0
= w
->phys_cursor
.y
;
23519 cy1
= cy0
+ w
->phys_cursor_height
;
23520 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23523 w
->phys_cursor_on_p
= 0;
23526 #endif /* HAVE_WINDOW_SYSTEM */
23529 /************************************************************************
23531 ************************************************************************/
23533 #ifdef HAVE_WINDOW_SYSTEM
23536 Fix the display of area AREA of overlapping row ROW in window W
23537 with respect to the overlapping part OVERLAPS. */
23540 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23541 enum glyph_row_area area
, int overlaps
)
23548 for (i
= 0; i
< row
->used
[area
];)
23550 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23552 int start
= i
, start_x
= x
;
23556 x
+= row
->glyphs
[area
][i
].pixel_width
;
23559 while (i
< row
->used
[area
]
23560 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23562 draw_glyphs (w
, start_x
, row
, area
,
23564 DRAW_NORMAL_TEXT
, overlaps
);
23568 x
+= row
->glyphs
[area
][i
].pixel_width
;
23578 Draw the cursor glyph of window W in glyph row ROW. See the
23579 comment of draw_glyphs for the meaning of HL. */
23582 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23583 enum draw_glyphs_face hl
)
23585 /* If cursor hpos is out of bounds, don't draw garbage. This can
23586 happen in mini-buffer windows when switching between echo area
23587 glyphs and mini-buffer. */
23588 if ((row
->reversed_p
23589 ? (w
->phys_cursor
.hpos
>= 0)
23590 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23592 int on_p
= w
->phys_cursor_on_p
;
23594 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23595 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23597 w
->phys_cursor_on_p
= on_p
;
23599 if (hl
== DRAW_CURSOR
)
23600 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23601 /* When we erase the cursor, and ROW is overlapped by other
23602 rows, make sure that these overlapping parts of other rows
23604 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23606 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23608 if (row
> w
->current_matrix
->rows
23609 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23610 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23611 OVERLAPS_ERASED_CURSOR
);
23613 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23614 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23615 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23616 OVERLAPS_ERASED_CURSOR
);
23623 Erase the image of a cursor of window W from the screen. */
23626 erase_phys_cursor (struct window
*w
)
23628 struct frame
*f
= XFRAME (w
->frame
);
23629 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23630 int hpos
= w
->phys_cursor
.hpos
;
23631 int vpos
= w
->phys_cursor
.vpos
;
23632 int mouse_face_here_p
= 0;
23633 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23634 struct glyph_row
*cursor_row
;
23635 struct glyph
*cursor_glyph
;
23636 enum draw_glyphs_face hl
;
23638 /* No cursor displayed or row invalidated => nothing to do on the
23640 if (w
->phys_cursor_type
== NO_CURSOR
)
23641 goto mark_cursor_off
;
23643 /* VPOS >= active_glyphs->nrows means that window has been resized.
23644 Don't bother to erase the cursor. */
23645 if (vpos
>= active_glyphs
->nrows
)
23646 goto mark_cursor_off
;
23648 /* If row containing cursor is marked invalid, there is nothing we
23650 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23651 if (!cursor_row
->enabled_p
)
23652 goto mark_cursor_off
;
23654 /* If line spacing is > 0, old cursor may only be partially visible in
23655 window after split-window. So adjust visible height. */
23656 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23657 window_text_bottom_y (w
) - cursor_row
->y
);
23659 /* If row is completely invisible, don't attempt to delete a cursor which
23660 isn't there. This can happen if cursor is at top of a window, and
23661 we switch to a buffer with a header line in that window. */
23662 if (cursor_row
->visible_height
<= 0)
23663 goto mark_cursor_off
;
23665 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23666 if (cursor_row
->cursor_in_fringe_p
)
23668 cursor_row
->cursor_in_fringe_p
= 0;
23669 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23670 goto mark_cursor_off
;
23673 /* This can happen when the new row is shorter than the old one.
23674 In this case, either draw_glyphs or clear_end_of_line
23675 should have cleared the cursor. Note that we wouldn't be
23676 able to erase the cursor in this case because we don't have a
23677 cursor glyph at hand. */
23678 if ((cursor_row
->reversed_p
23679 ? (w
->phys_cursor
.hpos
< 0)
23680 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23681 goto mark_cursor_off
;
23683 /* If the cursor is in the mouse face area, redisplay that when
23684 we clear the cursor. */
23685 if (! NILP (hlinfo
->mouse_face_window
)
23686 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23687 /* Don't redraw the cursor's spot in mouse face if it is at the
23688 end of a line (on a newline). The cursor appears there, but
23689 mouse highlighting does not. */
23690 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23691 mouse_face_here_p
= 1;
23693 /* Maybe clear the display under the cursor. */
23694 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23697 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23700 cursor_glyph
= get_phys_cursor_glyph (w
);
23701 if (cursor_glyph
== NULL
)
23702 goto mark_cursor_off
;
23704 width
= cursor_glyph
->pixel_width
;
23705 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23706 x
= w
->phys_cursor
.x
;
23708 width
-= left_x
- x
;
23709 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23710 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23711 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23714 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23717 /* Erase the cursor by redrawing the character underneath it. */
23718 if (mouse_face_here_p
)
23719 hl
= DRAW_MOUSE_FACE
;
23721 hl
= DRAW_NORMAL_TEXT
;
23722 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23725 w
->phys_cursor_on_p
= 0;
23726 w
->phys_cursor_type
= NO_CURSOR
;
23731 Display or clear cursor of window W. If ON is zero, clear the
23732 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23733 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23736 display_and_set_cursor (struct window
*w
, int on
,
23737 int hpos
, int vpos
, int x
, int y
)
23739 struct frame
*f
= XFRAME (w
->frame
);
23740 int new_cursor_type
;
23741 int new_cursor_width
;
23743 struct glyph_row
*glyph_row
;
23744 struct glyph
*glyph
;
23746 /* This is pointless on invisible frames, and dangerous on garbaged
23747 windows and frames; in the latter case, the frame or window may
23748 be in the midst of changing its size, and x and y may be off the
23750 if (! FRAME_VISIBLE_P (f
)
23751 || FRAME_GARBAGED_P (f
)
23752 || vpos
>= w
->current_matrix
->nrows
23753 || hpos
>= w
->current_matrix
->matrix_w
)
23756 /* If cursor is off and we want it off, return quickly. */
23757 if (!on
&& !w
->phys_cursor_on_p
)
23760 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23761 /* If cursor row is not enabled, we don't really know where to
23762 display the cursor. */
23763 if (!glyph_row
->enabled_p
)
23765 w
->phys_cursor_on_p
= 0;
23770 if (!glyph_row
->exact_window_width_line_p
23771 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23772 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23774 xassert (interrupt_input_blocked
);
23776 /* Set new_cursor_type to the cursor we want to be displayed. */
23777 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23778 &new_cursor_width
, &active_cursor
);
23780 /* If cursor is currently being shown and we don't want it to be or
23781 it is in the wrong place, or the cursor type is not what we want,
23783 if (w
->phys_cursor_on_p
23785 || w
->phys_cursor
.x
!= x
23786 || w
->phys_cursor
.y
!= y
23787 || new_cursor_type
!= w
->phys_cursor_type
23788 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23789 && new_cursor_width
!= w
->phys_cursor_width
)))
23790 erase_phys_cursor (w
);
23792 /* Don't check phys_cursor_on_p here because that flag is only set
23793 to zero in some cases where we know that the cursor has been
23794 completely erased, to avoid the extra work of erasing the cursor
23795 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23796 still not be visible, or it has only been partly erased. */
23799 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23800 w
->phys_cursor_height
= glyph_row
->height
;
23802 /* Set phys_cursor_.* before x_draw_.* is called because some
23803 of them may need the information. */
23804 w
->phys_cursor
.x
= x
;
23805 w
->phys_cursor
.y
= glyph_row
->y
;
23806 w
->phys_cursor
.hpos
= hpos
;
23807 w
->phys_cursor
.vpos
= vpos
;
23810 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23811 new_cursor_type
, new_cursor_width
,
23812 on
, active_cursor
);
23816 /* Switch the display of W's cursor on or off, according to the value
23820 update_window_cursor (struct window
*w
, int on
)
23822 /* Don't update cursor in windows whose frame is in the process
23823 of being deleted. */
23824 if (w
->current_matrix
)
23827 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23828 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23834 /* Call update_window_cursor with parameter ON_P on all leaf windows
23835 in the window tree rooted at W. */
23838 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23842 if (!NILP (w
->hchild
))
23843 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23844 else if (!NILP (w
->vchild
))
23845 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23847 update_window_cursor (w
, on_p
);
23849 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23855 Display the cursor on window W, or clear it, according to ON_P.
23856 Don't change the cursor's position. */
23859 x_update_cursor (struct frame
*f
, int on_p
)
23861 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23866 Clear the cursor of window W to background color, and mark the
23867 cursor as not shown. This is used when the text where the cursor
23868 is about to be rewritten. */
23871 x_clear_cursor (struct window
*w
)
23873 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23874 update_window_cursor (w
, 0);
23877 #endif /* HAVE_WINDOW_SYSTEM */
23879 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23882 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23883 int start_hpos
, int end_hpos
,
23884 enum draw_glyphs_face draw
)
23886 #ifdef HAVE_WINDOW_SYSTEM
23887 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23889 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23893 #if defined (HAVE_GPM) || defined (MSDOS)
23894 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23898 /* Display the active region described by mouse_face_* according to DRAW. */
23901 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23903 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23904 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23906 if (/* If window is in the process of being destroyed, don't bother
23908 w
->current_matrix
!= NULL
23909 /* Don't update mouse highlight if hidden */
23910 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23911 /* Recognize when we are called to operate on rows that don't exist
23912 anymore. This can happen when a window is split. */
23913 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23915 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23916 struct glyph_row
*row
, *first
, *last
;
23918 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23919 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23921 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23923 int start_hpos
, end_hpos
, start_x
;
23925 /* For all but the first row, the highlight starts at column 0. */
23928 /* R2L rows have BEG and END in reversed order, but the
23929 screen drawing geometry is always left to right. So
23930 we need to mirror the beginning and end of the
23931 highlighted area in R2L rows. */
23932 if (!row
->reversed_p
)
23934 start_hpos
= hlinfo
->mouse_face_beg_col
;
23935 start_x
= hlinfo
->mouse_face_beg_x
;
23937 else if (row
== last
)
23939 start_hpos
= hlinfo
->mouse_face_end_col
;
23940 start_x
= hlinfo
->mouse_face_end_x
;
23948 else if (row
->reversed_p
&& row
== last
)
23950 start_hpos
= hlinfo
->mouse_face_end_col
;
23951 start_x
= hlinfo
->mouse_face_end_x
;
23961 if (!row
->reversed_p
)
23962 end_hpos
= hlinfo
->mouse_face_end_col
;
23963 else if (row
== first
)
23964 end_hpos
= hlinfo
->mouse_face_beg_col
;
23967 end_hpos
= row
->used
[TEXT_AREA
];
23968 if (draw
== DRAW_NORMAL_TEXT
)
23969 row
->fill_line_p
= 1; /* Clear to end of line */
23972 else if (row
->reversed_p
&& row
== first
)
23973 end_hpos
= hlinfo
->mouse_face_beg_col
;
23976 end_hpos
= row
->used
[TEXT_AREA
];
23977 if (draw
== DRAW_NORMAL_TEXT
)
23978 row
->fill_line_p
= 1; /* Clear to end of line */
23981 if (end_hpos
> start_hpos
)
23983 draw_row_with_mouse_face (w
, start_x
, row
,
23984 start_hpos
, end_hpos
, draw
);
23987 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23991 #ifdef HAVE_WINDOW_SYSTEM
23992 /* When we've written over the cursor, arrange for it to
23993 be displayed again. */
23994 if (FRAME_WINDOW_P (f
)
23995 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23998 display_and_set_cursor (w
, 1,
23999 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24000 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24003 #endif /* HAVE_WINDOW_SYSTEM */
24006 #ifdef HAVE_WINDOW_SYSTEM
24007 /* Change the mouse cursor. */
24008 if (FRAME_WINDOW_P (f
))
24010 if (draw
== DRAW_NORMAL_TEXT
24011 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24012 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24013 else if (draw
== DRAW_MOUSE_FACE
)
24014 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24016 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24018 #endif /* HAVE_WINDOW_SYSTEM */
24022 Clear out the mouse-highlighted active region.
24023 Redraw it un-highlighted first. Value is non-zero if mouse
24024 face was actually drawn unhighlighted. */
24027 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24031 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24033 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24037 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24038 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24039 hlinfo
->mouse_face_window
= Qnil
;
24040 hlinfo
->mouse_face_overlay
= Qnil
;
24044 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24045 within the mouse face on that window. */
24047 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24049 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24051 /* Quickly resolve the easy cases. */
24052 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24053 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24055 if (vpos
< hlinfo
->mouse_face_beg_row
24056 || vpos
> hlinfo
->mouse_face_end_row
)
24058 if (vpos
> hlinfo
->mouse_face_beg_row
24059 && vpos
< hlinfo
->mouse_face_end_row
)
24062 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24064 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24066 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24069 else if ((vpos
== hlinfo
->mouse_face_beg_row
24070 && hpos
>= hlinfo
->mouse_face_beg_col
)
24071 || (vpos
== hlinfo
->mouse_face_end_row
24072 && hpos
< hlinfo
->mouse_face_end_col
))
24077 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24079 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24082 else if ((vpos
== hlinfo
->mouse_face_beg_row
24083 && hpos
<= hlinfo
->mouse_face_beg_col
)
24084 || (vpos
== hlinfo
->mouse_face_end_row
24085 && hpos
> hlinfo
->mouse_face_end_col
))
24093 Non-zero if physical cursor of window W is within mouse face. */
24096 cursor_in_mouse_face_p (struct window
*w
)
24098 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24103 /* Find the glyph rows START_ROW and END_ROW of window W that display
24104 characters between buffer positions START_CHARPOS and END_CHARPOS
24105 (excluding END_CHARPOS). This is similar to row_containing_pos,
24106 but is more accurate when bidi reordering makes buffer positions
24107 change non-linearly with glyph rows. */
24109 rows_from_pos_range (struct window
*w
,
24110 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24111 struct glyph_row
**start
, struct glyph_row
**end
)
24113 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24114 int last_y
= window_text_bottom_y (w
);
24115 struct glyph_row
*row
;
24120 while (!first
->enabled_p
24121 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24124 /* Find the START row. */
24126 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24129 /* A row can potentially be the START row if the range of the
24130 characters it displays intersects the range
24131 [START_CHARPOS..END_CHARPOS). */
24132 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24133 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24134 /* See the commentary in row_containing_pos, for the
24135 explanation of the complicated way to check whether
24136 some position is beyond the end of the characters
24137 displayed by a row. */
24138 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24139 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24140 && !row
->ends_at_zv_p
24141 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24142 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24143 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24144 && !row
->ends_at_zv_p
24145 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24147 /* Found a candidate row. Now make sure at least one of the
24148 glyphs it displays has a charpos from the range
24149 [START_CHARPOS..END_CHARPOS).
24151 This is not obvious because bidi reordering could make
24152 buffer positions of a row be 1,2,3,102,101,100, and if we
24153 want to highlight characters in [50..60), we don't want
24154 this row, even though [50..60) does intersect [1..103),
24155 the range of character positions given by the row's start
24156 and end positions. */
24157 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24158 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24162 if (BUFFERP (g
->object
)
24163 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24172 /* Find the END row. */
24174 /* If the last row is partially visible, start looking for END
24175 from that row, instead of starting from FIRST. */
24176 && !(row
->enabled_p
24177 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24179 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24181 struct glyph_row
*next
= row
+ 1;
24183 if (!next
->enabled_p
24184 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24185 /* The first row >= START whose range of displayed characters
24186 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24187 is the row END + 1. */
24188 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24189 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24190 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24191 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24192 && !next
->ends_at_zv_p
24193 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24194 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24195 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24196 && !next
->ends_at_zv_p
24197 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24204 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24205 but none of the characters it displays are in the range, it is
24207 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24208 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24212 if (BUFFERP (g
->object
)
24213 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24226 /* This function sets the mouse_face_* elements of HLINFO, assuming
24227 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24228 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24229 for the overlay or run of text properties specifying the mouse
24230 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24231 before-string and after-string that must also be highlighted.
24232 COVER_STRING, if non-nil, is a display string that may cover some
24233 or all of the highlighted text. */
24236 mouse_face_from_buffer_pos (Lisp_Object window
,
24237 Mouse_HLInfo
*hlinfo
,
24238 EMACS_INT mouse_charpos
,
24239 EMACS_INT start_charpos
,
24240 EMACS_INT end_charpos
,
24241 Lisp_Object before_string
,
24242 Lisp_Object after_string
,
24243 Lisp_Object cover_string
)
24245 struct window
*w
= XWINDOW (window
);
24246 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24247 struct glyph_row
*r1
, *r2
;
24248 struct glyph
*glyph
, *end
;
24249 EMACS_INT ignore
, pos
;
24252 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24253 xassert (NILP (before_string
) || STRINGP (before_string
));
24254 xassert (NILP (after_string
) || STRINGP (after_string
));
24256 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24257 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24259 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24260 /* If the before-string or display-string contains newlines,
24261 rows_from_pos_range skips to its last row. Move back. */
24262 if (!NILP (before_string
) || !NILP (cover_string
))
24264 struct glyph_row
*prev
;
24265 while ((prev
= r1
- 1, prev
>= first
)
24266 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24267 && prev
->used
[TEXT_AREA
] > 0)
24269 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24270 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24271 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24273 || !(EQ (glyph
->object
, before_string
)
24274 || EQ (glyph
->object
, cover_string
)))
24281 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24282 hlinfo
->mouse_face_past_end
= 1;
24284 else if (!NILP (after_string
))
24286 /* If the after-string has newlines, advance to its last row. */
24287 struct glyph_row
*next
;
24288 struct glyph_row
*last
24289 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24291 for (next
= r2
+ 1;
24293 && next
->used
[TEXT_AREA
] > 0
24294 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24298 /* The rest of the display engine assumes that mouse_face_beg_row is
24299 either above below mouse_face_end_row or identical to it. But
24300 with bidi-reordered continued lines, the row for START_CHARPOS
24301 could be below the row for END_CHARPOS. If so, swap the rows and
24302 store them in correct order. */
24305 struct glyph_row
*tem
= r2
;
24311 hlinfo
->mouse_face_beg_y
= r1
->y
;
24312 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24313 hlinfo
->mouse_face_end_y
= r2
->y
;
24314 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24316 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24317 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24318 could be anywhere in the row and in any order. The strategy
24319 below is to find the leftmost and the rightmost glyph that
24320 belongs to either of these 3 strings, or whose position is
24321 between START_CHARPOS and END_CHARPOS, and highlight all the
24322 glyphs between those two. This may cover more than just the text
24323 between START_CHARPOS and END_CHARPOS if the range of characters
24324 strides the bidi level boundary, e.g. if the beginning is in R2L
24325 text while the end is in L2R text or vice versa. */
24326 if (!r1
->reversed_p
)
24328 /* This row is in a left to right paragraph. Scan it left to
24330 glyph
= r1
->glyphs
[TEXT_AREA
];
24331 end
= glyph
+ r1
->used
[TEXT_AREA
];
24334 /* Skip truncation glyphs at the start of the glyph row. */
24335 if (r1
->displays_text_p
)
24337 && INTEGERP (glyph
->object
)
24338 && glyph
->charpos
< 0;
24340 x
+= glyph
->pixel_width
;
24342 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24343 or COVER_STRING, and the first glyph from buffer whose
24344 position is between START_CHARPOS and END_CHARPOS. */
24346 && !INTEGERP (glyph
->object
)
24347 && !EQ (glyph
->object
, cover_string
)
24348 && !(BUFFERP (glyph
->object
)
24349 && (glyph
->charpos
>= start_charpos
24350 && glyph
->charpos
< end_charpos
));
24353 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24354 are present at buffer positions between START_CHARPOS and
24355 END_CHARPOS, or if they come from an overlay. */
24356 if (EQ (glyph
->object
, before_string
))
24358 pos
= string_buffer_position (before_string
,
24360 /* If pos == 0, it means before_string came from an
24361 overlay, not from a buffer position. */
24362 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24365 else if (EQ (glyph
->object
, after_string
))
24367 pos
= string_buffer_position (after_string
, end_charpos
);
24368 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24371 x
+= glyph
->pixel_width
;
24373 hlinfo
->mouse_face_beg_x
= x
;
24374 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24378 /* This row is in a right to left paragraph. Scan it right to
24382 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24383 glyph
= end
+ r1
->used
[TEXT_AREA
];
24385 /* Skip truncation glyphs at the start of the glyph row. */
24386 if (r1
->displays_text_p
)
24388 && INTEGERP (glyph
->object
)
24389 && glyph
->charpos
< 0;
24393 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24394 or COVER_STRING, and the first glyph from buffer whose
24395 position is between START_CHARPOS and END_CHARPOS. */
24397 && !INTEGERP (glyph
->object
)
24398 && !EQ (glyph
->object
, cover_string
)
24399 && !(BUFFERP (glyph
->object
)
24400 && (glyph
->charpos
>= start_charpos
24401 && glyph
->charpos
< end_charpos
));
24404 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24405 are present at buffer positions between START_CHARPOS and
24406 END_CHARPOS, or if they come from an overlay. */
24407 if (EQ (glyph
->object
, before_string
))
24409 pos
= string_buffer_position (before_string
, start_charpos
);
24410 /* If pos == 0, it means before_string came from an
24411 overlay, not from a buffer position. */
24412 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24415 else if (EQ (glyph
->object
, after_string
))
24417 pos
= string_buffer_position (after_string
, end_charpos
);
24418 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24423 glyph
++; /* first glyph to the right of the highlighted area */
24424 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24425 x
+= g
->pixel_width
;
24426 hlinfo
->mouse_face_beg_x
= x
;
24427 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24430 /* If the highlight ends in a different row, compute GLYPH and END
24431 for the end row. Otherwise, reuse the values computed above for
24432 the row where the highlight begins. */
24435 if (!r2
->reversed_p
)
24437 glyph
= r2
->glyphs
[TEXT_AREA
];
24438 end
= glyph
+ r2
->used
[TEXT_AREA
];
24443 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24444 glyph
= end
+ r2
->used
[TEXT_AREA
];
24448 if (!r2
->reversed_p
)
24450 /* Skip truncation and continuation glyphs near the end of the
24451 row, and also blanks and stretch glyphs inserted by
24452 extend_face_to_end_of_line. */
24454 && INTEGERP ((end
- 1)->object
)
24455 && (end
- 1)->charpos
<= 0)
24457 /* Scan the rest of the glyph row from the end, looking for the
24458 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24459 COVER_STRING, or whose position is between START_CHARPOS
24463 && !INTEGERP (end
->object
)
24464 && !EQ (end
->object
, cover_string
)
24465 && !(BUFFERP (end
->object
)
24466 && (end
->charpos
>= start_charpos
24467 && end
->charpos
< end_charpos
));
24470 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24471 are present at buffer positions between START_CHARPOS and
24472 END_CHARPOS, or if they come from an overlay. */
24473 if (EQ (end
->object
, before_string
))
24475 pos
= string_buffer_position (before_string
, start_charpos
);
24476 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24479 else if (EQ (end
->object
, after_string
))
24481 pos
= string_buffer_position (after_string
, end_charpos
);
24482 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24486 /* Find the X coordinate of the last glyph to be highlighted. */
24487 for (; glyph
<= end
; ++glyph
)
24488 x
+= glyph
->pixel_width
;
24490 hlinfo
->mouse_face_end_x
= x
;
24491 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24495 /* Skip truncation and continuation glyphs near the end of the
24496 row, and also blanks and stretch glyphs inserted by
24497 extend_face_to_end_of_line. */
24501 && INTEGERP (end
->object
)
24502 && end
->charpos
<= 0)
24504 x
+= end
->pixel_width
;
24507 /* Scan the rest of the glyph row from the end, looking for the
24508 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24509 COVER_STRING, or whose position is between START_CHARPOS
24513 && !INTEGERP (end
->object
)
24514 && !EQ (end
->object
, cover_string
)
24515 && !(BUFFERP (end
->object
)
24516 && (end
->charpos
>= start_charpos
24517 && end
->charpos
< end_charpos
));
24520 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24521 are present at buffer positions between START_CHARPOS and
24522 END_CHARPOS, or if they come from an overlay. */
24523 if (EQ (end
->object
, before_string
))
24525 pos
= string_buffer_position (before_string
, start_charpos
);
24526 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24529 else if (EQ (end
->object
, after_string
))
24531 pos
= string_buffer_position (after_string
, end_charpos
);
24532 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24535 x
+= end
->pixel_width
;
24537 hlinfo
->mouse_face_end_x
= x
;
24538 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24541 hlinfo
->mouse_face_window
= window
;
24542 hlinfo
->mouse_face_face_id
24543 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24545 !hlinfo
->mouse_face_hidden
, -1);
24546 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24549 /* The following function is not used anymore (replaced with
24550 mouse_face_from_string_pos), but I leave it here for the time
24551 being, in case someone would. */
24553 #if 0 /* not used */
24555 /* Find the position of the glyph for position POS in OBJECT in
24556 window W's current matrix, and return in *X, *Y the pixel
24557 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24559 RIGHT_P non-zero means return the position of the right edge of the
24560 glyph, RIGHT_P zero means return the left edge position.
24562 If no glyph for POS exists in the matrix, return the position of
24563 the glyph with the next smaller position that is in the matrix, if
24564 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24565 exists in the matrix, return the position of the glyph with the
24566 next larger position in OBJECT.
24568 Value is non-zero if a glyph was found. */
24571 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24572 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24574 int yb
= window_text_bottom_y (w
);
24575 struct glyph_row
*r
;
24576 struct glyph
*best_glyph
= NULL
;
24577 struct glyph_row
*best_row
= NULL
;
24580 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24581 r
->enabled_p
&& r
->y
< yb
;
24584 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24585 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24588 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24589 if (EQ (g
->object
, object
))
24591 if (g
->charpos
== pos
)
24598 else if (best_glyph
== NULL
24599 || ((eabs (g
->charpos
- pos
)
24600 < eabs (best_glyph
->charpos
- pos
))
24603 : g
->charpos
> pos
)))
24617 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24621 *x
+= best_glyph
->pixel_width
;
24626 *vpos
= best_row
- w
->current_matrix
->rows
;
24629 return best_glyph
!= NULL
;
24631 #endif /* not used */
24633 /* Find the positions of the first and the last glyphs in window W's
24634 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24635 (assumed to be a string), and return in HLINFO's mouse_face_*
24636 members the pixel and column/row coordinates of those glyphs. */
24639 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24640 Lisp_Object object
,
24641 EMACS_INT startpos
, EMACS_INT endpos
)
24643 int yb
= window_text_bottom_y (w
);
24644 struct glyph_row
*r
;
24645 struct glyph
*g
, *e
;
24649 /* Find the glyph row with at least one position in the range
24650 [STARTPOS..ENDPOS], and the first glyph in that row whose
24651 position belongs to that range. */
24652 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24653 r
->enabled_p
&& r
->y
< yb
;
24656 if (!r
->reversed_p
)
24658 g
= r
->glyphs
[TEXT_AREA
];
24659 e
= g
+ r
->used
[TEXT_AREA
];
24660 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24661 if (EQ (g
->object
, object
)
24662 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24664 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24665 hlinfo
->mouse_face_beg_y
= r
->y
;
24666 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24667 hlinfo
->mouse_face_beg_x
= gx
;
24676 e
= r
->glyphs
[TEXT_AREA
];
24677 g
= e
+ r
->used
[TEXT_AREA
];
24678 for ( ; g
> e
; --g
)
24679 if (EQ ((g
-1)->object
, object
)
24680 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24682 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24683 hlinfo
->mouse_face_beg_y
= r
->y
;
24684 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24685 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24686 gx
+= g1
->pixel_width
;
24687 hlinfo
->mouse_face_beg_x
= gx
;
24699 /* Starting with the next row, look for the first row which does NOT
24700 include any glyphs whose positions are in the range. */
24701 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24703 g
= r
->glyphs
[TEXT_AREA
];
24704 e
= g
+ r
->used
[TEXT_AREA
];
24706 for ( ; g
< e
; ++g
)
24707 if (EQ (g
->object
, object
)
24708 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24717 /* The highlighted region ends on the previous row. */
24720 /* Set the end row and its vertical pixel coordinate. */
24721 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24722 hlinfo
->mouse_face_end_y
= r
->y
;
24724 /* Compute and set the end column and the end column's horizontal
24725 pixel coordinate. */
24726 if (!r
->reversed_p
)
24728 g
= r
->glyphs
[TEXT_AREA
];
24729 e
= g
+ r
->used
[TEXT_AREA
];
24730 for ( ; e
> g
; --e
)
24731 if (EQ ((e
-1)->object
, object
)
24732 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24734 hlinfo
->mouse_face_end_col
= e
- g
;
24736 for (gx
= r
->x
; g
< e
; ++g
)
24737 gx
+= g
->pixel_width
;
24738 hlinfo
->mouse_face_end_x
= gx
;
24742 e
= r
->glyphs
[TEXT_AREA
];
24743 g
= e
+ r
->used
[TEXT_AREA
];
24744 for (gx
= r
->x
; e
< g
; ++e
)
24746 if (EQ (e
->object
, object
)
24747 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24749 gx
+= e
->pixel_width
;
24751 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24752 hlinfo
->mouse_face_end_x
= gx
;
24756 #ifdef HAVE_WINDOW_SYSTEM
24758 /* See if position X, Y is within a hot-spot of an image. */
24761 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24763 if (!CONSP (hot_spot
))
24766 if (EQ (XCAR (hot_spot
), Qrect
))
24768 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24769 Lisp_Object rect
= XCDR (hot_spot
);
24773 if (!CONSP (XCAR (rect
)))
24775 if (!CONSP (XCDR (rect
)))
24777 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24779 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24781 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24783 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24787 else if (EQ (XCAR (hot_spot
), Qcircle
))
24789 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24790 Lisp_Object circ
= XCDR (hot_spot
);
24791 Lisp_Object lr
, lx0
, ly0
;
24793 && CONSP (XCAR (circ
))
24794 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24795 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24796 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24798 double r
= XFLOATINT (lr
);
24799 double dx
= XINT (lx0
) - x
;
24800 double dy
= XINT (ly0
) - y
;
24801 return (dx
* dx
+ dy
* dy
<= r
* r
);
24804 else if (EQ (XCAR (hot_spot
), Qpoly
))
24806 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24807 if (VECTORP (XCDR (hot_spot
)))
24809 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24810 Lisp_Object
*poly
= v
->contents
;
24814 Lisp_Object lx
, ly
;
24817 /* Need an even number of coordinates, and at least 3 edges. */
24818 if (n
< 6 || n
& 1)
24821 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24822 If count is odd, we are inside polygon. Pixels on edges
24823 may or may not be included depending on actual geometry of the
24825 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24826 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24828 x0
= XINT (lx
), y0
= XINT (ly
);
24829 for (i
= 0; i
< n
; i
+= 2)
24831 int x1
= x0
, y1
= y0
;
24832 if ((lx
= poly
[i
], !INTEGERP (lx
))
24833 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24835 x0
= XINT (lx
), y0
= XINT (ly
);
24837 /* Does this segment cross the X line? */
24845 if (y
> y0
&& y
> y1
)
24847 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24857 find_hot_spot (Lisp_Object map
, int x
, int y
)
24859 while (CONSP (map
))
24861 if (CONSP (XCAR (map
))
24862 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24870 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24872 doc
: /* Lookup in image map MAP coordinates X and Y.
24873 An image map is an alist where each element has the format (AREA ID PLIST).
24874 An AREA is specified as either a rectangle, a circle, or a polygon:
24875 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24876 pixel coordinates of the upper left and bottom right corners.
24877 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24878 and the radius of the circle; r may be a float or integer.
24879 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24880 vector describes one corner in the polygon.
24881 Returns the alist element for the first matching AREA in MAP. */)
24882 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24890 return find_hot_spot (map
, XINT (x
), XINT (y
));
24894 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24896 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24898 /* Do not change cursor shape while dragging mouse. */
24899 if (!NILP (do_mouse_tracking
))
24902 if (!NILP (pointer
))
24904 if (EQ (pointer
, Qarrow
))
24905 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24906 else if (EQ (pointer
, Qhand
))
24907 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24908 else if (EQ (pointer
, Qtext
))
24909 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24910 else if (EQ (pointer
, intern ("hdrag")))
24911 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24912 #ifdef HAVE_X_WINDOWS
24913 else if (EQ (pointer
, intern ("vdrag")))
24914 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24916 else if (EQ (pointer
, intern ("hourglass")))
24917 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24918 else if (EQ (pointer
, Qmodeline
))
24919 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24921 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24924 if (cursor
!= No_Cursor
)
24925 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24928 #endif /* HAVE_WINDOW_SYSTEM */
24930 /* Take proper action when mouse has moved to the mode or header line
24931 or marginal area AREA of window W, x-position X and y-position Y.
24932 X is relative to the start of the text display area of W, so the
24933 width of bitmap areas and scroll bars must be subtracted to get a
24934 position relative to the start of the mode line. */
24937 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24938 enum window_part area
)
24940 struct window
*w
= XWINDOW (window
);
24941 struct frame
*f
= XFRAME (w
->frame
);
24942 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24943 #ifdef HAVE_WINDOW_SYSTEM
24944 Display_Info
*dpyinfo
;
24946 Cursor cursor
= No_Cursor
;
24947 Lisp_Object pointer
= Qnil
;
24948 int dx
, dy
, width
, height
;
24950 Lisp_Object string
, object
= Qnil
;
24951 Lisp_Object pos
, help
;
24953 Lisp_Object mouse_face
;
24954 int original_x_pixel
= x
;
24955 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24956 struct glyph_row
*row
;
24958 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24963 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24964 returns them in row/column units! */
24965 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24966 &object
, &dx
, &dy
, &width
, &height
);
24968 row
= (area
== ON_MODE_LINE
24969 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24970 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24972 /* Find the glyph under the mouse pointer. */
24973 if (row
->mode_line_p
&& row
->enabled_p
)
24975 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24976 end
= glyph
+ row
->used
[TEXT_AREA
];
24978 for (x0
= original_x_pixel
;
24979 glyph
< end
&& x0
>= glyph
->pixel_width
;
24981 x0
-= glyph
->pixel_width
;
24989 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24990 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24991 returns them in row/column units! */
24992 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24993 &object
, &dx
, &dy
, &width
, &height
);
24998 #ifdef HAVE_WINDOW_SYSTEM
24999 if (IMAGEP (object
))
25001 Lisp_Object image_map
, hotspot
;
25002 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25004 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25006 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25010 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25011 If so, we could look for mouse-enter, mouse-leave
25012 properties in PLIST (and do something...). */
25013 hotspot
= XCDR (hotspot
);
25014 if (CONSP (hotspot
)
25015 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25017 pointer
= Fplist_get (plist
, Qpointer
);
25018 if (NILP (pointer
))
25020 help
= Fplist_get (plist
, Qhelp_echo
);
25023 help_echo_string
= help
;
25024 /* Is this correct? ++kfs */
25025 XSETWINDOW (help_echo_window
, w
);
25026 help_echo_object
= w
->buffer
;
25027 help_echo_pos
= charpos
;
25031 if (NILP (pointer
))
25032 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25034 #endif /* HAVE_WINDOW_SYSTEM */
25036 if (STRINGP (string
))
25038 pos
= make_number (charpos
);
25039 /* If we're on a string with `help-echo' text property, arrange
25040 for the help to be displayed. This is done by setting the
25041 global variable help_echo_string to the help string. */
25044 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25047 help_echo_string
= help
;
25048 XSETWINDOW (help_echo_window
, w
);
25049 help_echo_object
= string
;
25050 help_echo_pos
= charpos
;
25054 #ifdef HAVE_WINDOW_SYSTEM
25055 if (FRAME_WINDOW_P (f
))
25057 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25058 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25059 if (NILP (pointer
))
25060 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25062 /* Change the mouse pointer according to what is under X/Y. */
25064 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25067 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25068 if (!KEYMAPP (map
))
25069 map
= Fget_text_property (pos
, Qkeymap
, string
);
25070 if (!KEYMAPP (map
))
25071 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25076 /* Change the mouse face according to what is under X/Y. */
25077 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25078 if (!NILP (mouse_face
)
25079 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25084 struct glyph
* tmp_glyph
;
25088 int total_pixel_width
;
25089 EMACS_INT begpos
, endpos
, ignore
;
25093 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25094 Qmouse_face
, string
, Qnil
);
25100 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25102 endpos
= SCHARS (string
);
25106 /* Calculate the glyph position GPOS of GLYPH in the
25107 displayed string, relative to the beginning of the
25108 highlighted part of the string.
25110 Note: GPOS is different from CHARPOS. CHARPOS is the
25111 position of GLYPH in the internal string object. A mode
25112 line string format has structures which are converted to
25113 a flattened string by the Emacs Lisp interpreter. The
25114 internal string is an element of those structures. The
25115 displayed string is the flattened string. */
25116 tmp_glyph
= row_start_glyph
;
25117 while (tmp_glyph
< glyph
25118 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25119 && begpos
<= tmp_glyph
->charpos
25120 && tmp_glyph
->charpos
< endpos
)))
25122 gpos
= glyph
- tmp_glyph
;
25124 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25125 the highlighted part of the displayed string to which
25126 GLYPH belongs. Note: GSEQ_LENGTH is different from
25127 SCHARS (STRING), because the latter returns the length of
25128 the internal string. */
25129 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25131 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25132 && begpos
<= tmp_glyph
->charpos
25133 && tmp_glyph
->charpos
< endpos
));
25136 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25138 /* Calculate the total pixel width of all the glyphs between
25139 the beginning of the highlighted area and GLYPH. */
25140 total_pixel_width
= 0;
25141 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25142 total_pixel_width
+= tmp_glyph
->pixel_width
;
25144 /* Pre calculation of re-rendering position. Note: X is in
25145 column units here, after the call to mode_line_string or
25146 marginal_area_string. */
25148 vpos
= (area
== ON_MODE_LINE
25149 ? (w
->current_matrix
)->nrows
- 1
25152 /* If GLYPH's position is included in the region that is
25153 already drawn in mouse face, we have nothing to do. */
25154 if ( EQ (window
, hlinfo
->mouse_face_window
)
25155 && (!row
->reversed_p
25156 ? (hlinfo
->mouse_face_beg_col
<= hpos
25157 && hpos
< hlinfo
->mouse_face_end_col
)
25158 /* In R2L rows we swap BEG and END, see below. */
25159 : (hlinfo
->mouse_face_end_col
<= hpos
25160 && hpos
< hlinfo
->mouse_face_beg_col
))
25161 && hlinfo
->mouse_face_beg_row
== vpos
)
25164 if (clear_mouse_face (hlinfo
))
25165 cursor
= No_Cursor
;
25167 if (!row
->reversed_p
)
25169 hlinfo
->mouse_face_beg_col
= hpos
;
25170 hlinfo
->mouse_face_beg_x
= original_x_pixel
25171 - (total_pixel_width
+ dx
);
25172 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25173 hlinfo
->mouse_face_end_x
= 0;
25177 /* In R2L rows, show_mouse_face expects BEG and END
25178 coordinates to be swapped. */
25179 hlinfo
->mouse_face_end_col
= hpos
;
25180 hlinfo
->mouse_face_end_x
= original_x_pixel
25181 - (total_pixel_width
+ dx
);
25182 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25183 hlinfo
->mouse_face_beg_x
= 0;
25186 hlinfo
->mouse_face_beg_row
= vpos
;
25187 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25188 hlinfo
->mouse_face_beg_y
= 0;
25189 hlinfo
->mouse_face_end_y
= 0;
25190 hlinfo
->mouse_face_past_end
= 0;
25191 hlinfo
->mouse_face_window
= window
;
25193 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25199 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25201 if (NILP (pointer
))
25204 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25205 clear_mouse_face (hlinfo
);
25207 #ifdef HAVE_WINDOW_SYSTEM
25208 if (FRAME_WINDOW_P (f
))
25209 define_frame_cursor1 (f
, cursor
, pointer
);
25215 Take proper action when the mouse has moved to position X, Y on
25216 frame F as regards highlighting characters that have mouse-face
25217 properties. Also de-highlighting chars where the mouse was before.
25218 X and Y can be negative or out of range. */
25221 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25223 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25224 enum window_part part
;
25225 Lisp_Object window
;
25227 Cursor cursor
= No_Cursor
;
25228 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25231 /* When a menu is active, don't highlight because this looks odd. */
25232 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25233 if (popup_activated ())
25237 if (NILP (Vmouse_highlight
)
25238 || !f
->glyphs_initialized_p
25239 || f
->pointer_invisible
)
25242 hlinfo
->mouse_face_mouse_x
= x
;
25243 hlinfo
->mouse_face_mouse_y
= y
;
25244 hlinfo
->mouse_face_mouse_frame
= f
;
25246 if (hlinfo
->mouse_face_defer
)
25249 if (gc_in_progress
)
25251 hlinfo
->mouse_face_deferred_gc
= 1;
25255 /* Which window is that in? */
25256 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25258 /* If we were displaying active text in another window, clear that.
25259 Also clear if we move out of text area in same window. */
25260 if (! EQ (window
, hlinfo
->mouse_face_window
)
25261 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25262 && !NILP (hlinfo
->mouse_face_window
)))
25263 clear_mouse_face (hlinfo
);
25265 /* Not on a window -> return. */
25266 if (!WINDOWP (window
))
25269 /* Reset help_echo_string. It will get recomputed below. */
25270 help_echo_string
= Qnil
;
25272 /* Convert to window-relative pixel coordinates. */
25273 w
= XWINDOW (window
);
25274 frame_to_window_pixel_xy (w
, &x
, &y
);
25276 #ifdef HAVE_WINDOW_SYSTEM
25277 /* Handle tool-bar window differently since it doesn't display a
25279 if (EQ (window
, f
->tool_bar_window
))
25281 note_tool_bar_highlight (f
, x
, y
);
25286 /* Mouse is on the mode, header line or margin? */
25287 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25288 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25290 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25294 #ifdef HAVE_WINDOW_SYSTEM
25295 if (part
== ON_VERTICAL_BORDER
)
25297 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25298 help_echo_string
= build_string ("drag-mouse-1: resize");
25300 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25301 || part
== ON_SCROLL_BAR
)
25302 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25304 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25307 /* Are we in a window whose display is up to date?
25308 And verify the buffer's text has not changed. */
25309 b
= XBUFFER (w
->buffer
);
25310 if (part
== ON_TEXT
25311 && EQ (w
->window_end_valid
, w
->buffer
)
25312 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25313 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25315 int hpos
, vpos
, i
, dx
, dy
, area
;
25317 struct glyph
*glyph
;
25318 Lisp_Object object
;
25319 Lisp_Object mouse_face
= Qnil
, position
;
25320 Lisp_Object
*overlay_vec
= NULL
;
25322 struct buffer
*obuf
;
25323 EMACS_INT obegv
, ozv
;
25326 /* Find the glyph under X/Y. */
25327 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25329 #ifdef HAVE_WINDOW_SYSTEM
25330 /* Look for :pointer property on image. */
25331 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25333 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25334 if (img
!= NULL
&& IMAGEP (img
->spec
))
25336 Lisp_Object image_map
, hotspot
;
25337 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25339 && (hotspot
= find_hot_spot (image_map
,
25340 glyph
->slice
.img
.x
+ dx
,
25341 glyph
->slice
.img
.y
+ dy
),
25343 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25347 /* Could check XCAR (hotspot) to see if we enter/leave
25349 If so, we could look for mouse-enter, mouse-leave
25350 properties in PLIST (and do something...). */
25351 hotspot
= XCDR (hotspot
);
25352 if (CONSP (hotspot
)
25353 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25355 pointer
= Fplist_get (plist
, Qpointer
);
25356 if (NILP (pointer
))
25358 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25359 if (!NILP (help_echo_string
))
25361 help_echo_window
= window
;
25362 help_echo_object
= glyph
->object
;
25363 help_echo_pos
= glyph
->charpos
;
25367 if (NILP (pointer
))
25368 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25371 #endif /* HAVE_WINDOW_SYSTEM */
25373 /* Clear mouse face if X/Y not over text. */
25375 || area
!= TEXT_AREA
25376 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25377 /* Glyph's OBJECT is an integer for glyphs inserted by the
25378 display engine for its internal purposes, like truncation
25379 and continuation glyphs and blanks beyond the end of
25380 line's text on text terminals. If we are over such a
25381 glyph, we are not over any text. */
25382 || INTEGERP (glyph
->object
)
25383 /* R2L rows have a stretch glyph at their front, which
25384 stands for no text, whereas L2R rows have no glyphs at
25385 all beyond the end of text. Treat such stretch glyphs
25386 like we do with NULL glyphs in L2R rows. */
25387 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25388 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25389 && glyph
->type
== STRETCH_GLYPH
25390 && glyph
->avoid_cursor_p
))
25392 if (clear_mouse_face (hlinfo
))
25393 cursor
= No_Cursor
;
25394 #ifdef HAVE_WINDOW_SYSTEM
25395 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25397 if (area
!= TEXT_AREA
)
25398 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25400 pointer
= Vvoid_text_area_pointer
;
25406 pos
= glyph
->charpos
;
25407 object
= glyph
->object
;
25408 if (!STRINGP (object
) && !BUFFERP (object
))
25411 /* If we get an out-of-range value, return now; avoid an error. */
25412 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25415 /* Make the window's buffer temporarily current for
25416 overlays_at and compute_char_face. */
25417 obuf
= current_buffer
;
25418 current_buffer
= b
;
25424 /* Is this char mouse-active or does it have help-echo? */
25425 position
= make_number (pos
);
25427 if (BUFFERP (object
))
25429 /* Put all the overlays we want in a vector in overlay_vec. */
25430 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25431 /* Sort overlays into increasing priority order. */
25432 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25437 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25440 cursor
= No_Cursor
;
25442 /* Check mouse-face highlighting. */
25444 /* If there exists an overlay with mouse-face overlapping
25445 the one we are currently highlighting, we have to
25446 check if we enter the overlapping overlay, and then
25447 highlight only that. */
25448 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25449 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25451 /* Find the highest priority overlay with a mouse-face. */
25452 Lisp_Object overlay
= Qnil
;
25453 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25455 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25456 if (!NILP (mouse_face
))
25457 overlay
= overlay_vec
[i
];
25460 /* If we're highlighting the same overlay as before, there's
25461 no need to do that again. */
25462 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25463 goto check_help_echo
;
25464 hlinfo
->mouse_face_overlay
= overlay
;
25466 /* Clear the display of the old active region, if any. */
25467 if (clear_mouse_face (hlinfo
))
25468 cursor
= No_Cursor
;
25470 /* If no overlay applies, get a text property. */
25471 if (NILP (overlay
))
25472 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25474 /* Next, compute the bounds of the mouse highlighting and
25476 if (!NILP (mouse_face
) && STRINGP (object
))
25478 /* The mouse-highlighting comes from a display string
25479 with a mouse-face. */
25483 s
= Fprevious_single_property_change
25484 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25485 e
= Fnext_single_property_change
25486 (position
, Qmouse_face
, object
, Qnil
);
25488 s
= make_number (0);
25490 e
= make_number (SCHARS (object
) - 1);
25491 mouse_face_from_string_pos (w
, hlinfo
, object
,
25492 XINT (s
), XINT (e
));
25493 hlinfo
->mouse_face_past_end
= 0;
25494 hlinfo
->mouse_face_window
= window
;
25495 hlinfo
->mouse_face_face_id
25496 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25497 glyph
->face_id
, 1);
25498 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25499 cursor
= No_Cursor
;
25503 /* The mouse-highlighting, if any, comes from an overlay
25504 or text property in the buffer. */
25505 Lisp_Object buffer
IF_LINT (= Qnil
);
25506 Lisp_Object cover_string
IF_LINT (= Qnil
);
25508 if (STRINGP (object
))
25510 /* If we are on a display string with no mouse-face,
25511 check if the text under it has one. */
25512 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25513 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25514 pos
= string_buffer_position (object
, start
);
25517 mouse_face
= get_char_property_and_overlay
25518 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25519 buffer
= w
->buffer
;
25520 cover_string
= object
;
25526 cover_string
= Qnil
;
25529 if (!NILP (mouse_face
))
25531 Lisp_Object before
, after
;
25532 Lisp_Object before_string
, after_string
;
25533 /* To correctly find the limits of mouse highlight
25534 in a bidi-reordered buffer, we must not use the
25535 optimization of limiting the search in
25536 previous-single-property-change and
25537 next-single-property-change, because
25538 rows_from_pos_range needs the real start and end
25539 positions to DTRT in this case. That's because
25540 the first row visible in a window does not
25541 necessarily display the character whose position
25542 is the smallest. */
25544 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25545 ? Fmarker_position (w
->start
)
25548 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25549 ? make_number (BUF_Z (XBUFFER (buffer
))
25550 - XFASTINT (w
->window_end_pos
))
25553 if (NILP (overlay
))
25555 /* Handle the text property case. */
25556 before
= Fprevious_single_property_change
25557 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25558 after
= Fnext_single_property_change
25559 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25560 before_string
= after_string
= Qnil
;
25564 /* Handle the overlay case. */
25565 before
= Foverlay_start (overlay
);
25566 after
= Foverlay_end (overlay
);
25567 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25568 after_string
= Foverlay_get (overlay
, Qafter_string
);
25570 if (!STRINGP (before_string
)) before_string
= Qnil
;
25571 if (!STRINGP (after_string
)) after_string
= Qnil
;
25574 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25577 before_string
, after_string
,
25579 cursor
= No_Cursor
;
25586 /* Look for a `help-echo' property. */
25587 if (NILP (help_echo_string
)) {
25588 Lisp_Object help
, overlay
;
25590 /* Check overlays first. */
25591 help
= overlay
= Qnil
;
25592 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25594 overlay
= overlay_vec
[i
];
25595 help
= Foverlay_get (overlay
, Qhelp_echo
);
25600 help_echo_string
= help
;
25601 help_echo_window
= window
;
25602 help_echo_object
= overlay
;
25603 help_echo_pos
= pos
;
25607 Lisp_Object obj
= glyph
->object
;
25608 EMACS_INT charpos
= glyph
->charpos
;
25610 /* Try text properties. */
25613 && charpos
< SCHARS (obj
))
25615 help
= Fget_text_property (make_number (charpos
),
25619 /* If the string itself doesn't specify a help-echo,
25620 see if the buffer text ``under'' it does. */
25621 struct glyph_row
*r
25622 = MATRIX_ROW (w
->current_matrix
, vpos
);
25623 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25624 EMACS_INT p
= string_buffer_position (obj
, start
);
25627 help
= Fget_char_property (make_number (p
),
25628 Qhelp_echo
, w
->buffer
);
25637 else if (BUFFERP (obj
)
25640 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25645 help_echo_string
= help
;
25646 help_echo_window
= window
;
25647 help_echo_object
= obj
;
25648 help_echo_pos
= charpos
;
25653 #ifdef HAVE_WINDOW_SYSTEM
25654 /* Look for a `pointer' property. */
25655 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25657 /* Check overlays first. */
25658 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25659 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25661 if (NILP (pointer
))
25663 Lisp_Object obj
= glyph
->object
;
25664 EMACS_INT charpos
= glyph
->charpos
;
25666 /* Try text properties. */
25669 && charpos
< SCHARS (obj
))
25671 pointer
= Fget_text_property (make_number (charpos
),
25673 if (NILP (pointer
))
25675 /* If the string itself doesn't specify a pointer,
25676 see if the buffer text ``under'' it does. */
25677 struct glyph_row
*r
25678 = MATRIX_ROW (w
->current_matrix
, vpos
);
25679 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25680 EMACS_INT p
= string_buffer_position (obj
, start
);
25682 pointer
= Fget_char_property (make_number (p
),
25683 Qpointer
, w
->buffer
);
25686 else if (BUFFERP (obj
)
25689 pointer
= Fget_text_property (make_number (charpos
),
25693 #endif /* HAVE_WINDOW_SYSTEM */
25697 current_buffer
= obuf
;
25702 #ifdef HAVE_WINDOW_SYSTEM
25703 if (FRAME_WINDOW_P (f
))
25704 define_frame_cursor1 (f
, cursor
, pointer
);
25706 /* This is here to prevent a compiler error, about "label at end of
25707 compound statement". */
25714 Clear any mouse-face on window W. This function is part of the
25715 redisplay interface, and is called from try_window_id and similar
25716 functions to ensure the mouse-highlight is off. */
25719 x_clear_window_mouse_face (struct window
*w
)
25721 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25722 Lisp_Object window
;
25725 XSETWINDOW (window
, w
);
25726 if (EQ (window
, hlinfo
->mouse_face_window
))
25727 clear_mouse_face (hlinfo
);
25733 Just discard the mouse face information for frame F, if any.
25734 This is used when the size of F is changed. */
25737 cancel_mouse_face (struct frame
*f
)
25739 Lisp_Object window
;
25740 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25742 window
= hlinfo
->mouse_face_window
;
25743 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25745 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25746 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25747 hlinfo
->mouse_face_window
= Qnil
;
25753 /***********************************************************************
25755 ***********************************************************************/
25757 #ifdef HAVE_WINDOW_SYSTEM
25759 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25760 which intersects rectangle R. R is in window-relative coordinates. */
25763 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25764 enum glyph_row_area area
)
25766 struct glyph
*first
= row
->glyphs
[area
];
25767 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25768 struct glyph
*last
;
25769 int first_x
, start_x
, x
;
25771 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25772 /* If row extends face to end of line write the whole line. */
25773 draw_glyphs (w
, 0, row
, area
,
25774 0, row
->used
[area
],
25775 DRAW_NORMAL_TEXT
, 0);
25778 /* Set START_X to the window-relative start position for drawing glyphs of
25779 AREA. The first glyph of the text area can be partially visible.
25780 The first glyphs of other areas cannot. */
25781 start_x
= window_box_left_offset (w
, area
);
25783 if (area
== TEXT_AREA
)
25786 /* Find the first glyph that must be redrawn. */
25788 && x
+ first
->pixel_width
< r
->x
)
25790 x
+= first
->pixel_width
;
25794 /* Find the last one. */
25798 && x
< r
->x
+ r
->width
)
25800 x
+= last
->pixel_width
;
25806 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25807 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25808 DRAW_NORMAL_TEXT
, 0);
25813 /* Redraw the parts of the glyph row ROW on window W intersecting
25814 rectangle R. R is in window-relative coordinates. Value is
25815 non-zero if mouse-face was overwritten. */
25818 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25820 xassert (row
->enabled_p
);
25822 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25823 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25824 0, row
->used
[TEXT_AREA
],
25825 DRAW_NORMAL_TEXT
, 0);
25828 if (row
->used
[LEFT_MARGIN_AREA
])
25829 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25830 if (row
->used
[TEXT_AREA
])
25831 expose_area (w
, row
, r
, TEXT_AREA
);
25832 if (row
->used
[RIGHT_MARGIN_AREA
])
25833 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25834 draw_row_fringe_bitmaps (w
, row
);
25837 return row
->mouse_face_p
;
25841 /* Redraw those parts of glyphs rows during expose event handling that
25842 overlap other rows. Redrawing of an exposed line writes over parts
25843 of lines overlapping that exposed line; this function fixes that.
25845 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25846 row in W's current matrix that is exposed and overlaps other rows.
25847 LAST_OVERLAPPING_ROW is the last such row. */
25850 expose_overlaps (struct window
*w
,
25851 struct glyph_row
*first_overlapping_row
,
25852 struct glyph_row
*last_overlapping_row
,
25855 struct glyph_row
*row
;
25857 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25858 if (row
->overlapping_p
)
25860 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25863 if (row
->used
[LEFT_MARGIN_AREA
])
25864 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25866 if (row
->used
[TEXT_AREA
])
25867 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25869 if (row
->used
[RIGHT_MARGIN_AREA
])
25870 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25876 /* Return non-zero if W's cursor intersects rectangle R. */
25879 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25881 XRectangle cr
, result
;
25882 struct glyph
*cursor_glyph
;
25883 struct glyph_row
*row
;
25885 if (w
->phys_cursor
.vpos
>= 0
25886 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25887 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25889 && row
->cursor_in_fringe_p
)
25891 /* Cursor is in the fringe. */
25892 cr
.x
= window_box_right_offset (w
,
25893 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25894 ? RIGHT_MARGIN_AREA
25897 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25898 cr
.height
= row
->height
;
25899 return x_intersect_rectangles (&cr
, r
, &result
);
25902 cursor_glyph
= get_phys_cursor_glyph (w
);
25905 /* r is relative to W's box, but w->phys_cursor.x is relative
25906 to left edge of W's TEXT area. Adjust it. */
25907 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25908 cr
.y
= w
->phys_cursor
.y
;
25909 cr
.width
= cursor_glyph
->pixel_width
;
25910 cr
.height
= w
->phys_cursor_height
;
25911 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25912 I assume the effect is the same -- and this is portable. */
25913 return x_intersect_rectangles (&cr
, r
, &result
);
25915 /* If we don't understand the format, pretend we're not in the hot-spot. */
25921 Draw a vertical window border to the right of window W if W doesn't
25922 have vertical scroll bars. */
25925 x_draw_vertical_border (struct window
*w
)
25927 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25929 /* We could do better, if we knew what type of scroll-bar the adjacent
25930 windows (on either side) have... But we don't :-(
25931 However, I think this works ok. ++KFS 2003-04-25 */
25933 /* Redraw borders between horizontally adjacent windows. Don't
25934 do it for frames with vertical scroll bars because either the
25935 right scroll bar of a window, or the left scroll bar of its
25936 neighbor will suffice as a border. */
25937 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25940 if (!WINDOW_RIGHTMOST_P (w
)
25941 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25943 int x0
, x1
, y0
, y1
;
25945 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25948 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25951 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25953 else if (!WINDOW_LEFTMOST_P (w
)
25954 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25956 int x0
, x1
, y0
, y1
;
25958 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25961 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25964 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25969 /* Redraw the part of window W intersection rectangle FR. Pixel
25970 coordinates in FR are frame-relative. Call this function with
25971 input blocked. Value is non-zero if the exposure overwrites
25975 expose_window (struct window
*w
, XRectangle
*fr
)
25977 struct frame
*f
= XFRAME (w
->frame
);
25979 int mouse_face_overwritten_p
= 0;
25981 /* If window is not yet fully initialized, do nothing. This can
25982 happen when toolkit scroll bars are used and a window is split.
25983 Reconfiguring the scroll bar will generate an expose for a newly
25985 if (w
->current_matrix
== NULL
)
25988 /* When we're currently updating the window, display and current
25989 matrix usually don't agree. Arrange for a thorough display
25991 if (w
== updated_window
)
25993 SET_FRAME_GARBAGED (f
);
25997 /* Frame-relative pixel rectangle of W. */
25998 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25999 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26000 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26001 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26003 if (x_intersect_rectangles (fr
, &wr
, &r
))
26005 int yb
= window_text_bottom_y (w
);
26006 struct glyph_row
*row
;
26007 int cursor_cleared_p
;
26008 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26010 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26011 r
.x
, r
.y
, r
.width
, r
.height
));
26013 /* Convert to window coordinates. */
26014 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26015 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26017 /* Turn off the cursor. */
26018 if (!w
->pseudo_window_p
26019 && phys_cursor_in_rect_p (w
, &r
))
26021 x_clear_cursor (w
);
26022 cursor_cleared_p
= 1;
26025 cursor_cleared_p
= 0;
26027 /* Update lines intersecting rectangle R. */
26028 first_overlapping_row
= last_overlapping_row
= NULL
;
26029 for (row
= w
->current_matrix
->rows
;
26034 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26036 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26037 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26038 || (r
.y
>= y0
&& r
.y
< y1
)
26039 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26041 /* A header line may be overlapping, but there is no need
26042 to fix overlapping areas for them. KFS 2005-02-12 */
26043 if (row
->overlapping_p
&& !row
->mode_line_p
)
26045 if (first_overlapping_row
== NULL
)
26046 first_overlapping_row
= row
;
26047 last_overlapping_row
= row
;
26051 if (expose_line (w
, row
, &r
))
26052 mouse_face_overwritten_p
= 1;
26055 else if (row
->overlapping_p
)
26057 /* We must redraw a row overlapping the exposed area. */
26059 ? y0
+ row
->phys_height
> r
.y
26060 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26062 if (first_overlapping_row
== NULL
)
26063 first_overlapping_row
= row
;
26064 last_overlapping_row
= row
;
26072 /* Display the mode line if there is one. */
26073 if (WINDOW_WANTS_MODELINE_P (w
)
26074 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26076 && row
->y
< r
.y
+ r
.height
)
26078 if (expose_line (w
, row
, &r
))
26079 mouse_face_overwritten_p
= 1;
26082 if (!w
->pseudo_window_p
)
26084 /* Fix the display of overlapping rows. */
26085 if (first_overlapping_row
)
26086 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26089 /* Draw border between windows. */
26090 x_draw_vertical_border (w
);
26092 /* Turn the cursor on again. */
26093 if (cursor_cleared_p
)
26094 update_window_cursor (w
, 1);
26098 return mouse_face_overwritten_p
;
26103 /* Redraw (parts) of all windows in the window tree rooted at W that
26104 intersect R. R contains frame pixel coordinates. Value is
26105 non-zero if the exposure overwrites mouse-face. */
26108 expose_window_tree (struct window
*w
, XRectangle
*r
)
26110 struct frame
*f
= XFRAME (w
->frame
);
26111 int mouse_face_overwritten_p
= 0;
26113 while (w
&& !FRAME_GARBAGED_P (f
))
26115 if (!NILP (w
->hchild
))
26116 mouse_face_overwritten_p
26117 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26118 else if (!NILP (w
->vchild
))
26119 mouse_face_overwritten_p
26120 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26122 mouse_face_overwritten_p
|= expose_window (w
, r
);
26124 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26127 return mouse_face_overwritten_p
;
26132 Redisplay an exposed area of frame F. X and Y are the upper-left
26133 corner of the exposed rectangle. W and H are width and height of
26134 the exposed area. All are pixel values. W or H zero means redraw
26135 the entire frame. */
26138 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26141 int mouse_face_overwritten_p
= 0;
26143 TRACE ((stderr
, "expose_frame "));
26145 /* No need to redraw if frame will be redrawn soon. */
26146 if (FRAME_GARBAGED_P (f
))
26148 TRACE ((stderr
, " garbaged\n"));
26152 /* If basic faces haven't been realized yet, there is no point in
26153 trying to redraw anything. This can happen when we get an expose
26154 event while Emacs is starting, e.g. by moving another window. */
26155 if (FRAME_FACE_CACHE (f
) == NULL
26156 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26158 TRACE ((stderr
, " no faces\n"));
26162 if (w
== 0 || h
== 0)
26165 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26166 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26176 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26177 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26179 if (WINDOWP (f
->tool_bar_window
))
26180 mouse_face_overwritten_p
26181 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26183 #ifdef HAVE_X_WINDOWS
26185 #ifndef USE_X_TOOLKIT
26186 if (WINDOWP (f
->menu_bar_window
))
26187 mouse_face_overwritten_p
26188 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26189 #endif /* not USE_X_TOOLKIT */
26193 /* Some window managers support a focus-follows-mouse style with
26194 delayed raising of frames. Imagine a partially obscured frame,
26195 and moving the mouse into partially obscured mouse-face on that
26196 frame. The visible part of the mouse-face will be highlighted,
26197 then the WM raises the obscured frame. With at least one WM, KDE
26198 2.1, Emacs is not getting any event for the raising of the frame
26199 (even tried with SubstructureRedirectMask), only Expose events.
26200 These expose events will draw text normally, i.e. not
26201 highlighted. Which means we must redo the highlight here.
26202 Subsume it under ``we love X''. --gerd 2001-08-15 */
26203 /* Included in Windows version because Windows most likely does not
26204 do the right thing if any third party tool offers
26205 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26206 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26208 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26209 if (f
== hlinfo
->mouse_face_mouse_frame
)
26211 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26212 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26213 clear_mouse_face (hlinfo
);
26214 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26221 Determine the intersection of two rectangles R1 and R2. Return
26222 the intersection in *RESULT. Value is non-zero if RESULT is not
26226 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26228 XRectangle
*left
, *right
;
26229 XRectangle
*upper
, *lower
;
26230 int intersection_p
= 0;
26232 /* Rearrange so that R1 is the left-most rectangle. */
26234 left
= r1
, right
= r2
;
26236 left
= r2
, right
= r1
;
26238 /* X0 of the intersection is right.x0, if this is inside R1,
26239 otherwise there is no intersection. */
26240 if (right
->x
<= left
->x
+ left
->width
)
26242 result
->x
= right
->x
;
26244 /* The right end of the intersection is the minimum of the
26245 the right ends of left and right. */
26246 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26249 /* Same game for Y. */
26251 upper
= r1
, lower
= r2
;
26253 upper
= r2
, lower
= r1
;
26255 /* The upper end of the intersection is lower.y0, if this is inside
26256 of upper. Otherwise, there is no intersection. */
26257 if (lower
->y
<= upper
->y
+ upper
->height
)
26259 result
->y
= lower
->y
;
26261 /* The lower end of the intersection is the minimum of the lower
26262 ends of upper and lower. */
26263 result
->height
= (min (lower
->y
+ lower
->height
,
26264 upper
->y
+ upper
->height
)
26266 intersection_p
= 1;
26270 return intersection_p
;
26273 #endif /* HAVE_WINDOW_SYSTEM */
26276 /***********************************************************************
26278 ***********************************************************************/
26281 syms_of_xdisp (void)
26283 Vwith_echo_area_save_vector
= Qnil
;
26284 staticpro (&Vwith_echo_area_save_vector
);
26286 Vmessage_stack
= Qnil
;
26287 staticpro (&Vmessage_stack
);
26289 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26290 staticpro (&Qinhibit_redisplay
);
26292 message_dolog_marker1
= Fmake_marker ();
26293 staticpro (&message_dolog_marker1
);
26294 message_dolog_marker2
= Fmake_marker ();
26295 staticpro (&message_dolog_marker2
);
26296 message_dolog_marker3
= Fmake_marker ();
26297 staticpro (&message_dolog_marker3
);
26300 defsubr (&Sdump_frame_glyph_matrix
);
26301 defsubr (&Sdump_glyph_matrix
);
26302 defsubr (&Sdump_glyph_row
);
26303 defsubr (&Sdump_tool_bar_row
);
26304 defsubr (&Strace_redisplay
);
26305 defsubr (&Strace_to_stderr
);
26307 #ifdef HAVE_WINDOW_SYSTEM
26308 defsubr (&Stool_bar_lines_needed
);
26309 defsubr (&Slookup_image_map
);
26311 defsubr (&Sformat_mode_line
);
26312 defsubr (&Sinvisible_p
);
26313 defsubr (&Scurrent_bidi_paragraph_direction
);
26315 staticpro (&Qmenu_bar_update_hook
);
26316 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26318 staticpro (&Qoverriding_terminal_local_map
);
26319 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26321 staticpro (&Qoverriding_local_map
);
26322 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26324 staticpro (&Qwindow_scroll_functions
);
26325 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26327 staticpro (&Qwindow_text_change_functions
);
26328 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26330 staticpro (&Qredisplay_end_trigger_functions
);
26331 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26333 staticpro (&Qinhibit_point_motion_hooks
);
26334 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26336 Qeval
= intern_c_string ("eval");
26337 staticpro (&Qeval
);
26339 QCdata
= intern_c_string (":data");
26340 staticpro (&QCdata
);
26341 Qdisplay
= intern_c_string ("display");
26342 staticpro (&Qdisplay
);
26343 Qspace_width
= intern_c_string ("space-width");
26344 staticpro (&Qspace_width
);
26345 Qraise
= intern_c_string ("raise");
26346 staticpro (&Qraise
);
26347 Qslice
= intern_c_string ("slice");
26348 staticpro (&Qslice
);
26349 Qspace
= intern_c_string ("space");
26350 staticpro (&Qspace
);
26351 Qmargin
= intern_c_string ("margin");
26352 staticpro (&Qmargin
);
26353 Qpointer
= intern_c_string ("pointer");
26354 staticpro (&Qpointer
);
26355 Qleft_margin
= intern_c_string ("left-margin");
26356 staticpro (&Qleft_margin
);
26357 Qright_margin
= intern_c_string ("right-margin");
26358 staticpro (&Qright_margin
);
26359 Qcenter
= intern_c_string ("center");
26360 staticpro (&Qcenter
);
26361 Qline_height
= intern_c_string ("line-height");
26362 staticpro (&Qline_height
);
26363 QCalign_to
= intern_c_string (":align-to");
26364 staticpro (&QCalign_to
);
26365 QCrelative_width
= intern_c_string (":relative-width");
26366 staticpro (&QCrelative_width
);
26367 QCrelative_height
= intern_c_string (":relative-height");
26368 staticpro (&QCrelative_height
);
26369 QCeval
= intern_c_string (":eval");
26370 staticpro (&QCeval
);
26371 QCpropertize
= intern_c_string (":propertize");
26372 staticpro (&QCpropertize
);
26373 QCfile
= intern_c_string (":file");
26374 staticpro (&QCfile
);
26375 Qfontified
= intern_c_string ("fontified");
26376 staticpro (&Qfontified
);
26377 Qfontification_functions
= intern_c_string ("fontification-functions");
26378 staticpro (&Qfontification_functions
);
26379 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26380 staticpro (&Qtrailing_whitespace
);
26381 Qescape_glyph
= intern_c_string ("escape-glyph");
26382 staticpro (&Qescape_glyph
);
26383 Qnobreak_space
= intern_c_string ("nobreak-space");
26384 staticpro (&Qnobreak_space
);
26385 Qimage
= intern_c_string ("image");
26386 staticpro (&Qimage
);
26387 Qtext
= intern_c_string ("text");
26388 staticpro (&Qtext
);
26389 Qboth
= intern_c_string ("both");
26390 staticpro (&Qboth
);
26391 Qboth_horiz
= intern_c_string ("both-horiz");
26392 staticpro (&Qboth_horiz
);
26393 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26394 staticpro (&Qtext_image_horiz
);
26395 QCmap
= intern_c_string (":map");
26396 staticpro (&QCmap
);
26397 QCpointer
= intern_c_string (":pointer");
26398 staticpro (&QCpointer
);
26399 Qrect
= intern_c_string ("rect");
26400 staticpro (&Qrect
);
26401 Qcircle
= intern_c_string ("circle");
26402 staticpro (&Qcircle
);
26403 Qpoly
= intern_c_string ("poly");
26404 staticpro (&Qpoly
);
26405 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26406 staticpro (&Qmessage_truncate_lines
);
26407 Qgrow_only
= intern_c_string ("grow-only");
26408 staticpro (&Qgrow_only
);
26409 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26410 staticpro (&Qinhibit_menubar_update
);
26411 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26412 staticpro (&Qinhibit_eval_during_redisplay
);
26413 Qposition
= intern_c_string ("position");
26414 staticpro (&Qposition
);
26415 Qbuffer_position
= intern_c_string ("buffer-position");
26416 staticpro (&Qbuffer_position
);
26417 Qobject
= intern_c_string ("object");
26418 staticpro (&Qobject
);
26419 Qbar
= intern_c_string ("bar");
26421 Qhbar
= intern_c_string ("hbar");
26422 staticpro (&Qhbar
);
26423 Qbox
= intern_c_string ("box");
26425 Qhollow
= intern_c_string ("hollow");
26426 staticpro (&Qhollow
);
26427 Qhand
= intern_c_string ("hand");
26428 staticpro (&Qhand
);
26429 Qarrow
= intern_c_string ("arrow");
26430 staticpro (&Qarrow
);
26431 Qtext
= intern_c_string ("text");
26432 staticpro (&Qtext
);
26433 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26434 staticpro (&Qinhibit_free_realized_faces
);
26436 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26437 Fcons (intern_c_string ("void-variable"), Qnil
)),
26439 staticpro (&list_of_error
);
26441 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26442 staticpro (&Qlast_arrow_position
);
26443 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26444 staticpro (&Qlast_arrow_string
);
26446 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26447 staticpro (&Qoverlay_arrow_string
);
26448 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26449 staticpro (&Qoverlay_arrow_bitmap
);
26451 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26452 staticpro (&echo_buffer
[0]);
26453 staticpro (&echo_buffer
[1]);
26455 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26456 staticpro (&echo_area_buffer
[0]);
26457 staticpro (&echo_area_buffer
[1]);
26459 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26460 staticpro (&Vmessages_buffer_name
);
26462 mode_line_proptrans_alist
= Qnil
;
26463 staticpro (&mode_line_proptrans_alist
);
26464 mode_line_string_list
= Qnil
;
26465 staticpro (&mode_line_string_list
);
26466 mode_line_string_face
= Qnil
;
26467 staticpro (&mode_line_string_face
);
26468 mode_line_string_face_prop
= Qnil
;
26469 staticpro (&mode_line_string_face_prop
);
26470 Vmode_line_unwind_vector
= Qnil
;
26471 staticpro (&Vmode_line_unwind_vector
);
26473 help_echo_string
= Qnil
;
26474 staticpro (&help_echo_string
);
26475 help_echo_object
= Qnil
;
26476 staticpro (&help_echo_object
);
26477 help_echo_window
= Qnil
;
26478 staticpro (&help_echo_window
);
26479 previous_help_echo_string
= Qnil
;
26480 staticpro (&previous_help_echo_string
);
26481 help_echo_pos
= -1;
26483 Qright_to_left
= intern_c_string ("right-to-left");
26484 staticpro (&Qright_to_left
);
26485 Qleft_to_right
= intern_c_string ("left-to-right");
26486 staticpro (&Qleft_to_right
);
26488 #ifdef HAVE_WINDOW_SYSTEM
26489 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26490 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26491 For example, if a block cursor is over a tab, it will be drawn as
26492 wide as that tab on the display. */);
26493 x_stretch_cursor_p
= 0;
26496 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26497 doc
: /* *Non-nil means highlight trailing whitespace.
26498 The face used for trailing whitespace is `trailing-whitespace'. */);
26499 Vshow_trailing_whitespace
= Qnil
;
26501 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26502 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26503 A value of t means highlight the character itself (for nobreak space,
26504 use face `nobreak-space').
26505 A value of nil means no highlighting.
26506 Other values mean display the escape glyph followed by an ordinary
26507 space or ordinary hyphen. */);
26508 Vnobreak_char_display
= Qt
;
26510 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26511 doc
: /* *The pointer shape to show in void text areas.
26512 A value of nil means to show the text pointer. Other options are `arrow',
26513 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26514 Vvoid_text_area_pointer
= Qarrow
;
26516 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26517 doc
: /* Non-nil means don't actually do any redisplay.
26518 This is used for internal purposes. */);
26519 Vinhibit_redisplay
= Qnil
;
26521 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26522 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26523 Vglobal_mode_string
= Qnil
;
26525 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26526 doc
: /* Marker for where to display an arrow on top of the buffer text.
26527 This must be the beginning of a line in order to work.
26528 See also `overlay-arrow-string'. */);
26529 Voverlay_arrow_position
= Qnil
;
26531 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26532 doc
: /* String to display as an arrow in non-window frames.
26533 See also `overlay-arrow-position'. */);
26534 Voverlay_arrow_string
= make_pure_c_string ("=>");
26536 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26537 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26538 The symbols on this list are examined during redisplay to determine
26539 where to display overlay arrows. */);
26540 Voverlay_arrow_variable_list
26541 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26543 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26544 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26545 If that fails to bring point back on frame, point is centered instead.
26546 If this is zero, point is always centered after it moves off frame.
26547 If you want scrolling to always be a line at a time, you should set
26548 `scroll-conservatively' to a large value rather than set this to 1. */);
26550 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26551 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26552 If point moves off-screen, redisplay will scroll by up to
26553 `scroll-conservatively' lines in order to bring point just barely
26554 onto the screen again. If that cannot be done, then redisplay
26555 recenters point as usual.
26557 If the value is greater than 100, redisplay will never recenter point,
26558 but will always scroll just enough text to bring point into view, even
26559 if you move far away.
26561 A value of zero means always recenter point if it moves off screen. */);
26562 scroll_conservatively
= 0;
26564 DEFVAR_INT ("scroll-margin", scroll_margin
,
26565 doc
: /* *Number of lines of margin at the top and bottom of a window.
26566 Recenter the window whenever point gets within this many lines
26567 of the top or bottom of the window. */);
26570 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26571 doc
: /* Pixels per inch value for non-window system displays.
26572 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26573 Vdisplay_pixels_per_inch
= make_float (72.0);
26576 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26579 DEFVAR_LISP ("truncate-partial-width-windows",
26580 Vtruncate_partial_width_windows
,
26581 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26582 For an integer value, truncate lines in each window narrower than the
26583 full frame width, provided the window width is less than that integer;
26584 otherwise, respect the value of `truncate-lines'.
26586 For any other non-nil value, truncate lines in all windows that do
26587 not span the full frame width.
26589 A value of nil means to respect the value of `truncate-lines'.
26591 If `word-wrap' is enabled, you might want to reduce this. */);
26592 Vtruncate_partial_width_windows
= make_number (50);
26594 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26595 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26596 Any other value means to use the appropriate face, `mode-line',
26597 `header-line', or `menu' respectively. */);
26598 mode_line_inverse_video
= 1;
26600 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26601 doc
: /* *Maximum buffer size for which line number should be displayed.
26602 If the buffer is bigger than this, the line number does not appear
26603 in the mode line. A value of nil means no limit. */);
26604 Vline_number_display_limit
= Qnil
;
26606 DEFVAR_INT ("line-number-display-limit-width",
26607 line_number_display_limit_width
,
26608 doc
: /* *Maximum line width (in characters) for line number display.
26609 If the average length of the lines near point is bigger than this, then the
26610 line number may be omitted from the mode line. */);
26611 line_number_display_limit_width
= 200;
26613 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26614 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26615 highlight_nonselected_windows
= 0;
26617 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26618 doc
: /* Non-nil if more than one frame is visible on this display.
26619 Minibuffer-only frames don't count, but iconified frames do.
26620 This variable is not guaranteed to be accurate except while processing
26621 `frame-title-format' and `icon-title-format'. */);
26623 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26624 doc
: /* Template for displaying the title bar of visible frames.
26625 \(Assuming the window manager supports this feature.)
26627 This variable has the same structure as `mode-line-format', except that
26628 the %c and %l constructs are ignored. It is used only on frames for
26629 which no explicit name has been set \(see `modify-frame-parameters'). */);
26631 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26632 doc
: /* Template for displaying the title bar of an iconified frame.
26633 \(Assuming the window manager supports this feature.)
26634 This variable has the same structure as `mode-line-format' (which see),
26635 and is used only on frames for which no explicit name has been set
26636 \(see `modify-frame-parameters'). */);
26638 = Vframe_title_format
26639 = pure_cons (intern_c_string ("multiple-frames"),
26640 pure_cons (make_pure_c_string ("%b"),
26641 pure_cons (pure_cons (empty_unibyte_string
,
26642 pure_cons (intern_c_string ("invocation-name"),
26643 pure_cons (make_pure_c_string ("@"),
26644 pure_cons (intern_c_string ("system-name"),
26648 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26649 doc
: /* Maximum number of lines to keep in the message log buffer.
26650 If nil, disable message logging. If t, log messages but don't truncate
26651 the buffer when it becomes large. */);
26652 Vmessage_log_max
= make_number (100);
26654 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26655 doc
: /* Functions called before redisplay, if window sizes have changed.
26656 The value should be a list of functions that take one argument.
26657 Just before redisplay, for each frame, if any of its windows have changed
26658 size since the last redisplay, or have been split or deleted,
26659 all the functions in the list are called, with the frame as argument. */);
26660 Vwindow_size_change_functions
= Qnil
;
26662 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26663 doc
: /* List of functions to call before redisplaying a window with scrolling.
26664 Each function is called with two arguments, the window and its new
26665 display-start position. Note that these functions are also called by
26666 `set-window-buffer'. Also note that the value of `window-end' is not
26667 valid when these functions are called. */);
26668 Vwindow_scroll_functions
= Qnil
;
26670 DEFVAR_LISP ("window-text-change-functions",
26671 Vwindow_text_change_functions
,
26672 doc
: /* Functions to call in redisplay when text in the window might change. */);
26673 Vwindow_text_change_functions
= Qnil
;
26675 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26676 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26677 Each function is called with two arguments, the window and the end trigger value.
26678 See `set-window-redisplay-end-trigger'. */);
26679 Vredisplay_end_trigger_functions
= Qnil
;
26681 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26682 doc
: /* *Non-nil means autoselect window with mouse pointer.
26683 If nil, do not autoselect windows.
26684 A positive number means delay autoselection by that many seconds: a
26685 window is autoselected only after the mouse has remained in that
26686 window for the duration of the delay.
26687 A negative number has a similar effect, but causes windows to be
26688 autoselected only after the mouse has stopped moving. \(Because of
26689 the way Emacs compares mouse events, you will occasionally wait twice
26690 that time before the window gets selected.\)
26691 Any other value means to autoselect window instantaneously when the
26692 mouse pointer enters it.
26694 Autoselection selects the minibuffer only if it is active, and never
26695 unselects the minibuffer if it is active.
26697 When customizing this variable make sure that the actual value of
26698 `focus-follows-mouse' matches the behavior of your window manager. */);
26699 Vmouse_autoselect_window
= Qnil
;
26701 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26702 doc
: /* *Non-nil means automatically resize tool-bars.
26703 This dynamically changes the tool-bar's height to the minimum height
26704 that is needed to make all tool-bar items visible.
26705 If value is `grow-only', the tool-bar's height is only increased
26706 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26707 Vauto_resize_tool_bars
= Qt
;
26709 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26710 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26711 auto_raise_tool_bar_buttons_p
= 1;
26713 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26714 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26715 make_cursor_line_fully_visible_p
= 1;
26717 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26718 doc
: /* *Border below tool-bar in pixels.
26719 If an integer, use it as the height of the border.
26720 If it is one of `internal-border-width' or `border-width', use the
26721 value of the corresponding frame parameter.
26722 Otherwise, no border is added below the tool-bar. */);
26723 Vtool_bar_border
= Qinternal_border_width
;
26725 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26726 doc
: /* *Margin around tool-bar buttons in pixels.
26727 If an integer, use that for both horizontal and vertical margins.
26728 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26729 HORZ specifying the horizontal margin, and VERT specifying the
26730 vertical margin. */);
26731 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26733 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26734 doc
: /* *Relief thickness of tool-bar buttons. */);
26735 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26737 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26738 doc
: /* Tool bar style to use.
26740 image - show images only
26741 text - show text only
26742 both - show both, text below image
26743 both-horiz - show text to the right of the image
26744 text-image-horiz - show text to the left of the image
26745 any other - use system default or image if no system default. */);
26746 Vtool_bar_style
= Qnil
;
26748 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26749 doc
: /* *Maximum number of characters a label can have to be shown.
26750 The tool bar style must also show labels for this to have any effect, see
26751 `tool-bar-style'. */);
26752 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26754 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26755 doc
: /* List of functions to call to fontify regions of text.
26756 Each function is called with one argument POS. Functions must
26757 fontify a region starting at POS in the current buffer, and give
26758 fontified regions the property `fontified'. */);
26759 Vfontification_functions
= Qnil
;
26760 Fmake_variable_buffer_local (Qfontification_functions
);
26762 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26763 unibyte_display_via_language_environment
,
26764 doc
: /* *Non-nil means display unibyte text according to language environment.
26765 Specifically, this means that raw bytes in the range 160-255 decimal
26766 are displayed by converting them to the equivalent multibyte characters
26767 according to the current language environment. As a result, they are
26768 displayed according to the current fontset.
26770 Note that this variable affects only how these bytes are displayed,
26771 but does not change the fact they are interpreted as raw bytes. */);
26772 unibyte_display_via_language_environment
= 0;
26774 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26775 doc
: /* *Maximum height for resizing mini-windows.
26776 If a float, it specifies a fraction of the mini-window frame's height.
26777 If an integer, it specifies a number of lines. */);
26778 Vmax_mini_window_height
= make_float (0.25);
26780 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26781 doc
: /* *How to resize mini-windows.
26782 A value of nil means don't automatically resize mini-windows.
26783 A value of t means resize them to fit the text displayed in them.
26784 A value of `grow-only', the default, means let mini-windows grow
26785 only, until their display becomes empty, at which point the windows
26786 go back to their normal size. */);
26787 Vresize_mini_windows
= Qgrow_only
;
26789 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26790 doc
: /* Alist specifying how to blink the cursor off.
26791 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26792 `cursor-type' frame-parameter or variable equals ON-STATE,
26793 comparing using `equal', Emacs uses OFF-STATE to specify
26794 how to blink it off. ON-STATE and OFF-STATE are values for
26795 the `cursor-type' frame parameter.
26797 If a frame's ON-STATE has no entry in this list,
26798 the frame's other specifications determine how to blink the cursor off. */);
26799 Vblink_cursor_alist
= Qnil
;
26801 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26802 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26803 If non-nil, windows are automatically scrolled horizontally to make
26804 point visible. */);
26805 automatic_hscrolling_p
= 1;
26806 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26807 staticpro (&Qauto_hscroll_mode
);
26809 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26810 doc
: /* *How many columns away from the window edge point is allowed to get
26811 before automatic hscrolling will horizontally scroll the window. */);
26812 hscroll_margin
= 5;
26814 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26815 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26816 When point is less than `hscroll-margin' columns from the window
26817 edge, automatic hscrolling will scroll the window by the amount of columns
26818 determined by this variable. If its value is a positive integer, scroll that
26819 many columns. If it's a positive floating-point number, it specifies the
26820 fraction of the window's width to scroll. If it's nil or zero, point will be
26821 centered horizontally after the scroll. Any other value, including negative
26822 numbers, are treated as if the value were zero.
26824 Automatic hscrolling always moves point outside the scroll margin, so if
26825 point was more than scroll step columns inside the margin, the window will
26826 scroll more than the value given by the scroll step.
26828 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26829 and `scroll-right' overrides this variable's effect. */);
26830 Vhscroll_step
= make_number (0);
26832 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26833 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26834 Bind this around calls to `message' to let it take effect. */);
26835 message_truncate_lines
= 0;
26837 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26838 doc
: /* Normal hook run to update the menu bar definitions.
26839 Redisplay runs this hook before it redisplays the menu bar.
26840 This is used to update submenus such as Buffers,
26841 whose contents depend on various data. */);
26842 Vmenu_bar_update_hook
= Qnil
;
26844 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26845 doc
: /* Frame for which we are updating a menu.
26846 The enable predicate for a menu binding should check this variable. */);
26847 Vmenu_updating_frame
= Qnil
;
26849 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26850 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26851 inhibit_menubar_update
= 0;
26853 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26854 doc
: /* Prefix prepended to all continuation lines at display time.
26855 The value may be a string, an image, or a stretch-glyph; it is
26856 interpreted in the same way as the value of a `display' text property.
26858 This variable is overridden by any `wrap-prefix' text or overlay
26861 To add a prefix to non-continuation lines, use `line-prefix'. */);
26862 Vwrap_prefix
= Qnil
;
26863 staticpro (&Qwrap_prefix
);
26864 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26865 Fmake_variable_buffer_local (Qwrap_prefix
);
26867 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26868 doc
: /* Prefix prepended to all non-continuation lines at display time.
26869 The value may be a string, an image, or a stretch-glyph; it is
26870 interpreted in the same way as the value of a `display' text property.
26872 This variable is overridden by any `line-prefix' text or overlay
26875 To add a prefix to continuation lines, use `wrap-prefix'. */);
26876 Vline_prefix
= Qnil
;
26877 staticpro (&Qline_prefix
);
26878 Qline_prefix
= intern_c_string ("line-prefix");
26879 Fmake_variable_buffer_local (Qline_prefix
);
26881 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26882 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26883 inhibit_eval_during_redisplay
= 0;
26885 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26886 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26887 inhibit_free_realized_faces
= 0;
26890 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26891 doc
: /* Inhibit try_window_id display optimization. */);
26892 inhibit_try_window_id
= 0;
26894 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26895 doc
: /* Inhibit try_window_reusing display optimization. */);
26896 inhibit_try_window_reusing
= 0;
26898 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26899 doc
: /* Inhibit try_cursor_movement display optimization. */);
26900 inhibit_try_cursor_movement
= 0;
26901 #endif /* GLYPH_DEBUG */
26903 DEFVAR_INT ("overline-margin", overline_margin
,
26904 doc
: /* *Space between overline and text, in pixels.
26905 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26906 margin to the caracter height. */);
26907 overline_margin
= 2;
26909 DEFVAR_INT ("underline-minimum-offset",
26910 underline_minimum_offset
,
26911 doc
: /* Minimum distance between baseline and underline.
26912 This can improve legibility of underlined text at small font sizes,
26913 particularly when using variable `x-use-underline-position-properties'
26914 with fonts that specify an UNDERLINE_POSITION relatively close to the
26915 baseline. The default value is 1. */);
26916 underline_minimum_offset
= 1;
26918 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26919 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26920 This feature only works when on a window system that can change
26921 cursor shapes. */);
26922 display_hourglass_p
= 1;
26924 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26925 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26926 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26928 hourglass_atimer
= NULL
;
26929 hourglass_shown_p
= 0;
26931 DEFSYM (Qglyphless_char
, "glyphless-char");
26932 DEFSYM (Qhex_code
, "hex-code");
26933 DEFSYM (Qempty_box
, "empty-box");
26934 DEFSYM (Qthin_space
, "thin-space");
26935 DEFSYM (Qzero_width
, "zero-width");
26937 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26938 /* Intern this now in case it isn't already done.
26939 Setting this variable twice is harmless.
26940 But don't staticpro it here--that is done in alloc.c. */
26941 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26942 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26944 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26945 doc
: /* Char-table to control displaying of glyphless characters.
26946 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26947 or one of these symbols:
26948 hex-code: display the hexadecimal code of a character in a box
26949 empty-box: display as an empty box
26950 thin-space: display as 1-pixel width space
26951 zero-width: don't display
26953 It has one extra slot to control the display of a character for which
26954 no font is found. The value of the slot is `hex-code' or `empty-box'.
26955 The default is `empty-box'. */);
26956 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26957 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26962 /* Initialize this module when Emacs starts. */
26967 Lisp_Object root_window
;
26968 struct window
*mini_w
;
26970 current_header_line_height
= current_mode_line_height
= -1;
26972 CHARPOS (this_line_start_pos
) = 0;
26974 mini_w
= XWINDOW (minibuf_window
);
26975 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26977 if (!noninteractive
)
26979 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26982 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26983 set_window_height (root_window
,
26984 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26986 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26987 set_window_height (minibuf_window
, 1, 0);
26989 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26990 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26992 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26993 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26994 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26996 /* The default ellipsis glyphs `...'. */
26997 for (i
= 0; i
< 3; ++i
)
26998 default_invis_vector
[i
] = make_number ('.');
27002 /* Allocate the buffer for frame titles.
27003 Also used for `format-mode-line'. */
27005 mode_line_noprop_buf
= (char *) xmalloc (size
);
27006 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27007 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27008 mode_line_target
= MODE_LINE_DISPLAY
;
27011 help_echo_showing_p
= 0;
27014 /* Since w32 does not support atimers, it defines its own implementation of
27015 the following three functions in w32fns.c. */
27018 /* Platform-independent portion of hourglass implementation. */
27020 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27022 hourglass_started (void)
27024 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27027 /* Cancel a currently active hourglass timer, and start a new one. */
27029 start_hourglass (void)
27031 #if defined (HAVE_WINDOW_SYSTEM)
27033 int secs
, usecs
= 0;
27035 cancel_hourglass ();
27037 if (INTEGERP (Vhourglass_delay
)
27038 && XINT (Vhourglass_delay
) > 0)
27039 secs
= XFASTINT (Vhourglass_delay
);
27040 else if (FLOATP (Vhourglass_delay
)
27041 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27044 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27045 secs
= XFASTINT (tem
);
27046 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27049 secs
= DEFAULT_HOURGLASS_DELAY
;
27051 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27052 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27053 show_hourglass
, NULL
);
27058 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27061 cancel_hourglass (void)
27063 #if defined (HAVE_WINDOW_SYSTEM)
27064 if (hourglass_atimer
)
27066 cancel_atimer (hourglass_atimer
);
27067 hourglass_atimer
= NULL
;
27070 if (hourglass_shown_p
)
27074 #endif /* ! WINDOWSNT */