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 move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 static Lisp_Object Qwindow_text_change_functions
;
322 static Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 static Lisp_Object QCeval
, QCpropertize
;
325 Lisp_Object QCfile
, QCdata
;
326 static Lisp_Object Qfontified
;
327 static Lisp_Object Qgrow_only
;
328 static Lisp_Object Qinhibit_eval_during_redisplay
;
329 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
330 static Lisp_Object Qright_to_left
, Qleft_to_right
;
333 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
336 static Lisp_Object Qarrow
, Qhand
;
339 /* Holds the list (error). */
340 static Lisp_Object list_of_error
;
342 static Lisp_Object Qfontification_functions
;
344 static Lisp_Object Qwrap_prefix
;
345 static Lisp_Object Qline_prefix
;
347 /* Non-nil means don't actually do any redisplay. */
349 Lisp_Object Qinhibit_redisplay
;
351 /* Names of text properties relevant for redisplay. */
353 Lisp_Object Qdisplay
;
355 Lisp_Object Qspace
, QCalign_to
;
356 static Lisp_Object QCrelative_width
, QCrelative_height
;
357 Lisp_Object Qleft_margin
, Qright_margin
;
358 static Lisp_Object Qspace_width
, Qraise
;
359 static Lisp_Object Qslice
;
361 static Lisp_Object Qmargin
, Qpointer
;
362 static Lisp_Object Qline_height
;
364 #ifdef HAVE_WINDOW_SYSTEM
366 /* Test if overflow newline into fringe. Called with iterator IT
367 at or past right window margin, and with IT->current_x set. */
369 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
370 (!NILP (Voverflow_newline_into_fringe) \
371 && FRAME_WINDOW_P ((IT)->f) \
372 && ((IT)->bidi_it.paragraph_dir == R2L \
373 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
374 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
375 && (IT)->current_x == (IT)->last_visible_x \
376 && (IT)->line_wrap != WORD_WRAP)
378 #else /* !HAVE_WINDOW_SYSTEM */
379 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
380 #endif /* HAVE_WINDOW_SYSTEM */
382 /* Test if the display element loaded in IT is a space or tab
383 character. This is used to determine word wrapping. */
385 #define IT_DISPLAYING_WHITESPACE(it) \
386 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
388 /* Name of the face used to highlight trailing whitespace. */
390 static Lisp_Object Qtrailing_whitespace
;
392 /* Name and number of the face used to highlight escape glyphs. */
394 static Lisp_Object Qescape_glyph
;
396 /* Name and number of the face used to highlight non-breaking spaces. */
398 static Lisp_Object Qnobreak_space
;
400 /* The symbol `image' which is the car of the lists used to represent
401 images in Lisp. Also a tool bar style. */
405 /* The image map types. */
407 static Lisp_Object QCpointer
;
408 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
410 /* Tool bar styles */
411 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
413 /* Non-zero means print newline to stdout before next mini-buffer
416 int noninteractive_need_newline
;
418 /* Non-zero means print newline to message log before next message. */
420 static int message_log_need_newline
;
422 /* Three markers that message_dolog uses.
423 It could allocate them itself, but that causes trouble
424 in handling memory-full errors. */
425 static Lisp_Object message_dolog_marker1
;
426 static Lisp_Object message_dolog_marker2
;
427 static Lisp_Object message_dolog_marker3
;
429 /* The buffer position of the first character appearing entirely or
430 partially on the line of the selected window which contains the
431 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
432 redisplay optimization in redisplay_internal. */
434 static struct text_pos this_line_start_pos
;
436 /* Number of characters past the end of the line above, including the
437 terminating newline. */
439 static struct text_pos this_line_end_pos
;
441 /* The vertical positions and the height of this line. */
443 static int this_line_vpos
;
444 static int this_line_y
;
445 static int this_line_pixel_height
;
447 /* X position at which this display line starts. Usually zero;
448 negative if first character is partially visible. */
450 static int this_line_start_x
;
452 /* The smallest character position seen by move_it_* functions as they
453 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
454 hscrolled lines, see display_line. */
456 static struct text_pos this_line_min_pos
;
458 /* Buffer that this_line_.* variables are referring to. */
460 static struct buffer
*this_line_buffer
;
463 /* Values of those variables at last redisplay are stored as
464 properties on `overlay-arrow-position' symbol. However, if
465 Voverlay_arrow_position is a marker, last-arrow-position is its
466 numerical position. */
468 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
470 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
471 properties on a symbol in overlay-arrow-variable-list. */
473 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
475 Lisp_Object Qmenu_bar_update_hook
;
477 /* Nonzero if an overlay arrow has been displayed in this window. */
479 static int overlay_arrow_seen
;
481 /* Number of windows showing the buffer of the selected window (or
482 another buffer with the same base buffer). keyboard.c refers to
487 /* Vector containing glyphs for an ellipsis `...'. */
489 static Lisp_Object default_invis_vector
[3];
491 /* This is the window where the echo area message was displayed. It
492 is always a mini-buffer window, but it may not be the same window
493 currently active as a mini-buffer. */
495 Lisp_Object echo_area_window
;
497 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
498 pushes the current message and the value of
499 message_enable_multibyte on the stack, the function restore_message
500 pops the stack and displays MESSAGE again. */
502 static Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 static int message_enable_multibyte
;
509 /* Nonzero if we should redraw the mode lines on the next redisplay. */
511 int update_mode_lines
;
513 /* Nonzero if window sizes or contents have changed since last
514 redisplay that finished. */
516 int windows_or_buffers_changed
;
518 /* Nonzero means a frame's cursor type has been changed. */
520 int cursor_type_changed
;
522 /* Nonzero after display_mode_line if %l was used and it displayed a
525 static int line_number_displayed
;
527 /* The name of the *Messages* buffer, a string. */
529 static Lisp_Object Vmessages_buffer_name
;
531 /* Current, index 0, and last displayed echo area message. Either
532 buffers from echo_buffers, or nil to indicate no message. */
534 Lisp_Object echo_area_buffer
[2];
536 /* The buffers referenced from echo_area_buffer. */
538 static Lisp_Object echo_buffer
[2];
540 /* A vector saved used in with_area_buffer to reduce consing. */
542 static Lisp_Object Vwith_echo_area_save_vector
;
544 /* Non-zero means display_echo_area should display the last echo area
545 message again. Set by redisplay_preserve_echo_area. */
547 static int display_last_displayed_message_p
;
549 /* Nonzero if echo area is being used by print; zero if being used by
552 static int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 static Lisp_Object Qinhibit_menubar_update
;
557 static Lisp_Object Qmessage_truncate_lines
;
559 /* Set to 1 in clear_message to make redisplay_internal aware
560 of an emptied echo area. */
562 static int message_cleared_p
;
564 /* A scratch glyph row with contents used for generating truncation
565 glyphs. Also used in direct_output_for_insert. */
567 #define MAX_SCRATCH_GLYPHS 100
568 static struct glyph_row scratch_glyph_row
;
569 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
571 /* Ascent and height of the last line processed by move_it_to. */
573 static int last_max_ascent
, last_height
;
575 /* Non-zero if there's a help-echo in the echo area. */
577 int help_echo_showing_p
;
579 /* If >= 0, computed, exact values of mode-line and header-line height
580 to use in the macros CURRENT_MODE_LINE_HEIGHT and
581 CURRENT_HEADER_LINE_HEIGHT. */
583 int current_mode_line_height
, current_header_line_height
;
585 /* The maximum distance to look ahead for text properties. Values
586 that are too small let us call compute_char_face and similar
587 functions too often which is expensive. Values that are too large
588 let us call compute_char_face and alike too often because we
589 might not be interested in text properties that far away. */
591 #define TEXT_PROP_DISTANCE_LIMIT 100
595 /* Non-zero means print traces of redisplay if compiled with
598 int trace_redisplay_p
;
600 #endif /* GLYPH_DEBUG */
602 #ifdef DEBUG_TRACE_MOVE
603 /* Non-zero means trace with TRACE_MOVE to stderr. */
606 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
608 #define TRACE_MOVE(x) (void) 0
611 static Lisp_Object Qauto_hscroll_mode
;
613 /* Buffer being redisplayed -- for redisplay_window_error. */
615 static struct buffer
*displayed_buffer
;
617 /* Value returned from text property handlers (see below). */
622 HANDLED_RECOMPUTE_PROPS
,
623 HANDLED_OVERLAY_STRING_CONSUMED
,
627 /* A description of text properties that redisplay is interested
632 /* The name of the property. */
635 /* A unique index for the property. */
638 /* A handler function called to set up iterator IT from the property
639 at IT's current position. Value is used to steer handle_stop. */
640 enum prop_handled (*handler
) (struct it
*it
);
643 static enum prop_handled
handle_face_prop (struct it
*);
644 static enum prop_handled
handle_invisible_prop (struct it
*);
645 static enum prop_handled
handle_display_prop (struct it
*);
646 static enum prop_handled
handle_composition_prop (struct it
*);
647 static enum prop_handled
handle_overlay_change (struct it
*);
648 static enum prop_handled
handle_fontified_prop (struct it
*);
650 /* Properties handled by iterators. */
652 static struct props it_props
[] =
654 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
655 /* Handle `face' before `display' because some sub-properties of
656 `display' need to know the face. */
657 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
658 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
659 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
660 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
664 /* Value is the position described by X. If X is a marker, value is
665 the marker_position of X. Otherwise, value is X. */
667 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
669 /* Enumeration returned by some move_it_.* functions internally. */
673 /* Not used. Undefined value. */
676 /* Move ended at the requested buffer position or ZV. */
677 MOVE_POS_MATCH_OR_ZV
,
679 /* Move ended at the requested X pixel position. */
682 /* Move within a line ended at the end of a line that must be
686 /* Move within a line ended at the end of a line that would
687 be displayed truncated. */
690 /* Move within a line ended at a line end. */
694 /* This counter is used to clear the face cache every once in a while
695 in redisplay_internal. It is incremented for each redisplay.
696 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
699 #define CLEAR_FACE_CACHE_COUNT 500
700 static int clear_face_cache_count
;
702 /* Similarly for the image cache. */
704 #ifdef HAVE_WINDOW_SYSTEM
705 #define CLEAR_IMAGE_CACHE_COUNT 101
706 static int clear_image_cache_count
;
708 /* Null glyph slice */
709 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
712 /* Non-zero while redisplay_internal is in progress. */
716 static Lisp_Object Qinhibit_free_realized_faces
;
718 /* If a string, XTread_socket generates an event to display that string.
719 (The display is done in read_char.) */
721 Lisp_Object help_echo_string
;
722 Lisp_Object help_echo_window
;
723 Lisp_Object help_echo_object
;
724 EMACS_INT help_echo_pos
;
726 /* Temporary variable for XTread_socket. */
728 Lisp_Object previous_help_echo_string
;
730 /* Platform-independent portion of hourglass implementation. */
732 /* Non-zero means an hourglass cursor is currently shown. */
733 int hourglass_shown_p
;
735 /* If non-null, an asynchronous timer that, when it expires, displays
736 an hourglass cursor on all frames. */
737 struct atimer
*hourglass_atimer
;
739 /* Name of the face used to display glyphless characters. */
740 Lisp_Object Qglyphless_char
;
742 /* Symbol for the purpose of Vglyphless_char_display. */
743 static Lisp_Object Qglyphless_char_display
;
745 /* Method symbols for Vglyphless_char_display. */
746 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
748 /* Default pixel width of `thin-space' display method. */
749 #define THIN_SPACE_WIDTH 1
751 /* Default number of seconds to wait before displaying an hourglass
753 #define DEFAULT_HOURGLASS_DELAY 1
756 /* Function prototypes. */
758 static void setup_for_ellipsis (struct it
*, int);
759 static void set_iterator_to_next (struct it
*, int);
760 static void mark_window_display_accurate_1 (struct window
*, int);
761 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
762 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
763 static int cursor_row_p (struct glyph_row
*);
764 static int redisplay_mode_lines (Lisp_Object
, int);
765 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
767 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
769 static void handle_line_prefix (struct it
*);
771 static void pint2str (char *, int, EMACS_INT
);
772 static void pint2hrstr (char *, int, EMACS_INT
);
773 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
775 static void reconsider_clip_changes (struct window
*, struct buffer
*);
776 static int text_outside_line_unchanged_p (struct window
*,
777 EMACS_INT
, EMACS_INT
);
778 static void store_mode_line_noprop_char (char);
779 static int store_mode_line_noprop (const char *, int, int);
780 static void handle_stop (struct it
*);
781 static void handle_stop_backwards (struct it
*, EMACS_INT
);
782 static 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 void pop_message (void);
792 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
793 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
794 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
795 static int display_echo_area (struct window
*);
796 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
797 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static Lisp_Object
unwind_redisplay (Lisp_Object
);
799 static int string_char_and_length (const unsigned char *, int *);
800 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
802 static int compute_window_start_on_continuation_line (struct window
*);
803 static Lisp_Object
safe_eval_handler (Lisp_Object
);
804 static void insert_left_trunc_glyphs (struct it
*);
805 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
807 static void extend_face_to_end_of_line (struct it
*);
808 static int append_space_for_newline (struct it
*, int);
809 static int cursor_row_fully_visible_p (struct window
*, int, int);
810 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
811 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
812 static int trailing_whitespace_p (EMACS_INT
);
813 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
814 static void push_it (struct it
*, struct text_pos
*);
815 static void pop_it (struct it
*);
816 static void sync_frame_with_window_matrix_rows (struct window
*);
817 static void select_frame_for_redisplay (Lisp_Object
);
818 static void redisplay_internal (void);
819 static int echo_area_display (int);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, int);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
828 static int update_menu_bar (struct frame
*, int, int);
829 static int try_window_reusing_current_matrix (struct window
*);
830 static int try_window_id (struct window
*);
831 static int display_line (struct it
*);
832 static int display_mode_lines (struct window
*);
833 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
834 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
835 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
836 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
837 static void display_menu_bar (struct window
*);
838 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
840 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
841 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
842 static void compute_line_metrics (struct it
*);
843 static void run_redisplay_end_trigger_hook (struct it
*);
844 static int get_overlay_strings (struct it
*, EMACS_INT
);
845 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
846 static void next_overlay_string (struct it
*);
847 static void reseat (struct it
*, struct text_pos
, int);
848 static void reseat_1 (struct it
*, struct text_pos
, int);
849 static void back_to_previous_visible_line_start (struct it
*);
850 void reseat_at_previous_visible_line_start (struct it
*);
851 static void reseat_at_next_visible_line_start (struct it
*, int);
852 static int next_element_from_ellipsis (struct it
*);
853 static int next_element_from_display_vector (struct it
*);
854 static int next_element_from_string (struct it
*);
855 static int next_element_from_c_string (struct it
*);
856 static int next_element_from_buffer (struct it
*);
857 static int next_element_from_composition (struct it
*);
858 static int next_element_from_image (struct it
*);
859 static int next_element_from_stretch (struct it
*);
860 static void load_overlay_strings (struct it
*, EMACS_INT
);
861 static int init_from_display_pos (struct it
*, struct window
*,
862 struct display_pos
*);
863 static void reseat_to_string (struct it
*, const char *,
864 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
865 static int get_next_display_element (struct it
*);
866 static enum move_it_result
867 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
868 enum move_operation_enum
);
869 void move_it_vertically_backward (struct it
*, int);
870 static void init_to_row_start (struct it
*, struct window
*,
872 static int init_to_row_end (struct it
*, struct window
*,
874 static void back_to_previous_line_start (struct it
*);
875 static int forward_to_next_line_start (struct it
*, int *);
876 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
877 Lisp_Object
, EMACS_INT
);
878 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
879 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
880 static EMACS_INT
number_of_chars (const char *, int);
881 static void compute_stop_pos (struct it
*);
882 static void compute_string_pos (struct text_pos
*, struct text_pos
,
884 static int face_before_or_after_it_pos (struct it
*, int);
885 static EMACS_INT
next_overlay_change (EMACS_INT
);
886 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
887 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
888 static int handle_single_display_spec (struct it
*, Lisp_Object
,
889 Lisp_Object
, Lisp_Object
,
890 struct text_pos
*, EMACS_INT
, int, int);
891 static int underlying_face_id (struct it
*);
892 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
895 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
896 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
898 #ifdef HAVE_WINDOW_SYSTEM
900 static void x_consider_frame_title (Lisp_Object
);
901 static int tool_bar_lines_needed (struct frame
*, int *);
902 static void update_tool_bar (struct frame
*, int);
903 static void build_desired_tool_bar_string (struct frame
*f
);
904 static int redisplay_tool_bar (struct frame
*);
905 static void display_tool_bar_line (struct it
*, int);
906 static void notice_overwritten_cursor (struct window
*,
909 static void append_stretch_glyph (struct it
*, Lisp_Object
,
913 #endif /* HAVE_WINDOW_SYSTEM */
915 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
916 static int coords_in_mouse_face_p (struct window
*, int, int);
920 /***********************************************************************
921 Window display dimensions
922 ***********************************************************************/
924 /* Return the bottom boundary y-position for text lines in window W.
925 This is the first y position at which a line cannot start.
926 It is relative to the top of the window.
928 This is the height of W minus the height of a mode line, if any. */
931 window_text_bottom_y (struct window
*w
)
933 int height
= WINDOW_TOTAL_HEIGHT (w
);
935 if (WINDOW_WANTS_MODELINE_P (w
))
936 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
940 /* Return the pixel width of display area AREA of window W. AREA < 0
941 means return the total width of W, not including fringes to
942 the left and right of the window. */
945 window_box_width (struct window
*w
, int area
)
947 int cols
= XFASTINT (w
->total_cols
);
950 if (!w
->pseudo_window_p
)
952 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
954 if (area
== TEXT_AREA
)
956 if (INTEGERP (w
->left_margin_cols
))
957 cols
-= XFASTINT (w
->left_margin_cols
);
958 if (INTEGERP (w
->right_margin_cols
))
959 cols
-= XFASTINT (w
->right_margin_cols
);
960 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
962 else if (area
== LEFT_MARGIN_AREA
)
964 cols
= (INTEGERP (w
->left_margin_cols
)
965 ? XFASTINT (w
->left_margin_cols
) : 0);
968 else if (area
== RIGHT_MARGIN_AREA
)
970 cols
= (INTEGERP (w
->right_margin_cols
)
971 ? XFASTINT (w
->right_margin_cols
) : 0);
976 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
980 /* Return the pixel height of the display area of window W, not
981 including mode lines of W, if any. */
984 window_box_height (struct window
*w
)
986 struct frame
*f
= XFRAME (w
->frame
);
987 int height
= WINDOW_TOTAL_HEIGHT (w
);
989 xassert (height
>= 0);
991 /* Note: the code below that determines the mode-line/header-line
992 height is essentially the same as that contained in the macro
993 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
994 the appropriate glyph row has its `mode_line_p' flag set,
995 and if it doesn't, uses estimate_mode_line_height instead. */
997 if (WINDOW_WANTS_MODELINE_P (w
))
999 struct glyph_row
*ml_row
1000 = (w
->current_matrix
&& w
->current_matrix
->rows
1001 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1003 if (ml_row
&& ml_row
->mode_line_p
)
1004 height
-= ml_row
->height
;
1006 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1009 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1011 struct glyph_row
*hl_row
1012 = (w
->current_matrix
&& w
->current_matrix
->rows
1013 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1015 if (hl_row
&& hl_row
->mode_line_p
)
1016 height
-= hl_row
->height
;
1018 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1021 /* With a very small font and a mode-line that's taller than
1022 default, we might end up with a negative height. */
1023 return max (0, height
);
1026 /* Return the window-relative coordinate of the left edge of display
1027 area AREA of window W. AREA < 0 means return the left edge of the
1028 whole window, to the right of the left fringe of W. */
1031 window_box_left_offset (struct window
*w
, int area
)
1035 if (w
->pseudo_window_p
)
1038 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1040 if (area
== TEXT_AREA
)
1041 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1042 + window_box_width (w
, LEFT_MARGIN_AREA
));
1043 else if (area
== RIGHT_MARGIN_AREA
)
1044 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1045 + window_box_width (w
, LEFT_MARGIN_AREA
)
1046 + window_box_width (w
, TEXT_AREA
)
1047 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1049 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1050 else if (area
== LEFT_MARGIN_AREA
1051 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1052 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1058 /* Return the window-relative coordinate of the right edge of display
1059 area AREA of window W. AREA < 0 means return the right edge of the
1060 whole window, to the left of the right fringe of W. */
1063 window_box_right_offset (struct window
*w
, int area
)
1065 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1068 /* Return the frame-relative coordinate of the left edge of display
1069 area AREA of window W. AREA < 0 means return the left edge of the
1070 whole window, to the right of the left fringe of W. */
1073 window_box_left (struct window
*w
, int area
)
1075 struct frame
*f
= XFRAME (w
->frame
);
1078 if (w
->pseudo_window_p
)
1079 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1081 x
= (WINDOW_LEFT_EDGE_X (w
)
1082 + window_box_left_offset (w
, area
));
1088 /* Return the frame-relative coordinate of the right edge of display
1089 area AREA of window W. AREA < 0 means return the right edge of the
1090 whole window, to the left of the right fringe of W. */
1093 window_box_right (struct window
*w
, int area
)
1095 return window_box_left (w
, area
) + window_box_width (w
, area
);
1098 /* Get the bounding box of the display area AREA of window W, without
1099 mode lines, in frame-relative coordinates. AREA < 0 means the
1100 whole window, not including the left and right fringes of
1101 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1102 coordinates of the upper-left corner of the box. Return in
1103 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1106 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1107 int *box_width
, int *box_height
)
1110 *box_width
= window_box_width (w
, area
);
1112 *box_height
= window_box_height (w
);
1114 *box_x
= window_box_left (w
, area
);
1117 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1118 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1119 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1124 /* Get the bounding box of the display area AREA of window W, without
1125 mode lines. AREA < 0 means the whole window, not including the
1126 left and right fringe of the window. Return in *TOP_LEFT_X
1127 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1128 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1129 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1133 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1134 int *bottom_right_x
, int *bottom_right_y
)
1136 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1138 *bottom_right_x
+= *top_left_x
;
1139 *bottom_right_y
+= *top_left_y
;
1144 /***********************************************************************
1146 ***********************************************************************/
1148 /* Return the bottom y-position of the line the iterator IT is in.
1149 This can modify IT's settings. */
1152 line_bottom_y (struct it
*it
)
1154 int line_height
= it
->max_ascent
+ it
->max_descent
;
1155 int line_top_y
= it
->current_y
;
1157 if (line_height
== 0)
1160 line_height
= last_height
;
1161 else if (IT_CHARPOS (*it
) < ZV
)
1163 move_it_by_lines (it
, 1);
1164 line_height
= (it
->max_ascent
|| it
->max_descent
1165 ? it
->max_ascent
+ it
->max_descent
1170 struct glyph_row
*row
= it
->glyph_row
;
1172 /* Use the default character height. */
1173 it
->glyph_row
= NULL
;
1174 it
->what
= IT_CHARACTER
;
1177 PRODUCE_GLYPHS (it
);
1178 line_height
= it
->ascent
+ it
->descent
;
1179 it
->glyph_row
= row
;
1183 return line_top_y
+ line_height
;
1187 /* Return 1 if position CHARPOS is visible in window W.
1188 CHARPOS < 0 means return info about WINDOW_END position.
1189 If visible, set *X and *Y to pixel coordinates of top left corner.
1190 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1191 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1194 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1195 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1198 struct text_pos top
;
1200 struct buffer
*old_buffer
= NULL
;
1202 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1205 if (XBUFFER (w
->buffer
) != current_buffer
)
1207 old_buffer
= current_buffer
;
1208 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1211 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1213 /* Compute exact mode line heights. */
1214 if (WINDOW_WANTS_MODELINE_P (w
))
1215 current_mode_line_height
1216 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1217 BVAR (current_buffer
, mode_line_format
));
1219 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1220 current_header_line_height
1221 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1222 BVAR (current_buffer
, header_line_format
));
1224 start_display (&it
, w
, top
);
1225 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1226 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1228 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1230 /* We have reached CHARPOS, or passed it. How the call to
1231 move_it_to can overshoot: (i) If CHARPOS is on invisible
1232 text, move_it_to stops at the end of the invisible text,
1233 after CHARPOS. (ii) If CHARPOS is in a display vector,
1234 move_it_to stops on its last glyph. */
1235 int top_x
= it
.current_x
;
1236 int top_y
= it
.current_y
;
1237 enum it_method it_method
= it
.method
;
1238 /* Calling line_bottom_y may change it.method, it.position, etc. */
1239 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1240 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1242 if (top_y
< window_top_y
)
1243 visible_p
= bottom_y
> window_top_y
;
1244 else if (top_y
< it
.last_visible_y
)
1248 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1250 /* We stopped on the last glyph of a display vector.
1251 Try and recompute. Hack alert! */
1252 if (charpos
< 2 || top
.charpos
>= charpos
)
1253 top_x
= it
.glyph_row
->x
;
1257 start_display (&it2
, w
, top
);
1258 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1259 get_next_display_element (&it2
);
1260 PRODUCE_GLYPHS (&it2
);
1261 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1262 || it2
.current_x
> it2
.last_visible_x
)
1263 top_x
= it
.glyph_row
->x
;
1266 top_x
= it2
.current_x
;
1267 top_y
= it2
.current_y
;
1273 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1274 *rtop
= max (0, window_top_y
- top_y
);
1275 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1276 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1277 - max (top_y
, window_top_y
)));
1286 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1287 move_it_by_lines (&it
, 1);
1288 if (charpos
< IT_CHARPOS (it
)
1289 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1292 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1294 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1295 *rtop
= max (0, -it2
.current_y
);
1296 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1297 - it
.last_visible_y
));
1298 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1300 - max (it2
.current_y
,
1301 WINDOW_HEADER_LINE_HEIGHT (w
))));
1307 set_buffer_internal_1 (old_buffer
);
1309 current_header_line_height
= current_mode_line_height
= -1;
1311 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1312 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1315 /* Debugging code. */
1317 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1318 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1320 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1327 /* Return the next character from STR. Return in *LEN the length of
1328 the character. This is like STRING_CHAR_AND_LENGTH but never
1329 returns an invalid character. If we find one, we return a `?', but
1330 with the length of the invalid character. */
1333 string_char_and_length (const unsigned char *str
, int *len
)
1337 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1338 if (!CHAR_VALID_P (c
))
1339 /* We may not change the length here because other places in Emacs
1340 don't use this function, i.e. they silently accept invalid
1349 /* Given a position POS containing a valid character and byte position
1350 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1352 static struct text_pos
1353 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1355 xassert (STRINGP (string
) && nchars
>= 0);
1357 if (STRING_MULTIBYTE (string
))
1359 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1364 string_char_and_length (p
, &len
);
1367 BYTEPOS (pos
) += len
;
1371 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1377 /* Value is the text position, i.e. character and byte position,
1378 for character position CHARPOS in STRING. */
1380 static inline struct text_pos
1381 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1383 struct text_pos pos
;
1384 xassert (STRINGP (string
));
1385 xassert (charpos
>= 0);
1386 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1391 /* Value is a text position, i.e. character and byte position, for
1392 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1393 means recognize multibyte characters. */
1395 static struct text_pos
1396 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1398 struct text_pos pos
;
1400 xassert (s
!= NULL
);
1401 xassert (charpos
>= 0);
1407 SET_TEXT_POS (pos
, 0, 0);
1410 string_char_and_length ((const unsigned char *) s
, &len
);
1413 BYTEPOS (pos
) += len
;
1417 SET_TEXT_POS (pos
, charpos
, charpos
);
1423 /* Value is the number of characters in C string S. MULTIBYTE_P
1424 non-zero means recognize multibyte characters. */
1427 number_of_chars (const char *s
, int multibyte_p
)
1433 EMACS_INT rest
= strlen (s
);
1435 const unsigned char *p
= (const unsigned char *) s
;
1437 for (nchars
= 0; rest
> 0; ++nchars
)
1439 string_char_and_length (p
, &len
);
1440 rest
-= len
, p
+= len
;
1444 nchars
= strlen (s
);
1450 /* Compute byte position NEWPOS->bytepos corresponding to
1451 NEWPOS->charpos. POS is a known position in string STRING.
1452 NEWPOS->charpos must be >= POS.charpos. */
1455 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1457 xassert (STRINGP (string
));
1458 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1460 if (STRING_MULTIBYTE (string
))
1461 *newpos
= string_pos_nchars_ahead (pos
, string
,
1462 CHARPOS (*newpos
) - CHARPOS (pos
));
1464 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1468 Return an estimation of the pixel height of mode or header lines on
1469 frame F. FACE_ID specifies what line's height to estimate. */
1472 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1474 #ifdef HAVE_WINDOW_SYSTEM
1475 if (FRAME_WINDOW_P (f
))
1477 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1479 /* This function is called so early when Emacs starts that the face
1480 cache and mode line face are not yet initialized. */
1481 if (FRAME_FACE_CACHE (f
))
1483 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1487 height
= FONT_HEIGHT (face
->font
);
1488 if (face
->box_line_width
> 0)
1489 height
+= 2 * face
->box_line_width
;
1500 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1501 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1502 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1503 not force the value into range. */
1506 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1507 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1510 #ifdef HAVE_WINDOW_SYSTEM
1511 if (FRAME_WINDOW_P (f
))
1513 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1514 even for negative values. */
1516 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1518 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1520 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1521 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1524 STORE_NATIVE_RECT (*bounds
,
1525 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1526 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1527 FRAME_COLUMN_WIDTH (f
) - 1,
1528 FRAME_LINE_HEIGHT (f
) - 1);
1534 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1535 pix_x
= FRAME_TOTAL_COLS (f
);
1539 else if (pix_y
> FRAME_LINES (f
))
1540 pix_y
= FRAME_LINES (f
);
1550 /* Find the glyph under window-relative coordinates X/Y in window W.
1551 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1552 strings. Return in *HPOS and *VPOS the row and column number of
1553 the glyph found. Return in *AREA the glyph area containing X.
1554 Value is a pointer to the glyph found or null if X/Y is not on
1555 text, or we can't tell because W's current matrix is not up to
1560 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1561 int *dx
, int *dy
, int *area
)
1563 struct glyph
*glyph
, *end
;
1564 struct glyph_row
*row
= NULL
;
1567 /* Find row containing Y. Give up if some row is not enabled. */
1568 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1570 row
= MATRIX_ROW (w
->current_matrix
, i
);
1571 if (!row
->enabled_p
)
1573 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1580 /* Give up if Y is not in the window. */
1581 if (i
== w
->current_matrix
->nrows
)
1584 /* Get the glyph area containing X. */
1585 if (w
->pseudo_window_p
)
1592 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1594 *area
= LEFT_MARGIN_AREA
;
1595 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1597 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1600 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1604 *area
= RIGHT_MARGIN_AREA
;
1605 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1609 /* Find glyph containing X. */
1610 glyph
= row
->glyphs
[*area
];
1611 end
= glyph
+ row
->used
[*area
];
1613 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1615 x
-= glyph
->pixel_width
;
1625 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1628 *hpos
= glyph
- row
->glyphs
[*area
];
1632 /* Convert frame-relative x/y to coordinates relative to window W.
1633 Takes pseudo-windows into account. */
1636 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1638 if (w
->pseudo_window_p
)
1640 /* A pseudo-window is always full-width, and starts at the
1641 left edge of the frame, plus a frame border. */
1642 struct frame
*f
= XFRAME (w
->frame
);
1643 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1644 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1648 *x
-= WINDOW_LEFT_EDGE_X (w
);
1649 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1653 #ifdef HAVE_WINDOW_SYSTEM
1656 Return in RECTS[] at most N clipping rectangles for glyph string S.
1657 Return the number of stored rectangles. */
1660 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1667 if (s
->row
->full_width_p
)
1669 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1670 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1671 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1673 /* Unless displaying a mode or menu bar line, which are always
1674 fully visible, clip to the visible part of the row. */
1675 if (s
->w
->pseudo_window_p
)
1676 r
.height
= s
->row
->visible_height
;
1678 r
.height
= s
->height
;
1682 /* This is a text line that may be partially visible. */
1683 r
.x
= window_box_left (s
->w
, s
->area
);
1684 r
.width
= window_box_width (s
->w
, s
->area
);
1685 r
.height
= s
->row
->visible_height
;
1689 if (r
.x
< s
->clip_head
->x
)
1691 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1692 r
.width
-= s
->clip_head
->x
- r
.x
;
1695 r
.x
= s
->clip_head
->x
;
1698 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1700 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1701 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1706 /* If S draws overlapping rows, it's sufficient to use the top and
1707 bottom of the window for clipping because this glyph string
1708 intentionally draws over other lines. */
1709 if (s
->for_overlaps
)
1711 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1712 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1714 /* Alas, the above simple strategy does not work for the
1715 environments with anti-aliased text: if the same text is
1716 drawn onto the same place multiple times, it gets thicker.
1717 If the overlap we are processing is for the erased cursor, we
1718 take the intersection with the rectagle of the cursor. */
1719 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1721 XRectangle rc
, r_save
= r
;
1723 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1724 rc
.y
= s
->w
->phys_cursor
.y
;
1725 rc
.width
= s
->w
->phys_cursor_width
;
1726 rc
.height
= s
->w
->phys_cursor_height
;
1728 x_intersect_rectangles (&r_save
, &rc
, &r
);
1733 /* Don't use S->y for clipping because it doesn't take partially
1734 visible lines into account. For example, it can be negative for
1735 partially visible lines at the top of a window. */
1736 if (!s
->row
->full_width_p
1737 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1738 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1740 r
.y
= max (0, s
->row
->y
);
1743 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1745 /* If drawing the cursor, don't let glyph draw outside its
1746 advertised boundaries. Cleartype does this under some circumstances. */
1747 if (s
->hl
== DRAW_CURSOR
)
1749 struct glyph
*glyph
= s
->first_glyph
;
1754 r
.width
-= s
->x
- r
.x
;
1757 r
.width
= min (r
.width
, glyph
->pixel_width
);
1759 /* If r.y is below window bottom, ensure that we still see a cursor. */
1760 height
= min (glyph
->ascent
+ glyph
->descent
,
1761 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1762 max_y
= window_text_bottom_y (s
->w
) - height
;
1763 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1764 if (s
->ybase
- glyph
->ascent
> max_y
)
1771 /* Don't draw cursor glyph taller than our actual glyph. */
1772 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1773 if (height
< r
.height
)
1775 max_y
= r
.y
+ r
.height
;
1776 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1777 r
.height
= min (max_y
- r
.y
, height
);
1784 XRectangle r_save
= r
;
1786 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1790 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1791 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1793 #ifdef CONVERT_FROM_XRECT
1794 CONVERT_FROM_XRECT (r
, *rects
);
1802 /* If we are processing overlapping and allowed to return
1803 multiple clipping rectangles, we exclude the row of the glyph
1804 string from the clipping rectangle. This is to avoid drawing
1805 the same text on the environment with anti-aliasing. */
1806 #ifdef CONVERT_FROM_XRECT
1809 XRectangle
*rs
= rects
;
1811 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1813 if (s
->for_overlaps
& OVERLAPS_PRED
)
1816 if (r
.y
+ r
.height
> row_y
)
1819 rs
[i
].height
= row_y
- r
.y
;
1825 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1828 if (r
.y
< row_y
+ s
->row
->visible_height
)
1830 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1832 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1833 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1842 #ifdef CONVERT_FROM_XRECT
1843 for (i
= 0; i
< n
; i
++)
1844 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1851 Return in *NR the clipping rectangle for glyph string S. */
1854 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1856 get_glyph_string_clip_rects (s
, nr
, 1);
1861 Return the position and height of the phys cursor in window W.
1862 Set w->phys_cursor_width to width of phys cursor.
1866 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1867 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1869 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1870 int x
, y
, wd
, h
, h0
, y0
;
1872 /* Compute the width of the rectangle to draw. If on a stretch
1873 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1874 rectangle as wide as the glyph, but use a canonical character
1876 wd
= glyph
->pixel_width
- 1;
1877 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1881 x
= w
->phys_cursor
.x
;
1888 if (glyph
->type
== STRETCH_GLYPH
1889 && !x_stretch_cursor_p
)
1890 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1891 w
->phys_cursor_width
= wd
;
1893 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1895 /* If y is below window bottom, ensure that we still see a cursor. */
1896 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1898 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1899 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1901 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1904 h
= max (h
- (y0
- y
) + 1, h0
);
1909 y0
= window_text_bottom_y (w
) - h0
;
1917 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1918 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1923 * Remember which glyph the mouse is over.
1927 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1931 struct glyph_row
*r
, *gr
, *end_row
;
1932 enum window_part part
;
1933 enum glyph_row_area area
;
1934 int x
, y
, width
, height
;
1936 /* Try to determine frame pixel position and size of the glyph under
1937 frame pixel coordinates X/Y on frame F. */
1939 if (!f
->glyphs_initialized_p
1940 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1943 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1944 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1948 w
= XWINDOW (window
);
1949 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1950 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1952 x
= window_relative_x_coord (w
, part
, gx
);
1953 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1955 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1956 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1958 if (w
->pseudo_window_p
)
1961 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1967 case ON_LEFT_MARGIN
:
1968 area
= LEFT_MARGIN_AREA
;
1971 case ON_RIGHT_MARGIN
:
1972 area
= RIGHT_MARGIN_AREA
;
1975 case ON_HEADER_LINE
:
1977 gr
= (part
== ON_HEADER_LINE
1978 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1979 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1982 goto text_glyph_row_found
;
1989 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1990 if (r
->y
+ r
->height
> y
)
1996 text_glyph_row_found
:
1999 struct glyph
*g
= gr
->glyphs
[area
];
2000 struct glyph
*end
= g
+ gr
->used
[area
];
2002 height
= gr
->height
;
2003 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2004 if (gx
+ g
->pixel_width
> x
)
2009 if (g
->type
== IMAGE_GLYPH
)
2011 /* Don't remember when mouse is over image, as
2012 image may have hot-spots. */
2013 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2016 width
= g
->pixel_width
;
2020 /* Use nominal char spacing at end of line. */
2022 gx
+= (x
/ width
) * width
;
2025 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2026 gx
+= window_box_left_offset (w
, area
);
2030 /* Use nominal line height at end of window. */
2031 gx
= (x
/ width
) * width
;
2033 gy
+= (y
/ height
) * height
;
2037 case ON_LEFT_FRINGE
:
2038 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2039 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2040 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2041 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2044 case ON_RIGHT_FRINGE
:
2045 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2046 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2047 : window_box_right_offset (w
, TEXT_AREA
));
2048 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2052 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2054 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2055 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2056 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2058 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2062 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2063 if (r
->y
+ r
->height
> y
)
2070 height
= gr
->height
;
2073 /* Use nominal line height at end of window. */
2075 gy
+= (y
/ height
) * height
;
2082 /* If there is no glyph under the mouse, then we divide the screen
2083 into a grid of the smallest glyph in the frame, and use that
2086 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2087 round down even for negative values. */
2093 gx
= (gx
/ width
) * width
;
2094 gy
= (gy
/ height
) * height
;
2099 gx
+= WINDOW_LEFT_EDGE_X (w
);
2100 gy
+= WINDOW_TOP_EDGE_Y (w
);
2103 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2105 /* Visible feedback for debugging. */
2108 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2109 f
->output_data
.x
->normal_gc
,
2110 gx
, gy
, width
, height
);
2116 #endif /* HAVE_WINDOW_SYSTEM */
2119 /***********************************************************************
2120 Lisp form evaluation
2121 ***********************************************************************/
2123 /* Error handler for safe_eval and safe_call. */
2126 safe_eval_handler (Lisp_Object arg
)
2128 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2133 /* Evaluate SEXPR and return the result, or nil if something went
2134 wrong. Prevent redisplay during the evaluation. */
2136 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2137 Return the result, or nil if something went wrong. Prevent
2138 redisplay during the evaluation. */
2141 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2145 if (inhibit_eval_during_redisplay
)
2149 int count
= SPECPDL_INDEX ();
2150 struct gcpro gcpro1
;
2153 gcpro1
.nvars
= nargs
;
2154 specbind (Qinhibit_redisplay
, Qt
);
2155 /* Use Qt to ensure debugger does not run,
2156 so there is no possibility of wanting to redisplay. */
2157 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2160 val
= unbind_to (count
, val
);
2167 /* Call function FN with one argument ARG.
2168 Return the result, or nil if something went wrong. */
2171 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2173 Lisp_Object args
[2];
2176 return safe_call (2, args
);
2179 static Lisp_Object Qeval
;
2182 safe_eval (Lisp_Object sexpr
)
2184 return safe_call1 (Qeval
, sexpr
);
2187 /* Call function FN with one argument ARG.
2188 Return the result, or nil if something went wrong. */
2191 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2193 Lisp_Object args
[3];
2197 return safe_call (3, args
);
2202 /***********************************************************************
2204 ***********************************************************************/
2208 /* Define CHECK_IT to perform sanity checks on iterators.
2209 This is for debugging. It is too slow to do unconditionally. */
2215 if (it
->method
== GET_FROM_STRING
)
2217 xassert (STRINGP (it
->string
));
2218 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2222 xassert (IT_STRING_CHARPOS (*it
) < 0);
2223 if (it
->method
== GET_FROM_BUFFER
)
2225 /* Check that character and byte positions agree. */
2226 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2231 xassert (it
->current
.dpvec_index
>= 0);
2233 xassert (it
->current
.dpvec_index
< 0);
2236 #define CHECK_IT(IT) check_it ((IT))
2240 #define CHECK_IT(IT) (void) 0
2245 #if GLYPH_DEBUG && XASSERTS
2247 /* Check that the window end of window W is what we expect it
2248 to be---the last row in the current matrix displaying text. */
2251 check_window_end (struct window
*w
)
2253 if (!MINI_WINDOW_P (w
)
2254 && !NILP (w
->window_end_valid
))
2256 struct glyph_row
*row
;
2257 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2258 XFASTINT (w
->window_end_vpos
)),
2260 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2261 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2265 #define CHECK_WINDOW_END(W) check_window_end ((W))
2269 #define CHECK_WINDOW_END(W) (void) 0
2275 /***********************************************************************
2276 Iterator initialization
2277 ***********************************************************************/
2279 /* Initialize IT for displaying current_buffer in window W, starting
2280 at character position CHARPOS. CHARPOS < 0 means that no buffer
2281 position is specified which is useful when the iterator is assigned
2282 a position later. BYTEPOS is the byte position corresponding to
2283 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2285 If ROW is not null, calls to produce_glyphs with IT as parameter
2286 will produce glyphs in that row.
2288 BASE_FACE_ID is the id of a base face to use. It must be one of
2289 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2290 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2291 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2293 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2294 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2295 will be initialized to use the corresponding mode line glyph row of
2296 the desired matrix of W. */
2299 init_iterator (struct it
*it
, struct window
*w
,
2300 EMACS_INT charpos
, EMACS_INT bytepos
,
2301 struct glyph_row
*row
, enum face_id base_face_id
)
2303 int highlight_region_p
;
2304 enum face_id remapped_base_face_id
= base_face_id
;
2306 /* Some precondition checks. */
2307 xassert (w
!= NULL
&& it
!= NULL
);
2308 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2311 /* If face attributes have been changed since the last redisplay,
2312 free realized faces now because they depend on face definitions
2313 that might have changed. Don't free faces while there might be
2314 desired matrices pending which reference these faces. */
2315 if (face_change_count
&& !inhibit_free_realized_faces
)
2317 face_change_count
= 0;
2318 free_all_realized_faces (Qnil
);
2321 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2322 if (! NILP (Vface_remapping_alist
))
2323 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2325 /* Use one of the mode line rows of W's desired matrix if
2329 if (base_face_id
== MODE_LINE_FACE_ID
2330 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2331 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2332 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2333 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2337 memset (it
, 0, sizeof *it
);
2338 it
->current
.overlay_string_index
= -1;
2339 it
->current
.dpvec_index
= -1;
2340 it
->base_face_id
= remapped_base_face_id
;
2342 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2344 /* The window in which we iterate over current_buffer: */
2345 XSETWINDOW (it
->window
, w
);
2347 it
->f
= XFRAME (w
->frame
);
2351 /* Extra space between lines (on window systems only). */
2352 if (base_face_id
== DEFAULT_FACE_ID
2353 && FRAME_WINDOW_P (it
->f
))
2355 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2356 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2357 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2358 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2359 * FRAME_LINE_HEIGHT (it
->f
));
2360 else if (it
->f
->extra_line_spacing
> 0)
2361 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2362 it
->max_extra_line_spacing
= 0;
2365 /* If realized faces have been removed, e.g. because of face
2366 attribute changes of named faces, recompute them. When running
2367 in batch mode, the face cache of the initial frame is null. If
2368 we happen to get called, make a dummy face cache. */
2369 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2370 init_frame_faces (it
->f
);
2371 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2372 recompute_basic_faces (it
->f
);
2374 /* Current value of the `slice', `space-width', and 'height' properties. */
2375 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2376 it
->space_width
= Qnil
;
2377 it
->font_height
= Qnil
;
2378 it
->override_ascent
= -1;
2380 /* Are control characters displayed as `^C'? */
2381 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2383 /* -1 means everything between a CR and the following line end
2384 is invisible. >0 means lines indented more than this value are
2386 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2387 ? XINT (BVAR (current_buffer
, selective_display
))
2388 : (!NILP (BVAR (current_buffer
, selective_display
))
2390 it
->selective_display_ellipsis_p
2391 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2393 /* Display table to use. */
2394 it
->dp
= window_display_table (w
);
2396 /* Are multibyte characters enabled in current_buffer? */
2397 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2399 /* Do we need to reorder bidirectional text? Not if this is a
2400 unibyte buffer: by definition, none of the single-byte characters
2401 are strong R2L, so no reordering is needed. And bidi.c doesn't
2402 support unibyte buffers anyway. */
2404 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2406 /* Non-zero if we should highlight the region. */
2408 = (!NILP (Vtransient_mark_mode
)
2409 && !NILP (BVAR (current_buffer
, mark_active
))
2410 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2412 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2413 start and end of a visible region in window IT->w. Set both to
2414 -1 to indicate no region. */
2415 if (highlight_region_p
2416 /* Maybe highlight only in selected window. */
2417 && (/* Either show region everywhere. */
2418 highlight_nonselected_windows
2419 /* Or show region in the selected window. */
2420 || w
== XWINDOW (selected_window
)
2421 /* Or show the region if we are in the mini-buffer and W is
2422 the window the mini-buffer refers to. */
2423 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2424 && WINDOWP (minibuf_selected_window
)
2425 && w
== XWINDOW (minibuf_selected_window
))))
2427 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2428 it
->region_beg_charpos
= min (PT
, markpos
);
2429 it
->region_end_charpos
= max (PT
, markpos
);
2432 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2434 /* Get the position at which the redisplay_end_trigger hook should
2435 be run, if it is to be run at all. */
2436 if (MARKERP (w
->redisplay_end_trigger
)
2437 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2438 it
->redisplay_end_trigger_charpos
2439 = marker_position (w
->redisplay_end_trigger
);
2440 else if (INTEGERP (w
->redisplay_end_trigger
))
2441 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2443 /* Correct bogus values of tab_width. */
2444 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2445 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2448 /* Are lines in the display truncated? */
2449 if (base_face_id
!= DEFAULT_FACE_ID
2450 || XINT (it
->w
->hscroll
)
2451 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2452 && ((!NILP (Vtruncate_partial_width_windows
)
2453 && !INTEGERP (Vtruncate_partial_width_windows
))
2454 || (INTEGERP (Vtruncate_partial_width_windows
)
2455 && (WINDOW_TOTAL_COLS (it
->w
)
2456 < XINT (Vtruncate_partial_width_windows
))))))
2457 it
->line_wrap
= TRUNCATE
;
2458 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2459 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2460 ? WINDOW_WRAP
: WORD_WRAP
;
2462 it
->line_wrap
= TRUNCATE
;
2464 /* Get dimensions of truncation and continuation glyphs. These are
2465 displayed as fringe bitmaps under X, so we don't need them for such
2467 if (!FRAME_WINDOW_P (it
->f
))
2469 if (it
->line_wrap
== TRUNCATE
)
2471 /* We will need the truncation glyph. */
2472 xassert (it
->glyph_row
== NULL
);
2473 produce_special_glyphs (it
, IT_TRUNCATION
);
2474 it
->truncation_pixel_width
= it
->pixel_width
;
2478 /* We will need the continuation glyph. */
2479 xassert (it
->glyph_row
== NULL
);
2480 produce_special_glyphs (it
, IT_CONTINUATION
);
2481 it
->continuation_pixel_width
= it
->pixel_width
;
2484 /* Reset these values to zero because the produce_special_glyphs
2485 above has changed them. */
2486 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2487 it
->phys_ascent
= it
->phys_descent
= 0;
2490 /* Set this after getting the dimensions of truncation and
2491 continuation glyphs, so that we don't produce glyphs when calling
2492 produce_special_glyphs, above. */
2493 it
->glyph_row
= row
;
2494 it
->area
= TEXT_AREA
;
2496 /* Forget any previous info about this row being reversed. */
2498 it
->glyph_row
->reversed_p
= 0;
2500 /* Get the dimensions of the display area. The display area
2501 consists of the visible window area plus a horizontally scrolled
2502 part to the left of the window. All x-values are relative to the
2503 start of this total display area. */
2504 if (base_face_id
!= DEFAULT_FACE_ID
)
2506 /* Mode lines, menu bar in terminal frames. */
2507 it
->first_visible_x
= 0;
2508 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2513 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2514 it
->last_visible_x
= (it
->first_visible_x
2515 + window_box_width (w
, TEXT_AREA
));
2517 /* If we truncate lines, leave room for the truncator glyph(s) at
2518 the right margin. Otherwise, leave room for the continuation
2519 glyph(s). Truncation and continuation glyphs are not inserted
2520 for window-based redisplay. */
2521 if (!FRAME_WINDOW_P (it
->f
))
2523 if (it
->line_wrap
== TRUNCATE
)
2524 it
->last_visible_x
-= it
->truncation_pixel_width
;
2526 it
->last_visible_x
-= it
->continuation_pixel_width
;
2529 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2530 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2533 /* Leave room for a border glyph. */
2534 if (!FRAME_WINDOW_P (it
->f
)
2535 && !WINDOW_RIGHTMOST_P (it
->w
))
2536 it
->last_visible_x
-= 1;
2538 it
->last_visible_y
= window_text_bottom_y (w
);
2540 /* For mode lines and alike, arrange for the first glyph having a
2541 left box line if the face specifies a box. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2546 it
->face_id
= remapped_base_face_id
;
2548 /* If we have a boxed mode line, make the first character appear
2549 with a left box line. */
2550 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2551 if (face
->box
!= FACE_NO_BOX
)
2552 it
->start_of_box_run_p
= 1;
2555 /* If we are to reorder bidirectional text, init the bidi
2559 /* Note the paragraph direction that this buffer wants to
2561 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2562 it
->paragraph_embedding
= L2R
;
2563 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2564 it
->paragraph_embedding
= R2L
;
2566 it
->paragraph_embedding
= NEUTRAL_DIR
;
2567 bidi_init_it (charpos
, bytepos
, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
2570 /* If a buffer position was specified, set the iterator there,
2571 getting overlays and face properties from that position. */
2572 if (charpos
>= BUF_BEG (current_buffer
))
2574 it
->end_charpos
= ZV
;
2576 IT_CHARPOS (*it
) = charpos
;
2578 /* Compute byte position if not specified. */
2579 if (bytepos
< charpos
)
2580 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2582 IT_BYTEPOS (*it
) = bytepos
;
2584 it
->start
= it
->current
;
2586 /* Compute faces etc. */
2587 reseat (it
, it
->current
.pos
, 1);
2594 /* Initialize IT for the display of window W with window start POS. */
2597 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2599 struct glyph_row
*row
;
2600 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2602 row
= w
->desired_matrix
->rows
+ first_vpos
;
2603 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2604 it
->first_vpos
= first_vpos
;
2606 /* Don't reseat to previous visible line start if current start
2607 position is in a string or image. */
2608 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2610 int start_at_line_beg_p
;
2611 int first_y
= it
->current_y
;
2613 /* If window start is not at a line start, skip forward to POS to
2614 get the correct continuation lines width. */
2615 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2616 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2617 if (!start_at_line_beg_p
)
2621 reseat_at_previous_visible_line_start (it
);
2622 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2624 new_x
= it
->current_x
+ it
->pixel_width
;
2626 /* If lines are continued, this line may end in the middle
2627 of a multi-glyph character (e.g. a control character
2628 displayed as \003, or in the middle of an overlay
2629 string). In this case move_it_to above will not have
2630 taken us to the start of the continuation line but to the
2631 end of the continued line. */
2632 if (it
->current_x
> 0
2633 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2634 && (/* And glyph doesn't fit on the line. */
2635 new_x
> it
->last_visible_x
2636 /* Or it fits exactly and we're on a window
2638 || (new_x
== it
->last_visible_x
2639 && FRAME_WINDOW_P (it
->f
))))
2641 if (it
->current
.dpvec_index
>= 0
2642 || it
->current
.overlay_string_index
>= 0)
2644 set_iterator_to_next (it
, 1);
2645 move_it_in_display_line_to (it
, -1, -1, 0);
2648 it
->continuation_lines_width
+= it
->current_x
;
2651 /* We're starting a new display line, not affected by the
2652 height of the continued line, so clear the appropriate
2653 fields in the iterator structure. */
2654 it
->max_ascent
= it
->max_descent
= 0;
2655 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2657 it
->current_y
= first_y
;
2659 it
->current_x
= it
->hpos
= 0;
2665 /* Return 1 if POS is a position in ellipses displayed for invisible
2666 text. W is the window we display, for text property lookup. */
2669 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2671 Lisp_Object prop
, window
;
2673 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2675 /* If POS specifies a position in a display vector, this might
2676 be for an ellipsis displayed for invisible text. We won't
2677 get the iterator set up for delivering that ellipsis unless
2678 we make sure that it gets aware of the invisible text. */
2679 if (pos
->dpvec_index
>= 0
2680 && pos
->overlay_string_index
< 0
2681 && CHARPOS (pos
->string_pos
) < 0
2683 && (XSETWINDOW (window
, w
),
2684 prop
= Fget_char_property (make_number (charpos
),
2685 Qinvisible
, window
),
2686 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2688 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2690 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2697 /* Initialize IT for stepping through current_buffer in window W,
2698 starting at position POS that includes overlay string and display
2699 vector/ control character translation position information. Value
2700 is zero if there are overlay strings with newlines at POS. */
2703 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2705 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2706 int i
, overlay_strings_with_newlines
= 0;
2708 /* If POS specifies a position in a display vector, this might
2709 be for an ellipsis displayed for invisible text. We won't
2710 get the iterator set up for delivering that ellipsis unless
2711 we make sure that it gets aware of the invisible text. */
2712 if (in_ellipses_for_invisible_text_p (pos
, w
))
2718 /* Keep in mind: the call to reseat in init_iterator skips invisible
2719 text, so we might end up at a position different from POS. This
2720 is only a problem when POS is a row start after a newline and an
2721 overlay starts there with an after-string, and the overlay has an
2722 invisible property. Since we don't skip invisible text in
2723 display_line and elsewhere immediately after consuming the
2724 newline before the row start, such a POS will not be in a string,
2725 but the call to init_iterator below will move us to the
2727 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2729 /* This only scans the current chunk -- it should scan all chunks.
2730 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2731 to 16 in 22.1 to make this a lesser problem. */
2732 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2734 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2735 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2737 while (s
< e
&& *s
!= '\n')
2742 overlay_strings_with_newlines
= 1;
2747 /* If position is within an overlay string, set up IT to the right
2749 if (pos
->overlay_string_index
>= 0)
2753 /* If the first overlay string happens to have a `display'
2754 property for an image, the iterator will be set up for that
2755 image, and we have to undo that setup first before we can
2756 correct the overlay string index. */
2757 if (it
->method
== GET_FROM_IMAGE
)
2760 /* We already have the first chunk of overlay strings in
2761 IT->overlay_strings. Load more until the one for
2762 pos->overlay_string_index is in IT->overlay_strings. */
2763 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2765 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2766 it
->current
.overlay_string_index
= 0;
2769 load_overlay_strings (it
, 0);
2770 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2774 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2775 relative_index
= (it
->current
.overlay_string_index
2776 % OVERLAY_STRING_CHUNK_SIZE
);
2777 it
->string
= it
->overlay_strings
[relative_index
];
2778 xassert (STRINGP (it
->string
));
2779 it
->current
.string_pos
= pos
->string_pos
;
2780 it
->method
= GET_FROM_STRING
;
2783 if (CHARPOS (pos
->string_pos
) >= 0)
2785 /* Recorded position is not in an overlay string, but in another
2786 string. This can only be a string from a `display' property.
2787 IT should already be filled with that string. */
2788 it
->current
.string_pos
= pos
->string_pos
;
2789 xassert (STRINGP (it
->string
));
2792 /* Restore position in display vector translations, control
2793 character translations or ellipses. */
2794 if (pos
->dpvec_index
>= 0)
2796 if (it
->dpvec
== NULL
)
2797 get_next_display_element (it
);
2798 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2799 it
->current
.dpvec_index
= pos
->dpvec_index
;
2803 return !overlay_strings_with_newlines
;
2807 /* Initialize IT for stepping through current_buffer in window W
2808 starting at ROW->start. */
2811 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2813 init_from_display_pos (it
, w
, &row
->start
);
2814 it
->start
= row
->start
;
2815 it
->continuation_lines_width
= row
->continuation_lines_width
;
2820 /* Initialize IT for stepping through current_buffer in window W
2821 starting in the line following ROW, i.e. starting at ROW->end.
2822 Value is zero if there are overlay strings with newlines at ROW's
2826 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2830 if (init_from_display_pos (it
, w
, &row
->end
))
2832 if (row
->continued_p
)
2833 it
->continuation_lines_width
2834 = row
->continuation_lines_width
+ row
->pixel_width
;
2845 /***********************************************************************
2847 ***********************************************************************/
2849 /* Called when IT reaches IT->stop_charpos. Handle text property and
2850 overlay changes. Set IT->stop_charpos to the next position where
2854 handle_stop (struct it
*it
)
2856 enum prop_handled handled
;
2857 int handle_overlay_change_p
;
2861 it
->current
.dpvec_index
= -1;
2862 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2863 it
->ignore_overlay_strings_at_pos_p
= 0;
2866 /* Use face of preceding text for ellipsis (if invisible) */
2867 if (it
->selective_display_ellipsis_p
)
2868 it
->saved_face_id
= it
->face_id
;
2872 handled
= HANDLED_NORMALLY
;
2874 /* Call text property handlers. */
2875 for (p
= it_props
; p
->handler
; ++p
)
2877 handled
= p
->handler (it
);
2879 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2881 else if (handled
== HANDLED_RETURN
)
2883 /* We still want to show before and after strings from
2884 overlays even if the actual buffer text is replaced. */
2885 if (!handle_overlay_change_p
2887 || !get_overlay_strings_1 (it
, 0, 0))
2890 setup_for_ellipsis (it
, 0);
2891 /* When handling a display spec, we might load an
2892 empty string. In that case, discard it here. We
2893 used to discard it in handle_single_display_spec,
2894 but that causes get_overlay_strings_1, above, to
2895 ignore overlay strings that we must check. */
2896 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2900 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2904 it
->ignore_overlay_strings_at_pos_p
= 1;
2905 it
->string_from_display_prop_p
= 0;
2906 handle_overlay_change_p
= 0;
2908 handled
= HANDLED_RECOMPUTE_PROPS
;
2911 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2912 handle_overlay_change_p
= 0;
2915 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2917 /* Don't check for overlay strings below when set to deliver
2918 characters from a display vector. */
2919 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2920 handle_overlay_change_p
= 0;
2922 /* Handle overlay changes.
2923 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2924 if it finds overlays. */
2925 if (handle_overlay_change_p
)
2926 handled
= handle_overlay_change (it
);
2931 setup_for_ellipsis (it
, 0);
2935 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2937 /* Determine where to stop next. */
2938 if (handled
== HANDLED_NORMALLY
)
2939 compute_stop_pos (it
);
2943 /* Compute IT->stop_charpos from text property and overlay change
2944 information for IT's current position. */
2947 compute_stop_pos (struct it
*it
)
2949 register INTERVAL iv
, next_iv
;
2950 Lisp_Object object
, limit
, position
;
2951 EMACS_INT charpos
, bytepos
;
2953 /* If nowhere else, stop at the end. */
2954 it
->stop_charpos
= it
->end_charpos
;
2956 if (STRINGP (it
->string
))
2958 /* Strings are usually short, so don't limit the search for
2960 object
= it
->string
;
2962 charpos
= IT_STRING_CHARPOS (*it
);
2963 bytepos
= IT_STRING_BYTEPOS (*it
);
2969 /* If next overlay change is in front of the current stop pos
2970 (which is IT->end_charpos), stop there. Note: value of
2971 next_overlay_change is point-max if no overlay change
2973 charpos
= IT_CHARPOS (*it
);
2974 bytepos
= IT_BYTEPOS (*it
);
2975 pos
= next_overlay_change (charpos
);
2976 if (pos
< it
->stop_charpos
)
2977 it
->stop_charpos
= pos
;
2979 /* If showing the region, we have to stop at the region
2980 start or end because the face might change there. */
2981 if (it
->region_beg_charpos
> 0)
2983 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2984 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2985 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2986 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2989 /* Set up variables for computing the stop position from text
2990 property changes. */
2991 XSETBUFFER (object
, current_buffer
);
2992 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2995 /* Get the interval containing IT's position. Value is a null
2996 interval if there isn't such an interval. */
2997 position
= make_number (charpos
);
2998 iv
= validate_interval_range (object
, &position
, &position
, 0);
2999 if (!NULL_INTERVAL_P (iv
))
3001 Lisp_Object values_here
[LAST_PROP_IDX
];
3004 /* Get properties here. */
3005 for (p
= it_props
; p
->handler
; ++p
)
3006 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3008 /* Look for an interval following iv that has different
3010 for (next_iv
= next_interval (iv
);
3011 (!NULL_INTERVAL_P (next_iv
)
3013 || XFASTINT (limit
) > next_iv
->position
));
3014 next_iv
= next_interval (next_iv
))
3016 for (p
= it_props
; p
->handler
; ++p
)
3018 Lisp_Object new_value
;
3020 new_value
= textget (next_iv
->plist
, *p
->name
);
3021 if (!EQ (values_here
[p
->idx
], new_value
))
3029 if (!NULL_INTERVAL_P (next_iv
))
3031 if (INTEGERP (limit
)
3032 && next_iv
->position
>= XFASTINT (limit
))
3033 /* No text property change up to limit. */
3034 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3036 /* Text properties change in next_iv. */
3037 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3041 if (it
->cmp_it
.id
< 0)
3043 EMACS_INT stoppos
= it
->end_charpos
;
3045 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3047 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3048 stoppos
, it
->string
);
3051 xassert (STRINGP (it
->string
)
3052 || (it
->stop_charpos
>= BEGV
3053 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3057 /* Return the position of the next overlay change after POS in
3058 current_buffer. Value is point-max if no overlay change
3059 follows. This is like `next-overlay-change' but doesn't use
3063 next_overlay_change (EMACS_INT pos
)
3065 ptrdiff_t i
, noverlays
;
3067 Lisp_Object
*overlays
;
3069 /* Get all overlays at the given position. */
3070 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3072 /* If any of these overlays ends before endpos,
3073 use its ending point instead. */
3074 for (i
= 0; i
< noverlays
; ++i
)
3079 oend
= OVERLAY_END (overlays
[i
]);
3080 oendpos
= OVERLAY_POSITION (oend
);
3081 endpos
= min (endpos
, oendpos
);
3087 /* Return the character position of a display string at or after CHARPOS.
3088 If no display string exists at or after CHARPOS, return ZV. A
3089 display string is either an overlay with `display' property whose
3090 value is a string, or a `display' text property whose value is a
3091 string. FRAME_WINDOW_P is non-zero when we are displaying a window
3094 compute_display_string_pos (EMACS_INT charpos
, int frame_window_p
)
3096 /* FIXME: Support display properties on strings (object = Qnil means
3098 Lisp_Object object
= Qnil
;
3099 Lisp_Object pos
, spec
;
3100 struct text_pos position
;
3106 /* If the character at CHARPOS is where the display string begins,
3108 pos
= make_number (charpos
);
3109 CHARPOS (position
) = charpos
;
3110 BYTEPOS (position
) = CHAR_TO_BYTE (charpos
);
3111 bufpos
= charpos
; /* FIXME! support strings as well */
3112 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3114 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3117 && handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3121 /* Look forward for the first character with a `display' property
3122 that will replace the underlying text when displayed. */
3124 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3125 CHARPOS (position
) = XFASTINT (pos
);
3126 BYTEPOS (position
) = CHAR_TO_BYTE (CHARPOS (position
));
3127 if (CHARPOS (position
) >= ZV
)
3129 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3130 bufpos
= CHARPOS (position
); /* FIXME! support strings as well */
3131 } while (NILP (spec
)
3132 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3135 return CHARPOS (position
);
3138 /* Return the character position of the end of the display string that
3139 started at CHARPOS. A display string is either an overlay with
3140 `display' property whose value is a string or a `display' text
3141 property whose value is a string. */
3143 compute_display_string_end (EMACS_INT charpos
)
3145 /* FIXME: Support display properties on strings (object = Qnil means
3147 Lisp_Object object
= Qnil
;
3148 Lisp_Object pos
= make_number (charpos
);
3153 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3156 /* Look forward for the first character where the `display' property
3158 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3160 return XFASTINT (pos
);
3165 /***********************************************************************
3167 ***********************************************************************/
3169 /* Handle changes in the `fontified' property of the current buffer by
3170 calling hook functions from Qfontification_functions to fontify
3173 static enum prop_handled
3174 handle_fontified_prop (struct it
*it
)
3176 Lisp_Object prop
, pos
;
3177 enum prop_handled handled
= HANDLED_NORMALLY
;
3179 if (!NILP (Vmemory_full
))
3182 /* Get the value of the `fontified' property at IT's current buffer
3183 position. (The `fontified' property doesn't have a special
3184 meaning in strings.) If the value is nil, call functions from
3185 Qfontification_functions. */
3186 if (!STRINGP (it
->string
)
3188 && !NILP (Vfontification_functions
)
3189 && !NILP (Vrun_hooks
)
3190 && (pos
= make_number (IT_CHARPOS (*it
)),
3191 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3192 /* Ignore the special cased nil value always present at EOB since
3193 no amount of fontifying will be able to change it. */
3194 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3196 int count
= SPECPDL_INDEX ();
3198 struct buffer
*obuf
= current_buffer
;
3199 int begv
= BEGV
, zv
= ZV
;
3200 int old_clip_changed
= current_buffer
->clip_changed
;
3202 val
= Vfontification_functions
;
3203 specbind (Qfontification_functions
, Qnil
);
3205 xassert (it
->end_charpos
== ZV
);
3207 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3208 safe_call1 (val
, pos
);
3211 Lisp_Object fns
, fn
;
3212 struct gcpro gcpro1
, gcpro2
;
3217 for (; CONSP (val
); val
= XCDR (val
))
3223 /* A value of t indicates this hook has a local
3224 binding; it means to run the global binding too.
3225 In a global value, t should not occur. If it
3226 does, we must ignore it to avoid an endless
3228 for (fns
= Fdefault_value (Qfontification_functions
);
3234 safe_call1 (fn
, pos
);
3238 safe_call1 (fn
, pos
);
3244 unbind_to (count
, Qnil
);
3246 /* Fontification functions routinely call `save-restriction'.
3247 Normally, this tags clip_changed, which can confuse redisplay
3248 (see discussion in Bug#6671). Since we don't perform any
3249 special handling of fontification changes in the case where
3250 `save-restriction' isn't called, there's no point doing so in
3251 this case either. So, if the buffer's restrictions are
3252 actually left unchanged, reset clip_changed. */
3253 if (obuf
== current_buffer
)
3255 if (begv
== BEGV
&& zv
== ZV
)
3256 current_buffer
->clip_changed
= old_clip_changed
;
3258 /* There isn't much we can reasonably do to protect against
3259 misbehaving fontification, but here's a fig leaf. */
3260 else if (!NILP (BVAR (obuf
, name
)))
3261 set_buffer_internal_1 (obuf
);
3263 /* The fontification code may have added/removed text.
3264 It could do even a lot worse, but let's at least protect against
3265 the most obvious case where only the text past `pos' gets changed',
3266 as is/was done in grep.el where some escapes sequences are turned
3267 into face properties (bug#7876). */
3268 it
->end_charpos
= ZV
;
3270 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3271 something. This avoids an endless loop if they failed to
3272 fontify the text for which reason ever. */
3273 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3274 handled
= HANDLED_RECOMPUTE_PROPS
;
3282 /***********************************************************************
3284 ***********************************************************************/
3286 /* Set up iterator IT from face properties at its current position.
3287 Called from handle_stop. */
3289 static enum prop_handled
3290 handle_face_prop (struct it
*it
)
3293 EMACS_INT next_stop
;
3295 if (!STRINGP (it
->string
))
3298 = face_at_buffer_position (it
->w
,
3300 it
->region_beg_charpos
,
3301 it
->region_end_charpos
,
3304 + TEXT_PROP_DISTANCE_LIMIT
),
3305 0, it
->base_face_id
);
3307 /* Is this a start of a run of characters with box face?
3308 Caveat: this can be called for a freshly initialized
3309 iterator; face_id is -1 in this case. We know that the new
3310 face will not change until limit, i.e. if the new face has a
3311 box, all characters up to limit will have one. But, as
3312 usual, we don't know whether limit is really the end. */
3313 if (new_face_id
!= it
->face_id
)
3315 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3317 /* If new face has a box but old face has not, this is
3318 the start of a run of characters with box, i.e. it has
3319 a shadow on the left side. The value of face_id of the
3320 iterator will be -1 if this is the initial call that gets
3321 the face. In this case, we have to look in front of IT's
3322 position and see whether there is a face != new_face_id. */
3323 it
->start_of_box_run_p
3324 = (new_face
->box
!= FACE_NO_BOX
3325 && (it
->face_id
>= 0
3326 || IT_CHARPOS (*it
) == BEG
3327 || new_face_id
!= face_before_it_pos (it
)));
3328 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3336 Lisp_Object from_overlay
3337 = (it
->current
.overlay_string_index
>= 0
3338 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3341 /* See if we got to this string directly or indirectly from
3342 an overlay property. That includes the before-string or
3343 after-string of an overlay, strings in display properties
3344 provided by an overlay, their text properties, etc.
3346 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3347 if (! NILP (from_overlay
))
3348 for (i
= it
->sp
- 1; i
>= 0; i
--)
3350 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3352 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3353 else if (! NILP (it
->stack
[i
].from_overlay
))
3354 from_overlay
= it
->stack
[i
].from_overlay
;
3356 if (!NILP (from_overlay
))
3360 if (! NILP (from_overlay
))
3362 bufpos
= IT_CHARPOS (*it
);
3363 /* For a string from an overlay, the base face depends
3364 only on text properties and ignores overlays. */
3366 = face_for_overlay_string (it
->w
,
3368 it
->region_beg_charpos
,
3369 it
->region_end_charpos
,
3372 + TEXT_PROP_DISTANCE_LIMIT
),
3380 /* For strings from a `display' property, use the face at
3381 IT's current buffer position as the base face to merge
3382 with, so that overlay strings appear in the same face as
3383 surrounding text, unless they specify their own
3385 base_face_id
= underlying_face_id (it
);
3388 new_face_id
= face_at_string_position (it
->w
,
3390 IT_STRING_CHARPOS (*it
),
3392 it
->region_beg_charpos
,
3393 it
->region_end_charpos
,
3397 /* Is this a start of a run of characters with box? Caveat:
3398 this can be called for a freshly allocated iterator; face_id
3399 is -1 is this case. We know that the new face will not
3400 change until the next check pos, i.e. if the new face has a
3401 box, all characters up to that position will have a
3402 box. But, as usual, we don't know whether that position
3403 is really the end. */
3404 if (new_face_id
!= it
->face_id
)
3406 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3407 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3409 /* If new face has a box but old face hasn't, this is the
3410 start of a run of characters with box, i.e. it has a
3411 shadow on the left side. */
3412 it
->start_of_box_run_p
3413 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3414 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3418 it
->face_id
= new_face_id
;
3419 return HANDLED_NORMALLY
;
3423 /* Return the ID of the face ``underlying'' IT's current position,
3424 which is in a string. If the iterator is associated with a
3425 buffer, return the face at IT's current buffer position.
3426 Otherwise, use the iterator's base_face_id. */
3429 underlying_face_id (struct it
*it
)
3431 int face_id
= it
->base_face_id
, i
;
3433 xassert (STRINGP (it
->string
));
3435 for (i
= it
->sp
- 1; i
>= 0; --i
)
3436 if (NILP (it
->stack
[i
].string
))
3437 face_id
= it
->stack
[i
].face_id
;
3443 /* Compute the face one character before or after the current position
3444 of IT. BEFORE_P non-zero means get the face in front of IT's
3445 position. Value is the id of the face. */
3448 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3451 EMACS_INT next_check_charpos
;
3452 struct text_pos pos
;
3454 xassert (it
->s
== NULL
);
3456 if (STRINGP (it
->string
))
3461 /* No face change past the end of the string (for the case
3462 we are padding with spaces). No face change before the
3464 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3465 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3468 /* Set pos to the position before or after IT's current position. */
3470 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3472 /* For composition, we must check the character after the
3474 pos
= (it
->what
== IT_COMPOSITION
3475 ? string_pos (IT_STRING_CHARPOS (*it
)
3476 + it
->cmp_it
.nchars
, it
->string
)
3477 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3479 if (it
->current
.overlay_string_index
>= 0)
3480 bufpos
= IT_CHARPOS (*it
);
3484 base_face_id
= underlying_face_id (it
);
3486 /* Get the face for ASCII, or unibyte. */
3487 face_id
= face_at_string_position (it
->w
,
3491 it
->region_beg_charpos
,
3492 it
->region_end_charpos
,
3493 &next_check_charpos
,
3496 /* Correct the face for charsets different from ASCII. Do it
3497 for the multibyte case only. The face returned above is
3498 suitable for unibyte text if IT->string is unibyte. */
3499 if (STRING_MULTIBYTE (it
->string
))
3501 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3503 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3505 c
= string_char_and_length (p
, &len
);
3506 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3511 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3512 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3515 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3516 pos
= it
->current
.pos
;
3519 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3522 if (it
->what
== IT_COMPOSITION
)
3523 /* For composition, we must check the position after the
3525 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3527 INC_TEXT_POS (pos
, it
->multibyte_p
);
3530 /* Determine face for CHARSET_ASCII, or unibyte. */
3531 face_id
= face_at_buffer_position (it
->w
,
3533 it
->region_beg_charpos
,
3534 it
->region_end_charpos
,
3535 &next_check_charpos
,
3538 /* Correct the face for charsets different from ASCII. Do it
3539 for the multibyte case only. The face returned above is
3540 suitable for unibyte text if current_buffer is unibyte. */
3541 if (it
->multibyte_p
)
3543 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3544 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3545 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3554 /***********************************************************************
3556 ***********************************************************************/
3558 /* Set up iterator IT from invisible properties at its current
3559 position. Called from handle_stop. */
3561 static enum prop_handled
3562 handle_invisible_prop (struct it
*it
)
3564 enum prop_handled handled
= HANDLED_NORMALLY
;
3566 if (STRINGP (it
->string
))
3568 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3570 /* Get the value of the invisible text property at the
3571 current position. Value will be nil if there is no such
3573 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3574 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3577 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3579 handled
= HANDLED_RECOMPUTE_PROPS
;
3581 /* Get the position at which the next change of the
3582 invisible text property can be found in IT->string.
3583 Value will be nil if the property value is the same for
3584 all the rest of IT->string. */
3585 XSETINT (limit
, SCHARS (it
->string
));
3586 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3589 /* Text at current position is invisible. The next
3590 change in the property is at position end_charpos.
3591 Move IT's current position to that position. */
3592 if (INTEGERP (end_charpos
)
3593 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3595 struct text_pos old
;
3596 old
= it
->current
.string_pos
;
3597 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3598 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3602 /* The rest of the string is invisible. If this is an
3603 overlay string, proceed with the next overlay string
3604 or whatever comes and return a character from there. */
3605 if (it
->current
.overlay_string_index
>= 0)
3607 next_overlay_string (it
);
3608 /* Don't check for overlay strings when we just
3609 finished processing them. */
3610 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3614 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3615 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3623 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3624 Lisp_Object pos
, prop
, overlay
;
3626 /* First of all, is there invisible text at this position? */
3627 tem
= start_charpos
= IT_CHARPOS (*it
);
3628 pos
= make_number (tem
);
3629 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3631 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3633 /* If we are on invisible text, skip over it. */
3634 if (invis_p
&& start_charpos
< it
->end_charpos
)
3636 /* Record whether we have to display an ellipsis for the
3638 int display_ellipsis_p
= invis_p
== 2;
3640 handled
= HANDLED_RECOMPUTE_PROPS
;
3642 /* Loop skipping over invisible text. The loop is left at
3643 ZV or with IT on the first char being visible again. */
3646 /* Try to skip some invisible text. Return value is the
3647 position reached which can be equal to where we start
3648 if there is nothing invisible there. This skips both
3649 over invisible text properties and overlays with
3650 invisible property. */
3651 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3653 /* If we skipped nothing at all we weren't at invisible
3654 text in the first place. If everything to the end of
3655 the buffer was skipped, end the loop. */
3656 if (newpos
== tem
|| newpos
>= ZV
)
3660 /* We skipped some characters but not necessarily
3661 all there are. Check if we ended up on visible
3662 text. Fget_char_property returns the property of
3663 the char before the given position, i.e. if we
3664 get invis_p = 0, this means that the char at
3665 newpos is visible. */
3666 pos
= make_number (newpos
);
3667 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3668 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3671 /* If we ended up on invisible text, proceed to
3672 skip starting with next_stop. */
3676 /* If there are adjacent invisible texts, don't lose the
3677 second one's ellipsis. */
3679 display_ellipsis_p
= 1;
3683 /* The position newpos is now either ZV or on visible text. */
3684 if (it
->bidi_p
&& newpos
< ZV
)
3686 /* With bidi iteration, the region of invisible text
3687 could start and/or end in the middle of a non-base
3688 embedding level. Therefore, we need to skip
3689 invisible text using the bidi iterator, starting at
3690 IT's current position, until we find ourselves
3691 outside the invisible text. Skipping invisible text
3692 _after_ bidi iteration avoids affecting the visual
3693 order of the displayed text when invisible properties
3694 are added or removed. */
3695 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3697 /* If we were `reseat'ed to a new paragraph,
3698 determine the paragraph base direction. We need
3699 to do it now because next_element_from_buffer may
3700 not have a chance to do it, if we are going to
3701 skip any text at the beginning, which resets the
3703 bidi_paragraph_init (it
->paragraph_embedding
,
3708 bidi_move_to_visually_next (&it
->bidi_it
);
3710 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3711 && it
->bidi_it
.charpos
< newpos
);
3712 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3713 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3714 /* If we overstepped NEWPOS, record its position in the
3715 iterator, so that we skip invisible text if later the
3716 bidi iteration lands us in the invisible region
3718 if (IT_CHARPOS (*it
) >= newpos
)
3719 it
->prev_stop
= newpos
;
3723 IT_CHARPOS (*it
) = newpos
;
3724 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3727 /* If there are before-strings at the start of invisible
3728 text, and the text is invisible because of a text
3729 property, arrange to show before-strings because 20.x did
3730 it that way. (If the text is invisible because of an
3731 overlay property instead of a text property, this is
3732 already handled in the overlay code.) */
3734 && get_overlay_strings (it
, it
->stop_charpos
))
3736 handled
= HANDLED_RECOMPUTE_PROPS
;
3737 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3739 else if (display_ellipsis_p
)
3741 /* Make sure that the glyphs of the ellipsis will get
3742 correct `charpos' values. If we would not update
3743 it->position here, the glyphs would belong to the
3744 last visible character _before_ the invisible
3745 text, which confuses `set_cursor_from_row'.
3747 We use the last invisible position instead of the
3748 first because this way the cursor is always drawn on
3749 the first "." of the ellipsis, whenever PT is inside
3750 the invisible text. Otherwise the cursor would be
3751 placed _after_ the ellipsis when the point is after the
3752 first invisible character. */
3753 if (!STRINGP (it
->object
))
3755 it
->position
.charpos
= newpos
- 1;
3756 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3759 /* Let the ellipsis display before
3760 considering any properties of the following char.
3761 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3762 handled
= HANDLED_RETURN
;
3771 /* Make iterator IT return `...' next.
3772 Replaces LEN characters from buffer. */
3775 setup_for_ellipsis (struct it
*it
, int len
)
3777 /* Use the display table definition for `...'. Invalid glyphs
3778 will be handled by the method returning elements from dpvec. */
3779 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3781 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3782 it
->dpvec
= v
->contents
;
3783 it
->dpend
= v
->contents
+ v
->header
.size
;
3787 /* Default `...'. */
3788 it
->dpvec
= default_invis_vector
;
3789 it
->dpend
= default_invis_vector
+ 3;
3792 it
->dpvec_char_len
= len
;
3793 it
->current
.dpvec_index
= 0;
3794 it
->dpvec_face_id
= -1;
3796 /* Remember the current face id in case glyphs specify faces.
3797 IT's face is restored in set_iterator_to_next.
3798 saved_face_id was set to preceding char's face in handle_stop. */
3799 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3800 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3802 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3808 /***********************************************************************
3810 ***********************************************************************/
3812 /* Set up iterator IT from `display' property at its current position.
3813 Called from handle_stop.
3814 We return HANDLED_RETURN if some part of the display property
3815 overrides the display of the buffer text itself.
3816 Otherwise we return HANDLED_NORMALLY. */
3818 static enum prop_handled
3819 handle_display_prop (struct it
*it
)
3821 Lisp_Object propval
, object
, overlay
;
3822 struct text_pos
*position
;
3824 /* Nonzero if some property replaces the display of the text itself. */
3825 int display_replaced_p
= 0;
3827 if (STRINGP (it
->string
))
3829 object
= it
->string
;
3830 position
= &it
->current
.string_pos
;
3831 bufpos
= CHARPOS (it
->current
.pos
);
3835 XSETWINDOW (object
, it
->w
);
3836 position
= &it
->current
.pos
;
3837 bufpos
= CHARPOS (*position
);
3840 /* Reset those iterator values set from display property values. */
3841 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3842 it
->space_width
= Qnil
;
3843 it
->font_height
= Qnil
;
3846 /* We don't support recursive `display' properties, i.e. string
3847 values that have a string `display' property, that have a string
3848 `display' property etc. */
3849 if (!it
->string_from_display_prop_p
)
3850 it
->area
= TEXT_AREA
;
3852 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
3853 Qdisplay
, object
, &overlay
);
3855 return HANDLED_NORMALLY
;
3856 /* Now OVERLAY is the overlay that gave us this property, or nil
3857 if it was a text property. */
3859 if (!STRINGP (it
->string
))
3860 object
= it
->w
->buffer
;
3862 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
3864 FRAME_WINDOW_P (it
->f
));
3866 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3869 /* Subroutine of handle_display_prop. Returns non-zero if the display
3870 specification in SPEC is a replacing specification, i.e. it would
3871 replace the text covered by `display' property with something else,
3872 such as an image or a display string.
3874 See handle_single_display_spec for documentation of arguments.
3875 frame_window_p is non-zero if the window being redisplayed is on a
3876 GUI frame; this argument is used only if IT is NULL, see below.
3878 IT can be NULL, if this is called by the bidi reordering code
3879 through compute_display_string_pos, which see. In that case, this
3880 function only examines SPEC, but does not otherwise "handle" it, in
3881 the sense that it doesn't set up members of IT from the display
3884 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3885 Lisp_Object overlay
, struct text_pos
*position
,
3886 EMACS_INT bufpos
, int frame_window_p
)
3888 int replacing_p
= 0;
3891 /* Simple specerties. */
3892 && !EQ (XCAR (spec
), Qimage
)
3893 && !EQ (XCAR (spec
), Qspace
)
3894 && !EQ (XCAR (spec
), Qwhen
)
3895 && !EQ (XCAR (spec
), Qslice
)
3896 && !EQ (XCAR (spec
), Qspace_width
)
3897 && !EQ (XCAR (spec
), Qheight
)
3898 && !EQ (XCAR (spec
), Qraise
)
3899 /* Marginal area specifications. */
3900 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
3901 && !EQ (XCAR (spec
), Qleft_fringe
)
3902 && !EQ (XCAR (spec
), Qright_fringe
)
3903 && !NILP (XCAR (spec
)))
3905 for (; CONSP (spec
); spec
= XCDR (spec
))
3907 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
3908 position
, bufpos
, replacing_p
,
3912 /* If some text in a string is replaced, `position' no
3913 longer points to the position of `object'. */
3914 if (!it
|| STRINGP (object
))
3919 else if (VECTORP (spec
))
3922 for (i
= 0; i
< ASIZE (spec
); ++i
)
3923 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
3924 position
, bufpos
, replacing_p
,
3928 /* If some text in a string is replaced, `position' no
3929 longer points to the position of `object'. */
3930 if (!it
|| STRINGP (object
))
3936 if (handle_single_display_spec (it
, spec
, object
, overlay
,
3937 position
, bufpos
, 0, frame_window_p
))
3944 /* Value is the position of the end of the `display' property starting
3945 at START_POS in OBJECT. */
3947 static struct text_pos
3948 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3951 struct text_pos end_pos
;
3953 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3954 Qdisplay
, object
, Qnil
);
3955 CHARPOS (end_pos
) = XFASTINT (end
);
3956 if (STRINGP (object
))
3957 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3959 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3965 /* Set up IT from a single `display' property specification SPEC. OBJECT
3966 is the object in which the `display' property was found. *POSITION
3967 is the position in OBJECT at which the `display' property was found.
3968 BUFPOS is the buffer position of OBJECT (different from POSITION if
3969 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
3970 previously saw a display specification which already replaced text
3971 display with something else, for example an image; we ignore such
3972 properties after the first one has been processed.
3974 OVERLAY is the overlay this `display' property came from,
3975 or nil if it was a text property.
3977 If SPEC is a `space' or `image' specification, and in some other
3978 cases too, set *POSITION to the position where the `display'
3981 If IT is NULL, only examine the property specification in SPEC, but
3982 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
3983 is intended to be displayed in a window on a GUI frame.
3985 Value is non-zero if something was found which replaces the display
3986 of buffer or string text. */
3989 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3990 Lisp_Object overlay
, struct text_pos
*position
,
3991 EMACS_INT bufpos
, int display_replaced_p
,
3995 Lisp_Object location
, value
;
3996 struct text_pos start_pos
= *position
;
3999 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4000 If the result is non-nil, use VALUE instead of SPEC. */
4002 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4011 if (!NILP (form
) && !EQ (form
, Qt
))
4013 int count
= SPECPDL_INDEX ();
4014 struct gcpro gcpro1
;
4016 /* Bind `object' to the object having the `display' property, a
4017 buffer or string. Bind `position' to the position in the
4018 object where the property was found, and `buffer-position'
4019 to the current position in the buffer. */
4022 XSETBUFFER (object
, current_buffer
);
4023 specbind (Qobject
, object
);
4024 specbind (Qposition
, make_number (CHARPOS (*position
)));
4025 specbind (Qbuffer_position
, make_number (bufpos
));
4027 form
= safe_eval (form
);
4029 unbind_to (count
, Qnil
);
4035 /* Handle `(height HEIGHT)' specifications. */
4037 && EQ (XCAR (spec
), Qheight
)
4038 && CONSP (XCDR (spec
)))
4042 if (!FRAME_WINDOW_P (it
->f
))
4045 it
->font_height
= XCAR (XCDR (spec
));
4046 if (!NILP (it
->font_height
))
4048 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4049 int new_height
= -1;
4051 if (CONSP (it
->font_height
)
4052 && (EQ (XCAR (it
->font_height
), Qplus
)
4053 || EQ (XCAR (it
->font_height
), Qminus
))
4054 && CONSP (XCDR (it
->font_height
))
4055 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4057 /* `(+ N)' or `(- N)' where N is an integer. */
4058 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4059 if (EQ (XCAR (it
->font_height
), Qplus
))
4061 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4063 else if (FUNCTIONP (it
->font_height
))
4065 /* Call function with current height as argument.
4066 Value is the new height. */
4068 height
= safe_call1 (it
->font_height
,
4069 face
->lface
[LFACE_HEIGHT_INDEX
]);
4070 if (NUMBERP (height
))
4071 new_height
= XFLOATINT (height
);
4073 else if (NUMBERP (it
->font_height
))
4075 /* Value is a multiple of the canonical char height. */
4078 f
= FACE_FROM_ID (it
->f
,
4079 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4080 new_height
= (XFLOATINT (it
->font_height
)
4081 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4085 /* Evaluate IT->font_height with `height' bound to the
4086 current specified height to get the new height. */
4087 int count
= SPECPDL_INDEX ();
4089 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4090 value
= safe_eval (it
->font_height
);
4091 unbind_to (count
, Qnil
);
4093 if (NUMBERP (value
))
4094 new_height
= XFLOATINT (value
);
4098 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4105 /* Handle `(space-width WIDTH)'. */
4107 && EQ (XCAR (spec
), Qspace_width
)
4108 && CONSP (XCDR (spec
)))
4112 if (!FRAME_WINDOW_P (it
->f
))
4115 value
= XCAR (XCDR (spec
));
4116 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4117 it
->space_width
= value
;
4123 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4125 && EQ (XCAR (spec
), Qslice
))
4131 if (!FRAME_WINDOW_P (it
->f
))
4134 if (tem
= XCDR (spec
), CONSP (tem
))
4136 it
->slice
.x
= XCAR (tem
);
4137 if (tem
= XCDR (tem
), CONSP (tem
))
4139 it
->slice
.y
= XCAR (tem
);
4140 if (tem
= XCDR (tem
), CONSP (tem
))
4142 it
->slice
.width
= XCAR (tem
);
4143 if (tem
= XCDR (tem
), CONSP (tem
))
4144 it
->slice
.height
= XCAR (tem
);
4153 /* Handle `(raise FACTOR)'. */
4155 && EQ (XCAR (spec
), Qraise
)
4156 && CONSP (XCDR (spec
)))
4160 if (!FRAME_WINDOW_P (it
->f
))
4163 #ifdef HAVE_WINDOW_SYSTEM
4164 value
= XCAR (XCDR (spec
));
4165 if (NUMBERP (value
))
4167 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4168 it
->voffset
= - (XFLOATINT (value
)
4169 * (FONT_HEIGHT (face
->font
)));
4171 #endif /* HAVE_WINDOW_SYSTEM */
4177 /* Don't handle the other kinds of display specifications
4178 inside a string that we got from a `display' property. */
4179 if (it
&& it
->string_from_display_prop_p
)
4182 /* Characters having this form of property are not displayed, so
4183 we have to find the end of the property. */
4186 start_pos
= *position
;
4187 *position
= display_prop_end (it
, object
, start_pos
);
4191 /* Stop the scan at that end position--we assume that all
4192 text properties change there. */
4194 it
->stop_charpos
= position
->charpos
;
4196 /* Handle `(left-fringe BITMAP [FACE])'
4197 and `(right-fringe BITMAP [FACE])'. */
4199 && (EQ (XCAR (spec
), Qleft_fringe
)
4200 || EQ (XCAR (spec
), Qright_fringe
))
4201 && CONSP (XCDR (spec
)))
4207 if (!FRAME_WINDOW_P (it
->f
))
4208 /* If we return here, POSITION has been advanced
4209 across the text with this property. */
4212 else if (!frame_window_p
)
4215 #ifdef HAVE_WINDOW_SYSTEM
4216 value
= XCAR (XCDR (spec
));
4217 if (!SYMBOLP (value
)
4218 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4219 /* If we return here, POSITION has been advanced
4220 across the text with this property. */
4225 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4227 if (CONSP (XCDR (XCDR (spec
))))
4229 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4230 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4236 /* Save current settings of IT so that we can restore them
4237 when we are finished with the glyph property value. */
4238 push_it (it
, position
);
4240 it
->area
= TEXT_AREA
;
4241 it
->what
= IT_IMAGE
;
4242 it
->image_id
= -1; /* no image */
4243 it
->position
= start_pos
;
4244 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4245 it
->method
= GET_FROM_IMAGE
;
4246 it
->from_overlay
= Qnil
;
4247 it
->face_id
= face_id
;
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 *position
= start_pos
;
4254 if (EQ (XCAR (spec
), Qleft_fringe
))
4256 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4257 it
->left_user_fringe_face_id
= face_id
;
4261 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4262 it
->right_user_fringe_face_id
= face_id
;
4265 #endif /* HAVE_WINDOW_SYSTEM */
4269 /* Prepare to handle `((margin left-margin) ...)',
4270 `((margin right-margin) ...)' and `((margin nil) ...)'
4271 prefixes for display specifications. */
4272 location
= Qunbound
;
4273 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4277 value
= XCDR (spec
);
4279 value
= XCAR (value
);
4282 if (EQ (XCAR (tem
), Qmargin
)
4283 && (tem
= XCDR (tem
),
4284 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4286 || EQ (tem
, Qleft_margin
)
4287 || EQ (tem
, Qright_margin
))))
4291 if (EQ (location
, Qunbound
))
4297 /* After this point, VALUE is the property after any
4298 margin prefix has been stripped. It must be a string,
4299 an image specification, or `(space ...)'.
4301 LOCATION specifies where to display: `left-margin',
4302 `right-margin' or nil. */
4304 valid_p
= (STRINGP (value
)
4305 #ifdef HAVE_WINDOW_SYSTEM
4306 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4307 && valid_image_p (value
))
4308 #endif /* not HAVE_WINDOW_SYSTEM */
4309 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4311 if (valid_p
&& !display_replaced_p
)
4316 /* Save current settings of IT so that we can restore them
4317 when we are finished with the glyph property value. */
4318 push_it (it
, position
);
4319 it
->from_overlay
= overlay
;
4321 if (NILP (location
))
4322 it
->area
= TEXT_AREA
;
4323 else if (EQ (location
, Qleft_margin
))
4324 it
->area
= LEFT_MARGIN_AREA
;
4326 it
->area
= RIGHT_MARGIN_AREA
;
4328 if (STRINGP (value
))
4331 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4332 it
->current
.overlay_string_index
= -1;
4333 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4334 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4335 it
->method
= GET_FROM_STRING
;
4336 it
->stop_charpos
= 0;
4337 it
->string_from_display_prop_p
= 1;
4338 /* Say that we haven't consumed the characters with
4339 `display' property yet. The call to pop_it in
4340 set_iterator_to_next will clean this up. */
4341 if (BUFFERP (object
))
4342 *position
= start_pos
;
4344 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4346 it
->method
= GET_FROM_STRETCH
;
4348 *position
= it
->position
= start_pos
;
4350 #ifdef HAVE_WINDOW_SYSTEM
4353 it
->what
= IT_IMAGE
;
4354 it
->image_id
= lookup_image (it
->f
, value
);
4355 it
->position
= start_pos
;
4356 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4357 it
->method
= GET_FROM_IMAGE
;
4359 /* Say that we haven't consumed the characters with
4360 `display' property yet. The call to pop_it in
4361 set_iterator_to_next will clean this up. */
4362 *position
= start_pos
;
4364 #endif /* HAVE_WINDOW_SYSTEM */
4369 /* Invalid property or property not supported. Restore
4370 POSITION to what it was before. */
4371 *position
= start_pos
;
4375 /* Check if PROP is a display property value whose text should be
4376 treated as intangible. OVERLAY is the overlay from which PROP
4377 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4378 specify the buffer position covered by PROP. */
4381 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4382 EMACS_INT charpos
, EMACS_INT bytepos
)
4384 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4385 struct text_pos position
;
4387 SET_TEXT_POS (position
, charpos
, bytepos
);
4388 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4389 &position
, charpos
, frame_window_p
);
4393 /* Return 1 if PROP is a display sub-property value containing STRING.
4395 Implementation note: this and the following function are really
4396 special cases of handle_display_spec and
4397 handle_single_display_spec, and should ideally use the same code.
4398 Until they do, these two pairs must be consistent and must be
4399 modified in sync. */
4402 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4404 if (EQ (string
, prop
))
4407 /* Skip over `when FORM'. */
4408 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4413 /* Actually, the condition following `when' should be eval'ed,
4414 like handle_single_display_spec does, and we should return
4415 zero if it evaluates to nil. However, this function is
4416 called only when the buffer was already displayed and some
4417 glyph in the glyph matrix was found to come from a display
4418 string. Therefore, the condition was already evaluated, and
4419 the result was non-nil, otherwise the display string wouldn't
4420 have been displayed and we would have never been called for
4421 this property. Thus, we can skip the evaluation and assume
4422 its result is non-nil. */
4427 /* Skip over `margin LOCATION'. */
4428 if (EQ (XCAR (prop
), Qmargin
))
4439 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4443 /* Return 1 if STRING appears in the `display' property PROP. */
4446 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4449 && !EQ (XCAR (prop
), Qwhen
)
4450 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4452 /* A list of sub-properties. */
4453 while (CONSP (prop
))
4455 if (single_display_spec_string_p (XCAR (prop
), string
))
4460 else if (VECTORP (prop
))
4462 /* A vector of sub-properties. */
4464 for (i
= 0; i
< ASIZE (prop
); ++i
)
4465 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4469 return single_display_spec_string_p (prop
, string
);
4474 /* Look for STRING in overlays and text properties in the current
4475 buffer, between character positions FROM and TO (excluding TO).
4476 BACK_P non-zero means look back (in this case, TO is supposed to be
4478 Value is the first character position where STRING was found, or
4479 zero if it wasn't found before hitting TO.
4481 This function may only use code that doesn't eval because it is
4482 called asynchronously from note_mouse_highlight. */
4485 string_buffer_position_lim (Lisp_Object string
,
4486 EMACS_INT from
, EMACS_INT to
, int back_p
)
4488 Lisp_Object limit
, prop
, pos
;
4491 pos
= make_number (from
);
4493 if (!back_p
) /* looking forward */
4495 limit
= make_number (min (to
, ZV
));
4496 while (!found
&& !EQ (pos
, limit
))
4498 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4499 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4502 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4506 else /* looking back */
4508 limit
= make_number (max (to
, BEGV
));
4509 while (!found
&& !EQ (pos
, limit
))
4511 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4512 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4515 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4520 return found
? XINT (pos
) : 0;
4523 /* Determine which buffer position in current buffer STRING comes from.
4524 AROUND_CHARPOS is an approximate position where it could come from.
4525 Value is the buffer position or 0 if it couldn't be determined.
4527 This function is necessary because we don't record buffer positions
4528 in glyphs generated from strings (to keep struct glyph small).
4529 This function may only use code that doesn't eval because it is
4530 called asynchronously from note_mouse_highlight. */
4533 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4535 const int MAX_DISTANCE
= 1000;
4536 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4537 around_charpos
+ MAX_DISTANCE
,
4541 found
= string_buffer_position_lim (string
, around_charpos
,
4542 around_charpos
- MAX_DISTANCE
, 1);
4548 /***********************************************************************
4549 `composition' property
4550 ***********************************************************************/
4552 /* Set up iterator IT from `composition' property at its current
4553 position. Called from handle_stop. */
4555 static enum prop_handled
4556 handle_composition_prop (struct it
*it
)
4558 Lisp_Object prop
, string
;
4559 EMACS_INT pos
, pos_byte
, start
, end
;
4561 if (STRINGP (it
->string
))
4565 pos
= IT_STRING_CHARPOS (*it
);
4566 pos_byte
= IT_STRING_BYTEPOS (*it
);
4567 string
= it
->string
;
4568 s
= SDATA (string
) + pos_byte
;
4569 it
->c
= STRING_CHAR (s
);
4573 pos
= IT_CHARPOS (*it
);
4574 pos_byte
= IT_BYTEPOS (*it
);
4576 it
->c
= FETCH_CHAR (pos_byte
);
4579 /* If there's a valid composition and point is not inside of the
4580 composition (in the case that the composition is from the current
4581 buffer), draw a glyph composed from the composition components. */
4582 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4583 && COMPOSITION_VALID_P (start
, end
, prop
)
4584 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4587 /* As we can't handle this situation (perhaps font-lock added
4588 a new composition), we just return here hoping that next
4589 redisplay will detect this composition much earlier. */
4590 return HANDLED_NORMALLY
;
4593 if (STRINGP (it
->string
))
4594 pos_byte
= string_char_to_byte (it
->string
, start
);
4596 pos_byte
= CHAR_TO_BYTE (start
);
4598 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4601 if (it
->cmp_it
.id
>= 0)
4604 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4605 it
->cmp_it
.nglyphs
= -1;
4609 return HANDLED_NORMALLY
;
4614 /***********************************************************************
4616 ***********************************************************************/
4618 /* The following structure is used to record overlay strings for
4619 later sorting in load_overlay_strings. */
4621 struct overlay_entry
4623 Lisp_Object overlay
;
4630 /* Set up iterator IT from overlay strings at its current position.
4631 Called from handle_stop. */
4633 static enum prop_handled
4634 handle_overlay_change (struct it
*it
)
4636 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4637 return HANDLED_RECOMPUTE_PROPS
;
4639 return HANDLED_NORMALLY
;
4643 /* Set up the next overlay string for delivery by IT, if there is an
4644 overlay string to deliver. Called by set_iterator_to_next when the
4645 end of the current overlay string is reached. If there are more
4646 overlay strings to display, IT->string and
4647 IT->current.overlay_string_index are set appropriately here.
4648 Otherwise IT->string is set to nil. */
4651 next_overlay_string (struct it
*it
)
4653 ++it
->current
.overlay_string_index
;
4654 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4656 /* No more overlay strings. Restore IT's settings to what
4657 they were before overlay strings were processed, and
4658 continue to deliver from current_buffer. */
4660 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4663 || (NILP (it
->string
)
4664 && it
->method
== GET_FROM_BUFFER
4665 && it
->stop_charpos
>= BEGV
4666 && it
->stop_charpos
<= it
->end_charpos
));
4667 it
->current
.overlay_string_index
= -1;
4668 it
->n_overlay_strings
= 0;
4669 it
->overlay_strings_charpos
= -1;
4671 /* If we're at the end of the buffer, record that we have
4672 processed the overlay strings there already, so that
4673 next_element_from_buffer doesn't try it again. */
4674 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4675 it
->overlay_strings_at_end_processed_p
= 1;
4679 /* There are more overlay strings to process. If
4680 IT->current.overlay_string_index has advanced to a position
4681 where we must load IT->overlay_strings with more strings, do
4682 it. We must load at the IT->overlay_strings_charpos where
4683 IT->n_overlay_strings was originally computed; when invisible
4684 text is present, this might not be IT_CHARPOS (Bug#7016). */
4685 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4687 if (it
->current
.overlay_string_index
&& i
== 0)
4688 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4690 /* Initialize IT to deliver display elements from the overlay
4692 it
->string
= it
->overlay_strings
[i
];
4693 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4694 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4695 it
->method
= GET_FROM_STRING
;
4696 it
->stop_charpos
= 0;
4697 if (it
->cmp_it
.stop_pos
>= 0)
4698 it
->cmp_it
.stop_pos
= 0;
4705 /* Compare two overlay_entry structures E1 and E2. Used as a
4706 comparison function for qsort in load_overlay_strings. Overlay
4707 strings for the same position are sorted so that
4709 1. All after-strings come in front of before-strings, except
4710 when they come from the same overlay.
4712 2. Within after-strings, strings are sorted so that overlay strings
4713 from overlays with higher priorities come first.
4715 2. Within before-strings, strings are sorted so that overlay
4716 strings from overlays with higher priorities come last.
4718 Value is analogous to strcmp. */
4722 compare_overlay_entries (const void *e1
, const void *e2
)
4724 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4725 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4728 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4730 /* Let after-strings appear in front of before-strings if
4731 they come from different overlays. */
4732 if (EQ (entry1
->overlay
, entry2
->overlay
))
4733 result
= entry1
->after_string_p
? 1 : -1;
4735 result
= entry1
->after_string_p
? -1 : 1;
4737 else if (entry1
->after_string_p
)
4738 /* After-strings sorted in order of decreasing priority. */
4739 result
= entry2
->priority
- entry1
->priority
;
4741 /* Before-strings sorted in order of increasing priority. */
4742 result
= entry1
->priority
- entry2
->priority
;
4748 /* Load the vector IT->overlay_strings with overlay strings from IT's
4749 current buffer position, or from CHARPOS if that is > 0. Set
4750 IT->n_overlays to the total number of overlay strings found.
4752 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4753 a time. On entry into load_overlay_strings,
4754 IT->current.overlay_string_index gives the number of overlay
4755 strings that have already been loaded by previous calls to this
4758 IT->add_overlay_start contains an additional overlay start
4759 position to consider for taking overlay strings from, if non-zero.
4760 This position comes into play when the overlay has an `invisible'
4761 property, and both before and after-strings. When we've skipped to
4762 the end of the overlay, because of its `invisible' property, we
4763 nevertheless want its before-string to appear.
4764 IT->add_overlay_start will contain the overlay start position
4767 Overlay strings are sorted so that after-string strings come in
4768 front of before-string strings. Within before and after-strings,
4769 strings are sorted by overlay priority. See also function
4770 compare_overlay_entries. */
4773 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4775 Lisp_Object overlay
, window
, str
, invisible
;
4776 struct Lisp_Overlay
*ov
;
4777 EMACS_INT start
, end
;
4779 int n
= 0, i
, j
, invis_p
;
4780 struct overlay_entry
*entries
4781 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4784 charpos
= IT_CHARPOS (*it
);
4786 /* Append the overlay string STRING of overlay OVERLAY to vector
4787 `entries' which has size `size' and currently contains `n'
4788 elements. AFTER_P non-zero means STRING is an after-string of
4790 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4793 Lisp_Object priority; \
4797 int new_size = 2 * size; \
4798 struct overlay_entry *old = entries; \
4800 (struct overlay_entry *) alloca (new_size \
4801 * sizeof *entries); \
4802 memcpy (entries, old, size * sizeof *entries); \
4806 entries[n].string = (STRING); \
4807 entries[n].overlay = (OVERLAY); \
4808 priority = Foverlay_get ((OVERLAY), Qpriority); \
4809 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4810 entries[n].after_string_p = (AFTER_P); \
4815 /* Process overlay before the overlay center. */
4816 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4818 XSETMISC (overlay
, ov
);
4819 xassert (OVERLAYP (overlay
));
4820 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4821 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4826 /* Skip this overlay if it doesn't start or end at IT's current
4828 if (end
!= charpos
&& start
!= charpos
)
4831 /* Skip this overlay if it doesn't apply to IT->w. */
4832 window
= Foverlay_get (overlay
, Qwindow
);
4833 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4836 /* If the text ``under'' the overlay is invisible, both before-
4837 and after-strings from this overlay are visible; start and
4838 end position are indistinguishable. */
4839 invisible
= Foverlay_get (overlay
, Qinvisible
);
4840 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4842 /* If overlay has a non-empty before-string, record it. */
4843 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4844 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4846 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4848 /* If overlay has a non-empty after-string, record it. */
4849 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4850 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4852 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4855 /* Process overlays after the overlay center. */
4856 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4858 XSETMISC (overlay
, ov
);
4859 xassert (OVERLAYP (overlay
));
4860 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4861 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4863 if (start
> charpos
)
4866 /* Skip this overlay if it doesn't start or end at IT's current
4868 if (end
!= charpos
&& start
!= charpos
)
4871 /* Skip this overlay if it doesn't apply to IT->w. */
4872 window
= Foverlay_get (overlay
, Qwindow
);
4873 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4876 /* If the text ``under'' the overlay is invisible, it has a zero
4877 dimension, and both before- and after-strings apply. */
4878 invisible
= Foverlay_get (overlay
, Qinvisible
);
4879 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4881 /* If overlay has a non-empty before-string, record it. */
4882 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4883 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4885 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4887 /* If overlay has a non-empty after-string, record it. */
4888 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4889 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4891 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4894 #undef RECORD_OVERLAY_STRING
4898 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4900 /* Record number of overlay strings, and where we computed it. */
4901 it
->n_overlay_strings
= n
;
4902 it
->overlay_strings_charpos
= charpos
;
4904 /* IT->current.overlay_string_index is the number of overlay strings
4905 that have already been consumed by IT. Copy some of the
4906 remaining overlay strings to IT->overlay_strings. */
4908 j
= it
->current
.overlay_string_index
;
4909 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4911 it
->overlay_strings
[i
] = entries
[j
].string
;
4912 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4919 /* Get the first chunk of overlay strings at IT's current buffer
4920 position, or at CHARPOS if that is > 0. Value is non-zero if at
4921 least one overlay string was found. */
4924 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4926 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4927 process. This fills IT->overlay_strings with strings, and sets
4928 IT->n_overlay_strings to the total number of strings to process.
4929 IT->pos.overlay_string_index has to be set temporarily to zero
4930 because load_overlay_strings needs this; it must be set to -1
4931 when no overlay strings are found because a zero value would
4932 indicate a position in the first overlay string. */
4933 it
->current
.overlay_string_index
= 0;
4934 load_overlay_strings (it
, charpos
);
4936 /* If we found overlay strings, set up IT to deliver display
4937 elements from the first one. Otherwise set up IT to deliver
4938 from current_buffer. */
4939 if (it
->n_overlay_strings
)
4941 /* Make sure we know settings in current_buffer, so that we can
4942 restore meaningful values when we're done with the overlay
4945 compute_stop_pos (it
);
4946 xassert (it
->face_id
>= 0);
4948 /* Save IT's settings. They are restored after all overlay
4949 strings have been processed. */
4950 xassert (!compute_stop_p
|| it
->sp
== 0);
4952 /* When called from handle_stop, there might be an empty display
4953 string loaded. In that case, don't bother saving it. */
4954 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4957 /* Set up IT to deliver display elements from the first overlay
4959 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4960 it
->string
= it
->overlay_strings
[0];
4961 it
->from_overlay
= Qnil
;
4962 it
->stop_charpos
= 0;
4963 xassert (STRINGP (it
->string
));
4964 it
->end_charpos
= SCHARS (it
->string
);
4965 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4966 it
->method
= GET_FROM_STRING
;
4970 it
->current
.overlay_string_index
= -1;
4975 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4978 it
->method
= GET_FROM_BUFFER
;
4980 (void) get_overlay_strings_1 (it
, charpos
, 1);
4984 /* Value is non-zero if we found at least one overlay string. */
4985 return STRINGP (it
->string
);
4990 /***********************************************************************
4991 Saving and restoring state
4992 ***********************************************************************/
4994 /* Save current settings of IT on IT->stack. Called, for example,
4995 before setting up IT for an overlay string, to be able to restore
4996 IT's settings to what they were after the overlay string has been
4997 processed. If POSITION is non-NULL, it is the position to save on
4998 the stack instead of IT->position. */
5001 push_it (struct it
*it
, struct text_pos
*position
)
5003 struct iterator_stack_entry
*p
;
5005 xassert (it
->sp
< IT_STACK_SIZE
);
5006 p
= it
->stack
+ it
->sp
;
5008 p
->stop_charpos
= it
->stop_charpos
;
5009 p
->prev_stop
= it
->prev_stop
;
5010 p
->base_level_stop
= it
->base_level_stop
;
5011 p
->cmp_it
= it
->cmp_it
;
5012 xassert (it
->face_id
>= 0);
5013 p
->face_id
= it
->face_id
;
5014 p
->string
= it
->string
;
5015 p
->method
= it
->method
;
5016 p
->from_overlay
= it
->from_overlay
;
5019 case GET_FROM_IMAGE
:
5020 p
->u
.image
.object
= it
->object
;
5021 p
->u
.image
.image_id
= it
->image_id
;
5022 p
->u
.image
.slice
= it
->slice
;
5024 case GET_FROM_STRETCH
:
5025 p
->u
.stretch
.object
= it
->object
;
5028 p
->position
= position
? *position
: it
->position
;
5029 p
->current
= it
->current
;
5030 p
->end_charpos
= it
->end_charpos
;
5031 p
->string_nchars
= it
->string_nchars
;
5033 p
->multibyte_p
= it
->multibyte_p
;
5034 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5035 p
->space_width
= it
->space_width
;
5036 p
->font_height
= it
->font_height
;
5037 p
->voffset
= it
->voffset
;
5038 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5039 p
->display_ellipsis_p
= 0;
5040 p
->line_wrap
= it
->line_wrap
;
5045 iterate_out_of_display_property (struct it
*it
)
5047 /* Maybe initialize paragraph direction. If we are at the beginning
5048 of a new paragraph, next_element_from_buffer may not have a
5049 chance to do that. */
5050 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5051 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5052 /* prev_stop can be zero, so check against BEGV as well. */
5053 while (it
->bidi_it
.charpos
>= BEGV
5054 && it
->prev_stop
<= it
->bidi_it
.charpos
5055 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5056 bidi_move_to_visually_next (&it
->bidi_it
);
5057 /* Record the stop_pos we just crossed, for when we cross it
5059 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5060 it
->prev_stop
= CHARPOS (it
->position
);
5061 /* If we ended up not where pop_it put us, resync IT's
5062 positional members with the bidi iterator. */
5063 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5065 SET_TEXT_POS (it
->position
,
5066 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5067 it
->current
.pos
= it
->position
;
5071 /* Restore IT's settings from IT->stack. Called, for example, when no
5072 more overlay strings must be processed, and we return to delivering
5073 display elements from a buffer, or when the end of a string from a
5074 `display' property is reached and we return to delivering display
5075 elements from an overlay string, or from a buffer. */
5078 pop_it (struct it
*it
)
5080 struct iterator_stack_entry
*p
;
5082 xassert (it
->sp
> 0);
5084 p
= it
->stack
+ it
->sp
;
5085 it
->stop_charpos
= p
->stop_charpos
;
5086 it
->prev_stop
= p
->prev_stop
;
5087 it
->base_level_stop
= p
->base_level_stop
;
5088 it
->cmp_it
= p
->cmp_it
;
5089 it
->face_id
= p
->face_id
;
5090 it
->current
= p
->current
;
5091 it
->position
= p
->position
;
5092 it
->string
= p
->string
;
5093 it
->from_overlay
= p
->from_overlay
;
5094 if (NILP (it
->string
))
5095 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5096 it
->method
= p
->method
;
5099 case GET_FROM_IMAGE
:
5100 it
->image_id
= p
->u
.image
.image_id
;
5101 it
->object
= p
->u
.image
.object
;
5102 it
->slice
= p
->u
.image
.slice
;
5104 case GET_FROM_STRETCH
:
5105 it
->object
= p
->u
.comp
.object
;
5107 case GET_FROM_BUFFER
:
5108 it
->object
= it
->w
->buffer
;
5111 /* Bidi-iterate until we get out of the portion of text, if
5112 any, covered by a `display' text property or an overlay
5113 with `display' property. (We cannot just jump there,
5114 because the internal coherency of the bidi iterator state
5115 can not be preserved across such jumps.) We also must
5116 determine the paragraph base direction if the overlay we
5117 just processed is at the beginning of a new
5119 iterate_out_of_display_property (it
);
5122 case GET_FROM_STRING
:
5123 it
->object
= it
->string
;
5125 case GET_FROM_DISPLAY_VECTOR
:
5127 it
->method
= GET_FROM_C_STRING
;
5128 else if (STRINGP (it
->string
))
5129 it
->method
= GET_FROM_STRING
;
5132 it
->method
= GET_FROM_BUFFER
;
5133 it
->object
= it
->w
->buffer
;
5136 it
->end_charpos
= p
->end_charpos
;
5137 it
->string_nchars
= p
->string_nchars
;
5139 it
->multibyte_p
= p
->multibyte_p
;
5140 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5141 it
->space_width
= p
->space_width
;
5142 it
->font_height
= p
->font_height
;
5143 it
->voffset
= p
->voffset
;
5144 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5145 it
->line_wrap
= p
->line_wrap
;
5150 /***********************************************************************
5152 ***********************************************************************/
5154 /* Set IT's current position to the previous line start. */
5157 back_to_previous_line_start (struct it
*it
)
5159 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5160 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5164 /* Move IT to the next line start.
5166 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5167 we skipped over part of the text (as opposed to moving the iterator
5168 continuously over the text). Otherwise, don't change the value
5171 Newlines may come from buffer text, overlay strings, or strings
5172 displayed via the `display' property. That's the reason we can't
5173 simply use find_next_newline_no_quit.
5175 Note that this function may not skip over invisible text that is so
5176 because of text properties and immediately follows a newline. If
5177 it would, function reseat_at_next_visible_line_start, when called
5178 from set_iterator_to_next, would effectively make invisible
5179 characters following a newline part of the wrong glyph row, which
5180 leads to wrong cursor motion. */
5183 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5185 EMACS_INT old_selective
;
5186 int newline_found_p
, n
;
5187 const int MAX_NEWLINE_DISTANCE
= 500;
5189 /* If already on a newline, just consume it to avoid unintended
5190 skipping over invisible text below. */
5191 if (it
->what
== IT_CHARACTER
5193 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5195 set_iterator_to_next (it
, 0);
5200 /* Don't handle selective display in the following. It's (a)
5201 unnecessary because it's done by the caller, and (b) leads to an
5202 infinite recursion because next_element_from_ellipsis indirectly
5203 calls this function. */
5204 old_selective
= it
->selective
;
5207 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5208 from buffer text. */
5209 for (n
= newline_found_p
= 0;
5210 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5211 n
+= STRINGP (it
->string
) ? 0 : 1)
5213 if (!get_next_display_element (it
))
5215 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5216 set_iterator_to_next (it
, 0);
5219 /* If we didn't find a newline near enough, see if we can use a
5221 if (!newline_found_p
)
5223 EMACS_INT start
= IT_CHARPOS (*it
);
5224 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5227 xassert (!STRINGP (it
->string
));
5229 /* If there isn't any `display' property in sight, and no
5230 overlays, we can just use the position of the newline in
5232 if (it
->stop_charpos
>= limit
5233 || ((pos
= Fnext_single_property_change (make_number (start
),
5235 Qnil
, make_number (limit
)),
5237 && next_overlay_change (start
) == ZV
))
5239 IT_CHARPOS (*it
) = limit
;
5240 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5241 *skipped_p
= newline_found_p
= 1;
5245 while (get_next_display_element (it
)
5246 && !newline_found_p
)
5248 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5249 set_iterator_to_next (it
, 0);
5254 it
->selective
= old_selective
;
5255 return newline_found_p
;
5259 /* Set IT's current position to the previous visible line start. Skip
5260 invisible text that is so either due to text properties or due to
5261 selective display. Caution: this does not change IT->current_x and
5265 back_to_previous_visible_line_start (struct it
*it
)
5267 while (IT_CHARPOS (*it
) > BEGV
)
5269 back_to_previous_line_start (it
);
5271 if (IT_CHARPOS (*it
) <= BEGV
)
5274 /* If selective > 0, then lines indented more than its value are
5276 if (it
->selective
> 0
5277 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5281 /* Check the newline before point for invisibility. */
5284 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5285 Qinvisible
, it
->window
);
5286 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5290 if (IT_CHARPOS (*it
) <= BEGV
)
5297 Lisp_Object val
, overlay
;
5299 /* If newline is part of a composition, continue from start of composition */
5300 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5301 && beg
< IT_CHARPOS (*it
))
5304 /* If newline is replaced by a display property, find start of overlay
5305 or interval and continue search from that point. */
5307 pos
= --IT_CHARPOS (it2
);
5310 it2
.string_from_display_prop_p
= 0;
5311 if (handle_display_prop (&it2
) == HANDLED_RETURN
5312 && !NILP (val
= get_char_property_and_overlay
5313 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5314 && (OVERLAYP (overlay
)
5315 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5316 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5319 /* Newline is not replaced by anything -- so we are done. */
5325 IT_CHARPOS (*it
) = beg
;
5326 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5330 it
->continuation_lines_width
= 0;
5332 xassert (IT_CHARPOS (*it
) >= BEGV
);
5333 xassert (IT_CHARPOS (*it
) == BEGV
5334 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5339 /* Reseat iterator IT at the previous visible line start. Skip
5340 invisible text that is so either due to text properties or due to
5341 selective display. At the end, update IT's overlay information,
5342 face information etc. */
5345 reseat_at_previous_visible_line_start (struct it
*it
)
5347 back_to_previous_visible_line_start (it
);
5348 reseat (it
, it
->current
.pos
, 1);
5353 /* Reseat iterator IT on the next visible line start in the current
5354 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5355 preceding the line start. Skip over invisible text that is so
5356 because of selective display. Compute faces, overlays etc at the
5357 new position. Note that this function does not skip over text that
5358 is invisible because of text properties. */
5361 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5363 int newline_found_p
, skipped_p
= 0;
5365 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5367 /* Skip over lines that are invisible because they are indented
5368 more than the value of IT->selective. */
5369 if (it
->selective
> 0)
5370 while (IT_CHARPOS (*it
) < ZV
5371 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5374 xassert (IT_BYTEPOS (*it
) == BEGV
5375 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5376 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5379 /* Position on the newline if that's what's requested. */
5380 if (on_newline_p
&& newline_found_p
)
5382 if (STRINGP (it
->string
))
5384 if (IT_STRING_CHARPOS (*it
) > 0)
5386 --IT_STRING_CHARPOS (*it
);
5387 --IT_STRING_BYTEPOS (*it
);
5390 else if (IT_CHARPOS (*it
) > BEGV
)
5394 reseat (it
, it
->current
.pos
, 0);
5398 reseat (it
, it
->current
.pos
, 0);
5405 /***********************************************************************
5406 Changing an iterator's position
5407 ***********************************************************************/
5409 /* Change IT's current position to POS in current_buffer. If FORCE_P
5410 is non-zero, always check for text properties at the new position.
5411 Otherwise, text properties are only looked up if POS >=
5412 IT->check_charpos of a property. */
5415 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5417 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5419 reseat_1 (it
, pos
, 0);
5421 /* Determine where to check text properties. Avoid doing it
5422 where possible because text property lookup is very expensive. */
5424 || CHARPOS (pos
) > it
->stop_charpos
5425 || CHARPOS (pos
) < original_pos
)
5429 /* For bidi iteration, we need to prime prev_stop and
5430 base_level_stop with our best estimations. */
5431 if (CHARPOS (pos
) < it
->prev_stop
)
5433 handle_stop_backwards (it
, BEGV
);
5434 if (CHARPOS (pos
) < it
->base_level_stop
)
5435 it
->base_level_stop
= 0;
5437 else if (CHARPOS (pos
) > it
->stop_charpos
5438 && it
->stop_charpos
>= BEGV
)
5439 handle_stop_backwards (it
, it
->stop_charpos
);
5446 it
->prev_stop
= it
->base_level_stop
= 0;
5455 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5456 IT->stop_pos to POS, also. */
5459 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5461 /* Don't call this function when scanning a C string. */
5462 xassert (it
->s
== NULL
);
5464 /* POS must be a reasonable value. */
5465 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5467 it
->current
.pos
= it
->position
= pos
;
5468 it
->end_charpos
= ZV
;
5470 it
->current
.dpvec_index
= -1;
5471 it
->current
.overlay_string_index
= -1;
5472 IT_STRING_CHARPOS (*it
) = -1;
5473 IT_STRING_BYTEPOS (*it
) = -1;
5475 it
->string_from_display_prop_p
= 0;
5476 it
->method
= GET_FROM_BUFFER
;
5477 it
->object
= it
->w
->buffer
;
5478 it
->area
= TEXT_AREA
;
5479 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5481 it
->string_from_display_prop_p
= 0;
5482 it
->face_before_selective_p
= 0;
5485 it
->bidi_it
.first_elt
= 1;
5486 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5487 it
->bidi_it
.disp_pos
= -1;
5492 it
->stop_charpos
= CHARPOS (pos
);
5493 it
->base_level_stop
= CHARPOS (pos
);
5498 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5499 If S is non-null, it is a C string to iterate over. Otherwise,
5500 STRING gives a Lisp string to iterate over.
5502 If PRECISION > 0, don't return more then PRECISION number of
5503 characters from the string.
5505 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5506 characters have been returned. FIELD_WIDTH < 0 means an infinite
5509 MULTIBYTE = 0 means disable processing of multibyte characters,
5510 MULTIBYTE > 0 means enable it,
5511 MULTIBYTE < 0 means use IT->multibyte_p.
5513 IT must be initialized via a prior call to init_iterator before
5514 calling this function. */
5517 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5518 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5521 /* No region in strings. */
5522 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5524 /* No text property checks performed by default, but see below. */
5525 it
->stop_charpos
= -1;
5527 /* Set iterator position and end position. */
5528 memset (&it
->current
, 0, sizeof it
->current
);
5529 it
->current
.overlay_string_index
= -1;
5530 it
->current
.dpvec_index
= -1;
5531 xassert (charpos
>= 0);
5533 /* If STRING is specified, use its multibyteness, otherwise use the
5534 setting of MULTIBYTE, if specified. */
5536 it
->multibyte_p
= multibyte
> 0;
5540 xassert (STRINGP (string
));
5541 it
->string
= string
;
5543 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5544 it
->method
= GET_FROM_STRING
;
5545 it
->current
.string_pos
= string_pos (charpos
, string
);
5549 it
->s
= (const unsigned char *) s
;
5552 /* Note that we use IT->current.pos, not it->current.string_pos,
5553 for displaying C strings. */
5554 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5555 if (it
->multibyte_p
)
5557 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5558 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5562 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5563 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5566 it
->method
= GET_FROM_C_STRING
;
5569 /* PRECISION > 0 means don't return more than PRECISION characters
5571 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5572 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5574 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5575 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5576 FIELD_WIDTH < 0 means infinite field width. This is useful for
5577 padding with `-' at the end of a mode line. */
5578 if (field_width
< 0)
5579 field_width
= INFINITY
;
5580 if (field_width
> it
->end_charpos
- charpos
)
5581 it
->end_charpos
= charpos
+ field_width
;
5583 /* Use the standard display table for displaying strings. */
5584 if (DISP_TABLE_P (Vstandard_display_table
))
5585 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5587 it
->stop_charpos
= charpos
;
5588 if (s
== NULL
&& it
->multibyte_p
)
5590 EMACS_INT endpos
= SCHARS (it
->string
);
5591 if (endpos
> it
->end_charpos
)
5592 endpos
= it
->end_charpos
;
5593 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5601 /***********************************************************************
5603 ***********************************************************************/
5605 /* Map enum it_method value to corresponding next_element_from_* function. */
5607 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5609 next_element_from_buffer
,
5610 next_element_from_display_vector
,
5611 next_element_from_string
,
5612 next_element_from_c_string
,
5613 next_element_from_image
,
5614 next_element_from_stretch
5617 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5620 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5621 (possibly with the following characters). */
5623 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5624 ((IT)->cmp_it.id >= 0 \
5625 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5626 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5627 END_CHARPOS, (IT)->w, \
5628 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5632 /* Lookup the char-table Vglyphless_char_display for character C (-1
5633 if we want information for no-font case), and return the display
5634 method symbol. By side-effect, update it->what and
5635 it->glyphless_method. This function is called from
5636 get_next_display_element for each character element, and from
5637 x_produce_glyphs when no suitable font was found. */
5640 lookup_glyphless_char_display (int c
, struct it
*it
)
5642 Lisp_Object glyphless_method
= Qnil
;
5644 if (CHAR_TABLE_P (Vglyphless_char_display
)
5645 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5649 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5650 if (CONSP (glyphless_method
))
5651 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5652 ? XCAR (glyphless_method
)
5653 : XCDR (glyphless_method
);
5656 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5660 if (NILP (glyphless_method
))
5663 /* The default is to display the character by a proper font. */
5665 /* The default for the no-font case is to display an empty box. */
5666 glyphless_method
= Qempty_box
;
5668 if (EQ (glyphless_method
, Qzero_width
))
5671 return glyphless_method
;
5672 /* This method can't be used for the no-font case. */
5673 glyphless_method
= Qempty_box
;
5675 if (EQ (glyphless_method
, Qthin_space
))
5676 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5677 else if (EQ (glyphless_method
, Qempty_box
))
5678 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5679 else if (EQ (glyphless_method
, Qhex_code
))
5680 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5681 else if (STRINGP (glyphless_method
))
5682 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5685 /* Invalid value. We use the default method. */
5686 glyphless_method
= Qnil
;
5689 it
->what
= IT_GLYPHLESS
;
5690 return glyphless_method
;
5693 /* Load IT's display element fields with information about the next
5694 display element from the current position of IT. Value is zero if
5695 end of buffer (or C string) is reached. */
5697 static struct frame
*last_escape_glyph_frame
= NULL
;
5698 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5699 static int last_escape_glyph_merged_face_id
= 0;
5701 struct frame
*last_glyphless_glyph_frame
= NULL
;
5702 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5703 int last_glyphless_glyph_merged_face_id
= 0;
5706 get_next_display_element (struct it
*it
)
5708 /* Non-zero means that we found a display element. Zero means that
5709 we hit the end of what we iterate over. Performance note: the
5710 function pointer `method' used here turns out to be faster than
5711 using a sequence of if-statements. */
5715 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5717 if (it
->what
== IT_CHARACTER
)
5719 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5720 and only if (a) the resolved directionality of that character
5722 /* FIXME: Do we need an exception for characters from display
5724 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5725 it
->c
= bidi_mirror_char (it
->c
);
5726 /* Map via display table or translate control characters.
5727 IT->c, IT->len etc. have been set to the next character by
5728 the function call above. If we have a display table, and it
5729 contains an entry for IT->c, translate it. Don't do this if
5730 IT->c itself comes from a display table, otherwise we could
5731 end up in an infinite recursion. (An alternative could be to
5732 count the recursion depth of this function and signal an
5733 error when a certain maximum depth is reached.) Is it worth
5735 if (success_p
&& it
->dpvec
== NULL
)
5738 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5739 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5740 nbsp_or_shy
= char_is_other
;
5741 int c
= it
->c
; /* This is the character to display. */
5743 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5745 xassert (SINGLE_BYTE_CHAR_P (c
));
5746 if (unibyte_display_via_language_environment
)
5748 c
= DECODE_CHAR (unibyte
, c
);
5750 c
= BYTE8_TO_CHAR (it
->c
);
5753 c
= BYTE8_TO_CHAR (it
->c
);
5757 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5760 struct Lisp_Vector
*v
= XVECTOR (dv
);
5762 /* Return the first character from the display table
5763 entry, if not empty. If empty, don't display the
5764 current character. */
5767 it
->dpvec_char_len
= it
->len
;
5768 it
->dpvec
= v
->contents
;
5769 it
->dpend
= v
->contents
+ v
->header
.size
;
5770 it
->current
.dpvec_index
= 0;
5771 it
->dpvec_face_id
= -1;
5772 it
->saved_face_id
= it
->face_id
;
5773 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5778 set_iterator_to_next (it
, 0);
5783 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5785 if (it
->what
== IT_GLYPHLESS
)
5787 /* Don't display this character. */
5788 set_iterator_to_next (it
, 0);
5792 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5793 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5794 : c
== 0xAD ? char_is_soft_hyphen
5797 /* Translate control characters into `\003' or `^C' form.
5798 Control characters coming from a display table entry are
5799 currently not translated because we use IT->dpvec to hold
5800 the translation. This could easily be changed but I
5801 don't believe that it is worth doing.
5803 NBSP and SOFT-HYPEN are property translated too.
5805 Non-printable characters and raw-byte characters are also
5806 translated to octal form. */
5807 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5808 ? (it
->area
!= TEXT_AREA
5809 /* In mode line, treat \n, \t like other crl chars. */
5812 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5813 || (c
!= '\n' && c
!= '\t'))
5816 || ! CHAR_PRINTABLE_P (c
))))
5818 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5819 or a non-printable character which must be displayed
5820 either as '\003' or as `^C' where the '\\' and '^'
5821 can be defined in the display table. Fill
5822 IT->ctl_chars with glyphs for what we have to
5823 display. Then, set IT->dpvec to these glyphs. */
5827 EMACS_INT lface_id
= 0;
5830 /* Handle control characters with ^. */
5832 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5836 g
= '^'; /* default glyph for Control */
5837 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5839 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5840 && GLYPH_CODE_CHAR_VALID_P (gc
))
5842 g
= GLYPH_CODE_CHAR (gc
);
5843 lface_id
= GLYPH_CODE_FACE (gc
);
5847 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5849 else if (it
->f
== last_escape_glyph_frame
5850 && it
->face_id
== last_escape_glyph_face_id
)
5852 face_id
= last_escape_glyph_merged_face_id
;
5856 /* Merge the escape-glyph face into the current face. */
5857 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5859 last_escape_glyph_frame
= it
->f
;
5860 last_escape_glyph_face_id
= it
->face_id
;
5861 last_escape_glyph_merged_face_id
= face_id
;
5864 XSETINT (it
->ctl_chars
[0], g
);
5865 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5867 goto display_control
;
5870 /* Handle non-break space in the mode where it only gets
5873 if (EQ (Vnobreak_char_display
, Qt
)
5874 && nbsp_or_shy
== char_is_nbsp
)
5876 /* Merge the no-break-space face into the current face. */
5877 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5881 XSETINT (it
->ctl_chars
[0], ' ');
5883 goto display_control
;
5886 /* Handle sequences that start with the "escape glyph". */
5888 /* the default escape glyph is \. */
5889 escape_glyph
= '\\';
5892 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5893 && GLYPH_CODE_CHAR_VALID_P (gc
))
5895 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5896 lface_id
= GLYPH_CODE_FACE (gc
);
5900 /* The display table specified a face.
5901 Merge it into face_id and also into escape_glyph. */
5902 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5905 else if (it
->f
== last_escape_glyph_frame
5906 && it
->face_id
== last_escape_glyph_face_id
)
5908 face_id
= last_escape_glyph_merged_face_id
;
5912 /* Merge the escape-glyph face into the current face. */
5913 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5915 last_escape_glyph_frame
= it
->f
;
5916 last_escape_glyph_face_id
= it
->face_id
;
5917 last_escape_glyph_merged_face_id
= face_id
;
5920 /* Handle soft hyphens in the mode where they only get
5923 if (EQ (Vnobreak_char_display
, Qt
)
5924 && nbsp_or_shy
== char_is_soft_hyphen
)
5926 XSETINT (it
->ctl_chars
[0], '-');
5928 goto display_control
;
5931 /* Handle non-break space and soft hyphen
5932 with the escape glyph. */
5936 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5937 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5938 XSETINT (it
->ctl_chars
[1], c
);
5940 goto display_control
;
5947 if (CHAR_BYTE8_P (c
))
5948 /* Display \200 instead of \17777600. */
5949 c
= CHAR_TO_BYTE8 (c
);
5950 len
= sprintf (str
, "%03o", c
);
5952 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5953 for (i
= 0; i
< len
; i
++)
5954 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5959 /* Set up IT->dpvec and return first character from it. */
5960 it
->dpvec_char_len
= it
->len
;
5961 it
->dpvec
= it
->ctl_chars
;
5962 it
->dpend
= it
->dpvec
+ ctl_len
;
5963 it
->current
.dpvec_index
= 0;
5964 it
->dpvec_face_id
= face_id
;
5965 it
->saved_face_id
= it
->face_id
;
5966 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5970 it
->char_to_display
= c
;
5974 it
->char_to_display
= it
->c
;
5978 /* Adjust face id for a multibyte character. There are no multibyte
5979 character in unibyte text. */
5980 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5983 && FRAME_WINDOW_P (it
->f
))
5985 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5987 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5989 /* Automatic composition with glyph-string. */
5990 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5992 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5996 EMACS_INT pos
= (it
->s
? -1
5997 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5998 : IT_CHARPOS (*it
));
6001 if (it
->what
== IT_CHARACTER
)
6002 c
= it
->char_to_display
;
6005 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6009 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6010 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6013 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6018 /* Is this character the last one of a run of characters with
6019 box? If yes, set IT->end_of_box_run_p to 1. */
6023 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6025 int face_id
= underlying_face_id (it
);
6026 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6030 if (face
->box
== FACE_NO_BOX
)
6032 /* If the box comes from face properties in a
6033 display string, check faces in that string. */
6034 int string_face_id
= face_after_it_pos (it
);
6035 it
->end_of_box_run_p
6036 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6039 /* Otherwise, the box comes from the underlying face.
6040 If this is the last string character displayed, check
6041 the next buffer location. */
6042 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6043 && (it
->current
.overlay_string_index
6044 == it
->n_overlay_strings
- 1))
6048 struct text_pos pos
= it
->current
.pos
;
6049 INC_TEXT_POS (pos
, it
->multibyte_p
);
6051 next_face_id
= face_at_buffer_position
6052 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6053 it
->region_end_charpos
, &ignore
,
6054 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6056 it
->end_of_box_run_p
6057 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6064 int face_id
= face_after_it_pos (it
);
6065 it
->end_of_box_run_p
6066 = (face_id
!= it
->face_id
6067 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6071 /* Value is 0 if end of buffer or string reached. */
6076 /* Move IT to the next display element.
6078 RESEAT_P non-zero means if called on a newline in buffer text,
6079 skip to the next visible line start.
6081 Functions get_next_display_element and set_iterator_to_next are
6082 separate because I find this arrangement easier to handle than a
6083 get_next_display_element function that also increments IT's
6084 position. The way it is we can first look at an iterator's current
6085 display element, decide whether it fits on a line, and if it does,
6086 increment the iterator position. The other way around we probably
6087 would either need a flag indicating whether the iterator has to be
6088 incremented the next time, or we would have to implement a
6089 decrement position function which would not be easy to write. */
6092 set_iterator_to_next (struct it
*it
, int reseat_p
)
6094 /* Reset flags indicating start and end of a sequence of characters
6095 with box. Reset them at the start of this function because
6096 moving the iterator to a new position might set them. */
6097 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6101 case GET_FROM_BUFFER
:
6102 /* The current display element of IT is a character from
6103 current_buffer. Advance in the buffer, and maybe skip over
6104 invisible lines that are so because of selective display. */
6105 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6106 reseat_at_next_visible_line_start (it
, 0);
6107 else if (it
->cmp_it
.id
>= 0)
6109 /* We are currently getting glyphs from a composition. */
6114 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6115 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6116 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6118 it
->cmp_it
.from
= it
->cmp_it
.to
;
6123 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6125 it
->end_charpos
, Qnil
);
6128 else if (! it
->cmp_it
.reversed_p
)
6130 /* Composition created while scanning forward. */
6131 /* Update IT's char/byte positions to point to the first
6132 character of the next grapheme cluster, or to the
6133 character visually after the current composition. */
6134 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6135 bidi_move_to_visually_next (&it
->bidi_it
);
6136 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6137 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6139 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6141 /* Proceed to the next grapheme cluster. */
6142 it
->cmp_it
.from
= it
->cmp_it
.to
;
6146 /* No more grapheme clusters in this composition.
6147 Find the next stop position. */
6148 EMACS_INT stop
= it
->end_charpos
;
6149 if (it
->bidi_it
.scan_dir
< 0)
6150 /* Now we are scanning backward and don't know
6153 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6154 IT_BYTEPOS (*it
), stop
, Qnil
);
6159 /* Composition created while scanning backward. */
6160 /* Update IT's char/byte positions to point to the last
6161 character of the previous grapheme cluster, or the
6162 character visually after the current composition. */
6163 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6164 bidi_move_to_visually_next (&it
->bidi_it
);
6165 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6166 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6167 if (it
->cmp_it
.from
> 0)
6169 /* Proceed to the previous grapheme cluster. */
6170 it
->cmp_it
.to
= it
->cmp_it
.from
;
6174 /* No more grapheme clusters in this composition.
6175 Find the next stop position. */
6176 EMACS_INT stop
= it
->end_charpos
;
6177 if (it
->bidi_it
.scan_dir
< 0)
6178 /* Now we are scanning backward and don't know
6181 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6182 IT_BYTEPOS (*it
), stop
, Qnil
);
6188 xassert (it
->len
!= 0);
6192 IT_BYTEPOS (*it
) += it
->len
;
6193 IT_CHARPOS (*it
) += 1;
6197 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6198 /* If this is a new paragraph, determine its base
6199 direction (a.k.a. its base embedding level). */
6200 if (it
->bidi_it
.new_paragraph
)
6201 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6202 bidi_move_to_visually_next (&it
->bidi_it
);
6203 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6204 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6205 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6207 /* As the scan direction was changed, we must
6208 re-compute the stop position for composition. */
6209 EMACS_INT stop
= it
->end_charpos
;
6210 if (it
->bidi_it
.scan_dir
< 0)
6212 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6213 IT_BYTEPOS (*it
), stop
, Qnil
);
6216 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6220 case GET_FROM_C_STRING
:
6221 /* Current display element of IT is from a C string. */
6222 IT_BYTEPOS (*it
) += it
->len
;
6223 IT_CHARPOS (*it
) += 1;
6226 case GET_FROM_DISPLAY_VECTOR
:
6227 /* Current display element of IT is from a display table entry.
6228 Advance in the display table definition. Reset it to null if
6229 end reached, and continue with characters from buffers/
6231 ++it
->current
.dpvec_index
;
6233 /* Restore face of the iterator to what they were before the
6234 display vector entry (these entries may contain faces). */
6235 it
->face_id
= it
->saved_face_id
;
6237 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6239 int recheck_faces
= it
->ellipsis_p
;
6242 it
->method
= GET_FROM_C_STRING
;
6243 else if (STRINGP (it
->string
))
6244 it
->method
= GET_FROM_STRING
;
6247 it
->method
= GET_FROM_BUFFER
;
6248 it
->object
= it
->w
->buffer
;
6252 it
->current
.dpvec_index
= -1;
6254 /* Skip over characters which were displayed via IT->dpvec. */
6255 if (it
->dpvec_char_len
< 0)
6256 reseat_at_next_visible_line_start (it
, 1);
6257 else if (it
->dpvec_char_len
> 0)
6259 if (it
->method
== GET_FROM_STRING
6260 && it
->n_overlay_strings
> 0)
6261 it
->ignore_overlay_strings_at_pos_p
= 1;
6262 it
->len
= it
->dpvec_char_len
;
6263 set_iterator_to_next (it
, reseat_p
);
6266 /* Maybe recheck faces after display vector */
6268 it
->stop_charpos
= IT_CHARPOS (*it
);
6272 case GET_FROM_STRING
:
6273 /* Current display element is a character from a Lisp string. */
6274 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6275 if (it
->cmp_it
.id
>= 0)
6277 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6278 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6279 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6280 it
->cmp_it
.from
= it
->cmp_it
.to
;
6284 composition_compute_stop_pos (&it
->cmp_it
,
6285 IT_STRING_CHARPOS (*it
),
6286 IT_STRING_BYTEPOS (*it
),
6287 it
->end_charpos
, it
->string
);
6292 IT_STRING_BYTEPOS (*it
) += it
->len
;
6293 IT_STRING_CHARPOS (*it
) += 1;
6296 consider_string_end
:
6298 if (it
->current
.overlay_string_index
>= 0)
6300 /* IT->string is an overlay string. Advance to the
6301 next, if there is one. */
6302 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6305 next_overlay_string (it
);
6307 setup_for_ellipsis (it
, 0);
6312 /* IT->string is not an overlay string. If we reached
6313 its end, and there is something on IT->stack, proceed
6314 with what is on the stack. This can be either another
6315 string, this time an overlay string, or a buffer. */
6316 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6320 if (it
->method
== GET_FROM_STRING
)
6321 goto consider_string_end
;
6326 case GET_FROM_IMAGE
:
6327 case GET_FROM_STRETCH
:
6328 /* The position etc with which we have to proceed are on
6329 the stack. The position may be at the end of a string,
6330 if the `display' property takes up the whole string. */
6331 xassert (it
->sp
> 0);
6333 if (it
->method
== GET_FROM_STRING
)
6334 goto consider_string_end
;
6338 /* There are no other methods defined, so this should be a bug. */
6342 xassert (it
->method
!= GET_FROM_STRING
6343 || (STRINGP (it
->string
)
6344 && IT_STRING_CHARPOS (*it
) >= 0));
6347 /* Load IT's display element fields with information about the next
6348 display element which comes from a display table entry or from the
6349 result of translating a control character to one of the forms `^C'
6352 IT->dpvec holds the glyphs to return as characters.
6353 IT->saved_face_id holds the face id before the display vector--it
6354 is restored into IT->face_id in set_iterator_to_next. */
6357 next_element_from_display_vector (struct it
*it
)
6362 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6364 it
->face_id
= it
->saved_face_id
;
6366 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6367 That seemed totally bogus - so I changed it... */
6368 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6370 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6372 it
->c
= GLYPH_CODE_CHAR (gc
);
6373 it
->len
= CHAR_BYTES (it
->c
);
6375 /* The entry may contain a face id to use. Such a face id is
6376 the id of a Lisp face, not a realized face. A face id of
6377 zero means no face is specified. */
6378 if (it
->dpvec_face_id
>= 0)
6379 it
->face_id
= it
->dpvec_face_id
;
6382 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6384 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6389 /* Display table entry is invalid. Return a space. */
6390 it
->c
= ' ', it
->len
= 1;
6392 /* Don't change position and object of the iterator here. They are
6393 still the values of the character that had this display table
6394 entry or was translated, and that's what we want. */
6395 it
->what
= IT_CHARACTER
;
6400 /* Load IT with the next display element from Lisp string IT->string.
6401 IT->current.string_pos is the current position within the string.
6402 If IT->current.overlay_string_index >= 0, the Lisp string is an
6406 next_element_from_string (struct it
*it
)
6408 struct text_pos position
;
6410 xassert (STRINGP (it
->string
));
6411 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6412 position
= it
->current
.string_pos
;
6414 /* Time to check for invisible text? */
6415 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6416 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6420 /* Since a handler may have changed IT->method, we must
6422 return GET_NEXT_DISPLAY_ELEMENT (it
);
6425 if (it
->current
.overlay_string_index
>= 0)
6427 /* Get the next character from an overlay string. In overlay
6428 strings, There is no field width or padding with spaces to
6430 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6435 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6436 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6437 && next_element_from_composition (it
))
6441 else if (STRING_MULTIBYTE (it
->string
))
6443 const unsigned char *s
= (SDATA (it
->string
)
6444 + IT_STRING_BYTEPOS (*it
));
6445 it
->c
= string_char_and_length (s
, &it
->len
);
6449 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6455 /* Get the next character from a Lisp string that is not an
6456 overlay string. Such strings come from the mode line, for
6457 example. We may have to pad with spaces, or truncate the
6458 string. See also next_element_from_c_string. */
6459 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6464 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6466 /* Pad with spaces. */
6467 it
->c
= ' ', it
->len
= 1;
6468 CHARPOS (position
) = BYTEPOS (position
) = -1;
6470 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6471 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6472 && next_element_from_composition (it
))
6476 else if (STRING_MULTIBYTE (it
->string
))
6478 const unsigned char *s
= (SDATA (it
->string
)
6479 + IT_STRING_BYTEPOS (*it
));
6480 it
->c
= string_char_and_length (s
, &it
->len
);
6484 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6489 /* Record what we have and where it came from. */
6490 it
->what
= IT_CHARACTER
;
6491 it
->object
= it
->string
;
6492 it
->position
= position
;
6497 /* Load IT with next display element from C string IT->s.
6498 IT->string_nchars is the maximum number of characters to return
6499 from the string. IT->end_charpos may be greater than
6500 IT->string_nchars when this function is called, in which case we
6501 may have to return padding spaces. Value is zero if end of string
6502 reached, including padding spaces. */
6505 next_element_from_c_string (struct it
*it
)
6510 it
->what
= IT_CHARACTER
;
6511 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6514 /* IT's position can be greater IT->string_nchars in case a field
6515 width or precision has been specified when the iterator was
6517 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6519 /* End of the game. */
6523 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6525 /* Pad with spaces. */
6526 it
->c
= ' ', it
->len
= 1;
6527 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6529 else if (it
->multibyte_p
)
6530 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6532 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6538 /* Set up IT to return characters from an ellipsis, if appropriate.
6539 The definition of the ellipsis glyphs may come from a display table
6540 entry. This function fills IT with the first glyph from the
6541 ellipsis if an ellipsis is to be displayed. */
6544 next_element_from_ellipsis (struct it
*it
)
6546 if (it
->selective_display_ellipsis_p
)
6547 setup_for_ellipsis (it
, it
->len
);
6550 /* The face at the current position may be different from the
6551 face we find after the invisible text. Remember what it
6552 was in IT->saved_face_id, and signal that it's there by
6553 setting face_before_selective_p. */
6554 it
->saved_face_id
= it
->face_id
;
6555 it
->method
= GET_FROM_BUFFER
;
6556 it
->object
= it
->w
->buffer
;
6557 reseat_at_next_visible_line_start (it
, 1);
6558 it
->face_before_selective_p
= 1;
6561 return GET_NEXT_DISPLAY_ELEMENT (it
);
6565 /* Deliver an image display element. The iterator IT is already
6566 filled with image information (done in handle_display_prop). Value
6571 next_element_from_image (struct it
*it
)
6573 it
->what
= IT_IMAGE
;
6574 it
->ignore_overlay_strings_at_pos_p
= 0;
6579 /* Fill iterator IT with next display element from a stretch glyph
6580 property. IT->object is the value of the text property. Value is
6584 next_element_from_stretch (struct it
*it
)
6586 it
->what
= IT_STRETCH
;
6590 /* Scan forward from CHARPOS in the current buffer, until we find a
6591 stop position > current IT's position. Then handle the stop
6592 position before that. This is called when we bump into a stop
6593 position while reordering bidirectional text. CHARPOS should be
6594 the last previously processed stop_pos (or BEGV, if none were
6595 processed yet) whose position is less that IT's current
6599 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6601 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6602 struct display_pos save_current
= it
->current
;
6603 struct text_pos save_position
= it
->position
;
6604 struct text_pos pos1
;
6605 EMACS_INT next_stop
;
6607 /* Scan in strict logical order. */
6611 it
->prev_stop
= charpos
;
6612 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6613 reseat_1 (it
, pos1
, 0);
6614 compute_stop_pos (it
);
6615 /* We must advance forward, right? */
6616 if (it
->stop_charpos
<= it
->prev_stop
)
6618 charpos
= it
->stop_charpos
;
6620 while (charpos
<= where_we_are
);
6622 next_stop
= it
->stop_charpos
;
6623 it
->stop_charpos
= it
->prev_stop
;
6625 it
->current
= save_current
;
6626 it
->position
= save_position
;
6628 it
->stop_charpos
= next_stop
;
6631 /* Load IT with the next display element from current_buffer. Value
6632 is zero if end of buffer reached. IT->stop_charpos is the next
6633 position at which to stop and check for text properties or buffer
6637 next_element_from_buffer (struct it
*it
)
6641 xassert (IT_CHARPOS (*it
) >= BEGV
);
6643 /* With bidi reordering, the character to display might not be the
6644 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6645 we were reseat()ed to a new buffer position, which is potentially
6646 a different paragraph. */
6647 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6649 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6650 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6651 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6653 /* Nothing to do, but reset the FIRST_ELT flag, like
6654 bidi_paragraph_init does, because we are not going to
6656 it
->bidi_it
.first_elt
= 0;
6658 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6659 /* FIXME: Should support all Unicode line separators. */
6660 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6661 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6663 /* If we are at the beginning of a line, we can produce the
6664 next element right away. */
6665 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6666 bidi_move_to_visually_next (&it
->bidi_it
);
6670 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6672 /* We need to prime the bidi iterator starting at the line's
6673 beginning, before we will be able to produce the next
6675 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6676 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6677 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6678 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6679 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6682 /* Now return to buffer position where we were asked to
6683 get the next display element, and produce that. */
6684 bidi_move_to_visually_next (&it
->bidi_it
);
6686 while (it
->bidi_it
.bytepos
!= orig_bytepos
6687 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6690 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6691 /* Adjust IT's position information to where we ended up. */
6692 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6693 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6694 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6696 EMACS_INT stop
= it
->end_charpos
;
6697 if (it
->bidi_it
.scan_dir
< 0)
6699 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6700 IT_BYTEPOS (*it
), stop
, Qnil
);
6704 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6706 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6708 int overlay_strings_follow_p
;
6710 /* End of the game, except when overlay strings follow that
6711 haven't been returned yet. */
6712 if (it
->overlay_strings_at_end_processed_p
)
6713 overlay_strings_follow_p
= 0;
6716 it
->overlay_strings_at_end_processed_p
= 1;
6717 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6720 if (overlay_strings_follow_p
)
6721 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6725 it
->position
= it
->current
.pos
;
6729 else if (!(!it
->bidi_p
6730 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6731 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6733 /* With bidi non-linear iteration, we could find ourselves
6734 far beyond the last computed stop_charpos, with several
6735 other stop positions in between that we missed. Scan
6736 them all now, in buffer's logical order, until we find
6737 and handle the last stop_charpos that precedes our
6738 current position. */
6739 handle_stop_backwards (it
, it
->stop_charpos
);
6740 return GET_NEXT_DISPLAY_ELEMENT (it
);
6746 /* Take note of the stop position we just moved across,
6747 for when we will move back across it. */
6748 it
->prev_stop
= it
->stop_charpos
;
6749 /* If we are at base paragraph embedding level, take
6750 note of the last stop position seen at this
6752 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6753 it
->base_level_stop
= it
->stop_charpos
;
6756 return GET_NEXT_DISPLAY_ELEMENT (it
);
6760 /* We can sometimes back up for reasons that have nothing
6761 to do with bidi reordering. E.g., compositions. The
6762 code below is only needed when we are above the base
6763 embedding level, so test for that explicitly. */
6764 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6765 && IT_CHARPOS (*it
) < it
->prev_stop
)
6767 if (it
->base_level_stop
<= 0)
6768 it
->base_level_stop
= BEGV
;
6769 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6771 handle_stop_backwards (it
, it
->base_level_stop
);
6772 return GET_NEXT_DISPLAY_ELEMENT (it
);
6776 /* No face changes, overlays etc. in sight, so just return a
6777 character from current_buffer. */
6781 /* Maybe run the redisplay end trigger hook. Performance note:
6782 This doesn't seem to cost measurable time. */
6783 if (it
->redisplay_end_trigger_charpos
6785 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6786 run_redisplay_end_trigger_hook (it
);
6788 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6789 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6791 && next_element_from_composition (it
))
6796 /* Get the next character, maybe multibyte. */
6797 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6798 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6799 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6801 it
->c
= *p
, it
->len
= 1;
6803 /* Record what we have and where it came from. */
6804 it
->what
= IT_CHARACTER
;
6805 it
->object
= it
->w
->buffer
;
6806 it
->position
= it
->current
.pos
;
6808 /* Normally we return the character found above, except when we
6809 really want to return an ellipsis for selective display. */
6814 /* A value of selective > 0 means hide lines indented more
6815 than that number of columns. */
6816 if (it
->selective
> 0
6817 && IT_CHARPOS (*it
) + 1 < ZV
6818 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6819 IT_BYTEPOS (*it
) + 1,
6822 success_p
= next_element_from_ellipsis (it
);
6823 it
->dpvec_char_len
= -1;
6826 else if (it
->c
== '\r' && it
->selective
== -1)
6828 /* A value of selective == -1 means that everything from the
6829 CR to the end of the line is invisible, with maybe an
6830 ellipsis displayed for it. */
6831 success_p
= next_element_from_ellipsis (it
);
6832 it
->dpvec_char_len
= -1;
6837 /* Value is zero if end of buffer reached. */
6838 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6843 /* Run the redisplay end trigger hook for IT. */
6846 run_redisplay_end_trigger_hook (struct it
*it
)
6848 Lisp_Object args
[3];
6850 /* IT->glyph_row should be non-null, i.e. we should be actually
6851 displaying something, or otherwise we should not run the hook. */
6852 xassert (it
->glyph_row
);
6854 /* Set up hook arguments. */
6855 args
[0] = Qredisplay_end_trigger_functions
;
6856 args
[1] = it
->window
;
6857 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6858 it
->redisplay_end_trigger_charpos
= 0;
6860 /* Since we are *trying* to run these functions, don't try to run
6861 them again, even if they get an error. */
6862 it
->w
->redisplay_end_trigger
= Qnil
;
6863 Frun_hook_with_args (3, args
);
6865 /* Notice if it changed the face of the character we are on. */
6866 handle_face_prop (it
);
6870 /* Deliver a composition display element. Unlike the other
6871 next_element_from_XXX, this function is not registered in the array
6872 get_next_element[]. It is called from next_element_from_buffer and
6873 next_element_from_string when necessary. */
6876 next_element_from_composition (struct it
*it
)
6878 it
->what
= IT_COMPOSITION
;
6879 it
->len
= it
->cmp_it
.nbytes
;
6880 if (STRINGP (it
->string
))
6884 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6885 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6888 it
->position
= it
->current
.string_pos
;
6889 it
->object
= it
->string
;
6890 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6891 IT_STRING_BYTEPOS (*it
), it
->string
);
6897 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6898 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6901 if (it
->bidi_it
.new_paragraph
)
6902 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6903 /* Resync the bidi iterator with IT's new position.
6904 FIXME: this doesn't support bidirectional text. */
6905 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6906 bidi_move_to_visually_next (&it
->bidi_it
);
6910 it
->position
= it
->current
.pos
;
6911 it
->object
= it
->w
->buffer
;
6912 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6913 IT_BYTEPOS (*it
), Qnil
);
6920 /***********************************************************************
6921 Moving an iterator without producing glyphs
6922 ***********************************************************************/
6924 /* Check if iterator is at a position corresponding to a valid buffer
6925 position after some move_it_ call. */
6927 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6928 ((it)->method == GET_FROM_STRING \
6929 ? IT_STRING_CHARPOS (*it) == 0 \
6933 /* Move iterator IT to a specified buffer or X position within one
6934 line on the display without producing glyphs.
6936 OP should be a bit mask including some or all of these bits:
6937 MOVE_TO_X: Stop upon reaching x-position TO_X.
6938 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6939 Regardless of OP's value, stop upon reaching the end of the display line.
6941 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6942 This means, in particular, that TO_X includes window's horizontal
6945 The return value has several possible values that
6946 say what condition caused the scan to stop:
6948 MOVE_POS_MATCH_OR_ZV
6949 - when TO_POS or ZV was reached.
6952 -when TO_X was reached before TO_POS or ZV were reached.
6955 - when we reached the end of the display area and the line must
6959 - when we reached the end of the display area and the line is
6963 - when we stopped at a line end, i.e. a newline or a CR and selective
6966 static enum move_it_result
6967 move_it_in_display_line_to (struct it
*it
,
6968 EMACS_INT to_charpos
, int to_x
,
6969 enum move_operation_enum op
)
6971 enum move_it_result result
= MOVE_UNDEFINED
;
6972 struct glyph_row
*saved_glyph_row
;
6973 struct it wrap_it
, atpos_it
, atx_it
;
6975 enum it_method prev_method
= it
->method
;
6976 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6978 /* Don't produce glyphs in produce_glyphs. */
6979 saved_glyph_row
= it
->glyph_row
;
6980 it
->glyph_row
= NULL
;
6982 /* Use wrap_it to save a copy of IT wherever a word wrap could
6983 occur. Use atpos_it to save a copy of IT at the desired buffer
6984 position, if found, so that we can scan ahead and check if the
6985 word later overshoots the window edge. Use atx_it similarly, for
6991 #define BUFFER_POS_REACHED_P() \
6992 ((op & MOVE_TO_POS) != 0 \
6993 && BUFFERP (it->object) \
6994 && (IT_CHARPOS (*it) == to_charpos \
6995 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6996 && (it->method == GET_FROM_BUFFER \
6997 || (it->method == GET_FROM_DISPLAY_VECTOR \
6998 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7000 /* If there's a line-/wrap-prefix, handle it. */
7001 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7002 && it
->current_y
< it
->last_visible_y
)
7003 handle_line_prefix (it
);
7005 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7006 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7010 int x
, i
, ascent
= 0, descent
= 0;
7012 /* Utility macro to reset an iterator with x, ascent, and descent. */
7013 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7014 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7015 (IT)->max_descent = descent)
7017 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7019 if ((op
& MOVE_TO_POS
) != 0
7020 && BUFFERP (it
->object
)
7021 && it
->method
== GET_FROM_BUFFER
7022 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7024 && (prev_method
== GET_FROM_IMAGE
7025 || prev_method
== GET_FROM_STRETCH
)
7026 /* Passed TO_CHARPOS from left to right. */
7027 && ((prev_pos
< to_charpos
7028 && IT_CHARPOS (*it
) > to_charpos
)
7029 /* Passed TO_CHARPOS from right to left. */
7030 || (prev_pos
> to_charpos
7031 && IT_CHARPOS (*it
) < to_charpos
)))))
7033 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7035 result
= MOVE_POS_MATCH_OR_ZV
;
7038 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7039 /* If wrap_it is valid, the current position might be in a
7040 word that is wrapped. So, save the iterator in
7041 atpos_it and continue to see if wrapping happens. */
7045 prev_method
= it
->method
;
7046 if (it
->method
== GET_FROM_BUFFER
)
7047 prev_pos
= IT_CHARPOS (*it
);
7048 /* Stop when ZV reached.
7049 We used to stop here when TO_CHARPOS reached as well, but that is
7050 too soon if this glyph does not fit on this line. So we handle it
7051 explicitly below. */
7052 if (!get_next_display_element (it
))
7054 result
= MOVE_POS_MATCH_OR_ZV
;
7058 if (it
->line_wrap
== TRUNCATE
)
7060 if (BUFFER_POS_REACHED_P ())
7062 result
= MOVE_POS_MATCH_OR_ZV
;
7068 if (it
->line_wrap
== WORD_WRAP
)
7070 if (IT_DISPLAYING_WHITESPACE (it
))
7074 /* We have reached a glyph that follows one or more
7075 whitespace characters. If the position is
7076 already found, we are done. */
7077 if (atpos_it
.sp
>= 0)
7080 result
= MOVE_POS_MATCH_OR_ZV
;
7086 result
= MOVE_X_REACHED
;
7089 /* Otherwise, we can wrap here. */
7096 /* Remember the line height for the current line, in case
7097 the next element doesn't fit on the line. */
7098 ascent
= it
->max_ascent
;
7099 descent
= it
->max_descent
;
7101 /* The call to produce_glyphs will get the metrics of the
7102 display element IT is loaded with. Record the x-position
7103 before this display element, in case it doesn't fit on the
7107 PRODUCE_GLYPHS (it
);
7109 if (it
->area
!= TEXT_AREA
)
7111 set_iterator_to_next (it
, 1);
7112 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7113 SET_TEXT_POS (this_line_min_pos
,
7114 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7118 /* The number of glyphs we get back in IT->nglyphs will normally
7119 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7120 character on a terminal frame, or (iii) a line end. For the
7121 second case, IT->nglyphs - 1 padding glyphs will be present.
7122 (On X frames, there is only one glyph produced for a
7123 composite character.)
7125 The behavior implemented below means, for continuation lines,
7126 that as many spaces of a TAB as fit on the current line are
7127 displayed there. For terminal frames, as many glyphs of a
7128 multi-glyph character are displayed in the current line, too.
7129 This is what the old redisplay code did, and we keep it that
7130 way. Under X, the whole shape of a complex character must
7131 fit on the line or it will be completely displayed in the
7134 Note that both for tabs and padding glyphs, all glyphs have
7138 /* More than one glyph or glyph doesn't fit on line. All
7139 glyphs have the same width. */
7140 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7142 int x_before_this_char
= x
;
7143 int hpos_before_this_char
= it
->hpos
;
7145 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7147 new_x
= x
+ single_glyph_width
;
7149 /* We want to leave anything reaching TO_X to the caller. */
7150 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7152 if (BUFFER_POS_REACHED_P ())
7154 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7155 goto buffer_pos_reached
;
7156 if (atpos_it
.sp
< 0)
7159 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7164 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7167 result
= MOVE_X_REACHED
;
7173 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7178 if (/* Lines are continued. */
7179 it
->line_wrap
!= TRUNCATE
7180 && (/* And glyph doesn't fit on the line. */
7181 new_x
> it
->last_visible_x
7182 /* Or it fits exactly and we're on a window
7184 || (new_x
== it
->last_visible_x
7185 && FRAME_WINDOW_P (it
->f
))))
7187 if (/* IT->hpos == 0 means the very first glyph
7188 doesn't fit on the line, e.g. a wide image. */
7190 || (new_x
== it
->last_visible_x
7191 && FRAME_WINDOW_P (it
->f
)))
7194 it
->current_x
= new_x
;
7196 /* The character's last glyph just barely fits
7198 if (i
== it
->nglyphs
- 1)
7200 /* If this is the destination position,
7201 return a position *before* it in this row,
7202 now that we know it fits in this row. */
7203 if (BUFFER_POS_REACHED_P ())
7205 if (it
->line_wrap
!= WORD_WRAP
7208 it
->hpos
= hpos_before_this_char
;
7209 it
->current_x
= x_before_this_char
;
7210 result
= MOVE_POS_MATCH_OR_ZV
;
7213 if (it
->line_wrap
== WORD_WRAP
7217 atpos_it
.current_x
= x_before_this_char
;
7218 atpos_it
.hpos
= hpos_before_this_char
;
7222 set_iterator_to_next (it
, 1);
7223 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7224 SET_TEXT_POS (this_line_min_pos
,
7225 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7226 /* On graphical terminals, newlines may
7227 "overflow" into the fringe if
7228 overflow-newline-into-fringe is non-nil.
7229 On text-only terminals, newlines may
7230 overflow into the last glyph on the
7232 if (!FRAME_WINDOW_P (it
->f
)
7233 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7235 if (!get_next_display_element (it
))
7237 result
= MOVE_POS_MATCH_OR_ZV
;
7240 if (BUFFER_POS_REACHED_P ())
7242 if (ITERATOR_AT_END_OF_LINE_P (it
))
7243 result
= MOVE_POS_MATCH_OR_ZV
;
7245 result
= MOVE_LINE_CONTINUED
;
7248 if (ITERATOR_AT_END_OF_LINE_P (it
))
7250 result
= MOVE_NEWLINE_OR_CR
;
7257 IT_RESET_X_ASCENT_DESCENT (it
);
7259 if (wrap_it
.sp
>= 0)
7266 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7268 result
= MOVE_LINE_CONTINUED
;
7272 if (BUFFER_POS_REACHED_P ())
7274 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7275 goto buffer_pos_reached
;
7276 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7279 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7283 if (new_x
> it
->first_visible_x
)
7285 /* Glyph is visible. Increment number of glyphs that
7286 would be displayed. */
7291 if (result
!= MOVE_UNDEFINED
)
7294 else if (BUFFER_POS_REACHED_P ())
7297 IT_RESET_X_ASCENT_DESCENT (it
);
7298 result
= MOVE_POS_MATCH_OR_ZV
;
7301 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7303 /* Stop when TO_X specified and reached. This check is
7304 necessary here because of lines consisting of a line end,
7305 only. The line end will not produce any glyphs and we
7306 would never get MOVE_X_REACHED. */
7307 xassert (it
->nglyphs
== 0);
7308 result
= MOVE_X_REACHED
;
7312 /* Is this a line end? If yes, we're done. */
7313 if (ITERATOR_AT_END_OF_LINE_P (it
))
7315 result
= MOVE_NEWLINE_OR_CR
;
7319 if (it
->method
== GET_FROM_BUFFER
)
7320 prev_pos
= IT_CHARPOS (*it
);
7321 /* The current display element has been consumed. Advance
7323 set_iterator_to_next (it
, 1);
7324 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7325 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7327 /* Stop if lines are truncated and IT's current x-position is
7328 past the right edge of the window now. */
7329 if (it
->line_wrap
== TRUNCATE
7330 && it
->current_x
>= it
->last_visible_x
)
7332 if (!FRAME_WINDOW_P (it
->f
)
7333 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7335 if (!get_next_display_element (it
)
7336 || BUFFER_POS_REACHED_P ())
7338 result
= MOVE_POS_MATCH_OR_ZV
;
7341 if (ITERATOR_AT_END_OF_LINE_P (it
))
7343 result
= MOVE_NEWLINE_OR_CR
;
7347 result
= MOVE_LINE_TRUNCATED
;
7350 #undef IT_RESET_X_ASCENT_DESCENT
7353 #undef BUFFER_POS_REACHED_P
7355 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7356 restore the saved iterator. */
7357 if (atpos_it
.sp
>= 0)
7359 else if (atx_it
.sp
>= 0)
7364 /* Restore the iterator settings altered at the beginning of this
7366 it
->glyph_row
= saved_glyph_row
;
7370 /* For external use. */
7372 move_it_in_display_line (struct it
*it
,
7373 EMACS_INT to_charpos
, int to_x
,
7374 enum move_operation_enum op
)
7376 if (it
->line_wrap
== WORD_WRAP
7377 && (op
& MOVE_TO_X
))
7379 struct it save_it
= *it
;
7380 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7381 /* When word-wrap is on, TO_X may lie past the end
7382 of a wrapped line. Then it->current is the
7383 character on the next line, so backtrack to the
7384 space before the wrap point. */
7385 if (skip
== MOVE_LINE_CONTINUED
)
7387 int prev_x
= max (it
->current_x
- 1, 0);
7389 move_it_in_display_line_to
7390 (it
, -1, prev_x
, MOVE_TO_X
);
7394 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7398 /* Move IT forward until it satisfies one or more of the criteria in
7399 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7401 OP is a bit-mask that specifies where to stop, and in particular,
7402 which of those four position arguments makes a difference. See the
7403 description of enum move_operation_enum.
7405 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7406 screen line, this function will set IT to the next position >
7410 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7412 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7413 int line_height
, line_start_x
= 0, reached
= 0;
7417 if (op
& MOVE_TO_VPOS
)
7419 /* If no TO_CHARPOS and no TO_X specified, stop at the
7420 start of the line TO_VPOS. */
7421 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7423 if (it
->vpos
== to_vpos
)
7429 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7433 /* TO_VPOS >= 0 means stop at TO_X in the line at
7434 TO_VPOS, or at TO_POS, whichever comes first. */
7435 if (it
->vpos
== to_vpos
)
7441 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7443 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7448 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7450 /* We have reached TO_X but not in the line we want. */
7451 skip
= move_it_in_display_line_to (it
, to_charpos
,
7453 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7461 else if (op
& MOVE_TO_Y
)
7463 struct it it_backup
;
7465 if (it
->line_wrap
== WORD_WRAP
)
7468 /* TO_Y specified means stop at TO_X in the line containing
7469 TO_Y---or at TO_CHARPOS if this is reached first. The
7470 problem is that we can't really tell whether the line
7471 contains TO_Y before we have completely scanned it, and
7472 this may skip past TO_X. What we do is to first scan to
7475 If TO_X is not specified, use a TO_X of zero. The reason
7476 is to make the outcome of this function more predictable.
7477 If we didn't use TO_X == 0, we would stop at the end of
7478 the line which is probably not what a caller would expect
7480 skip
= move_it_in_display_line_to
7481 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7482 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7484 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7485 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7487 else if (skip
== MOVE_X_REACHED
)
7489 /* If TO_X was reached, we want to know whether TO_Y is
7490 in the line. We know this is the case if the already
7491 scanned glyphs make the line tall enough. Otherwise,
7492 we must check by scanning the rest of the line. */
7493 line_height
= it
->max_ascent
+ it
->max_descent
;
7494 if (to_y
>= it
->current_y
7495 && to_y
< it
->current_y
+ line_height
)
7501 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7502 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7504 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7505 line_height
= it
->max_ascent
+ it
->max_descent
;
7506 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7508 if (to_y
>= it
->current_y
7509 && to_y
< it
->current_y
+ line_height
)
7511 /* If TO_Y is in this line and TO_X was reached
7512 above, we scanned too far. We have to restore
7513 IT's settings to the ones before skipping. */
7520 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7526 /* Check whether TO_Y is in this line. */
7527 line_height
= it
->max_ascent
+ it
->max_descent
;
7528 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7530 if (to_y
>= it
->current_y
7531 && to_y
< it
->current_y
+ line_height
)
7533 /* When word-wrap is on, TO_X may lie past the end
7534 of a wrapped line. Then it->current is the
7535 character on the next line, so backtrack to the
7536 space before the wrap point. */
7537 if (skip
== MOVE_LINE_CONTINUED
7538 && it
->line_wrap
== WORD_WRAP
)
7540 int prev_x
= max (it
->current_x
- 1, 0);
7542 skip
= move_it_in_display_line_to
7543 (it
, -1, prev_x
, MOVE_TO_X
);
7552 else if (BUFFERP (it
->object
)
7553 && (it
->method
== GET_FROM_BUFFER
7554 || it
->method
== GET_FROM_STRETCH
)
7555 && IT_CHARPOS (*it
) >= to_charpos
)
7556 skip
= MOVE_POS_MATCH_OR_ZV
;
7558 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7562 case MOVE_POS_MATCH_OR_ZV
:
7566 case MOVE_NEWLINE_OR_CR
:
7567 set_iterator_to_next (it
, 1);
7568 it
->continuation_lines_width
= 0;
7571 case MOVE_LINE_TRUNCATED
:
7572 it
->continuation_lines_width
= 0;
7573 reseat_at_next_visible_line_start (it
, 0);
7574 if ((op
& MOVE_TO_POS
) != 0
7575 && IT_CHARPOS (*it
) > to_charpos
)
7582 case MOVE_LINE_CONTINUED
:
7583 /* For continued lines ending in a tab, some of the glyphs
7584 associated with the tab are displayed on the current
7585 line. Since it->current_x does not include these glyphs,
7586 we use it->last_visible_x instead. */
7589 it
->continuation_lines_width
+= it
->last_visible_x
;
7590 /* When moving by vpos, ensure that the iterator really
7591 advances to the next line (bug#847, bug#969). Fixme:
7592 do we need to do this in other circumstances? */
7593 if (it
->current_x
!= it
->last_visible_x
7594 && (op
& MOVE_TO_VPOS
)
7595 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7597 line_start_x
= it
->current_x
+ it
->pixel_width
7598 - it
->last_visible_x
;
7599 set_iterator_to_next (it
, 0);
7603 it
->continuation_lines_width
+= it
->current_x
;
7610 /* Reset/increment for the next run. */
7611 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7612 it
->current_x
= line_start_x
;
7615 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7617 last_height
= it
->max_ascent
+ it
->max_descent
;
7618 last_max_ascent
= it
->max_ascent
;
7619 it
->max_ascent
= it
->max_descent
= 0;
7624 /* On text terminals, we may stop at the end of a line in the middle
7625 of a multi-character glyph. If the glyph itself is continued,
7626 i.e. it is actually displayed on the next line, don't treat this
7627 stopping point as valid; move to the next line instead (unless
7628 that brings us offscreen). */
7629 if (!FRAME_WINDOW_P (it
->f
)
7631 && IT_CHARPOS (*it
) == to_charpos
7632 && it
->what
== IT_CHARACTER
7634 && it
->line_wrap
== WINDOW_WRAP
7635 && it
->current_x
== it
->last_visible_x
- 1
7638 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7640 it
->continuation_lines_width
+= it
->current_x
;
7641 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7642 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7644 last_height
= it
->max_ascent
+ it
->max_descent
;
7645 last_max_ascent
= it
->max_ascent
;
7648 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7652 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7654 If DY > 0, move IT backward at least that many pixels. DY = 0
7655 means move IT backward to the preceding line start or BEGV. This
7656 function may move over more than DY pixels if IT->current_y - DY
7657 ends up in the middle of a line; in this case IT->current_y will be
7658 set to the top of the line moved to. */
7661 move_it_vertically_backward (struct it
*it
, int dy
)
7665 EMACS_INT start_pos
;
7670 start_pos
= IT_CHARPOS (*it
);
7672 /* Estimate how many newlines we must move back. */
7673 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7675 /* Set the iterator's position that many lines back. */
7676 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7677 back_to_previous_visible_line_start (it
);
7679 /* Reseat the iterator here. When moving backward, we don't want
7680 reseat to skip forward over invisible text, set up the iterator
7681 to deliver from overlay strings at the new position etc. So,
7682 use reseat_1 here. */
7683 reseat_1 (it
, it
->current
.pos
, 1);
7685 /* We are now surely at a line start. */
7686 it
->current_x
= it
->hpos
= 0;
7687 it
->continuation_lines_width
= 0;
7689 /* Move forward and see what y-distance we moved. First move to the
7690 start of the next line so that we get its height. We need this
7691 height to be able to tell whether we reached the specified
7694 it2
.max_ascent
= it2
.max_descent
= 0;
7697 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7698 MOVE_TO_POS
| MOVE_TO_VPOS
);
7700 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7701 xassert (IT_CHARPOS (*it
) >= BEGV
);
7704 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7705 xassert (IT_CHARPOS (*it
) >= BEGV
);
7706 /* H is the actual vertical distance from the position in *IT
7707 and the starting position. */
7708 h
= it2
.current_y
- it
->current_y
;
7709 /* NLINES is the distance in number of lines. */
7710 nlines
= it2
.vpos
- it
->vpos
;
7712 /* Correct IT's y and vpos position
7713 so that they are relative to the starting point. */
7719 /* DY == 0 means move to the start of the screen line. The
7720 value of nlines is > 0 if continuation lines were involved. */
7722 move_it_by_lines (it
, nlines
);
7726 /* The y-position we try to reach, relative to *IT.
7727 Note that H has been subtracted in front of the if-statement. */
7728 int target_y
= it
->current_y
+ h
- dy
;
7729 int y0
= it3
.current_y
;
7730 int y1
= line_bottom_y (&it3
);
7731 int line_height
= y1
- y0
;
7733 /* If we did not reach target_y, try to move further backward if
7734 we can. If we moved too far backward, try to move forward. */
7735 if (target_y
< it
->current_y
7736 /* This is heuristic. In a window that's 3 lines high, with
7737 a line height of 13 pixels each, recentering with point
7738 on the bottom line will try to move -39/2 = 19 pixels
7739 backward. Try to avoid moving into the first line. */
7740 && (it
->current_y
- target_y
7741 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7742 && IT_CHARPOS (*it
) > BEGV
)
7744 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7745 target_y
- it
->current_y
));
7746 dy
= it
->current_y
- target_y
;
7747 goto move_further_back
;
7749 else if (target_y
>= it
->current_y
+ line_height
7750 && IT_CHARPOS (*it
) < ZV
)
7752 /* Should move forward by at least one line, maybe more.
7754 Note: Calling move_it_by_lines can be expensive on
7755 terminal frames, where compute_motion is used (via
7756 vmotion) to do the job, when there are very long lines
7757 and truncate-lines is nil. That's the reason for
7758 treating terminal frames specially here. */
7760 if (!FRAME_WINDOW_P (it
->f
))
7761 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7766 move_it_by_lines (it
, 1);
7768 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7775 /* Move IT by a specified amount of pixel lines DY. DY negative means
7776 move backwards. DY = 0 means move to start of screen line. At the
7777 end, IT will be on the start of a screen line. */
7780 move_it_vertically (struct it
*it
, int dy
)
7783 move_it_vertically_backward (it
, -dy
);
7786 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7787 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7788 MOVE_TO_POS
| MOVE_TO_Y
);
7789 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7791 /* If buffer ends in ZV without a newline, move to the start of
7792 the line to satisfy the post-condition. */
7793 if (IT_CHARPOS (*it
) == ZV
7795 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7796 move_it_by_lines (it
, 0);
7801 /* Move iterator IT past the end of the text line it is in. */
7804 move_it_past_eol (struct it
*it
)
7806 enum move_it_result rc
;
7808 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7809 if (rc
== MOVE_NEWLINE_OR_CR
)
7810 set_iterator_to_next (it
, 0);
7814 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7815 negative means move up. DVPOS == 0 means move to the start of the
7818 Optimization idea: If we would know that IT->f doesn't use
7819 a face with proportional font, we could be faster for
7820 truncate-lines nil. */
7823 move_it_by_lines (struct it
*it
, int dvpos
)
7826 /* The commented-out optimization uses vmotion on terminals. This
7827 gives bad results, because elements like it->what, on which
7828 callers such as pos_visible_p rely, aren't updated. */
7829 /* struct position pos;
7830 if (!FRAME_WINDOW_P (it->f))
7832 struct text_pos textpos;
7834 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7835 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7836 reseat (it, textpos, 1);
7837 it->vpos += pos.vpos;
7838 it->current_y += pos.vpos;
7844 /* DVPOS == 0 means move to the start of the screen line. */
7845 move_it_vertically_backward (it
, 0);
7846 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7847 /* Let next call to line_bottom_y calculate real line height */
7852 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7853 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7854 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7859 EMACS_INT start_charpos
, i
;
7861 /* Start at the beginning of the screen line containing IT's
7862 position. This may actually move vertically backwards,
7863 in case of overlays, so adjust dvpos accordingly. */
7865 move_it_vertically_backward (it
, 0);
7868 /* Go back -DVPOS visible lines and reseat the iterator there. */
7869 start_charpos
= IT_CHARPOS (*it
);
7870 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7871 back_to_previous_visible_line_start (it
);
7872 reseat (it
, it
->current
.pos
, 1);
7874 /* Move further back if we end up in a string or an image. */
7875 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7877 /* First try to move to start of display line. */
7879 move_it_vertically_backward (it
, 0);
7881 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7883 /* If start of line is still in string or image,
7884 move further back. */
7885 back_to_previous_visible_line_start (it
);
7886 reseat (it
, it
->current
.pos
, 1);
7890 it
->current_x
= it
->hpos
= 0;
7892 /* Above call may have moved too far if continuation lines
7893 are involved. Scan forward and see if it did. */
7895 it2
.vpos
= it2
.current_y
= 0;
7896 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7897 it
->vpos
-= it2
.vpos
;
7898 it
->current_y
-= it2
.current_y
;
7899 it
->current_x
= it
->hpos
= 0;
7901 /* If we moved too far back, move IT some lines forward. */
7902 if (it2
.vpos
> -dvpos
)
7904 int delta
= it2
.vpos
+ dvpos
;
7906 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7907 /* Move back again if we got too far ahead. */
7908 if (IT_CHARPOS (*it
) >= start_charpos
)
7914 /* Return 1 if IT points into the middle of a display vector. */
7917 in_display_vector_p (struct it
*it
)
7919 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7920 && it
->current
.dpvec_index
> 0
7921 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7925 /***********************************************************************
7927 ***********************************************************************/
7930 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7934 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7936 Lisp_Object args
[3];
7937 Lisp_Object msg
, fmt
;
7940 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7943 /* Do nothing if called asynchronously. Inserting text into
7944 a buffer may call after-change-functions and alike and
7945 that would means running Lisp asynchronously. */
7946 if (handling_signal
)
7950 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7952 args
[0] = fmt
= build_string (format
);
7955 msg
= Fformat (3, args
);
7957 len
= SBYTES (msg
) + 1;
7958 SAFE_ALLOCA (buffer
, char *, len
);
7959 memcpy (buffer
, SDATA (msg
), len
);
7961 message_dolog (buffer
, len
- 1, 1, 0);
7968 /* Output a newline in the *Messages* buffer if "needs" one. */
7971 message_log_maybe_newline (void)
7973 if (message_log_need_newline
)
7974 message_dolog ("", 0, 1, 0);
7978 /* Add a string M of length NBYTES to the message log, optionally
7979 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7980 nonzero, means interpret the contents of M as multibyte. This
7981 function calls low-level routines in order to bypass text property
7982 hooks, etc. which might not be safe to run.
7984 This may GC (insert may run before/after change hooks),
7985 so the buffer M must NOT point to a Lisp string. */
7988 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7990 const unsigned char *msg
= (const unsigned char *) m
;
7992 if (!NILP (Vmemory_full
))
7995 if (!NILP (Vmessage_log_max
))
7997 struct buffer
*oldbuf
;
7998 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7999 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8000 EMACS_INT point_at_end
= 0;
8001 EMACS_INT zv_at_end
= 0;
8002 Lisp_Object old_deactivate_mark
, tem
;
8003 struct gcpro gcpro1
;
8005 old_deactivate_mark
= Vdeactivate_mark
;
8006 oldbuf
= current_buffer
;
8007 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8008 BVAR (current_buffer
, undo_list
) = Qt
;
8010 oldpoint
= message_dolog_marker1
;
8011 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8012 oldbegv
= message_dolog_marker2
;
8013 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8014 oldzv
= message_dolog_marker3
;
8015 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8016 GCPRO1 (old_deactivate_mark
);
8024 BEGV_BYTE
= BEG_BYTE
;
8027 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8029 /* Insert the string--maybe converting multibyte to single byte
8030 or vice versa, so that all the text fits the buffer. */
8032 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8038 /* Convert a multibyte string to single-byte
8039 for the *Message* buffer. */
8040 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8042 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8043 work
[0] = (ASCII_CHAR_P (c
)
8045 : multibyte_char_to_unibyte (c
));
8046 insert_1_both (work
, 1, 1, 1, 0, 0);
8049 else if (! multibyte
8050 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8054 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8055 /* Convert a single-byte string to multibyte
8056 for the *Message* buffer. */
8057 for (i
= 0; i
< nbytes
; i
++)
8060 MAKE_CHAR_MULTIBYTE (c
);
8061 char_bytes
= CHAR_STRING (c
, str
);
8062 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8066 insert_1 (m
, nbytes
, 1, 0, 0);
8070 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8072 insert_1 ("\n", 1, 1, 0, 0);
8074 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8076 this_bol_byte
= PT_BYTE
;
8078 /* See if this line duplicates the previous one.
8079 If so, combine duplicates. */
8082 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8084 prev_bol_byte
= PT_BYTE
;
8086 dups
= message_log_check_duplicate (prev_bol_byte
,
8090 del_range_both (prev_bol
, prev_bol_byte
,
8091 this_bol
, this_bol_byte
, 0);
8094 char dupstr
[sizeof " [ times]"
8095 + INT_STRLEN_BOUND (printmax_t
)];
8098 /* If you change this format, don't forget to also
8099 change message_log_check_duplicate. */
8100 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8101 duplen
= strlen (dupstr
);
8102 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8103 insert_1 (dupstr
, duplen
, 1, 0, 1);
8108 /* If we have more than the desired maximum number of lines
8109 in the *Messages* buffer now, delete the oldest ones.
8110 This is safe because we don't have undo in this buffer. */
8112 if (NATNUMP (Vmessage_log_max
))
8114 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8115 -XFASTINT (Vmessage_log_max
) - 1, 0);
8116 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8119 BEGV
= XMARKER (oldbegv
)->charpos
;
8120 BEGV_BYTE
= marker_byte_position (oldbegv
);
8129 ZV
= XMARKER (oldzv
)->charpos
;
8130 ZV_BYTE
= marker_byte_position (oldzv
);
8134 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8136 /* We can't do Fgoto_char (oldpoint) because it will run some
8138 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8139 XMARKER (oldpoint
)->bytepos
);
8142 unchain_marker (XMARKER (oldpoint
));
8143 unchain_marker (XMARKER (oldbegv
));
8144 unchain_marker (XMARKER (oldzv
));
8146 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8147 set_buffer_internal (oldbuf
);
8149 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8150 message_log_need_newline
= !nlflag
;
8151 Vdeactivate_mark
= old_deactivate_mark
;
8156 /* We are at the end of the buffer after just having inserted a newline.
8157 (Note: We depend on the fact we won't be crossing the gap.)
8158 Check to see if the most recent message looks a lot like the previous one.
8159 Return 0 if different, 1 if the new one should just replace it, or a
8160 value N > 1 if we should also append " [N times]". */
8163 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8166 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8168 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8169 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8171 for (i
= 0; i
< len
; i
++)
8173 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8181 if (*p1
++ == ' ' && *p1
++ == '[')
8184 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8185 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8192 /* Display an echo area message M with a specified length of NBYTES
8193 bytes. The string may include null characters. If M is 0, clear
8194 out any existing message, and let the mini-buffer text show
8197 This may GC, so the buffer M must NOT point to a Lisp string. */
8200 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8202 /* First flush out any partial line written with print. */
8203 message_log_maybe_newline ();
8205 message_dolog (m
, nbytes
, 1, multibyte
);
8206 message2_nolog (m
, nbytes
, multibyte
);
8210 /* The non-logging counterpart of message2. */
8213 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8215 struct frame
*sf
= SELECTED_FRAME ();
8216 message_enable_multibyte
= multibyte
;
8218 if (FRAME_INITIAL_P (sf
))
8220 if (noninteractive_need_newline
)
8221 putc ('\n', stderr
);
8222 noninteractive_need_newline
= 0;
8224 fwrite (m
, nbytes
, 1, stderr
);
8225 if (cursor_in_echo_area
== 0)
8226 fprintf (stderr
, "\n");
8229 /* A null message buffer means that the frame hasn't really been
8230 initialized yet. Error messages get reported properly by
8231 cmd_error, so this must be just an informative message; toss it. */
8232 else if (INTERACTIVE
8233 && sf
->glyphs_initialized_p
8234 && FRAME_MESSAGE_BUF (sf
))
8236 Lisp_Object mini_window
;
8239 /* Get the frame containing the mini-buffer
8240 that the selected frame is using. */
8241 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8242 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8244 FRAME_SAMPLE_VISIBILITY (f
);
8245 if (FRAME_VISIBLE_P (sf
)
8246 && ! FRAME_VISIBLE_P (f
))
8247 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8251 set_message (m
, Qnil
, nbytes
, multibyte
);
8252 if (minibuffer_auto_raise
)
8253 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8256 clear_message (1, 1);
8258 do_pending_window_change (0);
8259 echo_area_display (1);
8260 do_pending_window_change (0);
8261 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8262 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8267 /* Display an echo area message M with a specified length of NBYTES
8268 bytes. The string may include null characters. If M is not a
8269 string, clear out any existing message, and let the mini-buffer
8272 This function cancels echoing. */
8275 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8277 struct gcpro gcpro1
;
8280 clear_message (1,1);
8283 /* First flush out any partial line written with print. */
8284 message_log_maybe_newline ();
8290 SAFE_ALLOCA (buffer
, char *, nbytes
);
8291 memcpy (buffer
, SDATA (m
), nbytes
);
8292 message_dolog (buffer
, nbytes
, 1, multibyte
);
8295 message3_nolog (m
, nbytes
, multibyte
);
8301 /* The non-logging version of message3.
8302 This does not cancel echoing, because it is used for echoing.
8303 Perhaps we need to make a separate function for echoing
8304 and make this cancel echoing. */
8307 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8309 struct frame
*sf
= SELECTED_FRAME ();
8310 message_enable_multibyte
= multibyte
;
8312 if (FRAME_INITIAL_P (sf
))
8314 if (noninteractive_need_newline
)
8315 putc ('\n', stderr
);
8316 noninteractive_need_newline
= 0;
8318 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8319 if (cursor_in_echo_area
== 0)
8320 fprintf (stderr
, "\n");
8323 /* A null message buffer means that the frame hasn't really been
8324 initialized yet. Error messages get reported properly by
8325 cmd_error, so this must be just an informative message; toss it. */
8326 else if (INTERACTIVE
8327 && sf
->glyphs_initialized_p
8328 && FRAME_MESSAGE_BUF (sf
))
8330 Lisp_Object mini_window
;
8334 /* Get the frame containing the mini-buffer
8335 that the selected frame is using. */
8336 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8337 frame
= XWINDOW (mini_window
)->frame
;
8340 FRAME_SAMPLE_VISIBILITY (f
);
8341 if (FRAME_VISIBLE_P (sf
)
8342 && !FRAME_VISIBLE_P (f
))
8343 Fmake_frame_visible (frame
);
8345 if (STRINGP (m
) && SCHARS (m
) > 0)
8347 set_message (NULL
, m
, nbytes
, multibyte
);
8348 if (minibuffer_auto_raise
)
8349 Fraise_frame (frame
);
8350 /* Assume we are not echoing.
8351 (If we are, echo_now will override this.) */
8352 echo_message_buffer
= Qnil
;
8355 clear_message (1, 1);
8357 do_pending_window_change (0);
8358 echo_area_display (1);
8359 do_pending_window_change (0);
8360 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8361 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8366 /* Display a null-terminated echo area message M. If M is 0, clear
8367 out any existing message, and let the mini-buffer text show through.
8369 The buffer M must continue to exist until after the echo area gets
8370 cleared or some other message gets displayed there. Do not pass
8371 text that is stored in a Lisp string. Do not pass text in a buffer
8372 that was alloca'd. */
8375 message1 (const char *m
)
8377 message2 (m
, (m
? strlen (m
) : 0), 0);
8381 /* The non-logging counterpart of message1. */
8384 message1_nolog (const char *m
)
8386 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8389 /* Display a message M which contains a single %s
8390 which gets replaced with STRING. */
8393 message_with_string (const char *m
, Lisp_Object string
, int log
)
8395 CHECK_STRING (string
);
8401 if (noninteractive_need_newline
)
8402 putc ('\n', stderr
);
8403 noninteractive_need_newline
= 0;
8404 fprintf (stderr
, m
, SDATA (string
));
8405 if (!cursor_in_echo_area
)
8406 fprintf (stderr
, "\n");
8410 else if (INTERACTIVE
)
8412 /* The frame whose minibuffer we're going to display the message on.
8413 It may be larger than the selected frame, so we need
8414 to use its buffer, not the selected frame's buffer. */
8415 Lisp_Object mini_window
;
8416 struct frame
*f
, *sf
= SELECTED_FRAME ();
8418 /* Get the frame containing the minibuffer
8419 that the selected frame is using. */
8420 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8421 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8423 /* A null message buffer means that the frame hasn't really been
8424 initialized yet. Error messages get reported properly by
8425 cmd_error, so this must be just an informative message; toss it. */
8426 if (FRAME_MESSAGE_BUF (f
))
8428 Lisp_Object args
[2], msg
;
8429 struct gcpro gcpro1
, gcpro2
;
8431 args
[0] = build_string (m
);
8432 args
[1] = msg
= string
;
8433 GCPRO2 (args
[0], msg
);
8436 msg
= Fformat (2, args
);
8439 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8441 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8445 /* Print should start at the beginning of the message
8446 buffer next time. */
8447 message_buf_print
= 0;
8453 /* Dump an informative message to the minibuf. If M is 0, clear out
8454 any existing message, and let the mini-buffer text show through. */
8457 vmessage (const char *m
, va_list ap
)
8463 if (noninteractive_need_newline
)
8464 putc ('\n', stderr
);
8465 noninteractive_need_newline
= 0;
8466 vfprintf (stderr
, m
, ap
);
8467 if (cursor_in_echo_area
== 0)
8468 fprintf (stderr
, "\n");
8472 else if (INTERACTIVE
)
8474 /* The frame whose mini-buffer we're going to display the message
8475 on. It may be larger than the selected frame, so we need to
8476 use its buffer, not the selected frame's buffer. */
8477 Lisp_Object mini_window
;
8478 struct frame
*f
, *sf
= SELECTED_FRAME ();
8480 /* Get the frame containing the mini-buffer
8481 that the selected frame is using. */
8482 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8483 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8485 /* A null message buffer means that the frame hasn't really been
8486 initialized yet. Error messages get reported properly by
8487 cmd_error, so this must be just an informative message; toss
8489 if (FRAME_MESSAGE_BUF (f
))
8495 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8496 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8498 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8503 /* Print should start at the beginning of the message
8504 buffer next time. */
8505 message_buf_print
= 0;
8511 message (const char *m
, ...)
8521 /* The non-logging version of message. */
8524 message_nolog (const char *m
, ...)
8526 Lisp_Object old_log_max
;
8529 old_log_max
= Vmessage_log_max
;
8530 Vmessage_log_max
= Qnil
;
8532 Vmessage_log_max
= old_log_max
;
8538 /* Display the current message in the current mini-buffer. This is
8539 only called from error handlers in process.c, and is not time
8543 update_echo_area (void)
8545 if (!NILP (echo_area_buffer
[0]))
8548 string
= Fcurrent_message ();
8549 message3 (string
, SBYTES (string
),
8550 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8555 /* Make sure echo area buffers in `echo_buffers' are live.
8556 If they aren't, make new ones. */
8559 ensure_echo_area_buffers (void)
8563 for (i
= 0; i
< 2; ++i
)
8564 if (!BUFFERP (echo_buffer
[i
])
8565 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8568 Lisp_Object old_buffer
;
8571 old_buffer
= echo_buffer
[i
];
8572 sprintf (name
, " *Echo Area %d*", i
);
8573 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8574 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8575 /* to force word wrap in echo area -
8576 it was decided to postpone this*/
8577 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8579 for (j
= 0; j
< 2; ++j
)
8580 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8581 echo_area_buffer
[j
] = echo_buffer
[i
];
8586 /* Call FN with args A1..A4 with either the current or last displayed
8587 echo_area_buffer as current buffer.
8589 WHICH zero means use the current message buffer
8590 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8591 from echo_buffer[] and clear it.
8593 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8594 suitable buffer from echo_buffer[] and clear it.
8596 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8597 that the current message becomes the last displayed one, make
8598 choose a suitable buffer for echo_area_buffer[0], and clear it.
8600 Value is what FN returns. */
8603 with_echo_area_buffer (struct window
*w
, int which
,
8604 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8605 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8608 int this_one
, the_other
, clear_buffer_p
, rc
;
8609 int count
= SPECPDL_INDEX ();
8611 /* If buffers aren't live, make new ones. */
8612 ensure_echo_area_buffers ();
8617 this_one
= 0, the_other
= 1;
8619 this_one
= 1, the_other
= 0;
8622 this_one
= 0, the_other
= 1;
8625 /* We need a fresh one in case the current echo buffer equals
8626 the one containing the last displayed echo area message. */
8627 if (!NILP (echo_area_buffer
[this_one
])
8628 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8629 echo_area_buffer
[this_one
] = Qnil
;
8632 /* Choose a suitable buffer from echo_buffer[] is we don't
8634 if (NILP (echo_area_buffer
[this_one
]))
8636 echo_area_buffer
[this_one
]
8637 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8638 ? echo_buffer
[the_other
]
8639 : echo_buffer
[this_one
]);
8643 buffer
= echo_area_buffer
[this_one
];
8645 /* Don't get confused by reusing the buffer used for echoing
8646 for a different purpose. */
8647 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8650 record_unwind_protect (unwind_with_echo_area_buffer
,
8651 with_echo_area_buffer_unwind_data (w
));
8653 /* Make the echo area buffer current. Note that for display
8654 purposes, it is not necessary that the displayed window's buffer
8655 == current_buffer, except for text property lookup. So, let's
8656 only set that buffer temporarily here without doing a full
8657 Fset_window_buffer. We must also change w->pointm, though,
8658 because otherwise an assertions in unshow_buffer fails, and Emacs
8660 set_buffer_internal_1 (XBUFFER (buffer
));
8664 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8667 BVAR (current_buffer
, undo_list
) = Qt
;
8668 BVAR (current_buffer
, read_only
) = Qnil
;
8669 specbind (Qinhibit_read_only
, Qt
);
8670 specbind (Qinhibit_modification_hooks
, Qt
);
8672 if (clear_buffer_p
&& Z
> BEG
)
8675 xassert (BEGV
>= BEG
);
8676 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8678 rc
= fn (a1
, a2
, a3
, a4
);
8680 xassert (BEGV
>= BEG
);
8681 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8683 unbind_to (count
, Qnil
);
8688 /* Save state that should be preserved around the call to the function
8689 FN called in with_echo_area_buffer. */
8692 with_echo_area_buffer_unwind_data (struct window
*w
)
8695 Lisp_Object vector
, tmp
;
8697 /* Reduce consing by keeping one vector in
8698 Vwith_echo_area_save_vector. */
8699 vector
= Vwith_echo_area_save_vector
;
8700 Vwith_echo_area_save_vector
= Qnil
;
8703 vector
= Fmake_vector (make_number (7), Qnil
);
8705 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8706 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8707 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8711 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8712 ASET (vector
, i
, w
->buffer
); ++i
;
8713 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8714 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8719 for (; i
< end
; ++i
)
8720 ASET (vector
, i
, Qnil
);
8723 xassert (i
== ASIZE (vector
));
8728 /* Restore global state from VECTOR which was created by
8729 with_echo_area_buffer_unwind_data. */
8732 unwind_with_echo_area_buffer (Lisp_Object vector
)
8734 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8735 Vdeactivate_mark
= AREF (vector
, 1);
8736 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8738 if (WINDOWP (AREF (vector
, 3)))
8741 Lisp_Object buffer
, charpos
, bytepos
;
8743 w
= XWINDOW (AREF (vector
, 3));
8744 buffer
= AREF (vector
, 4);
8745 charpos
= AREF (vector
, 5);
8746 bytepos
= AREF (vector
, 6);
8749 set_marker_both (w
->pointm
, buffer
,
8750 XFASTINT (charpos
), XFASTINT (bytepos
));
8753 Vwith_echo_area_save_vector
= vector
;
8758 /* Set up the echo area for use by print functions. MULTIBYTE_P
8759 non-zero means we will print multibyte. */
8762 setup_echo_area_for_printing (int multibyte_p
)
8764 /* If we can't find an echo area any more, exit. */
8765 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8768 ensure_echo_area_buffers ();
8770 if (!message_buf_print
)
8772 /* A message has been output since the last time we printed.
8773 Choose a fresh echo area buffer. */
8774 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8775 echo_area_buffer
[0] = echo_buffer
[1];
8777 echo_area_buffer
[0] = echo_buffer
[0];
8779 /* Switch to that buffer and clear it. */
8780 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8781 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8785 int count
= SPECPDL_INDEX ();
8786 specbind (Qinhibit_read_only
, Qt
);
8787 /* Note that undo recording is always disabled. */
8789 unbind_to (count
, Qnil
);
8791 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8793 /* Set up the buffer for the multibyteness we need. */
8795 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8796 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8798 /* Raise the frame containing the echo area. */
8799 if (minibuffer_auto_raise
)
8801 struct frame
*sf
= SELECTED_FRAME ();
8802 Lisp_Object mini_window
;
8803 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8804 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8807 message_log_maybe_newline ();
8808 message_buf_print
= 1;
8812 if (NILP (echo_area_buffer
[0]))
8814 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8815 echo_area_buffer
[0] = echo_buffer
[1];
8817 echo_area_buffer
[0] = echo_buffer
[0];
8820 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8822 /* Someone switched buffers between print requests. */
8823 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8824 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8830 /* Display an echo area message in window W. Value is non-zero if W's
8831 height is changed. If display_last_displayed_message_p is
8832 non-zero, display the message that was last displayed, otherwise
8833 display the current message. */
8836 display_echo_area (struct window
*w
)
8838 int i
, no_message_p
, window_height_changed_p
, count
;
8840 /* Temporarily disable garbage collections while displaying the echo
8841 area. This is done because a GC can print a message itself.
8842 That message would modify the echo area buffer's contents while a
8843 redisplay of the buffer is going on, and seriously confuse
8845 count
= inhibit_garbage_collection ();
8847 /* If there is no message, we must call display_echo_area_1
8848 nevertheless because it resizes the window. But we will have to
8849 reset the echo_area_buffer in question to nil at the end because
8850 with_echo_area_buffer will sets it to an empty buffer. */
8851 i
= display_last_displayed_message_p
? 1 : 0;
8852 no_message_p
= NILP (echo_area_buffer
[i
]);
8854 window_height_changed_p
8855 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8856 display_echo_area_1
,
8857 (intptr_t) w
, Qnil
, 0, 0);
8860 echo_area_buffer
[i
] = Qnil
;
8862 unbind_to (count
, Qnil
);
8863 return window_height_changed_p
;
8867 /* Helper for display_echo_area. Display the current buffer which
8868 contains the current echo area message in window W, a mini-window,
8869 a pointer to which is passed in A1. A2..A4 are currently not used.
8870 Change the height of W so that all of the message is displayed.
8871 Value is non-zero if height of W was changed. */
8874 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8877 struct window
*w
= (struct window
*) i1
;
8879 struct text_pos start
;
8880 int window_height_changed_p
= 0;
8882 /* Do this before displaying, so that we have a large enough glyph
8883 matrix for the display. If we can't get enough space for the
8884 whole text, display the last N lines. That works by setting w->start. */
8885 window_height_changed_p
= resize_mini_window (w
, 0);
8887 /* Use the starting position chosen by resize_mini_window. */
8888 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8891 clear_glyph_matrix (w
->desired_matrix
);
8892 XSETWINDOW (window
, w
);
8893 try_window (window
, start
, 0);
8895 return window_height_changed_p
;
8899 /* Resize the echo area window to exactly the size needed for the
8900 currently displayed message, if there is one. If a mini-buffer
8901 is active, don't shrink it. */
8904 resize_echo_area_exactly (void)
8906 if (BUFFERP (echo_area_buffer
[0])
8907 && WINDOWP (echo_area_window
))
8909 struct window
*w
= XWINDOW (echo_area_window
);
8911 Lisp_Object resize_exactly
;
8913 if (minibuf_level
== 0)
8914 resize_exactly
= Qt
;
8916 resize_exactly
= Qnil
;
8918 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8919 (intptr_t) w
, resize_exactly
,
8923 ++windows_or_buffers_changed
;
8924 ++update_mode_lines
;
8925 redisplay_internal ();
8931 /* Callback function for with_echo_area_buffer, when used from
8932 resize_echo_area_exactly. A1 contains a pointer to the window to
8933 resize, EXACTLY non-nil means resize the mini-window exactly to the
8934 size of the text displayed. A3 and A4 are not used. Value is what
8935 resize_mini_window returns. */
8938 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8941 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8945 /* Resize mini-window W to fit the size of its contents. EXACT_P
8946 means size the window exactly to the size needed. Otherwise, it's
8947 only enlarged until W's buffer is empty.
8949 Set W->start to the right place to begin display. If the whole
8950 contents fit, start at the beginning. Otherwise, start so as
8951 to make the end of the contents appear. This is particularly
8952 important for y-or-n-p, but seems desirable generally.
8954 Value is non-zero if the window height has been changed. */
8957 resize_mini_window (struct window
*w
, int exact_p
)
8959 struct frame
*f
= XFRAME (w
->frame
);
8960 int window_height_changed_p
= 0;
8962 xassert (MINI_WINDOW_P (w
));
8964 /* By default, start display at the beginning. */
8965 set_marker_both (w
->start
, w
->buffer
,
8966 BUF_BEGV (XBUFFER (w
->buffer
)),
8967 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8969 /* Don't resize windows while redisplaying a window; it would
8970 confuse redisplay functions when the size of the window they are
8971 displaying changes from under them. Such a resizing can happen,
8972 for instance, when which-func prints a long message while
8973 we are running fontification-functions. We're running these
8974 functions with safe_call which binds inhibit-redisplay to t. */
8975 if (!NILP (Vinhibit_redisplay
))
8978 /* Nil means don't try to resize. */
8979 if (NILP (Vresize_mini_windows
)
8980 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8983 if (!FRAME_MINIBUF_ONLY_P (f
))
8986 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8987 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8988 int height
, max_height
;
8989 int unit
= FRAME_LINE_HEIGHT (f
);
8990 struct text_pos start
;
8991 struct buffer
*old_current_buffer
= NULL
;
8993 if (current_buffer
!= XBUFFER (w
->buffer
))
8995 old_current_buffer
= current_buffer
;
8996 set_buffer_internal (XBUFFER (w
->buffer
));
8999 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9001 /* Compute the max. number of lines specified by the user. */
9002 if (FLOATP (Vmax_mini_window_height
))
9003 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9004 else if (INTEGERP (Vmax_mini_window_height
))
9005 max_height
= XINT (Vmax_mini_window_height
);
9007 max_height
= total_height
/ 4;
9009 /* Correct that max. height if it's bogus. */
9010 max_height
= max (1, max_height
);
9011 max_height
= min (total_height
, max_height
);
9013 /* Find out the height of the text in the window. */
9014 if (it
.line_wrap
== TRUNCATE
)
9019 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9020 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9021 height
= it
.current_y
+ last_height
;
9023 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9024 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9025 height
= (height
+ unit
- 1) / unit
;
9028 /* Compute a suitable window start. */
9029 if (height
> max_height
)
9031 height
= max_height
;
9032 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9033 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9034 start
= it
.current
.pos
;
9037 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9038 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9040 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9042 /* Let it grow only, until we display an empty message, in which
9043 case the window shrinks again. */
9044 if (height
> WINDOW_TOTAL_LINES (w
))
9046 int old_height
= WINDOW_TOTAL_LINES (w
);
9047 freeze_window_starts (f
, 1);
9048 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9049 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9051 else if (height
< WINDOW_TOTAL_LINES (w
)
9052 && (exact_p
|| BEGV
== ZV
))
9054 int old_height
= WINDOW_TOTAL_LINES (w
);
9055 freeze_window_starts (f
, 0);
9056 shrink_mini_window (w
);
9057 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9062 /* Always resize to exact size needed. */
9063 if (height
> WINDOW_TOTAL_LINES (w
))
9065 int old_height
= WINDOW_TOTAL_LINES (w
);
9066 freeze_window_starts (f
, 1);
9067 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9068 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9070 else if (height
< WINDOW_TOTAL_LINES (w
))
9072 int old_height
= WINDOW_TOTAL_LINES (w
);
9073 freeze_window_starts (f
, 0);
9074 shrink_mini_window (w
);
9078 freeze_window_starts (f
, 1);
9079 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9082 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9086 if (old_current_buffer
)
9087 set_buffer_internal (old_current_buffer
);
9090 return window_height_changed_p
;
9094 /* Value is the current message, a string, or nil if there is no
9098 current_message (void)
9102 if (!BUFFERP (echo_area_buffer
[0]))
9106 with_echo_area_buffer (0, 0, current_message_1
,
9107 (intptr_t) &msg
, Qnil
, 0, 0);
9109 echo_area_buffer
[0] = Qnil
;
9117 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9120 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9123 *msg
= make_buffer_string (BEG
, Z
, 1);
9130 /* Push the current message on Vmessage_stack for later restauration
9131 by restore_message. Value is non-zero if the current message isn't
9132 empty. This is a relatively infrequent operation, so it's not
9133 worth optimizing. */
9139 msg
= current_message ();
9140 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9141 return STRINGP (msg
);
9145 /* Restore message display from the top of Vmessage_stack. */
9148 restore_message (void)
9152 xassert (CONSP (Vmessage_stack
));
9153 msg
= XCAR (Vmessage_stack
);
9155 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9157 message3_nolog (msg
, 0, 0);
9161 /* Handler for record_unwind_protect calling pop_message. */
9164 pop_message_unwind (Lisp_Object dummy
)
9170 /* Pop the top-most entry off Vmessage_stack. */
9175 xassert (CONSP (Vmessage_stack
));
9176 Vmessage_stack
= XCDR (Vmessage_stack
);
9180 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9181 exits. If the stack is not empty, we have a missing pop_message
9185 check_message_stack (void)
9187 if (!NILP (Vmessage_stack
))
9192 /* Truncate to NCHARS what will be displayed in the echo area the next
9193 time we display it---but don't redisplay it now. */
9196 truncate_echo_area (EMACS_INT nchars
)
9199 echo_area_buffer
[0] = Qnil
;
9200 /* A null message buffer means that the frame hasn't really been
9201 initialized yet. Error messages get reported properly by
9202 cmd_error, so this must be just an informative message; toss it. */
9203 else if (!noninteractive
9205 && !NILP (echo_area_buffer
[0]))
9207 struct frame
*sf
= SELECTED_FRAME ();
9208 if (FRAME_MESSAGE_BUF (sf
))
9209 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9214 /* Helper function for truncate_echo_area. Truncate the current
9215 message to at most NCHARS characters. */
9218 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9220 if (BEG
+ nchars
< Z
)
9221 del_range (BEG
+ nchars
, Z
);
9223 echo_area_buffer
[0] = Qnil
;
9228 /* Set the current message to a substring of S or STRING.
9230 If STRING is a Lisp string, set the message to the first NBYTES
9231 bytes from STRING. NBYTES zero means use the whole string. If
9232 STRING is multibyte, the message will be displayed multibyte.
9234 If S is not null, set the message to the first LEN bytes of S. LEN
9235 zero means use the whole string. MULTIBYTE_P non-zero means S is
9236 multibyte. Display the message multibyte in that case.
9238 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9239 to t before calling set_message_1 (which calls insert).
9243 set_message (const char *s
, Lisp_Object string
,
9244 EMACS_INT nbytes
, int multibyte_p
)
9246 message_enable_multibyte
9247 = ((s
&& multibyte_p
)
9248 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9250 with_echo_area_buffer (0, -1, set_message_1
,
9251 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9252 message_buf_print
= 0;
9253 help_echo_showing_p
= 0;
9257 /* Helper function for set_message. Arguments have the same meaning
9258 as there, with A1 corresponding to S and A2 corresponding to STRING
9259 This function is called with the echo area buffer being
9263 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9266 const char *s
= (const char *) i1
;
9267 const unsigned char *msg
= (const unsigned char *) s
;
9268 Lisp_Object string
= a2
;
9270 /* Change multibyteness of the echo buffer appropriately. */
9271 if (message_enable_multibyte
9272 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9273 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9275 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9276 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9277 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9279 /* Insert new message at BEG. */
9280 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9282 if (STRINGP (string
))
9287 nbytes
= SBYTES (string
);
9288 nchars
= string_byte_to_char (string
, nbytes
);
9290 /* This function takes care of single/multibyte conversion. We
9291 just have to ensure that the echo area buffer has the right
9292 setting of enable_multibyte_characters. */
9293 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9298 nbytes
= strlen (s
);
9300 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9302 /* Convert from multi-byte to single-byte. */
9307 /* Convert a multibyte string to single-byte. */
9308 for (i
= 0; i
< nbytes
; i
+= n
)
9310 c
= string_char_and_length (msg
+ i
, &n
);
9311 work
[0] = (ASCII_CHAR_P (c
)
9313 : multibyte_char_to_unibyte (c
));
9314 insert_1_both (work
, 1, 1, 1, 0, 0);
9317 else if (!multibyte_p
9318 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9320 /* Convert from single-byte to multi-byte. */
9323 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9325 /* Convert a single-byte string to multibyte. */
9326 for (i
= 0; i
< nbytes
; i
++)
9329 MAKE_CHAR_MULTIBYTE (c
);
9330 n
= CHAR_STRING (c
, str
);
9331 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9335 insert_1 (s
, nbytes
, 1, 0, 0);
9342 /* Clear messages. CURRENT_P non-zero means clear the current
9343 message. LAST_DISPLAYED_P non-zero means clear the message
9347 clear_message (int current_p
, int last_displayed_p
)
9351 echo_area_buffer
[0] = Qnil
;
9352 message_cleared_p
= 1;
9355 if (last_displayed_p
)
9356 echo_area_buffer
[1] = Qnil
;
9358 message_buf_print
= 0;
9361 /* Clear garbaged frames.
9363 This function is used where the old redisplay called
9364 redraw_garbaged_frames which in turn called redraw_frame which in
9365 turn called clear_frame. The call to clear_frame was a source of
9366 flickering. I believe a clear_frame is not necessary. It should
9367 suffice in the new redisplay to invalidate all current matrices,
9368 and ensure a complete redisplay of all windows. */
9371 clear_garbaged_frames (void)
9375 Lisp_Object tail
, frame
;
9376 int changed_count
= 0;
9378 FOR_EACH_FRAME (tail
, frame
)
9380 struct frame
*f
= XFRAME (frame
);
9382 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9386 Fredraw_frame (frame
);
9387 f
->force_flush_display_p
= 1;
9389 clear_current_matrices (f
);
9398 ++windows_or_buffers_changed
;
9403 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9404 is non-zero update selected_frame. Value is non-zero if the
9405 mini-windows height has been changed. */
9408 echo_area_display (int update_frame_p
)
9410 Lisp_Object mini_window
;
9413 int window_height_changed_p
= 0;
9414 struct frame
*sf
= SELECTED_FRAME ();
9416 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9417 w
= XWINDOW (mini_window
);
9418 f
= XFRAME (WINDOW_FRAME (w
));
9420 /* Don't display if frame is invisible or not yet initialized. */
9421 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9424 #ifdef HAVE_WINDOW_SYSTEM
9425 /* When Emacs starts, selected_frame may be the initial terminal
9426 frame. If we let this through, a message would be displayed on
9428 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9430 #endif /* HAVE_WINDOW_SYSTEM */
9432 /* Redraw garbaged frames. */
9434 clear_garbaged_frames ();
9436 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9438 echo_area_window
= mini_window
;
9439 window_height_changed_p
= display_echo_area (w
);
9440 w
->must_be_updated_p
= 1;
9442 /* Update the display, unless called from redisplay_internal.
9443 Also don't update the screen during redisplay itself. The
9444 update will happen at the end of redisplay, and an update
9445 here could cause confusion. */
9446 if (update_frame_p
&& !redisplaying_p
)
9450 /* If the display update has been interrupted by pending
9451 input, update mode lines in the frame. Due to the
9452 pending input, it might have been that redisplay hasn't
9453 been called, so that mode lines above the echo area are
9454 garbaged. This looks odd, so we prevent it here. */
9455 if (!display_completed
)
9456 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9458 if (window_height_changed_p
9459 /* Don't do this if Emacs is shutting down. Redisplay
9460 needs to run hooks. */
9461 && !NILP (Vrun_hooks
))
9463 /* Must update other windows. Likewise as in other
9464 cases, don't let this update be interrupted by
9466 int count
= SPECPDL_INDEX ();
9467 specbind (Qredisplay_dont_pause
, Qt
);
9468 windows_or_buffers_changed
= 1;
9469 redisplay_internal ();
9470 unbind_to (count
, Qnil
);
9472 else if (FRAME_WINDOW_P (f
) && n
== 0)
9474 /* Window configuration is the same as before.
9475 Can do with a display update of the echo area,
9476 unless we displayed some mode lines. */
9477 update_single_window (w
, 1);
9478 FRAME_RIF (f
)->flush_display (f
);
9481 update_frame (f
, 1, 1);
9483 /* If cursor is in the echo area, make sure that the next
9484 redisplay displays the minibuffer, so that the cursor will
9485 be replaced with what the minibuffer wants. */
9486 if (cursor_in_echo_area
)
9487 ++windows_or_buffers_changed
;
9490 else if (!EQ (mini_window
, selected_window
))
9491 windows_or_buffers_changed
++;
9493 /* Last displayed message is now the current message. */
9494 echo_area_buffer
[1] = echo_area_buffer
[0];
9495 /* Inform read_char that we're not echoing. */
9496 echo_message_buffer
= Qnil
;
9498 /* Prevent redisplay optimization in redisplay_internal by resetting
9499 this_line_start_pos. This is done because the mini-buffer now
9500 displays the message instead of its buffer text. */
9501 if (EQ (mini_window
, selected_window
))
9502 CHARPOS (this_line_start_pos
) = 0;
9504 return window_height_changed_p
;
9509 /***********************************************************************
9510 Mode Lines and Frame Titles
9511 ***********************************************************************/
9513 /* A buffer for constructing non-propertized mode-line strings and
9514 frame titles in it; allocated from the heap in init_xdisp and
9515 resized as needed in store_mode_line_noprop_char. */
9517 static char *mode_line_noprop_buf
;
9519 /* The buffer's end, and a current output position in it. */
9521 static char *mode_line_noprop_buf_end
;
9522 static char *mode_line_noprop_ptr
;
9524 #define MODE_LINE_NOPROP_LEN(start) \
9525 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9528 MODE_LINE_DISPLAY
= 0,
9534 /* Alist that caches the results of :propertize.
9535 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9536 static Lisp_Object mode_line_proptrans_alist
;
9538 /* List of strings making up the mode-line. */
9539 static Lisp_Object mode_line_string_list
;
9541 /* Base face property when building propertized mode line string. */
9542 static Lisp_Object mode_line_string_face
;
9543 static Lisp_Object mode_line_string_face_prop
;
9546 /* Unwind data for mode line strings */
9548 static Lisp_Object Vmode_line_unwind_vector
;
9551 format_mode_line_unwind_data (struct buffer
*obuf
,
9555 Lisp_Object vector
, tmp
;
9557 /* Reduce consing by keeping one vector in
9558 Vwith_echo_area_save_vector. */
9559 vector
= Vmode_line_unwind_vector
;
9560 Vmode_line_unwind_vector
= Qnil
;
9563 vector
= Fmake_vector (make_number (8), Qnil
);
9565 ASET (vector
, 0, make_number (mode_line_target
));
9566 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9567 ASET (vector
, 2, mode_line_string_list
);
9568 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9569 ASET (vector
, 4, mode_line_string_face
);
9570 ASET (vector
, 5, mode_line_string_face_prop
);
9573 XSETBUFFER (tmp
, obuf
);
9576 ASET (vector
, 6, tmp
);
9577 ASET (vector
, 7, owin
);
9583 unwind_format_mode_line (Lisp_Object vector
)
9585 mode_line_target
= XINT (AREF (vector
, 0));
9586 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9587 mode_line_string_list
= AREF (vector
, 2);
9588 if (! EQ (AREF (vector
, 3), Qt
))
9589 mode_line_proptrans_alist
= AREF (vector
, 3);
9590 mode_line_string_face
= AREF (vector
, 4);
9591 mode_line_string_face_prop
= AREF (vector
, 5);
9593 if (!NILP (AREF (vector
, 7)))
9594 /* Select window before buffer, since it may change the buffer. */
9595 Fselect_window (AREF (vector
, 7), Qt
);
9597 if (!NILP (AREF (vector
, 6)))
9599 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9600 ASET (vector
, 6, Qnil
);
9603 Vmode_line_unwind_vector
= vector
;
9608 /* Store a single character C for the frame title in mode_line_noprop_buf.
9609 Re-allocate mode_line_noprop_buf if necessary. */
9612 store_mode_line_noprop_char (char c
)
9614 /* If output position has reached the end of the allocated buffer,
9615 double the buffer's size. */
9616 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9618 int len
= MODE_LINE_NOPROP_LEN (0);
9619 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9620 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9621 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9622 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9625 *mode_line_noprop_ptr
++ = c
;
9629 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9630 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9631 characters that yield more columns than PRECISION; PRECISION <= 0
9632 means copy the whole string. Pad with spaces until FIELD_WIDTH
9633 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9634 pad. Called from display_mode_element when it is used to build a
9638 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9640 const unsigned char *str
= (const unsigned char *) string
;
9642 EMACS_INT dummy
, nbytes
;
9644 /* Copy at most PRECISION chars from STR. */
9645 nbytes
= strlen (string
);
9646 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9648 store_mode_line_noprop_char (*str
++);
9650 /* Fill up with spaces until FIELD_WIDTH reached. */
9651 while (field_width
> 0
9654 store_mode_line_noprop_char (' ');
9661 /***********************************************************************
9663 ***********************************************************************/
9665 #ifdef HAVE_WINDOW_SYSTEM
9667 /* Set the title of FRAME, if it has changed. The title format is
9668 Vicon_title_format if FRAME is iconified, otherwise it is
9669 frame_title_format. */
9672 x_consider_frame_title (Lisp_Object frame
)
9674 struct frame
*f
= XFRAME (frame
);
9676 if (FRAME_WINDOW_P (f
)
9677 || FRAME_MINIBUF_ONLY_P (f
)
9678 || f
->explicit_name
)
9680 /* Do we have more than one visible frame on this X display? */
9687 int count
= SPECPDL_INDEX ();
9689 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9691 Lisp_Object other_frame
= XCAR (tail
);
9692 struct frame
*tf
= XFRAME (other_frame
);
9695 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9696 && !FRAME_MINIBUF_ONLY_P (tf
)
9697 && !EQ (other_frame
, tip_frame
)
9698 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9702 /* Set global variable indicating that multiple frames exist. */
9703 multiple_frames
= CONSP (tail
);
9705 /* Switch to the buffer of selected window of the frame. Set up
9706 mode_line_target so that display_mode_element will output into
9707 mode_line_noprop_buf; then display the title. */
9708 record_unwind_protect (unwind_format_mode_line
,
9709 format_mode_line_unwind_data
9710 (current_buffer
, selected_window
, 0));
9712 Fselect_window (f
->selected_window
, Qt
);
9713 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9714 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9716 mode_line_target
= MODE_LINE_TITLE
;
9717 title_start
= MODE_LINE_NOPROP_LEN (0);
9718 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9719 NULL
, DEFAULT_FACE_ID
);
9720 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9721 len
= MODE_LINE_NOPROP_LEN (title_start
);
9722 title
= mode_line_noprop_buf
+ title_start
;
9723 unbind_to (count
, Qnil
);
9725 /* Set the title only if it's changed. This avoids consing in
9726 the common case where it hasn't. (If it turns out that we've
9727 already wasted too much time by walking through the list with
9728 display_mode_element, then we might need to optimize at a
9729 higher level than this.) */
9730 if (! STRINGP (f
->name
)
9731 || SBYTES (f
->name
) != len
9732 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9733 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9737 #endif /* not HAVE_WINDOW_SYSTEM */
9742 /***********************************************************************
9744 ***********************************************************************/
9747 /* Prepare for redisplay by updating menu-bar item lists when
9748 appropriate. This can call eval. */
9751 prepare_menu_bars (void)
9754 struct gcpro gcpro1
, gcpro2
;
9756 Lisp_Object tooltip_frame
;
9758 #ifdef HAVE_WINDOW_SYSTEM
9759 tooltip_frame
= tip_frame
;
9761 tooltip_frame
= Qnil
;
9764 /* Update all frame titles based on their buffer names, etc. We do
9765 this before the menu bars so that the buffer-menu will show the
9766 up-to-date frame titles. */
9767 #ifdef HAVE_WINDOW_SYSTEM
9768 if (windows_or_buffers_changed
|| update_mode_lines
)
9770 Lisp_Object tail
, frame
;
9772 FOR_EACH_FRAME (tail
, frame
)
9775 if (!EQ (frame
, tooltip_frame
)
9776 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9777 x_consider_frame_title (frame
);
9780 #endif /* HAVE_WINDOW_SYSTEM */
9782 /* Update the menu bar item lists, if appropriate. This has to be
9783 done before any actual redisplay or generation of display lines. */
9784 all_windows
= (update_mode_lines
9785 || buffer_shared
> 1
9786 || windows_or_buffers_changed
);
9789 Lisp_Object tail
, frame
;
9790 int count
= SPECPDL_INDEX ();
9791 /* 1 means that update_menu_bar has run its hooks
9792 so any further calls to update_menu_bar shouldn't do so again. */
9793 int menu_bar_hooks_run
= 0;
9795 record_unwind_save_match_data ();
9797 FOR_EACH_FRAME (tail
, frame
)
9801 /* Ignore tooltip frame. */
9802 if (EQ (frame
, tooltip_frame
))
9805 /* If a window on this frame changed size, report that to
9806 the user and clear the size-change flag. */
9807 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9809 Lisp_Object functions
;
9811 /* Clear flag first in case we get an error below. */
9812 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9813 functions
= Vwindow_size_change_functions
;
9814 GCPRO2 (tail
, functions
);
9816 while (CONSP (functions
))
9818 if (!EQ (XCAR (functions
), Qt
))
9819 call1 (XCAR (functions
), frame
);
9820 functions
= XCDR (functions
);
9826 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9827 #ifdef HAVE_WINDOW_SYSTEM
9828 update_tool_bar (f
, 0);
9831 if (windows_or_buffers_changed
9833 ns_set_doc_edited (f
, Fbuffer_modified_p
9834 (XWINDOW (f
->selected_window
)->buffer
));
9839 unbind_to (count
, Qnil
);
9843 struct frame
*sf
= SELECTED_FRAME ();
9844 update_menu_bar (sf
, 1, 0);
9845 #ifdef HAVE_WINDOW_SYSTEM
9846 update_tool_bar (sf
, 1);
9852 /* Update the menu bar item list for frame F. This has to be done
9853 before we start to fill in any display lines, because it can call
9856 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9858 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9859 already ran the menu bar hooks for this redisplay, so there
9860 is no need to run them again. The return value is the
9861 updated value of this flag, to pass to the next call. */
9864 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9867 register struct window
*w
;
9869 /* If called recursively during a menu update, do nothing. This can
9870 happen when, for instance, an activate-menubar-hook causes a
9872 if (inhibit_menubar_update
)
9875 window
= FRAME_SELECTED_WINDOW (f
);
9876 w
= XWINDOW (window
);
9878 if (FRAME_WINDOW_P (f
)
9880 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9881 || defined (HAVE_NS) || defined (USE_GTK)
9882 FRAME_EXTERNAL_MENU_BAR (f
)
9884 FRAME_MENU_BAR_LINES (f
) > 0
9886 : FRAME_MENU_BAR_LINES (f
) > 0)
9888 /* If the user has switched buffers or windows, we need to
9889 recompute to reflect the new bindings. But we'll
9890 recompute when update_mode_lines is set too; that means
9891 that people can use force-mode-line-update to request
9892 that the menu bar be recomputed. The adverse effect on
9893 the rest of the redisplay algorithm is about the same as
9894 windows_or_buffers_changed anyway. */
9895 if (windows_or_buffers_changed
9896 /* This used to test w->update_mode_line, but we believe
9897 there is no need to recompute the menu in that case. */
9898 || update_mode_lines
9899 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9900 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9901 != !NILP (w
->last_had_star
))
9902 || ((!NILP (Vtransient_mark_mode
)
9903 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9904 != !NILP (w
->region_showing
)))
9906 struct buffer
*prev
= current_buffer
;
9907 int count
= SPECPDL_INDEX ();
9909 specbind (Qinhibit_menubar_update
, Qt
);
9911 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9912 if (save_match_data
)
9913 record_unwind_save_match_data ();
9914 if (NILP (Voverriding_local_map_menu_flag
))
9916 specbind (Qoverriding_terminal_local_map
, Qnil
);
9917 specbind (Qoverriding_local_map
, Qnil
);
9922 /* Run the Lucid hook. */
9923 safe_run_hooks (Qactivate_menubar_hook
);
9925 /* If it has changed current-menubar from previous value,
9926 really recompute the menu-bar from the value. */
9927 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9928 call0 (Qrecompute_lucid_menubar
);
9930 safe_run_hooks (Qmenu_bar_update_hook
);
9935 XSETFRAME (Vmenu_updating_frame
, f
);
9936 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9938 /* Redisplay the menu bar in case we changed it. */
9939 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9940 || defined (HAVE_NS) || defined (USE_GTK)
9941 if (FRAME_WINDOW_P (f
))
9943 #if defined (HAVE_NS)
9944 /* All frames on Mac OS share the same menubar. So only
9945 the selected frame should be allowed to set it. */
9946 if (f
== SELECTED_FRAME ())
9948 set_frame_menubar (f
, 0, 0);
9951 /* On a terminal screen, the menu bar is an ordinary screen
9952 line, and this makes it get updated. */
9953 w
->update_mode_line
= Qt
;
9954 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9955 /* In the non-toolkit version, the menu bar is an ordinary screen
9956 line, and this makes it get updated. */
9957 w
->update_mode_line
= Qt
;
9958 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9960 unbind_to (count
, Qnil
);
9961 set_buffer_internal_1 (prev
);
9970 /***********************************************************************
9972 ***********************************************************************/
9974 #ifdef HAVE_WINDOW_SYSTEM
9977 Nominal cursor position -- where to draw output.
9978 HPOS and VPOS are window relative glyph matrix coordinates.
9979 X and Y are window relative pixel coordinates. */
9981 struct cursor_pos output_cursor
;
9985 Set the global variable output_cursor to CURSOR. All cursor
9986 positions are relative to updated_window. */
9989 set_output_cursor (struct cursor_pos
*cursor
)
9991 output_cursor
.hpos
= cursor
->hpos
;
9992 output_cursor
.vpos
= cursor
->vpos
;
9993 output_cursor
.x
= cursor
->x
;
9994 output_cursor
.y
= cursor
->y
;
9999 Set a nominal cursor position.
10001 HPOS and VPOS are column/row positions in a window glyph matrix. X
10002 and Y are window text area relative pixel positions.
10004 If this is done during an update, updated_window will contain the
10005 window that is being updated and the position is the future output
10006 cursor position for that window. If updated_window is null, use
10007 selected_window and display the cursor at the given position. */
10010 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10014 /* If updated_window is not set, work on selected_window. */
10015 if (updated_window
)
10016 w
= updated_window
;
10018 w
= XWINDOW (selected_window
);
10020 /* Set the output cursor. */
10021 output_cursor
.hpos
= hpos
;
10022 output_cursor
.vpos
= vpos
;
10023 output_cursor
.x
= x
;
10024 output_cursor
.y
= y
;
10026 /* If not called as part of an update, really display the cursor.
10027 This will also set the cursor position of W. */
10028 if (updated_window
== NULL
)
10031 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10032 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10033 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10038 #endif /* HAVE_WINDOW_SYSTEM */
10041 /***********************************************************************
10043 ***********************************************************************/
10045 #ifdef HAVE_WINDOW_SYSTEM
10047 /* Where the mouse was last time we reported a mouse event. */
10049 FRAME_PTR last_mouse_frame
;
10051 /* Tool-bar item index of the item on which a mouse button was pressed
10054 int last_tool_bar_item
;
10058 update_tool_bar_unwind (Lisp_Object frame
)
10060 selected_frame
= frame
;
10064 /* Update the tool-bar item list for frame F. This has to be done
10065 before we start to fill in any display lines. Called from
10066 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10067 and restore it here. */
10070 update_tool_bar (struct frame
*f
, int save_match_data
)
10072 #if defined (USE_GTK) || defined (HAVE_NS)
10073 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10075 int do_update
= WINDOWP (f
->tool_bar_window
)
10076 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10081 Lisp_Object window
;
10084 window
= FRAME_SELECTED_WINDOW (f
);
10085 w
= XWINDOW (window
);
10087 /* If the user has switched buffers or windows, we need to
10088 recompute to reflect the new bindings. But we'll
10089 recompute when update_mode_lines is set too; that means
10090 that people can use force-mode-line-update to request
10091 that the menu bar be recomputed. The adverse effect on
10092 the rest of the redisplay algorithm is about the same as
10093 windows_or_buffers_changed anyway. */
10094 if (windows_or_buffers_changed
10095 || !NILP (w
->update_mode_line
)
10096 || update_mode_lines
10097 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10098 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10099 != !NILP (w
->last_had_star
))
10100 || ((!NILP (Vtransient_mark_mode
)
10101 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10102 != !NILP (w
->region_showing
)))
10104 struct buffer
*prev
= current_buffer
;
10105 int count
= SPECPDL_INDEX ();
10106 Lisp_Object frame
, new_tool_bar
;
10107 int new_n_tool_bar
;
10108 struct gcpro gcpro1
;
10110 /* Set current_buffer to the buffer of the selected
10111 window of the frame, so that we get the right local
10113 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10115 /* Save match data, if we must. */
10116 if (save_match_data
)
10117 record_unwind_save_match_data ();
10119 /* Make sure that we don't accidentally use bogus keymaps. */
10120 if (NILP (Voverriding_local_map_menu_flag
))
10122 specbind (Qoverriding_terminal_local_map
, Qnil
);
10123 specbind (Qoverriding_local_map
, Qnil
);
10126 GCPRO1 (new_tool_bar
);
10128 /* We must temporarily set the selected frame to this frame
10129 before calling tool_bar_items, because the calculation of
10130 the tool-bar keymap uses the selected frame (see
10131 `tool-bar-make-keymap' in tool-bar.el). */
10132 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10133 XSETFRAME (frame
, f
);
10134 selected_frame
= frame
;
10136 /* Build desired tool-bar items from keymaps. */
10137 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10140 /* Redisplay the tool-bar if we changed it. */
10141 if (new_n_tool_bar
!= f
->n_tool_bar_items
10142 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10144 /* Redisplay that happens asynchronously due to an expose event
10145 may access f->tool_bar_items. Make sure we update both
10146 variables within BLOCK_INPUT so no such event interrupts. */
10148 f
->tool_bar_items
= new_tool_bar
;
10149 f
->n_tool_bar_items
= new_n_tool_bar
;
10150 w
->update_mode_line
= Qt
;
10156 unbind_to (count
, Qnil
);
10157 set_buffer_internal_1 (prev
);
10163 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10164 F's desired tool-bar contents. F->tool_bar_items must have
10165 been set up previously by calling prepare_menu_bars. */
10168 build_desired_tool_bar_string (struct frame
*f
)
10170 int i
, size
, size_needed
;
10171 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10172 Lisp_Object image
, plist
, props
;
10174 image
= plist
= props
= Qnil
;
10175 GCPRO3 (image
, plist
, props
);
10177 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10178 Otherwise, make a new string. */
10180 /* The size of the string we might be able to reuse. */
10181 size
= (STRINGP (f
->desired_tool_bar_string
)
10182 ? SCHARS (f
->desired_tool_bar_string
)
10185 /* We need one space in the string for each image. */
10186 size_needed
= f
->n_tool_bar_items
;
10188 /* Reuse f->desired_tool_bar_string, if possible. */
10189 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10190 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10191 make_number (' '));
10194 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10195 Fremove_text_properties (make_number (0), make_number (size
),
10196 props
, f
->desired_tool_bar_string
);
10199 /* Put a `display' property on the string for the images to display,
10200 put a `menu_item' property on tool-bar items with a value that
10201 is the index of the item in F's tool-bar item vector. */
10202 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10204 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10206 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10207 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10208 int hmargin
, vmargin
, relief
, idx
, end
;
10210 /* If image is a vector, choose the image according to the
10212 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10213 if (VECTORP (image
))
10217 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10218 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10221 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10222 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10224 xassert (ASIZE (image
) >= idx
);
10225 image
= AREF (image
, idx
);
10230 /* Ignore invalid image specifications. */
10231 if (!valid_image_p (image
))
10234 /* Display the tool-bar button pressed, or depressed. */
10235 plist
= Fcopy_sequence (XCDR (image
));
10237 /* Compute margin and relief to draw. */
10238 relief
= (tool_bar_button_relief
>= 0
10239 ? tool_bar_button_relief
10240 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10241 hmargin
= vmargin
= relief
;
10243 if (INTEGERP (Vtool_bar_button_margin
)
10244 && XINT (Vtool_bar_button_margin
) > 0)
10246 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10247 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10249 else if (CONSP (Vtool_bar_button_margin
))
10251 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10252 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10253 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10255 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10256 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10257 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10260 if (auto_raise_tool_bar_buttons_p
)
10262 /* Add a `:relief' property to the image spec if the item is
10266 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10273 /* If image is selected, display it pressed, i.e. with a
10274 negative relief. If it's not selected, display it with a
10276 plist
= Fplist_put (plist
, QCrelief
,
10278 ? make_number (-relief
)
10279 : make_number (relief
)));
10284 /* Put a margin around the image. */
10285 if (hmargin
|| vmargin
)
10287 if (hmargin
== vmargin
)
10288 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10290 plist
= Fplist_put (plist
, QCmargin
,
10291 Fcons (make_number (hmargin
),
10292 make_number (vmargin
)));
10295 /* If button is not enabled, and we don't have special images
10296 for the disabled state, make the image appear disabled by
10297 applying an appropriate algorithm to it. */
10298 if (!enabled_p
&& idx
< 0)
10299 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10301 /* Put a `display' text property on the string for the image to
10302 display. Put a `menu-item' property on the string that gives
10303 the start of this item's properties in the tool-bar items
10305 image
= Fcons (Qimage
, plist
);
10306 props
= list4 (Qdisplay
, image
,
10307 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10309 /* Let the last image hide all remaining spaces in the tool bar
10310 string. The string can be longer than needed when we reuse a
10311 previous string. */
10312 if (i
+ 1 == f
->n_tool_bar_items
)
10313 end
= SCHARS (f
->desired_tool_bar_string
);
10316 Fadd_text_properties (make_number (i
), make_number (end
),
10317 props
, f
->desired_tool_bar_string
);
10325 /* Display one line of the tool-bar of frame IT->f.
10327 HEIGHT specifies the desired height of the tool-bar line.
10328 If the actual height of the glyph row is less than HEIGHT, the
10329 row's height is increased to HEIGHT, and the icons are centered
10330 vertically in the new height.
10332 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10333 count a final empty row in case the tool-bar width exactly matches
10338 display_tool_bar_line (struct it
*it
, int height
)
10340 struct glyph_row
*row
= it
->glyph_row
;
10341 int max_x
= it
->last_visible_x
;
10342 struct glyph
*last
;
10344 prepare_desired_row (row
);
10345 row
->y
= it
->current_y
;
10347 /* Note that this isn't made use of if the face hasn't a box,
10348 so there's no need to check the face here. */
10349 it
->start_of_box_run_p
= 1;
10351 while (it
->current_x
< max_x
)
10353 int x
, n_glyphs_before
, i
, nglyphs
;
10354 struct it it_before
;
10356 /* Get the next display element. */
10357 if (!get_next_display_element (it
))
10359 /* Don't count empty row if we are counting needed tool-bar lines. */
10360 if (height
< 0 && !it
->hpos
)
10365 /* Produce glyphs. */
10366 n_glyphs_before
= row
->used
[TEXT_AREA
];
10369 PRODUCE_GLYPHS (it
);
10371 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10373 x
= it_before
.current_x
;
10374 while (i
< nglyphs
)
10376 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10378 if (x
+ glyph
->pixel_width
> max_x
)
10380 /* Glyph doesn't fit on line. Backtrack. */
10381 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10383 /* If this is the only glyph on this line, it will never fit on the
10384 tool-bar, so skip it. But ensure there is at least one glyph,
10385 so we don't accidentally disable the tool-bar. */
10386 if (n_glyphs_before
== 0
10387 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10393 x
+= glyph
->pixel_width
;
10397 /* Stop at line ends. */
10398 if (ITERATOR_AT_END_OF_LINE_P (it
))
10401 set_iterator_to_next (it
, 1);
10406 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10408 /* Use default face for the border below the tool bar.
10410 FIXME: When auto-resize-tool-bars is grow-only, there is
10411 no additional border below the possibly empty tool-bar lines.
10412 So to make the extra empty lines look "normal", we have to
10413 use the tool-bar face for the border too. */
10414 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10415 it
->face_id
= DEFAULT_FACE_ID
;
10417 extend_face_to_end_of_line (it
);
10418 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10419 last
->right_box_line_p
= 1;
10420 if (last
== row
->glyphs
[TEXT_AREA
])
10421 last
->left_box_line_p
= 1;
10423 /* Make line the desired height and center it vertically. */
10424 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10426 /* Don't add more than one line height. */
10427 height
%= FRAME_LINE_HEIGHT (it
->f
);
10428 it
->max_ascent
+= height
/ 2;
10429 it
->max_descent
+= (height
+ 1) / 2;
10432 compute_line_metrics (it
);
10434 /* If line is empty, make it occupy the rest of the tool-bar. */
10435 if (!row
->displays_text_p
)
10437 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10438 row
->visible_height
= row
->height
;
10439 row
->ascent
= row
->phys_ascent
= 0;
10440 row
->extra_line_spacing
= 0;
10443 row
->full_width_p
= 1;
10444 row
->continued_p
= 0;
10445 row
->truncated_on_left_p
= 0;
10446 row
->truncated_on_right_p
= 0;
10448 it
->current_x
= it
->hpos
= 0;
10449 it
->current_y
+= row
->height
;
10455 /* Max tool-bar height. */
10457 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10458 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10460 /* Value is the number of screen lines needed to make all tool-bar
10461 items of frame F visible. The number of actual rows needed is
10462 returned in *N_ROWS if non-NULL. */
10465 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10467 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10469 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10470 the desired matrix, so use (unused) mode-line row as temporary row to
10471 avoid destroying the first tool-bar row. */
10472 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10474 /* Initialize an iterator for iteration over
10475 F->desired_tool_bar_string in the tool-bar window of frame F. */
10476 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10477 it
.first_visible_x
= 0;
10478 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10479 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10481 while (!ITERATOR_AT_END_P (&it
))
10483 clear_glyph_row (temp_row
);
10484 it
.glyph_row
= temp_row
;
10485 display_tool_bar_line (&it
, -1);
10487 clear_glyph_row (temp_row
);
10489 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10491 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10493 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10497 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10499 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10500 (Lisp_Object frame
)
10507 frame
= selected_frame
;
10509 CHECK_FRAME (frame
);
10510 f
= XFRAME (frame
);
10512 if (WINDOWP (f
->tool_bar_window
)
10513 || (w
= XWINDOW (f
->tool_bar_window
),
10514 WINDOW_TOTAL_LINES (w
) > 0))
10516 update_tool_bar (f
, 1);
10517 if (f
->n_tool_bar_items
)
10519 build_desired_tool_bar_string (f
);
10520 nlines
= tool_bar_lines_needed (f
, NULL
);
10524 return make_number (nlines
);
10528 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10529 height should be changed. */
10532 redisplay_tool_bar (struct frame
*f
)
10536 struct glyph_row
*row
;
10538 #if defined (USE_GTK) || defined (HAVE_NS)
10539 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10540 update_frame_tool_bar (f
);
10544 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10545 do anything. This means you must start with tool-bar-lines
10546 non-zero to get the auto-sizing effect. Or in other words, you
10547 can turn off tool-bars by specifying tool-bar-lines zero. */
10548 if (!WINDOWP (f
->tool_bar_window
)
10549 || (w
= XWINDOW (f
->tool_bar_window
),
10550 WINDOW_TOTAL_LINES (w
) == 0))
10553 /* Set up an iterator for the tool-bar window. */
10554 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10555 it
.first_visible_x
= 0;
10556 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10557 row
= it
.glyph_row
;
10559 /* Build a string that represents the contents of the tool-bar. */
10560 build_desired_tool_bar_string (f
);
10561 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10563 if (f
->n_tool_bar_rows
== 0)
10567 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10568 nlines
!= WINDOW_TOTAL_LINES (w
)))
10571 int old_height
= WINDOW_TOTAL_LINES (w
);
10573 XSETFRAME (frame
, f
);
10574 Fmodify_frame_parameters (frame
,
10575 Fcons (Fcons (Qtool_bar_lines
,
10576 make_number (nlines
)),
10578 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10580 clear_glyph_matrix (w
->desired_matrix
);
10581 fonts_changed_p
= 1;
10587 /* Display as many lines as needed to display all tool-bar items. */
10589 if (f
->n_tool_bar_rows
> 0)
10591 int border
, rows
, height
, extra
;
10593 if (INTEGERP (Vtool_bar_border
))
10594 border
= XINT (Vtool_bar_border
);
10595 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10596 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10597 else if (EQ (Vtool_bar_border
, Qborder_width
))
10598 border
= f
->border_width
;
10604 rows
= f
->n_tool_bar_rows
;
10605 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10606 extra
= it
.last_visible_y
- border
- height
* rows
;
10608 while (it
.current_y
< it
.last_visible_y
)
10611 if (extra
> 0 && rows
-- > 0)
10613 h
= (extra
+ rows
- 1) / rows
;
10616 display_tool_bar_line (&it
, height
+ h
);
10621 while (it
.current_y
< it
.last_visible_y
)
10622 display_tool_bar_line (&it
, 0);
10625 /* It doesn't make much sense to try scrolling in the tool-bar
10626 window, so don't do it. */
10627 w
->desired_matrix
->no_scrolling_p
= 1;
10628 w
->must_be_updated_p
= 1;
10630 if (!NILP (Vauto_resize_tool_bars
))
10632 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10633 int change_height_p
= 0;
10635 /* If we couldn't display everything, change the tool-bar's
10636 height if there is room for more. */
10637 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10638 && it
.current_y
< max_tool_bar_height
)
10639 change_height_p
= 1;
10641 row
= it
.glyph_row
- 1;
10643 /* If there are blank lines at the end, except for a partially
10644 visible blank line at the end that is smaller than
10645 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10646 if (!row
->displays_text_p
10647 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10648 change_height_p
= 1;
10650 /* If row displays tool-bar items, but is partially visible,
10651 change the tool-bar's height. */
10652 if (row
->displays_text_p
10653 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10654 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10655 change_height_p
= 1;
10657 /* Resize windows as needed by changing the `tool-bar-lines'
10658 frame parameter. */
10659 if (change_height_p
)
10662 int old_height
= WINDOW_TOTAL_LINES (w
);
10664 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10666 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10667 && !f
->minimize_tool_bar_window_p
)
10668 ? (nlines
> old_height
)
10669 : (nlines
!= old_height
));
10670 f
->minimize_tool_bar_window_p
= 0;
10672 if (change_height_p
)
10674 XSETFRAME (frame
, f
);
10675 Fmodify_frame_parameters (frame
,
10676 Fcons (Fcons (Qtool_bar_lines
,
10677 make_number (nlines
)),
10679 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10681 clear_glyph_matrix (w
->desired_matrix
);
10682 f
->n_tool_bar_rows
= nrows
;
10683 fonts_changed_p
= 1;
10690 f
->minimize_tool_bar_window_p
= 0;
10695 /* Get information about the tool-bar item which is displayed in GLYPH
10696 on frame F. Return in *PROP_IDX the index where tool-bar item
10697 properties start in F->tool_bar_items. Value is zero if
10698 GLYPH doesn't display a tool-bar item. */
10701 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10707 /* This function can be called asynchronously, which means we must
10708 exclude any possibility that Fget_text_property signals an
10710 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10711 charpos
= max (0, charpos
);
10713 /* Get the text property `menu-item' at pos. The value of that
10714 property is the start index of this item's properties in
10715 F->tool_bar_items. */
10716 prop
= Fget_text_property (make_number (charpos
),
10717 Qmenu_item
, f
->current_tool_bar_string
);
10718 if (INTEGERP (prop
))
10720 *prop_idx
= XINT (prop
);
10730 /* Get information about the tool-bar item at position X/Y on frame F.
10731 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10732 the current matrix of the tool-bar window of F, or NULL if not
10733 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10734 item in F->tool_bar_items. Value is
10736 -1 if X/Y is not on a tool-bar item
10737 0 if X/Y is on the same item that was highlighted before.
10741 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10742 int *hpos
, int *vpos
, int *prop_idx
)
10744 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10745 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10748 /* Find the glyph under X/Y. */
10749 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10750 if (*glyph
== NULL
)
10753 /* Get the start of this tool-bar item's properties in
10754 f->tool_bar_items. */
10755 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10758 /* Is mouse on the highlighted item? */
10759 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10760 && *vpos
>= hlinfo
->mouse_face_beg_row
10761 && *vpos
<= hlinfo
->mouse_face_end_row
10762 && (*vpos
> hlinfo
->mouse_face_beg_row
10763 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10764 && (*vpos
< hlinfo
->mouse_face_end_row
10765 || *hpos
< hlinfo
->mouse_face_end_col
10766 || hlinfo
->mouse_face_past_end
))
10774 Handle mouse button event on the tool-bar of frame F, at
10775 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10776 0 for button release. MODIFIERS is event modifiers for button
10780 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10781 unsigned int modifiers
)
10783 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10784 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10785 int hpos
, vpos
, prop_idx
;
10786 struct glyph
*glyph
;
10787 Lisp_Object enabled_p
;
10789 /* If not on the highlighted tool-bar item, return. */
10790 frame_to_window_pixel_xy (w
, &x
, &y
);
10791 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10794 /* If item is disabled, do nothing. */
10795 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10796 if (NILP (enabled_p
))
10801 /* Show item in pressed state. */
10802 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10803 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10804 last_tool_bar_item
= prop_idx
;
10808 Lisp_Object key
, frame
;
10809 struct input_event event
;
10810 EVENT_INIT (event
);
10812 /* Show item in released state. */
10813 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10814 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10816 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10818 XSETFRAME (frame
, f
);
10819 event
.kind
= TOOL_BAR_EVENT
;
10820 event
.frame_or_window
= frame
;
10822 kbd_buffer_store_event (&event
);
10824 event
.kind
= TOOL_BAR_EVENT
;
10825 event
.frame_or_window
= frame
;
10827 event
.modifiers
= modifiers
;
10828 kbd_buffer_store_event (&event
);
10829 last_tool_bar_item
= -1;
10834 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10835 tool-bar window-relative coordinates X/Y. Called from
10836 note_mouse_highlight. */
10839 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10841 Lisp_Object window
= f
->tool_bar_window
;
10842 struct window
*w
= XWINDOW (window
);
10843 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10844 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10846 struct glyph
*glyph
;
10847 struct glyph_row
*row
;
10849 Lisp_Object enabled_p
;
10851 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10852 int mouse_down_p
, rc
;
10854 /* Function note_mouse_highlight is called with negative X/Y
10855 values when mouse moves outside of the frame. */
10856 if (x
<= 0 || y
<= 0)
10858 clear_mouse_face (hlinfo
);
10862 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10865 /* Not on tool-bar item. */
10866 clear_mouse_face (hlinfo
);
10870 /* On same tool-bar item as before. */
10871 goto set_help_echo
;
10873 clear_mouse_face (hlinfo
);
10875 /* Mouse is down, but on different tool-bar item? */
10876 mouse_down_p
= (dpyinfo
->grabbed
10877 && f
== last_mouse_frame
10878 && FRAME_LIVE_P (f
));
10880 && last_tool_bar_item
!= prop_idx
)
10883 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10884 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10886 /* If tool-bar item is not enabled, don't highlight it. */
10887 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10888 if (!NILP (enabled_p
))
10890 /* Compute the x-position of the glyph. In front and past the
10891 image is a space. We include this in the highlighted area. */
10892 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10893 for (i
= x
= 0; i
< hpos
; ++i
)
10894 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10896 /* Record this as the current active region. */
10897 hlinfo
->mouse_face_beg_col
= hpos
;
10898 hlinfo
->mouse_face_beg_row
= vpos
;
10899 hlinfo
->mouse_face_beg_x
= x
;
10900 hlinfo
->mouse_face_beg_y
= row
->y
;
10901 hlinfo
->mouse_face_past_end
= 0;
10903 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10904 hlinfo
->mouse_face_end_row
= vpos
;
10905 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10906 hlinfo
->mouse_face_end_y
= row
->y
;
10907 hlinfo
->mouse_face_window
= window
;
10908 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10910 /* Display it as active. */
10911 show_mouse_face (hlinfo
, draw
);
10912 hlinfo
->mouse_face_image_state
= draw
;
10917 /* Set help_echo_string to a help string to display for this tool-bar item.
10918 XTread_socket does the rest. */
10919 help_echo_object
= help_echo_window
= Qnil
;
10920 help_echo_pos
= -1;
10921 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10922 if (NILP (help_echo_string
))
10923 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10926 #endif /* HAVE_WINDOW_SYSTEM */
10930 /************************************************************************
10931 Horizontal scrolling
10932 ************************************************************************/
10934 static int hscroll_window_tree (Lisp_Object
);
10935 static int hscroll_windows (Lisp_Object
);
10937 /* For all leaf windows in the window tree rooted at WINDOW, set their
10938 hscroll value so that PT is (i) visible in the window, and (ii) so
10939 that it is not within a certain margin at the window's left and
10940 right border. Value is non-zero if any window's hscroll has been
10944 hscroll_window_tree (Lisp_Object window
)
10946 int hscrolled_p
= 0;
10947 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10948 int hscroll_step_abs
= 0;
10949 double hscroll_step_rel
= 0;
10951 if (hscroll_relative_p
)
10953 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10954 if (hscroll_step_rel
< 0)
10956 hscroll_relative_p
= 0;
10957 hscroll_step_abs
= 0;
10960 else if (INTEGERP (Vhscroll_step
))
10962 hscroll_step_abs
= XINT (Vhscroll_step
);
10963 if (hscroll_step_abs
< 0)
10964 hscroll_step_abs
= 0;
10967 hscroll_step_abs
= 0;
10969 while (WINDOWP (window
))
10971 struct window
*w
= XWINDOW (window
);
10973 if (WINDOWP (w
->hchild
))
10974 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10975 else if (WINDOWP (w
->vchild
))
10976 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10977 else if (w
->cursor
.vpos
>= 0)
10980 int text_area_width
;
10981 struct glyph_row
*current_cursor_row
10982 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10983 struct glyph_row
*desired_cursor_row
10984 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10985 struct glyph_row
*cursor_row
10986 = (desired_cursor_row
->enabled_p
10987 ? desired_cursor_row
10988 : current_cursor_row
);
10990 text_area_width
= window_box_width (w
, TEXT_AREA
);
10992 /* Scroll when cursor is inside this scroll margin. */
10993 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10995 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10996 && ((XFASTINT (w
->hscroll
)
10997 && w
->cursor
.x
<= h_margin
)
10998 || (cursor_row
->enabled_p
10999 && cursor_row
->truncated_on_right_p
11000 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11004 struct buffer
*saved_current_buffer
;
11008 /* Find point in a display of infinite width. */
11009 saved_current_buffer
= current_buffer
;
11010 current_buffer
= XBUFFER (w
->buffer
);
11012 if (w
== XWINDOW (selected_window
))
11016 pt
= marker_position (w
->pointm
);
11017 pt
= max (BEGV
, pt
);
11021 /* Move iterator to pt starting at cursor_row->start in
11022 a line with infinite width. */
11023 init_to_row_start (&it
, w
, cursor_row
);
11024 it
.last_visible_x
= INFINITY
;
11025 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11026 current_buffer
= saved_current_buffer
;
11028 /* Position cursor in window. */
11029 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11030 hscroll
= max (0, (it
.current_x
11031 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11032 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11033 : (text_area_width
/ 2))))
11034 / FRAME_COLUMN_WIDTH (it
.f
);
11035 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11037 if (hscroll_relative_p
)
11038 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11041 wanted_x
= text_area_width
11042 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11045 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11049 if (hscroll_relative_p
)
11050 wanted_x
= text_area_width
* hscroll_step_rel
11053 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11056 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11058 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11060 /* Don't call Fset_window_hscroll if value hasn't
11061 changed because it will prevent redisplay
11063 if (XFASTINT (w
->hscroll
) != hscroll
)
11065 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11066 w
->hscroll
= make_number (hscroll
);
11075 /* Value is non-zero if hscroll of any leaf window has been changed. */
11076 return hscrolled_p
;
11080 /* Set hscroll so that cursor is visible and not inside horizontal
11081 scroll margins for all windows in the tree rooted at WINDOW. See
11082 also hscroll_window_tree above. Value is non-zero if any window's
11083 hscroll has been changed. If it has, desired matrices on the frame
11084 of WINDOW are cleared. */
11087 hscroll_windows (Lisp_Object window
)
11089 int hscrolled_p
= hscroll_window_tree (window
);
11091 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11092 return hscrolled_p
;
11097 /************************************************************************
11099 ************************************************************************/
11101 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11102 to a non-zero value. This is sometimes handy to have in a debugger
11107 /* First and last unchanged row for try_window_id. */
11109 static int debug_first_unchanged_at_end_vpos
;
11110 static int debug_last_unchanged_at_beg_vpos
;
11112 /* Delta vpos and y. */
11114 static int debug_dvpos
, debug_dy
;
11116 /* Delta in characters and bytes for try_window_id. */
11118 static EMACS_INT debug_delta
, debug_delta_bytes
;
11120 /* Values of window_end_pos and window_end_vpos at the end of
11123 static EMACS_INT debug_end_vpos
;
11125 /* Append a string to W->desired_matrix->method. FMT is a printf
11126 format string. If trace_redisplay_p is non-zero also printf the
11127 resulting string to stderr. */
11129 static void debug_method_add (struct window
*, char const *, ...)
11130 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11133 debug_method_add (struct window
*w
, char const *fmt
, ...)
11136 char *method
= w
->desired_matrix
->method
;
11137 int len
= strlen (method
);
11138 int size
= sizeof w
->desired_matrix
->method
;
11139 int remaining
= size
- len
- 1;
11142 va_start (ap
, fmt
);
11143 vsprintf (buffer
, fmt
, ap
);
11145 if (len
&& remaining
)
11148 --remaining
, ++len
;
11151 strncpy (method
+ len
, buffer
, remaining
);
11153 if (trace_redisplay_p
)
11154 fprintf (stderr
, "%p (%s): %s\n",
11156 ((BUFFERP (w
->buffer
)
11157 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11158 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11163 #endif /* GLYPH_DEBUG */
11166 /* Value is non-zero if all changes in window W, which displays
11167 current_buffer, are in the text between START and END. START is a
11168 buffer position, END is given as a distance from Z. Used in
11169 redisplay_internal for display optimization. */
11172 text_outside_line_unchanged_p (struct window
*w
,
11173 EMACS_INT start
, EMACS_INT end
)
11175 int unchanged_p
= 1;
11177 /* If text or overlays have changed, see where. */
11178 if (XFASTINT (w
->last_modified
) < MODIFF
11179 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11181 /* Gap in the line? */
11182 if (GPT
< start
|| Z
- GPT
< end
)
11185 /* Changes start in front of the line, or end after it? */
11187 && (BEG_UNCHANGED
< start
- 1
11188 || END_UNCHANGED
< end
))
11191 /* If selective display, can't optimize if changes start at the
11192 beginning of the line. */
11194 && INTEGERP (BVAR (current_buffer
, selective_display
))
11195 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11196 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11199 /* If there are overlays at the start or end of the line, these
11200 may have overlay strings with newlines in them. A change at
11201 START, for instance, may actually concern the display of such
11202 overlay strings as well, and they are displayed on different
11203 lines. So, quickly rule out this case. (For the future, it
11204 might be desirable to implement something more telling than
11205 just BEG/END_UNCHANGED.) */
11208 if (BEG
+ BEG_UNCHANGED
== start
11209 && overlay_touches_p (start
))
11211 if (END_UNCHANGED
== end
11212 && overlay_touches_p (Z
- end
))
11216 /* Under bidi reordering, adding or deleting a character in the
11217 beginning of a paragraph, before the first strong directional
11218 character, can change the base direction of the paragraph (unless
11219 the buffer specifies a fixed paragraph direction), which will
11220 require to redisplay the whole paragraph. It might be worthwhile
11221 to find the paragraph limits and widen the range of redisplayed
11222 lines to that, but for now just give up this optimization. */
11223 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11224 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11228 return unchanged_p
;
11232 /* Do a frame update, taking possible shortcuts into account. This is
11233 the main external entry point for redisplay.
11235 If the last redisplay displayed an echo area message and that message
11236 is no longer requested, we clear the echo area or bring back the
11237 mini-buffer if that is in use. */
11242 redisplay_internal ();
11247 overlay_arrow_string_or_property (Lisp_Object var
)
11251 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11254 return Voverlay_arrow_string
;
11257 /* Return 1 if there are any overlay-arrows in current_buffer. */
11259 overlay_arrow_in_current_buffer_p (void)
11263 for (vlist
= Voverlay_arrow_variable_list
;
11265 vlist
= XCDR (vlist
))
11267 Lisp_Object var
= XCAR (vlist
);
11270 if (!SYMBOLP (var
))
11272 val
= find_symbol_value (var
);
11274 && current_buffer
== XMARKER (val
)->buffer
)
11281 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11285 overlay_arrows_changed_p (void)
11289 for (vlist
= Voverlay_arrow_variable_list
;
11291 vlist
= XCDR (vlist
))
11293 Lisp_Object var
= XCAR (vlist
);
11294 Lisp_Object val
, pstr
;
11296 if (!SYMBOLP (var
))
11298 val
= find_symbol_value (var
);
11299 if (!MARKERP (val
))
11301 if (! EQ (COERCE_MARKER (val
),
11302 Fget (var
, Qlast_arrow_position
))
11303 || ! (pstr
= overlay_arrow_string_or_property (var
),
11304 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11310 /* Mark overlay arrows to be updated on next redisplay. */
11313 update_overlay_arrows (int up_to_date
)
11317 for (vlist
= Voverlay_arrow_variable_list
;
11319 vlist
= XCDR (vlist
))
11321 Lisp_Object var
= XCAR (vlist
);
11323 if (!SYMBOLP (var
))
11326 if (up_to_date
> 0)
11328 Lisp_Object val
= find_symbol_value (var
);
11329 Fput (var
, Qlast_arrow_position
,
11330 COERCE_MARKER (val
));
11331 Fput (var
, Qlast_arrow_string
,
11332 overlay_arrow_string_or_property (var
));
11334 else if (up_to_date
< 0
11335 || !NILP (Fget (var
, Qlast_arrow_position
)))
11337 Fput (var
, Qlast_arrow_position
, Qt
);
11338 Fput (var
, Qlast_arrow_string
, Qt
);
11344 /* Return overlay arrow string to display at row.
11345 Return integer (bitmap number) for arrow bitmap in left fringe.
11346 Return nil if no overlay arrow. */
11349 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11353 for (vlist
= Voverlay_arrow_variable_list
;
11355 vlist
= XCDR (vlist
))
11357 Lisp_Object var
= XCAR (vlist
);
11360 if (!SYMBOLP (var
))
11363 val
= find_symbol_value (var
);
11366 && current_buffer
== XMARKER (val
)->buffer
11367 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11369 if (FRAME_WINDOW_P (it
->f
)
11370 /* FIXME: if ROW->reversed_p is set, this should test
11371 the right fringe, not the left one. */
11372 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11374 #ifdef HAVE_WINDOW_SYSTEM
11375 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11378 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11379 return make_number (fringe_bitmap
);
11382 return make_number (-1); /* Use default arrow bitmap */
11384 return overlay_arrow_string_or_property (var
);
11391 /* Return 1 if point moved out of or into a composition. Otherwise
11392 return 0. PREV_BUF and PREV_PT are the last point buffer and
11393 position. BUF and PT are the current point buffer and position. */
11396 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11397 struct buffer
*buf
, EMACS_INT pt
)
11399 EMACS_INT start
, end
;
11401 Lisp_Object buffer
;
11403 XSETBUFFER (buffer
, buf
);
11404 /* Check a composition at the last point if point moved within the
11406 if (prev_buf
== buf
)
11409 /* Point didn't move. */
11412 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11413 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11414 && COMPOSITION_VALID_P (start
, end
, prop
)
11415 && start
< prev_pt
&& end
> prev_pt
)
11416 /* The last point was within the composition. Return 1 iff
11417 point moved out of the composition. */
11418 return (pt
<= start
|| pt
>= end
);
11421 /* Check a composition at the current point. */
11422 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11423 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11424 && COMPOSITION_VALID_P (start
, end
, prop
)
11425 && start
< pt
&& end
> pt
);
11429 /* Reconsider the setting of B->clip_changed which is displayed
11433 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11435 if (b
->clip_changed
11436 && !NILP (w
->window_end_valid
)
11437 && w
->current_matrix
->buffer
== b
11438 && w
->current_matrix
->zv
== BUF_ZV (b
)
11439 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11440 b
->clip_changed
= 0;
11442 /* If display wasn't paused, and W is not a tool bar window, see if
11443 point has been moved into or out of a composition. In that case,
11444 we set b->clip_changed to 1 to force updating the screen. If
11445 b->clip_changed has already been set to 1, we can skip this
11447 if (!b
->clip_changed
11448 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11452 if (w
== XWINDOW (selected_window
))
11455 pt
= marker_position (w
->pointm
);
11457 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11458 || pt
!= XINT (w
->last_point
))
11459 && check_point_in_composition (w
->current_matrix
->buffer
,
11460 XINT (w
->last_point
),
11461 XBUFFER (w
->buffer
), pt
))
11462 b
->clip_changed
= 1;
11467 /* Select FRAME to forward the values of frame-local variables into C
11468 variables so that the redisplay routines can access those values
11472 select_frame_for_redisplay (Lisp_Object frame
)
11474 Lisp_Object tail
, tem
;
11475 Lisp_Object old
= selected_frame
;
11476 struct Lisp_Symbol
*sym
;
11478 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11480 selected_frame
= frame
;
11483 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11484 if (CONSP (XCAR (tail
))
11485 && (tem
= XCAR (XCAR (tail
)),
11487 && (sym
= indirect_variable (XSYMBOL (tem
)),
11488 sym
->redirect
== SYMBOL_LOCALIZED
)
11489 && sym
->val
.blv
->frame_local
)
11490 /* Use find_symbol_value rather than Fsymbol_value
11491 to avoid an error if it is void. */
11492 find_symbol_value (tem
);
11493 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11497 #define STOP_POLLING \
11498 do { if (! polling_stopped_here) stop_polling (); \
11499 polling_stopped_here = 1; } while (0)
11501 #define RESUME_POLLING \
11502 do { if (polling_stopped_here) start_polling (); \
11503 polling_stopped_here = 0; } while (0)
11506 /* Perhaps in the future avoid recentering windows if it
11507 is not necessary; currently that causes some problems. */
11510 redisplay_internal (void)
11512 struct window
*w
= XWINDOW (selected_window
);
11516 int must_finish
= 0;
11517 struct text_pos tlbufpos
, tlendpos
;
11518 int number_of_visible_frames
;
11521 int polling_stopped_here
= 0;
11522 Lisp_Object old_frame
= selected_frame
;
11524 /* Non-zero means redisplay has to consider all windows on all
11525 frames. Zero means, only selected_window is considered. */
11526 int consider_all_windows_p
;
11528 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11530 /* No redisplay if running in batch mode or frame is not yet fully
11531 initialized, or redisplay is explicitly turned off by setting
11532 Vinhibit_redisplay. */
11533 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11534 || !NILP (Vinhibit_redisplay
))
11537 /* Don't examine these until after testing Vinhibit_redisplay.
11538 When Emacs is shutting down, perhaps because its connection to
11539 X has dropped, we should not look at them at all. */
11540 fr
= XFRAME (w
->frame
);
11541 sf
= SELECTED_FRAME ();
11543 if (!fr
->glyphs_initialized_p
)
11546 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11547 if (popup_activated ())
11551 /* I don't think this happens but let's be paranoid. */
11552 if (redisplaying_p
)
11555 /* Record a function that resets redisplaying_p to its old value
11556 when we leave this function. */
11557 count
= SPECPDL_INDEX ();
11558 record_unwind_protect (unwind_redisplay
,
11559 Fcons (make_number (redisplaying_p
), selected_frame
));
11561 specbind (Qinhibit_free_realized_faces
, Qnil
);
11564 Lisp_Object tail
, frame
;
11566 FOR_EACH_FRAME (tail
, frame
)
11568 struct frame
*f
= XFRAME (frame
);
11569 f
->already_hscrolled_p
= 0;
11574 /* Remember the currently selected window. */
11577 if (!EQ (old_frame
, selected_frame
)
11578 && FRAME_LIVE_P (XFRAME (old_frame
)))
11579 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11580 selected_frame and selected_window to be temporarily out-of-sync so
11581 when we come back here via `goto retry', we need to resync because we
11582 may need to run Elisp code (via prepare_menu_bars). */
11583 select_frame_for_redisplay (old_frame
);
11586 reconsider_clip_changes (w
, current_buffer
);
11587 last_escape_glyph_frame
= NULL
;
11588 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11589 last_glyphless_glyph_frame
= NULL
;
11590 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11592 /* If new fonts have been loaded that make a glyph matrix adjustment
11593 necessary, do it. */
11594 if (fonts_changed_p
)
11596 adjust_glyphs (NULL
);
11597 ++windows_or_buffers_changed
;
11598 fonts_changed_p
= 0;
11601 /* If face_change_count is non-zero, init_iterator will free all
11602 realized faces, which includes the faces referenced from current
11603 matrices. So, we can't reuse current matrices in this case. */
11604 if (face_change_count
)
11605 ++windows_or_buffers_changed
;
11607 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11608 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11610 /* Since frames on a single ASCII terminal share the same
11611 display area, displaying a different frame means redisplay
11612 the whole thing. */
11613 windows_or_buffers_changed
++;
11614 SET_FRAME_GARBAGED (sf
);
11616 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11618 FRAME_TTY (sf
)->previous_frame
= sf
;
11621 /* Set the visible flags for all frames. Do this before checking
11622 for resized or garbaged frames; they want to know if their frames
11623 are visible. See the comment in frame.h for
11624 FRAME_SAMPLE_VISIBILITY. */
11626 Lisp_Object tail
, frame
;
11628 number_of_visible_frames
= 0;
11630 FOR_EACH_FRAME (tail
, frame
)
11632 struct frame
*f
= XFRAME (frame
);
11634 FRAME_SAMPLE_VISIBILITY (f
);
11635 if (FRAME_VISIBLE_P (f
))
11636 ++number_of_visible_frames
;
11637 clear_desired_matrices (f
);
11641 /* Notice any pending interrupt request to change frame size. */
11642 do_pending_window_change (1);
11644 /* do_pending_window_change could change the selected_window due to
11645 frame resizing which makes the selected window too small. */
11646 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11649 reconsider_clip_changes (w
, current_buffer
);
11652 /* Clear frames marked as garbaged. */
11653 if (frame_garbaged
)
11654 clear_garbaged_frames ();
11656 /* Build menubar and tool-bar items. */
11657 if (NILP (Vmemory_full
))
11658 prepare_menu_bars ();
11660 if (windows_or_buffers_changed
)
11661 update_mode_lines
++;
11663 /* Detect case that we need to write or remove a star in the mode line. */
11664 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11666 w
->update_mode_line
= Qt
;
11667 if (buffer_shared
> 1)
11668 update_mode_lines
++;
11671 /* Avoid invocation of point motion hooks by `current_column' below. */
11672 count1
= SPECPDL_INDEX ();
11673 specbind (Qinhibit_point_motion_hooks
, Qt
);
11675 /* If %c is in the mode line, update it if needed. */
11676 if (!NILP (w
->column_number_displayed
)
11677 /* This alternative quickly identifies a common case
11678 where no change is needed. */
11679 && !(PT
== XFASTINT (w
->last_point
)
11680 && XFASTINT (w
->last_modified
) >= MODIFF
11681 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11682 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11683 w
->update_mode_line
= Qt
;
11685 unbind_to (count1
, Qnil
);
11687 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11689 /* The variable buffer_shared is set in redisplay_window and
11690 indicates that we redisplay a buffer in different windows. See
11692 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11693 || cursor_type_changed
);
11695 /* If specs for an arrow have changed, do thorough redisplay
11696 to ensure we remove any arrow that should no longer exist. */
11697 if (overlay_arrows_changed_p ())
11698 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11700 /* Normally the message* functions will have already displayed and
11701 updated the echo area, but the frame may have been trashed, or
11702 the update may have been preempted, so display the echo area
11703 again here. Checking message_cleared_p captures the case that
11704 the echo area should be cleared. */
11705 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11706 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11707 || (message_cleared_p
11708 && minibuf_level
== 0
11709 /* If the mini-window is currently selected, this means the
11710 echo-area doesn't show through. */
11711 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11713 int window_height_changed_p
= echo_area_display (0);
11716 /* If we don't display the current message, don't clear the
11717 message_cleared_p flag, because, if we did, we wouldn't clear
11718 the echo area in the next redisplay which doesn't preserve
11720 if (!display_last_displayed_message_p
)
11721 message_cleared_p
= 0;
11723 if (fonts_changed_p
)
11725 else if (window_height_changed_p
)
11727 consider_all_windows_p
= 1;
11728 ++update_mode_lines
;
11729 ++windows_or_buffers_changed
;
11731 /* If window configuration was changed, frames may have been
11732 marked garbaged. Clear them or we will experience
11733 surprises wrt scrolling. */
11734 if (frame_garbaged
)
11735 clear_garbaged_frames ();
11738 else if (EQ (selected_window
, minibuf_window
)
11739 && (current_buffer
->clip_changed
11740 || XFASTINT (w
->last_modified
) < MODIFF
11741 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11742 && resize_mini_window (w
, 0))
11744 /* Resized active mini-window to fit the size of what it is
11745 showing if its contents might have changed. */
11747 /* FIXME: this causes all frames to be updated, which seems unnecessary
11748 since only the current frame needs to be considered. This function needs
11749 to be rewritten with two variables, consider_all_windows and
11750 consider_all_frames. */
11751 consider_all_windows_p
= 1;
11752 ++windows_or_buffers_changed
;
11753 ++update_mode_lines
;
11755 /* If window configuration was changed, frames may have been
11756 marked garbaged. Clear them or we will experience
11757 surprises wrt scrolling. */
11758 if (frame_garbaged
)
11759 clear_garbaged_frames ();
11763 /* If showing the region, and mark has changed, we must redisplay
11764 the whole window. The assignment to this_line_start_pos prevents
11765 the optimization directly below this if-statement. */
11766 if (((!NILP (Vtransient_mark_mode
)
11767 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11768 != !NILP (w
->region_showing
))
11769 || (!NILP (w
->region_showing
)
11770 && !EQ (w
->region_showing
,
11771 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11772 CHARPOS (this_line_start_pos
) = 0;
11774 /* Optimize the case that only the line containing the cursor in the
11775 selected window has changed. Variables starting with this_ are
11776 set in display_line and record information about the line
11777 containing the cursor. */
11778 tlbufpos
= this_line_start_pos
;
11779 tlendpos
= this_line_end_pos
;
11780 if (!consider_all_windows_p
11781 && CHARPOS (tlbufpos
) > 0
11782 && NILP (w
->update_mode_line
)
11783 && !current_buffer
->clip_changed
11784 && !current_buffer
->prevent_redisplay_optimizations_p
11785 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11786 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11787 /* Make sure recorded data applies to current buffer, etc. */
11788 && this_line_buffer
== current_buffer
11789 && current_buffer
== XBUFFER (w
->buffer
)
11790 && NILP (w
->force_start
)
11791 && NILP (w
->optional_new_start
)
11792 /* Point must be on the line that we have info recorded about. */
11793 && PT
>= CHARPOS (tlbufpos
)
11794 && PT
<= Z
- CHARPOS (tlendpos
)
11795 /* All text outside that line, including its final newline,
11796 must be unchanged. */
11797 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11798 CHARPOS (tlendpos
)))
11800 if (CHARPOS (tlbufpos
) > BEGV
11801 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11802 && (CHARPOS (tlbufpos
) == ZV
11803 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11804 /* Former continuation line has disappeared by becoming empty. */
11806 else if (XFASTINT (w
->last_modified
) < MODIFF
11807 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11808 || MINI_WINDOW_P (w
))
11810 /* We have to handle the case of continuation around a
11811 wide-column character (see the comment in indent.c around
11814 For instance, in the following case:
11816 -------- Insert --------
11817 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11818 J_I_ ==> J_I_ `^^' are cursors.
11822 As we have to redraw the line above, we cannot use this
11826 int line_height_before
= this_line_pixel_height
;
11828 /* Note that start_display will handle the case that the
11829 line starting at tlbufpos is a continuation line. */
11830 start_display (&it
, w
, tlbufpos
);
11832 /* Implementation note: It this still necessary? */
11833 if (it
.current_x
!= this_line_start_x
)
11836 TRACE ((stderr
, "trying display optimization 1\n"));
11837 w
->cursor
.vpos
= -1;
11838 overlay_arrow_seen
= 0;
11839 it
.vpos
= this_line_vpos
;
11840 it
.current_y
= this_line_y
;
11841 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11842 display_line (&it
);
11844 /* If line contains point, is not continued,
11845 and ends at same distance from eob as before, we win. */
11846 if (w
->cursor
.vpos
>= 0
11847 /* Line is not continued, otherwise this_line_start_pos
11848 would have been set to 0 in display_line. */
11849 && CHARPOS (this_line_start_pos
)
11850 /* Line ends as before. */
11851 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11852 /* Line has same height as before. Otherwise other lines
11853 would have to be shifted up or down. */
11854 && this_line_pixel_height
== line_height_before
)
11856 /* If this is not the window's last line, we must adjust
11857 the charstarts of the lines below. */
11858 if (it
.current_y
< it
.last_visible_y
)
11860 struct glyph_row
*row
11861 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11862 EMACS_INT delta
, delta_bytes
;
11864 /* We used to distinguish between two cases here,
11865 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11866 when the line ends in a newline or the end of the
11867 buffer's accessible portion. But both cases did
11868 the same, so they were collapsed. */
11870 - CHARPOS (tlendpos
)
11871 - MATRIX_ROW_START_CHARPOS (row
));
11872 delta_bytes
= (Z_BYTE
11873 - BYTEPOS (tlendpos
)
11874 - MATRIX_ROW_START_BYTEPOS (row
));
11876 increment_matrix_positions (w
->current_matrix
,
11877 this_line_vpos
+ 1,
11878 w
->current_matrix
->nrows
,
11879 delta
, delta_bytes
);
11882 /* If this row displays text now but previously didn't,
11883 or vice versa, w->window_end_vpos may have to be
11885 if ((it
.glyph_row
- 1)->displays_text_p
)
11887 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11888 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11890 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11891 && this_line_vpos
> 0)
11892 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11893 w
->window_end_valid
= Qnil
;
11895 /* Update hint: No need to try to scroll in update_window. */
11896 w
->desired_matrix
->no_scrolling_p
= 1;
11899 *w
->desired_matrix
->method
= 0;
11900 debug_method_add (w
, "optimization 1");
11902 #ifdef HAVE_WINDOW_SYSTEM
11903 update_window_fringes (w
, 0);
11910 else if (/* Cursor position hasn't changed. */
11911 PT
== XFASTINT (w
->last_point
)
11912 /* Make sure the cursor was last displayed
11913 in this window. Otherwise we have to reposition it. */
11914 && 0 <= w
->cursor
.vpos
11915 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11919 do_pending_window_change (1);
11920 /* If selected_window changed, redisplay again. */
11921 if (WINDOWP (selected_window
)
11922 && (w
= XWINDOW (selected_window
)) != sw
)
11925 /* We used to always goto end_of_redisplay here, but this
11926 isn't enough if we have a blinking cursor. */
11927 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11928 goto end_of_redisplay
;
11932 /* If highlighting the region, or if the cursor is in the echo area,
11933 then we can't just move the cursor. */
11934 else if (! (!NILP (Vtransient_mark_mode
)
11935 && !NILP (BVAR (current_buffer
, mark_active
)))
11936 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11937 || highlight_nonselected_windows
)
11938 && NILP (w
->region_showing
)
11939 && NILP (Vshow_trailing_whitespace
)
11940 && !cursor_in_echo_area
)
11943 struct glyph_row
*row
;
11945 /* Skip from tlbufpos to PT and see where it is. Note that
11946 PT may be in invisible text. If so, we will end at the
11947 next visible position. */
11948 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11949 NULL
, DEFAULT_FACE_ID
);
11950 it
.current_x
= this_line_start_x
;
11951 it
.current_y
= this_line_y
;
11952 it
.vpos
= this_line_vpos
;
11954 /* The call to move_it_to stops in front of PT, but
11955 moves over before-strings. */
11956 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11958 if (it
.vpos
== this_line_vpos
11959 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11962 xassert (this_line_vpos
== it
.vpos
);
11963 xassert (this_line_y
== it
.current_y
);
11964 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11966 *w
->desired_matrix
->method
= 0;
11967 debug_method_add (w
, "optimization 3");
11976 /* Text changed drastically or point moved off of line. */
11977 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11980 CHARPOS (this_line_start_pos
) = 0;
11981 consider_all_windows_p
|= buffer_shared
> 1;
11982 ++clear_face_cache_count
;
11983 #ifdef HAVE_WINDOW_SYSTEM
11984 ++clear_image_cache_count
;
11987 /* Build desired matrices, and update the display. If
11988 consider_all_windows_p is non-zero, do it for all windows on all
11989 frames. Otherwise do it for selected_window, only. */
11991 if (consider_all_windows_p
)
11993 Lisp_Object tail
, frame
;
11995 FOR_EACH_FRAME (tail
, frame
)
11996 XFRAME (frame
)->updated_p
= 0;
11998 /* Recompute # windows showing selected buffer. This will be
11999 incremented each time such a window is displayed. */
12002 FOR_EACH_FRAME (tail
, frame
)
12004 struct frame
*f
= XFRAME (frame
);
12006 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12008 if (! EQ (frame
, selected_frame
))
12009 /* Select the frame, for the sake of frame-local
12011 select_frame_for_redisplay (frame
);
12013 /* Mark all the scroll bars to be removed; we'll redeem
12014 the ones we want when we redisplay their windows. */
12015 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12016 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12018 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12019 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12021 /* The X error handler may have deleted that frame. */
12022 if (!FRAME_LIVE_P (f
))
12025 /* Any scroll bars which redisplay_windows should have
12026 nuked should now go away. */
12027 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12028 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12030 /* If fonts changed, display again. */
12031 /* ??? rms: I suspect it is a mistake to jump all the way
12032 back to retry here. It should just retry this frame. */
12033 if (fonts_changed_p
)
12036 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12038 /* See if we have to hscroll. */
12039 if (!f
->already_hscrolled_p
)
12041 f
->already_hscrolled_p
= 1;
12042 if (hscroll_windows (f
->root_window
))
12046 /* Prevent various kinds of signals during display
12047 update. stdio is not robust about handling
12048 signals, which can cause an apparent I/O
12050 if (interrupt_input
)
12051 unrequest_sigio ();
12054 /* Update the display. */
12055 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12056 pending
|= update_frame (f
, 0, 0);
12062 if (!EQ (old_frame
, selected_frame
)
12063 && FRAME_LIVE_P (XFRAME (old_frame
)))
12064 /* We played a bit fast-and-loose above and allowed selected_frame
12065 and selected_window to be temporarily out-of-sync but let's make
12066 sure this stays contained. */
12067 select_frame_for_redisplay (old_frame
);
12068 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12072 /* Do the mark_window_display_accurate after all windows have
12073 been redisplayed because this call resets flags in buffers
12074 which are needed for proper redisplay. */
12075 FOR_EACH_FRAME (tail
, frame
)
12077 struct frame
*f
= XFRAME (frame
);
12080 mark_window_display_accurate (f
->root_window
, 1);
12081 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12082 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12087 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12089 Lisp_Object mini_window
;
12090 struct frame
*mini_frame
;
12092 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12093 /* Use list_of_error, not Qerror, so that
12094 we catch only errors and don't run the debugger. */
12095 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12097 redisplay_window_error
);
12099 /* Compare desired and current matrices, perform output. */
12102 /* If fonts changed, display again. */
12103 if (fonts_changed_p
)
12106 /* Prevent various kinds of signals during display update.
12107 stdio is not robust about handling signals,
12108 which can cause an apparent I/O error. */
12109 if (interrupt_input
)
12110 unrequest_sigio ();
12113 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12115 if (hscroll_windows (selected_window
))
12118 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12119 pending
= update_frame (sf
, 0, 0);
12122 /* We may have called echo_area_display at the top of this
12123 function. If the echo area is on another frame, that may
12124 have put text on a frame other than the selected one, so the
12125 above call to update_frame would not have caught it. Catch
12127 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12128 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12130 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12132 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12133 pending
|= update_frame (mini_frame
, 0, 0);
12134 if (!pending
&& hscroll_windows (mini_window
))
12139 /* If display was paused because of pending input, make sure we do a
12140 thorough update the next time. */
12143 /* Prevent the optimization at the beginning of
12144 redisplay_internal that tries a single-line update of the
12145 line containing the cursor in the selected window. */
12146 CHARPOS (this_line_start_pos
) = 0;
12148 /* Let the overlay arrow be updated the next time. */
12149 update_overlay_arrows (0);
12151 /* If we pause after scrolling, some rows in the current
12152 matrices of some windows are not valid. */
12153 if (!WINDOW_FULL_WIDTH_P (w
)
12154 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12155 update_mode_lines
= 1;
12159 if (!consider_all_windows_p
)
12161 /* This has already been done above if
12162 consider_all_windows_p is set. */
12163 mark_window_display_accurate_1 (w
, 1);
12165 /* Say overlay arrows are up to date. */
12166 update_overlay_arrows (1);
12168 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12169 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12172 update_mode_lines
= 0;
12173 windows_or_buffers_changed
= 0;
12174 cursor_type_changed
= 0;
12177 /* Start SIGIO interrupts coming again. Having them off during the
12178 code above makes it less likely one will discard output, but not
12179 impossible, since there might be stuff in the system buffer here.
12180 But it is much hairier to try to do anything about that. */
12181 if (interrupt_input
)
12185 /* If a frame has become visible which was not before, redisplay
12186 again, so that we display it. Expose events for such a frame
12187 (which it gets when becoming visible) don't call the parts of
12188 redisplay constructing glyphs, so simply exposing a frame won't
12189 display anything in this case. So, we have to display these
12190 frames here explicitly. */
12193 Lisp_Object tail
, frame
;
12196 FOR_EACH_FRAME (tail
, frame
)
12198 int this_is_visible
= 0;
12200 if (XFRAME (frame
)->visible
)
12201 this_is_visible
= 1;
12202 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12203 if (XFRAME (frame
)->visible
)
12204 this_is_visible
= 1;
12206 if (this_is_visible
)
12210 if (new_count
!= number_of_visible_frames
)
12211 windows_or_buffers_changed
++;
12214 /* Change frame size now if a change is pending. */
12215 do_pending_window_change (1);
12217 /* If we just did a pending size change, or have additional
12218 visible frames, or selected_window changed, redisplay again. */
12219 if ((windows_or_buffers_changed
&& !pending
)
12220 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12223 /* Clear the face and image caches.
12225 We used to do this only if consider_all_windows_p. But the cache
12226 needs to be cleared if a timer creates images in the current
12227 buffer (e.g. the test case in Bug#6230). */
12229 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12231 clear_face_cache (0);
12232 clear_face_cache_count
= 0;
12235 #ifdef HAVE_WINDOW_SYSTEM
12236 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12238 clear_image_caches (Qnil
);
12239 clear_image_cache_count
= 0;
12241 #endif /* HAVE_WINDOW_SYSTEM */
12244 unbind_to (count
, Qnil
);
12249 /* Redisplay, but leave alone any recent echo area message unless
12250 another message has been requested in its place.
12252 This is useful in situations where you need to redisplay but no
12253 user action has occurred, making it inappropriate for the message
12254 area to be cleared. See tracking_off and
12255 wait_reading_process_output for examples of these situations.
12257 FROM_WHERE is an integer saying from where this function was
12258 called. This is useful for debugging. */
12261 redisplay_preserve_echo_area (int from_where
)
12263 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12265 if (!NILP (echo_area_buffer
[1]))
12267 /* We have a previously displayed message, but no current
12268 message. Redisplay the previous message. */
12269 display_last_displayed_message_p
= 1;
12270 redisplay_internal ();
12271 display_last_displayed_message_p
= 0;
12274 redisplay_internal ();
12276 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12277 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12278 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12282 /* Function registered with record_unwind_protect in
12283 redisplay_internal. Reset redisplaying_p to the value it had
12284 before redisplay_internal was called, and clear
12285 prevent_freeing_realized_faces_p. It also selects the previously
12286 selected frame, unless it has been deleted (by an X connection
12287 failure during redisplay, for example). */
12290 unwind_redisplay (Lisp_Object val
)
12292 Lisp_Object old_redisplaying_p
, old_frame
;
12294 old_redisplaying_p
= XCAR (val
);
12295 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12296 old_frame
= XCDR (val
);
12297 if (! EQ (old_frame
, selected_frame
)
12298 && FRAME_LIVE_P (XFRAME (old_frame
)))
12299 select_frame_for_redisplay (old_frame
);
12304 /* Mark the display of window W as accurate or inaccurate. If
12305 ACCURATE_P is non-zero mark display of W as accurate. If
12306 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12307 redisplay_internal is called. */
12310 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12312 if (BUFFERP (w
->buffer
))
12314 struct buffer
*b
= XBUFFER (w
->buffer
);
12317 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12318 w
->last_overlay_modified
12319 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12321 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12325 b
->clip_changed
= 0;
12326 b
->prevent_redisplay_optimizations_p
= 0;
12328 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12329 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12330 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12331 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12333 w
->current_matrix
->buffer
= b
;
12334 w
->current_matrix
->begv
= BUF_BEGV (b
);
12335 w
->current_matrix
->zv
= BUF_ZV (b
);
12337 w
->last_cursor
= w
->cursor
;
12338 w
->last_cursor_off_p
= w
->cursor_off_p
;
12340 if (w
== XWINDOW (selected_window
))
12341 w
->last_point
= make_number (BUF_PT (b
));
12343 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12349 w
->window_end_valid
= w
->buffer
;
12350 w
->update_mode_line
= Qnil
;
12355 /* Mark the display of windows in the window tree rooted at WINDOW as
12356 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12357 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12358 be redisplayed the next time redisplay_internal is called. */
12361 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12365 for (; !NILP (window
); window
= w
->next
)
12367 w
= XWINDOW (window
);
12368 mark_window_display_accurate_1 (w
, accurate_p
);
12370 if (!NILP (w
->vchild
))
12371 mark_window_display_accurate (w
->vchild
, accurate_p
);
12372 if (!NILP (w
->hchild
))
12373 mark_window_display_accurate (w
->hchild
, accurate_p
);
12378 update_overlay_arrows (1);
12382 /* Force a thorough redisplay the next time by setting
12383 last_arrow_position and last_arrow_string to t, which is
12384 unequal to any useful value of Voverlay_arrow_... */
12385 update_overlay_arrows (-1);
12390 /* Return value in display table DP (Lisp_Char_Table *) for character
12391 C. Since a display table doesn't have any parent, we don't have to
12392 follow parent. Do not call this function directly but use the
12393 macro DISP_CHAR_VECTOR. */
12396 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12400 if (ASCII_CHAR_P (c
))
12403 if (SUB_CHAR_TABLE_P (val
))
12404 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12410 XSETCHAR_TABLE (table
, dp
);
12411 val
= char_table_ref (table
, c
);
12420 /***********************************************************************
12422 ***********************************************************************/
12424 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12427 redisplay_windows (Lisp_Object window
)
12429 while (!NILP (window
))
12431 struct window
*w
= XWINDOW (window
);
12433 if (!NILP (w
->hchild
))
12434 redisplay_windows (w
->hchild
);
12435 else if (!NILP (w
->vchild
))
12436 redisplay_windows (w
->vchild
);
12437 else if (!NILP (w
->buffer
))
12439 displayed_buffer
= XBUFFER (w
->buffer
);
12440 /* Use list_of_error, not Qerror, so that
12441 we catch only errors and don't run the debugger. */
12442 internal_condition_case_1 (redisplay_window_0
, window
,
12444 redisplay_window_error
);
12452 redisplay_window_error (Lisp_Object ignore
)
12454 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12459 redisplay_window_0 (Lisp_Object window
)
12461 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12462 redisplay_window (window
, 0);
12467 redisplay_window_1 (Lisp_Object window
)
12469 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12470 redisplay_window (window
, 1);
12475 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12476 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12477 which positions recorded in ROW differ from current buffer
12480 Return 0 if cursor is not on this row, 1 otherwise. */
12483 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12484 struct glyph_matrix
*matrix
,
12485 EMACS_INT delta
, EMACS_INT delta_bytes
,
12488 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12489 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12490 struct glyph
*cursor
= NULL
;
12491 /* The last known character position in row. */
12492 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12494 EMACS_INT pt_old
= PT
- delta
;
12495 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12496 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12497 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12498 /* A glyph beyond the edge of TEXT_AREA which we should never
12500 struct glyph
*glyphs_end
= end
;
12501 /* Non-zero means we've found a match for cursor position, but that
12502 glyph has the avoid_cursor_p flag set. */
12503 int match_with_avoid_cursor
= 0;
12504 /* Non-zero means we've seen at least one glyph that came from a
12506 int string_seen
= 0;
12507 /* Largest and smalles buffer positions seen so far during scan of
12509 EMACS_INT bpos_max
= pos_before
;
12510 EMACS_INT bpos_min
= pos_after
;
12511 /* Last buffer position covered by an overlay string with an integer
12512 `cursor' property. */
12513 EMACS_INT bpos_covered
= 0;
12515 /* Skip over glyphs not having an object at the start and the end of
12516 the row. These are special glyphs like truncation marks on
12517 terminal frames. */
12518 if (row
->displays_text_p
)
12520 if (!row
->reversed_p
)
12523 && INTEGERP (glyph
->object
)
12524 && glyph
->charpos
< 0)
12526 x
+= glyph
->pixel_width
;
12530 && INTEGERP ((end
- 1)->object
)
12531 /* CHARPOS is zero for blanks and stretch glyphs
12532 inserted by extend_face_to_end_of_line. */
12533 && (end
- 1)->charpos
<= 0)
12535 glyph_before
= glyph
- 1;
12542 /* If the glyph row is reversed, we need to process it from back
12543 to front, so swap the edge pointers. */
12544 glyphs_end
= end
= glyph
- 1;
12545 glyph
+= row
->used
[TEXT_AREA
] - 1;
12547 while (glyph
> end
+ 1
12548 && INTEGERP (glyph
->object
)
12549 && glyph
->charpos
< 0)
12552 x
-= glyph
->pixel_width
;
12554 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12556 /* By default, in reversed rows we put the cursor on the
12557 rightmost (first in the reading order) glyph. */
12558 for (g
= end
+ 1; g
< glyph
; g
++)
12559 x
+= g
->pixel_width
;
12561 && INTEGERP ((end
+ 1)->object
)
12562 && (end
+ 1)->charpos
<= 0)
12564 glyph_before
= glyph
+ 1;
12568 else if (row
->reversed_p
)
12570 /* In R2L rows that don't display text, put the cursor on the
12571 rightmost glyph. Case in point: an empty last line that is
12572 part of an R2L paragraph. */
12574 /* Avoid placing the cursor on the last glyph of the row, where
12575 on terminal frames we hold the vertical border between
12576 adjacent windows. */
12577 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12578 && !WINDOW_RIGHTMOST_P (w
)
12579 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12581 x
= -1; /* will be computed below, at label compute_x */
12584 /* Step 1: Try to find the glyph whose character position
12585 corresponds to point. If that's not possible, find 2 glyphs
12586 whose character positions are the closest to point, one before
12587 point, the other after it. */
12588 if (!row
->reversed_p
)
12589 while (/* not marched to end of glyph row */
12591 /* glyph was not inserted by redisplay for internal purposes */
12592 && !INTEGERP (glyph
->object
))
12594 if (BUFFERP (glyph
->object
))
12596 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12598 if (glyph
->charpos
> bpos_max
)
12599 bpos_max
= glyph
->charpos
;
12600 if (glyph
->charpos
< bpos_min
)
12601 bpos_min
= glyph
->charpos
;
12602 if (!glyph
->avoid_cursor_p
)
12604 /* If we hit point, we've found the glyph on which to
12605 display the cursor. */
12608 match_with_avoid_cursor
= 0;
12611 /* See if we've found a better approximation to
12612 POS_BEFORE or to POS_AFTER. Note that we want the
12613 first (leftmost) glyph of all those that are the
12614 closest from below, and the last (rightmost) of all
12615 those from above. */
12616 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12618 pos_before
= glyph
->charpos
;
12619 glyph_before
= glyph
;
12621 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12623 pos_after
= glyph
->charpos
;
12624 glyph_after
= glyph
;
12627 else if (dpos
== 0)
12628 match_with_avoid_cursor
= 1;
12630 else if (STRINGP (glyph
->object
))
12632 Lisp_Object chprop
;
12633 EMACS_INT glyph_pos
= glyph
->charpos
;
12635 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12637 if (INTEGERP (chprop
))
12639 bpos_covered
= bpos_max
+ XINT (chprop
);
12640 /* If the `cursor' property covers buffer positions up
12641 to and including point, we should display cursor on
12642 this glyph. Note that overlays and text properties
12643 with string values stop bidi reordering, so every
12644 buffer position to the left of the string is always
12645 smaller than any position to the right of the
12646 string. Therefore, if a `cursor' property on one
12647 of the string's characters has an integer value, we
12648 will break out of the loop below _before_ we get to
12649 the position match above. IOW, integer values of
12650 the `cursor' property override the "exact match for
12651 point" strategy of positioning the cursor. */
12652 /* Implementation note: bpos_max == pt_old when, e.g.,
12653 we are in an empty line, where bpos_max is set to
12654 MATRIX_ROW_START_CHARPOS, see above. */
12655 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12664 x
+= glyph
->pixel_width
;
12667 else if (glyph
> end
) /* row is reversed */
12668 while (!INTEGERP (glyph
->object
))
12670 if (BUFFERP (glyph
->object
))
12672 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12674 if (glyph
->charpos
> bpos_max
)
12675 bpos_max
= glyph
->charpos
;
12676 if (glyph
->charpos
< bpos_min
)
12677 bpos_min
= glyph
->charpos
;
12678 if (!glyph
->avoid_cursor_p
)
12682 match_with_avoid_cursor
= 0;
12685 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12687 pos_before
= glyph
->charpos
;
12688 glyph_before
= glyph
;
12690 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12692 pos_after
= glyph
->charpos
;
12693 glyph_after
= glyph
;
12696 else if (dpos
== 0)
12697 match_with_avoid_cursor
= 1;
12699 else if (STRINGP (glyph
->object
))
12701 Lisp_Object chprop
;
12702 EMACS_INT glyph_pos
= glyph
->charpos
;
12704 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12706 if (INTEGERP (chprop
))
12708 bpos_covered
= bpos_max
+ XINT (chprop
);
12709 /* If the `cursor' property covers buffer positions up
12710 to and including point, we should display cursor on
12712 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12721 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12723 x
--; /* can't use any pixel_width */
12726 x
-= glyph
->pixel_width
;
12729 /* Step 2: If we didn't find an exact match for point, we need to
12730 look for a proper place to put the cursor among glyphs between
12731 GLYPH_BEFORE and GLYPH_AFTER. */
12732 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12733 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12734 && bpos_covered
< pt_old
)
12736 /* An empty line has a single glyph whose OBJECT is zero and
12737 whose CHARPOS is the position of a newline on that line.
12738 Note that on a TTY, there are more glyphs after that, which
12739 were produced by extend_face_to_end_of_line, but their
12740 CHARPOS is zero or negative. */
12742 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12743 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12745 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12747 EMACS_INT ellipsis_pos
;
12749 /* Scan back over the ellipsis glyphs. */
12750 if (!row
->reversed_p
)
12752 ellipsis_pos
= (glyph
- 1)->charpos
;
12753 while (glyph
> row
->glyphs
[TEXT_AREA
]
12754 && (glyph
- 1)->charpos
== ellipsis_pos
)
12755 glyph
--, x
-= glyph
->pixel_width
;
12756 /* That loop always goes one position too far, including
12757 the glyph before the ellipsis. So scan forward over
12759 x
+= glyph
->pixel_width
;
12762 else /* row is reversed */
12764 ellipsis_pos
= (glyph
+ 1)->charpos
;
12765 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12766 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12767 glyph
++, x
+= glyph
->pixel_width
;
12768 x
-= glyph
->pixel_width
;
12772 else if (match_with_avoid_cursor
12773 /* A truncated row may not include PT among its
12774 character positions. Setting the cursor inside the
12775 scroll margin will trigger recalculation of hscroll
12776 in hscroll_window_tree. */
12777 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12778 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12779 /* Zero-width characters produce no glyphs. */
12782 && (row
->reversed_p
12783 ? glyph_after
> glyphs_end
12784 : glyph_after
< glyphs_end
)))
12786 cursor
= glyph_after
;
12789 else if (string_seen
)
12791 int incr
= row
->reversed_p
? -1 : +1;
12793 /* Need to find the glyph that came out of a string which is
12794 present at point. That glyph is somewhere between
12795 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12796 positioned between POS_BEFORE and POS_AFTER in the
12798 struct glyph
*start
, *stop
;
12799 EMACS_INT pos
= pos_before
;
12803 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
12804 correspond to POS_BEFORE and POS_AFTER, respectively. We
12805 need START and STOP in the order that corresponds to the
12806 row's direction as given by its reversed_p flag. If the
12807 directionality of characters between POS_BEFORE and
12808 POS_AFTER is the opposite of the row's base direction,
12809 these characters will have been reordered for display,
12810 and we need to reverse START and STOP. */
12811 if (!row
->reversed_p
)
12813 start
= min (glyph_before
, glyph_after
);
12814 stop
= max (glyph_before
, glyph_after
);
12818 start
= max (glyph_before
, glyph_after
);
12819 stop
= min (glyph_before
, glyph_after
);
12821 for (glyph
= start
+ incr
;
12822 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12825 /* Any glyphs that come from the buffer are here because
12826 of bidi reordering. Skip them, and only pay
12827 attention to glyphs that came from some string. */
12828 if (STRINGP (glyph
->object
))
12833 str
= glyph
->object
;
12834 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12835 if (tem
== 0 /* from overlay */
12838 /* If the string from which this glyph came is
12839 found in the buffer at point, then we've
12840 found the glyph we've been looking for. If
12841 it comes from an overlay (tem == 0), and it
12842 has the `cursor' property on one of its
12843 glyphs, record that glyph as a candidate for
12844 displaying the cursor. (As in the
12845 unidirectional version, we will display the
12846 cursor on the last candidate we find.) */
12847 if (tem
== 0 || tem
== pt_old
)
12849 /* The glyphs from this string could have
12850 been reordered. Find the one with the
12851 smallest string position. Or there could
12852 be a character in the string with the
12853 `cursor' property, which means display
12854 cursor on that character's glyph. */
12855 EMACS_INT strpos
= glyph
->charpos
;
12860 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12861 && EQ (glyph
->object
, str
);
12865 EMACS_INT gpos
= glyph
->charpos
;
12867 cprop
= Fget_char_property (make_number (gpos
),
12875 if (tem
&& glyph
->charpos
< strpos
)
12877 strpos
= glyph
->charpos
;
12886 pos
= tem
+ 1; /* don't find previous instances */
12888 /* This string is not what we want; skip all of the
12889 glyphs that came from it. */
12890 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12891 && EQ (glyph
->object
, str
))
12898 /* If we reached the end of the line, and END was from a string,
12899 the cursor is not on this line. */
12901 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12902 && STRINGP (end
->object
)
12903 && row
->continued_p
)
12909 if (cursor
!= NULL
)
12915 /* Need to compute x that corresponds to GLYPH. */
12916 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12918 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12920 x
+= g
->pixel_width
;
12924 /* ROW could be part of a continued line, which, under bidi
12925 reordering, might have other rows whose start and end charpos
12926 occlude point. Only set w->cursor if we found a better
12927 approximation to the cursor position than we have from previously
12928 examined candidate rows belonging to the same continued line. */
12929 if (/* we already have a candidate row */
12930 w
->cursor
.vpos
>= 0
12931 /* that candidate is not the row we are processing */
12932 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12933 /* the row we are processing is part of a continued line */
12934 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12935 /* Make sure cursor.vpos specifies a row whose start and end
12936 charpos occlude point. This is because some callers of this
12937 function leave cursor.vpos at the row where the cursor was
12938 displayed during the last redisplay cycle. */
12939 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12940 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12943 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12945 /* Don't consider glyphs that are outside TEXT_AREA. */
12946 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12948 /* Keep the candidate whose buffer position is the closest to
12950 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12951 w
->cursor
.hpos
>= 0
12952 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12953 && BUFFERP (g1
->object
)
12954 && (g1
->charpos
== pt_old
/* an exact match always wins */
12955 || (BUFFERP (glyph
->object
)
12956 && eabs (g1
->charpos
- pt_old
)
12957 < eabs (glyph
->charpos
- pt_old
))))
12959 /* If this candidate gives an exact match, use that. */
12960 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12961 /* Otherwise, keep the candidate that comes from a row
12962 spanning less buffer positions. This may win when one or
12963 both candidate positions are on glyphs that came from
12964 display strings, for which we cannot compare buffer
12966 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12967 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12968 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12971 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12973 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12974 w
->cursor
.y
= row
->y
+ dy
;
12976 if (w
== XWINDOW (selected_window
))
12978 if (!row
->continued_p
12979 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12982 this_line_buffer
= XBUFFER (w
->buffer
);
12984 CHARPOS (this_line_start_pos
)
12985 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12986 BYTEPOS (this_line_start_pos
)
12987 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12989 CHARPOS (this_line_end_pos
)
12990 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12991 BYTEPOS (this_line_end_pos
)
12992 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12994 this_line_y
= w
->cursor
.y
;
12995 this_line_pixel_height
= row
->height
;
12996 this_line_vpos
= w
->cursor
.vpos
;
12997 this_line_start_x
= row
->x
;
13000 CHARPOS (this_line_start_pos
) = 0;
13007 /* Run window scroll functions, if any, for WINDOW with new window
13008 start STARTP. Sets the window start of WINDOW to that position.
13010 We assume that the window's buffer is really current. */
13012 static inline struct text_pos
13013 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13015 struct window
*w
= XWINDOW (window
);
13016 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13018 if (current_buffer
!= XBUFFER (w
->buffer
))
13021 if (!NILP (Vwindow_scroll_functions
))
13023 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13024 make_number (CHARPOS (startp
)));
13025 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13026 /* In case the hook functions switch buffers. */
13027 if (current_buffer
!= XBUFFER (w
->buffer
))
13028 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13035 /* Make sure the line containing the cursor is fully visible.
13036 A value of 1 means there is nothing to be done.
13037 (Either the line is fully visible, or it cannot be made so,
13038 or we cannot tell.)
13040 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13041 is higher than window.
13043 A value of 0 means the caller should do scrolling
13044 as if point had gone off the screen. */
13047 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13049 struct glyph_matrix
*matrix
;
13050 struct glyph_row
*row
;
13053 if (!make_cursor_line_fully_visible_p
)
13056 /* It's not always possible to find the cursor, e.g, when a window
13057 is full of overlay strings. Don't do anything in that case. */
13058 if (w
->cursor
.vpos
< 0)
13061 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13062 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13064 /* If the cursor row is not partially visible, there's nothing to do. */
13065 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13068 /* If the row the cursor is in is taller than the window's height,
13069 it's not clear what to do, so do nothing. */
13070 window_height
= window_box_height (w
);
13071 if (row
->height
>= window_height
)
13073 if (!force_p
|| MINI_WINDOW_P (w
)
13074 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13081 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13082 non-zero means only WINDOW is redisplayed in redisplay_internal.
13083 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13084 in redisplay_window to bring a partially visible line into view in
13085 the case that only the cursor has moved.
13087 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13088 last screen line's vertical height extends past the end of the screen.
13092 1 if scrolling succeeded
13094 0 if scrolling didn't find point.
13096 -1 if new fonts have been loaded so that we must interrupt
13097 redisplay, adjust glyph matrices, and try again. */
13103 SCROLLING_NEED_LARGER_MATRICES
13106 /* If scroll-conservatively is more than this, never recenter.
13108 If you change this, don't forget to update the doc string of
13109 `scroll-conservatively' and the Emacs manual. */
13110 #define SCROLL_LIMIT 100
13113 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13114 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13115 int temp_scroll_step
, int last_line_misfit
)
13117 struct window
*w
= XWINDOW (window
);
13118 struct frame
*f
= XFRAME (w
->frame
);
13119 struct text_pos pos
, startp
;
13121 int this_scroll_margin
, scroll_max
, rc
, height
;
13122 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13123 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13124 Lisp_Object aggressive
;
13125 /* We will never try scrolling more than this number of lines. */
13126 int scroll_limit
= SCROLL_LIMIT
;
13129 debug_method_add (w
, "try_scrolling");
13132 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13134 /* Compute scroll margin height in pixels. We scroll when point is
13135 within this distance from the top or bottom of the window. */
13136 if (scroll_margin
> 0)
13137 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13138 * FRAME_LINE_HEIGHT (f
);
13140 this_scroll_margin
= 0;
13142 /* Force arg_scroll_conservatively to have a reasonable value, to
13143 avoid scrolling too far away with slow move_it_* functions. Note
13144 that the user can supply scroll-conservatively equal to
13145 `most-positive-fixnum', which can be larger than INT_MAX. */
13146 if (arg_scroll_conservatively
> scroll_limit
)
13148 arg_scroll_conservatively
= scroll_limit
+ 1;
13149 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13151 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13152 /* Compute how much we should try to scroll maximally to bring
13153 point into view. */
13154 scroll_max
= (max (scroll_step
,
13155 max (arg_scroll_conservatively
, temp_scroll_step
))
13156 * FRAME_LINE_HEIGHT (f
));
13157 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13158 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13159 /* We're trying to scroll because of aggressive scrolling but no
13160 scroll_step is set. Choose an arbitrary one. */
13161 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13167 /* Decide whether to scroll down. */
13168 if (PT
> CHARPOS (startp
))
13170 int scroll_margin_y
;
13172 /* Compute the pixel ypos of the scroll margin, then move it to
13173 either that ypos or PT, whichever comes first. */
13174 start_display (&it
, w
, startp
);
13175 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13176 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13177 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13178 (MOVE_TO_POS
| MOVE_TO_Y
));
13180 if (PT
> CHARPOS (it
.current
.pos
))
13182 int y0
= line_bottom_y (&it
);
13183 /* Compute how many pixels below window bottom to stop searching
13184 for PT. This avoids costly search for PT that is far away if
13185 the user limited scrolling by a small number of lines, but
13186 always finds PT if scroll_conservatively is set to a large
13187 number, such as most-positive-fixnum. */
13188 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13189 int y_to_move
= it
.last_visible_y
+ slack
;
13191 /* Compute the distance from the scroll margin to PT or to
13192 the scroll limit, whichever comes first. This should
13193 include the height of the cursor line, to make that line
13195 move_it_to (&it
, PT
, -1, y_to_move
,
13196 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13197 dy
= line_bottom_y (&it
) - y0
;
13199 if (dy
> scroll_max
)
13200 return SCROLLING_FAILED
;
13208 /* Point is in or below the bottom scroll margin, so move the
13209 window start down. If scrolling conservatively, move it just
13210 enough down to make point visible. If scroll_step is set,
13211 move it down by scroll_step. */
13212 if (arg_scroll_conservatively
)
13214 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13215 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13216 else if (scroll_step
|| temp_scroll_step
)
13217 amount_to_scroll
= scroll_max
;
13220 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13221 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13222 if (NUMBERP (aggressive
))
13224 double float_amount
= XFLOATINT (aggressive
) * height
;
13225 amount_to_scroll
= float_amount
;
13226 if (amount_to_scroll
== 0 && float_amount
> 0)
13227 amount_to_scroll
= 1;
13228 /* Don't let point enter the scroll margin near top of
13230 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13231 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13235 if (amount_to_scroll
<= 0)
13236 return SCROLLING_FAILED
;
13238 start_display (&it
, w
, startp
);
13239 if (arg_scroll_conservatively
<= scroll_limit
)
13240 move_it_vertically (&it
, amount_to_scroll
);
13243 /* Extra precision for users who set scroll-conservatively
13244 to a large number: make sure the amount we scroll
13245 the window start is never less than amount_to_scroll,
13246 which was computed as distance from window bottom to
13247 point. This matters when lines at window top and lines
13248 below window bottom have different height. */
13249 struct it it1
= it
;
13250 /* We use a temporary it1 because line_bottom_y can modify
13251 its argument, if it moves one line down; see there. */
13252 int start_y
= line_bottom_y (&it1
);
13255 move_it_by_lines (&it
, 1);
13257 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13260 /* If STARTP is unchanged, move it down another screen line. */
13261 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13262 move_it_by_lines (&it
, 1);
13263 startp
= it
.current
.pos
;
13267 struct text_pos scroll_margin_pos
= startp
;
13269 /* See if point is inside the scroll margin at the top of the
13271 if (this_scroll_margin
)
13273 start_display (&it
, w
, startp
);
13274 move_it_vertically (&it
, this_scroll_margin
);
13275 scroll_margin_pos
= it
.current
.pos
;
13278 if (PT
< CHARPOS (scroll_margin_pos
))
13280 /* Point is in the scroll margin at the top of the window or
13281 above what is displayed in the window. */
13284 /* Compute the vertical distance from PT to the scroll
13285 margin position. Move as far as scroll_max allows, or
13286 one screenful, or 10 screen lines, whichever is largest.
13287 Give up if distance is greater than scroll_max. */
13288 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13289 start_display (&it
, w
, pos
);
13291 y_to_move
= max (it
.last_visible_y
,
13292 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13293 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13295 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13296 dy
= it
.current_y
- y0
;
13297 if (dy
> scroll_max
)
13298 return SCROLLING_FAILED
;
13300 /* Compute new window start. */
13301 start_display (&it
, w
, startp
);
13303 if (arg_scroll_conservatively
)
13304 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13305 max (scroll_step
, temp_scroll_step
));
13306 else if (scroll_step
|| temp_scroll_step
)
13307 amount_to_scroll
= scroll_max
;
13310 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13311 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13312 if (NUMBERP (aggressive
))
13314 double float_amount
= XFLOATINT (aggressive
) * height
;
13315 amount_to_scroll
= float_amount
;
13316 if (amount_to_scroll
== 0 && float_amount
> 0)
13317 amount_to_scroll
= 1;
13318 amount_to_scroll
-=
13319 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13320 /* Don't let point enter the scroll margin near
13321 bottom of the window. */
13322 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13323 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13327 if (amount_to_scroll
<= 0)
13328 return SCROLLING_FAILED
;
13330 move_it_vertically_backward (&it
, amount_to_scroll
);
13331 startp
= it
.current
.pos
;
13335 /* Run window scroll functions. */
13336 startp
= run_window_scroll_functions (window
, startp
);
13338 /* Display the window. Give up if new fonts are loaded, or if point
13340 if (!try_window (window
, startp
, 0))
13341 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13342 else if (w
->cursor
.vpos
< 0)
13344 clear_glyph_matrix (w
->desired_matrix
);
13345 rc
= SCROLLING_FAILED
;
13349 /* Maybe forget recorded base line for line number display. */
13350 if (!just_this_one_p
13351 || current_buffer
->clip_changed
13352 || BEG_UNCHANGED
< CHARPOS (startp
))
13353 w
->base_line_number
= Qnil
;
13355 /* If cursor ends up on a partially visible line,
13356 treat that as being off the bottom of the screen. */
13357 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13358 /* It's possible that the cursor is on the first line of the
13359 buffer, which is partially obscured due to a vscroll
13360 (Bug#7537). In that case, avoid looping forever . */
13361 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13363 clear_glyph_matrix (w
->desired_matrix
);
13364 ++extra_scroll_margin_lines
;
13367 rc
= SCROLLING_SUCCESS
;
13374 /* Compute a suitable window start for window W if display of W starts
13375 on a continuation line. Value is non-zero if a new window start
13378 The new window start will be computed, based on W's width, starting
13379 from the start of the continued line. It is the start of the
13380 screen line with the minimum distance from the old start W->start. */
13383 compute_window_start_on_continuation_line (struct window
*w
)
13385 struct text_pos pos
, start_pos
;
13386 int window_start_changed_p
= 0;
13388 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13390 /* If window start is on a continuation line... Window start may be
13391 < BEGV in case there's invisible text at the start of the
13392 buffer (M-x rmail, for example). */
13393 if (CHARPOS (start_pos
) > BEGV
13394 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13397 struct glyph_row
*row
;
13399 /* Handle the case that the window start is out of range. */
13400 if (CHARPOS (start_pos
) < BEGV
)
13401 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13402 else if (CHARPOS (start_pos
) > ZV
)
13403 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13405 /* Find the start of the continued line. This should be fast
13406 because scan_buffer is fast (newline cache). */
13407 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13408 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13409 row
, DEFAULT_FACE_ID
);
13410 reseat_at_previous_visible_line_start (&it
);
13412 /* If the line start is "too far" away from the window start,
13413 say it takes too much time to compute a new window start. */
13414 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13415 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13417 int min_distance
, distance
;
13419 /* Move forward by display lines to find the new window
13420 start. If window width was enlarged, the new start can
13421 be expected to be > the old start. If window width was
13422 decreased, the new window start will be < the old start.
13423 So, we're looking for the display line start with the
13424 minimum distance from the old window start. */
13425 pos
= it
.current
.pos
;
13426 min_distance
= INFINITY
;
13427 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13428 distance
< min_distance
)
13430 min_distance
= distance
;
13431 pos
= it
.current
.pos
;
13432 move_it_by_lines (&it
, 1);
13435 /* Set the window start there. */
13436 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13437 window_start_changed_p
= 1;
13441 return window_start_changed_p
;
13445 /* Try cursor movement in case text has not changed in window WINDOW,
13446 with window start STARTP. Value is
13448 CURSOR_MOVEMENT_SUCCESS if successful
13450 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13452 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13453 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13454 we want to scroll as if scroll-step were set to 1. See the code.
13456 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13457 which case we have to abort this redisplay, and adjust matrices
13462 CURSOR_MOVEMENT_SUCCESS
,
13463 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13464 CURSOR_MOVEMENT_MUST_SCROLL
,
13465 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13469 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13471 struct window
*w
= XWINDOW (window
);
13472 struct frame
*f
= XFRAME (w
->frame
);
13473 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13476 if (inhibit_try_cursor_movement
)
13480 /* Handle case where text has not changed, only point, and it has
13481 not moved off the frame. */
13482 if (/* Point may be in this window. */
13483 PT
>= CHARPOS (startp
)
13484 /* Selective display hasn't changed. */
13485 && !current_buffer
->clip_changed
13486 /* Function force-mode-line-update is used to force a thorough
13487 redisplay. It sets either windows_or_buffers_changed or
13488 update_mode_lines. So don't take a shortcut here for these
13490 && !update_mode_lines
13491 && !windows_or_buffers_changed
13492 && !cursor_type_changed
13493 /* Can't use this case if highlighting a region. When a
13494 region exists, cursor movement has to do more than just
13496 && !(!NILP (Vtransient_mark_mode
)
13497 && !NILP (BVAR (current_buffer
, mark_active
)))
13498 && NILP (w
->region_showing
)
13499 && NILP (Vshow_trailing_whitespace
)
13500 /* Right after splitting windows, last_point may be nil. */
13501 && INTEGERP (w
->last_point
)
13502 /* This code is not used for mini-buffer for the sake of the case
13503 of redisplaying to replace an echo area message; since in
13504 that case the mini-buffer contents per se are usually
13505 unchanged. This code is of no real use in the mini-buffer
13506 since the handling of this_line_start_pos, etc., in redisplay
13507 handles the same cases. */
13508 && !EQ (window
, minibuf_window
)
13509 /* When splitting windows or for new windows, it happens that
13510 redisplay is called with a nil window_end_vpos or one being
13511 larger than the window. This should really be fixed in
13512 window.c. I don't have this on my list, now, so we do
13513 approximately the same as the old redisplay code. --gerd. */
13514 && INTEGERP (w
->window_end_vpos
)
13515 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13516 && (FRAME_WINDOW_P (f
)
13517 || !overlay_arrow_in_current_buffer_p ()))
13519 int this_scroll_margin
, top_scroll_margin
;
13520 struct glyph_row
*row
= NULL
;
13523 debug_method_add (w
, "cursor movement");
13526 /* Scroll if point within this distance from the top or bottom
13527 of the window. This is a pixel value. */
13528 if (scroll_margin
> 0)
13530 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13531 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13534 this_scroll_margin
= 0;
13536 top_scroll_margin
= this_scroll_margin
;
13537 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13538 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13540 /* Start with the row the cursor was displayed during the last
13541 not paused redisplay. Give up if that row is not valid. */
13542 if (w
->last_cursor
.vpos
< 0
13543 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13544 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13547 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13548 if (row
->mode_line_p
)
13550 if (!row
->enabled_p
)
13551 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13554 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13556 int scroll_p
= 0, must_scroll
= 0;
13557 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13559 if (PT
> XFASTINT (w
->last_point
))
13561 /* Point has moved forward. */
13562 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13563 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13565 xassert (row
->enabled_p
);
13569 /* If the end position of a row equals the start
13570 position of the next row, and PT is at that position,
13571 we would rather display cursor in the next line. */
13572 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13573 && MATRIX_ROW_END_CHARPOS (row
) == PT
13574 && row
< w
->current_matrix
->rows
13575 + w
->current_matrix
->nrows
- 1
13576 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13577 && !cursor_row_p (row
))
13580 /* If within the scroll margin, scroll. Note that
13581 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13582 the next line would be drawn, and that
13583 this_scroll_margin can be zero. */
13584 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13585 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13586 /* Line is completely visible last line in window
13587 and PT is to be set in the next line. */
13588 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13589 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13590 && !row
->ends_at_zv_p
13591 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13594 else if (PT
< XFASTINT (w
->last_point
))
13596 /* Cursor has to be moved backward. Note that PT >=
13597 CHARPOS (startp) because of the outer if-statement. */
13598 while (!row
->mode_line_p
13599 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13600 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13601 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13602 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13603 row
> w
->current_matrix
->rows
13604 && (row
-1)->ends_in_newline_from_string_p
))))
13605 && (row
->y
> top_scroll_margin
13606 || CHARPOS (startp
) == BEGV
))
13608 xassert (row
->enabled_p
);
13612 /* Consider the following case: Window starts at BEGV,
13613 there is invisible, intangible text at BEGV, so that
13614 display starts at some point START > BEGV. It can
13615 happen that we are called with PT somewhere between
13616 BEGV and START. Try to handle that case. */
13617 if (row
< w
->current_matrix
->rows
13618 || row
->mode_line_p
)
13620 row
= w
->current_matrix
->rows
;
13621 if (row
->mode_line_p
)
13625 /* Due to newlines in overlay strings, we may have to
13626 skip forward over overlay strings. */
13627 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13628 && MATRIX_ROW_END_CHARPOS (row
) == PT
13629 && !cursor_row_p (row
))
13632 /* If within the scroll margin, scroll. */
13633 if (row
->y
< top_scroll_margin
13634 && CHARPOS (startp
) != BEGV
)
13639 /* Cursor did not move. So don't scroll even if cursor line
13640 is partially visible, as it was so before. */
13641 rc
= CURSOR_MOVEMENT_SUCCESS
;
13644 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13645 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13647 /* if PT is not in the glyph row, give up. */
13648 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13651 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13652 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13654 /* If rows are bidi-reordered and point moved, back up
13655 until we find a row that does not belong to a
13656 continuation line. This is because we must consider
13657 all rows of a continued line as candidates for the
13658 new cursor positioning, since row start and end
13659 positions change non-linearly with vertical position
13661 /* FIXME: Revisit this when glyph ``spilling'' in
13662 continuation lines' rows is implemented for
13663 bidi-reordered rows. */
13664 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13666 xassert (row
->enabled_p
);
13668 /* If we hit the beginning of the displayed portion
13669 without finding the first row of a continued
13671 if (row
<= w
->current_matrix
->rows
)
13673 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13681 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13682 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13683 && make_cursor_line_fully_visible_p
)
13685 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13686 && !row
->ends_at_zv_p
13687 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13688 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13689 else if (row
->height
> window_box_height (w
))
13691 /* If we end up in a partially visible line, let's
13692 make it fully visible, except when it's taller
13693 than the window, in which case we can't do much
13696 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13700 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13701 if (!cursor_row_fully_visible_p (w
, 0, 1))
13702 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13704 rc
= CURSOR_MOVEMENT_SUCCESS
;
13708 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13709 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13710 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13712 /* With bidi-reordered rows, there could be more than
13713 one candidate row whose start and end positions
13714 occlude point. We need to let set_cursor_from_row
13715 find the best candidate. */
13716 /* FIXME: Revisit this when glyph ``spilling'' in
13717 continuation lines' rows is implemented for
13718 bidi-reordered rows. */
13723 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13724 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13725 && cursor_row_p (row
))
13726 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13728 /* As soon as we've found the first suitable row
13729 whose ends_at_zv_p flag is set, we are done. */
13731 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13733 rc
= CURSOR_MOVEMENT_SUCCESS
;
13738 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13739 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13740 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13741 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13742 /* If we didn't find any candidate rows, or exited the
13743 loop before all the candidates were examined, signal
13744 to the caller that this method failed. */
13745 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13746 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13747 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13749 rc
= CURSOR_MOVEMENT_SUCCESS
;
13755 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13757 rc
= CURSOR_MOVEMENT_SUCCESS
;
13762 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13763 && MATRIX_ROW_START_CHARPOS (row
) == PT
13764 && cursor_row_p (row
));
13772 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13776 set_vertical_scroll_bar (struct window
*w
)
13778 EMACS_INT start
, end
, whole
;
13780 /* Calculate the start and end positions for the current window.
13781 At some point, it would be nice to choose between scrollbars
13782 which reflect the whole buffer size, with special markers
13783 indicating narrowing, and scrollbars which reflect only the
13786 Note that mini-buffers sometimes aren't displaying any text. */
13787 if (!MINI_WINDOW_P (w
)
13788 || (w
== XWINDOW (minibuf_window
)
13789 && NILP (echo_area_buffer
[0])))
13791 struct buffer
*buf
= XBUFFER (w
->buffer
);
13792 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13793 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13794 /* I don't think this is guaranteed to be right. For the
13795 moment, we'll pretend it is. */
13796 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13800 if (whole
< (end
- start
))
13801 whole
= end
- start
;
13804 start
= end
= whole
= 0;
13806 /* Indicate what this scroll bar ought to be displaying now. */
13807 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13808 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13809 (w
, end
- start
, whole
, start
);
13813 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13814 selected_window is redisplayed.
13816 We can return without actually redisplaying the window if
13817 fonts_changed_p is nonzero. In that case, redisplay_internal will
13821 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13823 struct window
*w
= XWINDOW (window
);
13824 struct frame
*f
= XFRAME (w
->frame
);
13825 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13826 struct buffer
*old
= current_buffer
;
13827 struct text_pos lpoint
, opoint
, startp
;
13828 int update_mode_line
;
13831 /* Record it now because it's overwritten. */
13832 int current_matrix_up_to_date_p
= 0;
13833 int used_current_matrix_p
= 0;
13834 /* This is less strict than current_matrix_up_to_date_p.
13835 It indictes that the buffer contents and narrowing are unchanged. */
13836 int buffer_unchanged_p
= 0;
13837 int temp_scroll_step
= 0;
13838 int count
= SPECPDL_INDEX ();
13840 int centering_position
= -1;
13841 int last_line_misfit
= 0;
13842 EMACS_INT beg_unchanged
, end_unchanged
;
13844 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13847 /* W must be a leaf window here. */
13848 xassert (!NILP (w
->buffer
));
13850 *w
->desired_matrix
->method
= 0;
13854 reconsider_clip_changes (w
, buffer
);
13856 /* Has the mode line to be updated? */
13857 update_mode_line
= (!NILP (w
->update_mode_line
)
13858 || update_mode_lines
13859 || buffer
->clip_changed
13860 || buffer
->prevent_redisplay_optimizations_p
);
13862 if (MINI_WINDOW_P (w
))
13864 if (w
== XWINDOW (echo_area_window
)
13865 && !NILP (echo_area_buffer
[0]))
13867 if (update_mode_line
)
13868 /* We may have to update a tty frame's menu bar or a
13869 tool-bar. Example `M-x C-h C-h C-g'. */
13870 goto finish_menu_bars
;
13872 /* We've already displayed the echo area glyphs in this window. */
13873 goto finish_scroll_bars
;
13875 else if ((w
!= XWINDOW (minibuf_window
)
13876 || minibuf_level
== 0)
13877 /* When buffer is nonempty, redisplay window normally. */
13878 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13879 /* Quail displays non-mini buffers in minibuffer window.
13880 In that case, redisplay the window normally. */
13881 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13883 /* W is a mini-buffer window, but it's not active, so clear
13885 int yb
= window_text_bottom_y (w
);
13886 struct glyph_row
*row
;
13889 for (y
= 0, row
= w
->desired_matrix
->rows
;
13891 y
+= row
->height
, ++row
)
13892 blank_row (w
, row
, y
);
13893 goto finish_scroll_bars
;
13896 clear_glyph_matrix (w
->desired_matrix
);
13899 /* Otherwise set up data on this window; select its buffer and point
13901 /* Really select the buffer, for the sake of buffer-local
13903 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13905 current_matrix_up_to_date_p
13906 = (!NILP (w
->window_end_valid
)
13907 && !current_buffer
->clip_changed
13908 && !current_buffer
->prevent_redisplay_optimizations_p
13909 && XFASTINT (w
->last_modified
) >= MODIFF
13910 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13912 /* Run the window-bottom-change-functions
13913 if it is possible that the text on the screen has changed
13914 (either due to modification of the text, or any other reason). */
13915 if (!current_matrix_up_to_date_p
13916 && !NILP (Vwindow_text_change_functions
))
13918 safe_run_hooks (Qwindow_text_change_functions
);
13922 beg_unchanged
= BEG_UNCHANGED
;
13923 end_unchanged
= END_UNCHANGED
;
13925 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13927 specbind (Qinhibit_point_motion_hooks
, Qt
);
13930 = (!NILP (w
->window_end_valid
)
13931 && !current_buffer
->clip_changed
13932 && XFASTINT (w
->last_modified
) >= MODIFF
13933 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13935 /* When windows_or_buffers_changed is non-zero, we can't rely on
13936 the window end being valid, so set it to nil there. */
13937 if (windows_or_buffers_changed
)
13939 /* If window starts on a continuation line, maybe adjust the
13940 window start in case the window's width changed. */
13941 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13942 compute_window_start_on_continuation_line (w
);
13944 w
->window_end_valid
= Qnil
;
13947 /* Some sanity checks. */
13948 CHECK_WINDOW_END (w
);
13949 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13951 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13954 /* If %c is in mode line, update it if needed. */
13955 if (!NILP (w
->column_number_displayed
)
13956 /* This alternative quickly identifies a common case
13957 where no change is needed. */
13958 && !(PT
== XFASTINT (w
->last_point
)
13959 && XFASTINT (w
->last_modified
) >= MODIFF
13960 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13961 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13962 update_mode_line
= 1;
13964 /* Count number of windows showing the selected buffer. An indirect
13965 buffer counts as its base buffer. */
13966 if (!just_this_one_p
)
13968 struct buffer
*current_base
, *window_base
;
13969 current_base
= current_buffer
;
13970 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13971 if (current_base
->base_buffer
)
13972 current_base
= current_base
->base_buffer
;
13973 if (window_base
->base_buffer
)
13974 window_base
= window_base
->base_buffer
;
13975 if (current_base
== window_base
)
13979 /* Point refers normally to the selected window. For any other
13980 window, set up appropriate value. */
13981 if (!EQ (window
, selected_window
))
13983 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13984 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13988 new_pt_byte
= BEGV_BYTE
;
13989 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13991 else if (new_pt
> (ZV
- 1))
13994 new_pt_byte
= ZV_BYTE
;
13995 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13998 /* We don't use SET_PT so that the point-motion hooks don't run. */
13999 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14002 /* If any of the character widths specified in the display table
14003 have changed, invalidate the width run cache. It's true that
14004 this may be a bit late to catch such changes, but the rest of
14005 redisplay goes (non-fatally) haywire when the display table is
14006 changed, so why should we worry about doing any better? */
14007 if (current_buffer
->width_run_cache
)
14009 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14011 if (! disptab_matches_widthtab (disptab
,
14012 XVECTOR (BVAR (current_buffer
, width_table
))))
14014 invalidate_region_cache (current_buffer
,
14015 current_buffer
->width_run_cache
,
14017 recompute_width_table (current_buffer
, disptab
);
14021 /* If window-start is screwed up, choose a new one. */
14022 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14025 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14027 /* If someone specified a new starting point but did not insist,
14028 check whether it can be used. */
14029 if (!NILP (w
->optional_new_start
)
14030 && CHARPOS (startp
) >= BEGV
14031 && CHARPOS (startp
) <= ZV
)
14033 w
->optional_new_start
= Qnil
;
14034 start_display (&it
, w
, startp
);
14035 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14036 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14037 if (IT_CHARPOS (it
) == PT
)
14038 w
->force_start
= Qt
;
14039 /* IT may overshoot PT if text at PT is invisible. */
14040 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14041 w
->force_start
= Qt
;
14046 /* Handle case where place to start displaying has been specified,
14047 unless the specified location is outside the accessible range. */
14048 if (!NILP (w
->force_start
)
14049 || w
->frozen_window_start_p
)
14051 /* We set this later on if we have to adjust point. */
14054 w
->force_start
= Qnil
;
14056 w
->window_end_valid
= Qnil
;
14058 /* Forget any recorded base line for line number display. */
14059 if (!buffer_unchanged_p
)
14060 w
->base_line_number
= Qnil
;
14062 /* Redisplay the mode line. Select the buffer properly for that.
14063 Also, run the hook window-scroll-functions
14064 because we have scrolled. */
14065 /* Note, we do this after clearing force_start because
14066 if there's an error, it is better to forget about force_start
14067 than to get into an infinite loop calling the hook functions
14068 and having them get more errors. */
14069 if (!update_mode_line
14070 || ! NILP (Vwindow_scroll_functions
))
14072 update_mode_line
= 1;
14073 w
->update_mode_line
= Qt
;
14074 startp
= run_window_scroll_functions (window
, startp
);
14077 w
->last_modified
= make_number (0);
14078 w
->last_overlay_modified
= make_number (0);
14079 if (CHARPOS (startp
) < BEGV
)
14080 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14081 else if (CHARPOS (startp
) > ZV
)
14082 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14084 /* Redisplay, then check if cursor has been set during the
14085 redisplay. Give up if new fonts were loaded. */
14086 /* We used to issue a CHECK_MARGINS argument to try_window here,
14087 but this causes scrolling to fail when point begins inside
14088 the scroll margin (bug#148) -- cyd */
14089 if (!try_window (window
, startp
, 0))
14091 w
->force_start
= Qt
;
14092 clear_glyph_matrix (w
->desired_matrix
);
14093 goto need_larger_matrices
;
14096 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14098 /* If point does not appear, try to move point so it does
14099 appear. The desired matrix has been built above, so we
14100 can use it here. */
14101 new_vpos
= window_box_height (w
) / 2;
14104 if (!cursor_row_fully_visible_p (w
, 0, 0))
14106 /* Point does appear, but on a line partly visible at end of window.
14107 Move it back to a fully-visible line. */
14108 new_vpos
= window_box_height (w
);
14111 /* If we need to move point for either of the above reasons,
14112 now actually do it. */
14115 struct glyph_row
*row
;
14117 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14118 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14121 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14122 MATRIX_ROW_START_BYTEPOS (row
));
14124 if (w
!= XWINDOW (selected_window
))
14125 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14126 else if (current_buffer
== old
)
14127 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14129 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14131 /* If we are highlighting the region, then we just changed
14132 the region, so redisplay to show it. */
14133 if (!NILP (Vtransient_mark_mode
)
14134 && !NILP (BVAR (current_buffer
, mark_active
)))
14136 clear_glyph_matrix (w
->desired_matrix
);
14137 if (!try_window (window
, startp
, 0))
14138 goto need_larger_matrices
;
14143 debug_method_add (w
, "forced window start");
14148 /* Handle case where text has not changed, only point, and it has
14149 not moved off the frame, and we are not retrying after hscroll.
14150 (current_matrix_up_to_date_p is nonzero when retrying.) */
14151 if (current_matrix_up_to_date_p
14152 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14153 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14157 case CURSOR_MOVEMENT_SUCCESS
:
14158 used_current_matrix_p
= 1;
14161 case CURSOR_MOVEMENT_MUST_SCROLL
:
14162 goto try_to_scroll
;
14168 /* If current starting point was originally the beginning of a line
14169 but no longer is, find a new starting point. */
14170 else if (!NILP (w
->start_at_line_beg
)
14171 && !(CHARPOS (startp
) <= BEGV
14172 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14175 debug_method_add (w
, "recenter 1");
14180 /* Try scrolling with try_window_id. Value is > 0 if update has
14181 been done, it is -1 if we know that the same window start will
14182 not work. It is 0 if unsuccessful for some other reason. */
14183 else if ((tem
= try_window_id (w
)) != 0)
14186 debug_method_add (w
, "try_window_id %d", tem
);
14189 if (fonts_changed_p
)
14190 goto need_larger_matrices
;
14194 /* Otherwise try_window_id has returned -1 which means that we
14195 don't want the alternative below this comment to execute. */
14197 else if (CHARPOS (startp
) >= BEGV
14198 && CHARPOS (startp
) <= ZV
14199 && PT
>= CHARPOS (startp
)
14200 && (CHARPOS (startp
) < ZV
14201 /* Avoid starting at end of buffer. */
14202 || CHARPOS (startp
) == BEGV
14203 || (XFASTINT (w
->last_modified
) >= MODIFF
14204 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14207 /* If first window line is a continuation line, and window start
14208 is inside the modified region, but the first change is before
14209 current window start, we must select a new window start.
14211 However, if this is the result of a down-mouse event (e.g. by
14212 extending the mouse-drag-overlay), we don't want to select a
14213 new window start, since that would change the position under
14214 the mouse, resulting in an unwanted mouse-movement rather
14215 than a simple mouse-click. */
14216 if (NILP (w
->start_at_line_beg
)
14217 && NILP (do_mouse_tracking
)
14218 && CHARPOS (startp
) > BEGV
14219 && CHARPOS (startp
) > BEG
+ beg_unchanged
14220 && CHARPOS (startp
) <= Z
- end_unchanged
14221 /* Even if w->start_at_line_beg is nil, a new window may
14222 start at a line_beg, since that's how set_buffer_window
14223 sets it. So, we need to check the return value of
14224 compute_window_start_on_continuation_line. (See also
14226 && XMARKER (w
->start
)->buffer
== current_buffer
14227 && compute_window_start_on_continuation_line (w
))
14229 w
->force_start
= Qt
;
14230 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14235 debug_method_add (w
, "same window start");
14238 /* Try to redisplay starting at same place as before.
14239 If point has not moved off frame, accept the results. */
14240 if (!current_matrix_up_to_date_p
14241 /* Don't use try_window_reusing_current_matrix in this case
14242 because a window scroll function can have changed the
14244 || !NILP (Vwindow_scroll_functions
)
14245 || MINI_WINDOW_P (w
)
14246 || !(used_current_matrix_p
14247 = try_window_reusing_current_matrix (w
)))
14249 IF_DEBUG (debug_method_add (w
, "1"));
14250 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14251 /* -1 means we need to scroll.
14252 0 means we need new matrices, but fonts_changed_p
14253 is set in that case, so we will detect it below. */
14254 goto try_to_scroll
;
14257 if (fonts_changed_p
)
14258 goto need_larger_matrices
;
14260 if (w
->cursor
.vpos
>= 0)
14262 if (!just_this_one_p
14263 || current_buffer
->clip_changed
14264 || BEG_UNCHANGED
< CHARPOS (startp
))
14265 /* Forget any recorded base line for line number display. */
14266 w
->base_line_number
= Qnil
;
14268 if (!cursor_row_fully_visible_p (w
, 1, 0))
14270 clear_glyph_matrix (w
->desired_matrix
);
14271 last_line_misfit
= 1;
14273 /* Drop through and scroll. */
14278 clear_glyph_matrix (w
->desired_matrix
);
14283 w
->last_modified
= make_number (0);
14284 w
->last_overlay_modified
= make_number (0);
14286 /* Redisplay the mode line. Select the buffer properly for that. */
14287 if (!update_mode_line
)
14289 update_mode_line
= 1;
14290 w
->update_mode_line
= Qt
;
14293 /* Try to scroll by specified few lines. */
14294 if ((scroll_conservatively
14295 || emacs_scroll_step
14296 || temp_scroll_step
14297 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14298 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14299 && CHARPOS (startp
) >= BEGV
14300 && CHARPOS (startp
) <= ZV
)
14302 /* The function returns -1 if new fonts were loaded, 1 if
14303 successful, 0 if not successful. */
14304 int ss
= try_scrolling (window
, just_this_one_p
,
14305 scroll_conservatively
,
14307 temp_scroll_step
, last_line_misfit
);
14310 case SCROLLING_SUCCESS
:
14313 case SCROLLING_NEED_LARGER_MATRICES
:
14314 goto need_larger_matrices
;
14316 case SCROLLING_FAILED
:
14324 /* Finally, just choose a place to start which positions point
14325 according to user preferences. */
14330 debug_method_add (w
, "recenter");
14333 /* w->vscroll = 0; */
14335 /* Forget any previously recorded base line for line number display. */
14336 if (!buffer_unchanged_p
)
14337 w
->base_line_number
= Qnil
;
14339 /* Determine the window start relative to point. */
14340 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14341 it
.current_y
= it
.last_visible_y
;
14342 if (centering_position
< 0)
14346 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14348 EMACS_INT margin_pos
= CHARPOS (startp
);
14350 Lisp_Object aggressive
;
14352 /* If there is a scroll margin at the top of the window, find
14353 its character position. */
14355 /* Cannot call start_display if startp is not in the
14356 accessible region of the buffer. This can happen when we
14357 have just switched to a different buffer and/or changed
14358 its restriction. In that case, startp is initialized to
14359 the character position 1 (BEG) because we did not yet
14360 have chance to display the buffer even once. */
14361 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14365 start_display (&it1
, w
, startp
);
14366 move_it_vertically (&it1
, margin
);
14367 margin_pos
= IT_CHARPOS (it1
);
14369 scrolling_up
= PT
> margin_pos
;
14372 ? BVAR (current_buffer
, scroll_up_aggressively
)
14373 : BVAR (current_buffer
, scroll_down_aggressively
);
14375 if (!MINI_WINDOW_P (w
)
14376 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14380 /* Setting scroll-conservatively overrides
14381 scroll-*-aggressively. */
14382 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14384 double float_amount
= XFLOATINT (aggressive
);
14386 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14387 if (pt_offset
== 0 && float_amount
> 0)
14392 /* Compute how much to move the window start backward from
14393 point so that point will be displayed where the user
14397 centering_position
= it
.last_visible_y
;
14399 centering_position
-= pt_offset
;
14400 centering_position
-=
14401 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14402 /* Don't let point enter the scroll margin near top of
14404 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14405 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14408 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14411 /* Set the window start half the height of the window backward
14413 centering_position
= window_box_height (w
) / 2;
14415 move_it_vertically_backward (&it
, centering_position
);
14417 xassert (IT_CHARPOS (it
) >= BEGV
);
14419 /* The function move_it_vertically_backward may move over more
14420 than the specified y-distance. If it->w is small, e.g. a
14421 mini-buffer window, we may end up in front of the window's
14422 display area. Start displaying at the start of the line
14423 containing PT in this case. */
14424 if (it
.current_y
<= 0)
14426 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14427 move_it_vertically_backward (&it
, 0);
14431 it
.current_x
= it
.hpos
= 0;
14433 /* Set the window start position here explicitly, to avoid an
14434 infinite loop in case the functions in window-scroll-functions
14436 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14438 /* Run scroll hooks. */
14439 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14441 /* Redisplay the window. */
14442 if (!current_matrix_up_to_date_p
14443 || windows_or_buffers_changed
14444 || cursor_type_changed
14445 /* Don't use try_window_reusing_current_matrix in this case
14446 because it can have changed the buffer. */
14447 || !NILP (Vwindow_scroll_functions
)
14448 || !just_this_one_p
14449 || MINI_WINDOW_P (w
)
14450 || !(used_current_matrix_p
14451 = try_window_reusing_current_matrix (w
)))
14452 try_window (window
, startp
, 0);
14454 /* If new fonts have been loaded (due to fontsets), give up. We
14455 have to start a new redisplay since we need to re-adjust glyph
14457 if (fonts_changed_p
)
14458 goto need_larger_matrices
;
14460 /* If cursor did not appear assume that the middle of the window is
14461 in the first line of the window. Do it again with the next line.
14462 (Imagine a window of height 100, displaying two lines of height
14463 60. Moving back 50 from it->last_visible_y will end in the first
14465 if (w
->cursor
.vpos
< 0)
14467 if (!NILP (w
->window_end_valid
)
14468 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14470 clear_glyph_matrix (w
->desired_matrix
);
14471 move_it_by_lines (&it
, 1);
14472 try_window (window
, it
.current
.pos
, 0);
14474 else if (PT
< IT_CHARPOS (it
))
14476 clear_glyph_matrix (w
->desired_matrix
);
14477 move_it_by_lines (&it
, -1);
14478 try_window (window
, it
.current
.pos
, 0);
14482 /* Not much we can do about it. */
14486 /* Consider the following case: Window starts at BEGV, there is
14487 invisible, intangible text at BEGV, so that display starts at
14488 some point START > BEGV. It can happen that we are called with
14489 PT somewhere between BEGV and START. Try to handle that case. */
14490 if (w
->cursor
.vpos
< 0)
14492 struct glyph_row
*row
= w
->current_matrix
->rows
;
14493 if (row
->mode_line_p
)
14495 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14498 if (!cursor_row_fully_visible_p (w
, 0, 0))
14500 /* If vscroll is enabled, disable it and try again. */
14504 clear_glyph_matrix (w
->desired_matrix
);
14508 /* If centering point failed to make the whole line visible,
14509 put point at the top instead. That has to make the whole line
14510 visible, if it can be done. */
14511 if (centering_position
== 0)
14514 clear_glyph_matrix (w
->desired_matrix
);
14515 centering_position
= 0;
14521 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14522 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14523 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14526 /* Display the mode line, if we must. */
14527 if ((update_mode_line
14528 /* If window not full width, must redo its mode line
14529 if (a) the window to its side is being redone and
14530 (b) we do a frame-based redisplay. This is a consequence
14531 of how inverted lines are drawn in frame-based redisplay. */
14532 || (!just_this_one_p
14533 && !FRAME_WINDOW_P (f
)
14534 && !WINDOW_FULL_WIDTH_P (w
))
14535 /* Line number to display. */
14536 || INTEGERP (w
->base_line_pos
)
14537 /* Column number is displayed and different from the one displayed. */
14538 || (!NILP (w
->column_number_displayed
)
14539 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14540 /* This means that the window has a mode line. */
14541 && (WINDOW_WANTS_MODELINE_P (w
)
14542 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14544 display_mode_lines (w
);
14546 /* If mode line height has changed, arrange for a thorough
14547 immediate redisplay using the correct mode line height. */
14548 if (WINDOW_WANTS_MODELINE_P (w
)
14549 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14551 fonts_changed_p
= 1;
14552 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14553 = DESIRED_MODE_LINE_HEIGHT (w
);
14556 /* If header line height has changed, arrange for a thorough
14557 immediate redisplay using the correct header line height. */
14558 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14559 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14561 fonts_changed_p
= 1;
14562 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14563 = DESIRED_HEADER_LINE_HEIGHT (w
);
14566 if (fonts_changed_p
)
14567 goto need_larger_matrices
;
14570 if (!line_number_displayed
14571 && !BUFFERP (w
->base_line_pos
))
14573 w
->base_line_pos
= Qnil
;
14574 w
->base_line_number
= Qnil
;
14579 /* When we reach a frame's selected window, redo the frame's menu bar. */
14580 if (update_mode_line
14581 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14583 int redisplay_menu_p
= 0;
14585 if (FRAME_WINDOW_P (f
))
14587 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14588 || defined (HAVE_NS) || defined (USE_GTK)
14589 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14591 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14595 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14597 if (redisplay_menu_p
)
14598 display_menu_bar (w
);
14600 #ifdef HAVE_WINDOW_SYSTEM
14601 if (FRAME_WINDOW_P (f
))
14603 #if defined (USE_GTK) || defined (HAVE_NS)
14604 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14605 redisplay_tool_bar (f
);
14607 if (WINDOWP (f
->tool_bar_window
)
14608 && (FRAME_TOOL_BAR_LINES (f
) > 0
14609 || !NILP (Vauto_resize_tool_bars
))
14610 && redisplay_tool_bar (f
))
14611 ignore_mouse_drag_p
= 1;
14617 #ifdef HAVE_WINDOW_SYSTEM
14618 if (FRAME_WINDOW_P (f
)
14619 && update_window_fringes (w
, (just_this_one_p
14620 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14621 || w
->pseudo_window_p
)))
14625 if (draw_window_fringes (w
, 1))
14626 x_draw_vertical_border (w
);
14630 #endif /* HAVE_WINDOW_SYSTEM */
14632 /* We go to this label, with fonts_changed_p nonzero,
14633 if it is necessary to try again using larger glyph matrices.
14634 We have to redeem the scroll bar even in this case,
14635 because the loop in redisplay_internal expects that. */
14636 need_larger_matrices
:
14638 finish_scroll_bars
:
14640 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14642 /* Set the thumb's position and size. */
14643 set_vertical_scroll_bar (w
);
14645 /* Note that we actually used the scroll bar attached to this
14646 window, so it shouldn't be deleted at the end of redisplay. */
14647 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14648 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14651 /* Restore current_buffer and value of point in it. The window
14652 update may have changed the buffer, so first make sure `opoint'
14653 is still valid (Bug#6177). */
14654 if (CHARPOS (opoint
) < BEGV
)
14655 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14656 else if (CHARPOS (opoint
) > ZV
)
14657 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14659 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14661 set_buffer_internal_1 (old
);
14662 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14663 shorter. This can be caused by log truncation in *Messages*. */
14664 if (CHARPOS (lpoint
) <= ZV
)
14665 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14667 unbind_to (count
, Qnil
);
14671 /* Build the complete desired matrix of WINDOW with a window start
14672 buffer position POS.
14674 Value is 1 if successful. It is zero if fonts were loaded during
14675 redisplay which makes re-adjusting glyph matrices necessary, and -1
14676 if point would appear in the scroll margins.
14677 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14678 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14682 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14684 struct window
*w
= XWINDOW (window
);
14686 struct glyph_row
*last_text_row
= NULL
;
14687 struct frame
*f
= XFRAME (w
->frame
);
14689 /* Make POS the new window start. */
14690 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14692 /* Mark cursor position as unknown. No overlay arrow seen. */
14693 w
->cursor
.vpos
= -1;
14694 overlay_arrow_seen
= 0;
14696 /* Initialize iterator and info to start at POS. */
14697 start_display (&it
, w
, pos
);
14699 /* Display all lines of W. */
14700 while (it
.current_y
< it
.last_visible_y
)
14702 if (display_line (&it
))
14703 last_text_row
= it
.glyph_row
- 1;
14704 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14708 /* Don't let the cursor end in the scroll margins. */
14709 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14710 && !MINI_WINDOW_P (w
))
14712 int this_scroll_margin
;
14714 if (scroll_margin
> 0)
14716 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14717 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14720 this_scroll_margin
= 0;
14722 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14723 && w
->cursor
.y
< this_scroll_margin
14724 && CHARPOS (pos
) > BEGV
14725 && IT_CHARPOS (it
) < ZV
)
14726 /* rms: considering make_cursor_line_fully_visible_p here
14727 seems to give wrong results. We don't want to recenter
14728 when the last line is partly visible, we want to allow
14729 that case to be handled in the usual way. */
14730 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14732 w
->cursor
.vpos
= -1;
14733 clear_glyph_matrix (w
->desired_matrix
);
14738 /* If bottom moved off end of frame, change mode line percentage. */
14739 if (XFASTINT (w
->window_end_pos
) <= 0
14740 && Z
!= IT_CHARPOS (it
))
14741 w
->update_mode_line
= Qt
;
14743 /* Set window_end_pos to the offset of the last character displayed
14744 on the window from the end of current_buffer. Set
14745 window_end_vpos to its row number. */
14748 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14749 w
->window_end_bytepos
14750 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14752 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14754 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14755 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14756 ->displays_text_p
);
14760 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14761 w
->window_end_pos
= make_number (Z
- ZV
);
14762 w
->window_end_vpos
= make_number (0);
14765 /* But that is not valid info until redisplay finishes. */
14766 w
->window_end_valid
= Qnil
;
14772 /************************************************************************
14773 Window redisplay reusing current matrix when buffer has not changed
14774 ************************************************************************/
14776 /* Try redisplay of window W showing an unchanged buffer with a
14777 different window start than the last time it was displayed by
14778 reusing its current matrix. Value is non-zero if successful.
14779 W->start is the new window start. */
14782 try_window_reusing_current_matrix (struct window
*w
)
14784 struct frame
*f
= XFRAME (w
->frame
);
14785 struct glyph_row
*bottom_row
;
14788 struct text_pos start
, new_start
;
14789 int nrows_scrolled
, i
;
14790 struct glyph_row
*last_text_row
;
14791 struct glyph_row
*last_reused_text_row
;
14792 struct glyph_row
*start_row
;
14793 int start_vpos
, min_y
, max_y
;
14796 if (inhibit_try_window_reusing
)
14800 if (/* This function doesn't handle terminal frames. */
14801 !FRAME_WINDOW_P (f
)
14802 /* Don't try to reuse the display if windows have been split
14804 || windows_or_buffers_changed
14805 || cursor_type_changed
)
14808 /* Can't do this if region may have changed. */
14809 if ((!NILP (Vtransient_mark_mode
)
14810 && !NILP (BVAR (current_buffer
, mark_active
)))
14811 || !NILP (w
->region_showing
)
14812 || !NILP (Vshow_trailing_whitespace
))
14815 /* If top-line visibility has changed, give up. */
14816 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14817 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14820 /* Give up if old or new display is scrolled vertically. We could
14821 make this function handle this, but right now it doesn't. */
14822 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14823 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14826 /* The variable new_start now holds the new window start. The old
14827 start `start' can be determined from the current matrix. */
14828 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14829 start
= start_row
->minpos
;
14830 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14832 /* Clear the desired matrix for the display below. */
14833 clear_glyph_matrix (w
->desired_matrix
);
14835 if (CHARPOS (new_start
) <= CHARPOS (start
))
14837 /* Don't use this method if the display starts with an ellipsis
14838 displayed for invisible text. It's not easy to handle that case
14839 below, and it's certainly not worth the effort since this is
14840 not a frequent case. */
14841 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14844 IF_DEBUG (debug_method_add (w
, "twu1"));
14846 /* Display up to a row that can be reused. The variable
14847 last_text_row is set to the last row displayed that displays
14848 text. Note that it.vpos == 0 if or if not there is a
14849 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14850 start_display (&it
, w
, new_start
);
14851 w
->cursor
.vpos
= -1;
14852 last_text_row
= last_reused_text_row
= NULL
;
14854 while (it
.current_y
< it
.last_visible_y
14855 && !fonts_changed_p
)
14857 /* If we have reached into the characters in the START row,
14858 that means the line boundaries have changed. So we
14859 can't start copying with the row START. Maybe it will
14860 work to start copying with the following row. */
14861 while (IT_CHARPOS (it
) > CHARPOS (start
))
14863 /* Advance to the next row as the "start". */
14865 start
= start_row
->minpos
;
14866 /* If there are no more rows to try, or just one, give up. */
14867 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14868 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14869 || CHARPOS (start
) == ZV
)
14871 clear_glyph_matrix (w
->desired_matrix
);
14875 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14877 /* If we have reached alignment,
14878 we can copy the rest of the rows. */
14879 if (IT_CHARPOS (it
) == CHARPOS (start
))
14882 if (display_line (&it
))
14883 last_text_row
= it
.glyph_row
- 1;
14886 /* A value of current_y < last_visible_y means that we stopped
14887 at the previous window start, which in turn means that we
14888 have at least one reusable row. */
14889 if (it
.current_y
< it
.last_visible_y
)
14891 struct glyph_row
*row
;
14893 /* IT.vpos always starts from 0; it counts text lines. */
14894 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14896 /* Find PT if not already found in the lines displayed. */
14897 if (w
->cursor
.vpos
< 0)
14899 int dy
= it
.current_y
- start_row
->y
;
14901 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14902 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14904 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14905 dy
, nrows_scrolled
);
14908 clear_glyph_matrix (w
->desired_matrix
);
14913 /* Scroll the display. Do it before the current matrix is
14914 changed. The problem here is that update has not yet
14915 run, i.e. part of the current matrix is not up to date.
14916 scroll_run_hook will clear the cursor, and use the
14917 current matrix to get the height of the row the cursor is
14919 run
.current_y
= start_row
->y
;
14920 run
.desired_y
= it
.current_y
;
14921 run
.height
= it
.last_visible_y
- it
.current_y
;
14923 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14926 FRAME_RIF (f
)->update_window_begin_hook (w
);
14927 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14928 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14929 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14933 /* Shift current matrix down by nrows_scrolled lines. */
14934 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14935 rotate_matrix (w
->current_matrix
,
14937 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14940 /* Disable lines that must be updated. */
14941 for (i
= 0; i
< nrows_scrolled
; ++i
)
14942 (start_row
+ i
)->enabled_p
= 0;
14944 /* Re-compute Y positions. */
14945 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14946 max_y
= it
.last_visible_y
;
14947 for (row
= start_row
+ nrows_scrolled
;
14951 row
->y
= it
.current_y
;
14952 row
->visible_height
= row
->height
;
14954 if (row
->y
< min_y
)
14955 row
->visible_height
-= min_y
- row
->y
;
14956 if (row
->y
+ row
->height
> max_y
)
14957 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14958 if (row
->fringe_bitmap_periodic_p
)
14959 row
->redraw_fringe_bitmaps_p
= 1;
14961 it
.current_y
+= row
->height
;
14963 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14964 last_reused_text_row
= row
;
14965 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14969 /* Disable lines in the current matrix which are now
14970 below the window. */
14971 for (++row
; row
< bottom_row
; ++row
)
14972 row
->enabled_p
= row
->mode_line_p
= 0;
14975 /* Update window_end_pos etc.; last_reused_text_row is the last
14976 reused row from the current matrix containing text, if any.
14977 The value of last_text_row is the last displayed line
14978 containing text. */
14979 if (last_reused_text_row
)
14981 w
->window_end_bytepos
14982 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14984 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14986 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14987 w
->current_matrix
));
14989 else if (last_text_row
)
14991 w
->window_end_bytepos
14992 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14994 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14996 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15000 /* This window must be completely empty. */
15001 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15002 w
->window_end_pos
= make_number (Z
- ZV
);
15003 w
->window_end_vpos
= make_number (0);
15005 w
->window_end_valid
= Qnil
;
15007 /* Update hint: don't try scrolling again in update_window. */
15008 w
->desired_matrix
->no_scrolling_p
= 1;
15011 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15015 else if (CHARPOS (new_start
) > CHARPOS (start
))
15017 struct glyph_row
*pt_row
, *row
;
15018 struct glyph_row
*first_reusable_row
;
15019 struct glyph_row
*first_row_to_display
;
15021 int yb
= window_text_bottom_y (w
);
15023 /* Find the row starting at new_start, if there is one. Don't
15024 reuse a partially visible line at the end. */
15025 first_reusable_row
= start_row
;
15026 while (first_reusable_row
->enabled_p
15027 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15028 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15029 < CHARPOS (new_start
)))
15030 ++first_reusable_row
;
15032 /* Give up if there is no row to reuse. */
15033 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15034 || !first_reusable_row
->enabled_p
15035 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15036 != CHARPOS (new_start
)))
15039 /* We can reuse fully visible rows beginning with
15040 first_reusable_row to the end of the window. Set
15041 first_row_to_display to the first row that cannot be reused.
15042 Set pt_row to the row containing point, if there is any. */
15044 for (first_row_to_display
= first_reusable_row
;
15045 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15046 ++first_row_to_display
)
15048 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15049 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15050 pt_row
= first_row_to_display
;
15053 /* Start displaying at the start of first_row_to_display. */
15054 xassert (first_row_to_display
->y
< yb
);
15055 init_to_row_start (&it
, w
, first_row_to_display
);
15057 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15059 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15061 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15062 + WINDOW_HEADER_LINE_HEIGHT (w
));
15064 /* Display lines beginning with first_row_to_display in the
15065 desired matrix. Set last_text_row to the last row displayed
15066 that displays text. */
15067 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15068 if (pt_row
== NULL
)
15069 w
->cursor
.vpos
= -1;
15070 last_text_row
= NULL
;
15071 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15072 if (display_line (&it
))
15073 last_text_row
= it
.glyph_row
- 1;
15075 /* If point is in a reused row, adjust y and vpos of the cursor
15079 w
->cursor
.vpos
-= nrows_scrolled
;
15080 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15083 /* Give up if point isn't in a row displayed or reused. (This
15084 also handles the case where w->cursor.vpos < nrows_scrolled
15085 after the calls to display_line, which can happen with scroll
15086 margins. See bug#1295.) */
15087 if (w
->cursor
.vpos
< 0)
15089 clear_glyph_matrix (w
->desired_matrix
);
15093 /* Scroll the display. */
15094 run
.current_y
= first_reusable_row
->y
;
15095 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15096 run
.height
= it
.last_visible_y
- run
.current_y
;
15097 dy
= run
.current_y
- run
.desired_y
;
15102 FRAME_RIF (f
)->update_window_begin_hook (w
);
15103 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15104 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15105 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15109 /* Adjust Y positions of reused rows. */
15110 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15111 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15112 max_y
= it
.last_visible_y
;
15113 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15116 row
->visible_height
= row
->height
;
15117 if (row
->y
< min_y
)
15118 row
->visible_height
-= min_y
- row
->y
;
15119 if (row
->y
+ row
->height
> max_y
)
15120 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15121 if (row
->fringe_bitmap_periodic_p
)
15122 row
->redraw_fringe_bitmaps_p
= 1;
15125 /* Scroll the current matrix. */
15126 xassert (nrows_scrolled
> 0);
15127 rotate_matrix (w
->current_matrix
,
15129 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15132 /* Disable rows not reused. */
15133 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15134 row
->enabled_p
= 0;
15136 /* Point may have moved to a different line, so we cannot assume that
15137 the previous cursor position is valid; locate the correct row. */
15140 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15141 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15145 w
->cursor
.y
= row
->y
;
15147 if (row
< bottom_row
)
15149 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15150 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15152 /* Can't use this optimization with bidi-reordered glyph
15153 rows, unless cursor is already at point. */
15154 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15156 if (!(w
->cursor
.hpos
>= 0
15157 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15158 && BUFFERP (glyph
->object
)
15159 && glyph
->charpos
== PT
))
15164 && (!BUFFERP (glyph
->object
)
15165 || glyph
->charpos
< PT
);
15169 w
->cursor
.x
+= glyph
->pixel_width
;
15174 /* Adjust window end. A null value of last_text_row means that
15175 the window end is in reused rows which in turn means that
15176 only its vpos can have changed. */
15179 w
->window_end_bytepos
15180 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15182 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15184 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15189 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15192 w
->window_end_valid
= Qnil
;
15193 w
->desired_matrix
->no_scrolling_p
= 1;
15196 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15206 /************************************************************************
15207 Window redisplay reusing current matrix when buffer has changed
15208 ************************************************************************/
15210 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15211 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15212 EMACS_INT
*, EMACS_INT
*);
15213 static struct glyph_row
*
15214 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15215 struct glyph_row
*);
15218 /* Return the last row in MATRIX displaying text. If row START is
15219 non-null, start searching with that row. IT gives the dimensions
15220 of the display. Value is null if matrix is empty; otherwise it is
15221 a pointer to the row found. */
15223 static struct glyph_row
*
15224 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15225 struct glyph_row
*start
)
15227 struct glyph_row
*row
, *row_found
;
15229 /* Set row_found to the last row in IT->w's current matrix
15230 displaying text. The loop looks funny but think of partially
15233 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15234 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15236 xassert (row
->enabled_p
);
15238 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15247 /* Return the last row in the current matrix of W that is not affected
15248 by changes at the start of current_buffer that occurred since W's
15249 current matrix was built. Value is null if no such row exists.
15251 BEG_UNCHANGED us the number of characters unchanged at the start of
15252 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15253 first changed character in current_buffer. Characters at positions <
15254 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15255 when the current matrix was built. */
15257 static struct glyph_row
*
15258 find_last_unchanged_at_beg_row (struct window
*w
)
15260 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15261 struct glyph_row
*row
;
15262 struct glyph_row
*row_found
= NULL
;
15263 int yb
= window_text_bottom_y (w
);
15265 /* Find the last row displaying unchanged text. */
15266 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15267 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15268 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15271 if (/* If row ends before first_changed_pos, it is unchanged,
15272 except in some case. */
15273 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15274 /* When row ends in ZV and we write at ZV it is not
15276 && !row
->ends_at_zv_p
15277 /* When first_changed_pos is the end of a continued line,
15278 row is not unchanged because it may be no longer
15280 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15281 && (row
->continued_p
15282 || row
->exact_window_width_line_p
)))
15285 /* Stop if last visible row. */
15286 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15294 /* Find the first glyph row in the current matrix of W that is not
15295 affected by changes at the end of current_buffer since the
15296 time W's current matrix was built.
15298 Return in *DELTA the number of chars by which buffer positions in
15299 unchanged text at the end of current_buffer must be adjusted.
15301 Return in *DELTA_BYTES the corresponding number of bytes.
15303 Value is null if no such row exists, i.e. all rows are affected by
15306 static struct glyph_row
*
15307 find_first_unchanged_at_end_row (struct window
*w
,
15308 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15310 struct glyph_row
*row
;
15311 struct glyph_row
*row_found
= NULL
;
15313 *delta
= *delta_bytes
= 0;
15315 /* Display must not have been paused, otherwise the current matrix
15316 is not up to date. */
15317 eassert (!NILP (w
->window_end_valid
));
15319 /* A value of window_end_pos >= END_UNCHANGED means that the window
15320 end is in the range of changed text. If so, there is no
15321 unchanged row at the end of W's current matrix. */
15322 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15325 /* Set row to the last row in W's current matrix displaying text. */
15326 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15328 /* If matrix is entirely empty, no unchanged row exists. */
15329 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15331 /* The value of row is the last glyph row in the matrix having a
15332 meaningful buffer position in it. The end position of row
15333 corresponds to window_end_pos. This allows us to translate
15334 buffer positions in the current matrix to current buffer
15335 positions for characters not in changed text. */
15337 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15338 EMACS_INT Z_BYTE_old
=
15339 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15340 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15341 struct glyph_row
*first_text_row
15342 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15344 *delta
= Z
- Z_old
;
15345 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15347 /* Set last_unchanged_pos to the buffer position of the last
15348 character in the buffer that has not been changed. Z is the
15349 index + 1 of the last character in current_buffer, i.e. by
15350 subtracting END_UNCHANGED we get the index of the last
15351 unchanged character, and we have to add BEG to get its buffer
15353 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15354 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15356 /* Search backward from ROW for a row displaying a line that
15357 starts at a minimum position >= last_unchanged_pos_old. */
15358 for (; row
> first_text_row
; --row
)
15360 /* This used to abort, but it can happen.
15361 It is ok to just stop the search instead here. KFS. */
15362 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15365 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15370 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15376 /* Make sure that glyph rows in the current matrix of window W
15377 reference the same glyph memory as corresponding rows in the
15378 frame's frame matrix. This function is called after scrolling W's
15379 current matrix on a terminal frame in try_window_id and
15380 try_window_reusing_current_matrix. */
15383 sync_frame_with_window_matrix_rows (struct window
*w
)
15385 struct frame
*f
= XFRAME (w
->frame
);
15386 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15388 /* Preconditions: W must be a leaf window and full-width. Its frame
15389 must have a frame matrix. */
15390 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15391 xassert (WINDOW_FULL_WIDTH_P (w
));
15392 xassert (!FRAME_WINDOW_P (f
));
15394 /* If W is a full-width window, glyph pointers in W's current matrix
15395 have, by definition, to be the same as glyph pointers in the
15396 corresponding frame matrix. Note that frame matrices have no
15397 marginal areas (see build_frame_matrix). */
15398 window_row
= w
->current_matrix
->rows
;
15399 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15400 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15401 while (window_row
< window_row_end
)
15403 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15404 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15406 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15407 frame_row
->glyphs
[TEXT_AREA
] = start
;
15408 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15409 frame_row
->glyphs
[LAST_AREA
] = end
;
15411 /* Disable frame rows whose corresponding window rows have
15412 been disabled in try_window_id. */
15413 if (!window_row
->enabled_p
)
15414 frame_row
->enabled_p
= 0;
15416 ++window_row
, ++frame_row
;
15421 /* Find the glyph row in window W containing CHARPOS. Consider all
15422 rows between START and END (not inclusive). END null means search
15423 all rows to the end of the display area of W. Value is the row
15424 containing CHARPOS or null. */
15427 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15428 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15430 struct glyph_row
*row
= start
;
15431 struct glyph_row
*best_row
= NULL
;
15432 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15435 /* If we happen to start on a header-line, skip that. */
15436 if (row
->mode_line_p
)
15439 if ((end
&& row
>= end
) || !row
->enabled_p
)
15442 last_y
= window_text_bottom_y (w
) - dy
;
15446 /* Give up if we have gone too far. */
15447 if (end
&& row
>= end
)
15449 /* This formerly returned if they were equal.
15450 I think that both quantities are of a "last plus one" type;
15451 if so, when they are equal, the row is within the screen. -- rms. */
15452 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15455 /* If it is in this row, return this row. */
15456 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15457 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15458 /* The end position of a row equals the start
15459 position of the next row. If CHARPOS is there, we
15460 would rather display it in the next line, except
15461 when this line ends in ZV. */
15462 && !row
->ends_at_zv_p
15463 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15464 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15468 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15469 || (!best_row
&& !row
->continued_p
))
15471 /* In bidi-reordered rows, there could be several rows
15472 occluding point, all of them belonging to the same
15473 continued line. We need to find the row which fits
15474 CHARPOS the best. */
15475 for (g
= row
->glyphs
[TEXT_AREA
];
15476 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15479 if (!STRINGP (g
->object
))
15481 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15483 mindif
= eabs (g
->charpos
- charpos
);
15485 /* Exact match always wins. */
15492 else if (best_row
&& !row
->continued_p
)
15499 /* Try to redisplay window W by reusing its existing display. W's
15500 current matrix must be up to date when this function is called,
15501 i.e. window_end_valid must not be nil.
15505 1 if display has been updated
15506 0 if otherwise unsuccessful
15507 -1 if redisplay with same window start is known not to succeed
15509 The following steps are performed:
15511 1. Find the last row in the current matrix of W that is not
15512 affected by changes at the start of current_buffer. If no such row
15515 2. Find the first row in W's current matrix that is not affected by
15516 changes at the end of current_buffer. Maybe there is no such row.
15518 3. Display lines beginning with the row + 1 found in step 1 to the
15519 row found in step 2 or, if step 2 didn't find a row, to the end of
15522 4. If cursor is not known to appear on the window, give up.
15524 5. If display stopped at the row found in step 2, scroll the
15525 display and current matrix as needed.
15527 6. Maybe display some lines at the end of W, if we must. This can
15528 happen under various circumstances, like a partially visible line
15529 becoming fully visible, or because newly displayed lines are displayed
15530 in smaller font sizes.
15532 7. Update W's window end information. */
15535 try_window_id (struct window
*w
)
15537 struct frame
*f
= XFRAME (w
->frame
);
15538 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15539 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15540 struct glyph_row
*last_unchanged_at_beg_row
;
15541 struct glyph_row
*first_unchanged_at_end_row
;
15542 struct glyph_row
*row
;
15543 struct glyph_row
*bottom_row
;
15546 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15548 struct text_pos start_pos
;
15550 int first_unchanged_at_end_vpos
= 0;
15551 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15552 struct text_pos start
;
15553 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15556 if (inhibit_try_window_id
)
15560 /* This is handy for debugging. */
15562 #define GIVE_UP(X) \
15564 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15568 #define GIVE_UP(X) return 0
15571 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15573 /* Don't use this for mini-windows because these can show
15574 messages and mini-buffers, and we don't handle that here. */
15575 if (MINI_WINDOW_P (w
))
15578 /* This flag is used to prevent redisplay optimizations. */
15579 if (windows_or_buffers_changed
|| cursor_type_changed
)
15582 /* Verify that narrowing has not changed.
15583 Also verify that we were not told to prevent redisplay optimizations.
15584 It would be nice to further
15585 reduce the number of cases where this prevents try_window_id. */
15586 if (current_buffer
->clip_changed
15587 || current_buffer
->prevent_redisplay_optimizations_p
)
15590 /* Window must either use window-based redisplay or be full width. */
15591 if (!FRAME_WINDOW_P (f
)
15592 && (!FRAME_LINE_INS_DEL_OK (f
)
15593 || !WINDOW_FULL_WIDTH_P (w
)))
15596 /* Give up if point is known NOT to appear in W. */
15597 if (PT
< CHARPOS (start
))
15600 /* Another way to prevent redisplay optimizations. */
15601 if (XFASTINT (w
->last_modified
) == 0)
15604 /* Verify that window is not hscrolled. */
15605 if (XFASTINT (w
->hscroll
) != 0)
15608 /* Verify that display wasn't paused. */
15609 if (NILP (w
->window_end_valid
))
15612 /* Can't use this if highlighting a region because a cursor movement
15613 will do more than just set the cursor. */
15614 if (!NILP (Vtransient_mark_mode
)
15615 && !NILP (BVAR (current_buffer
, mark_active
)))
15618 /* Likewise if highlighting trailing whitespace. */
15619 if (!NILP (Vshow_trailing_whitespace
))
15622 /* Likewise if showing a region. */
15623 if (!NILP (w
->region_showing
))
15626 /* Can't use this if overlay arrow position and/or string have
15628 if (overlay_arrows_changed_p ())
15631 /* When word-wrap is on, adding a space to the first word of a
15632 wrapped line can change the wrap position, altering the line
15633 above it. It might be worthwhile to handle this more
15634 intelligently, but for now just redisplay from scratch. */
15635 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15638 /* Under bidi reordering, adding or deleting a character in the
15639 beginning of a paragraph, before the first strong directional
15640 character, can change the base direction of the paragraph (unless
15641 the buffer specifies a fixed paragraph direction), which will
15642 require to redisplay the whole paragraph. It might be worthwhile
15643 to find the paragraph limits and widen the range of redisplayed
15644 lines to that, but for now just give up this optimization and
15645 redisplay from scratch. */
15646 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15647 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15650 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15651 only if buffer has really changed. The reason is that the gap is
15652 initially at Z for freshly visited files. The code below would
15653 set end_unchanged to 0 in that case. */
15654 if (MODIFF
> SAVE_MODIFF
15655 /* This seems to happen sometimes after saving a buffer. */
15656 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15658 if (GPT
- BEG
< BEG_UNCHANGED
)
15659 BEG_UNCHANGED
= GPT
- BEG
;
15660 if (Z
- GPT
< END_UNCHANGED
)
15661 END_UNCHANGED
= Z
- GPT
;
15664 /* The position of the first and last character that has been changed. */
15665 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15666 last_changed_charpos
= Z
- END_UNCHANGED
;
15668 /* If window starts after a line end, and the last change is in
15669 front of that newline, then changes don't affect the display.
15670 This case happens with stealth-fontification. Note that although
15671 the display is unchanged, glyph positions in the matrix have to
15672 be adjusted, of course. */
15673 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15674 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15675 && ((last_changed_charpos
< CHARPOS (start
)
15676 && CHARPOS (start
) == BEGV
)
15677 || (last_changed_charpos
< CHARPOS (start
) - 1
15678 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15680 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15681 struct glyph_row
*r0
;
15683 /* Compute how many chars/bytes have been added to or removed
15684 from the buffer. */
15685 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15686 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15687 Z_delta
= Z
- Z_old
;
15688 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15690 /* Give up if PT is not in the window. Note that it already has
15691 been checked at the start of try_window_id that PT is not in
15692 front of the window start. */
15693 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15696 /* If window start is unchanged, we can reuse the whole matrix
15697 as is, after adjusting glyph positions. No need to compute
15698 the window end again, since its offset from Z hasn't changed. */
15699 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15700 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15701 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15702 /* PT must not be in a partially visible line. */
15703 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15704 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15706 /* Adjust positions in the glyph matrix. */
15707 if (Z_delta
|| Z_delta_bytes
)
15709 struct glyph_row
*r1
15710 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15711 increment_matrix_positions (w
->current_matrix
,
15712 MATRIX_ROW_VPOS (r0
, current_matrix
),
15713 MATRIX_ROW_VPOS (r1
, current_matrix
),
15714 Z_delta
, Z_delta_bytes
);
15717 /* Set the cursor. */
15718 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15720 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15727 /* Handle the case that changes are all below what is displayed in
15728 the window, and that PT is in the window. This shortcut cannot
15729 be taken if ZV is visible in the window, and text has been added
15730 there that is visible in the window. */
15731 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15732 /* ZV is not visible in the window, or there are no
15733 changes at ZV, actually. */
15734 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15735 || first_changed_charpos
== last_changed_charpos
))
15737 struct glyph_row
*r0
;
15739 /* Give up if PT is not in the window. Note that it already has
15740 been checked at the start of try_window_id that PT is not in
15741 front of the window start. */
15742 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15745 /* If window start is unchanged, we can reuse the whole matrix
15746 as is, without changing glyph positions since no text has
15747 been added/removed in front of the window end. */
15748 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15749 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15750 /* PT must not be in a partially visible line. */
15751 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15752 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15754 /* We have to compute the window end anew since text
15755 could have been added/removed after it. */
15757 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15758 w
->window_end_bytepos
15759 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15761 /* Set the cursor. */
15762 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15764 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15771 /* Give up if window start is in the changed area.
15773 The condition used to read
15775 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15777 but why that was tested escapes me at the moment. */
15778 if (CHARPOS (start
) >= first_changed_charpos
15779 && CHARPOS (start
) <= last_changed_charpos
)
15782 /* Check that window start agrees with the start of the first glyph
15783 row in its current matrix. Check this after we know the window
15784 start is not in changed text, otherwise positions would not be
15786 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15787 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15790 /* Give up if the window ends in strings. Overlay strings
15791 at the end are difficult to handle, so don't try. */
15792 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15793 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15796 /* Compute the position at which we have to start displaying new
15797 lines. Some of the lines at the top of the window might be
15798 reusable because they are not displaying changed text. Find the
15799 last row in W's current matrix not affected by changes at the
15800 start of current_buffer. Value is null if changes start in the
15801 first line of window. */
15802 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15803 if (last_unchanged_at_beg_row
)
15805 /* Avoid starting to display in the moddle of a character, a TAB
15806 for instance. This is easier than to set up the iterator
15807 exactly, and it's not a frequent case, so the additional
15808 effort wouldn't really pay off. */
15809 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15810 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15811 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15812 --last_unchanged_at_beg_row
;
15814 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15817 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15819 start_pos
= it
.current
.pos
;
15821 /* Start displaying new lines in the desired matrix at the same
15822 vpos we would use in the current matrix, i.e. below
15823 last_unchanged_at_beg_row. */
15824 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15826 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15827 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15829 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15833 /* There are no reusable lines at the start of the window.
15834 Start displaying in the first text line. */
15835 start_display (&it
, w
, start
);
15836 it
.vpos
= it
.first_vpos
;
15837 start_pos
= it
.current
.pos
;
15840 /* Find the first row that is not affected by changes at the end of
15841 the buffer. Value will be null if there is no unchanged row, in
15842 which case we must redisplay to the end of the window. delta
15843 will be set to the value by which buffer positions beginning with
15844 first_unchanged_at_end_row have to be adjusted due to text
15846 first_unchanged_at_end_row
15847 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15848 IF_DEBUG (debug_delta
= delta
);
15849 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15851 /* Set stop_pos to the buffer position up to which we will have to
15852 display new lines. If first_unchanged_at_end_row != NULL, this
15853 is the buffer position of the start of the line displayed in that
15854 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15855 that we don't stop at a buffer position. */
15857 if (first_unchanged_at_end_row
)
15859 xassert (last_unchanged_at_beg_row
== NULL
15860 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15862 /* If this is a continuation line, move forward to the next one
15863 that isn't. Changes in lines above affect this line.
15864 Caution: this may move first_unchanged_at_end_row to a row
15865 not displaying text. */
15866 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15867 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15868 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15869 < it
.last_visible_y
))
15870 ++first_unchanged_at_end_row
;
15872 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15873 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15874 >= it
.last_visible_y
))
15875 first_unchanged_at_end_row
= NULL
;
15878 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15880 first_unchanged_at_end_vpos
15881 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15882 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15885 else if (last_unchanged_at_beg_row
== NULL
)
15891 /* Either there is no unchanged row at the end, or the one we have
15892 now displays text. This is a necessary condition for the window
15893 end pos calculation at the end of this function. */
15894 xassert (first_unchanged_at_end_row
== NULL
15895 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15897 debug_last_unchanged_at_beg_vpos
15898 = (last_unchanged_at_beg_row
15899 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15901 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15903 #endif /* GLYPH_DEBUG != 0 */
15906 /* Display new lines. Set last_text_row to the last new line
15907 displayed which has text on it, i.e. might end up as being the
15908 line where the window_end_vpos is. */
15909 w
->cursor
.vpos
= -1;
15910 last_text_row
= NULL
;
15911 overlay_arrow_seen
= 0;
15912 while (it
.current_y
< it
.last_visible_y
15913 && !fonts_changed_p
15914 && (first_unchanged_at_end_row
== NULL
15915 || IT_CHARPOS (it
) < stop_pos
))
15917 if (display_line (&it
))
15918 last_text_row
= it
.glyph_row
- 1;
15921 if (fonts_changed_p
)
15925 /* Compute differences in buffer positions, y-positions etc. for
15926 lines reused at the bottom of the window. Compute what we can
15928 if (first_unchanged_at_end_row
15929 /* No lines reused because we displayed everything up to the
15930 bottom of the window. */
15931 && it
.current_y
< it
.last_visible_y
)
15934 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15936 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15937 run
.current_y
= first_unchanged_at_end_row
->y
;
15938 run
.desired_y
= run
.current_y
+ dy
;
15939 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15943 delta
= delta_bytes
= dvpos
= dy
15944 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15945 first_unchanged_at_end_row
= NULL
;
15947 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15950 /* Find the cursor if not already found. We have to decide whether
15951 PT will appear on this window (it sometimes doesn't, but this is
15952 not a very frequent case.) This decision has to be made before
15953 the current matrix is altered. A value of cursor.vpos < 0 means
15954 that PT is either in one of the lines beginning at
15955 first_unchanged_at_end_row or below the window. Don't care for
15956 lines that might be displayed later at the window end; as
15957 mentioned, this is not a frequent case. */
15958 if (w
->cursor
.vpos
< 0)
15960 /* Cursor in unchanged rows at the top? */
15961 if (PT
< CHARPOS (start_pos
)
15962 && last_unchanged_at_beg_row
)
15964 row
= row_containing_pos (w
, PT
,
15965 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15966 last_unchanged_at_beg_row
+ 1, 0);
15968 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15971 /* Start from first_unchanged_at_end_row looking for PT. */
15972 else if (first_unchanged_at_end_row
)
15974 row
= row_containing_pos (w
, PT
- delta
,
15975 first_unchanged_at_end_row
, NULL
, 0);
15977 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15978 delta_bytes
, dy
, dvpos
);
15981 /* Give up if cursor was not found. */
15982 if (w
->cursor
.vpos
< 0)
15984 clear_glyph_matrix (w
->desired_matrix
);
15989 /* Don't let the cursor end in the scroll margins. */
15991 int this_scroll_margin
, cursor_height
;
15993 this_scroll_margin
= max (0, scroll_margin
);
15994 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15995 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15996 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15998 if ((w
->cursor
.y
< this_scroll_margin
15999 && CHARPOS (start
) > BEGV
)
16000 /* Old redisplay didn't take scroll margin into account at the bottom,
16001 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16002 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16003 ? cursor_height
+ this_scroll_margin
16004 : 1)) > it
.last_visible_y
)
16006 w
->cursor
.vpos
= -1;
16007 clear_glyph_matrix (w
->desired_matrix
);
16012 /* Scroll the display. Do it before changing the current matrix so
16013 that xterm.c doesn't get confused about where the cursor glyph is
16015 if (dy
&& run
.height
)
16019 if (FRAME_WINDOW_P (f
))
16021 FRAME_RIF (f
)->update_window_begin_hook (w
);
16022 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16023 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16024 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16028 /* Terminal frame. In this case, dvpos gives the number of
16029 lines to scroll by; dvpos < 0 means scroll up. */
16031 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16032 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16033 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16034 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16035 + window_internal_height (w
));
16037 #if defined (HAVE_GPM) || defined (MSDOS)
16038 x_clear_window_mouse_face (w
);
16040 /* Perform the operation on the screen. */
16043 /* Scroll last_unchanged_at_beg_row to the end of the
16044 window down dvpos lines. */
16045 set_terminal_window (f
, end
);
16047 /* On dumb terminals delete dvpos lines at the end
16048 before inserting dvpos empty lines. */
16049 if (!FRAME_SCROLL_REGION_OK (f
))
16050 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16052 /* Insert dvpos empty lines in front of
16053 last_unchanged_at_beg_row. */
16054 ins_del_lines (f
, from
, dvpos
);
16056 else if (dvpos
< 0)
16058 /* Scroll up last_unchanged_at_beg_vpos to the end of
16059 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16060 set_terminal_window (f
, end
);
16062 /* Delete dvpos lines in front of
16063 last_unchanged_at_beg_vpos. ins_del_lines will set
16064 the cursor to the given vpos and emit |dvpos| delete
16066 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16068 /* On a dumb terminal insert dvpos empty lines at the
16070 if (!FRAME_SCROLL_REGION_OK (f
))
16071 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16074 set_terminal_window (f
, 0);
16080 /* Shift reused rows of the current matrix to the right position.
16081 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16083 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16084 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16087 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16088 bottom_vpos
, dvpos
);
16089 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16092 else if (dvpos
> 0)
16094 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16095 bottom_vpos
, dvpos
);
16096 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16097 first_unchanged_at_end_vpos
+ dvpos
, 0);
16100 /* For frame-based redisplay, make sure that current frame and window
16101 matrix are in sync with respect to glyph memory. */
16102 if (!FRAME_WINDOW_P (f
))
16103 sync_frame_with_window_matrix_rows (w
);
16105 /* Adjust buffer positions in reused rows. */
16106 if (delta
|| delta_bytes
)
16107 increment_matrix_positions (current_matrix
,
16108 first_unchanged_at_end_vpos
+ dvpos
,
16109 bottom_vpos
, delta
, delta_bytes
);
16111 /* Adjust Y positions. */
16113 shift_glyph_matrix (w
, current_matrix
,
16114 first_unchanged_at_end_vpos
+ dvpos
,
16117 if (first_unchanged_at_end_row
)
16119 first_unchanged_at_end_row
+= dvpos
;
16120 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16121 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16122 first_unchanged_at_end_row
= NULL
;
16125 /* If scrolling up, there may be some lines to display at the end of
16127 last_text_row_at_end
= NULL
;
16130 /* Scrolling up can leave for example a partially visible line
16131 at the end of the window to be redisplayed. */
16132 /* Set last_row to the glyph row in the current matrix where the
16133 window end line is found. It has been moved up or down in
16134 the matrix by dvpos. */
16135 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16136 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16138 /* If last_row is the window end line, it should display text. */
16139 xassert (last_row
->displays_text_p
);
16141 /* If window end line was partially visible before, begin
16142 displaying at that line. Otherwise begin displaying with the
16143 line following it. */
16144 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16146 init_to_row_start (&it
, w
, last_row
);
16147 it
.vpos
= last_vpos
;
16148 it
.current_y
= last_row
->y
;
16152 init_to_row_end (&it
, w
, last_row
);
16153 it
.vpos
= 1 + last_vpos
;
16154 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16158 /* We may start in a continuation line. If so, we have to
16159 get the right continuation_lines_width and current_x. */
16160 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16161 it
.hpos
= it
.current_x
= 0;
16163 /* Display the rest of the lines at the window end. */
16164 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16165 while (it
.current_y
< it
.last_visible_y
16166 && !fonts_changed_p
)
16168 /* Is it always sure that the display agrees with lines in
16169 the current matrix? I don't think so, so we mark rows
16170 displayed invalid in the current matrix by setting their
16171 enabled_p flag to zero. */
16172 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16173 if (display_line (&it
))
16174 last_text_row_at_end
= it
.glyph_row
- 1;
16178 /* Update window_end_pos and window_end_vpos. */
16179 if (first_unchanged_at_end_row
16180 && !last_text_row_at_end
)
16182 /* Window end line if one of the preserved rows from the current
16183 matrix. Set row to the last row displaying text in current
16184 matrix starting at first_unchanged_at_end_row, after
16186 xassert (first_unchanged_at_end_row
->displays_text_p
);
16187 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16188 first_unchanged_at_end_row
);
16189 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16191 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16192 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16194 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16195 xassert (w
->window_end_bytepos
>= 0);
16196 IF_DEBUG (debug_method_add (w
, "A"));
16198 else if (last_text_row_at_end
)
16201 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16202 w
->window_end_bytepos
16203 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16205 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16206 xassert (w
->window_end_bytepos
>= 0);
16207 IF_DEBUG (debug_method_add (w
, "B"));
16209 else if (last_text_row
)
16211 /* We have displayed either to the end of the window or at the
16212 end of the window, i.e. the last row with text is to be found
16213 in the desired matrix. */
16215 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16216 w
->window_end_bytepos
16217 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16219 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16220 xassert (w
->window_end_bytepos
>= 0);
16222 else if (first_unchanged_at_end_row
== NULL
16223 && last_text_row
== NULL
16224 && last_text_row_at_end
== NULL
)
16226 /* Displayed to end of window, but no line containing text was
16227 displayed. Lines were deleted at the end of the window. */
16228 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16229 int vpos
= XFASTINT (w
->window_end_vpos
);
16230 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16231 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16234 row
== NULL
&& vpos
>= first_vpos
;
16235 --vpos
, --current_row
, --desired_row
)
16237 if (desired_row
->enabled_p
)
16239 if (desired_row
->displays_text_p
)
16242 else if (current_row
->displays_text_p
)
16246 xassert (row
!= NULL
);
16247 w
->window_end_vpos
= make_number (vpos
+ 1);
16248 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16249 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16250 xassert (w
->window_end_bytepos
>= 0);
16251 IF_DEBUG (debug_method_add (w
, "C"));
16256 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16257 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16259 /* Record that display has not been completed. */
16260 w
->window_end_valid
= Qnil
;
16261 w
->desired_matrix
->no_scrolling_p
= 1;
16269 /***********************************************************************
16270 More debugging support
16271 ***********************************************************************/
16275 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
16276 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
16277 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
16280 /* Dump the contents of glyph matrix MATRIX on stderr.
16282 GLYPHS 0 means don't show glyph contents.
16283 GLYPHS 1 means show glyphs in short form
16284 GLYPHS > 1 means show glyphs in long form. */
16287 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
16290 for (i
= 0; i
< matrix
->nrows
; ++i
)
16291 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16295 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16296 the glyph row and area where the glyph comes from. */
16299 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
16301 if (glyph
->type
== CHAR_GLYPH
)
16304 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16305 glyph
- row
->glyphs
[TEXT_AREA
],
16308 (BUFFERP (glyph
->object
)
16310 : (STRINGP (glyph
->object
)
16313 glyph
->pixel_width
,
16315 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16319 glyph
->left_box_line_p
,
16320 glyph
->right_box_line_p
);
16322 else if (glyph
->type
== STRETCH_GLYPH
)
16325 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16326 glyph
- row
->glyphs
[TEXT_AREA
],
16329 (BUFFERP (glyph
->object
)
16331 : (STRINGP (glyph
->object
)
16334 glyph
->pixel_width
,
16338 glyph
->left_box_line_p
,
16339 glyph
->right_box_line_p
);
16341 else if (glyph
->type
== IMAGE_GLYPH
)
16344 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16345 glyph
- row
->glyphs
[TEXT_AREA
],
16348 (BUFFERP (glyph
->object
)
16350 : (STRINGP (glyph
->object
)
16353 glyph
->pixel_width
,
16357 glyph
->left_box_line_p
,
16358 glyph
->right_box_line_p
);
16360 else if (glyph
->type
== COMPOSITE_GLYPH
)
16363 " %5td %4c %6"pI
"d %c %3d 0x%05x",
16364 glyph
- row
->glyphs
[TEXT_AREA
],
16367 (BUFFERP (glyph
->object
)
16369 : (STRINGP (glyph
->object
)
16372 glyph
->pixel_width
,
16374 if (glyph
->u
.cmp
.automatic
)
16377 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16378 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16380 glyph
->left_box_line_p
,
16381 glyph
->right_box_line_p
);
16386 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16387 GLYPHS 0 means don't show glyph contents.
16388 GLYPHS 1 means show glyphs in short form
16389 GLYPHS > 1 means show glyphs in long form. */
16392 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
16396 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16397 fprintf (stderr
, "======================================================================\n");
16399 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
16400 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16402 MATRIX_ROW_START_CHARPOS (row
),
16403 MATRIX_ROW_END_CHARPOS (row
),
16404 row
->used
[TEXT_AREA
],
16405 row
->contains_overlapping_glyphs_p
,
16407 row
->truncated_on_left_p
,
16408 row
->truncated_on_right_p
,
16410 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16411 row
->displays_text_p
,
16414 row
->ends_in_middle_of_char_p
,
16415 row
->starts_in_middle_of_char_p
,
16421 row
->visible_height
,
16424 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16425 row
->end
.overlay_string_index
,
16426 row
->continuation_lines_width
);
16427 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
16428 CHARPOS (row
->start
.string_pos
),
16429 CHARPOS (row
->end
.string_pos
));
16430 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16431 row
->end
.dpvec_index
);
16438 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16440 struct glyph
*glyph
= row
->glyphs
[area
];
16441 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16443 /* Glyph for a line end in text. */
16444 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16447 if (glyph
< glyph_end
)
16448 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16450 for (; glyph
< glyph_end
; ++glyph
)
16451 dump_glyph (row
, glyph
, area
);
16454 else if (glyphs
== 1)
16458 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16460 char *s
= (char *) alloca (row
->used
[area
] + 1);
16463 for (i
= 0; i
< row
->used
[area
]; ++i
)
16465 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16466 if (glyph
->type
== CHAR_GLYPH
16467 && glyph
->u
.ch
< 0x80
16468 && glyph
->u
.ch
>= ' ')
16469 s
[i
] = glyph
->u
.ch
;
16475 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16481 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16482 Sdump_glyph_matrix
, 0, 1, "p",
16483 doc
: /* Dump the current matrix of the selected window to stderr.
16484 Shows contents of glyph row structures. With non-nil
16485 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16486 glyphs in short form, otherwise show glyphs in long form. */)
16487 (Lisp_Object glyphs
)
16489 struct window
*w
= XWINDOW (selected_window
);
16490 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16492 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
16493 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16494 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16495 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16496 fprintf (stderr
, "=============================================\n");
16497 dump_glyph_matrix (w
->current_matrix
,
16498 NILP (glyphs
) ? 0 : XINT (glyphs
));
16503 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16504 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16507 struct frame
*f
= XFRAME (selected_frame
);
16508 dump_glyph_matrix (f
->current_matrix
, 1);
16513 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16514 doc
: /* Dump glyph row ROW to stderr.
16515 GLYPH 0 means don't dump glyphs.
16516 GLYPH 1 means dump glyphs in short form.
16517 GLYPH > 1 or omitted means dump glyphs in long form. */)
16518 (Lisp_Object row
, Lisp_Object glyphs
)
16520 struct glyph_matrix
*matrix
;
16523 CHECK_NUMBER (row
);
16524 matrix
= XWINDOW (selected_window
)->current_matrix
;
16526 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16527 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16529 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16534 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16535 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16536 GLYPH 0 means don't dump glyphs.
16537 GLYPH 1 means dump glyphs in short form.
16538 GLYPH > 1 or omitted means dump glyphs in long form. */)
16539 (Lisp_Object row
, Lisp_Object glyphs
)
16541 struct frame
*sf
= SELECTED_FRAME ();
16542 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16545 CHECK_NUMBER (row
);
16547 if (vpos
>= 0 && vpos
< m
->nrows
)
16548 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16549 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16554 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16555 doc
: /* Toggle tracing of redisplay.
16556 With ARG, turn tracing on if and only if ARG is positive. */)
16560 trace_redisplay_p
= !trace_redisplay_p
;
16563 arg
= Fprefix_numeric_value (arg
);
16564 trace_redisplay_p
= XINT (arg
) > 0;
16571 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16572 doc
: /* Like `format', but print result to stderr.
16573 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16574 (ptrdiff_t nargs
, Lisp_Object
*args
)
16576 Lisp_Object s
= Fformat (nargs
, args
);
16577 fprintf (stderr
, "%s", SDATA (s
));
16581 #endif /* GLYPH_DEBUG */
16585 /***********************************************************************
16586 Building Desired Matrix Rows
16587 ***********************************************************************/
16589 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16590 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16592 static struct glyph_row
*
16593 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16595 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16596 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16597 struct buffer
*old
= current_buffer
;
16598 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16599 int arrow_len
= SCHARS (overlay_arrow_string
);
16600 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16601 const unsigned char *p
;
16604 int n_glyphs_before
;
16606 set_buffer_temp (buffer
);
16607 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16608 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16609 SET_TEXT_POS (it
.position
, 0, 0);
16611 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16613 while (p
< arrow_end
)
16615 Lisp_Object face
, ilisp
;
16617 /* Get the next character. */
16619 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16622 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16623 if (! ASCII_CHAR_P (it
.c
))
16624 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16628 /* Get its face. */
16629 ilisp
= make_number (p
- arrow_string
);
16630 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16631 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16633 /* Compute its width, get its glyphs. */
16634 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16635 SET_TEXT_POS (it
.position
, -1, -1);
16636 PRODUCE_GLYPHS (&it
);
16638 /* If this character doesn't fit any more in the line, we have
16639 to remove some glyphs. */
16640 if (it
.current_x
> it
.last_visible_x
)
16642 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16647 set_buffer_temp (old
);
16648 return it
.glyph_row
;
16652 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16653 glyphs are only inserted for terminal frames since we can't really
16654 win with truncation glyphs when partially visible glyphs are
16655 involved. Which glyphs to insert is determined by
16656 produce_special_glyphs. */
16659 insert_left_trunc_glyphs (struct it
*it
)
16661 struct it truncate_it
;
16662 struct glyph
*from
, *end
, *to
, *toend
;
16664 xassert (!FRAME_WINDOW_P (it
->f
));
16666 /* Get the truncation glyphs. */
16668 truncate_it
.current_x
= 0;
16669 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16670 truncate_it
.glyph_row
= &scratch_glyph_row
;
16671 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16672 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16673 truncate_it
.object
= make_number (0);
16674 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16676 /* Overwrite glyphs from IT with truncation glyphs. */
16677 if (!it
->glyph_row
->reversed_p
)
16679 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16680 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16681 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16682 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16687 /* There may be padding glyphs left over. Overwrite them too. */
16688 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16690 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16696 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16700 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16701 that back to front. */
16702 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16703 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16704 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16705 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16707 while (from
>= end
&& to
>= toend
)
16709 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16712 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16713 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16714 while (from
>= end
&& to
>= toend
)
16719 /* Need to free some room before prepending additional
16721 int move_by
= from
- end
+ 1;
16722 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16723 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16725 for ( ; g
>= g0
; g
--)
16727 while (from
>= end
)
16729 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16735 /* Compute the pixel height and width of IT->glyph_row.
16737 Most of the time, ascent and height of a display line will be equal
16738 to the max_ascent and max_height values of the display iterator
16739 structure. This is not the case if
16741 1. We hit ZV without displaying anything. In this case, max_ascent
16742 and max_height will be zero.
16744 2. We have some glyphs that don't contribute to the line height.
16745 (The glyph row flag contributes_to_line_height_p is for future
16746 pixmap extensions).
16748 The first case is easily covered by using default values because in
16749 these cases, the line height does not really matter, except that it
16750 must not be zero. */
16753 compute_line_metrics (struct it
*it
)
16755 struct glyph_row
*row
= it
->glyph_row
;
16757 if (FRAME_WINDOW_P (it
->f
))
16759 int i
, min_y
, max_y
;
16761 /* The line may consist of one space only, that was added to
16762 place the cursor on it. If so, the row's height hasn't been
16764 if (row
->height
== 0)
16766 if (it
->max_ascent
+ it
->max_descent
== 0)
16767 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16768 row
->ascent
= it
->max_ascent
;
16769 row
->height
= it
->max_ascent
+ it
->max_descent
;
16770 row
->phys_ascent
= it
->max_phys_ascent
;
16771 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16772 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16775 /* Compute the width of this line. */
16776 row
->pixel_width
= row
->x
;
16777 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16778 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16780 xassert (row
->pixel_width
>= 0);
16781 xassert (row
->ascent
>= 0 && row
->height
> 0);
16783 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16784 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16786 /* If first line's physical ascent is larger than its logical
16787 ascent, use the physical ascent, and make the row taller.
16788 This makes accented characters fully visible. */
16789 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16790 && row
->phys_ascent
> row
->ascent
)
16792 row
->height
+= row
->phys_ascent
- row
->ascent
;
16793 row
->ascent
= row
->phys_ascent
;
16796 /* Compute how much of the line is visible. */
16797 row
->visible_height
= row
->height
;
16799 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16800 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16802 if (row
->y
< min_y
)
16803 row
->visible_height
-= min_y
- row
->y
;
16804 if (row
->y
+ row
->height
> max_y
)
16805 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16809 row
->pixel_width
= row
->used
[TEXT_AREA
];
16810 if (row
->continued_p
)
16811 row
->pixel_width
-= it
->continuation_pixel_width
;
16812 else if (row
->truncated_on_right_p
)
16813 row
->pixel_width
-= it
->truncation_pixel_width
;
16814 row
->ascent
= row
->phys_ascent
= 0;
16815 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16816 row
->extra_line_spacing
= 0;
16819 /* Compute a hash code for this row. */
16823 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16824 for (i
= 0; i
< row
->used
[area
]; ++i
)
16825 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16826 + row
->glyphs
[area
][i
].u
.val
16827 + row
->glyphs
[area
][i
].face_id
16828 + row
->glyphs
[area
][i
].padding_p
16829 + (row
->glyphs
[area
][i
].type
<< 2));
16832 it
->max_ascent
= it
->max_descent
= 0;
16833 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16837 /* Append one space to the glyph row of iterator IT if doing a
16838 window-based redisplay. The space has the same face as
16839 IT->face_id. Value is non-zero if a space was added.
16841 This function is called to make sure that there is always one glyph
16842 at the end of a glyph row that the cursor can be set on under
16843 window-systems. (If there weren't such a glyph we would not know
16844 how wide and tall a box cursor should be displayed).
16846 At the same time this space let's a nicely handle clearing to the
16847 end of the line if the row ends in italic text. */
16850 append_space_for_newline (struct it
*it
, int default_face_p
)
16852 if (FRAME_WINDOW_P (it
->f
))
16854 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16856 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16857 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16859 /* Save some values that must not be changed.
16860 Must save IT->c and IT->len because otherwise
16861 ITERATOR_AT_END_P wouldn't work anymore after
16862 append_space_for_newline has been called. */
16863 enum display_element_type saved_what
= it
->what
;
16864 int saved_c
= it
->c
, saved_len
= it
->len
;
16865 int saved_char_to_display
= it
->char_to_display
;
16866 int saved_x
= it
->current_x
;
16867 int saved_face_id
= it
->face_id
;
16868 struct text_pos saved_pos
;
16869 Lisp_Object saved_object
;
16872 saved_object
= it
->object
;
16873 saved_pos
= it
->position
;
16875 it
->what
= IT_CHARACTER
;
16876 memset (&it
->position
, 0, sizeof it
->position
);
16877 it
->object
= make_number (0);
16878 it
->c
= it
->char_to_display
= ' ';
16881 if (default_face_p
)
16882 it
->face_id
= DEFAULT_FACE_ID
;
16883 else if (it
->face_before_selective_p
)
16884 it
->face_id
= it
->saved_face_id
;
16885 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16886 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16888 PRODUCE_GLYPHS (it
);
16890 it
->override_ascent
= -1;
16891 it
->constrain_row_ascent_descent_p
= 0;
16892 it
->current_x
= saved_x
;
16893 it
->object
= saved_object
;
16894 it
->position
= saved_pos
;
16895 it
->what
= saved_what
;
16896 it
->face_id
= saved_face_id
;
16897 it
->len
= saved_len
;
16899 it
->char_to_display
= saved_char_to_display
;
16908 /* Extend the face of the last glyph in the text area of IT->glyph_row
16909 to the end of the display line. Called from display_line. If the
16910 glyph row is empty, add a space glyph to it so that we know the
16911 face to draw. Set the glyph row flag fill_line_p. If the glyph
16912 row is R2L, prepend a stretch glyph to cover the empty space to the
16913 left of the leftmost glyph. */
16916 extend_face_to_end_of_line (struct it
*it
)
16919 struct frame
*f
= it
->f
;
16921 /* If line is already filled, do nothing. Non window-system frames
16922 get a grace of one more ``pixel'' because their characters are
16923 1-``pixel'' wide, so they hit the equality too early. This grace
16924 is needed only for R2L rows that are not continued, to produce
16925 one extra blank where we could display the cursor. */
16926 if (it
->current_x
>= it
->last_visible_x
16927 + (!FRAME_WINDOW_P (f
)
16928 && it
->glyph_row
->reversed_p
16929 && !it
->glyph_row
->continued_p
))
16932 /* Face extension extends the background and box of IT->face_id
16933 to the end of the line. If the background equals the background
16934 of the frame, we don't have to do anything. */
16935 if (it
->face_before_selective_p
)
16936 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16938 face
= FACE_FROM_ID (f
, it
->face_id
);
16940 if (FRAME_WINDOW_P (f
)
16941 && it
->glyph_row
->displays_text_p
16942 && face
->box
== FACE_NO_BOX
16943 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16945 && !it
->glyph_row
->reversed_p
)
16948 /* Set the glyph row flag indicating that the face of the last glyph
16949 in the text area has to be drawn to the end of the text area. */
16950 it
->glyph_row
->fill_line_p
= 1;
16952 /* If current character of IT is not ASCII, make sure we have the
16953 ASCII face. This will be automatically undone the next time
16954 get_next_display_element returns a multibyte character. Note
16955 that the character will always be single byte in unibyte
16957 if (!ASCII_CHAR_P (it
->c
))
16959 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16962 if (FRAME_WINDOW_P (f
))
16964 /* If the row is empty, add a space with the current face of IT,
16965 so that we know which face to draw. */
16966 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16968 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16969 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16970 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16972 #ifdef HAVE_WINDOW_SYSTEM
16973 if (it
->glyph_row
->reversed_p
)
16975 /* Prepend a stretch glyph to the row, such that the
16976 rightmost glyph will be drawn flushed all the way to the
16977 right margin of the window. The stretch glyph that will
16978 occupy the empty space, if any, to the left of the
16980 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16981 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16982 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16984 int row_width
, stretch_ascent
, stretch_width
;
16985 struct text_pos saved_pos
;
16986 int saved_face_id
, saved_avoid_cursor
;
16988 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16989 row_width
+= g
->pixel_width
;
16990 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16991 if (stretch_width
> 0)
16994 (((it
->ascent
+ it
->descent
)
16995 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16996 saved_pos
= it
->position
;
16997 memset (&it
->position
, 0, sizeof it
->position
);
16998 saved_avoid_cursor
= it
->avoid_cursor_p
;
16999 it
->avoid_cursor_p
= 1;
17000 saved_face_id
= it
->face_id
;
17001 /* The last row's stretch glyph should get the default
17002 face, to avoid painting the rest of the window with
17003 the region face, if the region ends at ZV. */
17004 if (it
->glyph_row
->ends_at_zv_p
)
17005 it
->face_id
= DEFAULT_FACE_ID
;
17007 it
->face_id
= face
->id
;
17008 append_stretch_glyph (it
, make_number (0), stretch_width
,
17009 it
->ascent
+ it
->descent
, stretch_ascent
);
17010 it
->position
= saved_pos
;
17011 it
->avoid_cursor_p
= saved_avoid_cursor
;
17012 it
->face_id
= saved_face_id
;
17015 #endif /* HAVE_WINDOW_SYSTEM */
17019 /* Save some values that must not be changed. */
17020 int saved_x
= it
->current_x
;
17021 struct text_pos saved_pos
;
17022 Lisp_Object saved_object
;
17023 enum display_element_type saved_what
= it
->what
;
17024 int saved_face_id
= it
->face_id
;
17026 saved_object
= it
->object
;
17027 saved_pos
= it
->position
;
17029 it
->what
= IT_CHARACTER
;
17030 memset (&it
->position
, 0, sizeof it
->position
);
17031 it
->object
= make_number (0);
17032 it
->c
= it
->char_to_display
= ' ';
17034 /* The last row's blank glyphs should get the default face, to
17035 avoid painting the rest of the window with the region face,
17036 if the region ends at ZV. */
17037 if (it
->glyph_row
->ends_at_zv_p
)
17038 it
->face_id
= DEFAULT_FACE_ID
;
17040 it
->face_id
= face
->id
;
17042 PRODUCE_GLYPHS (it
);
17044 while (it
->current_x
<= it
->last_visible_x
)
17045 PRODUCE_GLYPHS (it
);
17047 /* Don't count these blanks really. It would let us insert a left
17048 truncation glyph below and make us set the cursor on them, maybe. */
17049 it
->current_x
= saved_x
;
17050 it
->object
= saved_object
;
17051 it
->position
= saved_pos
;
17052 it
->what
= saved_what
;
17053 it
->face_id
= saved_face_id
;
17058 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17059 trailing whitespace. */
17062 trailing_whitespace_p (EMACS_INT charpos
)
17064 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17067 while (bytepos
< ZV_BYTE
17068 && (c
= FETCH_CHAR (bytepos
),
17069 c
== ' ' || c
== '\t'))
17072 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17074 if (bytepos
!= PT_BYTE
)
17081 /* Highlight trailing whitespace, if any, in ROW. */
17084 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17086 int used
= row
->used
[TEXT_AREA
];
17090 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17091 struct glyph
*glyph
= start
+ used
- 1;
17093 if (row
->reversed_p
)
17095 /* Right-to-left rows need to be processed in the opposite
17096 direction, so swap the edge pointers. */
17098 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17101 /* Skip over glyphs inserted to display the cursor at the
17102 end of a line, for extending the face of the last glyph
17103 to the end of the line on terminals, and for truncation
17104 and continuation glyphs. */
17105 if (!row
->reversed_p
)
17107 while (glyph
>= start
17108 && glyph
->type
== CHAR_GLYPH
17109 && INTEGERP (glyph
->object
))
17114 while (glyph
<= start
17115 && glyph
->type
== CHAR_GLYPH
17116 && INTEGERP (glyph
->object
))
17120 /* If last glyph is a space or stretch, and it's trailing
17121 whitespace, set the face of all trailing whitespace glyphs in
17122 IT->glyph_row to `trailing-whitespace'. */
17123 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17124 && BUFFERP (glyph
->object
)
17125 && (glyph
->type
== STRETCH_GLYPH
17126 || (glyph
->type
== CHAR_GLYPH
17127 && glyph
->u
.ch
== ' '))
17128 && trailing_whitespace_p (glyph
->charpos
))
17130 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17134 if (!row
->reversed_p
)
17136 while (glyph
>= start
17137 && BUFFERP (glyph
->object
)
17138 && (glyph
->type
== STRETCH_GLYPH
17139 || (glyph
->type
== CHAR_GLYPH
17140 && glyph
->u
.ch
== ' ')))
17141 (glyph
--)->face_id
= face_id
;
17145 while (glyph
<= start
17146 && BUFFERP (glyph
->object
)
17147 && (glyph
->type
== STRETCH_GLYPH
17148 || (glyph
->type
== CHAR_GLYPH
17149 && glyph
->u
.ch
== ' ')))
17150 (glyph
++)->face_id
= face_id
;
17157 /* Value is non-zero if glyph row ROW should be
17158 used to hold the cursor. */
17161 cursor_row_p (struct glyph_row
*row
)
17165 if (PT
== CHARPOS (row
->end
.pos
))
17167 /* Suppose the row ends on a string.
17168 Unless the row is continued, that means it ends on a newline
17169 in the string. If it's anything other than a display string
17170 (e.g. a before-string from an overlay), we don't want the
17171 cursor there. (This heuristic seems to give the optimal
17172 behavior for the various types of multi-line strings.) */
17173 if (CHARPOS (row
->end
.string_pos
) >= 0)
17175 if (row
->continued_p
)
17179 /* Check for `display' property. */
17180 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17181 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17182 struct glyph
*glyph
;
17185 for (glyph
= end
; glyph
>= beg
; --glyph
)
17186 if (STRINGP (glyph
->object
))
17189 = Fget_char_property (make_number (PT
),
17193 && display_prop_string_p (prop
, glyph
->object
));
17198 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17200 /* If the row ends in middle of a real character,
17201 and the line is continued, we want the cursor here.
17202 That's because CHARPOS (ROW->end.pos) would equal
17203 PT if PT is before the character. */
17204 if (!row
->ends_in_ellipsis_p
)
17205 result
= row
->continued_p
;
17207 /* If the row ends in an ellipsis, then
17208 CHARPOS (ROW->end.pos) will equal point after the
17209 invisible text. We want that position to be displayed
17210 after the ellipsis. */
17213 /* If the row ends at ZV, display the cursor at the end of that
17214 row instead of at the start of the row below. */
17215 else if (row
->ends_at_zv_p
)
17226 /* Push the display property PROP so that it will be rendered at the
17227 current position in IT. Return 1 if PROP was successfully pushed,
17231 push_display_prop (struct it
*it
, Lisp_Object prop
)
17233 push_it (it
, NULL
);
17235 if (STRINGP (prop
))
17237 if (SCHARS (prop
) == 0)
17244 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17245 it
->current
.overlay_string_index
= -1;
17246 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17247 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17248 it
->method
= GET_FROM_STRING
;
17249 it
->stop_charpos
= 0;
17251 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17253 it
->method
= GET_FROM_STRETCH
;
17256 #ifdef HAVE_WINDOW_SYSTEM
17257 else if (IMAGEP (prop
))
17259 it
->what
= IT_IMAGE
;
17260 it
->image_id
= lookup_image (it
->f
, prop
);
17261 it
->method
= GET_FROM_IMAGE
;
17263 #endif /* HAVE_WINDOW_SYSTEM */
17266 pop_it (it
); /* bogus display property, give up */
17273 /* Return the character-property PROP at the current position in IT. */
17276 get_it_property (struct it
*it
, Lisp_Object prop
)
17278 Lisp_Object position
;
17280 if (STRINGP (it
->object
))
17281 position
= make_number (IT_STRING_CHARPOS (*it
));
17282 else if (BUFFERP (it
->object
))
17283 position
= make_number (IT_CHARPOS (*it
));
17287 return Fget_char_property (position
, prop
, it
->object
);
17290 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17293 handle_line_prefix (struct it
*it
)
17295 Lisp_Object prefix
;
17296 if (it
->continuation_lines_width
> 0)
17298 prefix
= get_it_property (it
, Qwrap_prefix
);
17300 prefix
= Vwrap_prefix
;
17304 prefix
= get_it_property (it
, Qline_prefix
);
17306 prefix
= Vline_prefix
;
17308 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17310 /* If the prefix is wider than the window, and we try to wrap
17311 it, it would acquire its own wrap prefix, and so on till the
17312 iterator stack overflows. So, don't wrap the prefix. */
17313 it
->line_wrap
= TRUNCATE
;
17314 it
->avoid_cursor_p
= 1;
17320 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17321 only for R2L lines from display_line, when it decides that too many
17322 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17325 unproduce_glyphs (struct it
*it
, int n
)
17327 struct glyph
*glyph
, *end
;
17329 xassert (it
->glyph_row
);
17330 xassert (it
->glyph_row
->reversed_p
);
17331 xassert (it
->area
== TEXT_AREA
);
17332 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17334 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17335 n
= it
->glyph_row
->used
[TEXT_AREA
];
17336 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17337 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17338 for ( ; glyph
< end
; glyph
++)
17339 glyph
[-n
] = *glyph
;
17342 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17343 and ROW->maxpos. */
17345 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17346 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17347 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17349 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17350 lines' rows is implemented for bidi-reordered rows. */
17352 /* ROW->minpos is the value of min_pos, the minimal buffer position
17355 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17357 /* We didn't find _any_ valid buffer positions in any of the
17358 glyphs, so we must trust the iterator's computed positions. */
17359 row
->minpos
= row
->start
.pos
;
17362 max_pos
= CHARPOS (it
->current
.pos
);
17363 max_bpos
= BYTEPOS (it
->current
.pos
);
17366 /* Here are the various use-cases for ending the row, and the
17367 corresponding values for ROW->maxpos:
17369 Line ends in a newline from buffer eol_pos + 1
17370 Line is continued from buffer max_pos + 1
17371 Line is truncated on right it->current.pos
17372 Line ends in a newline from string max_pos
17373 Line is continued from string max_pos
17374 Line is continued from display vector max_pos
17375 Line is entirely from a string min_pos == max_pos
17376 Line is entirely from a display vector min_pos == max_pos
17377 Line that ends at ZV ZV
17379 If you discover other use-cases, please add them here as
17381 if (row
->ends_at_zv_p
)
17382 row
->maxpos
= it
->current
.pos
;
17383 else if (row
->used
[TEXT_AREA
])
17385 if (row
->ends_in_newline_from_string_p
)
17386 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17387 else if (CHARPOS (it
->eol_pos
) > 0)
17388 SET_TEXT_POS (row
->maxpos
,
17389 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17390 else if (row
->continued_p
)
17392 /* If max_pos is different from IT's current position, it
17393 means IT->method does not belong to the display element
17394 at max_pos. However, it also means that the display
17395 element at max_pos was displayed in its entirety on this
17396 line, which is equivalent to saying that the next line
17397 starts at the next buffer position. */
17398 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17399 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17402 INC_BOTH (max_pos
, max_bpos
);
17403 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17406 else if (row
->truncated_on_right_p
)
17407 /* display_line already called reseat_at_next_visible_line_start,
17408 which puts the iterator at the beginning of the next line, in
17409 the logical order. */
17410 row
->maxpos
= it
->current
.pos
;
17411 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17412 /* A line that is entirely from a string/image/stretch... */
17413 row
->maxpos
= row
->minpos
;
17418 row
->maxpos
= it
->current
.pos
;
17421 /* Construct the glyph row IT->glyph_row in the desired matrix of
17422 IT->w from text at the current position of IT. See dispextern.h
17423 for an overview of struct it. Value is non-zero if
17424 IT->glyph_row displays text, as opposed to a line displaying ZV
17428 display_line (struct it
*it
)
17430 struct glyph_row
*row
= it
->glyph_row
;
17431 Lisp_Object overlay_arrow_string
;
17433 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17434 int wrap_row_used
= -1;
17435 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17436 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17437 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17438 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17439 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17441 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17442 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17444 /* We always start displaying at hpos zero even if hscrolled. */
17445 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17447 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17448 >= it
->w
->desired_matrix
->nrows
)
17450 it
->w
->nrows_scale_factor
++;
17451 fonts_changed_p
= 1;
17455 /* Is IT->w showing the region? */
17456 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17458 /* Clear the result glyph row and enable it. */
17459 prepare_desired_row (row
);
17461 row
->y
= it
->current_y
;
17462 row
->start
= it
->start
;
17463 row
->continuation_lines_width
= it
->continuation_lines_width
;
17464 row
->displays_text_p
= 1;
17465 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17466 it
->starts_in_middle_of_char_p
= 0;
17468 /* Arrange the overlays nicely for our purposes. Usually, we call
17469 display_line on only one line at a time, in which case this
17470 can't really hurt too much, or we call it on lines which appear
17471 one after another in the buffer, in which case all calls to
17472 recenter_overlay_lists but the first will be pretty cheap. */
17473 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17475 /* Move over display elements that are not visible because we are
17476 hscrolled. This may stop at an x-position < IT->first_visible_x
17477 if the first glyph is partially visible or if we hit a line end. */
17478 if (it
->current_x
< it
->first_visible_x
)
17480 this_line_min_pos
= row
->start
.pos
;
17481 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17482 MOVE_TO_POS
| MOVE_TO_X
);
17483 /* Record the smallest positions seen while we moved over
17484 display elements that are not visible. This is needed by
17485 redisplay_internal for optimizing the case where the cursor
17486 stays inside the same line. The rest of this function only
17487 considers positions that are actually displayed, so
17488 RECORD_MAX_MIN_POS will not otherwise record positions that
17489 are hscrolled to the left of the left edge of the window. */
17490 min_pos
= CHARPOS (this_line_min_pos
);
17491 min_bpos
= BYTEPOS (this_line_min_pos
);
17495 /* We only do this when not calling `move_it_in_display_line_to'
17496 above, because move_it_in_display_line_to calls
17497 handle_line_prefix itself. */
17498 handle_line_prefix (it
);
17501 /* Get the initial row height. This is either the height of the
17502 text hscrolled, if there is any, or zero. */
17503 row
->ascent
= it
->max_ascent
;
17504 row
->height
= it
->max_ascent
+ it
->max_descent
;
17505 row
->phys_ascent
= it
->max_phys_ascent
;
17506 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17507 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17509 /* Utility macro to record max and min buffer positions seen until now. */
17510 #define RECORD_MAX_MIN_POS(IT) \
17513 if (IT_CHARPOS (*(IT)) < min_pos) \
17515 min_pos = IT_CHARPOS (*(IT)); \
17516 min_bpos = IT_BYTEPOS (*(IT)); \
17518 if (IT_CHARPOS (*(IT)) > max_pos) \
17520 max_pos = IT_CHARPOS (*(IT)); \
17521 max_bpos = IT_BYTEPOS (*(IT)); \
17526 /* Loop generating characters. The loop is left with IT on the next
17527 character to display. */
17530 int n_glyphs_before
, hpos_before
, x_before
;
17532 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17534 /* Retrieve the next thing to display. Value is zero if end of
17536 if (!get_next_display_element (it
))
17538 /* Maybe add a space at the end of this line that is used to
17539 display the cursor there under X. Set the charpos of the
17540 first glyph of blank lines not corresponding to any text
17542 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17543 row
->exact_window_width_line_p
= 1;
17544 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17545 || row
->used
[TEXT_AREA
] == 0)
17547 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17548 row
->displays_text_p
= 0;
17550 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17551 && (!MINI_WINDOW_P (it
->w
)
17552 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17553 row
->indicate_empty_line_p
= 1;
17556 it
->continuation_lines_width
= 0;
17557 row
->ends_at_zv_p
= 1;
17558 /* A row that displays right-to-left text must always have
17559 its last face extended all the way to the end of line,
17560 even if this row ends in ZV, because we still write to
17561 the screen left to right. */
17562 if (row
->reversed_p
)
17563 extend_face_to_end_of_line (it
);
17567 /* Now, get the metrics of what we want to display. This also
17568 generates glyphs in `row' (which is IT->glyph_row). */
17569 n_glyphs_before
= row
->used
[TEXT_AREA
];
17572 /* Remember the line height so far in case the next element doesn't
17573 fit on the line. */
17574 if (it
->line_wrap
!= TRUNCATE
)
17576 ascent
= it
->max_ascent
;
17577 descent
= it
->max_descent
;
17578 phys_ascent
= it
->max_phys_ascent
;
17579 phys_descent
= it
->max_phys_descent
;
17581 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17583 if (IT_DISPLAYING_WHITESPACE (it
))
17589 wrap_row_used
= row
->used
[TEXT_AREA
];
17590 wrap_row_ascent
= row
->ascent
;
17591 wrap_row_height
= row
->height
;
17592 wrap_row_phys_ascent
= row
->phys_ascent
;
17593 wrap_row_phys_height
= row
->phys_height
;
17594 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17595 wrap_row_min_pos
= min_pos
;
17596 wrap_row_min_bpos
= min_bpos
;
17597 wrap_row_max_pos
= max_pos
;
17598 wrap_row_max_bpos
= max_bpos
;
17604 PRODUCE_GLYPHS (it
);
17606 /* If this display element was in marginal areas, continue with
17608 if (it
->area
!= TEXT_AREA
)
17610 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17611 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17612 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17613 row
->phys_height
= max (row
->phys_height
,
17614 it
->max_phys_ascent
+ it
->max_phys_descent
);
17615 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17616 it
->max_extra_line_spacing
);
17617 set_iterator_to_next (it
, 1);
17621 /* Does the display element fit on the line? If we truncate
17622 lines, we should draw past the right edge of the window. If
17623 we don't truncate, we want to stop so that we can display the
17624 continuation glyph before the right margin. If lines are
17625 continued, there are two possible strategies for characters
17626 resulting in more than 1 glyph (e.g. tabs): Display as many
17627 glyphs as possible in this line and leave the rest for the
17628 continuation line, or display the whole element in the next
17629 line. Original redisplay did the former, so we do it also. */
17630 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17631 hpos_before
= it
->hpos
;
17634 if (/* Not a newline. */
17636 /* Glyphs produced fit entirely in the line. */
17637 && it
->current_x
< it
->last_visible_x
)
17639 it
->hpos
+= nglyphs
;
17640 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17641 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17642 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17643 row
->phys_height
= max (row
->phys_height
,
17644 it
->max_phys_ascent
+ it
->max_phys_descent
);
17645 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17646 it
->max_extra_line_spacing
);
17647 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17648 row
->x
= x
- it
->first_visible_x
;
17649 /* Record the maximum and minimum buffer positions seen so
17650 far in glyphs that will be displayed by this row. */
17652 RECORD_MAX_MIN_POS (it
);
17657 struct glyph
*glyph
;
17659 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17661 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17662 new_x
= x
+ glyph
->pixel_width
;
17664 if (/* Lines are continued. */
17665 it
->line_wrap
!= TRUNCATE
17666 && (/* Glyph doesn't fit on the line. */
17667 new_x
> it
->last_visible_x
17668 /* Or it fits exactly on a window system frame. */
17669 || (new_x
== it
->last_visible_x
17670 && FRAME_WINDOW_P (it
->f
))))
17672 /* End of a continued line. */
17675 || (new_x
== it
->last_visible_x
17676 && FRAME_WINDOW_P (it
->f
)))
17678 /* Current glyph is the only one on the line or
17679 fits exactly on the line. We must continue
17680 the line because we can't draw the cursor
17681 after the glyph. */
17682 row
->continued_p
= 1;
17683 it
->current_x
= new_x
;
17684 it
->continuation_lines_width
+= new_x
;
17686 /* Record the maximum and minimum buffer
17687 positions seen so far in glyphs that will be
17688 displayed by this row. */
17690 RECORD_MAX_MIN_POS (it
);
17691 if (i
== nglyphs
- 1)
17693 /* If line-wrap is on, check if a previous
17694 wrap point was found. */
17695 if (wrap_row_used
> 0
17696 /* Even if there is a previous wrap
17697 point, continue the line here as
17698 usual, if (i) the previous character
17699 was a space or tab AND (ii) the
17700 current character is not. */
17702 || IT_DISPLAYING_WHITESPACE (it
)))
17705 set_iterator_to_next (it
, 1);
17706 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17708 if (!get_next_display_element (it
))
17710 row
->exact_window_width_line_p
= 1;
17711 it
->continuation_lines_width
= 0;
17712 row
->continued_p
= 0;
17713 row
->ends_at_zv_p
= 1;
17715 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17717 row
->continued_p
= 0;
17718 row
->exact_window_width_line_p
= 1;
17723 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17724 && !FRAME_WINDOW_P (it
->f
))
17726 /* A padding glyph that doesn't fit on this line.
17727 This means the whole character doesn't fit
17729 if (row
->reversed_p
)
17730 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17731 - n_glyphs_before
);
17732 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17734 /* Fill the rest of the row with continuation
17735 glyphs like in 20.x. */
17736 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17737 < row
->glyphs
[1 + TEXT_AREA
])
17738 produce_special_glyphs (it
, IT_CONTINUATION
);
17740 row
->continued_p
= 1;
17741 it
->current_x
= x_before
;
17742 it
->continuation_lines_width
+= x_before
;
17744 /* Restore the height to what it was before the
17745 element not fitting on the line. */
17746 it
->max_ascent
= ascent
;
17747 it
->max_descent
= descent
;
17748 it
->max_phys_ascent
= phys_ascent
;
17749 it
->max_phys_descent
= phys_descent
;
17751 else if (wrap_row_used
> 0)
17754 if (row
->reversed_p
)
17755 unproduce_glyphs (it
,
17756 row
->used
[TEXT_AREA
] - wrap_row_used
);
17758 it
->continuation_lines_width
+= wrap_x
;
17759 row
->used
[TEXT_AREA
] = wrap_row_used
;
17760 row
->ascent
= wrap_row_ascent
;
17761 row
->height
= wrap_row_height
;
17762 row
->phys_ascent
= wrap_row_phys_ascent
;
17763 row
->phys_height
= wrap_row_phys_height
;
17764 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17765 min_pos
= wrap_row_min_pos
;
17766 min_bpos
= wrap_row_min_bpos
;
17767 max_pos
= wrap_row_max_pos
;
17768 max_bpos
= wrap_row_max_bpos
;
17769 row
->continued_p
= 1;
17770 row
->ends_at_zv_p
= 0;
17771 row
->exact_window_width_line_p
= 0;
17772 it
->continuation_lines_width
+= x
;
17774 /* Make sure that a non-default face is extended
17775 up to the right margin of the window. */
17776 extend_face_to_end_of_line (it
);
17778 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17780 /* A TAB that extends past the right edge of the
17781 window. This produces a single glyph on
17782 window system frames. We leave the glyph in
17783 this row and let it fill the row, but don't
17784 consume the TAB. */
17785 it
->continuation_lines_width
+= it
->last_visible_x
;
17786 row
->ends_in_middle_of_char_p
= 1;
17787 row
->continued_p
= 1;
17788 glyph
->pixel_width
= it
->last_visible_x
- x
;
17789 it
->starts_in_middle_of_char_p
= 1;
17793 /* Something other than a TAB that draws past
17794 the right edge of the window. Restore
17795 positions to values before the element. */
17796 if (row
->reversed_p
)
17797 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17798 - (n_glyphs_before
+ i
));
17799 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17801 /* Display continuation glyphs. */
17802 if (!FRAME_WINDOW_P (it
->f
))
17803 produce_special_glyphs (it
, IT_CONTINUATION
);
17804 row
->continued_p
= 1;
17806 it
->current_x
= x_before
;
17807 it
->continuation_lines_width
+= x
;
17808 extend_face_to_end_of_line (it
);
17810 if (nglyphs
> 1 && i
> 0)
17812 row
->ends_in_middle_of_char_p
= 1;
17813 it
->starts_in_middle_of_char_p
= 1;
17816 /* Restore the height to what it was before the
17817 element not fitting on the line. */
17818 it
->max_ascent
= ascent
;
17819 it
->max_descent
= descent
;
17820 it
->max_phys_ascent
= phys_ascent
;
17821 it
->max_phys_descent
= phys_descent
;
17826 else if (new_x
> it
->first_visible_x
)
17828 /* Increment number of glyphs actually displayed. */
17831 /* Record the maximum and minimum buffer positions
17832 seen so far in glyphs that will be displayed by
17835 RECORD_MAX_MIN_POS (it
);
17837 if (x
< it
->first_visible_x
)
17838 /* Glyph is partially visible, i.e. row starts at
17839 negative X position. */
17840 row
->x
= x
- it
->first_visible_x
;
17844 /* Glyph is completely off the left margin of the
17845 window. This should not happen because of the
17846 move_it_in_display_line at the start of this
17847 function, unless the text display area of the
17848 window is empty. */
17849 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17853 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17854 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17855 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17856 row
->phys_height
= max (row
->phys_height
,
17857 it
->max_phys_ascent
+ it
->max_phys_descent
);
17858 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17859 it
->max_extra_line_spacing
);
17861 /* End of this display line if row is continued. */
17862 if (row
->continued_p
|| row
->ends_at_zv_p
)
17867 /* Is this a line end? If yes, we're also done, after making
17868 sure that a non-default face is extended up to the right
17869 margin of the window. */
17870 if (ITERATOR_AT_END_OF_LINE_P (it
))
17872 int used_before
= row
->used
[TEXT_AREA
];
17874 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17876 /* Add a space at the end of the line that is used to
17877 display the cursor there. */
17878 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17879 append_space_for_newline (it
, 0);
17881 /* Extend the face to the end of the line. */
17882 extend_face_to_end_of_line (it
);
17884 /* Make sure we have the position. */
17885 if (used_before
== 0)
17886 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17888 /* Record the position of the newline, for use in
17890 it
->eol_pos
= it
->current
.pos
;
17892 /* Consume the line end. This skips over invisible lines. */
17893 set_iterator_to_next (it
, 1);
17894 it
->continuation_lines_width
= 0;
17898 /* Proceed with next display element. Note that this skips
17899 over lines invisible because of selective display. */
17900 set_iterator_to_next (it
, 1);
17902 /* If we truncate lines, we are done when the last displayed
17903 glyphs reach past the right margin of the window. */
17904 if (it
->line_wrap
== TRUNCATE
17905 && (FRAME_WINDOW_P (it
->f
)
17906 ? (it
->current_x
>= it
->last_visible_x
)
17907 : (it
->current_x
> it
->last_visible_x
)))
17909 /* Maybe add truncation glyphs. */
17910 if (!FRAME_WINDOW_P (it
->f
))
17914 if (!row
->reversed_p
)
17916 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17917 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17922 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17923 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17925 /* Remove any padding glyphs at the front of ROW, to
17926 make room for the truncation glyphs we will be
17927 adding below. The loop below always inserts at
17928 least one truncation glyph, so also remove the
17929 last glyph added to ROW. */
17930 unproduce_glyphs (it
, i
+ 1);
17931 /* Adjust i for the loop below. */
17932 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17935 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17937 row
->used
[TEXT_AREA
] = i
;
17938 produce_special_glyphs (it
, IT_TRUNCATION
);
17941 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17943 /* Don't truncate if we can overflow newline into fringe. */
17944 if (!get_next_display_element (it
))
17946 it
->continuation_lines_width
= 0;
17947 row
->ends_at_zv_p
= 1;
17948 row
->exact_window_width_line_p
= 1;
17951 if (ITERATOR_AT_END_OF_LINE_P (it
))
17953 row
->exact_window_width_line_p
= 1;
17954 goto at_end_of_line
;
17958 row
->truncated_on_right_p
= 1;
17959 it
->continuation_lines_width
= 0;
17960 reseat_at_next_visible_line_start (it
, 0);
17961 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17962 it
->hpos
= hpos_before
;
17963 it
->current_x
= x_before
;
17968 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17969 at the left window margin. */
17970 if (it
->first_visible_x
17971 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17973 if (!FRAME_WINDOW_P (it
->f
))
17974 insert_left_trunc_glyphs (it
);
17975 row
->truncated_on_left_p
= 1;
17978 /* Remember the position at which this line ends.
17980 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17981 cannot be before the call to find_row_edges below, since that is
17982 where these positions are determined. */
17983 row
->end
= it
->current
;
17986 row
->minpos
= row
->start
.pos
;
17987 row
->maxpos
= row
->end
.pos
;
17991 /* ROW->minpos and ROW->maxpos must be the smallest and
17992 `1 + the largest' buffer positions in ROW. But if ROW was
17993 bidi-reordered, these two positions can be anywhere in the
17994 row, so we must determine them now. */
17995 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17998 /* If the start of this line is the overlay arrow-position, then
17999 mark this glyph row as the one containing the overlay arrow.
18000 This is clearly a mess with variable size fonts. It would be
18001 better to let it be displayed like cursors under X. */
18002 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18003 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18004 !NILP (overlay_arrow_string
)))
18006 /* Overlay arrow in window redisplay is a fringe bitmap. */
18007 if (STRINGP (overlay_arrow_string
))
18009 struct glyph_row
*arrow_row
18010 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18011 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18012 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18013 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18014 struct glyph
*p2
, *end
;
18016 /* Copy the arrow glyphs. */
18017 while (glyph
< arrow_end
)
18020 /* Throw away padding glyphs. */
18022 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18023 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18029 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18034 xassert (INTEGERP (overlay_arrow_string
));
18035 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18037 overlay_arrow_seen
= 1;
18040 /* Compute pixel dimensions of this line. */
18041 compute_line_metrics (it
);
18043 /* Record whether this row ends inside an ellipsis. */
18044 row
->ends_in_ellipsis_p
18045 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18046 && it
->ellipsis_p
);
18048 /* Save fringe bitmaps in this row. */
18049 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18050 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18051 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18052 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18054 it
->left_user_fringe_bitmap
= 0;
18055 it
->left_user_fringe_face_id
= 0;
18056 it
->right_user_fringe_bitmap
= 0;
18057 it
->right_user_fringe_face_id
= 0;
18059 /* Maybe set the cursor. */
18060 cvpos
= it
->w
->cursor
.vpos
;
18062 /* In bidi-reordered rows, keep checking for proper cursor
18063 position even if one has been found already, because buffer
18064 positions in such rows change non-linearly with ROW->VPOS,
18065 when a line is continued. One exception: when we are at ZV,
18066 display cursor on the first suitable glyph row, since all
18067 the empty rows after that also have their position set to ZV. */
18068 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18069 lines' rows is implemented for bidi-reordered rows. */
18071 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18072 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18073 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18074 && cursor_row_p (row
))
18075 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18077 /* Highlight trailing whitespace. */
18078 if (!NILP (Vshow_trailing_whitespace
))
18079 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18081 /* Prepare for the next line. This line starts horizontally at (X
18082 HPOS) = (0 0). Vertical positions are incremented. As a
18083 convenience for the caller, IT->glyph_row is set to the next
18085 it
->current_x
= it
->hpos
= 0;
18086 it
->current_y
+= row
->height
;
18087 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18090 /* The next row should by default use the same value of the
18091 reversed_p flag as this one. set_iterator_to_next decides when
18092 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18093 the flag accordingly. */
18094 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18095 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18096 it
->start
= row
->end
;
18097 return row
->displays_text_p
;
18099 #undef RECORD_MAX_MIN_POS
18102 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18103 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18104 doc
: /* Return paragraph direction at point in BUFFER.
18105 Value is either `left-to-right' or `right-to-left'.
18106 If BUFFER is omitted or nil, it defaults to the current buffer.
18108 Paragraph direction determines how the text in the paragraph is displayed.
18109 In left-to-right paragraphs, text begins at the left margin of the window
18110 and the reading direction is generally left to right. In right-to-left
18111 paragraphs, text begins at the right margin and is read from right to left.
18113 See also `bidi-paragraph-direction'. */)
18114 (Lisp_Object buffer
)
18116 struct buffer
*buf
= current_buffer
;
18117 struct buffer
*old
= buf
;
18119 if (! NILP (buffer
))
18121 CHECK_BUFFER (buffer
);
18122 buf
= XBUFFER (buffer
);
18125 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18126 return Qleft_to_right
;
18127 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18128 return BVAR (buf
, bidi_paragraph_direction
);
18131 /* Determine the direction from buffer text. We could try to
18132 use current_matrix if it is up to date, but this seems fast
18133 enough as it is. */
18134 struct bidi_it itb
;
18135 EMACS_INT pos
= BUF_PT (buf
);
18136 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18139 set_buffer_temp (buf
);
18140 /* bidi_paragraph_init finds the base direction of the paragraph
18141 by searching forward from paragraph start. We need the base
18142 direction of the current or _previous_ paragraph, so we need
18143 to make sure we are within that paragraph. To that end, find
18144 the previous non-empty line. */
18145 if (pos
>= ZV
&& pos
> BEGV
)
18148 bytepos
= CHAR_TO_BYTE (pos
);
18150 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18151 || c
== ' ' || c
== '\t' || c
== '\f')
18153 if (bytepos
<= BEGV_BYTE
)
18158 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18161 itb
.bytepos
= bytepos
;
18163 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18165 itb
.separator_limit
= -1;
18166 itb
.paragraph_dir
= NEUTRAL_DIR
;
18168 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18169 set_buffer_temp (old
);
18170 switch (itb
.paragraph_dir
)
18173 return Qleft_to_right
;
18176 return Qright_to_left
;
18186 /***********************************************************************
18188 ***********************************************************************/
18190 /* Redisplay the menu bar in the frame for window W.
18192 The menu bar of X frames that don't have X toolkit support is
18193 displayed in a special window W->frame->menu_bar_window.
18195 The menu bar of terminal frames is treated specially as far as
18196 glyph matrices are concerned. Menu bar lines are not part of
18197 windows, so the update is done directly on the frame matrix rows
18198 for the menu bar. */
18201 display_menu_bar (struct window
*w
)
18203 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18208 /* Don't do all this for graphical frames. */
18210 if (FRAME_W32_P (f
))
18213 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18219 if (FRAME_NS_P (f
))
18221 #endif /* HAVE_NS */
18223 #ifdef USE_X_TOOLKIT
18224 xassert (!FRAME_WINDOW_P (f
));
18225 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18226 it
.first_visible_x
= 0;
18227 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18228 #else /* not USE_X_TOOLKIT */
18229 if (FRAME_WINDOW_P (f
))
18231 /* Menu bar lines are displayed in the desired matrix of the
18232 dummy window menu_bar_window. */
18233 struct window
*menu_w
;
18234 xassert (WINDOWP (f
->menu_bar_window
));
18235 menu_w
= XWINDOW (f
->menu_bar_window
);
18236 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18238 it
.first_visible_x
= 0;
18239 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18243 /* This is a TTY frame, i.e. character hpos/vpos are used as
18245 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18247 it
.first_visible_x
= 0;
18248 it
.last_visible_x
= FRAME_COLS (f
);
18250 #endif /* not USE_X_TOOLKIT */
18252 if (! mode_line_inverse_video
)
18253 /* Force the menu-bar to be displayed in the default face. */
18254 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18256 /* Clear all rows of the menu bar. */
18257 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18259 struct glyph_row
*row
= it
.glyph_row
+ i
;
18260 clear_glyph_row (row
);
18261 row
->enabled_p
= 1;
18262 row
->full_width_p
= 1;
18265 /* Display all items of the menu bar. */
18266 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18267 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18269 Lisp_Object string
;
18271 /* Stop at nil string. */
18272 string
= AREF (items
, i
+ 1);
18276 /* Remember where item was displayed. */
18277 ASET (items
, i
+ 3, make_number (it
.hpos
));
18279 /* Display the item, pad with one space. */
18280 if (it
.current_x
< it
.last_visible_x
)
18281 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18282 SCHARS (string
) + 1, 0, 0, -1);
18285 /* Fill out the line with spaces. */
18286 if (it
.current_x
< it
.last_visible_x
)
18287 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18289 /* Compute the total height of the lines. */
18290 compute_line_metrics (&it
);
18295 /***********************************************************************
18297 ***********************************************************************/
18299 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18300 FORCE is non-zero, redisplay mode lines unconditionally.
18301 Otherwise, redisplay only mode lines that are garbaged. Value is
18302 the number of windows whose mode lines were redisplayed. */
18305 redisplay_mode_lines (Lisp_Object window
, int force
)
18309 while (!NILP (window
))
18311 struct window
*w
= XWINDOW (window
);
18313 if (WINDOWP (w
->hchild
))
18314 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18315 else if (WINDOWP (w
->vchild
))
18316 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18318 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18319 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18321 struct text_pos lpoint
;
18322 struct buffer
*old
= current_buffer
;
18324 /* Set the window's buffer for the mode line display. */
18325 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18326 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18328 /* Point refers normally to the selected window. For any
18329 other window, set up appropriate value. */
18330 if (!EQ (window
, selected_window
))
18332 struct text_pos pt
;
18334 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18335 if (CHARPOS (pt
) < BEGV
)
18336 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18337 else if (CHARPOS (pt
) > (ZV
- 1))
18338 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18340 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18343 /* Display mode lines. */
18344 clear_glyph_matrix (w
->desired_matrix
);
18345 if (display_mode_lines (w
))
18348 w
->must_be_updated_p
= 1;
18351 /* Restore old settings. */
18352 set_buffer_internal_1 (old
);
18353 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18363 /* Display the mode and/or header line of window W. Value is the
18364 sum number of mode lines and header lines displayed. */
18367 display_mode_lines (struct window
*w
)
18369 Lisp_Object old_selected_window
, old_selected_frame
;
18372 old_selected_frame
= selected_frame
;
18373 selected_frame
= w
->frame
;
18374 old_selected_window
= selected_window
;
18375 XSETWINDOW (selected_window
, w
);
18377 /* These will be set while the mode line specs are processed. */
18378 line_number_displayed
= 0;
18379 w
->column_number_displayed
= Qnil
;
18381 if (WINDOW_WANTS_MODELINE_P (w
))
18383 struct window
*sel_w
= XWINDOW (old_selected_window
);
18385 /* Select mode line face based on the real selected window. */
18386 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18387 BVAR (current_buffer
, mode_line_format
));
18391 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18393 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18394 BVAR (current_buffer
, header_line_format
));
18398 selected_frame
= old_selected_frame
;
18399 selected_window
= old_selected_window
;
18404 /* Display mode or header line of window W. FACE_ID specifies which
18405 line to display; it is either MODE_LINE_FACE_ID or
18406 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18407 display. Value is the pixel height of the mode/header line
18411 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18415 int count
= SPECPDL_INDEX ();
18417 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18418 /* Don't extend on a previously drawn mode-line.
18419 This may happen if called from pos_visible_p. */
18420 it
.glyph_row
->enabled_p
= 0;
18421 prepare_desired_row (it
.glyph_row
);
18423 it
.glyph_row
->mode_line_p
= 1;
18425 if (! mode_line_inverse_video
)
18426 /* Force the mode-line to be displayed in the default face. */
18427 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18429 record_unwind_protect (unwind_format_mode_line
,
18430 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18432 mode_line_target
= MODE_LINE_DISPLAY
;
18434 /* Temporarily make frame's keyboard the current kboard so that
18435 kboard-local variables in the mode_line_format will get the right
18437 push_kboard (FRAME_KBOARD (it
.f
));
18438 record_unwind_save_match_data ();
18439 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18442 unbind_to (count
, Qnil
);
18444 /* Fill up with spaces. */
18445 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18447 compute_line_metrics (&it
);
18448 it
.glyph_row
->full_width_p
= 1;
18449 it
.glyph_row
->continued_p
= 0;
18450 it
.glyph_row
->truncated_on_left_p
= 0;
18451 it
.glyph_row
->truncated_on_right_p
= 0;
18453 /* Make a 3D mode-line have a shadow at its right end. */
18454 face
= FACE_FROM_ID (it
.f
, face_id
);
18455 extend_face_to_end_of_line (&it
);
18456 if (face
->box
!= FACE_NO_BOX
)
18458 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18459 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18460 last
->right_box_line_p
= 1;
18463 return it
.glyph_row
->height
;
18466 /* Move element ELT in LIST to the front of LIST.
18467 Return the updated list. */
18470 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18472 register Lisp_Object tail
, prev
;
18473 register Lisp_Object tem
;
18477 while (CONSP (tail
))
18483 /* Splice out the link TAIL. */
18485 list
= XCDR (tail
);
18487 Fsetcdr (prev
, XCDR (tail
));
18489 /* Now make it the first. */
18490 Fsetcdr (tail
, list
);
18495 tail
= XCDR (tail
);
18499 /* Not found--return unchanged LIST. */
18503 /* Contribute ELT to the mode line for window IT->w. How it
18504 translates into text depends on its data type.
18506 IT describes the display environment in which we display, as usual.
18508 DEPTH is the depth in recursion. It is used to prevent
18509 infinite recursion here.
18511 FIELD_WIDTH is the number of characters the display of ELT should
18512 occupy in the mode line, and PRECISION is the maximum number of
18513 characters to display from ELT's representation. See
18514 display_string for details.
18516 Returns the hpos of the end of the text generated by ELT.
18518 PROPS is a property list to add to any string we encounter.
18520 If RISKY is nonzero, remove (disregard) any properties in any string
18521 we encounter, and ignore :eval and :propertize.
18523 The global variable `mode_line_target' determines whether the
18524 output is passed to `store_mode_line_noprop',
18525 `store_mode_line_string', or `display_string'. */
18528 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18529 Lisp_Object elt
, Lisp_Object props
, int risky
)
18531 int n
= 0, field
, prec
;
18536 elt
= build_string ("*too-deep*");
18540 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18544 /* A string: output it and check for %-constructs within it. */
18546 EMACS_INT offset
= 0;
18548 if (SCHARS (elt
) > 0
18549 && (!NILP (props
) || risky
))
18551 Lisp_Object oprops
, aelt
;
18552 oprops
= Ftext_properties_at (make_number (0), elt
);
18554 /* If the starting string's properties are not what
18555 we want, translate the string. Also, if the string
18556 is risky, do that anyway. */
18558 if (NILP (Fequal (props
, oprops
)) || risky
)
18560 /* If the starting string has properties,
18561 merge the specified ones onto the existing ones. */
18562 if (! NILP (oprops
) && !risky
)
18566 oprops
= Fcopy_sequence (oprops
);
18568 while (CONSP (tem
))
18570 oprops
= Fplist_put (oprops
, XCAR (tem
),
18571 XCAR (XCDR (tem
)));
18572 tem
= XCDR (XCDR (tem
));
18577 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18578 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18580 /* AELT is what we want. Move it to the front
18581 without consing. */
18583 mode_line_proptrans_alist
18584 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18590 /* If AELT has the wrong props, it is useless.
18591 so get rid of it. */
18593 mode_line_proptrans_alist
18594 = Fdelq (aelt
, mode_line_proptrans_alist
);
18596 elt
= Fcopy_sequence (elt
);
18597 Fset_text_properties (make_number (0), Flength (elt
),
18599 /* Add this item to mode_line_proptrans_alist. */
18600 mode_line_proptrans_alist
18601 = Fcons (Fcons (elt
, props
),
18602 mode_line_proptrans_alist
);
18603 /* Truncate mode_line_proptrans_alist
18604 to at most 50 elements. */
18605 tem
= Fnthcdr (make_number (50),
18606 mode_line_proptrans_alist
);
18608 XSETCDR (tem
, Qnil
);
18617 prec
= precision
- n
;
18618 switch (mode_line_target
)
18620 case MODE_LINE_NOPROP
:
18621 case MODE_LINE_TITLE
:
18622 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18624 case MODE_LINE_STRING
:
18625 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18627 case MODE_LINE_DISPLAY
:
18628 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18629 0, prec
, 0, STRING_MULTIBYTE (elt
));
18636 /* Handle the non-literal case. */
18638 while ((precision
<= 0 || n
< precision
)
18639 && SREF (elt
, offset
) != 0
18640 && (mode_line_target
!= MODE_LINE_DISPLAY
18641 || it
->current_x
< it
->last_visible_x
))
18643 EMACS_INT last_offset
= offset
;
18645 /* Advance to end of string or next format specifier. */
18646 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18649 if (offset
- 1 != last_offset
)
18651 EMACS_INT nchars
, nbytes
;
18653 /* Output to end of string or up to '%'. Field width
18654 is length of string. Don't output more than
18655 PRECISION allows us. */
18658 prec
= c_string_width (SDATA (elt
) + last_offset
,
18659 offset
- last_offset
, precision
- n
,
18662 switch (mode_line_target
)
18664 case MODE_LINE_NOPROP
:
18665 case MODE_LINE_TITLE
:
18666 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18668 case MODE_LINE_STRING
:
18670 EMACS_INT bytepos
= last_offset
;
18671 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18672 EMACS_INT endpos
= (precision
<= 0
18673 ? string_byte_to_char (elt
, offset
)
18674 : charpos
+ nchars
);
18676 n
+= store_mode_line_string (NULL
,
18677 Fsubstring (elt
, make_number (charpos
),
18678 make_number (endpos
)),
18682 case MODE_LINE_DISPLAY
:
18684 EMACS_INT bytepos
= last_offset
;
18685 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18687 if (precision
<= 0)
18688 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18689 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18691 STRING_MULTIBYTE (elt
));
18696 else /* c == '%' */
18698 EMACS_INT percent_position
= offset
;
18700 /* Get the specified minimum width. Zero means
18703 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18704 field
= field
* 10 + c
- '0';
18706 /* Don't pad beyond the total padding allowed. */
18707 if (field_width
- n
> 0 && field
> field_width
- n
)
18708 field
= field_width
- n
;
18710 /* Note that either PRECISION <= 0 or N < PRECISION. */
18711 prec
= precision
- n
;
18714 n
+= display_mode_element (it
, depth
, field
, prec
,
18715 Vglobal_mode_string
, props
,
18720 EMACS_INT bytepos
, charpos
;
18722 Lisp_Object string
;
18724 bytepos
= percent_position
;
18725 charpos
= (STRING_MULTIBYTE (elt
)
18726 ? string_byte_to_char (elt
, bytepos
)
18728 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18729 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18731 switch (mode_line_target
)
18733 case MODE_LINE_NOPROP
:
18734 case MODE_LINE_TITLE
:
18735 n
+= store_mode_line_noprop (spec
, field
, prec
);
18737 case MODE_LINE_STRING
:
18739 Lisp_Object tem
= build_string (spec
);
18740 props
= Ftext_properties_at (make_number (charpos
), elt
);
18741 /* Should only keep face property in props */
18742 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18745 case MODE_LINE_DISPLAY
:
18747 int nglyphs_before
, nwritten
;
18749 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18750 nwritten
= display_string (spec
, string
, elt
,
18755 /* Assign to the glyphs written above the
18756 string where the `%x' came from, position
18760 struct glyph
*glyph
18761 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18765 for (i
= 0; i
< nwritten
; ++i
)
18767 glyph
[i
].object
= elt
;
18768 glyph
[i
].charpos
= charpos
;
18785 /* A symbol: process the value of the symbol recursively
18786 as if it appeared here directly. Avoid error if symbol void.
18787 Special case: if value of symbol is a string, output the string
18790 register Lisp_Object tem
;
18792 /* If the variable is not marked as risky to set
18793 then its contents are risky to use. */
18794 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18797 tem
= Fboundp (elt
);
18800 tem
= Fsymbol_value (elt
);
18801 /* If value is a string, output that string literally:
18802 don't check for % within it. */
18806 if (!EQ (tem
, elt
))
18808 /* Give up right away for nil or t. */
18818 register Lisp_Object car
, tem
;
18820 /* A cons cell: five distinct cases.
18821 If first element is :eval or :propertize, do something special.
18822 If first element is a string or a cons, process all the elements
18823 and effectively concatenate them.
18824 If first element is a negative number, truncate displaying cdr to
18825 at most that many characters. If positive, pad (with spaces)
18826 to at least that many characters.
18827 If first element is a symbol, process the cadr or caddr recursively
18828 according to whether the symbol's value is non-nil or nil. */
18830 if (EQ (car
, QCeval
))
18832 /* An element of the form (:eval FORM) means evaluate FORM
18833 and use the result as mode line elements. */
18838 if (CONSP (XCDR (elt
)))
18841 spec
= safe_eval (XCAR (XCDR (elt
)));
18842 n
+= display_mode_element (it
, depth
, field_width
- n
,
18843 precision
- n
, spec
, props
,
18847 else if (EQ (car
, QCpropertize
))
18849 /* An element of the form (:propertize ELT PROPS...)
18850 means display ELT but applying properties PROPS. */
18855 if (CONSP (XCDR (elt
)))
18856 n
+= display_mode_element (it
, depth
, field_width
- n
,
18857 precision
- n
, XCAR (XCDR (elt
)),
18858 XCDR (XCDR (elt
)), risky
);
18860 else if (SYMBOLP (car
))
18862 tem
= Fboundp (car
);
18866 /* elt is now the cdr, and we know it is a cons cell.
18867 Use its car if CAR has a non-nil value. */
18870 tem
= Fsymbol_value (car
);
18877 /* Symbol's value is nil (or symbol is unbound)
18878 Get the cddr of the original list
18879 and if possible find the caddr and use that. */
18883 else if (!CONSP (elt
))
18888 else if (INTEGERP (car
))
18890 register int lim
= XINT (car
);
18894 /* Negative int means reduce maximum width. */
18895 if (precision
<= 0)
18898 precision
= min (precision
, -lim
);
18902 /* Padding specified. Don't let it be more than
18903 current maximum. */
18905 lim
= min (precision
, lim
);
18907 /* If that's more padding than already wanted, queue it.
18908 But don't reduce padding already specified even if
18909 that is beyond the current truncation point. */
18910 field_width
= max (lim
, field_width
);
18914 else if (STRINGP (car
) || CONSP (car
))
18916 Lisp_Object halftail
= elt
;
18920 && (precision
<= 0 || n
< precision
))
18922 n
+= display_mode_element (it
, depth
,
18923 /* Do padding only after the last
18924 element in the list. */
18925 (! CONSP (XCDR (elt
))
18928 precision
- n
, XCAR (elt
),
18932 if ((len
& 1) == 0)
18933 halftail
= XCDR (halftail
);
18934 /* Check for cycle. */
18935 if (EQ (halftail
, elt
))
18944 elt
= build_string ("*invalid*");
18948 /* Pad to FIELD_WIDTH. */
18949 if (field_width
> 0 && n
< field_width
)
18951 switch (mode_line_target
)
18953 case MODE_LINE_NOPROP
:
18954 case MODE_LINE_TITLE
:
18955 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18957 case MODE_LINE_STRING
:
18958 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18960 case MODE_LINE_DISPLAY
:
18961 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18970 /* Store a mode-line string element in mode_line_string_list.
18972 If STRING is non-null, display that C string. Otherwise, the Lisp
18973 string LISP_STRING is displayed.
18975 FIELD_WIDTH is the minimum number of output glyphs to produce.
18976 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18977 with spaces. FIELD_WIDTH <= 0 means don't pad.
18979 PRECISION is the maximum number of characters to output from
18980 STRING. PRECISION <= 0 means don't truncate the string.
18982 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18983 properties to the string.
18985 PROPS are the properties to add to the string.
18986 The mode_line_string_face face property is always added to the string.
18990 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18991 int field_width
, int precision
, Lisp_Object props
)
18996 if (string
!= NULL
)
18998 len
= strlen (string
);
18999 if (precision
> 0 && len
> precision
)
19001 lisp_string
= make_string (string
, len
);
19003 props
= mode_line_string_face_prop
;
19004 else if (!NILP (mode_line_string_face
))
19006 Lisp_Object face
= Fplist_get (props
, Qface
);
19007 props
= Fcopy_sequence (props
);
19009 face
= mode_line_string_face
;
19011 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19012 props
= Fplist_put (props
, Qface
, face
);
19014 Fadd_text_properties (make_number (0), make_number (len
),
19015 props
, lisp_string
);
19019 len
= XFASTINT (Flength (lisp_string
));
19020 if (precision
> 0 && len
> precision
)
19023 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19026 if (!NILP (mode_line_string_face
))
19030 props
= Ftext_properties_at (make_number (0), lisp_string
);
19031 face
= Fplist_get (props
, Qface
);
19033 face
= mode_line_string_face
;
19035 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19036 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19038 lisp_string
= Fcopy_sequence (lisp_string
);
19041 Fadd_text_properties (make_number (0), make_number (len
),
19042 props
, lisp_string
);
19047 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19051 if (field_width
> len
)
19053 field_width
-= len
;
19054 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19056 Fadd_text_properties (make_number (0), make_number (field_width
),
19057 props
, lisp_string
);
19058 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19066 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19068 doc
: /* Format a string out of a mode line format specification.
19069 First arg FORMAT specifies the mode line format (see `mode-line-format'
19070 for details) to use.
19072 By default, the format is evaluated for the currently selected window.
19074 Optional second arg FACE specifies the face property to put on all
19075 characters for which no face is specified. The value nil means the
19076 default face. The value t means whatever face the window's mode line
19077 currently uses (either `mode-line' or `mode-line-inactive',
19078 depending on whether the window is the selected window or not).
19079 An integer value means the value string has no text
19082 Optional third and fourth args WINDOW and BUFFER specify the window
19083 and buffer to use as the context for the formatting (defaults
19084 are the selected window and the WINDOW's buffer). */)
19085 (Lisp_Object format
, Lisp_Object face
,
19086 Lisp_Object window
, Lisp_Object buffer
)
19091 struct buffer
*old_buffer
= NULL
;
19093 int no_props
= INTEGERP (face
);
19094 int count
= SPECPDL_INDEX ();
19096 int string_start
= 0;
19099 window
= selected_window
;
19100 CHECK_WINDOW (window
);
19101 w
= XWINDOW (window
);
19104 buffer
= w
->buffer
;
19105 CHECK_BUFFER (buffer
);
19107 /* Make formatting the modeline a non-op when noninteractive, otherwise
19108 there will be problems later caused by a partially initialized frame. */
19109 if (NILP (format
) || noninteractive
)
19110 return empty_unibyte_string
;
19115 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19116 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19117 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19118 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19119 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19120 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19121 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19124 if (XBUFFER (buffer
) != current_buffer
)
19125 old_buffer
= current_buffer
;
19127 /* Save things including mode_line_proptrans_alist,
19128 and set that to nil so that we don't alter the outer value. */
19129 record_unwind_protect (unwind_format_mode_line
,
19130 format_mode_line_unwind_data
19131 (old_buffer
, selected_window
, 1));
19132 mode_line_proptrans_alist
= Qnil
;
19134 Fselect_window (window
, Qt
);
19136 set_buffer_internal_1 (XBUFFER (buffer
));
19138 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19142 mode_line_target
= MODE_LINE_NOPROP
;
19143 mode_line_string_face_prop
= Qnil
;
19144 mode_line_string_list
= Qnil
;
19145 string_start
= MODE_LINE_NOPROP_LEN (0);
19149 mode_line_target
= MODE_LINE_STRING
;
19150 mode_line_string_list
= Qnil
;
19151 mode_line_string_face
= face
;
19152 mode_line_string_face_prop
19153 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19156 push_kboard (FRAME_KBOARD (it
.f
));
19157 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19162 len
= MODE_LINE_NOPROP_LEN (string_start
);
19163 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19167 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19168 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19169 empty_unibyte_string
);
19172 unbind_to (count
, Qnil
);
19176 /* Write a null-terminated, right justified decimal representation of
19177 the positive integer D to BUF using a minimal field width WIDTH. */
19180 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19182 register char *p
= buf
;
19190 *p
++ = d
% 10 + '0';
19195 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19206 /* Write a null-terminated, right justified decimal and "human
19207 readable" representation of the nonnegative integer D to BUF using
19208 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19210 static const char power_letter
[] =
19224 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19226 /* We aim to represent the nonnegative integer D as
19227 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19228 EMACS_INT quotient
= d
;
19230 /* -1 means: do not use TENTHS. */
19234 /* Length of QUOTIENT.TENTHS as a string. */
19240 if (1000 <= quotient
)
19242 /* Scale to the appropriate EXPONENT. */
19245 remainder
= quotient
% 1000;
19249 while (1000 <= quotient
);
19251 /* Round to nearest and decide whether to use TENTHS or not. */
19254 tenths
= remainder
/ 100;
19255 if (50 <= remainder
% 100)
19262 if (quotient
== 10)
19270 if (500 <= remainder
)
19272 if (quotient
< 999)
19283 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19284 if (tenths
== -1 && quotient
<= 99)
19291 p
= psuffix
= buf
+ max (width
, length
);
19293 /* Print EXPONENT. */
19294 *psuffix
++ = power_letter
[exponent
];
19297 /* Print TENTHS. */
19300 *--p
= '0' + tenths
;
19304 /* Print QUOTIENT. */
19307 int digit
= quotient
% 10;
19308 *--p
= '0' + digit
;
19310 while ((quotient
/= 10) != 0);
19312 /* Print leading spaces. */
19317 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19318 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19319 type of CODING_SYSTEM. Return updated pointer into BUF. */
19321 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19324 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19327 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19328 const unsigned char *eol_str
;
19330 /* The EOL conversion we are using. */
19331 Lisp_Object eoltype
;
19333 val
= CODING_SYSTEM_SPEC (coding_system
);
19336 if (!VECTORP (val
)) /* Not yet decided. */
19341 eoltype
= eol_mnemonic_undecided
;
19342 /* Don't mention EOL conversion if it isn't decided. */
19347 Lisp_Object eolvalue
;
19349 attrs
= AREF (val
, 0);
19350 eolvalue
= AREF (val
, 2);
19353 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19357 /* The EOL conversion that is normal on this system. */
19359 if (NILP (eolvalue
)) /* Not yet decided. */
19360 eoltype
= eol_mnemonic_undecided
;
19361 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19362 eoltype
= eol_mnemonic_undecided
;
19363 else /* eolvalue is Qunix, Qdos, or Qmac. */
19364 eoltype
= (EQ (eolvalue
, Qunix
)
19365 ? eol_mnemonic_unix
19366 : (EQ (eolvalue
, Qdos
) == 1
19367 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19373 /* Mention the EOL conversion if it is not the usual one. */
19374 if (STRINGP (eoltype
))
19376 eol_str
= SDATA (eoltype
);
19377 eol_str_len
= SBYTES (eoltype
);
19379 else if (CHARACTERP (eoltype
))
19381 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19382 int c
= XFASTINT (eoltype
);
19383 eol_str_len
= CHAR_STRING (c
, tmp
);
19388 eol_str
= invalid_eol_type
;
19389 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19391 memcpy (buf
, eol_str
, eol_str_len
);
19392 buf
+= eol_str_len
;
19398 /* Return a string for the output of a mode line %-spec for window W,
19399 generated by character C. FIELD_WIDTH > 0 means pad the string
19400 returned with spaces to that value. Return a Lisp string in
19401 *STRING if the resulting string is taken from that Lisp string.
19403 Note we operate on the current buffer for most purposes,
19404 the exception being w->base_line_pos. */
19406 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19408 static const char *
19409 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19410 Lisp_Object
*string
)
19413 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19414 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19415 struct buffer
*b
= current_buffer
;
19423 if (!NILP (BVAR (b
, read_only
)))
19425 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19430 /* This differs from %* only for a modified read-only buffer. */
19431 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19433 if (!NILP (BVAR (b
, read_only
)))
19438 /* This differs from %* in ignoring read-only-ness. */
19439 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19451 if (command_loop_level
> 5)
19453 p
= decode_mode_spec_buf
;
19454 for (i
= 0; i
< command_loop_level
; i
++)
19457 return decode_mode_spec_buf
;
19465 if (command_loop_level
> 5)
19467 p
= decode_mode_spec_buf
;
19468 for (i
= 0; i
< command_loop_level
; i
++)
19471 return decode_mode_spec_buf
;
19478 /* Let lots_of_dashes be a string of infinite length. */
19479 if (mode_line_target
== MODE_LINE_NOPROP
||
19480 mode_line_target
== MODE_LINE_STRING
)
19482 if (field_width
<= 0
19483 || field_width
> sizeof (lots_of_dashes
))
19485 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19486 decode_mode_spec_buf
[i
] = '-';
19487 decode_mode_spec_buf
[i
] = '\0';
19488 return decode_mode_spec_buf
;
19491 return lots_of_dashes
;
19495 obj
= BVAR (b
, name
);
19499 /* %c and %l are ignored in `frame-title-format'.
19500 (In redisplay_internal, the frame title is drawn _before_ the
19501 windows are updated, so the stuff which depends on actual
19502 window contents (such as %l) may fail to render properly, or
19503 even crash emacs.) */
19504 if (mode_line_target
== MODE_LINE_TITLE
)
19508 EMACS_INT col
= current_column ();
19509 w
->column_number_displayed
= make_number (col
);
19510 pint2str (decode_mode_spec_buf
, field_width
, col
);
19511 return decode_mode_spec_buf
;
19515 #ifndef SYSTEM_MALLOC
19517 if (NILP (Vmemory_full
))
19520 return "!MEM FULL! ";
19527 /* %F displays the frame name. */
19528 if (!NILP (f
->title
))
19529 return SSDATA (f
->title
);
19530 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19531 return SSDATA (f
->name
);
19535 obj
= BVAR (b
, filename
);
19540 EMACS_INT size
= ZV
- BEGV
;
19541 pint2str (decode_mode_spec_buf
, field_width
, size
);
19542 return decode_mode_spec_buf
;
19547 EMACS_INT size
= ZV
- BEGV
;
19548 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19549 return decode_mode_spec_buf
;
19554 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19555 EMACS_INT topline
, nlines
, height
;
19558 /* %c and %l are ignored in `frame-title-format'. */
19559 if (mode_line_target
== MODE_LINE_TITLE
)
19562 startpos
= XMARKER (w
->start
)->charpos
;
19563 startpos_byte
= marker_byte_position (w
->start
);
19564 height
= WINDOW_TOTAL_LINES (w
);
19566 /* If we decided that this buffer isn't suitable for line numbers,
19567 don't forget that too fast. */
19568 if (EQ (w
->base_line_pos
, w
->buffer
))
19570 /* But do forget it, if the window shows a different buffer now. */
19571 else if (BUFFERP (w
->base_line_pos
))
19572 w
->base_line_pos
= Qnil
;
19574 /* If the buffer is very big, don't waste time. */
19575 if (INTEGERP (Vline_number_display_limit
)
19576 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19578 w
->base_line_pos
= Qnil
;
19579 w
->base_line_number
= Qnil
;
19583 if (INTEGERP (w
->base_line_number
)
19584 && INTEGERP (w
->base_line_pos
)
19585 && XFASTINT (w
->base_line_pos
) <= startpos
)
19587 line
= XFASTINT (w
->base_line_number
);
19588 linepos
= XFASTINT (w
->base_line_pos
);
19589 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19594 linepos
= BUF_BEGV (b
);
19595 linepos_byte
= BUF_BEGV_BYTE (b
);
19598 /* Count lines from base line to window start position. */
19599 nlines
= display_count_lines (linepos_byte
,
19603 topline
= nlines
+ line
;
19605 /* Determine a new base line, if the old one is too close
19606 or too far away, or if we did not have one.
19607 "Too close" means it's plausible a scroll-down would
19608 go back past it. */
19609 if (startpos
== BUF_BEGV (b
))
19611 w
->base_line_number
= make_number (topline
);
19612 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19614 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19615 || linepos
== BUF_BEGV (b
))
19617 EMACS_INT limit
= BUF_BEGV (b
);
19618 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19619 EMACS_INT position
;
19620 EMACS_INT distance
=
19621 (height
* 2 + 30) * line_number_display_limit_width
;
19623 if (startpos
- distance
> limit
)
19625 limit
= startpos
- distance
;
19626 limit_byte
= CHAR_TO_BYTE (limit
);
19629 nlines
= display_count_lines (startpos_byte
,
19631 - (height
* 2 + 30),
19633 /* If we couldn't find the lines we wanted within
19634 line_number_display_limit_width chars per line,
19635 give up on line numbers for this window. */
19636 if (position
== limit_byte
&& limit
== startpos
- distance
)
19638 w
->base_line_pos
= w
->buffer
;
19639 w
->base_line_number
= Qnil
;
19643 w
->base_line_number
= make_number (topline
- nlines
);
19644 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19647 /* Now count lines from the start pos to point. */
19648 nlines
= display_count_lines (startpos_byte
,
19649 PT_BYTE
, PT
, &junk
);
19651 /* Record that we did display the line number. */
19652 line_number_displayed
= 1;
19654 /* Make the string to show. */
19655 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19656 return decode_mode_spec_buf
;
19659 char* p
= decode_mode_spec_buf
;
19660 int pad
= field_width
- 2;
19666 return decode_mode_spec_buf
;
19672 obj
= BVAR (b
, mode_name
);
19676 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19682 EMACS_INT pos
= marker_position (w
->start
);
19683 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19685 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19687 if (pos
<= BUF_BEGV (b
))
19692 else if (pos
<= BUF_BEGV (b
))
19696 if (total
> 1000000)
19697 /* Do it differently for a large value, to avoid overflow. */
19698 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19700 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19701 /* We can't normally display a 3-digit number,
19702 so get us a 2-digit number that is close. */
19705 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19706 return decode_mode_spec_buf
;
19710 /* Display percentage of size above the bottom of the screen. */
19713 EMACS_INT toppos
= marker_position (w
->start
);
19714 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19715 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19717 if (botpos
>= BUF_ZV (b
))
19719 if (toppos
<= BUF_BEGV (b
))
19726 if (total
> 1000000)
19727 /* Do it differently for a large value, to avoid overflow. */
19728 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19730 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19731 /* We can't normally display a 3-digit number,
19732 so get us a 2-digit number that is close. */
19735 if (toppos
<= BUF_BEGV (b
))
19736 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19738 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19739 return decode_mode_spec_buf
;
19744 /* status of process */
19745 obj
= Fget_buffer_process (Fcurrent_buffer ());
19747 return "no process";
19749 obj
= Fsymbol_name (Fprocess_status (obj
));
19755 int count
= inhibit_garbage_collection ();
19756 Lisp_Object val
= call1 (intern ("file-remote-p"),
19757 BVAR (current_buffer
, directory
));
19758 unbind_to (count
, Qnil
);
19766 case 't': /* indicate TEXT or BINARY */
19770 /* coding-system (not including end-of-line format) */
19772 /* coding-system (including end-of-line type) */
19774 int eol_flag
= (c
== 'Z');
19775 char *p
= decode_mode_spec_buf
;
19777 if (! FRAME_WINDOW_P (f
))
19779 /* No need to mention EOL here--the terminal never needs
19780 to do EOL conversion. */
19781 p
= decode_mode_spec_coding (CODING_ID_NAME
19782 (FRAME_KEYBOARD_CODING (f
)->id
),
19784 p
= decode_mode_spec_coding (CODING_ID_NAME
19785 (FRAME_TERMINAL_CODING (f
)->id
),
19788 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19791 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19792 #ifdef subprocesses
19793 obj
= Fget_buffer_process (Fcurrent_buffer ());
19794 if (PROCESSP (obj
))
19796 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19798 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19801 #endif /* subprocesses */
19804 return decode_mode_spec_buf
;
19811 return SSDATA (obj
);
19818 /* Count up to COUNT lines starting from START_BYTE.
19819 But don't go beyond LIMIT_BYTE.
19820 Return the number of lines thus found (always nonnegative).
19822 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19825 display_count_lines (EMACS_INT start_byte
,
19826 EMACS_INT limit_byte
, EMACS_INT count
,
19827 EMACS_INT
*byte_pos_ptr
)
19829 register unsigned char *cursor
;
19830 unsigned char *base
;
19832 register EMACS_INT ceiling
;
19833 register unsigned char *ceiling_addr
;
19834 EMACS_INT orig_count
= count
;
19836 /* If we are not in selective display mode,
19837 check only for newlines. */
19838 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19839 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19843 while (start_byte
< limit_byte
)
19845 ceiling
= BUFFER_CEILING_OF (start_byte
);
19846 ceiling
= min (limit_byte
- 1, ceiling
);
19847 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19848 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19851 if (selective_display
)
19852 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19855 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19858 if (cursor
!= ceiling_addr
)
19862 start_byte
+= cursor
- base
+ 1;
19863 *byte_pos_ptr
= start_byte
;
19867 if (++cursor
== ceiling_addr
)
19873 start_byte
+= cursor
- base
;
19878 while (start_byte
> limit_byte
)
19880 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19881 ceiling
= max (limit_byte
, ceiling
);
19882 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19883 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19886 if (selective_display
)
19887 while (--cursor
!= ceiling_addr
19888 && *cursor
!= '\n' && *cursor
!= 015)
19891 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19894 if (cursor
!= ceiling_addr
)
19898 start_byte
+= cursor
- base
+ 1;
19899 *byte_pos_ptr
= start_byte
;
19900 /* When scanning backwards, we should
19901 not count the newline posterior to which we stop. */
19902 return - orig_count
- 1;
19908 /* Here we add 1 to compensate for the last decrement
19909 of CURSOR, which took it past the valid range. */
19910 start_byte
+= cursor
- base
+ 1;
19914 *byte_pos_ptr
= limit_byte
;
19917 return - orig_count
+ count
;
19918 return orig_count
- count
;
19924 /***********************************************************************
19926 ***********************************************************************/
19928 /* Display a NUL-terminated string, starting with index START.
19930 If STRING is non-null, display that C string. Otherwise, the Lisp
19931 string LISP_STRING is displayed. There's a case that STRING is
19932 non-null and LISP_STRING is not nil. It means STRING is a string
19933 data of LISP_STRING. In that case, we display LISP_STRING while
19934 ignoring its text properties.
19936 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19937 FACE_STRING. Display STRING or LISP_STRING with the face at
19938 FACE_STRING_POS in FACE_STRING:
19940 Display the string in the environment given by IT, but use the
19941 standard display table, temporarily.
19943 FIELD_WIDTH is the minimum number of output glyphs to produce.
19944 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19945 with spaces. If STRING has more characters, more than FIELD_WIDTH
19946 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19948 PRECISION is the maximum number of characters to output from
19949 STRING. PRECISION < 0 means don't truncate the string.
19951 This is roughly equivalent to printf format specifiers:
19953 FIELD_WIDTH PRECISION PRINTF
19954 ----------------------------------------
19960 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19961 display them, and < 0 means obey the current buffer's value of
19962 enable_multibyte_characters.
19964 Value is the number of columns displayed. */
19967 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19968 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19969 int field_width
, int precision
, int max_x
, int multibyte
)
19971 int hpos_at_start
= it
->hpos
;
19972 int saved_face_id
= it
->face_id
;
19973 struct glyph_row
*row
= it
->glyph_row
;
19975 /* Initialize the iterator IT for iteration over STRING beginning
19976 with index START. */
19977 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19978 precision
, field_width
, multibyte
);
19979 if (string
&& STRINGP (lisp_string
))
19980 /* LISP_STRING is the one returned by decode_mode_spec. We should
19981 ignore its text properties. */
19982 it
->stop_charpos
= -1;
19984 /* If displaying STRING, set up the face of the iterator
19985 from LISP_STRING, if that's given. */
19986 if (STRINGP (face_string
))
19992 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19993 0, it
->region_beg_charpos
,
19994 it
->region_end_charpos
,
19995 &endptr
, it
->base_face_id
, 0);
19996 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19997 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20000 /* Set max_x to the maximum allowed X position. Don't let it go
20001 beyond the right edge of the window. */
20003 max_x
= it
->last_visible_x
;
20005 max_x
= min (max_x
, it
->last_visible_x
);
20007 /* Skip over display elements that are not visible. because IT->w is
20009 if (it
->current_x
< it
->first_visible_x
)
20010 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20011 MOVE_TO_POS
| MOVE_TO_X
);
20013 row
->ascent
= it
->max_ascent
;
20014 row
->height
= it
->max_ascent
+ it
->max_descent
;
20015 row
->phys_ascent
= it
->max_phys_ascent
;
20016 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20017 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20019 /* This condition is for the case that we are called with current_x
20020 past last_visible_x. */
20021 while (it
->current_x
< max_x
)
20023 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20025 /* Get the next display element. */
20026 if (!get_next_display_element (it
))
20029 /* Produce glyphs. */
20030 x_before
= it
->current_x
;
20031 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20032 PRODUCE_GLYPHS (it
);
20034 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20037 while (i
< nglyphs
)
20039 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20041 if (it
->line_wrap
!= TRUNCATE
20042 && x
+ glyph
->pixel_width
> max_x
)
20044 /* End of continued line or max_x reached. */
20045 if (CHAR_GLYPH_PADDING_P (*glyph
))
20047 /* A wide character is unbreakable. */
20048 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20049 it
->current_x
= x_before
;
20053 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20058 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20060 /* Glyph is at least partially visible. */
20062 if (x
< it
->first_visible_x
)
20063 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20067 /* Glyph is off the left margin of the display area.
20068 Should not happen. */
20072 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20073 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20074 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20075 row
->phys_height
= max (row
->phys_height
,
20076 it
->max_phys_ascent
+ it
->max_phys_descent
);
20077 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20078 it
->max_extra_line_spacing
);
20079 x
+= glyph
->pixel_width
;
20083 /* Stop if max_x reached. */
20087 /* Stop at line ends. */
20088 if (ITERATOR_AT_END_OF_LINE_P (it
))
20090 it
->continuation_lines_width
= 0;
20094 set_iterator_to_next (it
, 1);
20096 /* Stop if truncating at the right edge. */
20097 if (it
->line_wrap
== TRUNCATE
20098 && it
->current_x
>= it
->last_visible_x
)
20100 /* Add truncation mark, but don't do it if the line is
20101 truncated at a padding space. */
20102 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20104 if (!FRAME_WINDOW_P (it
->f
))
20108 if (it
->current_x
> it
->last_visible_x
)
20110 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20111 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20113 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20115 row
->used
[TEXT_AREA
] = ii
;
20116 produce_special_glyphs (it
, IT_TRUNCATION
);
20119 produce_special_glyphs (it
, IT_TRUNCATION
);
20121 it
->glyph_row
->truncated_on_right_p
= 1;
20127 /* Maybe insert a truncation at the left. */
20128 if (it
->first_visible_x
20129 && IT_CHARPOS (*it
) > 0)
20131 if (!FRAME_WINDOW_P (it
->f
))
20132 insert_left_trunc_glyphs (it
);
20133 it
->glyph_row
->truncated_on_left_p
= 1;
20136 it
->face_id
= saved_face_id
;
20138 /* Value is number of columns displayed. */
20139 return it
->hpos
- hpos_at_start
;
20144 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20145 appears as an element of LIST or as the car of an element of LIST.
20146 If PROPVAL is a list, compare each element against LIST in that
20147 way, and return 1/2 if any element of PROPVAL is found in LIST.
20148 Otherwise return 0. This function cannot quit.
20149 The return value is 2 if the text is invisible but with an ellipsis
20150 and 1 if it's invisible and without an ellipsis. */
20153 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20155 register Lisp_Object tail
, proptail
;
20157 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20159 register Lisp_Object tem
;
20161 if (EQ (propval
, tem
))
20163 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20164 return NILP (XCDR (tem
)) ? 1 : 2;
20167 if (CONSP (propval
))
20169 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20171 Lisp_Object propelt
;
20172 propelt
= XCAR (proptail
);
20173 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20175 register Lisp_Object tem
;
20177 if (EQ (propelt
, tem
))
20179 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20180 return NILP (XCDR (tem
)) ? 1 : 2;
20188 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20189 doc
: /* Non-nil if the property makes the text invisible.
20190 POS-OR-PROP can be a marker or number, in which case it is taken to be
20191 a position in the current buffer and the value of the `invisible' property
20192 is checked; or it can be some other value, which is then presumed to be the
20193 value of the `invisible' property of the text of interest.
20194 The non-nil value returned can be t for truly invisible text or something
20195 else if the text is replaced by an ellipsis. */)
20196 (Lisp_Object pos_or_prop
)
20199 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20200 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20202 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20203 return (invis
== 0 ? Qnil
20205 : make_number (invis
));
20208 /* Calculate a width or height in pixels from a specification using
20209 the following elements:
20212 NUM - a (fractional) multiple of the default font width/height
20213 (NUM) - specifies exactly NUM pixels
20214 UNIT - a fixed number of pixels, see below.
20215 ELEMENT - size of a display element in pixels, see below.
20216 (NUM . SPEC) - equals NUM * SPEC
20217 (+ SPEC SPEC ...) - add pixel values
20218 (- SPEC SPEC ...) - subtract pixel values
20219 (- SPEC) - negate pixel value
20222 INT or FLOAT - a number constant
20223 SYMBOL - use symbol's (buffer local) variable binding.
20226 in - pixels per inch *)
20227 mm - pixels per 1/1000 meter *)
20228 cm - pixels per 1/100 meter *)
20229 width - width of current font in pixels.
20230 height - height of current font in pixels.
20232 *) using the ratio(s) defined in display-pixels-per-inch.
20236 left-fringe - left fringe width in pixels
20237 right-fringe - right fringe width in pixels
20239 left-margin - left margin width in pixels
20240 right-margin - right margin width in pixels
20242 scroll-bar - scroll-bar area width in pixels
20246 Pixels corresponding to 5 inches:
20249 Total width of non-text areas on left side of window (if scroll-bar is on left):
20250 '(space :width (+ left-fringe left-margin scroll-bar))
20252 Align to first text column (in header line):
20253 '(space :align-to 0)
20255 Align to middle of text area minus half the width of variable `my-image'
20256 containing a loaded image:
20257 '(space :align-to (0.5 . (- text my-image)))
20259 Width of left margin minus width of 1 character in the default font:
20260 '(space :width (- left-margin 1))
20262 Width of left margin minus width of 2 characters in the current font:
20263 '(space :width (- left-margin (2 . width)))
20265 Center 1 character over left-margin (in header line):
20266 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20268 Different ways to express width of left fringe plus left margin minus one pixel:
20269 '(space :width (- (+ left-fringe left-margin) (1)))
20270 '(space :width (+ left-fringe left-margin (- (1))))
20271 '(space :width (+ left-fringe left-margin (-1)))
20275 #define NUMVAL(X) \
20276 ((INTEGERP (X) || FLOATP (X)) \
20281 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20282 struct font
*font
, int width_p
, int *align_to
)
20286 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20287 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20290 return OK_PIXELS (0);
20292 xassert (FRAME_LIVE_P (it
->f
));
20294 if (SYMBOLP (prop
))
20296 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20298 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20300 if (unit
[0] == 'i' && unit
[1] == 'n')
20302 else if (unit
[0] == 'm' && unit
[1] == 'm')
20304 else if (unit
[0] == 'c' && unit
[1] == 'm')
20311 #ifdef HAVE_WINDOW_SYSTEM
20312 if (FRAME_WINDOW_P (it
->f
)
20314 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20315 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20317 return OK_PIXELS (ppi
/ pixels
);
20320 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20321 || (CONSP (Vdisplay_pixels_per_inch
)
20323 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20324 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20326 return OK_PIXELS (ppi
/ pixels
);
20332 #ifdef HAVE_WINDOW_SYSTEM
20333 if (EQ (prop
, Qheight
))
20334 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20335 if (EQ (prop
, Qwidth
))
20336 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20338 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20339 return OK_PIXELS (1);
20342 if (EQ (prop
, Qtext
))
20343 return OK_PIXELS (width_p
20344 ? window_box_width (it
->w
, TEXT_AREA
)
20345 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20347 if (align_to
&& *align_to
< 0)
20350 if (EQ (prop
, Qleft
))
20351 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20352 if (EQ (prop
, Qright
))
20353 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20354 if (EQ (prop
, Qcenter
))
20355 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20356 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20357 if (EQ (prop
, Qleft_fringe
))
20358 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20359 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20360 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20361 if (EQ (prop
, Qright_fringe
))
20362 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20363 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20364 : window_box_right_offset (it
->w
, TEXT_AREA
));
20365 if (EQ (prop
, Qleft_margin
))
20366 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20367 if (EQ (prop
, Qright_margin
))
20368 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20369 if (EQ (prop
, Qscroll_bar
))
20370 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20372 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20373 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20374 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20379 if (EQ (prop
, Qleft_fringe
))
20380 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20381 if (EQ (prop
, Qright_fringe
))
20382 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20383 if (EQ (prop
, Qleft_margin
))
20384 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20385 if (EQ (prop
, Qright_margin
))
20386 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20387 if (EQ (prop
, Qscroll_bar
))
20388 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20391 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20394 if (INTEGERP (prop
) || FLOATP (prop
))
20396 int base_unit
= (width_p
20397 ? FRAME_COLUMN_WIDTH (it
->f
)
20398 : FRAME_LINE_HEIGHT (it
->f
));
20399 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20404 Lisp_Object car
= XCAR (prop
);
20405 Lisp_Object cdr
= XCDR (prop
);
20409 #ifdef HAVE_WINDOW_SYSTEM
20410 if (FRAME_WINDOW_P (it
->f
)
20411 && valid_image_p (prop
))
20413 int id
= lookup_image (it
->f
, prop
);
20414 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20416 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20419 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20425 while (CONSP (cdr
))
20427 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20428 font
, width_p
, align_to
))
20431 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20436 if (EQ (car
, Qminus
))
20438 return OK_PIXELS (pixels
);
20441 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20444 if (INTEGERP (car
) || FLOATP (car
))
20447 pixels
= XFLOATINT (car
);
20449 return OK_PIXELS (pixels
);
20450 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20451 font
, width_p
, align_to
))
20452 return OK_PIXELS (pixels
* fact
);
20463 /***********************************************************************
20465 ***********************************************************************/
20467 #ifdef HAVE_WINDOW_SYSTEM
20472 dump_glyph_string (struct glyph_string
*s
)
20474 fprintf (stderr
, "glyph string\n");
20475 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20476 s
->x
, s
->y
, s
->width
, s
->height
);
20477 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20478 fprintf (stderr
, " hl = %d\n", s
->hl
);
20479 fprintf (stderr
, " left overhang = %d, right = %d\n",
20480 s
->left_overhang
, s
->right_overhang
);
20481 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20482 fprintf (stderr
, " extends to end of line = %d\n",
20483 s
->extends_to_end_of_line_p
);
20484 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20485 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20488 #endif /* GLYPH_DEBUG */
20490 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20491 of XChar2b structures for S; it can't be allocated in
20492 init_glyph_string because it must be allocated via `alloca'. W
20493 is the window on which S is drawn. ROW and AREA are the glyph row
20494 and area within the row from which S is constructed. START is the
20495 index of the first glyph structure covered by S. HL is a
20496 face-override for drawing S. */
20499 #define OPTIONAL_HDC(hdc) HDC hdc,
20500 #define DECLARE_HDC(hdc) HDC hdc;
20501 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20502 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20505 #ifndef OPTIONAL_HDC
20506 #define OPTIONAL_HDC(hdc)
20507 #define DECLARE_HDC(hdc)
20508 #define ALLOCATE_HDC(hdc, f)
20509 #define RELEASE_HDC(hdc, f)
20513 init_glyph_string (struct glyph_string
*s
,
20515 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20516 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20518 memset (s
, 0, sizeof *s
);
20520 s
->f
= XFRAME (w
->frame
);
20524 s
->display
= FRAME_X_DISPLAY (s
->f
);
20525 s
->window
= FRAME_X_WINDOW (s
->f
);
20526 s
->char2b
= char2b
;
20530 s
->first_glyph
= row
->glyphs
[area
] + start
;
20531 s
->height
= row
->height
;
20532 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20533 s
->ybase
= s
->y
+ row
->ascent
;
20537 /* Append the list of glyph strings with head H and tail T to the list
20538 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20541 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20542 struct glyph_string
*h
, struct glyph_string
*t
)
20556 /* Prepend the list of glyph strings with head H and tail T to the
20557 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20561 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20562 struct glyph_string
*h
, struct glyph_string
*t
)
20576 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20577 Set *HEAD and *TAIL to the resulting list. */
20580 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20581 struct glyph_string
*s
)
20583 s
->next
= s
->prev
= NULL
;
20584 append_glyph_string_lists (head
, tail
, s
, s
);
20588 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20589 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20590 make sure that X resources for the face returned are allocated.
20591 Value is a pointer to a realized face that is ready for display if
20592 DISPLAY_P is non-zero. */
20594 static inline struct face
*
20595 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20596 XChar2b
*char2b
, int display_p
)
20598 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20602 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20604 if (code
!= FONT_INVALID_CODE
)
20605 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20607 STORE_XCHAR2B (char2b
, 0, 0);
20610 /* Make sure X resources of the face are allocated. */
20611 #ifdef HAVE_X_WINDOWS
20615 xassert (face
!= NULL
);
20616 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20623 /* Get face and two-byte form of character glyph GLYPH on frame F.
20624 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20625 a pointer to a realized face that is ready for display. */
20627 static inline struct face
*
20628 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20629 XChar2b
*char2b
, int *two_byte_p
)
20633 xassert (glyph
->type
== CHAR_GLYPH
);
20634 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20643 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20644 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20646 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20648 if (code
!= FONT_INVALID_CODE
)
20649 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20651 STORE_XCHAR2B (char2b
, 0, 0);
20654 /* Make sure X resources of the face are allocated. */
20655 xassert (face
!= NULL
);
20656 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20661 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20662 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20665 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20669 if (CHAR_BYTE8_P (c
))
20670 code
= CHAR_TO_BYTE8 (c
);
20672 code
= font
->driver
->encode_char (font
, c
);
20674 if (code
== FONT_INVALID_CODE
)
20676 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20681 /* Fill glyph string S with composition components specified by S->cmp.
20683 BASE_FACE is the base face of the composition.
20684 S->cmp_from is the index of the first component for S.
20686 OVERLAPS non-zero means S should draw the foreground only, and use
20687 its physical height for clipping. See also draw_glyphs.
20689 Value is the index of a component not in S. */
20692 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20696 /* For all glyphs of this composition, starting at the offset
20697 S->cmp_from, until we reach the end of the definition or encounter a
20698 glyph that requires the different face, add it to S. */
20703 s
->for_overlaps
= overlaps
;
20706 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20708 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20712 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20715 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20722 s
->font
= s
->face
->font
;
20724 else if (s
->face
!= face
)
20732 /* All glyph strings for the same composition has the same width,
20733 i.e. the width set for the first component of the composition. */
20734 s
->width
= s
->first_glyph
->pixel_width
;
20736 /* If the specified font could not be loaded, use the frame's
20737 default font, but record the fact that we couldn't load it in
20738 the glyph string so that we can draw rectangles for the
20739 characters of the glyph string. */
20740 if (s
->font
== NULL
)
20742 s
->font_not_found_p
= 1;
20743 s
->font
= FRAME_FONT (s
->f
);
20746 /* Adjust base line for subscript/superscript text. */
20747 s
->ybase
+= s
->first_glyph
->voffset
;
20749 /* This glyph string must always be drawn with 16-bit functions. */
20756 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20757 int start
, int end
, int overlaps
)
20759 struct glyph
*glyph
, *last
;
20760 Lisp_Object lgstring
;
20763 s
->for_overlaps
= overlaps
;
20764 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20765 last
= s
->row
->glyphs
[s
->area
] + end
;
20766 s
->cmp_id
= glyph
->u
.cmp
.id
;
20767 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20768 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20769 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20770 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20771 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20773 while (glyph
< last
20774 && glyph
->u
.cmp
.automatic
20775 && glyph
->u
.cmp
.id
== s
->cmp_id
20776 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20777 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20779 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20781 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20782 unsigned code
= LGLYPH_CODE (lglyph
);
20784 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20786 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20787 return glyph
- s
->row
->glyphs
[s
->area
];
20791 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20792 See the comment of fill_glyph_string for arguments.
20793 Value is the index of the first glyph not in S. */
20797 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20798 int start
, int end
, int overlaps
)
20800 struct glyph
*glyph
, *last
;
20803 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20804 s
->for_overlaps
= overlaps
;
20805 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20806 last
= s
->row
->glyphs
[s
->area
] + end
;
20807 voffset
= glyph
->voffset
;
20808 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20809 s
->font
= s
->face
->font
;
20811 s
->width
= glyph
->pixel_width
;
20813 while (glyph
< last
20814 && glyph
->type
== GLYPHLESS_GLYPH
20815 && glyph
->voffset
== voffset
20816 && glyph
->face_id
== face_id
)
20819 s
->width
+= glyph
->pixel_width
;
20822 s
->ybase
+= voffset
;
20823 return glyph
- s
->row
->glyphs
[s
->area
];
20827 /* Fill glyph string S from a sequence of character glyphs.
20829 FACE_ID is the face id of the string. START is the index of the
20830 first glyph to consider, END is the index of the last + 1.
20831 OVERLAPS non-zero means S should draw the foreground only, and use
20832 its physical height for clipping. See also draw_glyphs.
20834 Value is the index of the first glyph not in S. */
20837 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20838 int start
, int end
, int overlaps
)
20840 struct glyph
*glyph
, *last
;
20842 int glyph_not_available_p
;
20844 xassert (s
->f
== XFRAME (s
->w
->frame
));
20845 xassert (s
->nchars
== 0);
20846 xassert (start
>= 0 && end
> start
);
20848 s
->for_overlaps
= overlaps
;
20849 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20850 last
= s
->row
->glyphs
[s
->area
] + end
;
20851 voffset
= glyph
->voffset
;
20852 s
->padding_p
= glyph
->padding_p
;
20853 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20855 while (glyph
< last
20856 && glyph
->type
== CHAR_GLYPH
20857 && glyph
->voffset
== voffset
20858 /* Same face id implies same font, nowadays. */
20859 && glyph
->face_id
== face_id
20860 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20864 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20865 s
->char2b
+ s
->nchars
,
20867 s
->two_byte_p
= two_byte_p
;
20869 xassert (s
->nchars
<= end
- start
);
20870 s
->width
+= glyph
->pixel_width
;
20871 if (glyph
++->padding_p
!= s
->padding_p
)
20875 s
->font
= s
->face
->font
;
20877 /* If the specified font could not be loaded, use the frame's font,
20878 but record the fact that we couldn't load it in
20879 S->font_not_found_p so that we can draw rectangles for the
20880 characters of the glyph string. */
20881 if (s
->font
== NULL
|| glyph_not_available_p
)
20883 s
->font_not_found_p
= 1;
20884 s
->font
= FRAME_FONT (s
->f
);
20887 /* Adjust base line for subscript/superscript text. */
20888 s
->ybase
+= voffset
;
20890 xassert (s
->face
&& s
->face
->gc
);
20891 return glyph
- s
->row
->glyphs
[s
->area
];
20895 /* Fill glyph string S from image glyph S->first_glyph. */
20898 fill_image_glyph_string (struct glyph_string
*s
)
20900 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20901 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20903 s
->slice
= s
->first_glyph
->slice
.img
;
20904 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20905 s
->font
= s
->face
->font
;
20906 s
->width
= s
->first_glyph
->pixel_width
;
20908 /* Adjust base line for subscript/superscript text. */
20909 s
->ybase
+= s
->first_glyph
->voffset
;
20913 /* Fill glyph string S from a sequence of stretch glyphs.
20915 START is the index of the first glyph to consider,
20916 END is the index of the last + 1.
20918 Value is the index of the first glyph not in S. */
20921 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20923 struct glyph
*glyph
, *last
;
20924 int voffset
, face_id
;
20926 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20928 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20929 last
= s
->row
->glyphs
[s
->area
] + end
;
20930 face_id
= glyph
->face_id
;
20931 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20932 s
->font
= s
->face
->font
;
20933 s
->width
= glyph
->pixel_width
;
20935 voffset
= glyph
->voffset
;
20939 && glyph
->type
== STRETCH_GLYPH
20940 && glyph
->voffset
== voffset
20941 && glyph
->face_id
== face_id
);
20943 s
->width
+= glyph
->pixel_width
;
20945 /* Adjust base line for subscript/superscript text. */
20946 s
->ybase
+= voffset
;
20948 /* The case that face->gc == 0 is handled when drawing the glyph
20949 string by calling PREPARE_FACE_FOR_DISPLAY. */
20951 return glyph
- s
->row
->glyphs
[s
->area
];
20954 static struct font_metrics
*
20955 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20957 static struct font_metrics metrics
;
20958 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20960 if (! font
|| code
== FONT_INVALID_CODE
)
20962 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20967 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20968 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20969 assumed to be zero. */
20972 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20974 *left
= *right
= 0;
20976 if (glyph
->type
== CHAR_GLYPH
)
20980 struct font_metrics
*pcm
;
20982 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20983 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20985 if (pcm
->rbearing
> pcm
->width
)
20986 *right
= pcm
->rbearing
- pcm
->width
;
20987 if (pcm
->lbearing
< 0)
20988 *left
= -pcm
->lbearing
;
20991 else if (glyph
->type
== COMPOSITE_GLYPH
)
20993 if (! glyph
->u
.cmp
.automatic
)
20995 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20997 if (cmp
->rbearing
> cmp
->pixel_width
)
20998 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20999 if (cmp
->lbearing
< 0)
21000 *left
= - cmp
->lbearing
;
21004 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21005 struct font_metrics metrics
;
21007 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21008 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21009 if (metrics
.rbearing
> metrics
.width
)
21010 *right
= metrics
.rbearing
- metrics
.width
;
21011 if (metrics
.lbearing
< 0)
21012 *left
= - metrics
.lbearing
;
21018 /* Return the index of the first glyph preceding glyph string S that
21019 is overwritten by S because of S's left overhang. Value is -1
21020 if no glyphs are overwritten. */
21023 left_overwritten (struct glyph_string
*s
)
21027 if (s
->left_overhang
)
21030 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21031 int first
= s
->first_glyph
- glyphs
;
21033 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21034 x
-= glyphs
[i
].pixel_width
;
21045 /* Return the index of the first glyph preceding glyph string S that
21046 is overwriting S because of its right overhang. Value is -1 if no
21047 glyph in front of S overwrites S. */
21050 left_overwriting (struct glyph_string
*s
)
21053 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21054 int first
= s
->first_glyph
- glyphs
;
21058 for (i
= first
- 1; i
>= 0; --i
)
21061 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21064 x
-= glyphs
[i
].pixel_width
;
21071 /* Return the index of the last glyph following glyph string S that is
21072 overwritten by S because of S's right overhang. Value is -1 if
21073 no such glyph is found. */
21076 right_overwritten (struct glyph_string
*s
)
21080 if (s
->right_overhang
)
21083 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21084 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21085 int end
= s
->row
->used
[s
->area
];
21087 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21088 x
+= glyphs
[i
].pixel_width
;
21097 /* Return the index of the last glyph following glyph string S that
21098 overwrites S because of its left overhang. Value is negative
21099 if no such glyph is found. */
21102 right_overwriting (struct glyph_string
*s
)
21105 int end
= s
->row
->used
[s
->area
];
21106 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21107 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21111 for (i
= first
; i
< end
; ++i
)
21114 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21117 x
+= glyphs
[i
].pixel_width
;
21124 /* Set background width of glyph string S. START is the index of the
21125 first glyph following S. LAST_X is the right-most x-position + 1
21126 in the drawing area. */
21129 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21131 /* If the face of this glyph string has to be drawn to the end of
21132 the drawing area, set S->extends_to_end_of_line_p. */
21134 if (start
== s
->row
->used
[s
->area
]
21135 && s
->area
== TEXT_AREA
21136 && ((s
->row
->fill_line_p
21137 && (s
->hl
== DRAW_NORMAL_TEXT
21138 || s
->hl
== DRAW_IMAGE_RAISED
21139 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21140 || s
->hl
== DRAW_MOUSE_FACE
))
21141 s
->extends_to_end_of_line_p
= 1;
21143 /* If S extends its face to the end of the line, set its
21144 background_width to the distance to the right edge of the drawing
21146 if (s
->extends_to_end_of_line_p
)
21147 s
->background_width
= last_x
- s
->x
+ 1;
21149 s
->background_width
= s
->width
;
21153 /* Compute overhangs and x-positions for glyph string S and its
21154 predecessors, or successors. X is the starting x-position for S.
21155 BACKWARD_P non-zero means process predecessors. */
21158 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21164 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21165 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21175 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21176 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21186 /* The following macros are only called from draw_glyphs below.
21187 They reference the following parameters of that function directly:
21188 `w', `row', `area', and `overlap_p'
21189 as well as the following local variables:
21190 `s', `f', and `hdc' (in W32) */
21193 /* On W32, silently add local `hdc' variable to argument list of
21194 init_glyph_string. */
21195 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21196 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21198 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21199 init_glyph_string (s, char2b, w, row, area, start, hl)
21202 /* Add a glyph string for a stretch glyph to the list of strings
21203 between HEAD and TAIL. START is the index of the stretch glyph in
21204 row area AREA of glyph row ROW. END is the index of the last glyph
21205 in that glyph row area. X is the current output position assigned
21206 to the new glyph string constructed. HL overrides that face of the
21207 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21208 is the right-most x-position of the drawing area. */
21210 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21211 and below -- keep them on one line. */
21212 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21215 s = (struct glyph_string *) alloca (sizeof *s); \
21216 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21217 START = fill_stretch_glyph_string (s, START, END); \
21218 append_glyph_string (&HEAD, &TAIL, s); \
21224 /* Add a glyph string for an image glyph to the list of strings
21225 between HEAD and TAIL. START is the index of the image glyph in
21226 row area AREA of glyph row ROW. END is the index of the last glyph
21227 in that glyph row area. X is the current output position assigned
21228 to the new glyph string constructed. HL overrides that face of the
21229 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21230 is the right-most x-position of the drawing area. */
21232 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21235 s = (struct glyph_string *) alloca (sizeof *s); \
21236 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21237 fill_image_glyph_string (s); \
21238 append_glyph_string (&HEAD, &TAIL, s); \
21245 /* Add a glyph string for a sequence of character glyphs to the list
21246 of strings between HEAD and TAIL. START is the index of the first
21247 glyph in row area AREA of glyph row ROW that is part of the new
21248 glyph string. END is the index of the last glyph in that glyph row
21249 area. X is the current output position assigned to the new glyph
21250 string constructed. HL overrides that face of the glyph; e.g. it
21251 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21252 right-most x-position of the drawing area. */
21254 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21260 face_id = (row)->glyphs[area][START].face_id; \
21262 s = (struct glyph_string *) alloca (sizeof *s); \
21263 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21264 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21265 append_glyph_string (&HEAD, &TAIL, s); \
21267 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21272 /* Add a glyph string for a composite sequence to the list of strings
21273 between HEAD and TAIL. START is the index of the first glyph in
21274 row area AREA of glyph row ROW that is part of the new glyph
21275 string. END is the index of the last glyph in that glyph row area.
21276 X is the current output position assigned to the new glyph string
21277 constructed. HL overrides that face of the glyph; e.g. it is
21278 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21279 x-position of the drawing area. */
21281 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21283 int face_id = (row)->glyphs[area][START].face_id; \
21284 struct face *base_face = FACE_FROM_ID (f, face_id); \
21285 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21286 struct composition *cmp = composition_table[cmp_id]; \
21288 struct glyph_string *first_s IF_LINT (= NULL); \
21291 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21293 /* Make glyph_strings for each glyph sequence that is drawable by \
21294 the same face, and append them to HEAD/TAIL. */ \
21295 for (n = 0; n < cmp->glyph_len;) \
21297 s = (struct glyph_string *) alloca (sizeof *s); \
21298 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21299 append_glyph_string (&(HEAD), &(TAIL), s); \
21305 n = fill_composite_glyph_string (s, base_face, overlaps); \
21313 /* Add a glyph string for a glyph-string sequence to the list of strings
21314 between HEAD and TAIL. */
21316 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21320 Lisp_Object gstring; \
21322 face_id = (row)->glyphs[area][START].face_id; \
21323 gstring = (composition_gstring_from_id \
21324 ((row)->glyphs[area][START].u.cmp.id)); \
21325 s = (struct glyph_string *) alloca (sizeof *s); \
21326 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21327 * LGSTRING_GLYPH_LEN (gstring)); \
21328 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21329 append_glyph_string (&(HEAD), &(TAIL), s); \
21331 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21335 /* Add a glyph string for a sequence of glyphless character's glyphs
21336 to the list of strings between HEAD and TAIL. The meanings of
21337 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21339 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21344 face_id = (row)->glyphs[area][START].face_id; \
21346 s = (struct glyph_string *) alloca (sizeof *s); \
21347 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21348 append_glyph_string (&HEAD, &TAIL, s); \
21350 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21356 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21357 of AREA of glyph row ROW on window W between indices START and END.
21358 HL overrides the face for drawing glyph strings, e.g. it is
21359 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21360 x-positions of the drawing area.
21362 This is an ugly monster macro construct because we must use alloca
21363 to allocate glyph strings (because draw_glyphs can be called
21364 asynchronously). */
21366 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21369 HEAD = TAIL = NULL; \
21370 while (START < END) \
21372 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21373 switch (first_glyph->type) \
21376 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21380 case COMPOSITE_GLYPH: \
21381 if (first_glyph->u.cmp.automatic) \
21382 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21385 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21389 case STRETCH_GLYPH: \
21390 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21394 case IMAGE_GLYPH: \
21395 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21399 case GLYPHLESS_GLYPH: \
21400 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21410 set_glyph_string_background_width (s, START, LAST_X); \
21417 /* Draw glyphs between START and END in AREA of ROW on window W,
21418 starting at x-position X. X is relative to AREA in W. HL is a
21419 face-override with the following meaning:
21421 DRAW_NORMAL_TEXT draw normally
21422 DRAW_CURSOR draw in cursor face
21423 DRAW_MOUSE_FACE draw in mouse face.
21424 DRAW_INVERSE_VIDEO draw in mode line face
21425 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21426 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21428 If OVERLAPS is non-zero, draw only the foreground of characters and
21429 clip to the physical height of ROW. Non-zero value also defines
21430 the overlapping part to be drawn:
21432 OVERLAPS_PRED overlap with preceding rows
21433 OVERLAPS_SUCC overlap with succeeding rows
21434 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21435 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21437 Value is the x-position reached, relative to AREA of W. */
21440 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21441 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21442 enum draw_glyphs_face hl
, int overlaps
)
21444 struct glyph_string
*head
, *tail
;
21445 struct glyph_string
*s
;
21446 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21447 int i
, j
, x_reached
, last_x
, area_left
= 0;
21448 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21451 ALLOCATE_HDC (hdc
, f
);
21453 /* Let's rather be paranoid than getting a SEGV. */
21454 end
= min (end
, row
->used
[area
]);
21455 start
= max (0, start
);
21456 start
= min (end
, start
);
21458 /* Translate X to frame coordinates. Set last_x to the right
21459 end of the drawing area. */
21460 if (row
->full_width_p
)
21462 /* X is relative to the left edge of W, without scroll bars
21464 area_left
= WINDOW_LEFT_EDGE_X (w
);
21465 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21469 area_left
= window_box_left (w
, area
);
21470 last_x
= area_left
+ window_box_width (w
, area
);
21474 /* Build a doubly-linked list of glyph_string structures between
21475 head and tail from what we have to draw. Note that the macro
21476 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21477 the reason we use a separate variable `i'. */
21479 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21481 x_reached
= tail
->x
+ tail
->background_width
;
21485 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21486 the row, redraw some glyphs in front or following the glyph
21487 strings built above. */
21488 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21490 struct glyph_string
*h
, *t
;
21491 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21492 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21493 int check_mouse_face
= 0;
21496 /* If mouse highlighting is on, we may need to draw adjacent
21497 glyphs using mouse-face highlighting. */
21498 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21500 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21502 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21503 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21505 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21507 check_mouse_face
= 1;
21508 mouse_beg_col
= (row
== mouse_beg_row
)
21509 ? hlinfo
->mouse_face_beg_col
: 0;
21510 mouse_end_col
= (row
== mouse_end_row
)
21511 ? hlinfo
->mouse_face_end_col
21512 : row
->used
[TEXT_AREA
];
21516 /* Compute overhangs for all glyph strings. */
21517 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21518 for (s
= head
; s
; s
= s
->next
)
21519 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21521 /* Prepend glyph strings for glyphs in front of the first glyph
21522 string that are overwritten because of the first glyph
21523 string's left overhang. The background of all strings
21524 prepended must be drawn because the first glyph string
21526 i
= left_overwritten (head
);
21529 enum draw_glyphs_face overlap_hl
;
21531 /* If this row contains mouse highlighting, attempt to draw
21532 the overlapped glyphs with the correct highlight. This
21533 code fails if the overlap encompasses more than one glyph
21534 and mouse-highlight spans only some of these glyphs.
21535 However, making it work perfectly involves a lot more
21536 code, and I don't know if the pathological case occurs in
21537 practice, so we'll stick to this for now. --- cyd */
21538 if (check_mouse_face
21539 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21540 overlap_hl
= DRAW_MOUSE_FACE
;
21542 overlap_hl
= DRAW_NORMAL_TEXT
;
21545 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21546 overlap_hl
, dummy_x
, last_x
);
21548 compute_overhangs_and_x (t
, head
->x
, 1);
21549 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21553 /* Prepend glyph strings for glyphs in front of the first glyph
21554 string that overwrite that glyph string because of their
21555 right overhang. For these strings, only the foreground must
21556 be drawn, because it draws over the glyph string at `head'.
21557 The background must not be drawn because this would overwrite
21558 right overhangs of preceding glyphs for which no glyph
21560 i
= left_overwriting (head
);
21563 enum draw_glyphs_face overlap_hl
;
21565 if (check_mouse_face
21566 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21567 overlap_hl
= DRAW_MOUSE_FACE
;
21569 overlap_hl
= DRAW_NORMAL_TEXT
;
21572 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21573 overlap_hl
, dummy_x
, last_x
);
21574 for (s
= h
; s
; s
= s
->next
)
21575 s
->background_filled_p
= 1;
21576 compute_overhangs_and_x (t
, head
->x
, 1);
21577 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21580 /* Append glyphs strings for glyphs following the last glyph
21581 string tail that are overwritten by tail. The background of
21582 these strings has to be drawn because tail's foreground draws
21584 i
= right_overwritten (tail
);
21587 enum draw_glyphs_face overlap_hl
;
21589 if (check_mouse_face
21590 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21591 overlap_hl
= DRAW_MOUSE_FACE
;
21593 overlap_hl
= DRAW_NORMAL_TEXT
;
21595 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21596 overlap_hl
, x
, last_x
);
21597 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21598 we don't have `end = i;' here. */
21599 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21600 append_glyph_string_lists (&head
, &tail
, h
, t
);
21604 /* Append glyph strings for glyphs following the last glyph
21605 string tail that overwrite tail. The foreground of such
21606 glyphs has to be drawn because it writes into the background
21607 of tail. The background must not be drawn because it could
21608 paint over the foreground of following glyphs. */
21609 i
= right_overwriting (tail
);
21612 enum draw_glyphs_face overlap_hl
;
21613 if (check_mouse_face
21614 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21615 overlap_hl
= DRAW_MOUSE_FACE
;
21617 overlap_hl
= DRAW_NORMAL_TEXT
;
21620 i
++; /* We must include the Ith glyph. */
21621 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21622 overlap_hl
, x
, last_x
);
21623 for (s
= h
; s
; s
= s
->next
)
21624 s
->background_filled_p
= 1;
21625 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21626 append_glyph_string_lists (&head
, &tail
, h
, t
);
21628 if (clip_head
|| clip_tail
)
21629 for (s
= head
; s
; s
= s
->next
)
21631 s
->clip_head
= clip_head
;
21632 s
->clip_tail
= clip_tail
;
21636 /* Draw all strings. */
21637 for (s
= head
; s
; s
= s
->next
)
21638 FRAME_RIF (f
)->draw_glyph_string (s
);
21641 /* When focus a sole frame and move horizontally, this sets on_p to 0
21642 causing a failure to erase prev cursor position. */
21643 if (area
== TEXT_AREA
21644 && !row
->full_width_p
21645 /* When drawing overlapping rows, only the glyph strings'
21646 foreground is drawn, which doesn't erase a cursor
21650 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21651 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21652 : (tail
? tail
->x
+ tail
->background_width
: x
));
21656 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21657 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21661 /* Value is the x-position up to which drawn, relative to AREA of W.
21662 This doesn't include parts drawn because of overhangs. */
21663 if (row
->full_width_p
)
21664 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21666 x_reached
-= area_left
;
21668 RELEASE_HDC (hdc
, f
);
21673 /* Expand row matrix if too narrow. Don't expand if area
21676 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21678 if (!fonts_changed_p \
21679 && (it->glyph_row->glyphs[area] \
21680 < it->glyph_row->glyphs[area + 1])) \
21682 it->w->ncols_scale_factor++; \
21683 fonts_changed_p = 1; \
21687 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21688 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21691 append_glyph (struct it
*it
)
21693 struct glyph
*glyph
;
21694 enum glyph_row_area area
= it
->area
;
21696 xassert (it
->glyph_row
);
21697 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21699 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21700 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21702 /* If the glyph row is reversed, we need to prepend the glyph
21703 rather than append it. */
21704 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21708 /* Make room for the additional glyph. */
21709 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21711 glyph
= it
->glyph_row
->glyphs
[area
];
21713 glyph
->charpos
= CHARPOS (it
->position
);
21714 glyph
->object
= it
->object
;
21715 if (it
->pixel_width
> 0)
21717 glyph
->pixel_width
= it
->pixel_width
;
21718 glyph
->padding_p
= 0;
21722 /* Assure at least 1-pixel width. Otherwise, cursor can't
21723 be displayed correctly. */
21724 glyph
->pixel_width
= 1;
21725 glyph
->padding_p
= 1;
21727 glyph
->ascent
= it
->ascent
;
21728 glyph
->descent
= it
->descent
;
21729 glyph
->voffset
= it
->voffset
;
21730 glyph
->type
= CHAR_GLYPH
;
21731 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21732 glyph
->multibyte_p
= it
->multibyte_p
;
21733 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21734 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21735 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21736 || it
->phys_descent
> it
->descent
);
21737 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21738 glyph
->face_id
= it
->face_id
;
21739 glyph
->u
.ch
= it
->char_to_display
;
21740 glyph
->slice
.img
= null_glyph_slice
;
21741 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21744 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21745 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21747 glyph
->bidi_type
= it
->bidi_it
.type
;
21751 glyph
->resolved_level
= 0;
21752 glyph
->bidi_type
= UNKNOWN_BT
;
21754 ++it
->glyph_row
->used
[area
];
21757 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21760 /* Store one glyph for the composition IT->cmp_it.id in
21761 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21765 append_composite_glyph (struct it
*it
)
21767 struct glyph
*glyph
;
21768 enum glyph_row_area area
= it
->area
;
21770 xassert (it
->glyph_row
);
21772 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21773 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21775 /* If the glyph row is reversed, we need to prepend the glyph
21776 rather than append it. */
21777 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21781 /* Make room for the new glyph. */
21782 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21784 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21786 glyph
->charpos
= it
->cmp_it
.charpos
;
21787 glyph
->object
= it
->object
;
21788 glyph
->pixel_width
= it
->pixel_width
;
21789 glyph
->ascent
= it
->ascent
;
21790 glyph
->descent
= it
->descent
;
21791 glyph
->voffset
= it
->voffset
;
21792 glyph
->type
= COMPOSITE_GLYPH
;
21793 if (it
->cmp_it
.ch
< 0)
21795 glyph
->u
.cmp
.automatic
= 0;
21796 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21797 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21801 glyph
->u
.cmp
.automatic
= 1;
21802 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21803 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21804 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21806 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21807 glyph
->multibyte_p
= it
->multibyte_p
;
21808 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21809 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21810 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21811 || it
->phys_descent
> it
->descent
);
21812 glyph
->padding_p
= 0;
21813 glyph
->glyph_not_available_p
= 0;
21814 glyph
->face_id
= it
->face_id
;
21815 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21818 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21819 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21821 glyph
->bidi_type
= it
->bidi_it
.type
;
21823 ++it
->glyph_row
->used
[area
];
21826 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21830 /* Change IT->ascent and IT->height according to the setting of
21834 take_vertical_position_into_account (struct it
*it
)
21838 if (it
->voffset
< 0)
21839 /* Increase the ascent so that we can display the text higher
21841 it
->ascent
-= it
->voffset
;
21843 /* Increase the descent so that we can display the text lower
21845 it
->descent
+= it
->voffset
;
21850 /* Produce glyphs/get display metrics for the image IT is loaded with.
21851 See the description of struct display_iterator in dispextern.h for
21852 an overview of struct display_iterator. */
21855 produce_image_glyph (struct it
*it
)
21859 int glyph_ascent
, crop
;
21860 struct glyph_slice slice
;
21862 xassert (it
->what
== IT_IMAGE
);
21864 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21866 /* Make sure X resources of the face is loaded. */
21867 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21869 if (it
->image_id
< 0)
21871 /* Fringe bitmap. */
21872 it
->ascent
= it
->phys_ascent
= 0;
21873 it
->descent
= it
->phys_descent
= 0;
21874 it
->pixel_width
= 0;
21879 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21881 /* Make sure X resources of the image is loaded. */
21882 prepare_image_for_display (it
->f
, img
);
21884 slice
.x
= slice
.y
= 0;
21885 slice
.width
= img
->width
;
21886 slice
.height
= img
->height
;
21888 if (INTEGERP (it
->slice
.x
))
21889 slice
.x
= XINT (it
->slice
.x
);
21890 else if (FLOATP (it
->slice
.x
))
21891 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21893 if (INTEGERP (it
->slice
.y
))
21894 slice
.y
= XINT (it
->slice
.y
);
21895 else if (FLOATP (it
->slice
.y
))
21896 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21898 if (INTEGERP (it
->slice
.width
))
21899 slice
.width
= XINT (it
->slice
.width
);
21900 else if (FLOATP (it
->slice
.width
))
21901 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21903 if (INTEGERP (it
->slice
.height
))
21904 slice
.height
= XINT (it
->slice
.height
);
21905 else if (FLOATP (it
->slice
.height
))
21906 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21908 if (slice
.x
>= img
->width
)
21909 slice
.x
= img
->width
;
21910 if (slice
.y
>= img
->height
)
21911 slice
.y
= img
->height
;
21912 if (slice
.x
+ slice
.width
>= img
->width
)
21913 slice
.width
= img
->width
- slice
.x
;
21914 if (slice
.y
+ slice
.height
> img
->height
)
21915 slice
.height
= img
->height
- slice
.y
;
21917 if (slice
.width
== 0 || slice
.height
== 0)
21920 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21922 it
->descent
= slice
.height
- glyph_ascent
;
21924 it
->descent
+= img
->vmargin
;
21925 if (slice
.y
+ slice
.height
== img
->height
)
21926 it
->descent
+= img
->vmargin
;
21927 it
->phys_descent
= it
->descent
;
21929 it
->pixel_width
= slice
.width
;
21931 it
->pixel_width
+= img
->hmargin
;
21932 if (slice
.x
+ slice
.width
== img
->width
)
21933 it
->pixel_width
+= img
->hmargin
;
21935 /* It's quite possible for images to have an ascent greater than
21936 their height, so don't get confused in that case. */
21937 if (it
->descent
< 0)
21942 if (face
->box
!= FACE_NO_BOX
)
21944 if (face
->box_line_width
> 0)
21947 it
->ascent
+= face
->box_line_width
;
21948 if (slice
.y
+ slice
.height
== img
->height
)
21949 it
->descent
+= face
->box_line_width
;
21952 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21953 it
->pixel_width
+= eabs (face
->box_line_width
);
21954 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21955 it
->pixel_width
+= eabs (face
->box_line_width
);
21958 take_vertical_position_into_account (it
);
21960 /* Automatically crop wide image glyphs at right edge so we can
21961 draw the cursor on same display row. */
21962 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21963 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21965 it
->pixel_width
-= crop
;
21966 slice
.width
-= crop
;
21971 struct glyph
*glyph
;
21972 enum glyph_row_area area
= it
->area
;
21974 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21975 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21977 glyph
->charpos
= CHARPOS (it
->position
);
21978 glyph
->object
= it
->object
;
21979 glyph
->pixel_width
= it
->pixel_width
;
21980 glyph
->ascent
= glyph_ascent
;
21981 glyph
->descent
= it
->descent
;
21982 glyph
->voffset
= it
->voffset
;
21983 glyph
->type
= IMAGE_GLYPH
;
21984 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21985 glyph
->multibyte_p
= it
->multibyte_p
;
21986 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21987 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21988 glyph
->overlaps_vertically_p
= 0;
21989 glyph
->padding_p
= 0;
21990 glyph
->glyph_not_available_p
= 0;
21991 glyph
->face_id
= it
->face_id
;
21992 glyph
->u
.img_id
= img
->id
;
21993 glyph
->slice
.img
= slice
;
21994 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21997 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21998 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22000 glyph
->bidi_type
= it
->bidi_it
.type
;
22002 ++it
->glyph_row
->used
[area
];
22005 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22010 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22011 of the glyph, WIDTH and HEIGHT are the width and height of the
22012 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22015 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22016 int width
, int height
, int ascent
)
22018 struct glyph
*glyph
;
22019 enum glyph_row_area area
= it
->area
;
22021 xassert (ascent
>= 0 && ascent
<= height
);
22023 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22024 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22026 /* If the glyph row is reversed, we need to prepend the glyph
22027 rather than append it. */
22028 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22032 /* Make room for the additional glyph. */
22033 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22035 glyph
= it
->glyph_row
->glyphs
[area
];
22037 glyph
->charpos
= CHARPOS (it
->position
);
22038 glyph
->object
= object
;
22039 glyph
->pixel_width
= width
;
22040 glyph
->ascent
= ascent
;
22041 glyph
->descent
= height
- ascent
;
22042 glyph
->voffset
= it
->voffset
;
22043 glyph
->type
= STRETCH_GLYPH
;
22044 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22045 glyph
->multibyte_p
= it
->multibyte_p
;
22046 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22047 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22048 glyph
->overlaps_vertically_p
= 0;
22049 glyph
->padding_p
= 0;
22050 glyph
->glyph_not_available_p
= 0;
22051 glyph
->face_id
= it
->face_id
;
22052 glyph
->u
.stretch
.ascent
= ascent
;
22053 glyph
->u
.stretch
.height
= height
;
22054 glyph
->slice
.img
= null_glyph_slice
;
22055 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22058 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22059 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22061 glyph
->bidi_type
= it
->bidi_it
.type
;
22065 glyph
->resolved_level
= 0;
22066 glyph
->bidi_type
= UNKNOWN_BT
;
22068 ++it
->glyph_row
->used
[area
];
22071 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22075 /* Produce a stretch glyph for iterator IT. IT->object is the value
22076 of the glyph property displayed. The value must be a list
22077 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22080 1. `:width WIDTH' specifies that the space should be WIDTH *
22081 canonical char width wide. WIDTH may be an integer or floating
22084 2. `:relative-width FACTOR' specifies that the width of the stretch
22085 should be computed from the width of the first character having the
22086 `glyph' property, and should be FACTOR times that width.
22088 3. `:align-to HPOS' specifies that the space should be wide enough
22089 to reach HPOS, a value in canonical character units.
22091 Exactly one of the above pairs must be present.
22093 4. `:height HEIGHT' specifies that the height of the stretch produced
22094 should be HEIGHT, measured in canonical character units.
22096 5. `:relative-height FACTOR' specifies that the height of the
22097 stretch should be FACTOR times the height of the characters having
22098 the glyph property.
22100 Either none or exactly one of 4 or 5 must be present.
22102 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22103 of the stretch should be used for the ascent of the stretch.
22104 ASCENT must be in the range 0 <= ASCENT <= 100. */
22107 produce_stretch_glyph (struct it
*it
)
22109 /* (space :width WIDTH :height HEIGHT ...) */
22110 Lisp_Object prop
, plist
;
22111 int width
= 0, height
= 0, align_to
= -1;
22112 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22115 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22116 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22118 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22120 /* List should start with `space'. */
22121 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22122 plist
= XCDR (it
->object
);
22124 /* Compute the width of the stretch. */
22125 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22126 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22128 /* Absolute width `:width WIDTH' specified and valid. */
22129 zero_width_ok_p
= 1;
22132 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22135 /* Relative width `:relative-width FACTOR' specified and valid.
22136 Compute the width of the characters having the `glyph'
22139 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22142 if (it
->multibyte_p
)
22143 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22146 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22147 if (! ASCII_CHAR_P (it2
.c
))
22148 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22151 it2
.glyph_row
= NULL
;
22152 it2
.what
= IT_CHARACTER
;
22153 x_produce_glyphs (&it2
);
22154 width
= NUMVAL (prop
) * it2
.pixel_width
;
22156 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22157 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22159 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22160 align_to
= (align_to
< 0
22162 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22163 else if (align_to
< 0)
22164 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22165 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22166 zero_width_ok_p
= 1;
22169 /* Nothing specified -> width defaults to canonical char width. */
22170 width
= FRAME_COLUMN_WIDTH (it
->f
);
22172 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22175 /* Compute height. */
22176 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22177 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22180 zero_height_ok_p
= 1;
22182 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22184 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22186 height
= FONT_HEIGHT (font
);
22188 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22191 /* Compute percentage of height used for ascent. If
22192 `:ascent ASCENT' is present and valid, use that. Otherwise,
22193 derive the ascent from the font in use. */
22194 if (prop
= Fplist_get (plist
, QCascent
),
22195 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22196 ascent
= height
* NUMVAL (prop
) / 100.0;
22197 else if (!NILP (prop
)
22198 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22199 ascent
= min (max (0, (int)tem
), height
);
22201 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22203 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22204 && it
->current_x
+ width
> it
->last_visible_x
)
22205 width
= it
->last_visible_x
- it
->current_x
- 1;
22207 if (width
> 0 && height
> 0 && it
->glyph_row
)
22209 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22210 if (!STRINGP (object
))
22211 object
= it
->w
->buffer
;
22212 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22215 it
->pixel_width
= width
;
22216 it
->ascent
= it
->phys_ascent
= ascent
;
22217 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22218 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22220 take_vertical_position_into_account (it
);
22223 /* Calculate line-height and line-spacing properties.
22224 An integer value specifies explicit pixel value.
22225 A float value specifies relative value to current face height.
22226 A cons (float . face-name) specifies relative value to
22227 height of specified face font.
22229 Returns height in pixels, or nil. */
22233 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22234 int boff
, int override
)
22236 Lisp_Object face_name
= Qnil
;
22237 int ascent
, descent
, height
;
22239 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22244 face_name
= XCAR (val
);
22246 if (!NUMBERP (val
))
22247 val
= make_number (1);
22248 if (NILP (face_name
))
22250 height
= it
->ascent
+ it
->descent
;
22255 if (NILP (face_name
))
22257 font
= FRAME_FONT (it
->f
);
22258 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22260 else if (EQ (face_name
, Qt
))
22269 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22271 return make_number (-1);
22273 face
= FACE_FROM_ID (it
->f
, face_id
);
22276 return make_number (-1);
22277 boff
= font
->baseline_offset
;
22278 if (font
->vertical_centering
)
22279 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22282 ascent
= FONT_BASE (font
) + boff
;
22283 descent
= FONT_DESCENT (font
) - boff
;
22287 it
->override_ascent
= ascent
;
22288 it
->override_descent
= descent
;
22289 it
->override_boff
= boff
;
22292 height
= ascent
+ descent
;
22296 height
= (int)(XFLOAT_DATA (val
) * height
);
22297 else if (INTEGERP (val
))
22298 height
*= XINT (val
);
22300 return make_number (height
);
22304 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22305 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22306 and only if this is for a character for which no font was found.
22308 If the display method (it->glyphless_method) is
22309 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22310 length of the acronym or the hexadecimal string, UPPER_XOFF and
22311 UPPER_YOFF are pixel offsets for the upper part of the string,
22312 LOWER_XOFF and LOWER_YOFF are for the lower part.
22314 For the other display methods, LEN through LOWER_YOFF are zero. */
22317 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22318 short upper_xoff
, short upper_yoff
,
22319 short lower_xoff
, short lower_yoff
)
22321 struct glyph
*glyph
;
22322 enum glyph_row_area area
= it
->area
;
22324 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22325 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22327 /* If the glyph row is reversed, we need to prepend the glyph
22328 rather than append it. */
22329 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22333 /* Make room for the additional glyph. */
22334 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22336 glyph
= it
->glyph_row
->glyphs
[area
];
22338 glyph
->charpos
= CHARPOS (it
->position
);
22339 glyph
->object
= it
->object
;
22340 glyph
->pixel_width
= it
->pixel_width
;
22341 glyph
->ascent
= it
->ascent
;
22342 glyph
->descent
= it
->descent
;
22343 glyph
->voffset
= it
->voffset
;
22344 glyph
->type
= GLYPHLESS_GLYPH
;
22345 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22346 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22347 glyph
->u
.glyphless
.len
= len
;
22348 glyph
->u
.glyphless
.ch
= it
->c
;
22349 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22350 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22351 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22352 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22353 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22354 glyph
->multibyte_p
= it
->multibyte_p
;
22355 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22356 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22357 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22358 || it
->phys_descent
> it
->descent
);
22359 glyph
->padding_p
= 0;
22360 glyph
->glyph_not_available_p
= 0;
22361 glyph
->face_id
= face_id
;
22362 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22365 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22366 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22368 glyph
->bidi_type
= it
->bidi_it
.type
;
22370 ++it
->glyph_row
->used
[area
];
22373 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22377 /* Produce a glyph for a glyphless character for iterator IT.
22378 IT->glyphless_method specifies which method to use for displaying
22379 the character. See the description of enum
22380 glyphless_display_method in dispextern.h for the detail.
22382 FOR_NO_FONT is nonzero if and only if this is for a character for
22383 which no font was found. ACRONYM, if non-nil, is an acronym string
22384 for the character. */
22387 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22392 int base_width
, base_height
, width
, height
;
22393 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22396 /* Get the metrics of the base font. We always refer to the current
22398 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22399 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22400 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22401 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22402 base_height
= it
->ascent
+ it
->descent
;
22403 base_width
= font
->average_width
;
22405 /* Get a face ID for the glyph by utilizing a cache (the same way as
22406 doen for `escape-glyph' in get_next_display_element). */
22407 if (it
->f
== last_glyphless_glyph_frame
22408 && it
->face_id
== last_glyphless_glyph_face_id
)
22410 face_id
= last_glyphless_glyph_merged_face_id
;
22414 /* Merge the `glyphless-char' face into the current face. */
22415 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22416 last_glyphless_glyph_frame
= it
->f
;
22417 last_glyphless_glyph_face_id
= it
->face_id
;
22418 last_glyphless_glyph_merged_face_id
= face_id
;
22421 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22423 it
->pixel_width
= THIN_SPACE_WIDTH
;
22425 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22427 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22429 width
= CHAR_WIDTH (it
->c
);
22432 else if (width
> 4)
22434 it
->pixel_width
= base_width
* width
;
22436 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22442 unsigned int code
[6];
22444 int ascent
, descent
;
22445 struct font_metrics metrics_upper
, metrics_lower
;
22447 face
= FACE_FROM_ID (it
->f
, face_id
);
22448 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22449 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22451 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22453 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22454 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22455 if (CONSP (acronym
))
22456 acronym
= XCAR (acronym
);
22457 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22461 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22462 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22465 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22466 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22467 upper_len
= (len
+ 1) / 2;
22468 font
->driver
->text_extents (font
, code
, upper_len
,
22470 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22475 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22476 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22477 upper_xoff
= upper_yoff
= 2; /* the typical case */
22478 if (base_width
>= width
)
22480 /* Align the upper to the left, the lower to the right. */
22481 it
->pixel_width
= base_width
;
22482 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22486 /* Center the shorter one. */
22487 it
->pixel_width
= width
;
22488 if (metrics_upper
.width
>= metrics_lower
.width
)
22489 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22492 /* FIXME: This code doesn't look right. It formerly was
22493 missing the "lower_xoff = 0;", which couldn't have
22494 been right since it left lower_xoff uninitialized. */
22496 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22500 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22501 top, bottom, and between upper and lower strings. */
22502 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22503 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22504 /* Center vertically.
22505 H:base_height, D:base_descent
22506 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22508 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22509 descent = D - H/2 + h/2;
22510 lower_yoff = descent - 2 - ld;
22511 upper_yoff = lower_yoff - la - 1 - ud; */
22512 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22513 descent
= it
->descent
- (base_height
- height
) / 2;
22514 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22515 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22516 - metrics_upper
.descent
);
22517 /* Don't make the height shorter than the base height. */
22518 if (height
> base_height
)
22520 it
->ascent
= ascent
;
22521 it
->descent
= descent
;
22525 it
->phys_ascent
= it
->ascent
;
22526 it
->phys_descent
= it
->descent
;
22528 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22529 upper_xoff
, upper_yoff
,
22530 lower_xoff
, lower_yoff
);
22532 take_vertical_position_into_account (it
);
22537 Produce glyphs/get display metrics for the display element IT is
22538 loaded with. See the description of struct it in dispextern.h
22539 for an overview of struct it. */
22542 x_produce_glyphs (struct it
*it
)
22544 int extra_line_spacing
= it
->extra_line_spacing
;
22546 it
->glyph_not_available_p
= 0;
22548 if (it
->what
== IT_CHARACTER
)
22551 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22552 struct font
*font
= face
->font
;
22553 struct font_metrics
*pcm
= NULL
;
22554 int boff
; /* baseline offset */
22558 /* When no suitable font is found, display this character by
22559 the method specified in the first extra slot of
22560 Vglyphless_char_display. */
22561 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22563 xassert (it
->what
== IT_GLYPHLESS
);
22564 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22568 boff
= font
->baseline_offset
;
22569 if (font
->vertical_centering
)
22570 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22572 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22578 if (it
->override_ascent
>= 0)
22580 it
->ascent
= it
->override_ascent
;
22581 it
->descent
= it
->override_descent
;
22582 boff
= it
->override_boff
;
22586 it
->ascent
= FONT_BASE (font
) + boff
;
22587 it
->descent
= FONT_DESCENT (font
) - boff
;
22590 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22592 pcm
= get_per_char_metric (font
, &char2b
);
22593 if (pcm
->width
== 0
22594 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22600 it
->phys_ascent
= pcm
->ascent
+ boff
;
22601 it
->phys_descent
= pcm
->descent
- boff
;
22602 it
->pixel_width
= pcm
->width
;
22606 it
->glyph_not_available_p
= 1;
22607 it
->phys_ascent
= it
->ascent
;
22608 it
->phys_descent
= it
->descent
;
22609 it
->pixel_width
= font
->space_width
;
22612 if (it
->constrain_row_ascent_descent_p
)
22614 if (it
->descent
> it
->max_descent
)
22616 it
->ascent
+= it
->descent
- it
->max_descent
;
22617 it
->descent
= it
->max_descent
;
22619 if (it
->ascent
> it
->max_ascent
)
22621 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22622 it
->ascent
= it
->max_ascent
;
22624 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22625 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22626 extra_line_spacing
= 0;
22629 /* If this is a space inside a region of text with
22630 `space-width' property, change its width. */
22631 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22633 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22635 /* If face has a box, add the box thickness to the character
22636 height. If character has a box line to the left and/or
22637 right, add the box line width to the character's width. */
22638 if (face
->box
!= FACE_NO_BOX
)
22640 int thick
= face
->box_line_width
;
22644 it
->ascent
+= thick
;
22645 it
->descent
+= thick
;
22650 if (it
->start_of_box_run_p
)
22651 it
->pixel_width
+= thick
;
22652 if (it
->end_of_box_run_p
)
22653 it
->pixel_width
+= thick
;
22656 /* If face has an overline, add the height of the overline
22657 (1 pixel) and a 1 pixel margin to the character height. */
22658 if (face
->overline_p
)
22659 it
->ascent
+= overline_margin
;
22661 if (it
->constrain_row_ascent_descent_p
)
22663 if (it
->ascent
> it
->max_ascent
)
22664 it
->ascent
= it
->max_ascent
;
22665 if (it
->descent
> it
->max_descent
)
22666 it
->descent
= it
->max_descent
;
22669 take_vertical_position_into_account (it
);
22671 /* If we have to actually produce glyphs, do it. */
22676 /* Translate a space with a `space-width' property
22677 into a stretch glyph. */
22678 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22679 / FONT_HEIGHT (font
));
22680 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22681 it
->ascent
+ it
->descent
, ascent
);
22686 /* If characters with lbearing or rbearing are displayed
22687 in this line, record that fact in a flag of the
22688 glyph row. This is used to optimize X output code. */
22689 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22690 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22692 if (! stretched_p
&& it
->pixel_width
== 0)
22693 /* We assure that all visible glyphs have at least 1-pixel
22695 it
->pixel_width
= 1;
22697 else if (it
->char_to_display
== '\n')
22699 /* A newline has no width, but we need the height of the
22700 line. But if previous part of the line sets a height,
22701 don't increase that height */
22703 Lisp_Object height
;
22704 Lisp_Object total_height
= Qnil
;
22706 it
->override_ascent
= -1;
22707 it
->pixel_width
= 0;
22710 height
= get_it_property (it
, Qline_height
);
22711 /* Split (line-height total-height) list */
22713 && CONSP (XCDR (height
))
22714 && NILP (XCDR (XCDR (height
))))
22716 total_height
= XCAR (XCDR (height
));
22717 height
= XCAR (height
);
22719 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22721 if (it
->override_ascent
>= 0)
22723 it
->ascent
= it
->override_ascent
;
22724 it
->descent
= it
->override_descent
;
22725 boff
= it
->override_boff
;
22729 it
->ascent
= FONT_BASE (font
) + boff
;
22730 it
->descent
= FONT_DESCENT (font
) - boff
;
22733 if (EQ (height
, Qt
))
22735 if (it
->descent
> it
->max_descent
)
22737 it
->ascent
+= it
->descent
- it
->max_descent
;
22738 it
->descent
= it
->max_descent
;
22740 if (it
->ascent
> it
->max_ascent
)
22742 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22743 it
->ascent
= it
->max_ascent
;
22745 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22746 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22747 it
->constrain_row_ascent_descent_p
= 1;
22748 extra_line_spacing
= 0;
22752 Lisp_Object spacing
;
22754 it
->phys_ascent
= it
->ascent
;
22755 it
->phys_descent
= it
->descent
;
22757 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22758 && face
->box
!= FACE_NO_BOX
22759 && face
->box_line_width
> 0)
22761 it
->ascent
+= face
->box_line_width
;
22762 it
->descent
+= face
->box_line_width
;
22765 && XINT (height
) > it
->ascent
+ it
->descent
)
22766 it
->ascent
= XINT (height
) - it
->descent
;
22768 if (!NILP (total_height
))
22769 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22772 spacing
= get_it_property (it
, Qline_spacing
);
22773 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22775 if (INTEGERP (spacing
))
22777 extra_line_spacing
= XINT (spacing
);
22778 if (!NILP (total_height
))
22779 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22783 else /* i.e. (it->char_to_display == '\t') */
22785 if (font
->space_width
> 0)
22787 int tab_width
= it
->tab_width
* font
->space_width
;
22788 int x
= it
->current_x
+ it
->continuation_lines_width
;
22789 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22791 /* If the distance from the current position to the next tab
22792 stop is less than a space character width, use the
22793 tab stop after that. */
22794 if (next_tab_x
- x
< font
->space_width
)
22795 next_tab_x
+= tab_width
;
22797 it
->pixel_width
= next_tab_x
- x
;
22799 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22800 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22804 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22805 it
->ascent
+ it
->descent
, it
->ascent
);
22810 it
->pixel_width
= 0;
22815 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22817 /* A static composition.
22819 Note: A composition is represented as one glyph in the
22820 glyph matrix. There are no padding glyphs.
22822 Important note: pixel_width, ascent, and descent are the
22823 values of what is drawn by draw_glyphs (i.e. the values of
22824 the overall glyphs composed). */
22825 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22826 int boff
; /* baseline offset */
22827 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22828 int glyph_len
= cmp
->glyph_len
;
22829 struct font
*font
= face
->font
;
22833 /* If we have not yet calculated pixel size data of glyphs of
22834 the composition for the current face font, calculate them
22835 now. Theoretically, we have to check all fonts for the
22836 glyphs, but that requires much time and memory space. So,
22837 here we check only the font of the first glyph. This may
22838 lead to incorrect display, but it's very rare, and C-l
22839 (recenter-top-bottom) can correct the display anyway. */
22840 if (! cmp
->font
|| cmp
->font
!= font
)
22842 /* Ascent and descent of the font of the first character
22843 of this composition (adjusted by baseline offset).
22844 Ascent and descent of overall glyphs should not be less
22845 than these, respectively. */
22846 int font_ascent
, font_descent
, font_height
;
22847 /* Bounding box of the overall glyphs. */
22848 int leftmost
, rightmost
, lowest
, highest
;
22849 int lbearing
, rbearing
;
22850 int i
, width
, ascent
, descent
;
22851 int left_padded
= 0, right_padded
= 0;
22852 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22854 struct font_metrics
*pcm
;
22855 int font_not_found_p
;
22858 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22859 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22861 if (glyph_len
< cmp
->glyph_len
)
22863 for (i
= 0; i
< glyph_len
; i
++)
22865 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22867 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22872 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22873 : IT_CHARPOS (*it
));
22874 /* If no suitable font is found, use the default font. */
22875 font_not_found_p
= font
== NULL
;
22876 if (font_not_found_p
)
22878 face
= face
->ascii_face
;
22881 boff
= font
->baseline_offset
;
22882 if (font
->vertical_centering
)
22883 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22884 font_ascent
= FONT_BASE (font
) + boff
;
22885 font_descent
= FONT_DESCENT (font
) - boff
;
22886 font_height
= FONT_HEIGHT (font
);
22888 cmp
->font
= (void *) font
;
22891 if (! font_not_found_p
)
22893 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22895 pcm
= get_per_char_metric (font
, &char2b
);
22898 /* Initialize the bounding box. */
22901 width
= pcm
->width
;
22902 ascent
= pcm
->ascent
;
22903 descent
= pcm
->descent
;
22904 lbearing
= pcm
->lbearing
;
22905 rbearing
= pcm
->rbearing
;
22909 width
= font
->space_width
;
22910 ascent
= FONT_BASE (font
);
22911 descent
= FONT_DESCENT (font
);
22918 lowest
= - descent
+ boff
;
22919 highest
= ascent
+ boff
;
22921 if (! font_not_found_p
22922 && font
->default_ascent
22923 && CHAR_TABLE_P (Vuse_default_ascent
)
22924 && !NILP (Faref (Vuse_default_ascent
,
22925 make_number (it
->char_to_display
))))
22926 highest
= font
->default_ascent
+ boff
;
22928 /* Draw the first glyph at the normal position. It may be
22929 shifted to right later if some other glyphs are drawn
22931 cmp
->offsets
[i
* 2] = 0;
22932 cmp
->offsets
[i
* 2 + 1] = boff
;
22933 cmp
->lbearing
= lbearing
;
22934 cmp
->rbearing
= rbearing
;
22936 /* Set cmp->offsets for the remaining glyphs. */
22937 for (i
++; i
< glyph_len
; i
++)
22939 int left
, right
, btm
, top
;
22940 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22942 struct face
*this_face
;
22946 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22947 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22948 font
= this_face
->font
;
22954 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22956 pcm
= get_per_char_metric (font
, &char2b
);
22959 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22962 width
= pcm
->width
;
22963 ascent
= pcm
->ascent
;
22964 descent
= pcm
->descent
;
22965 lbearing
= pcm
->lbearing
;
22966 rbearing
= pcm
->rbearing
;
22967 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22969 /* Relative composition with or without
22970 alternate chars. */
22971 left
= (leftmost
+ rightmost
- width
) / 2;
22972 btm
= - descent
+ boff
;
22973 if (font
->relative_compose
22974 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22975 || NILP (Faref (Vignore_relative_composition
,
22976 make_number (ch
)))))
22979 if (- descent
>= font
->relative_compose
)
22980 /* One extra pixel between two glyphs. */
22982 else if (ascent
<= 0)
22983 /* One extra pixel between two glyphs. */
22984 btm
= lowest
- 1 - ascent
- descent
;
22989 /* A composition rule is specified by an integer
22990 value that encodes global and new reference
22991 points (GREF and NREF). GREF and NREF are
22992 specified by numbers as below:
22994 0---1---2 -- ascent
22998 9--10--11 -- center
23000 ---3---4---5--- baseline
23002 6---7---8 -- descent
23004 int rule
= COMPOSITION_RULE (cmp
, i
);
23005 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23007 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23008 grefx
= gref
% 3, nrefx
= nref
% 3;
23009 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23011 xoff
= font_height
* (xoff
- 128) / 256;
23013 yoff
= font_height
* (yoff
- 128) / 256;
23016 + grefx
* (rightmost
- leftmost
) / 2
23017 - nrefx
* width
/ 2
23020 btm
= ((grefy
== 0 ? highest
23022 : grefy
== 2 ? lowest
23023 : (highest
+ lowest
) / 2)
23024 - (nrefy
== 0 ? ascent
+ descent
23025 : nrefy
== 1 ? descent
- boff
23027 : (ascent
+ descent
) / 2)
23031 cmp
->offsets
[i
* 2] = left
;
23032 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23034 /* Update the bounding box of the overall glyphs. */
23037 right
= left
+ width
;
23038 if (left
< leftmost
)
23040 if (right
> rightmost
)
23043 top
= btm
+ descent
+ ascent
;
23049 if (cmp
->lbearing
> left
+ lbearing
)
23050 cmp
->lbearing
= left
+ lbearing
;
23051 if (cmp
->rbearing
< left
+ rbearing
)
23052 cmp
->rbearing
= left
+ rbearing
;
23056 /* If there are glyphs whose x-offsets are negative,
23057 shift all glyphs to the right and make all x-offsets
23061 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23062 cmp
->offsets
[i
* 2] -= leftmost
;
23063 rightmost
-= leftmost
;
23064 cmp
->lbearing
-= leftmost
;
23065 cmp
->rbearing
-= leftmost
;
23068 if (left_padded
&& cmp
->lbearing
< 0)
23070 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23071 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23072 rightmost
-= cmp
->lbearing
;
23073 cmp
->rbearing
-= cmp
->lbearing
;
23076 if (right_padded
&& rightmost
< cmp
->rbearing
)
23078 rightmost
= cmp
->rbearing
;
23081 cmp
->pixel_width
= rightmost
;
23082 cmp
->ascent
= highest
;
23083 cmp
->descent
= - lowest
;
23084 if (cmp
->ascent
< font_ascent
)
23085 cmp
->ascent
= font_ascent
;
23086 if (cmp
->descent
< font_descent
)
23087 cmp
->descent
= font_descent
;
23091 && (cmp
->lbearing
< 0
23092 || cmp
->rbearing
> cmp
->pixel_width
))
23093 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23095 it
->pixel_width
= cmp
->pixel_width
;
23096 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23097 it
->descent
= it
->phys_descent
= cmp
->descent
;
23098 if (face
->box
!= FACE_NO_BOX
)
23100 int thick
= face
->box_line_width
;
23104 it
->ascent
+= thick
;
23105 it
->descent
+= thick
;
23110 if (it
->start_of_box_run_p
)
23111 it
->pixel_width
+= thick
;
23112 if (it
->end_of_box_run_p
)
23113 it
->pixel_width
+= thick
;
23116 /* If face has an overline, add the height of the overline
23117 (1 pixel) and a 1 pixel margin to the character height. */
23118 if (face
->overline_p
)
23119 it
->ascent
+= overline_margin
;
23121 take_vertical_position_into_account (it
);
23122 if (it
->ascent
< 0)
23124 if (it
->descent
< 0)
23128 append_composite_glyph (it
);
23130 else if (it
->what
== IT_COMPOSITION
)
23132 /* A dynamic (automatic) composition. */
23133 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23134 Lisp_Object gstring
;
23135 struct font_metrics metrics
;
23137 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23139 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23142 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23143 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23144 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23145 it
->descent
= it
->phys_descent
= metrics
.descent
;
23146 if (face
->box
!= FACE_NO_BOX
)
23148 int thick
= face
->box_line_width
;
23152 it
->ascent
+= thick
;
23153 it
->descent
+= thick
;
23158 if (it
->start_of_box_run_p
)
23159 it
->pixel_width
+= thick
;
23160 if (it
->end_of_box_run_p
)
23161 it
->pixel_width
+= thick
;
23163 /* If face has an overline, add the height of the overline
23164 (1 pixel) and a 1 pixel margin to the character height. */
23165 if (face
->overline_p
)
23166 it
->ascent
+= overline_margin
;
23167 take_vertical_position_into_account (it
);
23168 if (it
->ascent
< 0)
23170 if (it
->descent
< 0)
23174 append_composite_glyph (it
);
23176 else if (it
->what
== IT_GLYPHLESS
)
23177 produce_glyphless_glyph (it
, 0, Qnil
);
23178 else if (it
->what
== IT_IMAGE
)
23179 produce_image_glyph (it
);
23180 else if (it
->what
== IT_STRETCH
)
23181 produce_stretch_glyph (it
);
23184 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23185 because this isn't true for images with `:ascent 100'. */
23186 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23187 if (it
->area
== TEXT_AREA
)
23188 it
->current_x
+= it
->pixel_width
;
23190 if (extra_line_spacing
> 0)
23192 it
->descent
+= extra_line_spacing
;
23193 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23194 it
->max_extra_line_spacing
= extra_line_spacing
;
23197 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23198 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23199 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23200 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23204 Output LEN glyphs starting at START at the nominal cursor position.
23205 Advance the nominal cursor over the text. The global variable
23206 updated_window contains the window being updated, updated_row is
23207 the glyph row being updated, and updated_area is the area of that
23208 row being updated. */
23211 x_write_glyphs (struct glyph
*start
, int len
)
23215 xassert (updated_window
&& updated_row
);
23218 /* Write glyphs. */
23220 hpos
= start
- updated_row
->glyphs
[updated_area
];
23221 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23222 updated_row
, updated_area
,
23224 DRAW_NORMAL_TEXT
, 0);
23226 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23227 if (updated_area
== TEXT_AREA
23228 && updated_window
->phys_cursor_on_p
23229 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23230 && updated_window
->phys_cursor
.hpos
>= hpos
23231 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23232 updated_window
->phys_cursor_on_p
= 0;
23236 /* Advance the output cursor. */
23237 output_cursor
.hpos
+= len
;
23238 output_cursor
.x
= x
;
23243 Insert LEN glyphs from START at the nominal cursor position. */
23246 x_insert_glyphs (struct glyph
*start
, int len
)
23250 int line_height
, shift_by_width
, shifted_region_width
;
23251 struct glyph_row
*row
;
23252 struct glyph
*glyph
;
23253 int frame_x
, frame_y
;
23256 xassert (updated_window
&& updated_row
);
23258 w
= updated_window
;
23259 f
= XFRAME (WINDOW_FRAME (w
));
23261 /* Get the height of the line we are in. */
23263 line_height
= row
->height
;
23265 /* Get the width of the glyphs to insert. */
23266 shift_by_width
= 0;
23267 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23268 shift_by_width
+= glyph
->pixel_width
;
23270 /* Get the width of the region to shift right. */
23271 shifted_region_width
= (window_box_width (w
, updated_area
)
23276 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23277 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23279 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23280 line_height
, shift_by_width
);
23282 /* Write the glyphs. */
23283 hpos
= start
- row
->glyphs
[updated_area
];
23284 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23286 DRAW_NORMAL_TEXT
, 0);
23288 /* Advance the output cursor. */
23289 output_cursor
.hpos
+= len
;
23290 output_cursor
.x
+= shift_by_width
;
23296 Erase the current text line from the nominal cursor position
23297 (inclusive) to pixel column TO_X (exclusive). The idea is that
23298 everything from TO_X onward is already erased.
23300 TO_X is a pixel position relative to updated_area of
23301 updated_window. TO_X == -1 means clear to the end of this area. */
23304 x_clear_end_of_line (int to_x
)
23307 struct window
*w
= updated_window
;
23308 int max_x
, min_y
, max_y
;
23309 int from_x
, from_y
, to_y
;
23311 xassert (updated_window
&& updated_row
);
23312 f
= XFRAME (w
->frame
);
23314 if (updated_row
->full_width_p
)
23315 max_x
= WINDOW_TOTAL_WIDTH (w
);
23317 max_x
= window_box_width (w
, updated_area
);
23318 max_y
= window_text_bottom_y (w
);
23320 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23321 of window. For TO_X > 0, truncate to end of drawing area. */
23327 to_x
= min (to_x
, max_x
);
23329 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23331 /* Notice if the cursor will be cleared by this operation. */
23332 if (!updated_row
->full_width_p
)
23333 notice_overwritten_cursor (w
, updated_area
,
23334 output_cursor
.x
, -1,
23336 MATRIX_ROW_BOTTOM_Y (updated_row
));
23338 from_x
= output_cursor
.x
;
23340 /* Translate to frame coordinates. */
23341 if (updated_row
->full_width_p
)
23343 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23344 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23348 int area_left
= window_box_left (w
, updated_area
);
23349 from_x
+= area_left
;
23353 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23354 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23355 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23357 /* Prevent inadvertently clearing to end of the X window. */
23358 if (to_x
> from_x
&& to_y
> from_y
)
23361 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23362 to_x
- from_x
, to_y
- from_y
);
23367 #endif /* HAVE_WINDOW_SYSTEM */
23371 /***********************************************************************
23373 ***********************************************************************/
23375 /* Value is the internal representation of the specified cursor type
23376 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23377 of the bar cursor. */
23379 static enum text_cursor_kinds
23380 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23382 enum text_cursor_kinds type
;
23387 if (EQ (arg
, Qbox
))
23388 return FILLED_BOX_CURSOR
;
23390 if (EQ (arg
, Qhollow
))
23391 return HOLLOW_BOX_CURSOR
;
23393 if (EQ (arg
, Qbar
))
23400 && EQ (XCAR (arg
), Qbar
)
23401 && INTEGERP (XCDR (arg
))
23402 && XINT (XCDR (arg
)) >= 0)
23404 *width
= XINT (XCDR (arg
));
23408 if (EQ (arg
, Qhbar
))
23411 return HBAR_CURSOR
;
23415 && EQ (XCAR (arg
), Qhbar
)
23416 && INTEGERP (XCDR (arg
))
23417 && XINT (XCDR (arg
)) >= 0)
23419 *width
= XINT (XCDR (arg
));
23420 return HBAR_CURSOR
;
23423 /* Treat anything unknown as "hollow box cursor".
23424 It was bad to signal an error; people have trouble fixing
23425 .Xdefaults with Emacs, when it has something bad in it. */
23426 type
= HOLLOW_BOX_CURSOR
;
23431 /* Set the default cursor types for specified frame. */
23433 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23438 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23439 FRAME_CURSOR_WIDTH (f
) = width
;
23441 /* By default, set up the blink-off state depending on the on-state. */
23443 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23446 FRAME_BLINK_OFF_CURSOR (f
)
23447 = get_specified_cursor_type (XCDR (tem
), &width
);
23448 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23451 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23455 #ifdef HAVE_WINDOW_SYSTEM
23457 /* Return the cursor we want to be displayed in window W. Return
23458 width of bar/hbar cursor through WIDTH arg. Return with
23459 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23460 (i.e. if the `system caret' should track this cursor).
23462 In a mini-buffer window, we want the cursor only to appear if we
23463 are reading input from this window. For the selected window, we
23464 want the cursor type given by the frame parameter or buffer local
23465 setting of cursor-type. If explicitly marked off, draw no cursor.
23466 In all other cases, we want a hollow box cursor. */
23468 static enum text_cursor_kinds
23469 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23470 int *active_cursor
)
23472 struct frame
*f
= XFRAME (w
->frame
);
23473 struct buffer
*b
= XBUFFER (w
->buffer
);
23474 int cursor_type
= DEFAULT_CURSOR
;
23475 Lisp_Object alt_cursor
;
23476 int non_selected
= 0;
23478 *active_cursor
= 1;
23481 if (cursor_in_echo_area
23482 && FRAME_HAS_MINIBUF_P (f
)
23483 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23485 if (w
== XWINDOW (echo_area_window
))
23487 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23489 *width
= FRAME_CURSOR_WIDTH (f
);
23490 return FRAME_DESIRED_CURSOR (f
);
23493 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23496 *active_cursor
= 0;
23500 /* Detect a nonselected window or nonselected frame. */
23501 else if (w
!= XWINDOW (f
->selected_window
)
23502 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23504 *active_cursor
= 0;
23506 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23512 /* Never display a cursor in a window in which cursor-type is nil. */
23513 if (NILP (BVAR (b
, cursor_type
)))
23516 /* Get the normal cursor type for this window. */
23517 if (EQ (BVAR (b
, cursor_type
), Qt
))
23519 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23520 *width
= FRAME_CURSOR_WIDTH (f
);
23523 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23525 /* Use cursor-in-non-selected-windows instead
23526 for non-selected window or frame. */
23529 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23530 if (!EQ (Qt
, alt_cursor
))
23531 return get_specified_cursor_type (alt_cursor
, width
);
23532 /* t means modify the normal cursor type. */
23533 if (cursor_type
== FILLED_BOX_CURSOR
)
23534 cursor_type
= HOLLOW_BOX_CURSOR
;
23535 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23537 return cursor_type
;
23540 /* Use normal cursor if not blinked off. */
23541 if (!w
->cursor_off_p
)
23543 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23545 if (cursor_type
== FILLED_BOX_CURSOR
)
23547 /* Using a block cursor on large images can be very annoying.
23548 So use a hollow cursor for "large" images.
23549 If image is not transparent (no mask), also use hollow cursor. */
23550 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23551 if (img
!= NULL
&& IMAGEP (img
->spec
))
23553 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23554 where N = size of default frame font size.
23555 This should cover most of the "tiny" icons people may use. */
23557 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23558 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23559 cursor_type
= HOLLOW_BOX_CURSOR
;
23562 else if (cursor_type
!= NO_CURSOR
)
23564 /* Display current only supports BOX and HOLLOW cursors for images.
23565 So for now, unconditionally use a HOLLOW cursor when cursor is
23566 not a solid box cursor. */
23567 cursor_type
= HOLLOW_BOX_CURSOR
;
23570 return cursor_type
;
23573 /* Cursor is blinked off, so determine how to "toggle" it. */
23575 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23576 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23577 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23579 /* Then see if frame has specified a specific blink off cursor type. */
23580 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23582 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23583 return FRAME_BLINK_OFF_CURSOR (f
);
23587 /* Some people liked having a permanently visible blinking cursor,
23588 while others had very strong opinions against it. So it was
23589 decided to remove it. KFS 2003-09-03 */
23591 /* Finally perform built-in cursor blinking:
23592 filled box <-> hollow box
23593 wide [h]bar <-> narrow [h]bar
23594 narrow [h]bar <-> no cursor
23595 other type <-> no cursor */
23597 if (cursor_type
== FILLED_BOX_CURSOR
)
23598 return HOLLOW_BOX_CURSOR
;
23600 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23603 return cursor_type
;
23611 /* Notice when the text cursor of window W has been completely
23612 overwritten by a drawing operation that outputs glyphs in AREA
23613 starting at X0 and ending at X1 in the line starting at Y0 and
23614 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23615 the rest of the line after X0 has been written. Y coordinates
23616 are window-relative. */
23619 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23620 int x0
, int x1
, int y0
, int y1
)
23622 int cx0
, cx1
, cy0
, cy1
;
23623 struct glyph_row
*row
;
23625 if (!w
->phys_cursor_on_p
)
23627 if (area
!= TEXT_AREA
)
23630 if (w
->phys_cursor
.vpos
< 0
23631 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23632 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23633 !(row
->enabled_p
&& row
->displays_text_p
)))
23636 if (row
->cursor_in_fringe_p
)
23638 row
->cursor_in_fringe_p
= 0;
23639 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23640 w
->phys_cursor_on_p
= 0;
23644 cx0
= w
->phys_cursor
.x
;
23645 cx1
= cx0
+ w
->phys_cursor_width
;
23646 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23649 /* The cursor image will be completely removed from the
23650 screen if the output area intersects the cursor area in
23651 y-direction. When we draw in [y0 y1[, and some part of
23652 the cursor is at y < y0, that part must have been drawn
23653 before. When scrolling, the cursor is erased before
23654 actually scrolling, so we don't come here. When not
23655 scrolling, the rows above the old cursor row must have
23656 changed, and in this case these rows must have written
23657 over the cursor image.
23659 Likewise if part of the cursor is below y1, with the
23660 exception of the cursor being in the first blank row at
23661 the buffer and window end because update_text_area
23662 doesn't draw that row. (Except when it does, but
23663 that's handled in update_text_area.) */
23665 cy0
= w
->phys_cursor
.y
;
23666 cy1
= cy0
+ w
->phys_cursor_height
;
23667 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23670 w
->phys_cursor_on_p
= 0;
23673 #endif /* HAVE_WINDOW_SYSTEM */
23676 /************************************************************************
23678 ************************************************************************/
23680 #ifdef HAVE_WINDOW_SYSTEM
23683 Fix the display of area AREA of overlapping row ROW in window W
23684 with respect to the overlapping part OVERLAPS. */
23687 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23688 enum glyph_row_area area
, int overlaps
)
23695 for (i
= 0; i
< row
->used
[area
];)
23697 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23699 int start
= i
, start_x
= x
;
23703 x
+= row
->glyphs
[area
][i
].pixel_width
;
23706 while (i
< row
->used
[area
]
23707 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23709 draw_glyphs (w
, start_x
, row
, area
,
23711 DRAW_NORMAL_TEXT
, overlaps
);
23715 x
+= row
->glyphs
[area
][i
].pixel_width
;
23725 Draw the cursor glyph of window W in glyph row ROW. See the
23726 comment of draw_glyphs for the meaning of HL. */
23729 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23730 enum draw_glyphs_face hl
)
23732 /* If cursor hpos is out of bounds, don't draw garbage. This can
23733 happen in mini-buffer windows when switching between echo area
23734 glyphs and mini-buffer. */
23735 if ((row
->reversed_p
23736 ? (w
->phys_cursor
.hpos
>= 0)
23737 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23739 int on_p
= w
->phys_cursor_on_p
;
23741 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23742 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23744 w
->phys_cursor_on_p
= on_p
;
23746 if (hl
== DRAW_CURSOR
)
23747 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23748 /* When we erase the cursor, and ROW is overlapped by other
23749 rows, make sure that these overlapping parts of other rows
23751 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23753 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23755 if (row
> w
->current_matrix
->rows
23756 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23757 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23758 OVERLAPS_ERASED_CURSOR
);
23760 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23761 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23762 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23763 OVERLAPS_ERASED_CURSOR
);
23770 Erase the image of a cursor of window W from the screen. */
23773 erase_phys_cursor (struct window
*w
)
23775 struct frame
*f
= XFRAME (w
->frame
);
23776 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23777 int hpos
= w
->phys_cursor
.hpos
;
23778 int vpos
= w
->phys_cursor
.vpos
;
23779 int mouse_face_here_p
= 0;
23780 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23781 struct glyph_row
*cursor_row
;
23782 struct glyph
*cursor_glyph
;
23783 enum draw_glyphs_face hl
;
23785 /* No cursor displayed or row invalidated => nothing to do on the
23787 if (w
->phys_cursor_type
== NO_CURSOR
)
23788 goto mark_cursor_off
;
23790 /* VPOS >= active_glyphs->nrows means that window has been resized.
23791 Don't bother to erase the cursor. */
23792 if (vpos
>= active_glyphs
->nrows
)
23793 goto mark_cursor_off
;
23795 /* If row containing cursor is marked invalid, there is nothing we
23797 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23798 if (!cursor_row
->enabled_p
)
23799 goto mark_cursor_off
;
23801 /* If line spacing is > 0, old cursor may only be partially visible in
23802 window after split-window. So adjust visible height. */
23803 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23804 window_text_bottom_y (w
) - cursor_row
->y
);
23806 /* If row is completely invisible, don't attempt to delete a cursor which
23807 isn't there. This can happen if cursor is at top of a window, and
23808 we switch to a buffer with a header line in that window. */
23809 if (cursor_row
->visible_height
<= 0)
23810 goto mark_cursor_off
;
23812 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23813 if (cursor_row
->cursor_in_fringe_p
)
23815 cursor_row
->cursor_in_fringe_p
= 0;
23816 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23817 goto mark_cursor_off
;
23820 /* This can happen when the new row is shorter than the old one.
23821 In this case, either draw_glyphs or clear_end_of_line
23822 should have cleared the cursor. Note that we wouldn't be
23823 able to erase the cursor in this case because we don't have a
23824 cursor glyph at hand. */
23825 if ((cursor_row
->reversed_p
23826 ? (w
->phys_cursor
.hpos
< 0)
23827 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23828 goto mark_cursor_off
;
23830 /* If the cursor is in the mouse face area, redisplay that when
23831 we clear the cursor. */
23832 if (! NILP (hlinfo
->mouse_face_window
)
23833 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23834 /* Don't redraw the cursor's spot in mouse face if it is at the
23835 end of a line (on a newline). The cursor appears there, but
23836 mouse highlighting does not. */
23837 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23838 mouse_face_here_p
= 1;
23840 /* Maybe clear the display under the cursor. */
23841 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23844 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23847 cursor_glyph
= get_phys_cursor_glyph (w
);
23848 if (cursor_glyph
== NULL
)
23849 goto mark_cursor_off
;
23851 width
= cursor_glyph
->pixel_width
;
23852 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23853 x
= w
->phys_cursor
.x
;
23855 width
-= left_x
- x
;
23856 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23857 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23858 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23861 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23864 /* Erase the cursor by redrawing the character underneath it. */
23865 if (mouse_face_here_p
)
23866 hl
= DRAW_MOUSE_FACE
;
23868 hl
= DRAW_NORMAL_TEXT
;
23869 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23872 w
->phys_cursor_on_p
= 0;
23873 w
->phys_cursor_type
= NO_CURSOR
;
23878 Display or clear cursor of window W. If ON is zero, clear the
23879 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23880 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23883 display_and_set_cursor (struct window
*w
, int on
,
23884 int hpos
, int vpos
, int x
, int y
)
23886 struct frame
*f
= XFRAME (w
->frame
);
23887 int new_cursor_type
;
23888 int new_cursor_width
;
23890 struct glyph_row
*glyph_row
;
23891 struct glyph
*glyph
;
23893 /* This is pointless on invisible frames, and dangerous on garbaged
23894 windows and frames; in the latter case, the frame or window may
23895 be in the midst of changing its size, and x and y may be off the
23897 if (! FRAME_VISIBLE_P (f
)
23898 || FRAME_GARBAGED_P (f
)
23899 || vpos
>= w
->current_matrix
->nrows
23900 || hpos
>= w
->current_matrix
->matrix_w
)
23903 /* If cursor is off and we want it off, return quickly. */
23904 if (!on
&& !w
->phys_cursor_on_p
)
23907 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23908 /* If cursor row is not enabled, we don't really know where to
23909 display the cursor. */
23910 if (!glyph_row
->enabled_p
)
23912 w
->phys_cursor_on_p
= 0;
23917 if (!glyph_row
->exact_window_width_line_p
23918 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23919 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23921 xassert (interrupt_input_blocked
);
23923 /* Set new_cursor_type to the cursor we want to be displayed. */
23924 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23925 &new_cursor_width
, &active_cursor
);
23927 /* If cursor is currently being shown and we don't want it to be or
23928 it is in the wrong place, or the cursor type is not what we want,
23930 if (w
->phys_cursor_on_p
23932 || w
->phys_cursor
.x
!= x
23933 || w
->phys_cursor
.y
!= y
23934 || new_cursor_type
!= w
->phys_cursor_type
23935 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23936 && new_cursor_width
!= w
->phys_cursor_width
)))
23937 erase_phys_cursor (w
);
23939 /* Don't check phys_cursor_on_p here because that flag is only set
23940 to zero in some cases where we know that the cursor has been
23941 completely erased, to avoid the extra work of erasing the cursor
23942 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23943 still not be visible, or it has only been partly erased. */
23946 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23947 w
->phys_cursor_height
= glyph_row
->height
;
23949 /* Set phys_cursor_.* before x_draw_.* is called because some
23950 of them may need the information. */
23951 w
->phys_cursor
.x
= x
;
23952 w
->phys_cursor
.y
= glyph_row
->y
;
23953 w
->phys_cursor
.hpos
= hpos
;
23954 w
->phys_cursor
.vpos
= vpos
;
23957 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23958 new_cursor_type
, new_cursor_width
,
23959 on
, active_cursor
);
23963 /* Switch the display of W's cursor on or off, according to the value
23967 update_window_cursor (struct window
*w
, int on
)
23969 /* Don't update cursor in windows whose frame is in the process
23970 of being deleted. */
23971 if (w
->current_matrix
)
23974 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23975 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23981 /* Call update_window_cursor with parameter ON_P on all leaf windows
23982 in the window tree rooted at W. */
23985 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23989 if (!NILP (w
->hchild
))
23990 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23991 else if (!NILP (w
->vchild
))
23992 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23994 update_window_cursor (w
, on_p
);
23996 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24002 Display the cursor on window W, or clear it, according to ON_P.
24003 Don't change the cursor's position. */
24006 x_update_cursor (struct frame
*f
, int on_p
)
24008 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24013 Clear the cursor of window W to background color, and mark the
24014 cursor as not shown. This is used when the text where the cursor
24015 is about to be rewritten. */
24018 x_clear_cursor (struct window
*w
)
24020 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24021 update_window_cursor (w
, 0);
24024 #endif /* HAVE_WINDOW_SYSTEM */
24026 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24029 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24030 int start_hpos
, int end_hpos
,
24031 enum draw_glyphs_face draw
)
24033 #ifdef HAVE_WINDOW_SYSTEM
24034 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24036 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24040 #if defined (HAVE_GPM) || defined (MSDOS)
24041 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24045 /* Display the active region described by mouse_face_* according to DRAW. */
24048 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24050 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24051 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24053 if (/* If window is in the process of being destroyed, don't bother
24055 w
->current_matrix
!= NULL
24056 /* Don't update mouse highlight if hidden */
24057 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24058 /* Recognize when we are called to operate on rows that don't exist
24059 anymore. This can happen when a window is split. */
24060 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24062 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24063 struct glyph_row
*row
, *first
, *last
;
24065 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24066 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24068 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24070 int start_hpos
, end_hpos
, start_x
;
24072 /* For all but the first row, the highlight starts at column 0. */
24075 /* R2L rows have BEG and END in reversed order, but the
24076 screen drawing geometry is always left to right. So
24077 we need to mirror the beginning and end of the
24078 highlighted area in R2L rows. */
24079 if (!row
->reversed_p
)
24081 start_hpos
= hlinfo
->mouse_face_beg_col
;
24082 start_x
= hlinfo
->mouse_face_beg_x
;
24084 else if (row
== last
)
24086 start_hpos
= hlinfo
->mouse_face_end_col
;
24087 start_x
= hlinfo
->mouse_face_end_x
;
24095 else if (row
->reversed_p
&& row
== last
)
24097 start_hpos
= hlinfo
->mouse_face_end_col
;
24098 start_x
= hlinfo
->mouse_face_end_x
;
24108 if (!row
->reversed_p
)
24109 end_hpos
= hlinfo
->mouse_face_end_col
;
24110 else if (row
== first
)
24111 end_hpos
= hlinfo
->mouse_face_beg_col
;
24114 end_hpos
= row
->used
[TEXT_AREA
];
24115 if (draw
== DRAW_NORMAL_TEXT
)
24116 row
->fill_line_p
= 1; /* Clear to end of line */
24119 else if (row
->reversed_p
&& row
== first
)
24120 end_hpos
= hlinfo
->mouse_face_beg_col
;
24123 end_hpos
= row
->used
[TEXT_AREA
];
24124 if (draw
== DRAW_NORMAL_TEXT
)
24125 row
->fill_line_p
= 1; /* Clear to end of line */
24128 if (end_hpos
> start_hpos
)
24130 draw_row_with_mouse_face (w
, start_x
, row
,
24131 start_hpos
, end_hpos
, draw
);
24134 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24138 #ifdef HAVE_WINDOW_SYSTEM
24139 /* When we've written over the cursor, arrange for it to
24140 be displayed again. */
24141 if (FRAME_WINDOW_P (f
)
24142 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24145 display_and_set_cursor (w
, 1,
24146 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24147 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24150 #endif /* HAVE_WINDOW_SYSTEM */
24153 #ifdef HAVE_WINDOW_SYSTEM
24154 /* Change the mouse cursor. */
24155 if (FRAME_WINDOW_P (f
))
24157 if (draw
== DRAW_NORMAL_TEXT
24158 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24159 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24160 else if (draw
== DRAW_MOUSE_FACE
)
24161 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24163 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24165 #endif /* HAVE_WINDOW_SYSTEM */
24169 Clear out the mouse-highlighted active region.
24170 Redraw it un-highlighted first. Value is non-zero if mouse
24171 face was actually drawn unhighlighted. */
24174 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24178 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24180 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24184 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24185 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24186 hlinfo
->mouse_face_window
= Qnil
;
24187 hlinfo
->mouse_face_overlay
= Qnil
;
24191 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24192 within the mouse face on that window. */
24194 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24196 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24198 /* Quickly resolve the easy cases. */
24199 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24200 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24202 if (vpos
< hlinfo
->mouse_face_beg_row
24203 || vpos
> hlinfo
->mouse_face_end_row
)
24205 if (vpos
> hlinfo
->mouse_face_beg_row
24206 && vpos
< hlinfo
->mouse_face_end_row
)
24209 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24211 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24213 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24216 else if ((vpos
== hlinfo
->mouse_face_beg_row
24217 && hpos
>= hlinfo
->mouse_face_beg_col
)
24218 || (vpos
== hlinfo
->mouse_face_end_row
24219 && hpos
< hlinfo
->mouse_face_end_col
))
24224 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24226 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24229 else if ((vpos
== hlinfo
->mouse_face_beg_row
24230 && hpos
<= hlinfo
->mouse_face_beg_col
)
24231 || (vpos
== hlinfo
->mouse_face_end_row
24232 && hpos
> hlinfo
->mouse_face_end_col
))
24240 Non-zero if physical cursor of window W is within mouse face. */
24243 cursor_in_mouse_face_p (struct window
*w
)
24245 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24250 /* Find the glyph rows START_ROW and END_ROW of window W that display
24251 characters between buffer positions START_CHARPOS and END_CHARPOS
24252 (excluding END_CHARPOS). This is similar to row_containing_pos,
24253 but is more accurate when bidi reordering makes buffer positions
24254 change non-linearly with glyph rows. */
24256 rows_from_pos_range (struct window
*w
,
24257 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24258 struct glyph_row
**start
, struct glyph_row
**end
)
24260 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24261 int last_y
= window_text_bottom_y (w
);
24262 struct glyph_row
*row
;
24267 while (!first
->enabled_p
24268 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24271 /* Find the START row. */
24273 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24276 /* A row can potentially be the START row if the range of the
24277 characters it displays intersects the range
24278 [START_CHARPOS..END_CHARPOS). */
24279 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24280 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24281 /* See the commentary in row_containing_pos, for the
24282 explanation of the complicated way to check whether
24283 some position is beyond the end of the characters
24284 displayed by a row. */
24285 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24286 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24287 && !row
->ends_at_zv_p
24288 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24289 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24290 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24291 && !row
->ends_at_zv_p
24292 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24294 /* Found a candidate row. Now make sure at least one of the
24295 glyphs it displays has a charpos from the range
24296 [START_CHARPOS..END_CHARPOS).
24298 This is not obvious because bidi reordering could make
24299 buffer positions of a row be 1,2,3,102,101,100, and if we
24300 want to highlight characters in [50..60), we don't want
24301 this row, even though [50..60) does intersect [1..103),
24302 the range of character positions given by the row's start
24303 and end positions. */
24304 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24305 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24309 if (BUFFERP (g
->object
)
24310 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24319 /* Find the END row. */
24321 /* If the last row is partially visible, start looking for END
24322 from that row, instead of starting from FIRST. */
24323 && !(row
->enabled_p
24324 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24326 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24328 struct glyph_row
*next
= row
+ 1;
24330 if (!next
->enabled_p
24331 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24332 /* The first row >= START whose range of displayed characters
24333 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24334 is the row END + 1. */
24335 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24336 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24337 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24338 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24339 && !next
->ends_at_zv_p
24340 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24341 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24342 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24343 && !next
->ends_at_zv_p
24344 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24351 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24352 but none of the characters it displays are in the range, it is
24354 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24355 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24359 if (BUFFERP (g
->object
)
24360 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24373 /* This function sets the mouse_face_* elements of HLINFO, assuming
24374 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24375 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24376 for the overlay or run of text properties specifying the mouse
24377 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24378 before-string and after-string that must also be highlighted.
24379 COVER_STRING, if non-nil, is a display string that may cover some
24380 or all of the highlighted text. */
24383 mouse_face_from_buffer_pos (Lisp_Object window
,
24384 Mouse_HLInfo
*hlinfo
,
24385 EMACS_INT mouse_charpos
,
24386 EMACS_INT start_charpos
,
24387 EMACS_INT end_charpos
,
24388 Lisp_Object before_string
,
24389 Lisp_Object after_string
,
24390 Lisp_Object cover_string
)
24392 struct window
*w
= XWINDOW (window
);
24393 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24394 struct glyph_row
*r1
, *r2
;
24395 struct glyph
*glyph
, *end
;
24396 EMACS_INT ignore
, pos
;
24399 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24400 xassert (NILP (before_string
) || STRINGP (before_string
));
24401 xassert (NILP (after_string
) || STRINGP (after_string
));
24403 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24404 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24406 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24407 /* If the before-string or display-string contains newlines,
24408 rows_from_pos_range skips to its last row. Move back. */
24409 if (!NILP (before_string
) || !NILP (cover_string
))
24411 struct glyph_row
*prev
;
24412 while ((prev
= r1
- 1, prev
>= first
)
24413 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24414 && prev
->used
[TEXT_AREA
] > 0)
24416 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24417 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24418 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24420 || !(EQ (glyph
->object
, before_string
)
24421 || EQ (glyph
->object
, cover_string
)))
24428 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24429 hlinfo
->mouse_face_past_end
= 1;
24431 else if (!NILP (after_string
))
24433 /* If the after-string has newlines, advance to its last row. */
24434 struct glyph_row
*next
;
24435 struct glyph_row
*last
24436 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24438 for (next
= r2
+ 1;
24440 && next
->used
[TEXT_AREA
] > 0
24441 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24445 /* The rest of the display engine assumes that mouse_face_beg_row is
24446 either above below mouse_face_end_row or identical to it. But
24447 with bidi-reordered continued lines, the row for START_CHARPOS
24448 could be below the row for END_CHARPOS. If so, swap the rows and
24449 store them in correct order. */
24452 struct glyph_row
*tem
= r2
;
24458 hlinfo
->mouse_face_beg_y
= r1
->y
;
24459 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24460 hlinfo
->mouse_face_end_y
= r2
->y
;
24461 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24463 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24464 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24465 could be anywhere in the row and in any order. The strategy
24466 below is to find the leftmost and the rightmost glyph that
24467 belongs to either of these 3 strings, or whose position is
24468 between START_CHARPOS and END_CHARPOS, and highlight all the
24469 glyphs between those two. This may cover more than just the text
24470 between START_CHARPOS and END_CHARPOS if the range of characters
24471 strides the bidi level boundary, e.g. if the beginning is in R2L
24472 text while the end is in L2R text or vice versa. */
24473 if (!r1
->reversed_p
)
24475 /* This row is in a left to right paragraph. Scan it left to
24477 glyph
= r1
->glyphs
[TEXT_AREA
];
24478 end
= glyph
+ r1
->used
[TEXT_AREA
];
24481 /* Skip truncation glyphs at the start of the glyph row. */
24482 if (r1
->displays_text_p
)
24484 && INTEGERP (glyph
->object
)
24485 && glyph
->charpos
< 0;
24487 x
+= glyph
->pixel_width
;
24489 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24490 or COVER_STRING, and the first glyph from buffer whose
24491 position is between START_CHARPOS and END_CHARPOS. */
24493 && !INTEGERP (glyph
->object
)
24494 && !EQ (glyph
->object
, cover_string
)
24495 && !(BUFFERP (glyph
->object
)
24496 && (glyph
->charpos
>= start_charpos
24497 && glyph
->charpos
< end_charpos
));
24500 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24501 are present at buffer positions between START_CHARPOS and
24502 END_CHARPOS, or if they come from an overlay. */
24503 if (EQ (glyph
->object
, before_string
))
24505 pos
= string_buffer_position (before_string
,
24507 /* If pos == 0, it means before_string came from an
24508 overlay, not from a buffer position. */
24509 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24512 else if (EQ (glyph
->object
, after_string
))
24514 pos
= string_buffer_position (after_string
, end_charpos
);
24515 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24518 x
+= glyph
->pixel_width
;
24520 hlinfo
->mouse_face_beg_x
= x
;
24521 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24525 /* This row is in a right to left paragraph. Scan it right to
24529 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24530 glyph
= end
+ r1
->used
[TEXT_AREA
];
24532 /* Skip truncation glyphs at the start of the glyph row. */
24533 if (r1
->displays_text_p
)
24535 && INTEGERP (glyph
->object
)
24536 && glyph
->charpos
< 0;
24540 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24541 or COVER_STRING, and the first glyph from buffer whose
24542 position is between START_CHARPOS and END_CHARPOS. */
24544 && !INTEGERP (glyph
->object
)
24545 && !EQ (glyph
->object
, cover_string
)
24546 && !(BUFFERP (glyph
->object
)
24547 && (glyph
->charpos
>= start_charpos
24548 && glyph
->charpos
< end_charpos
));
24551 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24552 are present at buffer positions between START_CHARPOS and
24553 END_CHARPOS, or if they come from an overlay. */
24554 if (EQ (glyph
->object
, before_string
))
24556 pos
= string_buffer_position (before_string
, start_charpos
);
24557 /* If pos == 0, it means before_string came from an
24558 overlay, not from a buffer position. */
24559 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24562 else if (EQ (glyph
->object
, after_string
))
24564 pos
= string_buffer_position (after_string
, end_charpos
);
24565 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24570 glyph
++; /* first glyph to the right of the highlighted area */
24571 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24572 x
+= g
->pixel_width
;
24573 hlinfo
->mouse_face_beg_x
= x
;
24574 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24577 /* If the highlight ends in a different row, compute GLYPH and END
24578 for the end row. Otherwise, reuse the values computed above for
24579 the row where the highlight begins. */
24582 if (!r2
->reversed_p
)
24584 glyph
= r2
->glyphs
[TEXT_AREA
];
24585 end
= glyph
+ r2
->used
[TEXT_AREA
];
24590 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24591 glyph
= end
+ r2
->used
[TEXT_AREA
];
24595 if (!r2
->reversed_p
)
24597 /* Skip truncation and continuation glyphs near the end of the
24598 row, and also blanks and stretch glyphs inserted by
24599 extend_face_to_end_of_line. */
24601 && INTEGERP ((end
- 1)->object
)
24602 && (end
- 1)->charpos
<= 0)
24604 /* Scan the rest of the glyph row from the end, looking for the
24605 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24606 COVER_STRING, or whose position is between START_CHARPOS
24610 && !INTEGERP (end
->object
)
24611 && !EQ (end
->object
, cover_string
)
24612 && !(BUFFERP (end
->object
)
24613 && (end
->charpos
>= start_charpos
24614 && end
->charpos
< end_charpos
));
24617 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24618 are present at buffer positions between START_CHARPOS and
24619 END_CHARPOS, or if they come from an overlay. */
24620 if (EQ (end
->object
, before_string
))
24622 pos
= string_buffer_position (before_string
, start_charpos
);
24623 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24626 else if (EQ (end
->object
, after_string
))
24628 pos
= string_buffer_position (after_string
, end_charpos
);
24629 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24633 /* Find the X coordinate of the last glyph to be highlighted. */
24634 for (; glyph
<= end
; ++glyph
)
24635 x
+= glyph
->pixel_width
;
24637 hlinfo
->mouse_face_end_x
= x
;
24638 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24642 /* Skip truncation and continuation glyphs near the end of the
24643 row, and also blanks and stretch glyphs inserted by
24644 extend_face_to_end_of_line. */
24648 && INTEGERP (end
->object
)
24649 && end
->charpos
<= 0)
24651 x
+= end
->pixel_width
;
24654 /* Scan the rest of the glyph row from the end, looking for the
24655 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24656 COVER_STRING, or whose position is between START_CHARPOS
24660 && !INTEGERP (end
->object
)
24661 && !EQ (end
->object
, cover_string
)
24662 && !(BUFFERP (end
->object
)
24663 && (end
->charpos
>= start_charpos
24664 && end
->charpos
< end_charpos
));
24667 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24668 are present at buffer positions between START_CHARPOS and
24669 END_CHARPOS, or if they come from an overlay. */
24670 if (EQ (end
->object
, before_string
))
24672 pos
= string_buffer_position (before_string
, start_charpos
);
24673 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24676 else if (EQ (end
->object
, after_string
))
24678 pos
= string_buffer_position (after_string
, end_charpos
);
24679 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24682 x
+= end
->pixel_width
;
24684 hlinfo
->mouse_face_end_x
= x
;
24685 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24688 hlinfo
->mouse_face_window
= window
;
24689 hlinfo
->mouse_face_face_id
24690 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24692 !hlinfo
->mouse_face_hidden
, -1);
24693 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24696 /* The following function is not used anymore (replaced with
24697 mouse_face_from_string_pos), but I leave it here for the time
24698 being, in case someone would. */
24700 #if 0 /* not used */
24702 /* Find the position of the glyph for position POS in OBJECT in
24703 window W's current matrix, and return in *X, *Y the pixel
24704 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24706 RIGHT_P non-zero means return the position of the right edge of the
24707 glyph, RIGHT_P zero means return the left edge position.
24709 If no glyph for POS exists in the matrix, return the position of
24710 the glyph with the next smaller position that is in the matrix, if
24711 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24712 exists in the matrix, return the position of the glyph with the
24713 next larger position in OBJECT.
24715 Value is non-zero if a glyph was found. */
24718 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24719 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24721 int yb
= window_text_bottom_y (w
);
24722 struct glyph_row
*r
;
24723 struct glyph
*best_glyph
= NULL
;
24724 struct glyph_row
*best_row
= NULL
;
24727 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24728 r
->enabled_p
&& r
->y
< yb
;
24731 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24732 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24735 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24736 if (EQ (g
->object
, object
))
24738 if (g
->charpos
== pos
)
24745 else if (best_glyph
== NULL
24746 || ((eabs (g
->charpos
- pos
)
24747 < eabs (best_glyph
->charpos
- pos
))
24750 : g
->charpos
> pos
)))
24764 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24768 *x
+= best_glyph
->pixel_width
;
24773 *vpos
= best_row
- w
->current_matrix
->rows
;
24776 return best_glyph
!= NULL
;
24778 #endif /* not used */
24780 /* Find the positions of the first and the last glyphs in window W's
24781 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24782 (assumed to be a string), and return in HLINFO's mouse_face_*
24783 members the pixel and column/row coordinates of those glyphs. */
24786 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24787 Lisp_Object object
,
24788 EMACS_INT startpos
, EMACS_INT endpos
)
24790 int yb
= window_text_bottom_y (w
);
24791 struct glyph_row
*r
;
24792 struct glyph
*g
, *e
;
24796 /* Find the glyph row with at least one position in the range
24797 [STARTPOS..ENDPOS], and the first glyph in that row whose
24798 position belongs to that range. */
24799 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24800 r
->enabled_p
&& r
->y
< yb
;
24803 if (!r
->reversed_p
)
24805 g
= r
->glyphs
[TEXT_AREA
];
24806 e
= g
+ r
->used
[TEXT_AREA
];
24807 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24808 if (EQ (g
->object
, object
)
24809 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24811 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24812 hlinfo
->mouse_face_beg_y
= r
->y
;
24813 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24814 hlinfo
->mouse_face_beg_x
= gx
;
24823 e
= r
->glyphs
[TEXT_AREA
];
24824 g
= e
+ r
->used
[TEXT_AREA
];
24825 for ( ; g
> e
; --g
)
24826 if (EQ ((g
-1)->object
, object
)
24827 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24829 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24830 hlinfo
->mouse_face_beg_y
= r
->y
;
24831 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24832 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24833 gx
+= g1
->pixel_width
;
24834 hlinfo
->mouse_face_beg_x
= gx
;
24846 /* Starting with the next row, look for the first row which does NOT
24847 include any glyphs whose positions are in the range. */
24848 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24850 g
= r
->glyphs
[TEXT_AREA
];
24851 e
= g
+ r
->used
[TEXT_AREA
];
24853 for ( ; g
< e
; ++g
)
24854 if (EQ (g
->object
, object
)
24855 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24864 /* The highlighted region ends on the previous row. */
24867 /* Set the end row and its vertical pixel coordinate. */
24868 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24869 hlinfo
->mouse_face_end_y
= r
->y
;
24871 /* Compute and set the end column and the end column's horizontal
24872 pixel coordinate. */
24873 if (!r
->reversed_p
)
24875 g
= r
->glyphs
[TEXT_AREA
];
24876 e
= g
+ r
->used
[TEXT_AREA
];
24877 for ( ; e
> g
; --e
)
24878 if (EQ ((e
-1)->object
, object
)
24879 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24881 hlinfo
->mouse_face_end_col
= e
- g
;
24883 for (gx
= r
->x
; g
< e
; ++g
)
24884 gx
+= g
->pixel_width
;
24885 hlinfo
->mouse_face_end_x
= gx
;
24889 e
= r
->glyphs
[TEXT_AREA
];
24890 g
= e
+ r
->used
[TEXT_AREA
];
24891 for (gx
= r
->x
; e
< g
; ++e
)
24893 if (EQ (e
->object
, object
)
24894 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24896 gx
+= e
->pixel_width
;
24898 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24899 hlinfo
->mouse_face_end_x
= gx
;
24903 #ifdef HAVE_WINDOW_SYSTEM
24905 /* See if position X, Y is within a hot-spot of an image. */
24908 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24910 if (!CONSP (hot_spot
))
24913 if (EQ (XCAR (hot_spot
), Qrect
))
24915 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24916 Lisp_Object rect
= XCDR (hot_spot
);
24920 if (!CONSP (XCAR (rect
)))
24922 if (!CONSP (XCDR (rect
)))
24924 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24926 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24928 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24930 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24934 else if (EQ (XCAR (hot_spot
), Qcircle
))
24936 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24937 Lisp_Object circ
= XCDR (hot_spot
);
24938 Lisp_Object lr
, lx0
, ly0
;
24940 && CONSP (XCAR (circ
))
24941 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24942 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24943 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24945 double r
= XFLOATINT (lr
);
24946 double dx
= XINT (lx0
) - x
;
24947 double dy
= XINT (ly0
) - y
;
24948 return (dx
* dx
+ dy
* dy
<= r
* r
);
24951 else if (EQ (XCAR (hot_spot
), Qpoly
))
24953 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24954 if (VECTORP (XCDR (hot_spot
)))
24956 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24957 Lisp_Object
*poly
= v
->contents
;
24958 int n
= v
->header
.size
;
24961 Lisp_Object lx
, ly
;
24964 /* Need an even number of coordinates, and at least 3 edges. */
24965 if (n
< 6 || n
& 1)
24968 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24969 If count is odd, we are inside polygon. Pixels on edges
24970 may or may not be included depending on actual geometry of the
24972 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24973 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24975 x0
= XINT (lx
), y0
= XINT (ly
);
24976 for (i
= 0; i
< n
; i
+= 2)
24978 int x1
= x0
, y1
= y0
;
24979 if ((lx
= poly
[i
], !INTEGERP (lx
))
24980 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24982 x0
= XINT (lx
), y0
= XINT (ly
);
24984 /* Does this segment cross the X line? */
24992 if (y
> y0
&& y
> y1
)
24994 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25004 find_hot_spot (Lisp_Object map
, int x
, int y
)
25006 while (CONSP (map
))
25008 if (CONSP (XCAR (map
))
25009 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25017 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25019 doc
: /* Lookup in image map MAP coordinates X and Y.
25020 An image map is an alist where each element has the format (AREA ID PLIST).
25021 An AREA is specified as either a rectangle, a circle, or a polygon:
25022 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25023 pixel coordinates of the upper left and bottom right corners.
25024 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25025 and the radius of the circle; r may be a float or integer.
25026 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25027 vector describes one corner in the polygon.
25028 Returns the alist element for the first matching AREA in MAP. */)
25029 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25037 return find_hot_spot (map
, XINT (x
), XINT (y
));
25041 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25043 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25045 /* Do not change cursor shape while dragging mouse. */
25046 if (!NILP (do_mouse_tracking
))
25049 if (!NILP (pointer
))
25051 if (EQ (pointer
, Qarrow
))
25052 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25053 else if (EQ (pointer
, Qhand
))
25054 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25055 else if (EQ (pointer
, Qtext
))
25056 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25057 else if (EQ (pointer
, intern ("hdrag")))
25058 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25059 #ifdef HAVE_X_WINDOWS
25060 else if (EQ (pointer
, intern ("vdrag")))
25061 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25063 else if (EQ (pointer
, intern ("hourglass")))
25064 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25065 else if (EQ (pointer
, Qmodeline
))
25066 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25068 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25071 if (cursor
!= No_Cursor
)
25072 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25075 #endif /* HAVE_WINDOW_SYSTEM */
25077 /* Take proper action when mouse has moved to the mode or header line
25078 or marginal area AREA of window W, x-position X and y-position Y.
25079 X is relative to the start of the text display area of W, so the
25080 width of bitmap areas and scroll bars must be subtracted to get a
25081 position relative to the start of the mode line. */
25084 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25085 enum window_part area
)
25087 struct window
*w
= XWINDOW (window
);
25088 struct frame
*f
= XFRAME (w
->frame
);
25089 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25090 #ifdef HAVE_WINDOW_SYSTEM
25091 Display_Info
*dpyinfo
;
25093 Cursor cursor
= No_Cursor
;
25094 Lisp_Object pointer
= Qnil
;
25095 int dx
, dy
, width
, height
;
25097 Lisp_Object string
, object
= Qnil
;
25098 Lisp_Object pos
, help
;
25100 Lisp_Object mouse_face
;
25101 int original_x_pixel
= x
;
25102 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25103 struct glyph_row
*row
;
25105 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25110 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25111 returns them in row/column units! */
25112 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25113 &object
, &dx
, &dy
, &width
, &height
);
25115 row
= (area
== ON_MODE_LINE
25116 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25117 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25119 /* Find the glyph under the mouse pointer. */
25120 if (row
->mode_line_p
&& row
->enabled_p
)
25122 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25123 end
= glyph
+ row
->used
[TEXT_AREA
];
25125 for (x0
= original_x_pixel
;
25126 glyph
< end
&& x0
>= glyph
->pixel_width
;
25128 x0
-= glyph
->pixel_width
;
25136 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25137 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25138 returns them in row/column units! */
25139 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25140 &object
, &dx
, &dy
, &width
, &height
);
25145 #ifdef HAVE_WINDOW_SYSTEM
25146 if (IMAGEP (object
))
25148 Lisp_Object image_map
, hotspot
;
25149 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25151 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25153 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25157 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25158 If so, we could look for mouse-enter, mouse-leave
25159 properties in PLIST (and do something...). */
25160 hotspot
= XCDR (hotspot
);
25161 if (CONSP (hotspot
)
25162 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25164 pointer
= Fplist_get (plist
, Qpointer
);
25165 if (NILP (pointer
))
25167 help
= Fplist_get (plist
, Qhelp_echo
);
25170 help_echo_string
= help
;
25171 /* Is this correct? ++kfs */
25172 XSETWINDOW (help_echo_window
, w
);
25173 help_echo_object
= w
->buffer
;
25174 help_echo_pos
= charpos
;
25178 if (NILP (pointer
))
25179 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25181 #endif /* HAVE_WINDOW_SYSTEM */
25183 if (STRINGP (string
))
25185 pos
= make_number (charpos
);
25186 /* If we're on a string with `help-echo' text property, arrange
25187 for the help to be displayed. This is done by setting the
25188 global variable help_echo_string to the help string. */
25191 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25194 help_echo_string
= help
;
25195 XSETWINDOW (help_echo_window
, w
);
25196 help_echo_object
= string
;
25197 help_echo_pos
= charpos
;
25201 #ifdef HAVE_WINDOW_SYSTEM
25202 if (FRAME_WINDOW_P (f
))
25204 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25205 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25206 if (NILP (pointer
))
25207 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25209 /* Change the mouse pointer according to what is under X/Y. */
25211 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25214 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25215 if (!KEYMAPP (map
))
25216 map
= Fget_text_property (pos
, Qkeymap
, string
);
25217 if (!KEYMAPP (map
))
25218 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25223 /* Change the mouse face according to what is under X/Y. */
25224 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25225 if (!NILP (mouse_face
)
25226 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25231 struct glyph
* tmp_glyph
;
25235 int total_pixel_width
;
25236 EMACS_INT begpos
, endpos
, ignore
;
25240 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25241 Qmouse_face
, string
, Qnil
);
25247 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25249 endpos
= SCHARS (string
);
25253 /* Calculate the glyph position GPOS of GLYPH in the
25254 displayed string, relative to the beginning of the
25255 highlighted part of the string.
25257 Note: GPOS is different from CHARPOS. CHARPOS is the
25258 position of GLYPH in the internal string object. A mode
25259 line string format has structures which are converted to
25260 a flattened string by the Emacs Lisp interpreter. The
25261 internal string is an element of those structures. The
25262 displayed string is the flattened string. */
25263 tmp_glyph
= row_start_glyph
;
25264 while (tmp_glyph
< glyph
25265 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25266 && begpos
<= tmp_glyph
->charpos
25267 && tmp_glyph
->charpos
< endpos
)))
25269 gpos
= glyph
- tmp_glyph
;
25271 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25272 the highlighted part of the displayed string to which
25273 GLYPH belongs. Note: GSEQ_LENGTH is different from
25274 SCHARS (STRING), because the latter returns the length of
25275 the internal string. */
25276 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25278 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25279 && begpos
<= tmp_glyph
->charpos
25280 && tmp_glyph
->charpos
< endpos
));
25283 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25285 /* Calculate the total pixel width of all the glyphs between
25286 the beginning of the highlighted area and GLYPH. */
25287 total_pixel_width
= 0;
25288 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25289 total_pixel_width
+= tmp_glyph
->pixel_width
;
25291 /* Pre calculation of re-rendering position. Note: X is in
25292 column units here, after the call to mode_line_string or
25293 marginal_area_string. */
25295 vpos
= (area
== ON_MODE_LINE
25296 ? (w
->current_matrix
)->nrows
- 1
25299 /* If GLYPH's position is included in the region that is
25300 already drawn in mouse face, we have nothing to do. */
25301 if ( EQ (window
, hlinfo
->mouse_face_window
)
25302 && (!row
->reversed_p
25303 ? (hlinfo
->mouse_face_beg_col
<= hpos
25304 && hpos
< hlinfo
->mouse_face_end_col
)
25305 /* In R2L rows we swap BEG and END, see below. */
25306 : (hlinfo
->mouse_face_end_col
<= hpos
25307 && hpos
< hlinfo
->mouse_face_beg_col
))
25308 && hlinfo
->mouse_face_beg_row
== vpos
)
25311 if (clear_mouse_face (hlinfo
))
25312 cursor
= No_Cursor
;
25314 if (!row
->reversed_p
)
25316 hlinfo
->mouse_face_beg_col
= hpos
;
25317 hlinfo
->mouse_face_beg_x
= original_x_pixel
25318 - (total_pixel_width
+ dx
);
25319 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25320 hlinfo
->mouse_face_end_x
= 0;
25324 /* In R2L rows, show_mouse_face expects BEG and END
25325 coordinates to be swapped. */
25326 hlinfo
->mouse_face_end_col
= hpos
;
25327 hlinfo
->mouse_face_end_x
= original_x_pixel
25328 - (total_pixel_width
+ dx
);
25329 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25330 hlinfo
->mouse_face_beg_x
= 0;
25333 hlinfo
->mouse_face_beg_row
= vpos
;
25334 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25335 hlinfo
->mouse_face_beg_y
= 0;
25336 hlinfo
->mouse_face_end_y
= 0;
25337 hlinfo
->mouse_face_past_end
= 0;
25338 hlinfo
->mouse_face_window
= window
;
25340 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25346 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25348 if (NILP (pointer
))
25351 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25352 clear_mouse_face (hlinfo
);
25354 #ifdef HAVE_WINDOW_SYSTEM
25355 if (FRAME_WINDOW_P (f
))
25356 define_frame_cursor1 (f
, cursor
, pointer
);
25362 Take proper action when the mouse has moved to position X, Y on
25363 frame F as regards highlighting characters that have mouse-face
25364 properties. Also de-highlighting chars where the mouse was before.
25365 X and Y can be negative or out of range. */
25368 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25370 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25371 enum window_part part
;
25372 Lisp_Object window
;
25374 Cursor cursor
= No_Cursor
;
25375 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25378 /* When a menu is active, don't highlight because this looks odd. */
25379 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25380 if (popup_activated ())
25384 if (NILP (Vmouse_highlight
)
25385 || !f
->glyphs_initialized_p
25386 || f
->pointer_invisible
)
25389 hlinfo
->mouse_face_mouse_x
= x
;
25390 hlinfo
->mouse_face_mouse_y
= y
;
25391 hlinfo
->mouse_face_mouse_frame
= f
;
25393 if (hlinfo
->mouse_face_defer
)
25396 if (gc_in_progress
)
25398 hlinfo
->mouse_face_deferred_gc
= 1;
25402 /* Which window is that in? */
25403 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25405 /* If we were displaying active text in another window, clear that.
25406 Also clear if we move out of text area in same window. */
25407 if (! EQ (window
, hlinfo
->mouse_face_window
)
25408 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25409 && !NILP (hlinfo
->mouse_face_window
)))
25410 clear_mouse_face (hlinfo
);
25412 /* Not on a window -> return. */
25413 if (!WINDOWP (window
))
25416 /* Reset help_echo_string. It will get recomputed below. */
25417 help_echo_string
= Qnil
;
25419 /* Convert to window-relative pixel coordinates. */
25420 w
= XWINDOW (window
);
25421 frame_to_window_pixel_xy (w
, &x
, &y
);
25423 #ifdef HAVE_WINDOW_SYSTEM
25424 /* Handle tool-bar window differently since it doesn't display a
25426 if (EQ (window
, f
->tool_bar_window
))
25428 note_tool_bar_highlight (f
, x
, y
);
25433 /* Mouse is on the mode, header line or margin? */
25434 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25435 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25437 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25441 #ifdef HAVE_WINDOW_SYSTEM
25442 if (part
== ON_VERTICAL_BORDER
)
25444 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25445 help_echo_string
= build_string ("drag-mouse-1: resize");
25447 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25448 || part
== ON_SCROLL_BAR
)
25449 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25451 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25454 /* Are we in a window whose display is up to date?
25455 And verify the buffer's text has not changed. */
25456 b
= XBUFFER (w
->buffer
);
25457 if (part
== ON_TEXT
25458 && EQ (w
->window_end_valid
, w
->buffer
)
25459 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25460 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25462 int hpos
, vpos
, dx
, dy
, area
;
25464 struct glyph
*glyph
;
25465 Lisp_Object object
;
25466 Lisp_Object mouse_face
= Qnil
, position
;
25467 Lisp_Object
*overlay_vec
= NULL
;
25468 ptrdiff_t i
, noverlays
;
25469 struct buffer
*obuf
;
25470 EMACS_INT obegv
, ozv
;
25473 /* Find the glyph under X/Y. */
25474 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25476 #ifdef HAVE_WINDOW_SYSTEM
25477 /* Look for :pointer property on image. */
25478 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25480 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25481 if (img
!= NULL
&& IMAGEP (img
->spec
))
25483 Lisp_Object image_map
, hotspot
;
25484 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25486 && (hotspot
= find_hot_spot (image_map
,
25487 glyph
->slice
.img
.x
+ dx
,
25488 glyph
->slice
.img
.y
+ dy
),
25490 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25494 /* Could check XCAR (hotspot) to see if we enter/leave
25496 If so, we could look for mouse-enter, mouse-leave
25497 properties in PLIST (and do something...). */
25498 hotspot
= XCDR (hotspot
);
25499 if (CONSP (hotspot
)
25500 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25502 pointer
= Fplist_get (plist
, Qpointer
);
25503 if (NILP (pointer
))
25505 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25506 if (!NILP (help_echo_string
))
25508 help_echo_window
= window
;
25509 help_echo_object
= glyph
->object
;
25510 help_echo_pos
= glyph
->charpos
;
25514 if (NILP (pointer
))
25515 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25518 #endif /* HAVE_WINDOW_SYSTEM */
25520 /* Clear mouse face if X/Y not over text. */
25522 || area
!= TEXT_AREA
25523 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25524 /* Glyph's OBJECT is an integer for glyphs inserted by the
25525 display engine for its internal purposes, like truncation
25526 and continuation glyphs and blanks beyond the end of
25527 line's text on text terminals. If we are over such a
25528 glyph, we are not over any text. */
25529 || INTEGERP (glyph
->object
)
25530 /* R2L rows have a stretch glyph at their front, which
25531 stands for no text, whereas L2R rows have no glyphs at
25532 all beyond the end of text. Treat such stretch glyphs
25533 like we do with NULL glyphs in L2R rows. */
25534 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25535 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25536 && glyph
->type
== STRETCH_GLYPH
25537 && glyph
->avoid_cursor_p
))
25539 if (clear_mouse_face (hlinfo
))
25540 cursor
= No_Cursor
;
25541 #ifdef HAVE_WINDOW_SYSTEM
25542 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25544 if (area
!= TEXT_AREA
)
25545 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25547 pointer
= Vvoid_text_area_pointer
;
25553 pos
= glyph
->charpos
;
25554 object
= glyph
->object
;
25555 if (!STRINGP (object
) && !BUFFERP (object
))
25558 /* If we get an out-of-range value, return now; avoid an error. */
25559 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25562 /* Make the window's buffer temporarily current for
25563 overlays_at and compute_char_face. */
25564 obuf
= current_buffer
;
25565 current_buffer
= b
;
25571 /* Is this char mouse-active or does it have help-echo? */
25572 position
= make_number (pos
);
25574 if (BUFFERP (object
))
25576 /* Put all the overlays we want in a vector in overlay_vec. */
25577 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25578 /* Sort overlays into increasing priority order. */
25579 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25584 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25587 cursor
= No_Cursor
;
25589 /* Check mouse-face highlighting. */
25591 /* If there exists an overlay with mouse-face overlapping
25592 the one we are currently highlighting, we have to
25593 check if we enter the overlapping overlay, and then
25594 highlight only that. */
25595 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25596 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25598 /* Find the highest priority overlay with a mouse-face. */
25599 Lisp_Object overlay
= Qnil
;
25600 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25602 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25603 if (!NILP (mouse_face
))
25604 overlay
= overlay_vec
[i
];
25607 /* If we're highlighting the same overlay as before, there's
25608 no need to do that again. */
25609 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25610 goto check_help_echo
;
25611 hlinfo
->mouse_face_overlay
= overlay
;
25613 /* Clear the display of the old active region, if any. */
25614 if (clear_mouse_face (hlinfo
))
25615 cursor
= No_Cursor
;
25617 /* If no overlay applies, get a text property. */
25618 if (NILP (overlay
))
25619 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25621 /* Next, compute the bounds of the mouse highlighting and
25623 if (!NILP (mouse_face
) && STRINGP (object
))
25625 /* The mouse-highlighting comes from a display string
25626 with a mouse-face. */
25630 s
= Fprevious_single_property_change
25631 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25632 e
= Fnext_single_property_change
25633 (position
, Qmouse_face
, object
, Qnil
);
25635 s
= make_number (0);
25637 e
= make_number (SCHARS (object
) - 1);
25638 mouse_face_from_string_pos (w
, hlinfo
, object
,
25639 XINT (s
), XINT (e
));
25640 hlinfo
->mouse_face_past_end
= 0;
25641 hlinfo
->mouse_face_window
= window
;
25642 hlinfo
->mouse_face_face_id
25643 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25644 glyph
->face_id
, 1);
25645 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25646 cursor
= No_Cursor
;
25650 /* The mouse-highlighting, if any, comes from an overlay
25651 or text property in the buffer. */
25652 Lisp_Object buffer
IF_LINT (= Qnil
);
25653 Lisp_Object cover_string
IF_LINT (= Qnil
);
25655 if (STRINGP (object
))
25657 /* If we are on a display string with no mouse-face,
25658 check if the text under it has one. */
25659 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25660 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25661 pos
= string_buffer_position (object
, start
);
25664 mouse_face
= get_char_property_and_overlay
25665 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25666 buffer
= w
->buffer
;
25667 cover_string
= object
;
25673 cover_string
= Qnil
;
25676 if (!NILP (mouse_face
))
25678 Lisp_Object before
, after
;
25679 Lisp_Object before_string
, after_string
;
25680 /* To correctly find the limits of mouse highlight
25681 in a bidi-reordered buffer, we must not use the
25682 optimization of limiting the search in
25683 previous-single-property-change and
25684 next-single-property-change, because
25685 rows_from_pos_range needs the real start and end
25686 positions to DTRT in this case. That's because
25687 the first row visible in a window does not
25688 necessarily display the character whose position
25689 is the smallest. */
25691 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25692 ? Fmarker_position (w
->start
)
25695 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25696 ? make_number (BUF_Z (XBUFFER (buffer
))
25697 - XFASTINT (w
->window_end_pos
))
25700 if (NILP (overlay
))
25702 /* Handle the text property case. */
25703 before
= Fprevious_single_property_change
25704 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25705 after
= Fnext_single_property_change
25706 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25707 before_string
= after_string
= Qnil
;
25711 /* Handle the overlay case. */
25712 before
= Foverlay_start (overlay
);
25713 after
= Foverlay_end (overlay
);
25714 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25715 after_string
= Foverlay_get (overlay
, Qafter_string
);
25717 if (!STRINGP (before_string
)) before_string
= Qnil
;
25718 if (!STRINGP (after_string
)) after_string
= Qnil
;
25721 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25724 before_string
, after_string
,
25726 cursor
= No_Cursor
;
25733 /* Look for a `help-echo' property. */
25734 if (NILP (help_echo_string
)) {
25735 Lisp_Object help
, overlay
;
25737 /* Check overlays first. */
25738 help
= overlay
= Qnil
;
25739 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25741 overlay
= overlay_vec
[i
];
25742 help
= Foverlay_get (overlay
, Qhelp_echo
);
25747 help_echo_string
= help
;
25748 help_echo_window
= window
;
25749 help_echo_object
= overlay
;
25750 help_echo_pos
= pos
;
25754 Lisp_Object obj
= glyph
->object
;
25755 EMACS_INT charpos
= glyph
->charpos
;
25757 /* Try text properties. */
25760 && charpos
< SCHARS (obj
))
25762 help
= Fget_text_property (make_number (charpos
),
25766 /* If the string itself doesn't specify a help-echo,
25767 see if the buffer text ``under'' it does. */
25768 struct glyph_row
*r
25769 = MATRIX_ROW (w
->current_matrix
, vpos
);
25770 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25771 EMACS_INT p
= string_buffer_position (obj
, start
);
25774 help
= Fget_char_property (make_number (p
),
25775 Qhelp_echo
, w
->buffer
);
25784 else if (BUFFERP (obj
)
25787 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25792 help_echo_string
= help
;
25793 help_echo_window
= window
;
25794 help_echo_object
= obj
;
25795 help_echo_pos
= charpos
;
25800 #ifdef HAVE_WINDOW_SYSTEM
25801 /* Look for a `pointer' property. */
25802 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25804 /* Check overlays first. */
25805 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25806 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25808 if (NILP (pointer
))
25810 Lisp_Object obj
= glyph
->object
;
25811 EMACS_INT charpos
= glyph
->charpos
;
25813 /* Try text properties. */
25816 && charpos
< SCHARS (obj
))
25818 pointer
= Fget_text_property (make_number (charpos
),
25820 if (NILP (pointer
))
25822 /* If the string itself doesn't specify a pointer,
25823 see if the buffer text ``under'' it does. */
25824 struct glyph_row
*r
25825 = MATRIX_ROW (w
->current_matrix
, vpos
);
25826 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25827 EMACS_INT p
= string_buffer_position (obj
, start
);
25829 pointer
= Fget_char_property (make_number (p
),
25830 Qpointer
, w
->buffer
);
25833 else if (BUFFERP (obj
)
25836 pointer
= Fget_text_property (make_number (charpos
),
25840 #endif /* HAVE_WINDOW_SYSTEM */
25844 current_buffer
= obuf
;
25849 #ifdef HAVE_WINDOW_SYSTEM
25850 if (FRAME_WINDOW_P (f
))
25851 define_frame_cursor1 (f
, cursor
, pointer
);
25853 /* This is here to prevent a compiler error, about "label at end of
25854 compound statement". */
25861 Clear any mouse-face on window W. This function is part of the
25862 redisplay interface, and is called from try_window_id and similar
25863 functions to ensure the mouse-highlight is off. */
25866 x_clear_window_mouse_face (struct window
*w
)
25868 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25869 Lisp_Object window
;
25872 XSETWINDOW (window
, w
);
25873 if (EQ (window
, hlinfo
->mouse_face_window
))
25874 clear_mouse_face (hlinfo
);
25880 Just discard the mouse face information for frame F, if any.
25881 This is used when the size of F is changed. */
25884 cancel_mouse_face (struct frame
*f
)
25886 Lisp_Object window
;
25887 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25889 window
= hlinfo
->mouse_face_window
;
25890 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25892 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25893 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25894 hlinfo
->mouse_face_window
= Qnil
;
25900 /***********************************************************************
25902 ***********************************************************************/
25904 #ifdef HAVE_WINDOW_SYSTEM
25906 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25907 which intersects rectangle R. R is in window-relative coordinates. */
25910 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25911 enum glyph_row_area area
)
25913 struct glyph
*first
= row
->glyphs
[area
];
25914 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25915 struct glyph
*last
;
25916 int first_x
, start_x
, x
;
25918 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25919 /* If row extends face to end of line write the whole line. */
25920 draw_glyphs (w
, 0, row
, area
,
25921 0, row
->used
[area
],
25922 DRAW_NORMAL_TEXT
, 0);
25925 /* Set START_X to the window-relative start position for drawing glyphs of
25926 AREA. The first glyph of the text area can be partially visible.
25927 The first glyphs of other areas cannot. */
25928 start_x
= window_box_left_offset (w
, area
);
25930 if (area
== TEXT_AREA
)
25933 /* Find the first glyph that must be redrawn. */
25935 && x
+ first
->pixel_width
< r
->x
)
25937 x
+= first
->pixel_width
;
25941 /* Find the last one. */
25945 && x
< r
->x
+ r
->width
)
25947 x
+= last
->pixel_width
;
25953 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25954 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25955 DRAW_NORMAL_TEXT
, 0);
25960 /* Redraw the parts of the glyph row ROW on window W intersecting
25961 rectangle R. R is in window-relative coordinates. Value is
25962 non-zero if mouse-face was overwritten. */
25965 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25967 xassert (row
->enabled_p
);
25969 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25970 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25971 0, row
->used
[TEXT_AREA
],
25972 DRAW_NORMAL_TEXT
, 0);
25975 if (row
->used
[LEFT_MARGIN_AREA
])
25976 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25977 if (row
->used
[TEXT_AREA
])
25978 expose_area (w
, row
, r
, TEXT_AREA
);
25979 if (row
->used
[RIGHT_MARGIN_AREA
])
25980 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25981 draw_row_fringe_bitmaps (w
, row
);
25984 return row
->mouse_face_p
;
25988 /* Redraw those parts of glyphs rows during expose event handling that
25989 overlap other rows. Redrawing of an exposed line writes over parts
25990 of lines overlapping that exposed line; this function fixes that.
25992 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25993 row in W's current matrix that is exposed and overlaps other rows.
25994 LAST_OVERLAPPING_ROW is the last such row. */
25997 expose_overlaps (struct window
*w
,
25998 struct glyph_row
*first_overlapping_row
,
25999 struct glyph_row
*last_overlapping_row
,
26002 struct glyph_row
*row
;
26004 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26005 if (row
->overlapping_p
)
26007 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26010 if (row
->used
[LEFT_MARGIN_AREA
])
26011 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26013 if (row
->used
[TEXT_AREA
])
26014 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26016 if (row
->used
[RIGHT_MARGIN_AREA
])
26017 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26023 /* Return non-zero if W's cursor intersects rectangle R. */
26026 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26028 XRectangle cr
, result
;
26029 struct glyph
*cursor_glyph
;
26030 struct glyph_row
*row
;
26032 if (w
->phys_cursor
.vpos
>= 0
26033 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26034 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26036 && row
->cursor_in_fringe_p
)
26038 /* Cursor is in the fringe. */
26039 cr
.x
= window_box_right_offset (w
,
26040 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26041 ? RIGHT_MARGIN_AREA
26044 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26045 cr
.height
= row
->height
;
26046 return x_intersect_rectangles (&cr
, r
, &result
);
26049 cursor_glyph
= get_phys_cursor_glyph (w
);
26052 /* r is relative to W's box, but w->phys_cursor.x is relative
26053 to left edge of W's TEXT area. Adjust it. */
26054 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26055 cr
.y
= w
->phys_cursor
.y
;
26056 cr
.width
= cursor_glyph
->pixel_width
;
26057 cr
.height
= w
->phys_cursor_height
;
26058 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26059 I assume the effect is the same -- and this is portable. */
26060 return x_intersect_rectangles (&cr
, r
, &result
);
26062 /* If we don't understand the format, pretend we're not in the hot-spot. */
26068 Draw a vertical window border to the right of window W if W doesn't
26069 have vertical scroll bars. */
26072 x_draw_vertical_border (struct window
*w
)
26074 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26076 /* We could do better, if we knew what type of scroll-bar the adjacent
26077 windows (on either side) have... But we don't :-(
26078 However, I think this works ok. ++KFS 2003-04-25 */
26080 /* Redraw borders between horizontally adjacent windows. Don't
26081 do it for frames with vertical scroll bars because either the
26082 right scroll bar of a window, or the left scroll bar of its
26083 neighbor will suffice as a border. */
26084 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26087 if (!WINDOW_RIGHTMOST_P (w
)
26088 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26090 int x0
, x1
, y0
, y1
;
26092 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26095 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26098 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26100 else if (!WINDOW_LEFTMOST_P (w
)
26101 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26103 int x0
, x1
, y0
, y1
;
26105 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26108 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26111 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26116 /* Redraw the part of window W intersection rectangle FR. Pixel
26117 coordinates in FR are frame-relative. Call this function with
26118 input blocked. Value is non-zero if the exposure overwrites
26122 expose_window (struct window
*w
, XRectangle
*fr
)
26124 struct frame
*f
= XFRAME (w
->frame
);
26126 int mouse_face_overwritten_p
= 0;
26128 /* If window is not yet fully initialized, do nothing. This can
26129 happen when toolkit scroll bars are used and a window is split.
26130 Reconfiguring the scroll bar will generate an expose for a newly
26132 if (w
->current_matrix
== NULL
)
26135 /* When we're currently updating the window, display and current
26136 matrix usually don't agree. Arrange for a thorough display
26138 if (w
== updated_window
)
26140 SET_FRAME_GARBAGED (f
);
26144 /* Frame-relative pixel rectangle of W. */
26145 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26146 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26147 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26148 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26150 if (x_intersect_rectangles (fr
, &wr
, &r
))
26152 int yb
= window_text_bottom_y (w
);
26153 struct glyph_row
*row
;
26154 int cursor_cleared_p
;
26155 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26157 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26158 r
.x
, r
.y
, r
.width
, r
.height
));
26160 /* Convert to window coordinates. */
26161 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26162 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26164 /* Turn off the cursor. */
26165 if (!w
->pseudo_window_p
26166 && phys_cursor_in_rect_p (w
, &r
))
26168 x_clear_cursor (w
);
26169 cursor_cleared_p
= 1;
26172 cursor_cleared_p
= 0;
26174 /* Update lines intersecting rectangle R. */
26175 first_overlapping_row
= last_overlapping_row
= NULL
;
26176 for (row
= w
->current_matrix
->rows
;
26181 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26183 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26184 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26185 || (r
.y
>= y0
&& r
.y
< y1
)
26186 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26188 /* A header line may be overlapping, but there is no need
26189 to fix overlapping areas for them. KFS 2005-02-12 */
26190 if (row
->overlapping_p
&& !row
->mode_line_p
)
26192 if (first_overlapping_row
== NULL
)
26193 first_overlapping_row
= row
;
26194 last_overlapping_row
= row
;
26198 if (expose_line (w
, row
, &r
))
26199 mouse_face_overwritten_p
= 1;
26202 else if (row
->overlapping_p
)
26204 /* We must redraw a row overlapping the exposed area. */
26206 ? y0
+ row
->phys_height
> r
.y
26207 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26209 if (first_overlapping_row
== NULL
)
26210 first_overlapping_row
= row
;
26211 last_overlapping_row
= row
;
26219 /* Display the mode line if there is one. */
26220 if (WINDOW_WANTS_MODELINE_P (w
)
26221 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26223 && row
->y
< r
.y
+ r
.height
)
26225 if (expose_line (w
, row
, &r
))
26226 mouse_face_overwritten_p
= 1;
26229 if (!w
->pseudo_window_p
)
26231 /* Fix the display of overlapping rows. */
26232 if (first_overlapping_row
)
26233 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26236 /* Draw border between windows. */
26237 x_draw_vertical_border (w
);
26239 /* Turn the cursor on again. */
26240 if (cursor_cleared_p
)
26241 update_window_cursor (w
, 1);
26245 return mouse_face_overwritten_p
;
26250 /* Redraw (parts) of all windows in the window tree rooted at W that
26251 intersect R. R contains frame pixel coordinates. Value is
26252 non-zero if the exposure overwrites mouse-face. */
26255 expose_window_tree (struct window
*w
, XRectangle
*r
)
26257 struct frame
*f
= XFRAME (w
->frame
);
26258 int mouse_face_overwritten_p
= 0;
26260 while (w
&& !FRAME_GARBAGED_P (f
))
26262 if (!NILP (w
->hchild
))
26263 mouse_face_overwritten_p
26264 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26265 else if (!NILP (w
->vchild
))
26266 mouse_face_overwritten_p
26267 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26269 mouse_face_overwritten_p
|= expose_window (w
, r
);
26271 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26274 return mouse_face_overwritten_p
;
26279 Redisplay an exposed area of frame F. X and Y are the upper-left
26280 corner of the exposed rectangle. W and H are width and height of
26281 the exposed area. All are pixel values. W or H zero means redraw
26282 the entire frame. */
26285 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26288 int mouse_face_overwritten_p
= 0;
26290 TRACE ((stderr
, "expose_frame "));
26292 /* No need to redraw if frame will be redrawn soon. */
26293 if (FRAME_GARBAGED_P (f
))
26295 TRACE ((stderr
, " garbaged\n"));
26299 /* If basic faces haven't been realized yet, there is no point in
26300 trying to redraw anything. This can happen when we get an expose
26301 event while Emacs is starting, e.g. by moving another window. */
26302 if (FRAME_FACE_CACHE (f
) == NULL
26303 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26305 TRACE ((stderr
, " no faces\n"));
26309 if (w
== 0 || h
== 0)
26312 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26313 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26323 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26324 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26326 if (WINDOWP (f
->tool_bar_window
))
26327 mouse_face_overwritten_p
26328 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26330 #ifdef HAVE_X_WINDOWS
26332 #ifndef USE_X_TOOLKIT
26333 if (WINDOWP (f
->menu_bar_window
))
26334 mouse_face_overwritten_p
26335 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26336 #endif /* not USE_X_TOOLKIT */
26340 /* Some window managers support a focus-follows-mouse style with
26341 delayed raising of frames. Imagine a partially obscured frame,
26342 and moving the mouse into partially obscured mouse-face on that
26343 frame. The visible part of the mouse-face will be highlighted,
26344 then the WM raises the obscured frame. With at least one WM, KDE
26345 2.1, Emacs is not getting any event for the raising of the frame
26346 (even tried with SubstructureRedirectMask), only Expose events.
26347 These expose events will draw text normally, i.e. not
26348 highlighted. Which means we must redo the highlight here.
26349 Subsume it under ``we love X''. --gerd 2001-08-15 */
26350 /* Included in Windows version because Windows most likely does not
26351 do the right thing if any third party tool offers
26352 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26353 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26355 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26356 if (f
== hlinfo
->mouse_face_mouse_frame
)
26358 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26359 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26360 clear_mouse_face (hlinfo
);
26361 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26368 Determine the intersection of two rectangles R1 and R2. Return
26369 the intersection in *RESULT. Value is non-zero if RESULT is not
26373 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26375 XRectangle
*left
, *right
;
26376 XRectangle
*upper
, *lower
;
26377 int intersection_p
= 0;
26379 /* Rearrange so that R1 is the left-most rectangle. */
26381 left
= r1
, right
= r2
;
26383 left
= r2
, right
= r1
;
26385 /* X0 of the intersection is right.x0, if this is inside R1,
26386 otherwise there is no intersection. */
26387 if (right
->x
<= left
->x
+ left
->width
)
26389 result
->x
= right
->x
;
26391 /* The right end of the intersection is the minimum of
26392 the right ends of left and right. */
26393 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26396 /* Same game for Y. */
26398 upper
= r1
, lower
= r2
;
26400 upper
= r2
, lower
= r1
;
26402 /* The upper end of the intersection is lower.y0, if this is inside
26403 of upper. Otherwise, there is no intersection. */
26404 if (lower
->y
<= upper
->y
+ upper
->height
)
26406 result
->y
= lower
->y
;
26408 /* The lower end of the intersection is the minimum of the lower
26409 ends of upper and lower. */
26410 result
->height
= (min (lower
->y
+ lower
->height
,
26411 upper
->y
+ upper
->height
)
26413 intersection_p
= 1;
26417 return intersection_p
;
26420 #endif /* HAVE_WINDOW_SYSTEM */
26423 /***********************************************************************
26425 ***********************************************************************/
26428 syms_of_xdisp (void)
26430 Vwith_echo_area_save_vector
= Qnil
;
26431 staticpro (&Vwith_echo_area_save_vector
);
26433 Vmessage_stack
= Qnil
;
26434 staticpro (&Vmessage_stack
);
26436 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
26438 message_dolog_marker1
= Fmake_marker ();
26439 staticpro (&message_dolog_marker1
);
26440 message_dolog_marker2
= Fmake_marker ();
26441 staticpro (&message_dolog_marker2
);
26442 message_dolog_marker3
= Fmake_marker ();
26443 staticpro (&message_dolog_marker3
);
26446 defsubr (&Sdump_frame_glyph_matrix
);
26447 defsubr (&Sdump_glyph_matrix
);
26448 defsubr (&Sdump_glyph_row
);
26449 defsubr (&Sdump_tool_bar_row
);
26450 defsubr (&Strace_redisplay
);
26451 defsubr (&Strace_to_stderr
);
26453 #ifdef HAVE_WINDOW_SYSTEM
26454 defsubr (&Stool_bar_lines_needed
);
26455 defsubr (&Slookup_image_map
);
26457 defsubr (&Sformat_mode_line
);
26458 defsubr (&Sinvisible_p
);
26459 defsubr (&Scurrent_bidi_paragraph_direction
);
26461 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
26462 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
26463 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
26464 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
26465 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
26466 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
26467 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
26468 DEFSYM (Qeval
, "eval");
26469 DEFSYM (QCdata
, ":data");
26470 DEFSYM (Qdisplay
, "display");
26471 DEFSYM (Qspace_width
, "space-width");
26472 DEFSYM (Qraise
, "raise");
26473 DEFSYM (Qslice
, "slice");
26474 DEFSYM (Qspace
, "space");
26475 DEFSYM (Qmargin
, "margin");
26476 DEFSYM (Qpointer
, "pointer");
26477 DEFSYM (Qleft_margin
, "left-margin");
26478 DEFSYM (Qright_margin
, "right-margin");
26479 DEFSYM (Qcenter
, "center");
26480 DEFSYM (Qline_height
, "line-height");
26481 DEFSYM (QCalign_to
, ":align-to");
26482 DEFSYM (QCrelative_width
, ":relative-width");
26483 DEFSYM (QCrelative_height
, ":relative-height");
26484 DEFSYM (QCeval
, ":eval");
26485 DEFSYM (QCpropertize
, ":propertize");
26486 DEFSYM (QCfile
, ":file");
26487 DEFSYM (Qfontified
, "fontified");
26488 DEFSYM (Qfontification_functions
, "fontification-functions");
26489 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
26490 DEFSYM (Qescape_glyph
, "escape-glyph");
26491 DEFSYM (Qnobreak_space
, "nobreak-space");
26492 DEFSYM (Qimage
, "image");
26493 DEFSYM (Qtext
, "text");
26494 DEFSYM (Qboth
, "both");
26495 DEFSYM (Qboth_horiz
, "both-horiz");
26496 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
26497 DEFSYM (QCmap
, ":map");
26498 DEFSYM (QCpointer
, ":pointer");
26499 DEFSYM (Qrect
, "rect");
26500 DEFSYM (Qcircle
, "circle");
26501 DEFSYM (Qpoly
, "poly");
26502 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
26503 DEFSYM (Qgrow_only
, "grow-only");
26504 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
26505 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
26506 DEFSYM (Qposition
, "position");
26507 DEFSYM (Qbuffer_position
, "buffer-position");
26508 DEFSYM (Qobject
, "object");
26509 DEFSYM (Qbar
, "bar");
26510 DEFSYM (Qhbar
, "hbar");
26511 DEFSYM (Qbox
, "box");
26512 DEFSYM (Qhollow
, "hollow");
26513 DEFSYM (Qhand
, "hand");
26514 DEFSYM (Qarrow
, "arrow");
26515 DEFSYM (Qtext
, "text");
26516 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
26518 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26519 Fcons (intern_c_string ("void-variable"), Qnil
)),
26521 staticpro (&list_of_error
);
26523 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
26524 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
26525 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
26526 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
26528 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26529 staticpro (&echo_buffer
[0]);
26530 staticpro (&echo_buffer
[1]);
26532 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26533 staticpro (&echo_area_buffer
[0]);
26534 staticpro (&echo_area_buffer
[1]);
26536 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26537 staticpro (&Vmessages_buffer_name
);
26539 mode_line_proptrans_alist
= Qnil
;
26540 staticpro (&mode_line_proptrans_alist
);
26541 mode_line_string_list
= Qnil
;
26542 staticpro (&mode_line_string_list
);
26543 mode_line_string_face
= Qnil
;
26544 staticpro (&mode_line_string_face
);
26545 mode_line_string_face_prop
= Qnil
;
26546 staticpro (&mode_line_string_face_prop
);
26547 Vmode_line_unwind_vector
= Qnil
;
26548 staticpro (&Vmode_line_unwind_vector
);
26550 help_echo_string
= Qnil
;
26551 staticpro (&help_echo_string
);
26552 help_echo_object
= Qnil
;
26553 staticpro (&help_echo_object
);
26554 help_echo_window
= Qnil
;
26555 staticpro (&help_echo_window
);
26556 previous_help_echo_string
= Qnil
;
26557 staticpro (&previous_help_echo_string
);
26558 help_echo_pos
= -1;
26560 DEFSYM (Qright_to_left
, "right-to-left");
26561 DEFSYM (Qleft_to_right
, "left-to-right");
26563 #ifdef HAVE_WINDOW_SYSTEM
26564 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26565 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26566 For example, if a block cursor is over a tab, it will be drawn as
26567 wide as that tab on the display. */);
26568 x_stretch_cursor_p
= 0;
26571 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26572 doc
: /* *Non-nil means highlight trailing whitespace.
26573 The face used for trailing whitespace is `trailing-whitespace'. */);
26574 Vshow_trailing_whitespace
= Qnil
;
26576 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26577 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26578 A value of t means highlight the character itself (for nobreak space,
26579 use face `nobreak-space').
26580 A value of nil means no highlighting.
26581 Other values mean display the escape glyph followed by an ordinary
26582 space or ordinary hyphen. */);
26583 Vnobreak_char_display
= Qt
;
26585 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26586 doc
: /* *The pointer shape to show in void text areas.
26587 A value of nil means to show the text pointer. Other options are `arrow',
26588 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26589 Vvoid_text_area_pointer
= Qarrow
;
26591 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26592 doc
: /* Non-nil means don't actually do any redisplay.
26593 This is used for internal purposes. */);
26594 Vinhibit_redisplay
= Qnil
;
26596 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26597 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26598 Vglobal_mode_string
= Qnil
;
26600 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26601 doc
: /* Marker for where to display an arrow on top of the buffer text.
26602 This must be the beginning of a line in order to work.
26603 See also `overlay-arrow-string'. */);
26604 Voverlay_arrow_position
= Qnil
;
26606 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26607 doc
: /* String to display as an arrow in non-window frames.
26608 See also `overlay-arrow-position'. */);
26609 Voverlay_arrow_string
= make_pure_c_string ("=>");
26611 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26612 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26613 The symbols on this list are examined during redisplay to determine
26614 where to display overlay arrows. */);
26615 Voverlay_arrow_variable_list
26616 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26618 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26619 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26620 If that fails to bring point back on frame, point is centered instead.
26621 If this is zero, point is always centered after it moves off frame.
26622 If you want scrolling to always be a line at a time, you should set
26623 `scroll-conservatively' to a large value rather than set this to 1. */);
26625 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26626 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26627 If point moves off-screen, redisplay will scroll by up to
26628 `scroll-conservatively' lines in order to bring point just barely
26629 onto the screen again. If that cannot be done, then redisplay
26630 recenters point as usual.
26632 If the value is greater than 100, redisplay will never recenter point,
26633 but will always scroll just enough text to bring point into view, even
26634 if you move far away.
26636 A value of zero means always recenter point if it moves off screen. */);
26637 scroll_conservatively
= 0;
26639 DEFVAR_INT ("scroll-margin", scroll_margin
,
26640 doc
: /* *Number of lines of margin at the top and bottom of a window.
26641 Recenter the window whenever point gets within this many lines
26642 of the top or bottom of the window. */);
26645 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26646 doc
: /* Pixels per inch value for non-window system displays.
26647 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26648 Vdisplay_pixels_per_inch
= make_float (72.0);
26651 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26654 DEFVAR_LISP ("truncate-partial-width-windows",
26655 Vtruncate_partial_width_windows
,
26656 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26657 For an integer value, truncate lines in each window narrower than the
26658 full frame width, provided the window width is less than that integer;
26659 otherwise, respect the value of `truncate-lines'.
26661 For any other non-nil value, truncate lines in all windows that do
26662 not span the full frame width.
26664 A value of nil means to respect the value of `truncate-lines'.
26666 If `word-wrap' is enabled, you might want to reduce this. */);
26667 Vtruncate_partial_width_windows
= make_number (50);
26669 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26670 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26671 Any other value means to use the appropriate face, `mode-line',
26672 `header-line', or `menu' respectively. */);
26673 mode_line_inverse_video
= 1;
26675 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26676 doc
: /* *Maximum buffer size for which line number should be displayed.
26677 If the buffer is bigger than this, the line number does not appear
26678 in the mode line. A value of nil means no limit. */);
26679 Vline_number_display_limit
= Qnil
;
26681 DEFVAR_INT ("line-number-display-limit-width",
26682 line_number_display_limit_width
,
26683 doc
: /* *Maximum line width (in characters) for line number display.
26684 If the average length of the lines near point is bigger than this, then the
26685 line number may be omitted from the mode line. */);
26686 line_number_display_limit_width
= 200;
26688 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26689 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26690 highlight_nonselected_windows
= 0;
26692 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26693 doc
: /* Non-nil if more than one frame is visible on this display.
26694 Minibuffer-only frames don't count, but iconified frames do.
26695 This variable is not guaranteed to be accurate except while processing
26696 `frame-title-format' and `icon-title-format'. */);
26698 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26699 doc
: /* Template for displaying the title bar of visible frames.
26700 \(Assuming the window manager supports this feature.)
26702 This variable has the same structure as `mode-line-format', except that
26703 the %c and %l constructs are ignored. It is used only on frames for
26704 which no explicit name has been set \(see `modify-frame-parameters'). */);
26706 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26707 doc
: /* Template for displaying the title bar of an iconified frame.
26708 \(Assuming the window manager supports this feature.)
26709 This variable has the same structure as `mode-line-format' (which see),
26710 and is used only on frames for which no explicit name has been set
26711 \(see `modify-frame-parameters'). */);
26713 = Vframe_title_format
26714 = pure_cons (intern_c_string ("multiple-frames"),
26715 pure_cons (make_pure_c_string ("%b"),
26716 pure_cons (pure_cons (empty_unibyte_string
,
26717 pure_cons (intern_c_string ("invocation-name"),
26718 pure_cons (make_pure_c_string ("@"),
26719 pure_cons (intern_c_string ("system-name"),
26723 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26724 doc
: /* Maximum number of lines to keep in the message log buffer.
26725 If nil, disable message logging. If t, log messages but don't truncate
26726 the buffer when it becomes large. */);
26727 Vmessage_log_max
= make_number (100);
26729 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26730 doc
: /* Functions called before redisplay, if window sizes have changed.
26731 The value should be a list of functions that take one argument.
26732 Just before redisplay, for each frame, if any of its windows have changed
26733 size since the last redisplay, or have been split or deleted,
26734 all the functions in the list are called, with the frame as argument. */);
26735 Vwindow_size_change_functions
= Qnil
;
26737 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26738 doc
: /* List of functions to call before redisplaying a window with scrolling.
26739 Each function is called with two arguments, the window and its new
26740 display-start position. Note that these functions are also called by
26741 `set-window-buffer'. Also note that the value of `window-end' is not
26742 valid when these functions are called. */);
26743 Vwindow_scroll_functions
= Qnil
;
26745 DEFVAR_LISP ("window-text-change-functions",
26746 Vwindow_text_change_functions
,
26747 doc
: /* Functions to call in redisplay when text in the window might change. */);
26748 Vwindow_text_change_functions
= Qnil
;
26750 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26751 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26752 Each function is called with two arguments, the window and the end trigger value.
26753 See `set-window-redisplay-end-trigger'. */);
26754 Vredisplay_end_trigger_functions
= Qnil
;
26756 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26757 doc
: /* *Non-nil means autoselect window with mouse pointer.
26758 If nil, do not autoselect windows.
26759 A positive number means delay autoselection by that many seconds: a
26760 window is autoselected only after the mouse has remained in that
26761 window for the duration of the delay.
26762 A negative number has a similar effect, but causes windows to be
26763 autoselected only after the mouse has stopped moving. \(Because of
26764 the way Emacs compares mouse events, you will occasionally wait twice
26765 that time before the window gets selected.\)
26766 Any other value means to autoselect window instantaneously when the
26767 mouse pointer enters it.
26769 Autoselection selects the minibuffer only if it is active, and never
26770 unselects the minibuffer if it is active.
26772 When customizing this variable make sure that the actual value of
26773 `focus-follows-mouse' matches the behavior of your window manager. */);
26774 Vmouse_autoselect_window
= Qnil
;
26776 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26777 doc
: /* *Non-nil means automatically resize tool-bars.
26778 This dynamically changes the tool-bar's height to the minimum height
26779 that is needed to make all tool-bar items visible.
26780 If value is `grow-only', the tool-bar's height is only increased
26781 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26782 Vauto_resize_tool_bars
= Qt
;
26784 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26785 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26786 auto_raise_tool_bar_buttons_p
= 1;
26788 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26789 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26790 make_cursor_line_fully_visible_p
= 1;
26792 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26793 doc
: /* *Border below tool-bar in pixels.
26794 If an integer, use it as the height of the border.
26795 If it is one of `internal-border-width' or `border-width', use the
26796 value of the corresponding frame parameter.
26797 Otherwise, no border is added below the tool-bar. */);
26798 Vtool_bar_border
= Qinternal_border_width
;
26800 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26801 doc
: /* *Margin around tool-bar buttons in pixels.
26802 If an integer, use that for both horizontal and vertical margins.
26803 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26804 HORZ specifying the horizontal margin, and VERT specifying the
26805 vertical margin. */);
26806 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26808 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26809 doc
: /* *Relief thickness of tool-bar buttons. */);
26810 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26812 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26813 doc
: /* Tool bar style to use.
26815 image - show images only
26816 text - show text only
26817 both - show both, text below image
26818 both-horiz - show text to the right of the image
26819 text-image-horiz - show text to the left of the image
26820 any other - use system default or image if no system default. */);
26821 Vtool_bar_style
= Qnil
;
26823 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26824 doc
: /* *Maximum number of characters a label can have to be shown.
26825 The tool bar style must also show labels for this to have any effect, see
26826 `tool-bar-style'. */);
26827 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26829 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26830 doc
: /* List of functions to call to fontify regions of text.
26831 Each function is called with one argument POS. Functions must
26832 fontify a region starting at POS in the current buffer, and give
26833 fontified regions the property `fontified'. */);
26834 Vfontification_functions
= Qnil
;
26835 Fmake_variable_buffer_local (Qfontification_functions
);
26837 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26838 unibyte_display_via_language_environment
,
26839 doc
: /* *Non-nil means display unibyte text according to language environment.
26840 Specifically, this means that raw bytes in the range 160-255 decimal
26841 are displayed by converting them to the equivalent multibyte characters
26842 according to the current language environment. As a result, they are
26843 displayed according to the current fontset.
26845 Note that this variable affects only how these bytes are displayed,
26846 but does not change the fact they are interpreted as raw bytes. */);
26847 unibyte_display_via_language_environment
= 0;
26849 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26850 doc
: /* *Maximum height for resizing mini-windows.
26851 If a float, it specifies a fraction of the mini-window frame's height.
26852 If an integer, it specifies a number of lines. */);
26853 Vmax_mini_window_height
= make_float (0.25);
26855 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26856 doc
: /* *How to resize mini-windows.
26857 A value of nil means don't automatically resize mini-windows.
26858 A value of t means resize them to fit the text displayed in them.
26859 A value of `grow-only', the default, means let mini-windows grow
26860 only, until their display becomes empty, at which point the windows
26861 go back to their normal size. */);
26862 Vresize_mini_windows
= Qgrow_only
;
26864 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26865 doc
: /* Alist specifying how to blink the cursor off.
26866 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26867 `cursor-type' frame-parameter or variable equals ON-STATE,
26868 comparing using `equal', Emacs uses OFF-STATE to specify
26869 how to blink it off. ON-STATE and OFF-STATE are values for
26870 the `cursor-type' frame parameter.
26872 If a frame's ON-STATE has no entry in this list,
26873 the frame's other specifications determine how to blink the cursor off. */);
26874 Vblink_cursor_alist
= Qnil
;
26876 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26877 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26878 If non-nil, windows are automatically scrolled horizontally to make
26879 point visible. */);
26880 automatic_hscrolling_p
= 1;
26881 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
26883 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26884 doc
: /* *How many columns away from the window edge point is allowed to get
26885 before automatic hscrolling will horizontally scroll the window. */);
26886 hscroll_margin
= 5;
26888 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26889 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26890 When point is less than `hscroll-margin' columns from the window
26891 edge, automatic hscrolling will scroll the window by the amount of columns
26892 determined by this variable. If its value is a positive integer, scroll that
26893 many columns. If it's a positive floating-point number, it specifies the
26894 fraction of the window's width to scroll. If it's nil or zero, point will be
26895 centered horizontally after the scroll. Any other value, including negative
26896 numbers, are treated as if the value were zero.
26898 Automatic hscrolling always moves point outside the scroll margin, so if
26899 point was more than scroll step columns inside the margin, the window will
26900 scroll more than the value given by the scroll step.
26902 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26903 and `scroll-right' overrides this variable's effect. */);
26904 Vhscroll_step
= make_number (0);
26906 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26907 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26908 Bind this around calls to `message' to let it take effect. */);
26909 message_truncate_lines
= 0;
26911 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26912 doc
: /* Normal hook run to update the menu bar definitions.
26913 Redisplay runs this hook before it redisplays the menu bar.
26914 This is used to update submenus such as Buffers,
26915 whose contents depend on various data. */);
26916 Vmenu_bar_update_hook
= Qnil
;
26918 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26919 doc
: /* Frame for which we are updating a menu.
26920 The enable predicate for a menu binding should check this variable. */);
26921 Vmenu_updating_frame
= Qnil
;
26923 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26924 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26925 inhibit_menubar_update
= 0;
26927 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26928 doc
: /* Prefix prepended to all continuation lines at display time.
26929 The value may be a string, an image, or a stretch-glyph; it is
26930 interpreted in the same way as the value of a `display' text property.
26932 This variable is overridden by any `wrap-prefix' text or overlay
26935 To add a prefix to non-continuation lines, use `line-prefix'. */);
26936 Vwrap_prefix
= Qnil
;
26937 DEFSYM (Qwrap_prefix
, "wrap-prefix");
26938 Fmake_variable_buffer_local (Qwrap_prefix
);
26940 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26941 doc
: /* Prefix prepended to all non-continuation lines at display time.
26942 The value may be a string, an image, or a stretch-glyph; it is
26943 interpreted in the same way as the value of a `display' text property.
26945 This variable is overridden by any `line-prefix' text or overlay
26948 To add a prefix to continuation lines, use `wrap-prefix'. */);
26949 Vline_prefix
= Qnil
;
26950 DEFSYM (Qline_prefix
, "line-prefix");
26951 Fmake_variable_buffer_local (Qline_prefix
);
26953 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26954 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26955 inhibit_eval_during_redisplay
= 0;
26957 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26958 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26959 inhibit_free_realized_faces
= 0;
26962 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26963 doc
: /* Inhibit try_window_id display optimization. */);
26964 inhibit_try_window_id
= 0;
26966 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26967 doc
: /* Inhibit try_window_reusing display optimization. */);
26968 inhibit_try_window_reusing
= 0;
26970 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26971 doc
: /* Inhibit try_cursor_movement display optimization. */);
26972 inhibit_try_cursor_movement
= 0;
26973 #endif /* GLYPH_DEBUG */
26975 DEFVAR_INT ("overline-margin", overline_margin
,
26976 doc
: /* *Space between overline and text, in pixels.
26977 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26978 margin to the caracter height. */);
26979 overline_margin
= 2;
26981 DEFVAR_INT ("underline-minimum-offset",
26982 underline_minimum_offset
,
26983 doc
: /* Minimum distance between baseline and underline.
26984 This can improve legibility of underlined text at small font sizes,
26985 particularly when using variable `x-use-underline-position-properties'
26986 with fonts that specify an UNDERLINE_POSITION relatively close to the
26987 baseline. The default value is 1. */);
26988 underline_minimum_offset
= 1;
26990 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26991 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26992 This feature only works when on a window system that can change
26993 cursor shapes. */);
26994 display_hourglass_p
= 1;
26996 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26997 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26998 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27000 hourglass_atimer
= NULL
;
27001 hourglass_shown_p
= 0;
27003 DEFSYM (Qglyphless_char
, "glyphless-char");
27004 DEFSYM (Qhex_code
, "hex-code");
27005 DEFSYM (Qempty_box
, "empty-box");
27006 DEFSYM (Qthin_space
, "thin-space");
27007 DEFSYM (Qzero_width
, "zero-width");
27009 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27010 /* Intern this now in case it isn't already done.
27011 Setting this variable twice is harmless.
27012 But don't staticpro it here--that is done in alloc.c. */
27013 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27014 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27016 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27017 doc
: /* Char-table defining glyphless characters.
27018 Each element, if non-nil, should be one of the following:
27019 an ASCII acronym string: display this string in a box
27020 `hex-code': display the hexadecimal code of a character in a box
27021 `empty-box': display as an empty box
27022 `thin-space': display as 1-pixel width space
27023 `zero-width': don't display
27024 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27025 display method for graphical terminals and text terminals respectively.
27026 GRAPHICAL and TEXT should each have one of the values listed above.
27028 The char-table has one extra slot to control the display of a character for
27029 which no font is found. This slot only takes effect on graphical terminals.
27030 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27031 `thin-space'. The default is `empty-box'. */);
27032 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27033 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27038 /* Initialize this module when Emacs starts. */
27043 current_header_line_height
= current_mode_line_height
= -1;
27045 CHARPOS (this_line_start_pos
) = 0;
27047 if (!noninteractive
)
27049 struct window
*m
= XWINDOW (minibuf_window
);
27050 Lisp_Object frame
= m
->frame
;
27051 struct frame
*f
= XFRAME (frame
);
27052 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27053 struct window
*r
= XWINDOW (root
);
27056 echo_area_window
= minibuf_window
;
27058 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27059 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27060 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27061 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27062 XSETFASTINT (m
->total_lines
, 1);
27063 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27065 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27066 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27067 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27069 /* The default ellipsis glyphs `...'. */
27070 for (i
= 0; i
< 3; ++i
)
27071 default_invis_vector
[i
] = make_number ('.');
27075 /* Allocate the buffer for frame titles.
27076 Also used for `format-mode-line'. */
27078 mode_line_noprop_buf
= (char *) xmalloc (size
);
27079 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27080 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27081 mode_line_target
= MODE_LINE_DISPLAY
;
27084 help_echo_showing_p
= 0;
27087 /* Since w32 does not support atimers, it defines its own implementation of
27088 the following three functions in w32fns.c. */
27091 /* Platform-independent portion of hourglass implementation. */
27093 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27095 hourglass_started (void)
27097 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27100 /* Cancel a currently active hourglass timer, and start a new one. */
27102 start_hourglass (void)
27104 #if defined (HAVE_WINDOW_SYSTEM)
27106 int secs
, usecs
= 0;
27108 cancel_hourglass ();
27110 if (INTEGERP (Vhourglass_delay
)
27111 && XINT (Vhourglass_delay
) > 0)
27112 secs
= XFASTINT (Vhourglass_delay
);
27113 else if (FLOATP (Vhourglass_delay
)
27114 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27117 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27118 secs
= XFASTINT (tem
);
27119 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27122 secs
= DEFAULT_HOURGLASS_DELAY
;
27124 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27125 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27126 show_hourglass
, NULL
);
27131 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27134 cancel_hourglass (void)
27136 #if defined (HAVE_WINDOW_SYSTEM)
27137 if (hourglass_atimer
)
27139 cancel_atimer (hourglass_atimer
);
27140 hourglass_atimer
= NULL
;
27143 if (hourglass_shown_p
)
27147 #endif /* ! WINDOWSNT */