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 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 Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 int message_enable_multibyte
;
509 /* Nonzero if we should redraw the mode lines on the next redisplay. */
511 int update_mode_lines
;
513 /* Nonzero if window sizes or contents have changed since last
514 redisplay that finished. */
516 int windows_or_buffers_changed
;
518 /* Nonzero means a frame's cursor type has been changed. */
520 int cursor_type_changed
;
522 /* Nonzero after display_mode_line if %l was used and it displayed a
525 int line_number_displayed
;
527 /* The name of the *Messages* buffer, a string. */
529 static Lisp_Object Vmessages_buffer_name
;
531 /* Current, index 0, and last displayed echo area message. Either
532 buffers from echo_buffers, or nil to indicate no message. */
534 Lisp_Object echo_area_buffer
[2];
536 /* The buffers referenced from echo_area_buffer. */
538 static Lisp_Object echo_buffer
[2];
540 /* A vector saved used in with_area_buffer to reduce consing. */
542 static Lisp_Object Vwith_echo_area_save_vector
;
544 /* Non-zero means display_echo_area should display the last echo area
545 message again. Set by redisplay_preserve_echo_area. */
547 static int display_last_displayed_message_p
;
549 /* Nonzero if echo area is being used by print; zero if being used by
552 int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 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 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 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 mark_window_display_accurate_1 (struct window
*, int);
760 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
761 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
762 static int cursor_row_p (struct glyph_row
*);
763 static int redisplay_mode_lines (Lisp_Object
, int);
764 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
766 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
768 static void handle_line_prefix (struct it
*);
770 static void pint2str (char *, int, EMACS_INT
);
771 static void pint2hrstr (char *, int, EMACS_INT
);
772 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
774 static void reconsider_clip_changes (struct window
*, struct buffer
*);
775 static int text_outside_line_unchanged_p (struct window
*,
776 EMACS_INT
, EMACS_INT
);
777 static void store_mode_line_noprop_char (char);
778 static int store_mode_line_noprop (const char *, int, int);
779 static void handle_stop (struct it
*);
780 static void handle_stop_backwards (struct it
*, EMACS_INT
);
781 static int single_display_spec_intangible_p (Lisp_Object
);
782 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
783 static void ensure_echo_area_buffers (void);
784 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
785 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
786 static int with_echo_area_buffer (struct window
*, int,
787 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
788 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static void clear_garbaged_frames (void);
790 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
791 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
793 static int display_echo_area (struct window
*);
794 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
795 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static Lisp_Object
unwind_redisplay (Lisp_Object
);
797 static int string_char_and_length (const unsigned char *, int *);
798 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
800 static int compute_window_start_on_continuation_line (struct window
*);
801 static Lisp_Object
safe_eval_handler (Lisp_Object
);
802 static void insert_left_trunc_glyphs (struct it
*);
803 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
805 static void extend_face_to_end_of_line (struct it
*);
806 static int append_space_for_newline (struct it
*, int);
807 static int cursor_row_fully_visible_p (struct window
*, int, int);
808 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
809 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
810 static int trailing_whitespace_p (EMACS_INT
);
811 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
812 static void push_it (struct it
*);
813 static void pop_it (struct it
*);
814 static void sync_frame_with_window_matrix_rows (struct window
*);
815 static void select_frame_for_redisplay (Lisp_Object
);
816 static void redisplay_internal (void);
817 static int echo_area_display (int);
818 static void redisplay_windows (Lisp_Object
);
819 static void redisplay_window (Lisp_Object
, int);
820 static Lisp_Object
redisplay_window_error (Lisp_Object
);
821 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
822 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
823 static int update_menu_bar (struct frame
*, int, int);
824 static int try_window_reusing_current_matrix (struct window
*);
825 static int try_window_id (struct window
*);
826 static int display_line (struct it
*);
827 static int display_mode_lines (struct window
*);
828 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
829 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
830 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
831 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
832 static void display_menu_bar (struct window
*);
833 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
835 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
836 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
837 static void compute_line_metrics (struct it
*);
838 static void run_redisplay_end_trigger_hook (struct it
*);
839 static int get_overlay_strings (struct it
*, EMACS_INT
);
840 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
841 static void next_overlay_string (struct it
*);
842 static void reseat (struct it
*, struct text_pos
, int);
843 static void reseat_1 (struct it
*, struct text_pos
, int);
844 static void back_to_previous_visible_line_start (struct it
*);
845 void reseat_at_previous_visible_line_start (struct it
*);
846 static void reseat_at_next_visible_line_start (struct it
*, int);
847 static int next_element_from_ellipsis (struct it
*);
848 static int next_element_from_display_vector (struct it
*);
849 static int next_element_from_string (struct it
*);
850 static int next_element_from_c_string (struct it
*);
851 static int next_element_from_buffer (struct it
*);
852 static int next_element_from_composition (struct it
*);
853 static int next_element_from_image (struct it
*);
854 static int next_element_from_stretch (struct it
*);
855 static void load_overlay_strings (struct it
*, EMACS_INT
);
856 static int init_from_display_pos (struct it
*, struct window
*,
857 struct display_pos
*);
858 static void reseat_to_string (struct it
*, const char *,
859 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
860 static enum move_it_result
861 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
862 enum move_operation_enum
);
863 void move_it_vertically_backward (struct it
*, int);
864 static void init_to_row_start (struct it
*, struct window
*,
866 static int init_to_row_end (struct it
*, struct window
*,
868 static void back_to_previous_line_start (struct it
*);
869 static int forward_to_next_line_start (struct it
*, int *);
870 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
871 Lisp_Object
, EMACS_INT
);
872 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
873 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
874 static EMACS_INT
number_of_chars (const char *, int);
875 static void compute_stop_pos (struct it
*);
876 static void compute_string_pos (struct text_pos
*, struct text_pos
,
878 static int face_before_or_after_it_pos (struct it
*, int);
879 static EMACS_INT
next_overlay_change (EMACS_INT
);
880 static int handle_single_display_spec (struct it
*, Lisp_Object
,
881 Lisp_Object
, Lisp_Object
,
882 struct text_pos
*, int);
883 static int underlying_face_id (struct it
*);
884 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
887 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
888 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
890 #ifdef HAVE_WINDOW_SYSTEM
892 static void x_consider_frame_title (Lisp_Object
);
893 static int tool_bar_lines_needed (struct frame
*, int *);
894 static void update_tool_bar (struct frame
*, int);
895 static void build_desired_tool_bar_string (struct frame
*f
);
896 static int redisplay_tool_bar (struct frame
*);
897 static void display_tool_bar_line (struct it
*, int);
898 static void notice_overwritten_cursor (struct window
*,
901 static void append_stretch_glyph (struct it
*, Lisp_Object
,
905 #endif /* HAVE_WINDOW_SYSTEM */
907 static int coords_in_mouse_face_p (struct window
*, int, int);
911 /***********************************************************************
912 Window display dimensions
913 ***********************************************************************/
915 /* Return the bottom boundary y-position for text lines in window W.
916 This is the first y position at which a line cannot start.
917 It is relative to the top of the window.
919 This is the height of W minus the height of a mode line, if any. */
922 window_text_bottom_y (struct window
*w
)
924 int height
= WINDOW_TOTAL_HEIGHT (w
);
926 if (WINDOW_WANTS_MODELINE_P (w
))
927 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
931 /* Return the pixel width of display area AREA of window W. AREA < 0
932 means return the total width of W, not including fringes to
933 the left and right of the window. */
936 window_box_width (struct window
*w
, int area
)
938 int cols
= XFASTINT (w
->total_cols
);
941 if (!w
->pseudo_window_p
)
943 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
945 if (area
== TEXT_AREA
)
947 if (INTEGERP (w
->left_margin_cols
))
948 cols
-= XFASTINT (w
->left_margin_cols
);
949 if (INTEGERP (w
->right_margin_cols
))
950 cols
-= XFASTINT (w
->right_margin_cols
);
951 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
953 else if (area
== LEFT_MARGIN_AREA
)
955 cols
= (INTEGERP (w
->left_margin_cols
)
956 ? XFASTINT (w
->left_margin_cols
) : 0);
959 else if (area
== RIGHT_MARGIN_AREA
)
961 cols
= (INTEGERP (w
->right_margin_cols
)
962 ? XFASTINT (w
->right_margin_cols
) : 0);
967 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
971 /* Return the pixel height of the display area of window W, not
972 including mode lines of W, if any. */
975 window_box_height (struct window
*w
)
977 struct frame
*f
= XFRAME (w
->frame
);
978 int height
= WINDOW_TOTAL_HEIGHT (w
);
980 xassert (height
>= 0);
982 /* Note: the code below that determines the mode-line/header-line
983 height is essentially the same as that contained in the macro
984 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
985 the appropriate glyph row has its `mode_line_p' flag set,
986 and if it doesn't, uses estimate_mode_line_height instead. */
988 if (WINDOW_WANTS_MODELINE_P (w
))
990 struct glyph_row
*ml_row
991 = (w
->current_matrix
&& w
->current_matrix
->rows
992 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
994 if (ml_row
&& ml_row
->mode_line_p
)
995 height
-= ml_row
->height
;
997 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1000 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1002 struct glyph_row
*hl_row
1003 = (w
->current_matrix
&& w
->current_matrix
->rows
1004 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1006 if (hl_row
&& hl_row
->mode_line_p
)
1007 height
-= hl_row
->height
;
1009 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1012 /* With a very small font and a mode-line that's taller than
1013 default, we might end up with a negative height. */
1014 return max (0, height
);
1017 /* Return the window-relative coordinate of the left edge of display
1018 area AREA of window W. AREA < 0 means return the left edge of the
1019 whole window, to the right of the left fringe of W. */
1022 window_box_left_offset (struct window
*w
, int area
)
1026 if (w
->pseudo_window_p
)
1029 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1031 if (area
== TEXT_AREA
)
1032 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1033 + window_box_width (w
, LEFT_MARGIN_AREA
));
1034 else if (area
== RIGHT_MARGIN_AREA
)
1035 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1036 + window_box_width (w
, LEFT_MARGIN_AREA
)
1037 + window_box_width (w
, TEXT_AREA
)
1038 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1040 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1041 else if (area
== LEFT_MARGIN_AREA
1042 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1043 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1049 /* Return the window-relative coordinate of the right edge of display
1050 area AREA of window W. AREA < 0 means return the right edge of the
1051 whole window, to the left of the right fringe of W. */
1054 window_box_right_offset (struct window
*w
, int area
)
1056 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1059 /* Return the frame-relative coordinate of the left edge of display
1060 area AREA of window W. AREA < 0 means return the left edge of the
1061 whole window, to the right of the left fringe of W. */
1064 window_box_left (struct window
*w
, int area
)
1066 struct frame
*f
= XFRAME (w
->frame
);
1069 if (w
->pseudo_window_p
)
1070 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1072 x
= (WINDOW_LEFT_EDGE_X (w
)
1073 + window_box_left_offset (w
, area
));
1079 /* Return the frame-relative coordinate of the right edge of display
1080 area AREA of window W. AREA < 0 means return the right edge of the
1081 whole window, to the left of the right fringe of W. */
1084 window_box_right (struct window
*w
, int area
)
1086 return window_box_left (w
, area
) + window_box_width (w
, area
);
1089 /* Get the bounding box of the display area AREA of window W, without
1090 mode lines, in frame-relative coordinates. AREA < 0 means the
1091 whole window, not including the left and right fringes of
1092 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1093 coordinates of the upper-left corner of the box. Return in
1094 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1097 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1098 int *box_width
, int *box_height
)
1101 *box_width
= window_box_width (w
, area
);
1103 *box_height
= window_box_height (w
);
1105 *box_x
= window_box_left (w
, area
);
1108 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1109 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1110 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1115 /* Get the bounding box of the display area AREA of window W, without
1116 mode lines. AREA < 0 means the whole window, not including the
1117 left and right fringe of the window. Return in *TOP_LEFT_X
1118 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1119 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1120 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1124 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1125 int *bottom_right_x
, int *bottom_right_y
)
1127 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1129 *bottom_right_x
+= *top_left_x
;
1130 *bottom_right_y
+= *top_left_y
;
1135 /***********************************************************************
1137 ***********************************************************************/
1139 /* Return the bottom y-position of the line the iterator IT is in.
1140 This can modify IT's settings. */
1143 line_bottom_y (struct it
*it
)
1145 int line_height
= it
->max_ascent
+ it
->max_descent
;
1146 int line_top_y
= it
->current_y
;
1148 if (line_height
== 0)
1151 line_height
= last_height
;
1152 else if (IT_CHARPOS (*it
) < ZV
)
1154 move_it_by_lines (it
, 1);
1155 line_height
= (it
->max_ascent
|| it
->max_descent
1156 ? it
->max_ascent
+ it
->max_descent
1161 struct glyph_row
*row
= it
->glyph_row
;
1163 /* Use the default character height. */
1164 it
->glyph_row
= NULL
;
1165 it
->what
= IT_CHARACTER
;
1168 PRODUCE_GLYPHS (it
);
1169 line_height
= it
->ascent
+ it
->descent
;
1170 it
->glyph_row
= row
;
1174 return line_top_y
+ line_height
;
1178 /* Return 1 if position CHARPOS is visible in window W.
1179 CHARPOS < 0 means return info about WINDOW_END position.
1180 If visible, set *X and *Y to pixel coordinates of top left corner.
1181 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1182 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1185 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1186 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1189 struct text_pos top
;
1191 struct buffer
*old_buffer
= NULL
;
1193 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1196 if (XBUFFER (w
->buffer
) != current_buffer
)
1198 old_buffer
= current_buffer
;
1199 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1202 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1204 /* Compute exact mode line heights. */
1205 if (WINDOW_WANTS_MODELINE_P (w
))
1206 current_mode_line_height
1207 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1208 BVAR (current_buffer
, mode_line_format
));
1210 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1211 current_header_line_height
1212 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1213 BVAR (current_buffer
, header_line_format
));
1215 start_display (&it
, w
, top
);
1216 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1217 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1219 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1221 /* We have reached CHARPOS, or passed it. How the call to
1222 move_it_to can overshoot: (i) If CHARPOS is on invisible
1223 text, move_it_to stops at the end of the invisible text,
1224 after CHARPOS. (ii) If CHARPOS is in a display vector,
1225 move_it_to stops on its last glyph. */
1226 int top_x
= it
.current_x
;
1227 int top_y
= it
.current_y
;
1228 enum it_method it_method
= it
.method
;
1229 /* Calling line_bottom_y may change it.method, it.position, etc. */
1230 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1231 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1233 if (top_y
< window_top_y
)
1234 visible_p
= bottom_y
> window_top_y
;
1235 else if (top_y
< it
.last_visible_y
)
1239 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1241 /* We stopped on the last glyph of a display vector.
1242 Try and recompute. Hack alert! */
1243 if (charpos
< 2 || top
.charpos
>= charpos
)
1244 top_x
= it
.glyph_row
->x
;
1248 start_display (&it2
, w
, top
);
1249 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1250 get_next_display_element (&it2
);
1251 PRODUCE_GLYPHS (&it2
);
1252 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1253 || it2
.current_x
> it2
.last_visible_x
)
1254 top_x
= it
.glyph_row
->x
;
1257 top_x
= it2
.current_x
;
1258 top_y
= it2
.current_y
;
1264 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1265 *rtop
= max (0, window_top_y
- top_y
);
1266 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1267 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1268 - max (top_y
, window_top_y
)));
1277 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1278 move_it_by_lines (&it
, 1);
1279 if (charpos
< IT_CHARPOS (it
)
1280 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1283 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1285 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1286 *rtop
= max (0, -it2
.current_y
);
1287 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1288 - it
.last_visible_y
));
1289 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1291 - max (it2
.current_y
,
1292 WINDOW_HEADER_LINE_HEIGHT (w
))));
1298 set_buffer_internal_1 (old_buffer
);
1300 current_header_line_height
= current_mode_line_height
= -1;
1302 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1303 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1306 /* Debugging code. */
1308 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1309 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1311 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1318 /* Return the next character from STR. Return in *LEN the length of
1319 the character. This is like STRING_CHAR_AND_LENGTH but never
1320 returns an invalid character. If we find one, we return a `?', but
1321 with the length of the invalid character. */
1324 string_char_and_length (const unsigned char *str
, int *len
)
1328 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1329 if (!CHAR_VALID_P (c
, 1))
1330 /* We may not change the length here because other places in Emacs
1331 don't use this function, i.e. they silently accept invalid
1340 /* Given a position POS containing a valid character and byte position
1341 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1343 static struct text_pos
1344 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1346 xassert (STRINGP (string
) && nchars
>= 0);
1348 if (STRING_MULTIBYTE (string
))
1350 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1355 string_char_and_length (p
, &len
);
1358 BYTEPOS (pos
) += len
;
1362 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1368 /* Value is the text position, i.e. character and byte position,
1369 for character position CHARPOS in STRING. */
1371 static INLINE
struct text_pos
1372 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1374 struct text_pos pos
;
1375 xassert (STRINGP (string
));
1376 xassert (charpos
>= 0);
1377 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1382 /* Value is a text position, i.e. character and byte position, for
1383 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1384 means recognize multibyte characters. */
1386 static struct text_pos
1387 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1389 struct text_pos pos
;
1391 xassert (s
!= NULL
);
1392 xassert (charpos
>= 0);
1398 SET_TEXT_POS (pos
, 0, 0);
1401 string_char_and_length ((const unsigned char *) s
, &len
);
1404 BYTEPOS (pos
) += len
;
1408 SET_TEXT_POS (pos
, charpos
, charpos
);
1414 /* Value is the number of characters in C string S. MULTIBYTE_P
1415 non-zero means recognize multibyte characters. */
1418 number_of_chars (const char *s
, int multibyte_p
)
1424 EMACS_INT rest
= strlen (s
);
1426 const unsigned char *p
= (const unsigned char *) s
;
1428 for (nchars
= 0; rest
> 0; ++nchars
)
1430 string_char_and_length (p
, &len
);
1431 rest
-= len
, p
+= len
;
1435 nchars
= strlen (s
);
1441 /* Compute byte position NEWPOS->bytepos corresponding to
1442 NEWPOS->charpos. POS is a known position in string STRING.
1443 NEWPOS->charpos must be >= POS.charpos. */
1446 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1448 xassert (STRINGP (string
));
1449 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1451 if (STRING_MULTIBYTE (string
))
1452 *newpos
= string_pos_nchars_ahead (pos
, string
,
1453 CHARPOS (*newpos
) - CHARPOS (pos
));
1455 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1459 Return an estimation of the pixel height of mode or header lines on
1460 frame F. FACE_ID specifies what line's height to estimate. */
1463 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1465 #ifdef HAVE_WINDOW_SYSTEM
1466 if (FRAME_WINDOW_P (f
))
1468 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1470 /* This function is called so early when Emacs starts that the face
1471 cache and mode line face are not yet initialized. */
1472 if (FRAME_FACE_CACHE (f
))
1474 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1478 height
= FONT_HEIGHT (face
->font
);
1479 if (face
->box_line_width
> 0)
1480 height
+= 2 * face
->box_line_width
;
1491 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1492 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1493 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1494 not force the value into range. */
1497 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1498 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1501 #ifdef HAVE_WINDOW_SYSTEM
1502 if (FRAME_WINDOW_P (f
))
1504 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1505 even for negative values. */
1507 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1509 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1511 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1512 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1515 STORE_NATIVE_RECT (*bounds
,
1516 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1517 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1518 FRAME_COLUMN_WIDTH (f
) - 1,
1519 FRAME_LINE_HEIGHT (f
) - 1);
1525 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1526 pix_x
= FRAME_TOTAL_COLS (f
);
1530 else if (pix_y
> FRAME_LINES (f
))
1531 pix_y
= FRAME_LINES (f
);
1541 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1542 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1543 can't tell the positions because W's display is not up to date,
1547 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1548 int *frame_x
, int *frame_y
)
1550 #ifdef HAVE_WINDOW_SYSTEM
1551 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1555 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1556 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1558 if (display_completed
)
1560 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1561 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1562 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1568 hpos
+= glyph
->pixel_width
;
1572 /* If first glyph is partially visible, its first visible position is still 0. */
1584 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1585 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1596 /* Find the glyph under window-relative coordinates X/Y in window W.
1597 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1598 strings. Return in *HPOS and *VPOS the row and column number of
1599 the glyph found. Return in *AREA the glyph area containing X.
1600 Value is a pointer to the glyph found or null if X/Y is not on
1601 text, or we can't tell because W's current matrix is not up to
1606 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1607 int *dx
, int *dy
, int *area
)
1609 struct glyph
*glyph
, *end
;
1610 struct glyph_row
*row
= NULL
;
1613 /* Find row containing Y. Give up if some row is not enabled. */
1614 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1616 row
= MATRIX_ROW (w
->current_matrix
, i
);
1617 if (!row
->enabled_p
)
1619 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1626 /* Give up if Y is not in the window. */
1627 if (i
== w
->current_matrix
->nrows
)
1630 /* Get the glyph area containing X. */
1631 if (w
->pseudo_window_p
)
1638 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1640 *area
= LEFT_MARGIN_AREA
;
1641 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1643 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1646 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1650 *area
= RIGHT_MARGIN_AREA
;
1651 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1655 /* Find glyph containing X. */
1656 glyph
= row
->glyphs
[*area
];
1657 end
= glyph
+ row
->used
[*area
];
1659 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1661 x
-= glyph
->pixel_width
;
1671 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1674 *hpos
= glyph
- row
->glyphs
[*area
];
1679 Convert frame-relative x/y to coordinates relative to window W.
1680 Takes pseudo-windows into account. */
1683 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1685 if (w
->pseudo_window_p
)
1687 /* A pseudo-window is always full-width, and starts at the
1688 left edge of the frame, plus a frame border. */
1689 struct frame
*f
= XFRAME (w
->frame
);
1690 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 *x
-= WINDOW_LEFT_EDGE_X (w
);
1696 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1700 #ifdef HAVE_WINDOW_SYSTEM
1703 Return in RECTS[] at most N clipping rectangles for glyph string S.
1704 Return the number of stored rectangles. */
1707 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1714 if (s
->row
->full_width_p
)
1716 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1717 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1718 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1720 /* Unless displaying a mode or menu bar line, which are always
1721 fully visible, clip to the visible part of the row. */
1722 if (s
->w
->pseudo_window_p
)
1723 r
.height
= s
->row
->visible_height
;
1725 r
.height
= s
->height
;
1729 /* This is a text line that may be partially visible. */
1730 r
.x
= window_box_left (s
->w
, s
->area
);
1731 r
.width
= window_box_width (s
->w
, s
->area
);
1732 r
.height
= s
->row
->visible_height
;
1736 if (r
.x
< s
->clip_head
->x
)
1738 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1739 r
.width
-= s
->clip_head
->x
- r
.x
;
1742 r
.x
= s
->clip_head
->x
;
1745 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1747 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1748 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1753 /* If S draws overlapping rows, it's sufficient to use the top and
1754 bottom of the window for clipping because this glyph string
1755 intentionally draws over other lines. */
1756 if (s
->for_overlaps
)
1758 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1759 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1761 /* Alas, the above simple strategy does not work for the
1762 environments with anti-aliased text: if the same text is
1763 drawn onto the same place multiple times, it gets thicker.
1764 If the overlap we are processing is for the erased cursor, we
1765 take the intersection with the rectagle of the cursor. */
1766 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1768 XRectangle rc
, r_save
= r
;
1770 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1771 rc
.y
= s
->w
->phys_cursor
.y
;
1772 rc
.width
= s
->w
->phys_cursor_width
;
1773 rc
.height
= s
->w
->phys_cursor_height
;
1775 x_intersect_rectangles (&r_save
, &rc
, &r
);
1780 /* Don't use S->y for clipping because it doesn't take partially
1781 visible lines into account. For example, it can be negative for
1782 partially visible lines at the top of a window. */
1783 if (!s
->row
->full_width_p
1784 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1785 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1787 r
.y
= max (0, s
->row
->y
);
1790 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1792 /* If drawing the cursor, don't let glyph draw outside its
1793 advertised boundaries. Cleartype does this under some circumstances. */
1794 if (s
->hl
== DRAW_CURSOR
)
1796 struct glyph
*glyph
= s
->first_glyph
;
1801 r
.width
-= s
->x
- r
.x
;
1804 r
.width
= min (r
.width
, glyph
->pixel_width
);
1806 /* If r.y is below window bottom, ensure that we still see a cursor. */
1807 height
= min (glyph
->ascent
+ glyph
->descent
,
1808 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1809 max_y
= window_text_bottom_y (s
->w
) - height
;
1810 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1811 if (s
->ybase
- glyph
->ascent
> max_y
)
1818 /* Don't draw cursor glyph taller than our actual glyph. */
1819 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1820 if (height
< r
.height
)
1822 max_y
= r
.y
+ r
.height
;
1823 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1824 r
.height
= min (max_y
- r
.y
, height
);
1831 XRectangle r_save
= r
;
1833 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1837 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1838 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1840 #ifdef CONVERT_FROM_XRECT
1841 CONVERT_FROM_XRECT (r
, *rects
);
1849 /* If we are processing overlapping and allowed to return
1850 multiple clipping rectangles, we exclude the row of the glyph
1851 string from the clipping rectangle. This is to avoid drawing
1852 the same text on the environment with anti-aliasing. */
1853 #ifdef CONVERT_FROM_XRECT
1856 XRectangle
*rs
= rects
;
1858 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1860 if (s
->for_overlaps
& OVERLAPS_PRED
)
1863 if (r
.y
+ r
.height
> row_y
)
1866 rs
[i
].height
= row_y
- r
.y
;
1872 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1875 if (r
.y
< row_y
+ s
->row
->visible_height
)
1877 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1879 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1880 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1889 #ifdef CONVERT_FROM_XRECT
1890 for (i
= 0; i
< n
; i
++)
1891 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1898 Return in *NR the clipping rectangle for glyph string S. */
1901 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1903 get_glyph_string_clip_rects (s
, nr
, 1);
1908 Return the position and height of the phys cursor in window W.
1909 Set w->phys_cursor_width to width of phys cursor.
1913 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1914 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1916 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1917 int x
, y
, wd
, h
, h0
, y0
;
1919 /* Compute the width of the rectangle to draw. If on a stretch
1920 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1921 rectangle as wide as the glyph, but use a canonical character
1923 wd
= glyph
->pixel_width
- 1;
1924 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1928 x
= w
->phys_cursor
.x
;
1935 if (glyph
->type
== STRETCH_GLYPH
1936 && !x_stretch_cursor_p
)
1937 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1938 w
->phys_cursor_width
= wd
;
1940 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1942 /* If y is below window bottom, ensure that we still see a cursor. */
1943 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1945 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1946 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1948 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1951 h
= max (h
- (y0
- y
) + 1, h0
);
1956 y0
= window_text_bottom_y (w
) - h0
;
1964 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1965 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1970 * Remember which glyph the mouse is over.
1974 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1978 struct glyph_row
*r
, *gr
, *end_row
;
1979 enum window_part part
;
1980 enum glyph_row_area area
;
1981 int x
, y
, width
, height
;
1983 /* Try to determine frame pixel position and size of the glyph under
1984 frame pixel coordinates X/Y on frame F. */
1986 if (!f
->glyphs_initialized_p
1987 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1990 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1991 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1995 w
= XWINDOW (window
);
1996 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1997 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1999 x
= window_relative_x_coord (w
, part
, gx
);
2000 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2002 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2003 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2005 if (w
->pseudo_window_p
)
2008 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2014 case ON_LEFT_MARGIN
:
2015 area
= LEFT_MARGIN_AREA
;
2018 case ON_RIGHT_MARGIN
:
2019 area
= RIGHT_MARGIN_AREA
;
2022 case ON_HEADER_LINE
:
2024 gr
= (part
== ON_HEADER_LINE
2025 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2026 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2029 goto text_glyph_row_found
;
2036 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2037 if (r
->y
+ r
->height
> y
)
2043 text_glyph_row_found
:
2046 struct glyph
*g
= gr
->glyphs
[area
];
2047 struct glyph
*end
= g
+ gr
->used
[area
];
2049 height
= gr
->height
;
2050 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2051 if (gx
+ g
->pixel_width
> x
)
2056 if (g
->type
== IMAGE_GLYPH
)
2058 /* Don't remember when mouse is over image, as
2059 image may have hot-spots. */
2060 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2063 width
= g
->pixel_width
;
2067 /* Use nominal char spacing at end of line. */
2069 gx
+= (x
/ width
) * width
;
2072 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2073 gx
+= window_box_left_offset (w
, area
);
2077 /* Use nominal line height at end of window. */
2078 gx
= (x
/ width
) * width
;
2080 gy
+= (y
/ height
) * height
;
2084 case ON_LEFT_FRINGE
:
2085 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2086 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2087 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2088 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2091 case ON_RIGHT_FRINGE
:
2092 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2093 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2094 : window_box_right_offset (w
, TEXT_AREA
));
2095 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2099 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2101 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2102 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2103 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2105 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2109 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2110 if (r
->y
+ r
->height
> y
)
2117 height
= gr
->height
;
2120 /* Use nominal line height at end of window. */
2122 gy
+= (y
/ height
) * height
;
2129 /* If there is no glyph under the mouse, then we divide the screen
2130 into a grid of the smallest glyph in the frame, and use that
2133 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2134 round down even for negative values. */
2140 gx
= (gx
/ width
) * width
;
2141 gy
= (gy
/ height
) * height
;
2146 gx
+= WINDOW_LEFT_EDGE_X (w
);
2147 gy
+= WINDOW_TOP_EDGE_Y (w
);
2150 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2152 /* Visible feedback for debugging. */
2155 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2156 f
->output_data
.x
->normal_gc
,
2157 gx
, gy
, width
, height
);
2163 #endif /* HAVE_WINDOW_SYSTEM */
2166 /***********************************************************************
2167 Lisp form evaluation
2168 ***********************************************************************/
2170 /* Error handler for safe_eval and safe_call. */
2173 safe_eval_handler (Lisp_Object arg
)
2175 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2180 /* Evaluate SEXPR and return the result, or nil if something went
2181 wrong. Prevent redisplay during the evaluation. */
2183 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2184 Return the result, or nil if something went wrong. Prevent
2185 redisplay during the evaluation. */
2188 safe_call (size_t nargs
, Lisp_Object
*args
)
2192 if (inhibit_eval_during_redisplay
)
2196 int count
= SPECPDL_INDEX ();
2197 struct gcpro gcpro1
;
2200 gcpro1
.nvars
= nargs
;
2201 specbind (Qinhibit_redisplay
, Qt
);
2202 /* Use Qt to ensure debugger does not run,
2203 so there is no possibility of wanting to redisplay. */
2204 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2207 val
= unbind_to (count
, val
);
2214 /* Call function FN with one argument ARG.
2215 Return the result, or nil if something went wrong. */
2218 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2220 Lisp_Object args
[2];
2223 return safe_call (2, args
);
2226 static Lisp_Object Qeval
;
2229 safe_eval (Lisp_Object sexpr
)
2231 return safe_call1 (Qeval
, sexpr
);
2234 /* Call function FN with one argument ARG.
2235 Return the result, or nil if something went wrong. */
2238 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2240 Lisp_Object args
[3];
2244 return safe_call (3, args
);
2249 /***********************************************************************
2251 ***********************************************************************/
2255 /* Define CHECK_IT to perform sanity checks on iterators.
2256 This is for debugging. It is too slow to do unconditionally. */
2262 if (it
->method
== GET_FROM_STRING
)
2264 xassert (STRINGP (it
->string
));
2265 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2269 xassert (IT_STRING_CHARPOS (*it
) < 0);
2270 if (it
->method
== GET_FROM_BUFFER
)
2272 /* Check that character and byte positions agree. */
2273 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2278 xassert (it
->current
.dpvec_index
>= 0);
2280 xassert (it
->current
.dpvec_index
< 0);
2283 #define CHECK_IT(IT) check_it ((IT))
2287 #define CHECK_IT(IT) (void) 0
2294 /* Check that the window end of window W is what we expect it
2295 to be---the last row in the current matrix displaying text. */
2298 check_window_end (w
)
2301 if (!MINI_WINDOW_P (w
)
2302 && !NILP (w
->window_end_valid
))
2304 struct glyph_row
*row
;
2305 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2306 XFASTINT (w
->window_end_vpos
)),
2308 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2309 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2313 #define CHECK_WINDOW_END(W) check_window_end ((W))
2315 #else /* not GLYPH_DEBUG */
2317 #define CHECK_WINDOW_END(W) (void) 0
2319 #endif /* not GLYPH_DEBUG */
2323 /***********************************************************************
2324 Iterator initialization
2325 ***********************************************************************/
2327 /* Initialize IT for displaying current_buffer in window W, starting
2328 at character position CHARPOS. CHARPOS < 0 means that no buffer
2329 position is specified which is useful when the iterator is assigned
2330 a position later. BYTEPOS is the byte position corresponding to
2331 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2333 If ROW is not null, calls to produce_glyphs with IT as parameter
2334 will produce glyphs in that row.
2336 BASE_FACE_ID is the id of a base face to use. It must be one of
2337 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2338 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2339 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2341 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2342 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2343 will be initialized to use the corresponding mode line glyph row of
2344 the desired matrix of W. */
2347 init_iterator (struct it
*it
, struct window
*w
,
2348 EMACS_INT charpos
, EMACS_INT bytepos
,
2349 struct glyph_row
*row
, enum face_id base_face_id
)
2351 int highlight_region_p
;
2352 enum face_id remapped_base_face_id
= base_face_id
;
2354 /* Some precondition checks. */
2355 xassert (w
!= NULL
&& it
!= NULL
);
2356 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2359 /* If face attributes have been changed since the last redisplay,
2360 free realized faces now because they depend on face definitions
2361 that might have changed. Don't free faces while there might be
2362 desired matrices pending which reference these faces. */
2363 if (face_change_count
&& !inhibit_free_realized_faces
)
2365 face_change_count
= 0;
2366 free_all_realized_faces (Qnil
);
2369 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2370 if (! NILP (Vface_remapping_alist
))
2371 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2373 /* Use one of the mode line rows of W's desired matrix if
2377 if (base_face_id
== MODE_LINE_FACE_ID
2378 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2379 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2380 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2381 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2385 memset (it
, 0, sizeof *it
);
2386 it
->current
.overlay_string_index
= -1;
2387 it
->current
.dpvec_index
= -1;
2388 it
->base_face_id
= remapped_base_face_id
;
2390 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2392 /* The window in which we iterate over current_buffer: */
2393 XSETWINDOW (it
->window
, w
);
2395 it
->f
= XFRAME (w
->frame
);
2399 /* Extra space between lines (on window systems only). */
2400 if (base_face_id
== DEFAULT_FACE_ID
2401 && FRAME_WINDOW_P (it
->f
))
2403 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2404 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2405 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2406 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2407 * FRAME_LINE_HEIGHT (it
->f
));
2408 else if (it
->f
->extra_line_spacing
> 0)
2409 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2410 it
->max_extra_line_spacing
= 0;
2413 /* If realized faces have been removed, e.g. because of face
2414 attribute changes of named faces, recompute them. When running
2415 in batch mode, the face cache of the initial frame is null. If
2416 we happen to get called, make a dummy face cache. */
2417 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2418 init_frame_faces (it
->f
);
2419 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2420 recompute_basic_faces (it
->f
);
2422 /* Current value of the `slice', `space-width', and 'height' properties. */
2423 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2424 it
->space_width
= Qnil
;
2425 it
->font_height
= Qnil
;
2426 it
->override_ascent
= -1;
2428 /* Are control characters displayed as `^C'? */
2429 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2431 /* -1 means everything between a CR and the following line end
2432 is invisible. >0 means lines indented more than this value are
2434 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2435 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2436 : (!NILP (BVAR (current_buffer
, selective_display
))
2438 it
->selective_display_ellipsis_p
2439 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2441 /* Display table to use. */
2442 it
->dp
= window_display_table (w
);
2444 /* Are multibyte characters enabled in current_buffer? */
2445 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2447 /* Do we need to reorder bidirectional text? Not if this is a
2448 unibyte buffer: by definition, none of the single-byte characters
2449 are strong R2L, so no reordering is needed. And bidi.c doesn't
2450 support unibyte buffers anyway. */
2452 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2454 /* Non-zero if we should highlight the region. */
2456 = (!NILP (Vtransient_mark_mode
)
2457 && !NILP (BVAR (current_buffer
, mark_active
))
2458 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2460 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2461 start and end of a visible region in window IT->w. Set both to
2462 -1 to indicate no region. */
2463 if (highlight_region_p
2464 /* Maybe highlight only in selected window. */
2465 && (/* Either show region everywhere. */
2466 highlight_nonselected_windows
2467 /* Or show region in the selected window. */
2468 || w
== XWINDOW (selected_window
)
2469 /* Or show the region if we are in the mini-buffer and W is
2470 the window the mini-buffer refers to. */
2471 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2472 && WINDOWP (minibuf_selected_window
)
2473 && w
== XWINDOW (minibuf_selected_window
))))
2475 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2476 it
->region_beg_charpos
= min (PT
, markpos
);
2477 it
->region_end_charpos
= max (PT
, markpos
);
2480 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2482 /* Get the position at which the redisplay_end_trigger hook should
2483 be run, if it is to be run at all. */
2484 if (MARKERP (w
->redisplay_end_trigger
)
2485 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2486 it
->redisplay_end_trigger_charpos
2487 = marker_position (w
->redisplay_end_trigger
);
2488 else if (INTEGERP (w
->redisplay_end_trigger
))
2489 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2491 /* Correct bogus values of tab_width. */
2492 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2493 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2496 /* Are lines in the display truncated? */
2497 if (base_face_id
!= DEFAULT_FACE_ID
2498 || XINT (it
->w
->hscroll
)
2499 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2500 && ((!NILP (Vtruncate_partial_width_windows
)
2501 && !INTEGERP (Vtruncate_partial_width_windows
))
2502 || (INTEGERP (Vtruncate_partial_width_windows
)
2503 && (WINDOW_TOTAL_COLS (it
->w
)
2504 < XINT (Vtruncate_partial_width_windows
))))))
2505 it
->line_wrap
= TRUNCATE
;
2506 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2507 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2508 ? WINDOW_WRAP
: WORD_WRAP
;
2510 it
->line_wrap
= TRUNCATE
;
2512 /* Get dimensions of truncation and continuation glyphs. These are
2513 displayed as fringe bitmaps under X, so we don't need them for such
2515 if (!FRAME_WINDOW_P (it
->f
))
2517 if (it
->line_wrap
== TRUNCATE
)
2519 /* We will need the truncation glyph. */
2520 xassert (it
->glyph_row
== NULL
);
2521 produce_special_glyphs (it
, IT_TRUNCATION
);
2522 it
->truncation_pixel_width
= it
->pixel_width
;
2526 /* We will need the continuation glyph. */
2527 xassert (it
->glyph_row
== NULL
);
2528 produce_special_glyphs (it
, IT_CONTINUATION
);
2529 it
->continuation_pixel_width
= it
->pixel_width
;
2532 /* Reset these values to zero because the produce_special_glyphs
2533 above has changed them. */
2534 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2535 it
->phys_ascent
= it
->phys_descent
= 0;
2538 /* Set this after getting the dimensions of truncation and
2539 continuation glyphs, so that we don't produce glyphs when calling
2540 produce_special_glyphs, above. */
2541 it
->glyph_row
= row
;
2542 it
->area
= TEXT_AREA
;
2544 /* Forget any previous info about this row being reversed. */
2546 it
->glyph_row
->reversed_p
= 0;
2548 /* Get the dimensions of the display area. The display area
2549 consists of the visible window area plus a horizontally scrolled
2550 part to the left of the window. All x-values are relative to the
2551 start of this total display area. */
2552 if (base_face_id
!= DEFAULT_FACE_ID
)
2554 /* Mode lines, menu bar in terminal frames. */
2555 it
->first_visible_x
= 0;
2556 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2561 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2562 it
->last_visible_x
= (it
->first_visible_x
2563 + window_box_width (w
, TEXT_AREA
));
2565 /* If we truncate lines, leave room for the truncator glyph(s) at
2566 the right margin. Otherwise, leave room for the continuation
2567 glyph(s). Truncation and continuation glyphs are not inserted
2568 for window-based redisplay. */
2569 if (!FRAME_WINDOW_P (it
->f
))
2571 if (it
->line_wrap
== TRUNCATE
)
2572 it
->last_visible_x
-= it
->truncation_pixel_width
;
2574 it
->last_visible_x
-= it
->continuation_pixel_width
;
2577 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2578 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2581 /* Leave room for a border glyph. */
2582 if (!FRAME_WINDOW_P (it
->f
)
2583 && !WINDOW_RIGHTMOST_P (it
->w
))
2584 it
->last_visible_x
-= 1;
2586 it
->last_visible_y
= window_text_bottom_y (w
);
2588 /* For mode lines and alike, arrange for the first glyph having a
2589 left box line if the face specifies a box. */
2590 if (base_face_id
!= DEFAULT_FACE_ID
)
2594 it
->face_id
= remapped_base_face_id
;
2596 /* If we have a boxed mode line, make the first character appear
2597 with a left box line. */
2598 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2599 if (face
->box
!= FACE_NO_BOX
)
2600 it
->start_of_box_run_p
= 1;
2603 /* If we are to reorder bidirectional text, init the bidi
2607 /* Note the paragraph direction that this buffer wants to
2609 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2610 it
->paragraph_embedding
= L2R
;
2611 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2612 it
->paragraph_embedding
= R2L
;
2614 it
->paragraph_embedding
= NEUTRAL_DIR
;
2615 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2618 /* If a buffer position was specified, set the iterator there,
2619 getting overlays and face properties from that position. */
2620 if (charpos
>= BUF_BEG (current_buffer
))
2622 it
->end_charpos
= ZV
;
2624 IT_CHARPOS (*it
) = charpos
;
2626 /* Compute byte position if not specified. */
2627 if (bytepos
< charpos
)
2628 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2630 IT_BYTEPOS (*it
) = bytepos
;
2632 it
->start
= it
->current
;
2634 /* Compute faces etc. */
2635 reseat (it
, it
->current
.pos
, 1);
2642 /* Initialize IT for the display of window W with window start POS. */
2645 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2647 struct glyph_row
*row
;
2648 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2650 row
= w
->desired_matrix
->rows
+ first_vpos
;
2651 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2652 it
->first_vpos
= first_vpos
;
2654 /* Don't reseat to previous visible line start if current start
2655 position is in a string or image. */
2656 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2658 int start_at_line_beg_p
;
2659 int first_y
= it
->current_y
;
2661 /* If window start is not at a line start, skip forward to POS to
2662 get the correct continuation lines width. */
2663 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2664 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2665 if (!start_at_line_beg_p
)
2669 reseat_at_previous_visible_line_start (it
);
2670 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2672 new_x
= it
->current_x
+ it
->pixel_width
;
2674 /* If lines are continued, this line may end in the middle
2675 of a multi-glyph character (e.g. a control character
2676 displayed as \003, or in the middle of an overlay
2677 string). In this case move_it_to above will not have
2678 taken us to the start of the continuation line but to the
2679 end of the continued line. */
2680 if (it
->current_x
> 0
2681 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2682 && (/* And glyph doesn't fit on the line. */
2683 new_x
> it
->last_visible_x
2684 /* Or it fits exactly and we're on a window
2686 || (new_x
== it
->last_visible_x
2687 && FRAME_WINDOW_P (it
->f
))))
2689 if (it
->current
.dpvec_index
>= 0
2690 || it
->current
.overlay_string_index
>= 0)
2692 set_iterator_to_next (it
, 1);
2693 move_it_in_display_line_to (it
, -1, -1, 0);
2696 it
->continuation_lines_width
+= it
->current_x
;
2699 /* We're starting a new display line, not affected by the
2700 height of the continued line, so clear the appropriate
2701 fields in the iterator structure. */
2702 it
->max_ascent
= it
->max_descent
= 0;
2703 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2705 it
->current_y
= first_y
;
2707 it
->current_x
= it
->hpos
= 0;
2713 /* Return 1 if POS is a position in ellipses displayed for invisible
2714 text. W is the window we display, for text property lookup. */
2717 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2719 Lisp_Object prop
, window
;
2721 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2723 /* If POS specifies a position in a display vector, this might
2724 be for an ellipsis displayed for invisible text. We won't
2725 get the iterator set up for delivering that ellipsis unless
2726 we make sure that it gets aware of the invisible text. */
2727 if (pos
->dpvec_index
>= 0
2728 && pos
->overlay_string_index
< 0
2729 && CHARPOS (pos
->string_pos
) < 0
2731 && (XSETWINDOW (window
, w
),
2732 prop
= Fget_char_property (make_number (charpos
),
2733 Qinvisible
, window
),
2734 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2736 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2738 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2745 /* Initialize IT for stepping through current_buffer in window W,
2746 starting at position POS that includes overlay string and display
2747 vector/ control character translation position information. Value
2748 is zero if there are overlay strings with newlines at POS. */
2751 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2753 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2754 int i
, overlay_strings_with_newlines
= 0;
2756 /* If POS specifies a position in a display vector, this might
2757 be for an ellipsis displayed for invisible text. We won't
2758 get the iterator set up for delivering that ellipsis unless
2759 we make sure that it gets aware of the invisible text. */
2760 if (in_ellipses_for_invisible_text_p (pos
, w
))
2766 /* Keep in mind: the call to reseat in init_iterator skips invisible
2767 text, so we might end up at a position different from POS. This
2768 is only a problem when POS is a row start after a newline and an
2769 overlay starts there with an after-string, and the overlay has an
2770 invisible property. Since we don't skip invisible text in
2771 display_line and elsewhere immediately after consuming the
2772 newline before the row start, such a POS will not be in a string,
2773 but the call to init_iterator below will move us to the
2775 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2777 /* This only scans the current chunk -- it should scan all chunks.
2778 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2779 to 16 in 22.1 to make this a lesser problem. */
2780 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2782 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2783 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2785 while (s
< e
&& *s
!= '\n')
2790 overlay_strings_with_newlines
= 1;
2795 /* If position is within an overlay string, set up IT to the right
2797 if (pos
->overlay_string_index
>= 0)
2801 /* If the first overlay string happens to have a `display'
2802 property for an image, the iterator will be set up for that
2803 image, and we have to undo that setup first before we can
2804 correct the overlay string index. */
2805 if (it
->method
== GET_FROM_IMAGE
)
2808 /* We already have the first chunk of overlay strings in
2809 IT->overlay_strings. Load more until the one for
2810 pos->overlay_string_index is in IT->overlay_strings. */
2811 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2813 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2814 it
->current
.overlay_string_index
= 0;
2817 load_overlay_strings (it
, 0);
2818 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2822 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2823 relative_index
= (it
->current
.overlay_string_index
2824 % OVERLAY_STRING_CHUNK_SIZE
);
2825 it
->string
= it
->overlay_strings
[relative_index
];
2826 xassert (STRINGP (it
->string
));
2827 it
->current
.string_pos
= pos
->string_pos
;
2828 it
->method
= GET_FROM_STRING
;
2831 if (CHARPOS (pos
->string_pos
) >= 0)
2833 /* Recorded position is not in an overlay string, but in another
2834 string. This can only be a string from a `display' property.
2835 IT should already be filled with that string. */
2836 it
->current
.string_pos
= pos
->string_pos
;
2837 xassert (STRINGP (it
->string
));
2840 /* Restore position in display vector translations, control
2841 character translations or ellipses. */
2842 if (pos
->dpvec_index
>= 0)
2844 if (it
->dpvec
== NULL
)
2845 get_next_display_element (it
);
2846 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2847 it
->current
.dpvec_index
= pos
->dpvec_index
;
2851 return !overlay_strings_with_newlines
;
2855 /* Initialize IT for stepping through current_buffer in window W
2856 starting at ROW->start. */
2859 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2861 init_from_display_pos (it
, w
, &row
->start
);
2862 it
->start
= row
->start
;
2863 it
->continuation_lines_width
= row
->continuation_lines_width
;
2868 /* Initialize IT for stepping through current_buffer in window W
2869 starting in the line following ROW, i.e. starting at ROW->end.
2870 Value is zero if there are overlay strings with newlines at ROW's
2874 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2878 if (init_from_display_pos (it
, w
, &row
->end
))
2880 if (row
->continued_p
)
2881 it
->continuation_lines_width
2882 = row
->continuation_lines_width
+ row
->pixel_width
;
2893 /***********************************************************************
2895 ***********************************************************************/
2897 /* Called when IT reaches IT->stop_charpos. Handle text property and
2898 overlay changes. Set IT->stop_charpos to the next position where
2902 handle_stop (struct it
*it
)
2904 enum prop_handled handled
;
2905 int handle_overlay_change_p
;
2909 it
->current
.dpvec_index
= -1;
2910 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2911 it
->ignore_overlay_strings_at_pos_p
= 0;
2914 /* Use face of preceding text for ellipsis (if invisible) */
2915 if (it
->selective_display_ellipsis_p
)
2916 it
->saved_face_id
= it
->face_id
;
2920 handled
= HANDLED_NORMALLY
;
2922 /* Call text property handlers. */
2923 for (p
= it_props
; p
->handler
; ++p
)
2925 handled
= p
->handler (it
);
2927 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2929 else if (handled
== HANDLED_RETURN
)
2931 /* We still want to show before and after strings from
2932 overlays even if the actual buffer text is replaced. */
2933 if (!handle_overlay_change_p
2935 || !get_overlay_strings_1 (it
, 0, 0))
2938 setup_for_ellipsis (it
, 0);
2939 /* When handling a display spec, we might load an
2940 empty string. In that case, discard it here. We
2941 used to discard it in handle_single_display_spec,
2942 but that causes get_overlay_strings_1, above, to
2943 ignore overlay strings that we must check. */
2944 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2948 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2952 it
->ignore_overlay_strings_at_pos_p
= 1;
2953 it
->string_from_display_prop_p
= 0;
2954 handle_overlay_change_p
= 0;
2956 handled
= HANDLED_RECOMPUTE_PROPS
;
2959 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2960 handle_overlay_change_p
= 0;
2963 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2965 /* Don't check for overlay strings below when set to deliver
2966 characters from a display vector. */
2967 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2968 handle_overlay_change_p
= 0;
2970 /* Handle overlay changes.
2971 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2972 if it finds overlays. */
2973 if (handle_overlay_change_p
)
2974 handled
= handle_overlay_change (it
);
2979 setup_for_ellipsis (it
, 0);
2983 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2985 /* Determine where to stop next. */
2986 if (handled
== HANDLED_NORMALLY
)
2987 compute_stop_pos (it
);
2991 /* Compute IT->stop_charpos from text property and overlay change
2992 information for IT's current position. */
2995 compute_stop_pos (struct it
*it
)
2997 register INTERVAL iv
, next_iv
;
2998 Lisp_Object object
, limit
, position
;
2999 EMACS_INT charpos
, bytepos
;
3001 /* If nowhere else, stop at the end. */
3002 it
->stop_charpos
= it
->end_charpos
;
3004 if (STRINGP (it
->string
))
3006 /* Strings are usually short, so don't limit the search for
3008 object
= it
->string
;
3010 charpos
= IT_STRING_CHARPOS (*it
);
3011 bytepos
= IT_STRING_BYTEPOS (*it
);
3017 /* If next overlay change is in front of the current stop pos
3018 (which is IT->end_charpos), stop there. Note: value of
3019 next_overlay_change is point-max if no overlay change
3021 charpos
= IT_CHARPOS (*it
);
3022 bytepos
= IT_BYTEPOS (*it
);
3023 pos
= next_overlay_change (charpos
);
3024 if (pos
< it
->stop_charpos
)
3025 it
->stop_charpos
= pos
;
3027 /* If showing the region, we have to stop at the region
3028 start or end because the face might change there. */
3029 if (it
->region_beg_charpos
> 0)
3031 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3032 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3033 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3037 /* Set up variables for computing the stop position from text
3038 property changes. */
3039 XSETBUFFER (object
, current_buffer
);
3040 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3043 /* Get the interval containing IT's position. Value is a null
3044 interval if there isn't such an interval. */
3045 position
= make_number (charpos
);
3046 iv
= validate_interval_range (object
, &position
, &position
, 0);
3047 if (!NULL_INTERVAL_P (iv
))
3049 Lisp_Object values_here
[LAST_PROP_IDX
];
3052 /* Get properties here. */
3053 for (p
= it_props
; p
->handler
; ++p
)
3054 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3056 /* Look for an interval following iv that has different
3058 for (next_iv
= next_interval (iv
);
3059 (!NULL_INTERVAL_P (next_iv
)
3061 || XFASTINT (limit
) > next_iv
->position
));
3062 next_iv
= next_interval (next_iv
))
3064 for (p
= it_props
; p
->handler
; ++p
)
3066 Lisp_Object new_value
;
3068 new_value
= textget (next_iv
->plist
, *p
->name
);
3069 if (!EQ (values_here
[p
->idx
], new_value
))
3077 if (!NULL_INTERVAL_P (next_iv
))
3079 if (INTEGERP (limit
)
3080 && next_iv
->position
>= XFASTINT (limit
))
3081 /* No text property change up to limit. */
3082 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3084 /* Text properties change in next_iv. */
3085 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3089 if (it
->cmp_it
.id
< 0)
3091 EMACS_INT stoppos
= it
->end_charpos
;
3093 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3095 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3096 stoppos
, it
->string
);
3099 xassert (STRINGP (it
->string
)
3100 || (it
->stop_charpos
>= BEGV
3101 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3105 /* Return the position of the next overlay change after POS in
3106 current_buffer. Value is point-max if no overlay change
3107 follows. This is like `next-overlay-change' but doesn't use
3111 next_overlay_change (EMACS_INT pos
)
3115 Lisp_Object
*overlays
;
3118 /* Get all overlays at the given position. */
3119 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3121 /* If any of these overlays ends before endpos,
3122 use its ending point instead. */
3123 for (i
= 0; i
< noverlays
; ++i
)
3128 oend
= OVERLAY_END (overlays
[i
]);
3129 oendpos
= OVERLAY_POSITION (oend
);
3130 endpos
= min (endpos
, oendpos
);
3138 /***********************************************************************
3140 ***********************************************************************/
3142 /* Handle changes in the `fontified' property of the current buffer by
3143 calling hook functions from Qfontification_functions to fontify
3146 static enum prop_handled
3147 handle_fontified_prop (struct it
*it
)
3149 Lisp_Object prop
, pos
;
3150 enum prop_handled handled
= HANDLED_NORMALLY
;
3152 if (!NILP (Vmemory_full
))
3155 /* Get the value of the `fontified' property at IT's current buffer
3156 position. (The `fontified' property doesn't have a special
3157 meaning in strings.) If the value is nil, call functions from
3158 Qfontification_functions. */
3159 if (!STRINGP (it
->string
)
3161 && !NILP (Vfontification_functions
)
3162 && !NILP (Vrun_hooks
)
3163 && (pos
= make_number (IT_CHARPOS (*it
)),
3164 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3165 /* Ignore the special cased nil value always present at EOB since
3166 no amount of fontifying will be able to change it. */
3167 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3169 int count
= SPECPDL_INDEX ();
3171 struct buffer
*obuf
= current_buffer
;
3172 int begv
= BEGV
, zv
= ZV
;
3173 int old_clip_changed
= current_buffer
->clip_changed
;
3175 val
= Vfontification_functions
;
3176 specbind (Qfontification_functions
, Qnil
);
3178 xassert (it
->end_charpos
== ZV
);
3180 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3181 safe_call1 (val
, pos
);
3184 Lisp_Object fns
, fn
;
3185 struct gcpro gcpro1
, gcpro2
;
3190 for (; CONSP (val
); val
= XCDR (val
))
3196 /* A value of t indicates this hook has a local
3197 binding; it means to run the global binding too.
3198 In a global value, t should not occur. If it
3199 does, we must ignore it to avoid an endless
3201 for (fns
= Fdefault_value (Qfontification_functions
);
3207 safe_call1 (fn
, pos
);
3211 safe_call1 (fn
, pos
);
3217 unbind_to (count
, Qnil
);
3219 /* Fontification functions routinely call `save-restriction'.
3220 Normally, this tags clip_changed, which can confuse redisplay
3221 (see discussion in Bug#6671). Since we don't perform any
3222 special handling of fontification changes in the case where
3223 `save-restriction' isn't called, there's no point doing so in
3224 this case either. So, if the buffer's restrictions are
3225 actually left unchanged, reset clip_changed. */
3226 if (obuf
== current_buffer
)
3228 if (begv
== BEGV
&& zv
== ZV
)
3229 current_buffer
->clip_changed
= old_clip_changed
;
3231 /* There isn't much we can reasonably do to protect against
3232 misbehaving fontification, but here's a fig leaf. */
3233 else if (!NILP (BVAR (obuf
, name
)))
3234 set_buffer_internal_1 (obuf
);
3236 /* The fontification code may have added/removed text.
3237 It could do even a lot worse, but let's at least protect against
3238 the most obvious case where only the text past `pos' gets changed',
3239 as is/was done in grep.el where some escapes sequences are turned
3240 into face properties (bug#7876). */
3241 it
->end_charpos
= ZV
;
3243 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3244 something. This avoids an endless loop if they failed to
3245 fontify the text for which reason ever. */
3246 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3247 handled
= HANDLED_RECOMPUTE_PROPS
;
3255 /***********************************************************************
3257 ***********************************************************************/
3259 /* Set up iterator IT from face properties at its current position.
3260 Called from handle_stop. */
3262 static enum prop_handled
3263 handle_face_prop (struct it
*it
)
3266 EMACS_INT next_stop
;
3268 if (!STRINGP (it
->string
))
3271 = face_at_buffer_position (it
->w
,
3273 it
->region_beg_charpos
,
3274 it
->region_end_charpos
,
3277 + TEXT_PROP_DISTANCE_LIMIT
),
3278 0, it
->base_face_id
);
3280 /* Is this a start of a run of characters with box face?
3281 Caveat: this can be called for a freshly initialized
3282 iterator; face_id is -1 in this case. We know that the new
3283 face will not change until limit, i.e. if the new face has a
3284 box, all characters up to limit will have one. But, as
3285 usual, we don't know whether limit is really the end. */
3286 if (new_face_id
!= it
->face_id
)
3288 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3290 /* If new face has a box but old face has not, this is
3291 the start of a run of characters with box, i.e. it has
3292 a shadow on the left side. The value of face_id of the
3293 iterator will be -1 if this is the initial call that gets
3294 the face. In this case, we have to look in front of IT's
3295 position and see whether there is a face != new_face_id. */
3296 it
->start_of_box_run_p
3297 = (new_face
->box
!= FACE_NO_BOX
3298 && (it
->face_id
>= 0
3299 || IT_CHARPOS (*it
) == BEG
3300 || new_face_id
!= face_before_it_pos (it
)));
3301 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3309 Lisp_Object from_overlay
3310 = (it
->current
.overlay_string_index
>= 0
3311 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3314 /* See if we got to this string directly or indirectly from
3315 an overlay property. That includes the before-string or
3316 after-string of an overlay, strings in display properties
3317 provided by an overlay, their text properties, etc.
3319 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3320 if (! NILP (from_overlay
))
3321 for (i
= it
->sp
- 1; i
>= 0; i
--)
3323 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3325 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3326 else if (! NILP (it
->stack
[i
].from_overlay
))
3327 from_overlay
= it
->stack
[i
].from_overlay
;
3329 if (!NILP (from_overlay
))
3333 if (! NILP (from_overlay
))
3335 bufpos
= IT_CHARPOS (*it
);
3336 /* For a string from an overlay, the base face depends
3337 only on text properties and ignores overlays. */
3339 = face_for_overlay_string (it
->w
,
3341 it
->region_beg_charpos
,
3342 it
->region_end_charpos
,
3345 + TEXT_PROP_DISTANCE_LIMIT
),
3353 /* For strings from a `display' property, use the face at
3354 IT's current buffer position as the base face to merge
3355 with, so that overlay strings appear in the same face as
3356 surrounding text, unless they specify their own
3358 base_face_id
= underlying_face_id (it
);
3361 new_face_id
= face_at_string_position (it
->w
,
3363 IT_STRING_CHARPOS (*it
),
3365 it
->region_beg_charpos
,
3366 it
->region_end_charpos
,
3370 /* Is this a start of a run of characters with box? Caveat:
3371 this can be called for a freshly allocated iterator; face_id
3372 is -1 is this case. We know that the new face will not
3373 change until the next check pos, i.e. if the new face has a
3374 box, all characters up to that position will have a
3375 box. But, as usual, we don't know whether that position
3376 is really the end. */
3377 if (new_face_id
!= it
->face_id
)
3379 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3380 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3382 /* If new face has a box but old face hasn't, this is the
3383 start of a run of characters with box, i.e. it has a
3384 shadow on the left side. */
3385 it
->start_of_box_run_p
3386 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3387 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3391 it
->face_id
= new_face_id
;
3392 return HANDLED_NORMALLY
;
3396 /* Return the ID of the face ``underlying'' IT's current position,
3397 which is in a string. If the iterator is associated with a
3398 buffer, return the face at IT's current buffer position.
3399 Otherwise, use the iterator's base_face_id. */
3402 underlying_face_id (struct it
*it
)
3404 int face_id
= it
->base_face_id
, i
;
3406 xassert (STRINGP (it
->string
));
3408 for (i
= it
->sp
- 1; i
>= 0; --i
)
3409 if (NILP (it
->stack
[i
].string
))
3410 face_id
= it
->stack
[i
].face_id
;
3416 /* Compute the face one character before or after the current position
3417 of IT. BEFORE_P non-zero means get the face in front of IT's
3418 position. Value is the id of the face. */
3421 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3424 EMACS_INT next_check_charpos
;
3425 struct text_pos pos
;
3427 xassert (it
->s
== NULL
);
3429 if (STRINGP (it
->string
))
3434 /* No face change past the end of the string (for the case
3435 we are padding with spaces). No face change before the
3437 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3438 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3441 /* Set pos to the position before or after IT's current position. */
3443 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3445 /* For composition, we must check the character after the
3447 pos
= (it
->what
== IT_COMPOSITION
3448 ? string_pos (IT_STRING_CHARPOS (*it
)
3449 + it
->cmp_it
.nchars
, it
->string
)
3450 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3452 if (it
->current
.overlay_string_index
>= 0)
3453 bufpos
= IT_CHARPOS (*it
);
3457 base_face_id
= underlying_face_id (it
);
3459 /* Get the face for ASCII, or unibyte. */
3460 face_id
= face_at_string_position (it
->w
,
3464 it
->region_beg_charpos
,
3465 it
->region_end_charpos
,
3466 &next_check_charpos
,
3469 /* Correct the face for charsets different from ASCII. Do it
3470 for the multibyte case only. The face returned above is
3471 suitable for unibyte text if IT->string is unibyte. */
3472 if (STRING_MULTIBYTE (it
->string
))
3474 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3476 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3478 c
= string_char_and_length (p
, &len
);
3479 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3484 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3485 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3488 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3489 pos
= it
->current
.pos
;
3492 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3495 if (it
->what
== IT_COMPOSITION
)
3496 /* For composition, we must check the position after the
3498 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3500 INC_TEXT_POS (pos
, it
->multibyte_p
);
3503 /* Determine face for CHARSET_ASCII, or unibyte. */
3504 face_id
= face_at_buffer_position (it
->w
,
3506 it
->region_beg_charpos
,
3507 it
->region_end_charpos
,
3508 &next_check_charpos
,
3511 /* Correct the face for charsets different from ASCII. Do it
3512 for the multibyte case only. The face returned above is
3513 suitable for unibyte text if current_buffer is unibyte. */
3514 if (it
->multibyte_p
)
3516 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3517 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3518 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3527 /***********************************************************************
3529 ***********************************************************************/
3531 /* Set up iterator IT from invisible properties at its current
3532 position. Called from handle_stop. */
3534 static enum prop_handled
3535 handle_invisible_prop (struct it
*it
)
3537 enum prop_handled handled
= HANDLED_NORMALLY
;
3539 if (STRINGP (it
->string
))
3541 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3543 /* Get the value of the invisible text property at the
3544 current position. Value will be nil if there is no such
3546 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3547 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3550 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3552 handled
= HANDLED_RECOMPUTE_PROPS
;
3554 /* Get the position at which the next change of the
3555 invisible text property can be found in IT->string.
3556 Value will be nil if the property value is the same for
3557 all the rest of IT->string. */
3558 XSETINT (limit
, SCHARS (it
->string
));
3559 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3562 /* Text at current position is invisible. The next
3563 change in the property is at position end_charpos.
3564 Move IT's current position to that position. */
3565 if (INTEGERP (end_charpos
)
3566 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3568 struct text_pos old
;
3569 old
= it
->current
.string_pos
;
3570 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3571 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3575 /* The rest of the string is invisible. If this is an
3576 overlay string, proceed with the next overlay string
3577 or whatever comes and return a character from there. */
3578 if (it
->current
.overlay_string_index
>= 0)
3580 next_overlay_string (it
);
3581 /* Don't check for overlay strings when we just
3582 finished processing them. */
3583 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3587 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3588 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3596 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3597 Lisp_Object pos
, prop
, overlay
;
3599 /* First of all, is there invisible text at this position? */
3600 tem
= start_charpos
= IT_CHARPOS (*it
);
3601 pos
= make_number (tem
);
3602 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3604 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3606 /* If we are on invisible text, skip over it. */
3607 if (invis_p
&& start_charpos
< it
->end_charpos
)
3609 /* Record whether we have to display an ellipsis for the
3611 int display_ellipsis_p
= invis_p
== 2;
3613 handled
= HANDLED_RECOMPUTE_PROPS
;
3615 /* Loop skipping over invisible text. The loop is left at
3616 ZV or with IT on the first char being visible again. */
3619 /* Try to skip some invisible text. Return value is the
3620 position reached which can be equal to where we start
3621 if there is nothing invisible there. This skips both
3622 over invisible text properties and overlays with
3623 invisible property. */
3624 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3626 /* If we skipped nothing at all we weren't at invisible
3627 text in the first place. If everything to the end of
3628 the buffer was skipped, end the loop. */
3629 if (newpos
== tem
|| newpos
>= ZV
)
3633 /* We skipped some characters but not necessarily
3634 all there are. Check if we ended up on visible
3635 text. Fget_char_property returns the property of
3636 the char before the given position, i.e. if we
3637 get invis_p = 0, this means that the char at
3638 newpos is visible. */
3639 pos
= make_number (newpos
);
3640 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3641 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3644 /* If we ended up on invisible text, proceed to
3645 skip starting with next_stop. */
3649 /* If there are adjacent invisible texts, don't lose the
3650 second one's ellipsis. */
3652 display_ellipsis_p
= 1;
3656 /* The position newpos is now either ZV or on visible text. */
3657 if (it
->bidi_p
&& newpos
< ZV
)
3659 /* With bidi iteration, the region of invisible text
3660 could start and/or end in the middle of a non-base
3661 embedding level. Therefore, we need to skip
3662 invisible text using the bidi iterator, starting at
3663 IT's current position, until we find ourselves
3664 outside the invisible text. Skipping invisible text
3665 _after_ bidi iteration avoids affecting the visual
3666 order of the displayed text when invisible properties
3667 are added or removed. */
3668 if (it
->bidi_it
.first_elt
)
3670 /* If we were `reseat'ed to a new paragraph,
3671 determine the paragraph base direction. We need
3672 to do it now because next_element_from_buffer may
3673 not have a chance to do it, if we are going to
3674 skip any text at the beginning, which resets the
3676 bidi_paragraph_init (it
->paragraph_embedding
,
3681 bidi_move_to_visually_next (&it
->bidi_it
);
3683 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3684 && it
->bidi_it
.charpos
< newpos
);
3685 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3686 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3687 /* If we overstepped NEWPOS, record its position in the
3688 iterator, so that we skip invisible text if later the
3689 bidi iteration lands us in the invisible region
3691 if (IT_CHARPOS (*it
) >= newpos
)
3692 it
->prev_stop
= newpos
;
3696 IT_CHARPOS (*it
) = newpos
;
3697 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3700 /* If there are before-strings at the start of invisible
3701 text, and the text is invisible because of a text
3702 property, arrange to show before-strings because 20.x did
3703 it that way. (If the text is invisible because of an
3704 overlay property instead of a text property, this is
3705 already handled in the overlay code.) */
3707 && get_overlay_strings (it
, it
->stop_charpos
))
3709 handled
= HANDLED_RECOMPUTE_PROPS
;
3710 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3712 else if (display_ellipsis_p
)
3714 /* Make sure that the glyphs of the ellipsis will get
3715 correct `charpos' values. If we would not update
3716 it->position here, the glyphs would belong to the
3717 last visible character _before_ the invisible
3718 text, which confuses `set_cursor_from_row'.
3720 We use the last invisible position instead of the
3721 first because this way the cursor is always drawn on
3722 the first "." of the ellipsis, whenever PT is inside
3723 the invisible text. Otherwise the cursor would be
3724 placed _after_ the ellipsis when the point is after the
3725 first invisible character. */
3726 if (!STRINGP (it
->object
))
3728 it
->position
.charpos
= newpos
- 1;
3729 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3732 /* Let the ellipsis display before
3733 considering any properties of the following char.
3734 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3735 handled
= HANDLED_RETURN
;
3744 /* Make iterator IT return `...' next.
3745 Replaces LEN characters from buffer. */
3748 setup_for_ellipsis (struct it
*it
, int len
)
3750 /* Use the display table definition for `...'. Invalid glyphs
3751 will be handled by the method returning elements from dpvec. */
3752 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3754 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3755 it
->dpvec
= v
->contents
;
3756 it
->dpend
= v
->contents
+ v
->size
;
3760 /* Default `...'. */
3761 it
->dpvec
= default_invis_vector
;
3762 it
->dpend
= default_invis_vector
+ 3;
3765 it
->dpvec_char_len
= len
;
3766 it
->current
.dpvec_index
= 0;
3767 it
->dpvec_face_id
= -1;
3769 /* Remember the current face id in case glyphs specify faces.
3770 IT's face is restored in set_iterator_to_next.
3771 saved_face_id was set to preceding char's face in handle_stop. */
3772 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3773 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3775 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3781 /***********************************************************************
3783 ***********************************************************************/
3785 /* Set up iterator IT from `display' property at its current position.
3786 Called from handle_stop.
3787 We return HANDLED_RETURN if some part of the display property
3788 overrides the display of the buffer text itself.
3789 Otherwise we return HANDLED_NORMALLY. */
3791 static enum prop_handled
3792 handle_display_prop (struct it
*it
)
3794 Lisp_Object prop
, object
, overlay
;
3795 struct text_pos
*position
;
3796 /* Nonzero if some property replaces the display of the text itself. */
3797 int display_replaced_p
= 0;
3799 if (STRINGP (it
->string
))
3801 object
= it
->string
;
3802 position
= &it
->current
.string_pos
;
3806 XSETWINDOW (object
, it
->w
);
3807 position
= &it
->current
.pos
;
3810 /* Reset those iterator values set from display property values. */
3811 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3812 it
->space_width
= Qnil
;
3813 it
->font_height
= Qnil
;
3816 /* We don't support recursive `display' properties, i.e. string
3817 values that have a string `display' property, that have a string
3818 `display' property etc. */
3819 if (!it
->string_from_display_prop_p
)
3820 it
->area
= TEXT_AREA
;
3822 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3823 Qdisplay
, object
, &overlay
);
3825 return HANDLED_NORMALLY
;
3826 /* Now OVERLAY is the overlay that gave us this property, or nil
3827 if it was a text property. */
3829 if (!STRINGP (it
->string
))
3830 object
= it
->w
->buffer
;
3833 /* Simple properties. */
3834 && !EQ (XCAR (prop
), Qimage
)
3835 && !EQ (XCAR (prop
), Qspace
)
3836 && !EQ (XCAR (prop
), Qwhen
)
3837 && !EQ (XCAR (prop
), Qslice
)
3838 && !EQ (XCAR (prop
), Qspace_width
)
3839 && !EQ (XCAR (prop
), Qheight
)
3840 && !EQ (XCAR (prop
), Qraise
)
3841 /* Marginal area specifications. */
3842 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3843 && !EQ (XCAR (prop
), Qleft_fringe
)
3844 && !EQ (XCAR (prop
), Qright_fringe
)
3845 && !NILP (XCAR (prop
)))
3847 for (; CONSP (prop
); prop
= XCDR (prop
))
3849 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3850 position
, display_replaced_p
))
3852 display_replaced_p
= 1;
3853 /* If some text in a string is replaced, `position' no
3854 longer points to the position of `object'. */
3855 if (STRINGP (object
))
3860 else if (VECTORP (prop
))
3863 for (i
= 0; i
< ASIZE (prop
); ++i
)
3864 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3865 position
, display_replaced_p
))
3867 display_replaced_p
= 1;
3868 /* If some text in a string is replaced, `position' no
3869 longer points to the position of `object'. */
3870 if (STRINGP (object
))
3876 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3878 display_replaced_p
= 1;
3881 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3885 /* Value is the position of the end of the `display' property starting
3886 at START_POS in OBJECT. */
3888 static struct text_pos
3889 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3892 struct text_pos end_pos
;
3894 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3895 Qdisplay
, object
, Qnil
);
3896 CHARPOS (end_pos
) = XFASTINT (end
);
3897 if (STRINGP (object
))
3898 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3900 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3906 /* Set up IT from a single `display' specification PROP. OBJECT
3907 is the object in which the `display' property was found. *POSITION
3908 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3909 means that we previously saw a display specification which already
3910 replaced text display with something else, for example an image;
3911 we ignore such properties after the first one has been processed.
3913 OVERLAY is the overlay this `display' property came from,
3914 or nil if it was a text property.
3916 If PROP is a `space' or `image' specification, and in some other
3917 cases too, set *POSITION to the position where the `display'
3920 Value is non-zero if something was found which replaces the display
3921 of buffer or string text. */
3924 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3925 Lisp_Object overlay
, struct text_pos
*position
,
3926 int display_replaced_before_p
)
3929 Lisp_Object location
, value
;
3930 struct text_pos start_pos
, save_pos
;
3933 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3934 If the result is non-nil, use VALUE instead of SPEC. */
3936 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3945 if (!NILP (form
) && !EQ (form
, Qt
))
3947 int count
= SPECPDL_INDEX ();
3948 struct gcpro gcpro1
;
3950 /* Bind `object' to the object having the `display' property, a
3951 buffer or string. Bind `position' to the position in the
3952 object where the property was found, and `buffer-position'
3953 to the current position in the buffer. */
3954 specbind (Qobject
, object
);
3955 specbind (Qposition
, make_number (CHARPOS (*position
)));
3956 specbind (Qbuffer_position
,
3957 make_number (STRINGP (object
)
3958 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3960 form
= safe_eval (form
);
3962 unbind_to (count
, Qnil
);
3968 /* Handle `(height HEIGHT)' specifications. */
3970 && EQ (XCAR (spec
), Qheight
)
3971 && CONSP (XCDR (spec
)))
3973 if (!FRAME_WINDOW_P (it
->f
))
3976 it
->font_height
= XCAR (XCDR (spec
));
3977 if (!NILP (it
->font_height
))
3979 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3980 int new_height
= -1;
3982 if (CONSP (it
->font_height
)
3983 && (EQ (XCAR (it
->font_height
), Qplus
)
3984 || EQ (XCAR (it
->font_height
), Qminus
))
3985 && CONSP (XCDR (it
->font_height
))
3986 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3988 /* `(+ N)' or `(- N)' where N is an integer. */
3989 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3990 if (EQ (XCAR (it
->font_height
), Qplus
))
3992 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3994 else if (FUNCTIONP (it
->font_height
))
3996 /* Call function with current height as argument.
3997 Value is the new height. */
3999 height
= safe_call1 (it
->font_height
,
4000 face
->lface
[LFACE_HEIGHT_INDEX
]);
4001 if (NUMBERP (height
))
4002 new_height
= XFLOATINT (height
);
4004 else if (NUMBERP (it
->font_height
))
4006 /* Value is a multiple of the canonical char height. */
4009 f
= FACE_FROM_ID (it
->f
,
4010 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4011 new_height
= (XFLOATINT (it
->font_height
)
4012 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4016 /* Evaluate IT->font_height with `height' bound to the
4017 current specified height to get the new height. */
4018 int count
= SPECPDL_INDEX ();
4020 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4021 value
= safe_eval (it
->font_height
);
4022 unbind_to (count
, Qnil
);
4024 if (NUMBERP (value
))
4025 new_height
= XFLOATINT (value
);
4029 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4035 /* Handle `(space-width WIDTH)'. */
4037 && EQ (XCAR (spec
), Qspace_width
)
4038 && CONSP (XCDR (spec
)))
4040 if (!FRAME_WINDOW_P (it
->f
))
4043 value
= XCAR (XCDR (spec
));
4044 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4045 it
->space_width
= value
;
4050 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4052 && EQ (XCAR (spec
), Qslice
))
4056 if (!FRAME_WINDOW_P (it
->f
))
4059 if (tem
= XCDR (spec
), CONSP (tem
))
4061 it
->slice
.x
= XCAR (tem
);
4062 if (tem
= XCDR (tem
), CONSP (tem
))
4064 it
->slice
.y
= XCAR (tem
);
4065 if (tem
= XCDR (tem
), CONSP (tem
))
4067 it
->slice
.width
= XCAR (tem
);
4068 if (tem
= XCDR (tem
), CONSP (tem
))
4069 it
->slice
.height
= XCAR (tem
);
4077 /* Handle `(raise FACTOR)'. */
4079 && EQ (XCAR (spec
), Qraise
)
4080 && CONSP (XCDR (spec
)))
4082 if (!FRAME_WINDOW_P (it
->f
))
4085 #ifdef HAVE_WINDOW_SYSTEM
4086 value
= XCAR (XCDR (spec
));
4087 if (NUMBERP (value
))
4089 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4090 it
->voffset
= - (XFLOATINT (value
)
4091 * (FONT_HEIGHT (face
->font
)));
4093 #endif /* HAVE_WINDOW_SYSTEM */
4098 /* Don't handle the other kinds of display specifications
4099 inside a string that we got from a `display' property. */
4100 if (it
->string_from_display_prop_p
)
4103 /* Characters having this form of property are not displayed, so
4104 we have to find the end of the property. */
4105 start_pos
= *position
;
4106 *position
= display_prop_end (it
, object
, start_pos
);
4109 /* Stop the scan at that end position--we assume that all
4110 text properties change there. */
4111 it
->stop_charpos
= position
->charpos
;
4113 /* Handle `(left-fringe BITMAP [FACE])'
4114 and `(right-fringe BITMAP [FACE])'. */
4116 && (EQ (XCAR (spec
), Qleft_fringe
)
4117 || EQ (XCAR (spec
), Qright_fringe
))
4118 && CONSP (XCDR (spec
)))
4120 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4123 if (!FRAME_WINDOW_P (it
->f
))
4124 /* If we return here, POSITION has been advanced
4125 across the text with this property. */
4128 #ifdef HAVE_WINDOW_SYSTEM
4129 value
= XCAR (XCDR (spec
));
4130 if (!SYMBOLP (value
)
4131 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4132 /* If we return here, POSITION has been advanced
4133 across the text with this property. */
4136 if (CONSP (XCDR (XCDR (spec
))))
4138 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4139 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4145 /* Save current settings of IT so that we can restore them
4146 when we are finished with the glyph property value. */
4148 save_pos
= it
->position
;
4149 it
->position
= *position
;
4151 it
->position
= save_pos
;
4153 it
->area
= TEXT_AREA
;
4154 it
->what
= IT_IMAGE
;
4155 it
->image_id
= -1; /* no image */
4156 it
->position
= start_pos
;
4157 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4158 it
->method
= GET_FROM_IMAGE
;
4159 it
->from_overlay
= Qnil
;
4160 it
->face_id
= face_id
;
4162 /* Say that we haven't consumed the characters with
4163 `display' property yet. The call to pop_it in
4164 set_iterator_to_next will clean this up. */
4165 *position
= start_pos
;
4167 if (EQ (XCAR (spec
), Qleft_fringe
))
4169 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4170 it
->left_user_fringe_face_id
= face_id
;
4174 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4175 it
->right_user_fringe_face_id
= face_id
;
4177 #endif /* HAVE_WINDOW_SYSTEM */
4181 /* Prepare to handle `((margin left-margin) ...)',
4182 `((margin right-margin) ...)' and `((margin nil) ...)'
4183 prefixes for display specifications. */
4184 location
= Qunbound
;
4185 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4189 value
= XCDR (spec
);
4191 value
= XCAR (value
);
4194 if (EQ (XCAR (tem
), Qmargin
)
4195 && (tem
= XCDR (tem
),
4196 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4198 || EQ (tem
, Qleft_margin
)
4199 || EQ (tem
, Qright_margin
))))
4203 if (EQ (location
, Qunbound
))
4209 /* After this point, VALUE is the property after any
4210 margin prefix has been stripped. It must be a string,
4211 an image specification, or `(space ...)'.
4213 LOCATION specifies where to display: `left-margin',
4214 `right-margin' or nil. */
4216 valid_p
= (STRINGP (value
)
4217 #ifdef HAVE_WINDOW_SYSTEM
4218 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4219 #endif /* not HAVE_WINDOW_SYSTEM */
4220 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4222 if (valid_p
&& !display_replaced_before_p
)
4224 /* Save current settings of IT so that we can restore them
4225 when we are finished with the glyph property value. */
4226 save_pos
= it
->position
;
4227 it
->position
= *position
;
4229 it
->position
= save_pos
;
4230 it
->from_overlay
= overlay
;
4232 if (NILP (location
))
4233 it
->area
= TEXT_AREA
;
4234 else if (EQ (location
, Qleft_margin
))
4235 it
->area
= LEFT_MARGIN_AREA
;
4237 it
->area
= RIGHT_MARGIN_AREA
;
4239 if (STRINGP (value
))
4242 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4243 it
->current
.overlay_string_index
= -1;
4244 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4245 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4246 it
->method
= GET_FROM_STRING
;
4247 it
->stop_charpos
= 0;
4248 it
->string_from_display_prop_p
= 1;
4249 /* Say that we haven't consumed the characters with
4250 `display' property yet. The call to pop_it in
4251 set_iterator_to_next will clean this up. */
4252 if (BUFFERP (object
))
4253 *position
= start_pos
;
4255 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4257 it
->method
= GET_FROM_STRETCH
;
4259 *position
= it
->position
= start_pos
;
4261 #ifdef HAVE_WINDOW_SYSTEM
4264 it
->what
= IT_IMAGE
;
4265 it
->image_id
= lookup_image (it
->f
, value
);
4266 it
->position
= start_pos
;
4267 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4268 it
->method
= GET_FROM_IMAGE
;
4270 /* Say that we haven't consumed the characters with
4271 `display' property yet. The call to pop_it in
4272 set_iterator_to_next will clean this up. */
4273 *position
= start_pos
;
4275 #endif /* HAVE_WINDOW_SYSTEM */
4280 /* Invalid property or property not supported. Restore
4281 POSITION to what it was before. */
4282 *position
= start_pos
;
4287 /* Check if SPEC is a display sub-property value whose text should be
4288 treated as intangible. */
4291 single_display_spec_intangible_p (Lisp_Object prop
)
4293 /* Skip over `when FORM'. */
4294 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4308 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4309 we don't need to treat text as intangible. */
4310 if (EQ (XCAR (prop
), Qmargin
))
4318 || EQ (XCAR (prop
), Qleft_margin
)
4319 || EQ (XCAR (prop
), Qright_margin
))
4323 return (CONSP (prop
)
4324 && (EQ (XCAR (prop
), Qimage
)
4325 || EQ (XCAR (prop
), Qspace
)));
4329 /* Check if PROP is a display property value whose text should be
4330 treated as intangible. */
4333 display_prop_intangible_p (Lisp_Object prop
)
4336 && CONSP (XCAR (prop
))
4337 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4339 /* A list of sub-properties. */
4340 while (CONSP (prop
))
4342 if (single_display_spec_intangible_p (XCAR (prop
)))
4347 else if (VECTORP (prop
))
4349 /* A vector of sub-properties. */
4351 for (i
= 0; i
< ASIZE (prop
); ++i
)
4352 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4356 return single_display_spec_intangible_p (prop
);
4362 /* Return 1 if PROP is a display sub-property value containing STRING. */
4365 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4367 if (EQ (string
, prop
))
4370 /* Skip over `when FORM'. */
4371 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4380 /* Skip over `margin LOCATION'. */
4381 if (EQ (XCAR (prop
), Qmargin
))
4392 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4396 /* Return 1 if STRING appears in the `display' property PROP. */
4399 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4402 && CONSP (XCAR (prop
))
4403 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4405 /* A list of sub-properties. */
4406 while (CONSP (prop
))
4408 if (single_display_spec_string_p (XCAR (prop
), string
))
4413 else if (VECTORP (prop
))
4415 /* A vector of sub-properties. */
4417 for (i
= 0; i
< ASIZE (prop
); ++i
)
4418 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4422 return single_display_spec_string_p (prop
, string
);
4427 /* Look for STRING in overlays and text properties in the current
4428 buffer, between character positions FROM and TO (excluding TO).
4429 BACK_P non-zero means look back (in this case, TO is supposed to be
4431 Value is the first character position where STRING was found, or
4432 zero if it wasn't found before hitting TO.
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_lim (Lisp_Object string
,
4439 EMACS_INT from
, EMACS_INT to
, int back_p
)
4441 Lisp_Object limit
, prop
, pos
;
4444 pos
= make_number (from
);
4446 if (!back_p
) /* looking forward */
4448 limit
= make_number (min (to
, ZV
));
4449 while (!found
&& !EQ (pos
, limit
))
4451 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4452 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4455 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4459 else /* looking back */
4461 limit
= make_number (max (to
, BEGV
));
4462 while (!found
&& !EQ (pos
, limit
))
4464 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4465 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4468 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4473 return found
? XINT (pos
) : 0;
4476 /* Determine which buffer position in current buffer STRING comes from.
4477 AROUND_CHARPOS is an approximate position where it could come from.
4478 Value is the buffer position or 0 if it couldn't be determined.
4480 This function is necessary because we don't record buffer positions
4481 in glyphs generated from strings (to keep struct glyph small).
4482 This function may only use code that doesn't eval because it is
4483 called asynchronously from note_mouse_highlight. */
4486 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4488 const int MAX_DISTANCE
= 1000;
4489 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4490 around_charpos
+ MAX_DISTANCE
,
4494 found
= string_buffer_position_lim (string
, around_charpos
,
4495 around_charpos
- MAX_DISTANCE
, 1);
4501 /***********************************************************************
4502 `composition' property
4503 ***********************************************************************/
4505 /* Set up iterator IT from `composition' property at its current
4506 position. Called from handle_stop. */
4508 static enum prop_handled
4509 handle_composition_prop (struct it
*it
)
4511 Lisp_Object prop
, string
;
4512 EMACS_INT pos
, pos_byte
, start
, end
;
4514 if (STRINGP (it
->string
))
4518 pos
= IT_STRING_CHARPOS (*it
);
4519 pos_byte
= IT_STRING_BYTEPOS (*it
);
4520 string
= it
->string
;
4521 s
= SDATA (string
) + pos_byte
;
4522 it
->c
= STRING_CHAR (s
);
4526 pos
= IT_CHARPOS (*it
);
4527 pos_byte
= IT_BYTEPOS (*it
);
4529 it
->c
= FETCH_CHAR (pos_byte
);
4532 /* If there's a valid composition and point is not inside of the
4533 composition (in the case that the composition is from the current
4534 buffer), draw a glyph composed from the composition components. */
4535 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4536 && COMPOSITION_VALID_P (start
, end
, prop
)
4537 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4541 if (STRINGP (it
->string
))
4542 pos_byte
= string_char_to_byte (it
->string
, start
);
4544 pos_byte
= CHAR_TO_BYTE (start
);
4546 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4549 if (it
->cmp_it
.id
>= 0)
4552 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4553 it
->cmp_it
.nglyphs
= -1;
4557 return HANDLED_NORMALLY
;
4562 /***********************************************************************
4564 ***********************************************************************/
4566 /* The following structure is used to record overlay strings for
4567 later sorting in load_overlay_strings. */
4569 struct overlay_entry
4571 Lisp_Object overlay
;
4578 /* Set up iterator IT from overlay strings at its current position.
4579 Called from handle_stop. */
4581 static enum prop_handled
4582 handle_overlay_change (struct it
*it
)
4584 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4585 return HANDLED_RECOMPUTE_PROPS
;
4587 return HANDLED_NORMALLY
;
4591 /* Set up the next overlay string for delivery by IT, if there is an
4592 overlay string to deliver. Called by set_iterator_to_next when the
4593 end of the current overlay string is reached. If there are more
4594 overlay strings to display, IT->string and
4595 IT->current.overlay_string_index are set appropriately here.
4596 Otherwise IT->string is set to nil. */
4599 next_overlay_string (struct it
*it
)
4601 ++it
->current
.overlay_string_index
;
4602 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4604 /* No more overlay strings. Restore IT's settings to what
4605 they were before overlay strings were processed, and
4606 continue to deliver from current_buffer. */
4608 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4611 || (NILP (it
->string
)
4612 && it
->method
== GET_FROM_BUFFER
4613 && it
->stop_charpos
>= BEGV
4614 && it
->stop_charpos
<= it
->end_charpos
));
4615 it
->current
.overlay_string_index
= -1;
4616 it
->n_overlay_strings
= 0;
4617 it
->overlay_strings_charpos
= -1;
4619 /* If we're at the end of the buffer, record that we have
4620 processed the overlay strings there already, so that
4621 next_element_from_buffer doesn't try it again. */
4622 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4623 it
->overlay_strings_at_end_processed_p
= 1;
4627 /* There are more overlay strings to process. If
4628 IT->current.overlay_string_index has advanced to a position
4629 where we must load IT->overlay_strings with more strings, do
4630 it. We must load at the IT->overlay_strings_charpos where
4631 IT->n_overlay_strings was originally computed; when invisible
4632 text is present, this might not be IT_CHARPOS (Bug#7016). */
4633 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4635 if (it
->current
.overlay_string_index
&& i
== 0)
4636 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4638 /* Initialize IT to deliver display elements from the overlay
4640 it
->string
= it
->overlay_strings
[i
];
4641 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4642 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4643 it
->method
= GET_FROM_STRING
;
4644 it
->stop_charpos
= 0;
4645 if (it
->cmp_it
.stop_pos
>= 0)
4646 it
->cmp_it
.stop_pos
= 0;
4653 /* Compare two overlay_entry structures E1 and E2. Used as a
4654 comparison function for qsort in load_overlay_strings. Overlay
4655 strings for the same position are sorted so that
4657 1. All after-strings come in front of before-strings, except
4658 when they come from the same overlay.
4660 2. Within after-strings, strings are sorted so that overlay strings
4661 from overlays with higher priorities come first.
4663 2. Within before-strings, strings are sorted so that overlay
4664 strings from overlays with higher priorities come last.
4666 Value is analogous to strcmp. */
4670 compare_overlay_entries (const void *e1
, const void *e2
)
4672 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4673 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4676 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4678 /* Let after-strings appear in front of before-strings if
4679 they come from different overlays. */
4680 if (EQ (entry1
->overlay
, entry2
->overlay
))
4681 result
= entry1
->after_string_p
? 1 : -1;
4683 result
= entry1
->after_string_p
? -1 : 1;
4685 else if (entry1
->after_string_p
)
4686 /* After-strings sorted in order of decreasing priority. */
4687 result
= entry2
->priority
- entry1
->priority
;
4689 /* Before-strings sorted in order of increasing priority. */
4690 result
= entry1
->priority
- entry2
->priority
;
4696 /* Load the vector IT->overlay_strings with overlay strings from IT's
4697 current buffer position, or from CHARPOS if that is > 0. Set
4698 IT->n_overlays to the total number of overlay strings found.
4700 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4701 a time. On entry into load_overlay_strings,
4702 IT->current.overlay_string_index gives the number of overlay
4703 strings that have already been loaded by previous calls to this
4706 IT->add_overlay_start contains an additional overlay start
4707 position to consider for taking overlay strings from, if non-zero.
4708 This position comes into play when the overlay has an `invisible'
4709 property, and both before and after-strings. When we've skipped to
4710 the end of the overlay, because of its `invisible' property, we
4711 nevertheless want its before-string to appear.
4712 IT->add_overlay_start will contain the overlay start position
4715 Overlay strings are sorted so that after-string strings come in
4716 front of before-string strings. Within before and after-strings,
4717 strings are sorted by overlay priority. See also function
4718 compare_overlay_entries. */
4721 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4723 Lisp_Object overlay
, window
, str
, invisible
;
4724 struct Lisp_Overlay
*ov
;
4725 EMACS_INT start
, end
;
4727 int n
= 0, i
, j
, invis_p
;
4728 struct overlay_entry
*entries
4729 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4732 charpos
= IT_CHARPOS (*it
);
4734 /* Append the overlay string STRING of overlay OVERLAY to vector
4735 `entries' which has size `size' and currently contains `n'
4736 elements. AFTER_P non-zero means STRING is an after-string of
4738 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4741 Lisp_Object priority; \
4745 int new_size = 2 * size; \
4746 struct overlay_entry *old = entries; \
4748 (struct overlay_entry *) alloca (new_size \
4749 * sizeof *entries); \
4750 memcpy (entries, old, size * sizeof *entries); \
4754 entries[n].string = (STRING); \
4755 entries[n].overlay = (OVERLAY); \
4756 priority = Foverlay_get ((OVERLAY), Qpriority); \
4757 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4758 entries[n].after_string_p = (AFTER_P); \
4763 /* Process overlay before the overlay center. */
4764 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4766 XSETMISC (overlay
, ov
);
4767 xassert (OVERLAYP (overlay
));
4768 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4769 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4774 /* Skip this overlay if it doesn't start or end at IT's current
4776 if (end
!= charpos
&& start
!= charpos
)
4779 /* Skip this overlay if it doesn't apply to IT->w. */
4780 window
= Foverlay_get (overlay
, Qwindow
);
4781 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4784 /* If the text ``under'' the overlay is invisible, both before-
4785 and after-strings from this overlay are visible; start and
4786 end position are indistinguishable. */
4787 invisible
= Foverlay_get (overlay
, Qinvisible
);
4788 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4790 /* If overlay has a non-empty before-string, record it. */
4791 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4792 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4794 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4796 /* If overlay has a non-empty after-string, record it. */
4797 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4798 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4800 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4803 /* Process overlays after the overlay center. */
4804 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4806 XSETMISC (overlay
, ov
);
4807 xassert (OVERLAYP (overlay
));
4808 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4809 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4811 if (start
> charpos
)
4814 /* Skip this overlay if it doesn't start or end at IT's current
4816 if (end
!= charpos
&& start
!= charpos
)
4819 /* Skip this overlay if it doesn't apply to IT->w. */
4820 window
= Foverlay_get (overlay
, Qwindow
);
4821 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4824 /* If the text ``under'' the overlay is invisible, it has a zero
4825 dimension, and both before- and after-strings apply. */
4826 invisible
= Foverlay_get (overlay
, Qinvisible
);
4827 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4829 /* If overlay has a non-empty before-string, record it. */
4830 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4831 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4833 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4835 /* If overlay has a non-empty after-string, record it. */
4836 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4837 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4839 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4842 #undef RECORD_OVERLAY_STRING
4846 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4848 /* Record number of overlay strings, and where we computed it. */
4849 it
->n_overlay_strings
= n
;
4850 it
->overlay_strings_charpos
= charpos
;
4852 /* IT->current.overlay_string_index is the number of overlay strings
4853 that have already been consumed by IT. Copy some of the
4854 remaining overlay strings to IT->overlay_strings. */
4856 j
= it
->current
.overlay_string_index
;
4857 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4859 it
->overlay_strings
[i
] = entries
[j
].string
;
4860 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4867 /* Get the first chunk of overlay strings at IT's current buffer
4868 position, or at CHARPOS if that is > 0. Value is non-zero if at
4869 least one overlay string was found. */
4872 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4874 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4875 process. This fills IT->overlay_strings with strings, and sets
4876 IT->n_overlay_strings to the total number of strings to process.
4877 IT->pos.overlay_string_index has to be set temporarily to zero
4878 because load_overlay_strings needs this; it must be set to -1
4879 when no overlay strings are found because a zero value would
4880 indicate a position in the first overlay string. */
4881 it
->current
.overlay_string_index
= 0;
4882 load_overlay_strings (it
, charpos
);
4884 /* If we found overlay strings, set up IT to deliver display
4885 elements from the first one. Otherwise set up IT to deliver
4886 from current_buffer. */
4887 if (it
->n_overlay_strings
)
4889 /* Make sure we know settings in current_buffer, so that we can
4890 restore meaningful values when we're done with the overlay
4893 compute_stop_pos (it
);
4894 xassert (it
->face_id
>= 0);
4896 /* Save IT's settings. They are restored after all overlay
4897 strings have been processed. */
4898 xassert (!compute_stop_p
|| it
->sp
== 0);
4900 /* When called from handle_stop, there might be an empty display
4901 string loaded. In that case, don't bother saving it. */
4902 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4905 /* Set up IT to deliver display elements from the first overlay
4907 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4908 it
->string
= it
->overlay_strings
[0];
4909 it
->from_overlay
= Qnil
;
4910 it
->stop_charpos
= 0;
4911 xassert (STRINGP (it
->string
));
4912 it
->end_charpos
= SCHARS (it
->string
);
4913 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4914 it
->method
= GET_FROM_STRING
;
4918 it
->current
.overlay_string_index
= -1;
4923 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4926 it
->method
= GET_FROM_BUFFER
;
4928 (void) get_overlay_strings_1 (it
, charpos
, 1);
4932 /* Value is non-zero if we found at least one overlay string. */
4933 return STRINGP (it
->string
);
4938 /***********************************************************************
4939 Saving and restoring state
4940 ***********************************************************************/
4942 /* Save current settings of IT on IT->stack. Called, for example,
4943 before setting up IT for an overlay string, to be able to restore
4944 IT's settings to what they were after the overlay string has been
4948 push_it (struct it
*it
)
4950 struct iterator_stack_entry
*p
;
4952 xassert (it
->sp
< IT_STACK_SIZE
);
4953 p
= it
->stack
+ it
->sp
;
4955 p
->stop_charpos
= it
->stop_charpos
;
4956 p
->prev_stop
= it
->prev_stop
;
4957 p
->base_level_stop
= it
->base_level_stop
;
4958 p
->cmp_it
= it
->cmp_it
;
4959 xassert (it
->face_id
>= 0);
4960 p
->face_id
= it
->face_id
;
4961 p
->string
= it
->string
;
4962 p
->method
= it
->method
;
4963 p
->from_overlay
= it
->from_overlay
;
4966 case GET_FROM_IMAGE
:
4967 p
->u
.image
.object
= it
->object
;
4968 p
->u
.image
.image_id
= it
->image_id
;
4969 p
->u
.image
.slice
= it
->slice
;
4971 case GET_FROM_STRETCH
:
4972 p
->u
.stretch
.object
= it
->object
;
4975 p
->position
= it
->position
;
4976 p
->current
= it
->current
;
4977 p
->end_charpos
= it
->end_charpos
;
4978 p
->string_nchars
= it
->string_nchars
;
4980 p
->multibyte_p
= it
->multibyte_p
;
4981 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4982 p
->space_width
= it
->space_width
;
4983 p
->font_height
= it
->font_height
;
4984 p
->voffset
= it
->voffset
;
4985 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4986 p
->display_ellipsis_p
= 0;
4987 p
->line_wrap
= it
->line_wrap
;
4992 iterate_out_of_display_property (struct it
*it
)
4994 /* Maybe initialize paragraph direction. If we are at the beginning
4995 of a new paragraph, next_element_from_buffer may not have a
4996 chance to do that. */
4997 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4998 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4999 /* prev_stop can be zero, so check against BEGV as well. */
5000 while (it
->bidi_it
.charpos
>= BEGV
5001 && it
->prev_stop
<= it
->bidi_it
.charpos
5002 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5003 bidi_move_to_visually_next (&it
->bidi_it
);
5004 /* Record the stop_pos we just crossed, for when we cross it
5006 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5007 it
->prev_stop
= CHARPOS (it
->position
);
5008 /* If we ended up not where pop_it put us, resync IT's
5009 positional members with the bidi iterator. */
5010 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5012 SET_TEXT_POS (it
->position
,
5013 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5014 it
->current
.pos
= it
->position
;
5018 /* Restore IT's settings from IT->stack. Called, for example, when no
5019 more overlay strings must be processed, and we return to delivering
5020 display elements from a buffer, or when the end of a string from a
5021 `display' property is reached and we return to delivering display
5022 elements from an overlay string, or from a buffer. */
5025 pop_it (struct it
*it
)
5027 struct iterator_stack_entry
*p
;
5029 xassert (it
->sp
> 0);
5031 p
= it
->stack
+ it
->sp
;
5032 it
->stop_charpos
= p
->stop_charpos
;
5033 it
->prev_stop
= p
->prev_stop
;
5034 it
->base_level_stop
= p
->base_level_stop
;
5035 it
->cmp_it
= p
->cmp_it
;
5036 it
->face_id
= p
->face_id
;
5037 it
->current
= p
->current
;
5038 it
->position
= p
->position
;
5039 it
->string
= p
->string
;
5040 it
->from_overlay
= p
->from_overlay
;
5041 if (NILP (it
->string
))
5042 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5043 it
->method
= p
->method
;
5046 case GET_FROM_IMAGE
:
5047 it
->image_id
= p
->u
.image
.image_id
;
5048 it
->object
= p
->u
.image
.object
;
5049 it
->slice
= p
->u
.image
.slice
;
5051 case GET_FROM_STRETCH
:
5052 it
->object
= p
->u
.comp
.object
;
5054 case GET_FROM_BUFFER
:
5055 it
->object
= it
->w
->buffer
;
5058 /* Bidi-iterate until we get out of the portion of text, if
5059 any, covered by a `display' text property or an overlay
5060 with `display' property. (We cannot just jump there,
5061 because the internal coherency of the bidi iterator state
5062 can not be preserved across such jumps.) We also must
5063 determine the paragraph base direction if the overlay we
5064 just processed is at the beginning of a new
5066 iterate_out_of_display_property (it
);
5069 case GET_FROM_STRING
:
5070 it
->object
= it
->string
;
5072 case GET_FROM_DISPLAY_VECTOR
:
5074 it
->method
= GET_FROM_C_STRING
;
5075 else if (STRINGP (it
->string
))
5076 it
->method
= GET_FROM_STRING
;
5079 it
->method
= GET_FROM_BUFFER
;
5080 it
->object
= it
->w
->buffer
;
5083 it
->end_charpos
= p
->end_charpos
;
5084 it
->string_nchars
= p
->string_nchars
;
5086 it
->multibyte_p
= p
->multibyte_p
;
5087 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5088 it
->space_width
= p
->space_width
;
5089 it
->font_height
= p
->font_height
;
5090 it
->voffset
= p
->voffset
;
5091 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5092 it
->line_wrap
= p
->line_wrap
;
5097 /***********************************************************************
5099 ***********************************************************************/
5101 /* Set IT's current position to the previous line start. */
5104 back_to_previous_line_start (struct it
*it
)
5106 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5107 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5111 /* Move IT to the next line start.
5113 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5114 we skipped over part of the text (as opposed to moving the iterator
5115 continuously over the text). Otherwise, don't change the value
5118 Newlines may come from buffer text, overlay strings, or strings
5119 displayed via the `display' property. That's the reason we can't
5120 simply use find_next_newline_no_quit.
5122 Note that this function may not skip over invisible text that is so
5123 because of text properties and immediately follows a newline. If
5124 it would, function reseat_at_next_visible_line_start, when called
5125 from set_iterator_to_next, would effectively make invisible
5126 characters following a newline part of the wrong glyph row, which
5127 leads to wrong cursor motion. */
5130 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5132 int old_selective
, newline_found_p
, n
;
5133 const int MAX_NEWLINE_DISTANCE
= 500;
5135 /* If already on a newline, just consume it to avoid unintended
5136 skipping over invisible text below. */
5137 if (it
->what
== IT_CHARACTER
5139 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5141 set_iterator_to_next (it
, 0);
5146 /* Don't handle selective display in the following. It's (a)
5147 unnecessary because it's done by the caller, and (b) leads to an
5148 infinite recursion because next_element_from_ellipsis indirectly
5149 calls this function. */
5150 old_selective
= it
->selective
;
5153 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5154 from buffer text. */
5155 for (n
= newline_found_p
= 0;
5156 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5157 n
+= STRINGP (it
->string
) ? 0 : 1)
5159 if (!get_next_display_element (it
))
5161 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5162 set_iterator_to_next (it
, 0);
5165 /* If we didn't find a newline near enough, see if we can use a
5167 if (!newline_found_p
)
5169 EMACS_INT start
= IT_CHARPOS (*it
);
5170 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5173 xassert (!STRINGP (it
->string
));
5175 /* If there isn't any `display' property in sight, and no
5176 overlays, we can just use the position of the newline in
5178 if (it
->stop_charpos
>= limit
5179 || ((pos
= Fnext_single_property_change (make_number (start
),
5181 Qnil
, make_number (limit
)),
5183 && next_overlay_change (start
) == ZV
))
5185 IT_CHARPOS (*it
) = limit
;
5186 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5187 *skipped_p
= newline_found_p
= 1;
5191 while (get_next_display_element (it
)
5192 && !newline_found_p
)
5194 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5195 set_iterator_to_next (it
, 0);
5200 it
->selective
= old_selective
;
5201 return newline_found_p
;
5205 /* Set IT's current position to the previous visible line start. Skip
5206 invisible text that is so either due to text properties or due to
5207 selective display. Caution: this does not change IT->current_x and
5211 back_to_previous_visible_line_start (struct it
*it
)
5213 while (IT_CHARPOS (*it
) > BEGV
)
5215 back_to_previous_line_start (it
);
5217 if (IT_CHARPOS (*it
) <= BEGV
)
5220 /* If selective > 0, then lines indented more than its value are
5222 if (it
->selective
> 0
5223 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5224 (double) it
->selective
)) /* iftc */
5227 /* Check the newline before point for invisibility. */
5230 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5231 Qinvisible
, it
->window
);
5232 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5236 if (IT_CHARPOS (*it
) <= BEGV
)
5243 Lisp_Object val
, overlay
;
5245 /* If newline is part of a composition, continue from start of composition */
5246 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5247 && beg
< IT_CHARPOS (*it
))
5250 /* If newline is replaced by a display property, find start of overlay
5251 or interval and continue search from that point. */
5253 pos
= --IT_CHARPOS (it2
);
5256 it2
.string_from_display_prop_p
= 0;
5257 if (handle_display_prop (&it2
) == HANDLED_RETURN
5258 && !NILP (val
= get_char_property_and_overlay
5259 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5260 && (OVERLAYP (overlay
)
5261 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5262 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5265 /* Newline is not replaced by anything -- so we are done. */
5271 IT_CHARPOS (*it
) = beg
;
5272 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5276 it
->continuation_lines_width
= 0;
5278 xassert (IT_CHARPOS (*it
) >= BEGV
);
5279 xassert (IT_CHARPOS (*it
) == BEGV
5280 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5285 /* Reseat iterator IT at the previous visible line start. Skip
5286 invisible text that is so either due to text properties or due to
5287 selective display. At the end, update IT's overlay information,
5288 face information etc. */
5291 reseat_at_previous_visible_line_start (struct it
*it
)
5293 back_to_previous_visible_line_start (it
);
5294 reseat (it
, it
->current
.pos
, 1);
5299 /* Reseat iterator IT on the next visible line start in the current
5300 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5301 preceding the line start. Skip over invisible text that is so
5302 because of selective display. Compute faces, overlays etc at the
5303 new position. Note that this function does not skip over text that
5304 is invisible because of text properties. */
5307 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5309 int newline_found_p
, skipped_p
= 0;
5311 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5313 /* Skip over lines that are invisible because they are indented
5314 more than the value of IT->selective. */
5315 if (it
->selective
> 0)
5316 while (IT_CHARPOS (*it
) < ZV
5317 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5318 (double) it
->selective
)) /* iftc */
5320 xassert (IT_BYTEPOS (*it
) == BEGV
5321 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5322 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5325 /* Position on the newline if that's what's requested. */
5326 if (on_newline_p
&& newline_found_p
)
5328 if (STRINGP (it
->string
))
5330 if (IT_STRING_CHARPOS (*it
) > 0)
5332 --IT_STRING_CHARPOS (*it
);
5333 --IT_STRING_BYTEPOS (*it
);
5336 else if (IT_CHARPOS (*it
) > BEGV
)
5340 reseat (it
, it
->current
.pos
, 0);
5344 reseat (it
, it
->current
.pos
, 0);
5351 /***********************************************************************
5352 Changing an iterator's position
5353 ***********************************************************************/
5355 /* Change IT's current position to POS in current_buffer. If FORCE_P
5356 is non-zero, always check for text properties at the new position.
5357 Otherwise, text properties are only looked up if POS >=
5358 IT->check_charpos of a property. */
5361 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5363 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5365 reseat_1 (it
, pos
, 0);
5367 /* Determine where to check text properties. Avoid doing it
5368 where possible because text property lookup is very expensive. */
5370 || CHARPOS (pos
) > it
->stop_charpos
5371 || CHARPOS (pos
) < original_pos
)
5375 /* For bidi iteration, we need to prime prev_stop and
5376 base_level_stop with our best estimations. */
5377 if (CHARPOS (pos
) < it
->prev_stop
)
5379 handle_stop_backwards (it
, BEGV
);
5380 if (CHARPOS (pos
) < it
->base_level_stop
)
5381 it
->base_level_stop
= 0;
5383 else if (CHARPOS (pos
) > it
->stop_charpos
5384 && it
->stop_charpos
>= BEGV
)
5385 handle_stop_backwards (it
, it
->stop_charpos
);
5392 it
->prev_stop
= it
->base_level_stop
= 0;
5401 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5402 IT->stop_pos to POS, also. */
5405 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5407 /* Don't call this function when scanning a C string. */
5408 xassert (it
->s
== NULL
);
5410 /* POS must be a reasonable value. */
5411 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5413 it
->current
.pos
= it
->position
= pos
;
5414 it
->end_charpos
= ZV
;
5416 it
->current
.dpvec_index
= -1;
5417 it
->current
.overlay_string_index
= -1;
5418 IT_STRING_CHARPOS (*it
) = -1;
5419 IT_STRING_BYTEPOS (*it
) = -1;
5421 it
->string_from_display_prop_p
= 0;
5422 it
->method
= GET_FROM_BUFFER
;
5423 it
->object
= it
->w
->buffer
;
5424 it
->area
= TEXT_AREA
;
5425 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5427 it
->string_from_display_prop_p
= 0;
5428 it
->face_before_selective_p
= 0;
5431 it
->bidi_it
.first_elt
= 1;
5432 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5437 it
->stop_charpos
= CHARPOS (pos
);
5438 it
->base_level_stop
= CHARPOS (pos
);
5443 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5444 If S is non-null, it is a C string to iterate over. Otherwise,
5445 STRING gives a Lisp string to iterate over.
5447 If PRECISION > 0, don't return more then PRECISION number of
5448 characters from the string.
5450 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5451 characters have been returned. FIELD_WIDTH < 0 means an infinite
5454 MULTIBYTE = 0 means disable processing of multibyte characters,
5455 MULTIBYTE > 0 means enable it,
5456 MULTIBYTE < 0 means use IT->multibyte_p.
5458 IT must be initialized via a prior call to init_iterator before
5459 calling this function. */
5462 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5463 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5466 /* No region in strings. */
5467 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5469 /* No text property checks performed by default, but see below. */
5470 it
->stop_charpos
= -1;
5472 /* Set iterator position and end position. */
5473 memset (&it
->current
, 0, sizeof it
->current
);
5474 it
->current
.overlay_string_index
= -1;
5475 it
->current
.dpvec_index
= -1;
5476 xassert (charpos
>= 0);
5478 /* If STRING is specified, use its multibyteness, otherwise use the
5479 setting of MULTIBYTE, if specified. */
5481 it
->multibyte_p
= multibyte
> 0;
5485 xassert (STRINGP (string
));
5486 it
->string
= string
;
5488 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5489 it
->method
= GET_FROM_STRING
;
5490 it
->current
.string_pos
= string_pos (charpos
, string
);
5494 it
->s
= (const unsigned char *) s
;
5497 /* Note that we use IT->current.pos, not it->current.string_pos,
5498 for displaying C strings. */
5499 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5500 if (it
->multibyte_p
)
5502 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5503 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5507 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5508 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5511 it
->method
= GET_FROM_C_STRING
;
5514 /* PRECISION > 0 means don't return more than PRECISION characters
5516 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5517 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5519 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5520 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5521 FIELD_WIDTH < 0 means infinite field width. This is useful for
5522 padding with `-' at the end of a mode line. */
5523 if (field_width
< 0)
5524 field_width
= INFINITY
;
5525 if (field_width
> it
->end_charpos
- charpos
)
5526 it
->end_charpos
= charpos
+ field_width
;
5528 /* Use the standard display table for displaying strings. */
5529 if (DISP_TABLE_P (Vstandard_display_table
))
5530 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5532 it
->stop_charpos
= charpos
;
5533 if (s
== NULL
&& it
->multibyte_p
)
5535 EMACS_INT endpos
= SCHARS (it
->string
);
5536 if (endpos
> it
->end_charpos
)
5537 endpos
= it
->end_charpos
;
5538 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5546 /***********************************************************************
5548 ***********************************************************************/
5550 /* Map enum it_method value to corresponding next_element_from_* function. */
5552 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5554 next_element_from_buffer
,
5555 next_element_from_display_vector
,
5556 next_element_from_string
,
5557 next_element_from_c_string
,
5558 next_element_from_image
,
5559 next_element_from_stretch
5562 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5565 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5566 (possibly with the following characters). */
5568 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5569 ((IT)->cmp_it.id >= 0 \
5570 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5571 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5572 END_CHARPOS, (IT)->w, \
5573 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5577 /* Lookup the char-table Vglyphless_char_display for character C (-1
5578 if we want information for no-font case), and return the display
5579 method symbol. By side-effect, update it->what and
5580 it->glyphless_method. This function is called from
5581 get_next_display_element for each character element, and from
5582 x_produce_glyphs when no suitable font was found. */
5585 lookup_glyphless_char_display (int c
, struct it
*it
)
5587 Lisp_Object glyphless_method
= Qnil
;
5589 if (CHAR_TABLE_P (Vglyphless_char_display
)
5590 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5591 glyphless_method
= (c
>= 0
5592 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5593 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5595 if (NILP (glyphless_method
))
5598 /* The default is to display the character by a proper font. */
5600 /* The default for the no-font case is to display an empty box. */
5601 glyphless_method
= Qempty_box
;
5603 if (EQ (glyphless_method
, Qzero_width
))
5606 return glyphless_method
;
5607 /* This method can't be used for the no-font case. */
5608 glyphless_method
= Qempty_box
;
5610 if (EQ (glyphless_method
, Qthin_space
))
5611 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5612 else if (EQ (glyphless_method
, Qempty_box
))
5613 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5614 else if (EQ (glyphless_method
, Qhex_code
))
5615 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5616 else if (STRINGP (glyphless_method
))
5617 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5620 /* Invalid value. We use the default method. */
5621 glyphless_method
= Qnil
;
5624 it
->what
= IT_GLYPHLESS
;
5625 return glyphless_method
;
5628 /* Load IT's display element fields with information about the next
5629 display element from the current position of IT. Value is zero if
5630 end of buffer (or C string) is reached. */
5632 static struct frame
*last_escape_glyph_frame
= NULL
;
5633 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5634 static int last_escape_glyph_merged_face_id
= 0;
5636 struct frame
*last_glyphless_glyph_frame
= NULL
;
5637 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5638 int last_glyphless_glyph_merged_face_id
= 0;
5641 get_next_display_element (struct it
*it
)
5643 /* Non-zero means that we found a display element. Zero means that
5644 we hit the end of what we iterate over. Performance note: the
5645 function pointer `method' used here turns out to be faster than
5646 using a sequence of if-statements. */
5650 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5652 if (it
->what
== IT_CHARACTER
)
5654 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5655 and only if (a) the resolved directionality of that character
5657 /* FIXME: Do we need an exception for characters from display
5659 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5660 it
->c
= bidi_mirror_char (it
->c
);
5661 /* Map via display table or translate control characters.
5662 IT->c, IT->len etc. have been set to the next character by
5663 the function call above. If we have a display table, and it
5664 contains an entry for IT->c, translate it. Don't do this if
5665 IT->c itself comes from a display table, otherwise we could
5666 end up in an infinite recursion. (An alternative could be to
5667 count the recursion depth of this function and signal an
5668 error when a certain maximum depth is reached.) Is it worth
5670 if (success_p
&& it
->dpvec
== NULL
)
5673 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5674 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5675 nbsp_or_shy
= char_is_other
;
5676 int c
= it
->c
; /* This is the character to display. */
5678 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5680 xassert (SINGLE_BYTE_CHAR_P (c
));
5681 if (unibyte_display_via_language_environment
)
5683 c
= DECODE_CHAR (unibyte
, c
);
5685 c
= BYTE8_TO_CHAR (it
->c
);
5688 c
= BYTE8_TO_CHAR (it
->c
);
5692 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5695 struct Lisp_Vector
*v
= XVECTOR (dv
);
5697 /* Return the first character from the display table
5698 entry, if not empty. If empty, don't display the
5699 current character. */
5702 it
->dpvec_char_len
= it
->len
;
5703 it
->dpvec
= v
->contents
;
5704 it
->dpend
= v
->contents
+ v
->size
;
5705 it
->current
.dpvec_index
= 0;
5706 it
->dpvec_face_id
= -1;
5707 it
->saved_face_id
= it
->face_id
;
5708 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5713 set_iterator_to_next (it
, 0);
5718 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5720 if (it
->what
== IT_GLYPHLESS
)
5722 /* Don't display this character. */
5723 set_iterator_to_next (it
, 0);
5727 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5728 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5729 : c
== 0xAD ? char_is_soft_hyphen
5732 /* Translate control characters into `\003' or `^C' form.
5733 Control characters coming from a display table entry are
5734 currently not translated because we use IT->dpvec to hold
5735 the translation. This could easily be changed but I
5736 don't believe that it is worth doing.
5738 NBSP and SOFT-HYPEN are property translated too.
5740 Non-printable characters and raw-byte characters are also
5741 translated to octal form. */
5742 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5743 ? (it
->area
!= TEXT_AREA
5744 /* In mode line, treat \n, \t like other crl chars. */
5747 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5748 || (c
!= '\n' && c
!= '\t'))
5751 || ! CHAR_PRINTABLE_P (c
))))
5753 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5754 or a non-printable character which must be displayed
5755 either as '\003' or as `^C' where the '\\' and '^'
5756 can be defined in the display table. Fill
5757 IT->ctl_chars with glyphs for what we have to
5758 display. Then, set IT->dpvec to these glyphs. */
5761 int face_id
, lface_id
= 0 ;
5764 /* Handle control characters with ^. */
5766 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5770 g
= '^'; /* default glyph for Control */
5771 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5773 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5774 && GLYPH_CODE_CHAR_VALID_P (gc
))
5776 g
= GLYPH_CODE_CHAR (gc
);
5777 lface_id
= GLYPH_CODE_FACE (gc
);
5781 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5783 else if (it
->f
== last_escape_glyph_frame
5784 && it
->face_id
== last_escape_glyph_face_id
)
5786 face_id
= last_escape_glyph_merged_face_id
;
5790 /* Merge the escape-glyph face into the current face. */
5791 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5793 last_escape_glyph_frame
= it
->f
;
5794 last_escape_glyph_face_id
= it
->face_id
;
5795 last_escape_glyph_merged_face_id
= face_id
;
5798 XSETINT (it
->ctl_chars
[0], g
);
5799 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5801 goto display_control
;
5804 /* Handle non-break space in the mode where it only gets
5807 if (EQ (Vnobreak_char_display
, Qt
)
5808 && nbsp_or_shy
== char_is_nbsp
)
5810 /* Merge the no-break-space face into the current face. */
5811 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5815 XSETINT (it
->ctl_chars
[0], ' ');
5817 goto display_control
;
5820 /* Handle sequences that start with the "escape glyph". */
5822 /* the default escape glyph is \. */
5823 escape_glyph
= '\\';
5826 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5827 && GLYPH_CODE_CHAR_VALID_P (gc
))
5829 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5830 lface_id
= GLYPH_CODE_FACE (gc
);
5834 /* The display table specified a face.
5835 Merge it into face_id and also into escape_glyph. */
5836 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5839 else if (it
->f
== last_escape_glyph_frame
5840 && it
->face_id
== last_escape_glyph_face_id
)
5842 face_id
= last_escape_glyph_merged_face_id
;
5846 /* Merge the escape-glyph face into the current face. */
5847 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5849 last_escape_glyph_frame
= it
->f
;
5850 last_escape_glyph_face_id
= it
->face_id
;
5851 last_escape_glyph_merged_face_id
= face_id
;
5854 /* Handle soft hyphens in the mode where they only get
5857 if (EQ (Vnobreak_char_display
, Qt
)
5858 && nbsp_or_shy
== char_is_soft_hyphen
)
5860 XSETINT (it
->ctl_chars
[0], '-');
5862 goto display_control
;
5865 /* Handle non-break space and soft hyphen
5866 with the escape glyph. */
5870 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5871 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5872 XSETINT (it
->ctl_chars
[1], c
);
5874 goto display_control
;
5881 if (CHAR_BYTE8_P (c
))
5882 /* Display \200 instead of \17777600. */
5883 c
= CHAR_TO_BYTE8 (c
);
5884 len
= sprintf (str
, "%03o", c
);
5886 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5887 for (i
= 0; i
< len
; i
++)
5888 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5893 /* Set up IT->dpvec and return first character from it. */
5894 it
->dpvec_char_len
= it
->len
;
5895 it
->dpvec
= it
->ctl_chars
;
5896 it
->dpend
= it
->dpvec
+ ctl_len
;
5897 it
->current
.dpvec_index
= 0;
5898 it
->dpvec_face_id
= face_id
;
5899 it
->saved_face_id
= it
->face_id
;
5900 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5904 it
->char_to_display
= c
;
5908 it
->char_to_display
= it
->c
;
5912 #ifdef HAVE_WINDOW_SYSTEM
5913 /* Adjust face id for a multibyte character. There are no multibyte
5914 character in unibyte text. */
5915 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5918 && FRAME_WINDOW_P (it
->f
))
5920 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5922 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5924 /* Automatic composition with glyph-string. */
5925 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5927 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5931 EMACS_INT pos
= (it
->s
? -1
5932 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5933 : IT_CHARPOS (*it
));
5935 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5942 /* Is this character the last one of a run of characters with
5943 box? If yes, set IT->end_of_box_run_p to 1. */
5947 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5949 int face_id
= underlying_face_id (it
);
5950 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5954 if (face
->box
== FACE_NO_BOX
)
5956 /* If the box comes from face properties in a
5957 display string, check faces in that string. */
5958 int string_face_id
= face_after_it_pos (it
);
5959 it
->end_of_box_run_p
5960 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5963 /* Otherwise, the box comes from the underlying face.
5964 If this is the last string character displayed, check
5965 the next buffer location. */
5966 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5967 && (it
->current
.overlay_string_index
5968 == it
->n_overlay_strings
- 1))
5972 struct text_pos pos
= it
->current
.pos
;
5973 INC_TEXT_POS (pos
, it
->multibyte_p
);
5975 next_face_id
= face_at_buffer_position
5976 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5977 it
->region_end_charpos
, &ignore
,
5978 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5980 it
->end_of_box_run_p
5981 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5988 int face_id
= face_after_it_pos (it
);
5989 it
->end_of_box_run_p
5990 = (face_id
!= it
->face_id
5991 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5995 /* Value is 0 if end of buffer or string reached. */
6000 /* Move IT to the next display element.
6002 RESEAT_P non-zero means if called on a newline in buffer text,
6003 skip to the next visible line start.
6005 Functions get_next_display_element and set_iterator_to_next are
6006 separate because I find this arrangement easier to handle than a
6007 get_next_display_element function that also increments IT's
6008 position. The way it is we can first look at an iterator's current
6009 display element, decide whether it fits on a line, and if it does,
6010 increment the iterator position. The other way around we probably
6011 would either need a flag indicating whether the iterator has to be
6012 incremented the next time, or we would have to implement a
6013 decrement position function which would not be easy to write. */
6016 set_iterator_to_next (struct it
*it
, int reseat_p
)
6018 /* Reset flags indicating start and end of a sequence of characters
6019 with box. Reset them at the start of this function because
6020 moving the iterator to a new position might set them. */
6021 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6025 case GET_FROM_BUFFER
:
6026 /* The current display element of IT is a character from
6027 current_buffer. Advance in the buffer, and maybe skip over
6028 invisible lines that are so because of selective display. */
6029 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6030 reseat_at_next_visible_line_start (it
, 0);
6031 else if (it
->cmp_it
.id
>= 0)
6033 /* We are currently getting glyphs from a composition. */
6038 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6039 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6040 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6042 it
->cmp_it
.from
= it
->cmp_it
.to
;
6047 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6049 it
->end_charpos
, Qnil
);
6052 else if (! it
->cmp_it
.reversed_p
)
6054 /* Composition created while scanning forward. */
6055 /* Update IT's char/byte positions to point to the first
6056 character of the next grapheme cluster, or to the
6057 character visually after the current composition. */
6058 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6059 bidi_move_to_visually_next (&it
->bidi_it
);
6060 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6061 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6063 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6065 /* Proceed to the next grapheme cluster. */
6066 it
->cmp_it
.from
= it
->cmp_it
.to
;
6070 /* No more grapheme clusters in this composition.
6071 Find the next stop position. */
6072 EMACS_INT stop
= it
->end_charpos
;
6073 if (it
->bidi_it
.scan_dir
< 0)
6074 /* Now we are scanning backward and don't know
6077 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6078 IT_BYTEPOS (*it
), stop
, Qnil
);
6083 /* Composition created while scanning backward. */
6084 /* Update IT's char/byte positions to point to the last
6085 character of the previous grapheme cluster, or the
6086 character visually after the current composition. */
6087 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6088 bidi_move_to_visually_next (&it
->bidi_it
);
6089 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6090 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6091 if (it
->cmp_it
.from
> 0)
6093 /* Proceed to the previous grapheme cluster. */
6094 it
->cmp_it
.to
= it
->cmp_it
.from
;
6098 /* No more grapheme clusters in this composition.
6099 Find the next stop position. */
6100 EMACS_INT stop
= it
->end_charpos
;
6101 if (it
->bidi_it
.scan_dir
< 0)
6102 /* Now we are scanning backward and don't know
6105 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6106 IT_BYTEPOS (*it
), stop
, Qnil
);
6112 xassert (it
->len
!= 0);
6116 IT_BYTEPOS (*it
) += it
->len
;
6117 IT_CHARPOS (*it
) += 1;
6121 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6122 /* If this is a new paragraph, determine its base
6123 direction (a.k.a. its base embedding level). */
6124 if (it
->bidi_it
.new_paragraph
)
6125 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6126 bidi_move_to_visually_next (&it
->bidi_it
);
6127 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6128 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6129 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6131 /* As the scan direction was changed, we must
6132 re-compute the stop position for composition. */
6133 EMACS_INT stop
= it
->end_charpos
;
6134 if (it
->bidi_it
.scan_dir
< 0)
6136 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6137 IT_BYTEPOS (*it
), stop
, Qnil
);
6140 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6144 case GET_FROM_C_STRING
:
6145 /* Current display element of IT is from a C string. */
6146 IT_BYTEPOS (*it
) += it
->len
;
6147 IT_CHARPOS (*it
) += 1;
6150 case GET_FROM_DISPLAY_VECTOR
:
6151 /* Current display element of IT is from a display table entry.
6152 Advance in the display table definition. Reset it to null if
6153 end reached, and continue with characters from buffers/
6155 ++it
->current
.dpvec_index
;
6157 /* Restore face of the iterator to what they were before the
6158 display vector entry (these entries may contain faces). */
6159 it
->face_id
= it
->saved_face_id
;
6161 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6163 int recheck_faces
= it
->ellipsis_p
;
6166 it
->method
= GET_FROM_C_STRING
;
6167 else if (STRINGP (it
->string
))
6168 it
->method
= GET_FROM_STRING
;
6171 it
->method
= GET_FROM_BUFFER
;
6172 it
->object
= it
->w
->buffer
;
6176 it
->current
.dpvec_index
= -1;
6178 /* Skip over characters which were displayed via IT->dpvec. */
6179 if (it
->dpvec_char_len
< 0)
6180 reseat_at_next_visible_line_start (it
, 1);
6181 else if (it
->dpvec_char_len
> 0)
6183 if (it
->method
== GET_FROM_STRING
6184 && it
->n_overlay_strings
> 0)
6185 it
->ignore_overlay_strings_at_pos_p
= 1;
6186 it
->len
= it
->dpvec_char_len
;
6187 set_iterator_to_next (it
, reseat_p
);
6190 /* Maybe recheck faces after display vector */
6192 it
->stop_charpos
= IT_CHARPOS (*it
);
6196 case GET_FROM_STRING
:
6197 /* Current display element is a character from a Lisp string. */
6198 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6199 if (it
->cmp_it
.id
>= 0)
6201 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6202 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6203 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6204 it
->cmp_it
.from
= it
->cmp_it
.to
;
6208 composition_compute_stop_pos (&it
->cmp_it
,
6209 IT_STRING_CHARPOS (*it
),
6210 IT_STRING_BYTEPOS (*it
),
6211 it
->end_charpos
, it
->string
);
6216 IT_STRING_BYTEPOS (*it
) += it
->len
;
6217 IT_STRING_CHARPOS (*it
) += 1;
6220 consider_string_end
:
6222 if (it
->current
.overlay_string_index
>= 0)
6224 /* IT->string is an overlay string. Advance to the
6225 next, if there is one. */
6226 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6229 next_overlay_string (it
);
6231 setup_for_ellipsis (it
, 0);
6236 /* IT->string is not an overlay string. If we reached
6237 its end, and there is something on IT->stack, proceed
6238 with what is on the stack. This can be either another
6239 string, this time an overlay string, or a buffer. */
6240 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6244 if (it
->method
== GET_FROM_STRING
)
6245 goto consider_string_end
;
6250 case GET_FROM_IMAGE
:
6251 case GET_FROM_STRETCH
:
6252 /* The position etc with which we have to proceed are on
6253 the stack. The position may be at the end of a string,
6254 if the `display' property takes up the whole string. */
6255 xassert (it
->sp
> 0);
6257 if (it
->method
== GET_FROM_STRING
)
6258 goto consider_string_end
;
6262 /* There are no other methods defined, so this should be a bug. */
6266 xassert (it
->method
!= GET_FROM_STRING
6267 || (STRINGP (it
->string
)
6268 && IT_STRING_CHARPOS (*it
) >= 0));
6271 /* Load IT's display element fields with information about the next
6272 display element which comes from a display table entry or from the
6273 result of translating a control character to one of the forms `^C'
6276 IT->dpvec holds the glyphs to return as characters.
6277 IT->saved_face_id holds the face id before the display vector--it
6278 is restored into IT->face_id in set_iterator_to_next. */
6281 next_element_from_display_vector (struct it
*it
)
6286 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6288 it
->face_id
= it
->saved_face_id
;
6290 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6291 That seemed totally bogus - so I changed it... */
6292 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6294 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6296 it
->c
= GLYPH_CODE_CHAR (gc
);
6297 it
->len
= CHAR_BYTES (it
->c
);
6299 /* The entry may contain a face id to use. Such a face id is
6300 the id of a Lisp face, not a realized face. A face id of
6301 zero means no face is specified. */
6302 if (it
->dpvec_face_id
>= 0)
6303 it
->face_id
= it
->dpvec_face_id
;
6306 int lface_id
= GLYPH_CODE_FACE (gc
);
6308 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6313 /* Display table entry is invalid. Return a space. */
6314 it
->c
= ' ', it
->len
= 1;
6316 /* Don't change position and object of the iterator here. They are
6317 still the values of the character that had this display table
6318 entry or was translated, and that's what we want. */
6319 it
->what
= IT_CHARACTER
;
6324 /* Load IT with the next display element from Lisp string IT->string.
6325 IT->current.string_pos is the current position within the string.
6326 If IT->current.overlay_string_index >= 0, the Lisp string is an
6330 next_element_from_string (struct it
*it
)
6332 struct text_pos position
;
6334 xassert (STRINGP (it
->string
));
6335 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6336 position
= it
->current
.string_pos
;
6338 /* Time to check for invisible text? */
6339 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6340 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6344 /* Since a handler may have changed IT->method, we must
6346 return GET_NEXT_DISPLAY_ELEMENT (it
);
6349 if (it
->current
.overlay_string_index
>= 0)
6351 /* Get the next character from an overlay string. In overlay
6352 strings, There is no field width or padding with spaces to
6354 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6359 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6360 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6361 && next_element_from_composition (it
))
6365 else if (STRING_MULTIBYTE (it
->string
))
6367 const unsigned char *s
= (SDATA (it
->string
)
6368 + IT_STRING_BYTEPOS (*it
));
6369 it
->c
= string_char_and_length (s
, &it
->len
);
6373 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6379 /* Get the next character from a Lisp string that is not an
6380 overlay string. Such strings come from the mode line, for
6381 example. We may have to pad with spaces, or truncate the
6382 string. See also next_element_from_c_string. */
6383 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6388 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6390 /* Pad with spaces. */
6391 it
->c
= ' ', it
->len
= 1;
6392 CHARPOS (position
) = BYTEPOS (position
) = -1;
6394 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6395 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6396 && next_element_from_composition (it
))
6400 else if (STRING_MULTIBYTE (it
->string
))
6402 const unsigned char *s
= (SDATA (it
->string
)
6403 + IT_STRING_BYTEPOS (*it
));
6404 it
->c
= string_char_and_length (s
, &it
->len
);
6408 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6413 /* Record what we have and where it came from. */
6414 it
->what
= IT_CHARACTER
;
6415 it
->object
= it
->string
;
6416 it
->position
= position
;
6421 /* Load IT with next display element from C string IT->s.
6422 IT->string_nchars is the maximum number of characters to return
6423 from the string. IT->end_charpos may be greater than
6424 IT->string_nchars when this function is called, in which case we
6425 may have to return padding spaces. Value is zero if end of string
6426 reached, including padding spaces. */
6429 next_element_from_c_string (struct it
*it
)
6434 it
->what
= IT_CHARACTER
;
6435 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6438 /* IT's position can be greater IT->string_nchars in case a field
6439 width or precision has been specified when the iterator was
6441 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6443 /* End of the game. */
6447 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6449 /* Pad with spaces. */
6450 it
->c
= ' ', it
->len
= 1;
6451 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6453 else if (it
->multibyte_p
)
6454 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6456 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6462 /* Set up IT to return characters from an ellipsis, if appropriate.
6463 The definition of the ellipsis glyphs may come from a display table
6464 entry. This function fills IT with the first glyph from the
6465 ellipsis if an ellipsis is to be displayed. */
6468 next_element_from_ellipsis (struct it
*it
)
6470 if (it
->selective_display_ellipsis_p
)
6471 setup_for_ellipsis (it
, it
->len
);
6474 /* The face at the current position may be different from the
6475 face we find after the invisible text. Remember what it
6476 was in IT->saved_face_id, and signal that it's there by
6477 setting face_before_selective_p. */
6478 it
->saved_face_id
= it
->face_id
;
6479 it
->method
= GET_FROM_BUFFER
;
6480 it
->object
= it
->w
->buffer
;
6481 reseat_at_next_visible_line_start (it
, 1);
6482 it
->face_before_selective_p
= 1;
6485 return GET_NEXT_DISPLAY_ELEMENT (it
);
6489 /* Deliver an image display element. The iterator IT is already
6490 filled with image information (done in handle_display_prop). Value
6495 next_element_from_image (struct it
*it
)
6497 it
->what
= IT_IMAGE
;
6498 it
->ignore_overlay_strings_at_pos_p
= 0;
6503 /* Fill iterator IT with next display element from a stretch glyph
6504 property. IT->object is the value of the text property. Value is
6508 next_element_from_stretch (struct it
*it
)
6510 it
->what
= IT_STRETCH
;
6514 /* Scan forward from CHARPOS in the current buffer, until we find a
6515 stop position > current IT's position. Then handle the stop
6516 position before that. This is called when we bump into a stop
6517 position while reordering bidirectional text. CHARPOS should be
6518 the last previously processed stop_pos (or BEGV, if none were
6519 processed yet) whose position is less that IT's current
6523 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6525 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6526 struct display_pos save_current
= it
->current
;
6527 struct text_pos save_position
= it
->position
;
6528 struct text_pos pos1
;
6529 EMACS_INT next_stop
;
6531 /* Scan in strict logical order. */
6535 it
->prev_stop
= charpos
;
6536 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6537 reseat_1 (it
, pos1
, 0);
6538 compute_stop_pos (it
);
6539 /* We must advance forward, right? */
6540 if (it
->stop_charpos
<= it
->prev_stop
)
6542 charpos
= it
->stop_charpos
;
6544 while (charpos
<= where_we_are
);
6546 next_stop
= it
->stop_charpos
;
6547 it
->stop_charpos
= it
->prev_stop
;
6549 it
->current
= save_current
;
6550 it
->position
= save_position
;
6552 it
->stop_charpos
= next_stop
;
6555 /* Load IT with the next display element from current_buffer. Value
6556 is zero if end of buffer reached. IT->stop_charpos is the next
6557 position at which to stop and check for text properties or buffer
6561 next_element_from_buffer (struct it
*it
)
6565 xassert (IT_CHARPOS (*it
) >= BEGV
);
6567 /* With bidi reordering, the character to display might not be the
6568 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6569 we were reseat()ed to a new buffer position, which is potentially
6570 a different paragraph. */
6571 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6573 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6574 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6575 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6577 /* Nothing to do, but reset the FIRST_ELT flag, like
6578 bidi_paragraph_init does, because we are not going to
6580 it
->bidi_it
.first_elt
= 0;
6582 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6583 /* FIXME: Should support all Unicode line separators. */
6584 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6585 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6587 /* If we are at the beginning of a line, we can produce the
6588 next element right away. */
6589 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6590 bidi_move_to_visually_next (&it
->bidi_it
);
6594 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6596 /* We need to prime the bidi iterator starting at the line's
6597 beginning, before we will be able to produce the next
6599 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6601 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6602 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6603 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6606 /* Now return to buffer position where we were asked to
6607 get the next display element, and produce that. */
6608 bidi_move_to_visually_next (&it
->bidi_it
);
6610 while (it
->bidi_it
.bytepos
!= orig_bytepos
6611 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6614 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6615 /* Adjust IT's position information to where we ended up. */
6616 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6617 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6618 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6620 EMACS_INT stop
= it
->end_charpos
;
6621 if (it
->bidi_it
.scan_dir
< 0)
6623 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6624 IT_BYTEPOS (*it
), stop
, Qnil
);
6628 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6630 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6632 int overlay_strings_follow_p
;
6634 /* End of the game, except when overlay strings follow that
6635 haven't been returned yet. */
6636 if (it
->overlay_strings_at_end_processed_p
)
6637 overlay_strings_follow_p
= 0;
6640 it
->overlay_strings_at_end_processed_p
= 1;
6641 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6644 if (overlay_strings_follow_p
)
6645 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6649 it
->position
= it
->current
.pos
;
6653 else if (!(!it
->bidi_p
6654 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6655 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6657 /* With bidi non-linear iteration, we could find ourselves
6658 far beyond the last computed stop_charpos, with several
6659 other stop positions in between that we missed. Scan
6660 them all now, in buffer's logical order, until we find
6661 and handle the last stop_charpos that precedes our
6662 current position. */
6663 handle_stop_backwards (it
, it
->stop_charpos
);
6664 return GET_NEXT_DISPLAY_ELEMENT (it
);
6670 /* Take note of the stop position we just moved across,
6671 for when we will move back across it. */
6672 it
->prev_stop
= it
->stop_charpos
;
6673 /* If we are at base paragraph embedding level, take
6674 note of the last stop position seen at this
6676 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6677 it
->base_level_stop
= it
->stop_charpos
;
6680 return GET_NEXT_DISPLAY_ELEMENT (it
);
6684 /* We can sometimes back up for reasons that have nothing
6685 to do with bidi reordering. E.g., compositions. The
6686 code below is only needed when we are above the base
6687 embedding level, so test for that explicitly. */
6688 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6689 && IT_CHARPOS (*it
) < it
->prev_stop
)
6691 if (it
->base_level_stop
<= 0)
6692 it
->base_level_stop
= BEGV
;
6693 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6695 handle_stop_backwards (it
, it
->base_level_stop
);
6696 return GET_NEXT_DISPLAY_ELEMENT (it
);
6700 /* No face changes, overlays etc. in sight, so just return a
6701 character from current_buffer. */
6705 /* Maybe run the redisplay end trigger hook. Performance note:
6706 This doesn't seem to cost measurable time. */
6707 if (it
->redisplay_end_trigger_charpos
6709 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6710 run_redisplay_end_trigger_hook (it
);
6712 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6713 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6715 && next_element_from_composition (it
))
6720 /* Get the next character, maybe multibyte. */
6721 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6722 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6723 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6725 it
->c
= *p
, it
->len
= 1;
6727 /* Record what we have and where it came from. */
6728 it
->what
= IT_CHARACTER
;
6729 it
->object
= it
->w
->buffer
;
6730 it
->position
= it
->current
.pos
;
6732 /* Normally we return the character found above, except when we
6733 really want to return an ellipsis for selective display. */
6738 /* A value of selective > 0 means hide lines indented more
6739 than that number of columns. */
6740 if (it
->selective
> 0
6741 && IT_CHARPOS (*it
) + 1 < ZV
6742 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6743 IT_BYTEPOS (*it
) + 1,
6744 (double) it
->selective
)) /* iftc */
6746 success_p
= next_element_from_ellipsis (it
);
6747 it
->dpvec_char_len
= -1;
6750 else if (it
->c
== '\r' && it
->selective
== -1)
6752 /* A value of selective == -1 means that everything from the
6753 CR to the end of the line is invisible, with maybe an
6754 ellipsis displayed for it. */
6755 success_p
= next_element_from_ellipsis (it
);
6756 it
->dpvec_char_len
= -1;
6761 /* Value is zero if end of buffer reached. */
6762 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6767 /* Run the redisplay end trigger hook for IT. */
6770 run_redisplay_end_trigger_hook (struct it
*it
)
6772 Lisp_Object args
[3];
6774 /* IT->glyph_row should be non-null, i.e. we should be actually
6775 displaying something, or otherwise we should not run the hook. */
6776 xassert (it
->glyph_row
);
6778 /* Set up hook arguments. */
6779 args
[0] = Qredisplay_end_trigger_functions
;
6780 args
[1] = it
->window
;
6781 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6782 it
->redisplay_end_trigger_charpos
= 0;
6784 /* Since we are *trying* to run these functions, don't try to run
6785 them again, even if they get an error. */
6786 it
->w
->redisplay_end_trigger
= Qnil
;
6787 Frun_hook_with_args (3, args
);
6789 /* Notice if it changed the face of the character we are on. */
6790 handle_face_prop (it
);
6794 /* Deliver a composition display element. Unlike the other
6795 next_element_from_XXX, this function is not registered in the array
6796 get_next_element[]. It is called from next_element_from_buffer and
6797 next_element_from_string when necessary. */
6800 next_element_from_composition (struct it
*it
)
6802 it
->what
= IT_COMPOSITION
;
6803 it
->len
= it
->cmp_it
.nbytes
;
6804 if (STRINGP (it
->string
))
6808 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6809 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6812 it
->position
= it
->current
.string_pos
;
6813 it
->object
= it
->string
;
6814 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6815 IT_STRING_BYTEPOS (*it
), it
->string
);
6821 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6822 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6825 if (it
->bidi_it
.new_paragraph
)
6826 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6827 /* Resync the bidi iterator with IT's new position.
6828 FIXME: this doesn't support bidirectional text. */
6829 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6830 bidi_move_to_visually_next (&it
->bidi_it
);
6834 it
->position
= it
->current
.pos
;
6835 it
->object
= it
->w
->buffer
;
6836 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6837 IT_BYTEPOS (*it
), Qnil
);
6844 /***********************************************************************
6845 Moving an iterator without producing glyphs
6846 ***********************************************************************/
6848 /* Check if iterator is at a position corresponding to a valid buffer
6849 position after some move_it_ call. */
6851 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6852 ((it)->method == GET_FROM_STRING \
6853 ? IT_STRING_CHARPOS (*it) == 0 \
6857 /* Move iterator IT to a specified buffer or X position within one
6858 line on the display without producing glyphs.
6860 OP should be a bit mask including some or all of these bits:
6861 MOVE_TO_X: Stop upon reaching x-position TO_X.
6862 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6863 Regardless of OP's value, stop upon reaching the end of the display line.
6865 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6866 This means, in particular, that TO_X includes window's horizontal
6869 The return value has several possible values that
6870 say what condition caused the scan to stop:
6872 MOVE_POS_MATCH_OR_ZV
6873 - when TO_POS or ZV was reached.
6876 -when TO_X was reached before TO_POS or ZV were reached.
6879 - when we reached the end of the display area and the line must
6883 - when we reached the end of the display area and the line is
6887 - when we stopped at a line end, i.e. a newline or a CR and selective
6890 static enum move_it_result
6891 move_it_in_display_line_to (struct it
*it
,
6892 EMACS_INT to_charpos
, int to_x
,
6893 enum move_operation_enum op
)
6895 enum move_it_result result
= MOVE_UNDEFINED
;
6896 struct glyph_row
*saved_glyph_row
;
6897 struct it wrap_it
, atpos_it
, atx_it
;
6899 enum it_method prev_method
= it
->method
;
6900 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6902 /* Don't produce glyphs in produce_glyphs. */
6903 saved_glyph_row
= it
->glyph_row
;
6904 it
->glyph_row
= NULL
;
6906 /* Use wrap_it to save a copy of IT wherever a word wrap could
6907 occur. Use atpos_it to save a copy of IT at the desired buffer
6908 position, if found, so that we can scan ahead and check if the
6909 word later overshoots the window edge. Use atx_it similarly, for
6915 #define BUFFER_POS_REACHED_P() \
6916 ((op & MOVE_TO_POS) != 0 \
6917 && BUFFERP (it->object) \
6918 && (IT_CHARPOS (*it) == to_charpos \
6919 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6920 && (it->method == GET_FROM_BUFFER \
6921 || (it->method == GET_FROM_DISPLAY_VECTOR \
6922 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6924 /* If there's a line-/wrap-prefix, handle it. */
6925 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6926 && it
->current_y
< it
->last_visible_y
)
6927 handle_line_prefix (it
);
6929 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6930 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6934 int x
, i
, ascent
= 0, descent
= 0;
6936 /* Utility macro to reset an iterator with x, ascent, and descent. */
6937 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6938 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6939 (IT)->max_descent = descent)
6941 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6943 if ((op
& MOVE_TO_POS
) != 0
6944 && BUFFERP (it
->object
)
6945 && it
->method
== GET_FROM_BUFFER
6946 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6948 && (prev_method
== GET_FROM_IMAGE
6949 || prev_method
== GET_FROM_STRETCH
)
6950 /* Passed TO_CHARPOS from left to right. */
6951 && ((prev_pos
< to_charpos
6952 && IT_CHARPOS (*it
) > to_charpos
)
6953 /* Passed TO_CHARPOS from right to left. */
6954 || (prev_pos
> to_charpos
6955 && IT_CHARPOS (*it
) < to_charpos
)))))
6957 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6959 result
= MOVE_POS_MATCH_OR_ZV
;
6962 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6963 /* If wrap_it is valid, the current position might be in a
6964 word that is wrapped. So, save the iterator in
6965 atpos_it and continue to see if wrapping happens. */
6969 prev_method
= it
->method
;
6970 if (it
->method
== GET_FROM_BUFFER
)
6971 prev_pos
= IT_CHARPOS (*it
);
6972 /* Stop when ZV reached.
6973 We used to stop here when TO_CHARPOS reached as well, but that is
6974 too soon if this glyph does not fit on this line. So we handle it
6975 explicitly below. */
6976 if (!get_next_display_element (it
))
6978 result
= MOVE_POS_MATCH_OR_ZV
;
6982 if (it
->line_wrap
== TRUNCATE
)
6984 if (BUFFER_POS_REACHED_P ())
6986 result
= MOVE_POS_MATCH_OR_ZV
;
6992 if (it
->line_wrap
== WORD_WRAP
)
6994 if (IT_DISPLAYING_WHITESPACE (it
))
6998 /* We have reached a glyph that follows one or more
6999 whitespace characters. If the position is
7000 already found, we are done. */
7001 if (atpos_it
.sp
>= 0)
7004 result
= MOVE_POS_MATCH_OR_ZV
;
7010 result
= MOVE_X_REACHED
;
7013 /* Otherwise, we can wrap here. */
7020 /* Remember the line height for the current line, in case
7021 the next element doesn't fit on the line. */
7022 ascent
= it
->max_ascent
;
7023 descent
= it
->max_descent
;
7025 /* The call to produce_glyphs will get the metrics of the
7026 display element IT is loaded with. Record the x-position
7027 before this display element, in case it doesn't fit on the
7031 PRODUCE_GLYPHS (it
);
7033 if (it
->area
!= TEXT_AREA
)
7035 set_iterator_to_next (it
, 1);
7036 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7037 SET_TEXT_POS (this_line_min_pos
,
7038 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7042 /* The number of glyphs we get back in IT->nglyphs will normally
7043 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7044 character on a terminal frame, or (iii) a line end. For the
7045 second case, IT->nglyphs - 1 padding glyphs will be present.
7046 (On X frames, there is only one glyph produced for a
7047 composite character.)
7049 The behavior implemented below means, for continuation lines,
7050 that as many spaces of a TAB as fit on the current line are
7051 displayed there. For terminal frames, as many glyphs of a
7052 multi-glyph character are displayed in the current line, too.
7053 This is what the old redisplay code did, and we keep it that
7054 way. Under X, the whole shape of a complex character must
7055 fit on the line or it will be completely displayed in the
7058 Note that both for tabs and padding glyphs, all glyphs have
7062 /* More than one glyph or glyph doesn't fit on line. All
7063 glyphs have the same width. */
7064 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7066 int x_before_this_char
= x
;
7067 int hpos_before_this_char
= it
->hpos
;
7069 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7071 new_x
= x
+ single_glyph_width
;
7073 /* We want to leave anything reaching TO_X to the caller. */
7074 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7076 if (BUFFER_POS_REACHED_P ())
7078 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7079 goto buffer_pos_reached
;
7080 if (atpos_it
.sp
< 0)
7083 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7088 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7091 result
= MOVE_X_REACHED
;
7097 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7102 if (/* Lines are continued. */
7103 it
->line_wrap
!= TRUNCATE
7104 && (/* And glyph doesn't fit on the line. */
7105 new_x
> it
->last_visible_x
7106 /* Or it fits exactly and we're on a window
7108 || (new_x
== it
->last_visible_x
7109 && FRAME_WINDOW_P (it
->f
))))
7111 if (/* IT->hpos == 0 means the very first glyph
7112 doesn't fit on the line, e.g. a wide image. */
7114 || (new_x
== it
->last_visible_x
7115 && FRAME_WINDOW_P (it
->f
)))
7118 it
->current_x
= new_x
;
7120 /* The character's last glyph just barely fits
7122 if (i
== it
->nglyphs
- 1)
7124 /* If this is the destination position,
7125 return a position *before* it in this row,
7126 now that we know it fits in this row. */
7127 if (BUFFER_POS_REACHED_P ())
7129 if (it
->line_wrap
!= WORD_WRAP
7132 it
->hpos
= hpos_before_this_char
;
7133 it
->current_x
= x_before_this_char
;
7134 result
= MOVE_POS_MATCH_OR_ZV
;
7137 if (it
->line_wrap
== WORD_WRAP
7141 atpos_it
.current_x
= x_before_this_char
;
7142 atpos_it
.hpos
= hpos_before_this_char
;
7146 set_iterator_to_next (it
, 1);
7147 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7148 SET_TEXT_POS (this_line_min_pos
,
7149 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7150 /* On graphical terminals, newlines may
7151 "overflow" into the fringe if
7152 overflow-newline-into-fringe is non-nil.
7153 On text-only terminals, newlines may
7154 overflow into the last glyph on the
7156 if (!FRAME_WINDOW_P (it
->f
)
7157 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7159 if (!get_next_display_element (it
))
7161 result
= MOVE_POS_MATCH_OR_ZV
;
7164 if (BUFFER_POS_REACHED_P ())
7166 if (ITERATOR_AT_END_OF_LINE_P (it
))
7167 result
= MOVE_POS_MATCH_OR_ZV
;
7169 result
= MOVE_LINE_CONTINUED
;
7172 if (ITERATOR_AT_END_OF_LINE_P (it
))
7174 result
= MOVE_NEWLINE_OR_CR
;
7181 IT_RESET_X_ASCENT_DESCENT (it
);
7183 if (wrap_it
.sp
>= 0)
7190 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7192 result
= MOVE_LINE_CONTINUED
;
7196 if (BUFFER_POS_REACHED_P ())
7198 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7199 goto buffer_pos_reached
;
7200 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7203 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7207 if (new_x
> it
->first_visible_x
)
7209 /* Glyph is visible. Increment number of glyphs that
7210 would be displayed. */
7215 if (result
!= MOVE_UNDEFINED
)
7218 else if (BUFFER_POS_REACHED_P ())
7221 IT_RESET_X_ASCENT_DESCENT (it
);
7222 result
= MOVE_POS_MATCH_OR_ZV
;
7225 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7227 /* Stop when TO_X specified and reached. This check is
7228 necessary here because of lines consisting of a line end,
7229 only. The line end will not produce any glyphs and we
7230 would never get MOVE_X_REACHED. */
7231 xassert (it
->nglyphs
== 0);
7232 result
= MOVE_X_REACHED
;
7236 /* Is this a line end? If yes, we're done. */
7237 if (ITERATOR_AT_END_OF_LINE_P (it
))
7239 result
= MOVE_NEWLINE_OR_CR
;
7243 if (it
->method
== GET_FROM_BUFFER
)
7244 prev_pos
= IT_CHARPOS (*it
);
7245 /* The current display element has been consumed. Advance
7247 set_iterator_to_next (it
, 1);
7248 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7249 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7251 /* Stop if lines are truncated and IT's current x-position is
7252 past the right edge of the window now. */
7253 if (it
->line_wrap
== TRUNCATE
7254 && it
->current_x
>= it
->last_visible_x
)
7256 if (!FRAME_WINDOW_P (it
->f
)
7257 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7259 if (!get_next_display_element (it
)
7260 || BUFFER_POS_REACHED_P ())
7262 result
= MOVE_POS_MATCH_OR_ZV
;
7265 if (ITERATOR_AT_END_OF_LINE_P (it
))
7267 result
= MOVE_NEWLINE_OR_CR
;
7271 result
= MOVE_LINE_TRUNCATED
;
7274 #undef IT_RESET_X_ASCENT_DESCENT
7277 #undef BUFFER_POS_REACHED_P
7279 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7280 restore the saved iterator. */
7281 if (atpos_it
.sp
>= 0)
7283 else if (atx_it
.sp
>= 0)
7288 /* Restore the iterator settings altered at the beginning of this
7290 it
->glyph_row
= saved_glyph_row
;
7294 /* For external use. */
7296 move_it_in_display_line (struct it
*it
,
7297 EMACS_INT to_charpos
, int to_x
,
7298 enum move_operation_enum op
)
7300 if (it
->line_wrap
== WORD_WRAP
7301 && (op
& MOVE_TO_X
))
7303 struct it save_it
= *it
;
7304 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7305 /* When word-wrap is on, TO_X may lie past the end
7306 of a wrapped line. Then it->current is the
7307 character on the next line, so backtrack to the
7308 space before the wrap point. */
7309 if (skip
== MOVE_LINE_CONTINUED
)
7311 int prev_x
= max (it
->current_x
- 1, 0);
7313 move_it_in_display_line_to
7314 (it
, -1, prev_x
, MOVE_TO_X
);
7318 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7322 /* Move IT forward until it satisfies one or more of the criteria in
7323 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7325 OP is a bit-mask that specifies where to stop, and in particular,
7326 which of those four position arguments makes a difference. See the
7327 description of enum move_operation_enum.
7329 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7330 screen line, this function will set IT to the next position >
7334 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7336 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7337 int line_height
, line_start_x
= 0, reached
= 0;
7341 if (op
& MOVE_TO_VPOS
)
7343 /* If no TO_CHARPOS and no TO_X specified, stop at the
7344 start of the line TO_VPOS. */
7345 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7347 if (it
->vpos
== to_vpos
)
7353 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7357 /* TO_VPOS >= 0 means stop at TO_X in the line at
7358 TO_VPOS, or at TO_POS, whichever comes first. */
7359 if (it
->vpos
== to_vpos
)
7365 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7367 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7372 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7374 /* We have reached TO_X but not in the line we want. */
7375 skip
= move_it_in_display_line_to (it
, to_charpos
,
7377 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7385 else if (op
& MOVE_TO_Y
)
7387 struct it it_backup
;
7389 if (it
->line_wrap
== WORD_WRAP
)
7392 /* TO_Y specified means stop at TO_X in the line containing
7393 TO_Y---or at TO_CHARPOS if this is reached first. The
7394 problem is that we can't really tell whether the line
7395 contains TO_Y before we have completely scanned it, and
7396 this may skip past TO_X. What we do is to first scan to
7399 If TO_X is not specified, use a TO_X of zero. The reason
7400 is to make the outcome of this function more predictable.
7401 If we didn't use TO_X == 0, we would stop at the end of
7402 the line which is probably not what a caller would expect
7404 skip
= move_it_in_display_line_to
7405 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7406 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7408 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7409 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7411 else if (skip
== MOVE_X_REACHED
)
7413 /* If TO_X was reached, we want to know whether TO_Y is
7414 in the line. We know this is the case if the already
7415 scanned glyphs make the line tall enough. Otherwise,
7416 we must check by scanning the rest of the line. */
7417 line_height
= it
->max_ascent
+ it
->max_descent
;
7418 if (to_y
>= it
->current_y
7419 && to_y
< it
->current_y
+ line_height
)
7425 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7426 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7428 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7429 line_height
= it
->max_ascent
+ it
->max_descent
;
7430 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7432 if (to_y
>= it
->current_y
7433 && to_y
< it
->current_y
+ line_height
)
7435 /* If TO_Y is in this line and TO_X was reached
7436 above, we scanned too far. We have to restore
7437 IT's settings to the ones before skipping. */
7444 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7450 /* Check whether TO_Y is in this line. */
7451 line_height
= it
->max_ascent
+ it
->max_descent
;
7452 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7454 if (to_y
>= it
->current_y
7455 && to_y
< it
->current_y
+ line_height
)
7457 /* When word-wrap is on, TO_X may lie past the end
7458 of a wrapped line. Then it->current is the
7459 character on the next line, so backtrack to the
7460 space before the wrap point. */
7461 if (skip
== MOVE_LINE_CONTINUED
7462 && it
->line_wrap
== WORD_WRAP
)
7464 int prev_x
= max (it
->current_x
- 1, 0);
7466 skip
= move_it_in_display_line_to
7467 (it
, -1, prev_x
, MOVE_TO_X
);
7476 else if (BUFFERP (it
->object
)
7477 && (it
->method
== GET_FROM_BUFFER
7478 || it
->method
== GET_FROM_STRETCH
)
7479 && IT_CHARPOS (*it
) >= to_charpos
)
7480 skip
= MOVE_POS_MATCH_OR_ZV
;
7482 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7486 case MOVE_POS_MATCH_OR_ZV
:
7490 case MOVE_NEWLINE_OR_CR
:
7491 set_iterator_to_next (it
, 1);
7492 it
->continuation_lines_width
= 0;
7495 case MOVE_LINE_TRUNCATED
:
7496 it
->continuation_lines_width
= 0;
7497 reseat_at_next_visible_line_start (it
, 0);
7498 if ((op
& MOVE_TO_POS
) != 0
7499 && IT_CHARPOS (*it
) > to_charpos
)
7506 case MOVE_LINE_CONTINUED
:
7507 /* For continued lines ending in a tab, some of the glyphs
7508 associated with the tab are displayed on the current
7509 line. Since it->current_x does not include these glyphs,
7510 we use it->last_visible_x instead. */
7513 it
->continuation_lines_width
+= it
->last_visible_x
;
7514 /* When moving by vpos, ensure that the iterator really
7515 advances to the next line (bug#847, bug#969). Fixme:
7516 do we need to do this in other circumstances? */
7517 if (it
->current_x
!= it
->last_visible_x
7518 && (op
& MOVE_TO_VPOS
)
7519 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7521 line_start_x
= it
->current_x
+ it
->pixel_width
7522 - it
->last_visible_x
;
7523 set_iterator_to_next (it
, 0);
7527 it
->continuation_lines_width
+= it
->current_x
;
7534 /* Reset/increment for the next run. */
7535 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7536 it
->current_x
= line_start_x
;
7539 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7541 last_height
= it
->max_ascent
+ it
->max_descent
;
7542 last_max_ascent
= it
->max_ascent
;
7543 it
->max_ascent
= it
->max_descent
= 0;
7548 /* On text terminals, we may stop at the end of a line in the middle
7549 of a multi-character glyph. If the glyph itself is continued,
7550 i.e. it is actually displayed on the next line, don't treat this
7551 stopping point as valid; move to the next line instead (unless
7552 that brings us offscreen). */
7553 if (!FRAME_WINDOW_P (it
->f
)
7555 && IT_CHARPOS (*it
) == to_charpos
7556 && it
->what
== IT_CHARACTER
7558 && it
->line_wrap
== WINDOW_WRAP
7559 && it
->current_x
== it
->last_visible_x
- 1
7562 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7564 it
->continuation_lines_width
+= it
->current_x
;
7565 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7566 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7568 last_height
= it
->max_ascent
+ it
->max_descent
;
7569 last_max_ascent
= it
->max_ascent
;
7572 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7576 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7578 If DY > 0, move IT backward at least that many pixels. DY = 0
7579 means move IT backward to the preceding line start or BEGV. This
7580 function may move over more than DY pixels if IT->current_y - DY
7581 ends up in the middle of a line; in this case IT->current_y will be
7582 set to the top of the line moved to. */
7585 move_it_vertically_backward (struct it
*it
, int dy
)
7589 EMACS_INT start_pos
;
7594 start_pos
= IT_CHARPOS (*it
);
7596 /* Estimate how many newlines we must move back. */
7597 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7599 /* Set the iterator's position that many lines back. */
7600 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7601 back_to_previous_visible_line_start (it
);
7603 /* Reseat the iterator here. When moving backward, we don't want
7604 reseat to skip forward over invisible text, set up the iterator
7605 to deliver from overlay strings at the new position etc. So,
7606 use reseat_1 here. */
7607 reseat_1 (it
, it
->current
.pos
, 1);
7609 /* We are now surely at a line start. */
7610 it
->current_x
= it
->hpos
= 0;
7611 it
->continuation_lines_width
= 0;
7613 /* Move forward and see what y-distance we moved. First move to the
7614 start of the next line so that we get its height. We need this
7615 height to be able to tell whether we reached the specified
7618 it2
.max_ascent
= it2
.max_descent
= 0;
7621 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7622 MOVE_TO_POS
| MOVE_TO_VPOS
);
7624 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7625 xassert (IT_CHARPOS (*it
) >= BEGV
);
7628 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7629 xassert (IT_CHARPOS (*it
) >= BEGV
);
7630 /* H is the actual vertical distance from the position in *IT
7631 and the starting position. */
7632 h
= it2
.current_y
- it
->current_y
;
7633 /* NLINES is the distance in number of lines. */
7634 nlines
= it2
.vpos
- it
->vpos
;
7636 /* Correct IT's y and vpos position
7637 so that they are relative to the starting point. */
7643 /* DY == 0 means move to the start of the screen line. The
7644 value of nlines is > 0 if continuation lines were involved. */
7646 move_it_by_lines (it
, nlines
);
7650 /* The y-position we try to reach, relative to *IT.
7651 Note that H has been subtracted in front of the if-statement. */
7652 int target_y
= it
->current_y
+ h
- dy
;
7653 int y0
= it3
.current_y
;
7654 int y1
= line_bottom_y (&it3
);
7655 int line_height
= y1
- y0
;
7657 /* If we did not reach target_y, try to move further backward if
7658 we can. If we moved too far backward, try to move forward. */
7659 if (target_y
< it
->current_y
7660 /* This is heuristic. In a window that's 3 lines high, with
7661 a line height of 13 pixels each, recentering with point
7662 on the bottom line will try to move -39/2 = 19 pixels
7663 backward. Try to avoid moving into the first line. */
7664 && (it
->current_y
- target_y
7665 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7666 && IT_CHARPOS (*it
) > BEGV
)
7668 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7669 target_y
- it
->current_y
));
7670 dy
= it
->current_y
- target_y
;
7671 goto move_further_back
;
7673 else if (target_y
>= it
->current_y
+ line_height
7674 && IT_CHARPOS (*it
) < ZV
)
7676 /* Should move forward by at least one line, maybe more.
7678 Note: Calling move_it_by_lines can be expensive on
7679 terminal frames, where compute_motion is used (via
7680 vmotion) to do the job, when there are very long lines
7681 and truncate-lines is nil. That's the reason for
7682 treating terminal frames specially here. */
7684 if (!FRAME_WINDOW_P (it
->f
))
7685 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7690 move_it_by_lines (it
, 1);
7692 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7699 /* Move IT by a specified amount of pixel lines DY. DY negative means
7700 move backwards. DY = 0 means move to start of screen line. At the
7701 end, IT will be on the start of a screen line. */
7704 move_it_vertically (struct it
*it
, int dy
)
7707 move_it_vertically_backward (it
, -dy
);
7710 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7711 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7712 MOVE_TO_POS
| MOVE_TO_Y
);
7713 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7715 /* If buffer ends in ZV without a newline, move to the start of
7716 the line to satisfy the post-condition. */
7717 if (IT_CHARPOS (*it
) == ZV
7719 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7720 move_it_by_lines (it
, 0);
7725 /* Move iterator IT past the end of the text line it is in. */
7728 move_it_past_eol (struct it
*it
)
7730 enum move_it_result rc
;
7732 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7733 if (rc
== MOVE_NEWLINE_OR_CR
)
7734 set_iterator_to_next (it
, 0);
7738 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7739 negative means move up. DVPOS == 0 means move to the start of the
7742 Optimization idea: If we would know that IT->f doesn't use
7743 a face with proportional font, we could be faster for
7744 truncate-lines nil. */
7747 move_it_by_lines (struct it
*it
, int dvpos
)
7750 /* The commented-out optimization uses vmotion on terminals. This
7751 gives bad results, because elements like it->what, on which
7752 callers such as pos_visible_p rely, aren't updated. */
7753 /* struct position pos;
7754 if (!FRAME_WINDOW_P (it->f))
7756 struct text_pos textpos;
7758 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7759 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7760 reseat (it, textpos, 1);
7761 it->vpos += pos.vpos;
7762 it->current_y += pos.vpos;
7768 /* DVPOS == 0 means move to the start of the screen line. */
7769 move_it_vertically_backward (it
, 0);
7770 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7771 /* Let next call to line_bottom_y calculate real line height */
7776 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7777 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7778 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7783 EMACS_INT start_charpos
, i
;
7785 /* Start at the beginning of the screen line containing IT's
7786 position. This may actually move vertically backwards,
7787 in case of overlays, so adjust dvpos accordingly. */
7789 move_it_vertically_backward (it
, 0);
7792 /* Go back -DVPOS visible lines and reseat the iterator there. */
7793 start_charpos
= IT_CHARPOS (*it
);
7794 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7795 back_to_previous_visible_line_start (it
);
7796 reseat (it
, it
->current
.pos
, 1);
7798 /* Move further back if we end up in a string or an image. */
7799 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7801 /* First try to move to start of display line. */
7803 move_it_vertically_backward (it
, 0);
7805 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7807 /* If start of line is still in string or image,
7808 move further back. */
7809 back_to_previous_visible_line_start (it
);
7810 reseat (it
, it
->current
.pos
, 1);
7814 it
->current_x
= it
->hpos
= 0;
7816 /* Above call may have moved too far if continuation lines
7817 are involved. Scan forward and see if it did. */
7819 it2
.vpos
= it2
.current_y
= 0;
7820 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7821 it
->vpos
-= it2
.vpos
;
7822 it
->current_y
-= it2
.current_y
;
7823 it
->current_x
= it
->hpos
= 0;
7825 /* If we moved too far back, move IT some lines forward. */
7826 if (it2
.vpos
> -dvpos
)
7828 int delta
= it2
.vpos
+ dvpos
;
7830 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7831 /* Move back again if we got too far ahead. */
7832 if (IT_CHARPOS (*it
) >= start_charpos
)
7838 /* Return 1 if IT points into the middle of a display vector. */
7841 in_display_vector_p (struct it
*it
)
7843 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7844 && it
->current
.dpvec_index
> 0
7845 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7849 /***********************************************************************
7851 ***********************************************************************/
7854 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7858 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7860 Lisp_Object args
[3];
7861 Lisp_Object msg
, fmt
;
7864 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7867 /* Do nothing if called asynchronously. Inserting text into
7868 a buffer may call after-change-functions and alike and
7869 that would means running Lisp asynchronously. */
7870 if (handling_signal
)
7874 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7876 args
[0] = fmt
= build_string (format
);
7879 msg
= Fformat (3, args
);
7881 len
= SBYTES (msg
) + 1;
7882 SAFE_ALLOCA (buffer
, char *, len
);
7883 memcpy (buffer
, SDATA (msg
), len
);
7885 message_dolog (buffer
, len
- 1, 1, 0);
7892 /* Output a newline in the *Messages* buffer if "needs" one. */
7895 message_log_maybe_newline (void)
7897 if (message_log_need_newline
)
7898 message_dolog ("", 0, 1, 0);
7902 /* Add a string M of length NBYTES to the message log, optionally
7903 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7904 nonzero, means interpret the contents of M as multibyte. This
7905 function calls low-level routines in order to bypass text property
7906 hooks, etc. which might not be safe to run.
7908 This may GC (insert may run before/after change hooks),
7909 so the buffer M must NOT point to a Lisp string. */
7912 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7914 const unsigned char *msg
= (const unsigned char *) m
;
7916 if (!NILP (Vmemory_full
))
7919 if (!NILP (Vmessage_log_max
))
7921 struct buffer
*oldbuf
;
7922 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7923 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7924 EMACS_INT point_at_end
= 0;
7925 EMACS_INT zv_at_end
= 0;
7926 Lisp_Object old_deactivate_mark
, tem
;
7927 struct gcpro gcpro1
;
7929 old_deactivate_mark
= Vdeactivate_mark
;
7930 oldbuf
= current_buffer
;
7931 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7932 BVAR (current_buffer
, undo_list
) = Qt
;
7934 oldpoint
= message_dolog_marker1
;
7935 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7936 oldbegv
= message_dolog_marker2
;
7937 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7938 oldzv
= message_dolog_marker3
;
7939 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7940 GCPRO1 (old_deactivate_mark
);
7948 BEGV_BYTE
= BEG_BYTE
;
7951 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7953 /* Insert the string--maybe converting multibyte to single byte
7954 or vice versa, so that all the text fits the buffer. */
7956 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7962 /* Convert a multibyte string to single-byte
7963 for the *Message* buffer. */
7964 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7966 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7967 work
[0] = (ASCII_CHAR_P (c
)
7969 : multibyte_char_to_unibyte (c
));
7970 insert_1_both (work
, 1, 1, 1, 0, 0);
7973 else if (! multibyte
7974 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
7978 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7979 /* Convert a single-byte string to multibyte
7980 for the *Message* buffer. */
7981 for (i
= 0; i
< nbytes
; i
++)
7984 MAKE_CHAR_MULTIBYTE (c
);
7985 char_bytes
= CHAR_STRING (c
, str
);
7986 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7990 insert_1 (m
, nbytes
, 1, 0, 0);
7994 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7995 unsigned long int dups
;
7996 insert_1 ("\n", 1, 1, 0, 0);
7998 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8000 this_bol_byte
= PT_BYTE
;
8002 /* See if this line duplicates the previous one.
8003 If so, combine duplicates. */
8006 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8008 prev_bol_byte
= PT_BYTE
;
8010 dups
= message_log_check_duplicate (prev_bol_byte
,
8014 del_range_both (prev_bol
, prev_bol_byte
,
8015 this_bol
, this_bol_byte
, 0);
8021 /* If you change this format, don't forget to also
8022 change message_log_check_duplicate. */
8023 sprintf (dupstr
, " [%lu times]", dups
);
8024 duplen
= strlen (dupstr
);
8025 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8026 insert_1 (dupstr
, duplen
, 1, 0, 1);
8031 /* If we have more than the desired maximum number of lines
8032 in the *Messages* buffer now, delete the oldest ones.
8033 This is safe because we don't have undo in this buffer. */
8035 if (NATNUMP (Vmessage_log_max
))
8037 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8038 -XFASTINT (Vmessage_log_max
) - 1, 0);
8039 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8042 BEGV
= XMARKER (oldbegv
)->charpos
;
8043 BEGV_BYTE
= marker_byte_position (oldbegv
);
8052 ZV
= XMARKER (oldzv
)->charpos
;
8053 ZV_BYTE
= marker_byte_position (oldzv
);
8057 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8059 /* We can't do Fgoto_char (oldpoint) because it will run some
8061 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8062 XMARKER (oldpoint
)->bytepos
);
8065 unchain_marker (XMARKER (oldpoint
));
8066 unchain_marker (XMARKER (oldbegv
));
8067 unchain_marker (XMARKER (oldzv
));
8069 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8070 set_buffer_internal (oldbuf
);
8072 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8073 message_log_need_newline
= !nlflag
;
8074 Vdeactivate_mark
= old_deactivate_mark
;
8079 /* We are at the end of the buffer after just having inserted a newline.
8080 (Note: We depend on the fact we won't be crossing the gap.)
8081 Check to see if the most recent message looks a lot like the previous one.
8082 Return 0 if different, 1 if the new one should just replace it, or a
8083 value N > 1 if we should also append " [N times]". */
8085 static unsigned long int
8086 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8089 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8091 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8092 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8094 for (i
= 0; i
< len
; i
++)
8096 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8104 if (*p1
++ == ' ' && *p1
++ == '[')
8107 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8108 if (strncmp (pend
, " times]\n", 8) == 0)
8115 /* Display an echo area message M with a specified length of NBYTES
8116 bytes. The string may include null characters. If M is 0, clear
8117 out any existing message, and let the mini-buffer text show
8120 This may GC, so the buffer M must NOT point to a Lisp string. */
8123 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8125 /* First flush out any partial line written with print. */
8126 message_log_maybe_newline ();
8128 message_dolog (m
, nbytes
, 1, multibyte
);
8129 message2_nolog (m
, nbytes
, multibyte
);
8133 /* The non-logging counterpart of message2. */
8136 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8138 struct frame
*sf
= SELECTED_FRAME ();
8139 message_enable_multibyte
= multibyte
;
8141 if (FRAME_INITIAL_P (sf
))
8143 if (noninteractive_need_newline
)
8144 putc ('\n', stderr
);
8145 noninteractive_need_newline
= 0;
8147 fwrite (m
, nbytes
, 1, stderr
);
8148 if (cursor_in_echo_area
== 0)
8149 fprintf (stderr
, "\n");
8152 /* A null message buffer means that the frame hasn't really been
8153 initialized yet. Error messages get reported properly by
8154 cmd_error, so this must be just an informative message; toss it. */
8155 else if (INTERACTIVE
8156 && sf
->glyphs_initialized_p
8157 && FRAME_MESSAGE_BUF (sf
))
8159 Lisp_Object mini_window
;
8162 /* Get the frame containing the mini-buffer
8163 that the selected frame is using. */
8164 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8165 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8167 FRAME_SAMPLE_VISIBILITY (f
);
8168 if (FRAME_VISIBLE_P (sf
)
8169 && ! FRAME_VISIBLE_P (f
))
8170 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8174 set_message (m
, Qnil
, nbytes
, multibyte
);
8175 if (minibuffer_auto_raise
)
8176 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8179 clear_message (1, 1);
8181 do_pending_window_change (0);
8182 echo_area_display (1);
8183 do_pending_window_change (0);
8184 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8185 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8190 /* Display an echo area message M with a specified length of NBYTES
8191 bytes. The string may include null characters. If M is not a
8192 string, clear out any existing message, and let the mini-buffer
8195 This function cancels echoing. */
8198 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8200 struct gcpro gcpro1
;
8203 clear_message (1,1);
8206 /* First flush out any partial line written with print. */
8207 message_log_maybe_newline ();
8213 SAFE_ALLOCA (buffer
, char *, nbytes
);
8214 memcpy (buffer
, SDATA (m
), nbytes
);
8215 message_dolog (buffer
, nbytes
, 1, multibyte
);
8218 message3_nolog (m
, nbytes
, multibyte
);
8224 /* The non-logging version of message3.
8225 This does not cancel echoing, because it is used for echoing.
8226 Perhaps we need to make a separate function for echoing
8227 and make this cancel echoing. */
8230 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8232 struct frame
*sf
= SELECTED_FRAME ();
8233 message_enable_multibyte
= multibyte
;
8235 if (FRAME_INITIAL_P (sf
))
8237 if (noninteractive_need_newline
)
8238 putc ('\n', stderr
);
8239 noninteractive_need_newline
= 0;
8241 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8242 if (cursor_in_echo_area
== 0)
8243 fprintf (stderr
, "\n");
8246 /* A null message buffer means that the frame hasn't really been
8247 initialized yet. Error messages get reported properly by
8248 cmd_error, so this must be just an informative message; toss it. */
8249 else if (INTERACTIVE
8250 && sf
->glyphs_initialized_p
8251 && FRAME_MESSAGE_BUF (sf
))
8253 Lisp_Object mini_window
;
8257 /* Get the frame containing the mini-buffer
8258 that the selected frame is using. */
8259 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8260 frame
= XWINDOW (mini_window
)->frame
;
8263 FRAME_SAMPLE_VISIBILITY (f
);
8264 if (FRAME_VISIBLE_P (sf
)
8265 && !FRAME_VISIBLE_P (f
))
8266 Fmake_frame_visible (frame
);
8268 if (STRINGP (m
) && SCHARS (m
) > 0)
8270 set_message (NULL
, m
, nbytes
, multibyte
);
8271 if (minibuffer_auto_raise
)
8272 Fraise_frame (frame
);
8273 /* Assume we are not echoing.
8274 (If we are, echo_now will override this.) */
8275 echo_message_buffer
= Qnil
;
8278 clear_message (1, 1);
8280 do_pending_window_change (0);
8281 echo_area_display (1);
8282 do_pending_window_change (0);
8283 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8284 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8289 /* Display a null-terminated echo area message M. If M is 0, clear
8290 out any existing message, and let the mini-buffer text show through.
8292 The buffer M must continue to exist until after the echo area gets
8293 cleared or some other message gets displayed there. Do not pass
8294 text that is stored in a Lisp string. Do not pass text in a buffer
8295 that was alloca'd. */
8298 message1 (const char *m
)
8300 message2 (m
, (m
? strlen (m
) : 0), 0);
8304 /* The non-logging counterpart of message1. */
8307 message1_nolog (const char *m
)
8309 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8312 /* Display a message M which contains a single %s
8313 which gets replaced with STRING. */
8316 message_with_string (const char *m
, Lisp_Object string
, int log
)
8318 CHECK_STRING (string
);
8324 if (noninteractive_need_newline
)
8325 putc ('\n', stderr
);
8326 noninteractive_need_newline
= 0;
8327 fprintf (stderr
, m
, SDATA (string
));
8328 if (!cursor_in_echo_area
)
8329 fprintf (stderr
, "\n");
8333 else if (INTERACTIVE
)
8335 /* The frame whose minibuffer we're going to display the message on.
8336 It may be larger than the selected frame, so we need
8337 to use its buffer, not the selected frame's buffer. */
8338 Lisp_Object mini_window
;
8339 struct frame
*f
, *sf
= SELECTED_FRAME ();
8341 /* Get the frame containing the minibuffer
8342 that the selected frame is using. */
8343 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8344 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8346 /* A null message buffer means that the frame hasn't really been
8347 initialized yet. Error messages get reported properly by
8348 cmd_error, so this must be just an informative message; toss it. */
8349 if (FRAME_MESSAGE_BUF (f
))
8351 Lisp_Object args
[2], msg
;
8352 struct gcpro gcpro1
, gcpro2
;
8354 args
[0] = build_string (m
);
8355 args
[1] = msg
= string
;
8356 GCPRO2 (args
[0], msg
);
8359 msg
= Fformat (2, args
);
8362 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8364 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8368 /* Print should start at the beginning of the message
8369 buffer next time. */
8370 message_buf_print
= 0;
8376 /* Dump an informative message to the minibuf. If M is 0, clear out
8377 any existing message, and let the mini-buffer text show through. */
8380 vmessage (const char *m
, va_list ap
)
8386 if (noninteractive_need_newline
)
8387 putc ('\n', stderr
);
8388 noninteractive_need_newline
= 0;
8389 vfprintf (stderr
, m
, ap
);
8390 if (cursor_in_echo_area
== 0)
8391 fprintf (stderr
, "\n");
8395 else if (INTERACTIVE
)
8397 /* The frame whose mini-buffer we're going to display the message
8398 on. It may be larger than the selected frame, so we need to
8399 use its buffer, not the selected frame's buffer. */
8400 Lisp_Object mini_window
;
8401 struct frame
*f
, *sf
= SELECTED_FRAME ();
8403 /* Get the frame containing the mini-buffer
8404 that the selected frame is using. */
8405 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8406 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8408 /* A null message buffer means that the frame hasn't really been
8409 initialized yet. Error messages get reported properly by
8410 cmd_error, so this must be just an informative message; toss
8412 if (FRAME_MESSAGE_BUF (f
))
8416 char *buf
= FRAME_MESSAGE_BUF (f
);
8417 size_t bufsize
= FRAME_MESSAGE_BUF_SIZE (f
);
8420 memset (buf
, 0, bufsize
);
8421 len
= vsnprintf (buf
, bufsize
, m
, ap
);
8423 /* Do any truncation at a character boundary. */
8424 if (! (0 <= len
&& len
< bufsize
))
8425 for (len
= strnlen (buf
, bufsize
);
8426 len
&& ! CHAR_HEAD_P (buf
[len
- 1]);
8430 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8435 /* Print should start at the beginning of the message
8436 buffer next time. */
8437 message_buf_print
= 0;
8443 message (const char *m
, ...)
8453 /* The non-logging version of message. */
8456 message_nolog (const char *m
, ...)
8458 Lisp_Object old_log_max
;
8461 old_log_max
= Vmessage_log_max
;
8462 Vmessage_log_max
= Qnil
;
8464 Vmessage_log_max
= old_log_max
;
8470 /* Display the current message in the current mini-buffer. This is
8471 only called from error handlers in process.c, and is not time
8475 update_echo_area (void)
8477 if (!NILP (echo_area_buffer
[0]))
8480 string
= Fcurrent_message ();
8481 message3 (string
, SBYTES (string
),
8482 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8487 /* Make sure echo area buffers in `echo_buffers' are live.
8488 If they aren't, make new ones. */
8491 ensure_echo_area_buffers (void)
8495 for (i
= 0; i
< 2; ++i
)
8496 if (!BUFFERP (echo_buffer
[i
])
8497 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8500 Lisp_Object old_buffer
;
8503 old_buffer
= echo_buffer
[i
];
8504 sprintf (name
, " *Echo Area %d*", i
);
8505 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8506 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8507 /* to force word wrap in echo area -
8508 it was decided to postpone this*/
8509 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8511 for (j
= 0; j
< 2; ++j
)
8512 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8513 echo_area_buffer
[j
] = echo_buffer
[i
];
8518 /* Call FN with args A1..A4 with either the current or last displayed
8519 echo_area_buffer as current buffer.
8521 WHICH zero means use the current message buffer
8522 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8523 from echo_buffer[] and clear it.
8525 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8526 suitable buffer from echo_buffer[] and clear it.
8528 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8529 that the current message becomes the last displayed one, make
8530 choose a suitable buffer for echo_area_buffer[0], and clear it.
8532 Value is what FN returns. */
8535 with_echo_area_buffer (struct window
*w
, int which
,
8536 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8537 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8540 int this_one
, the_other
, clear_buffer_p
, rc
;
8541 int count
= SPECPDL_INDEX ();
8543 /* If buffers aren't live, make new ones. */
8544 ensure_echo_area_buffers ();
8549 this_one
= 0, the_other
= 1;
8551 this_one
= 1, the_other
= 0;
8554 this_one
= 0, the_other
= 1;
8557 /* We need a fresh one in case the current echo buffer equals
8558 the one containing the last displayed echo area message. */
8559 if (!NILP (echo_area_buffer
[this_one
])
8560 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8561 echo_area_buffer
[this_one
] = Qnil
;
8564 /* Choose a suitable buffer from echo_buffer[] is we don't
8566 if (NILP (echo_area_buffer
[this_one
]))
8568 echo_area_buffer
[this_one
]
8569 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8570 ? echo_buffer
[the_other
]
8571 : echo_buffer
[this_one
]);
8575 buffer
= echo_area_buffer
[this_one
];
8577 /* Don't get confused by reusing the buffer used for echoing
8578 for a different purpose. */
8579 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8582 record_unwind_protect (unwind_with_echo_area_buffer
,
8583 with_echo_area_buffer_unwind_data (w
));
8585 /* Make the echo area buffer current. Note that for display
8586 purposes, it is not necessary that the displayed window's buffer
8587 == current_buffer, except for text property lookup. So, let's
8588 only set that buffer temporarily here without doing a full
8589 Fset_window_buffer. We must also change w->pointm, though,
8590 because otherwise an assertions in unshow_buffer fails, and Emacs
8592 set_buffer_internal_1 (XBUFFER (buffer
));
8596 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8599 BVAR (current_buffer
, undo_list
) = Qt
;
8600 BVAR (current_buffer
, read_only
) = Qnil
;
8601 specbind (Qinhibit_read_only
, Qt
);
8602 specbind (Qinhibit_modification_hooks
, Qt
);
8604 if (clear_buffer_p
&& Z
> BEG
)
8607 xassert (BEGV
>= BEG
);
8608 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8610 rc
= fn (a1
, a2
, a3
, a4
);
8612 xassert (BEGV
>= BEG
);
8613 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8615 unbind_to (count
, Qnil
);
8620 /* Save state that should be preserved around the call to the function
8621 FN called in with_echo_area_buffer. */
8624 with_echo_area_buffer_unwind_data (struct window
*w
)
8627 Lisp_Object vector
, tmp
;
8629 /* Reduce consing by keeping one vector in
8630 Vwith_echo_area_save_vector. */
8631 vector
= Vwith_echo_area_save_vector
;
8632 Vwith_echo_area_save_vector
= Qnil
;
8635 vector
= Fmake_vector (make_number (7), Qnil
);
8637 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8638 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8639 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8643 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8644 ASET (vector
, i
, w
->buffer
); ++i
;
8645 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8646 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8651 for (; i
< end
; ++i
)
8652 ASET (vector
, i
, Qnil
);
8655 xassert (i
== ASIZE (vector
));
8660 /* Restore global state from VECTOR which was created by
8661 with_echo_area_buffer_unwind_data. */
8664 unwind_with_echo_area_buffer (Lisp_Object vector
)
8666 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8667 Vdeactivate_mark
= AREF (vector
, 1);
8668 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8670 if (WINDOWP (AREF (vector
, 3)))
8673 Lisp_Object buffer
, charpos
, bytepos
;
8675 w
= XWINDOW (AREF (vector
, 3));
8676 buffer
= AREF (vector
, 4);
8677 charpos
= AREF (vector
, 5);
8678 bytepos
= AREF (vector
, 6);
8681 set_marker_both (w
->pointm
, buffer
,
8682 XFASTINT (charpos
), XFASTINT (bytepos
));
8685 Vwith_echo_area_save_vector
= vector
;
8690 /* Set up the echo area for use by print functions. MULTIBYTE_P
8691 non-zero means we will print multibyte. */
8694 setup_echo_area_for_printing (int multibyte_p
)
8696 /* If we can't find an echo area any more, exit. */
8697 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8700 ensure_echo_area_buffers ();
8702 if (!message_buf_print
)
8704 /* A message has been output since the last time we printed.
8705 Choose a fresh echo area buffer. */
8706 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8707 echo_area_buffer
[0] = echo_buffer
[1];
8709 echo_area_buffer
[0] = echo_buffer
[0];
8711 /* Switch to that buffer and clear it. */
8712 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8713 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8717 int count
= SPECPDL_INDEX ();
8718 specbind (Qinhibit_read_only
, Qt
);
8719 /* Note that undo recording is always disabled. */
8721 unbind_to (count
, Qnil
);
8723 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8725 /* Set up the buffer for the multibyteness we need. */
8727 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8728 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8730 /* Raise the frame containing the echo area. */
8731 if (minibuffer_auto_raise
)
8733 struct frame
*sf
= SELECTED_FRAME ();
8734 Lisp_Object mini_window
;
8735 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8736 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8739 message_log_maybe_newline ();
8740 message_buf_print
= 1;
8744 if (NILP (echo_area_buffer
[0]))
8746 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8747 echo_area_buffer
[0] = echo_buffer
[1];
8749 echo_area_buffer
[0] = echo_buffer
[0];
8752 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8754 /* Someone switched buffers between print requests. */
8755 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8756 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8762 /* Display an echo area message in window W. Value is non-zero if W's
8763 height is changed. If display_last_displayed_message_p is
8764 non-zero, display the message that was last displayed, otherwise
8765 display the current message. */
8768 display_echo_area (struct window
*w
)
8770 int i
, no_message_p
, window_height_changed_p
, count
;
8772 /* Temporarily disable garbage collections while displaying the echo
8773 area. This is done because a GC can print a message itself.
8774 That message would modify the echo area buffer's contents while a
8775 redisplay of the buffer is going on, and seriously confuse
8777 count
= inhibit_garbage_collection ();
8779 /* If there is no message, we must call display_echo_area_1
8780 nevertheless because it resizes the window. But we will have to
8781 reset the echo_area_buffer in question to nil at the end because
8782 with_echo_area_buffer will sets it to an empty buffer. */
8783 i
= display_last_displayed_message_p
? 1 : 0;
8784 no_message_p
= NILP (echo_area_buffer
[i
]);
8786 window_height_changed_p
8787 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8788 display_echo_area_1
,
8789 (EMACS_INT
) w
, Qnil
, 0, 0);
8792 echo_area_buffer
[i
] = Qnil
;
8794 unbind_to (count
, Qnil
);
8795 return window_height_changed_p
;
8799 /* Helper for display_echo_area. Display the current buffer which
8800 contains the current echo area message in window W, a mini-window,
8801 a pointer to which is passed in A1. A2..A4 are currently not used.
8802 Change the height of W so that all of the message is displayed.
8803 Value is non-zero if height of W was changed. */
8806 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8808 struct window
*w
= (struct window
*) a1
;
8810 struct text_pos start
;
8811 int window_height_changed_p
= 0;
8813 /* Do this before displaying, so that we have a large enough glyph
8814 matrix for the display. If we can't get enough space for the
8815 whole text, display the last N lines. That works by setting w->start. */
8816 window_height_changed_p
= resize_mini_window (w
, 0);
8818 /* Use the starting position chosen by resize_mini_window. */
8819 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8822 clear_glyph_matrix (w
->desired_matrix
);
8823 XSETWINDOW (window
, w
);
8824 try_window (window
, start
, 0);
8826 return window_height_changed_p
;
8830 /* Resize the echo area window to exactly the size needed for the
8831 currently displayed message, if there is one. If a mini-buffer
8832 is active, don't shrink it. */
8835 resize_echo_area_exactly (void)
8837 if (BUFFERP (echo_area_buffer
[0])
8838 && WINDOWP (echo_area_window
))
8840 struct window
*w
= XWINDOW (echo_area_window
);
8842 Lisp_Object resize_exactly
;
8844 if (minibuf_level
== 0)
8845 resize_exactly
= Qt
;
8847 resize_exactly
= Qnil
;
8849 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8850 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8853 ++windows_or_buffers_changed
;
8854 ++update_mode_lines
;
8855 redisplay_internal ();
8861 /* Callback function for with_echo_area_buffer, when used from
8862 resize_echo_area_exactly. A1 contains a pointer to the window to
8863 resize, EXACTLY non-nil means resize the mini-window exactly to the
8864 size of the text displayed. A3 and A4 are not used. Value is what
8865 resize_mini_window returns. */
8868 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8870 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8874 /* Resize mini-window W to fit the size of its contents. EXACT_P
8875 means size the window exactly to the size needed. Otherwise, it's
8876 only enlarged until W's buffer is empty.
8878 Set W->start to the right place to begin display. If the whole
8879 contents fit, start at the beginning. Otherwise, start so as
8880 to make the end of the contents appear. This is particularly
8881 important for y-or-n-p, but seems desirable generally.
8883 Value is non-zero if the window height has been changed. */
8886 resize_mini_window (struct window
*w
, int exact_p
)
8888 struct frame
*f
= XFRAME (w
->frame
);
8889 int window_height_changed_p
= 0;
8891 xassert (MINI_WINDOW_P (w
));
8893 /* By default, start display at the beginning. */
8894 set_marker_both (w
->start
, w
->buffer
,
8895 BUF_BEGV (XBUFFER (w
->buffer
)),
8896 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8898 /* Don't resize windows while redisplaying a window; it would
8899 confuse redisplay functions when the size of the window they are
8900 displaying changes from under them. Such a resizing can happen,
8901 for instance, when which-func prints a long message while
8902 we are running fontification-functions. We're running these
8903 functions with safe_call which binds inhibit-redisplay to t. */
8904 if (!NILP (Vinhibit_redisplay
))
8907 /* Nil means don't try to resize. */
8908 if (NILP (Vresize_mini_windows
)
8909 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8912 if (!FRAME_MINIBUF_ONLY_P (f
))
8915 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8916 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8917 int height
, max_height
;
8918 int unit
= FRAME_LINE_HEIGHT (f
);
8919 struct text_pos start
;
8920 struct buffer
*old_current_buffer
= NULL
;
8922 if (current_buffer
!= XBUFFER (w
->buffer
))
8924 old_current_buffer
= current_buffer
;
8925 set_buffer_internal (XBUFFER (w
->buffer
));
8928 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8930 /* Compute the max. number of lines specified by the user. */
8931 if (FLOATP (Vmax_mini_window_height
))
8932 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8933 else if (INTEGERP (Vmax_mini_window_height
))
8934 max_height
= XINT (Vmax_mini_window_height
);
8936 max_height
= total_height
/ 4;
8938 /* Correct that max. height if it's bogus. */
8939 max_height
= max (1, max_height
);
8940 max_height
= min (total_height
, max_height
);
8942 /* Find out the height of the text in the window. */
8943 if (it
.line_wrap
== TRUNCATE
)
8948 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8949 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8950 height
= it
.current_y
+ last_height
;
8952 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8953 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8954 height
= (height
+ unit
- 1) / unit
;
8957 /* Compute a suitable window start. */
8958 if (height
> max_height
)
8960 height
= max_height
;
8961 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8962 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8963 start
= it
.current
.pos
;
8966 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8967 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8969 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8971 /* Let it grow only, until we display an empty message, in which
8972 case the window shrinks again. */
8973 if (height
> WINDOW_TOTAL_LINES (w
))
8975 int old_height
= WINDOW_TOTAL_LINES (w
);
8976 freeze_window_starts (f
, 1);
8977 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8978 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8980 else if (height
< WINDOW_TOTAL_LINES (w
)
8981 && (exact_p
|| BEGV
== ZV
))
8983 int old_height
= WINDOW_TOTAL_LINES (w
);
8984 freeze_window_starts (f
, 0);
8985 shrink_mini_window (w
);
8986 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8991 /* Always resize to exact size needed. */
8992 if (height
> WINDOW_TOTAL_LINES (w
))
8994 int old_height
= WINDOW_TOTAL_LINES (w
);
8995 freeze_window_starts (f
, 1);
8996 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8997 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8999 else if (height
< WINDOW_TOTAL_LINES (w
))
9001 int old_height
= WINDOW_TOTAL_LINES (w
);
9002 freeze_window_starts (f
, 0);
9003 shrink_mini_window (w
);
9007 freeze_window_starts (f
, 1);
9008 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9011 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9015 if (old_current_buffer
)
9016 set_buffer_internal (old_current_buffer
);
9019 return window_height_changed_p
;
9023 /* Value is the current message, a string, or nil if there is no
9027 current_message (void)
9031 if (!BUFFERP (echo_area_buffer
[0]))
9035 with_echo_area_buffer (0, 0, current_message_1
,
9036 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9038 echo_area_buffer
[0] = Qnil
;
9046 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9048 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9051 *msg
= make_buffer_string (BEG
, Z
, 1);
9058 /* Push the current message on Vmessage_stack for later restauration
9059 by restore_message. Value is non-zero if the current message isn't
9060 empty. This is a relatively infrequent operation, so it's not
9061 worth optimizing. */
9067 msg
= current_message ();
9068 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9069 return STRINGP (msg
);
9073 /* Restore message display from the top of Vmessage_stack. */
9076 restore_message (void)
9080 xassert (CONSP (Vmessage_stack
));
9081 msg
= XCAR (Vmessage_stack
);
9083 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9085 message3_nolog (msg
, 0, 0);
9089 /* Handler for record_unwind_protect calling pop_message. */
9092 pop_message_unwind (Lisp_Object dummy
)
9098 /* Pop the top-most entry off Vmessage_stack. */
9103 xassert (CONSP (Vmessage_stack
));
9104 Vmessage_stack
= XCDR (Vmessage_stack
);
9108 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9109 exits. If the stack is not empty, we have a missing pop_message
9113 check_message_stack (void)
9115 if (!NILP (Vmessage_stack
))
9120 /* Truncate to NCHARS what will be displayed in the echo area the next
9121 time we display it---but don't redisplay it now. */
9124 truncate_echo_area (EMACS_INT nchars
)
9127 echo_area_buffer
[0] = Qnil
;
9128 /* A null message buffer means that the frame hasn't really been
9129 initialized yet. Error messages get reported properly by
9130 cmd_error, so this must be just an informative message; toss it. */
9131 else if (!noninteractive
9133 && !NILP (echo_area_buffer
[0]))
9135 struct frame
*sf
= SELECTED_FRAME ();
9136 if (FRAME_MESSAGE_BUF (sf
))
9137 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9142 /* Helper function for truncate_echo_area. Truncate the current
9143 message to at most NCHARS characters. */
9146 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9148 if (BEG
+ nchars
< Z
)
9149 del_range (BEG
+ nchars
, Z
);
9151 echo_area_buffer
[0] = Qnil
;
9156 /* Set the current message to a substring of S or STRING.
9158 If STRING is a Lisp string, set the message to the first NBYTES
9159 bytes from STRING. NBYTES zero means use the whole string. If
9160 STRING is multibyte, the message will be displayed multibyte.
9162 If S is not null, set the message to the first LEN bytes of S. LEN
9163 zero means use the whole string. MULTIBYTE_P non-zero means S is
9164 multibyte. Display the message multibyte in that case.
9166 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9167 to t before calling set_message_1 (which calls insert).
9171 set_message (const char *s
, Lisp_Object string
,
9172 EMACS_INT nbytes
, int multibyte_p
)
9174 message_enable_multibyte
9175 = ((s
&& multibyte_p
)
9176 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9178 with_echo_area_buffer (0, -1, set_message_1
,
9179 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9180 message_buf_print
= 0;
9181 help_echo_showing_p
= 0;
9185 /* Helper function for set_message. Arguments have the same meaning
9186 as there, with A1 corresponding to S and A2 corresponding to STRING
9187 This function is called with the echo area buffer being
9191 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9193 const char *s
= (const char *) a1
;
9194 const unsigned char *msg
= (const unsigned char *) s
;
9195 Lisp_Object string
= a2
;
9197 /* Change multibyteness of the echo buffer appropriately. */
9198 if (message_enable_multibyte
9199 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9200 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9202 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9203 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9204 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9206 /* Insert new message at BEG. */
9207 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9209 if (STRINGP (string
))
9214 nbytes
= SBYTES (string
);
9215 nchars
= string_byte_to_char (string
, nbytes
);
9217 /* This function takes care of single/multibyte conversion. We
9218 just have to ensure that the echo area buffer has the right
9219 setting of enable_multibyte_characters. */
9220 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9225 nbytes
= strlen (s
);
9227 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9229 /* Convert from multi-byte to single-byte. */
9234 /* Convert a multibyte string to single-byte. */
9235 for (i
= 0; i
< nbytes
; i
+= n
)
9237 c
= string_char_and_length (msg
+ i
, &n
);
9238 work
[0] = (ASCII_CHAR_P (c
)
9240 : multibyte_char_to_unibyte (c
));
9241 insert_1_both (work
, 1, 1, 1, 0, 0);
9244 else if (!multibyte_p
9245 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9247 /* Convert from single-byte to multi-byte. */
9250 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9252 /* Convert a single-byte string to multibyte. */
9253 for (i
= 0; i
< nbytes
; i
++)
9256 MAKE_CHAR_MULTIBYTE (c
);
9257 n
= CHAR_STRING (c
, str
);
9258 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9262 insert_1 (s
, nbytes
, 1, 0, 0);
9269 /* Clear messages. CURRENT_P non-zero means clear the current
9270 message. LAST_DISPLAYED_P non-zero means clear the message
9274 clear_message (int current_p
, int last_displayed_p
)
9278 echo_area_buffer
[0] = Qnil
;
9279 message_cleared_p
= 1;
9282 if (last_displayed_p
)
9283 echo_area_buffer
[1] = Qnil
;
9285 message_buf_print
= 0;
9288 /* Clear garbaged frames.
9290 This function is used where the old redisplay called
9291 redraw_garbaged_frames which in turn called redraw_frame which in
9292 turn called clear_frame. The call to clear_frame was a source of
9293 flickering. I believe a clear_frame is not necessary. It should
9294 suffice in the new redisplay to invalidate all current matrices,
9295 and ensure a complete redisplay of all windows. */
9298 clear_garbaged_frames (void)
9302 Lisp_Object tail
, frame
;
9303 int changed_count
= 0;
9305 FOR_EACH_FRAME (tail
, frame
)
9307 struct frame
*f
= XFRAME (frame
);
9309 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9313 Fredraw_frame (frame
);
9314 f
->force_flush_display_p
= 1;
9316 clear_current_matrices (f
);
9325 ++windows_or_buffers_changed
;
9330 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9331 is non-zero update selected_frame. Value is non-zero if the
9332 mini-windows height has been changed. */
9335 echo_area_display (int update_frame_p
)
9337 Lisp_Object mini_window
;
9340 int window_height_changed_p
= 0;
9341 struct frame
*sf
= SELECTED_FRAME ();
9343 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9344 w
= XWINDOW (mini_window
);
9345 f
= XFRAME (WINDOW_FRAME (w
));
9347 /* Don't display if frame is invisible or not yet initialized. */
9348 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9351 #ifdef HAVE_WINDOW_SYSTEM
9352 /* When Emacs starts, selected_frame may be the initial terminal
9353 frame. If we let this through, a message would be displayed on
9355 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9357 #endif /* HAVE_WINDOW_SYSTEM */
9359 /* Redraw garbaged frames. */
9361 clear_garbaged_frames ();
9363 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9365 echo_area_window
= mini_window
;
9366 window_height_changed_p
= display_echo_area (w
);
9367 w
->must_be_updated_p
= 1;
9369 /* Update the display, unless called from redisplay_internal.
9370 Also don't update the screen during redisplay itself. The
9371 update will happen at the end of redisplay, and an update
9372 here could cause confusion. */
9373 if (update_frame_p
&& !redisplaying_p
)
9377 /* If the display update has been interrupted by pending
9378 input, update mode lines in the frame. Due to the
9379 pending input, it might have been that redisplay hasn't
9380 been called, so that mode lines above the echo area are
9381 garbaged. This looks odd, so we prevent it here. */
9382 if (!display_completed
)
9383 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9385 if (window_height_changed_p
9386 /* Don't do this if Emacs is shutting down. Redisplay
9387 needs to run hooks. */
9388 && !NILP (Vrun_hooks
))
9390 /* Must update other windows. Likewise as in other
9391 cases, don't let this update be interrupted by
9393 int count
= SPECPDL_INDEX ();
9394 specbind (Qredisplay_dont_pause
, Qt
);
9395 windows_or_buffers_changed
= 1;
9396 redisplay_internal ();
9397 unbind_to (count
, Qnil
);
9399 else if (FRAME_WINDOW_P (f
) && n
== 0)
9401 /* Window configuration is the same as before.
9402 Can do with a display update of the echo area,
9403 unless we displayed some mode lines. */
9404 update_single_window (w
, 1);
9405 FRAME_RIF (f
)->flush_display (f
);
9408 update_frame (f
, 1, 1);
9410 /* If cursor is in the echo area, make sure that the next
9411 redisplay displays the minibuffer, so that the cursor will
9412 be replaced with what the minibuffer wants. */
9413 if (cursor_in_echo_area
)
9414 ++windows_or_buffers_changed
;
9417 else if (!EQ (mini_window
, selected_window
))
9418 windows_or_buffers_changed
++;
9420 /* Last displayed message is now the current message. */
9421 echo_area_buffer
[1] = echo_area_buffer
[0];
9422 /* Inform read_char that we're not echoing. */
9423 echo_message_buffer
= Qnil
;
9425 /* Prevent redisplay optimization in redisplay_internal by resetting
9426 this_line_start_pos. This is done because the mini-buffer now
9427 displays the message instead of its buffer text. */
9428 if (EQ (mini_window
, selected_window
))
9429 CHARPOS (this_line_start_pos
) = 0;
9431 return window_height_changed_p
;
9436 /***********************************************************************
9437 Mode Lines and Frame Titles
9438 ***********************************************************************/
9440 /* A buffer for constructing non-propertized mode-line strings and
9441 frame titles in it; allocated from the heap in init_xdisp and
9442 resized as needed in store_mode_line_noprop_char. */
9444 static char *mode_line_noprop_buf
;
9446 /* The buffer's end, and a current output position in it. */
9448 static char *mode_line_noprop_buf_end
;
9449 static char *mode_line_noprop_ptr
;
9451 #define MODE_LINE_NOPROP_LEN(start) \
9452 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9455 MODE_LINE_DISPLAY
= 0,
9461 /* Alist that caches the results of :propertize.
9462 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9463 static Lisp_Object mode_line_proptrans_alist
;
9465 /* List of strings making up the mode-line. */
9466 static Lisp_Object mode_line_string_list
;
9468 /* Base face property when building propertized mode line string. */
9469 static Lisp_Object mode_line_string_face
;
9470 static Lisp_Object mode_line_string_face_prop
;
9473 /* Unwind data for mode line strings */
9475 static Lisp_Object Vmode_line_unwind_vector
;
9478 format_mode_line_unwind_data (struct buffer
*obuf
,
9482 Lisp_Object vector
, tmp
;
9484 /* Reduce consing by keeping one vector in
9485 Vwith_echo_area_save_vector. */
9486 vector
= Vmode_line_unwind_vector
;
9487 Vmode_line_unwind_vector
= Qnil
;
9490 vector
= Fmake_vector (make_number (8), Qnil
);
9492 ASET (vector
, 0, make_number (mode_line_target
));
9493 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9494 ASET (vector
, 2, mode_line_string_list
);
9495 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9496 ASET (vector
, 4, mode_line_string_face
);
9497 ASET (vector
, 5, mode_line_string_face_prop
);
9500 XSETBUFFER (tmp
, obuf
);
9503 ASET (vector
, 6, tmp
);
9504 ASET (vector
, 7, owin
);
9510 unwind_format_mode_line (Lisp_Object vector
)
9512 mode_line_target
= XINT (AREF (vector
, 0));
9513 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9514 mode_line_string_list
= AREF (vector
, 2);
9515 if (! EQ (AREF (vector
, 3), Qt
))
9516 mode_line_proptrans_alist
= AREF (vector
, 3);
9517 mode_line_string_face
= AREF (vector
, 4);
9518 mode_line_string_face_prop
= AREF (vector
, 5);
9520 if (!NILP (AREF (vector
, 7)))
9521 /* Select window before buffer, since it may change the buffer. */
9522 Fselect_window (AREF (vector
, 7), Qt
);
9524 if (!NILP (AREF (vector
, 6)))
9526 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9527 ASET (vector
, 6, Qnil
);
9530 Vmode_line_unwind_vector
= vector
;
9535 /* Store a single character C for the frame title in mode_line_noprop_buf.
9536 Re-allocate mode_line_noprop_buf if necessary. */
9539 store_mode_line_noprop_char (char c
)
9541 /* If output position has reached the end of the allocated buffer,
9542 double the buffer's size. */
9543 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9545 int len
= MODE_LINE_NOPROP_LEN (0);
9546 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9547 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9548 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9549 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9552 *mode_line_noprop_ptr
++ = c
;
9556 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9557 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9558 characters that yield more columns than PRECISION; PRECISION <= 0
9559 means copy the whole string. Pad with spaces until FIELD_WIDTH
9560 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9561 pad. Called from display_mode_element when it is used to build a
9565 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9567 const unsigned char *str
= (const unsigned char *) string
;
9569 EMACS_INT dummy
, nbytes
;
9571 /* Copy at most PRECISION chars from STR. */
9572 nbytes
= strlen (string
);
9573 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9575 store_mode_line_noprop_char (*str
++);
9577 /* Fill up with spaces until FIELD_WIDTH reached. */
9578 while (field_width
> 0
9581 store_mode_line_noprop_char (' ');
9588 /***********************************************************************
9590 ***********************************************************************/
9592 #ifdef HAVE_WINDOW_SYSTEM
9594 /* Set the title of FRAME, if it has changed. The title format is
9595 Vicon_title_format if FRAME is iconified, otherwise it is
9596 frame_title_format. */
9599 x_consider_frame_title (Lisp_Object frame
)
9601 struct frame
*f
= XFRAME (frame
);
9603 if (FRAME_WINDOW_P (f
)
9604 || FRAME_MINIBUF_ONLY_P (f
)
9605 || f
->explicit_name
)
9607 /* Do we have more than one visible frame on this X display? */
9614 int count
= SPECPDL_INDEX ();
9616 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9618 Lisp_Object other_frame
= XCAR (tail
);
9619 struct frame
*tf
= XFRAME (other_frame
);
9622 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9623 && !FRAME_MINIBUF_ONLY_P (tf
)
9624 && !EQ (other_frame
, tip_frame
)
9625 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9629 /* Set global variable indicating that multiple frames exist. */
9630 multiple_frames
= CONSP (tail
);
9632 /* Switch to the buffer of selected window of the frame. Set up
9633 mode_line_target so that display_mode_element will output into
9634 mode_line_noprop_buf; then display the title. */
9635 record_unwind_protect (unwind_format_mode_line
,
9636 format_mode_line_unwind_data
9637 (current_buffer
, selected_window
, 0));
9639 Fselect_window (f
->selected_window
, Qt
);
9640 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9641 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9643 mode_line_target
= MODE_LINE_TITLE
;
9644 title_start
= MODE_LINE_NOPROP_LEN (0);
9645 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9646 NULL
, DEFAULT_FACE_ID
);
9647 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9648 len
= MODE_LINE_NOPROP_LEN (title_start
);
9649 title
= mode_line_noprop_buf
+ title_start
;
9650 unbind_to (count
, Qnil
);
9652 /* Set the title only if it's changed. This avoids consing in
9653 the common case where it hasn't. (If it turns out that we've
9654 already wasted too much time by walking through the list with
9655 display_mode_element, then we might need to optimize at a
9656 higher level than this.) */
9657 if (! STRINGP (f
->name
)
9658 || SBYTES (f
->name
) != len
9659 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9660 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9664 #endif /* not HAVE_WINDOW_SYSTEM */
9669 /***********************************************************************
9671 ***********************************************************************/
9674 /* Prepare for redisplay by updating menu-bar item lists when
9675 appropriate. This can call eval. */
9678 prepare_menu_bars (void)
9681 struct gcpro gcpro1
, gcpro2
;
9683 Lisp_Object tooltip_frame
;
9685 #ifdef HAVE_WINDOW_SYSTEM
9686 tooltip_frame
= tip_frame
;
9688 tooltip_frame
= Qnil
;
9691 /* Update all frame titles based on their buffer names, etc. We do
9692 this before the menu bars so that the buffer-menu will show the
9693 up-to-date frame titles. */
9694 #ifdef HAVE_WINDOW_SYSTEM
9695 if (windows_or_buffers_changed
|| update_mode_lines
)
9697 Lisp_Object tail
, frame
;
9699 FOR_EACH_FRAME (tail
, frame
)
9702 if (!EQ (frame
, tooltip_frame
)
9703 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9704 x_consider_frame_title (frame
);
9707 #endif /* HAVE_WINDOW_SYSTEM */
9709 /* Update the menu bar item lists, if appropriate. This has to be
9710 done before any actual redisplay or generation of display lines. */
9711 all_windows
= (update_mode_lines
9712 || buffer_shared
> 1
9713 || windows_or_buffers_changed
);
9716 Lisp_Object tail
, frame
;
9717 int count
= SPECPDL_INDEX ();
9718 /* 1 means that update_menu_bar has run its hooks
9719 so any further calls to update_menu_bar shouldn't do so again. */
9720 int menu_bar_hooks_run
= 0;
9722 record_unwind_save_match_data ();
9724 FOR_EACH_FRAME (tail
, frame
)
9728 /* Ignore tooltip frame. */
9729 if (EQ (frame
, tooltip_frame
))
9732 /* If a window on this frame changed size, report that to
9733 the user and clear the size-change flag. */
9734 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9736 Lisp_Object functions
;
9738 /* Clear flag first in case we get an error below. */
9739 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9740 functions
= Vwindow_size_change_functions
;
9741 GCPRO2 (tail
, functions
);
9743 while (CONSP (functions
))
9745 if (!EQ (XCAR (functions
), Qt
))
9746 call1 (XCAR (functions
), frame
);
9747 functions
= XCDR (functions
);
9753 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9754 #ifdef HAVE_WINDOW_SYSTEM
9755 update_tool_bar (f
, 0);
9758 if (windows_or_buffers_changed
9760 ns_set_doc_edited (f
, Fbuffer_modified_p
9761 (XWINDOW (f
->selected_window
)->buffer
));
9766 unbind_to (count
, Qnil
);
9770 struct frame
*sf
= SELECTED_FRAME ();
9771 update_menu_bar (sf
, 1, 0);
9772 #ifdef HAVE_WINDOW_SYSTEM
9773 update_tool_bar (sf
, 1);
9779 /* Update the menu bar item list for frame F. This has to be done
9780 before we start to fill in any display lines, because it can call
9783 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9785 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9786 already ran the menu bar hooks for this redisplay, so there
9787 is no need to run them again. The return value is the
9788 updated value of this flag, to pass to the next call. */
9791 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9794 register struct window
*w
;
9796 /* If called recursively during a menu update, do nothing. This can
9797 happen when, for instance, an activate-menubar-hook causes a
9799 if (inhibit_menubar_update
)
9802 window
= FRAME_SELECTED_WINDOW (f
);
9803 w
= XWINDOW (window
);
9805 if (FRAME_WINDOW_P (f
)
9807 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9808 || defined (HAVE_NS) || defined (USE_GTK)
9809 FRAME_EXTERNAL_MENU_BAR (f
)
9811 FRAME_MENU_BAR_LINES (f
) > 0
9813 : FRAME_MENU_BAR_LINES (f
) > 0)
9815 /* If the user has switched buffers or windows, we need to
9816 recompute to reflect the new bindings. But we'll
9817 recompute when update_mode_lines is set too; that means
9818 that people can use force-mode-line-update to request
9819 that the menu bar be recomputed. The adverse effect on
9820 the rest of the redisplay algorithm is about the same as
9821 windows_or_buffers_changed anyway. */
9822 if (windows_or_buffers_changed
9823 /* This used to test w->update_mode_line, but we believe
9824 there is no need to recompute the menu in that case. */
9825 || update_mode_lines
9826 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9827 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9828 != !NILP (w
->last_had_star
))
9829 || ((!NILP (Vtransient_mark_mode
)
9830 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9831 != !NILP (w
->region_showing
)))
9833 struct buffer
*prev
= current_buffer
;
9834 int count
= SPECPDL_INDEX ();
9836 specbind (Qinhibit_menubar_update
, Qt
);
9838 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9839 if (save_match_data
)
9840 record_unwind_save_match_data ();
9841 if (NILP (Voverriding_local_map_menu_flag
))
9843 specbind (Qoverriding_terminal_local_map
, Qnil
);
9844 specbind (Qoverriding_local_map
, Qnil
);
9849 /* Run the Lucid hook. */
9850 safe_run_hooks (Qactivate_menubar_hook
);
9852 /* If it has changed current-menubar from previous value,
9853 really recompute the menu-bar from the value. */
9854 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9855 call0 (Qrecompute_lucid_menubar
);
9857 safe_run_hooks (Qmenu_bar_update_hook
);
9862 XSETFRAME (Vmenu_updating_frame
, f
);
9863 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9865 /* Redisplay the menu bar in case we changed it. */
9866 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9867 || defined (HAVE_NS) || defined (USE_GTK)
9868 if (FRAME_WINDOW_P (f
))
9870 #if defined (HAVE_NS)
9871 /* All frames on Mac OS share the same menubar. So only
9872 the selected frame should be allowed to set it. */
9873 if (f
== SELECTED_FRAME ())
9875 set_frame_menubar (f
, 0, 0);
9878 /* On a terminal screen, the menu bar is an ordinary screen
9879 line, and this makes it get updated. */
9880 w
->update_mode_line
= Qt
;
9881 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9882 /* In the non-toolkit version, the menu bar is an ordinary screen
9883 line, and this makes it get updated. */
9884 w
->update_mode_line
= Qt
;
9885 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9887 unbind_to (count
, Qnil
);
9888 set_buffer_internal_1 (prev
);
9897 /***********************************************************************
9899 ***********************************************************************/
9901 #ifdef HAVE_WINDOW_SYSTEM
9904 Nominal cursor position -- where to draw output.
9905 HPOS and VPOS are window relative glyph matrix coordinates.
9906 X and Y are window relative pixel coordinates. */
9908 struct cursor_pos output_cursor
;
9912 Set the global variable output_cursor to CURSOR. All cursor
9913 positions are relative to updated_window. */
9916 set_output_cursor (struct cursor_pos
*cursor
)
9918 output_cursor
.hpos
= cursor
->hpos
;
9919 output_cursor
.vpos
= cursor
->vpos
;
9920 output_cursor
.x
= cursor
->x
;
9921 output_cursor
.y
= cursor
->y
;
9926 Set a nominal cursor position.
9928 HPOS and VPOS are column/row positions in a window glyph matrix. X
9929 and Y are window text area relative pixel positions.
9931 If this is done during an update, updated_window will contain the
9932 window that is being updated and the position is the future output
9933 cursor position for that window. If updated_window is null, use
9934 selected_window and display the cursor at the given position. */
9937 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9941 /* If updated_window is not set, work on selected_window. */
9945 w
= XWINDOW (selected_window
);
9947 /* Set the output cursor. */
9948 output_cursor
.hpos
= hpos
;
9949 output_cursor
.vpos
= vpos
;
9950 output_cursor
.x
= x
;
9951 output_cursor
.y
= y
;
9953 /* If not called as part of an update, really display the cursor.
9954 This will also set the cursor position of W. */
9955 if (updated_window
== NULL
)
9958 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9959 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9960 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9965 #endif /* HAVE_WINDOW_SYSTEM */
9968 /***********************************************************************
9970 ***********************************************************************/
9972 #ifdef HAVE_WINDOW_SYSTEM
9974 /* Where the mouse was last time we reported a mouse event. */
9976 FRAME_PTR last_mouse_frame
;
9978 /* Tool-bar item index of the item on which a mouse button was pressed
9981 int last_tool_bar_item
;
9985 update_tool_bar_unwind (Lisp_Object frame
)
9987 selected_frame
= frame
;
9991 /* Update the tool-bar item list for frame F. This has to be done
9992 before we start to fill in any display lines. Called from
9993 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9994 and restore it here. */
9997 update_tool_bar (struct frame
*f
, int save_match_data
)
9999 #if defined (USE_GTK) || defined (HAVE_NS)
10000 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10002 int do_update
= WINDOWP (f
->tool_bar_window
)
10003 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10008 Lisp_Object window
;
10011 window
= FRAME_SELECTED_WINDOW (f
);
10012 w
= XWINDOW (window
);
10014 /* If the user has switched buffers or windows, we need to
10015 recompute to reflect the new bindings. But we'll
10016 recompute when update_mode_lines is set too; that means
10017 that people can use force-mode-line-update to request
10018 that the menu bar be recomputed. The adverse effect on
10019 the rest of the redisplay algorithm is about the same as
10020 windows_or_buffers_changed anyway. */
10021 if (windows_or_buffers_changed
10022 || !NILP (w
->update_mode_line
)
10023 || update_mode_lines
10024 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10025 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10026 != !NILP (w
->last_had_star
))
10027 || ((!NILP (Vtransient_mark_mode
)
10028 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10029 != !NILP (w
->region_showing
)))
10031 struct buffer
*prev
= current_buffer
;
10032 int count
= SPECPDL_INDEX ();
10033 Lisp_Object frame
, new_tool_bar
;
10034 int new_n_tool_bar
;
10035 struct gcpro gcpro1
;
10037 /* Set current_buffer to the buffer of the selected
10038 window of the frame, so that we get the right local
10040 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10042 /* Save match data, if we must. */
10043 if (save_match_data
)
10044 record_unwind_save_match_data ();
10046 /* Make sure that we don't accidentally use bogus keymaps. */
10047 if (NILP (Voverriding_local_map_menu_flag
))
10049 specbind (Qoverriding_terminal_local_map
, Qnil
);
10050 specbind (Qoverriding_local_map
, Qnil
);
10053 GCPRO1 (new_tool_bar
);
10055 /* We must temporarily set the selected frame to this frame
10056 before calling tool_bar_items, because the calculation of
10057 the tool-bar keymap uses the selected frame (see
10058 `tool-bar-make-keymap' in tool-bar.el). */
10059 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10060 XSETFRAME (frame
, f
);
10061 selected_frame
= frame
;
10063 /* Build desired tool-bar items from keymaps. */
10064 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10067 /* Redisplay the tool-bar if we changed it. */
10068 if (new_n_tool_bar
!= f
->n_tool_bar_items
10069 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10071 /* Redisplay that happens asynchronously due to an expose event
10072 may access f->tool_bar_items. Make sure we update both
10073 variables within BLOCK_INPUT so no such event interrupts. */
10075 f
->tool_bar_items
= new_tool_bar
;
10076 f
->n_tool_bar_items
= new_n_tool_bar
;
10077 w
->update_mode_line
= Qt
;
10083 unbind_to (count
, Qnil
);
10084 set_buffer_internal_1 (prev
);
10090 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10091 F's desired tool-bar contents. F->tool_bar_items must have
10092 been set up previously by calling prepare_menu_bars. */
10095 build_desired_tool_bar_string (struct frame
*f
)
10097 int i
, size
, size_needed
;
10098 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10099 Lisp_Object image
, plist
, props
;
10101 image
= plist
= props
= Qnil
;
10102 GCPRO3 (image
, plist
, props
);
10104 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10105 Otherwise, make a new string. */
10107 /* The size of the string we might be able to reuse. */
10108 size
= (STRINGP (f
->desired_tool_bar_string
)
10109 ? SCHARS (f
->desired_tool_bar_string
)
10112 /* We need one space in the string for each image. */
10113 size_needed
= f
->n_tool_bar_items
;
10115 /* Reuse f->desired_tool_bar_string, if possible. */
10116 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10117 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10118 make_number (' '));
10121 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10122 Fremove_text_properties (make_number (0), make_number (size
),
10123 props
, f
->desired_tool_bar_string
);
10126 /* Put a `display' property on the string for the images to display,
10127 put a `menu_item' property on tool-bar items with a value that
10128 is the index of the item in F's tool-bar item vector. */
10129 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10131 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10133 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10134 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10135 int hmargin
, vmargin
, relief
, idx
, end
;
10137 /* If image is a vector, choose the image according to the
10139 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10140 if (VECTORP (image
))
10144 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10145 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10148 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10149 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10151 xassert (ASIZE (image
) >= idx
);
10152 image
= AREF (image
, idx
);
10157 /* Ignore invalid image specifications. */
10158 if (!valid_image_p (image
))
10161 /* Display the tool-bar button pressed, or depressed. */
10162 plist
= Fcopy_sequence (XCDR (image
));
10164 /* Compute margin and relief to draw. */
10165 relief
= (tool_bar_button_relief
>= 0
10166 ? tool_bar_button_relief
10167 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10168 hmargin
= vmargin
= relief
;
10170 if (INTEGERP (Vtool_bar_button_margin
)
10171 && XINT (Vtool_bar_button_margin
) > 0)
10173 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10174 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10176 else if (CONSP (Vtool_bar_button_margin
))
10178 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10179 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10180 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10182 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10183 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10184 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10187 if (auto_raise_tool_bar_buttons_p
)
10189 /* Add a `:relief' property to the image spec if the item is
10193 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10200 /* If image is selected, display it pressed, i.e. with a
10201 negative relief. If it's not selected, display it with a
10203 plist
= Fplist_put (plist
, QCrelief
,
10205 ? make_number (-relief
)
10206 : make_number (relief
)));
10211 /* Put a margin around the image. */
10212 if (hmargin
|| vmargin
)
10214 if (hmargin
== vmargin
)
10215 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10217 plist
= Fplist_put (plist
, QCmargin
,
10218 Fcons (make_number (hmargin
),
10219 make_number (vmargin
)));
10222 /* If button is not enabled, and we don't have special images
10223 for the disabled state, make the image appear disabled by
10224 applying an appropriate algorithm to it. */
10225 if (!enabled_p
&& idx
< 0)
10226 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10228 /* Put a `display' text property on the string for the image to
10229 display. Put a `menu-item' property on the string that gives
10230 the start of this item's properties in the tool-bar items
10232 image
= Fcons (Qimage
, plist
);
10233 props
= list4 (Qdisplay
, image
,
10234 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10236 /* Let the last image hide all remaining spaces in the tool bar
10237 string. The string can be longer than needed when we reuse a
10238 previous string. */
10239 if (i
+ 1 == f
->n_tool_bar_items
)
10240 end
= SCHARS (f
->desired_tool_bar_string
);
10243 Fadd_text_properties (make_number (i
), make_number (end
),
10244 props
, f
->desired_tool_bar_string
);
10252 /* Display one line of the tool-bar of frame IT->f.
10254 HEIGHT specifies the desired height of the tool-bar line.
10255 If the actual height of the glyph row is less than HEIGHT, the
10256 row's height is increased to HEIGHT, and the icons are centered
10257 vertically in the new height.
10259 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10260 count a final empty row in case the tool-bar width exactly matches
10265 display_tool_bar_line (struct it
*it
, int height
)
10267 struct glyph_row
*row
= it
->glyph_row
;
10268 int max_x
= it
->last_visible_x
;
10269 struct glyph
*last
;
10271 prepare_desired_row (row
);
10272 row
->y
= it
->current_y
;
10274 /* Note that this isn't made use of if the face hasn't a box,
10275 so there's no need to check the face here. */
10276 it
->start_of_box_run_p
= 1;
10278 while (it
->current_x
< max_x
)
10280 int x
, n_glyphs_before
, i
, nglyphs
;
10281 struct it it_before
;
10283 /* Get the next display element. */
10284 if (!get_next_display_element (it
))
10286 /* Don't count empty row if we are counting needed tool-bar lines. */
10287 if (height
< 0 && !it
->hpos
)
10292 /* Produce glyphs. */
10293 n_glyphs_before
= row
->used
[TEXT_AREA
];
10296 PRODUCE_GLYPHS (it
);
10298 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10300 x
= it_before
.current_x
;
10301 while (i
< nglyphs
)
10303 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10305 if (x
+ glyph
->pixel_width
> max_x
)
10307 /* Glyph doesn't fit on line. Backtrack. */
10308 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10310 /* If this is the only glyph on this line, it will never fit on the
10311 tool-bar, so skip it. But ensure there is at least one glyph,
10312 so we don't accidentally disable the tool-bar. */
10313 if (n_glyphs_before
== 0
10314 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10320 x
+= glyph
->pixel_width
;
10324 /* Stop at line ends. */
10325 if (ITERATOR_AT_END_OF_LINE_P (it
))
10328 set_iterator_to_next (it
, 1);
10333 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10335 /* Use default face for the border below the tool bar.
10337 FIXME: When auto-resize-tool-bars is grow-only, there is
10338 no additional border below the possibly empty tool-bar lines.
10339 So to make the extra empty lines look "normal", we have to
10340 use the tool-bar face for the border too. */
10341 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10342 it
->face_id
= DEFAULT_FACE_ID
;
10344 extend_face_to_end_of_line (it
);
10345 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10346 last
->right_box_line_p
= 1;
10347 if (last
== row
->glyphs
[TEXT_AREA
])
10348 last
->left_box_line_p
= 1;
10350 /* Make line the desired height and center it vertically. */
10351 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10353 /* Don't add more than one line height. */
10354 height
%= FRAME_LINE_HEIGHT (it
->f
);
10355 it
->max_ascent
+= height
/ 2;
10356 it
->max_descent
+= (height
+ 1) / 2;
10359 compute_line_metrics (it
);
10361 /* If line is empty, make it occupy the rest of the tool-bar. */
10362 if (!row
->displays_text_p
)
10364 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10365 row
->visible_height
= row
->height
;
10366 row
->ascent
= row
->phys_ascent
= 0;
10367 row
->extra_line_spacing
= 0;
10370 row
->full_width_p
= 1;
10371 row
->continued_p
= 0;
10372 row
->truncated_on_left_p
= 0;
10373 row
->truncated_on_right_p
= 0;
10375 it
->current_x
= it
->hpos
= 0;
10376 it
->current_y
+= row
->height
;
10382 /* Max tool-bar height. */
10384 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10385 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10387 /* Value is the number of screen lines needed to make all tool-bar
10388 items of frame F visible. The number of actual rows needed is
10389 returned in *N_ROWS if non-NULL. */
10392 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10394 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10396 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10397 the desired matrix, so use (unused) mode-line row as temporary row to
10398 avoid destroying the first tool-bar row. */
10399 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10401 /* Initialize an iterator for iteration over
10402 F->desired_tool_bar_string in the tool-bar window of frame F. */
10403 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10404 it
.first_visible_x
= 0;
10405 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10406 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10408 while (!ITERATOR_AT_END_P (&it
))
10410 clear_glyph_row (temp_row
);
10411 it
.glyph_row
= temp_row
;
10412 display_tool_bar_line (&it
, -1);
10414 clear_glyph_row (temp_row
);
10416 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10418 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10420 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10424 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10426 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10427 (Lisp_Object frame
)
10434 frame
= selected_frame
;
10436 CHECK_FRAME (frame
);
10437 f
= XFRAME (frame
);
10439 if (WINDOWP (f
->tool_bar_window
)
10440 || (w
= XWINDOW (f
->tool_bar_window
),
10441 WINDOW_TOTAL_LINES (w
) > 0))
10443 update_tool_bar (f
, 1);
10444 if (f
->n_tool_bar_items
)
10446 build_desired_tool_bar_string (f
);
10447 nlines
= tool_bar_lines_needed (f
, NULL
);
10451 return make_number (nlines
);
10455 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10456 height should be changed. */
10459 redisplay_tool_bar (struct frame
*f
)
10463 struct glyph_row
*row
;
10465 #if defined (USE_GTK) || defined (HAVE_NS)
10466 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10467 update_frame_tool_bar (f
);
10471 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10472 do anything. This means you must start with tool-bar-lines
10473 non-zero to get the auto-sizing effect. Or in other words, you
10474 can turn off tool-bars by specifying tool-bar-lines zero. */
10475 if (!WINDOWP (f
->tool_bar_window
)
10476 || (w
= XWINDOW (f
->tool_bar_window
),
10477 WINDOW_TOTAL_LINES (w
) == 0))
10480 /* Set up an iterator for the tool-bar window. */
10481 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10482 it
.first_visible_x
= 0;
10483 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10484 row
= it
.glyph_row
;
10486 /* Build a string that represents the contents of the tool-bar. */
10487 build_desired_tool_bar_string (f
);
10488 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10490 if (f
->n_tool_bar_rows
== 0)
10494 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10495 nlines
!= WINDOW_TOTAL_LINES (w
)))
10498 int old_height
= WINDOW_TOTAL_LINES (w
);
10500 XSETFRAME (frame
, f
);
10501 Fmodify_frame_parameters (frame
,
10502 Fcons (Fcons (Qtool_bar_lines
,
10503 make_number (nlines
)),
10505 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10507 clear_glyph_matrix (w
->desired_matrix
);
10508 fonts_changed_p
= 1;
10514 /* Display as many lines as needed to display all tool-bar items. */
10516 if (f
->n_tool_bar_rows
> 0)
10518 int border
, rows
, height
, extra
;
10520 if (INTEGERP (Vtool_bar_border
))
10521 border
= XINT (Vtool_bar_border
);
10522 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10523 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10524 else if (EQ (Vtool_bar_border
, Qborder_width
))
10525 border
= f
->border_width
;
10531 rows
= f
->n_tool_bar_rows
;
10532 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10533 extra
= it
.last_visible_y
- border
- height
* rows
;
10535 while (it
.current_y
< it
.last_visible_y
)
10538 if (extra
> 0 && rows
-- > 0)
10540 h
= (extra
+ rows
- 1) / rows
;
10543 display_tool_bar_line (&it
, height
+ h
);
10548 while (it
.current_y
< it
.last_visible_y
)
10549 display_tool_bar_line (&it
, 0);
10552 /* It doesn't make much sense to try scrolling in the tool-bar
10553 window, so don't do it. */
10554 w
->desired_matrix
->no_scrolling_p
= 1;
10555 w
->must_be_updated_p
= 1;
10557 if (!NILP (Vauto_resize_tool_bars
))
10559 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10560 int change_height_p
= 0;
10562 /* If we couldn't display everything, change the tool-bar's
10563 height if there is room for more. */
10564 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10565 && it
.current_y
< max_tool_bar_height
)
10566 change_height_p
= 1;
10568 row
= it
.glyph_row
- 1;
10570 /* If there are blank lines at the end, except for a partially
10571 visible blank line at the end that is smaller than
10572 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10573 if (!row
->displays_text_p
10574 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10575 change_height_p
= 1;
10577 /* If row displays tool-bar items, but is partially visible,
10578 change the tool-bar's height. */
10579 if (row
->displays_text_p
10580 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10581 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10582 change_height_p
= 1;
10584 /* Resize windows as needed by changing the `tool-bar-lines'
10585 frame parameter. */
10586 if (change_height_p
)
10589 int old_height
= WINDOW_TOTAL_LINES (w
);
10591 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10593 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10594 && !f
->minimize_tool_bar_window_p
)
10595 ? (nlines
> old_height
)
10596 : (nlines
!= old_height
));
10597 f
->minimize_tool_bar_window_p
= 0;
10599 if (change_height_p
)
10601 XSETFRAME (frame
, f
);
10602 Fmodify_frame_parameters (frame
,
10603 Fcons (Fcons (Qtool_bar_lines
,
10604 make_number (nlines
)),
10606 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10608 clear_glyph_matrix (w
->desired_matrix
);
10609 f
->n_tool_bar_rows
= nrows
;
10610 fonts_changed_p
= 1;
10617 f
->minimize_tool_bar_window_p
= 0;
10622 /* Get information about the tool-bar item which is displayed in GLYPH
10623 on frame F. Return in *PROP_IDX the index where tool-bar item
10624 properties start in F->tool_bar_items. Value is zero if
10625 GLYPH doesn't display a tool-bar item. */
10628 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10634 /* This function can be called asynchronously, which means we must
10635 exclude any possibility that Fget_text_property signals an
10637 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10638 charpos
= max (0, charpos
);
10640 /* Get the text property `menu-item' at pos. The value of that
10641 property is the start index of this item's properties in
10642 F->tool_bar_items. */
10643 prop
= Fget_text_property (make_number (charpos
),
10644 Qmenu_item
, f
->current_tool_bar_string
);
10645 if (INTEGERP (prop
))
10647 *prop_idx
= XINT (prop
);
10657 /* Get information about the tool-bar item at position X/Y on frame F.
10658 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10659 the current matrix of the tool-bar window of F, or NULL if not
10660 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10661 item in F->tool_bar_items. Value is
10663 -1 if X/Y is not on a tool-bar item
10664 0 if X/Y is on the same item that was highlighted before.
10668 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10669 int *hpos
, int *vpos
, int *prop_idx
)
10671 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10672 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10675 /* Find the glyph under X/Y. */
10676 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10677 if (*glyph
== NULL
)
10680 /* Get the start of this tool-bar item's properties in
10681 f->tool_bar_items. */
10682 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10685 /* Is mouse on the highlighted item? */
10686 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10687 && *vpos
>= hlinfo
->mouse_face_beg_row
10688 && *vpos
<= hlinfo
->mouse_face_end_row
10689 && (*vpos
> hlinfo
->mouse_face_beg_row
10690 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10691 && (*vpos
< hlinfo
->mouse_face_end_row
10692 || *hpos
< hlinfo
->mouse_face_end_col
10693 || hlinfo
->mouse_face_past_end
))
10701 Handle mouse button event on the tool-bar of frame F, at
10702 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10703 0 for button release. MODIFIERS is event modifiers for button
10707 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10708 unsigned int modifiers
)
10710 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10711 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10712 int hpos
, vpos
, prop_idx
;
10713 struct glyph
*glyph
;
10714 Lisp_Object enabled_p
;
10716 /* If not on the highlighted tool-bar item, return. */
10717 frame_to_window_pixel_xy (w
, &x
, &y
);
10718 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10721 /* If item is disabled, do nothing. */
10722 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10723 if (NILP (enabled_p
))
10728 /* Show item in pressed state. */
10729 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10730 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10731 last_tool_bar_item
= prop_idx
;
10735 Lisp_Object key
, frame
;
10736 struct input_event event
;
10737 EVENT_INIT (event
);
10739 /* Show item in released state. */
10740 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10741 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10743 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10745 XSETFRAME (frame
, f
);
10746 event
.kind
= TOOL_BAR_EVENT
;
10747 event
.frame_or_window
= frame
;
10749 kbd_buffer_store_event (&event
);
10751 event
.kind
= TOOL_BAR_EVENT
;
10752 event
.frame_or_window
= frame
;
10754 event
.modifiers
= modifiers
;
10755 kbd_buffer_store_event (&event
);
10756 last_tool_bar_item
= -1;
10761 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10762 tool-bar window-relative coordinates X/Y. Called from
10763 note_mouse_highlight. */
10766 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10768 Lisp_Object window
= f
->tool_bar_window
;
10769 struct window
*w
= XWINDOW (window
);
10770 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10771 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10773 struct glyph
*glyph
;
10774 struct glyph_row
*row
;
10776 Lisp_Object enabled_p
;
10778 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10779 int mouse_down_p
, rc
;
10781 /* Function note_mouse_highlight is called with negative X/Y
10782 values when mouse moves outside of the frame. */
10783 if (x
<= 0 || y
<= 0)
10785 clear_mouse_face (hlinfo
);
10789 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10792 /* Not on tool-bar item. */
10793 clear_mouse_face (hlinfo
);
10797 /* On same tool-bar item as before. */
10798 goto set_help_echo
;
10800 clear_mouse_face (hlinfo
);
10802 /* Mouse is down, but on different tool-bar item? */
10803 mouse_down_p
= (dpyinfo
->grabbed
10804 && f
== last_mouse_frame
10805 && FRAME_LIVE_P (f
));
10807 && last_tool_bar_item
!= prop_idx
)
10810 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10811 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10813 /* If tool-bar item is not enabled, don't highlight it. */
10814 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10815 if (!NILP (enabled_p
))
10817 /* Compute the x-position of the glyph. In front and past the
10818 image is a space. We include this in the highlighted area. */
10819 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10820 for (i
= x
= 0; i
< hpos
; ++i
)
10821 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10823 /* Record this as the current active region. */
10824 hlinfo
->mouse_face_beg_col
= hpos
;
10825 hlinfo
->mouse_face_beg_row
= vpos
;
10826 hlinfo
->mouse_face_beg_x
= x
;
10827 hlinfo
->mouse_face_beg_y
= row
->y
;
10828 hlinfo
->mouse_face_past_end
= 0;
10830 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10831 hlinfo
->mouse_face_end_row
= vpos
;
10832 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10833 hlinfo
->mouse_face_end_y
= row
->y
;
10834 hlinfo
->mouse_face_window
= window
;
10835 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10837 /* Display it as active. */
10838 show_mouse_face (hlinfo
, draw
);
10839 hlinfo
->mouse_face_image_state
= draw
;
10844 /* Set help_echo_string to a help string to display for this tool-bar item.
10845 XTread_socket does the rest. */
10846 help_echo_object
= help_echo_window
= Qnil
;
10847 help_echo_pos
= -1;
10848 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10849 if (NILP (help_echo_string
))
10850 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10853 #endif /* HAVE_WINDOW_SYSTEM */
10857 /************************************************************************
10858 Horizontal scrolling
10859 ************************************************************************/
10861 static int hscroll_window_tree (Lisp_Object
);
10862 static int hscroll_windows (Lisp_Object
);
10864 /* For all leaf windows in the window tree rooted at WINDOW, set their
10865 hscroll value so that PT is (i) visible in the window, and (ii) so
10866 that it is not within a certain margin at the window's left and
10867 right border. Value is non-zero if any window's hscroll has been
10871 hscroll_window_tree (Lisp_Object window
)
10873 int hscrolled_p
= 0;
10874 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10875 int hscroll_step_abs
= 0;
10876 double hscroll_step_rel
= 0;
10878 if (hscroll_relative_p
)
10880 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10881 if (hscroll_step_rel
< 0)
10883 hscroll_relative_p
= 0;
10884 hscroll_step_abs
= 0;
10887 else if (INTEGERP (Vhscroll_step
))
10889 hscroll_step_abs
= XINT (Vhscroll_step
);
10890 if (hscroll_step_abs
< 0)
10891 hscroll_step_abs
= 0;
10894 hscroll_step_abs
= 0;
10896 while (WINDOWP (window
))
10898 struct window
*w
= XWINDOW (window
);
10900 if (WINDOWP (w
->hchild
))
10901 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10902 else if (WINDOWP (w
->vchild
))
10903 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10904 else if (w
->cursor
.vpos
>= 0)
10907 int text_area_width
;
10908 struct glyph_row
*current_cursor_row
10909 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10910 struct glyph_row
*desired_cursor_row
10911 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10912 struct glyph_row
*cursor_row
10913 = (desired_cursor_row
->enabled_p
10914 ? desired_cursor_row
10915 : current_cursor_row
);
10917 text_area_width
= window_box_width (w
, TEXT_AREA
);
10919 /* Scroll when cursor is inside this scroll margin. */
10920 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10922 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10923 && ((XFASTINT (w
->hscroll
)
10924 && w
->cursor
.x
<= h_margin
)
10925 || (cursor_row
->enabled_p
10926 && cursor_row
->truncated_on_right_p
10927 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10931 struct buffer
*saved_current_buffer
;
10935 /* Find point in a display of infinite width. */
10936 saved_current_buffer
= current_buffer
;
10937 current_buffer
= XBUFFER (w
->buffer
);
10939 if (w
== XWINDOW (selected_window
))
10943 pt
= marker_position (w
->pointm
);
10944 pt
= max (BEGV
, pt
);
10948 /* Move iterator to pt starting at cursor_row->start in
10949 a line with infinite width. */
10950 init_to_row_start (&it
, w
, cursor_row
);
10951 it
.last_visible_x
= INFINITY
;
10952 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10953 current_buffer
= saved_current_buffer
;
10955 /* Position cursor in window. */
10956 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10957 hscroll
= max (0, (it
.current_x
10958 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10959 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10960 : (text_area_width
/ 2))))
10961 / FRAME_COLUMN_WIDTH (it
.f
);
10962 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10964 if (hscroll_relative_p
)
10965 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10968 wanted_x
= text_area_width
10969 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10972 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10976 if (hscroll_relative_p
)
10977 wanted_x
= text_area_width
* hscroll_step_rel
10980 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10983 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10985 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10987 /* Don't call Fset_window_hscroll if value hasn't
10988 changed because it will prevent redisplay
10990 if (XFASTINT (w
->hscroll
) != hscroll
)
10992 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10993 w
->hscroll
= make_number (hscroll
);
11002 /* Value is non-zero if hscroll of any leaf window has been changed. */
11003 return hscrolled_p
;
11007 /* Set hscroll so that cursor is visible and not inside horizontal
11008 scroll margins for all windows in the tree rooted at WINDOW. See
11009 also hscroll_window_tree above. Value is non-zero if any window's
11010 hscroll has been changed. If it has, desired matrices on the frame
11011 of WINDOW are cleared. */
11014 hscroll_windows (Lisp_Object window
)
11016 int hscrolled_p
= hscroll_window_tree (window
);
11018 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11019 return hscrolled_p
;
11024 /************************************************************************
11026 ************************************************************************/
11028 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11029 to a non-zero value. This is sometimes handy to have in a debugger
11034 /* First and last unchanged row for try_window_id. */
11036 int debug_first_unchanged_at_end_vpos
;
11037 int debug_last_unchanged_at_beg_vpos
;
11039 /* Delta vpos and y. */
11041 int debug_dvpos
, debug_dy
;
11043 /* Delta in characters and bytes for try_window_id. */
11045 EMACS_INT debug_delta
, debug_delta_bytes
;
11047 /* Values of window_end_pos and window_end_vpos at the end of
11050 EMACS_INT debug_end_vpos
;
11052 /* Append a string to W->desired_matrix->method. FMT is a printf
11053 format string. A1...A9 are a supplement for a variable-length
11054 argument list. If trace_redisplay_p is non-zero also printf the
11055 resulting string to stderr. */
11058 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11061 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11064 char *method
= w
->desired_matrix
->method
;
11065 int len
= strlen (method
);
11066 int size
= sizeof w
->desired_matrix
->method
;
11067 int remaining
= size
- len
- 1;
11069 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11070 if (len
&& remaining
)
11073 --remaining
, ++len
;
11076 strncpy (method
+ len
, buffer
, remaining
);
11078 if (trace_redisplay_p
)
11079 fprintf (stderr
, "%p (%s): %s\n",
11081 ((BUFFERP (w
->buffer
)
11082 && STRINGP (XBUFFER (w
->buffer
)->name
))
11083 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11088 #endif /* GLYPH_DEBUG */
11091 /* Value is non-zero if all changes in window W, which displays
11092 current_buffer, are in the text between START and END. START is a
11093 buffer position, END is given as a distance from Z. Used in
11094 redisplay_internal for display optimization. */
11097 text_outside_line_unchanged_p (struct window
*w
,
11098 EMACS_INT start
, EMACS_INT end
)
11100 int unchanged_p
= 1;
11102 /* If text or overlays have changed, see where. */
11103 if (XFASTINT (w
->last_modified
) < MODIFF
11104 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11106 /* Gap in the line? */
11107 if (GPT
< start
|| Z
- GPT
< end
)
11110 /* Changes start in front of the line, or end after it? */
11112 && (BEG_UNCHANGED
< start
- 1
11113 || END_UNCHANGED
< end
))
11116 /* If selective display, can't optimize if changes start at the
11117 beginning of the line. */
11119 && INTEGERP (BVAR (current_buffer
, selective_display
))
11120 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11121 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11124 /* If there are overlays at the start or end of the line, these
11125 may have overlay strings with newlines in them. A change at
11126 START, for instance, may actually concern the display of such
11127 overlay strings as well, and they are displayed on different
11128 lines. So, quickly rule out this case. (For the future, it
11129 might be desirable to implement something more telling than
11130 just BEG/END_UNCHANGED.) */
11133 if (BEG
+ BEG_UNCHANGED
== start
11134 && overlay_touches_p (start
))
11136 if (END_UNCHANGED
== end
11137 && overlay_touches_p (Z
- end
))
11141 /* Under bidi reordering, adding or deleting a character in the
11142 beginning of a paragraph, before the first strong directional
11143 character, can change the base direction of the paragraph (unless
11144 the buffer specifies a fixed paragraph direction), which will
11145 require to redisplay the whole paragraph. It might be worthwhile
11146 to find the paragraph limits and widen the range of redisplayed
11147 lines to that, but for now just give up this optimization. */
11148 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11149 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11153 return unchanged_p
;
11157 /* Do a frame update, taking possible shortcuts into account. This is
11158 the main external entry point for redisplay.
11160 If the last redisplay displayed an echo area message and that message
11161 is no longer requested, we clear the echo area or bring back the
11162 mini-buffer if that is in use. */
11167 redisplay_internal ();
11172 overlay_arrow_string_or_property (Lisp_Object var
)
11176 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11179 return Voverlay_arrow_string
;
11182 /* Return 1 if there are any overlay-arrows in current_buffer. */
11184 overlay_arrow_in_current_buffer_p (void)
11188 for (vlist
= Voverlay_arrow_variable_list
;
11190 vlist
= XCDR (vlist
))
11192 Lisp_Object var
= XCAR (vlist
);
11195 if (!SYMBOLP (var
))
11197 val
= find_symbol_value (var
);
11199 && current_buffer
== XMARKER (val
)->buffer
)
11206 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11210 overlay_arrows_changed_p (void)
11214 for (vlist
= Voverlay_arrow_variable_list
;
11216 vlist
= XCDR (vlist
))
11218 Lisp_Object var
= XCAR (vlist
);
11219 Lisp_Object val
, pstr
;
11221 if (!SYMBOLP (var
))
11223 val
= find_symbol_value (var
);
11224 if (!MARKERP (val
))
11226 if (! EQ (COERCE_MARKER (val
),
11227 Fget (var
, Qlast_arrow_position
))
11228 || ! (pstr
= overlay_arrow_string_or_property (var
),
11229 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11235 /* Mark overlay arrows to be updated on next redisplay. */
11238 update_overlay_arrows (int up_to_date
)
11242 for (vlist
= Voverlay_arrow_variable_list
;
11244 vlist
= XCDR (vlist
))
11246 Lisp_Object var
= XCAR (vlist
);
11248 if (!SYMBOLP (var
))
11251 if (up_to_date
> 0)
11253 Lisp_Object val
= find_symbol_value (var
);
11254 Fput (var
, Qlast_arrow_position
,
11255 COERCE_MARKER (val
));
11256 Fput (var
, Qlast_arrow_string
,
11257 overlay_arrow_string_or_property (var
));
11259 else if (up_to_date
< 0
11260 || !NILP (Fget (var
, Qlast_arrow_position
)))
11262 Fput (var
, Qlast_arrow_position
, Qt
);
11263 Fput (var
, Qlast_arrow_string
, Qt
);
11269 /* Return overlay arrow string to display at row.
11270 Return integer (bitmap number) for arrow bitmap in left fringe.
11271 Return nil if no overlay arrow. */
11274 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11278 for (vlist
= Voverlay_arrow_variable_list
;
11280 vlist
= XCDR (vlist
))
11282 Lisp_Object var
= XCAR (vlist
);
11285 if (!SYMBOLP (var
))
11288 val
= find_symbol_value (var
);
11291 && current_buffer
== XMARKER (val
)->buffer
11292 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11294 if (FRAME_WINDOW_P (it
->f
)
11295 /* FIXME: if ROW->reversed_p is set, this should test
11296 the right fringe, not the left one. */
11297 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11299 #ifdef HAVE_WINDOW_SYSTEM
11300 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11303 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11304 return make_number (fringe_bitmap
);
11307 return make_number (-1); /* Use default arrow bitmap */
11309 return overlay_arrow_string_or_property (var
);
11316 /* Return 1 if point moved out of or into a composition. Otherwise
11317 return 0. PREV_BUF and PREV_PT are the last point buffer and
11318 position. BUF and PT are the current point buffer and position. */
11321 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11322 struct buffer
*buf
, EMACS_INT pt
)
11324 EMACS_INT start
, end
;
11326 Lisp_Object buffer
;
11328 XSETBUFFER (buffer
, buf
);
11329 /* Check a composition at the last point if point moved within the
11331 if (prev_buf
== buf
)
11334 /* Point didn't move. */
11337 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11338 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11339 && COMPOSITION_VALID_P (start
, end
, prop
)
11340 && start
< prev_pt
&& end
> prev_pt
)
11341 /* The last point was within the composition. Return 1 iff
11342 point moved out of the composition. */
11343 return (pt
<= start
|| pt
>= end
);
11346 /* Check a composition at the current point. */
11347 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11348 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11349 && COMPOSITION_VALID_P (start
, end
, prop
)
11350 && start
< pt
&& end
> pt
);
11354 /* Reconsider the setting of B->clip_changed which is displayed
11358 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11360 if (b
->clip_changed
11361 && !NILP (w
->window_end_valid
)
11362 && w
->current_matrix
->buffer
== b
11363 && w
->current_matrix
->zv
== BUF_ZV (b
)
11364 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11365 b
->clip_changed
= 0;
11367 /* If display wasn't paused, and W is not a tool bar window, see if
11368 point has been moved into or out of a composition. In that case,
11369 we set b->clip_changed to 1 to force updating the screen. If
11370 b->clip_changed has already been set to 1, we can skip this
11372 if (!b
->clip_changed
11373 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11377 if (w
== XWINDOW (selected_window
))
11380 pt
= marker_position (w
->pointm
);
11382 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11383 || pt
!= XINT (w
->last_point
))
11384 && check_point_in_composition (w
->current_matrix
->buffer
,
11385 XINT (w
->last_point
),
11386 XBUFFER (w
->buffer
), pt
))
11387 b
->clip_changed
= 1;
11392 /* Select FRAME to forward the values of frame-local variables into C
11393 variables so that the redisplay routines can access those values
11397 select_frame_for_redisplay (Lisp_Object frame
)
11399 Lisp_Object tail
, tem
;
11400 Lisp_Object old
= selected_frame
;
11401 struct Lisp_Symbol
*sym
;
11403 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11405 selected_frame
= frame
;
11408 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11409 if (CONSP (XCAR (tail
))
11410 && (tem
= XCAR (XCAR (tail
)),
11412 && (sym
= indirect_variable (XSYMBOL (tem
)),
11413 sym
->redirect
== SYMBOL_LOCALIZED
)
11414 && sym
->val
.blv
->frame_local
)
11415 /* Use find_symbol_value rather than Fsymbol_value
11416 to avoid an error if it is void. */
11417 find_symbol_value (tem
);
11418 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11422 #define STOP_POLLING \
11423 do { if (! polling_stopped_here) stop_polling (); \
11424 polling_stopped_here = 1; } while (0)
11426 #define RESUME_POLLING \
11427 do { if (polling_stopped_here) start_polling (); \
11428 polling_stopped_here = 0; } while (0)
11431 /* Perhaps in the future avoid recentering windows if it
11432 is not necessary; currently that causes some problems. */
11435 redisplay_internal (void)
11437 struct window
*w
= XWINDOW (selected_window
);
11441 int must_finish
= 0;
11442 struct text_pos tlbufpos
, tlendpos
;
11443 int number_of_visible_frames
;
11446 int polling_stopped_here
= 0;
11447 Lisp_Object old_frame
= selected_frame
;
11449 /* Non-zero means redisplay has to consider all windows on all
11450 frames. Zero means, only selected_window is considered. */
11451 int consider_all_windows_p
;
11453 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11455 /* No redisplay if running in batch mode or frame is not yet fully
11456 initialized, or redisplay is explicitly turned off by setting
11457 Vinhibit_redisplay. */
11458 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11459 || !NILP (Vinhibit_redisplay
))
11462 /* Don't examine these until after testing Vinhibit_redisplay.
11463 When Emacs is shutting down, perhaps because its connection to
11464 X has dropped, we should not look at them at all. */
11465 fr
= XFRAME (w
->frame
);
11466 sf
= SELECTED_FRAME ();
11468 if (!fr
->glyphs_initialized_p
)
11471 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11472 if (popup_activated ())
11476 /* I don't think this happens but let's be paranoid. */
11477 if (redisplaying_p
)
11480 /* Record a function that resets redisplaying_p to its old value
11481 when we leave this function. */
11482 count
= SPECPDL_INDEX ();
11483 record_unwind_protect (unwind_redisplay
,
11484 Fcons (make_number (redisplaying_p
), selected_frame
));
11486 specbind (Qinhibit_free_realized_faces
, Qnil
);
11489 Lisp_Object tail
, frame
;
11491 FOR_EACH_FRAME (tail
, frame
)
11493 struct frame
*f
= XFRAME (frame
);
11494 f
->already_hscrolled_p
= 0;
11499 /* Remember the currently selected window. */
11502 if (!EQ (old_frame
, selected_frame
)
11503 && FRAME_LIVE_P (XFRAME (old_frame
)))
11504 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11505 selected_frame and selected_window to be temporarily out-of-sync so
11506 when we come back here via `goto retry', we need to resync because we
11507 may need to run Elisp code (via prepare_menu_bars). */
11508 select_frame_for_redisplay (old_frame
);
11511 reconsider_clip_changes (w
, current_buffer
);
11512 last_escape_glyph_frame
= NULL
;
11513 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11514 last_glyphless_glyph_frame
= NULL
;
11515 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11517 /* If new fonts have been loaded that make a glyph matrix adjustment
11518 necessary, do it. */
11519 if (fonts_changed_p
)
11521 adjust_glyphs (NULL
);
11522 ++windows_or_buffers_changed
;
11523 fonts_changed_p
= 0;
11526 /* If face_change_count is non-zero, init_iterator will free all
11527 realized faces, which includes the faces referenced from current
11528 matrices. So, we can't reuse current matrices in this case. */
11529 if (face_change_count
)
11530 ++windows_or_buffers_changed
;
11532 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11533 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11535 /* Since frames on a single ASCII terminal share the same
11536 display area, displaying a different frame means redisplay
11537 the whole thing. */
11538 windows_or_buffers_changed
++;
11539 SET_FRAME_GARBAGED (sf
);
11541 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11543 FRAME_TTY (sf
)->previous_frame
= sf
;
11546 /* Set the visible flags for all frames. Do this before checking
11547 for resized or garbaged frames; they want to know if their frames
11548 are visible. See the comment in frame.h for
11549 FRAME_SAMPLE_VISIBILITY. */
11551 Lisp_Object tail
, frame
;
11553 number_of_visible_frames
= 0;
11555 FOR_EACH_FRAME (tail
, frame
)
11557 struct frame
*f
= XFRAME (frame
);
11559 FRAME_SAMPLE_VISIBILITY (f
);
11560 if (FRAME_VISIBLE_P (f
))
11561 ++number_of_visible_frames
;
11562 clear_desired_matrices (f
);
11566 /* Notice any pending interrupt request to change frame size. */
11567 do_pending_window_change (1);
11569 /* do_pending_window_change could change the selected_window due to
11570 frame resizing which makes the selected window too small. */
11571 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11574 reconsider_clip_changes (w
, current_buffer
);
11577 /* Clear frames marked as garbaged. */
11578 if (frame_garbaged
)
11579 clear_garbaged_frames ();
11581 /* Build menubar and tool-bar items. */
11582 if (NILP (Vmemory_full
))
11583 prepare_menu_bars ();
11585 if (windows_or_buffers_changed
)
11586 update_mode_lines
++;
11588 /* Detect case that we need to write or remove a star in the mode line. */
11589 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11591 w
->update_mode_line
= Qt
;
11592 if (buffer_shared
> 1)
11593 update_mode_lines
++;
11596 /* Avoid invocation of point motion hooks by `current_column' below. */
11597 count1
= SPECPDL_INDEX ();
11598 specbind (Qinhibit_point_motion_hooks
, Qt
);
11600 /* If %c is in the mode line, update it if needed. */
11601 if (!NILP (w
->column_number_displayed
)
11602 /* This alternative quickly identifies a common case
11603 where no change is needed. */
11604 && !(PT
== XFASTINT (w
->last_point
)
11605 && XFASTINT (w
->last_modified
) >= MODIFF
11606 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11607 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11608 w
->update_mode_line
= Qt
;
11610 unbind_to (count1
, Qnil
);
11612 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11614 /* The variable buffer_shared is set in redisplay_window and
11615 indicates that we redisplay a buffer in different windows. See
11617 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11618 || cursor_type_changed
);
11620 /* If specs for an arrow have changed, do thorough redisplay
11621 to ensure we remove any arrow that should no longer exist. */
11622 if (overlay_arrows_changed_p ())
11623 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11625 /* Normally the message* functions will have already displayed and
11626 updated the echo area, but the frame may have been trashed, or
11627 the update may have been preempted, so display the echo area
11628 again here. Checking message_cleared_p captures the case that
11629 the echo area should be cleared. */
11630 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11631 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11632 || (message_cleared_p
11633 && minibuf_level
== 0
11634 /* If the mini-window is currently selected, this means the
11635 echo-area doesn't show through. */
11636 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11638 int window_height_changed_p
= echo_area_display (0);
11641 /* If we don't display the current message, don't clear the
11642 message_cleared_p flag, because, if we did, we wouldn't clear
11643 the echo area in the next redisplay which doesn't preserve
11645 if (!display_last_displayed_message_p
)
11646 message_cleared_p
= 0;
11648 if (fonts_changed_p
)
11650 else if (window_height_changed_p
)
11652 consider_all_windows_p
= 1;
11653 ++update_mode_lines
;
11654 ++windows_or_buffers_changed
;
11656 /* If window configuration was changed, frames may have been
11657 marked garbaged. Clear them or we will experience
11658 surprises wrt scrolling. */
11659 if (frame_garbaged
)
11660 clear_garbaged_frames ();
11663 else if (EQ (selected_window
, minibuf_window
)
11664 && (current_buffer
->clip_changed
11665 || XFASTINT (w
->last_modified
) < MODIFF
11666 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11667 && resize_mini_window (w
, 0))
11669 /* Resized active mini-window to fit the size of what it is
11670 showing if its contents might have changed. */
11672 /* FIXME: this causes all frames to be updated, which seems unnecessary
11673 since only the current frame needs to be considered. This function needs
11674 to be rewritten with two variables, consider_all_windows and
11675 consider_all_frames. */
11676 consider_all_windows_p
= 1;
11677 ++windows_or_buffers_changed
;
11678 ++update_mode_lines
;
11680 /* If window configuration was changed, frames may have been
11681 marked garbaged. Clear them or we will experience
11682 surprises wrt scrolling. */
11683 if (frame_garbaged
)
11684 clear_garbaged_frames ();
11688 /* If showing the region, and mark has changed, we must redisplay
11689 the whole window. The assignment to this_line_start_pos prevents
11690 the optimization directly below this if-statement. */
11691 if (((!NILP (Vtransient_mark_mode
)
11692 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11693 != !NILP (w
->region_showing
))
11694 || (!NILP (w
->region_showing
)
11695 && !EQ (w
->region_showing
,
11696 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11697 CHARPOS (this_line_start_pos
) = 0;
11699 /* Optimize the case that only the line containing the cursor in the
11700 selected window has changed. Variables starting with this_ are
11701 set in display_line and record information about the line
11702 containing the cursor. */
11703 tlbufpos
= this_line_start_pos
;
11704 tlendpos
= this_line_end_pos
;
11705 if (!consider_all_windows_p
11706 && CHARPOS (tlbufpos
) > 0
11707 && NILP (w
->update_mode_line
)
11708 && !current_buffer
->clip_changed
11709 && !current_buffer
->prevent_redisplay_optimizations_p
11710 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11711 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11712 /* Make sure recorded data applies to current buffer, etc. */
11713 && this_line_buffer
== current_buffer
11714 && current_buffer
== XBUFFER (w
->buffer
)
11715 && NILP (w
->force_start
)
11716 && NILP (w
->optional_new_start
)
11717 /* Point must be on the line that we have info recorded about. */
11718 && PT
>= CHARPOS (tlbufpos
)
11719 && PT
<= Z
- CHARPOS (tlendpos
)
11720 /* All text outside that line, including its final newline,
11721 must be unchanged. */
11722 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11723 CHARPOS (tlendpos
)))
11725 if (CHARPOS (tlbufpos
) > BEGV
11726 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11727 && (CHARPOS (tlbufpos
) == ZV
11728 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11729 /* Former continuation line has disappeared by becoming empty. */
11731 else if (XFASTINT (w
->last_modified
) < MODIFF
11732 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11733 || MINI_WINDOW_P (w
))
11735 /* We have to handle the case of continuation around a
11736 wide-column character (see the comment in indent.c around
11739 For instance, in the following case:
11741 -------- Insert --------
11742 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11743 J_I_ ==> J_I_ `^^' are cursors.
11747 As we have to redraw the line above, we cannot use this
11751 int line_height_before
= this_line_pixel_height
;
11753 /* Note that start_display will handle the case that the
11754 line starting at tlbufpos is a continuation line. */
11755 start_display (&it
, w
, tlbufpos
);
11757 /* Implementation note: It this still necessary? */
11758 if (it
.current_x
!= this_line_start_x
)
11761 TRACE ((stderr
, "trying display optimization 1\n"));
11762 w
->cursor
.vpos
= -1;
11763 overlay_arrow_seen
= 0;
11764 it
.vpos
= this_line_vpos
;
11765 it
.current_y
= this_line_y
;
11766 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11767 display_line (&it
);
11769 /* If line contains point, is not continued,
11770 and ends at same distance from eob as before, we win. */
11771 if (w
->cursor
.vpos
>= 0
11772 /* Line is not continued, otherwise this_line_start_pos
11773 would have been set to 0 in display_line. */
11774 && CHARPOS (this_line_start_pos
)
11775 /* Line ends as before. */
11776 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11777 /* Line has same height as before. Otherwise other lines
11778 would have to be shifted up or down. */
11779 && this_line_pixel_height
== line_height_before
)
11781 /* If this is not the window's last line, we must adjust
11782 the charstarts of the lines below. */
11783 if (it
.current_y
< it
.last_visible_y
)
11785 struct glyph_row
*row
11786 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11787 EMACS_INT delta
, delta_bytes
;
11789 /* We used to distinguish between two cases here,
11790 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11791 when the line ends in a newline or the end of the
11792 buffer's accessible portion. But both cases did
11793 the same, so they were collapsed. */
11795 - CHARPOS (tlendpos
)
11796 - MATRIX_ROW_START_CHARPOS (row
));
11797 delta_bytes
= (Z_BYTE
11798 - BYTEPOS (tlendpos
)
11799 - MATRIX_ROW_START_BYTEPOS (row
));
11801 increment_matrix_positions (w
->current_matrix
,
11802 this_line_vpos
+ 1,
11803 w
->current_matrix
->nrows
,
11804 delta
, delta_bytes
);
11807 /* If this row displays text now but previously didn't,
11808 or vice versa, w->window_end_vpos may have to be
11810 if ((it
.glyph_row
- 1)->displays_text_p
)
11812 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11813 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11815 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11816 && this_line_vpos
> 0)
11817 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11818 w
->window_end_valid
= Qnil
;
11820 /* Update hint: No need to try to scroll in update_window. */
11821 w
->desired_matrix
->no_scrolling_p
= 1;
11824 *w
->desired_matrix
->method
= 0;
11825 debug_method_add (w
, "optimization 1");
11827 #ifdef HAVE_WINDOW_SYSTEM
11828 update_window_fringes (w
, 0);
11835 else if (/* Cursor position hasn't changed. */
11836 PT
== XFASTINT (w
->last_point
)
11837 /* Make sure the cursor was last displayed
11838 in this window. Otherwise we have to reposition it. */
11839 && 0 <= w
->cursor
.vpos
11840 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11844 do_pending_window_change (1);
11845 /* If selected_window changed, redisplay again. */
11846 if (WINDOWP (selected_window
)
11847 && (w
= XWINDOW (selected_window
)) != sw
)
11850 /* We used to always goto end_of_redisplay here, but this
11851 isn't enough if we have a blinking cursor. */
11852 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11853 goto end_of_redisplay
;
11857 /* If highlighting the region, or if the cursor is in the echo area,
11858 then we can't just move the cursor. */
11859 else if (! (!NILP (Vtransient_mark_mode
)
11860 && !NILP (BVAR (current_buffer
, mark_active
)))
11861 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11862 || highlight_nonselected_windows
)
11863 && NILP (w
->region_showing
)
11864 && NILP (Vshow_trailing_whitespace
)
11865 && !cursor_in_echo_area
)
11868 struct glyph_row
*row
;
11870 /* Skip from tlbufpos to PT and see where it is. Note that
11871 PT may be in invisible text. If so, we will end at the
11872 next visible position. */
11873 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11874 NULL
, DEFAULT_FACE_ID
);
11875 it
.current_x
= this_line_start_x
;
11876 it
.current_y
= this_line_y
;
11877 it
.vpos
= this_line_vpos
;
11879 /* The call to move_it_to stops in front of PT, but
11880 moves over before-strings. */
11881 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11883 if (it
.vpos
== this_line_vpos
11884 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11887 xassert (this_line_vpos
== it
.vpos
);
11888 xassert (this_line_y
== it
.current_y
);
11889 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11891 *w
->desired_matrix
->method
= 0;
11892 debug_method_add (w
, "optimization 3");
11901 /* Text changed drastically or point moved off of line. */
11902 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11905 CHARPOS (this_line_start_pos
) = 0;
11906 consider_all_windows_p
|= buffer_shared
> 1;
11907 ++clear_face_cache_count
;
11908 #ifdef HAVE_WINDOW_SYSTEM
11909 ++clear_image_cache_count
;
11912 /* Build desired matrices, and update the display. If
11913 consider_all_windows_p is non-zero, do it for all windows on all
11914 frames. Otherwise do it for selected_window, only. */
11916 if (consider_all_windows_p
)
11918 Lisp_Object tail
, frame
;
11920 FOR_EACH_FRAME (tail
, frame
)
11921 XFRAME (frame
)->updated_p
= 0;
11923 /* Recompute # windows showing selected buffer. This will be
11924 incremented each time such a window is displayed. */
11927 FOR_EACH_FRAME (tail
, frame
)
11929 struct frame
*f
= XFRAME (frame
);
11931 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11933 if (! EQ (frame
, selected_frame
))
11934 /* Select the frame, for the sake of frame-local
11936 select_frame_for_redisplay (frame
);
11938 /* Mark all the scroll bars to be removed; we'll redeem
11939 the ones we want when we redisplay their windows. */
11940 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11941 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11943 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11944 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11946 /* The X error handler may have deleted that frame. */
11947 if (!FRAME_LIVE_P (f
))
11950 /* Any scroll bars which redisplay_windows should have
11951 nuked should now go away. */
11952 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11953 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11955 /* If fonts changed, display again. */
11956 /* ??? rms: I suspect it is a mistake to jump all the way
11957 back to retry here. It should just retry this frame. */
11958 if (fonts_changed_p
)
11961 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11963 /* See if we have to hscroll. */
11964 if (!f
->already_hscrolled_p
)
11966 f
->already_hscrolled_p
= 1;
11967 if (hscroll_windows (f
->root_window
))
11971 /* Prevent various kinds of signals during display
11972 update. stdio is not robust about handling
11973 signals, which can cause an apparent I/O
11975 if (interrupt_input
)
11976 unrequest_sigio ();
11979 /* Update the display. */
11980 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11981 pending
|= update_frame (f
, 0, 0);
11987 if (!EQ (old_frame
, selected_frame
)
11988 && FRAME_LIVE_P (XFRAME (old_frame
)))
11989 /* We played a bit fast-and-loose above and allowed selected_frame
11990 and selected_window to be temporarily out-of-sync but let's make
11991 sure this stays contained. */
11992 select_frame_for_redisplay (old_frame
);
11993 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11997 /* Do the mark_window_display_accurate after all windows have
11998 been redisplayed because this call resets flags in buffers
11999 which are needed for proper redisplay. */
12000 FOR_EACH_FRAME (tail
, frame
)
12002 struct frame
*f
= XFRAME (frame
);
12005 mark_window_display_accurate (f
->root_window
, 1);
12006 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12007 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12012 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12014 Lisp_Object mini_window
;
12015 struct frame
*mini_frame
;
12017 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12018 /* Use list_of_error, not Qerror, so that
12019 we catch only errors and don't run the debugger. */
12020 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12022 redisplay_window_error
);
12024 /* Compare desired and current matrices, perform output. */
12027 /* If fonts changed, display again. */
12028 if (fonts_changed_p
)
12031 /* Prevent various kinds of signals during display update.
12032 stdio is not robust about handling signals,
12033 which can cause an apparent I/O error. */
12034 if (interrupt_input
)
12035 unrequest_sigio ();
12038 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12040 if (hscroll_windows (selected_window
))
12043 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12044 pending
= update_frame (sf
, 0, 0);
12047 /* We may have called echo_area_display at the top of this
12048 function. If the echo area is on another frame, that may
12049 have put text on a frame other than the selected one, so the
12050 above call to update_frame would not have caught it. Catch
12052 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12053 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12055 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12057 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12058 pending
|= update_frame (mini_frame
, 0, 0);
12059 if (!pending
&& hscroll_windows (mini_window
))
12064 /* If display was paused because of pending input, make sure we do a
12065 thorough update the next time. */
12068 /* Prevent the optimization at the beginning of
12069 redisplay_internal that tries a single-line update of the
12070 line containing the cursor in the selected window. */
12071 CHARPOS (this_line_start_pos
) = 0;
12073 /* Let the overlay arrow be updated the next time. */
12074 update_overlay_arrows (0);
12076 /* If we pause after scrolling, some rows in the current
12077 matrices of some windows are not valid. */
12078 if (!WINDOW_FULL_WIDTH_P (w
)
12079 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12080 update_mode_lines
= 1;
12084 if (!consider_all_windows_p
)
12086 /* This has already been done above if
12087 consider_all_windows_p is set. */
12088 mark_window_display_accurate_1 (w
, 1);
12090 /* Say overlay arrows are up to date. */
12091 update_overlay_arrows (1);
12093 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12094 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12097 update_mode_lines
= 0;
12098 windows_or_buffers_changed
= 0;
12099 cursor_type_changed
= 0;
12102 /* Start SIGIO interrupts coming again. Having them off during the
12103 code above makes it less likely one will discard output, but not
12104 impossible, since there might be stuff in the system buffer here.
12105 But it is much hairier to try to do anything about that. */
12106 if (interrupt_input
)
12110 /* If a frame has become visible which was not before, redisplay
12111 again, so that we display it. Expose events for such a frame
12112 (which it gets when becoming visible) don't call the parts of
12113 redisplay constructing glyphs, so simply exposing a frame won't
12114 display anything in this case. So, we have to display these
12115 frames here explicitly. */
12118 Lisp_Object tail
, frame
;
12121 FOR_EACH_FRAME (tail
, frame
)
12123 int this_is_visible
= 0;
12125 if (XFRAME (frame
)->visible
)
12126 this_is_visible
= 1;
12127 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12128 if (XFRAME (frame
)->visible
)
12129 this_is_visible
= 1;
12131 if (this_is_visible
)
12135 if (new_count
!= number_of_visible_frames
)
12136 windows_or_buffers_changed
++;
12139 /* Change frame size now if a change is pending. */
12140 do_pending_window_change (1);
12142 /* If we just did a pending size change, or have additional
12143 visible frames, or selected_window changed, redisplay again. */
12144 if ((windows_or_buffers_changed
&& !pending
)
12145 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12148 /* Clear the face and image caches.
12150 We used to do this only if consider_all_windows_p. But the cache
12151 needs to be cleared if a timer creates images in the current
12152 buffer (e.g. the test case in Bug#6230). */
12154 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12156 clear_face_cache (0);
12157 clear_face_cache_count
= 0;
12160 #ifdef HAVE_WINDOW_SYSTEM
12161 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12163 clear_image_caches (Qnil
);
12164 clear_image_cache_count
= 0;
12166 #endif /* HAVE_WINDOW_SYSTEM */
12169 unbind_to (count
, Qnil
);
12174 /* Redisplay, but leave alone any recent echo area message unless
12175 another message has been requested in its place.
12177 This is useful in situations where you need to redisplay but no
12178 user action has occurred, making it inappropriate for the message
12179 area to be cleared. See tracking_off and
12180 wait_reading_process_output for examples of these situations.
12182 FROM_WHERE is an integer saying from where this function was
12183 called. This is useful for debugging. */
12186 redisplay_preserve_echo_area (int from_where
)
12188 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12190 if (!NILP (echo_area_buffer
[1]))
12192 /* We have a previously displayed message, but no current
12193 message. Redisplay the previous message. */
12194 display_last_displayed_message_p
= 1;
12195 redisplay_internal ();
12196 display_last_displayed_message_p
= 0;
12199 redisplay_internal ();
12201 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12202 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12203 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12207 /* Function registered with record_unwind_protect in
12208 redisplay_internal. Reset redisplaying_p to the value it had
12209 before redisplay_internal was called, and clear
12210 prevent_freeing_realized_faces_p. It also selects the previously
12211 selected frame, unless it has been deleted (by an X connection
12212 failure during redisplay, for example). */
12215 unwind_redisplay (Lisp_Object val
)
12217 Lisp_Object old_redisplaying_p
, old_frame
;
12219 old_redisplaying_p
= XCAR (val
);
12220 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12221 old_frame
= XCDR (val
);
12222 if (! EQ (old_frame
, selected_frame
)
12223 && FRAME_LIVE_P (XFRAME (old_frame
)))
12224 select_frame_for_redisplay (old_frame
);
12229 /* Mark the display of window W as accurate or inaccurate. If
12230 ACCURATE_P is non-zero mark display of W as accurate. If
12231 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12232 redisplay_internal is called. */
12235 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12237 if (BUFFERP (w
->buffer
))
12239 struct buffer
*b
= XBUFFER (w
->buffer
);
12242 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12243 w
->last_overlay_modified
12244 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12246 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12250 b
->clip_changed
= 0;
12251 b
->prevent_redisplay_optimizations_p
= 0;
12253 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12254 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12255 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12256 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12258 w
->current_matrix
->buffer
= b
;
12259 w
->current_matrix
->begv
= BUF_BEGV (b
);
12260 w
->current_matrix
->zv
= BUF_ZV (b
);
12262 w
->last_cursor
= w
->cursor
;
12263 w
->last_cursor_off_p
= w
->cursor_off_p
;
12265 if (w
== XWINDOW (selected_window
))
12266 w
->last_point
= make_number (BUF_PT (b
));
12268 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12274 w
->window_end_valid
= w
->buffer
;
12275 w
->update_mode_line
= Qnil
;
12280 /* Mark the display of windows in the window tree rooted at WINDOW as
12281 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12282 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12283 be redisplayed the next time redisplay_internal is called. */
12286 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12290 for (; !NILP (window
); window
= w
->next
)
12292 w
= XWINDOW (window
);
12293 mark_window_display_accurate_1 (w
, accurate_p
);
12295 if (!NILP (w
->vchild
))
12296 mark_window_display_accurate (w
->vchild
, accurate_p
);
12297 if (!NILP (w
->hchild
))
12298 mark_window_display_accurate (w
->hchild
, accurate_p
);
12303 update_overlay_arrows (1);
12307 /* Force a thorough redisplay the next time by setting
12308 last_arrow_position and last_arrow_string to t, which is
12309 unequal to any useful value of Voverlay_arrow_... */
12310 update_overlay_arrows (-1);
12315 /* Return value in display table DP (Lisp_Char_Table *) for character
12316 C. Since a display table doesn't have any parent, we don't have to
12317 follow parent. Do not call this function directly but use the
12318 macro DISP_CHAR_VECTOR. */
12321 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12325 if (ASCII_CHAR_P (c
))
12328 if (SUB_CHAR_TABLE_P (val
))
12329 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12335 XSETCHAR_TABLE (table
, dp
);
12336 val
= char_table_ref (table
, c
);
12345 /***********************************************************************
12347 ***********************************************************************/
12349 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12352 redisplay_windows (Lisp_Object window
)
12354 while (!NILP (window
))
12356 struct window
*w
= XWINDOW (window
);
12358 if (!NILP (w
->hchild
))
12359 redisplay_windows (w
->hchild
);
12360 else if (!NILP (w
->vchild
))
12361 redisplay_windows (w
->vchild
);
12362 else if (!NILP (w
->buffer
))
12364 displayed_buffer
= XBUFFER (w
->buffer
);
12365 /* Use list_of_error, not Qerror, so that
12366 we catch only errors and don't run the debugger. */
12367 internal_condition_case_1 (redisplay_window_0
, window
,
12369 redisplay_window_error
);
12377 redisplay_window_error (Lisp_Object ignore
)
12379 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12384 redisplay_window_0 (Lisp_Object window
)
12386 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12387 redisplay_window (window
, 0);
12392 redisplay_window_1 (Lisp_Object window
)
12394 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12395 redisplay_window (window
, 1);
12400 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12401 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12402 which positions recorded in ROW differ from current buffer
12405 Return 0 if cursor is not on this row, 1 otherwise. */
12408 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12409 struct glyph_matrix
*matrix
,
12410 EMACS_INT delta
, EMACS_INT delta_bytes
,
12413 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12414 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12415 struct glyph
*cursor
= NULL
;
12416 /* The last known character position in row. */
12417 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12419 EMACS_INT pt_old
= PT
- delta
;
12420 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12421 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12422 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12423 /* A glyph beyond the edge of TEXT_AREA which we should never
12425 struct glyph
*glyphs_end
= end
;
12426 /* Non-zero means we've found a match for cursor position, but that
12427 glyph has the avoid_cursor_p flag set. */
12428 int match_with_avoid_cursor
= 0;
12429 /* Non-zero means we've seen at least one glyph that came from a
12431 int string_seen
= 0;
12432 /* Largest and smalles buffer positions seen so far during scan of
12434 EMACS_INT bpos_max
= pos_before
;
12435 EMACS_INT bpos_min
= pos_after
;
12436 /* Last buffer position covered by an overlay string with an integer
12437 `cursor' property. */
12438 EMACS_INT bpos_covered
= 0;
12440 /* Skip over glyphs not having an object at the start and the end of
12441 the row. These are special glyphs like truncation marks on
12442 terminal frames. */
12443 if (row
->displays_text_p
)
12445 if (!row
->reversed_p
)
12448 && INTEGERP (glyph
->object
)
12449 && glyph
->charpos
< 0)
12451 x
+= glyph
->pixel_width
;
12455 && INTEGERP ((end
- 1)->object
)
12456 /* CHARPOS is zero for blanks and stretch glyphs
12457 inserted by extend_face_to_end_of_line. */
12458 && (end
- 1)->charpos
<= 0)
12460 glyph_before
= glyph
- 1;
12467 /* If the glyph row is reversed, we need to process it from back
12468 to front, so swap the edge pointers. */
12469 glyphs_end
= end
= glyph
- 1;
12470 glyph
+= row
->used
[TEXT_AREA
] - 1;
12472 while (glyph
> end
+ 1
12473 && INTEGERP (glyph
->object
)
12474 && glyph
->charpos
< 0)
12477 x
-= glyph
->pixel_width
;
12479 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12481 /* By default, in reversed rows we put the cursor on the
12482 rightmost (first in the reading order) glyph. */
12483 for (g
= end
+ 1; g
< glyph
; g
++)
12484 x
+= g
->pixel_width
;
12486 && INTEGERP ((end
+ 1)->object
)
12487 && (end
+ 1)->charpos
<= 0)
12489 glyph_before
= glyph
+ 1;
12493 else if (row
->reversed_p
)
12495 /* In R2L rows that don't display text, put the cursor on the
12496 rightmost glyph. Case in point: an empty last line that is
12497 part of an R2L paragraph. */
12499 /* Avoid placing the cursor on the last glyph of the row, where
12500 on terminal frames we hold the vertical border between
12501 adjacent windows. */
12502 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12503 && !WINDOW_RIGHTMOST_P (w
)
12504 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12506 x
= -1; /* will be computed below, at label compute_x */
12509 /* Step 1: Try to find the glyph whose character position
12510 corresponds to point. If that's not possible, find 2 glyphs
12511 whose character positions are the closest to point, one before
12512 point, the other after it. */
12513 if (!row
->reversed_p
)
12514 while (/* not marched to end of glyph row */
12516 /* glyph was not inserted by redisplay for internal purposes */
12517 && !INTEGERP (glyph
->object
))
12519 if (BUFFERP (glyph
->object
))
12521 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12523 if (glyph
->charpos
> bpos_max
)
12524 bpos_max
= glyph
->charpos
;
12525 if (glyph
->charpos
< bpos_min
)
12526 bpos_min
= glyph
->charpos
;
12527 if (!glyph
->avoid_cursor_p
)
12529 /* If we hit point, we've found the glyph on which to
12530 display the cursor. */
12533 match_with_avoid_cursor
= 0;
12536 /* See if we've found a better approximation to
12537 POS_BEFORE or to POS_AFTER. Note that we want the
12538 first (leftmost) glyph of all those that are the
12539 closest from below, and the last (rightmost) of all
12540 those from above. */
12541 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12543 pos_before
= glyph
->charpos
;
12544 glyph_before
= glyph
;
12546 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12548 pos_after
= glyph
->charpos
;
12549 glyph_after
= glyph
;
12552 else if (dpos
== 0)
12553 match_with_avoid_cursor
= 1;
12555 else if (STRINGP (glyph
->object
))
12557 Lisp_Object chprop
;
12558 EMACS_INT glyph_pos
= glyph
->charpos
;
12560 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12562 if (INTEGERP (chprop
))
12564 bpos_covered
= bpos_max
+ XINT (chprop
);
12565 /* If the `cursor' property covers buffer positions up
12566 to and including point, we should display cursor on
12567 this glyph. Note that overlays and text properties
12568 with string values stop bidi reordering, so every
12569 buffer position to the left of the string is always
12570 smaller than any position to the right of the
12571 string. Therefore, if a `cursor' property on one
12572 of the string's characters has an integer value, we
12573 will break out of the loop below _before_ we get to
12574 the position match above. IOW, integer values of
12575 the `cursor' property override the "exact match for
12576 point" strategy of positioning the cursor. */
12577 /* Implementation note: bpos_max == pt_old when, e.g.,
12578 we are in an empty line, where bpos_max is set to
12579 MATRIX_ROW_START_CHARPOS, see above. */
12580 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12589 x
+= glyph
->pixel_width
;
12592 else if (glyph
> end
) /* row is reversed */
12593 while (!INTEGERP (glyph
->object
))
12595 if (BUFFERP (glyph
->object
))
12597 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12599 if (glyph
->charpos
> bpos_max
)
12600 bpos_max
= glyph
->charpos
;
12601 if (glyph
->charpos
< bpos_min
)
12602 bpos_min
= glyph
->charpos
;
12603 if (!glyph
->avoid_cursor_p
)
12607 match_with_avoid_cursor
= 0;
12610 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12612 pos_before
= glyph
->charpos
;
12613 glyph_before
= glyph
;
12615 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12617 pos_after
= glyph
->charpos
;
12618 glyph_after
= glyph
;
12621 else if (dpos
== 0)
12622 match_with_avoid_cursor
= 1;
12624 else if (STRINGP (glyph
->object
))
12626 Lisp_Object chprop
;
12627 EMACS_INT glyph_pos
= glyph
->charpos
;
12629 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12631 if (INTEGERP (chprop
))
12633 bpos_covered
= bpos_max
+ XINT (chprop
);
12634 /* If the `cursor' property covers buffer positions up
12635 to and including point, we should display cursor on
12637 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12646 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12648 x
--; /* can't use any pixel_width */
12651 x
-= glyph
->pixel_width
;
12654 /* Step 2: If we didn't find an exact match for point, we need to
12655 look for a proper place to put the cursor among glyphs between
12656 GLYPH_BEFORE and GLYPH_AFTER. */
12657 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12658 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12659 && bpos_covered
< pt_old
)
12661 /* An empty line has a single glyph whose OBJECT is zero and
12662 whose CHARPOS is the position of a newline on that line.
12663 Note that on a TTY, there are more glyphs after that, which
12664 were produced by extend_face_to_end_of_line, but their
12665 CHARPOS is zero or negative. */
12667 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12668 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12670 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12672 EMACS_INT ellipsis_pos
;
12674 /* Scan back over the ellipsis glyphs. */
12675 if (!row
->reversed_p
)
12677 ellipsis_pos
= (glyph
- 1)->charpos
;
12678 while (glyph
> row
->glyphs
[TEXT_AREA
]
12679 && (glyph
- 1)->charpos
== ellipsis_pos
)
12680 glyph
--, x
-= glyph
->pixel_width
;
12681 /* That loop always goes one position too far, including
12682 the glyph before the ellipsis. So scan forward over
12684 x
+= glyph
->pixel_width
;
12687 else /* row is reversed */
12689 ellipsis_pos
= (glyph
+ 1)->charpos
;
12690 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12691 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12692 glyph
++, x
+= glyph
->pixel_width
;
12693 x
-= glyph
->pixel_width
;
12697 else if (match_with_avoid_cursor
12698 /* A truncated row may not include PT among its
12699 character positions. Setting the cursor inside the
12700 scroll margin will trigger recalculation of hscroll
12701 in hscroll_window_tree. */
12702 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12703 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12704 /* Zero-width characters produce no glyphs. */
12707 && (row
->reversed_p
12708 ? glyph_after
> glyphs_end
12709 : glyph_after
< glyphs_end
)))
12711 cursor
= glyph_after
;
12714 else if (string_seen
)
12716 int incr
= row
->reversed_p
? -1 : +1;
12718 /* Need to find the glyph that came out of a string which is
12719 present at point. That glyph is somewhere between
12720 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12721 positioned between POS_BEFORE and POS_AFTER in the
12723 struct glyph
*stop
= glyph_after
;
12724 EMACS_INT pos
= pos_before
;
12727 for (glyph
= glyph_before
+ incr
;
12728 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12731 /* Any glyphs that come from the buffer are here because
12732 of bidi reordering. Skip them, and only pay
12733 attention to glyphs that came from some string. */
12734 if (STRINGP (glyph
->object
))
12739 str
= glyph
->object
;
12740 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12741 if (tem
== 0 /* from overlay */
12744 /* If the string from which this glyph came is
12745 found in the buffer at point, then we've
12746 found the glyph we've been looking for. If
12747 it comes from an overlay (tem == 0), and it
12748 has the `cursor' property on one of its
12749 glyphs, record that glyph as a candidate for
12750 displaying the cursor. (As in the
12751 unidirectional version, we will display the
12752 cursor on the last candidate we find.) */
12753 if (tem
== 0 || tem
== pt_old
)
12755 /* The glyphs from this string could have
12756 been reordered. Find the one with the
12757 smallest string position. Or there could
12758 be a character in the string with the
12759 `cursor' property, which means display
12760 cursor on that character's glyph. */
12761 EMACS_INT strpos
= glyph
->charpos
;
12766 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12767 && EQ (glyph
->object
, str
);
12771 EMACS_INT gpos
= glyph
->charpos
;
12773 cprop
= Fget_char_property (make_number (gpos
),
12781 if (tem
&& glyph
->charpos
< strpos
)
12783 strpos
= glyph
->charpos
;
12792 pos
= tem
+ 1; /* don't find previous instances */
12794 /* This string is not what we want; skip all of the
12795 glyphs that came from it. */
12796 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12797 && EQ (glyph
->object
, str
))
12804 /* If we reached the end of the line, and END was from a string,
12805 the cursor is not on this line. */
12807 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12808 && STRINGP (end
->object
)
12809 && row
->continued_p
)
12815 if (cursor
!= NULL
)
12821 /* Need to compute x that corresponds to GLYPH. */
12822 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12824 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12826 x
+= g
->pixel_width
;
12830 /* ROW could be part of a continued line, which, under bidi
12831 reordering, might have other rows whose start and end charpos
12832 occlude point. Only set w->cursor if we found a better
12833 approximation to the cursor position than we have from previously
12834 examined candidate rows belonging to the same continued line. */
12835 if (/* we already have a candidate row */
12836 w
->cursor
.vpos
>= 0
12837 /* that candidate is not the row we are processing */
12838 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12839 /* the row we are processing is part of a continued line */
12840 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12841 /* Make sure cursor.vpos specifies a row whose start and end
12842 charpos occlude point. This is because some callers of this
12843 function leave cursor.vpos at the row where the cursor was
12844 displayed during the last redisplay cycle. */
12845 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12846 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12849 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12851 /* Don't consider glyphs that are outside TEXT_AREA. */
12852 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12854 /* Keep the candidate whose buffer position is the closest to
12856 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12857 w
->cursor
.hpos
>= 0
12858 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12859 && BUFFERP (g1
->object
)
12860 && (g1
->charpos
== pt_old
/* an exact match always wins */
12861 || (BUFFERP (glyph
->object
)
12862 && eabs (g1
->charpos
- pt_old
)
12863 < eabs (glyph
->charpos
- pt_old
))))
12865 /* If this candidate gives an exact match, use that. */
12866 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12867 /* Otherwise, keep the candidate that comes from a row
12868 spanning less buffer positions. This may win when one or
12869 both candidate positions are on glyphs that came from
12870 display strings, for which we cannot compare buffer
12872 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12873 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12874 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12877 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12879 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12880 w
->cursor
.y
= row
->y
+ dy
;
12882 if (w
== XWINDOW (selected_window
))
12884 if (!row
->continued_p
12885 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12888 this_line_buffer
= XBUFFER (w
->buffer
);
12890 CHARPOS (this_line_start_pos
)
12891 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12892 BYTEPOS (this_line_start_pos
)
12893 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12895 CHARPOS (this_line_end_pos
)
12896 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12897 BYTEPOS (this_line_end_pos
)
12898 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12900 this_line_y
= w
->cursor
.y
;
12901 this_line_pixel_height
= row
->height
;
12902 this_line_vpos
= w
->cursor
.vpos
;
12903 this_line_start_x
= row
->x
;
12906 CHARPOS (this_line_start_pos
) = 0;
12913 /* Run window scroll functions, if any, for WINDOW with new window
12914 start STARTP. Sets the window start of WINDOW to that position.
12916 We assume that the window's buffer is really current. */
12918 static INLINE
struct text_pos
12919 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12921 struct window
*w
= XWINDOW (window
);
12922 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12924 if (current_buffer
!= XBUFFER (w
->buffer
))
12927 if (!NILP (Vwindow_scroll_functions
))
12929 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12930 make_number (CHARPOS (startp
)));
12931 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12932 /* In case the hook functions switch buffers. */
12933 if (current_buffer
!= XBUFFER (w
->buffer
))
12934 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12941 /* Make sure the line containing the cursor is fully visible.
12942 A value of 1 means there is nothing to be done.
12943 (Either the line is fully visible, or it cannot be made so,
12944 or we cannot tell.)
12946 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12947 is higher than window.
12949 A value of 0 means the caller should do scrolling
12950 as if point had gone off the screen. */
12953 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12955 struct glyph_matrix
*matrix
;
12956 struct glyph_row
*row
;
12959 if (!make_cursor_line_fully_visible_p
)
12962 /* It's not always possible to find the cursor, e.g, when a window
12963 is full of overlay strings. Don't do anything in that case. */
12964 if (w
->cursor
.vpos
< 0)
12967 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12968 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12970 /* If the cursor row is not partially visible, there's nothing to do. */
12971 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12974 /* If the row the cursor is in is taller than the window's height,
12975 it's not clear what to do, so do nothing. */
12976 window_height
= window_box_height (w
);
12977 if (row
->height
>= window_height
)
12979 if (!force_p
|| MINI_WINDOW_P (w
)
12980 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12987 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12988 non-zero means only WINDOW is redisplayed in redisplay_internal.
12989 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12990 in redisplay_window to bring a partially visible line into view in
12991 the case that only the cursor has moved.
12993 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12994 last screen line's vertical height extends past the end of the screen.
12998 1 if scrolling succeeded
13000 0 if scrolling didn't find point.
13002 -1 if new fonts have been loaded so that we must interrupt
13003 redisplay, adjust glyph matrices, and try again. */
13009 SCROLLING_NEED_LARGER_MATRICES
13012 /* If scroll-conservatively is more than this, never recenter.
13014 If you change this, don't forget to update the doc string of
13015 `scroll-conservatively' and the Emacs manual. */
13016 #define SCROLL_LIMIT 100
13019 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13020 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13021 int temp_scroll_step
, int last_line_misfit
)
13023 struct window
*w
= XWINDOW (window
);
13024 struct frame
*f
= XFRAME (w
->frame
);
13025 struct text_pos pos
, startp
;
13027 int this_scroll_margin
, scroll_max
, rc
, height
;
13028 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13029 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13030 Lisp_Object aggressive
;
13031 /* We will never try scrolling more than this number of lines. */
13032 int scroll_limit
= SCROLL_LIMIT
;
13035 debug_method_add (w
, "try_scrolling");
13038 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13040 /* Compute scroll margin height in pixels. We scroll when point is
13041 within this distance from the top or bottom of the window. */
13042 if (scroll_margin
> 0)
13043 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13044 * FRAME_LINE_HEIGHT (f
);
13046 this_scroll_margin
= 0;
13048 /* Force arg_scroll_conservatively to have a reasonable value, to
13049 avoid scrolling too far away with slow move_it_* functions. Note
13050 that the user can supply scroll-conservatively equal to
13051 `most-positive-fixnum', which can be larger than INT_MAX. */
13052 if (arg_scroll_conservatively
> scroll_limit
)
13054 arg_scroll_conservatively
= scroll_limit
+ 1;
13055 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13057 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13058 /* Compute how much we should try to scroll maximally to bring
13059 point into view. */
13060 scroll_max
= (max (scroll_step
,
13061 max (arg_scroll_conservatively
, temp_scroll_step
))
13062 * FRAME_LINE_HEIGHT (f
));
13063 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13064 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13065 /* We're trying to scroll because of aggressive scrolling but no
13066 scroll_step is set. Choose an arbitrary one. */
13067 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13073 /* Decide whether to scroll down. */
13074 if (PT
> CHARPOS (startp
))
13076 int scroll_margin_y
;
13078 /* Compute the pixel ypos of the scroll margin, then move it to
13079 either that ypos or PT, whichever comes first. */
13080 start_display (&it
, w
, startp
);
13081 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13082 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13083 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13084 (MOVE_TO_POS
| MOVE_TO_Y
));
13086 if (PT
> CHARPOS (it
.current
.pos
))
13088 int y0
= line_bottom_y (&it
);
13089 /* Compute how many pixels below window bottom to stop searching
13090 for PT. This avoids costly search for PT that is far away if
13091 the user limited scrolling by a small number of lines, but
13092 always finds PT if scroll_conservatively is set to a large
13093 number, such as most-positive-fixnum. */
13094 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13095 int y_to_move
= it
.last_visible_y
+ slack
;
13097 /* Compute the distance from the scroll margin to PT or to
13098 the scroll limit, whichever comes first. This should
13099 include the height of the cursor line, to make that line
13101 move_it_to (&it
, PT
, -1, y_to_move
,
13102 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13103 dy
= line_bottom_y (&it
) - y0
;
13105 if (dy
> scroll_max
)
13106 return SCROLLING_FAILED
;
13114 /* Point is in or below the bottom scroll margin, so move the
13115 window start down. If scrolling conservatively, move it just
13116 enough down to make point visible. If scroll_step is set,
13117 move it down by scroll_step. */
13118 if (arg_scroll_conservatively
)
13120 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13121 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13122 else if (scroll_step
|| temp_scroll_step
)
13123 amount_to_scroll
= scroll_max
;
13126 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13127 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13128 if (NUMBERP (aggressive
))
13130 double float_amount
= XFLOATINT (aggressive
) * height
;
13131 amount_to_scroll
= float_amount
;
13132 if (amount_to_scroll
== 0 && float_amount
> 0)
13133 amount_to_scroll
= 1;
13134 /* Don't let point enter the scroll margin near top of
13136 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13137 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13141 if (amount_to_scroll
<= 0)
13142 return SCROLLING_FAILED
;
13144 start_display (&it
, w
, startp
);
13145 if (arg_scroll_conservatively
<= scroll_limit
)
13146 move_it_vertically (&it
, amount_to_scroll
);
13149 /* Extra precision for users who set scroll-conservatively
13150 to a large number: make sure the amount we scroll
13151 the window start is never less than amount_to_scroll,
13152 which was computed as distance from window bottom to
13153 point. This matters when lines at window top and lines
13154 below window bottom have different height. */
13155 struct it it1
= it
;
13156 /* We use a temporary it1 because line_bottom_y can modify
13157 its argument, if it moves one line down; see there. */
13158 int start_y
= line_bottom_y (&it1
);
13161 move_it_by_lines (&it
, 1);
13163 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13166 /* If STARTP is unchanged, move it down another screen line. */
13167 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13168 move_it_by_lines (&it
, 1);
13169 startp
= it
.current
.pos
;
13173 struct text_pos scroll_margin_pos
= startp
;
13175 /* See if point is inside the scroll margin at the top of the
13177 if (this_scroll_margin
)
13179 start_display (&it
, w
, startp
);
13180 move_it_vertically (&it
, this_scroll_margin
);
13181 scroll_margin_pos
= it
.current
.pos
;
13184 if (PT
< CHARPOS (scroll_margin_pos
))
13186 /* Point is in the scroll margin at the top of the window or
13187 above what is displayed in the window. */
13190 /* Compute the vertical distance from PT to the scroll
13191 margin position. Move as far as scroll_max allows, or
13192 one screenful, or 10 screen lines, whichever is largest.
13193 Give up if distance is greater than scroll_max. */
13194 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13195 start_display (&it
, w
, pos
);
13197 y_to_move
= max (it
.last_visible_y
,
13198 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13199 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13201 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13202 dy
= it
.current_y
- y0
;
13203 if (dy
> scroll_max
)
13204 return SCROLLING_FAILED
;
13206 /* Compute new window start. */
13207 start_display (&it
, w
, startp
);
13209 if (arg_scroll_conservatively
)
13210 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13211 max (scroll_step
, temp_scroll_step
));
13212 else if (scroll_step
|| temp_scroll_step
)
13213 amount_to_scroll
= scroll_max
;
13216 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13217 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13218 if (NUMBERP (aggressive
))
13220 double float_amount
= XFLOATINT (aggressive
) * height
;
13221 amount_to_scroll
= float_amount
;
13222 if (amount_to_scroll
== 0 && float_amount
> 0)
13223 amount_to_scroll
= 1;
13224 amount_to_scroll
-=
13225 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13226 /* Don't let point enter the scroll margin near
13227 bottom of the window. */
13228 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13229 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13233 if (amount_to_scroll
<= 0)
13234 return SCROLLING_FAILED
;
13236 move_it_vertically_backward (&it
, amount_to_scroll
);
13237 startp
= it
.current
.pos
;
13241 /* Run window scroll functions. */
13242 startp
= run_window_scroll_functions (window
, startp
);
13244 /* Display the window. Give up if new fonts are loaded, or if point
13246 if (!try_window (window
, startp
, 0))
13247 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13248 else if (w
->cursor
.vpos
< 0)
13250 clear_glyph_matrix (w
->desired_matrix
);
13251 rc
= SCROLLING_FAILED
;
13255 /* Maybe forget recorded base line for line number display. */
13256 if (!just_this_one_p
13257 || current_buffer
->clip_changed
13258 || BEG_UNCHANGED
< CHARPOS (startp
))
13259 w
->base_line_number
= Qnil
;
13261 /* If cursor ends up on a partially visible line,
13262 treat that as being off the bottom of the screen. */
13263 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13264 /* It's possible that the cursor is on the first line of the
13265 buffer, which is partially obscured due to a vscroll
13266 (Bug#7537). In that case, avoid looping forever . */
13267 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13269 clear_glyph_matrix (w
->desired_matrix
);
13270 ++extra_scroll_margin_lines
;
13273 rc
= SCROLLING_SUCCESS
;
13280 /* Compute a suitable window start for window W if display of W starts
13281 on a continuation line. Value is non-zero if a new window start
13284 The new window start will be computed, based on W's width, starting
13285 from the start of the continued line. It is the start of the
13286 screen line with the minimum distance from the old start W->start. */
13289 compute_window_start_on_continuation_line (struct window
*w
)
13291 struct text_pos pos
, start_pos
;
13292 int window_start_changed_p
= 0;
13294 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13296 /* If window start is on a continuation line... Window start may be
13297 < BEGV in case there's invisible text at the start of the
13298 buffer (M-x rmail, for example). */
13299 if (CHARPOS (start_pos
) > BEGV
13300 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13303 struct glyph_row
*row
;
13305 /* Handle the case that the window start is out of range. */
13306 if (CHARPOS (start_pos
) < BEGV
)
13307 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13308 else if (CHARPOS (start_pos
) > ZV
)
13309 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13311 /* Find the start of the continued line. This should be fast
13312 because scan_buffer is fast (newline cache). */
13313 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13314 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13315 row
, DEFAULT_FACE_ID
);
13316 reseat_at_previous_visible_line_start (&it
);
13318 /* If the line start is "too far" away from the window start,
13319 say it takes too much time to compute a new window start. */
13320 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13321 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13323 int min_distance
, distance
;
13325 /* Move forward by display lines to find the new window
13326 start. If window width was enlarged, the new start can
13327 be expected to be > the old start. If window width was
13328 decreased, the new window start will be < the old start.
13329 So, we're looking for the display line start with the
13330 minimum distance from the old window start. */
13331 pos
= it
.current
.pos
;
13332 min_distance
= INFINITY
;
13333 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13334 distance
< min_distance
)
13336 min_distance
= distance
;
13337 pos
= it
.current
.pos
;
13338 move_it_by_lines (&it
, 1);
13341 /* Set the window start there. */
13342 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13343 window_start_changed_p
= 1;
13347 return window_start_changed_p
;
13351 /* Try cursor movement in case text has not changed in window WINDOW,
13352 with window start STARTP. Value is
13354 CURSOR_MOVEMENT_SUCCESS if successful
13356 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13358 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13359 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13360 we want to scroll as if scroll-step were set to 1. See the code.
13362 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13363 which case we have to abort this redisplay, and adjust matrices
13368 CURSOR_MOVEMENT_SUCCESS
,
13369 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13370 CURSOR_MOVEMENT_MUST_SCROLL
,
13371 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13375 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13377 struct window
*w
= XWINDOW (window
);
13378 struct frame
*f
= XFRAME (w
->frame
);
13379 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13382 if (inhibit_try_cursor_movement
)
13386 /* Handle case where text has not changed, only point, and it has
13387 not moved off the frame. */
13388 if (/* Point may be in this window. */
13389 PT
>= CHARPOS (startp
)
13390 /* Selective display hasn't changed. */
13391 && !current_buffer
->clip_changed
13392 /* Function force-mode-line-update is used to force a thorough
13393 redisplay. It sets either windows_or_buffers_changed or
13394 update_mode_lines. So don't take a shortcut here for these
13396 && !update_mode_lines
13397 && !windows_or_buffers_changed
13398 && !cursor_type_changed
13399 /* Can't use this case if highlighting a region. When a
13400 region exists, cursor movement has to do more than just
13402 && !(!NILP (Vtransient_mark_mode
)
13403 && !NILP (BVAR (current_buffer
, mark_active
)))
13404 && NILP (w
->region_showing
)
13405 && NILP (Vshow_trailing_whitespace
)
13406 /* Right after splitting windows, last_point may be nil. */
13407 && INTEGERP (w
->last_point
)
13408 /* This code is not used for mini-buffer for the sake of the case
13409 of redisplaying to replace an echo area message; since in
13410 that case the mini-buffer contents per se are usually
13411 unchanged. This code is of no real use in the mini-buffer
13412 since the handling of this_line_start_pos, etc., in redisplay
13413 handles the same cases. */
13414 && !EQ (window
, minibuf_window
)
13415 /* When splitting windows or for new windows, it happens that
13416 redisplay is called with a nil window_end_vpos or one being
13417 larger than the window. This should really be fixed in
13418 window.c. I don't have this on my list, now, so we do
13419 approximately the same as the old redisplay code. --gerd. */
13420 && INTEGERP (w
->window_end_vpos
)
13421 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13422 && (FRAME_WINDOW_P (f
)
13423 || !overlay_arrow_in_current_buffer_p ()))
13425 int this_scroll_margin
, top_scroll_margin
;
13426 struct glyph_row
*row
= NULL
;
13429 debug_method_add (w
, "cursor movement");
13432 /* Scroll if point within this distance from the top or bottom
13433 of the window. This is a pixel value. */
13434 if (scroll_margin
> 0)
13436 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13437 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13440 this_scroll_margin
= 0;
13442 top_scroll_margin
= this_scroll_margin
;
13443 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13444 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13446 /* Start with the row the cursor was displayed during the last
13447 not paused redisplay. Give up if that row is not valid. */
13448 if (w
->last_cursor
.vpos
< 0
13449 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13450 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13453 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13454 if (row
->mode_line_p
)
13456 if (!row
->enabled_p
)
13457 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13460 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13462 int scroll_p
= 0, must_scroll
= 0;
13463 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13465 if (PT
> XFASTINT (w
->last_point
))
13467 /* Point has moved forward. */
13468 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13469 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13471 xassert (row
->enabled_p
);
13475 /* If the end position of a row equals the start
13476 position of the next row, and PT is at that position,
13477 we would rather display cursor in the next line. */
13478 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13479 && MATRIX_ROW_END_CHARPOS (row
) == PT
13480 && row
< w
->current_matrix
->rows
13481 + w
->current_matrix
->nrows
- 1
13482 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13483 && !cursor_row_p (row
))
13486 /* If within the scroll margin, scroll. Note that
13487 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13488 the next line would be drawn, and that
13489 this_scroll_margin can be zero. */
13490 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13491 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13492 /* Line is completely visible last line in window
13493 and PT is to be set in the next line. */
13494 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13495 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13496 && !row
->ends_at_zv_p
13497 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13500 else if (PT
< XFASTINT (w
->last_point
))
13502 /* Cursor has to be moved backward. Note that PT >=
13503 CHARPOS (startp) because of the outer if-statement. */
13504 while (!row
->mode_line_p
13505 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13506 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13507 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13508 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13509 row
> w
->current_matrix
->rows
13510 && (row
-1)->ends_in_newline_from_string_p
))))
13511 && (row
->y
> top_scroll_margin
13512 || CHARPOS (startp
) == BEGV
))
13514 xassert (row
->enabled_p
);
13518 /* Consider the following case: Window starts at BEGV,
13519 there is invisible, intangible text at BEGV, so that
13520 display starts at some point START > BEGV. It can
13521 happen that we are called with PT somewhere between
13522 BEGV and START. Try to handle that case. */
13523 if (row
< w
->current_matrix
->rows
13524 || row
->mode_line_p
)
13526 row
= w
->current_matrix
->rows
;
13527 if (row
->mode_line_p
)
13531 /* Due to newlines in overlay strings, we may have to
13532 skip forward over overlay strings. */
13533 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13534 && MATRIX_ROW_END_CHARPOS (row
) == PT
13535 && !cursor_row_p (row
))
13538 /* If within the scroll margin, scroll. */
13539 if (row
->y
< top_scroll_margin
13540 && CHARPOS (startp
) != BEGV
)
13545 /* Cursor did not move. So don't scroll even if cursor line
13546 is partially visible, as it was so before. */
13547 rc
= CURSOR_MOVEMENT_SUCCESS
;
13550 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13551 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13553 /* if PT is not in the glyph row, give up. */
13554 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13557 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13558 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13560 /* If rows are bidi-reordered and point moved, back up
13561 until we find a row that does not belong to a
13562 continuation line. This is because we must consider
13563 all rows of a continued line as candidates for the
13564 new cursor positioning, since row start and end
13565 positions change non-linearly with vertical position
13567 /* FIXME: Revisit this when glyph ``spilling'' in
13568 continuation lines' rows is implemented for
13569 bidi-reordered rows. */
13570 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13572 xassert (row
->enabled_p
);
13574 /* If we hit the beginning of the displayed portion
13575 without finding the first row of a continued
13577 if (row
<= w
->current_matrix
->rows
)
13579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13587 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13588 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13589 && make_cursor_line_fully_visible_p
)
13591 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13592 && !row
->ends_at_zv_p
13593 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13594 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13595 else if (row
->height
> window_box_height (w
))
13597 /* If we end up in a partially visible line, let's
13598 make it fully visible, except when it's taller
13599 than the window, in which case we can't do much
13602 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13606 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13607 if (!cursor_row_fully_visible_p (w
, 0, 1))
13608 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13610 rc
= CURSOR_MOVEMENT_SUCCESS
;
13614 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13615 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13616 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13618 /* With bidi-reordered rows, there could be more than
13619 one candidate row whose start and end positions
13620 occlude point. We need to let set_cursor_from_row
13621 find the best candidate. */
13622 /* FIXME: Revisit this when glyph ``spilling'' in
13623 continuation lines' rows is implemented for
13624 bidi-reordered rows. */
13629 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13630 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13631 && cursor_row_p (row
))
13632 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13634 /* As soon as we've found the first suitable row
13635 whose ends_at_zv_p flag is set, we are done. */
13637 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13639 rc
= CURSOR_MOVEMENT_SUCCESS
;
13644 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13645 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13646 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13647 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13648 /* If we didn't find any candidate rows, or exited the
13649 loop before all the candidates were examined, signal
13650 to the caller that this method failed. */
13651 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13652 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13655 rc
= CURSOR_MOVEMENT_SUCCESS
;
13661 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13663 rc
= CURSOR_MOVEMENT_SUCCESS
;
13668 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13669 && MATRIX_ROW_START_CHARPOS (row
) == PT
13670 && cursor_row_p (row
));
13679 set_vertical_scroll_bar (struct window
*w
)
13681 EMACS_INT start
, end
, whole
;
13683 /* Calculate the start and end positions for the current window.
13684 At some point, it would be nice to choose between scrollbars
13685 which reflect the whole buffer size, with special markers
13686 indicating narrowing, and scrollbars which reflect only the
13689 Note that mini-buffers sometimes aren't displaying any text. */
13690 if (!MINI_WINDOW_P (w
)
13691 || (w
== XWINDOW (minibuf_window
)
13692 && NILP (echo_area_buffer
[0])))
13694 struct buffer
*buf
= XBUFFER (w
->buffer
);
13695 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13696 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13697 /* I don't think this is guaranteed to be right. For the
13698 moment, we'll pretend it is. */
13699 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13703 if (whole
< (end
- start
))
13704 whole
= end
- start
;
13707 start
= end
= whole
= 0;
13709 /* Indicate what this scroll bar ought to be displaying now. */
13710 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13711 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13712 (w
, end
- start
, whole
, start
);
13716 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13717 selected_window is redisplayed.
13719 We can return without actually redisplaying the window if
13720 fonts_changed_p is nonzero. In that case, redisplay_internal will
13724 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13726 struct window
*w
= XWINDOW (window
);
13727 struct frame
*f
= XFRAME (w
->frame
);
13728 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13729 struct buffer
*old
= current_buffer
;
13730 struct text_pos lpoint
, opoint
, startp
;
13731 int update_mode_line
;
13734 /* Record it now because it's overwritten. */
13735 int current_matrix_up_to_date_p
= 0;
13736 int used_current_matrix_p
= 0;
13737 /* This is less strict than current_matrix_up_to_date_p.
13738 It indictes that the buffer contents and narrowing are unchanged. */
13739 int buffer_unchanged_p
= 0;
13740 int temp_scroll_step
= 0;
13741 int count
= SPECPDL_INDEX ();
13743 int centering_position
= -1;
13744 int last_line_misfit
= 0;
13745 EMACS_INT beg_unchanged
, end_unchanged
;
13747 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13750 /* W must be a leaf window here. */
13751 xassert (!NILP (w
->buffer
));
13753 *w
->desired_matrix
->method
= 0;
13757 reconsider_clip_changes (w
, buffer
);
13759 /* Has the mode line to be updated? */
13760 update_mode_line
= (!NILP (w
->update_mode_line
)
13761 || update_mode_lines
13762 || buffer
->clip_changed
13763 || buffer
->prevent_redisplay_optimizations_p
);
13765 if (MINI_WINDOW_P (w
))
13767 if (w
== XWINDOW (echo_area_window
)
13768 && !NILP (echo_area_buffer
[0]))
13770 if (update_mode_line
)
13771 /* We may have to update a tty frame's menu bar or a
13772 tool-bar. Example `M-x C-h C-h C-g'. */
13773 goto finish_menu_bars
;
13775 /* We've already displayed the echo area glyphs in this window. */
13776 goto finish_scroll_bars
;
13778 else if ((w
!= XWINDOW (minibuf_window
)
13779 || minibuf_level
== 0)
13780 /* When buffer is nonempty, redisplay window normally. */
13781 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13782 /* Quail displays non-mini buffers in minibuffer window.
13783 In that case, redisplay the window normally. */
13784 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13786 /* W is a mini-buffer window, but it's not active, so clear
13788 int yb
= window_text_bottom_y (w
);
13789 struct glyph_row
*row
;
13792 for (y
= 0, row
= w
->desired_matrix
->rows
;
13794 y
+= row
->height
, ++row
)
13795 blank_row (w
, row
, y
);
13796 goto finish_scroll_bars
;
13799 clear_glyph_matrix (w
->desired_matrix
);
13802 /* Otherwise set up data on this window; select its buffer and point
13804 /* Really select the buffer, for the sake of buffer-local
13806 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13808 current_matrix_up_to_date_p
13809 = (!NILP (w
->window_end_valid
)
13810 && !current_buffer
->clip_changed
13811 && !current_buffer
->prevent_redisplay_optimizations_p
13812 && XFASTINT (w
->last_modified
) >= MODIFF
13813 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13815 /* Run the window-bottom-change-functions
13816 if it is possible that the text on the screen has changed
13817 (either due to modification of the text, or any other reason). */
13818 if (!current_matrix_up_to_date_p
13819 && !NILP (Vwindow_text_change_functions
))
13821 safe_run_hooks (Qwindow_text_change_functions
);
13825 beg_unchanged
= BEG_UNCHANGED
;
13826 end_unchanged
= END_UNCHANGED
;
13828 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13830 specbind (Qinhibit_point_motion_hooks
, Qt
);
13833 = (!NILP (w
->window_end_valid
)
13834 && !current_buffer
->clip_changed
13835 && XFASTINT (w
->last_modified
) >= MODIFF
13836 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13838 /* When windows_or_buffers_changed is non-zero, we can't rely on
13839 the window end being valid, so set it to nil there. */
13840 if (windows_or_buffers_changed
)
13842 /* If window starts on a continuation line, maybe adjust the
13843 window start in case the window's width changed. */
13844 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13845 compute_window_start_on_continuation_line (w
);
13847 w
->window_end_valid
= Qnil
;
13850 /* Some sanity checks. */
13851 CHECK_WINDOW_END (w
);
13852 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13854 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13857 /* If %c is in mode line, update it if needed. */
13858 if (!NILP (w
->column_number_displayed
)
13859 /* This alternative quickly identifies a common case
13860 where no change is needed. */
13861 && !(PT
== XFASTINT (w
->last_point
)
13862 && XFASTINT (w
->last_modified
) >= MODIFF
13863 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13864 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13865 update_mode_line
= 1;
13867 /* Count number of windows showing the selected buffer. An indirect
13868 buffer counts as its base buffer. */
13869 if (!just_this_one_p
)
13871 struct buffer
*current_base
, *window_base
;
13872 current_base
= current_buffer
;
13873 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13874 if (current_base
->base_buffer
)
13875 current_base
= current_base
->base_buffer
;
13876 if (window_base
->base_buffer
)
13877 window_base
= window_base
->base_buffer
;
13878 if (current_base
== window_base
)
13882 /* Point refers normally to the selected window. For any other
13883 window, set up appropriate value. */
13884 if (!EQ (window
, selected_window
))
13886 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13887 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13891 new_pt_byte
= BEGV_BYTE
;
13892 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13894 else if (new_pt
> (ZV
- 1))
13897 new_pt_byte
= ZV_BYTE
;
13898 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13901 /* We don't use SET_PT so that the point-motion hooks don't run. */
13902 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13905 /* If any of the character widths specified in the display table
13906 have changed, invalidate the width run cache. It's true that
13907 this may be a bit late to catch such changes, but the rest of
13908 redisplay goes (non-fatally) haywire when the display table is
13909 changed, so why should we worry about doing any better? */
13910 if (current_buffer
->width_run_cache
)
13912 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13914 if (! disptab_matches_widthtab (disptab
,
13915 XVECTOR (BVAR (current_buffer
, width_table
))))
13917 invalidate_region_cache (current_buffer
,
13918 current_buffer
->width_run_cache
,
13920 recompute_width_table (current_buffer
, disptab
);
13924 /* If window-start is screwed up, choose a new one. */
13925 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13928 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13930 /* If someone specified a new starting point but did not insist,
13931 check whether it can be used. */
13932 if (!NILP (w
->optional_new_start
)
13933 && CHARPOS (startp
) >= BEGV
13934 && CHARPOS (startp
) <= ZV
)
13936 w
->optional_new_start
= Qnil
;
13937 start_display (&it
, w
, startp
);
13938 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13939 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13940 if (IT_CHARPOS (it
) == PT
)
13941 w
->force_start
= Qt
;
13942 /* IT may overshoot PT if text at PT is invisible. */
13943 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13944 w
->force_start
= Qt
;
13949 /* Handle case where place to start displaying has been specified,
13950 unless the specified location is outside the accessible range. */
13951 if (!NILP (w
->force_start
)
13952 || w
->frozen_window_start_p
)
13954 /* We set this later on if we have to adjust point. */
13957 w
->force_start
= Qnil
;
13959 w
->window_end_valid
= Qnil
;
13961 /* Forget any recorded base line for line number display. */
13962 if (!buffer_unchanged_p
)
13963 w
->base_line_number
= Qnil
;
13965 /* Redisplay the mode line. Select the buffer properly for that.
13966 Also, run the hook window-scroll-functions
13967 because we have scrolled. */
13968 /* Note, we do this after clearing force_start because
13969 if there's an error, it is better to forget about force_start
13970 than to get into an infinite loop calling the hook functions
13971 and having them get more errors. */
13972 if (!update_mode_line
13973 || ! NILP (Vwindow_scroll_functions
))
13975 update_mode_line
= 1;
13976 w
->update_mode_line
= Qt
;
13977 startp
= run_window_scroll_functions (window
, startp
);
13980 w
->last_modified
= make_number (0);
13981 w
->last_overlay_modified
= make_number (0);
13982 if (CHARPOS (startp
) < BEGV
)
13983 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13984 else if (CHARPOS (startp
) > ZV
)
13985 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13987 /* Redisplay, then check if cursor has been set during the
13988 redisplay. Give up if new fonts were loaded. */
13989 /* We used to issue a CHECK_MARGINS argument to try_window here,
13990 but this causes scrolling to fail when point begins inside
13991 the scroll margin (bug#148) -- cyd */
13992 if (!try_window (window
, startp
, 0))
13994 w
->force_start
= Qt
;
13995 clear_glyph_matrix (w
->desired_matrix
);
13996 goto need_larger_matrices
;
13999 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14001 /* If point does not appear, try to move point so it does
14002 appear. The desired matrix has been built above, so we
14003 can use it here. */
14004 new_vpos
= window_box_height (w
) / 2;
14007 if (!cursor_row_fully_visible_p (w
, 0, 0))
14009 /* Point does appear, but on a line partly visible at end of window.
14010 Move it back to a fully-visible line. */
14011 new_vpos
= window_box_height (w
);
14014 /* If we need to move point for either of the above reasons,
14015 now actually do it. */
14018 struct glyph_row
*row
;
14020 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14021 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14024 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14025 MATRIX_ROW_START_BYTEPOS (row
));
14027 if (w
!= XWINDOW (selected_window
))
14028 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14029 else if (current_buffer
== old
)
14030 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14032 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14034 /* If we are highlighting the region, then we just changed
14035 the region, so redisplay to show it. */
14036 if (!NILP (Vtransient_mark_mode
)
14037 && !NILP (BVAR (current_buffer
, mark_active
)))
14039 clear_glyph_matrix (w
->desired_matrix
);
14040 if (!try_window (window
, startp
, 0))
14041 goto need_larger_matrices
;
14046 debug_method_add (w
, "forced window start");
14051 /* Handle case where text has not changed, only point, and it has
14052 not moved off the frame, and we are not retrying after hscroll.
14053 (current_matrix_up_to_date_p is nonzero when retrying.) */
14054 if (current_matrix_up_to_date_p
14055 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14056 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14060 case CURSOR_MOVEMENT_SUCCESS
:
14061 used_current_matrix_p
= 1;
14064 case CURSOR_MOVEMENT_MUST_SCROLL
:
14065 goto try_to_scroll
;
14071 /* If current starting point was originally the beginning of a line
14072 but no longer is, find a new starting point. */
14073 else if (!NILP (w
->start_at_line_beg
)
14074 && !(CHARPOS (startp
) <= BEGV
14075 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14078 debug_method_add (w
, "recenter 1");
14083 /* Try scrolling with try_window_id. Value is > 0 if update has
14084 been done, it is -1 if we know that the same window start will
14085 not work. It is 0 if unsuccessful for some other reason. */
14086 else if ((tem
= try_window_id (w
)) != 0)
14089 debug_method_add (w
, "try_window_id %d", tem
);
14092 if (fonts_changed_p
)
14093 goto need_larger_matrices
;
14097 /* Otherwise try_window_id has returned -1 which means that we
14098 don't want the alternative below this comment to execute. */
14100 else if (CHARPOS (startp
) >= BEGV
14101 && CHARPOS (startp
) <= ZV
14102 && PT
>= CHARPOS (startp
)
14103 && (CHARPOS (startp
) < ZV
14104 /* Avoid starting at end of buffer. */
14105 || CHARPOS (startp
) == BEGV
14106 || (XFASTINT (w
->last_modified
) >= MODIFF
14107 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14110 /* If first window line is a continuation line, and window start
14111 is inside the modified region, but the first change is before
14112 current window start, we must select a new window start.
14114 However, if this is the result of a down-mouse event (e.g. by
14115 extending the mouse-drag-overlay), we don't want to select a
14116 new window start, since that would change the position under
14117 the mouse, resulting in an unwanted mouse-movement rather
14118 than a simple mouse-click. */
14119 if (NILP (w
->start_at_line_beg
)
14120 && NILP (do_mouse_tracking
)
14121 && CHARPOS (startp
) > BEGV
14122 && CHARPOS (startp
) > BEG
+ beg_unchanged
14123 && CHARPOS (startp
) <= Z
- end_unchanged
14124 /* Even if w->start_at_line_beg is nil, a new window may
14125 start at a line_beg, since that's how set_buffer_window
14126 sets it. So, we need to check the return value of
14127 compute_window_start_on_continuation_line. (See also
14129 && XMARKER (w
->start
)->buffer
== current_buffer
14130 && compute_window_start_on_continuation_line (w
))
14132 w
->force_start
= Qt
;
14133 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14138 debug_method_add (w
, "same window start");
14141 /* Try to redisplay starting at same place as before.
14142 If point has not moved off frame, accept the results. */
14143 if (!current_matrix_up_to_date_p
14144 /* Don't use try_window_reusing_current_matrix in this case
14145 because a window scroll function can have changed the
14147 || !NILP (Vwindow_scroll_functions
)
14148 || MINI_WINDOW_P (w
)
14149 || !(used_current_matrix_p
14150 = try_window_reusing_current_matrix (w
)))
14152 IF_DEBUG (debug_method_add (w
, "1"));
14153 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14154 /* -1 means we need to scroll.
14155 0 means we need new matrices, but fonts_changed_p
14156 is set in that case, so we will detect it below. */
14157 goto try_to_scroll
;
14160 if (fonts_changed_p
)
14161 goto need_larger_matrices
;
14163 if (w
->cursor
.vpos
>= 0)
14165 if (!just_this_one_p
14166 || current_buffer
->clip_changed
14167 || BEG_UNCHANGED
< CHARPOS (startp
))
14168 /* Forget any recorded base line for line number display. */
14169 w
->base_line_number
= Qnil
;
14171 if (!cursor_row_fully_visible_p (w
, 1, 0))
14173 clear_glyph_matrix (w
->desired_matrix
);
14174 last_line_misfit
= 1;
14176 /* Drop through and scroll. */
14181 clear_glyph_matrix (w
->desired_matrix
);
14186 w
->last_modified
= make_number (0);
14187 w
->last_overlay_modified
= make_number (0);
14189 /* Redisplay the mode line. Select the buffer properly for that. */
14190 if (!update_mode_line
)
14192 update_mode_line
= 1;
14193 w
->update_mode_line
= Qt
;
14196 /* Try to scroll by specified few lines. */
14197 if ((scroll_conservatively
14198 || emacs_scroll_step
14199 || temp_scroll_step
14200 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14201 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14202 && CHARPOS (startp
) >= BEGV
14203 && CHARPOS (startp
) <= ZV
)
14205 /* The function returns -1 if new fonts were loaded, 1 if
14206 successful, 0 if not successful. */
14207 int ss
= try_scrolling (window
, just_this_one_p
,
14208 scroll_conservatively
,
14210 temp_scroll_step
, last_line_misfit
);
14213 case SCROLLING_SUCCESS
:
14216 case SCROLLING_NEED_LARGER_MATRICES
:
14217 goto need_larger_matrices
;
14219 case SCROLLING_FAILED
:
14227 /* Finally, just choose a place to start which positions point
14228 according to user preferences. */
14233 debug_method_add (w
, "recenter");
14236 /* w->vscroll = 0; */
14238 /* Forget any previously recorded base line for line number display. */
14239 if (!buffer_unchanged_p
)
14240 w
->base_line_number
= Qnil
;
14242 /* Determine the window start relative to point. */
14243 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14244 it
.current_y
= it
.last_visible_y
;
14245 if (centering_position
< 0)
14249 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14251 EMACS_INT margin_pos
= CHARPOS (startp
);
14253 Lisp_Object aggressive
;
14255 /* If there is a scroll margin at the top of the window, find
14256 its character position. */
14261 start_display (&it1
, w
, startp
);
14262 move_it_vertically (&it1
, margin
);
14263 margin_pos
= IT_CHARPOS (it1
);
14265 scrolling_up
= PT
> margin_pos
;
14268 ? BVAR (current_buffer
, scroll_up_aggressively
)
14269 : BVAR (current_buffer
, scroll_down_aggressively
);
14271 if (!MINI_WINDOW_P (w
)
14272 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14276 /* Setting scroll-conservatively overrides
14277 scroll-*-aggressively. */
14278 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14280 double float_amount
= XFLOATINT (aggressive
);
14282 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14283 if (pt_offset
== 0 && float_amount
> 0)
14288 /* Compute how much to move the window start backward from
14289 point so that point will be displayed where the user
14293 centering_position
= it
.last_visible_y
;
14295 centering_position
-= pt_offset
;
14296 centering_position
-=
14297 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14298 /* Don't let point enter the scroll margin near top of
14300 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14301 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14304 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14307 /* Set the window start half the height of the window backward
14309 centering_position
= window_box_height (w
) / 2;
14311 move_it_vertically_backward (&it
, centering_position
);
14313 xassert (IT_CHARPOS (it
) >= BEGV
);
14315 /* The function move_it_vertically_backward may move over more
14316 than the specified y-distance. If it->w is small, e.g. a
14317 mini-buffer window, we may end up in front of the window's
14318 display area. Start displaying at the start of the line
14319 containing PT in this case. */
14320 if (it
.current_y
<= 0)
14322 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14323 move_it_vertically_backward (&it
, 0);
14327 it
.current_x
= it
.hpos
= 0;
14329 /* Set the window start position here explicitly, to avoid an
14330 infinite loop in case the functions in window-scroll-functions
14332 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14334 /* Run scroll hooks. */
14335 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14337 /* Redisplay the window. */
14338 if (!current_matrix_up_to_date_p
14339 || windows_or_buffers_changed
14340 || cursor_type_changed
14341 /* Don't use try_window_reusing_current_matrix in this case
14342 because it can have changed the buffer. */
14343 || !NILP (Vwindow_scroll_functions
)
14344 || !just_this_one_p
14345 || MINI_WINDOW_P (w
)
14346 || !(used_current_matrix_p
14347 = try_window_reusing_current_matrix (w
)))
14348 try_window (window
, startp
, 0);
14350 /* If new fonts have been loaded (due to fontsets), give up. We
14351 have to start a new redisplay since we need to re-adjust glyph
14353 if (fonts_changed_p
)
14354 goto need_larger_matrices
;
14356 /* If cursor did not appear assume that the middle of the window is
14357 in the first line of the window. Do it again with the next line.
14358 (Imagine a window of height 100, displaying two lines of height
14359 60. Moving back 50 from it->last_visible_y will end in the first
14361 if (w
->cursor
.vpos
< 0)
14363 if (!NILP (w
->window_end_valid
)
14364 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14366 clear_glyph_matrix (w
->desired_matrix
);
14367 move_it_by_lines (&it
, 1);
14368 try_window (window
, it
.current
.pos
, 0);
14370 else if (PT
< IT_CHARPOS (it
))
14372 clear_glyph_matrix (w
->desired_matrix
);
14373 move_it_by_lines (&it
, -1);
14374 try_window (window
, it
.current
.pos
, 0);
14378 /* Not much we can do about it. */
14382 /* Consider the following case: Window starts at BEGV, there is
14383 invisible, intangible text at BEGV, so that display starts at
14384 some point START > BEGV. It can happen that we are called with
14385 PT somewhere between BEGV and START. Try to handle that case. */
14386 if (w
->cursor
.vpos
< 0)
14388 struct glyph_row
*row
= w
->current_matrix
->rows
;
14389 if (row
->mode_line_p
)
14391 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14394 if (!cursor_row_fully_visible_p (w
, 0, 0))
14396 /* If vscroll is enabled, disable it and try again. */
14400 clear_glyph_matrix (w
->desired_matrix
);
14404 /* If centering point failed to make the whole line visible,
14405 put point at the top instead. That has to make the whole line
14406 visible, if it can be done. */
14407 if (centering_position
== 0)
14410 clear_glyph_matrix (w
->desired_matrix
);
14411 centering_position
= 0;
14417 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14418 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14419 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14422 /* Display the mode line, if we must. */
14423 if ((update_mode_line
14424 /* If window not full width, must redo its mode line
14425 if (a) the window to its side is being redone and
14426 (b) we do a frame-based redisplay. This is a consequence
14427 of how inverted lines are drawn in frame-based redisplay. */
14428 || (!just_this_one_p
14429 && !FRAME_WINDOW_P (f
)
14430 && !WINDOW_FULL_WIDTH_P (w
))
14431 /* Line number to display. */
14432 || INTEGERP (w
->base_line_pos
)
14433 /* Column number is displayed and different from the one displayed. */
14434 || (!NILP (w
->column_number_displayed
)
14435 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14436 /* This means that the window has a mode line. */
14437 && (WINDOW_WANTS_MODELINE_P (w
)
14438 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14440 display_mode_lines (w
);
14442 /* If mode line height has changed, arrange for a thorough
14443 immediate redisplay using the correct mode line height. */
14444 if (WINDOW_WANTS_MODELINE_P (w
)
14445 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14447 fonts_changed_p
= 1;
14448 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14449 = DESIRED_MODE_LINE_HEIGHT (w
);
14452 /* If header line height has changed, arrange for a thorough
14453 immediate redisplay using the correct header line height. */
14454 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14455 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14457 fonts_changed_p
= 1;
14458 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14459 = DESIRED_HEADER_LINE_HEIGHT (w
);
14462 if (fonts_changed_p
)
14463 goto need_larger_matrices
;
14466 if (!line_number_displayed
14467 && !BUFFERP (w
->base_line_pos
))
14469 w
->base_line_pos
= Qnil
;
14470 w
->base_line_number
= Qnil
;
14475 /* When we reach a frame's selected window, redo the frame's menu bar. */
14476 if (update_mode_line
14477 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14479 int redisplay_menu_p
= 0;
14480 int redisplay_tool_bar_p
= 0;
14482 if (FRAME_WINDOW_P (f
))
14484 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14485 || defined (HAVE_NS) || defined (USE_GTK)
14486 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14488 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14492 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14494 if (redisplay_menu_p
)
14495 display_menu_bar (w
);
14497 #ifdef HAVE_WINDOW_SYSTEM
14498 if (FRAME_WINDOW_P (f
))
14500 #if defined (USE_GTK) || defined (HAVE_NS)
14501 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14503 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14504 && (FRAME_TOOL_BAR_LINES (f
) > 0
14505 || !NILP (Vauto_resize_tool_bars
));
14508 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14510 ignore_mouse_drag_p
= 1;
14516 #ifdef HAVE_WINDOW_SYSTEM
14517 if (FRAME_WINDOW_P (f
)
14518 && update_window_fringes (w
, (just_this_one_p
14519 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14520 || w
->pseudo_window_p
)))
14524 if (draw_window_fringes (w
, 1))
14525 x_draw_vertical_border (w
);
14529 #endif /* HAVE_WINDOW_SYSTEM */
14531 /* We go to this label, with fonts_changed_p nonzero,
14532 if it is necessary to try again using larger glyph matrices.
14533 We have to redeem the scroll bar even in this case,
14534 because the loop in redisplay_internal expects that. */
14535 need_larger_matrices
:
14537 finish_scroll_bars
:
14539 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14541 /* Set the thumb's position and size. */
14542 set_vertical_scroll_bar (w
);
14544 /* Note that we actually used the scroll bar attached to this
14545 window, so it shouldn't be deleted at the end of redisplay. */
14546 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14547 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14550 /* Restore current_buffer and value of point in it. The window
14551 update may have changed the buffer, so first make sure `opoint'
14552 is still valid (Bug#6177). */
14553 if (CHARPOS (opoint
) < BEGV
)
14554 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14555 else if (CHARPOS (opoint
) > ZV
)
14556 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14558 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14560 set_buffer_internal_1 (old
);
14561 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14562 shorter. This can be caused by log truncation in *Messages*. */
14563 if (CHARPOS (lpoint
) <= ZV
)
14564 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14566 unbind_to (count
, Qnil
);
14570 /* Build the complete desired matrix of WINDOW with a window start
14571 buffer position POS.
14573 Value is 1 if successful. It is zero if fonts were loaded during
14574 redisplay which makes re-adjusting glyph matrices necessary, and -1
14575 if point would appear in the scroll margins.
14576 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14577 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14581 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14583 struct window
*w
= XWINDOW (window
);
14585 struct glyph_row
*last_text_row
= NULL
;
14586 struct frame
*f
= XFRAME (w
->frame
);
14588 /* Make POS the new window start. */
14589 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14591 /* Mark cursor position as unknown. No overlay arrow seen. */
14592 w
->cursor
.vpos
= -1;
14593 overlay_arrow_seen
= 0;
14595 /* Initialize iterator and info to start at POS. */
14596 start_display (&it
, w
, pos
);
14598 /* Display all lines of W. */
14599 while (it
.current_y
< it
.last_visible_y
)
14601 if (display_line (&it
))
14602 last_text_row
= it
.glyph_row
- 1;
14603 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14607 /* Don't let the cursor end in the scroll margins. */
14608 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14609 && !MINI_WINDOW_P (w
))
14611 int this_scroll_margin
;
14613 if (scroll_margin
> 0)
14615 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14616 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14619 this_scroll_margin
= 0;
14621 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14622 && w
->cursor
.y
< this_scroll_margin
14623 && CHARPOS (pos
) > BEGV
14624 && IT_CHARPOS (it
) < ZV
)
14625 /* rms: considering make_cursor_line_fully_visible_p here
14626 seems to give wrong results. We don't want to recenter
14627 when the last line is partly visible, we want to allow
14628 that case to be handled in the usual way. */
14629 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14631 w
->cursor
.vpos
= -1;
14632 clear_glyph_matrix (w
->desired_matrix
);
14637 /* If bottom moved off end of frame, change mode line percentage. */
14638 if (XFASTINT (w
->window_end_pos
) <= 0
14639 && Z
!= IT_CHARPOS (it
))
14640 w
->update_mode_line
= Qt
;
14642 /* Set window_end_pos to the offset of the last character displayed
14643 on the window from the end of current_buffer. Set
14644 window_end_vpos to its row number. */
14647 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14648 w
->window_end_bytepos
14649 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14651 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14653 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14654 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14655 ->displays_text_p
);
14659 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14660 w
->window_end_pos
= make_number (Z
- ZV
);
14661 w
->window_end_vpos
= make_number (0);
14664 /* But that is not valid info until redisplay finishes. */
14665 w
->window_end_valid
= Qnil
;
14671 /************************************************************************
14672 Window redisplay reusing current matrix when buffer has not changed
14673 ************************************************************************/
14675 /* Try redisplay of window W showing an unchanged buffer with a
14676 different window start than the last time it was displayed by
14677 reusing its current matrix. Value is non-zero if successful.
14678 W->start is the new window start. */
14681 try_window_reusing_current_matrix (struct window
*w
)
14683 struct frame
*f
= XFRAME (w
->frame
);
14684 struct glyph_row
*bottom_row
;
14687 struct text_pos start
, new_start
;
14688 int nrows_scrolled
, i
;
14689 struct glyph_row
*last_text_row
;
14690 struct glyph_row
*last_reused_text_row
;
14691 struct glyph_row
*start_row
;
14692 int start_vpos
, min_y
, max_y
;
14695 if (inhibit_try_window_reusing
)
14699 if (/* This function doesn't handle terminal frames. */
14700 !FRAME_WINDOW_P (f
)
14701 /* Don't try to reuse the display if windows have been split
14703 || windows_or_buffers_changed
14704 || cursor_type_changed
)
14707 /* Can't do this if region may have changed. */
14708 if ((!NILP (Vtransient_mark_mode
)
14709 && !NILP (BVAR (current_buffer
, mark_active
)))
14710 || !NILP (w
->region_showing
)
14711 || !NILP (Vshow_trailing_whitespace
))
14714 /* If top-line visibility has changed, give up. */
14715 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14716 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14719 /* Give up if old or new display is scrolled vertically. We could
14720 make this function handle this, but right now it doesn't. */
14721 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14722 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14725 /* The variable new_start now holds the new window start. The old
14726 start `start' can be determined from the current matrix. */
14727 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14728 start
= start_row
->minpos
;
14729 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14731 /* Clear the desired matrix for the display below. */
14732 clear_glyph_matrix (w
->desired_matrix
);
14734 if (CHARPOS (new_start
) <= CHARPOS (start
))
14736 /* Don't use this method if the display starts with an ellipsis
14737 displayed for invisible text. It's not easy to handle that case
14738 below, and it's certainly not worth the effort since this is
14739 not a frequent case. */
14740 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14743 IF_DEBUG (debug_method_add (w
, "twu1"));
14745 /* Display up to a row that can be reused. The variable
14746 last_text_row is set to the last row displayed that displays
14747 text. Note that it.vpos == 0 if or if not there is a
14748 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14749 start_display (&it
, w
, new_start
);
14750 w
->cursor
.vpos
= -1;
14751 last_text_row
= last_reused_text_row
= NULL
;
14753 while (it
.current_y
< it
.last_visible_y
14754 && !fonts_changed_p
)
14756 /* If we have reached into the characters in the START row,
14757 that means the line boundaries have changed. So we
14758 can't start copying with the row START. Maybe it will
14759 work to start copying with the following row. */
14760 while (IT_CHARPOS (it
) > CHARPOS (start
))
14762 /* Advance to the next row as the "start". */
14764 start
= start_row
->minpos
;
14765 /* If there are no more rows to try, or just one, give up. */
14766 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14767 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14768 || CHARPOS (start
) == ZV
)
14770 clear_glyph_matrix (w
->desired_matrix
);
14774 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14776 /* If we have reached alignment,
14777 we can copy the rest of the rows. */
14778 if (IT_CHARPOS (it
) == CHARPOS (start
))
14781 if (display_line (&it
))
14782 last_text_row
= it
.glyph_row
- 1;
14785 /* A value of current_y < last_visible_y means that we stopped
14786 at the previous window start, which in turn means that we
14787 have at least one reusable row. */
14788 if (it
.current_y
< it
.last_visible_y
)
14790 struct glyph_row
*row
;
14792 /* IT.vpos always starts from 0; it counts text lines. */
14793 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14795 /* Find PT if not already found in the lines displayed. */
14796 if (w
->cursor
.vpos
< 0)
14798 int dy
= it
.current_y
- start_row
->y
;
14800 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14801 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14803 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14804 dy
, nrows_scrolled
);
14807 clear_glyph_matrix (w
->desired_matrix
);
14812 /* Scroll the display. Do it before the current matrix is
14813 changed. The problem here is that update has not yet
14814 run, i.e. part of the current matrix is not up to date.
14815 scroll_run_hook will clear the cursor, and use the
14816 current matrix to get the height of the row the cursor is
14818 run
.current_y
= start_row
->y
;
14819 run
.desired_y
= it
.current_y
;
14820 run
.height
= it
.last_visible_y
- it
.current_y
;
14822 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14825 FRAME_RIF (f
)->update_window_begin_hook (w
);
14826 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14827 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14828 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14832 /* Shift current matrix down by nrows_scrolled lines. */
14833 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14834 rotate_matrix (w
->current_matrix
,
14836 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14839 /* Disable lines that must be updated. */
14840 for (i
= 0; i
< nrows_scrolled
; ++i
)
14841 (start_row
+ i
)->enabled_p
= 0;
14843 /* Re-compute Y positions. */
14844 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14845 max_y
= it
.last_visible_y
;
14846 for (row
= start_row
+ nrows_scrolled
;
14850 row
->y
= it
.current_y
;
14851 row
->visible_height
= row
->height
;
14853 if (row
->y
< min_y
)
14854 row
->visible_height
-= min_y
- row
->y
;
14855 if (row
->y
+ row
->height
> max_y
)
14856 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14857 row
->redraw_fringe_bitmaps_p
= 1;
14859 it
.current_y
+= row
->height
;
14861 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14862 last_reused_text_row
= row
;
14863 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14867 /* Disable lines in the current matrix which are now
14868 below the window. */
14869 for (++row
; row
< bottom_row
; ++row
)
14870 row
->enabled_p
= row
->mode_line_p
= 0;
14873 /* Update window_end_pos etc.; last_reused_text_row is the last
14874 reused row from the current matrix containing text, if any.
14875 The value of last_text_row is the last displayed line
14876 containing text. */
14877 if (last_reused_text_row
)
14879 w
->window_end_bytepos
14880 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14882 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14884 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14885 w
->current_matrix
));
14887 else if (last_text_row
)
14889 w
->window_end_bytepos
14890 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14892 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14894 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14898 /* This window must be completely empty. */
14899 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14900 w
->window_end_pos
= make_number (Z
- ZV
);
14901 w
->window_end_vpos
= make_number (0);
14903 w
->window_end_valid
= Qnil
;
14905 /* Update hint: don't try scrolling again in update_window. */
14906 w
->desired_matrix
->no_scrolling_p
= 1;
14909 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14913 else if (CHARPOS (new_start
) > CHARPOS (start
))
14915 struct glyph_row
*pt_row
, *row
;
14916 struct glyph_row
*first_reusable_row
;
14917 struct glyph_row
*first_row_to_display
;
14919 int yb
= window_text_bottom_y (w
);
14921 /* Find the row starting at new_start, if there is one. Don't
14922 reuse a partially visible line at the end. */
14923 first_reusable_row
= start_row
;
14924 while (first_reusable_row
->enabled_p
14925 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14926 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14927 < CHARPOS (new_start
)))
14928 ++first_reusable_row
;
14930 /* Give up if there is no row to reuse. */
14931 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14932 || !first_reusable_row
->enabled_p
14933 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14934 != CHARPOS (new_start
)))
14937 /* We can reuse fully visible rows beginning with
14938 first_reusable_row to the end of the window. Set
14939 first_row_to_display to the first row that cannot be reused.
14940 Set pt_row to the row containing point, if there is any. */
14942 for (first_row_to_display
= first_reusable_row
;
14943 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14944 ++first_row_to_display
)
14946 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14947 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14948 pt_row
= first_row_to_display
;
14951 /* Start displaying at the start of first_row_to_display. */
14952 xassert (first_row_to_display
->y
< yb
);
14953 init_to_row_start (&it
, w
, first_row_to_display
);
14955 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14957 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14959 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14960 + WINDOW_HEADER_LINE_HEIGHT (w
));
14962 /* Display lines beginning with first_row_to_display in the
14963 desired matrix. Set last_text_row to the last row displayed
14964 that displays text. */
14965 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14966 if (pt_row
== NULL
)
14967 w
->cursor
.vpos
= -1;
14968 last_text_row
= NULL
;
14969 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14970 if (display_line (&it
))
14971 last_text_row
= it
.glyph_row
- 1;
14973 /* If point is in a reused row, adjust y and vpos of the cursor
14977 w
->cursor
.vpos
-= nrows_scrolled
;
14978 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14981 /* Give up if point isn't in a row displayed or reused. (This
14982 also handles the case where w->cursor.vpos < nrows_scrolled
14983 after the calls to display_line, which can happen with scroll
14984 margins. See bug#1295.) */
14985 if (w
->cursor
.vpos
< 0)
14987 clear_glyph_matrix (w
->desired_matrix
);
14991 /* Scroll the display. */
14992 run
.current_y
= first_reusable_row
->y
;
14993 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14994 run
.height
= it
.last_visible_y
- run
.current_y
;
14995 dy
= run
.current_y
- run
.desired_y
;
15000 FRAME_RIF (f
)->update_window_begin_hook (w
);
15001 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15002 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15003 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15007 /* Adjust Y positions of reused rows. */
15008 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15009 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15010 max_y
= it
.last_visible_y
;
15011 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15014 row
->visible_height
= row
->height
;
15015 if (row
->y
< min_y
)
15016 row
->visible_height
-= min_y
- row
->y
;
15017 if (row
->y
+ row
->height
> max_y
)
15018 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15019 row
->redraw_fringe_bitmaps_p
= 1;
15022 /* Scroll the current matrix. */
15023 xassert (nrows_scrolled
> 0);
15024 rotate_matrix (w
->current_matrix
,
15026 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15029 /* Disable rows not reused. */
15030 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15031 row
->enabled_p
= 0;
15033 /* Point may have moved to a different line, so we cannot assume that
15034 the previous cursor position is valid; locate the correct row. */
15037 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15038 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15042 w
->cursor
.y
= row
->y
;
15044 if (row
< bottom_row
)
15046 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15047 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15049 /* Can't use this optimization with bidi-reordered glyph
15050 rows, unless cursor is already at point. */
15051 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15053 if (!(w
->cursor
.hpos
>= 0
15054 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15055 && BUFFERP (glyph
->object
)
15056 && glyph
->charpos
== PT
))
15061 && (!BUFFERP (glyph
->object
)
15062 || glyph
->charpos
< PT
);
15066 w
->cursor
.x
+= glyph
->pixel_width
;
15071 /* Adjust window end. A null value of last_text_row means that
15072 the window end is in reused rows which in turn means that
15073 only its vpos can have changed. */
15076 w
->window_end_bytepos
15077 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15079 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15081 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15086 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15089 w
->window_end_valid
= Qnil
;
15090 w
->desired_matrix
->no_scrolling_p
= 1;
15093 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15103 /************************************************************************
15104 Window redisplay reusing current matrix when buffer has changed
15105 ************************************************************************/
15107 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15108 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15109 EMACS_INT
*, EMACS_INT
*);
15110 static struct glyph_row
*
15111 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15112 struct glyph_row
*);
15115 /* Return the last row in MATRIX displaying text. If row START is
15116 non-null, start searching with that row. IT gives the dimensions
15117 of the display. Value is null if matrix is empty; otherwise it is
15118 a pointer to the row found. */
15120 static struct glyph_row
*
15121 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15122 struct glyph_row
*start
)
15124 struct glyph_row
*row
, *row_found
;
15126 /* Set row_found to the last row in IT->w's current matrix
15127 displaying text. The loop looks funny but think of partially
15130 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15131 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15133 xassert (row
->enabled_p
);
15135 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15144 /* Return the last row in the current matrix of W that is not affected
15145 by changes at the start of current_buffer that occurred since W's
15146 current matrix was built. Value is null if no such row exists.
15148 BEG_UNCHANGED us the number of characters unchanged at the start of
15149 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15150 first changed character in current_buffer. Characters at positions <
15151 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15152 when the current matrix was built. */
15154 static struct glyph_row
*
15155 find_last_unchanged_at_beg_row (struct window
*w
)
15157 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15158 struct glyph_row
*row
;
15159 struct glyph_row
*row_found
= NULL
;
15160 int yb
= window_text_bottom_y (w
);
15162 /* Find the last row displaying unchanged text. */
15163 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15164 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15165 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15168 if (/* If row ends before first_changed_pos, it is unchanged,
15169 except in some case. */
15170 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15171 /* When row ends in ZV and we write at ZV it is not
15173 && !row
->ends_at_zv_p
15174 /* When first_changed_pos is the end of a continued line,
15175 row is not unchanged because it may be no longer
15177 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15178 && (row
->continued_p
15179 || row
->exact_window_width_line_p
)))
15182 /* Stop if last visible row. */
15183 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15191 /* Find the first glyph row in the current matrix of W that is not
15192 affected by changes at the end of current_buffer since the
15193 time W's current matrix was built.
15195 Return in *DELTA the number of chars by which buffer positions in
15196 unchanged text at the end of current_buffer must be adjusted.
15198 Return in *DELTA_BYTES the corresponding number of bytes.
15200 Value is null if no such row exists, i.e. all rows are affected by
15203 static struct glyph_row
*
15204 find_first_unchanged_at_end_row (struct window
*w
,
15205 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15207 struct glyph_row
*row
;
15208 struct glyph_row
*row_found
= NULL
;
15210 *delta
= *delta_bytes
= 0;
15212 /* Display must not have been paused, otherwise the current matrix
15213 is not up to date. */
15214 eassert (!NILP (w
->window_end_valid
));
15216 /* A value of window_end_pos >= END_UNCHANGED means that the window
15217 end is in the range of changed text. If so, there is no
15218 unchanged row at the end of W's current matrix. */
15219 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15222 /* Set row to the last row in W's current matrix displaying text. */
15223 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15225 /* If matrix is entirely empty, no unchanged row exists. */
15226 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15228 /* The value of row is the last glyph row in the matrix having a
15229 meaningful buffer position in it. The end position of row
15230 corresponds to window_end_pos. This allows us to translate
15231 buffer positions in the current matrix to current buffer
15232 positions for characters not in changed text. */
15234 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15235 EMACS_INT Z_BYTE_old
=
15236 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15237 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15238 struct glyph_row
*first_text_row
15239 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15241 *delta
= Z
- Z_old
;
15242 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15244 /* Set last_unchanged_pos to the buffer position of the last
15245 character in the buffer that has not been changed. Z is the
15246 index + 1 of the last character in current_buffer, i.e. by
15247 subtracting END_UNCHANGED we get the index of the last
15248 unchanged character, and we have to add BEG to get its buffer
15250 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15251 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15253 /* Search backward from ROW for a row displaying a line that
15254 starts at a minimum position >= last_unchanged_pos_old. */
15255 for (; row
> first_text_row
; --row
)
15257 /* This used to abort, but it can happen.
15258 It is ok to just stop the search instead here. KFS. */
15259 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15262 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15267 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15273 /* Make sure that glyph rows in the current matrix of window W
15274 reference the same glyph memory as corresponding rows in the
15275 frame's frame matrix. This function is called after scrolling W's
15276 current matrix on a terminal frame in try_window_id and
15277 try_window_reusing_current_matrix. */
15280 sync_frame_with_window_matrix_rows (struct window
*w
)
15282 struct frame
*f
= XFRAME (w
->frame
);
15283 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15285 /* Preconditions: W must be a leaf window and full-width. Its frame
15286 must have a frame matrix. */
15287 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15288 xassert (WINDOW_FULL_WIDTH_P (w
));
15289 xassert (!FRAME_WINDOW_P (f
));
15291 /* If W is a full-width window, glyph pointers in W's current matrix
15292 have, by definition, to be the same as glyph pointers in the
15293 corresponding frame matrix. Note that frame matrices have no
15294 marginal areas (see build_frame_matrix). */
15295 window_row
= w
->current_matrix
->rows
;
15296 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15297 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15298 while (window_row
< window_row_end
)
15300 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15301 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15303 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15304 frame_row
->glyphs
[TEXT_AREA
] = start
;
15305 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15306 frame_row
->glyphs
[LAST_AREA
] = end
;
15308 /* Disable frame rows whose corresponding window rows have
15309 been disabled in try_window_id. */
15310 if (!window_row
->enabled_p
)
15311 frame_row
->enabled_p
= 0;
15313 ++window_row
, ++frame_row
;
15318 /* Find the glyph row in window W containing CHARPOS. Consider all
15319 rows between START and END (not inclusive). END null means search
15320 all rows to the end of the display area of W. Value is the row
15321 containing CHARPOS or null. */
15324 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15325 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15327 struct glyph_row
*row
= start
;
15328 struct glyph_row
*best_row
= NULL
;
15329 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15332 /* If we happen to start on a header-line, skip that. */
15333 if (row
->mode_line_p
)
15336 if ((end
&& row
>= end
) || !row
->enabled_p
)
15339 last_y
= window_text_bottom_y (w
) - dy
;
15343 /* Give up if we have gone too far. */
15344 if (end
&& row
>= end
)
15346 /* This formerly returned if they were equal.
15347 I think that both quantities are of a "last plus one" type;
15348 if so, when they are equal, the row is within the screen. -- rms. */
15349 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15352 /* If it is in this row, return this row. */
15353 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15354 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15355 /* The end position of a row equals the start
15356 position of the next row. If CHARPOS is there, we
15357 would rather display it in the next line, except
15358 when this line ends in ZV. */
15359 && !row
->ends_at_zv_p
15360 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15361 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15365 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15366 || (!best_row
&& !row
->continued_p
))
15368 /* In bidi-reordered rows, there could be several rows
15369 occluding point, all of them belonging to the same
15370 continued line. We need to find the row which fits
15371 CHARPOS the best. */
15372 for (g
= row
->glyphs
[TEXT_AREA
];
15373 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15376 if (!STRINGP (g
->object
))
15378 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15380 mindif
= eabs (g
->charpos
- charpos
);
15382 /* Exact match always wins. */
15389 else if (best_row
&& !row
->continued_p
)
15396 /* Try to redisplay window W by reusing its existing display. W's
15397 current matrix must be up to date when this function is called,
15398 i.e. window_end_valid must not be nil.
15402 1 if display has been updated
15403 0 if otherwise unsuccessful
15404 -1 if redisplay with same window start is known not to succeed
15406 The following steps are performed:
15408 1. Find the last row in the current matrix of W that is not
15409 affected by changes at the start of current_buffer. If no such row
15412 2. Find the first row in W's current matrix that is not affected by
15413 changes at the end of current_buffer. Maybe there is no such row.
15415 3. Display lines beginning with the row + 1 found in step 1 to the
15416 row found in step 2 or, if step 2 didn't find a row, to the end of
15419 4. If cursor is not known to appear on the window, give up.
15421 5. If display stopped at the row found in step 2, scroll the
15422 display and current matrix as needed.
15424 6. Maybe display some lines at the end of W, if we must. This can
15425 happen under various circumstances, like a partially visible line
15426 becoming fully visible, or because newly displayed lines are displayed
15427 in smaller font sizes.
15429 7. Update W's window end information. */
15432 try_window_id (struct window
*w
)
15434 struct frame
*f
= XFRAME (w
->frame
);
15435 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15436 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15437 struct glyph_row
*last_unchanged_at_beg_row
;
15438 struct glyph_row
*first_unchanged_at_end_row
;
15439 struct glyph_row
*row
;
15440 struct glyph_row
*bottom_row
;
15443 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15445 struct text_pos start_pos
;
15447 int first_unchanged_at_end_vpos
= 0;
15448 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15449 struct text_pos start
;
15450 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15453 if (inhibit_try_window_id
)
15457 /* This is handy for debugging. */
15459 #define GIVE_UP(X) \
15461 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15465 #define GIVE_UP(X) return 0
15468 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15470 /* Don't use this for mini-windows because these can show
15471 messages and mini-buffers, and we don't handle that here. */
15472 if (MINI_WINDOW_P (w
))
15475 /* This flag is used to prevent redisplay optimizations. */
15476 if (windows_or_buffers_changed
|| cursor_type_changed
)
15479 /* Verify that narrowing has not changed.
15480 Also verify that we were not told to prevent redisplay optimizations.
15481 It would be nice to further
15482 reduce the number of cases where this prevents try_window_id. */
15483 if (current_buffer
->clip_changed
15484 || current_buffer
->prevent_redisplay_optimizations_p
)
15487 /* Window must either use window-based redisplay or be full width. */
15488 if (!FRAME_WINDOW_P (f
)
15489 && (!FRAME_LINE_INS_DEL_OK (f
)
15490 || !WINDOW_FULL_WIDTH_P (w
)))
15493 /* Give up if point is known NOT to appear in W. */
15494 if (PT
< CHARPOS (start
))
15497 /* Another way to prevent redisplay optimizations. */
15498 if (XFASTINT (w
->last_modified
) == 0)
15501 /* Verify that window is not hscrolled. */
15502 if (XFASTINT (w
->hscroll
) != 0)
15505 /* Verify that display wasn't paused. */
15506 if (NILP (w
->window_end_valid
))
15509 /* Can't use this if highlighting a region because a cursor movement
15510 will do more than just set the cursor. */
15511 if (!NILP (Vtransient_mark_mode
)
15512 && !NILP (BVAR (current_buffer
, mark_active
)))
15515 /* Likewise if highlighting trailing whitespace. */
15516 if (!NILP (Vshow_trailing_whitespace
))
15519 /* Likewise if showing a region. */
15520 if (!NILP (w
->region_showing
))
15523 /* Can't use this if overlay arrow position and/or string have
15525 if (overlay_arrows_changed_p ())
15528 /* When word-wrap is on, adding a space to the first word of a
15529 wrapped line can change the wrap position, altering the line
15530 above it. It might be worthwhile to handle this more
15531 intelligently, but for now just redisplay from scratch. */
15532 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15535 /* Under bidi reordering, adding or deleting a character in the
15536 beginning of a paragraph, before the first strong directional
15537 character, can change the base direction of the paragraph (unless
15538 the buffer specifies a fixed paragraph direction), which will
15539 require to redisplay the whole paragraph. It might be worthwhile
15540 to find the paragraph limits and widen the range of redisplayed
15541 lines to that, but for now just give up this optimization and
15542 redisplay from scratch. */
15543 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15544 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15547 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15548 only if buffer has really changed. The reason is that the gap is
15549 initially at Z for freshly visited files. The code below would
15550 set end_unchanged to 0 in that case. */
15551 if (MODIFF
> SAVE_MODIFF
15552 /* This seems to happen sometimes after saving a buffer. */
15553 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15555 if (GPT
- BEG
< BEG_UNCHANGED
)
15556 BEG_UNCHANGED
= GPT
- BEG
;
15557 if (Z
- GPT
< END_UNCHANGED
)
15558 END_UNCHANGED
= Z
- GPT
;
15561 /* The position of the first and last character that has been changed. */
15562 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15563 last_changed_charpos
= Z
- END_UNCHANGED
;
15565 /* If window starts after a line end, and the last change is in
15566 front of that newline, then changes don't affect the display.
15567 This case happens with stealth-fontification. Note that although
15568 the display is unchanged, glyph positions in the matrix have to
15569 be adjusted, of course. */
15570 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15571 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15572 && ((last_changed_charpos
< CHARPOS (start
)
15573 && CHARPOS (start
) == BEGV
)
15574 || (last_changed_charpos
< CHARPOS (start
) - 1
15575 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15577 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15578 struct glyph_row
*r0
;
15580 /* Compute how many chars/bytes have been added to or removed
15581 from the buffer. */
15582 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15583 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15584 Z_delta
= Z
- Z_old
;
15585 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15587 /* Give up if PT is not in the window. Note that it already has
15588 been checked at the start of try_window_id that PT is not in
15589 front of the window start. */
15590 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15593 /* If window start is unchanged, we can reuse the whole matrix
15594 as is, after adjusting glyph positions. No need to compute
15595 the window end again, since its offset from Z hasn't changed. */
15596 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15597 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15598 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15599 /* PT must not be in a partially visible line. */
15600 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15601 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15603 /* Adjust positions in the glyph matrix. */
15604 if (Z_delta
|| Z_delta_bytes
)
15606 struct glyph_row
*r1
15607 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15608 increment_matrix_positions (w
->current_matrix
,
15609 MATRIX_ROW_VPOS (r0
, current_matrix
),
15610 MATRIX_ROW_VPOS (r1
, current_matrix
),
15611 Z_delta
, Z_delta_bytes
);
15614 /* Set the cursor. */
15615 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15617 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15624 /* Handle the case that changes are all below what is displayed in
15625 the window, and that PT is in the window. This shortcut cannot
15626 be taken if ZV is visible in the window, and text has been added
15627 there that is visible in the window. */
15628 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15629 /* ZV is not visible in the window, or there are no
15630 changes at ZV, actually. */
15631 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15632 || first_changed_charpos
== last_changed_charpos
))
15634 struct glyph_row
*r0
;
15636 /* Give up if PT is not in the window. Note that it already has
15637 been checked at the start of try_window_id that PT is not in
15638 front of the window start. */
15639 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15642 /* If window start is unchanged, we can reuse the whole matrix
15643 as is, without changing glyph positions since no text has
15644 been added/removed in front of the window end. */
15645 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15646 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15647 /* PT must not be in a partially visible line. */
15648 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15649 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15651 /* We have to compute the window end anew since text
15652 could have been added/removed after it. */
15654 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15655 w
->window_end_bytepos
15656 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15658 /* Set the cursor. */
15659 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15661 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15668 /* Give up if window start is in the changed area.
15670 The condition used to read
15672 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15674 but why that was tested escapes me at the moment. */
15675 if (CHARPOS (start
) >= first_changed_charpos
15676 && CHARPOS (start
) <= last_changed_charpos
)
15679 /* Check that window start agrees with the start of the first glyph
15680 row in its current matrix. Check this after we know the window
15681 start is not in changed text, otherwise positions would not be
15683 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15684 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15687 /* Give up if the window ends in strings. Overlay strings
15688 at the end are difficult to handle, so don't try. */
15689 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15690 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15693 /* Compute the position at which we have to start displaying new
15694 lines. Some of the lines at the top of the window might be
15695 reusable because they are not displaying changed text. Find the
15696 last row in W's current matrix not affected by changes at the
15697 start of current_buffer. Value is null if changes start in the
15698 first line of window. */
15699 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15700 if (last_unchanged_at_beg_row
)
15702 /* Avoid starting to display in the moddle of a character, a TAB
15703 for instance. This is easier than to set up the iterator
15704 exactly, and it's not a frequent case, so the additional
15705 effort wouldn't really pay off. */
15706 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15707 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15708 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15709 --last_unchanged_at_beg_row
;
15711 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15714 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15716 start_pos
= it
.current
.pos
;
15718 /* Start displaying new lines in the desired matrix at the same
15719 vpos we would use in the current matrix, i.e. below
15720 last_unchanged_at_beg_row. */
15721 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15723 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15724 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15726 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15730 /* There are no reusable lines at the start of the window.
15731 Start displaying in the first text line. */
15732 start_display (&it
, w
, start
);
15733 it
.vpos
= it
.first_vpos
;
15734 start_pos
= it
.current
.pos
;
15737 /* Find the first row that is not affected by changes at the end of
15738 the buffer. Value will be null if there is no unchanged row, in
15739 which case we must redisplay to the end of the window. delta
15740 will be set to the value by which buffer positions beginning with
15741 first_unchanged_at_end_row have to be adjusted due to text
15743 first_unchanged_at_end_row
15744 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15745 IF_DEBUG (debug_delta
= delta
);
15746 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15748 /* Set stop_pos to the buffer position up to which we will have to
15749 display new lines. If first_unchanged_at_end_row != NULL, this
15750 is the buffer position of the start of the line displayed in that
15751 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15752 that we don't stop at a buffer position. */
15754 if (first_unchanged_at_end_row
)
15756 xassert (last_unchanged_at_beg_row
== NULL
15757 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15759 /* If this is a continuation line, move forward to the next one
15760 that isn't. Changes in lines above affect this line.
15761 Caution: this may move first_unchanged_at_end_row to a row
15762 not displaying text. */
15763 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15764 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15765 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15766 < it
.last_visible_y
))
15767 ++first_unchanged_at_end_row
;
15769 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15770 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15771 >= it
.last_visible_y
))
15772 first_unchanged_at_end_row
= NULL
;
15775 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15777 first_unchanged_at_end_vpos
15778 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15779 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15782 else if (last_unchanged_at_beg_row
== NULL
)
15788 /* Either there is no unchanged row at the end, or the one we have
15789 now displays text. This is a necessary condition for the window
15790 end pos calculation at the end of this function. */
15791 xassert (first_unchanged_at_end_row
== NULL
15792 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15794 debug_last_unchanged_at_beg_vpos
15795 = (last_unchanged_at_beg_row
15796 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15798 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15800 #endif /* GLYPH_DEBUG != 0 */
15803 /* Display new lines. Set last_text_row to the last new line
15804 displayed which has text on it, i.e. might end up as being the
15805 line where the window_end_vpos is. */
15806 w
->cursor
.vpos
= -1;
15807 last_text_row
= NULL
;
15808 overlay_arrow_seen
= 0;
15809 while (it
.current_y
< it
.last_visible_y
15810 && !fonts_changed_p
15811 && (first_unchanged_at_end_row
== NULL
15812 || IT_CHARPOS (it
) < stop_pos
))
15814 if (display_line (&it
))
15815 last_text_row
= it
.glyph_row
- 1;
15818 if (fonts_changed_p
)
15822 /* Compute differences in buffer positions, y-positions etc. for
15823 lines reused at the bottom of the window. Compute what we can
15825 if (first_unchanged_at_end_row
15826 /* No lines reused because we displayed everything up to the
15827 bottom of the window. */
15828 && it
.current_y
< it
.last_visible_y
)
15831 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15833 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15834 run
.current_y
= first_unchanged_at_end_row
->y
;
15835 run
.desired_y
= run
.current_y
+ dy
;
15836 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15840 delta
= delta_bytes
= dvpos
= dy
15841 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15842 first_unchanged_at_end_row
= NULL
;
15844 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15847 /* Find the cursor if not already found. We have to decide whether
15848 PT will appear on this window (it sometimes doesn't, but this is
15849 not a very frequent case.) This decision has to be made before
15850 the current matrix is altered. A value of cursor.vpos < 0 means
15851 that PT is either in one of the lines beginning at
15852 first_unchanged_at_end_row or below the window. Don't care for
15853 lines that might be displayed later at the window end; as
15854 mentioned, this is not a frequent case. */
15855 if (w
->cursor
.vpos
< 0)
15857 /* Cursor in unchanged rows at the top? */
15858 if (PT
< CHARPOS (start_pos
)
15859 && last_unchanged_at_beg_row
)
15861 row
= row_containing_pos (w
, PT
,
15862 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15863 last_unchanged_at_beg_row
+ 1, 0);
15865 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15868 /* Start from first_unchanged_at_end_row looking for PT. */
15869 else if (first_unchanged_at_end_row
)
15871 row
= row_containing_pos (w
, PT
- delta
,
15872 first_unchanged_at_end_row
, NULL
, 0);
15874 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15875 delta_bytes
, dy
, dvpos
);
15878 /* Give up if cursor was not found. */
15879 if (w
->cursor
.vpos
< 0)
15881 clear_glyph_matrix (w
->desired_matrix
);
15886 /* Don't let the cursor end in the scroll margins. */
15888 int this_scroll_margin
, cursor_height
;
15890 this_scroll_margin
= max (0, scroll_margin
);
15891 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15892 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15893 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15895 if ((w
->cursor
.y
< this_scroll_margin
15896 && CHARPOS (start
) > BEGV
)
15897 /* Old redisplay didn't take scroll margin into account at the bottom,
15898 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15899 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15900 ? cursor_height
+ this_scroll_margin
15901 : 1)) > it
.last_visible_y
)
15903 w
->cursor
.vpos
= -1;
15904 clear_glyph_matrix (w
->desired_matrix
);
15909 /* Scroll the display. Do it before changing the current matrix so
15910 that xterm.c doesn't get confused about where the cursor glyph is
15912 if (dy
&& run
.height
)
15916 if (FRAME_WINDOW_P (f
))
15918 FRAME_RIF (f
)->update_window_begin_hook (w
);
15919 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15920 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15921 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15925 /* Terminal frame. In this case, dvpos gives the number of
15926 lines to scroll by; dvpos < 0 means scroll up. */
15928 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15929 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
15930 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15931 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15932 + window_internal_height (w
));
15934 #if defined (HAVE_GPM) || defined (MSDOS)
15935 x_clear_window_mouse_face (w
);
15937 /* Perform the operation on the screen. */
15940 /* Scroll last_unchanged_at_beg_row to the end of the
15941 window down dvpos lines. */
15942 set_terminal_window (f
, end
);
15944 /* On dumb terminals delete dvpos lines at the end
15945 before inserting dvpos empty lines. */
15946 if (!FRAME_SCROLL_REGION_OK (f
))
15947 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15949 /* Insert dvpos empty lines in front of
15950 last_unchanged_at_beg_row. */
15951 ins_del_lines (f
, from
, dvpos
);
15953 else if (dvpos
< 0)
15955 /* Scroll up last_unchanged_at_beg_vpos to the end of
15956 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15957 set_terminal_window (f
, end
);
15959 /* Delete dvpos lines in front of
15960 last_unchanged_at_beg_vpos. ins_del_lines will set
15961 the cursor to the given vpos and emit |dvpos| delete
15963 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15965 /* On a dumb terminal insert dvpos empty lines at the
15967 if (!FRAME_SCROLL_REGION_OK (f
))
15968 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15971 set_terminal_window (f
, 0);
15977 /* Shift reused rows of the current matrix to the right position.
15978 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15980 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15981 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15984 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15985 bottom_vpos
, dvpos
);
15986 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15989 else if (dvpos
> 0)
15991 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15992 bottom_vpos
, dvpos
);
15993 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15994 first_unchanged_at_end_vpos
+ dvpos
, 0);
15997 /* For frame-based redisplay, make sure that current frame and window
15998 matrix are in sync with respect to glyph memory. */
15999 if (!FRAME_WINDOW_P (f
))
16000 sync_frame_with_window_matrix_rows (w
);
16002 /* Adjust buffer positions in reused rows. */
16003 if (delta
|| delta_bytes
)
16004 increment_matrix_positions (current_matrix
,
16005 first_unchanged_at_end_vpos
+ dvpos
,
16006 bottom_vpos
, delta
, delta_bytes
);
16008 /* Adjust Y positions. */
16010 shift_glyph_matrix (w
, current_matrix
,
16011 first_unchanged_at_end_vpos
+ dvpos
,
16014 if (first_unchanged_at_end_row
)
16016 first_unchanged_at_end_row
+= dvpos
;
16017 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16018 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16019 first_unchanged_at_end_row
= NULL
;
16022 /* If scrolling up, there may be some lines to display at the end of
16024 last_text_row_at_end
= NULL
;
16027 /* Scrolling up can leave for example a partially visible line
16028 at the end of the window to be redisplayed. */
16029 /* Set last_row to the glyph row in the current matrix where the
16030 window end line is found. It has been moved up or down in
16031 the matrix by dvpos. */
16032 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16033 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16035 /* If last_row is the window end line, it should display text. */
16036 xassert (last_row
->displays_text_p
);
16038 /* If window end line was partially visible before, begin
16039 displaying at that line. Otherwise begin displaying with the
16040 line following it. */
16041 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16043 init_to_row_start (&it
, w
, last_row
);
16044 it
.vpos
= last_vpos
;
16045 it
.current_y
= last_row
->y
;
16049 init_to_row_end (&it
, w
, last_row
);
16050 it
.vpos
= 1 + last_vpos
;
16051 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16055 /* We may start in a continuation line. If so, we have to
16056 get the right continuation_lines_width and current_x. */
16057 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16058 it
.hpos
= it
.current_x
= 0;
16060 /* Display the rest of the lines at the window end. */
16061 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16062 while (it
.current_y
< it
.last_visible_y
16063 && !fonts_changed_p
)
16065 /* Is it always sure that the display agrees with lines in
16066 the current matrix? I don't think so, so we mark rows
16067 displayed invalid in the current matrix by setting their
16068 enabled_p flag to zero. */
16069 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16070 if (display_line (&it
))
16071 last_text_row_at_end
= it
.glyph_row
- 1;
16075 /* Update window_end_pos and window_end_vpos. */
16076 if (first_unchanged_at_end_row
16077 && !last_text_row_at_end
)
16079 /* Window end line if one of the preserved rows from the current
16080 matrix. Set row to the last row displaying text in current
16081 matrix starting at first_unchanged_at_end_row, after
16083 xassert (first_unchanged_at_end_row
->displays_text_p
);
16084 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16085 first_unchanged_at_end_row
);
16086 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16088 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16089 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16091 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16092 xassert (w
->window_end_bytepos
>= 0);
16093 IF_DEBUG (debug_method_add (w
, "A"));
16095 else if (last_text_row_at_end
)
16098 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16099 w
->window_end_bytepos
16100 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16102 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16103 xassert (w
->window_end_bytepos
>= 0);
16104 IF_DEBUG (debug_method_add (w
, "B"));
16106 else if (last_text_row
)
16108 /* We have displayed either to the end of the window or at the
16109 end of the window, i.e. the last row with text is to be found
16110 in the desired matrix. */
16112 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16113 w
->window_end_bytepos
16114 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16116 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16117 xassert (w
->window_end_bytepos
>= 0);
16119 else if (first_unchanged_at_end_row
== NULL
16120 && last_text_row
== NULL
16121 && last_text_row_at_end
== NULL
)
16123 /* Displayed to end of window, but no line containing text was
16124 displayed. Lines were deleted at the end of the window. */
16125 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16126 int vpos
= XFASTINT (w
->window_end_vpos
);
16127 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16128 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16131 row
== NULL
&& vpos
>= first_vpos
;
16132 --vpos
, --current_row
, --desired_row
)
16134 if (desired_row
->enabled_p
)
16136 if (desired_row
->displays_text_p
)
16139 else if (current_row
->displays_text_p
)
16143 xassert (row
!= NULL
);
16144 w
->window_end_vpos
= make_number (vpos
+ 1);
16145 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16146 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16147 xassert (w
->window_end_bytepos
>= 0);
16148 IF_DEBUG (debug_method_add (w
, "C"));
16153 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16154 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16156 /* Record that display has not been completed. */
16157 w
->window_end_valid
= Qnil
;
16158 w
->desired_matrix
->no_scrolling_p
= 1;
16166 /***********************************************************************
16167 More debugging support
16168 ***********************************************************************/
16172 void dump_glyph_row (struct glyph_row
*, int, int);
16173 void dump_glyph_matrix (struct glyph_matrix
*, int);
16174 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16177 /* Dump the contents of glyph matrix MATRIX on stderr.
16179 GLYPHS 0 means don't show glyph contents.
16180 GLYPHS 1 means show glyphs in short form
16181 GLYPHS > 1 means show glyphs in long form. */
16184 dump_glyph_matrix (matrix
, glyphs
)
16185 struct glyph_matrix
*matrix
;
16189 for (i
= 0; i
< matrix
->nrows
; ++i
)
16190 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16194 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16195 the glyph row and area where the glyph comes from. */
16198 dump_glyph (row
, glyph
, area
)
16199 struct glyph_row
*row
;
16200 struct glyph
*glyph
;
16203 if (glyph
->type
== CHAR_GLYPH
)
16206 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16207 glyph
- row
->glyphs
[TEXT_AREA
],
16210 (BUFFERP (glyph
->object
)
16212 : (STRINGP (glyph
->object
)
16215 glyph
->pixel_width
,
16217 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16221 glyph
->left_box_line_p
,
16222 glyph
->right_box_line_p
);
16224 else if (glyph
->type
== STRETCH_GLYPH
)
16227 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16228 glyph
- row
->glyphs
[TEXT_AREA
],
16231 (BUFFERP (glyph
->object
)
16233 : (STRINGP (glyph
->object
)
16236 glyph
->pixel_width
,
16240 glyph
->left_box_line_p
,
16241 glyph
->right_box_line_p
);
16243 else if (glyph
->type
== IMAGE_GLYPH
)
16246 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16247 glyph
- row
->glyphs
[TEXT_AREA
],
16250 (BUFFERP (glyph
->object
)
16252 : (STRINGP (glyph
->object
)
16255 glyph
->pixel_width
,
16259 glyph
->left_box_line_p
,
16260 glyph
->right_box_line_p
);
16262 else if (glyph
->type
== COMPOSITE_GLYPH
)
16265 " %5d %4c %6d %c %3d 0x%05x",
16266 glyph
- row
->glyphs
[TEXT_AREA
],
16269 (BUFFERP (glyph
->object
)
16271 : (STRINGP (glyph
->object
)
16274 glyph
->pixel_width
,
16276 if (glyph
->u
.cmp
.automatic
)
16279 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16280 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16282 glyph
->left_box_line_p
,
16283 glyph
->right_box_line_p
);
16288 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16289 GLYPHS 0 means don't show glyph contents.
16290 GLYPHS 1 means show glyphs in short form
16291 GLYPHS > 1 means show glyphs in long form. */
16294 dump_glyph_row (row
, vpos
, glyphs
)
16295 struct glyph_row
*row
;
16300 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16301 fprintf (stderr
, "======================================================================\n");
16303 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16304 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16306 MATRIX_ROW_START_CHARPOS (row
),
16307 MATRIX_ROW_END_CHARPOS (row
),
16308 row
->used
[TEXT_AREA
],
16309 row
->contains_overlapping_glyphs_p
,
16311 row
->truncated_on_left_p
,
16312 row
->truncated_on_right_p
,
16314 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16315 row
->displays_text_p
,
16318 row
->ends_in_middle_of_char_p
,
16319 row
->starts_in_middle_of_char_p
,
16325 row
->visible_height
,
16328 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16329 row
->end
.overlay_string_index
,
16330 row
->continuation_lines_width
);
16331 fprintf (stderr
, "%9d %5d\n",
16332 CHARPOS (row
->start
.string_pos
),
16333 CHARPOS (row
->end
.string_pos
));
16334 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16335 row
->end
.dpvec_index
);
16342 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16344 struct glyph
*glyph
= row
->glyphs
[area
];
16345 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16347 /* Glyph for a line end in text. */
16348 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16351 if (glyph
< glyph_end
)
16352 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16354 for (; glyph
< glyph_end
; ++glyph
)
16355 dump_glyph (row
, glyph
, area
);
16358 else if (glyphs
== 1)
16362 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16364 char *s
= (char *) alloca (row
->used
[area
] + 1);
16367 for (i
= 0; i
< row
->used
[area
]; ++i
)
16369 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16370 if (glyph
->type
== CHAR_GLYPH
16371 && glyph
->u
.ch
< 0x80
16372 && glyph
->u
.ch
>= ' ')
16373 s
[i
] = glyph
->u
.ch
;
16379 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16385 DEFUE ("dump-glyph-matrix", Fdump_glyph_matrix
,
16386 Sdump_glyph_matrix
, 0, 1, "p",
16387 doc
: /* Dump the current matrix of the selected window to stderr.
16388 Shows contents of glyph row structures. With non-nil
16389 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16390 glyphs in short form, otherwise show glyphs in long form. */)
16391 (Lisp_Object glyphs
)
16393 struct window
*w
= XWINDOW (selected_window
);
16394 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16396 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16397 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16398 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16399 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16400 fprintf (stderr
, "=============================================\n");
16401 dump_glyph_matrix (w
->current_matrix
,
16402 NILP (glyphs
) ? 0 : XINT (glyphs
));
16407 DEFUE ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16408 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16411 struct frame
*f
= XFRAME (selected_frame
);
16412 dump_glyph_matrix (f
->current_matrix
, 1);
16417 DEFUE ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16418 doc
: /* Dump glyph row ROW to stderr.
16419 GLYPH 0 means don't dump glyphs.
16420 GLYPH 1 means dump glyphs in short form.
16421 GLYPH > 1 or omitted means dump glyphs in long form. */)
16422 (Lisp_Object row
, Lisp_Object glyphs
)
16424 struct glyph_matrix
*matrix
;
16427 CHECK_NUMBER (row
);
16428 matrix
= XWINDOW (selected_window
)->current_matrix
;
16430 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16431 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16433 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16438 DEFUE ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16439 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16440 GLYPH 0 means don't dump glyphs.
16441 GLYPH 1 means dump glyphs in short form.
16442 GLYPH > 1 or omitted means dump glyphs in long form. */)
16443 (Lisp_Object row
, Lisp_Object glyphs
)
16445 struct frame
*sf
= SELECTED_FRAME ();
16446 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16449 CHECK_NUMBER (row
);
16451 if (vpos
>= 0 && vpos
< m
->nrows
)
16452 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16453 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16458 DEFUE ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16459 doc
: /* Toggle tracing of redisplay.
16460 With ARG, turn tracing on if and only if ARG is positive. */)
16464 trace_redisplay_p
= !trace_redisplay_p
;
16467 arg
= Fprefix_numeric_value (arg
);
16468 trace_redisplay_p
= XINT (arg
) > 0;
16475 DEFUE ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16476 doc
: /* Like `format', but print result to stderr.
16477 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16478 (size_t nargs
, Lisp_Object
*args
)
16480 Lisp_Object s
= Fformat (nargs
, args
);
16481 fprintf (stderr
, "%s", SDATA (s
));
16485 #endif /* GLYPH_DEBUG */
16489 /***********************************************************************
16490 Building Desired Matrix Rows
16491 ***********************************************************************/
16493 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16494 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16496 static struct glyph_row
*
16497 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16499 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16500 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16501 struct buffer
*old
= current_buffer
;
16502 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16503 int arrow_len
= SCHARS (overlay_arrow_string
);
16504 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16505 const unsigned char *p
;
16508 int n_glyphs_before
;
16510 set_buffer_temp (buffer
);
16511 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16512 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16513 SET_TEXT_POS (it
.position
, 0, 0);
16515 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16517 while (p
< arrow_end
)
16519 Lisp_Object face
, ilisp
;
16521 /* Get the next character. */
16523 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16526 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16527 if (! ASCII_CHAR_P (it
.c
))
16528 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16532 /* Get its face. */
16533 ilisp
= make_number (p
- arrow_string
);
16534 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16535 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16537 /* Compute its width, get its glyphs. */
16538 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16539 SET_TEXT_POS (it
.position
, -1, -1);
16540 PRODUCE_GLYPHS (&it
);
16542 /* If this character doesn't fit any more in the line, we have
16543 to remove some glyphs. */
16544 if (it
.current_x
> it
.last_visible_x
)
16546 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16551 set_buffer_temp (old
);
16552 return it
.glyph_row
;
16556 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16557 glyphs are only inserted for terminal frames since we can't really
16558 win with truncation glyphs when partially visible glyphs are
16559 involved. Which glyphs to insert is determined by
16560 produce_special_glyphs. */
16563 insert_left_trunc_glyphs (struct it
*it
)
16565 struct it truncate_it
;
16566 struct glyph
*from
, *end
, *to
, *toend
;
16568 xassert (!FRAME_WINDOW_P (it
->f
));
16570 /* Get the truncation glyphs. */
16572 truncate_it
.current_x
= 0;
16573 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16574 truncate_it
.glyph_row
= &scratch_glyph_row
;
16575 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16576 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16577 truncate_it
.object
= make_number (0);
16578 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16580 /* Overwrite glyphs from IT with truncation glyphs. */
16581 if (!it
->glyph_row
->reversed_p
)
16583 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16584 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16585 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16586 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16591 /* There may be padding glyphs left over. Overwrite them too. */
16592 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16594 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16600 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16604 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16605 that back to front. */
16606 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16607 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16608 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16609 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16611 while (from
>= end
&& to
>= toend
)
16613 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16616 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16617 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16618 while (from
>= end
&& to
>= toend
)
16623 /* Need to free some room before prepending additional
16625 int move_by
= from
- end
+ 1;
16626 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16627 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16629 for ( ; g
>= g0
; g
--)
16631 while (from
>= end
)
16633 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16639 /* Compute the pixel height and width of IT->glyph_row.
16641 Most of the time, ascent and height of a display line will be equal
16642 to the max_ascent and max_height values of the display iterator
16643 structure. This is not the case if
16645 1. We hit ZV without displaying anything. In this case, max_ascent
16646 and max_height will be zero.
16648 2. We have some glyphs that don't contribute to the line height.
16649 (The glyph row flag contributes_to_line_height_p is for future
16650 pixmap extensions).
16652 The first case is easily covered by using default values because in
16653 these cases, the line height does not really matter, except that it
16654 must not be zero. */
16657 compute_line_metrics (struct it
*it
)
16659 struct glyph_row
*row
= it
->glyph_row
;
16661 if (FRAME_WINDOW_P (it
->f
))
16663 int i
, min_y
, max_y
;
16665 /* The line may consist of one space only, that was added to
16666 place the cursor on it. If so, the row's height hasn't been
16668 if (row
->height
== 0)
16670 if (it
->max_ascent
+ it
->max_descent
== 0)
16671 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16672 row
->ascent
= it
->max_ascent
;
16673 row
->height
= it
->max_ascent
+ it
->max_descent
;
16674 row
->phys_ascent
= it
->max_phys_ascent
;
16675 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16676 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16679 /* Compute the width of this line. */
16680 row
->pixel_width
= row
->x
;
16681 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16682 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16684 xassert (row
->pixel_width
>= 0);
16685 xassert (row
->ascent
>= 0 && row
->height
> 0);
16687 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16688 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16690 /* If first line's physical ascent is larger than its logical
16691 ascent, use the physical ascent, and make the row taller.
16692 This makes accented characters fully visible. */
16693 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16694 && row
->phys_ascent
> row
->ascent
)
16696 row
->height
+= row
->phys_ascent
- row
->ascent
;
16697 row
->ascent
= row
->phys_ascent
;
16700 /* Compute how much of the line is visible. */
16701 row
->visible_height
= row
->height
;
16703 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16704 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16706 if (row
->y
< min_y
)
16707 row
->visible_height
-= min_y
- row
->y
;
16708 if (row
->y
+ row
->height
> max_y
)
16709 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16713 row
->pixel_width
= row
->used
[TEXT_AREA
];
16714 if (row
->continued_p
)
16715 row
->pixel_width
-= it
->continuation_pixel_width
;
16716 else if (row
->truncated_on_right_p
)
16717 row
->pixel_width
-= it
->truncation_pixel_width
;
16718 row
->ascent
= row
->phys_ascent
= 0;
16719 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16720 row
->extra_line_spacing
= 0;
16723 /* Compute a hash code for this row. */
16727 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16728 for (i
= 0; i
< row
->used
[area
]; ++i
)
16729 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16730 + row
->glyphs
[area
][i
].u
.val
16731 + row
->glyphs
[area
][i
].face_id
16732 + row
->glyphs
[area
][i
].padding_p
16733 + (row
->glyphs
[area
][i
].type
<< 2));
16736 it
->max_ascent
= it
->max_descent
= 0;
16737 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16741 /* Append one space to the glyph row of iterator IT if doing a
16742 window-based redisplay. The space has the same face as
16743 IT->face_id. Value is non-zero if a space was added.
16745 This function is called to make sure that there is always one glyph
16746 at the end of a glyph row that the cursor can be set on under
16747 window-systems. (If there weren't such a glyph we would not know
16748 how wide and tall a box cursor should be displayed).
16750 At the same time this space let's a nicely handle clearing to the
16751 end of the line if the row ends in italic text. */
16754 append_space_for_newline (struct it
*it
, int default_face_p
)
16756 if (FRAME_WINDOW_P (it
->f
))
16758 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16760 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16761 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16763 /* Save some values that must not be changed.
16764 Must save IT->c and IT->len because otherwise
16765 ITERATOR_AT_END_P wouldn't work anymore after
16766 append_space_for_newline has been called. */
16767 enum display_element_type saved_what
= it
->what
;
16768 int saved_c
= it
->c
, saved_len
= it
->len
;
16769 int saved_char_to_display
= it
->char_to_display
;
16770 int saved_x
= it
->current_x
;
16771 int saved_face_id
= it
->face_id
;
16772 struct text_pos saved_pos
;
16773 Lisp_Object saved_object
;
16776 saved_object
= it
->object
;
16777 saved_pos
= it
->position
;
16779 it
->what
= IT_CHARACTER
;
16780 memset (&it
->position
, 0, sizeof it
->position
);
16781 it
->object
= make_number (0);
16782 it
->c
= it
->char_to_display
= ' ';
16785 if (default_face_p
)
16786 it
->face_id
= DEFAULT_FACE_ID
;
16787 else if (it
->face_before_selective_p
)
16788 it
->face_id
= it
->saved_face_id
;
16789 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16790 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16792 PRODUCE_GLYPHS (it
);
16794 it
->override_ascent
= -1;
16795 it
->constrain_row_ascent_descent_p
= 0;
16796 it
->current_x
= saved_x
;
16797 it
->object
= saved_object
;
16798 it
->position
= saved_pos
;
16799 it
->what
= saved_what
;
16800 it
->face_id
= saved_face_id
;
16801 it
->len
= saved_len
;
16803 it
->char_to_display
= saved_char_to_display
;
16812 /* Extend the face of the last glyph in the text area of IT->glyph_row
16813 to the end of the display line. Called from display_line. If the
16814 glyph row is empty, add a space glyph to it so that we know the
16815 face to draw. Set the glyph row flag fill_line_p. If the glyph
16816 row is R2L, prepend a stretch glyph to cover the empty space to the
16817 left of the leftmost glyph. */
16820 extend_face_to_end_of_line (struct it
*it
)
16823 struct frame
*f
= it
->f
;
16825 /* If line is already filled, do nothing. Non window-system frames
16826 get a grace of one more ``pixel'' because their characters are
16827 1-``pixel'' wide, so they hit the equality too early. This grace
16828 is needed only for R2L rows that are not continued, to produce
16829 one extra blank where we could display the cursor. */
16830 if (it
->current_x
>= it
->last_visible_x
16831 + (!FRAME_WINDOW_P (f
)
16832 && it
->glyph_row
->reversed_p
16833 && !it
->glyph_row
->continued_p
))
16836 /* Face extension extends the background and box of IT->face_id
16837 to the end of the line. If the background equals the background
16838 of the frame, we don't have to do anything. */
16839 if (it
->face_before_selective_p
)
16840 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16842 face
= FACE_FROM_ID (f
, it
->face_id
);
16844 if (FRAME_WINDOW_P (f
)
16845 && it
->glyph_row
->displays_text_p
16846 && face
->box
== FACE_NO_BOX
16847 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16849 && !it
->glyph_row
->reversed_p
)
16852 /* Set the glyph row flag indicating that the face of the last glyph
16853 in the text area has to be drawn to the end of the text area. */
16854 it
->glyph_row
->fill_line_p
= 1;
16856 /* If current character of IT is not ASCII, make sure we have the
16857 ASCII face. This will be automatically undone the next time
16858 get_next_display_element returns a multibyte character. Note
16859 that the character will always be single byte in unibyte
16861 if (!ASCII_CHAR_P (it
->c
))
16863 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16866 if (FRAME_WINDOW_P (f
))
16868 /* If the row is empty, add a space with the current face of IT,
16869 so that we know which face to draw. */
16870 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16872 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16873 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16874 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16876 #ifdef HAVE_WINDOW_SYSTEM
16877 if (it
->glyph_row
->reversed_p
)
16879 /* Prepend a stretch glyph to the row, such that the
16880 rightmost glyph will be drawn flushed all the way to the
16881 right margin of the window. The stretch glyph that will
16882 occupy the empty space, if any, to the left of the
16884 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16885 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16886 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16888 int row_width
, stretch_ascent
, stretch_width
;
16889 struct text_pos saved_pos
;
16890 int saved_face_id
, saved_avoid_cursor
;
16892 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16893 row_width
+= g
->pixel_width
;
16894 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16895 if (stretch_width
> 0)
16898 (((it
->ascent
+ it
->descent
)
16899 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16900 saved_pos
= it
->position
;
16901 memset (&it
->position
, 0, sizeof it
->position
);
16902 saved_avoid_cursor
= it
->avoid_cursor_p
;
16903 it
->avoid_cursor_p
= 1;
16904 saved_face_id
= it
->face_id
;
16905 /* The last row's stretch glyph should get the default
16906 face, to avoid painting the rest of the window with
16907 the region face, if the region ends at ZV. */
16908 if (it
->glyph_row
->ends_at_zv_p
)
16909 it
->face_id
= DEFAULT_FACE_ID
;
16911 it
->face_id
= face
->id
;
16912 append_stretch_glyph (it
, make_number (0), stretch_width
,
16913 it
->ascent
+ it
->descent
, stretch_ascent
);
16914 it
->position
= saved_pos
;
16915 it
->avoid_cursor_p
= saved_avoid_cursor
;
16916 it
->face_id
= saved_face_id
;
16919 #endif /* HAVE_WINDOW_SYSTEM */
16923 /* Save some values that must not be changed. */
16924 int saved_x
= it
->current_x
;
16925 struct text_pos saved_pos
;
16926 Lisp_Object saved_object
;
16927 enum display_element_type saved_what
= it
->what
;
16928 int saved_face_id
= it
->face_id
;
16930 saved_object
= it
->object
;
16931 saved_pos
= it
->position
;
16933 it
->what
= IT_CHARACTER
;
16934 memset (&it
->position
, 0, sizeof it
->position
);
16935 it
->object
= make_number (0);
16936 it
->c
= it
->char_to_display
= ' ';
16938 /* The last row's blank glyphs should get the default face, to
16939 avoid painting the rest of the window with the region face,
16940 if the region ends at ZV. */
16941 if (it
->glyph_row
->ends_at_zv_p
)
16942 it
->face_id
= DEFAULT_FACE_ID
;
16944 it
->face_id
= face
->id
;
16946 PRODUCE_GLYPHS (it
);
16948 while (it
->current_x
<= it
->last_visible_x
)
16949 PRODUCE_GLYPHS (it
);
16951 /* Don't count these blanks really. It would let us insert a left
16952 truncation glyph below and make us set the cursor on them, maybe. */
16953 it
->current_x
= saved_x
;
16954 it
->object
= saved_object
;
16955 it
->position
= saved_pos
;
16956 it
->what
= saved_what
;
16957 it
->face_id
= saved_face_id
;
16962 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16963 trailing whitespace. */
16966 trailing_whitespace_p (EMACS_INT charpos
)
16968 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16971 while (bytepos
< ZV_BYTE
16972 && (c
= FETCH_CHAR (bytepos
),
16973 c
== ' ' || c
== '\t'))
16976 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16978 if (bytepos
!= PT_BYTE
)
16985 /* Highlight trailing whitespace, if any, in ROW. */
16988 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16990 int used
= row
->used
[TEXT_AREA
];
16994 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16995 struct glyph
*glyph
= start
+ used
- 1;
16997 if (row
->reversed_p
)
16999 /* Right-to-left rows need to be processed in the opposite
17000 direction, so swap the edge pointers. */
17002 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17005 /* Skip over glyphs inserted to display the cursor at the
17006 end of a line, for extending the face of the last glyph
17007 to the end of the line on terminals, and for truncation
17008 and continuation glyphs. */
17009 if (!row
->reversed_p
)
17011 while (glyph
>= start
17012 && glyph
->type
== CHAR_GLYPH
17013 && INTEGERP (glyph
->object
))
17018 while (glyph
<= start
17019 && glyph
->type
== CHAR_GLYPH
17020 && INTEGERP (glyph
->object
))
17024 /* If last glyph is a space or stretch, and it's trailing
17025 whitespace, set the face of all trailing whitespace glyphs in
17026 IT->glyph_row to `trailing-whitespace'. */
17027 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17028 && BUFFERP (glyph
->object
)
17029 && (glyph
->type
== STRETCH_GLYPH
17030 || (glyph
->type
== CHAR_GLYPH
17031 && glyph
->u
.ch
== ' '))
17032 && trailing_whitespace_p (glyph
->charpos
))
17034 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17038 if (!row
->reversed_p
)
17040 while (glyph
>= start
17041 && BUFFERP (glyph
->object
)
17042 && (glyph
->type
== STRETCH_GLYPH
17043 || (glyph
->type
== CHAR_GLYPH
17044 && glyph
->u
.ch
== ' ')))
17045 (glyph
--)->face_id
= face_id
;
17049 while (glyph
<= start
17050 && BUFFERP (glyph
->object
)
17051 && (glyph
->type
== STRETCH_GLYPH
17052 || (glyph
->type
== CHAR_GLYPH
17053 && glyph
->u
.ch
== ' ')))
17054 (glyph
++)->face_id
= face_id
;
17061 /* Value is non-zero if glyph row ROW should be
17062 used to hold the cursor. */
17065 cursor_row_p (struct glyph_row
*row
)
17069 if (PT
== CHARPOS (row
->end
.pos
))
17071 /* Suppose the row ends on a string.
17072 Unless the row is continued, that means it ends on a newline
17073 in the string. If it's anything other than a display string
17074 (e.g. a before-string from an overlay), we don't want the
17075 cursor there. (This heuristic seems to give the optimal
17076 behavior for the various types of multi-line strings.) */
17077 if (CHARPOS (row
->end
.string_pos
) >= 0)
17079 if (row
->continued_p
)
17083 /* Check for `display' property. */
17084 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17085 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17086 struct glyph
*glyph
;
17089 for (glyph
= end
; glyph
>= beg
; --glyph
)
17090 if (STRINGP (glyph
->object
))
17093 = Fget_char_property (make_number (PT
),
17097 && display_prop_string_p (prop
, glyph
->object
));
17102 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17104 /* If the row ends in middle of a real character,
17105 and the line is continued, we want the cursor here.
17106 That's because CHARPOS (ROW->end.pos) would equal
17107 PT if PT is before the character. */
17108 if (!row
->ends_in_ellipsis_p
)
17109 result
= row
->continued_p
;
17111 /* If the row ends in an ellipsis, then
17112 CHARPOS (ROW->end.pos) will equal point after the
17113 invisible text. We want that position to be displayed
17114 after the ellipsis. */
17117 /* If the row ends at ZV, display the cursor at the end of that
17118 row instead of at the start of the row below. */
17119 else if (row
->ends_at_zv_p
)
17130 /* Push the display property PROP so that it will be rendered at the
17131 current position in IT. Return 1 if PROP was successfully pushed,
17135 push_display_prop (struct it
*it
, Lisp_Object prop
)
17139 if (STRINGP (prop
))
17141 if (SCHARS (prop
) == 0)
17148 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17149 it
->current
.overlay_string_index
= -1;
17150 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17151 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17152 it
->method
= GET_FROM_STRING
;
17153 it
->stop_charpos
= 0;
17155 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17157 it
->method
= GET_FROM_STRETCH
;
17160 #ifdef HAVE_WINDOW_SYSTEM
17161 else if (IMAGEP (prop
))
17163 it
->what
= IT_IMAGE
;
17164 it
->image_id
= lookup_image (it
->f
, prop
);
17165 it
->method
= GET_FROM_IMAGE
;
17167 #endif /* HAVE_WINDOW_SYSTEM */
17170 pop_it (it
); /* bogus display property, give up */
17177 /* Return the character-property PROP at the current position in IT. */
17180 get_it_property (struct it
*it
, Lisp_Object prop
)
17182 Lisp_Object position
;
17184 if (STRINGP (it
->object
))
17185 position
= make_number (IT_STRING_CHARPOS (*it
));
17186 else if (BUFFERP (it
->object
))
17187 position
= make_number (IT_CHARPOS (*it
));
17191 return Fget_char_property (position
, prop
, it
->object
);
17194 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17197 handle_line_prefix (struct it
*it
)
17199 Lisp_Object prefix
;
17200 if (it
->continuation_lines_width
> 0)
17202 prefix
= get_it_property (it
, Qwrap_prefix
);
17204 prefix
= Vwrap_prefix
;
17208 prefix
= get_it_property (it
, Qline_prefix
);
17210 prefix
= Vline_prefix
;
17212 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17214 /* If the prefix is wider than the window, and we try to wrap
17215 it, it would acquire its own wrap prefix, and so on till the
17216 iterator stack overflows. So, don't wrap the prefix. */
17217 it
->line_wrap
= TRUNCATE
;
17218 it
->avoid_cursor_p
= 1;
17224 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17225 only for R2L lines from display_line, when it decides that too many
17226 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17229 unproduce_glyphs (struct it
*it
, int n
)
17231 struct glyph
*glyph
, *end
;
17233 xassert (it
->glyph_row
);
17234 xassert (it
->glyph_row
->reversed_p
);
17235 xassert (it
->area
== TEXT_AREA
);
17236 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17238 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17239 n
= it
->glyph_row
->used
[TEXT_AREA
];
17240 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17241 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17242 for ( ; glyph
< end
; glyph
++)
17243 glyph
[-n
] = *glyph
;
17246 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17247 and ROW->maxpos. */
17249 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17250 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17251 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17253 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17254 lines' rows is implemented for bidi-reordered rows. */
17256 /* ROW->minpos is the value of min_pos, the minimal buffer position
17259 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17261 /* We didn't find _any_ valid buffer positions in any of the
17262 glyphs, so we must trust the iterator's computed positions. */
17263 row
->minpos
= row
->start
.pos
;
17266 max_pos
= CHARPOS (it
->current
.pos
);
17267 max_bpos
= BYTEPOS (it
->current
.pos
);
17270 /* Here are the various use-cases for ending the row, and the
17271 corresponding values for ROW->maxpos:
17273 Line ends in a newline from buffer eol_pos + 1
17274 Line is continued from buffer max_pos + 1
17275 Line is truncated on right it->current.pos
17276 Line ends in a newline from string max_pos
17277 Line is continued from string max_pos
17278 Line is continued from display vector max_pos
17279 Line is entirely from a string min_pos == max_pos
17280 Line is entirely from a display vector min_pos == max_pos
17281 Line that ends at ZV ZV
17283 If you discover other use-cases, please add them here as
17285 if (row
->ends_at_zv_p
)
17286 row
->maxpos
= it
->current
.pos
;
17287 else if (row
->used
[TEXT_AREA
])
17289 if (row
->ends_in_newline_from_string_p
)
17290 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17291 else if (CHARPOS (it
->eol_pos
) > 0)
17292 SET_TEXT_POS (row
->maxpos
,
17293 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17294 else if (row
->continued_p
)
17296 /* If max_pos is different from IT's current position, it
17297 means IT->method does not belong to the display element
17298 at max_pos. However, it also means that the display
17299 element at max_pos was displayed in its entirety on this
17300 line, which is equivalent to saying that the next line
17301 starts at the next buffer position. */
17302 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17303 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17306 INC_BOTH (max_pos
, max_bpos
);
17307 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17310 else if (row
->truncated_on_right_p
)
17311 /* display_line already called reseat_at_next_visible_line_start,
17312 which puts the iterator at the beginning of the next line, in
17313 the logical order. */
17314 row
->maxpos
= it
->current
.pos
;
17315 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17316 /* A line that is entirely from a string/image/stretch... */
17317 row
->maxpos
= row
->minpos
;
17322 row
->maxpos
= it
->current
.pos
;
17325 /* Construct the glyph row IT->glyph_row in the desired matrix of
17326 IT->w from text at the current position of IT. See dispextern.h
17327 for an overview of struct it. Value is non-zero if
17328 IT->glyph_row displays text, as opposed to a line displaying ZV
17332 display_line (struct it
*it
)
17334 struct glyph_row
*row
= it
->glyph_row
;
17335 Lisp_Object overlay_arrow_string
;
17337 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17338 int wrap_row_used
= -1;
17339 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17340 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17341 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17342 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17343 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17345 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17346 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17348 /* We always start displaying at hpos zero even if hscrolled. */
17349 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17351 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17352 >= it
->w
->desired_matrix
->nrows
)
17354 it
->w
->nrows_scale_factor
++;
17355 fonts_changed_p
= 1;
17359 /* Is IT->w showing the region? */
17360 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17362 /* Clear the result glyph row and enable it. */
17363 prepare_desired_row (row
);
17365 row
->y
= it
->current_y
;
17366 row
->start
= it
->start
;
17367 row
->continuation_lines_width
= it
->continuation_lines_width
;
17368 row
->displays_text_p
= 1;
17369 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17370 it
->starts_in_middle_of_char_p
= 0;
17372 /* Arrange the overlays nicely for our purposes. Usually, we call
17373 display_line on only one line at a time, in which case this
17374 can't really hurt too much, or we call it on lines which appear
17375 one after another in the buffer, in which case all calls to
17376 recenter_overlay_lists but the first will be pretty cheap. */
17377 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17379 /* Move over display elements that are not visible because we are
17380 hscrolled. This may stop at an x-position < IT->first_visible_x
17381 if the first glyph is partially visible or if we hit a line end. */
17382 if (it
->current_x
< it
->first_visible_x
)
17384 this_line_min_pos
= row
->start
.pos
;
17385 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17386 MOVE_TO_POS
| MOVE_TO_X
);
17387 /* Record the smallest positions seen while we moved over
17388 display elements that are not visible. This is needed by
17389 redisplay_internal for optimizing the case where the cursor
17390 stays inside the same line. The rest of this function only
17391 considers positions that are actually displayed, so
17392 RECORD_MAX_MIN_POS will not otherwise record positions that
17393 are hscrolled to the left of the left edge of the window. */
17394 min_pos
= CHARPOS (this_line_min_pos
);
17395 min_bpos
= BYTEPOS (this_line_min_pos
);
17399 /* We only do this when not calling `move_it_in_display_line_to'
17400 above, because move_it_in_display_line_to calls
17401 handle_line_prefix itself. */
17402 handle_line_prefix (it
);
17405 /* Get the initial row height. This is either the height of the
17406 text hscrolled, if there is any, or zero. */
17407 row
->ascent
= it
->max_ascent
;
17408 row
->height
= it
->max_ascent
+ it
->max_descent
;
17409 row
->phys_ascent
= it
->max_phys_ascent
;
17410 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17411 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17413 /* Utility macro to record max and min buffer positions seen until now. */
17414 #define RECORD_MAX_MIN_POS(IT) \
17417 if (IT_CHARPOS (*(IT)) < min_pos) \
17419 min_pos = IT_CHARPOS (*(IT)); \
17420 min_bpos = IT_BYTEPOS (*(IT)); \
17422 if (IT_CHARPOS (*(IT)) > max_pos) \
17424 max_pos = IT_CHARPOS (*(IT)); \
17425 max_bpos = IT_BYTEPOS (*(IT)); \
17430 /* Loop generating characters. The loop is left with IT on the next
17431 character to display. */
17434 int n_glyphs_before
, hpos_before
, x_before
;
17436 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17438 /* Retrieve the next thing to display. Value is zero if end of
17440 if (!get_next_display_element (it
))
17442 /* Maybe add a space at the end of this line that is used to
17443 display the cursor there under X. Set the charpos of the
17444 first glyph of blank lines not corresponding to any text
17446 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17447 row
->exact_window_width_line_p
= 1;
17448 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17449 || row
->used
[TEXT_AREA
] == 0)
17451 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17452 row
->displays_text_p
= 0;
17454 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17455 && (!MINI_WINDOW_P (it
->w
)
17456 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17457 row
->indicate_empty_line_p
= 1;
17460 it
->continuation_lines_width
= 0;
17461 row
->ends_at_zv_p
= 1;
17462 /* A row that displays right-to-left text must always have
17463 its last face extended all the way to the end of line,
17464 even if this row ends in ZV, because we still write to
17465 the screen left to right. */
17466 if (row
->reversed_p
)
17467 extend_face_to_end_of_line (it
);
17471 /* Now, get the metrics of what we want to display. This also
17472 generates glyphs in `row' (which is IT->glyph_row). */
17473 n_glyphs_before
= row
->used
[TEXT_AREA
];
17476 /* Remember the line height so far in case the next element doesn't
17477 fit on the line. */
17478 if (it
->line_wrap
!= TRUNCATE
)
17480 ascent
= it
->max_ascent
;
17481 descent
= it
->max_descent
;
17482 phys_ascent
= it
->max_phys_ascent
;
17483 phys_descent
= it
->max_phys_descent
;
17485 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17487 if (IT_DISPLAYING_WHITESPACE (it
))
17493 wrap_row_used
= row
->used
[TEXT_AREA
];
17494 wrap_row_ascent
= row
->ascent
;
17495 wrap_row_height
= row
->height
;
17496 wrap_row_phys_ascent
= row
->phys_ascent
;
17497 wrap_row_phys_height
= row
->phys_height
;
17498 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17499 wrap_row_min_pos
= min_pos
;
17500 wrap_row_min_bpos
= min_bpos
;
17501 wrap_row_max_pos
= max_pos
;
17502 wrap_row_max_bpos
= max_bpos
;
17508 PRODUCE_GLYPHS (it
);
17510 /* If this display element was in marginal areas, continue with
17512 if (it
->area
!= TEXT_AREA
)
17514 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17515 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17516 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17517 row
->phys_height
= max (row
->phys_height
,
17518 it
->max_phys_ascent
+ it
->max_phys_descent
);
17519 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17520 it
->max_extra_line_spacing
);
17521 set_iterator_to_next (it
, 1);
17525 /* Does the display element fit on the line? If we truncate
17526 lines, we should draw past the right edge of the window. If
17527 we don't truncate, we want to stop so that we can display the
17528 continuation glyph before the right margin. If lines are
17529 continued, there are two possible strategies for characters
17530 resulting in more than 1 glyph (e.g. tabs): Display as many
17531 glyphs as possible in this line and leave the rest for the
17532 continuation line, or display the whole element in the next
17533 line. Original redisplay did the former, so we do it also. */
17534 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17535 hpos_before
= it
->hpos
;
17538 if (/* Not a newline. */
17540 /* Glyphs produced fit entirely in the line. */
17541 && it
->current_x
< it
->last_visible_x
)
17543 it
->hpos
+= nglyphs
;
17544 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17545 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17546 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17547 row
->phys_height
= max (row
->phys_height
,
17548 it
->max_phys_ascent
+ it
->max_phys_descent
);
17549 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17550 it
->max_extra_line_spacing
);
17551 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17552 row
->x
= x
- it
->first_visible_x
;
17553 /* Record the maximum and minimum buffer positions seen so
17554 far in glyphs that will be displayed by this row. */
17556 RECORD_MAX_MIN_POS (it
);
17561 struct glyph
*glyph
;
17563 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17565 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17566 new_x
= x
+ glyph
->pixel_width
;
17568 if (/* Lines are continued. */
17569 it
->line_wrap
!= TRUNCATE
17570 && (/* Glyph doesn't fit on the line. */
17571 new_x
> it
->last_visible_x
17572 /* Or it fits exactly on a window system frame. */
17573 || (new_x
== it
->last_visible_x
17574 && FRAME_WINDOW_P (it
->f
))))
17576 /* End of a continued line. */
17579 || (new_x
== it
->last_visible_x
17580 && FRAME_WINDOW_P (it
->f
)))
17582 /* Current glyph is the only one on the line or
17583 fits exactly on the line. We must continue
17584 the line because we can't draw the cursor
17585 after the glyph. */
17586 row
->continued_p
= 1;
17587 it
->current_x
= new_x
;
17588 it
->continuation_lines_width
+= new_x
;
17590 /* Record the maximum and minimum buffer
17591 positions seen so far in glyphs that will be
17592 displayed by this row. */
17594 RECORD_MAX_MIN_POS (it
);
17595 if (i
== nglyphs
- 1)
17597 /* If line-wrap is on, check if a previous
17598 wrap point was found. */
17599 if (wrap_row_used
> 0
17600 /* Even if there is a previous wrap
17601 point, continue the line here as
17602 usual, if (i) the previous character
17603 was a space or tab AND (ii) the
17604 current character is not. */
17606 || IT_DISPLAYING_WHITESPACE (it
)))
17609 set_iterator_to_next (it
, 1);
17610 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17612 if (!get_next_display_element (it
))
17614 row
->exact_window_width_line_p
= 1;
17615 it
->continuation_lines_width
= 0;
17616 row
->continued_p
= 0;
17617 row
->ends_at_zv_p
= 1;
17619 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17621 row
->continued_p
= 0;
17622 row
->exact_window_width_line_p
= 1;
17627 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17628 && !FRAME_WINDOW_P (it
->f
))
17630 /* A padding glyph that doesn't fit on this line.
17631 This means the whole character doesn't fit
17633 if (row
->reversed_p
)
17634 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17635 - n_glyphs_before
);
17636 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17638 /* Fill the rest of the row with continuation
17639 glyphs like in 20.x. */
17640 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17641 < row
->glyphs
[1 + TEXT_AREA
])
17642 produce_special_glyphs (it
, IT_CONTINUATION
);
17644 row
->continued_p
= 1;
17645 it
->current_x
= x_before
;
17646 it
->continuation_lines_width
+= x_before
;
17648 /* Restore the height to what it was before the
17649 element not fitting on the line. */
17650 it
->max_ascent
= ascent
;
17651 it
->max_descent
= descent
;
17652 it
->max_phys_ascent
= phys_ascent
;
17653 it
->max_phys_descent
= phys_descent
;
17655 else if (wrap_row_used
> 0)
17658 if (row
->reversed_p
)
17659 unproduce_glyphs (it
,
17660 row
->used
[TEXT_AREA
] - wrap_row_used
);
17662 it
->continuation_lines_width
+= wrap_x
;
17663 row
->used
[TEXT_AREA
] = wrap_row_used
;
17664 row
->ascent
= wrap_row_ascent
;
17665 row
->height
= wrap_row_height
;
17666 row
->phys_ascent
= wrap_row_phys_ascent
;
17667 row
->phys_height
= wrap_row_phys_height
;
17668 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17669 min_pos
= wrap_row_min_pos
;
17670 min_bpos
= wrap_row_min_bpos
;
17671 max_pos
= wrap_row_max_pos
;
17672 max_bpos
= wrap_row_max_bpos
;
17673 row
->continued_p
= 1;
17674 row
->ends_at_zv_p
= 0;
17675 row
->exact_window_width_line_p
= 0;
17676 it
->continuation_lines_width
+= x
;
17678 /* Make sure that a non-default face is extended
17679 up to the right margin of the window. */
17680 extend_face_to_end_of_line (it
);
17682 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17684 /* A TAB that extends past the right edge of the
17685 window. This produces a single glyph on
17686 window system frames. We leave the glyph in
17687 this row and let it fill the row, but don't
17688 consume the TAB. */
17689 it
->continuation_lines_width
+= it
->last_visible_x
;
17690 row
->ends_in_middle_of_char_p
= 1;
17691 row
->continued_p
= 1;
17692 glyph
->pixel_width
= it
->last_visible_x
- x
;
17693 it
->starts_in_middle_of_char_p
= 1;
17697 /* Something other than a TAB that draws past
17698 the right edge of the window. Restore
17699 positions to values before the element. */
17700 if (row
->reversed_p
)
17701 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17702 - (n_glyphs_before
+ i
));
17703 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17705 /* Display continuation glyphs. */
17706 if (!FRAME_WINDOW_P (it
->f
))
17707 produce_special_glyphs (it
, IT_CONTINUATION
);
17708 row
->continued_p
= 1;
17710 it
->current_x
= x_before
;
17711 it
->continuation_lines_width
+= x
;
17712 extend_face_to_end_of_line (it
);
17714 if (nglyphs
> 1 && i
> 0)
17716 row
->ends_in_middle_of_char_p
= 1;
17717 it
->starts_in_middle_of_char_p
= 1;
17720 /* Restore the height to what it was before the
17721 element not fitting on the line. */
17722 it
->max_ascent
= ascent
;
17723 it
->max_descent
= descent
;
17724 it
->max_phys_ascent
= phys_ascent
;
17725 it
->max_phys_descent
= phys_descent
;
17730 else if (new_x
> it
->first_visible_x
)
17732 /* Increment number of glyphs actually displayed. */
17735 /* Record the maximum and minimum buffer positions
17736 seen so far in glyphs that will be displayed by
17739 RECORD_MAX_MIN_POS (it
);
17741 if (x
< it
->first_visible_x
)
17742 /* Glyph is partially visible, i.e. row starts at
17743 negative X position. */
17744 row
->x
= x
- it
->first_visible_x
;
17748 /* Glyph is completely off the left margin of the
17749 window. This should not happen because of the
17750 move_it_in_display_line at the start of this
17751 function, unless the text display area of the
17752 window is empty. */
17753 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17757 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17758 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17759 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17760 row
->phys_height
= max (row
->phys_height
,
17761 it
->max_phys_ascent
+ it
->max_phys_descent
);
17762 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17763 it
->max_extra_line_spacing
);
17765 /* End of this display line if row is continued. */
17766 if (row
->continued_p
|| row
->ends_at_zv_p
)
17771 /* Is this a line end? If yes, we're also done, after making
17772 sure that a non-default face is extended up to the right
17773 margin of the window. */
17774 if (ITERATOR_AT_END_OF_LINE_P (it
))
17776 int used_before
= row
->used
[TEXT_AREA
];
17778 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17780 /* Add a space at the end of the line that is used to
17781 display the cursor there. */
17782 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17783 append_space_for_newline (it
, 0);
17785 /* Extend the face to the end of the line. */
17786 extend_face_to_end_of_line (it
);
17788 /* Make sure we have the position. */
17789 if (used_before
== 0)
17790 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17792 /* Record the position of the newline, for use in
17794 it
->eol_pos
= it
->current
.pos
;
17796 /* Consume the line end. This skips over invisible lines. */
17797 set_iterator_to_next (it
, 1);
17798 it
->continuation_lines_width
= 0;
17802 /* Proceed with next display element. Note that this skips
17803 over lines invisible because of selective display. */
17804 set_iterator_to_next (it
, 1);
17806 /* If we truncate lines, we are done when the last displayed
17807 glyphs reach past the right margin of the window. */
17808 if (it
->line_wrap
== TRUNCATE
17809 && (FRAME_WINDOW_P (it
->f
)
17810 ? (it
->current_x
>= it
->last_visible_x
)
17811 : (it
->current_x
> it
->last_visible_x
)))
17813 /* Maybe add truncation glyphs. */
17814 if (!FRAME_WINDOW_P (it
->f
))
17818 if (!row
->reversed_p
)
17820 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17821 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17826 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17827 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17829 /* Remove any padding glyphs at the front of ROW, to
17830 make room for the truncation glyphs we will be
17831 adding below. The loop below always inserts at
17832 least one truncation glyph, so also remove the
17833 last glyph added to ROW. */
17834 unproduce_glyphs (it
, i
+ 1);
17835 /* Adjust i for the loop below. */
17836 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17839 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17841 row
->used
[TEXT_AREA
] = i
;
17842 produce_special_glyphs (it
, IT_TRUNCATION
);
17845 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17847 /* Don't truncate if we can overflow newline into fringe. */
17848 if (!get_next_display_element (it
))
17850 it
->continuation_lines_width
= 0;
17851 row
->ends_at_zv_p
= 1;
17852 row
->exact_window_width_line_p
= 1;
17855 if (ITERATOR_AT_END_OF_LINE_P (it
))
17857 row
->exact_window_width_line_p
= 1;
17858 goto at_end_of_line
;
17862 row
->truncated_on_right_p
= 1;
17863 it
->continuation_lines_width
= 0;
17864 reseat_at_next_visible_line_start (it
, 0);
17865 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17866 it
->hpos
= hpos_before
;
17867 it
->current_x
= x_before
;
17872 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17873 at the left window margin. */
17874 if (it
->first_visible_x
17875 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17877 if (!FRAME_WINDOW_P (it
->f
))
17878 insert_left_trunc_glyphs (it
);
17879 row
->truncated_on_left_p
= 1;
17882 /* Remember the position at which this line ends.
17884 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17885 cannot be before the call to find_row_edges below, since that is
17886 where these positions are determined. */
17887 row
->end
= it
->current
;
17890 row
->minpos
= row
->start
.pos
;
17891 row
->maxpos
= row
->end
.pos
;
17895 /* ROW->minpos and ROW->maxpos must be the smallest and
17896 `1 + the largest' buffer positions in ROW. But if ROW was
17897 bidi-reordered, these two positions can be anywhere in the
17898 row, so we must determine them now. */
17899 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17902 /* If the start of this line is the overlay arrow-position, then
17903 mark this glyph row as the one containing the overlay arrow.
17904 This is clearly a mess with variable size fonts. It would be
17905 better to let it be displayed like cursors under X. */
17906 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17907 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17908 !NILP (overlay_arrow_string
)))
17910 /* Overlay arrow in window redisplay is a fringe bitmap. */
17911 if (STRINGP (overlay_arrow_string
))
17913 struct glyph_row
*arrow_row
17914 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17915 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17916 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17917 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17918 struct glyph
*p2
, *end
;
17920 /* Copy the arrow glyphs. */
17921 while (glyph
< arrow_end
)
17924 /* Throw away padding glyphs. */
17926 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17927 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17933 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17938 xassert (INTEGERP (overlay_arrow_string
));
17939 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17941 overlay_arrow_seen
= 1;
17944 /* Compute pixel dimensions of this line. */
17945 compute_line_metrics (it
);
17947 /* Record whether this row ends inside an ellipsis. */
17948 row
->ends_in_ellipsis_p
17949 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17950 && it
->ellipsis_p
);
17952 /* Save fringe bitmaps in this row. */
17953 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17954 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17955 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17956 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17958 it
->left_user_fringe_bitmap
= 0;
17959 it
->left_user_fringe_face_id
= 0;
17960 it
->right_user_fringe_bitmap
= 0;
17961 it
->right_user_fringe_face_id
= 0;
17963 /* Maybe set the cursor. */
17964 cvpos
= it
->w
->cursor
.vpos
;
17966 /* In bidi-reordered rows, keep checking for proper cursor
17967 position even if one has been found already, because buffer
17968 positions in such rows change non-linearly with ROW->VPOS,
17969 when a line is continued. One exception: when we are at ZV,
17970 display cursor on the first suitable glyph row, since all
17971 the empty rows after that also have their position set to ZV. */
17972 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17973 lines' rows is implemented for bidi-reordered rows. */
17975 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17976 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17977 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17978 && cursor_row_p (row
))
17979 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17981 /* Highlight trailing whitespace. */
17982 if (!NILP (Vshow_trailing_whitespace
))
17983 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17985 /* Prepare for the next line. This line starts horizontally at (X
17986 HPOS) = (0 0). Vertical positions are incremented. As a
17987 convenience for the caller, IT->glyph_row is set to the next
17989 it
->current_x
= it
->hpos
= 0;
17990 it
->current_y
+= row
->height
;
17991 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17994 /* The next row should by default use the same value of the
17995 reversed_p flag as this one. set_iterator_to_next decides when
17996 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17997 the flag accordingly. */
17998 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17999 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18000 it
->start
= row
->end
;
18001 return row
->displays_text_p
;
18003 #undef RECORD_MAX_MIN_POS
18006 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18007 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18008 doc
: /* Return paragraph direction at point in BUFFER.
18009 Value is either `left-to-right' or `right-to-left'.
18010 If BUFFER is omitted or nil, it defaults to the current buffer.
18012 Paragraph direction determines how the text in the paragraph is displayed.
18013 In left-to-right paragraphs, text begins at the left margin of the window
18014 and the reading direction is generally left to right. In right-to-left
18015 paragraphs, text begins at the right margin and is read from right to left.
18017 See also `bidi-paragraph-direction'. */)
18018 (Lisp_Object buffer
)
18020 struct buffer
*buf
= current_buffer
;
18021 struct buffer
*old
= buf
;
18023 if (! NILP (buffer
))
18025 CHECK_BUFFER (buffer
);
18026 buf
= XBUFFER (buffer
);
18029 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18030 return Qleft_to_right
;
18031 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18032 return BVAR (buf
, bidi_paragraph_direction
);
18035 /* Determine the direction from buffer text. We could try to
18036 use current_matrix if it is up to date, but this seems fast
18037 enough as it is. */
18038 struct bidi_it itb
;
18039 EMACS_INT pos
= BUF_PT (buf
);
18040 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18043 set_buffer_temp (buf
);
18044 /* bidi_paragraph_init finds the base direction of the paragraph
18045 by searching forward from paragraph start. We need the base
18046 direction of the current or _previous_ paragraph, so we need
18047 to make sure we are within that paragraph. To that end, find
18048 the previous non-empty line. */
18049 if (pos
>= ZV
&& pos
> BEGV
)
18052 bytepos
= CHAR_TO_BYTE (pos
);
18054 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18055 || c
== ' ' || c
== '\t' || c
== '\f')
18057 if (bytepos
<= BEGV_BYTE
)
18062 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18065 itb
.bytepos
= bytepos
;
18067 itb
.separator_limit
= -1;
18068 itb
.paragraph_dir
= NEUTRAL_DIR
;
18070 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18071 set_buffer_temp (old
);
18072 switch (itb
.paragraph_dir
)
18075 return Qleft_to_right
;
18078 return Qright_to_left
;
18088 /***********************************************************************
18090 ***********************************************************************/
18092 /* Redisplay the menu bar in the frame for window W.
18094 The menu bar of X frames that don't have X toolkit support is
18095 displayed in a special window W->frame->menu_bar_window.
18097 The menu bar of terminal frames is treated specially as far as
18098 glyph matrices are concerned. Menu bar lines are not part of
18099 windows, so the update is done directly on the frame matrix rows
18100 for the menu bar. */
18103 display_menu_bar (struct window
*w
)
18105 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18110 /* Don't do all this for graphical frames. */
18112 if (FRAME_W32_P (f
))
18115 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18121 if (FRAME_NS_P (f
))
18123 #endif /* HAVE_NS */
18125 #ifdef USE_X_TOOLKIT
18126 xassert (!FRAME_WINDOW_P (f
));
18127 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18128 it
.first_visible_x
= 0;
18129 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18130 #else /* not USE_X_TOOLKIT */
18131 if (FRAME_WINDOW_P (f
))
18133 /* Menu bar lines are displayed in the desired matrix of the
18134 dummy window menu_bar_window. */
18135 struct window
*menu_w
;
18136 xassert (WINDOWP (f
->menu_bar_window
));
18137 menu_w
= XWINDOW (f
->menu_bar_window
);
18138 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18140 it
.first_visible_x
= 0;
18141 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18145 /* This is a TTY frame, i.e. character hpos/vpos are used as
18147 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18149 it
.first_visible_x
= 0;
18150 it
.last_visible_x
= FRAME_COLS (f
);
18152 #endif /* not USE_X_TOOLKIT */
18154 if (! mode_line_inverse_video
)
18155 /* Force the menu-bar to be displayed in the default face. */
18156 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18158 /* Clear all rows of the menu bar. */
18159 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18161 struct glyph_row
*row
= it
.glyph_row
+ i
;
18162 clear_glyph_row (row
);
18163 row
->enabled_p
= 1;
18164 row
->full_width_p
= 1;
18167 /* Display all items of the menu bar. */
18168 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18169 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18171 Lisp_Object string
;
18173 /* Stop at nil string. */
18174 string
= AREF (items
, i
+ 1);
18178 /* Remember where item was displayed. */
18179 ASET (items
, i
+ 3, make_number (it
.hpos
));
18181 /* Display the item, pad with one space. */
18182 if (it
.current_x
< it
.last_visible_x
)
18183 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18184 SCHARS (string
) + 1, 0, 0, -1);
18187 /* Fill out the line with spaces. */
18188 if (it
.current_x
< it
.last_visible_x
)
18189 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18191 /* Compute the total height of the lines. */
18192 compute_line_metrics (&it
);
18197 /***********************************************************************
18199 ***********************************************************************/
18201 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18202 FORCE is non-zero, redisplay mode lines unconditionally.
18203 Otherwise, redisplay only mode lines that are garbaged. Value is
18204 the number of windows whose mode lines were redisplayed. */
18207 redisplay_mode_lines (Lisp_Object window
, int force
)
18211 while (!NILP (window
))
18213 struct window
*w
= XWINDOW (window
);
18215 if (WINDOWP (w
->hchild
))
18216 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18217 else if (WINDOWP (w
->vchild
))
18218 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18220 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18221 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18223 struct text_pos lpoint
;
18224 struct buffer
*old
= current_buffer
;
18226 /* Set the window's buffer for the mode line display. */
18227 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18228 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18230 /* Point refers normally to the selected window. For any
18231 other window, set up appropriate value. */
18232 if (!EQ (window
, selected_window
))
18234 struct text_pos pt
;
18236 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18237 if (CHARPOS (pt
) < BEGV
)
18238 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18239 else if (CHARPOS (pt
) > (ZV
- 1))
18240 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18242 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18245 /* Display mode lines. */
18246 clear_glyph_matrix (w
->desired_matrix
);
18247 if (display_mode_lines (w
))
18250 w
->must_be_updated_p
= 1;
18253 /* Restore old settings. */
18254 set_buffer_internal_1 (old
);
18255 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18265 /* Display the mode and/or header line of window W. Value is the
18266 sum number of mode lines and header lines displayed. */
18269 display_mode_lines (struct window
*w
)
18271 Lisp_Object old_selected_window
, old_selected_frame
;
18274 old_selected_frame
= selected_frame
;
18275 selected_frame
= w
->frame
;
18276 old_selected_window
= selected_window
;
18277 XSETWINDOW (selected_window
, w
);
18279 /* These will be set while the mode line specs are processed. */
18280 line_number_displayed
= 0;
18281 w
->column_number_displayed
= Qnil
;
18283 if (WINDOW_WANTS_MODELINE_P (w
))
18285 struct window
*sel_w
= XWINDOW (old_selected_window
);
18287 /* Select mode line face based on the real selected window. */
18288 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18289 BVAR (current_buffer
, mode_line_format
));
18293 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18295 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18296 BVAR (current_buffer
, header_line_format
));
18300 selected_frame
= old_selected_frame
;
18301 selected_window
= old_selected_window
;
18306 /* Display mode or header line of window W. FACE_ID specifies which
18307 line to display; it is either MODE_LINE_FACE_ID or
18308 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18309 display. Value is the pixel height of the mode/header line
18313 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18317 int count
= SPECPDL_INDEX ();
18319 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18320 /* Don't extend on a previously drawn mode-line.
18321 This may happen if called from pos_visible_p. */
18322 it
.glyph_row
->enabled_p
= 0;
18323 prepare_desired_row (it
.glyph_row
);
18325 it
.glyph_row
->mode_line_p
= 1;
18327 if (! mode_line_inverse_video
)
18328 /* Force the mode-line to be displayed in the default face. */
18329 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18331 record_unwind_protect (unwind_format_mode_line
,
18332 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18334 mode_line_target
= MODE_LINE_DISPLAY
;
18336 /* Temporarily make frame's keyboard the current kboard so that
18337 kboard-local variables in the mode_line_format will get the right
18339 push_kboard (FRAME_KBOARD (it
.f
));
18340 record_unwind_save_match_data ();
18341 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18344 unbind_to (count
, Qnil
);
18346 /* Fill up with spaces. */
18347 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18349 compute_line_metrics (&it
);
18350 it
.glyph_row
->full_width_p
= 1;
18351 it
.glyph_row
->continued_p
= 0;
18352 it
.glyph_row
->truncated_on_left_p
= 0;
18353 it
.glyph_row
->truncated_on_right_p
= 0;
18355 /* Make a 3D mode-line have a shadow at its right end. */
18356 face
= FACE_FROM_ID (it
.f
, face_id
);
18357 extend_face_to_end_of_line (&it
);
18358 if (face
->box
!= FACE_NO_BOX
)
18360 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18361 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18362 last
->right_box_line_p
= 1;
18365 return it
.glyph_row
->height
;
18368 /* Move element ELT in LIST to the front of LIST.
18369 Return the updated list. */
18372 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18374 register Lisp_Object tail
, prev
;
18375 register Lisp_Object tem
;
18379 while (CONSP (tail
))
18385 /* Splice out the link TAIL. */
18387 list
= XCDR (tail
);
18389 Fsetcdr (prev
, XCDR (tail
));
18391 /* Now make it the first. */
18392 Fsetcdr (tail
, list
);
18397 tail
= XCDR (tail
);
18401 /* Not found--return unchanged LIST. */
18405 /* Contribute ELT to the mode line for window IT->w. How it
18406 translates into text depends on its data type.
18408 IT describes the display environment in which we display, as usual.
18410 DEPTH is the depth in recursion. It is used to prevent
18411 infinite recursion here.
18413 FIELD_WIDTH is the number of characters the display of ELT should
18414 occupy in the mode line, and PRECISION is the maximum number of
18415 characters to display from ELT's representation. See
18416 display_string for details.
18418 Returns the hpos of the end of the text generated by ELT.
18420 PROPS is a property list to add to any string we encounter.
18422 If RISKY is nonzero, remove (disregard) any properties in any string
18423 we encounter, and ignore :eval and :propertize.
18425 The global variable `mode_line_target' determines whether the
18426 output is passed to `store_mode_line_noprop',
18427 `store_mode_line_string', or `display_string'. */
18430 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18431 Lisp_Object elt
, Lisp_Object props
, int risky
)
18433 int n
= 0, field
, prec
;
18438 elt
= build_string ("*too-deep*");
18442 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18446 /* A string: output it and check for %-constructs within it. */
18448 EMACS_INT offset
= 0;
18450 if (SCHARS (elt
) > 0
18451 && (!NILP (props
) || risky
))
18453 Lisp_Object oprops
, aelt
;
18454 oprops
= Ftext_properties_at (make_number (0), elt
);
18456 /* If the starting string's properties are not what
18457 we want, translate the string. Also, if the string
18458 is risky, do that anyway. */
18460 if (NILP (Fequal (props
, oprops
)) || risky
)
18462 /* If the starting string has properties,
18463 merge the specified ones onto the existing ones. */
18464 if (! NILP (oprops
) && !risky
)
18468 oprops
= Fcopy_sequence (oprops
);
18470 while (CONSP (tem
))
18472 oprops
= Fplist_put (oprops
, XCAR (tem
),
18473 XCAR (XCDR (tem
)));
18474 tem
= XCDR (XCDR (tem
));
18479 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18480 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18482 /* AELT is what we want. Move it to the front
18483 without consing. */
18485 mode_line_proptrans_alist
18486 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18492 /* If AELT has the wrong props, it is useless.
18493 so get rid of it. */
18495 mode_line_proptrans_alist
18496 = Fdelq (aelt
, mode_line_proptrans_alist
);
18498 elt
= Fcopy_sequence (elt
);
18499 Fset_text_properties (make_number (0), Flength (elt
),
18501 /* Add this item to mode_line_proptrans_alist. */
18502 mode_line_proptrans_alist
18503 = Fcons (Fcons (elt
, props
),
18504 mode_line_proptrans_alist
);
18505 /* Truncate mode_line_proptrans_alist
18506 to at most 50 elements. */
18507 tem
= Fnthcdr (make_number (50),
18508 mode_line_proptrans_alist
);
18510 XSETCDR (tem
, Qnil
);
18519 prec
= precision
- n
;
18520 switch (mode_line_target
)
18522 case MODE_LINE_NOPROP
:
18523 case MODE_LINE_TITLE
:
18524 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18526 case MODE_LINE_STRING
:
18527 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18529 case MODE_LINE_DISPLAY
:
18530 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18531 0, prec
, 0, STRING_MULTIBYTE (elt
));
18538 /* Handle the non-literal case. */
18540 while ((precision
<= 0 || n
< precision
)
18541 && SREF (elt
, offset
) != 0
18542 && (mode_line_target
!= MODE_LINE_DISPLAY
18543 || it
->current_x
< it
->last_visible_x
))
18545 EMACS_INT last_offset
= offset
;
18547 /* Advance to end of string or next format specifier. */
18548 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18551 if (offset
- 1 != last_offset
)
18553 EMACS_INT nchars
, nbytes
;
18555 /* Output to end of string or up to '%'. Field width
18556 is length of string. Don't output more than
18557 PRECISION allows us. */
18560 prec
= c_string_width (SDATA (elt
) + last_offset
,
18561 offset
- last_offset
, precision
- n
,
18564 switch (mode_line_target
)
18566 case MODE_LINE_NOPROP
:
18567 case MODE_LINE_TITLE
:
18568 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18570 case MODE_LINE_STRING
:
18572 EMACS_INT bytepos
= last_offset
;
18573 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18574 EMACS_INT endpos
= (precision
<= 0
18575 ? string_byte_to_char (elt
, offset
)
18576 : charpos
+ nchars
);
18578 n
+= store_mode_line_string (NULL
,
18579 Fsubstring (elt
, make_number (charpos
),
18580 make_number (endpos
)),
18584 case MODE_LINE_DISPLAY
:
18586 EMACS_INT bytepos
= last_offset
;
18587 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18589 if (precision
<= 0)
18590 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18591 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18593 STRING_MULTIBYTE (elt
));
18598 else /* c == '%' */
18600 EMACS_INT percent_position
= offset
;
18602 /* Get the specified minimum width. Zero means
18605 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18606 field
= field
* 10 + c
- '0';
18608 /* Don't pad beyond the total padding allowed. */
18609 if (field_width
- n
> 0 && field
> field_width
- n
)
18610 field
= field_width
- n
;
18612 /* Note that either PRECISION <= 0 or N < PRECISION. */
18613 prec
= precision
- n
;
18616 n
+= display_mode_element (it
, depth
, field
, prec
,
18617 Vglobal_mode_string
, props
,
18622 EMACS_INT bytepos
, charpos
;
18624 Lisp_Object string
;
18626 bytepos
= percent_position
;
18627 charpos
= (STRING_MULTIBYTE (elt
)
18628 ? string_byte_to_char (elt
, bytepos
)
18630 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18631 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18633 switch (mode_line_target
)
18635 case MODE_LINE_NOPROP
:
18636 case MODE_LINE_TITLE
:
18637 n
+= store_mode_line_noprop (spec
, field
, prec
);
18639 case MODE_LINE_STRING
:
18641 int len
= strlen (spec
);
18642 Lisp_Object tem
= make_string (spec
, len
);
18643 props
= Ftext_properties_at (make_number (charpos
), elt
);
18644 /* Should only keep face property in props */
18645 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18648 case MODE_LINE_DISPLAY
:
18650 int nglyphs_before
, nwritten
;
18652 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18653 nwritten
= display_string (spec
, string
, elt
,
18658 /* Assign to the glyphs written above the
18659 string where the `%x' came from, position
18663 struct glyph
*glyph
18664 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18668 for (i
= 0; i
< nwritten
; ++i
)
18670 glyph
[i
].object
= elt
;
18671 glyph
[i
].charpos
= charpos
;
18688 /* A symbol: process the value of the symbol recursively
18689 as if it appeared here directly. Avoid error if symbol void.
18690 Special case: if value of symbol is a string, output the string
18693 register Lisp_Object tem
;
18695 /* If the variable is not marked as risky to set
18696 then its contents are risky to use. */
18697 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18700 tem
= Fboundp (elt
);
18703 tem
= Fsymbol_value (elt
);
18704 /* If value is a string, output that string literally:
18705 don't check for % within it. */
18709 if (!EQ (tem
, elt
))
18711 /* Give up right away for nil or t. */
18721 register Lisp_Object car
, tem
;
18723 /* A cons cell: five distinct cases.
18724 If first element is :eval or :propertize, do something special.
18725 If first element is a string or a cons, process all the elements
18726 and effectively concatenate them.
18727 If first element is a negative number, truncate displaying cdr to
18728 at most that many characters. If positive, pad (with spaces)
18729 to at least that many characters.
18730 If first element is a symbol, process the cadr or caddr recursively
18731 according to whether the symbol's value is non-nil or nil. */
18733 if (EQ (car
, QCeval
))
18735 /* An element of the form (:eval FORM) means evaluate FORM
18736 and use the result as mode line elements. */
18741 if (CONSP (XCDR (elt
)))
18744 spec
= safe_eval (XCAR (XCDR (elt
)));
18745 n
+= display_mode_element (it
, depth
, field_width
- n
,
18746 precision
- n
, spec
, props
,
18750 else if (EQ (car
, QCpropertize
))
18752 /* An element of the form (:propertize ELT PROPS...)
18753 means display ELT but applying properties PROPS. */
18758 if (CONSP (XCDR (elt
)))
18759 n
+= display_mode_element (it
, depth
, field_width
- n
,
18760 precision
- n
, XCAR (XCDR (elt
)),
18761 XCDR (XCDR (elt
)), risky
);
18763 else if (SYMBOLP (car
))
18765 tem
= Fboundp (car
);
18769 /* elt is now the cdr, and we know it is a cons cell.
18770 Use its car if CAR has a non-nil value. */
18773 tem
= Fsymbol_value (car
);
18780 /* Symbol's value is nil (or symbol is unbound)
18781 Get the cddr of the original list
18782 and if possible find the caddr and use that. */
18786 else if (!CONSP (elt
))
18791 else if (INTEGERP (car
))
18793 register int lim
= XINT (car
);
18797 /* Negative int means reduce maximum width. */
18798 if (precision
<= 0)
18801 precision
= min (precision
, -lim
);
18805 /* Padding specified. Don't let it be more than
18806 current maximum. */
18808 lim
= min (precision
, lim
);
18810 /* If that's more padding than already wanted, queue it.
18811 But don't reduce padding already specified even if
18812 that is beyond the current truncation point. */
18813 field_width
= max (lim
, field_width
);
18817 else if (STRINGP (car
) || CONSP (car
))
18819 Lisp_Object halftail
= elt
;
18823 && (precision
<= 0 || n
< precision
))
18825 n
+= display_mode_element (it
, depth
,
18826 /* Do padding only after the last
18827 element in the list. */
18828 (! CONSP (XCDR (elt
))
18831 precision
- n
, XCAR (elt
),
18835 if ((len
& 1) == 0)
18836 halftail
= XCDR (halftail
);
18837 /* Check for cycle. */
18838 if (EQ (halftail
, elt
))
18847 elt
= build_string ("*invalid*");
18851 /* Pad to FIELD_WIDTH. */
18852 if (field_width
> 0 && n
< field_width
)
18854 switch (mode_line_target
)
18856 case MODE_LINE_NOPROP
:
18857 case MODE_LINE_TITLE
:
18858 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18860 case MODE_LINE_STRING
:
18861 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18863 case MODE_LINE_DISPLAY
:
18864 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18873 /* Store a mode-line string element in mode_line_string_list.
18875 If STRING is non-null, display that C string. Otherwise, the Lisp
18876 string LISP_STRING is displayed.
18878 FIELD_WIDTH is the minimum number of output glyphs to produce.
18879 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18880 with spaces. FIELD_WIDTH <= 0 means don't pad.
18882 PRECISION is the maximum number of characters to output from
18883 STRING. PRECISION <= 0 means don't truncate the string.
18885 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18886 properties to the string.
18888 PROPS are the properties to add to the string.
18889 The mode_line_string_face face property is always added to the string.
18893 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18894 int field_width
, int precision
, Lisp_Object props
)
18899 if (string
!= NULL
)
18901 len
= strlen (string
);
18902 if (precision
> 0 && len
> precision
)
18904 lisp_string
= make_string (string
, len
);
18906 props
= mode_line_string_face_prop
;
18907 else if (!NILP (mode_line_string_face
))
18909 Lisp_Object face
= Fplist_get (props
, Qface
);
18910 props
= Fcopy_sequence (props
);
18912 face
= mode_line_string_face
;
18914 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18915 props
= Fplist_put (props
, Qface
, face
);
18917 Fadd_text_properties (make_number (0), make_number (len
),
18918 props
, lisp_string
);
18922 len
= XFASTINT (Flength (lisp_string
));
18923 if (precision
> 0 && len
> precision
)
18926 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18929 if (!NILP (mode_line_string_face
))
18933 props
= Ftext_properties_at (make_number (0), lisp_string
);
18934 face
= Fplist_get (props
, Qface
);
18936 face
= mode_line_string_face
;
18938 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18939 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18941 lisp_string
= Fcopy_sequence (lisp_string
);
18944 Fadd_text_properties (make_number (0), make_number (len
),
18945 props
, lisp_string
);
18950 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18954 if (field_width
> len
)
18956 field_width
-= len
;
18957 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18959 Fadd_text_properties (make_number (0), make_number (field_width
),
18960 props
, lisp_string
);
18961 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18969 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18971 doc
: /* Format a string out of a mode line format specification.
18972 First arg FORMAT specifies the mode line format (see `mode-line-format'
18973 for details) to use.
18975 By default, the format is evaluated for the currently selected window.
18977 Optional second arg FACE specifies the face property to put on all
18978 characters for which no face is specified. The value nil means the
18979 default face. The value t means whatever face the window's mode line
18980 currently uses (either `mode-line' or `mode-line-inactive',
18981 depending on whether the window is the selected window or not).
18982 An integer value means the value string has no text
18985 Optional third and fourth args WINDOW and BUFFER specify the window
18986 and buffer to use as the context for the formatting (defaults
18987 are the selected window and the WINDOW's buffer). */)
18988 (Lisp_Object format
, Lisp_Object face
,
18989 Lisp_Object window
, Lisp_Object buffer
)
18994 struct buffer
*old_buffer
= NULL
;
18996 int no_props
= INTEGERP (face
);
18997 int count
= SPECPDL_INDEX ();
18999 int string_start
= 0;
19002 window
= selected_window
;
19003 CHECK_WINDOW (window
);
19004 w
= XWINDOW (window
);
19007 buffer
= w
->buffer
;
19008 CHECK_BUFFER (buffer
);
19010 /* Make formatting the modeline a non-op when noninteractive, otherwise
19011 there will be problems later caused by a partially initialized frame. */
19012 if (NILP (format
) || noninteractive
)
19013 return empty_unibyte_string
;
19018 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19019 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19020 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19021 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19022 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19023 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19024 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19027 if (XBUFFER (buffer
) != current_buffer
)
19028 old_buffer
= current_buffer
;
19030 /* Save things including mode_line_proptrans_alist,
19031 and set that to nil so that we don't alter the outer value. */
19032 record_unwind_protect (unwind_format_mode_line
,
19033 format_mode_line_unwind_data
19034 (old_buffer
, selected_window
, 1));
19035 mode_line_proptrans_alist
= Qnil
;
19037 Fselect_window (window
, Qt
);
19039 set_buffer_internal_1 (XBUFFER (buffer
));
19041 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19045 mode_line_target
= MODE_LINE_NOPROP
;
19046 mode_line_string_face_prop
= Qnil
;
19047 mode_line_string_list
= Qnil
;
19048 string_start
= MODE_LINE_NOPROP_LEN (0);
19052 mode_line_target
= MODE_LINE_STRING
;
19053 mode_line_string_list
= Qnil
;
19054 mode_line_string_face
= face
;
19055 mode_line_string_face_prop
19056 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19059 push_kboard (FRAME_KBOARD (it
.f
));
19060 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19065 len
= MODE_LINE_NOPROP_LEN (string_start
);
19066 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19070 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19071 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19072 empty_unibyte_string
);
19075 unbind_to (count
, Qnil
);
19079 /* Write a null-terminated, right justified decimal representation of
19080 the positive integer D to BUF using a minimal field width WIDTH. */
19083 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19085 register char *p
= buf
;
19093 *p
++ = d
% 10 + '0';
19098 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19109 /* Write a null-terminated, right justified decimal and "human
19110 readable" representation of the nonnegative integer D to BUF using
19111 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19113 static const char power_letter
[] =
19127 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19129 /* We aim to represent the nonnegative integer D as
19130 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19131 EMACS_INT quotient
= d
;
19133 /* -1 means: do not use TENTHS. */
19137 /* Length of QUOTIENT.TENTHS as a string. */
19143 if (1000 <= quotient
)
19145 /* Scale to the appropriate EXPONENT. */
19148 remainder
= quotient
% 1000;
19152 while (1000 <= quotient
);
19154 /* Round to nearest and decide whether to use TENTHS or not. */
19157 tenths
= remainder
/ 100;
19158 if (50 <= remainder
% 100)
19165 if (quotient
== 10)
19173 if (500 <= remainder
)
19175 if (quotient
< 999)
19186 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19187 if (tenths
== -1 && quotient
<= 99)
19194 p
= psuffix
= buf
+ max (width
, length
);
19196 /* Print EXPONENT. */
19197 *psuffix
++ = power_letter
[exponent
];
19200 /* Print TENTHS. */
19203 *--p
= '0' + tenths
;
19207 /* Print QUOTIENT. */
19210 int digit
= quotient
% 10;
19211 *--p
= '0' + digit
;
19213 while ((quotient
/= 10) != 0);
19215 /* Print leading spaces. */
19220 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19221 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19222 type of CODING_SYSTEM. Return updated pointer into BUF. */
19224 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19227 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19230 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19231 const unsigned char *eol_str
;
19233 /* The EOL conversion we are using. */
19234 Lisp_Object eoltype
;
19236 val
= CODING_SYSTEM_SPEC (coding_system
);
19239 if (!VECTORP (val
)) /* Not yet decided. */
19244 eoltype
= eol_mnemonic_undecided
;
19245 /* Don't mention EOL conversion if it isn't decided. */
19250 Lisp_Object eolvalue
;
19252 attrs
= AREF (val
, 0);
19253 eolvalue
= AREF (val
, 2);
19256 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19260 /* The EOL conversion that is normal on this system. */
19262 if (NILP (eolvalue
)) /* Not yet decided. */
19263 eoltype
= eol_mnemonic_undecided
;
19264 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19265 eoltype
= eol_mnemonic_undecided
;
19266 else /* eolvalue is Qunix, Qdos, or Qmac. */
19267 eoltype
= (EQ (eolvalue
, Qunix
)
19268 ? eol_mnemonic_unix
19269 : (EQ (eolvalue
, Qdos
) == 1
19270 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19276 /* Mention the EOL conversion if it is not the usual one. */
19277 if (STRINGP (eoltype
))
19279 eol_str
= SDATA (eoltype
);
19280 eol_str_len
= SBYTES (eoltype
);
19282 else if (CHARACTERP (eoltype
))
19284 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19285 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19290 eol_str
= invalid_eol_type
;
19291 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19293 memcpy (buf
, eol_str
, eol_str_len
);
19294 buf
+= eol_str_len
;
19300 /* Return a string for the output of a mode line %-spec for window W,
19301 generated by character C. FIELD_WIDTH > 0 means pad the string
19302 returned with spaces to that value. Return a Lisp string in
19303 *STRING if the resulting string is taken from that Lisp string.
19305 Note we operate on the current buffer for most purposes,
19306 the exception being w->base_line_pos. */
19308 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19310 static const char *
19311 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19312 Lisp_Object
*string
)
19315 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19316 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19317 struct buffer
*b
= current_buffer
;
19325 if (!NILP (BVAR (b
, read_only
)))
19327 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19332 /* This differs from %* only for a modified read-only buffer. */
19333 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19335 if (!NILP (BVAR (b
, read_only
)))
19340 /* This differs from %* in ignoring read-only-ness. */
19341 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19353 if (command_loop_level
> 5)
19355 p
= decode_mode_spec_buf
;
19356 for (i
= 0; i
< command_loop_level
; i
++)
19359 return decode_mode_spec_buf
;
19367 if (command_loop_level
> 5)
19369 p
= decode_mode_spec_buf
;
19370 for (i
= 0; i
< command_loop_level
; i
++)
19373 return decode_mode_spec_buf
;
19380 /* Let lots_of_dashes be a string of infinite length. */
19381 if (mode_line_target
== MODE_LINE_NOPROP
||
19382 mode_line_target
== MODE_LINE_STRING
)
19384 if (field_width
<= 0
19385 || field_width
> sizeof (lots_of_dashes
))
19387 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19388 decode_mode_spec_buf
[i
] = '-';
19389 decode_mode_spec_buf
[i
] = '\0';
19390 return decode_mode_spec_buf
;
19393 return lots_of_dashes
;
19397 obj
= BVAR (b
, name
);
19401 /* %c and %l are ignored in `frame-title-format'.
19402 (In redisplay_internal, the frame title is drawn _before_ the
19403 windows are updated, so the stuff which depends on actual
19404 window contents (such as %l) may fail to render properly, or
19405 even crash emacs.) */
19406 if (mode_line_target
== MODE_LINE_TITLE
)
19410 EMACS_INT col
= current_column ();
19411 w
->column_number_displayed
= make_number (col
);
19412 pint2str (decode_mode_spec_buf
, field_width
, col
);
19413 return decode_mode_spec_buf
;
19417 #ifndef SYSTEM_MALLOC
19419 if (NILP (Vmemory_full
))
19422 return "!MEM FULL! ";
19429 /* %F displays the frame name. */
19430 if (!NILP (f
->title
))
19431 return SSDATA (f
->title
);
19432 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19433 return SSDATA (f
->name
);
19437 obj
= BVAR (b
, filename
);
19442 EMACS_INT size
= ZV
- BEGV
;
19443 pint2str (decode_mode_spec_buf
, field_width
, size
);
19444 return decode_mode_spec_buf
;
19449 EMACS_INT size
= ZV
- BEGV
;
19450 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19451 return decode_mode_spec_buf
;
19456 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19457 EMACS_INT topline
, nlines
, height
;
19460 /* %c and %l are ignored in `frame-title-format'. */
19461 if (mode_line_target
== MODE_LINE_TITLE
)
19464 startpos
= XMARKER (w
->start
)->charpos
;
19465 startpos_byte
= marker_byte_position (w
->start
);
19466 height
= WINDOW_TOTAL_LINES (w
);
19468 /* If we decided that this buffer isn't suitable for line numbers,
19469 don't forget that too fast. */
19470 if (EQ (w
->base_line_pos
, w
->buffer
))
19472 /* But do forget it, if the window shows a different buffer now. */
19473 else if (BUFFERP (w
->base_line_pos
))
19474 w
->base_line_pos
= Qnil
;
19476 /* If the buffer is very big, don't waste time. */
19477 if (INTEGERP (Vline_number_display_limit
)
19478 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19480 w
->base_line_pos
= Qnil
;
19481 w
->base_line_number
= Qnil
;
19485 if (INTEGERP (w
->base_line_number
)
19486 && INTEGERP (w
->base_line_pos
)
19487 && XFASTINT (w
->base_line_pos
) <= startpos
)
19489 line
= XFASTINT (w
->base_line_number
);
19490 linepos
= XFASTINT (w
->base_line_pos
);
19491 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19496 linepos
= BUF_BEGV (b
);
19497 linepos_byte
= BUF_BEGV_BYTE (b
);
19500 /* Count lines from base line to window start position. */
19501 nlines
= display_count_lines (linepos_byte
,
19505 topline
= nlines
+ line
;
19507 /* Determine a new base line, if the old one is too close
19508 or too far away, or if we did not have one.
19509 "Too close" means it's plausible a scroll-down would
19510 go back past it. */
19511 if (startpos
== BUF_BEGV (b
))
19513 w
->base_line_number
= make_number (topline
);
19514 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19516 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19517 || linepos
== BUF_BEGV (b
))
19519 EMACS_INT limit
= BUF_BEGV (b
);
19520 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19521 EMACS_INT position
;
19522 EMACS_INT distance
=
19523 (height
* 2 + 30) * line_number_display_limit_width
;
19525 if (startpos
- distance
> limit
)
19527 limit
= startpos
- distance
;
19528 limit_byte
= CHAR_TO_BYTE (limit
);
19531 nlines
= display_count_lines (startpos_byte
,
19533 - (height
* 2 + 30),
19535 /* If we couldn't find the lines we wanted within
19536 line_number_display_limit_width chars per line,
19537 give up on line numbers for this window. */
19538 if (position
== limit_byte
&& limit
== startpos
- distance
)
19540 w
->base_line_pos
= w
->buffer
;
19541 w
->base_line_number
= Qnil
;
19545 w
->base_line_number
= make_number (topline
- nlines
);
19546 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19549 /* Now count lines from the start pos to point. */
19550 nlines
= display_count_lines (startpos_byte
,
19551 PT_BYTE
, PT
, &junk
);
19553 /* Record that we did display the line number. */
19554 line_number_displayed
= 1;
19556 /* Make the string to show. */
19557 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19558 return decode_mode_spec_buf
;
19561 char* p
= decode_mode_spec_buf
;
19562 int pad
= field_width
- 2;
19568 return decode_mode_spec_buf
;
19574 obj
= BVAR (b
, mode_name
);
19578 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19584 EMACS_INT pos
= marker_position (w
->start
);
19585 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19587 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19589 if (pos
<= BUF_BEGV (b
))
19594 else if (pos
<= BUF_BEGV (b
))
19598 if (total
> 1000000)
19599 /* Do it differently for a large value, to avoid overflow. */
19600 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19602 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19603 /* We can't normally display a 3-digit number,
19604 so get us a 2-digit number that is close. */
19607 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19608 return decode_mode_spec_buf
;
19612 /* Display percentage of size above the bottom of the screen. */
19615 EMACS_INT toppos
= marker_position (w
->start
);
19616 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19617 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19619 if (botpos
>= BUF_ZV (b
))
19621 if (toppos
<= BUF_BEGV (b
))
19628 if (total
> 1000000)
19629 /* Do it differently for a large value, to avoid overflow. */
19630 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19632 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19633 /* We can't normally display a 3-digit number,
19634 so get us a 2-digit number that is close. */
19637 if (toppos
<= BUF_BEGV (b
))
19638 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19640 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19641 return decode_mode_spec_buf
;
19646 /* status of process */
19647 obj
= Fget_buffer_process (Fcurrent_buffer ());
19649 return "no process";
19651 obj
= Fsymbol_name (Fprocess_status (obj
));
19657 int count
= inhibit_garbage_collection ();
19658 Lisp_Object val
= call1 (intern ("file-remote-p"),
19659 BVAR (current_buffer
, directory
));
19660 unbind_to (count
, Qnil
);
19668 case 't': /* indicate TEXT or BINARY */
19672 /* coding-system (not including end-of-line format) */
19674 /* coding-system (including end-of-line type) */
19676 int eol_flag
= (c
== 'Z');
19677 char *p
= decode_mode_spec_buf
;
19679 if (! FRAME_WINDOW_P (f
))
19681 /* No need to mention EOL here--the terminal never needs
19682 to do EOL conversion. */
19683 p
= decode_mode_spec_coding (CODING_ID_NAME
19684 (FRAME_KEYBOARD_CODING (f
)->id
),
19686 p
= decode_mode_spec_coding (CODING_ID_NAME
19687 (FRAME_TERMINAL_CODING (f
)->id
),
19690 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19693 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19694 #ifdef subprocesses
19695 obj
= Fget_buffer_process (Fcurrent_buffer ());
19696 if (PROCESSP (obj
))
19698 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19700 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19703 #endif /* subprocesses */
19706 return decode_mode_spec_buf
;
19713 return SSDATA (obj
);
19720 /* Count up to COUNT lines starting from START_BYTE.
19721 But don't go beyond LIMIT_BYTE.
19722 Return the number of lines thus found (always nonnegative).
19724 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19727 display_count_lines (EMACS_INT start_byte
,
19728 EMACS_INT limit_byte
, EMACS_INT count
,
19729 EMACS_INT
*byte_pos_ptr
)
19731 register unsigned char *cursor
;
19732 unsigned char *base
;
19734 register EMACS_INT ceiling
;
19735 register unsigned char *ceiling_addr
;
19736 EMACS_INT orig_count
= count
;
19738 /* If we are not in selective display mode,
19739 check only for newlines. */
19740 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19741 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19745 while (start_byte
< limit_byte
)
19747 ceiling
= BUFFER_CEILING_OF (start_byte
);
19748 ceiling
= min (limit_byte
- 1, ceiling
);
19749 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19750 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19753 if (selective_display
)
19754 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19757 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19760 if (cursor
!= ceiling_addr
)
19764 start_byte
+= cursor
- base
+ 1;
19765 *byte_pos_ptr
= start_byte
;
19769 if (++cursor
== ceiling_addr
)
19775 start_byte
+= cursor
- base
;
19780 while (start_byte
> limit_byte
)
19782 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19783 ceiling
= max (limit_byte
, ceiling
);
19784 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19785 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19788 if (selective_display
)
19789 while (--cursor
!= ceiling_addr
19790 && *cursor
!= '\n' && *cursor
!= 015)
19793 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19796 if (cursor
!= ceiling_addr
)
19800 start_byte
+= cursor
- base
+ 1;
19801 *byte_pos_ptr
= start_byte
;
19802 /* When scanning backwards, we should
19803 not count the newline posterior to which we stop. */
19804 return - orig_count
- 1;
19810 /* Here we add 1 to compensate for the last decrement
19811 of CURSOR, which took it past the valid range. */
19812 start_byte
+= cursor
- base
+ 1;
19816 *byte_pos_ptr
= limit_byte
;
19819 return - orig_count
+ count
;
19820 return orig_count
- count
;
19826 /***********************************************************************
19828 ***********************************************************************/
19830 /* Display a NUL-terminated string, starting with index START.
19832 If STRING is non-null, display that C string. Otherwise, the Lisp
19833 string LISP_STRING is displayed. There's a case that STRING is
19834 non-null and LISP_STRING is not nil. It means STRING is a string
19835 data of LISP_STRING. In that case, we display LISP_STRING while
19836 ignoring its text properties.
19838 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19839 FACE_STRING. Display STRING or LISP_STRING with the face at
19840 FACE_STRING_POS in FACE_STRING:
19842 Display the string in the environment given by IT, but use the
19843 standard display table, temporarily.
19845 FIELD_WIDTH is the minimum number of output glyphs to produce.
19846 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19847 with spaces. If STRING has more characters, more than FIELD_WIDTH
19848 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19850 PRECISION is the maximum number of characters to output from
19851 STRING. PRECISION < 0 means don't truncate the string.
19853 This is roughly equivalent to printf format specifiers:
19855 FIELD_WIDTH PRECISION PRINTF
19856 ----------------------------------------
19862 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19863 display them, and < 0 means obey the current buffer's value of
19864 enable_multibyte_characters.
19866 Value is the number of columns displayed. */
19869 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19870 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19871 int field_width
, int precision
, int max_x
, int multibyte
)
19873 int hpos_at_start
= it
->hpos
;
19874 int saved_face_id
= it
->face_id
;
19875 struct glyph_row
*row
= it
->glyph_row
;
19877 /* Initialize the iterator IT for iteration over STRING beginning
19878 with index START. */
19879 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19880 precision
, field_width
, multibyte
);
19881 if (string
&& STRINGP (lisp_string
))
19882 /* LISP_STRING is the one returned by decode_mode_spec. We should
19883 ignore its text properties. */
19884 it
->stop_charpos
= -1;
19886 /* If displaying STRING, set up the face of the iterator
19887 from LISP_STRING, if that's given. */
19888 if (STRINGP (face_string
))
19894 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19895 0, it
->region_beg_charpos
,
19896 it
->region_end_charpos
,
19897 &endptr
, it
->base_face_id
, 0);
19898 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19899 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19902 /* Set max_x to the maximum allowed X position. Don't let it go
19903 beyond the right edge of the window. */
19905 max_x
= it
->last_visible_x
;
19907 max_x
= min (max_x
, it
->last_visible_x
);
19909 /* Skip over display elements that are not visible. because IT->w is
19911 if (it
->current_x
< it
->first_visible_x
)
19912 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19913 MOVE_TO_POS
| MOVE_TO_X
);
19915 row
->ascent
= it
->max_ascent
;
19916 row
->height
= it
->max_ascent
+ it
->max_descent
;
19917 row
->phys_ascent
= it
->max_phys_ascent
;
19918 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19919 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19921 /* This condition is for the case that we are called with current_x
19922 past last_visible_x. */
19923 while (it
->current_x
< max_x
)
19925 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19927 /* Get the next display element. */
19928 if (!get_next_display_element (it
))
19931 /* Produce glyphs. */
19932 x_before
= it
->current_x
;
19933 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19934 PRODUCE_GLYPHS (it
);
19936 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19939 while (i
< nglyphs
)
19941 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19943 if (it
->line_wrap
!= TRUNCATE
19944 && x
+ glyph
->pixel_width
> max_x
)
19946 /* End of continued line or max_x reached. */
19947 if (CHAR_GLYPH_PADDING_P (*glyph
))
19949 /* A wide character is unbreakable. */
19950 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19951 it
->current_x
= x_before
;
19955 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19960 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19962 /* Glyph is at least partially visible. */
19964 if (x
< it
->first_visible_x
)
19965 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19969 /* Glyph is off the left margin of the display area.
19970 Should not happen. */
19974 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19975 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19976 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19977 row
->phys_height
= max (row
->phys_height
,
19978 it
->max_phys_ascent
+ it
->max_phys_descent
);
19979 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19980 it
->max_extra_line_spacing
);
19981 x
+= glyph
->pixel_width
;
19985 /* Stop if max_x reached. */
19989 /* Stop at line ends. */
19990 if (ITERATOR_AT_END_OF_LINE_P (it
))
19992 it
->continuation_lines_width
= 0;
19996 set_iterator_to_next (it
, 1);
19998 /* Stop if truncating at the right edge. */
19999 if (it
->line_wrap
== TRUNCATE
20000 && it
->current_x
>= it
->last_visible_x
)
20002 /* Add truncation mark, but don't do it if the line is
20003 truncated at a padding space. */
20004 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20006 if (!FRAME_WINDOW_P (it
->f
))
20010 if (it
->current_x
> it
->last_visible_x
)
20012 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20013 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20015 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20017 row
->used
[TEXT_AREA
] = ii
;
20018 produce_special_glyphs (it
, IT_TRUNCATION
);
20021 produce_special_glyphs (it
, IT_TRUNCATION
);
20023 it
->glyph_row
->truncated_on_right_p
= 1;
20029 /* Maybe insert a truncation at the left. */
20030 if (it
->first_visible_x
20031 && IT_CHARPOS (*it
) > 0)
20033 if (!FRAME_WINDOW_P (it
->f
))
20034 insert_left_trunc_glyphs (it
);
20035 it
->glyph_row
->truncated_on_left_p
= 1;
20038 it
->face_id
= saved_face_id
;
20040 /* Value is number of columns displayed. */
20041 return it
->hpos
- hpos_at_start
;
20046 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20047 appears as an element of LIST or as the car of an element of LIST.
20048 If PROPVAL is a list, compare each element against LIST in that
20049 way, and return 1/2 if any element of PROPVAL is found in LIST.
20050 Otherwise return 0. This function cannot quit.
20051 The return value is 2 if the text is invisible but with an ellipsis
20052 and 1 if it's invisible and without an ellipsis. */
20055 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20057 register Lisp_Object tail
, proptail
;
20059 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20061 register Lisp_Object tem
;
20063 if (EQ (propval
, tem
))
20065 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20066 return NILP (XCDR (tem
)) ? 1 : 2;
20069 if (CONSP (propval
))
20071 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20073 Lisp_Object propelt
;
20074 propelt
= XCAR (proptail
);
20075 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20077 register Lisp_Object tem
;
20079 if (EQ (propelt
, tem
))
20081 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20082 return NILP (XCDR (tem
)) ? 1 : 2;
20090 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20091 doc
: /* Non-nil if the property makes the text invisible.
20092 POS-OR-PROP can be a marker or number, in which case it is taken to be
20093 a position in the current buffer and the value of the `invisible' property
20094 is checked; or it can be some other value, which is then presumed to be the
20095 value of the `invisible' property of the text of interest.
20096 The non-nil value returned can be t for truly invisible text or something
20097 else if the text is replaced by an ellipsis. */)
20098 (Lisp_Object pos_or_prop
)
20101 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20102 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20104 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20105 return (invis
== 0 ? Qnil
20107 : make_number (invis
));
20110 /* Calculate a width or height in pixels from a specification using
20111 the following elements:
20114 NUM - a (fractional) multiple of the default font width/height
20115 (NUM) - specifies exactly NUM pixels
20116 UNIT - a fixed number of pixels, see below.
20117 ELEMENT - size of a display element in pixels, see below.
20118 (NUM . SPEC) - equals NUM * SPEC
20119 (+ SPEC SPEC ...) - add pixel values
20120 (- SPEC SPEC ...) - subtract pixel values
20121 (- SPEC) - negate pixel value
20124 INT or FLOAT - a number constant
20125 SYMBOL - use symbol's (buffer local) variable binding.
20128 in - pixels per inch *)
20129 mm - pixels per 1/1000 meter *)
20130 cm - pixels per 1/100 meter *)
20131 width - width of current font in pixels.
20132 height - height of current font in pixels.
20134 *) using the ratio(s) defined in display-pixels-per-inch.
20138 left-fringe - left fringe width in pixels
20139 right-fringe - right fringe width in pixels
20141 left-margin - left margin width in pixels
20142 right-margin - right margin width in pixels
20144 scroll-bar - scroll-bar area width in pixels
20148 Pixels corresponding to 5 inches:
20151 Total width of non-text areas on left side of window (if scroll-bar is on left):
20152 '(space :width (+ left-fringe left-margin scroll-bar))
20154 Align to first text column (in header line):
20155 '(space :align-to 0)
20157 Align to middle of text area minus half the width of variable `my-image'
20158 containing a loaded image:
20159 '(space :align-to (0.5 . (- text my-image)))
20161 Width of left margin minus width of 1 character in the default font:
20162 '(space :width (- left-margin 1))
20164 Width of left margin minus width of 2 characters in the current font:
20165 '(space :width (- left-margin (2 . width)))
20167 Center 1 character over left-margin (in header line):
20168 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20170 Different ways to express width of left fringe plus left margin minus one pixel:
20171 '(space :width (- (+ left-fringe left-margin) (1)))
20172 '(space :width (+ left-fringe left-margin (- (1))))
20173 '(space :width (+ left-fringe left-margin (-1)))
20177 #define NUMVAL(X) \
20178 ((INTEGERP (X) || FLOATP (X)) \
20183 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20184 struct font
*font
, int width_p
, int *align_to
)
20188 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20189 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20192 return OK_PIXELS (0);
20194 xassert (FRAME_LIVE_P (it
->f
));
20196 if (SYMBOLP (prop
))
20198 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20200 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20202 if (unit
[0] == 'i' && unit
[1] == 'n')
20204 else if (unit
[0] == 'm' && unit
[1] == 'm')
20206 else if (unit
[0] == 'c' && unit
[1] == 'm')
20213 #ifdef HAVE_WINDOW_SYSTEM
20214 if (FRAME_WINDOW_P (it
->f
)
20216 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20217 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20219 return OK_PIXELS (ppi
/ pixels
);
20222 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20223 || (CONSP (Vdisplay_pixels_per_inch
)
20225 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20226 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20228 return OK_PIXELS (ppi
/ pixels
);
20234 #ifdef HAVE_WINDOW_SYSTEM
20235 if (EQ (prop
, Qheight
))
20236 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20237 if (EQ (prop
, Qwidth
))
20238 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20240 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20241 return OK_PIXELS (1);
20244 if (EQ (prop
, Qtext
))
20245 return OK_PIXELS (width_p
20246 ? window_box_width (it
->w
, TEXT_AREA
)
20247 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20249 if (align_to
&& *align_to
< 0)
20252 if (EQ (prop
, Qleft
))
20253 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20254 if (EQ (prop
, Qright
))
20255 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20256 if (EQ (prop
, Qcenter
))
20257 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20258 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20259 if (EQ (prop
, Qleft_fringe
))
20260 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20261 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20262 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20263 if (EQ (prop
, Qright_fringe
))
20264 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20265 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20266 : window_box_right_offset (it
->w
, TEXT_AREA
));
20267 if (EQ (prop
, Qleft_margin
))
20268 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20269 if (EQ (prop
, Qright_margin
))
20270 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20271 if (EQ (prop
, Qscroll_bar
))
20272 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20274 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20275 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20276 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20281 if (EQ (prop
, Qleft_fringe
))
20282 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20283 if (EQ (prop
, Qright_fringe
))
20284 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20285 if (EQ (prop
, Qleft_margin
))
20286 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20287 if (EQ (prop
, Qright_margin
))
20288 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20289 if (EQ (prop
, Qscroll_bar
))
20290 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20293 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20296 if (INTEGERP (prop
) || FLOATP (prop
))
20298 int base_unit
= (width_p
20299 ? FRAME_COLUMN_WIDTH (it
->f
)
20300 : FRAME_LINE_HEIGHT (it
->f
));
20301 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20306 Lisp_Object car
= XCAR (prop
);
20307 Lisp_Object cdr
= XCDR (prop
);
20311 #ifdef HAVE_WINDOW_SYSTEM
20312 if (FRAME_WINDOW_P (it
->f
)
20313 && valid_image_p (prop
))
20315 int id
= lookup_image (it
->f
, prop
);
20316 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20318 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20321 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20327 while (CONSP (cdr
))
20329 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20330 font
, width_p
, align_to
))
20333 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20338 if (EQ (car
, Qminus
))
20340 return OK_PIXELS (pixels
);
20343 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20346 if (INTEGERP (car
) || FLOATP (car
))
20349 pixels
= XFLOATINT (car
);
20351 return OK_PIXELS (pixels
);
20352 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20353 font
, width_p
, align_to
))
20354 return OK_PIXELS (pixels
* fact
);
20365 /***********************************************************************
20367 ***********************************************************************/
20369 #ifdef HAVE_WINDOW_SYSTEM
20374 dump_glyph_string (s
)
20375 struct glyph_string
*s
;
20377 fprintf (stderr
, "glyph string\n");
20378 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20379 s
->x
, s
->y
, s
->width
, s
->height
);
20380 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20381 fprintf (stderr
, " hl = %d\n", s
->hl
);
20382 fprintf (stderr
, " left overhang = %d, right = %d\n",
20383 s
->left_overhang
, s
->right_overhang
);
20384 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20385 fprintf (stderr
, " extends to end of line = %d\n",
20386 s
->extends_to_end_of_line_p
);
20387 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20388 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20391 #endif /* GLYPH_DEBUG */
20393 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20394 of XChar2b structures for S; it can't be allocated in
20395 init_glyph_string because it must be allocated via `alloca'. W
20396 is the window on which S is drawn. ROW and AREA are the glyph row
20397 and area within the row from which S is constructed. START is the
20398 index of the first glyph structure covered by S. HL is a
20399 face-override for drawing S. */
20402 #define OPTIONAL_HDC(hdc) HDC hdc,
20403 #define DECLARE_HDC(hdc) HDC hdc;
20404 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20405 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20408 #ifndef OPTIONAL_HDC
20409 #define OPTIONAL_HDC(hdc)
20410 #define DECLARE_HDC(hdc)
20411 #define ALLOCATE_HDC(hdc, f)
20412 #define RELEASE_HDC(hdc, f)
20416 init_glyph_string (struct glyph_string
*s
,
20418 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20419 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20421 memset (s
, 0, sizeof *s
);
20423 s
->f
= XFRAME (w
->frame
);
20427 s
->display
= FRAME_X_DISPLAY (s
->f
);
20428 s
->window
= FRAME_X_WINDOW (s
->f
);
20429 s
->char2b
= char2b
;
20433 s
->first_glyph
= row
->glyphs
[area
] + start
;
20434 s
->height
= row
->height
;
20435 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20436 s
->ybase
= s
->y
+ row
->ascent
;
20440 /* Append the list of glyph strings with head H and tail T to the list
20441 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20444 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20445 struct glyph_string
*h
, struct glyph_string
*t
)
20459 /* Prepend the list of glyph strings with head H and tail T to the
20460 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20464 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20465 struct glyph_string
*h
, struct glyph_string
*t
)
20479 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20480 Set *HEAD and *TAIL to the resulting list. */
20483 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20484 struct glyph_string
*s
)
20486 s
->next
= s
->prev
= NULL
;
20487 append_glyph_string_lists (head
, tail
, s
, s
);
20491 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20492 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20493 make sure that X resources for the face returned are allocated.
20494 Value is a pointer to a realized face that is ready for display if
20495 DISPLAY_P is non-zero. */
20497 static INLINE
struct face
*
20498 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20499 XChar2b
*char2b
, int display_p
)
20501 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20505 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20507 if (code
!= FONT_INVALID_CODE
)
20508 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20510 STORE_XCHAR2B (char2b
, 0, 0);
20513 /* Make sure X resources of the face are allocated. */
20514 #ifdef HAVE_X_WINDOWS
20518 xassert (face
!= NULL
);
20519 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20526 /* Get face and two-byte form of character glyph GLYPH on frame F.
20527 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20528 a pointer to a realized face that is ready for display. */
20530 static INLINE
struct face
*
20531 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20532 XChar2b
*char2b
, int *two_byte_p
)
20536 xassert (glyph
->type
== CHAR_GLYPH
);
20537 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20546 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20547 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20549 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20551 if (code
!= FONT_INVALID_CODE
)
20552 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20554 STORE_XCHAR2B (char2b
, 0, 0);
20557 /* Make sure X resources of the face are allocated. */
20558 xassert (face
!= NULL
);
20559 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20564 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20565 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20568 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20572 if (CHAR_BYTE8_P (c
))
20573 code
= CHAR_TO_BYTE8 (c
);
20575 code
= font
->driver
->encode_char (font
, c
);
20577 if (code
== FONT_INVALID_CODE
)
20579 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20584 /* Fill glyph string S with composition components specified by S->cmp.
20586 BASE_FACE is the base face of the composition.
20587 S->cmp_from is the index of the first component for S.
20589 OVERLAPS non-zero means S should draw the foreground only, and use
20590 its physical height for clipping. See also draw_glyphs.
20592 Value is the index of a component not in S. */
20595 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20599 /* For all glyphs of this composition, starting at the offset
20600 S->cmp_from, until we reach the end of the definition or encounter a
20601 glyph that requires the different face, add it to S. */
20606 s
->for_overlaps
= overlaps
;
20609 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20611 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20615 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20618 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20625 s
->font
= s
->face
->font
;
20627 else if (s
->face
!= face
)
20635 /* All glyph strings for the same composition has the same width,
20636 i.e. the width set for the first component of the composition. */
20637 s
->width
= s
->first_glyph
->pixel_width
;
20639 /* If the specified font could not be loaded, use the frame's
20640 default font, but record the fact that we couldn't load it in
20641 the glyph string so that we can draw rectangles for the
20642 characters of the glyph string. */
20643 if (s
->font
== NULL
)
20645 s
->font_not_found_p
= 1;
20646 s
->font
= FRAME_FONT (s
->f
);
20649 /* Adjust base line for subscript/superscript text. */
20650 s
->ybase
+= s
->first_glyph
->voffset
;
20652 /* This glyph string must always be drawn with 16-bit functions. */
20659 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20660 int start
, int end
, int overlaps
)
20662 struct glyph
*glyph
, *last
;
20663 Lisp_Object lgstring
;
20666 s
->for_overlaps
= overlaps
;
20667 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20668 last
= s
->row
->glyphs
[s
->area
] + end
;
20669 s
->cmp_id
= glyph
->u
.cmp
.id
;
20670 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20671 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20672 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20673 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20674 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20676 while (glyph
< last
20677 && glyph
->u
.cmp
.automatic
20678 && glyph
->u
.cmp
.id
== s
->cmp_id
20679 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20680 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20682 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20684 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20685 unsigned code
= LGLYPH_CODE (lglyph
);
20687 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20689 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20690 return glyph
- s
->row
->glyphs
[s
->area
];
20694 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20695 See the comment of fill_glyph_string for arguments.
20696 Value is the index of the first glyph not in S. */
20700 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20701 int start
, int end
, int overlaps
)
20703 struct glyph
*glyph
, *last
;
20706 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20707 s
->for_overlaps
= overlaps
;
20708 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20709 last
= s
->row
->glyphs
[s
->area
] + end
;
20710 voffset
= glyph
->voffset
;
20711 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20712 s
->font
= s
->face
->font
;
20714 s
->width
= glyph
->pixel_width
;
20716 while (glyph
< last
20717 && glyph
->type
== GLYPHLESS_GLYPH
20718 && glyph
->voffset
== voffset
20719 && glyph
->face_id
== face_id
)
20722 s
->width
+= glyph
->pixel_width
;
20725 s
->ybase
+= voffset
;
20726 return glyph
- s
->row
->glyphs
[s
->area
];
20730 /* Fill glyph string S from a sequence of character glyphs.
20732 FACE_ID is the face id of the string. START is the index of the
20733 first glyph to consider, END is the index of the last + 1.
20734 OVERLAPS non-zero means S should draw the foreground only, and use
20735 its physical height for clipping. See also draw_glyphs.
20737 Value is the index of the first glyph not in S. */
20740 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20741 int start
, int end
, int overlaps
)
20743 struct glyph
*glyph
, *last
;
20745 int glyph_not_available_p
;
20747 xassert (s
->f
== XFRAME (s
->w
->frame
));
20748 xassert (s
->nchars
== 0);
20749 xassert (start
>= 0 && end
> start
);
20751 s
->for_overlaps
= overlaps
;
20752 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20753 last
= s
->row
->glyphs
[s
->area
] + end
;
20754 voffset
= glyph
->voffset
;
20755 s
->padding_p
= glyph
->padding_p
;
20756 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20758 while (glyph
< last
20759 && glyph
->type
== CHAR_GLYPH
20760 && glyph
->voffset
== voffset
20761 /* Same face id implies same font, nowadays. */
20762 && glyph
->face_id
== face_id
20763 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20767 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20768 s
->char2b
+ s
->nchars
,
20770 s
->two_byte_p
= two_byte_p
;
20772 xassert (s
->nchars
<= end
- start
);
20773 s
->width
+= glyph
->pixel_width
;
20774 if (glyph
++->padding_p
!= s
->padding_p
)
20778 s
->font
= s
->face
->font
;
20780 /* If the specified font could not be loaded, use the frame's font,
20781 but record the fact that we couldn't load it in
20782 S->font_not_found_p so that we can draw rectangles for the
20783 characters of the glyph string. */
20784 if (s
->font
== NULL
|| glyph_not_available_p
)
20786 s
->font_not_found_p
= 1;
20787 s
->font
= FRAME_FONT (s
->f
);
20790 /* Adjust base line for subscript/superscript text. */
20791 s
->ybase
+= voffset
;
20793 xassert (s
->face
&& s
->face
->gc
);
20794 return glyph
- s
->row
->glyphs
[s
->area
];
20798 /* Fill glyph string S from image glyph S->first_glyph. */
20801 fill_image_glyph_string (struct glyph_string
*s
)
20803 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20804 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20806 s
->slice
= s
->first_glyph
->slice
.img
;
20807 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20808 s
->font
= s
->face
->font
;
20809 s
->width
= s
->first_glyph
->pixel_width
;
20811 /* Adjust base line for subscript/superscript text. */
20812 s
->ybase
+= s
->first_glyph
->voffset
;
20816 /* Fill glyph string S from a sequence of stretch glyphs.
20818 START is the index of the first glyph to consider,
20819 END is the index of the last + 1.
20821 Value is the index of the first glyph not in S. */
20824 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20826 struct glyph
*glyph
, *last
;
20827 int voffset
, face_id
;
20829 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20831 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20832 last
= s
->row
->glyphs
[s
->area
] + end
;
20833 face_id
= glyph
->face_id
;
20834 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20835 s
->font
= s
->face
->font
;
20836 s
->width
= glyph
->pixel_width
;
20838 voffset
= glyph
->voffset
;
20842 && glyph
->type
== STRETCH_GLYPH
20843 && glyph
->voffset
== voffset
20844 && glyph
->face_id
== face_id
);
20846 s
->width
+= glyph
->pixel_width
;
20848 /* Adjust base line for subscript/superscript text. */
20849 s
->ybase
+= voffset
;
20851 /* The case that face->gc == 0 is handled when drawing the glyph
20852 string by calling PREPARE_FACE_FOR_DISPLAY. */
20854 return glyph
- s
->row
->glyphs
[s
->area
];
20857 static struct font_metrics
*
20858 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20860 static struct font_metrics metrics
;
20861 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20863 if (! font
|| code
== FONT_INVALID_CODE
)
20865 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20870 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20871 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20872 assumed to be zero. */
20875 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20877 *left
= *right
= 0;
20879 if (glyph
->type
== CHAR_GLYPH
)
20883 struct font_metrics
*pcm
;
20885 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20886 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20888 if (pcm
->rbearing
> pcm
->width
)
20889 *right
= pcm
->rbearing
- pcm
->width
;
20890 if (pcm
->lbearing
< 0)
20891 *left
= -pcm
->lbearing
;
20894 else if (glyph
->type
== COMPOSITE_GLYPH
)
20896 if (! glyph
->u
.cmp
.automatic
)
20898 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20900 if (cmp
->rbearing
> cmp
->pixel_width
)
20901 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20902 if (cmp
->lbearing
< 0)
20903 *left
= - cmp
->lbearing
;
20907 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20908 struct font_metrics metrics
;
20910 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20911 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20912 if (metrics
.rbearing
> metrics
.width
)
20913 *right
= metrics
.rbearing
- metrics
.width
;
20914 if (metrics
.lbearing
< 0)
20915 *left
= - metrics
.lbearing
;
20921 /* Return the index of the first glyph preceding glyph string S that
20922 is overwritten by S because of S's left overhang. Value is -1
20923 if no glyphs are overwritten. */
20926 left_overwritten (struct glyph_string
*s
)
20930 if (s
->left_overhang
)
20933 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20934 int first
= s
->first_glyph
- glyphs
;
20936 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20937 x
-= glyphs
[i
].pixel_width
;
20948 /* Return the index of the first glyph preceding glyph string S that
20949 is overwriting S because of its right overhang. Value is -1 if no
20950 glyph in front of S overwrites S. */
20953 left_overwriting (struct glyph_string
*s
)
20956 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20957 int first
= s
->first_glyph
- glyphs
;
20961 for (i
= first
- 1; i
>= 0; --i
)
20964 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20967 x
-= glyphs
[i
].pixel_width
;
20974 /* Return the index of the last glyph following glyph string S that is
20975 overwritten by S because of S's right overhang. Value is -1 if
20976 no such glyph is found. */
20979 right_overwritten (struct glyph_string
*s
)
20983 if (s
->right_overhang
)
20986 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20987 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20988 int end
= s
->row
->used
[s
->area
];
20990 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20991 x
+= glyphs
[i
].pixel_width
;
21000 /* Return the index of the last glyph following glyph string S that
21001 overwrites S because of its left overhang. Value is negative
21002 if no such glyph is found. */
21005 right_overwriting (struct glyph_string
*s
)
21008 int end
= s
->row
->used
[s
->area
];
21009 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21010 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21014 for (i
= first
; i
< end
; ++i
)
21017 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21020 x
+= glyphs
[i
].pixel_width
;
21027 /* Set background width of glyph string S. START is the index of the
21028 first glyph following S. LAST_X is the right-most x-position + 1
21029 in the drawing area. */
21032 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21034 /* If the face of this glyph string has to be drawn to the end of
21035 the drawing area, set S->extends_to_end_of_line_p. */
21037 if (start
== s
->row
->used
[s
->area
]
21038 && s
->area
== TEXT_AREA
21039 && ((s
->row
->fill_line_p
21040 && (s
->hl
== DRAW_NORMAL_TEXT
21041 || s
->hl
== DRAW_IMAGE_RAISED
21042 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21043 || s
->hl
== DRAW_MOUSE_FACE
))
21044 s
->extends_to_end_of_line_p
= 1;
21046 /* If S extends its face to the end of the line, set its
21047 background_width to the distance to the right edge of the drawing
21049 if (s
->extends_to_end_of_line_p
)
21050 s
->background_width
= last_x
- s
->x
+ 1;
21052 s
->background_width
= s
->width
;
21056 /* Compute overhangs and x-positions for glyph string S and its
21057 predecessors, or successors. X is the starting x-position for S.
21058 BACKWARD_P non-zero means process predecessors. */
21061 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21067 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21068 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21078 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21079 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21089 /* The following macros are only called from draw_glyphs below.
21090 They reference the following parameters of that function directly:
21091 `w', `row', `area', and `overlap_p'
21092 as well as the following local variables:
21093 `s', `f', and `hdc' (in W32) */
21096 /* On W32, silently add local `hdc' variable to argument list of
21097 init_glyph_string. */
21098 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21099 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21101 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21102 init_glyph_string (s, char2b, w, row, area, start, hl)
21105 /* Add a glyph string for a stretch glyph to the list of strings
21106 between HEAD and TAIL. START is the index of the stretch glyph in
21107 row area AREA of glyph row ROW. END is the index of the last glyph
21108 in that glyph row area. X is the current output position assigned
21109 to the new glyph string constructed. HL overrides that face of the
21110 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21111 is the right-most x-position of the drawing area. */
21113 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21114 and below -- keep them on one line. */
21115 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21118 s = (struct glyph_string *) alloca (sizeof *s); \
21119 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21120 START = fill_stretch_glyph_string (s, START, END); \
21121 append_glyph_string (&HEAD, &TAIL, s); \
21127 /* Add a glyph string for an image glyph to the list of strings
21128 between HEAD and TAIL. START is the index of the image glyph in
21129 row area AREA of glyph row ROW. END is the index of the last glyph
21130 in that glyph row area. X is the current output position assigned
21131 to the new glyph string constructed. HL overrides that face of the
21132 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21133 is the right-most x-position of the drawing area. */
21135 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21138 s = (struct glyph_string *) alloca (sizeof *s); \
21139 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21140 fill_image_glyph_string (s); \
21141 append_glyph_string (&HEAD, &TAIL, s); \
21148 /* Add a glyph string for a sequence of character glyphs to the list
21149 of strings between HEAD and TAIL. START is the index of the first
21150 glyph in row area AREA of glyph row ROW that is part of the new
21151 glyph string. END is the index of the last glyph in that glyph row
21152 area. X is the current output position assigned to the new glyph
21153 string constructed. HL overrides that face of the glyph; e.g. it
21154 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21155 right-most x-position of the drawing area. */
21157 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21163 face_id = (row)->glyphs[area][START].face_id; \
21165 s = (struct glyph_string *) alloca (sizeof *s); \
21166 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21167 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21168 append_glyph_string (&HEAD, &TAIL, s); \
21170 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21175 /* Add a glyph string for a composite sequence to the list of strings
21176 between HEAD and TAIL. START is the index of the first glyph in
21177 row area AREA of glyph row ROW that is part of the new glyph
21178 string. END is the index of the last glyph in that glyph row area.
21179 X is the current output position assigned to the new glyph string
21180 constructed. HL overrides that face of the glyph; e.g. it is
21181 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21182 x-position of the drawing area. */
21184 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21186 int face_id = (row)->glyphs[area][START].face_id; \
21187 struct face *base_face = FACE_FROM_ID (f, face_id); \
21188 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21189 struct composition *cmp = composition_table[cmp_id]; \
21191 struct glyph_string *first_s IF_LINT (= NULL); \
21194 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21196 /* Make glyph_strings for each glyph sequence that is drawable by \
21197 the same face, and append them to HEAD/TAIL. */ \
21198 for (n = 0; n < cmp->glyph_len;) \
21200 s = (struct glyph_string *) alloca (sizeof *s); \
21201 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21202 append_glyph_string (&(HEAD), &(TAIL), s); \
21208 n = fill_composite_glyph_string (s, base_face, overlaps); \
21216 /* Add a glyph string for a glyph-string sequence to the list of strings
21217 between HEAD and TAIL. */
21219 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21223 Lisp_Object gstring; \
21225 face_id = (row)->glyphs[area][START].face_id; \
21226 gstring = (composition_gstring_from_id \
21227 ((row)->glyphs[area][START].u.cmp.id)); \
21228 s = (struct glyph_string *) alloca (sizeof *s); \
21229 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21230 * LGSTRING_GLYPH_LEN (gstring)); \
21231 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21232 append_glyph_string (&(HEAD), &(TAIL), s); \
21234 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21238 /* Add a glyph string for a sequence of glyphless character's glyphs
21239 to the list of strings between HEAD and TAIL. The meanings of
21240 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21242 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21247 face_id = (row)->glyphs[area][START].face_id; \
21249 s = (struct glyph_string *) alloca (sizeof *s); \
21250 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21251 append_glyph_string (&HEAD, &TAIL, s); \
21253 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21259 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21260 of AREA of glyph row ROW on window W between indices START and END.
21261 HL overrides the face for drawing glyph strings, e.g. it is
21262 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21263 x-positions of the drawing area.
21265 This is an ugly monster macro construct because we must use alloca
21266 to allocate glyph strings (because draw_glyphs can be called
21267 asynchronously). */
21269 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21272 HEAD = TAIL = NULL; \
21273 while (START < END) \
21275 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21276 switch (first_glyph->type) \
21279 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21283 case COMPOSITE_GLYPH: \
21284 if (first_glyph->u.cmp.automatic) \
21285 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21288 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21292 case STRETCH_GLYPH: \
21293 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21297 case IMAGE_GLYPH: \
21298 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21302 case GLYPHLESS_GLYPH: \
21303 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21313 set_glyph_string_background_width (s, START, LAST_X); \
21320 /* Draw glyphs between START and END in AREA of ROW on window W,
21321 starting at x-position X. X is relative to AREA in W. HL is a
21322 face-override with the following meaning:
21324 DRAW_NORMAL_TEXT draw normally
21325 DRAW_CURSOR draw in cursor face
21326 DRAW_MOUSE_FACE draw in mouse face.
21327 DRAW_INVERSE_VIDEO draw in mode line face
21328 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21329 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21331 If OVERLAPS is non-zero, draw only the foreground of characters and
21332 clip to the physical height of ROW. Non-zero value also defines
21333 the overlapping part to be drawn:
21335 OVERLAPS_PRED overlap with preceding rows
21336 OVERLAPS_SUCC overlap with succeeding rows
21337 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21338 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21340 Value is the x-position reached, relative to AREA of W. */
21343 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21344 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21345 enum draw_glyphs_face hl
, int overlaps
)
21347 struct glyph_string
*head
, *tail
;
21348 struct glyph_string
*s
;
21349 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21350 int i
, j
, x_reached
, last_x
, area_left
= 0;
21351 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21354 ALLOCATE_HDC (hdc
, f
);
21356 /* Let's rather be paranoid than getting a SEGV. */
21357 end
= min (end
, row
->used
[area
]);
21358 start
= max (0, start
);
21359 start
= min (end
, start
);
21361 /* Translate X to frame coordinates. Set last_x to the right
21362 end of the drawing area. */
21363 if (row
->full_width_p
)
21365 /* X is relative to the left edge of W, without scroll bars
21367 area_left
= WINDOW_LEFT_EDGE_X (w
);
21368 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21372 area_left
= window_box_left (w
, area
);
21373 last_x
= area_left
+ window_box_width (w
, area
);
21377 /* Build a doubly-linked list of glyph_string structures between
21378 head and tail from what we have to draw. Note that the macro
21379 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21380 the reason we use a separate variable `i'. */
21382 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21384 x_reached
= tail
->x
+ tail
->background_width
;
21388 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21389 the row, redraw some glyphs in front or following the glyph
21390 strings built above. */
21391 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21393 struct glyph_string
*h
, *t
;
21394 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21395 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21396 int check_mouse_face
= 0;
21399 /* If mouse highlighting is on, we may need to draw adjacent
21400 glyphs using mouse-face highlighting. */
21401 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21403 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21405 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21406 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21408 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21410 check_mouse_face
= 1;
21411 mouse_beg_col
= (row
== mouse_beg_row
)
21412 ? hlinfo
->mouse_face_beg_col
: 0;
21413 mouse_end_col
= (row
== mouse_end_row
)
21414 ? hlinfo
->mouse_face_end_col
21415 : row
->used
[TEXT_AREA
];
21419 /* Compute overhangs for all glyph strings. */
21420 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21421 for (s
= head
; s
; s
= s
->next
)
21422 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21424 /* Prepend glyph strings for glyphs in front of the first glyph
21425 string that are overwritten because of the first glyph
21426 string's left overhang. The background of all strings
21427 prepended must be drawn because the first glyph string
21429 i
= left_overwritten (head
);
21432 enum draw_glyphs_face overlap_hl
;
21434 /* If this row contains mouse highlighting, attempt to draw
21435 the overlapped glyphs with the correct highlight. This
21436 code fails if the overlap encompasses more than one glyph
21437 and mouse-highlight spans only some of these glyphs.
21438 However, making it work perfectly involves a lot more
21439 code, and I don't know if the pathological case occurs in
21440 practice, so we'll stick to this for now. --- cyd */
21441 if (check_mouse_face
21442 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21443 overlap_hl
= DRAW_MOUSE_FACE
;
21445 overlap_hl
= DRAW_NORMAL_TEXT
;
21448 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21449 overlap_hl
, dummy_x
, last_x
);
21451 compute_overhangs_and_x (t
, head
->x
, 1);
21452 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21456 /* Prepend glyph strings for glyphs in front of the first glyph
21457 string that overwrite that glyph string because of their
21458 right overhang. For these strings, only the foreground must
21459 be drawn, because it draws over the glyph string at `head'.
21460 The background must not be drawn because this would overwrite
21461 right overhangs of preceding glyphs for which no glyph
21463 i
= left_overwriting (head
);
21466 enum draw_glyphs_face overlap_hl
;
21468 if (check_mouse_face
21469 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21470 overlap_hl
= DRAW_MOUSE_FACE
;
21472 overlap_hl
= DRAW_NORMAL_TEXT
;
21475 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21476 overlap_hl
, dummy_x
, last_x
);
21477 for (s
= h
; s
; s
= s
->next
)
21478 s
->background_filled_p
= 1;
21479 compute_overhangs_and_x (t
, head
->x
, 1);
21480 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21483 /* Append glyphs strings for glyphs following the last glyph
21484 string tail that are overwritten by tail. The background of
21485 these strings has to be drawn because tail's foreground draws
21487 i
= right_overwritten (tail
);
21490 enum draw_glyphs_face overlap_hl
;
21492 if (check_mouse_face
21493 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21494 overlap_hl
= DRAW_MOUSE_FACE
;
21496 overlap_hl
= DRAW_NORMAL_TEXT
;
21498 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21499 overlap_hl
, x
, last_x
);
21500 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21501 we don't have `end = i;' here. */
21502 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21503 append_glyph_string_lists (&head
, &tail
, h
, t
);
21507 /* Append glyph strings for glyphs following the last glyph
21508 string tail that overwrite tail. The foreground of such
21509 glyphs has to be drawn because it writes into the background
21510 of tail. The background must not be drawn because it could
21511 paint over the foreground of following glyphs. */
21512 i
= right_overwriting (tail
);
21515 enum draw_glyphs_face overlap_hl
;
21516 if (check_mouse_face
21517 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21518 overlap_hl
= DRAW_MOUSE_FACE
;
21520 overlap_hl
= DRAW_NORMAL_TEXT
;
21523 i
++; /* We must include the Ith glyph. */
21524 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21525 overlap_hl
, x
, last_x
);
21526 for (s
= h
; s
; s
= s
->next
)
21527 s
->background_filled_p
= 1;
21528 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21529 append_glyph_string_lists (&head
, &tail
, h
, t
);
21531 if (clip_head
|| clip_tail
)
21532 for (s
= head
; s
; s
= s
->next
)
21534 s
->clip_head
= clip_head
;
21535 s
->clip_tail
= clip_tail
;
21539 /* Draw all strings. */
21540 for (s
= head
; s
; s
= s
->next
)
21541 FRAME_RIF (f
)->draw_glyph_string (s
);
21544 /* When focus a sole frame and move horizontally, this sets on_p to 0
21545 causing a failure to erase prev cursor position. */
21546 if (area
== TEXT_AREA
21547 && !row
->full_width_p
21548 /* When drawing overlapping rows, only the glyph strings'
21549 foreground is drawn, which doesn't erase a cursor
21553 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21554 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21555 : (tail
? tail
->x
+ tail
->background_width
: x
));
21559 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21560 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21564 /* Value is the x-position up to which drawn, relative to AREA of W.
21565 This doesn't include parts drawn because of overhangs. */
21566 if (row
->full_width_p
)
21567 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21569 x_reached
-= area_left
;
21571 RELEASE_HDC (hdc
, f
);
21576 /* Expand row matrix if too narrow. Don't expand if area
21579 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21581 if (!fonts_changed_p \
21582 && (it->glyph_row->glyphs[area] \
21583 < it->glyph_row->glyphs[area + 1])) \
21585 it->w->ncols_scale_factor++; \
21586 fonts_changed_p = 1; \
21590 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21591 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21594 append_glyph (struct it
*it
)
21596 struct glyph
*glyph
;
21597 enum glyph_row_area area
= it
->area
;
21599 xassert (it
->glyph_row
);
21600 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21602 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21603 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21605 /* If the glyph row is reversed, we need to prepend the glyph
21606 rather than append it. */
21607 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21611 /* Make room for the additional glyph. */
21612 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21614 glyph
= it
->glyph_row
->glyphs
[area
];
21616 glyph
->charpos
= CHARPOS (it
->position
);
21617 glyph
->object
= it
->object
;
21618 if (it
->pixel_width
> 0)
21620 glyph
->pixel_width
= it
->pixel_width
;
21621 glyph
->padding_p
= 0;
21625 /* Assure at least 1-pixel width. Otherwise, cursor can't
21626 be displayed correctly. */
21627 glyph
->pixel_width
= 1;
21628 glyph
->padding_p
= 1;
21630 glyph
->ascent
= it
->ascent
;
21631 glyph
->descent
= it
->descent
;
21632 glyph
->voffset
= it
->voffset
;
21633 glyph
->type
= CHAR_GLYPH
;
21634 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21635 glyph
->multibyte_p
= it
->multibyte_p
;
21636 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21637 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21638 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21639 || it
->phys_descent
> it
->descent
);
21640 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21641 glyph
->face_id
= it
->face_id
;
21642 glyph
->u
.ch
= it
->char_to_display
;
21643 glyph
->slice
.img
= null_glyph_slice
;
21644 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21647 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21648 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21650 glyph
->bidi_type
= it
->bidi_it
.type
;
21654 glyph
->resolved_level
= 0;
21655 glyph
->bidi_type
= UNKNOWN_BT
;
21657 ++it
->glyph_row
->used
[area
];
21660 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21663 /* Store one glyph for the composition IT->cmp_it.id in
21664 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21668 append_composite_glyph (struct it
*it
)
21670 struct glyph
*glyph
;
21671 enum glyph_row_area area
= it
->area
;
21673 xassert (it
->glyph_row
);
21675 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21676 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21678 /* If the glyph row is reversed, we need to prepend the glyph
21679 rather than append it. */
21680 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21684 /* Make room for the new glyph. */
21685 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21687 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21689 glyph
->charpos
= it
->cmp_it
.charpos
;
21690 glyph
->object
= it
->object
;
21691 glyph
->pixel_width
= it
->pixel_width
;
21692 glyph
->ascent
= it
->ascent
;
21693 glyph
->descent
= it
->descent
;
21694 glyph
->voffset
= it
->voffset
;
21695 glyph
->type
= COMPOSITE_GLYPH
;
21696 if (it
->cmp_it
.ch
< 0)
21698 glyph
->u
.cmp
.automatic
= 0;
21699 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21700 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21704 glyph
->u
.cmp
.automatic
= 1;
21705 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21706 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21707 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21709 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21710 glyph
->multibyte_p
= it
->multibyte_p
;
21711 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21712 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21713 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21714 || it
->phys_descent
> it
->descent
);
21715 glyph
->padding_p
= 0;
21716 glyph
->glyph_not_available_p
= 0;
21717 glyph
->face_id
= it
->face_id
;
21718 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21721 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21722 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21724 glyph
->bidi_type
= it
->bidi_it
.type
;
21726 ++it
->glyph_row
->used
[area
];
21729 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21733 /* Change IT->ascent and IT->height according to the setting of
21737 take_vertical_position_into_account (struct it
*it
)
21741 if (it
->voffset
< 0)
21742 /* Increase the ascent so that we can display the text higher
21744 it
->ascent
-= it
->voffset
;
21746 /* Increase the descent so that we can display the text lower
21748 it
->descent
+= it
->voffset
;
21753 /* Produce glyphs/get display metrics for the image IT is loaded with.
21754 See the description of struct display_iterator in dispextern.h for
21755 an overview of struct display_iterator. */
21758 produce_image_glyph (struct it
*it
)
21762 int glyph_ascent
, crop
;
21763 struct glyph_slice slice
;
21765 xassert (it
->what
== IT_IMAGE
);
21767 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21769 /* Make sure X resources of the face is loaded. */
21770 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21772 if (it
->image_id
< 0)
21774 /* Fringe bitmap. */
21775 it
->ascent
= it
->phys_ascent
= 0;
21776 it
->descent
= it
->phys_descent
= 0;
21777 it
->pixel_width
= 0;
21782 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21784 /* Make sure X resources of the image is loaded. */
21785 prepare_image_for_display (it
->f
, img
);
21787 slice
.x
= slice
.y
= 0;
21788 slice
.width
= img
->width
;
21789 slice
.height
= img
->height
;
21791 if (INTEGERP (it
->slice
.x
))
21792 slice
.x
= XINT (it
->slice
.x
);
21793 else if (FLOATP (it
->slice
.x
))
21794 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21796 if (INTEGERP (it
->slice
.y
))
21797 slice
.y
= XINT (it
->slice
.y
);
21798 else if (FLOATP (it
->slice
.y
))
21799 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21801 if (INTEGERP (it
->slice
.width
))
21802 slice
.width
= XINT (it
->slice
.width
);
21803 else if (FLOATP (it
->slice
.width
))
21804 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21806 if (INTEGERP (it
->slice
.height
))
21807 slice
.height
= XINT (it
->slice
.height
);
21808 else if (FLOATP (it
->slice
.height
))
21809 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21811 if (slice
.x
>= img
->width
)
21812 slice
.x
= img
->width
;
21813 if (slice
.y
>= img
->height
)
21814 slice
.y
= img
->height
;
21815 if (slice
.x
+ slice
.width
>= img
->width
)
21816 slice
.width
= img
->width
- slice
.x
;
21817 if (slice
.y
+ slice
.height
> img
->height
)
21818 slice
.height
= img
->height
- slice
.y
;
21820 if (slice
.width
== 0 || slice
.height
== 0)
21823 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21825 it
->descent
= slice
.height
- glyph_ascent
;
21827 it
->descent
+= img
->vmargin
;
21828 if (slice
.y
+ slice
.height
== img
->height
)
21829 it
->descent
+= img
->vmargin
;
21830 it
->phys_descent
= it
->descent
;
21832 it
->pixel_width
= slice
.width
;
21834 it
->pixel_width
+= img
->hmargin
;
21835 if (slice
.x
+ slice
.width
== img
->width
)
21836 it
->pixel_width
+= img
->hmargin
;
21838 /* It's quite possible for images to have an ascent greater than
21839 their height, so don't get confused in that case. */
21840 if (it
->descent
< 0)
21845 if (face
->box
!= FACE_NO_BOX
)
21847 if (face
->box_line_width
> 0)
21850 it
->ascent
+= face
->box_line_width
;
21851 if (slice
.y
+ slice
.height
== img
->height
)
21852 it
->descent
+= face
->box_line_width
;
21855 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21856 it
->pixel_width
+= eabs (face
->box_line_width
);
21857 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21858 it
->pixel_width
+= eabs (face
->box_line_width
);
21861 take_vertical_position_into_account (it
);
21863 /* Automatically crop wide image glyphs at right edge so we can
21864 draw the cursor on same display row. */
21865 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21866 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21868 it
->pixel_width
-= crop
;
21869 slice
.width
-= crop
;
21874 struct glyph
*glyph
;
21875 enum glyph_row_area area
= it
->area
;
21877 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21878 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21880 glyph
->charpos
= CHARPOS (it
->position
);
21881 glyph
->object
= it
->object
;
21882 glyph
->pixel_width
= it
->pixel_width
;
21883 glyph
->ascent
= glyph_ascent
;
21884 glyph
->descent
= it
->descent
;
21885 glyph
->voffset
= it
->voffset
;
21886 glyph
->type
= IMAGE_GLYPH
;
21887 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21888 glyph
->multibyte_p
= it
->multibyte_p
;
21889 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21890 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21891 glyph
->overlaps_vertically_p
= 0;
21892 glyph
->padding_p
= 0;
21893 glyph
->glyph_not_available_p
= 0;
21894 glyph
->face_id
= it
->face_id
;
21895 glyph
->u
.img_id
= img
->id
;
21896 glyph
->slice
.img
= slice
;
21897 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21900 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21901 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21903 glyph
->bidi_type
= it
->bidi_it
.type
;
21905 ++it
->glyph_row
->used
[area
];
21908 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21913 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21914 of the glyph, WIDTH and HEIGHT are the width and height of the
21915 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21918 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21919 int width
, int height
, int ascent
)
21921 struct glyph
*glyph
;
21922 enum glyph_row_area area
= it
->area
;
21924 xassert (ascent
>= 0 && ascent
<= height
);
21926 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21927 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21929 /* If the glyph row is reversed, we need to prepend the glyph
21930 rather than append it. */
21931 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21935 /* Make room for the additional glyph. */
21936 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21938 glyph
= it
->glyph_row
->glyphs
[area
];
21940 glyph
->charpos
= CHARPOS (it
->position
);
21941 glyph
->object
= object
;
21942 glyph
->pixel_width
= width
;
21943 glyph
->ascent
= ascent
;
21944 glyph
->descent
= height
- ascent
;
21945 glyph
->voffset
= it
->voffset
;
21946 glyph
->type
= STRETCH_GLYPH
;
21947 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21948 glyph
->multibyte_p
= it
->multibyte_p
;
21949 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21950 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21951 glyph
->overlaps_vertically_p
= 0;
21952 glyph
->padding_p
= 0;
21953 glyph
->glyph_not_available_p
= 0;
21954 glyph
->face_id
= it
->face_id
;
21955 glyph
->u
.stretch
.ascent
= ascent
;
21956 glyph
->u
.stretch
.height
= height
;
21957 glyph
->slice
.img
= null_glyph_slice
;
21958 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21961 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21962 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21964 glyph
->bidi_type
= it
->bidi_it
.type
;
21968 glyph
->resolved_level
= 0;
21969 glyph
->bidi_type
= UNKNOWN_BT
;
21971 ++it
->glyph_row
->used
[area
];
21974 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21978 /* Produce a stretch glyph for iterator IT. IT->object is the value
21979 of the glyph property displayed. The value must be a list
21980 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21983 1. `:width WIDTH' specifies that the space should be WIDTH *
21984 canonical char width wide. WIDTH may be an integer or floating
21987 2. `:relative-width FACTOR' specifies that the width of the stretch
21988 should be computed from the width of the first character having the
21989 `glyph' property, and should be FACTOR times that width.
21991 3. `:align-to HPOS' specifies that the space should be wide enough
21992 to reach HPOS, a value in canonical character units.
21994 Exactly one of the above pairs must be present.
21996 4. `:height HEIGHT' specifies that the height of the stretch produced
21997 should be HEIGHT, measured in canonical character units.
21999 5. `:relative-height FACTOR' specifies that the height of the
22000 stretch should be FACTOR times the height of the characters having
22001 the glyph property.
22003 Either none or exactly one of 4 or 5 must be present.
22005 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22006 of the stretch should be used for the ascent of the stretch.
22007 ASCENT must be in the range 0 <= ASCENT <= 100. */
22010 produce_stretch_glyph (struct it
*it
)
22012 /* (space :width WIDTH :height HEIGHT ...) */
22013 Lisp_Object prop
, plist
;
22014 int width
= 0, height
= 0, align_to
= -1;
22015 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22018 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22019 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22021 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22023 /* List should start with `space'. */
22024 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22025 plist
= XCDR (it
->object
);
22027 /* Compute the width of the stretch. */
22028 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22029 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22031 /* Absolute width `:width WIDTH' specified and valid. */
22032 zero_width_ok_p
= 1;
22035 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22038 /* Relative width `:relative-width FACTOR' specified and valid.
22039 Compute the width of the characters having the `glyph'
22042 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22045 if (it
->multibyte_p
)
22046 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22049 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22050 if (! ASCII_CHAR_P (it2
.c
))
22051 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22054 it2
.glyph_row
= NULL
;
22055 it2
.what
= IT_CHARACTER
;
22056 x_produce_glyphs (&it2
);
22057 width
= NUMVAL (prop
) * it2
.pixel_width
;
22059 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22060 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22062 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22063 align_to
= (align_to
< 0
22065 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22066 else if (align_to
< 0)
22067 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22068 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22069 zero_width_ok_p
= 1;
22072 /* Nothing specified -> width defaults to canonical char width. */
22073 width
= FRAME_COLUMN_WIDTH (it
->f
);
22075 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22078 /* Compute height. */
22079 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22080 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22083 zero_height_ok_p
= 1;
22085 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22087 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22089 height
= FONT_HEIGHT (font
);
22091 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22094 /* Compute percentage of height used for ascent. If
22095 `:ascent ASCENT' is present and valid, use that. Otherwise,
22096 derive the ascent from the font in use. */
22097 if (prop
= Fplist_get (plist
, QCascent
),
22098 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22099 ascent
= height
* NUMVAL (prop
) / 100.0;
22100 else if (!NILP (prop
)
22101 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22102 ascent
= min (max (0, (int)tem
), height
);
22104 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22106 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22107 && it
->current_x
+ width
> it
->last_visible_x
)
22108 width
= it
->last_visible_x
- it
->current_x
- 1;
22110 if (width
> 0 && height
> 0 && it
->glyph_row
)
22112 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22113 if (!STRINGP (object
))
22114 object
= it
->w
->buffer
;
22115 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22118 it
->pixel_width
= width
;
22119 it
->ascent
= it
->phys_ascent
= ascent
;
22120 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22121 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22123 take_vertical_position_into_account (it
);
22126 /* Calculate line-height and line-spacing properties.
22127 An integer value specifies explicit pixel value.
22128 A float value specifies relative value to current face height.
22129 A cons (float . face-name) specifies relative value to
22130 height of specified face font.
22132 Returns height in pixels, or nil. */
22136 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22137 int boff
, int override
)
22139 Lisp_Object face_name
= Qnil
;
22140 int ascent
, descent
, height
;
22142 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22147 face_name
= XCAR (val
);
22149 if (!NUMBERP (val
))
22150 val
= make_number (1);
22151 if (NILP (face_name
))
22153 height
= it
->ascent
+ it
->descent
;
22158 if (NILP (face_name
))
22160 font
= FRAME_FONT (it
->f
);
22161 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22163 else if (EQ (face_name
, Qt
))
22172 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22174 return make_number (-1);
22176 face
= FACE_FROM_ID (it
->f
, face_id
);
22179 return make_number (-1);
22180 boff
= font
->baseline_offset
;
22181 if (font
->vertical_centering
)
22182 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22185 ascent
= FONT_BASE (font
) + boff
;
22186 descent
= FONT_DESCENT (font
) - boff
;
22190 it
->override_ascent
= ascent
;
22191 it
->override_descent
= descent
;
22192 it
->override_boff
= boff
;
22195 height
= ascent
+ descent
;
22199 height
= (int)(XFLOAT_DATA (val
) * height
);
22200 else if (INTEGERP (val
))
22201 height
*= XINT (val
);
22203 return make_number (height
);
22207 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22208 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22209 and only if this is for a character for which no font was found.
22211 If the display method (it->glyphless_method) is
22212 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22213 length of the acronym or the hexadecimal string, UPPER_XOFF and
22214 UPPER_YOFF are pixel offsets for the upper part of the string,
22215 LOWER_XOFF and LOWER_YOFF are for the lower part.
22217 For the other display methods, LEN through LOWER_YOFF are zero. */
22220 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22221 short upper_xoff
, short upper_yoff
,
22222 short lower_xoff
, short lower_yoff
)
22224 struct glyph
*glyph
;
22225 enum glyph_row_area area
= it
->area
;
22227 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22228 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22230 /* If the glyph row is reversed, we need to prepend the glyph
22231 rather than append it. */
22232 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22236 /* Make room for the additional glyph. */
22237 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22239 glyph
= it
->glyph_row
->glyphs
[area
];
22241 glyph
->charpos
= CHARPOS (it
->position
);
22242 glyph
->object
= it
->object
;
22243 glyph
->pixel_width
= it
->pixel_width
;
22244 glyph
->ascent
= it
->ascent
;
22245 glyph
->descent
= it
->descent
;
22246 glyph
->voffset
= it
->voffset
;
22247 glyph
->type
= GLYPHLESS_GLYPH
;
22248 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22249 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22250 glyph
->u
.glyphless
.len
= len
;
22251 glyph
->u
.glyphless
.ch
= it
->c
;
22252 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22253 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22254 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22255 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22256 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22257 glyph
->multibyte_p
= it
->multibyte_p
;
22258 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22259 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22260 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22261 || it
->phys_descent
> it
->descent
);
22262 glyph
->padding_p
= 0;
22263 glyph
->glyph_not_available_p
= 0;
22264 glyph
->face_id
= face_id
;
22265 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22268 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22269 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22271 glyph
->bidi_type
= it
->bidi_it
.type
;
22273 ++it
->glyph_row
->used
[area
];
22276 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22280 /* Produce a glyph for a glyphless character for iterator IT.
22281 IT->glyphless_method specifies which method to use for displaying
22282 the character. See the description of enum
22283 glyphless_display_method in dispextern.h for the detail.
22285 FOR_NO_FONT is nonzero if and only if this is for a character for
22286 which no font was found. ACRONYM, if non-nil, is an acronym string
22287 for the character. */
22290 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22295 int base_width
, base_height
, width
, height
;
22296 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22299 /* Get the metrics of the base font. We always refer to the current
22301 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22302 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22303 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22304 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22305 base_height
= it
->ascent
+ it
->descent
;
22306 base_width
= font
->average_width
;
22308 /* Get a face ID for the glyph by utilizing a cache (the same way as
22309 doen for `escape-glyph' in get_next_display_element). */
22310 if (it
->f
== last_glyphless_glyph_frame
22311 && it
->face_id
== last_glyphless_glyph_face_id
)
22313 face_id
= last_glyphless_glyph_merged_face_id
;
22317 /* Merge the `glyphless-char' face into the current face. */
22318 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22319 last_glyphless_glyph_frame
= it
->f
;
22320 last_glyphless_glyph_face_id
= it
->face_id
;
22321 last_glyphless_glyph_merged_face_id
= face_id
;
22324 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22326 it
->pixel_width
= THIN_SPACE_WIDTH
;
22328 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22330 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22332 width
= CHAR_WIDTH (it
->c
);
22335 else if (width
> 4)
22337 it
->pixel_width
= base_width
* width
;
22339 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22345 unsigned int code
[6];
22347 int ascent
, descent
;
22348 struct font_metrics metrics_upper
, metrics_lower
;
22350 face
= FACE_FROM_ID (it
->f
, face_id
);
22351 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22352 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22354 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22356 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22357 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22358 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22362 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22363 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22366 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22367 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22368 upper_len
= (len
+ 1) / 2;
22369 font
->driver
->text_extents (font
, code
, upper_len
,
22371 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22376 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22377 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22378 upper_xoff
= upper_yoff
= 2; /* the typical case */
22379 if (base_width
>= width
)
22381 /* Align the upper to the left, the lower to the right. */
22382 it
->pixel_width
= base_width
;
22383 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22387 /* Center the shorter one. */
22388 it
->pixel_width
= width
;
22389 if (metrics_upper
.width
>= metrics_lower
.width
)
22390 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22393 /* FIXME: This code doesn't look right. It formerly was
22394 missing the "lower_xoff = 0;", which couldn't have
22395 been right since it left lower_xoff uninitialized. */
22397 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22401 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22402 top, bottom, and between upper and lower strings. */
22403 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22404 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22405 /* Center vertically.
22406 H:base_height, D:base_descent
22407 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22409 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22410 descent = D - H/2 + h/2;
22411 lower_yoff = descent - 2 - ld;
22412 upper_yoff = lower_yoff - la - 1 - ud; */
22413 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22414 descent
= it
->descent
- (base_height
- height
) / 2;
22415 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22416 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22417 - metrics_upper
.descent
);
22418 /* Don't make the height shorter than the base height. */
22419 if (height
> base_height
)
22421 it
->ascent
= ascent
;
22422 it
->descent
= descent
;
22426 it
->phys_ascent
= it
->ascent
;
22427 it
->phys_descent
= it
->descent
;
22429 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22430 upper_xoff
, upper_yoff
,
22431 lower_xoff
, lower_yoff
);
22433 take_vertical_position_into_account (it
);
22438 Produce glyphs/get display metrics for the display element IT is
22439 loaded with. See the description of struct it in dispextern.h
22440 for an overview of struct it. */
22443 x_produce_glyphs (struct it
*it
)
22445 int extra_line_spacing
= it
->extra_line_spacing
;
22447 it
->glyph_not_available_p
= 0;
22449 if (it
->what
== IT_CHARACTER
)
22452 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22453 struct font
*font
= face
->font
;
22454 struct font_metrics
*pcm
= NULL
;
22455 int boff
; /* baseline offset */
22459 /* When no suitable font is found, display this character by
22460 the method specified in the first extra slot of
22461 Vglyphless_char_display. */
22462 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22464 xassert (it
->what
== IT_GLYPHLESS
);
22465 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22469 boff
= font
->baseline_offset
;
22470 if (font
->vertical_centering
)
22471 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22473 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22479 if (it
->override_ascent
>= 0)
22481 it
->ascent
= it
->override_ascent
;
22482 it
->descent
= it
->override_descent
;
22483 boff
= it
->override_boff
;
22487 it
->ascent
= FONT_BASE (font
) + boff
;
22488 it
->descent
= FONT_DESCENT (font
) - boff
;
22491 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22493 pcm
= get_per_char_metric (font
, &char2b
);
22494 if (pcm
->width
== 0
22495 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22501 it
->phys_ascent
= pcm
->ascent
+ boff
;
22502 it
->phys_descent
= pcm
->descent
- boff
;
22503 it
->pixel_width
= pcm
->width
;
22507 it
->glyph_not_available_p
= 1;
22508 it
->phys_ascent
= it
->ascent
;
22509 it
->phys_descent
= it
->descent
;
22510 it
->pixel_width
= font
->space_width
;
22513 if (it
->constrain_row_ascent_descent_p
)
22515 if (it
->descent
> it
->max_descent
)
22517 it
->ascent
+= it
->descent
- it
->max_descent
;
22518 it
->descent
= it
->max_descent
;
22520 if (it
->ascent
> it
->max_ascent
)
22522 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22523 it
->ascent
= it
->max_ascent
;
22525 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22526 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22527 extra_line_spacing
= 0;
22530 /* If this is a space inside a region of text with
22531 `space-width' property, change its width. */
22532 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22534 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22536 /* If face has a box, add the box thickness to the character
22537 height. If character has a box line to the left and/or
22538 right, add the box line width to the character's width. */
22539 if (face
->box
!= FACE_NO_BOX
)
22541 int thick
= face
->box_line_width
;
22545 it
->ascent
+= thick
;
22546 it
->descent
+= thick
;
22551 if (it
->start_of_box_run_p
)
22552 it
->pixel_width
+= thick
;
22553 if (it
->end_of_box_run_p
)
22554 it
->pixel_width
+= thick
;
22557 /* If face has an overline, add the height of the overline
22558 (1 pixel) and a 1 pixel margin to the character height. */
22559 if (face
->overline_p
)
22560 it
->ascent
+= overline_margin
;
22562 if (it
->constrain_row_ascent_descent_p
)
22564 if (it
->ascent
> it
->max_ascent
)
22565 it
->ascent
= it
->max_ascent
;
22566 if (it
->descent
> it
->max_descent
)
22567 it
->descent
= it
->max_descent
;
22570 take_vertical_position_into_account (it
);
22572 /* If we have to actually produce glyphs, do it. */
22577 /* Translate a space with a `space-width' property
22578 into a stretch glyph. */
22579 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22580 / FONT_HEIGHT (font
));
22581 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22582 it
->ascent
+ it
->descent
, ascent
);
22587 /* If characters with lbearing or rbearing are displayed
22588 in this line, record that fact in a flag of the
22589 glyph row. This is used to optimize X output code. */
22590 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22591 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22593 if (! stretched_p
&& it
->pixel_width
== 0)
22594 /* We assure that all visible glyphs have at least 1-pixel
22596 it
->pixel_width
= 1;
22598 else if (it
->char_to_display
== '\n')
22600 /* A newline has no width, but we need the height of the
22601 line. But if previous part of the line sets a height,
22602 don't increase that height */
22604 Lisp_Object height
;
22605 Lisp_Object total_height
= Qnil
;
22607 it
->override_ascent
= -1;
22608 it
->pixel_width
= 0;
22611 height
= get_it_property (it
, Qline_height
);
22612 /* Split (line-height total-height) list */
22614 && CONSP (XCDR (height
))
22615 && NILP (XCDR (XCDR (height
))))
22617 total_height
= XCAR (XCDR (height
));
22618 height
= XCAR (height
);
22620 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22622 if (it
->override_ascent
>= 0)
22624 it
->ascent
= it
->override_ascent
;
22625 it
->descent
= it
->override_descent
;
22626 boff
= it
->override_boff
;
22630 it
->ascent
= FONT_BASE (font
) + boff
;
22631 it
->descent
= FONT_DESCENT (font
) - boff
;
22634 if (EQ (height
, Qt
))
22636 if (it
->descent
> it
->max_descent
)
22638 it
->ascent
+= it
->descent
- it
->max_descent
;
22639 it
->descent
= it
->max_descent
;
22641 if (it
->ascent
> it
->max_ascent
)
22643 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22644 it
->ascent
= it
->max_ascent
;
22646 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22647 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22648 it
->constrain_row_ascent_descent_p
= 1;
22649 extra_line_spacing
= 0;
22653 Lisp_Object spacing
;
22655 it
->phys_ascent
= it
->ascent
;
22656 it
->phys_descent
= it
->descent
;
22658 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22659 && face
->box
!= FACE_NO_BOX
22660 && face
->box_line_width
> 0)
22662 it
->ascent
+= face
->box_line_width
;
22663 it
->descent
+= face
->box_line_width
;
22666 && XINT (height
) > it
->ascent
+ it
->descent
)
22667 it
->ascent
= XINT (height
) - it
->descent
;
22669 if (!NILP (total_height
))
22670 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22673 spacing
= get_it_property (it
, Qline_spacing
);
22674 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22676 if (INTEGERP (spacing
))
22678 extra_line_spacing
= XINT (spacing
);
22679 if (!NILP (total_height
))
22680 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22684 else /* i.e. (it->char_to_display == '\t') */
22686 if (font
->space_width
> 0)
22688 int tab_width
= it
->tab_width
* font
->space_width
;
22689 int x
= it
->current_x
+ it
->continuation_lines_width
;
22690 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22692 /* If the distance from the current position to the next tab
22693 stop is less than a space character width, use the
22694 tab stop after that. */
22695 if (next_tab_x
- x
< font
->space_width
)
22696 next_tab_x
+= tab_width
;
22698 it
->pixel_width
= next_tab_x
- x
;
22700 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22701 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22705 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22706 it
->ascent
+ it
->descent
, it
->ascent
);
22711 it
->pixel_width
= 0;
22716 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22718 /* A static composition.
22720 Note: A composition is represented as one glyph in the
22721 glyph matrix. There are no padding glyphs.
22723 Important note: pixel_width, ascent, and descent are the
22724 values of what is drawn by draw_glyphs (i.e. the values of
22725 the overall glyphs composed). */
22726 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22727 int boff
; /* baseline offset */
22728 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22729 int glyph_len
= cmp
->glyph_len
;
22730 struct font
*font
= face
->font
;
22734 /* If we have not yet calculated pixel size data of glyphs of
22735 the composition for the current face font, calculate them
22736 now. Theoretically, we have to check all fonts for the
22737 glyphs, but that requires much time and memory space. So,
22738 here we check only the font of the first glyph. This may
22739 lead to incorrect display, but it's very rare, and C-l
22740 (recenter-top-bottom) can correct the display anyway. */
22741 if (! cmp
->font
|| cmp
->font
!= font
)
22743 /* Ascent and descent of the font of the first character
22744 of this composition (adjusted by baseline offset).
22745 Ascent and descent of overall glyphs should not be less
22746 than these, respectively. */
22747 int font_ascent
, font_descent
, font_height
;
22748 /* Bounding box of the overall glyphs. */
22749 int leftmost
, rightmost
, lowest
, highest
;
22750 int lbearing
, rbearing
;
22751 int i
, width
, ascent
, descent
;
22752 int left_padded
= 0, right_padded
= 0;
22755 struct font_metrics
*pcm
;
22756 int font_not_found_p
;
22759 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22760 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22762 if (glyph_len
< cmp
->glyph_len
)
22764 for (i
= 0; i
< glyph_len
; i
++)
22766 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22768 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22773 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22774 : IT_CHARPOS (*it
));
22775 /* If no suitable font is found, use the default font. */
22776 font_not_found_p
= font
== NULL
;
22777 if (font_not_found_p
)
22779 face
= face
->ascii_face
;
22782 boff
= font
->baseline_offset
;
22783 if (font
->vertical_centering
)
22784 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22785 font_ascent
= FONT_BASE (font
) + boff
;
22786 font_descent
= FONT_DESCENT (font
) - boff
;
22787 font_height
= FONT_HEIGHT (font
);
22789 cmp
->font
= (void *) font
;
22792 if (! font_not_found_p
)
22794 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22796 pcm
= get_per_char_metric (font
, &char2b
);
22799 /* Initialize the bounding box. */
22802 width
= pcm
->width
;
22803 ascent
= pcm
->ascent
;
22804 descent
= pcm
->descent
;
22805 lbearing
= pcm
->lbearing
;
22806 rbearing
= pcm
->rbearing
;
22810 width
= font
->space_width
;
22811 ascent
= FONT_BASE (font
);
22812 descent
= FONT_DESCENT (font
);
22819 lowest
= - descent
+ boff
;
22820 highest
= ascent
+ boff
;
22822 if (! font_not_found_p
22823 && font
->default_ascent
22824 && CHAR_TABLE_P (Vuse_default_ascent
)
22825 && !NILP (Faref (Vuse_default_ascent
,
22826 make_number (it
->char_to_display
))))
22827 highest
= font
->default_ascent
+ boff
;
22829 /* Draw the first glyph at the normal position. It may be
22830 shifted to right later if some other glyphs are drawn
22832 cmp
->offsets
[i
* 2] = 0;
22833 cmp
->offsets
[i
* 2 + 1] = boff
;
22834 cmp
->lbearing
= lbearing
;
22835 cmp
->rbearing
= rbearing
;
22837 /* Set cmp->offsets for the remaining glyphs. */
22838 for (i
++; i
< glyph_len
; i
++)
22840 int left
, right
, btm
, top
;
22841 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22843 struct face
*this_face
;
22847 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22848 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22849 font
= this_face
->font
;
22855 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22857 pcm
= get_per_char_metric (font
, &char2b
);
22860 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22863 width
= pcm
->width
;
22864 ascent
= pcm
->ascent
;
22865 descent
= pcm
->descent
;
22866 lbearing
= pcm
->lbearing
;
22867 rbearing
= pcm
->rbearing
;
22868 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22870 /* Relative composition with or without
22871 alternate chars. */
22872 left
= (leftmost
+ rightmost
- width
) / 2;
22873 btm
= - descent
+ boff
;
22874 if (font
->relative_compose
22875 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22876 || NILP (Faref (Vignore_relative_composition
,
22877 make_number (ch
)))))
22880 if (- descent
>= font
->relative_compose
)
22881 /* One extra pixel between two glyphs. */
22883 else if (ascent
<= 0)
22884 /* One extra pixel between two glyphs. */
22885 btm
= lowest
- 1 - ascent
- descent
;
22890 /* A composition rule is specified by an integer
22891 value that encodes global and new reference
22892 points (GREF and NREF). GREF and NREF are
22893 specified by numbers as below:
22895 0---1---2 -- ascent
22899 9--10--11 -- center
22901 ---3---4---5--- baseline
22903 6---7---8 -- descent
22905 int rule
= COMPOSITION_RULE (cmp
, i
);
22906 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22908 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22909 grefx
= gref
% 3, nrefx
= nref
% 3;
22910 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22912 xoff
= font_height
* (xoff
- 128) / 256;
22914 yoff
= font_height
* (yoff
- 128) / 256;
22917 + grefx
* (rightmost
- leftmost
) / 2
22918 - nrefx
* width
/ 2
22921 btm
= ((grefy
== 0 ? highest
22923 : grefy
== 2 ? lowest
22924 : (highest
+ lowest
) / 2)
22925 - (nrefy
== 0 ? ascent
+ descent
22926 : nrefy
== 1 ? descent
- boff
22928 : (ascent
+ descent
) / 2)
22932 cmp
->offsets
[i
* 2] = left
;
22933 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22935 /* Update the bounding box of the overall glyphs. */
22938 right
= left
+ width
;
22939 if (left
< leftmost
)
22941 if (right
> rightmost
)
22944 top
= btm
+ descent
+ ascent
;
22950 if (cmp
->lbearing
> left
+ lbearing
)
22951 cmp
->lbearing
= left
+ lbearing
;
22952 if (cmp
->rbearing
< left
+ rbearing
)
22953 cmp
->rbearing
= left
+ rbearing
;
22957 /* If there are glyphs whose x-offsets are negative,
22958 shift all glyphs to the right and make all x-offsets
22962 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22963 cmp
->offsets
[i
* 2] -= leftmost
;
22964 rightmost
-= leftmost
;
22965 cmp
->lbearing
-= leftmost
;
22966 cmp
->rbearing
-= leftmost
;
22969 if (left_padded
&& cmp
->lbearing
< 0)
22971 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22972 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22973 rightmost
-= cmp
->lbearing
;
22974 cmp
->rbearing
-= cmp
->lbearing
;
22977 if (right_padded
&& rightmost
< cmp
->rbearing
)
22979 rightmost
= cmp
->rbearing
;
22982 cmp
->pixel_width
= rightmost
;
22983 cmp
->ascent
= highest
;
22984 cmp
->descent
= - lowest
;
22985 if (cmp
->ascent
< font_ascent
)
22986 cmp
->ascent
= font_ascent
;
22987 if (cmp
->descent
< font_descent
)
22988 cmp
->descent
= font_descent
;
22992 && (cmp
->lbearing
< 0
22993 || cmp
->rbearing
> cmp
->pixel_width
))
22994 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22996 it
->pixel_width
= cmp
->pixel_width
;
22997 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22998 it
->descent
= it
->phys_descent
= cmp
->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
;
23017 /* If face has an overline, add the height of the overline
23018 (1 pixel) and a 1 pixel margin to the character height. */
23019 if (face
->overline_p
)
23020 it
->ascent
+= overline_margin
;
23022 take_vertical_position_into_account (it
);
23023 if (it
->ascent
< 0)
23025 if (it
->descent
< 0)
23029 append_composite_glyph (it
);
23031 else if (it
->what
== IT_COMPOSITION
)
23033 /* A dynamic (automatic) composition. */
23034 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23035 Lisp_Object gstring
;
23036 struct font_metrics metrics
;
23038 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23040 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23043 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23044 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23045 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23046 it
->descent
= it
->phys_descent
= metrics
.descent
;
23047 if (face
->box
!= FACE_NO_BOX
)
23049 int thick
= face
->box_line_width
;
23053 it
->ascent
+= thick
;
23054 it
->descent
+= thick
;
23059 if (it
->start_of_box_run_p
)
23060 it
->pixel_width
+= thick
;
23061 if (it
->end_of_box_run_p
)
23062 it
->pixel_width
+= thick
;
23064 /* If face has an overline, add the height of the overline
23065 (1 pixel) and a 1 pixel margin to the character height. */
23066 if (face
->overline_p
)
23067 it
->ascent
+= overline_margin
;
23068 take_vertical_position_into_account (it
);
23069 if (it
->ascent
< 0)
23071 if (it
->descent
< 0)
23075 append_composite_glyph (it
);
23077 else if (it
->what
== IT_GLYPHLESS
)
23078 produce_glyphless_glyph (it
, 0, Qnil
);
23079 else if (it
->what
== IT_IMAGE
)
23080 produce_image_glyph (it
);
23081 else if (it
->what
== IT_STRETCH
)
23082 produce_stretch_glyph (it
);
23085 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23086 because this isn't true for images with `:ascent 100'. */
23087 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23088 if (it
->area
== TEXT_AREA
)
23089 it
->current_x
+= it
->pixel_width
;
23091 if (extra_line_spacing
> 0)
23093 it
->descent
+= extra_line_spacing
;
23094 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23095 it
->max_extra_line_spacing
= extra_line_spacing
;
23098 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23099 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23100 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23101 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23105 Output LEN glyphs starting at START at the nominal cursor position.
23106 Advance the nominal cursor over the text. The global variable
23107 updated_window contains the window being updated, updated_row is
23108 the glyph row being updated, and updated_area is the area of that
23109 row being updated. */
23112 x_write_glyphs (struct glyph
*start
, int len
)
23116 xassert (updated_window
&& updated_row
);
23119 /* Write glyphs. */
23121 hpos
= start
- updated_row
->glyphs
[updated_area
];
23122 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23123 updated_row
, updated_area
,
23125 DRAW_NORMAL_TEXT
, 0);
23127 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23128 if (updated_area
== TEXT_AREA
23129 && updated_window
->phys_cursor_on_p
23130 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23131 && updated_window
->phys_cursor
.hpos
>= hpos
23132 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23133 updated_window
->phys_cursor_on_p
= 0;
23137 /* Advance the output cursor. */
23138 output_cursor
.hpos
+= len
;
23139 output_cursor
.x
= x
;
23144 Insert LEN glyphs from START at the nominal cursor position. */
23147 x_insert_glyphs (struct glyph
*start
, int len
)
23151 int line_height
, shift_by_width
, shifted_region_width
;
23152 struct glyph_row
*row
;
23153 struct glyph
*glyph
;
23154 int frame_x
, frame_y
;
23157 xassert (updated_window
&& updated_row
);
23159 w
= updated_window
;
23160 f
= XFRAME (WINDOW_FRAME (w
));
23162 /* Get the height of the line we are in. */
23164 line_height
= row
->height
;
23166 /* Get the width of the glyphs to insert. */
23167 shift_by_width
= 0;
23168 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23169 shift_by_width
+= glyph
->pixel_width
;
23171 /* Get the width of the region to shift right. */
23172 shifted_region_width
= (window_box_width (w
, updated_area
)
23177 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23178 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23180 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23181 line_height
, shift_by_width
);
23183 /* Write the glyphs. */
23184 hpos
= start
- row
->glyphs
[updated_area
];
23185 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23187 DRAW_NORMAL_TEXT
, 0);
23189 /* Advance the output cursor. */
23190 output_cursor
.hpos
+= len
;
23191 output_cursor
.x
+= shift_by_width
;
23197 Erase the current text line from the nominal cursor position
23198 (inclusive) to pixel column TO_X (exclusive). The idea is that
23199 everything from TO_X onward is already erased.
23201 TO_X is a pixel position relative to updated_area of
23202 updated_window. TO_X == -1 means clear to the end of this area. */
23205 x_clear_end_of_line (int to_x
)
23208 struct window
*w
= updated_window
;
23209 int max_x
, min_y
, max_y
;
23210 int from_x
, from_y
, to_y
;
23212 xassert (updated_window
&& updated_row
);
23213 f
= XFRAME (w
->frame
);
23215 if (updated_row
->full_width_p
)
23216 max_x
= WINDOW_TOTAL_WIDTH (w
);
23218 max_x
= window_box_width (w
, updated_area
);
23219 max_y
= window_text_bottom_y (w
);
23221 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23222 of window. For TO_X > 0, truncate to end of drawing area. */
23228 to_x
= min (to_x
, max_x
);
23230 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23232 /* Notice if the cursor will be cleared by this operation. */
23233 if (!updated_row
->full_width_p
)
23234 notice_overwritten_cursor (w
, updated_area
,
23235 output_cursor
.x
, -1,
23237 MATRIX_ROW_BOTTOM_Y (updated_row
));
23239 from_x
= output_cursor
.x
;
23241 /* Translate to frame coordinates. */
23242 if (updated_row
->full_width_p
)
23244 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23245 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23249 int area_left
= window_box_left (w
, updated_area
);
23250 from_x
+= area_left
;
23254 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23255 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23256 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23258 /* Prevent inadvertently clearing to end of the X window. */
23259 if (to_x
> from_x
&& to_y
> from_y
)
23262 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23263 to_x
- from_x
, to_y
- from_y
);
23268 #endif /* HAVE_WINDOW_SYSTEM */
23272 /***********************************************************************
23274 ***********************************************************************/
23276 /* Value is the internal representation of the specified cursor type
23277 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23278 of the bar cursor. */
23280 static enum text_cursor_kinds
23281 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23283 enum text_cursor_kinds type
;
23288 if (EQ (arg
, Qbox
))
23289 return FILLED_BOX_CURSOR
;
23291 if (EQ (arg
, Qhollow
))
23292 return HOLLOW_BOX_CURSOR
;
23294 if (EQ (arg
, Qbar
))
23301 && EQ (XCAR (arg
), Qbar
)
23302 && INTEGERP (XCDR (arg
))
23303 && XINT (XCDR (arg
)) >= 0)
23305 *width
= XINT (XCDR (arg
));
23309 if (EQ (arg
, Qhbar
))
23312 return HBAR_CURSOR
;
23316 && EQ (XCAR (arg
), Qhbar
)
23317 && INTEGERP (XCDR (arg
))
23318 && XINT (XCDR (arg
)) >= 0)
23320 *width
= XINT (XCDR (arg
));
23321 return HBAR_CURSOR
;
23324 /* Treat anything unknown as "hollow box cursor".
23325 It was bad to signal an error; people have trouble fixing
23326 .Xdefaults with Emacs, when it has something bad in it. */
23327 type
= HOLLOW_BOX_CURSOR
;
23332 /* Set the default cursor types for specified frame. */
23334 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23339 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23340 FRAME_CURSOR_WIDTH (f
) = width
;
23342 /* By default, set up the blink-off state depending on the on-state. */
23344 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23347 FRAME_BLINK_OFF_CURSOR (f
)
23348 = get_specified_cursor_type (XCDR (tem
), &width
);
23349 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23352 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23356 #ifdef HAVE_WINDOW_SYSTEM
23358 /* Return the cursor we want to be displayed in window W. Return
23359 width of bar/hbar cursor through WIDTH arg. Return with
23360 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23361 (i.e. if the `system caret' should track this cursor).
23363 In a mini-buffer window, we want the cursor only to appear if we
23364 are reading input from this window. For the selected window, we
23365 want the cursor type given by the frame parameter or buffer local
23366 setting of cursor-type. If explicitly marked off, draw no cursor.
23367 In all other cases, we want a hollow box cursor. */
23369 static enum text_cursor_kinds
23370 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23371 int *active_cursor
)
23373 struct frame
*f
= XFRAME (w
->frame
);
23374 struct buffer
*b
= XBUFFER (w
->buffer
);
23375 int cursor_type
= DEFAULT_CURSOR
;
23376 Lisp_Object alt_cursor
;
23377 int non_selected
= 0;
23379 *active_cursor
= 1;
23382 if (cursor_in_echo_area
23383 && FRAME_HAS_MINIBUF_P (f
)
23384 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23386 if (w
== XWINDOW (echo_area_window
))
23388 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23390 *width
= FRAME_CURSOR_WIDTH (f
);
23391 return FRAME_DESIRED_CURSOR (f
);
23394 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23397 *active_cursor
= 0;
23401 /* Detect a nonselected window or nonselected frame. */
23402 else if (w
!= XWINDOW (f
->selected_window
)
23403 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23405 *active_cursor
= 0;
23407 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23413 /* Never display a cursor in a window in which cursor-type is nil. */
23414 if (NILP (BVAR (b
, cursor_type
)))
23417 /* Get the normal cursor type for this window. */
23418 if (EQ (BVAR (b
, cursor_type
), Qt
))
23420 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23421 *width
= FRAME_CURSOR_WIDTH (f
);
23424 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23426 /* Use cursor-in-non-selected-windows instead
23427 for non-selected window or frame. */
23430 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23431 if (!EQ (Qt
, alt_cursor
))
23432 return get_specified_cursor_type (alt_cursor
, width
);
23433 /* t means modify the normal cursor type. */
23434 if (cursor_type
== FILLED_BOX_CURSOR
)
23435 cursor_type
= HOLLOW_BOX_CURSOR
;
23436 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23438 return cursor_type
;
23441 /* Use normal cursor if not blinked off. */
23442 if (!w
->cursor_off_p
)
23444 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23446 if (cursor_type
== FILLED_BOX_CURSOR
)
23448 /* Using a block cursor on large images can be very annoying.
23449 So use a hollow cursor for "large" images.
23450 If image is not transparent (no mask), also use hollow cursor. */
23451 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23452 if (img
!= NULL
&& IMAGEP (img
->spec
))
23454 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23455 where N = size of default frame font size.
23456 This should cover most of the "tiny" icons people may use. */
23458 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23459 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23460 cursor_type
= HOLLOW_BOX_CURSOR
;
23463 else if (cursor_type
!= NO_CURSOR
)
23465 /* Display current only supports BOX and HOLLOW cursors for images.
23466 So for now, unconditionally use a HOLLOW cursor when cursor is
23467 not a solid box cursor. */
23468 cursor_type
= HOLLOW_BOX_CURSOR
;
23471 return cursor_type
;
23474 /* Cursor is blinked off, so determine how to "toggle" it. */
23476 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23477 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23478 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23480 /* Then see if frame has specified a specific blink off cursor type. */
23481 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23483 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23484 return FRAME_BLINK_OFF_CURSOR (f
);
23488 /* Some people liked having a permanently visible blinking cursor,
23489 while others had very strong opinions against it. So it was
23490 decided to remove it. KFS 2003-09-03 */
23492 /* Finally perform built-in cursor blinking:
23493 filled box <-> hollow box
23494 wide [h]bar <-> narrow [h]bar
23495 narrow [h]bar <-> no cursor
23496 other type <-> no cursor */
23498 if (cursor_type
== FILLED_BOX_CURSOR
)
23499 return HOLLOW_BOX_CURSOR
;
23501 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23504 return cursor_type
;
23512 /* Notice when the text cursor of window W has been completely
23513 overwritten by a drawing operation that outputs glyphs in AREA
23514 starting at X0 and ending at X1 in the line starting at Y0 and
23515 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23516 the rest of the line after X0 has been written. Y coordinates
23517 are window-relative. */
23520 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23521 int x0
, int x1
, int y0
, int y1
)
23523 int cx0
, cx1
, cy0
, cy1
;
23524 struct glyph_row
*row
;
23526 if (!w
->phys_cursor_on_p
)
23528 if (area
!= TEXT_AREA
)
23531 if (w
->phys_cursor
.vpos
< 0
23532 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23533 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23534 !(row
->enabled_p
&& row
->displays_text_p
)))
23537 if (row
->cursor_in_fringe_p
)
23539 row
->cursor_in_fringe_p
= 0;
23540 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23541 w
->phys_cursor_on_p
= 0;
23545 cx0
= w
->phys_cursor
.x
;
23546 cx1
= cx0
+ w
->phys_cursor_width
;
23547 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23550 /* The cursor image will be completely removed from the
23551 screen if the output area intersects the cursor area in
23552 y-direction. When we draw in [y0 y1[, and some part of
23553 the cursor is at y < y0, that part must have been drawn
23554 before. When scrolling, the cursor is erased before
23555 actually scrolling, so we don't come here. When not
23556 scrolling, the rows above the old cursor row must have
23557 changed, and in this case these rows must have written
23558 over the cursor image.
23560 Likewise if part of the cursor is below y1, with the
23561 exception of the cursor being in the first blank row at
23562 the buffer and window end because update_text_area
23563 doesn't draw that row. (Except when it does, but
23564 that's handled in update_text_area.) */
23566 cy0
= w
->phys_cursor
.y
;
23567 cy1
= cy0
+ w
->phys_cursor_height
;
23568 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23571 w
->phys_cursor_on_p
= 0;
23574 #endif /* HAVE_WINDOW_SYSTEM */
23577 /************************************************************************
23579 ************************************************************************/
23581 #ifdef HAVE_WINDOW_SYSTEM
23584 Fix the display of area AREA of overlapping row ROW in window W
23585 with respect to the overlapping part OVERLAPS. */
23588 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23589 enum glyph_row_area area
, int overlaps
)
23596 for (i
= 0; i
< row
->used
[area
];)
23598 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23600 int start
= i
, start_x
= x
;
23604 x
+= row
->glyphs
[area
][i
].pixel_width
;
23607 while (i
< row
->used
[area
]
23608 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23610 draw_glyphs (w
, start_x
, row
, area
,
23612 DRAW_NORMAL_TEXT
, overlaps
);
23616 x
+= row
->glyphs
[area
][i
].pixel_width
;
23626 Draw the cursor glyph of window W in glyph row ROW. See the
23627 comment of draw_glyphs for the meaning of HL. */
23630 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23631 enum draw_glyphs_face hl
)
23633 /* If cursor hpos is out of bounds, don't draw garbage. This can
23634 happen in mini-buffer windows when switching between echo area
23635 glyphs and mini-buffer. */
23636 if ((row
->reversed_p
23637 ? (w
->phys_cursor
.hpos
>= 0)
23638 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23640 int on_p
= w
->phys_cursor_on_p
;
23642 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23643 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23645 w
->phys_cursor_on_p
= on_p
;
23647 if (hl
== DRAW_CURSOR
)
23648 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23649 /* When we erase the cursor, and ROW is overlapped by other
23650 rows, make sure that these overlapping parts of other rows
23652 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23654 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23656 if (row
> w
->current_matrix
->rows
23657 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23658 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23659 OVERLAPS_ERASED_CURSOR
);
23661 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23662 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23663 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23664 OVERLAPS_ERASED_CURSOR
);
23671 Erase the image of a cursor of window W from the screen. */
23674 erase_phys_cursor (struct window
*w
)
23676 struct frame
*f
= XFRAME (w
->frame
);
23677 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23678 int hpos
= w
->phys_cursor
.hpos
;
23679 int vpos
= w
->phys_cursor
.vpos
;
23680 int mouse_face_here_p
= 0;
23681 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23682 struct glyph_row
*cursor_row
;
23683 struct glyph
*cursor_glyph
;
23684 enum draw_glyphs_face hl
;
23686 /* No cursor displayed or row invalidated => nothing to do on the
23688 if (w
->phys_cursor_type
== NO_CURSOR
)
23689 goto mark_cursor_off
;
23691 /* VPOS >= active_glyphs->nrows means that window has been resized.
23692 Don't bother to erase the cursor. */
23693 if (vpos
>= active_glyphs
->nrows
)
23694 goto mark_cursor_off
;
23696 /* If row containing cursor is marked invalid, there is nothing we
23698 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23699 if (!cursor_row
->enabled_p
)
23700 goto mark_cursor_off
;
23702 /* If line spacing is > 0, old cursor may only be partially visible in
23703 window after split-window. So adjust visible height. */
23704 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23705 window_text_bottom_y (w
) - cursor_row
->y
);
23707 /* If row is completely invisible, don't attempt to delete a cursor which
23708 isn't there. This can happen if cursor is at top of a window, and
23709 we switch to a buffer with a header line in that window. */
23710 if (cursor_row
->visible_height
<= 0)
23711 goto mark_cursor_off
;
23713 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23714 if (cursor_row
->cursor_in_fringe_p
)
23716 cursor_row
->cursor_in_fringe_p
= 0;
23717 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23718 goto mark_cursor_off
;
23721 /* This can happen when the new row is shorter than the old one.
23722 In this case, either draw_glyphs or clear_end_of_line
23723 should have cleared the cursor. Note that we wouldn't be
23724 able to erase the cursor in this case because we don't have a
23725 cursor glyph at hand. */
23726 if ((cursor_row
->reversed_p
23727 ? (w
->phys_cursor
.hpos
< 0)
23728 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23729 goto mark_cursor_off
;
23731 /* If the cursor is in the mouse face area, redisplay that when
23732 we clear the cursor. */
23733 if (! NILP (hlinfo
->mouse_face_window
)
23734 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23735 /* Don't redraw the cursor's spot in mouse face if it is at the
23736 end of a line (on a newline). The cursor appears there, but
23737 mouse highlighting does not. */
23738 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23739 mouse_face_here_p
= 1;
23741 /* Maybe clear the display under the cursor. */
23742 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23745 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23748 cursor_glyph
= get_phys_cursor_glyph (w
);
23749 if (cursor_glyph
== NULL
)
23750 goto mark_cursor_off
;
23752 width
= cursor_glyph
->pixel_width
;
23753 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23754 x
= w
->phys_cursor
.x
;
23756 width
-= left_x
- x
;
23757 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23758 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23759 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23762 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23765 /* Erase the cursor by redrawing the character underneath it. */
23766 if (mouse_face_here_p
)
23767 hl
= DRAW_MOUSE_FACE
;
23769 hl
= DRAW_NORMAL_TEXT
;
23770 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23773 w
->phys_cursor_on_p
= 0;
23774 w
->phys_cursor_type
= NO_CURSOR
;
23779 Display or clear cursor of window W. If ON is zero, clear the
23780 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23781 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23784 display_and_set_cursor (struct window
*w
, int on
,
23785 int hpos
, int vpos
, int x
, int y
)
23787 struct frame
*f
= XFRAME (w
->frame
);
23788 int new_cursor_type
;
23789 int new_cursor_width
;
23791 struct glyph_row
*glyph_row
;
23792 struct glyph
*glyph
;
23794 /* This is pointless on invisible frames, and dangerous on garbaged
23795 windows and frames; in the latter case, the frame or window may
23796 be in the midst of changing its size, and x and y may be off the
23798 if (! FRAME_VISIBLE_P (f
)
23799 || FRAME_GARBAGED_P (f
)
23800 || vpos
>= w
->current_matrix
->nrows
23801 || hpos
>= w
->current_matrix
->matrix_w
)
23804 /* If cursor is off and we want it off, return quickly. */
23805 if (!on
&& !w
->phys_cursor_on_p
)
23808 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23809 /* If cursor row is not enabled, we don't really know where to
23810 display the cursor. */
23811 if (!glyph_row
->enabled_p
)
23813 w
->phys_cursor_on_p
= 0;
23818 if (!glyph_row
->exact_window_width_line_p
23819 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23820 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23822 xassert (interrupt_input_blocked
);
23824 /* Set new_cursor_type to the cursor we want to be displayed. */
23825 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23826 &new_cursor_width
, &active_cursor
);
23828 /* If cursor is currently being shown and we don't want it to be or
23829 it is in the wrong place, or the cursor type is not what we want,
23831 if (w
->phys_cursor_on_p
23833 || w
->phys_cursor
.x
!= x
23834 || w
->phys_cursor
.y
!= y
23835 || new_cursor_type
!= w
->phys_cursor_type
23836 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23837 && new_cursor_width
!= w
->phys_cursor_width
)))
23838 erase_phys_cursor (w
);
23840 /* Don't check phys_cursor_on_p here because that flag is only set
23841 to zero in some cases where we know that the cursor has been
23842 completely erased, to avoid the extra work of erasing the cursor
23843 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23844 still not be visible, or it has only been partly erased. */
23847 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23848 w
->phys_cursor_height
= glyph_row
->height
;
23850 /* Set phys_cursor_.* before x_draw_.* is called because some
23851 of them may need the information. */
23852 w
->phys_cursor
.x
= x
;
23853 w
->phys_cursor
.y
= glyph_row
->y
;
23854 w
->phys_cursor
.hpos
= hpos
;
23855 w
->phys_cursor
.vpos
= vpos
;
23858 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23859 new_cursor_type
, new_cursor_width
,
23860 on
, active_cursor
);
23864 /* Switch the display of W's cursor on or off, according to the value
23868 update_window_cursor (struct window
*w
, int on
)
23870 /* Don't update cursor in windows whose frame is in the process
23871 of being deleted. */
23872 if (w
->current_matrix
)
23875 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23876 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23882 /* Call update_window_cursor with parameter ON_P on all leaf windows
23883 in the window tree rooted at W. */
23886 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23890 if (!NILP (w
->hchild
))
23891 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23892 else if (!NILP (w
->vchild
))
23893 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23895 update_window_cursor (w
, on_p
);
23897 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23903 Display the cursor on window W, or clear it, according to ON_P.
23904 Don't change the cursor's position. */
23907 x_update_cursor (struct frame
*f
, int on_p
)
23909 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23914 Clear the cursor of window W to background color, and mark the
23915 cursor as not shown. This is used when the text where the cursor
23916 is about to be rewritten. */
23919 x_clear_cursor (struct window
*w
)
23921 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23922 update_window_cursor (w
, 0);
23925 #endif /* HAVE_WINDOW_SYSTEM */
23927 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23930 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23931 int start_hpos
, int end_hpos
,
23932 enum draw_glyphs_face draw
)
23934 #ifdef HAVE_WINDOW_SYSTEM
23935 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23937 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23941 #if defined (HAVE_GPM) || defined (MSDOS)
23942 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23947 Display the active region described by mouse_face_* according to DRAW. */
23950 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23952 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23953 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23955 if (/* If window is in the process of being destroyed, don't bother
23957 w
->current_matrix
!= NULL
23958 /* Don't update mouse highlight if hidden */
23959 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23960 /* Recognize when we are called to operate on rows that don't exist
23961 anymore. This can happen when a window is split. */
23962 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23964 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23965 struct glyph_row
*row
, *first
, *last
;
23967 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23968 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23970 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23972 int start_hpos
, end_hpos
, start_x
;
23974 /* For all but the first row, the highlight starts at column 0. */
23977 /* R2L rows have BEG and END in reversed order, but the
23978 screen drawing geometry is always left to right. So
23979 we need to mirror the beginning and end of the
23980 highlighted area in R2L rows. */
23981 if (!row
->reversed_p
)
23983 start_hpos
= hlinfo
->mouse_face_beg_col
;
23984 start_x
= hlinfo
->mouse_face_beg_x
;
23986 else if (row
== last
)
23988 start_hpos
= hlinfo
->mouse_face_end_col
;
23989 start_x
= hlinfo
->mouse_face_end_x
;
23997 else if (row
->reversed_p
&& row
== last
)
23999 start_hpos
= hlinfo
->mouse_face_end_col
;
24000 start_x
= hlinfo
->mouse_face_end_x
;
24010 if (!row
->reversed_p
)
24011 end_hpos
= hlinfo
->mouse_face_end_col
;
24012 else if (row
== first
)
24013 end_hpos
= hlinfo
->mouse_face_beg_col
;
24016 end_hpos
= row
->used
[TEXT_AREA
];
24017 if (draw
== DRAW_NORMAL_TEXT
)
24018 row
->fill_line_p
= 1; /* Clear to end of line */
24021 else if (row
->reversed_p
&& row
== first
)
24022 end_hpos
= hlinfo
->mouse_face_beg_col
;
24025 end_hpos
= row
->used
[TEXT_AREA
];
24026 if (draw
== DRAW_NORMAL_TEXT
)
24027 row
->fill_line_p
= 1; /* Clear to end of line */
24030 if (end_hpos
> start_hpos
)
24032 draw_row_with_mouse_face (w
, start_x
, row
,
24033 start_hpos
, end_hpos
, draw
);
24036 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24040 #ifdef HAVE_WINDOW_SYSTEM
24041 /* When we've written over the cursor, arrange for it to
24042 be displayed again. */
24043 if (FRAME_WINDOW_P (f
)
24044 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24047 display_and_set_cursor (w
, 1,
24048 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24049 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24052 #endif /* HAVE_WINDOW_SYSTEM */
24055 #ifdef HAVE_WINDOW_SYSTEM
24056 /* Change the mouse cursor. */
24057 if (FRAME_WINDOW_P (f
))
24059 if (draw
== DRAW_NORMAL_TEXT
24060 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24061 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24062 else if (draw
== DRAW_MOUSE_FACE
)
24063 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24065 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24067 #endif /* HAVE_WINDOW_SYSTEM */
24071 Clear out the mouse-highlighted active region.
24072 Redraw it un-highlighted first. Value is non-zero if mouse
24073 face was actually drawn unhighlighted. */
24076 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24080 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24082 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24086 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24087 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24088 hlinfo
->mouse_face_window
= Qnil
;
24089 hlinfo
->mouse_face_overlay
= Qnil
;
24093 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24094 within the mouse face on that window. */
24096 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24098 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24100 /* Quickly resolve the easy cases. */
24101 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24102 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24104 if (vpos
< hlinfo
->mouse_face_beg_row
24105 || vpos
> hlinfo
->mouse_face_end_row
)
24107 if (vpos
> hlinfo
->mouse_face_beg_row
24108 && vpos
< hlinfo
->mouse_face_end_row
)
24111 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24113 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24115 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24118 else if ((vpos
== hlinfo
->mouse_face_beg_row
24119 && hpos
>= hlinfo
->mouse_face_beg_col
)
24120 || (vpos
== hlinfo
->mouse_face_end_row
24121 && hpos
< hlinfo
->mouse_face_end_col
))
24126 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24128 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24131 else if ((vpos
== hlinfo
->mouse_face_beg_row
24132 && hpos
<= hlinfo
->mouse_face_beg_col
)
24133 || (vpos
== hlinfo
->mouse_face_end_row
24134 && hpos
> hlinfo
->mouse_face_end_col
))
24142 Non-zero if physical cursor of window W is within mouse face. */
24145 cursor_in_mouse_face_p (struct window
*w
)
24147 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24152 /* Find the glyph rows START_ROW and END_ROW of window W that display
24153 characters between buffer positions START_CHARPOS and END_CHARPOS
24154 (excluding END_CHARPOS). This is similar to row_containing_pos,
24155 but is more accurate when bidi reordering makes buffer positions
24156 change non-linearly with glyph rows. */
24158 rows_from_pos_range (struct window
*w
,
24159 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24160 struct glyph_row
**start
, struct glyph_row
**end
)
24162 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24163 int last_y
= window_text_bottom_y (w
);
24164 struct glyph_row
*row
;
24169 while (!first
->enabled_p
24170 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24173 /* Find the START row. */
24175 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24178 /* A row can potentially be the START row if the range of the
24179 characters it displays intersects the range
24180 [START_CHARPOS..END_CHARPOS). */
24181 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24182 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24183 /* See the commentary in row_containing_pos, for the
24184 explanation of the complicated way to check whether
24185 some position is beyond the end of the characters
24186 displayed by a row. */
24187 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24188 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24189 && !row
->ends_at_zv_p
24190 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24191 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24192 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24193 && !row
->ends_at_zv_p
24194 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24196 /* Found a candidate row. Now make sure at least one of the
24197 glyphs it displays has a charpos from the range
24198 [START_CHARPOS..END_CHARPOS).
24200 This is not obvious because bidi reordering could make
24201 buffer positions of a row be 1,2,3,102,101,100, and if we
24202 want to highlight characters in [50..60), we don't want
24203 this row, even though [50..60) does intersect [1..103),
24204 the range of character positions given by the row's start
24205 and end positions. */
24206 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24207 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24211 if (BUFFERP (g
->object
)
24212 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24221 /* Find the END row. */
24223 /* If the last row is partially visible, start looking for END
24224 from that row, instead of starting from FIRST. */
24225 && !(row
->enabled_p
24226 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24228 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24230 struct glyph_row
*next
= row
+ 1;
24232 if (!next
->enabled_p
24233 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24234 /* The first row >= START whose range of displayed characters
24235 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24236 is the row END + 1. */
24237 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24238 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24239 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24240 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24241 && !next
->ends_at_zv_p
24242 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24243 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24244 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24245 && !next
->ends_at_zv_p
24246 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24253 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24254 but none of the characters it displays are in the range, it is
24256 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24257 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24261 if (BUFFERP (g
->object
)
24262 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24275 /* This function sets the mouse_face_* elements of HLINFO, assuming
24276 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24277 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24278 for the overlay or run of text properties specifying the mouse
24279 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24280 before-string and after-string that must also be highlighted.
24281 COVER_STRING, if non-nil, is a display string that may cover some
24282 or all of the highlighted text. */
24285 mouse_face_from_buffer_pos (Lisp_Object window
,
24286 Mouse_HLInfo
*hlinfo
,
24287 EMACS_INT mouse_charpos
,
24288 EMACS_INT start_charpos
,
24289 EMACS_INT end_charpos
,
24290 Lisp_Object before_string
,
24291 Lisp_Object after_string
,
24292 Lisp_Object cover_string
)
24294 struct window
*w
= XWINDOW (window
);
24295 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24296 struct glyph_row
*r1
, *r2
;
24297 struct glyph
*glyph
, *end
;
24298 EMACS_INT ignore
, pos
;
24301 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24302 xassert (NILP (before_string
) || STRINGP (before_string
));
24303 xassert (NILP (after_string
) || STRINGP (after_string
));
24305 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24306 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24308 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24309 /* If the before-string or display-string contains newlines,
24310 rows_from_pos_range skips to its last row. Move back. */
24311 if (!NILP (before_string
) || !NILP (cover_string
))
24313 struct glyph_row
*prev
;
24314 while ((prev
= r1
- 1, prev
>= first
)
24315 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24316 && prev
->used
[TEXT_AREA
] > 0)
24318 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24319 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24320 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24322 || !(EQ (glyph
->object
, before_string
)
24323 || EQ (glyph
->object
, cover_string
)))
24330 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24331 hlinfo
->mouse_face_past_end
= 1;
24333 else if (!NILP (after_string
))
24335 /* If the after-string has newlines, advance to its last row. */
24336 struct glyph_row
*next
;
24337 struct glyph_row
*last
24338 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24340 for (next
= r2
+ 1;
24342 && next
->used
[TEXT_AREA
] > 0
24343 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24347 /* The rest of the display engine assumes that mouse_face_beg_row is
24348 either above below mouse_face_end_row or identical to it. But
24349 with bidi-reordered continued lines, the row for START_CHARPOS
24350 could be below the row for END_CHARPOS. If so, swap the rows and
24351 store them in correct order. */
24354 struct glyph_row
*tem
= r2
;
24360 hlinfo
->mouse_face_beg_y
= r1
->y
;
24361 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24362 hlinfo
->mouse_face_end_y
= r2
->y
;
24363 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24365 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24366 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24367 could be anywhere in the row and in any order. The strategy
24368 below is to find the leftmost and the rightmost glyph that
24369 belongs to either of these 3 strings, or whose position is
24370 between START_CHARPOS and END_CHARPOS, and highlight all the
24371 glyphs between those two. This may cover more than just the text
24372 between START_CHARPOS and END_CHARPOS if the range of characters
24373 strides the bidi level boundary, e.g. if the beginning is in R2L
24374 text while the end is in L2R text or vice versa. */
24375 if (!r1
->reversed_p
)
24377 /* This row is in a left to right paragraph. Scan it left to
24379 glyph
= r1
->glyphs
[TEXT_AREA
];
24380 end
= glyph
+ r1
->used
[TEXT_AREA
];
24383 /* Skip truncation glyphs at the start of the glyph row. */
24384 if (r1
->displays_text_p
)
24386 && INTEGERP (glyph
->object
)
24387 && glyph
->charpos
< 0;
24389 x
+= glyph
->pixel_width
;
24391 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24392 or COVER_STRING, and the first glyph from buffer whose
24393 position is between START_CHARPOS and END_CHARPOS. */
24395 && !INTEGERP (glyph
->object
)
24396 && !EQ (glyph
->object
, cover_string
)
24397 && !(BUFFERP (glyph
->object
)
24398 && (glyph
->charpos
>= start_charpos
24399 && glyph
->charpos
< end_charpos
));
24402 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24403 are present at buffer positions between START_CHARPOS and
24404 END_CHARPOS, or if they come from an overlay. */
24405 if (EQ (glyph
->object
, before_string
))
24407 pos
= string_buffer_position (before_string
,
24409 /* If pos == 0, it means before_string came from an
24410 overlay, not from a buffer position. */
24411 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24414 else if (EQ (glyph
->object
, after_string
))
24416 pos
= string_buffer_position (after_string
, end_charpos
);
24417 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24420 x
+= glyph
->pixel_width
;
24422 hlinfo
->mouse_face_beg_x
= x
;
24423 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24427 /* This row is in a right to left paragraph. Scan it right to
24431 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24432 glyph
= end
+ r1
->used
[TEXT_AREA
];
24434 /* Skip truncation glyphs at the start of the glyph row. */
24435 if (r1
->displays_text_p
)
24437 && INTEGERP (glyph
->object
)
24438 && glyph
->charpos
< 0;
24442 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24443 or COVER_STRING, and the first glyph from buffer whose
24444 position is between START_CHARPOS and END_CHARPOS. */
24446 && !INTEGERP (glyph
->object
)
24447 && !EQ (glyph
->object
, cover_string
)
24448 && !(BUFFERP (glyph
->object
)
24449 && (glyph
->charpos
>= start_charpos
24450 && glyph
->charpos
< end_charpos
));
24453 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24454 are present at buffer positions between START_CHARPOS and
24455 END_CHARPOS, or if they come from an overlay. */
24456 if (EQ (glyph
->object
, before_string
))
24458 pos
= string_buffer_position (before_string
, start_charpos
);
24459 /* If pos == 0, it means before_string came from an
24460 overlay, not from a buffer position. */
24461 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24464 else if (EQ (glyph
->object
, after_string
))
24466 pos
= string_buffer_position (after_string
, end_charpos
);
24467 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24472 glyph
++; /* first glyph to the right of the highlighted area */
24473 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24474 x
+= g
->pixel_width
;
24475 hlinfo
->mouse_face_beg_x
= x
;
24476 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24479 /* If the highlight ends in a different row, compute GLYPH and END
24480 for the end row. Otherwise, reuse the values computed above for
24481 the row where the highlight begins. */
24484 if (!r2
->reversed_p
)
24486 glyph
= r2
->glyphs
[TEXT_AREA
];
24487 end
= glyph
+ r2
->used
[TEXT_AREA
];
24492 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24493 glyph
= end
+ r2
->used
[TEXT_AREA
];
24497 if (!r2
->reversed_p
)
24499 /* Skip truncation and continuation glyphs near the end of the
24500 row, and also blanks and stretch glyphs inserted by
24501 extend_face_to_end_of_line. */
24503 && INTEGERP ((end
- 1)->object
)
24504 && (end
- 1)->charpos
<= 0)
24506 /* Scan the rest of the glyph row from the end, looking for the
24507 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24508 COVER_STRING, or whose position is between START_CHARPOS
24512 && !INTEGERP (end
->object
)
24513 && !EQ (end
->object
, cover_string
)
24514 && !(BUFFERP (end
->object
)
24515 && (end
->charpos
>= start_charpos
24516 && end
->charpos
< end_charpos
));
24519 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24520 are present at buffer positions between START_CHARPOS and
24521 END_CHARPOS, or if they come from an overlay. */
24522 if (EQ (end
->object
, before_string
))
24524 pos
= string_buffer_position (before_string
, start_charpos
);
24525 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24528 else if (EQ (end
->object
, after_string
))
24530 pos
= string_buffer_position (after_string
, end_charpos
);
24531 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24535 /* Find the X coordinate of the last glyph to be highlighted. */
24536 for (; glyph
<= end
; ++glyph
)
24537 x
+= glyph
->pixel_width
;
24539 hlinfo
->mouse_face_end_x
= x
;
24540 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24544 /* Skip truncation and continuation glyphs near the end of the
24545 row, and also blanks and stretch glyphs inserted by
24546 extend_face_to_end_of_line. */
24550 && INTEGERP (end
->object
)
24551 && end
->charpos
<= 0)
24553 x
+= end
->pixel_width
;
24556 /* Scan the rest of the glyph row from the end, looking for the
24557 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24558 COVER_STRING, or whose position is between START_CHARPOS
24562 && !INTEGERP (end
->object
)
24563 && !EQ (end
->object
, cover_string
)
24564 && !(BUFFERP (end
->object
)
24565 && (end
->charpos
>= start_charpos
24566 && end
->charpos
< end_charpos
));
24569 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24570 are present at buffer positions between START_CHARPOS and
24571 END_CHARPOS, or if they come from an overlay. */
24572 if (EQ (end
->object
, before_string
))
24574 pos
= string_buffer_position (before_string
, start_charpos
);
24575 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24578 else if (EQ (end
->object
, after_string
))
24580 pos
= string_buffer_position (after_string
, end_charpos
);
24581 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24584 x
+= end
->pixel_width
;
24586 hlinfo
->mouse_face_end_x
= x
;
24587 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24590 hlinfo
->mouse_face_window
= window
;
24591 hlinfo
->mouse_face_face_id
24592 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24594 !hlinfo
->mouse_face_hidden
, -1);
24595 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24598 /* The following function is not used anymore (replaced with
24599 mouse_face_from_string_pos), but I leave it here for the time
24600 being, in case someone would. */
24602 #if 0 /* not used */
24604 /* Find the position of the glyph for position POS in OBJECT in
24605 window W's current matrix, and return in *X, *Y the pixel
24606 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24608 RIGHT_P non-zero means return the position of the right edge of the
24609 glyph, RIGHT_P zero means return the left edge position.
24611 If no glyph for POS exists in the matrix, return the position of
24612 the glyph with the next smaller position that is in the matrix, if
24613 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24614 exists in the matrix, return the position of the glyph with the
24615 next larger position in OBJECT.
24617 Value is non-zero if a glyph was found. */
24620 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24621 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24623 int yb
= window_text_bottom_y (w
);
24624 struct glyph_row
*r
;
24625 struct glyph
*best_glyph
= NULL
;
24626 struct glyph_row
*best_row
= NULL
;
24629 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24630 r
->enabled_p
&& r
->y
< yb
;
24633 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24634 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24637 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24638 if (EQ (g
->object
, object
))
24640 if (g
->charpos
== pos
)
24647 else if (best_glyph
== NULL
24648 || ((eabs (g
->charpos
- pos
)
24649 < eabs (best_glyph
->charpos
- pos
))
24652 : g
->charpos
> pos
)))
24666 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24670 *x
+= best_glyph
->pixel_width
;
24675 *vpos
= best_row
- w
->current_matrix
->rows
;
24678 return best_glyph
!= NULL
;
24680 #endif /* not used */
24682 /* Find the positions of the first and the last glyphs in window W's
24683 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24684 (assumed to be a string), and return in HLINFO's mouse_face_*
24685 members the pixel and column/row coordinates of those glyphs. */
24688 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24689 Lisp_Object object
,
24690 EMACS_INT startpos
, EMACS_INT endpos
)
24692 int yb
= window_text_bottom_y (w
);
24693 struct glyph_row
*r
;
24694 struct glyph
*g
, *e
;
24698 /* Find the glyph row with at least one position in the range
24699 [STARTPOS..ENDPOS], and the first glyph in that row whose
24700 position belongs to that range. */
24701 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24702 r
->enabled_p
&& r
->y
< yb
;
24705 if (!r
->reversed_p
)
24707 g
= r
->glyphs
[TEXT_AREA
];
24708 e
= g
+ r
->used
[TEXT_AREA
];
24709 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24710 if (EQ (g
->object
, object
)
24711 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24713 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24714 hlinfo
->mouse_face_beg_y
= r
->y
;
24715 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24716 hlinfo
->mouse_face_beg_x
= gx
;
24725 e
= r
->glyphs
[TEXT_AREA
];
24726 g
= e
+ r
->used
[TEXT_AREA
];
24727 for ( ; g
> e
; --g
)
24728 if (EQ ((g
-1)->object
, object
)
24729 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24731 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24732 hlinfo
->mouse_face_beg_y
= r
->y
;
24733 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24734 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24735 gx
+= g1
->pixel_width
;
24736 hlinfo
->mouse_face_beg_x
= gx
;
24748 /* Starting with the next row, look for the first row which does NOT
24749 include any glyphs whose positions are in the range. */
24750 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24752 g
= r
->glyphs
[TEXT_AREA
];
24753 e
= g
+ r
->used
[TEXT_AREA
];
24755 for ( ; g
< e
; ++g
)
24756 if (EQ (g
->object
, object
)
24757 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24766 /* The highlighted region ends on the previous row. */
24769 /* Set the end row and its vertical pixel coordinate. */
24770 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24771 hlinfo
->mouse_face_end_y
= r
->y
;
24773 /* Compute and set the end column and the end column's horizontal
24774 pixel coordinate. */
24775 if (!r
->reversed_p
)
24777 g
= r
->glyphs
[TEXT_AREA
];
24778 e
= g
+ r
->used
[TEXT_AREA
];
24779 for ( ; e
> g
; --e
)
24780 if (EQ ((e
-1)->object
, object
)
24781 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24783 hlinfo
->mouse_face_end_col
= e
- g
;
24785 for (gx
= r
->x
; g
< e
; ++g
)
24786 gx
+= g
->pixel_width
;
24787 hlinfo
->mouse_face_end_x
= gx
;
24791 e
= r
->glyphs
[TEXT_AREA
];
24792 g
= e
+ r
->used
[TEXT_AREA
];
24793 for (gx
= r
->x
; e
< g
; ++e
)
24795 if (EQ (e
->object
, object
)
24796 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24798 gx
+= e
->pixel_width
;
24800 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24801 hlinfo
->mouse_face_end_x
= gx
;
24805 #ifdef HAVE_WINDOW_SYSTEM
24807 /* See if position X, Y is within a hot-spot of an image. */
24810 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24812 if (!CONSP (hot_spot
))
24815 if (EQ (XCAR (hot_spot
), Qrect
))
24817 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24818 Lisp_Object rect
= XCDR (hot_spot
);
24822 if (!CONSP (XCAR (rect
)))
24824 if (!CONSP (XCDR (rect
)))
24826 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24828 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24830 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24832 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24836 else if (EQ (XCAR (hot_spot
), Qcircle
))
24838 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24839 Lisp_Object circ
= XCDR (hot_spot
);
24840 Lisp_Object lr
, lx0
, ly0
;
24842 && CONSP (XCAR (circ
))
24843 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24844 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24845 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24847 double r
= XFLOATINT (lr
);
24848 double dx
= XINT (lx0
) - x
;
24849 double dy
= XINT (ly0
) - y
;
24850 return (dx
* dx
+ dy
* dy
<= r
* r
);
24853 else if (EQ (XCAR (hot_spot
), Qpoly
))
24855 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24856 if (VECTORP (XCDR (hot_spot
)))
24858 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24859 Lisp_Object
*poly
= v
->contents
;
24863 Lisp_Object lx
, ly
;
24866 /* Need an even number of coordinates, and at least 3 edges. */
24867 if (n
< 6 || n
& 1)
24870 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24871 If count is odd, we are inside polygon. Pixels on edges
24872 may or may not be included depending on actual geometry of the
24874 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24875 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24877 x0
= XINT (lx
), y0
= XINT (ly
);
24878 for (i
= 0; i
< n
; i
+= 2)
24880 int x1
= x0
, y1
= y0
;
24881 if ((lx
= poly
[i
], !INTEGERP (lx
))
24882 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24884 x0
= XINT (lx
), y0
= XINT (ly
);
24886 /* Does this segment cross the X line? */
24894 if (y
> y0
&& y
> y1
)
24896 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24906 find_hot_spot (Lisp_Object map
, int x
, int y
)
24908 while (CONSP (map
))
24910 if (CONSP (XCAR (map
))
24911 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24919 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24921 doc
: /* Lookup in image map MAP coordinates X and Y.
24922 An image map is an alist where each element has the format (AREA ID PLIST).
24923 An AREA is specified as either a rectangle, a circle, or a polygon:
24924 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24925 pixel coordinates of the upper left and bottom right corners.
24926 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24927 and the radius of the circle; r may be a float or integer.
24928 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24929 vector describes one corner in the polygon.
24930 Returns the alist element for the first matching AREA in MAP. */)
24931 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24939 return find_hot_spot (map
, XINT (x
), XINT (y
));
24943 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24945 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24947 /* Do not change cursor shape while dragging mouse. */
24948 if (!NILP (do_mouse_tracking
))
24951 if (!NILP (pointer
))
24953 if (EQ (pointer
, Qarrow
))
24954 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24955 else if (EQ (pointer
, Qhand
))
24956 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24957 else if (EQ (pointer
, Qtext
))
24958 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24959 else if (EQ (pointer
, intern ("hdrag")))
24960 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24961 #ifdef HAVE_X_WINDOWS
24962 else if (EQ (pointer
, intern ("vdrag")))
24963 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24965 else if (EQ (pointer
, intern ("hourglass")))
24966 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24967 else if (EQ (pointer
, Qmodeline
))
24968 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24970 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24973 if (cursor
!= No_Cursor
)
24974 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24977 #endif /* HAVE_WINDOW_SYSTEM */
24979 /* Take proper action when mouse has moved to the mode or header line
24980 or marginal area AREA of window W, x-position X and y-position Y.
24981 X is relative to the start of the text display area of W, so the
24982 width of bitmap areas and scroll bars must be subtracted to get a
24983 position relative to the start of the mode line. */
24986 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24987 enum window_part area
)
24989 struct window
*w
= XWINDOW (window
);
24990 struct frame
*f
= XFRAME (w
->frame
);
24991 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24992 #ifdef HAVE_WINDOW_SYSTEM
24993 Display_Info
*dpyinfo
;
24995 Cursor cursor
= No_Cursor
;
24996 Lisp_Object pointer
= Qnil
;
24997 int dx
, dy
, width
, height
;
24999 Lisp_Object string
, object
= Qnil
;
25000 Lisp_Object pos
, help
;
25002 Lisp_Object mouse_face
;
25003 int original_x_pixel
= x
;
25004 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25005 struct glyph_row
*row
;
25007 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25012 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25013 returns them in row/column units! */
25014 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25015 &object
, &dx
, &dy
, &width
, &height
);
25017 row
= (area
== ON_MODE_LINE
25018 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25019 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25021 /* Find the glyph under the mouse pointer. */
25022 if (row
->mode_line_p
&& row
->enabled_p
)
25024 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25025 end
= glyph
+ row
->used
[TEXT_AREA
];
25027 for (x0
= original_x_pixel
;
25028 glyph
< end
&& x0
>= glyph
->pixel_width
;
25030 x0
-= glyph
->pixel_width
;
25038 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25039 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25040 returns them in row/column units! */
25041 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25042 &object
, &dx
, &dy
, &width
, &height
);
25047 #ifdef HAVE_WINDOW_SYSTEM
25048 if (IMAGEP (object
))
25050 Lisp_Object image_map
, hotspot
;
25051 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25053 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25055 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25059 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25060 If so, we could look for mouse-enter, mouse-leave
25061 properties in PLIST (and do something...). */
25062 hotspot
= XCDR (hotspot
);
25063 if (CONSP (hotspot
)
25064 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25066 pointer
= Fplist_get (plist
, Qpointer
);
25067 if (NILP (pointer
))
25069 help
= Fplist_get (plist
, Qhelp_echo
);
25072 help_echo_string
= help
;
25073 /* Is this correct? ++kfs */
25074 XSETWINDOW (help_echo_window
, w
);
25075 help_echo_object
= w
->buffer
;
25076 help_echo_pos
= charpos
;
25080 if (NILP (pointer
))
25081 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25083 #endif /* HAVE_WINDOW_SYSTEM */
25085 if (STRINGP (string
))
25087 pos
= make_number (charpos
);
25088 /* If we're on a string with `help-echo' text property, arrange
25089 for the help to be displayed. This is done by setting the
25090 global variable help_echo_string to the help string. */
25093 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25096 help_echo_string
= help
;
25097 XSETWINDOW (help_echo_window
, w
);
25098 help_echo_object
= string
;
25099 help_echo_pos
= charpos
;
25103 #ifdef HAVE_WINDOW_SYSTEM
25104 if (FRAME_WINDOW_P (f
))
25106 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25107 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25108 if (NILP (pointer
))
25109 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25111 /* Change the mouse pointer according to what is under X/Y. */
25113 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25116 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25117 if (!KEYMAPP (map
))
25118 map
= Fget_text_property (pos
, Qkeymap
, string
);
25119 if (!KEYMAPP (map
))
25120 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25125 /* Change the mouse face according to what is under X/Y. */
25126 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25127 if (!NILP (mouse_face
)
25128 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25133 struct glyph
* tmp_glyph
;
25137 int total_pixel_width
;
25138 EMACS_INT begpos
, endpos
, ignore
;
25142 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25143 Qmouse_face
, string
, Qnil
);
25149 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25151 endpos
= SCHARS (string
);
25155 /* Calculate the glyph position GPOS of GLYPH in the
25156 displayed string, relative to the beginning of the
25157 highlighted part of the string.
25159 Note: GPOS is different from CHARPOS. CHARPOS is the
25160 position of GLYPH in the internal string object. A mode
25161 line string format has structures which are converted to
25162 a flattened string by the Emacs Lisp interpreter. The
25163 internal string is an element of those structures. The
25164 displayed string is the flattened string. */
25165 tmp_glyph
= row_start_glyph
;
25166 while (tmp_glyph
< glyph
25167 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25168 && begpos
<= tmp_glyph
->charpos
25169 && tmp_glyph
->charpos
< endpos
)))
25171 gpos
= glyph
- tmp_glyph
;
25173 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25174 the highlighted part of the displayed string to which
25175 GLYPH belongs. Note: GSEQ_LENGTH is different from
25176 SCHARS (STRING), because the latter returns the length of
25177 the internal string. */
25178 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25180 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25181 && begpos
<= tmp_glyph
->charpos
25182 && tmp_glyph
->charpos
< endpos
));
25185 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25187 /* Calculate the total pixel width of all the glyphs between
25188 the beginning of the highlighted area and GLYPH. */
25189 total_pixel_width
= 0;
25190 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25191 total_pixel_width
+= tmp_glyph
->pixel_width
;
25193 /* Pre calculation of re-rendering position. Note: X is in
25194 column units here, after the call to mode_line_string or
25195 marginal_area_string. */
25197 vpos
= (area
== ON_MODE_LINE
25198 ? (w
->current_matrix
)->nrows
- 1
25201 /* If GLYPH's position is included in the region that is
25202 already drawn in mouse face, we have nothing to do. */
25203 if ( EQ (window
, hlinfo
->mouse_face_window
)
25204 && (!row
->reversed_p
25205 ? (hlinfo
->mouse_face_beg_col
<= hpos
25206 && hpos
< hlinfo
->mouse_face_end_col
)
25207 /* In R2L rows we swap BEG and END, see below. */
25208 : (hlinfo
->mouse_face_end_col
<= hpos
25209 && hpos
< hlinfo
->mouse_face_beg_col
))
25210 && hlinfo
->mouse_face_beg_row
== vpos
)
25213 if (clear_mouse_face (hlinfo
))
25214 cursor
= No_Cursor
;
25216 if (!row
->reversed_p
)
25218 hlinfo
->mouse_face_beg_col
= hpos
;
25219 hlinfo
->mouse_face_beg_x
= original_x_pixel
25220 - (total_pixel_width
+ dx
);
25221 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25222 hlinfo
->mouse_face_end_x
= 0;
25226 /* In R2L rows, show_mouse_face expects BEG and END
25227 coordinates to be swapped. */
25228 hlinfo
->mouse_face_end_col
= hpos
;
25229 hlinfo
->mouse_face_end_x
= original_x_pixel
25230 - (total_pixel_width
+ dx
);
25231 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25232 hlinfo
->mouse_face_beg_x
= 0;
25235 hlinfo
->mouse_face_beg_row
= vpos
;
25236 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25237 hlinfo
->mouse_face_beg_y
= 0;
25238 hlinfo
->mouse_face_end_y
= 0;
25239 hlinfo
->mouse_face_past_end
= 0;
25240 hlinfo
->mouse_face_window
= window
;
25242 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25248 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25250 if (NILP (pointer
))
25253 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25254 clear_mouse_face (hlinfo
);
25256 #ifdef HAVE_WINDOW_SYSTEM
25257 if (FRAME_WINDOW_P (f
))
25258 define_frame_cursor1 (f
, cursor
, pointer
);
25264 Take proper action when the mouse has moved to position X, Y on
25265 frame F as regards highlighting characters that have mouse-face
25266 properties. Also de-highlighting chars where the mouse was before.
25267 X and Y can be negative or out of range. */
25270 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25272 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25273 enum window_part part
;
25274 Lisp_Object window
;
25276 Cursor cursor
= No_Cursor
;
25277 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25280 /* When a menu is active, don't highlight because this looks odd. */
25281 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25282 if (popup_activated ())
25286 if (NILP (Vmouse_highlight
)
25287 || !f
->glyphs_initialized_p
25288 || f
->pointer_invisible
)
25291 hlinfo
->mouse_face_mouse_x
= x
;
25292 hlinfo
->mouse_face_mouse_y
= y
;
25293 hlinfo
->mouse_face_mouse_frame
= f
;
25295 if (hlinfo
->mouse_face_defer
)
25298 if (gc_in_progress
)
25300 hlinfo
->mouse_face_deferred_gc
= 1;
25304 /* Which window is that in? */
25305 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25307 /* If we were displaying active text in another window, clear that.
25308 Also clear if we move out of text area in same window. */
25309 if (! EQ (window
, hlinfo
->mouse_face_window
)
25310 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25311 && !NILP (hlinfo
->mouse_face_window
)))
25312 clear_mouse_face (hlinfo
);
25314 /* Not on a window -> return. */
25315 if (!WINDOWP (window
))
25318 /* Reset help_echo_string. It will get recomputed below. */
25319 help_echo_string
= Qnil
;
25321 /* Convert to window-relative pixel coordinates. */
25322 w
= XWINDOW (window
);
25323 frame_to_window_pixel_xy (w
, &x
, &y
);
25325 #ifdef HAVE_WINDOW_SYSTEM
25326 /* Handle tool-bar window differently since it doesn't display a
25328 if (EQ (window
, f
->tool_bar_window
))
25330 note_tool_bar_highlight (f
, x
, y
);
25335 /* Mouse is on the mode, header line or margin? */
25336 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25337 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25339 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25343 #ifdef HAVE_WINDOW_SYSTEM
25344 if (part
== ON_VERTICAL_BORDER
)
25346 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25347 help_echo_string
= build_string ("drag-mouse-1: resize");
25349 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25350 || part
== ON_SCROLL_BAR
)
25351 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25353 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25356 /* Are we in a window whose display is up to date?
25357 And verify the buffer's text has not changed. */
25358 b
= XBUFFER (w
->buffer
);
25359 if (part
== ON_TEXT
25360 && EQ (w
->window_end_valid
, w
->buffer
)
25361 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25362 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25364 int hpos
, vpos
, i
, dx
, dy
, area
;
25366 struct glyph
*glyph
;
25367 Lisp_Object object
;
25368 Lisp_Object mouse_face
= Qnil
, position
;
25369 Lisp_Object
*overlay_vec
= NULL
;
25371 struct buffer
*obuf
;
25372 EMACS_INT obegv
, ozv
;
25375 /* Find the glyph under X/Y. */
25376 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25378 #ifdef HAVE_WINDOW_SYSTEM
25379 /* Look for :pointer property on image. */
25380 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25382 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25383 if (img
!= NULL
&& IMAGEP (img
->spec
))
25385 Lisp_Object image_map
, hotspot
;
25386 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25388 && (hotspot
= find_hot_spot (image_map
,
25389 glyph
->slice
.img
.x
+ dx
,
25390 glyph
->slice
.img
.y
+ dy
),
25392 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25396 /* Could check XCAR (hotspot) to see if we enter/leave
25398 If so, we could look for mouse-enter, mouse-leave
25399 properties in PLIST (and do something...). */
25400 hotspot
= XCDR (hotspot
);
25401 if (CONSP (hotspot
)
25402 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25404 pointer
= Fplist_get (plist
, Qpointer
);
25405 if (NILP (pointer
))
25407 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25408 if (!NILP (help_echo_string
))
25410 help_echo_window
= window
;
25411 help_echo_object
= glyph
->object
;
25412 help_echo_pos
= glyph
->charpos
;
25416 if (NILP (pointer
))
25417 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25420 #endif /* HAVE_WINDOW_SYSTEM */
25422 /* Clear mouse face if X/Y not over text. */
25424 || area
!= TEXT_AREA
25425 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25426 /* Glyph's OBJECT is an integer for glyphs inserted by the
25427 display engine for its internal purposes, like truncation
25428 and continuation glyphs and blanks beyond the end of
25429 line's text on text terminals. If we are over such a
25430 glyph, we are not over any text. */
25431 || INTEGERP (glyph
->object
)
25432 /* R2L rows have a stretch glyph at their front, which
25433 stands for no text, whereas L2R rows have no glyphs at
25434 all beyond the end of text. Treat such stretch glyphs
25435 like we do with NULL glyphs in L2R rows. */
25436 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25437 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25438 && glyph
->type
== STRETCH_GLYPH
25439 && glyph
->avoid_cursor_p
))
25441 if (clear_mouse_face (hlinfo
))
25442 cursor
= No_Cursor
;
25443 #ifdef HAVE_WINDOW_SYSTEM
25444 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25446 if (area
!= TEXT_AREA
)
25447 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25449 pointer
= Vvoid_text_area_pointer
;
25455 pos
= glyph
->charpos
;
25456 object
= glyph
->object
;
25457 if (!STRINGP (object
) && !BUFFERP (object
))
25460 /* If we get an out-of-range value, return now; avoid an error. */
25461 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25464 /* Make the window's buffer temporarily current for
25465 overlays_at and compute_char_face. */
25466 obuf
= current_buffer
;
25467 current_buffer
= b
;
25473 /* Is this char mouse-active or does it have help-echo? */
25474 position
= make_number (pos
);
25476 if (BUFFERP (object
))
25478 /* Put all the overlays we want in a vector in overlay_vec. */
25479 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25480 /* Sort overlays into increasing priority order. */
25481 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25486 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25489 cursor
= No_Cursor
;
25491 /* Check mouse-face highlighting. */
25493 /* If there exists an overlay with mouse-face overlapping
25494 the one we are currently highlighting, we have to
25495 check if we enter the overlapping overlay, and then
25496 highlight only that. */
25497 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25498 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25500 /* Find the highest priority overlay with a mouse-face. */
25501 Lisp_Object overlay
= Qnil
;
25502 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25504 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25505 if (!NILP (mouse_face
))
25506 overlay
= overlay_vec
[i
];
25509 /* If we're highlighting the same overlay as before, there's
25510 no need to do that again. */
25511 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25512 goto check_help_echo
;
25513 hlinfo
->mouse_face_overlay
= overlay
;
25515 /* Clear the display of the old active region, if any. */
25516 if (clear_mouse_face (hlinfo
))
25517 cursor
= No_Cursor
;
25519 /* If no overlay applies, get a text property. */
25520 if (NILP (overlay
))
25521 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25523 /* Next, compute the bounds of the mouse highlighting and
25525 if (!NILP (mouse_face
) && STRINGP (object
))
25527 /* The mouse-highlighting comes from a display string
25528 with a mouse-face. */
25532 s
= Fprevious_single_property_change
25533 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25534 e
= Fnext_single_property_change
25535 (position
, Qmouse_face
, object
, Qnil
);
25537 s
= make_number (0);
25539 e
= make_number (SCHARS (object
) - 1);
25540 mouse_face_from_string_pos (w
, hlinfo
, object
,
25541 XINT (s
), XINT (e
));
25542 hlinfo
->mouse_face_past_end
= 0;
25543 hlinfo
->mouse_face_window
= window
;
25544 hlinfo
->mouse_face_face_id
25545 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25546 glyph
->face_id
, 1);
25547 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25548 cursor
= No_Cursor
;
25552 /* The mouse-highlighting, if any, comes from an overlay
25553 or text property in the buffer. */
25554 Lisp_Object buffer
IF_LINT (= Qnil
);
25555 Lisp_Object cover_string
IF_LINT (= Qnil
);
25557 if (STRINGP (object
))
25559 /* If we are on a display string with no mouse-face,
25560 check if the text under it has one. */
25561 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25562 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25563 pos
= string_buffer_position (object
, start
);
25566 mouse_face
= get_char_property_and_overlay
25567 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25568 buffer
= w
->buffer
;
25569 cover_string
= object
;
25575 cover_string
= Qnil
;
25578 if (!NILP (mouse_face
))
25580 Lisp_Object before
, after
;
25581 Lisp_Object before_string
, after_string
;
25582 /* To correctly find the limits of mouse highlight
25583 in a bidi-reordered buffer, we must not use the
25584 optimization of limiting the search in
25585 previous-single-property-change and
25586 next-single-property-change, because
25587 rows_from_pos_range needs the real start and end
25588 positions to DTRT in this case. That's because
25589 the first row visible in a window does not
25590 necessarily display the character whose position
25591 is the smallest. */
25593 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25594 ? Fmarker_position (w
->start
)
25597 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25598 ? make_number (BUF_Z (XBUFFER (buffer
))
25599 - XFASTINT (w
->window_end_pos
))
25602 if (NILP (overlay
))
25604 /* Handle the text property case. */
25605 before
= Fprevious_single_property_change
25606 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25607 after
= Fnext_single_property_change
25608 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25609 before_string
= after_string
= Qnil
;
25613 /* Handle the overlay case. */
25614 before
= Foverlay_start (overlay
);
25615 after
= Foverlay_end (overlay
);
25616 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25617 after_string
= Foverlay_get (overlay
, Qafter_string
);
25619 if (!STRINGP (before_string
)) before_string
= Qnil
;
25620 if (!STRINGP (after_string
)) after_string
= Qnil
;
25623 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25626 before_string
, after_string
,
25628 cursor
= No_Cursor
;
25635 /* Look for a `help-echo' property. */
25636 if (NILP (help_echo_string
)) {
25637 Lisp_Object help
, overlay
;
25639 /* Check overlays first. */
25640 help
= overlay
= Qnil
;
25641 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25643 overlay
= overlay_vec
[i
];
25644 help
= Foverlay_get (overlay
, Qhelp_echo
);
25649 help_echo_string
= help
;
25650 help_echo_window
= window
;
25651 help_echo_object
= overlay
;
25652 help_echo_pos
= pos
;
25656 Lisp_Object obj
= glyph
->object
;
25657 EMACS_INT charpos
= glyph
->charpos
;
25659 /* Try text properties. */
25662 && charpos
< SCHARS (obj
))
25664 help
= Fget_text_property (make_number (charpos
),
25668 /* If the string itself doesn't specify a help-echo,
25669 see if the buffer text ``under'' it does. */
25670 struct glyph_row
*r
25671 = MATRIX_ROW (w
->current_matrix
, vpos
);
25672 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25673 EMACS_INT p
= string_buffer_position (obj
, start
);
25676 help
= Fget_char_property (make_number (p
),
25677 Qhelp_echo
, w
->buffer
);
25686 else if (BUFFERP (obj
)
25689 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25694 help_echo_string
= help
;
25695 help_echo_window
= window
;
25696 help_echo_object
= obj
;
25697 help_echo_pos
= charpos
;
25702 #ifdef HAVE_WINDOW_SYSTEM
25703 /* Look for a `pointer' property. */
25704 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25706 /* Check overlays first. */
25707 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25708 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25710 if (NILP (pointer
))
25712 Lisp_Object obj
= glyph
->object
;
25713 EMACS_INT charpos
= glyph
->charpos
;
25715 /* Try text properties. */
25718 && charpos
< SCHARS (obj
))
25720 pointer
= Fget_text_property (make_number (charpos
),
25722 if (NILP (pointer
))
25724 /* If the string itself doesn't specify a pointer,
25725 see if the buffer text ``under'' it does. */
25726 struct glyph_row
*r
25727 = MATRIX_ROW (w
->current_matrix
, vpos
);
25728 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25729 EMACS_INT p
= string_buffer_position (obj
, start
);
25731 pointer
= Fget_char_property (make_number (p
),
25732 Qpointer
, w
->buffer
);
25735 else if (BUFFERP (obj
)
25738 pointer
= Fget_text_property (make_number (charpos
),
25742 #endif /* HAVE_WINDOW_SYSTEM */
25746 current_buffer
= obuf
;
25751 #ifdef HAVE_WINDOW_SYSTEM
25752 if (FRAME_WINDOW_P (f
))
25753 define_frame_cursor1 (f
, cursor
, pointer
);
25755 /* This is here to prevent a compiler error, about "label at end of
25756 compound statement". */
25763 Clear any mouse-face on window W. This function is part of the
25764 redisplay interface, and is called from try_window_id and similar
25765 functions to ensure the mouse-highlight is off. */
25768 x_clear_window_mouse_face (struct window
*w
)
25770 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25771 Lisp_Object window
;
25774 XSETWINDOW (window
, w
);
25775 if (EQ (window
, hlinfo
->mouse_face_window
))
25776 clear_mouse_face (hlinfo
);
25782 Just discard the mouse face information for frame F, if any.
25783 This is used when the size of F is changed. */
25786 cancel_mouse_face (struct frame
*f
)
25788 Lisp_Object window
;
25789 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25791 window
= hlinfo
->mouse_face_window
;
25792 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25794 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25795 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25796 hlinfo
->mouse_face_window
= Qnil
;
25802 /***********************************************************************
25804 ***********************************************************************/
25806 #ifdef HAVE_WINDOW_SYSTEM
25808 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25809 which intersects rectangle R. R is in window-relative coordinates. */
25812 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25813 enum glyph_row_area area
)
25815 struct glyph
*first
= row
->glyphs
[area
];
25816 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25817 struct glyph
*last
;
25818 int first_x
, start_x
, x
;
25820 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25821 /* If row extends face to end of line write the whole line. */
25822 draw_glyphs (w
, 0, row
, area
,
25823 0, row
->used
[area
],
25824 DRAW_NORMAL_TEXT
, 0);
25827 /* Set START_X to the window-relative start position for drawing glyphs of
25828 AREA. The first glyph of the text area can be partially visible.
25829 The first glyphs of other areas cannot. */
25830 start_x
= window_box_left_offset (w
, area
);
25832 if (area
== TEXT_AREA
)
25835 /* Find the first glyph that must be redrawn. */
25837 && x
+ first
->pixel_width
< r
->x
)
25839 x
+= first
->pixel_width
;
25843 /* Find the last one. */
25847 && x
< r
->x
+ r
->width
)
25849 x
+= last
->pixel_width
;
25855 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25856 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25857 DRAW_NORMAL_TEXT
, 0);
25862 /* Redraw the parts of the glyph row ROW on window W intersecting
25863 rectangle R. R is in window-relative coordinates. Value is
25864 non-zero if mouse-face was overwritten. */
25867 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25869 xassert (row
->enabled_p
);
25871 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25872 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25873 0, row
->used
[TEXT_AREA
],
25874 DRAW_NORMAL_TEXT
, 0);
25877 if (row
->used
[LEFT_MARGIN_AREA
])
25878 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25879 if (row
->used
[TEXT_AREA
])
25880 expose_area (w
, row
, r
, TEXT_AREA
);
25881 if (row
->used
[RIGHT_MARGIN_AREA
])
25882 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25883 draw_row_fringe_bitmaps (w
, row
);
25886 return row
->mouse_face_p
;
25890 /* Redraw those parts of glyphs rows during expose event handling that
25891 overlap other rows. Redrawing of an exposed line writes over parts
25892 of lines overlapping that exposed line; this function fixes that.
25894 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25895 row in W's current matrix that is exposed and overlaps other rows.
25896 LAST_OVERLAPPING_ROW is the last such row. */
25899 expose_overlaps (struct window
*w
,
25900 struct glyph_row
*first_overlapping_row
,
25901 struct glyph_row
*last_overlapping_row
,
25904 struct glyph_row
*row
;
25906 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25907 if (row
->overlapping_p
)
25909 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25912 if (row
->used
[LEFT_MARGIN_AREA
])
25913 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25915 if (row
->used
[TEXT_AREA
])
25916 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25918 if (row
->used
[RIGHT_MARGIN_AREA
])
25919 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25925 /* Return non-zero if W's cursor intersects rectangle R. */
25928 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25930 XRectangle cr
, result
;
25931 struct glyph
*cursor_glyph
;
25932 struct glyph_row
*row
;
25934 if (w
->phys_cursor
.vpos
>= 0
25935 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25936 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25938 && row
->cursor_in_fringe_p
)
25940 /* Cursor is in the fringe. */
25941 cr
.x
= window_box_right_offset (w
,
25942 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25943 ? RIGHT_MARGIN_AREA
25946 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25947 cr
.height
= row
->height
;
25948 return x_intersect_rectangles (&cr
, r
, &result
);
25951 cursor_glyph
= get_phys_cursor_glyph (w
);
25954 /* r is relative to W's box, but w->phys_cursor.x is relative
25955 to left edge of W's TEXT area. Adjust it. */
25956 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25957 cr
.y
= w
->phys_cursor
.y
;
25958 cr
.width
= cursor_glyph
->pixel_width
;
25959 cr
.height
= w
->phys_cursor_height
;
25960 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25961 I assume the effect is the same -- and this is portable. */
25962 return x_intersect_rectangles (&cr
, r
, &result
);
25964 /* If we don't understand the format, pretend we're not in the hot-spot. */
25970 Draw a vertical window border to the right of window W if W doesn't
25971 have vertical scroll bars. */
25974 x_draw_vertical_border (struct window
*w
)
25976 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25978 /* We could do better, if we knew what type of scroll-bar the adjacent
25979 windows (on either side) have... But we don't :-(
25980 However, I think this works ok. ++KFS 2003-04-25 */
25982 /* Redraw borders between horizontally adjacent windows. Don't
25983 do it for frames with vertical scroll bars because either the
25984 right scroll bar of a window, or the left scroll bar of its
25985 neighbor will suffice as a border. */
25986 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25989 if (!WINDOW_RIGHTMOST_P (w
)
25990 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25992 int x0
, x1
, y0
, y1
;
25994 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25997 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26000 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26002 else if (!WINDOW_LEFTMOST_P (w
)
26003 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26005 int x0
, x1
, y0
, y1
;
26007 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26010 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26013 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26018 /* Redraw the part of window W intersection rectangle FR. Pixel
26019 coordinates in FR are frame-relative. Call this function with
26020 input blocked. Value is non-zero if the exposure overwrites
26024 expose_window (struct window
*w
, XRectangle
*fr
)
26026 struct frame
*f
= XFRAME (w
->frame
);
26028 int mouse_face_overwritten_p
= 0;
26030 /* If window is not yet fully initialized, do nothing. This can
26031 happen when toolkit scroll bars are used and a window is split.
26032 Reconfiguring the scroll bar will generate an expose for a newly
26034 if (w
->current_matrix
== NULL
)
26037 /* When we're currently updating the window, display and current
26038 matrix usually don't agree. Arrange for a thorough display
26040 if (w
== updated_window
)
26042 SET_FRAME_GARBAGED (f
);
26046 /* Frame-relative pixel rectangle of W. */
26047 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26048 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26049 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26050 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26052 if (x_intersect_rectangles (fr
, &wr
, &r
))
26054 int yb
= window_text_bottom_y (w
);
26055 struct glyph_row
*row
;
26056 int cursor_cleared_p
;
26057 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26059 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26060 r
.x
, r
.y
, r
.width
, r
.height
));
26062 /* Convert to window coordinates. */
26063 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26064 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26066 /* Turn off the cursor. */
26067 if (!w
->pseudo_window_p
26068 && phys_cursor_in_rect_p (w
, &r
))
26070 x_clear_cursor (w
);
26071 cursor_cleared_p
= 1;
26074 cursor_cleared_p
= 0;
26076 /* Update lines intersecting rectangle R. */
26077 first_overlapping_row
= last_overlapping_row
= NULL
;
26078 for (row
= w
->current_matrix
->rows
;
26083 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26085 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26086 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26087 || (r
.y
>= y0
&& r
.y
< y1
)
26088 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26090 /* A header line may be overlapping, but there is no need
26091 to fix overlapping areas for them. KFS 2005-02-12 */
26092 if (row
->overlapping_p
&& !row
->mode_line_p
)
26094 if (first_overlapping_row
== NULL
)
26095 first_overlapping_row
= row
;
26096 last_overlapping_row
= row
;
26100 if (expose_line (w
, row
, &r
))
26101 mouse_face_overwritten_p
= 1;
26104 else if (row
->overlapping_p
)
26106 /* We must redraw a row overlapping the exposed area. */
26108 ? y0
+ row
->phys_height
> r
.y
26109 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26111 if (first_overlapping_row
== NULL
)
26112 first_overlapping_row
= row
;
26113 last_overlapping_row
= row
;
26121 /* Display the mode line if there is one. */
26122 if (WINDOW_WANTS_MODELINE_P (w
)
26123 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26125 && row
->y
< r
.y
+ r
.height
)
26127 if (expose_line (w
, row
, &r
))
26128 mouse_face_overwritten_p
= 1;
26131 if (!w
->pseudo_window_p
)
26133 /* Fix the display of overlapping rows. */
26134 if (first_overlapping_row
)
26135 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26138 /* Draw border between windows. */
26139 x_draw_vertical_border (w
);
26141 /* Turn the cursor on again. */
26142 if (cursor_cleared_p
)
26143 update_window_cursor (w
, 1);
26147 return mouse_face_overwritten_p
;
26152 /* Redraw (parts) of all windows in the window tree rooted at W that
26153 intersect R. R contains frame pixel coordinates. Value is
26154 non-zero if the exposure overwrites mouse-face. */
26157 expose_window_tree (struct window
*w
, XRectangle
*r
)
26159 struct frame
*f
= XFRAME (w
->frame
);
26160 int mouse_face_overwritten_p
= 0;
26162 while (w
&& !FRAME_GARBAGED_P (f
))
26164 if (!NILP (w
->hchild
))
26165 mouse_face_overwritten_p
26166 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26167 else if (!NILP (w
->vchild
))
26168 mouse_face_overwritten_p
26169 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26171 mouse_face_overwritten_p
|= expose_window (w
, r
);
26173 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26176 return mouse_face_overwritten_p
;
26181 Redisplay an exposed area of frame F. X and Y are the upper-left
26182 corner of the exposed rectangle. W and H are width and height of
26183 the exposed area. All are pixel values. W or H zero means redraw
26184 the entire frame. */
26187 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26190 int mouse_face_overwritten_p
= 0;
26192 TRACE ((stderr
, "expose_frame "));
26194 /* No need to redraw if frame will be redrawn soon. */
26195 if (FRAME_GARBAGED_P (f
))
26197 TRACE ((stderr
, " garbaged\n"));
26201 /* If basic faces haven't been realized yet, there is no point in
26202 trying to redraw anything. This can happen when we get an expose
26203 event while Emacs is starting, e.g. by moving another window. */
26204 if (FRAME_FACE_CACHE (f
) == NULL
26205 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26207 TRACE ((stderr
, " no faces\n"));
26211 if (w
== 0 || h
== 0)
26214 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26215 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26225 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26226 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26228 if (WINDOWP (f
->tool_bar_window
))
26229 mouse_face_overwritten_p
26230 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26232 #ifdef HAVE_X_WINDOWS
26234 #ifndef USE_X_TOOLKIT
26235 if (WINDOWP (f
->menu_bar_window
))
26236 mouse_face_overwritten_p
26237 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26238 #endif /* not USE_X_TOOLKIT */
26242 /* Some window managers support a focus-follows-mouse style with
26243 delayed raising of frames. Imagine a partially obscured frame,
26244 and moving the mouse into partially obscured mouse-face on that
26245 frame. The visible part of the mouse-face will be highlighted,
26246 then the WM raises the obscured frame. With at least one WM, KDE
26247 2.1, Emacs is not getting any event for the raising of the frame
26248 (even tried with SubstructureRedirectMask), only Expose events.
26249 These expose events will draw text normally, i.e. not
26250 highlighted. Which means we must redo the highlight here.
26251 Subsume it under ``we love X''. --gerd 2001-08-15 */
26252 /* Included in Windows version because Windows most likely does not
26253 do the right thing if any third party tool offers
26254 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26255 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26257 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26258 if (f
== hlinfo
->mouse_face_mouse_frame
)
26260 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26261 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26262 clear_mouse_face (hlinfo
);
26263 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26270 Determine the intersection of two rectangles R1 and R2. Return
26271 the intersection in *RESULT. Value is non-zero if RESULT is not
26275 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26277 XRectangle
*left
, *right
;
26278 XRectangle
*upper
, *lower
;
26279 int intersection_p
= 0;
26281 /* Rearrange so that R1 is the left-most rectangle. */
26283 left
= r1
, right
= r2
;
26285 left
= r2
, right
= r1
;
26287 /* X0 of the intersection is right.x0, if this is inside R1,
26288 otherwise there is no intersection. */
26289 if (right
->x
<= left
->x
+ left
->width
)
26291 result
->x
= right
->x
;
26293 /* The right end of the intersection is the minimum of the
26294 the right ends of left and right. */
26295 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26298 /* Same game for Y. */
26300 upper
= r1
, lower
= r2
;
26302 upper
= r2
, lower
= r1
;
26304 /* The upper end of the intersection is lower.y0, if this is inside
26305 of upper. Otherwise, there is no intersection. */
26306 if (lower
->y
<= upper
->y
+ upper
->height
)
26308 result
->y
= lower
->y
;
26310 /* The lower end of the intersection is the minimum of the lower
26311 ends of upper and lower. */
26312 result
->height
= (min (lower
->y
+ lower
->height
,
26313 upper
->y
+ upper
->height
)
26315 intersection_p
= 1;
26319 return intersection_p
;
26322 #endif /* HAVE_WINDOW_SYSTEM */
26325 /***********************************************************************
26327 ***********************************************************************/
26330 syms_of_xdisp (void)
26332 Vwith_echo_area_save_vector
= Qnil
;
26333 staticpro (&Vwith_echo_area_save_vector
);
26335 Vmessage_stack
= Qnil
;
26336 staticpro (&Vmessage_stack
);
26338 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26339 staticpro (&Qinhibit_redisplay
);
26341 message_dolog_marker1
= Fmake_marker ();
26342 staticpro (&message_dolog_marker1
);
26343 message_dolog_marker2
= Fmake_marker ();
26344 staticpro (&message_dolog_marker2
);
26345 message_dolog_marker3
= Fmake_marker ();
26346 staticpro (&message_dolog_marker3
);
26349 defsubr (&Sdump_frame_glyph_matrix
);
26350 defsubr (&Sdump_glyph_matrix
);
26351 defsubr (&Sdump_glyph_row
);
26352 defsubr (&Sdump_tool_bar_row
);
26353 defsubr (&Strace_redisplay
);
26354 defsubr (&Strace_to_stderr
);
26356 #ifdef HAVE_WINDOW_SYSTEM
26357 defsubr (&Stool_bar_lines_needed
);
26358 defsubr (&Slookup_image_map
);
26360 defsubr (&Sformat_mode_line
);
26361 defsubr (&Sinvisible_p
);
26362 defsubr (&Scurrent_bidi_paragraph_direction
);
26364 staticpro (&Qmenu_bar_update_hook
);
26365 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26367 staticpro (&Qoverriding_terminal_local_map
);
26368 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26370 staticpro (&Qoverriding_local_map
);
26371 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26373 staticpro (&Qwindow_scroll_functions
);
26374 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26376 staticpro (&Qwindow_text_change_functions
);
26377 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26379 staticpro (&Qredisplay_end_trigger_functions
);
26380 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26382 staticpro (&Qinhibit_point_motion_hooks
);
26383 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26385 Qeval
= intern_c_string ("eval");
26386 staticpro (&Qeval
);
26388 QCdata
= intern_c_string (":data");
26389 staticpro (&QCdata
);
26390 Qdisplay
= intern_c_string ("display");
26391 staticpro (&Qdisplay
);
26392 Qspace_width
= intern_c_string ("space-width");
26393 staticpro (&Qspace_width
);
26394 Qraise
= intern_c_string ("raise");
26395 staticpro (&Qraise
);
26396 Qslice
= intern_c_string ("slice");
26397 staticpro (&Qslice
);
26398 Qspace
= intern_c_string ("space");
26399 staticpro (&Qspace
);
26400 Qmargin
= intern_c_string ("margin");
26401 staticpro (&Qmargin
);
26402 Qpointer
= intern_c_string ("pointer");
26403 staticpro (&Qpointer
);
26404 Qleft_margin
= intern_c_string ("left-margin");
26405 staticpro (&Qleft_margin
);
26406 Qright_margin
= intern_c_string ("right-margin");
26407 staticpro (&Qright_margin
);
26408 Qcenter
= intern_c_string ("center");
26409 staticpro (&Qcenter
);
26410 Qline_height
= intern_c_string ("line-height");
26411 staticpro (&Qline_height
);
26412 QCalign_to
= intern_c_string (":align-to");
26413 staticpro (&QCalign_to
);
26414 QCrelative_width
= intern_c_string (":relative-width");
26415 staticpro (&QCrelative_width
);
26416 QCrelative_height
= intern_c_string (":relative-height");
26417 staticpro (&QCrelative_height
);
26418 QCeval
= intern_c_string (":eval");
26419 staticpro (&QCeval
);
26420 QCpropertize
= intern_c_string (":propertize");
26421 staticpro (&QCpropertize
);
26422 QCfile
= intern_c_string (":file");
26423 staticpro (&QCfile
);
26424 Qfontified
= intern_c_string ("fontified");
26425 staticpro (&Qfontified
);
26426 Qfontification_functions
= intern_c_string ("fontification-functions");
26427 staticpro (&Qfontification_functions
);
26428 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26429 staticpro (&Qtrailing_whitespace
);
26430 Qescape_glyph
= intern_c_string ("escape-glyph");
26431 staticpro (&Qescape_glyph
);
26432 Qnobreak_space
= intern_c_string ("nobreak-space");
26433 staticpro (&Qnobreak_space
);
26434 Qimage
= intern_c_string ("image");
26435 staticpro (&Qimage
);
26436 Qtext
= intern_c_string ("text");
26437 staticpro (&Qtext
);
26438 Qboth
= intern_c_string ("both");
26439 staticpro (&Qboth
);
26440 Qboth_horiz
= intern_c_string ("both-horiz");
26441 staticpro (&Qboth_horiz
);
26442 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26443 staticpro (&Qtext_image_horiz
);
26444 QCmap
= intern_c_string (":map");
26445 staticpro (&QCmap
);
26446 QCpointer
= intern_c_string (":pointer");
26447 staticpro (&QCpointer
);
26448 Qrect
= intern_c_string ("rect");
26449 staticpro (&Qrect
);
26450 Qcircle
= intern_c_string ("circle");
26451 staticpro (&Qcircle
);
26452 Qpoly
= intern_c_string ("poly");
26453 staticpro (&Qpoly
);
26454 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26455 staticpro (&Qmessage_truncate_lines
);
26456 Qgrow_only
= intern_c_string ("grow-only");
26457 staticpro (&Qgrow_only
);
26458 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26459 staticpro (&Qinhibit_menubar_update
);
26460 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26461 staticpro (&Qinhibit_eval_during_redisplay
);
26462 Qposition
= intern_c_string ("position");
26463 staticpro (&Qposition
);
26464 Qbuffer_position
= intern_c_string ("buffer-position");
26465 staticpro (&Qbuffer_position
);
26466 Qobject
= intern_c_string ("object");
26467 staticpro (&Qobject
);
26468 Qbar
= intern_c_string ("bar");
26470 Qhbar
= intern_c_string ("hbar");
26471 staticpro (&Qhbar
);
26472 Qbox
= intern_c_string ("box");
26474 Qhollow
= intern_c_string ("hollow");
26475 staticpro (&Qhollow
);
26476 Qhand
= intern_c_string ("hand");
26477 staticpro (&Qhand
);
26478 Qarrow
= intern_c_string ("arrow");
26479 staticpro (&Qarrow
);
26480 Qtext
= intern_c_string ("text");
26481 staticpro (&Qtext
);
26482 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26483 staticpro (&Qinhibit_free_realized_faces
);
26485 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26486 Fcons (intern_c_string ("void-variable"), Qnil
)),
26488 staticpro (&list_of_error
);
26490 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26491 staticpro (&Qlast_arrow_position
);
26492 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26493 staticpro (&Qlast_arrow_string
);
26495 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26496 staticpro (&Qoverlay_arrow_string
);
26497 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26498 staticpro (&Qoverlay_arrow_bitmap
);
26500 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26501 staticpro (&echo_buffer
[0]);
26502 staticpro (&echo_buffer
[1]);
26504 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26505 staticpro (&echo_area_buffer
[0]);
26506 staticpro (&echo_area_buffer
[1]);
26508 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26509 staticpro (&Vmessages_buffer_name
);
26511 mode_line_proptrans_alist
= Qnil
;
26512 staticpro (&mode_line_proptrans_alist
);
26513 mode_line_string_list
= Qnil
;
26514 staticpro (&mode_line_string_list
);
26515 mode_line_string_face
= Qnil
;
26516 staticpro (&mode_line_string_face
);
26517 mode_line_string_face_prop
= Qnil
;
26518 staticpro (&mode_line_string_face_prop
);
26519 Vmode_line_unwind_vector
= Qnil
;
26520 staticpro (&Vmode_line_unwind_vector
);
26522 help_echo_string
= Qnil
;
26523 staticpro (&help_echo_string
);
26524 help_echo_object
= Qnil
;
26525 staticpro (&help_echo_object
);
26526 help_echo_window
= Qnil
;
26527 staticpro (&help_echo_window
);
26528 previous_help_echo_string
= Qnil
;
26529 staticpro (&previous_help_echo_string
);
26530 help_echo_pos
= -1;
26532 Qright_to_left
= intern_c_string ("right-to-left");
26533 staticpro (&Qright_to_left
);
26534 Qleft_to_right
= intern_c_string ("left-to-right");
26535 staticpro (&Qleft_to_right
);
26537 #ifdef HAVE_WINDOW_SYSTEM
26538 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26539 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26540 For example, if a block cursor is over a tab, it will be drawn as
26541 wide as that tab on the display. */);
26542 x_stretch_cursor_p
= 0;
26545 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26546 doc
: /* *Non-nil means highlight trailing whitespace.
26547 The face used for trailing whitespace is `trailing-whitespace'. */);
26548 Vshow_trailing_whitespace
= Qnil
;
26550 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26551 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26552 A value of t means highlight the character itself (for nobreak space,
26553 use face `nobreak-space').
26554 A value of nil means no highlighting.
26555 Other values mean display the escape glyph followed by an ordinary
26556 space or ordinary hyphen. */);
26557 Vnobreak_char_display
= Qt
;
26559 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26560 doc
: /* *The pointer shape to show in void text areas.
26561 A value of nil means to show the text pointer. Other options are `arrow',
26562 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26563 Vvoid_text_area_pointer
= Qarrow
;
26565 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26566 doc
: /* Non-nil means don't actually do any redisplay.
26567 This is used for internal purposes. */);
26568 Vinhibit_redisplay
= Qnil
;
26570 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26571 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26572 Vglobal_mode_string
= Qnil
;
26574 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26575 doc
: /* Marker for where to display an arrow on top of the buffer text.
26576 This must be the beginning of a line in order to work.
26577 See also `overlay-arrow-string'. */);
26578 Voverlay_arrow_position
= Qnil
;
26580 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26581 doc
: /* String to display as an arrow in non-window frames.
26582 See also `overlay-arrow-position'. */);
26583 Voverlay_arrow_string
= make_pure_c_string ("=>");
26585 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26586 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26587 The symbols on this list are examined during redisplay to determine
26588 where to display overlay arrows. */);
26589 Voverlay_arrow_variable_list
26590 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26592 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26593 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26594 If that fails to bring point back on frame, point is centered instead.
26595 If this is zero, point is always centered after it moves off frame.
26596 If you want scrolling to always be a line at a time, you should set
26597 `scroll-conservatively' to a large value rather than set this to 1. */);
26599 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26600 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26601 If point moves off-screen, redisplay will scroll by up to
26602 `scroll-conservatively' lines in order to bring point just barely
26603 onto the screen again. If that cannot be done, then redisplay
26604 recenters point as usual.
26606 If the value is greater than 100, redisplay will never recenter point,
26607 but will always scroll just enough text to bring point into view, even
26608 if you move far away.
26610 A value of zero means always recenter point if it moves off screen. */);
26611 scroll_conservatively
= 0;
26613 DEFVAR_INT ("scroll-margin", scroll_margin
,
26614 doc
: /* *Number of lines of margin at the top and bottom of a window.
26615 Recenter the window whenever point gets within this many lines
26616 of the top or bottom of the window. */);
26619 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26620 doc
: /* Pixels per inch value for non-window system displays.
26621 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26622 Vdisplay_pixels_per_inch
= make_float (72.0);
26625 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26628 DEFVAR_LISP ("truncate-partial-width-windows",
26629 Vtruncate_partial_width_windows
,
26630 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26631 For an integer value, truncate lines in each window narrower than the
26632 full frame width, provided the window width is less than that integer;
26633 otherwise, respect the value of `truncate-lines'.
26635 For any other non-nil value, truncate lines in all windows that do
26636 not span the full frame width.
26638 A value of nil means to respect the value of `truncate-lines'.
26640 If `word-wrap' is enabled, you might want to reduce this. */);
26641 Vtruncate_partial_width_windows
= make_number (50);
26643 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26644 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26645 Any other value means to use the appropriate face, `mode-line',
26646 `header-line', or `menu' respectively. */);
26647 mode_line_inverse_video
= 1;
26649 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26650 doc
: /* *Maximum buffer size for which line number should be displayed.
26651 If the buffer is bigger than this, the line number does not appear
26652 in the mode line. A value of nil means no limit. */);
26653 Vline_number_display_limit
= Qnil
;
26655 DEFVAR_INT ("line-number-display-limit-width",
26656 line_number_display_limit_width
,
26657 doc
: /* *Maximum line width (in characters) for line number display.
26658 If the average length of the lines near point is bigger than this, then the
26659 line number may be omitted from the mode line. */);
26660 line_number_display_limit_width
= 200;
26662 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26663 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26664 highlight_nonselected_windows
= 0;
26666 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26667 doc
: /* Non-nil if more than one frame is visible on this display.
26668 Minibuffer-only frames don't count, but iconified frames do.
26669 This variable is not guaranteed to be accurate except while processing
26670 `frame-title-format' and `icon-title-format'. */);
26672 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26673 doc
: /* Template for displaying the title bar of visible frames.
26674 \(Assuming the window manager supports this feature.)
26676 This variable has the same structure as `mode-line-format', except that
26677 the %c and %l constructs are ignored. It is used only on frames for
26678 which no explicit name has been set \(see `modify-frame-parameters'). */);
26680 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26681 doc
: /* Template for displaying the title bar of an iconified frame.
26682 \(Assuming the window manager supports this feature.)
26683 This variable has the same structure as `mode-line-format' (which see),
26684 and is used only on frames for which no explicit name has been set
26685 \(see `modify-frame-parameters'). */);
26687 = Vframe_title_format
26688 = pure_cons (intern_c_string ("multiple-frames"),
26689 pure_cons (make_pure_c_string ("%b"),
26690 pure_cons (pure_cons (empty_unibyte_string
,
26691 pure_cons (intern_c_string ("invocation-name"),
26692 pure_cons (make_pure_c_string ("@"),
26693 pure_cons (intern_c_string ("system-name"),
26697 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26698 doc
: /* Maximum number of lines to keep in the message log buffer.
26699 If nil, disable message logging. If t, log messages but don't truncate
26700 the buffer when it becomes large. */);
26701 Vmessage_log_max
= make_number (100);
26703 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26704 doc
: /* Functions called before redisplay, if window sizes have changed.
26705 The value should be a list of functions that take one argument.
26706 Just before redisplay, for each frame, if any of its windows have changed
26707 size since the last redisplay, or have been split or deleted,
26708 all the functions in the list are called, with the frame as argument. */);
26709 Vwindow_size_change_functions
= Qnil
;
26711 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26712 doc
: /* List of functions to call before redisplaying a window with scrolling.
26713 Each function is called with two arguments, the window and its new
26714 display-start position. Note that these functions are also called by
26715 `set-window-buffer'. Also note that the value of `window-end' is not
26716 valid when these functions are called. */);
26717 Vwindow_scroll_functions
= Qnil
;
26719 DEFVAR_LISP ("window-text-change-functions",
26720 Vwindow_text_change_functions
,
26721 doc
: /* Functions to call in redisplay when text in the window might change. */);
26722 Vwindow_text_change_functions
= Qnil
;
26724 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26725 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26726 Each function is called with two arguments, the window and the end trigger value.
26727 See `set-window-redisplay-end-trigger'. */);
26728 Vredisplay_end_trigger_functions
= Qnil
;
26730 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26731 doc
: /* *Non-nil means autoselect window with mouse pointer.
26732 If nil, do not autoselect windows.
26733 A positive number means delay autoselection by that many seconds: a
26734 window is autoselected only after the mouse has remained in that
26735 window for the duration of the delay.
26736 A negative number has a similar effect, but causes windows to be
26737 autoselected only after the mouse has stopped moving. \(Because of
26738 the way Emacs compares mouse events, you will occasionally wait twice
26739 that time before the window gets selected.\)
26740 Any other value means to autoselect window instantaneously when the
26741 mouse pointer enters it.
26743 Autoselection selects the minibuffer only if it is active, and never
26744 unselects the minibuffer if it is active.
26746 When customizing this variable make sure that the actual value of
26747 `focus-follows-mouse' matches the behavior of your window manager. */);
26748 Vmouse_autoselect_window
= Qnil
;
26750 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26751 doc
: /* *Non-nil means automatically resize tool-bars.
26752 This dynamically changes the tool-bar's height to the minimum height
26753 that is needed to make all tool-bar items visible.
26754 If value is `grow-only', the tool-bar's height is only increased
26755 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26756 Vauto_resize_tool_bars
= Qt
;
26758 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26759 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26760 auto_raise_tool_bar_buttons_p
= 1;
26762 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26763 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26764 make_cursor_line_fully_visible_p
= 1;
26766 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26767 doc
: /* *Border below tool-bar in pixels.
26768 If an integer, use it as the height of the border.
26769 If it is one of `internal-border-width' or `border-width', use the
26770 value of the corresponding frame parameter.
26771 Otherwise, no border is added below the tool-bar. */);
26772 Vtool_bar_border
= Qinternal_border_width
;
26774 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26775 doc
: /* *Margin around tool-bar buttons in pixels.
26776 If an integer, use that for both horizontal and vertical margins.
26777 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26778 HORZ specifying the horizontal margin, and VERT specifying the
26779 vertical margin. */);
26780 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26782 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26783 doc
: /* *Relief thickness of tool-bar buttons. */);
26784 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26786 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26787 doc
: /* Tool bar style to use.
26789 image - show images only
26790 text - show text only
26791 both - show both, text below image
26792 both-horiz - show text to the right of the image
26793 text-image-horiz - show text to the left of the image
26794 any other - use system default or image if no system default. */);
26795 Vtool_bar_style
= Qnil
;
26797 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26798 doc
: /* *Maximum number of characters a label can have to be shown.
26799 The tool bar style must also show labels for this to have any effect, see
26800 `tool-bar-style'. */);
26801 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26803 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26804 doc
: /* List of functions to call to fontify regions of text.
26805 Each function is called with one argument POS. Functions must
26806 fontify a region starting at POS in the current buffer, and give
26807 fontified regions the property `fontified'. */);
26808 Vfontification_functions
= Qnil
;
26809 Fmake_variable_buffer_local (Qfontification_functions
);
26811 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26812 unibyte_display_via_language_environment
,
26813 doc
: /* *Non-nil means display unibyte text according to language environment.
26814 Specifically, this means that raw bytes in the range 160-255 decimal
26815 are displayed by converting them to the equivalent multibyte characters
26816 according to the current language environment. As a result, they are
26817 displayed according to the current fontset.
26819 Note that this variable affects only how these bytes are displayed,
26820 but does not change the fact they are interpreted as raw bytes. */);
26821 unibyte_display_via_language_environment
= 0;
26823 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26824 doc
: /* *Maximum height for resizing mini-windows.
26825 If a float, it specifies a fraction of the mini-window frame's height.
26826 If an integer, it specifies a number of lines. */);
26827 Vmax_mini_window_height
= make_float (0.25);
26829 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26830 doc
: /* *How to resize mini-windows.
26831 A value of nil means don't automatically resize mini-windows.
26832 A value of t means resize them to fit the text displayed in them.
26833 A value of `grow-only', the default, means let mini-windows grow
26834 only, until their display becomes empty, at which point the windows
26835 go back to their normal size. */);
26836 Vresize_mini_windows
= Qgrow_only
;
26838 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26839 doc
: /* Alist specifying how to blink the cursor off.
26840 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26841 `cursor-type' frame-parameter or variable equals ON-STATE,
26842 comparing using `equal', Emacs uses OFF-STATE to specify
26843 how to blink it off. ON-STATE and OFF-STATE are values for
26844 the `cursor-type' frame parameter.
26846 If a frame's ON-STATE has no entry in this list,
26847 the frame's other specifications determine how to blink the cursor off. */);
26848 Vblink_cursor_alist
= Qnil
;
26850 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26851 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26852 If non-nil, windows are automatically scrolled horizontally to make
26853 point visible. */);
26854 automatic_hscrolling_p
= 1;
26855 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26856 staticpro (&Qauto_hscroll_mode
);
26858 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26859 doc
: /* *How many columns away from the window edge point is allowed to get
26860 before automatic hscrolling will horizontally scroll the window. */);
26861 hscroll_margin
= 5;
26863 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26864 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26865 When point is less than `hscroll-margin' columns from the window
26866 edge, automatic hscrolling will scroll the window by the amount of columns
26867 determined by this variable. If its value is a positive integer, scroll that
26868 many columns. If it's a positive floating-point number, it specifies the
26869 fraction of the window's width to scroll. If it's nil or zero, point will be
26870 centered horizontally after the scroll. Any other value, including negative
26871 numbers, are treated as if the value were zero.
26873 Automatic hscrolling always moves point outside the scroll margin, so if
26874 point was more than scroll step columns inside the margin, the window will
26875 scroll more than the value given by the scroll step.
26877 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26878 and `scroll-right' overrides this variable's effect. */);
26879 Vhscroll_step
= make_number (0);
26881 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26882 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26883 Bind this around calls to `message' to let it take effect. */);
26884 message_truncate_lines
= 0;
26886 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26887 doc
: /* Normal hook run to update the menu bar definitions.
26888 Redisplay runs this hook before it redisplays the menu bar.
26889 This is used to update submenus such as Buffers,
26890 whose contents depend on various data. */);
26891 Vmenu_bar_update_hook
= Qnil
;
26893 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26894 doc
: /* Frame for which we are updating a menu.
26895 The enable predicate for a menu binding should check this variable. */);
26896 Vmenu_updating_frame
= Qnil
;
26898 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26899 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26900 inhibit_menubar_update
= 0;
26902 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26903 doc
: /* Prefix prepended to all continuation lines at display time.
26904 The value may be a string, an image, or a stretch-glyph; it is
26905 interpreted in the same way as the value of a `display' text property.
26907 This variable is overridden by any `wrap-prefix' text or overlay
26910 To add a prefix to non-continuation lines, use `line-prefix'. */);
26911 Vwrap_prefix
= Qnil
;
26912 staticpro (&Qwrap_prefix
);
26913 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26914 Fmake_variable_buffer_local (Qwrap_prefix
);
26916 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26917 doc
: /* Prefix prepended to all non-continuation lines at display time.
26918 The value may be a string, an image, or a stretch-glyph; it is
26919 interpreted in the same way as the value of a `display' text property.
26921 This variable is overridden by any `line-prefix' text or overlay
26924 To add a prefix to continuation lines, use `wrap-prefix'. */);
26925 Vline_prefix
= Qnil
;
26926 staticpro (&Qline_prefix
);
26927 Qline_prefix
= intern_c_string ("line-prefix");
26928 Fmake_variable_buffer_local (Qline_prefix
);
26930 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26931 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26932 inhibit_eval_during_redisplay
= 0;
26934 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26935 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26936 inhibit_free_realized_faces
= 0;
26939 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26940 doc
: /* Inhibit try_window_id display optimization. */);
26941 inhibit_try_window_id
= 0;
26943 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26944 doc
: /* Inhibit try_window_reusing display optimization. */);
26945 inhibit_try_window_reusing
= 0;
26947 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26948 doc
: /* Inhibit try_cursor_movement display optimization. */);
26949 inhibit_try_cursor_movement
= 0;
26950 #endif /* GLYPH_DEBUG */
26952 DEFVAR_INT ("overline-margin", overline_margin
,
26953 doc
: /* *Space between overline and text, in pixels.
26954 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26955 margin to the caracter height. */);
26956 overline_margin
= 2;
26958 DEFVAR_INT ("underline-minimum-offset",
26959 underline_minimum_offset
,
26960 doc
: /* Minimum distance between baseline and underline.
26961 This can improve legibility of underlined text at small font sizes,
26962 particularly when using variable `x-use-underline-position-properties'
26963 with fonts that specify an UNDERLINE_POSITION relatively close to the
26964 baseline. The default value is 1. */);
26965 underline_minimum_offset
= 1;
26967 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26968 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26969 This feature only works when on a window system that can change
26970 cursor shapes. */);
26971 display_hourglass_p
= 1;
26973 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26974 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26975 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26977 hourglass_atimer
= NULL
;
26978 hourglass_shown_p
= 0;
26980 DEFSYM (Qglyphless_char
, "glyphless-char");
26981 DEFSYM (Qhex_code
, "hex-code");
26982 DEFSYM (Qempty_box
, "empty-box");
26983 DEFSYM (Qthin_space
, "thin-space");
26984 DEFSYM (Qzero_width
, "zero-width");
26986 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26987 /* Intern this now in case it isn't already done.
26988 Setting this variable twice is harmless.
26989 But don't staticpro it here--that is done in alloc.c. */
26990 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26991 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26993 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26994 doc
: /* Char-table to control displaying of glyphless characters.
26995 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26996 or one of these symbols:
26997 hex-code: display the hexadecimal code of a character in a box
26998 empty-box: display as an empty box
26999 thin-space: display as 1-pixel width space
27000 zero-width: don't display
27002 It has one extra slot to control the display of a character for which
27003 no font is found. The value of the slot is `hex-code' or `empty-box'.
27004 The default is `empty-box'. */);
27005 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27006 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27011 /* Initialize this module when Emacs starts. */
27016 Lisp_Object root_window
;
27017 struct window
*mini_w
;
27019 current_header_line_height
= current_mode_line_height
= -1;
27021 CHARPOS (this_line_start_pos
) = 0;
27023 mini_w
= XWINDOW (minibuf_window
);
27024 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27026 if (!noninteractive
)
27028 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27031 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27032 set_window_height (root_window
,
27033 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27035 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27036 set_window_height (minibuf_window
, 1, 0);
27038 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27039 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27041 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27042 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27043 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27045 /* The default ellipsis glyphs `...'. */
27046 for (i
= 0; i
< 3; ++i
)
27047 default_invis_vector
[i
] = make_number ('.');
27051 /* Allocate the buffer for frame titles.
27052 Also used for `format-mode-line'. */
27054 mode_line_noprop_buf
= (char *) xmalloc (size
);
27055 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27056 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27057 mode_line_target
= MODE_LINE_DISPLAY
;
27060 help_echo_showing_p
= 0;
27063 /* Since w32 does not support atimers, it defines its own implementation of
27064 the following three functions in w32fns.c. */
27067 /* Platform-independent portion of hourglass implementation. */
27069 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27071 hourglass_started (void)
27073 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27076 /* Cancel a currently active hourglass timer, and start a new one. */
27078 start_hourglass (void)
27080 #if defined (HAVE_WINDOW_SYSTEM)
27082 int secs
, usecs
= 0;
27084 cancel_hourglass ();
27086 if (INTEGERP (Vhourglass_delay
)
27087 && XINT (Vhourglass_delay
) > 0)
27088 secs
= XFASTINT (Vhourglass_delay
);
27089 else if (FLOATP (Vhourglass_delay
)
27090 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27093 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27094 secs
= XFASTINT (tem
);
27095 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27098 secs
= DEFAULT_HOURGLASS_DELAY
;
27100 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27101 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27102 show_hourglass
, NULL
);
27107 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27110 cancel_hourglass (void)
27112 #if defined (HAVE_WINDOW_SYSTEM)
27113 if (hourglass_atimer
)
27115 cancel_atimer (hourglass_atimer
);
27116 hourglass_atimer
= NULL
;
27119 if (hourglass_shown_p
)
27123 #endif /* ! WINDOWSNT */