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 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 ptrdiff_t help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, ptrdiff_t);
799 static void pint2hrstr (char *, int, ptrdiff_t);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 ptrdiff_t, ptrdiff_t);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, ptrdiff_t);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
815 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
818 static void pop_message (void);
819 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
820 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
821 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
824 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (ptrdiff_t);
840 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, ptrdiff_t);
872 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, ptrdiff_t);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, ptrdiff_t);
905 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
906 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
907 static ptrdiff_t number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static ptrdiff_t next_overlay_change (ptrdiff_t);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, ptrdiff_t, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 ptrdiff_t rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 ptrdiff_t count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? clip_to_bounds (-1, XINT (BVAR (current_buffer
,
2433 selective_display
)),
2435 : (!NILP (BVAR (current_buffer
, selective_display
))
2437 it
->selective_display_ellipsis_p
2438 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2440 /* Display table to use. */
2441 it
->dp
= window_display_table (w
);
2443 /* Are multibyte characters enabled in current_buffer? */
2444 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2446 /* Non-zero if we should highlight the region. */
2448 = (!NILP (Vtransient_mark_mode
)
2449 && !NILP (BVAR (current_buffer
, mark_active
))
2450 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2452 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2453 start and end of a visible region in window IT->w. Set both to
2454 -1 to indicate no region. */
2455 if (highlight_region_p
2456 /* Maybe highlight only in selected window. */
2457 && (/* Either show region everywhere. */
2458 highlight_nonselected_windows
2459 /* Or show region in the selected window. */
2460 || w
== XWINDOW (selected_window
)
2461 /* Or show the region if we are in the mini-buffer and W is
2462 the window the mini-buffer refers to. */
2463 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2464 && WINDOWP (minibuf_selected_window
)
2465 && w
== XWINDOW (minibuf_selected_window
))))
2467 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2468 it
->region_beg_charpos
= min (PT
, markpos
);
2469 it
->region_end_charpos
= max (PT
, markpos
);
2472 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2474 /* Get the position at which the redisplay_end_trigger hook should
2475 be run, if it is to be run at all. */
2476 if (MARKERP (w
->redisplay_end_trigger
)
2477 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2478 it
->redisplay_end_trigger_charpos
2479 = marker_position (w
->redisplay_end_trigger
);
2480 else if (INTEGERP (w
->redisplay_end_trigger
))
2481 it
->redisplay_end_trigger_charpos
=
2482 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2484 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2486 /* Are lines in the display truncated? */
2487 if (base_face_id
!= DEFAULT_FACE_ID
2488 || XINT (it
->w
->hscroll
)
2489 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2490 && ((!NILP (Vtruncate_partial_width_windows
)
2491 && !INTEGERP (Vtruncate_partial_width_windows
))
2492 || (INTEGERP (Vtruncate_partial_width_windows
)
2493 && (WINDOW_TOTAL_COLS (it
->w
)
2494 < XINT (Vtruncate_partial_width_windows
))))))
2495 it
->line_wrap
= TRUNCATE
;
2496 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2497 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2498 ? WINDOW_WRAP
: WORD_WRAP
;
2500 it
->line_wrap
= TRUNCATE
;
2502 /* Get dimensions of truncation and continuation glyphs. These are
2503 displayed as fringe bitmaps under X, so we don't need them for such
2505 if (!FRAME_WINDOW_P (it
->f
))
2507 if (it
->line_wrap
== TRUNCATE
)
2509 /* We will need the truncation glyph. */
2510 xassert (it
->glyph_row
== NULL
);
2511 produce_special_glyphs (it
, IT_TRUNCATION
);
2512 it
->truncation_pixel_width
= it
->pixel_width
;
2516 /* We will need the continuation glyph. */
2517 xassert (it
->glyph_row
== NULL
);
2518 produce_special_glyphs (it
, IT_CONTINUATION
);
2519 it
->continuation_pixel_width
= it
->pixel_width
;
2522 /* Reset these values to zero because the produce_special_glyphs
2523 above has changed them. */
2524 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2525 it
->phys_ascent
= it
->phys_descent
= 0;
2528 /* Set this after getting the dimensions of truncation and
2529 continuation glyphs, so that we don't produce glyphs when calling
2530 produce_special_glyphs, above. */
2531 it
->glyph_row
= row
;
2532 it
->area
= TEXT_AREA
;
2534 /* Forget any previous info about this row being reversed. */
2536 it
->glyph_row
->reversed_p
= 0;
2538 /* Get the dimensions of the display area. The display area
2539 consists of the visible window area plus a horizontally scrolled
2540 part to the left of the window. All x-values are relative to the
2541 start of this total display area. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2544 /* Mode lines, menu bar in terminal frames. */
2545 it
->first_visible_x
= 0;
2546 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2551 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2552 it
->last_visible_x
= (it
->first_visible_x
2553 + window_box_width (w
, TEXT_AREA
));
2555 /* If we truncate lines, leave room for the truncator glyph(s) at
2556 the right margin. Otherwise, leave room for the continuation
2557 glyph(s). Truncation and continuation glyphs are not inserted
2558 for window-based redisplay. */
2559 if (!FRAME_WINDOW_P (it
->f
))
2561 if (it
->line_wrap
== TRUNCATE
)
2562 it
->last_visible_x
-= it
->truncation_pixel_width
;
2564 it
->last_visible_x
-= it
->continuation_pixel_width
;
2567 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2568 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2571 /* Leave room for a border glyph. */
2572 if (!FRAME_WINDOW_P (it
->f
)
2573 && !WINDOW_RIGHTMOST_P (it
->w
))
2574 it
->last_visible_x
-= 1;
2576 it
->last_visible_y
= window_text_bottom_y (w
);
2578 /* For mode lines and alike, arrange for the first glyph having a
2579 left box line if the face specifies a box. */
2580 if (base_face_id
!= DEFAULT_FACE_ID
)
2584 it
->face_id
= remapped_base_face_id
;
2586 /* If we have a boxed mode line, make the first character appear
2587 with a left box line. */
2588 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2589 if (face
->box
!= FACE_NO_BOX
)
2590 it
->start_of_box_run_p
= 1;
2593 /* If a buffer position was specified, set the iterator there,
2594 getting overlays and face properties from that position. */
2595 if (charpos
>= BUF_BEG (current_buffer
))
2597 it
->end_charpos
= ZV
;
2599 IT_CHARPOS (*it
) = charpos
;
2601 /* Compute byte position if not specified. */
2602 if (bytepos
< charpos
)
2603 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2605 IT_BYTEPOS (*it
) = bytepos
;
2607 it
->start
= it
->current
;
2608 /* Do we need to reorder bidirectional text? Not if this is a
2609 unibyte buffer: by definition, none of the single-byte
2610 characters are strong R2L, so no reordering is needed. And
2611 bidi.c doesn't support unibyte buffers anyway. */
2613 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2616 /* If we are to reorder bidirectional text, init the bidi
2620 /* Note the paragraph direction that this buffer wants to
2622 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= L2R
;
2625 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2627 it
->paragraph_embedding
= R2L
;
2629 it
->paragraph_embedding
= NEUTRAL_DIR
;
2630 bidi_unshelve_cache (NULL
, 0);
2631 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 it
->from_disp_prop_p
= 0;
2956 handle_overlay_change_p
= 0;
2958 handled
= HANDLED_RECOMPUTE_PROPS
;
2961 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2962 handle_overlay_change_p
= 0;
2965 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2967 /* Don't check for overlay strings below when set to deliver
2968 characters from a display vector. */
2969 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2970 handle_overlay_change_p
= 0;
2972 /* Handle overlay changes.
2973 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2974 if it finds overlays. */
2975 if (handle_overlay_change_p
)
2976 handled
= handle_overlay_change (it
);
2981 setup_for_ellipsis (it
, 0);
2985 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2987 /* Determine where to stop next. */
2988 if (handled
== HANDLED_NORMALLY
)
2989 compute_stop_pos (it
);
2993 /* Compute IT->stop_charpos from text property and overlay change
2994 information for IT's current position. */
2997 compute_stop_pos (struct it
*it
)
2999 register INTERVAL iv
, next_iv
;
3000 Lisp_Object object
, limit
, position
;
3001 ptrdiff_t charpos
, bytepos
;
3003 /* If nowhere else, stop at the end. */
3004 it
->stop_charpos
= it
->end_charpos
;
3006 if (STRINGP (it
->string
))
3008 /* Strings are usually short, so don't limit the search for
3010 object
= it
->string
;
3012 charpos
= IT_STRING_CHARPOS (*it
);
3013 bytepos
= IT_STRING_BYTEPOS (*it
);
3019 /* If next overlay change is in front of the current stop pos
3020 (which is IT->end_charpos), stop there. Note: value of
3021 next_overlay_change is point-max if no overlay change
3023 charpos
= IT_CHARPOS (*it
);
3024 bytepos
= IT_BYTEPOS (*it
);
3025 pos
= next_overlay_change (charpos
);
3026 if (pos
< it
->stop_charpos
)
3027 it
->stop_charpos
= pos
;
3029 /* If showing the region, we have to stop at the region
3030 start or end because the face might change there. */
3031 if (it
->region_beg_charpos
> 0)
3033 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3035 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3039 /* Set up variables for computing the stop position from text
3040 property changes. */
3041 XSETBUFFER (object
, current_buffer
);
3042 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3045 /* Get the interval containing IT's position. Value is a null
3046 interval if there isn't such an interval. */
3047 position
= make_number (charpos
);
3048 iv
= validate_interval_range (object
, &position
, &position
, 0);
3049 if (!NULL_INTERVAL_P (iv
))
3051 Lisp_Object values_here
[LAST_PROP_IDX
];
3054 /* Get properties here. */
3055 for (p
= it_props
; p
->handler
; ++p
)
3056 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3058 /* Look for an interval following iv that has different
3060 for (next_iv
= next_interval (iv
);
3061 (!NULL_INTERVAL_P (next_iv
)
3063 || XFASTINT (limit
) > next_iv
->position
));
3064 next_iv
= next_interval (next_iv
))
3066 for (p
= it_props
; p
->handler
; ++p
)
3068 Lisp_Object new_value
;
3070 new_value
= textget (next_iv
->plist
, *p
->name
);
3071 if (!EQ (values_here
[p
->idx
], new_value
))
3079 if (!NULL_INTERVAL_P (next_iv
))
3081 if (INTEGERP (limit
)
3082 && next_iv
->position
>= XFASTINT (limit
))
3083 /* No text property change up to limit. */
3084 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3086 /* Text properties change in next_iv. */
3087 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3091 if (it
->cmp_it
.id
< 0)
3093 ptrdiff_t stoppos
= it
->end_charpos
;
3095 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3097 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3098 stoppos
, it
->string
);
3101 xassert (STRINGP (it
->string
)
3102 || (it
->stop_charpos
>= BEGV
3103 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3107 /* Return the position of the next overlay change after POS in
3108 current_buffer. Value is point-max if no overlay change
3109 follows. This is like `next-overlay-change' but doesn't use
3113 next_overlay_change (ptrdiff_t pos
)
3115 ptrdiff_t i
, noverlays
;
3117 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3137 /* How many characters forward to search for a display property or
3138 display string. Searching too far forward makes the bidi display
3139 sluggish, especially in small windows. */
3140 #define MAX_DISP_SCAN 250
3142 /* Return the character position of a display string at or after
3143 position specified by POSITION. If no display string exists at or
3144 after POSITION, return ZV. A display string is either an overlay
3145 with `display' property whose value is a string, or a `display'
3146 text property whose value is a string. STRING is data about the
3147 string to iterate; if STRING->lstring is nil, we are iterating a
3148 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3149 on a GUI frame. DISP_PROP is set to zero if we searched
3150 MAX_DISP_SCAN characters forward without finding any display
3151 strings, non-zero otherwise. It is set to 2 if the display string
3152 uses any kind of `(space ...)' spec that will produce a stretch of
3153 white space in the text area. */
3155 compute_display_string_pos (struct text_pos
*position
,
3156 struct bidi_string_data
*string
,
3157 int frame_window_p
, int *disp_prop
)
3159 /* OBJECT = nil means current buffer. */
3160 Lisp_Object object
=
3161 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3162 Lisp_Object pos
, spec
, limpos
;
3163 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3164 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3165 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3166 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3168 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3169 struct text_pos tpos
;
3175 /* We don't support display properties whose values are strings
3176 that have display string properties. */
3177 || string
->from_disp_str
3178 /* C strings cannot have display properties. */
3179 || (string
->s
&& !STRINGP (object
)))
3185 /* If the character at CHARPOS is where the display string begins,
3187 pos
= make_number (charpos
);
3188 if (STRINGP (object
))
3189 bufpos
= string
->bufpos
;
3193 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3195 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3198 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3206 /* Look forward for the first character with a `display' property
3207 that will replace the underlying text when displayed. */
3208 limpos
= make_number (lim
);
3210 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3211 CHARPOS (tpos
) = XFASTINT (pos
);
3212 if (CHARPOS (tpos
) >= lim
)
3217 if (STRINGP (object
))
3218 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3220 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3221 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3222 if (!STRINGP (object
))
3223 bufpos
= CHARPOS (tpos
);
3224 } while (NILP (spec
)
3225 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3226 bufpos
, frame_window_p
)));
3230 return CHARPOS (tpos
);
3233 /* Return the character position of the end of the display string that
3234 started at CHARPOS. A display string is either an overlay with
3235 `display' property whose value is a string or a `display' text
3236 property whose value is a string. */
3238 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3240 /* OBJECT = nil means current buffer. */
3241 Lisp_Object object
=
3242 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3243 Lisp_Object pos
= make_number (charpos
);
3245 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3247 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3250 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3253 /* Look forward for the first character where the `display' property
3255 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3257 return XFASTINT (pos
);
3262 /***********************************************************************
3264 ***********************************************************************/
3266 /* Handle changes in the `fontified' property of the current buffer by
3267 calling hook functions from Qfontification_functions to fontify
3270 static enum prop_handled
3271 handle_fontified_prop (struct it
*it
)
3273 Lisp_Object prop
, pos
;
3274 enum prop_handled handled
= HANDLED_NORMALLY
;
3276 if (!NILP (Vmemory_full
))
3279 /* Get the value of the `fontified' property at IT's current buffer
3280 position. (The `fontified' property doesn't have a special
3281 meaning in strings.) If the value is nil, call functions from
3282 Qfontification_functions. */
3283 if (!STRINGP (it
->string
)
3285 && !NILP (Vfontification_functions
)
3286 && !NILP (Vrun_hooks
)
3287 && (pos
= make_number (IT_CHARPOS (*it
)),
3288 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3289 /* Ignore the special cased nil value always present at EOB since
3290 no amount of fontifying will be able to change it. */
3291 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3293 ptrdiff_t count
= SPECPDL_INDEX ();
3295 struct buffer
*obuf
= current_buffer
;
3296 int begv
= BEGV
, zv
= ZV
;
3297 int old_clip_changed
= current_buffer
->clip_changed
;
3299 val
= Vfontification_functions
;
3300 specbind (Qfontification_functions
, Qnil
);
3302 xassert (it
->end_charpos
== ZV
);
3304 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3305 safe_call1 (val
, pos
);
3308 Lisp_Object fns
, fn
;
3309 struct gcpro gcpro1
, gcpro2
;
3314 for (; CONSP (val
); val
= XCDR (val
))
3320 /* A value of t indicates this hook has a local
3321 binding; it means to run the global binding too.
3322 In a global value, t should not occur. If it
3323 does, we must ignore it to avoid an endless
3325 for (fns
= Fdefault_value (Qfontification_functions
);
3331 safe_call1 (fn
, pos
);
3335 safe_call1 (fn
, pos
);
3341 unbind_to (count
, Qnil
);
3343 /* Fontification functions routinely call `save-restriction'.
3344 Normally, this tags clip_changed, which can confuse redisplay
3345 (see discussion in Bug#6671). Since we don't perform any
3346 special handling of fontification changes in the case where
3347 `save-restriction' isn't called, there's no point doing so in
3348 this case either. So, if the buffer's restrictions are
3349 actually left unchanged, reset clip_changed. */
3350 if (obuf
== current_buffer
)
3352 if (begv
== BEGV
&& zv
== ZV
)
3353 current_buffer
->clip_changed
= old_clip_changed
;
3355 /* There isn't much we can reasonably do to protect against
3356 misbehaving fontification, but here's a fig leaf. */
3357 else if (!NILP (BVAR (obuf
, name
)))
3358 set_buffer_internal_1 (obuf
);
3360 /* The fontification code may have added/removed text.
3361 It could do even a lot worse, but let's at least protect against
3362 the most obvious case where only the text past `pos' gets changed',
3363 as is/was done in grep.el where some escapes sequences are turned
3364 into face properties (bug#7876). */
3365 it
->end_charpos
= ZV
;
3367 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3368 something. This avoids an endless loop if they failed to
3369 fontify the text for which reason ever. */
3370 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3371 handled
= HANDLED_RECOMPUTE_PROPS
;
3379 /***********************************************************************
3381 ***********************************************************************/
3383 /* Set up iterator IT from face properties at its current position.
3384 Called from handle_stop. */
3386 static enum prop_handled
3387 handle_face_prop (struct it
*it
)
3390 ptrdiff_t next_stop
;
3392 if (!STRINGP (it
->string
))
3395 = face_at_buffer_position (it
->w
,
3397 it
->region_beg_charpos
,
3398 it
->region_end_charpos
,
3401 + TEXT_PROP_DISTANCE_LIMIT
),
3402 0, it
->base_face_id
);
3404 /* Is this a start of a run of characters with box face?
3405 Caveat: this can be called for a freshly initialized
3406 iterator; face_id is -1 in this case. We know that the new
3407 face will not change until limit, i.e. if the new face has a
3408 box, all characters up to limit will have one. But, as
3409 usual, we don't know whether limit is really the end. */
3410 if (new_face_id
!= it
->face_id
)
3412 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3414 /* If new face has a box but old face has not, this is
3415 the start of a run of characters with box, i.e. it has
3416 a shadow on the left side. The value of face_id of the
3417 iterator will be -1 if this is the initial call that gets
3418 the face. In this case, we have to look in front of IT's
3419 position and see whether there is a face != new_face_id. */
3420 it
->start_of_box_run_p
3421 = (new_face
->box
!= FACE_NO_BOX
3422 && (it
->face_id
>= 0
3423 || IT_CHARPOS (*it
) == BEG
3424 || new_face_id
!= face_before_it_pos (it
)));
3425 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3433 Lisp_Object from_overlay
3434 = (it
->current
.overlay_string_index
>= 0
3435 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3438 /* See if we got to this string directly or indirectly from
3439 an overlay property. That includes the before-string or
3440 after-string of an overlay, strings in display properties
3441 provided by an overlay, their text properties, etc.
3443 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3444 if (! NILP (from_overlay
))
3445 for (i
= it
->sp
- 1; i
>= 0; i
--)
3447 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3449 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3450 else if (! NILP (it
->stack
[i
].from_overlay
))
3451 from_overlay
= it
->stack
[i
].from_overlay
;
3453 if (!NILP (from_overlay
))
3457 if (! NILP (from_overlay
))
3459 bufpos
= IT_CHARPOS (*it
);
3460 /* For a string from an overlay, the base face depends
3461 only on text properties and ignores overlays. */
3463 = face_for_overlay_string (it
->w
,
3465 it
->region_beg_charpos
,
3466 it
->region_end_charpos
,
3469 + TEXT_PROP_DISTANCE_LIMIT
),
3477 /* For strings from a `display' property, use the face at
3478 IT's current buffer position as the base face to merge
3479 with, so that overlay strings appear in the same face as
3480 surrounding text, unless they specify their own
3482 base_face_id
= underlying_face_id (it
);
3485 new_face_id
= face_at_string_position (it
->w
,
3487 IT_STRING_CHARPOS (*it
),
3489 it
->region_beg_charpos
,
3490 it
->region_end_charpos
,
3494 /* Is this a start of a run of characters with box? Caveat:
3495 this can be called for a freshly allocated iterator; face_id
3496 is -1 is this case. We know that the new face will not
3497 change until the next check pos, i.e. if the new face has a
3498 box, all characters up to that position will have a
3499 box. But, as usual, we don't know whether that position
3500 is really the end. */
3501 if (new_face_id
!= it
->face_id
)
3503 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3504 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3506 /* If new face has a box but old face hasn't, this is the
3507 start of a run of characters with box, i.e. it has a
3508 shadow on the left side. */
3509 it
->start_of_box_run_p
3510 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3511 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3515 it
->face_id
= new_face_id
;
3516 return HANDLED_NORMALLY
;
3520 /* Return the ID of the face ``underlying'' IT's current position,
3521 which is in a string. If the iterator is associated with a
3522 buffer, return the face at IT's current buffer position.
3523 Otherwise, use the iterator's base_face_id. */
3526 underlying_face_id (struct it
*it
)
3528 int face_id
= it
->base_face_id
, i
;
3530 xassert (STRINGP (it
->string
));
3532 for (i
= it
->sp
- 1; i
>= 0; --i
)
3533 if (NILP (it
->stack
[i
].string
))
3534 face_id
= it
->stack
[i
].face_id
;
3540 /* Compute the face one character before or after the current position
3541 of IT, in the visual order. BEFORE_P non-zero means get the face
3542 in front (to the left in L2R paragraphs, to the right in R2L
3543 paragraphs) of IT's screen position. Value is the ID of the face. */
3546 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3549 ptrdiff_t next_check_charpos
;
3551 void *it_copy_data
= NULL
;
3553 xassert (it
->s
== NULL
);
3555 if (STRINGP (it
->string
))
3557 ptrdiff_t bufpos
, charpos
;
3560 /* No face change past the end of the string (for the case
3561 we are padding with spaces). No face change before the
3563 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3564 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3569 /* Set charpos to the position before or after IT's current
3570 position, in the logical order, which in the non-bidi
3571 case is the same as the visual order. */
3573 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3574 else if (it
->what
== IT_COMPOSITION
)
3575 /* For composition, we must check the character after the
3577 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3579 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3585 /* With bidi iteration, the character before the current
3586 in the visual order cannot be found by simple
3587 iteration, because "reverse" reordering is not
3588 supported. Instead, we need to use the move_it_*
3589 family of functions. */
3590 /* Ignore face changes before the first visible
3591 character on this display line. */
3592 if (it
->current_x
<= it
->first_visible_x
)
3594 SAVE_IT (it_copy
, *it
, it_copy_data
);
3595 /* Implementation note: Since move_it_in_display_line
3596 works in the iterator geometry, and thinks the first
3597 character is always the leftmost, even in R2L lines,
3598 we don't need to distinguish between the R2L and L2R
3600 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3601 it_copy
.current_x
- 1, MOVE_TO_X
);
3602 charpos
= IT_STRING_CHARPOS (it_copy
);
3603 RESTORE_IT (it
, it
, it_copy_data
);
3607 /* Set charpos to the string position of the character
3608 that comes after IT's current position in the visual
3610 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3614 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3616 charpos
= it_copy
.bidi_it
.charpos
;
3619 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3621 if (it
->current
.overlay_string_index
>= 0)
3622 bufpos
= IT_CHARPOS (*it
);
3626 base_face_id
= underlying_face_id (it
);
3628 /* Get the face for ASCII, or unibyte. */
3629 face_id
= face_at_string_position (it
->w
,
3633 it
->region_beg_charpos
,
3634 it
->region_end_charpos
,
3635 &next_check_charpos
,
3638 /* Correct the face for charsets different from ASCII. Do it
3639 for the multibyte case only. The face returned above is
3640 suitable for unibyte text if IT->string is unibyte. */
3641 if (STRING_MULTIBYTE (it
->string
))
3643 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3644 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3646 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3648 c
= string_char_and_length (p
, &len
);
3649 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3654 struct text_pos pos
;
3656 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3657 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3660 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3661 pos
= it
->current
.pos
;
3666 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3669 if (it
->what
== IT_COMPOSITION
)
3671 /* For composition, we must check the position after
3673 pos
.charpos
+= it
->cmp_it
.nchars
;
3674 pos
.bytepos
+= it
->len
;
3677 INC_TEXT_POS (pos
, it
->multibyte_p
);
3684 /* With bidi iteration, the character before the current
3685 in the visual order cannot be found by simple
3686 iteration, because "reverse" reordering is not
3687 supported. Instead, we need to use the move_it_*
3688 family of functions. */
3689 /* Ignore face changes before the first visible
3690 character on this display line. */
3691 if (it
->current_x
<= it
->first_visible_x
)
3693 SAVE_IT (it_copy
, *it
, it_copy_data
);
3694 /* Implementation note: Since move_it_in_display_line
3695 works in the iterator geometry, and thinks the first
3696 character is always the leftmost, even in R2L lines,
3697 we don't need to distinguish between the R2L and L2R
3699 move_it_in_display_line (&it_copy
, ZV
,
3700 it_copy
.current_x
- 1, MOVE_TO_X
);
3701 pos
= it_copy
.current
.pos
;
3702 RESTORE_IT (it
, it
, it_copy_data
);
3706 /* Set charpos to the buffer position of the character
3707 that comes after IT's current position in the visual
3709 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3713 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3716 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3719 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3721 /* Determine face for CHARSET_ASCII, or unibyte. */
3722 face_id
= face_at_buffer_position (it
->w
,
3724 it
->region_beg_charpos
,
3725 it
->region_end_charpos
,
3726 &next_check_charpos
,
3729 /* Correct the face for charsets different from ASCII. Do it
3730 for the multibyte case only. The face returned above is
3731 suitable for unibyte text if current_buffer is unibyte. */
3732 if (it
->multibyte_p
)
3734 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3735 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3736 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3745 /***********************************************************************
3747 ***********************************************************************/
3749 /* Set up iterator IT from invisible properties at its current
3750 position. Called from handle_stop. */
3752 static enum prop_handled
3753 handle_invisible_prop (struct it
*it
)
3755 enum prop_handled handled
= HANDLED_NORMALLY
;
3757 if (STRINGP (it
->string
))
3759 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3761 /* Get the value of the invisible text property at the
3762 current position. Value will be nil if there is no such
3764 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3765 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3768 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3772 handled
= HANDLED_RECOMPUTE_PROPS
;
3774 /* Get the position at which the next change of the
3775 invisible text property can be found in IT->string.
3776 Value will be nil if the property value is the same for
3777 all the rest of IT->string. */
3778 XSETINT (limit
, SCHARS (it
->string
));
3779 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3782 /* Text at current position is invisible. The next
3783 change in the property is at position end_charpos.
3784 Move IT's current position to that position. */
3785 if (INTEGERP (end_charpos
)
3786 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3788 struct text_pos old
;
3791 old
= it
->current
.string_pos
;
3792 oldpos
= CHARPOS (old
);
3795 if (it
->bidi_it
.first_elt
3796 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3797 bidi_paragraph_init (it
->paragraph_embedding
,
3799 /* Bidi-iterate out of the invisible text. */
3802 bidi_move_to_visually_next (&it
->bidi_it
);
3804 while (oldpos
<= it
->bidi_it
.charpos
3805 && it
->bidi_it
.charpos
< endpos
);
3807 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3808 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3809 if (IT_CHARPOS (*it
) >= endpos
)
3810 it
->prev_stop
= endpos
;
3814 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3815 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3820 /* The rest of the string is invisible. If this is an
3821 overlay string, proceed with the next overlay string
3822 or whatever comes and return a character from there. */
3823 if (it
->current
.overlay_string_index
>= 0)
3825 next_overlay_string (it
);
3826 /* Don't check for overlay strings when we just
3827 finished processing them. */
3828 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3832 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3833 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3841 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
3842 Lisp_Object pos
, prop
, overlay
;
3844 /* First of all, is there invisible text at this position? */
3845 tem
= start_charpos
= IT_CHARPOS (*it
);
3846 pos
= make_number (tem
);
3847 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3849 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3851 /* If we are on invisible text, skip over it. */
3852 if (invis_p
&& start_charpos
< it
->end_charpos
)
3854 /* Record whether we have to display an ellipsis for the
3856 int display_ellipsis_p
= invis_p
== 2;
3858 handled
= HANDLED_RECOMPUTE_PROPS
;
3860 /* Loop skipping over invisible text. The loop is left at
3861 ZV or with IT on the first char being visible again. */
3864 /* Try to skip some invisible text. Return value is the
3865 position reached which can be equal to where we start
3866 if there is nothing invisible there. This skips both
3867 over invisible text properties and overlays with
3868 invisible property. */
3869 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3871 /* If we skipped nothing at all we weren't at invisible
3872 text in the first place. If everything to the end of
3873 the buffer was skipped, end the loop. */
3874 if (newpos
== tem
|| newpos
>= ZV
)
3878 /* We skipped some characters but not necessarily
3879 all there are. Check if we ended up on visible
3880 text. Fget_char_property returns the property of
3881 the char before the given position, i.e. if we
3882 get invis_p = 0, this means that the char at
3883 newpos is visible. */
3884 pos
= make_number (newpos
);
3885 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3886 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3889 /* If we ended up on invisible text, proceed to
3890 skip starting with next_stop. */
3894 /* If there are adjacent invisible texts, don't lose the
3895 second one's ellipsis. */
3897 display_ellipsis_p
= 1;
3901 /* The position newpos is now either ZV or on visible text. */
3902 if (it
->bidi_p
&& newpos
< ZV
)
3904 /* With bidi iteration, the region of invisible text
3905 could start and/or end in the middle of a non-base
3906 embedding level. Therefore, we need to skip
3907 invisible text using the bidi iterator, starting at
3908 IT's current position, until we find ourselves
3909 outside the invisible text. Skipping invisible text
3910 _after_ bidi iteration avoids affecting the visual
3911 order of the displayed text when invisible properties
3912 are added or removed. */
3913 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3915 /* If we were `reseat'ed to a new paragraph,
3916 determine the paragraph base direction. We need
3917 to do it now because next_element_from_buffer may
3918 not have a chance to do it, if we are going to
3919 skip any text at the beginning, which resets the
3921 bidi_paragraph_init (it
->paragraph_embedding
,
3926 bidi_move_to_visually_next (&it
->bidi_it
);
3928 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3929 && it
->bidi_it
.charpos
< newpos
);
3930 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3931 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3932 /* If we overstepped NEWPOS, record its position in the
3933 iterator, so that we skip invisible text if later the
3934 bidi iteration lands us in the invisible region
3936 if (IT_CHARPOS (*it
) >= newpos
)
3937 it
->prev_stop
= newpos
;
3941 IT_CHARPOS (*it
) = newpos
;
3942 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3945 /* If there are before-strings at the start of invisible
3946 text, and the text is invisible because of a text
3947 property, arrange to show before-strings because 20.x did
3948 it that way. (If the text is invisible because of an
3949 overlay property instead of a text property, this is
3950 already handled in the overlay code.) */
3952 && get_overlay_strings (it
, it
->stop_charpos
))
3954 handled
= HANDLED_RECOMPUTE_PROPS
;
3955 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3957 else if (display_ellipsis_p
)
3959 /* Make sure that the glyphs of the ellipsis will get
3960 correct `charpos' values. If we would not update
3961 it->position here, the glyphs would belong to the
3962 last visible character _before_ the invisible
3963 text, which confuses `set_cursor_from_row'.
3965 We use the last invisible position instead of the
3966 first because this way the cursor is always drawn on
3967 the first "." of the ellipsis, whenever PT is inside
3968 the invisible text. Otherwise the cursor would be
3969 placed _after_ the ellipsis when the point is after the
3970 first invisible character. */
3971 if (!STRINGP (it
->object
))
3973 it
->position
.charpos
= newpos
- 1;
3974 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3977 /* Let the ellipsis display before
3978 considering any properties of the following char.
3979 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3980 handled
= HANDLED_RETURN
;
3989 /* Make iterator IT return `...' next.
3990 Replaces LEN characters from buffer. */
3993 setup_for_ellipsis (struct it
*it
, int len
)
3995 /* Use the display table definition for `...'. Invalid glyphs
3996 will be handled by the method returning elements from dpvec. */
3997 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3999 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4000 it
->dpvec
= v
->contents
;
4001 it
->dpend
= v
->contents
+ v
->header
.size
;
4005 /* Default `...'. */
4006 it
->dpvec
= default_invis_vector
;
4007 it
->dpend
= default_invis_vector
+ 3;
4010 it
->dpvec_char_len
= len
;
4011 it
->current
.dpvec_index
= 0;
4012 it
->dpvec_face_id
= -1;
4014 /* Remember the current face id in case glyphs specify faces.
4015 IT's face is restored in set_iterator_to_next.
4016 saved_face_id was set to preceding char's face in handle_stop. */
4017 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4018 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4020 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4026 /***********************************************************************
4028 ***********************************************************************/
4030 /* Set up iterator IT from `display' property at its current position.
4031 Called from handle_stop.
4032 We return HANDLED_RETURN if some part of the display property
4033 overrides the display of the buffer text itself.
4034 Otherwise we return HANDLED_NORMALLY. */
4036 static enum prop_handled
4037 handle_display_prop (struct it
*it
)
4039 Lisp_Object propval
, object
, overlay
;
4040 struct text_pos
*position
;
4042 /* Nonzero if some property replaces the display of the text itself. */
4043 int display_replaced_p
= 0;
4045 if (STRINGP (it
->string
))
4047 object
= it
->string
;
4048 position
= &it
->current
.string_pos
;
4049 bufpos
= CHARPOS (it
->current
.pos
);
4053 XSETWINDOW (object
, it
->w
);
4054 position
= &it
->current
.pos
;
4055 bufpos
= CHARPOS (*position
);
4058 /* Reset those iterator values set from display property values. */
4059 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4060 it
->space_width
= Qnil
;
4061 it
->font_height
= Qnil
;
4064 /* We don't support recursive `display' properties, i.e. string
4065 values that have a string `display' property, that have a string
4066 `display' property etc. */
4067 if (!it
->string_from_display_prop_p
)
4068 it
->area
= TEXT_AREA
;
4070 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4071 Qdisplay
, object
, &overlay
);
4073 return HANDLED_NORMALLY
;
4074 /* Now OVERLAY is the overlay that gave us this property, or nil
4075 if it was a text property. */
4077 if (!STRINGP (it
->string
))
4078 object
= it
->w
->buffer
;
4080 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4082 FRAME_WINDOW_P (it
->f
));
4084 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4087 /* Subroutine of handle_display_prop. Returns non-zero if the display
4088 specification in SPEC is a replacing specification, i.e. it would
4089 replace the text covered by `display' property with something else,
4090 such as an image or a display string. If SPEC includes any kind or
4091 `(space ...) specification, the value is 2; this is used by
4092 compute_display_string_pos, which see.
4094 See handle_single_display_spec for documentation of arguments.
4095 frame_window_p is non-zero if the window being redisplayed is on a
4096 GUI frame; this argument is used only if IT is NULL, see below.
4098 IT can be NULL, if this is called by the bidi reordering code
4099 through compute_display_string_pos, which see. In that case, this
4100 function only examines SPEC, but does not otherwise "handle" it, in
4101 the sense that it doesn't set up members of IT from the display
4104 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4105 Lisp_Object overlay
, struct text_pos
*position
,
4106 ptrdiff_t bufpos
, int frame_window_p
)
4108 int replacing_p
= 0;
4112 /* Simple specerties. */
4113 && !EQ (XCAR (spec
), Qimage
)
4114 && !EQ (XCAR (spec
), Qspace
)
4115 && !EQ (XCAR (spec
), Qwhen
)
4116 && !EQ (XCAR (spec
), Qslice
)
4117 && !EQ (XCAR (spec
), Qspace_width
)
4118 && !EQ (XCAR (spec
), Qheight
)
4119 && !EQ (XCAR (spec
), Qraise
)
4120 /* Marginal area specifications. */
4121 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4122 && !EQ (XCAR (spec
), Qleft_fringe
)
4123 && !EQ (XCAR (spec
), Qright_fringe
)
4124 && !NILP (XCAR (spec
)))
4126 for (; CONSP (spec
); spec
= XCDR (spec
))
4128 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4129 overlay
, position
, bufpos
,
4130 replacing_p
, frame_window_p
)))
4133 /* If some text in a string is replaced, `position' no
4134 longer points to the position of `object'. */
4135 if (!it
|| STRINGP (object
))
4140 else if (VECTORP (spec
))
4143 for (i
= 0; i
< ASIZE (spec
); ++i
)
4144 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4145 overlay
, position
, bufpos
,
4146 replacing_p
, frame_window_p
)))
4149 /* If some text in a string is replaced, `position' no
4150 longer points to the position of `object'. */
4151 if (!it
|| STRINGP (object
))
4157 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4158 position
, bufpos
, 0,
4166 /* Value is the position of the end of the `display' property starting
4167 at START_POS in OBJECT. */
4169 static struct text_pos
4170 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4173 struct text_pos end_pos
;
4175 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4176 Qdisplay
, object
, Qnil
);
4177 CHARPOS (end_pos
) = XFASTINT (end
);
4178 if (STRINGP (object
))
4179 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4181 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4187 /* Set up IT from a single `display' property specification SPEC. OBJECT
4188 is the object in which the `display' property was found. *POSITION
4189 is the position in OBJECT at which the `display' property was found.
4190 BUFPOS is the buffer position of OBJECT (different from POSITION if
4191 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4192 previously saw a display specification which already replaced text
4193 display with something else, for example an image; we ignore such
4194 properties after the first one has been processed.
4196 OVERLAY is the overlay this `display' property came from,
4197 or nil if it was a text property.
4199 If SPEC is a `space' or `image' specification, and in some other
4200 cases too, set *POSITION to the position where the `display'
4203 If IT is NULL, only examine the property specification in SPEC, but
4204 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4205 is intended to be displayed in a window on a GUI frame.
4207 Value is non-zero if something was found which replaces the display
4208 of buffer or string text. */
4211 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4212 Lisp_Object overlay
, struct text_pos
*position
,
4213 ptrdiff_t bufpos
, int display_replaced_p
,
4217 Lisp_Object location
, value
;
4218 struct text_pos start_pos
= *position
;
4221 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4222 If the result is non-nil, use VALUE instead of SPEC. */
4224 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4233 if (!NILP (form
) && !EQ (form
, Qt
))
4235 ptrdiff_t count
= SPECPDL_INDEX ();
4236 struct gcpro gcpro1
;
4238 /* Bind `object' to the object having the `display' property, a
4239 buffer or string. Bind `position' to the position in the
4240 object where the property was found, and `buffer-position'
4241 to the current position in the buffer. */
4244 XSETBUFFER (object
, current_buffer
);
4245 specbind (Qobject
, object
);
4246 specbind (Qposition
, make_number (CHARPOS (*position
)));
4247 specbind (Qbuffer_position
, make_number (bufpos
));
4249 form
= safe_eval (form
);
4251 unbind_to (count
, Qnil
);
4257 /* Handle `(height HEIGHT)' specifications. */
4259 && EQ (XCAR (spec
), Qheight
)
4260 && CONSP (XCDR (spec
)))
4264 if (!FRAME_WINDOW_P (it
->f
))
4267 it
->font_height
= XCAR (XCDR (spec
));
4268 if (!NILP (it
->font_height
))
4270 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4271 int new_height
= -1;
4273 if (CONSP (it
->font_height
)
4274 && (EQ (XCAR (it
->font_height
), Qplus
)
4275 || EQ (XCAR (it
->font_height
), Qminus
))
4276 && CONSP (XCDR (it
->font_height
))
4277 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4279 /* `(+ N)' or `(- N)' where N is an integer. */
4280 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4281 if (EQ (XCAR (it
->font_height
), Qplus
))
4283 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4285 else if (FUNCTIONP (it
->font_height
))
4287 /* Call function with current height as argument.
4288 Value is the new height. */
4290 height
= safe_call1 (it
->font_height
,
4291 face
->lface
[LFACE_HEIGHT_INDEX
]);
4292 if (NUMBERP (height
))
4293 new_height
= XFLOATINT (height
);
4295 else if (NUMBERP (it
->font_height
))
4297 /* Value is a multiple of the canonical char height. */
4300 f
= FACE_FROM_ID (it
->f
,
4301 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4302 new_height
= (XFLOATINT (it
->font_height
)
4303 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4307 /* Evaluate IT->font_height with `height' bound to the
4308 current specified height to get the new height. */
4309 ptrdiff_t count
= SPECPDL_INDEX ();
4311 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4312 value
= safe_eval (it
->font_height
);
4313 unbind_to (count
, Qnil
);
4315 if (NUMBERP (value
))
4316 new_height
= XFLOATINT (value
);
4320 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4327 /* Handle `(space-width WIDTH)'. */
4329 && EQ (XCAR (spec
), Qspace_width
)
4330 && CONSP (XCDR (spec
)))
4334 if (!FRAME_WINDOW_P (it
->f
))
4337 value
= XCAR (XCDR (spec
));
4338 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4339 it
->space_width
= value
;
4345 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4347 && EQ (XCAR (spec
), Qslice
))
4353 if (!FRAME_WINDOW_P (it
->f
))
4356 if (tem
= XCDR (spec
), CONSP (tem
))
4358 it
->slice
.x
= XCAR (tem
);
4359 if (tem
= XCDR (tem
), CONSP (tem
))
4361 it
->slice
.y
= XCAR (tem
);
4362 if (tem
= XCDR (tem
), CONSP (tem
))
4364 it
->slice
.width
= XCAR (tem
);
4365 if (tem
= XCDR (tem
), CONSP (tem
))
4366 it
->slice
.height
= XCAR (tem
);
4375 /* Handle `(raise FACTOR)'. */
4377 && EQ (XCAR (spec
), Qraise
)
4378 && CONSP (XCDR (spec
)))
4382 if (!FRAME_WINDOW_P (it
->f
))
4385 #ifdef HAVE_WINDOW_SYSTEM
4386 value
= XCAR (XCDR (spec
));
4387 if (NUMBERP (value
))
4389 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4390 it
->voffset
= - (XFLOATINT (value
)
4391 * (FONT_HEIGHT (face
->font
)));
4393 #endif /* HAVE_WINDOW_SYSTEM */
4399 /* Don't handle the other kinds of display specifications
4400 inside a string that we got from a `display' property. */
4401 if (it
&& it
->string_from_display_prop_p
)
4404 /* Characters having this form of property are not displayed, so
4405 we have to find the end of the property. */
4408 start_pos
= *position
;
4409 *position
= display_prop_end (it
, object
, start_pos
);
4413 /* Stop the scan at that end position--we assume that all
4414 text properties change there. */
4416 it
->stop_charpos
= position
->charpos
;
4418 /* Handle `(left-fringe BITMAP [FACE])'
4419 and `(right-fringe BITMAP [FACE])'. */
4421 && (EQ (XCAR (spec
), Qleft_fringe
)
4422 || EQ (XCAR (spec
), Qright_fringe
))
4423 && CONSP (XCDR (spec
)))
4429 if (!FRAME_WINDOW_P (it
->f
))
4430 /* If we return here, POSITION has been advanced
4431 across the text with this property. */
4434 else if (!frame_window_p
)
4437 #ifdef HAVE_WINDOW_SYSTEM
4438 value
= XCAR (XCDR (spec
));
4439 if (!SYMBOLP (value
)
4440 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4441 /* If we return here, POSITION has been advanced
4442 across the text with this property. */
4447 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4449 if (CONSP (XCDR (XCDR (spec
))))
4451 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4452 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4458 /* Save current settings of IT so that we can restore them
4459 when we are finished with the glyph property value. */
4460 push_it (it
, position
);
4462 it
->area
= TEXT_AREA
;
4463 it
->what
= IT_IMAGE
;
4464 it
->image_id
= -1; /* no image */
4465 it
->position
= start_pos
;
4466 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4467 it
->method
= GET_FROM_IMAGE
;
4468 it
->from_overlay
= Qnil
;
4469 it
->face_id
= face_id
;
4470 it
->from_disp_prop_p
= 1;
4472 /* Say that we haven't consumed the characters with
4473 `display' property yet. The call to pop_it in
4474 set_iterator_to_next will clean this up. */
4475 *position
= start_pos
;
4477 if (EQ (XCAR (spec
), Qleft_fringe
))
4479 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4480 it
->left_user_fringe_face_id
= face_id
;
4484 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4485 it
->right_user_fringe_face_id
= face_id
;
4488 #endif /* HAVE_WINDOW_SYSTEM */
4492 /* Prepare to handle `((margin left-margin) ...)',
4493 `((margin right-margin) ...)' and `((margin nil) ...)'
4494 prefixes for display specifications. */
4495 location
= Qunbound
;
4496 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4500 value
= XCDR (spec
);
4502 value
= XCAR (value
);
4505 if (EQ (XCAR (tem
), Qmargin
)
4506 && (tem
= XCDR (tem
),
4507 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4509 || EQ (tem
, Qleft_margin
)
4510 || EQ (tem
, Qright_margin
))))
4514 if (EQ (location
, Qunbound
))
4520 /* After this point, VALUE is the property after any
4521 margin prefix has been stripped. It must be a string,
4522 an image specification, or `(space ...)'.
4524 LOCATION specifies where to display: `left-margin',
4525 `right-margin' or nil. */
4527 valid_p
= (STRINGP (value
)
4528 #ifdef HAVE_WINDOW_SYSTEM
4529 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4530 && valid_image_p (value
))
4531 #endif /* not HAVE_WINDOW_SYSTEM */
4532 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4534 if (valid_p
&& !display_replaced_p
)
4540 /* Callers need to know whether the display spec is any kind
4541 of `(space ...)' spec that is about to affect text-area
4543 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4548 /* Save current settings of IT so that we can restore them
4549 when we are finished with the glyph property value. */
4550 push_it (it
, position
);
4551 it
->from_overlay
= overlay
;
4552 it
->from_disp_prop_p
= 1;
4554 if (NILP (location
))
4555 it
->area
= TEXT_AREA
;
4556 else if (EQ (location
, Qleft_margin
))
4557 it
->area
= LEFT_MARGIN_AREA
;
4559 it
->area
= RIGHT_MARGIN_AREA
;
4561 if (STRINGP (value
))
4564 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4565 it
->current
.overlay_string_index
= -1;
4566 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4567 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4568 it
->method
= GET_FROM_STRING
;
4569 it
->stop_charpos
= 0;
4571 it
->base_level_stop
= 0;
4572 it
->string_from_display_prop_p
= 1;
4573 /* Say that we haven't consumed the characters with
4574 `display' property yet. The call to pop_it in
4575 set_iterator_to_next will clean this up. */
4576 if (BUFFERP (object
))
4577 *position
= start_pos
;
4579 /* Force paragraph direction to be that of the parent
4580 object. If the parent object's paragraph direction is
4581 not yet determined, default to L2R. */
4582 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4583 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4585 it
->paragraph_embedding
= L2R
;
4587 /* Set up the bidi iterator for this display string. */
4590 it
->bidi_it
.string
.lstring
= it
->string
;
4591 it
->bidi_it
.string
.s
= NULL
;
4592 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4593 it
->bidi_it
.string
.bufpos
= bufpos
;
4594 it
->bidi_it
.string
.from_disp_str
= 1;
4595 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4596 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4599 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4601 it
->method
= GET_FROM_STRETCH
;
4603 *position
= it
->position
= start_pos
;
4604 retval
= 1 + (it
->area
== TEXT_AREA
);
4606 #ifdef HAVE_WINDOW_SYSTEM
4609 it
->what
= IT_IMAGE
;
4610 it
->image_id
= lookup_image (it
->f
, value
);
4611 it
->position
= start_pos
;
4612 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4613 it
->method
= GET_FROM_IMAGE
;
4615 /* Say that we haven't consumed the characters with
4616 `display' property yet. The call to pop_it in
4617 set_iterator_to_next will clean this up. */
4618 *position
= start_pos
;
4620 #endif /* HAVE_WINDOW_SYSTEM */
4625 /* Invalid property or property not supported. Restore
4626 POSITION to what it was before. */
4627 *position
= start_pos
;
4631 /* Check if PROP is a display property value whose text should be
4632 treated as intangible. OVERLAY is the overlay from which PROP
4633 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4634 specify the buffer position covered by PROP. */
4637 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4638 ptrdiff_t charpos
, ptrdiff_t bytepos
)
4640 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4641 struct text_pos position
;
4643 SET_TEXT_POS (position
, charpos
, bytepos
);
4644 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4645 &position
, charpos
, frame_window_p
);
4649 /* Return 1 if PROP is a display sub-property value containing STRING.
4651 Implementation note: this and the following function are really
4652 special cases of handle_display_spec and
4653 handle_single_display_spec, and should ideally use the same code.
4654 Until they do, these two pairs must be consistent and must be
4655 modified in sync. */
4658 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4660 if (EQ (string
, prop
))
4663 /* Skip over `when FORM'. */
4664 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4669 /* Actually, the condition following `when' should be eval'ed,
4670 like handle_single_display_spec does, and we should return
4671 zero if it evaluates to nil. However, this function is
4672 called only when the buffer was already displayed and some
4673 glyph in the glyph matrix was found to come from a display
4674 string. Therefore, the condition was already evaluated, and
4675 the result was non-nil, otherwise the display string wouldn't
4676 have been displayed and we would have never been called for
4677 this property. Thus, we can skip the evaluation and assume
4678 its result is non-nil. */
4683 /* Skip over `margin LOCATION'. */
4684 if (EQ (XCAR (prop
), Qmargin
))
4695 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4699 /* Return 1 if STRING appears in the `display' property PROP. */
4702 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4705 && !EQ (XCAR (prop
), Qwhen
)
4706 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4708 /* A list of sub-properties. */
4709 while (CONSP (prop
))
4711 if (single_display_spec_string_p (XCAR (prop
), string
))
4716 else if (VECTORP (prop
))
4718 /* A vector of sub-properties. */
4720 for (i
= 0; i
< ASIZE (prop
); ++i
)
4721 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4725 return single_display_spec_string_p (prop
, string
);
4730 /* Look for STRING in overlays and text properties in the current
4731 buffer, between character positions FROM and TO (excluding TO).
4732 BACK_P non-zero means look back (in this case, TO is supposed to be
4734 Value is the first character position where STRING was found, or
4735 zero if it wasn't found before hitting TO.
4737 This function may only use code that doesn't eval because it is
4738 called asynchronously from note_mouse_highlight. */
4741 string_buffer_position_lim (Lisp_Object string
,
4742 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
4744 Lisp_Object limit
, prop
, pos
;
4747 pos
= make_number (from
);
4749 if (!back_p
) /* looking forward */
4751 limit
= make_number (min (to
, ZV
));
4752 while (!found
&& !EQ (pos
, limit
))
4754 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4755 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4758 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4762 else /* looking back */
4764 limit
= make_number (max (to
, BEGV
));
4765 while (!found
&& !EQ (pos
, limit
))
4767 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4768 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4771 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4776 return found
? XINT (pos
) : 0;
4779 /* Determine which buffer position in current buffer STRING comes from.
4780 AROUND_CHARPOS is an approximate position where it could come from.
4781 Value is the buffer position or 0 if it couldn't be determined.
4783 This function is necessary because we don't record buffer positions
4784 in glyphs generated from strings (to keep struct glyph small).
4785 This function may only use code that doesn't eval because it is
4786 called asynchronously from note_mouse_highlight. */
4789 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
4791 const int MAX_DISTANCE
= 1000;
4792 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
4793 around_charpos
+ MAX_DISTANCE
,
4797 found
= string_buffer_position_lim (string
, around_charpos
,
4798 around_charpos
- MAX_DISTANCE
, 1);
4804 /***********************************************************************
4805 `composition' property
4806 ***********************************************************************/
4808 /* Set up iterator IT from `composition' property at its current
4809 position. Called from handle_stop. */
4811 static enum prop_handled
4812 handle_composition_prop (struct it
*it
)
4814 Lisp_Object prop
, string
;
4815 ptrdiff_t pos
, pos_byte
, start
, end
;
4817 if (STRINGP (it
->string
))
4821 pos
= IT_STRING_CHARPOS (*it
);
4822 pos_byte
= IT_STRING_BYTEPOS (*it
);
4823 string
= it
->string
;
4824 s
= SDATA (string
) + pos_byte
;
4825 it
->c
= STRING_CHAR (s
);
4829 pos
= IT_CHARPOS (*it
);
4830 pos_byte
= IT_BYTEPOS (*it
);
4832 it
->c
= FETCH_CHAR (pos_byte
);
4835 /* If there's a valid composition and point is not inside of the
4836 composition (in the case that the composition is from the current
4837 buffer), draw a glyph composed from the composition components. */
4838 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4839 && COMPOSITION_VALID_P (start
, end
, prop
)
4840 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4843 /* As we can't handle this situation (perhaps font-lock added
4844 a new composition), we just return here hoping that next
4845 redisplay will detect this composition much earlier. */
4846 return HANDLED_NORMALLY
;
4849 if (STRINGP (it
->string
))
4850 pos_byte
= string_char_to_byte (it
->string
, start
);
4852 pos_byte
= CHAR_TO_BYTE (start
);
4854 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4857 if (it
->cmp_it
.id
>= 0)
4860 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4861 it
->cmp_it
.nglyphs
= -1;
4865 return HANDLED_NORMALLY
;
4870 /***********************************************************************
4872 ***********************************************************************/
4874 /* The following structure is used to record overlay strings for
4875 later sorting in load_overlay_strings. */
4877 struct overlay_entry
4879 Lisp_Object overlay
;
4886 /* Set up iterator IT from overlay strings at its current position.
4887 Called from handle_stop. */
4889 static enum prop_handled
4890 handle_overlay_change (struct it
*it
)
4892 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4893 return HANDLED_RECOMPUTE_PROPS
;
4895 return HANDLED_NORMALLY
;
4899 /* Set up the next overlay string for delivery by IT, if there is an
4900 overlay string to deliver. Called by set_iterator_to_next when the
4901 end of the current overlay string is reached. If there are more
4902 overlay strings to display, IT->string and
4903 IT->current.overlay_string_index are set appropriately here.
4904 Otherwise IT->string is set to nil. */
4907 next_overlay_string (struct it
*it
)
4909 ++it
->current
.overlay_string_index
;
4910 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4912 /* No more overlay strings. Restore IT's settings to what
4913 they were before overlay strings were processed, and
4914 continue to deliver from current_buffer. */
4916 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4919 || (NILP (it
->string
)
4920 && it
->method
== GET_FROM_BUFFER
4921 && it
->stop_charpos
>= BEGV
4922 && it
->stop_charpos
<= it
->end_charpos
));
4923 it
->current
.overlay_string_index
= -1;
4924 it
->n_overlay_strings
= 0;
4925 it
->overlay_strings_charpos
= -1;
4927 /* If we're at the end of the buffer, record that we have
4928 processed the overlay strings there already, so that
4929 next_element_from_buffer doesn't try it again. */
4930 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4931 it
->overlay_strings_at_end_processed_p
= 1;
4935 /* There are more overlay strings to process. If
4936 IT->current.overlay_string_index has advanced to a position
4937 where we must load IT->overlay_strings with more strings, do
4938 it. We must load at the IT->overlay_strings_charpos where
4939 IT->n_overlay_strings was originally computed; when invisible
4940 text is present, this might not be IT_CHARPOS (Bug#7016). */
4941 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4943 if (it
->current
.overlay_string_index
&& i
== 0)
4944 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4946 /* Initialize IT to deliver display elements from the overlay
4948 it
->string
= it
->overlay_strings
[i
];
4949 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4950 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4951 it
->method
= GET_FROM_STRING
;
4952 it
->stop_charpos
= 0;
4953 if (it
->cmp_it
.stop_pos
>= 0)
4954 it
->cmp_it
.stop_pos
= 0;
4956 it
->base_level_stop
= 0;
4958 /* Set up the bidi iterator for this overlay string. */
4961 it
->bidi_it
.string
.lstring
= it
->string
;
4962 it
->bidi_it
.string
.s
= NULL
;
4963 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4964 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4965 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4966 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4967 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4975 /* Compare two overlay_entry structures E1 and E2. Used as a
4976 comparison function for qsort in load_overlay_strings. Overlay
4977 strings for the same position are sorted so that
4979 1. All after-strings come in front of before-strings, except
4980 when they come from the same overlay.
4982 2. Within after-strings, strings are sorted so that overlay strings
4983 from overlays with higher priorities come first.
4985 2. Within before-strings, strings are sorted so that overlay
4986 strings from overlays with higher priorities come last.
4988 Value is analogous to strcmp. */
4992 compare_overlay_entries (const void *e1
, const void *e2
)
4994 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4995 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4998 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5000 /* Let after-strings appear in front of before-strings if
5001 they come from different overlays. */
5002 if (EQ (entry1
->overlay
, entry2
->overlay
))
5003 result
= entry1
->after_string_p
? 1 : -1;
5005 result
= entry1
->after_string_p
? -1 : 1;
5007 else if (entry1
->priority
!= entry2
->priority
)
5009 if (entry1
->after_string_p
)
5010 /* After-strings sorted in order of decreasing priority. */
5011 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5013 /* Before-strings sorted in order of increasing priority. */
5014 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5023 /* Load the vector IT->overlay_strings with overlay strings from IT's
5024 current buffer position, or from CHARPOS if that is > 0. Set
5025 IT->n_overlays to the total number of overlay strings found.
5027 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5028 a time. On entry into load_overlay_strings,
5029 IT->current.overlay_string_index gives the number of overlay
5030 strings that have already been loaded by previous calls to this
5033 IT->add_overlay_start contains an additional overlay start
5034 position to consider for taking overlay strings from, if non-zero.
5035 This position comes into play when the overlay has an `invisible'
5036 property, and both before and after-strings. When we've skipped to
5037 the end of the overlay, because of its `invisible' property, we
5038 nevertheless want its before-string to appear.
5039 IT->add_overlay_start will contain the overlay start position
5042 Overlay strings are sorted so that after-string strings come in
5043 front of before-string strings. Within before and after-strings,
5044 strings are sorted by overlay priority. See also function
5045 compare_overlay_entries. */
5048 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5050 Lisp_Object overlay
, window
, str
, invisible
;
5051 struct Lisp_Overlay
*ov
;
5052 ptrdiff_t start
, end
;
5053 ptrdiff_t size
= 20;
5054 ptrdiff_t n
= 0, i
, j
;
5056 struct overlay_entry
*entries
5057 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5061 charpos
= IT_CHARPOS (*it
);
5063 /* Append the overlay string STRING of overlay OVERLAY to vector
5064 `entries' which has size `size' and currently contains `n'
5065 elements. AFTER_P non-zero means STRING is an after-string of
5067 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5070 Lisp_Object priority; \
5074 struct overlay_entry *old = entries; \
5075 SAFE_NALLOCA (entries, 2, size); \
5076 memcpy (entries, old, size * sizeof *entries); \
5080 entries[n].string = (STRING); \
5081 entries[n].overlay = (OVERLAY); \
5082 priority = Foverlay_get ((OVERLAY), Qpriority); \
5083 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5084 entries[n].after_string_p = (AFTER_P); \
5089 /* Process overlay before the overlay center. */
5090 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5092 XSETMISC (overlay
, ov
);
5093 xassert (OVERLAYP (overlay
));
5094 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5095 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5100 /* Skip this overlay if it doesn't start or end at IT's current
5102 if (end
!= charpos
&& start
!= charpos
)
5105 /* Skip this overlay if it doesn't apply to IT->w. */
5106 window
= Foverlay_get (overlay
, Qwindow
);
5107 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5110 /* If the text ``under'' the overlay is invisible, both before-
5111 and after-strings from this overlay are visible; start and
5112 end position are indistinguishable. */
5113 invisible
= Foverlay_get (overlay
, Qinvisible
);
5114 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5116 /* If overlay has a non-empty before-string, record it. */
5117 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5118 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5120 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5122 /* If overlay has a non-empty after-string, record it. */
5123 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5124 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5126 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5129 /* Process overlays after the overlay center. */
5130 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5132 XSETMISC (overlay
, ov
);
5133 xassert (OVERLAYP (overlay
));
5134 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5135 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5137 if (start
> charpos
)
5140 /* Skip this overlay if it doesn't start or end at IT's current
5142 if (end
!= charpos
&& start
!= charpos
)
5145 /* Skip this overlay if it doesn't apply to IT->w. */
5146 window
= Foverlay_get (overlay
, Qwindow
);
5147 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5150 /* If the text ``under'' the overlay is invisible, it has a zero
5151 dimension, and both before- and after-strings apply. */
5152 invisible
= Foverlay_get (overlay
, Qinvisible
);
5153 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5155 /* If overlay has a non-empty before-string, record it. */
5156 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5157 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5159 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5161 /* If overlay has a non-empty after-string, record it. */
5162 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5163 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5165 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5168 #undef RECORD_OVERLAY_STRING
5172 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5174 /* Record number of overlay strings, and where we computed it. */
5175 it
->n_overlay_strings
= n
;
5176 it
->overlay_strings_charpos
= charpos
;
5178 /* IT->current.overlay_string_index is the number of overlay strings
5179 that have already been consumed by IT. Copy some of the
5180 remaining overlay strings to IT->overlay_strings. */
5182 j
= it
->current
.overlay_string_index
;
5183 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5185 it
->overlay_strings
[i
] = entries
[j
].string
;
5186 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5194 /* Get the first chunk of overlay strings at IT's current buffer
5195 position, or at CHARPOS if that is > 0. Value is non-zero if at
5196 least one overlay string was found. */
5199 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5201 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5202 process. This fills IT->overlay_strings with strings, and sets
5203 IT->n_overlay_strings to the total number of strings to process.
5204 IT->pos.overlay_string_index has to be set temporarily to zero
5205 because load_overlay_strings needs this; it must be set to -1
5206 when no overlay strings are found because a zero value would
5207 indicate a position in the first overlay string. */
5208 it
->current
.overlay_string_index
= 0;
5209 load_overlay_strings (it
, charpos
);
5211 /* If we found overlay strings, set up IT to deliver display
5212 elements from the first one. Otherwise set up IT to deliver
5213 from current_buffer. */
5214 if (it
->n_overlay_strings
)
5216 /* Make sure we know settings in current_buffer, so that we can
5217 restore meaningful values when we're done with the overlay
5220 compute_stop_pos (it
);
5221 xassert (it
->face_id
>= 0);
5223 /* Save IT's settings. They are restored after all overlay
5224 strings have been processed. */
5225 xassert (!compute_stop_p
|| it
->sp
== 0);
5227 /* When called from handle_stop, there might be an empty display
5228 string loaded. In that case, don't bother saving it. */
5229 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5232 /* Set up IT to deliver display elements from the first overlay
5234 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5235 it
->string
= it
->overlay_strings
[0];
5236 it
->from_overlay
= Qnil
;
5237 it
->stop_charpos
= 0;
5238 xassert (STRINGP (it
->string
));
5239 it
->end_charpos
= SCHARS (it
->string
);
5241 it
->base_level_stop
= 0;
5242 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5243 it
->method
= GET_FROM_STRING
;
5244 it
->from_disp_prop_p
= 0;
5246 /* Force paragraph direction to be that of the parent
5248 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5249 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5251 it
->paragraph_embedding
= L2R
;
5253 /* Set up the bidi iterator for this overlay string. */
5256 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5258 it
->bidi_it
.string
.lstring
= it
->string
;
5259 it
->bidi_it
.string
.s
= NULL
;
5260 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5261 it
->bidi_it
.string
.bufpos
= pos
;
5262 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5263 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5264 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5269 it
->current
.overlay_string_index
= -1;
5274 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5277 it
->method
= GET_FROM_BUFFER
;
5279 (void) get_overlay_strings_1 (it
, charpos
, 1);
5283 /* Value is non-zero if we found at least one overlay string. */
5284 return STRINGP (it
->string
);
5289 /***********************************************************************
5290 Saving and restoring state
5291 ***********************************************************************/
5293 /* Save current settings of IT on IT->stack. Called, for example,
5294 before setting up IT for an overlay string, to be able to restore
5295 IT's settings to what they were after the overlay string has been
5296 processed. If POSITION is non-NULL, it is the position to save on
5297 the stack instead of IT->position. */
5300 push_it (struct it
*it
, struct text_pos
*position
)
5302 struct iterator_stack_entry
*p
;
5304 xassert (it
->sp
< IT_STACK_SIZE
);
5305 p
= it
->stack
+ it
->sp
;
5307 p
->stop_charpos
= it
->stop_charpos
;
5308 p
->prev_stop
= it
->prev_stop
;
5309 p
->base_level_stop
= it
->base_level_stop
;
5310 p
->cmp_it
= it
->cmp_it
;
5311 xassert (it
->face_id
>= 0);
5312 p
->face_id
= it
->face_id
;
5313 p
->string
= it
->string
;
5314 p
->method
= it
->method
;
5315 p
->from_overlay
= it
->from_overlay
;
5318 case GET_FROM_IMAGE
:
5319 p
->u
.image
.object
= it
->object
;
5320 p
->u
.image
.image_id
= it
->image_id
;
5321 p
->u
.image
.slice
= it
->slice
;
5323 case GET_FROM_STRETCH
:
5324 p
->u
.stretch
.object
= it
->object
;
5327 p
->position
= position
? *position
: it
->position
;
5328 p
->current
= it
->current
;
5329 p
->end_charpos
= it
->end_charpos
;
5330 p
->string_nchars
= it
->string_nchars
;
5332 p
->multibyte_p
= it
->multibyte_p
;
5333 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5334 p
->space_width
= it
->space_width
;
5335 p
->font_height
= it
->font_height
;
5336 p
->voffset
= it
->voffset
;
5337 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5338 p
->display_ellipsis_p
= 0;
5339 p
->line_wrap
= it
->line_wrap
;
5340 p
->bidi_p
= it
->bidi_p
;
5341 p
->paragraph_embedding
= it
->paragraph_embedding
;
5342 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5345 /* Save the state of the bidi iterator as well. */
5347 bidi_push_it (&it
->bidi_it
);
5351 iterate_out_of_display_property (struct it
*it
)
5353 int buffer_p
= BUFFERP (it
->object
);
5354 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5355 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5357 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5359 /* Maybe initialize paragraph direction. If we are at the beginning
5360 of a new paragraph, next_element_from_buffer may not have a
5361 chance to do that. */
5362 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5363 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5364 /* prev_stop can be zero, so check against BEGV as well. */
5365 while (it
->bidi_it
.charpos
>= bob
5366 && it
->prev_stop
<= it
->bidi_it
.charpos
5367 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5368 && it
->bidi_it
.charpos
< eob
)
5369 bidi_move_to_visually_next (&it
->bidi_it
);
5370 /* Record the stop_pos we just crossed, for when we cross it
5372 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5373 it
->prev_stop
= CHARPOS (it
->position
);
5374 /* If we ended up not where pop_it put us, resync IT's
5375 positional members with the bidi iterator. */
5376 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5377 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5379 it
->current
.pos
= it
->position
;
5381 it
->current
.string_pos
= it
->position
;
5384 /* Restore IT's settings from IT->stack. Called, for example, when no
5385 more overlay strings must be processed, and we return to delivering
5386 display elements from a buffer, or when the end of a string from a
5387 `display' property is reached and we return to delivering display
5388 elements from an overlay string, or from a buffer. */
5391 pop_it (struct it
*it
)
5393 struct iterator_stack_entry
*p
;
5394 int from_display_prop
= it
->from_disp_prop_p
;
5396 xassert (it
->sp
> 0);
5398 p
= it
->stack
+ it
->sp
;
5399 it
->stop_charpos
= p
->stop_charpos
;
5400 it
->prev_stop
= p
->prev_stop
;
5401 it
->base_level_stop
= p
->base_level_stop
;
5402 it
->cmp_it
= p
->cmp_it
;
5403 it
->face_id
= p
->face_id
;
5404 it
->current
= p
->current
;
5405 it
->position
= p
->position
;
5406 it
->string
= p
->string
;
5407 it
->from_overlay
= p
->from_overlay
;
5408 if (NILP (it
->string
))
5409 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5410 it
->method
= p
->method
;
5413 case GET_FROM_IMAGE
:
5414 it
->image_id
= p
->u
.image
.image_id
;
5415 it
->object
= p
->u
.image
.object
;
5416 it
->slice
= p
->u
.image
.slice
;
5418 case GET_FROM_STRETCH
:
5419 it
->object
= p
->u
.stretch
.object
;
5421 case GET_FROM_BUFFER
:
5422 it
->object
= it
->w
->buffer
;
5424 case GET_FROM_STRING
:
5425 it
->object
= it
->string
;
5427 case GET_FROM_DISPLAY_VECTOR
:
5429 it
->method
= GET_FROM_C_STRING
;
5430 else if (STRINGP (it
->string
))
5431 it
->method
= GET_FROM_STRING
;
5434 it
->method
= GET_FROM_BUFFER
;
5435 it
->object
= it
->w
->buffer
;
5438 it
->end_charpos
= p
->end_charpos
;
5439 it
->string_nchars
= p
->string_nchars
;
5441 it
->multibyte_p
= p
->multibyte_p
;
5442 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5443 it
->space_width
= p
->space_width
;
5444 it
->font_height
= p
->font_height
;
5445 it
->voffset
= p
->voffset
;
5446 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5447 it
->line_wrap
= p
->line_wrap
;
5448 it
->bidi_p
= p
->bidi_p
;
5449 it
->paragraph_embedding
= p
->paragraph_embedding
;
5450 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5453 bidi_pop_it (&it
->bidi_it
);
5454 /* Bidi-iterate until we get out of the portion of text, if any,
5455 covered by a `display' text property or by an overlay with
5456 `display' property. (We cannot just jump there, because the
5457 internal coherency of the bidi iterator state can not be
5458 preserved across such jumps.) We also must determine the
5459 paragraph base direction if the overlay we just processed is
5460 at the beginning of a new paragraph. */
5461 if (from_display_prop
5462 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5463 iterate_out_of_display_property (it
);
5465 xassert ((BUFFERP (it
->object
)
5466 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5467 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5468 || (STRINGP (it
->object
)
5469 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5470 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5476 /***********************************************************************
5478 ***********************************************************************/
5480 /* Set IT's current position to the previous line start. */
5483 back_to_previous_line_start (struct it
*it
)
5485 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5486 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5490 /* Move IT to the next line start.
5492 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5493 we skipped over part of the text (as opposed to moving the iterator
5494 continuously over the text). Otherwise, don't change the value
5497 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5498 iterator on the newline, if it was found.
5500 Newlines may come from buffer text, overlay strings, or strings
5501 displayed via the `display' property. That's the reason we can't
5502 simply use find_next_newline_no_quit.
5504 Note that this function may not skip over invisible text that is so
5505 because of text properties and immediately follows a newline. If
5506 it would, function reseat_at_next_visible_line_start, when called
5507 from set_iterator_to_next, would effectively make invisible
5508 characters following a newline part of the wrong glyph row, which
5509 leads to wrong cursor motion. */
5512 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5513 struct bidi_it
*bidi_it_prev
)
5515 ptrdiff_t old_selective
;
5516 int newline_found_p
, n
;
5517 const int MAX_NEWLINE_DISTANCE
= 500;
5519 /* If already on a newline, just consume it to avoid unintended
5520 skipping over invisible text below. */
5521 if (it
->what
== IT_CHARACTER
5523 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5525 if (it
->bidi_p
&& bidi_it_prev
)
5526 *bidi_it_prev
= it
->bidi_it
;
5527 set_iterator_to_next (it
, 0);
5532 /* Don't handle selective display in the following. It's (a)
5533 unnecessary because it's done by the caller, and (b) leads to an
5534 infinite recursion because next_element_from_ellipsis indirectly
5535 calls this function. */
5536 old_selective
= it
->selective
;
5539 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5540 from buffer text. */
5541 for (n
= newline_found_p
= 0;
5542 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5543 n
+= STRINGP (it
->string
) ? 0 : 1)
5545 if (!get_next_display_element (it
))
5547 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5548 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5549 *bidi_it_prev
= it
->bidi_it
;
5550 set_iterator_to_next (it
, 0);
5553 /* If we didn't find a newline near enough, see if we can use a
5555 if (!newline_found_p
)
5557 ptrdiff_t start
= IT_CHARPOS (*it
);
5558 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5561 xassert (!STRINGP (it
->string
));
5563 /* If there isn't any `display' property in sight, and no
5564 overlays, we can just use the position of the newline in
5566 if (it
->stop_charpos
>= limit
5567 || ((pos
= Fnext_single_property_change (make_number (start
),
5569 make_number (limit
)),
5571 && next_overlay_change (start
) == ZV
))
5575 IT_CHARPOS (*it
) = limit
;
5576 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5580 struct bidi_it bprev
;
5582 /* Help bidi.c avoid expensive searches for display
5583 properties and overlays, by telling it that there are
5584 none up to `limit'. */
5585 if (it
->bidi_it
.disp_pos
< limit
)
5587 it
->bidi_it
.disp_pos
= limit
;
5588 it
->bidi_it
.disp_prop
= 0;
5591 bprev
= it
->bidi_it
;
5592 bidi_move_to_visually_next (&it
->bidi_it
);
5593 } while (it
->bidi_it
.charpos
!= limit
);
5594 IT_CHARPOS (*it
) = limit
;
5595 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5597 *bidi_it_prev
= bprev
;
5599 *skipped_p
= newline_found_p
= 1;
5603 while (get_next_display_element (it
)
5604 && !newline_found_p
)
5606 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5607 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5608 *bidi_it_prev
= it
->bidi_it
;
5609 set_iterator_to_next (it
, 0);
5614 it
->selective
= old_selective
;
5615 return newline_found_p
;
5619 /* Set IT's current position to the previous visible line start. Skip
5620 invisible text that is so either due to text properties or due to
5621 selective display. Caution: this does not change IT->current_x and
5625 back_to_previous_visible_line_start (struct it
*it
)
5627 while (IT_CHARPOS (*it
) > BEGV
)
5629 back_to_previous_line_start (it
);
5631 if (IT_CHARPOS (*it
) <= BEGV
)
5634 /* If selective > 0, then lines indented more than its value are
5636 if (it
->selective
> 0
5637 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5641 /* Check the newline before point for invisibility. */
5644 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5645 Qinvisible
, it
->window
);
5646 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5650 if (IT_CHARPOS (*it
) <= BEGV
)
5655 void *it2data
= NULL
;
5658 Lisp_Object val
, overlay
;
5660 SAVE_IT (it2
, *it
, it2data
);
5662 /* If newline is part of a composition, continue from start of composition */
5663 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5664 && beg
< IT_CHARPOS (*it
))
5667 /* If newline is replaced by a display property, find start of overlay
5668 or interval and continue search from that point. */
5669 pos
= --IT_CHARPOS (it2
);
5672 bidi_unshelve_cache (NULL
, 0);
5673 it2
.string_from_display_prop_p
= 0;
5674 it2
.from_disp_prop_p
= 0;
5675 if (handle_display_prop (&it2
) == HANDLED_RETURN
5676 && !NILP (val
= get_char_property_and_overlay
5677 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5678 && (OVERLAYP (overlay
)
5679 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5680 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5682 RESTORE_IT (it
, it
, it2data
);
5686 /* Newline is not replaced by anything -- so we are done. */
5687 RESTORE_IT (it
, it
, it2data
);
5693 IT_CHARPOS (*it
) = beg
;
5694 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5698 it
->continuation_lines_width
= 0;
5700 xassert (IT_CHARPOS (*it
) >= BEGV
);
5701 xassert (IT_CHARPOS (*it
) == BEGV
5702 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5707 /* Reseat iterator IT at the previous visible line start. Skip
5708 invisible text that is so either due to text properties or due to
5709 selective display. At the end, update IT's overlay information,
5710 face information etc. */
5713 reseat_at_previous_visible_line_start (struct it
*it
)
5715 back_to_previous_visible_line_start (it
);
5716 reseat (it
, it
->current
.pos
, 1);
5721 /* Reseat iterator IT on the next visible line start in the current
5722 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5723 preceding the line start. Skip over invisible text that is so
5724 because of selective display. Compute faces, overlays etc at the
5725 new position. Note that this function does not skip over text that
5726 is invisible because of text properties. */
5729 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5731 int newline_found_p
, skipped_p
= 0;
5732 struct bidi_it bidi_it_prev
;
5734 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5736 /* Skip over lines that are invisible because they are indented
5737 more than the value of IT->selective. */
5738 if (it
->selective
> 0)
5739 while (IT_CHARPOS (*it
) < ZV
5740 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5743 xassert (IT_BYTEPOS (*it
) == BEGV
5744 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5746 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5749 /* Position on the newline if that's what's requested. */
5750 if (on_newline_p
&& newline_found_p
)
5752 if (STRINGP (it
->string
))
5754 if (IT_STRING_CHARPOS (*it
) > 0)
5758 --IT_STRING_CHARPOS (*it
);
5759 --IT_STRING_BYTEPOS (*it
);
5763 /* We need to restore the bidi iterator to the state
5764 it had on the newline, and resync the IT's
5765 position with that. */
5766 it
->bidi_it
= bidi_it_prev
;
5767 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5768 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5772 else if (IT_CHARPOS (*it
) > BEGV
)
5781 /* We need to restore the bidi iterator to the state it
5782 had on the newline and resync IT with that. */
5783 it
->bidi_it
= bidi_it_prev
;
5784 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5785 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5787 reseat (it
, it
->current
.pos
, 0);
5791 reseat (it
, it
->current
.pos
, 0);
5798 /***********************************************************************
5799 Changing an iterator's position
5800 ***********************************************************************/
5802 /* Change IT's current position to POS in current_buffer. If FORCE_P
5803 is non-zero, always check for text properties at the new position.
5804 Otherwise, text properties are only looked up if POS >=
5805 IT->check_charpos of a property. */
5808 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5810 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
5812 reseat_1 (it
, pos
, 0);
5814 /* Determine where to check text properties. Avoid doing it
5815 where possible because text property lookup is very expensive. */
5817 || CHARPOS (pos
) > it
->stop_charpos
5818 || CHARPOS (pos
) < original_pos
)
5822 /* For bidi iteration, we need to prime prev_stop and
5823 base_level_stop with our best estimations. */
5824 /* Implementation note: Of course, POS is not necessarily a
5825 stop position, so assigning prev_pos to it is a lie; we
5826 should have called compute_stop_backwards. However, if
5827 the current buffer does not include any R2L characters,
5828 that call would be a waste of cycles, because the
5829 iterator will never move back, and thus never cross this
5830 "fake" stop position. So we delay that backward search
5831 until the time we really need it, in next_element_from_buffer. */
5832 if (CHARPOS (pos
) != it
->prev_stop
)
5833 it
->prev_stop
= CHARPOS (pos
);
5834 if (CHARPOS (pos
) < it
->base_level_stop
)
5835 it
->base_level_stop
= 0; /* meaning it's unknown */
5841 it
->prev_stop
= it
->base_level_stop
= 0;
5850 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5851 IT->stop_pos to POS, also. */
5854 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5856 /* Don't call this function when scanning a C string. */
5857 xassert (it
->s
== NULL
);
5859 /* POS must be a reasonable value. */
5860 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5862 it
->current
.pos
= it
->position
= pos
;
5863 it
->end_charpos
= ZV
;
5865 it
->current
.dpvec_index
= -1;
5866 it
->current
.overlay_string_index
= -1;
5867 IT_STRING_CHARPOS (*it
) = -1;
5868 IT_STRING_BYTEPOS (*it
) = -1;
5870 it
->method
= GET_FROM_BUFFER
;
5871 it
->object
= it
->w
->buffer
;
5872 it
->area
= TEXT_AREA
;
5873 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5875 it
->string_from_display_prop_p
= 0;
5876 it
->from_disp_prop_p
= 0;
5877 it
->face_before_selective_p
= 0;
5880 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5882 bidi_unshelve_cache (NULL
, 0);
5883 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5884 it
->bidi_it
.string
.s
= NULL
;
5885 it
->bidi_it
.string
.lstring
= Qnil
;
5886 it
->bidi_it
.string
.bufpos
= 0;
5887 it
->bidi_it
.string
.unibyte
= 0;
5892 it
->stop_charpos
= CHARPOS (pos
);
5893 it
->base_level_stop
= CHARPOS (pos
);
5898 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5899 If S is non-null, it is a C string to iterate over. Otherwise,
5900 STRING gives a Lisp string to iterate over.
5902 If PRECISION > 0, don't return more then PRECISION number of
5903 characters from the string.
5905 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5906 characters have been returned. FIELD_WIDTH < 0 means an infinite
5909 MULTIBYTE = 0 means disable processing of multibyte characters,
5910 MULTIBYTE > 0 means enable it,
5911 MULTIBYTE < 0 means use IT->multibyte_p.
5913 IT must be initialized via a prior call to init_iterator before
5914 calling this function. */
5917 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5918 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
5921 /* No region in strings. */
5922 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5924 /* No text property checks performed by default, but see below. */
5925 it
->stop_charpos
= -1;
5927 /* Set iterator position and end position. */
5928 memset (&it
->current
, 0, sizeof it
->current
);
5929 it
->current
.overlay_string_index
= -1;
5930 it
->current
.dpvec_index
= -1;
5931 xassert (charpos
>= 0);
5933 /* If STRING is specified, use its multibyteness, otherwise use the
5934 setting of MULTIBYTE, if specified. */
5936 it
->multibyte_p
= multibyte
> 0;
5938 /* Bidirectional reordering of strings is controlled by the default
5939 value of bidi-display-reordering. */
5940 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5944 xassert (STRINGP (string
));
5945 it
->string
= string
;
5947 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5948 it
->method
= GET_FROM_STRING
;
5949 it
->current
.string_pos
= string_pos (charpos
, string
);
5953 it
->bidi_it
.string
.lstring
= string
;
5954 it
->bidi_it
.string
.s
= NULL
;
5955 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5956 it
->bidi_it
.string
.bufpos
= 0;
5957 it
->bidi_it
.string
.from_disp_str
= 0;
5958 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5959 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5960 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5965 it
->s
= (const unsigned char *) s
;
5968 /* Note that we use IT->current.pos, not it->current.string_pos,
5969 for displaying C strings. */
5970 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5971 if (it
->multibyte_p
)
5973 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5974 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5978 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5979 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5984 it
->bidi_it
.string
.lstring
= Qnil
;
5985 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5986 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5987 it
->bidi_it
.string
.bufpos
= 0;
5988 it
->bidi_it
.string
.from_disp_str
= 0;
5989 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5990 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5993 it
->method
= GET_FROM_C_STRING
;
5996 /* PRECISION > 0 means don't return more than PRECISION characters
5998 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6000 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6002 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6005 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6006 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6007 FIELD_WIDTH < 0 means infinite field width. This is useful for
6008 padding with `-' at the end of a mode line. */
6009 if (field_width
< 0)
6010 field_width
= INFINITY
;
6011 /* Implementation note: We deliberately don't enlarge
6012 it->bidi_it.string.schars here to fit it->end_charpos, because
6013 the bidi iterator cannot produce characters out of thin air. */
6014 if (field_width
> it
->end_charpos
- charpos
)
6015 it
->end_charpos
= charpos
+ field_width
;
6017 /* Use the standard display table for displaying strings. */
6018 if (DISP_TABLE_P (Vstandard_display_table
))
6019 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6021 it
->stop_charpos
= charpos
;
6022 it
->prev_stop
= charpos
;
6023 it
->base_level_stop
= 0;
6026 it
->bidi_it
.first_elt
= 1;
6027 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6028 it
->bidi_it
.disp_pos
= -1;
6030 if (s
== NULL
&& it
->multibyte_p
)
6032 ptrdiff_t endpos
= SCHARS (it
->string
);
6033 if (endpos
> it
->end_charpos
)
6034 endpos
= it
->end_charpos
;
6035 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6043 /***********************************************************************
6045 ***********************************************************************/
6047 /* Map enum it_method value to corresponding next_element_from_* function. */
6049 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6051 next_element_from_buffer
,
6052 next_element_from_display_vector
,
6053 next_element_from_string
,
6054 next_element_from_c_string
,
6055 next_element_from_image
,
6056 next_element_from_stretch
6059 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6062 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6063 (possibly with the following characters). */
6065 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6066 ((IT)->cmp_it.id >= 0 \
6067 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6068 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6069 END_CHARPOS, (IT)->w, \
6070 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6074 /* Lookup the char-table Vglyphless_char_display for character C (-1
6075 if we want information for no-font case), and return the display
6076 method symbol. By side-effect, update it->what and
6077 it->glyphless_method. This function is called from
6078 get_next_display_element for each character element, and from
6079 x_produce_glyphs when no suitable font was found. */
6082 lookup_glyphless_char_display (int c
, struct it
*it
)
6084 Lisp_Object glyphless_method
= Qnil
;
6086 if (CHAR_TABLE_P (Vglyphless_char_display
)
6087 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6091 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6092 if (CONSP (glyphless_method
))
6093 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6094 ? XCAR (glyphless_method
)
6095 : XCDR (glyphless_method
);
6098 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6102 if (NILP (glyphless_method
))
6105 /* The default is to display the character by a proper font. */
6107 /* The default for the no-font case is to display an empty box. */
6108 glyphless_method
= Qempty_box
;
6110 if (EQ (glyphless_method
, Qzero_width
))
6113 return glyphless_method
;
6114 /* This method can't be used for the no-font case. */
6115 glyphless_method
= Qempty_box
;
6117 if (EQ (glyphless_method
, Qthin_space
))
6118 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6119 else if (EQ (glyphless_method
, Qempty_box
))
6120 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6121 else if (EQ (glyphless_method
, Qhex_code
))
6122 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6123 else if (STRINGP (glyphless_method
))
6124 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6127 /* Invalid value. We use the default method. */
6128 glyphless_method
= Qnil
;
6131 it
->what
= IT_GLYPHLESS
;
6132 return glyphless_method
;
6135 /* Load IT's display element fields with information about the next
6136 display element from the current position of IT. Value is zero if
6137 end of buffer (or C string) is reached. */
6139 static struct frame
*last_escape_glyph_frame
= NULL
;
6140 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6141 static int last_escape_glyph_merged_face_id
= 0;
6143 struct frame
*last_glyphless_glyph_frame
= NULL
;
6144 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6145 int last_glyphless_glyph_merged_face_id
= 0;
6148 get_next_display_element (struct it
*it
)
6150 /* Non-zero means that we found a display element. Zero means that
6151 we hit the end of what we iterate over. Performance note: the
6152 function pointer `method' used here turns out to be faster than
6153 using a sequence of if-statements. */
6157 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6159 if (it
->what
== IT_CHARACTER
)
6161 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6162 and only if (a) the resolved directionality of that character
6164 /* FIXME: Do we need an exception for characters from display
6166 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6167 it
->c
= bidi_mirror_char (it
->c
);
6168 /* Map via display table or translate control characters.
6169 IT->c, IT->len etc. have been set to the next character by
6170 the function call above. If we have a display table, and it
6171 contains an entry for IT->c, translate it. Don't do this if
6172 IT->c itself comes from a display table, otherwise we could
6173 end up in an infinite recursion. (An alternative could be to
6174 count the recursion depth of this function and signal an
6175 error when a certain maximum depth is reached.) Is it worth
6177 if (success_p
&& it
->dpvec
== NULL
)
6180 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6181 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6182 nbsp_or_shy
= char_is_other
;
6183 int c
= it
->c
; /* This is the character to display. */
6185 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6187 xassert (SINGLE_BYTE_CHAR_P (c
));
6188 if (unibyte_display_via_language_environment
)
6190 c
= DECODE_CHAR (unibyte
, c
);
6192 c
= BYTE8_TO_CHAR (it
->c
);
6195 c
= BYTE8_TO_CHAR (it
->c
);
6199 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6202 struct Lisp_Vector
*v
= XVECTOR (dv
);
6204 /* Return the first character from the display table
6205 entry, if not empty. If empty, don't display the
6206 current character. */
6209 it
->dpvec_char_len
= it
->len
;
6210 it
->dpvec
= v
->contents
;
6211 it
->dpend
= v
->contents
+ v
->header
.size
;
6212 it
->current
.dpvec_index
= 0;
6213 it
->dpvec_face_id
= -1;
6214 it
->saved_face_id
= it
->face_id
;
6215 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6220 set_iterator_to_next (it
, 0);
6225 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6227 if (it
->what
== IT_GLYPHLESS
)
6229 /* Don't display this character. */
6230 set_iterator_to_next (it
, 0);
6234 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6235 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6236 : c
== 0xAD ? char_is_soft_hyphen
6239 /* Translate control characters into `\003' or `^C' form.
6240 Control characters coming from a display table entry are
6241 currently not translated because we use IT->dpvec to hold
6242 the translation. This could easily be changed but I
6243 don't believe that it is worth doing.
6245 NBSP and SOFT-HYPEN are property translated too.
6247 Non-printable characters and raw-byte characters are also
6248 translated to octal form. */
6249 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6250 ? (it
->area
!= TEXT_AREA
6251 /* In mode line, treat \n, \t like other crl chars. */
6254 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6255 || (c
!= '\n' && c
!= '\t'))
6258 || ! CHAR_PRINTABLE_P (c
))))
6260 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6261 or a non-printable character which must be displayed
6262 either as '\003' or as `^C' where the '\\' and '^'
6263 can be defined in the display table. Fill
6264 IT->ctl_chars with glyphs for what we have to
6265 display. Then, set IT->dpvec to these glyphs. */
6272 /* Handle control characters with ^. */
6274 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6278 g
= '^'; /* default glyph for Control */
6279 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6281 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6283 g
= GLYPH_CODE_CHAR (gc
);
6284 lface_id
= GLYPH_CODE_FACE (gc
);
6288 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6290 else if (it
->f
== last_escape_glyph_frame
6291 && it
->face_id
== last_escape_glyph_face_id
)
6293 face_id
= last_escape_glyph_merged_face_id
;
6297 /* Merge the escape-glyph face into the current face. */
6298 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6300 last_escape_glyph_frame
= it
->f
;
6301 last_escape_glyph_face_id
= it
->face_id
;
6302 last_escape_glyph_merged_face_id
= face_id
;
6305 XSETINT (it
->ctl_chars
[0], g
);
6306 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6308 goto display_control
;
6311 /* Handle non-break space in the mode where it only gets
6314 if (EQ (Vnobreak_char_display
, Qt
)
6315 && nbsp_or_shy
== char_is_nbsp
)
6317 /* Merge the no-break-space face into the current face. */
6318 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6322 XSETINT (it
->ctl_chars
[0], ' ');
6324 goto display_control
;
6327 /* Handle sequences that start with the "escape glyph". */
6329 /* the default escape glyph is \. */
6330 escape_glyph
= '\\';
6333 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6335 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6336 lface_id
= GLYPH_CODE_FACE (gc
);
6340 /* The display table specified a face.
6341 Merge it into face_id and also into escape_glyph. */
6342 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6345 else if (it
->f
== last_escape_glyph_frame
6346 && it
->face_id
== last_escape_glyph_face_id
)
6348 face_id
= last_escape_glyph_merged_face_id
;
6352 /* Merge the escape-glyph face into the current face. */
6353 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6355 last_escape_glyph_frame
= it
->f
;
6356 last_escape_glyph_face_id
= it
->face_id
;
6357 last_escape_glyph_merged_face_id
= face_id
;
6360 /* Handle soft hyphens in the mode where they only get
6363 if (EQ (Vnobreak_char_display
, Qt
)
6364 && nbsp_or_shy
== char_is_soft_hyphen
)
6366 XSETINT (it
->ctl_chars
[0], '-');
6368 goto display_control
;
6371 /* Handle non-break space and soft hyphen
6372 with the escape glyph. */
6376 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6377 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6378 XSETINT (it
->ctl_chars
[1], c
);
6380 goto display_control
;
6387 if (CHAR_BYTE8_P (c
))
6388 /* Display \200 instead of \17777600. */
6389 c
= CHAR_TO_BYTE8 (c
);
6390 len
= sprintf (str
, "%03o", c
);
6392 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6393 for (i
= 0; i
< len
; i
++)
6394 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6399 /* Set up IT->dpvec and return first character from it. */
6400 it
->dpvec_char_len
= it
->len
;
6401 it
->dpvec
= it
->ctl_chars
;
6402 it
->dpend
= it
->dpvec
+ ctl_len
;
6403 it
->current
.dpvec_index
= 0;
6404 it
->dpvec_face_id
= face_id
;
6405 it
->saved_face_id
= it
->face_id
;
6406 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6410 it
->char_to_display
= c
;
6414 it
->char_to_display
= it
->c
;
6418 /* Adjust face id for a multibyte character. There are no multibyte
6419 character in unibyte text. */
6420 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6423 && FRAME_WINDOW_P (it
->f
))
6425 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6427 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6429 /* Automatic composition with glyph-string. */
6430 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6432 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6436 ptrdiff_t pos
= (it
->s
? -1
6437 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6438 : IT_CHARPOS (*it
));
6441 if (it
->what
== IT_CHARACTER
)
6442 c
= it
->char_to_display
;
6445 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6449 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6450 /* TAB in a composition means display glyphs with
6451 padding space on the left or right. */
6452 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6455 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6460 /* Is this character the last one of a run of characters with
6461 box? If yes, set IT->end_of_box_run_p to 1. */
6465 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6467 int face_id
= underlying_face_id (it
);
6468 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6472 if (face
->box
== FACE_NO_BOX
)
6474 /* If the box comes from face properties in a
6475 display string, check faces in that string. */
6476 int string_face_id
= face_after_it_pos (it
);
6477 it
->end_of_box_run_p
6478 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6481 /* Otherwise, the box comes from the underlying face.
6482 If this is the last string character displayed, check
6483 the next buffer location. */
6484 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6485 && (it
->current
.overlay_string_index
6486 == it
->n_overlay_strings
- 1))
6490 struct text_pos pos
= it
->current
.pos
;
6491 INC_TEXT_POS (pos
, it
->multibyte_p
);
6493 next_face_id
= face_at_buffer_position
6494 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6495 it
->region_end_charpos
, &ignore
,
6496 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6498 it
->end_of_box_run_p
6499 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6506 int face_id
= face_after_it_pos (it
);
6507 it
->end_of_box_run_p
6508 = (face_id
!= it
->face_id
6509 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6513 /* Value is 0 if end of buffer or string reached. */
6518 /* Move IT to the next display element.
6520 RESEAT_P non-zero means if called on a newline in buffer text,
6521 skip to the next visible line start.
6523 Functions get_next_display_element and set_iterator_to_next are
6524 separate because I find this arrangement easier to handle than a
6525 get_next_display_element function that also increments IT's
6526 position. The way it is we can first look at an iterator's current
6527 display element, decide whether it fits on a line, and if it does,
6528 increment the iterator position. The other way around we probably
6529 would either need a flag indicating whether the iterator has to be
6530 incremented the next time, or we would have to implement a
6531 decrement position function which would not be easy to write. */
6534 set_iterator_to_next (struct it
*it
, int reseat_p
)
6536 /* Reset flags indicating start and end of a sequence of characters
6537 with box. Reset them at the start of this function because
6538 moving the iterator to a new position might set them. */
6539 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6543 case GET_FROM_BUFFER
:
6544 /* The current display element of IT is a character from
6545 current_buffer. Advance in the buffer, and maybe skip over
6546 invisible lines that are so because of selective display. */
6547 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6548 reseat_at_next_visible_line_start (it
, 0);
6549 else if (it
->cmp_it
.id
>= 0)
6551 /* We are currently getting glyphs from a composition. */
6556 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6557 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6558 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6560 it
->cmp_it
.from
= it
->cmp_it
.to
;
6565 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6567 it
->end_charpos
, Qnil
);
6570 else if (! it
->cmp_it
.reversed_p
)
6572 /* Composition created while scanning forward. */
6573 /* Update IT's char/byte positions to point to the first
6574 character of the next grapheme cluster, or to the
6575 character visually after the current composition. */
6576 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6577 bidi_move_to_visually_next (&it
->bidi_it
);
6578 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6579 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6581 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6583 /* Proceed to the next grapheme cluster. */
6584 it
->cmp_it
.from
= it
->cmp_it
.to
;
6588 /* No more grapheme clusters in this composition.
6589 Find the next stop position. */
6590 ptrdiff_t stop
= it
->end_charpos
;
6591 if (it
->bidi_it
.scan_dir
< 0)
6592 /* Now we are scanning backward and don't know
6595 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6596 IT_BYTEPOS (*it
), stop
, Qnil
);
6601 /* Composition created while scanning backward. */
6602 /* Update IT's char/byte positions to point to the last
6603 character of the previous grapheme cluster, or the
6604 character visually after the current composition. */
6605 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6606 bidi_move_to_visually_next (&it
->bidi_it
);
6607 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6608 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6609 if (it
->cmp_it
.from
> 0)
6611 /* Proceed to the previous grapheme cluster. */
6612 it
->cmp_it
.to
= it
->cmp_it
.from
;
6616 /* No more grapheme clusters in this composition.
6617 Find the next stop position. */
6618 ptrdiff_t stop
= it
->end_charpos
;
6619 if (it
->bidi_it
.scan_dir
< 0)
6620 /* Now we are scanning backward and don't know
6623 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6624 IT_BYTEPOS (*it
), stop
, Qnil
);
6630 xassert (it
->len
!= 0);
6634 IT_BYTEPOS (*it
) += it
->len
;
6635 IT_CHARPOS (*it
) += 1;
6639 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6640 /* If this is a new paragraph, determine its base
6641 direction (a.k.a. its base embedding level). */
6642 if (it
->bidi_it
.new_paragraph
)
6643 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6644 bidi_move_to_visually_next (&it
->bidi_it
);
6645 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6646 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6647 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6649 /* As the scan direction was changed, we must
6650 re-compute the stop position for composition. */
6651 ptrdiff_t stop
= it
->end_charpos
;
6652 if (it
->bidi_it
.scan_dir
< 0)
6654 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6655 IT_BYTEPOS (*it
), stop
, Qnil
);
6658 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6662 case GET_FROM_C_STRING
:
6663 /* Current display element of IT is from a C string. */
6665 /* If the string position is beyond string's end, it means
6666 next_element_from_c_string is padding the string with
6667 blanks, in which case we bypass the bidi iterator,
6668 because it cannot deal with such virtual characters. */
6669 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6671 IT_BYTEPOS (*it
) += it
->len
;
6672 IT_CHARPOS (*it
) += 1;
6676 bidi_move_to_visually_next (&it
->bidi_it
);
6677 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6678 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6682 case GET_FROM_DISPLAY_VECTOR
:
6683 /* Current display element of IT is from a display table entry.
6684 Advance in the display table definition. Reset it to null if
6685 end reached, and continue with characters from buffers/
6687 ++it
->current
.dpvec_index
;
6689 /* Restore face of the iterator to what they were before the
6690 display vector entry (these entries may contain faces). */
6691 it
->face_id
= it
->saved_face_id
;
6693 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6695 int recheck_faces
= it
->ellipsis_p
;
6698 it
->method
= GET_FROM_C_STRING
;
6699 else if (STRINGP (it
->string
))
6700 it
->method
= GET_FROM_STRING
;
6703 it
->method
= GET_FROM_BUFFER
;
6704 it
->object
= it
->w
->buffer
;
6708 it
->current
.dpvec_index
= -1;
6710 /* Skip over characters which were displayed via IT->dpvec. */
6711 if (it
->dpvec_char_len
< 0)
6712 reseat_at_next_visible_line_start (it
, 1);
6713 else if (it
->dpvec_char_len
> 0)
6715 if (it
->method
== GET_FROM_STRING
6716 && it
->n_overlay_strings
> 0)
6717 it
->ignore_overlay_strings_at_pos_p
= 1;
6718 it
->len
= it
->dpvec_char_len
;
6719 set_iterator_to_next (it
, reseat_p
);
6722 /* Maybe recheck faces after display vector */
6724 it
->stop_charpos
= IT_CHARPOS (*it
);
6728 case GET_FROM_STRING
:
6729 /* Current display element is a character from a Lisp string. */
6730 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6731 if (it
->cmp_it
.id
>= 0)
6737 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6738 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6739 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6740 it
->cmp_it
.from
= it
->cmp_it
.to
;
6744 composition_compute_stop_pos (&it
->cmp_it
,
6745 IT_STRING_CHARPOS (*it
),
6746 IT_STRING_BYTEPOS (*it
),
6747 it
->end_charpos
, it
->string
);
6750 else if (! it
->cmp_it
.reversed_p
)
6752 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6753 bidi_move_to_visually_next (&it
->bidi_it
);
6754 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6755 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6757 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6758 it
->cmp_it
.from
= it
->cmp_it
.to
;
6761 ptrdiff_t stop
= it
->end_charpos
;
6762 if (it
->bidi_it
.scan_dir
< 0)
6764 composition_compute_stop_pos (&it
->cmp_it
,
6765 IT_STRING_CHARPOS (*it
),
6766 IT_STRING_BYTEPOS (*it
), stop
,
6772 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6773 bidi_move_to_visually_next (&it
->bidi_it
);
6774 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6775 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6776 if (it
->cmp_it
.from
> 0)
6777 it
->cmp_it
.to
= it
->cmp_it
.from
;
6780 ptrdiff_t stop
= it
->end_charpos
;
6781 if (it
->bidi_it
.scan_dir
< 0)
6783 composition_compute_stop_pos (&it
->cmp_it
,
6784 IT_STRING_CHARPOS (*it
),
6785 IT_STRING_BYTEPOS (*it
), stop
,
6793 /* If the string position is beyond string's end, it
6794 means next_element_from_string is padding the string
6795 with blanks, in which case we bypass the bidi
6796 iterator, because it cannot deal with such virtual
6798 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6800 IT_STRING_BYTEPOS (*it
) += it
->len
;
6801 IT_STRING_CHARPOS (*it
) += 1;
6805 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6807 bidi_move_to_visually_next (&it
->bidi_it
);
6808 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6809 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6810 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6812 ptrdiff_t stop
= it
->end_charpos
;
6814 if (it
->bidi_it
.scan_dir
< 0)
6816 composition_compute_stop_pos (&it
->cmp_it
,
6817 IT_STRING_CHARPOS (*it
),
6818 IT_STRING_BYTEPOS (*it
), stop
,
6824 consider_string_end
:
6826 if (it
->current
.overlay_string_index
>= 0)
6828 /* IT->string is an overlay string. Advance to the
6829 next, if there is one. */
6830 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6833 next_overlay_string (it
);
6835 setup_for_ellipsis (it
, 0);
6840 /* IT->string is not an overlay string. If we reached
6841 its end, and there is something on IT->stack, proceed
6842 with what is on the stack. This can be either another
6843 string, this time an overlay string, or a buffer. */
6844 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6848 if (it
->method
== GET_FROM_STRING
)
6849 goto consider_string_end
;
6854 case GET_FROM_IMAGE
:
6855 case GET_FROM_STRETCH
:
6856 /* The position etc with which we have to proceed are on
6857 the stack. The position may be at the end of a string,
6858 if the `display' property takes up the whole string. */
6859 xassert (it
->sp
> 0);
6861 if (it
->method
== GET_FROM_STRING
)
6862 goto consider_string_end
;
6866 /* There are no other methods defined, so this should be a bug. */
6870 xassert (it
->method
!= GET_FROM_STRING
6871 || (STRINGP (it
->string
)
6872 && IT_STRING_CHARPOS (*it
) >= 0));
6875 /* Load IT's display element fields with information about the next
6876 display element which comes from a display table entry or from the
6877 result of translating a control character to one of the forms `^C'
6880 IT->dpvec holds the glyphs to return as characters.
6881 IT->saved_face_id holds the face id before the display vector--it
6882 is restored into IT->face_id in set_iterator_to_next. */
6885 next_element_from_display_vector (struct it
*it
)
6890 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6892 it
->face_id
= it
->saved_face_id
;
6894 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6895 That seemed totally bogus - so I changed it... */
6896 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6898 if (GLYPH_CODE_P (gc
))
6900 it
->c
= GLYPH_CODE_CHAR (gc
);
6901 it
->len
= CHAR_BYTES (it
->c
);
6903 /* The entry may contain a face id to use. Such a face id is
6904 the id of a Lisp face, not a realized face. A face id of
6905 zero means no face is specified. */
6906 if (it
->dpvec_face_id
>= 0)
6907 it
->face_id
= it
->dpvec_face_id
;
6910 int lface_id
= GLYPH_CODE_FACE (gc
);
6912 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6917 /* Display table entry is invalid. Return a space. */
6918 it
->c
= ' ', it
->len
= 1;
6920 /* Don't change position and object of the iterator here. They are
6921 still the values of the character that had this display table
6922 entry or was translated, and that's what we want. */
6923 it
->what
= IT_CHARACTER
;
6927 /* Get the first element of string/buffer in the visual order, after
6928 being reseated to a new position in a string or a buffer. */
6930 get_visually_first_element (struct it
*it
)
6932 int string_p
= STRINGP (it
->string
) || it
->s
;
6933 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6934 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
6936 if (STRINGP (it
->string
))
6938 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6939 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6943 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6944 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6947 if (it
->bidi_it
.charpos
== eob
)
6949 /* Nothing to do, but reset the FIRST_ELT flag, like
6950 bidi_paragraph_init does, because we are not going to
6952 it
->bidi_it
.first_elt
= 0;
6954 else if (it
->bidi_it
.charpos
== bob
6956 /* FIXME: Should support all Unicode line separators. */
6957 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6958 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6960 /* If we are at the beginning of a line/string, we can produce
6961 the next element right away. */
6962 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6963 bidi_move_to_visually_next (&it
->bidi_it
);
6967 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
6969 /* We need to prime the bidi iterator starting at the line's or
6970 string's beginning, before we will be able to produce the
6973 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6976 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6978 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6980 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6983 /* Now return to buffer/string position where we were asked
6984 to get the next display element, and produce that. */
6985 bidi_move_to_visually_next (&it
->bidi_it
);
6987 while (it
->bidi_it
.bytepos
!= orig_bytepos
6988 && it
->bidi_it
.charpos
< eob
);
6991 /* Adjust IT's position information to where we ended up. */
6992 if (STRINGP (it
->string
))
6994 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6995 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6999 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7000 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7003 if (STRINGP (it
->string
) || !it
->s
)
7005 ptrdiff_t stop
, charpos
, bytepos
;
7007 if (STRINGP (it
->string
))
7010 stop
= SCHARS (it
->string
);
7011 if (stop
> it
->end_charpos
)
7012 stop
= it
->end_charpos
;
7013 charpos
= IT_STRING_CHARPOS (*it
);
7014 bytepos
= IT_STRING_BYTEPOS (*it
);
7018 stop
= it
->end_charpos
;
7019 charpos
= IT_CHARPOS (*it
);
7020 bytepos
= IT_BYTEPOS (*it
);
7022 if (it
->bidi_it
.scan_dir
< 0)
7024 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7029 /* Load IT with the next display element from Lisp string IT->string.
7030 IT->current.string_pos is the current position within the string.
7031 If IT->current.overlay_string_index >= 0, the Lisp string is an
7035 next_element_from_string (struct it
*it
)
7037 struct text_pos position
;
7039 xassert (STRINGP (it
->string
));
7040 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7041 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7042 position
= it
->current
.string_pos
;
7044 /* With bidi reordering, the character to display might not be the
7045 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7046 that we were reseat()ed to a new string, whose paragraph
7047 direction is not known. */
7048 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7050 get_visually_first_element (it
);
7051 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7054 /* Time to check for invisible text? */
7055 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7057 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7060 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7061 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7063 /* With bidi non-linear iteration, we could find
7064 ourselves far beyond the last computed stop_charpos,
7065 with several other stop positions in between that we
7066 missed. Scan them all now, in buffer's logical
7067 order, until we find and handle the last stop_charpos
7068 that precedes our current position. */
7069 handle_stop_backwards (it
, it
->stop_charpos
);
7070 return GET_NEXT_DISPLAY_ELEMENT (it
);
7076 /* Take note of the stop position we just moved
7077 across, for when we will move back across it. */
7078 it
->prev_stop
= it
->stop_charpos
;
7079 /* If we are at base paragraph embedding level, take
7080 note of the last stop position seen at this
7082 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7083 it
->base_level_stop
= it
->stop_charpos
;
7087 /* Since a handler may have changed IT->method, we must
7089 return GET_NEXT_DISPLAY_ELEMENT (it
);
7093 /* If we are before prev_stop, we may have overstepped
7094 on our way backwards a stop_pos, and if so, we need
7095 to handle that stop_pos. */
7096 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7097 /* We can sometimes back up for reasons that have nothing
7098 to do with bidi reordering. E.g., compositions. The
7099 code below is only needed when we are above the base
7100 embedding level, so test for that explicitly. */
7101 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7103 /* If we lost track of base_level_stop, we have no better
7104 place for handle_stop_backwards to start from than string
7105 beginning. This happens, e.g., when we were reseated to
7106 the previous screenful of text by vertical-motion. */
7107 if (it
->base_level_stop
<= 0
7108 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7109 it
->base_level_stop
= 0;
7110 handle_stop_backwards (it
, it
->base_level_stop
);
7111 return GET_NEXT_DISPLAY_ELEMENT (it
);
7115 if (it
->current
.overlay_string_index
>= 0)
7117 /* Get the next character from an overlay string. In overlay
7118 strings, There is no field width or padding with spaces to
7120 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7125 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7126 IT_STRING_BYTEPOS (*it
),
7127 it
->bidi_it
.scan_dir
< 0
7129 : SCHARS (it
->string
))
7130 && next_element_from_composition (it
))
7134 else if (STRING_MULTIBYTE (it
->string
))
7136 const unsigned char *s
= (SDATA (it
->string
)
7137 + IT_STRING_BYTEPOS (*it
));
7138 it
->c
= string_char_and_length (s
, &it
->len
);
7142 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7148 /* Get the next character from a Lisp string that is not an
7149 overlay string. Such strings come from the mode line, for
7150 example. We may have to pad with spaces, or truncate the
7151 string. See also next_element_from_c_string. */
7152 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7157 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7159 /* Pad with spaces. */
7160 it
->c
= ' ', it
->len
= 1;
7161 CHARPOS (position
) = BYTEPOS (position
) = -1;
7163 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7164 IT_STRING_BYTEPOS (*it
),
7165 it
->bidi_it
.scan_dir
< 0
7167 : it
->string_nchars
)
7168 && next_element_from_composition (it
))
7172 else if (STRING_MULTIBYTE (it
->string
))
7174 const unsigned char *s
= (SDATA (it
->string
)
7175 + IT_STRING_BYTEPOS (*it
));
7176 it
->c
= string_char_and_length (s
, &it
->len
);
7180 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7185 /* Record what we have and where it came from. */
7186 it
->what
= IT_CHARACTER
;
7187 it
->object
= it
->string
;
7188 it
->position
= position
;
7193 /* Load IT with next display element from C string IT->s.
7194 IT->string_nchars is the maximum number of characters to return
7195 from the string. IT->end_charpos may be greater than
7196 IT->string_nchars when this function is called, in which case we
7197 may have to return padding spaces. Value is zero if end of string
7198 reached, including padding spaces. */
7201 next_element_from_c_string (struct it
*it
)
7206 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7207 it
->what
= IT_CHARACTER
;
7208 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7211 /* With bidi reordering, the character to display might not be the
7212 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7213 we were reseated to a new string, whose paragraph direction is
7215 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7216 get_visually_first_element (it
);
7218 /* IT's position can be greater than IT->string_nchars in case a
7219 field width or precision has been specified when the iterator was
7221 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7223 /* End of the game. */
7227 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7229 /* Pad with spaces. */
7230 it
->c
= ' ', it
->len
= 1;
7231 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7233 else if (it
->multibyte_p
)
7234 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7236 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7242 /* Set up IT to return characters from an ellipsis, if appropriate.
7243 The definition of the ellipsis glyphs may come from a display table
7244 entry. This function fills IT with the first glyph from the
7245 ellipsis if an ellipsis is to be displayed. */
7248 next_element_from_ellipsis (struct it
*it
)
7250 if (it
->selective_display_ellipsis_p
)
7251 setup_for_ellipsis (it
, it
->len
);
7254 /* The face at the current position may be different from the
7255 face we find after the invisible text. Remember what it
7256 was in IT->saved_face_id, and signal that it's there by
7257 setting face_before_selective_p. */
7258 it
->saved_face_id
= it
->face_id
;
7259 it
->method
= GET_FROM_BUFFER
;
7260 it
->object
= it
->w
->buffer
;
7261 reseat_at_next_visible_line_start (it
, 1);
7262 it
->face_before_selective_p
= 1;
7265 return GET_NEXT_DISPLAY_ELEMENT (it
);
7269 /* Deliver an image display element. The iterator IT is already
7270 filled with image information (done in handle_display_prop). Value
7275 next_element_from_image (struct it
*it
)
7277 it
->what
= IT_IMAGE
;
7278 it
->ignore_overlay_strings_at_pos_p
= 0;
7283 /* Fill iterator IT with next display element from a stretch glyph
7284 property. IT->object is the value of the text property. Value is
7288 next_element_from_stretch (struct it
*it
)
7290 it
->what
= IT_STRETCH
;
7294 /* Scan backwards from IT's current position until we find a stop
7295 position, or until BEGV. This is called when we find ourself
7296 before both the last known prev_stop and base_level_stop while
7297 reordering bidirectional text. */
7300 compute_stop_pos_backwards (struct it
*it
)
7302 const int SCAN_BACK_LIMIT
= 1000;
7303 struct text_pos pos
;
7304 struct display_pos save_current
= it
->current
;
7305 struct text_pos save_position
= it
->position
;
7306 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7307 ptrdiff_t where_we_are
= charpos
;
7308 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7309 ptrdiff_t save_end_pos
= it
->end_charpos
;
7311 xassert (NILP (it
->string
) && !it
->s
);
7312 xassert (it
->bidi_p
);
7316 it
->end_charpos
= min (charpos
+ 1, ZV
);
7317 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7318 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7319 reseat_1 (it
, pos
, 0);
7320 compute_stop_pos (it
);
7321 /* We must advance forward, right? */
7322 if (it
->stop_charpos
<= charpos
)
7325 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7327 if (it
->stop_charpos
<= where_we_are
)
7328 it
->prev_stop
= it
->stop_charpos
;
7330 it
->prev_stop
= BEGV
;
7332 it
->current
= save_current
;
7333 it
->position
= save_position
;
7334 it
->stop_charpos
= save_stop_pos
;
7335 it
->end_charpos
= save_end_pos
;
7338 /* Scan forward from CHARPOS in the current buffer/string, until we
7339 find a stop position > current IT's position. Then handle the stop
7340 position before that. This is called when we bump into a stop
7341 position while reordering bidirectional text. CHARPOS should be
7342 the last previously processed stop_pos (or BEGV/0, if none were
7343 processed yet) whose position is less that IT's current
7347 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7349 int bufp
= !STRINGP (it
->string
);
7350 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7351 struct display_pos save_current
= it
->current
;
7352 struct text_pos save_position
= it
->position
;
7353 struct text_pos pos1
;
7354 ptrdiff_t next_stop
;
7356 /* Scan in strict logical order. */
7357 xassert (it
->bidi_p
);
7361 it
->prev_stop
= charpos
;
7364 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7365 reseat_1 (it
, pos1
, 0);
7368 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7369 compute_stop_pos (it
);
7370 /* We must advance forward, right? */
7371 if (it
->stop_charpos
<= it
->prev_stop
)
7373 charpos
= it
->stop_charpos
;
7375 while (charpos
<= where_we_are
);
7378 it
->current
= save_current
;
7379 it
->position
= save_position
;
7380 next_stop
= it
->stop_charpos
;
7381 it
->stop_charpos
= it
->prev_stop
;
7383 it
->stop_charpos
= next_stop
;
7386 /* Load IT with the next display element from current_buffer. Value
7387 is zero if end of buffer reached. IT->stop_charpos is the next
7388 position at which to stop and check for text properties or buffer
7392 next_element_from_buffer (struct it
*it
)
7396 xassert (IT_CHARPOS (*it
) >= BEGV
);
7397 xassert (NILP (it
->string
) && !it
->s
);
7398 xassert (!it
->bidi_p
7399 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7400 && it
->bidi_it
.string
.s
== NULL
));
7402 /* With bidi reordering, the character to display might not be the
7403 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7404 we were reseat()ed to a new buffer position, which is potentially
7405 a different paragraph. */
7406 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7408 get_visually_first_element (it
);
7409 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7412 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7414 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7416 int overlay_strings_follow_p
;
7418 /* End of the game, except when overlay strings follow that
7419 haven't been returned yet. */
7420 if (it
->overlay_strings_at_end_processed_p
)
7421 overlay_strings_follow_p
= 0;
7424 it
->overlay_strings_at_end_processed_p
= 1;
7425 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7428 if (overlay_strings_follow_p
)
7429 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7433 it
->position
= it
->current
.pos
;
7437 else if (!(!it
->bidi_p
7438 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7439 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7441 /* With bidi non-linear iteration, we could find ourselves
7442 far beyond the last computed stop_charpos, with several
7443 other stop positions in between that we missed. Scan
7444 them all now, in buffer's logical order, until we find
7445 and handle the last stop_charpos that precedes our
7446 current position. */
7447 handle_stop_backwards (it
, it
->stop_charpos
);
7448 return GET_NEXT_DISPLAY_ELEMENT (it
);
7454 /* Take note of the stop position we just moved across,
7455 for when we will move back across it. */
7456 it
->prev_stop
= it
->stop_charpos
;
7457 /* If we are at base paragraph embedding level, take
7458 note of the last stop position seen at this
7460 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7461 it
->base_level_stop
= it
->stop_charpos
;
7464 return GET_NEXT_DISPLAY_ELEMENT (it
);
7468 /* If we are before prev_stop, we may have overstepped on
7469 our way backwards a stop_pos, and if so, we need to
7470 handle that stop_pos. */
7471 && IT_CHARPOS (*it
) < it
->prev_stop
7472 /* We can sometimes back up for reasons that have nothing
7473 to do with bidi reordering. E.g., compositions. The
7474 code below is only needed when we are above the base
7475 embedding level, so test for that explicitly. */
7476 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7478 if (it
->base_level_stop
<= 0
7479 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7481 /* If we lost track of base_level_stop, we need to find
7482 prev_stop by looking backwards. This happens, e.g., when
7483 we were reseated to the previous screenful of text by
7485 it
->base_level_stop
= BEGV
;
7486 compute_stop_pos_backwards (it
);
7487 handle_stop_backwards (it
, it
->prev_stop
);
7490 handle_stop_backwards (it
, it
->base_level_stop
);
7491 return GET_NEXT_DISPLAY_ELEMENT (it
);
7495 /* No face changes, overlays etc. in sight, so just return a
7496 character from current_buffer. */
7500 /* Maybe run the redisplay end trigger hook. Performance note:
7501 This doesn't seem to cost measurable time. */
7502 if (it
->redisplay_end_trigger_charpos
7504 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7505 run_redisplay_end_trigger_hook (it
);
7507 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7508 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7510 && next_element_from_composition (it
))
7515 /* Get the next character, maybe multibyte. */
7516 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7517 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7518 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7520 it
->c
= *p
, it
->len
= 1;
7522 /* Record what we have and where it came from. */
7523 it
->what
= IT_CHARACTER
;
7524 it
->object
= it
->w
->buffer
;
7525 it
->position
= it
->current
.pos
;
7527 /* Normally we return the character found above, except when we
7528 really want to return an ellipsis for selective display. */
7533 /* A value of selective > 0 means hide lines indented more
7534 than that number of columns. */
7535 if (it
->selective
> 0
7536 && IT_CHARPOS (*it
) + 1 < ZV
7537 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7538 IT_BYTEPOS (*it
) + 1,
7541 success_p
= next_element_from_ellipsis (it
);
7542 it
->dpvec_char_len
= -1;
7545 else if (it
->c
== '\r' && it
->selective
== -1)
7547 /* A value of selective == -1 means that everything from the
7548 CR to the end of the line is invisible, with maybe an
7549 ellipsis displayed for it. */
7550 success_p
= next_element_from_ellipsis (it
);
7551 it
->dpvec_char_len
= -1;
7556 /* Value is zero if end of buffer reached. */
7557 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7562 /* Run the redisplay end trigger hook for IT. */
7565 run_redisplay_end_trigger_hook (struct it
*it
)
7567 Lisp_Object args
[3];
7569 /* IT->glyph_row should be non-null, i.e. we should be actually
7570 displaying something, or otherwise we should not run the hook. */
7571 xassert (it
->glyph_row
);
7573 /* Set up hook arguments. */
7574 args
[0] = Qredisplay_end_trigger_functions
;
7575 args
[1] = it
->window
;
7576 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7577 it
->redisplay_end_trigger_charpos
= 0;
7579 /* Since we are *trying* to run these functions, don't try to run
7580 them again, even if they get an error. */
7581 it
->w
->redisplay_end_trigger
= Qnil
;
7582 Frun_hook_with_args (3, args
);
7584 /* Notice if it changed the face of the character we are on. */
7585 handle_face_prop (it
);
7589 /* Deliver a composition display element. Unlike the other
7590 next_element_from_XXX, this function is not registered in the array
7591 get_next_element[]. It is called from next_element_from_buffer and
7592 next_element_from_string when necessary. */
7595 next_element_from_composition (struct it
*it
)
7597 it
->what
= IT_COMPOSITION
;
7598 it
->len
= it
->cmp_it
.nbytes
;
7599 if (STRINGP (it
->string
))
7603 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7604 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7607 it
->position
= it
->current
.string_pos
;
7608 it
->object
= it
->string
;
7609 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7610 IT_STRING_BYTEPOS (*it
), it
->string
);
7616 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7617 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7620 if (it
->bidi_it
.new_paragraph
)
7621 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7622 /* Resync the bidi iterator with IT's new position.
7623 FIXME: this doesn't support bidirectional text. */
7624 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7625 bidi_move_to_visually_next (&it
->bidi_it
);
7629 it
->position
= it
->current
.pos
;
7630 it
->object
= it
->w
->buffer
;
7631 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7632 IT_BYTEPOS (*it
), Qnil
);
7639 /***********************************************************************
7640 Moving an iterator without producing glyphs
7641 ***********************************************************************/
7643 /* Check if iterator is at a position corresponding to a valid buffer
7644 position after some move_it_ call. */
7646 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7647 ((it)->method == GET_FROM_STRING \
7648 ? IT_STRING_CHARPOS (*it) == 0 \
7652 /* Move iterator IT to a specified buffer or X position within one
7653 line on the display without producing glyphs.
7655 OP should be a bit mask including some or all of these bits:
7656 MOVE_TO_X: Stop upon reaching x-position TO_X.
7657 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7658 Regardless of OP's value, stop upon reaching the end of the display line.
7660 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7661 This means, in particular, that TO_X includes window's horizontal
7664 The return value has several possible values that
7665 say what condition caused the scan to stop:
7667 MOVE_POS_MATCH_OR_ZV
7668 - when TO_POS or ZV was reached.
7671 -when TO_X was reached before TO_POS or ZV were reached.
7674 - when we reached the end of the display area and the line must
7678 - when we reached the end of the display area and the line is
7682 - when we stopped at a line end, i.e. a newline or a CR and selective
7685 static enum move_it_result
7686 move_it_in_display_line_to (struct it
*it
,
7687 ptrdiff_t to_charpos
, int to_x
,
7688 enum move_operation_enum op
)
7690 enum move_it_result result
= MOVE_UNDEFINED
;
7691 struct glyph_row
*saved_glyph_row
;
7692 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7693 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7694 void *ppos_data
= NULL
;
7696 enum it_method prev_method
= it
->method
;
7697 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
7698 int saw_smaller_pos
= prev_pos
< to_charpos
;
7700 /* Don't produce glyphs in produce_glyphs. */
7701 saved_glyph_row
= it
->glyph_row
;
7702 it
->glyph_row
= NULL
;
7704 /* Use wrap_it to save a copy of IT wherever a word wrap could
7705 occur. Use atpos_it to save a copy of IT at the desired buffer
7706 position, if found, so that we can scan ahead and check if the
7707 word later overshoots the window edge. Use atx_it similarly, for
7713 /* Use ppos_it under bidi reordering to save a copy of IT for the
7714 position > CHARPOS that is the closest to CHARPOS. We restore
7715 that position in IT when we have scanned the entire display line
7716 without finding a match for CHARPOS and all the character
7717 positions are greater than CHARPOS. */
7720 SAVE_IT (ppos_it
, *it
, ppos_data
);
7721 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7722 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7723 SAVE_IT (ppos_it
, *it
, ppos_data
);
7726 #define BUFFER_POS_REACHED_P() \
7727 ((op & MOVE_TO_POS) != 0 \
7728 && BUFFERP (it->object) \
7729 && (IT_CHARPOS (*it) == to_charpos \
7730 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos) \
7731 || (it->what == IT_COMPOSITION \
7732 && ((IT_CHARPOS (*it) > to_charpos \
7733 && to_charpos >= it->cmp_it.charpos) \
7734 || (IT_CHARPOS (*it) < to_charpos \
7735 && to_charpos <= it->cmp_it.charpos)))) \
7736 && (it->method == GET_FROM_BUFFER \
7737 || (it->method == GET_FROM_DISPLAY_VECTOR \
7738 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7740 /* If there's a line-/wrap-prefix, handle it. */
7741 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7742 && it
->current_y
< it
->last_visible_y
)
7743 handle_line_prefix (it
);
7745 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7746 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7750 int x
, i
, ascent
= 0, descent
= 0;
7752 /* Utility macro to reset an iterator with x, ascent, and descent. */
7753 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7754 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7755 (IT)->max_descent = descent)
7757 /* Stop if we move beyond TO_CHARPOS (after an image or a
7758 display string or stretch glyph). */
7759 if ((op
& MOVE_TO_POS
) != 0
7760 && BUFFERP (it
->object
)
7761 && it
->method
== GET_FROM_BUFFER
7762 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7764 && (prev_method
== GET_FROM_IMAGE
7765 || prev_method
== GET_FROM_STRETCH
7766 || prev_method
== GET_FROM_STRING
)
7767 /* Passed TO_CHARPOS from left to right. */
7768 && ((prev_pos
< to_charpos
7769 && IT_CHARPOS (*it
) > to_charpos
)
7770 /* Passed TO_CHARPOS from right to left. */
7771 || (prev_pos
> to_charpos
7772 && IT_CHARPOS (*it
) < to_charpos
)))))
7774 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7776 result
= MOVE_POS_MATCH_OR_ZV
;
7779 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7780 /* If wrap_it is valid, the current position might be in a
7781 word that is wrapped. So, save the iterator in
7782 atpos_it and continue to see if wrapping happens. */
7783 SAVE_IT (atpos_it
, *it
, atpos_data
);
7786 /* Stop when ZV reached.
7787 We used to stop here when TO_CHARPOS reached as well, but that is
7788 too soon if this glyph does not fit on this line. So we handle it
7789 explicitly below. */
7790 if (!get_next_display_element (it
))
7792 result
= MOVE_POS_MATCH_OR_ZV
;
7796 if (it
->line_wrap
== TRUNCATE
)
7798 if (BUFFER_POS_REACHED_P ())
7800 result
= MOVE_POS_MATCH_OR_ZV
;
7806 if (it
->line_wrap
== WORD_WRAP
)
7808 if (IT_DISPLAYING_WHITESPACE (it
))
7812 /* We have reached a glyph that follows one or more
7813 whitespace characters. If the position is
7814 already found, we are done. */
7815 if (atpos_it
.sp
>= 0)
7817 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7818 result
= MOVE_POS_MATCH_OR_ZV
;
7823 RESTORE_IT (it
, &atx_it
, atx_data
);
7824 result
= MOVE_X_REACHED
;
7827 /* Otherwise, we can wrap here. */
7828 SAVE_IT (wrap_it
, *it
, wrap_data
);
7834 /* Remember the line height for the current line, in case
7835 the next element doesn't fit on the line. */
7836 ascent
= it
->max_ascent
;
7837 descent
= it
->max_descent
;
7839 /* The call to produce_glyphs will get the metrics of the
7840 display element IT is loaded with. Record the x-position
7841 before this display element, in case it doesn't fit on the
7845 PRODUCE_GLYPHS (it
);
7847 if (it
->area
!= TEXT_AREA
)
7849 prev_method
= it
->method
;
7850 if (it
->method
== GET_FROM_BUFFER
)
7851 prev_pos
= IT_CHARPOS (*it
);
7852 set_iterator_to_next (it
, 1);
7853 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7854 SET_TEXT_POS (this_line_min_pos
,
7855 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7857 && (op
& MOVE_TO_POS
)
7858 && IT_CHARPOS (*it
) > to_charpos
7859 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7860 SAVE_IT (ppos_it
, *it
, ppos_data
);
7864 /* The number of glyphs we get back in IT->nglyphs will normally
7865 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7866 character on a terminal frame, or (iii) a line end. For the
7867 second case, IT->nglyphs - 1 padding glyphs will be present.
7868 (On X frames, there is only one glyph produced for a
7869 composite character.)
7871 The behavior implemented below means, for continuation lines,
7872 that as many spaces of a TAB as fit on the current line are
7873 displayed there. For terminal frames, as many glyphs of a
7874 multi-glyph character are displayed in the current line, too.
7875 This is what the old redisplay code did, and we keep it that
7876 way. Under X, the whole shape of a complex character must
7877 fit on the line or it will be completely displayed in the
7880 Note that both for tabs and padding glyphs, all glyphs have
7884 /* More than one glyph or glyph doesn't fit on line. All
7885 glyphs have the same width. */
7886 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7888 int x_before_this_char
= x
;
7889 int hpos_before_this_char
= it
->hpos
;
7891 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7893 new_x
= x
+ single_glyph_width
;
7895 /* We want to leave anything reaching TO_X to the caller. */
7896 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7898 if (BUFFER_POS_REACHED_P ())
7900 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7901 goto buffer_pos_reached
;
7902 if (atpos_it
.sp
< 0)
7904 SAVE_IT (atpos_it
, *it
, atpos_data
);
7905 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7910 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7913 result
= MOVE_X_REACHED
;
7918 SAVE_IT (atx_it
, *it
, atx_data
);
7919 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7924 if (/* Lines are continued. */
7925 it
->line_wrap
!= TRUNCATE
7926 && (/* And glyph doesn't fit on the line. */
7927 new_x
> it
->last_visible_x
7928 /* Or it fits exactly and we're on a window
7930 || (new_x
== it
->last_visible_x
7931 && FRAME_WINDOW_P (it
->f
))))
7933 if (/* IT->hpos == 0 means the very first glyph
7934 doesn't fit on the line, e.g. a wide image. */
7936 || (new_x
== it
->last_visible_x
7937 && FRAME_WINDOW_P (it
->f
)))
7940 it
->current_x
= new_x
;
7942 /* The character's last glyph just barely fits
7944 if (i
== it
->nglyphs
- 1)
7946 /* If this is the destination position,
7947 return a position *before* it in this row,
7948 now that we know it fits in this row. */
7949 if (BUFFER_POS_REACHED_P ())
7951 if (it
->line_wrap
!= WORD_WRAP
7954 it
->hpos
= hpos_before_this_char
;
7955 it
->current_x
= x_before_this_char
;
7956 result
= MOVE_POS_MATCH_OR_ZV
;
7959 if (it
->line_wrap
== WORD_WRAP
7962 SAVE_IT (atpos_it
, *it
, atpos_data
);
7963 atpos_it
.current_x
= x_before_this_char
;
7964 atpos_it
.hpos
= hpos_before_this_char
;
7968 prev_method
= it
->method
;
7969 if (it
->method
== GET_FROM_BUFFER
)
7970 prev_pos
= IT_CHARPOS (*it
);
7971 set_iterator_to_next (it
, 1);
7972 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7973 SET_TEXT_POS (this_line_min_pos
,
7974 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7975 /* On graphical terminals, newlines may
7976 "overflow" into the fringe if
7977 overflow-newline-into-fringe is non-nil.
7978 On text-only terminals, newlines may
7979 overflow into the last glyph on the
7981 if (!FRAME_WINDOW_P (it
->f
)
7982 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7984 if (!get_next_display_element (it
))
7986 result
= MOVE_POS_MATCH_OR_ZV
;
7989 if (BUFFER_POS_REACHED_P ())
7991 if (ITERATOR_AT_END_OF_LINE_P (it
))
7992 result
= MOVE_POS_MATCH_OR_ZV
;
7994 result
= MOVE_LINE_CONTINUED
;
7997 if (ITERATOR_AT_END_OF_LINE_P (it
))
7999 result
= MOVE_NEWLINE_OR_CR
;
8006 IT_RESET_X_ASCENT_DESCENT (it
);
8008 if (wrap_it
.sp
>= 0)
8010 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8015 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8017 result
= MOVE_LINE_CONTINUED
;
8021 if (BUFFER_POS_REACHED_P ())
8023 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8024 goto buffer_pos_reached
;
8025 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8027 SAVE_IT (atpos_it
, *it
, atpos_data
);
8028 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8032 if (new_x
> it
->first_visible_x
)
8034 /* Glyph is visible. Increment number of glyphs that
8035 would be displayed. */
8040 if (result
!= MOVE_UNDEFINED
)
8043 else if (BUFFER_POS_REACHED_P ())
8046 IT_RESET_X_ASCENT_DESCENT (it
);
8047 result
= MOVE_POS_MATCH_OR_ZV
;
8050 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8052 /* Stop when TO_X specified and reached. This check is
8053 necessary here because of lines consisting of a line end,
8054 only. The line end will not produce any glyphs and we
8055 would never get MOVE_X_REACHED. */
8056 xassert (it
->nglyphs
== 0);
8057 result
= MOVE_X_REACHED
;
8061 /* Is this a line end? If yes, we're done. */
8062 if (ITERATOR_AT_END_OF_LINE_P (it
))
8064 /* If we are past TO_CHARPOS, but never saw any character
8065 positions smaller than TO_CHARPOS, return
8066 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8068 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8070 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8072 if (IT_CHARPOS (ppos_it
) < ZV
)
8074 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8075 result
= MOVE_POS_MATCH_OR_ZV
;
8078 goto buffer_pos_reached
;
8080 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8081 && IT_CHARPOS (*it
) > to_charpos
)
8082 goto buffer_pos_reached
;
8084 result
= MOVE_NEWLINE_OR_CR
;
8087 result
= MOVE_NEWLINE_OR_CR
;
8091 prev_method
= it
->method
;
8092 if (it
->method
== GET_FROM_BUFFER
)
8093 prev_pos
= IT_CHARPOS (*it
);
8094 /* The current display element has been consumed. Advance
8096 set_iterator_to_next (it
, 1);
8097 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8098 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8099 if (IT_CHARPOS (*it
) < to_charpos
)
8100 saw_smaller_pos
= 1;
8102 && (op
& MOVE_TO_POS
)
8103 && IT_CHARPOS (*it
) >= to_charpos
8104 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8105 SAVE_IT (ppos_it
, *it
, ppos_data
);
8107 /* Stop if lines are truncated and IT's current x-position is
8108 past the right edge of the window now. */
8109 if (it
->line_wrap
== TRUNCATE
8110 && it
->current_x
>= it
->last_visible_x
)
8112 if (!FRAME_WINDOW_P (it
->f
)
8113 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8117 if ((at_eob_p
= !get_next_display_element (it
))
8118 || BUFFER_POS_REACHED_P ()
8119 /* If we are past TO_CHARPOS, but never saw any
8120 character positions smaller than TO_CHARPOS,
8121 return MOVE_POS_MATCH_OR_ZV, like the
8122 unidirectional display did. */
8123 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8125 && IT_CHARPOS (*it
) > to_charpos
))
8128 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8129 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8130 result
= MOVE_POS_MATCH_OR_ZV
;
8133 if (ITERATOR_AT_END_OF_LINE_P (it
))
8135 result
= MOVE_NEWLINE_OR_CR
;
8139 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8141 && IT_CHARPOS (*it
) > to_charpos
)
8143 if (IT_CHARPOS (ppos_it
) < ZV
)
8144 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8145 result
= MOVE_POS_MATCH_OR_ZV
;
8148 result
= MOVE_LINE_TRUNCATED
;
8151 #undef IT_RESET_X_ASCENT_DESCENT
8154 #undef BUFFER_POS_REACHED_P
8156 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8157 restore the saved iterator. */
8158 if (atpos_it
.sp
>= 0)
8159 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8160 else if (atx_it
.sp
>= 0)
8161 RESTORE_IT (it
, &atx_it
, atx_data
);
8166 bidi_unshelve_cache (atpos_data
, 1);
8168 bidi_unshelve_cache (atx_data
, 1);
8170 bidi_unshelve_cache (wrap_data
, 1);
8172 bidi_unshelve_cache (ppos_data
, 1);
8174 /* Restore the iterator settings altered at the beginning of this
8176 it
->glyph_row
= saved_glyph_row
;
8180 /* For external use. */
8182 move_it_in_display_line (struct it
*it
,
8183 ptrdiff_t to_charpos
, int to_x
,
8184 enum move_operation_enum op
)
8186 if (it
->line_wrap
== WORD_WRAP
8187 && (op
& MOVE_TO_X
))
8190 void *save_data
= NULL
;
8193 SAVE_IT (save_it
, *it
, save_data
);
8194 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8195 /* When word-wrap is on, TO_X may lie past the end
8196 of a wrapped line. Then it->current is the
8197 character on the next line, so backtrack to the
8198 space before the wrap point. */
8199 if (skip
== MOVE_LINE_CONTINUED
)
8201 int prev_x
= max (it
->current_x
- 1, 0);
8202 RESTORE_IT (it
, &save_it
, save_data
);
8203 move_it_in_display_line_to
8204 (it
, -1, prev_x
, MOVE_TO_X
);
8207 bidi_unshelve_cache (save_data
, 1);
8210 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8214 /* Move IT forward until it satisfies one or more of the criteria in
8215 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8217 OP is a bit-mask that specifies where to stop, and in particular,
8218 which of those four position arguments makes a difference. See the
8219 description of enum move_operation_enum.
8221 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8222 screen line, this function will set IT to the next position that is
8223 displayed to the right of TO_CHARPOS on the screen. */
8226 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8228 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8229 int line_height
, line_start_x
= 0, reached
= 0;
8230 void *backup_data
= NULL
;
8234 if (op
& MOVE_TO_VPOS
)
8236 /* If no TO_CHARPOS and no TO_X specified, stop at the
8237 start of the line TO_VPOS. */
8238 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8240 if (it
->vpos
== to_vpos
)
8246 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8250 /* TO_VPOS >= 0 means stop at TO_X in the line at
8251 TO_VPOS, or at TO_POS, whichever comes first. */
8252 if (it
->vpos
== to_vpos
)
8258 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8260 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8265 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8267 /* We have reached TO_X but not in the line we want. */
8268 skip
= move_it_in_display_line_to (it
, to_charpos
,
8270 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8278 else if (op
& MOVE_TO_Y
)
8280 struct it it_backup
;
8282 if (it
->line_wrap
== WORD_WRAP
)
8283 SAVE_IT (it_backup
, *it
, backup_data
);
8285 /* TO_Y specified means stop at TO_X in the line containing
8286 TO_Y---or at TO_CHARPOS if this is reached first. The
8287 problem is that we can't really tell whether the line
8288 contains TO_Y before we have completely scanned it, and
8289 this may skip past TO_X. What we do is to first scan to
8292 If TO_X is not specified, use a TO_X of zero. The reason
8293 is to make the outcome of this function more predictable.
8294 If we didn't use TO_X == 0, we would stop at the end of
8295 the line which is probably not what a caller would expect
8297 skip
= move_it_in_display_line_to
8298 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8299 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8301 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8302 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8304 else if (skip
== MOVE_X_REACHED
)
8306 /* If TO_X was reached, we want to know whether TO_Y is
8307 in the line. We know this is the case if the already
8308 scanned glyphs make the line tall enough. Otherwise,
8309 we must check by scanning the rest of the line. */
8310 line_height
= it
->max_ascent
+ it
->max_descent
;
8311 if (to_y
>= it
->current_y
8312 && to_y
< it
->current_y
+ line_height
)
8317 SAVE_IT (it_backup
, *it
, backup_data
);
8318 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8319 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8321 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8322 line_height
= it
->max_ascent
+ it
->max_descent
;
8323 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8325 if (to_y
>= it
->current_y
8326 && to_y
< it
->current_y
+ line_height
)
8328 /* If TO_Y is in this line and TO_X was reached
8329 above, we scanned too far. We have to restore
8330 IT's settings to the ones before skipping. */
8331 RESTORE_IT (it
, &it_backup
, backup_data
);
8337 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8343 /* Check whether TO_Y is in this line. */
8344 line_height
= it
->max_ascent
+ it
->max_descent
;
8345 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8347 if (to_y
>= it
->current_y
8348 && to_y
< it
->current_y
+ line_height
)
8350 /* When word-wrap is on, TO_X may lie past the end
8351 of a wrapped line. Then it->current is the
8352 character on the next line, so backtrack to the
8353 space before the wrap point. */
8354 if (skip
== MOVE_LINE_CONTINUED
8355 && it
->line_wrap
== WORD_WRAP
)
8357 int prev_x
= max (it
->current_x
- 1, 0);
8358 RESTORE_IT (it
, &it_backup
, backup_data
);
8359 skip
= move_it_in_display_line_to
8360 (it
, -1, prev_x
, MOVE_TO_X
);
8369 else if (BUFFERP (it
->object
)
8370 && (it
->method
== GET_FROM_BUFFER
8371 || it
->method
== GET_FROM_STRETCH
)
8372 && IT_CHARPOS (*it
) >= to_charpos
8373 /* Under bidi iteration, a call to set_iterator_to_next
8374 can scan far beyond to_charpos if the initial
8375 portion of the next line needs to be reordered. In
8376 that case, give move_it_in_display_line_to another
8379 && it
->bidi_it
.scan_dir
== -1))
8380 skip
= MOVE_POS_MATCH_OR_ZV
;
8382 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8386 case MOVE_POS_MATCH_OR_ZV
:
8390 case MOVE_NEWLINE_OR_CR
:
8391 set_iterator_to_next (it
, 1);
8392 it
->continuation_lines_width
= 0;
8395 case MOVE_LINE_TRUNCATED
:
8396 it
->continuation_lines_width
= 0;
8397 reseat_at_next_visible_line_start (it
, 0);
8398 if ((op
& MOVE_TO_POS
) != 0
8399 && IT_CHARPOS (*it
) > to_charpos
)
8406 case MOVE_LINE_CONTINUED
:
8407 /* For continued lines ending in a tab, some of the glyphs
8408 associated with the tab are displayed on the current
8409 line. Since it->current_x does not include these glyphs,
8410 we use it->last_visible_x instead. */
8413 it
->continuation_lines_width
+= it
->last_visible_x
;
8414 /* When moving by vpos, ensure that the iterator really
8415 advances to the next line (bug#847, bug#969). Fixme:
8416 do we need to do this in other circumstances? */
8417 if (it
->current_x
!= it
->last_visible_x
8418 && (op
& MOVE_TO_VPOS
)
8419 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8421 line_start_x
= it
->current_x
+ it
->pixel_width
8422 - it
->last_visible_x
;
8423 set_iterator_to_next (it
, 0);
8427 it
->continuation_lines_width
+= it
->current_x
;
8434 /* Reset/increment for the next run. */
8435 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8436 it
->current_x
= line_start_x
;
8439 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8441 last_height
= it
->max_ascent
+ it
->max_descent
;
8442 last_max_ascent
= it
->max_ascent
;
8443 it
->max_ascent
= it
->max_descent
= 0;
8448 /* On text terminals, we may stop at the end of a line in the middle
8449 of a multi-character glyph. If the glyph itself is continued,
8450 i.e. it is actually displayed on the next line, don't treat this
8451 stopping point as valid; move to the next line instead (unless
8452 that brings us offscreen). */
8453 if (!FRAME_WINDOW_P (it
->f
)
8455 && IT_CHARPOS (*it
) == to_charpos
8456 && it
->what
== IT_CHARACTER
8458 && it
->line_wrap
== WINDOW_WRAP
8459 && it
->current_x
== it
->last_visible_x
- 1
8462 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8464 it
->continuation_lines_width
+= it
->current_x
;
8465 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8466 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8468 last_height
= it
->max_ascent
+ it
->max_descent
;
8469 last_max_ascent
= it
->max_ascent
;
8473 bidi_unshelve_cache (backup_data
, 1);
8475 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8479 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8481 If DY > 0, move IT backward at least that many pixels. DY = 0
8482 means move IT backward to the preceding line start or BEGV. This
8483 function may move over more than DY pixels if IT->current_y - DY
8484 ends up in the middle of a line; in this case IT->current_y will be
8485 set to the top of the line moved to. */
8488 move_it_vertically_backward (struct it
*it
, int dy
)
8492 void *it2data
= NULL
, *it3data
= NULL
;
8493 ptrdiff_t start_pos
;
8498 start_pos
= IT_CHARPOS (*it
);
8500 /* Estimate how many newlines we must move back. */
8501 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8503 /* Set the iterator's position that many lines back. */
8504 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8505 back_to_previous_visible_line_start (it
);
8507 /* Reseat the iterator here. When moving backward, we don't want
8508 reseat to skip forward over invisible text, set up the iterator
8509 to deliver from overlay strings at the new position etc. So,
8510 use reseat_1 here. */
8511 reseat_1 (it
, it
->current
.pos
, 1);
8513 /* We are now surely at a line start. */
8514 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8515 reordering is in effect. */
8516 it
->continuation_lines_width
= 0;
8518 /* Move forward and see what y-distance we moved. First move to the
8519 start of the next line so that we get its height. We need this
8520 height to be able to tell whether we reached the specified
8522 SAVE_IT (it2
, *it
, it2data
);
8523 it2
.max_ascent
= it2
.max_descent
= 0;
8526 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8527 MOVE_TO_POS
| MOVE_TO_VPOS
);
8529 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8530 xassert (IT_CHARPOS (*it
) >= BEGV
);
8531 SAVE_IT (it3
, it2
, it3data
);
8533 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8534 xassert (IT_CHARPOS (*it
) >= BEGV
);
8535 /* H is the actual vertical distance from the position in *IT
8536 and the starting position. */
8537 h
= it2
.current_y
- it
->current_y
;
8538 /* NLINES is the distance in number of lines. */
8539 nlines
= it2
.vpos
- it
->vpos
;
8541 /* Correct IT's y and vpos position
8542 so that they are relative to the starting point. */
8548 /* DY == 0 means move to the start of the screen line. The
8549 value of nlines is > 0 if continuation lines were involved,
8550 or if the original IT position was at start of a line. */
8551 RESTORE_IT (it
, it
, it2data
);
8553 move_it_by_lines (it
, nlines
);
8554 /* The above code moves us to some position NLINES down,
8555 usually to its first glyph (leftmost in an L2R line), but
8556 that's not necessarily the start of the line, under bidi
8557 reordering. We want to get to the character position
8558 that is immediately after the newline of the previous
8560 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8561 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8564 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8566 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8568 bidi_unshelve_cache (it3data
, 1);
8572 /* The y-position we try to reach, relative to *IT.
8573 Note that H has been subtracted in front of the if-statement. */
8574 int target_y
= it
->current_y
+ h
- dy
;
8575 int y0
= it3
.current_y
;
8579 RESTORE_IT (&it3
, &it3
, it3data
);
8580 y1
= line_bottom_y (&it3
);
8581 line_height
= y1
- y0
;
8582 RESTORE_IT (it
, it
, it2data
);
8583 /* If we did not reach target_y, try to move further backward if
8584 we can. If we moved too far backward, try to move forward. */
8585 if (target_y
< it
->current_y
8586 /* This is heuristic. In a window that's 3 lines high, with
8587 a line height of 13 pixels each, recentering with point
8588 on the bottom line will try to move -39/2 = 19 pixels
8589 backward. Try to avoid moving into the first line. */
8590 && (it
->current_y
- target_y
8591 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8592 && IT_CHARPOS (*it
) > BEGV
)
8594 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8595 target_y
- it
->current_y
));
8596 dy
= it
->current_y
- target_y
;
8597 goto move_further_back
;
8599 else if (target_y
>= it
->current_y
+ line_height
8600 && IT_CHARPOS (*it
) < ZV
)
8602 /* Should move forward by at least one line, maybe more.
8604 Note: Calling move_it_by_lines can be expensive on
8605 terminal frames, where compute_motion is used (via
8606 vmotion) to do the job, when there are very long lines
8607 and truncate-lines is nil. That's the reason for
8608 treating terminal frames specially here. */
8610 if (!FRAME_WINDOW_P (it
->f
))
8611 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8616 move_it_by_lines (it
, 1);
8618 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8625 /* Move IT by a specified amount of pixel lines DY. DY negative means
8626 move backwards. DY = 0 means move to start of screen line. At the
8627 end, IT will be on the start of a screen line. */
8630 move_it_vertically (struct it
*it
, int dy
)
8633 move_it_vertically_backward (it
, -dy
);
8636 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8637 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8638 MOVE_TO_POS
| MOVE_TO_Y
);
8639 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8641 /* If buffer ends in ZV without a newline, move to the start of
8642 the line to satisfy the post-condition. */
8643 if (IT_CHARPOS (*it
) == ZV
8645 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8646 move_it_by_lines (it
, 0);
8651 /* Move iterator IT past the end of the text line it is in. */
8654 move_it_past_eol (struct it
*it
)
8656 enum move_it_result rc
;
8658 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8659 if (rc
== MOVE_NEWLINE_OR_CR
)
8660 set_iterator_to_next (it
, 0);
8664 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8665 negative means move up. DVPOS == 0 means move to the start of the
8668 Optimization idea: If we would know that IT->f doesn't use
8669 a face with proportional font, we could be faster for
8670 truncate-lines nil. */
8673 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
8676 /* The commented-out optimization uses vmotion on terminals. This
8677 gives bad results, because elements like it->what, on which
8678 callers such as pos_visible_p rely, aren't updated. */
8679 /* struct position pos;
8680 if (!FRAME_WINDOW_P (it->f))
8682 struct text_pos textpos;
8684 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8685 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8686 reseat (it, textpos, 1);
8687 it->vpos += pos.vpos;
8688 it->current_y += pos.vpos;
8694 /* DVPOS == 0 means move to the start of the screen line. */
8695 move_it_vertically_backward (it
, 0);
8696 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8697 /* Let next call to line_bottom_y calculate real line height */
8702 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8703 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8704 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8709 void *it2data
= NULL
;
8710 ptrdiff_t start_charpos
, i
;
8712 /* Start at the beginning of the screen line containing IT's
8713 position. This may actually move vertically backwards,
8714 in case of overlays, so adjust dvpos accordingly. */
8716 move_it_vertically_backward (it
, 0);
8719 /* Go back -DVPOS visible lines and reseat the iterator there. */
8720 start_charpos
= IT_CHARPOS (*it
);
8721 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8722 back_to_previous_visible_line_start (it
);
8723 reseat (it
, it
->current
.pos
, 1);
8725 /* Move further back if we end up in a string or an image. */
8726 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8728 /* First try to move to start of display line. */
8730 move_it_vertically_backward (it
, 0);
8732 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8734 /* If start of line is still in string or image,
8735 move further back. */
8736 back_to_previous_visible_line_start (it
);
8737 reseat (it
, it
->current
.pos
, 1);
8741 it
->current_x
= it
->hpos
= 0;
8743 /* Above call may have moved too far if continuation lines
8744 are involved. Scan forward and see if it did. */
8745 SAVE_IT (it2
, *it
, it2data
);
8746 it2
.vpos
= it2
.current_y
= 0;
8747 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8748 it
->vpos
-= it2
.vpos
;
8749 it
->current_y
-= it2
.current_y
;
8750 it
->current_x
= it
->hpos
= 0;
8752 /* If we moved too far back, move IT some lines forward. */
8753 if (it2
.vpos
> -dvpos
)
8755 int delta
= it2
.vpos
+ dvpos
;
8757 RESTORE_IT (&it2
, &it2
, it2data
);
8758 SAVE_IT (it2
, *it
, it2data
);
8759 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8760 /* Move back again if we got too far ahead. */
8761 if (IT_CHARPOS (*it
) >= start_charpos
)
8762 RESTORE_IT (it
, &it2
, it2data
);
8764 bidi_unshelve_cache (it2data
, 1);
8767 RESTORE_IT (it
, it
, it2data
);
8771 /* Return 1 if IT points into the middle of a display vector. */
8774 in_display_vector_p (struct it
*it
)
8776 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8777 && it
->current
.dpvec_index
> 0
8778 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8782 /***********************************************************************
8784 ***********************************************************************/
8787 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8791 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8793 Lisp_Object args
[3];
8794 Lisp_Object msg
, fmt
;
8797 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8800 /* Do nothing if called asynchronously. Inserting text into
8801 a buffer may call after-change-functions and alike and
8802 that would means running Lisp asynchronously. */
8803 if (handling_signal
)
8807 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8809 args
[0] = fmt
= build_string (format
);
8812 msg
= Fformat (3, args
);
8814 len
= SBYTES (msg
) + 1;
8815 SAFE_ALLOCA (buffer
, char *, len
);
8816 memcpy (buffer
, SDATA (msg
), len
);
8818 message_dolog (buffer
, len
- 1, 1, 0);
8825 /* Output a newline in the *Messages* buffer if "needs" one. */
8828 message_log_maybe_newline (void)
8830 if (message_log_need_newline
)
8831 message_dolog ("", 0, 1, 0);
8835 /* Add a string M of length NBYTES to the message log, optionally
8836 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8837 nonzero, means interpret the contents of M as multibyte. This
8838 function calls low-level routines in order to bypass text property
8839 hooks, etc. which might not be safe to run.
8841 This may GC (insert may run before/after change hooks),
8842 so the buffer M must NOT point to a Lisp string. */
8845 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
8847 const unsigned char *msg
= (const unsigned char *) m
;
8849 if (!NILP (Vmemory_full
))
8852 if (!NILP (Vmessage_log_max
))
8854 struct buffer
*oldbuf
;
8855 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8856 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8857 ptrdiff_t point_at_end
= 0;
8858 ptrdiff_t zv_at_end
= 0;
8859 Lisp_Object old_deactivate_mark
, tem
;
8860 struct gcpro gcpro1
;
8862 old_deactivate_mark
= Vdeactivate_mark
;
8863 oldbuf
= current_buffer
;
8864 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8865 BVAR (current_buffer
, undo_list
) = Qt
;
8867 oldpoint
= message_dolog_marker1
;
8868 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8869 oldbegv
= message_dolog_marker2
;
8870 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8871 oldzv
= message_dolog_marker3
;
8872 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8873 GCPRO1 (old_deactivate_mark
);
8881 BEGV_BYTE
= BEG_BYTE
;
8884 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8886 /* Insert the string--maybe converting multibyte to single byte
8887 or vice versa, so that all the text fits the buffer. */
8889 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8895 /* Convert a multibyte string to single-byte
8896 for the *Message* buffer. */
8897 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8899 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8900 work
[0] = (ASCII_CHAR_P (c
)
8902 : multibyte_char_to_unibyte (c
));
8903 insert_1_both (work
, 1, 1, 1, 0, 0);
8906 else if (! multibyte
8907 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8911 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8912 /* Convert a single-byte string to multibyte
8913 for the *Message* buffer. */
8914 for (i
= 0; i
< nbytes
; i
++)
8917 MAKE_CHAR_MULTIBYTE (c
);
8918 char_bytes
= CHAR_STRING (c
, str
);
8919 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8923 insert_1 (m
, nbytes
, 1, 0, 0);
8927 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8929 insert_1 ("\n", 1, 1, 0, 0);
8931 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8933 this_bol_byte
= PT_BYTE
;
8935 /* See if this line duplicates the previous one.
8936 If so, combine duplicates. */
8939 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8941 prev_bol_byte
= PT_BYTE
;
8943 dups
= message_log_check_duplicate (prev_bol_byte
,
8947 del_range_both (prev_bol
, prev_bol_byte
,
8948 this_bol
, this_bol_byte
, 0);
8951 char dupstr
[sizeof " [ times]"
8952 + INT_STRLEN_BOUND (printmax_t
)];
8955 /* If you change this format, don't forget to also
8956 change message_log_check_duplicate. */
8957 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8958 duplen
= strlen (dupstr
);
8959 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8960 insert_1 (dupstr
, duplen
, 1, 0, 1);
8965 /* If we have more than the desired maximum number of lines
8966 in the *Messages* buffer now, delete the oldest ones.
8967 This is safe because we don't have undo in this buffer. */
8969 if (NATNUMP (Vmessage_log_max
))
8971 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8972 -XFASTINT (Vmessage_log_max
) - 1, 0);
8973 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8976 BEGV
= XMARKER (oldbegv
)->charpos
;
8977 BEGV_BYTE
= marker_byte_position (oldbegv
);
8986 ZV
= XMARKER (oldzv
)->charpos
;
8987 ZV_BYTE
= marker_byte_position (oldzv
);
8991 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8993 /* We can't do Fgoto_char (oldpoint) because it will run some
8995 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8996 XMARKER (oldpoint
)->bytepos
);
8999 unchain_marker (XMARKER (oldpoint
));
9000 unchain_marker (XMARKER (oldbegv
));
9001 unchain_marker (XMARKER (oldzv
));
9003 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9004 set_buffer_internal (oldbuf
);
9006 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9007 message_log_need_newline
= !nlflag
;
9008 Vdeactivate_mark
= old_deactivate_mark
;
9013 /* We are at the end of the buffer after just having inserted a newline.
9014 (Note: We depend on the fact we won't be crossing the gap.)
9015 Check to see if the most recent message looks a lot like the previous one.
9016 Return 0 if different, 1 if the new one should just replace it, or a
9017 value N > 1 if we should also append " [N times]". */
9020 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9023 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9025 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9026 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9028 for (i
= 0; i
< len
; i
++)
9030 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9038 if (*p1
++ == ' ' && *p1
++ == '[')
9041 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9042 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9049 /* Display an echo area message M with a specified length of NBYTES
9050 bytes. The string may include null characters. If M is 0, clear
9051 out any existing message, and let the mini-buffer text show
9054 This may GC, so the buffer M must NOT point to a Lisp string. */
9057 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9059 /* First flush out any partial line written with print. */
9060 message_log_maybe_newline ();
9062 message_dolog (m
, nbytes
, 1, multibyte
);
9063 message2_nolog (m
, nbytes
, multibyte
);
9067 /* The non-logging counterpart of message2. */
9070 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9072 struct frame
*sf
= SELECTED_FRAME ();
9073 message_enable_multibyte
= multibyte
;
9075 if (FRAME_INITIAL_P (sf
))
9077 if (noninteractive_need_newline
)
9078 putc ('\n', stderr
);
9079 noninteractive_need_newline
= 0;
9081 fwrite (m
, nbytes
, 1, stderr
);
9082 if (cursor_in_echo_area
== 0)
9083 fprintf (stderr
, "\n");
9086 /* A null message buffer means that the frame hasn't really been
9087 initialized yet. Error messages get reported properly by
9088 cmd_error, so this must be just an informative message; toss it. */
9089 else if (INTERACTIVE
9090 && sf
->glyphs_initialized_p
9091 && FRAME_MESSAGE_BUF (sf
))
9093 Lisp_Object mini_window
;
9096 /* Get the frame containing the mini-buffer
9097 that the selected frame is using. */
9098 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9099 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9101 FRAME_SAMPLE_VISIBILITY (f
);
9102 if (FRAME_VISIBLE_P (sf
)
9103 && ! FRAME_VISIBLE_P (f
))
9104 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9108 set_message (m
, Qnil
, nbytes
, multibyte
);
9109 if (minibuffer_auto_raise
)
9110 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9113 clear_message (1, 1);
9115 do_pending_window_change (0);
9116 echo_area_display (1);
9117 do_pending_window_change (0);
9118 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9119 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9124 /* Display an echo area message M with a specified length of NBYTES
9125 bytes. The string may include null characters. If M is not a
9126 string, clear out any existing message, and let the mini-buffer
9129 This function cancels echoing. */
9132 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9134 struct gcpro gcpro1
;
9137 clear_message (1,1);
9140 /* First flush out any partial line written with print. */
9141 message_log_maybe_newline ();
9147 SAFE_ALLOCA (buffer
, char *, nbytes
);
9148 memcpy (buffer
, SDATA (m
), nbytes
);
9149 message_dolog (buffer
, nbytes
, 1, multibyte
);
9152 message3_nolog (m
, nbytes
, multibyte
);
9158 /* The non-logging version of message3.
9159 This does not cancel echoing, because it is used for echoing.
9160 Perhaps we need to make a separate function for echoing
9161 and make this cancel echoing. */
9164 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9166 struct frame
*sf
= SELECTED_FRAME ();
9167 message_enable_multibyte
= multibyte
;
9169 if (FRAME_INITIAL_P (sf
))
9171 if (noninteractive_need_newline
)
9172 putc ('\n', stderr
);
9173 noninteractive_need_newline
= 0;
9175 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9176 if (cursor_in_echo_area
== 0)
9177 fprintf (stderr
, "\n");
9180 /* A null message buffer means that the frame hasn't really been
9181 initialized yet. Error messages get reported properly by
9182 cmd_error, so this must be just an informative message; toss it. */
9183 else if (INTERACTIVE
9184 && sf
->glyphs_initialized_p
9185 && FRAME_MESSAGE_BUF (sf
))
9187 Lisp_Object mini_window
;
9191 /* Get the frame containing the mini-buffer
9192 that the selected frame is using. */
9193 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9194 frame
= XWINDOW (mini_window
)->frame
;
9197 FRAME_SAMPLE_VISIBILITY (f
);
9198 if (FRAME_VISIBLE_P (sf
)
9199 && !FRAME_VISIBLE_P (f
))
9200 Fmake_frame_visible (frame
);
9202 if (STRINGP (m
) && SCHARS (m
) > 0)
9204 set_message (NULL
, m
, nbytes
, multibyte
);
9205 if (minibuffer_auto_raise
)
9206 Fraise_frame (frame
);
9207 /* Assume we are not echoing.
9208 (If we are, echo_now will override this.) */
9209 echo_message_buffer
= Qnil
;
9212 clear_message (1, 1);
9214 do_pending_window_change (0);
9215 echo_area_display (1);
9216 do_pending_window_change (0);
9217 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9218 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9223 /* Display a null-terminated echo area message M. If M is 0, clear
9224 out any existing message, and let the mini-buffer text show through.
9226 The buffer M must continue to exist until after the echo area gets
9227 cleared or some other message gets displayed there. Do not pass
9228 text that is stored in a Lisp string. Do not pass text in a buffer
9229 that was alloca'd. */
9232 message1 (const char *m
)
9234 message2 (m
, (m
? strlen (m
) : 0), 0);
9238 /* The non-logging counterpart of message1. */
9241 message1_nolog (const char *m
)
9243 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9246 /* Display a message M which contains a single %s
9247 which gets replaced with STRING. */
9250 message_with_string (const char *m
, Lisp_Object string
, int log
)
9252 CHECK_STRING (string
);
9258 if (noninteractive_need_newline
)
9259 putc ('\n', stderr
);
9260 noninteractive_need_newline
= 0;
9261 fprintf (stderr
, m
, SDATA (string
));
9262 if (!cursor_in_echo_area
)
9263 fprintf (stderr
, "\n");
9267 else if (INTERACTIVE
)
9269 /* The frame whose minibuffer we're going to display the message on.
9270 It may be larger than the selected frame, so we need
9271 to use its buffer, not the selected frame's buffer. */
9272 Lisp_Object mini_window
;
9273 struct frame
*f
, *sf
= SELECTED_FRAME ();
9275 /* Get the frame containing the minibuffer
9276 that the selected frame is using. */
9277 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9278 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9280 /* A null message buffer means that the frame hasn't really been
9281 initialized yet. Error messages get reported properly by
9282 cmd_error, so this must be just an informative message; toss it. */
9283 if (FRAME_MESSAGE_BUF (f
))
9285 Lisp_Object args
[2], msg
;
9286 struct gcpro gcpro1
, gcpro2
;
9288 args
[0] = build_string (m
);
9289 args
[1] = msg
= string
;
9290 GCPRO2 (args
[0], msg
);
9293 msg
= Fformat (2, args
);
9296 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9298 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9302 /* Print should start at the beginning of the message
9303 buffer next time. */
9304 message_buf_print
= 0;
9310 /* Dump an informative message to the minibuf. If M is 0, clear out
9311 any existing message, and let the mini-buffer text show through. */
9314 vmessage (const char *m
, va_list ap
)
9320 if (noninteractive_need_newline
)
9321 putc ('\n', stderr
);
9322 noninteractive_need_newline
= 0;
9323 vfprintf (stderr
, m
, ap
);
9324 if (cursor_in_echo_area
== 0)
9325 fprintf (stderr
, "\n");
9329 else if (INTERACTIVE
)
9331 /* The frame whose mini-buffer we're going to display the message
9332 on. It may be larger than the selected frame, so we need to
9333 use its buffer, not the selected frame's buffer. */
9334 Lisp_Object mini_window
;
9335 struct frame
*f
, *sf
= SELECTED_FRAME ();
9337 /* Get the frame containing the mini-buffer
9338 that the selected frame is using. */
9339 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9340 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9342 /* A null message buffer means that the frame hasn't really been
9343 initialized yet. Error messages get reported properly by
9344 cmd_error, so this must be just an informative message; toss
9346 if (FRAME_MESSAGE_BUF (f
))
9352 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9353 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9355 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9360 /* Print should start at the beginning of the message
9361 buffer next time. */
9362 message_buf_print
= 0;
9368 message (const char *m
, ...)
9378 /* The non-logging version of message. */
9381 message_nolog (const char *m
, ...)
9383 Lisp_Object old_log_max
;
9386 old_log_max
= Vmessage_log_max
;
9387 Vmessage_log_max
= Qnil
;
9389 Vmessage_log_max
= old_log_max
;
9395 /* Display the current message in the current mini-buffer. This is
9396 only called from error handlers in process.c, and is not time
9400 update_echo_area (void)
9402 if (!NILP (echo_area_buffer
[0]))
9405 string
= Fcurrent_message ();
9406 message3 (string
, SBYTES (string
),
9407 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9412 /* Make sure echo area buffers in `echo_buffers' are live.
9413 If they aren't, make new ones. */
9416 ensure_echo_area_buffers (void)
9420 for (i
= 0; i
< 2; ++i
)
9421 if (!BUFFERP (echo_buffer
[i
])
9422 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9425 Lisp_Object old_buffer
;
9428 old_buffer
= echo_buffer
[i
];
9429 sprintf (name
, " *Echo Area %d*", i
);
9430 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9431 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9432 /* to force word wrap in echo area -
9433 it was decided to postpone this*/
9434 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9436 for (j
= 0; j
< 2; ++j
)
9437 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9438 echo_area_buffer
[j
] = echo_buffer
[i
];
9443 /* Call FN with args A1..A4 with either the current or last displayed
9444 echo_area_buffer as current buffer.
9446 WHICH zero means use the current message buffer
9447 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9448 from echo_buffer[] and clear it.
9450 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9451 suitable buffer from echo_buffer[] and clear it.
9453 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9454 that the current message becomes the last displayed one, make
9455 choose a suitable buffer for echo_area_buffer[0], and clear it.
9457 Value is what FN returns. */
9460 with_echo_area_buffer (struct window
*w
, int which
,
9461 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9462 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9465 int this_one
, the_other
, clear_buffer_p
, rc
;
9466 ptrdiff_t count
= SPECPDL_INDEX ();
9468 /* If buffers aren't live, make new ones. */
9469 ensure_echo_area_buffers ();
9474 this_one
= 0, the_other
= 1;
9476 this_one
= 1, the_other
= 0;
9479 this_one
= 0, the_other
= 1;
9482 /* We need a fresh one in case the current echo buffer equals
9483 the one containing the last displayed echo area message. */
9484 if (!NILP (echo_area_buffer
[this_one
])
9485 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9486 echo_area_buffer
[this_one
] = Qnil
;
9489 /* Choose a suitable buffer from echo_buffer[] is we don't
9491 if (NILP (echo_area_buffer
[this_one
]))
9493 echo_area_buffer
[this_one
]
9494 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9495 ? echo_buffer
[the_other
]
9496 : echo_buffer
[this_one
]);
9500 buffer
= echo_area_buffer
[this_one
];
9502 /* Don't get confused by reusing the buffer used for echoing
9503 for a different purpose. */
9504 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9507 record_unwind_protect (unwind_with_echo_area_buffer
,
9508 with_echo_area_buffer_unwind_data (w
));
9510 /* Make the echo area buffer current. Note that for display
9511 purposes, it is not necessary that the displayed window's buffer
9512 == current_buffer, except for text property lookup. So, let's
9513 only set that buffer temporarily here without doing a full
9514 Fset_window_buffer. We must also change w->pointm, though,
9515 because otherwise an assertions in unshow_buffer fails, and Emacs
9517 set_buffer_internal_1 (XBUFFER (buffer
));
9521 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9524 BVAR (current_buffer
, undo_list
) = Qt
;
9525 BVAR (current_buffer
, read_only
) = Qnil
;
9526 specbind (Qinhibit_read_only
, Qt
);
9527 specbind (Qinhibit_modification_hooks
, Qt
);
9529 if (clear_buffer_p
&& Z
> BEG
)
9532 xassert (BEGV
>= BEG
);
9533 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9535 rc
= fn (a1
, a2
, a3
, a4
);
9537 xassert (BEGV
>= BEG
);
9538 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9540 unbind_to (count
, Qnil
);
9545 /* Save state that should be preserved around the call to the function
9546 FN called in with_echo_area_buffer. */
9549 with_echo_area_buffer_unwind_data (struct window
*w
)
9552 Lisp_Object vector
, tmp
;
9554 /* Reduce consing by keeping one vector in
9555 Vwith_echo_area_save_vector. */
9556 vector
= Vwith_echo_area_save_vector
;
9557 Vwith_echo_area_save_vector
= Qnil
;
9560 vector
= Fmake_vector (make_number (7), Qnil
);
9562 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9563 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9564 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9568 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9569 ASET (vector
, i
, w
->buffer
); ++i
;
9570 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9571 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9576 for (; i
< end
; ++i
)
9577 ASET (vector
, i
, Qnil
);
9580 xassert (i
== ASIZE (vector
));
9585 /* Restore global state from VECTOR which was created by
9586 with_echo_area_buffer_unwind_data. */
9589 unwind_with_echo_area_buffer (Lisp_Object vector
)
9591 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9592 Vdeactivate_mark
= AREF (vector
, 1);
9593 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9595 if (WINDOWP (AREF (vector
, 3)))
9598 Lisp_Object buffer
, charpos
, bytepos
;
9600 w
= XWINDOW (AREF (vector
, 3));
9601 buffer
= AREF (vector
, 4);
9602 charpos
= AREF (vector
, 5);
9603 bytepos
= AREF (vector
, 6);
9606 set_marker_both (w
->pointm
, buffer
,
9607 XFASTINT (charpos
), XFASTINT (bytepos
));
9610 Vwith_echo_area_save_vector
= vector
;
9615 /* Set up the echo area for use by print functions. MULTIBYTE_P
9616 non-zero means we will print multibyte. */
9619 setup_echo_area_for_printing (int multibyte_p
)
9621 /* If we can't find an echo area any more, exit. */
9622 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9625 ensure_echo_area_buffers ();
9627 if (!message_buf_print
)
9629 /* A message has been output since the last time we printed.
9630 Choose a fresh echo area buffer. */
9631 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9632 echo_area_buffer
[0] = echo_buffer
[1];
9634 echo_area_buffer
[0] = echo_buffer
[0];
9636 /* Switch to that buffer and clear it. */
9637 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9638 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9642 ptrdiff_t count
= SPECPDL_INDEX ();
9643 specbind (Qinhibit_read_only
, Qt
);
9644 /* Note that undo recording is always disabled. */
9646 unbind_to (count
, Qnil
);
9648 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9650 /* Set up the buffer for the multibyteness we need. */
9652 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9653 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9655 /* Raise the frame containing the echo area. */
9656 if (minibuffer_auto_raise
)
9658 struct frame
*sf
= SELECTED_FRAME ();
9659 Lisp_Object mini_window
;
9660 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9661 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9664 message_log_maybe_newline ();
9665 message_buf_print
= 1;
9669 if (NILP (echo_area_buffer
[0]))
9671 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9672 echo_area_buffer
[0] = echo_buffer
[1];
9674 echo_area_buffer
[0] = echo_buffer
[0];
9677 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9679 /* Someone switched buffers between print requests. */
9680 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9681 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9687 /* Display an echo area message in window W. Value is non-zero if W's
9688 height is changed. If display_last_displayed_message_p is
9689 non-zero, display the message that was last displayed, otherwise
9690 display the current message. */
9693 display_echo_area (struct window
*w
)
9695 int i
, no_message_p
, window_height_changed_p
;
9697 /* Temporarily disable garbage collections while displaying the echo
9698 area. This is done because a GC can print a message itself.
9699 That message would modify the echo area buffer's contents while a
9700 redisplay of the buffer is going on, and seriously confuse
9702 ptrdiff_t count
= inhibit_garbage_collection ();
9704 /* If there is no message, we must call display_echo_area_1
9705 nevertheless because it resizes the window. But we will have to
9706 reset the echo_area_buffer in question to nil at the end because
9707 with_echo_area_buffer will sets it to an empty buffer. */
9708 i
= display_last_displayed_message_p
? 1 : 0;
9709 no_message_p
= NILP (echo_area_buffer
[i
]);
9711 window_height_changed_p
9712 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9713 display_echo_area_1
,
9714 (intptr_t) w
, Qnil
, 0, 0);
9717 echo_area_buffer
[i
] = Qnil
;
9719 unbind_to (count
, Qnil
);
9720 return window_height_changed_p
;
9724 /* Helper for display_echo_area. Display the current buffer which
9725 contains the current echo area message in window W, a mini-window,
9726 a pointer to which is passed in A1. A2..A4 are currently not used.
9727 Change the height of W so that all of the message is displayed.
9728 Value is non-zero if height of W was changed. */
9731 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9734 struct window
*w
= (struct window
*) i1
;
9736 struct text_pos start
;
9737 int window_height_changed_p
= 0;
9739 /* Do this before displaying, so that we have a large enough glyph
9740 matrix for the display. If we can't get enough space for the
9741 whole text, display the last N lines. That works by setting w->start. */
9742 window_height_changed_p
= resize_mini_window (w
, 0);
9744 /* Use the starting position chosen by resize_mini_window. */
9745 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9748 clear_glyph_matrix (w
->desired_matrix
);
9749 XSETWINDOW (window
, w
);
9750 try_window (window
, start
, 0);
9752 return window_height_changed_p
;
9756 /* Resize the echo area window to exactly the size needed for the
9757 currently displayed message, if there is one. If a mini-buffer
9758 is active, don't shrink it. */
9761 resize_echo_area_exactly (void)
9763 if (BUFFERP (echo_area_buffer
[0])
9764 && WINDOWP (echo_area_window
))
9766 struct window
*w
= XWINDOW (echo_area_window
);
9768 Lisp_Object resize_exactly
;
9770 if (minibuf_level
== 0)
9771 resize_exactly
= Qt
;
9773 resize_exactly
= Qnil
;
9775 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9776 (intptr_t) w
, resize_exactly
,
9780 ++windows_or_buffers_changed
;
9781 ++update_mode_lines
;
9782 redisplay_internal ();
9788 /* Callback function for with_echo_area_buffer, when used from
9789 resize_echo_area_exactly. A1 contains a pointer to the window to
9790 resize, EXACTLY non-nil means resize the mini-window exactly to the
9791 size of the text displayed. A3 and A4 are not used. Value is what
9792 resize_mini_window returns. */
9795 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
9798 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9802 /* Resize mini-window W to fit the size of its contents. EXACT_P
9803 means size the window exactly to the size needed. Otherwise, it's
9804 only enlarged until W's buffer is empty.
9806 Set W->start to the right place to begin display. If the whole
9807 contents fit, start at the beginning. Otherwise, start so as
9808 to make the end of the contents appear. This is particularly
9809 important for y-or-n-p, but seems desirable generally.
9811 Value is non-zero if the window height has been changed. */
9814 resize_mini_window (struct window
*w
, int exact_p
)
9816 struct frame
*f
= XFRAME (w
->frame
);
9817 int window_height_changed_p
= 0;
9819 xassert (MINI_WINDOW_P (w
));
9821 /* By default, start display at the beginning. */
9822 set_marker_both (w
->start
, w
->buffer
,
9823 BUF_BEGV (XBUFFER (w
->buffer
)),
9824 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9826 /* Don't resize windows while redisplaying a window; it would
9827 confuse redisplay functions when the size of the window they are
9828 displaying changes from under them. Such a resizing can happen,
9829 for instance, when which-func prints a long message while
9830 we are running fontification-functions. We're running these
9831 functions with safe_call which binds inhibit-redisplay to t. */
9832 if (!NILP (Vinhibit_redisplay
))
9835 /* Nil means don't try to resize. */
9836 if (NILP (Vresize_mini_windows
)
9837 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9840 if (!FRAME_MINIBUF_ONLY_P (f
))
9843 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9844 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9846 EMACS_INT max_height
;
9847 int unit
= FRAME_LINE_HEIGHT (f
);
9848 struct text_pos start
;
9849 struct buffer
*old_current_buffer
= NULL
;
9851 if (current_buffer
!= XBUFFER (w
->buffer
))
9853 old_current_buffer
= current_buffer
;
9854 set_buffer_internal (XBUFFER (w
->buffer
));
9857 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9859 /* Compute the max. number of lines specified by the user. */
9860 if (FLOATP (Vmax_mini_window_height
))
9861 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9862 else if (INTEGERP (Vmax_mini_window_height
))
9863 max_height
= XINT (Vmax_mini_window_height
);
9865 max_height
= total_height
/ 4;
9867 /* Correct that max. height if it's bogus. */
9868 max_height
= max (1, max_height
);
9869 max_height
= min (total_height
, max_height
);
9871 /* Find out the height of the text in the window. */
9872 if (it
.line_wrap
== TRUNCATE
)
9877 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9878 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9879 height
= it
.current_y
+ last_height
;
9881 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9882 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9883 height
= (height
+ unit
- 1) / unit
;
9886 /* Compute a suitable window start. */
9887 if (height
> max_height
)
9889 height
= max_height
;
9890 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9891 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9892 start
= it
.current
.pos
;
9895 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9896 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9898 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9900 /* Let it grow only, until we display an empty message, in which
9901 case the window shrinks again. */
9902 if (height
> WINDOW_TOTAL_LINES (w
))
9904 int old_height
= WINDOW_TOTAL_LINES (w
);
9905 freeze_window_starts (f
, 1);
9906 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9907 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9909 else if (height
< WINDOW_TOTAL_LINES (w
)
9910 && (exact_p
|| BEGV
== ZV
))
9912 int old_height
= WINDOW_TOTAL_LINES (w
);
9913 freeze_window_starts (f
, 0);
9914 shrink_mini_window (w
);
9915 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9920 /* Always resize to exact size needed. */
9921 if (height
> WINDOW_TOTAL_LINES (w
))
9923 int old_height
= WINDOW_TOTAL_LINES (w
);
9924 freeze_window_starts (f
, 1);
9925 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9926 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9928 else if (height
< WINDOW_TOTAL_LINES (w
))
9930 int old_height
= WINDOW_TOTAL_LINES (w
);
9931 freeze_window_starts (f
, 0);
9932 shrink_mini_window (w
);
9936 freeze_window_starts (f
, 1);
9937 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9940 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9944 if (old_current_buffer
)
9945 set_buffer_internal (old_current_buffer
);
9948 return window_height_changed_p
;
9952 /* Value is the current message, a string, or nil if there is no
9956 current_message (void)
9960 if (!BUFFERP (echo_area_buffer
[0]))
9964 with_echo_area_buffer (0, 0, current_message_1
,
9965 (intptr_t) &msg
, Qnil
, 0, 0);
9967 echo_area_buffer
[0] = Qnil
;
9975 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9978 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9981 *msg
= make_buffer_string (BEG
, Z
, 1);
9988 /* Push the current message on Vmessage_stack for later restauration
9989 by restore_message. Value is non-zero if the current message isn't
9990 empty. This is a relatively infrequent operation, so it's not
9991 worth optimizing. */
9997 msg
= current_message ();
9998 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9999 return STRINGP (msg
);
10003 /* Restore message display from the top of Vmessage_stack. */
10006 restore_message (void)
10010 xassert (CONSP (Vmessage_stack
));
10011 msg
= XCAR (Vmessage_stack
);
10013 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10015 message3_nolog (msg
, 0, 0);
10019 /* Handler for record_unwind_protect calling pop_message. */
10022 pop_message_unwind (Lisp_Object dummy
)
10028 /* Pop the top-most entry off Vmessage_stack. */
10033 xassert (CONSP (Vmessage_stack
));
10034 Vmessage_stack
= XCDR (Vmessage_stack
);
10038 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10039 exits. If the stack is not empty, we have a missing pop_message
10043 check_message_stack (void)
10045 if (!NILP (Vmessage_stack
))
10050 /* Truncate to NCHARS what will be displayed in the echo area the next
10051 time we display it---but don't redisplay it now. */
10054 truncate_echo_area (ptrdiff_t nchars
)
10057 echo_area_buffer
[0] = Qnil
;
10058 /* A null message buffer means that the frame hasn't really been
10059 initialized yet. Error messages get reported properly by
10060 cmd_error, so this must be just an informative message; toss it. */
10061 else if (!noninteractive
10063 && !NILP (echo_area_buffer
[0]))
10065 struct frame
*sf
= SELECTED_FRAME ();
10066 if (FRAME_MESSAGE_BUF (sf
))
10067 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10072 /* Helper function for truncate_echo_area. Truncate the current
10073 message to at most NCHARS characters. */
10076 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10078 if (BEG
+ nchars
< Z
)
10079 del_range (BEG
+ nchars
, Z
);
10081 echo_area_buffer
[0] = Qnil
;
10086 /* Set the current message to a substring of S or STRING.
10088 If STRING is a Lisp string, set the message to the first NBYTES
10089 bytes from STRING. NBYTES zero means use the whole string. If
10090 STRING is multibyte, the message will be displayed multibyte.
10092 If S is not null, set the message to the first LEN bytes of S. LEN
10093 zero means use the whole string. MULTIBYTE_P non-zero means S is
10094 multibyte. Display the message multibyte in that case.
10096 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10097 to t before calling set_message_1 (which calls insert).
10101 set_message (const char *s
, Lisp_Object string
,
10102 ptrdiff_t nbytes
, int multibyte_p
)
10104 message_enable_multibyte
10105 = ((s
&& multibyte_p
)
10106 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10108 with_echo_area_buffer (0, -1, set_message_1
,
10109 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10110 message_buf_print
= 0;
10111 help_echo_showing_p
= 0;
10115 /* Helper function for set_message. Arguments have the same meaning
10116 as there, with A1 corresponding to S and A2 corresponding to STRING
10117 This function is called with the echo area buffer being
10121 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10124 const char *s
= (const char *) i1
;
10125 const unsigned char *msg
= (const unsigned char *) s
;
10126 Lisp_Object string
= a2
;
10128 /* Change multibyteness of the echo buffer appropriately. */
10129 if (message_enable_multibyte
10130 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10131 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10133 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10134 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10135 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10137 /* Insert new message at BEG. */
10138 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10140 if (STRINGP (string
))
10145 nbytes
= SBYTES (string
);
10146 nchars
= string_byte_to_char (string
, nbytes
);
10148 /* This function takes care of single/multibyte conversion. We
10149 just have to ensure that the echo area buffer has the right
10150 setting of enable_multibyte_characters. */
10151 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10156 nbytes
= strlen (s
);
10158 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10160 /* Convert from multi-byte to single-byte. */
10165 /* Convert a multibyte string to single-byte. */
10166 for (i
= 0; i
< nbytes
; i
+= n
)
10168 c
= string_char_and_length (msg
+ i
, &n
);
10169 work
[0] = (ASCII_CHAR_P (c
)
10171 : multibyte_char_to_unibyte (c
));
10172 insert_1_both (work
, 1, 1, 1, 0, 0);
10175 else if (!multibyte_p
10176 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10178 /* Convert from single-byte to multi-byte. */
10181 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10183 /* Convert a single-byte string to multibyte. */
10184 for (i
= 0; i
< nbytes
; i
++)
10187 MAKE_CHAR_MULTIBYTE (c
);
10188 n
= CHAR_STRING (c
, str
);
10189 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10193 insert_1 (s
, nbytes
, 1, 0, 0);
10200 /* Clear messages. CURRENT_P non-zero means clear the current
10201 message. LAST_DISPLAYED_P non-zero means clear the message
10205 clear_message (int current_p
, int last_displayed_p
)
10209 echo_area_buffer
[0] = Qnil
;
10210 message_cleared_p
= 1;
10213 if (last_displayed_p
)
10214 echo_area_buffer
[1] = Qnil
;
10216 message_buf_print
= 0;
10219 /* Clear garbaged frames.
10221 This function is used where the old redisplay called
10222 redraw_garbaged_frames which in turn called redraw_frame which in
10223 turn called clear_frame. The call to clear_frame was a source of
10224 flickering. I believe a clear_frame is not necessary. It should
10225 suffice in the new redisplay to invalidate all current matrices,
10226 and ensure a complete redisplay of all windows. */
10229 clear_garbaged_frames (void)
10231 if (frame_garbaged
)
10233 Lisp_Object tail
, frame
;
10234 int changed_count
= 0;
10236 FOR_EACH_FRAME (tail
, frame
)
10238 struct frame
*f
= XFRAME (frame
);
10240 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10244 Fredraw_frame (frame
);
10245 f
->force_flush_display_p
= 1;
10247 clear_current_matrices (f
);
10254 frame_garbaged
= 0;
10256 ++windows_or_buffers_changed
;
10261 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10262 is non-zero update selected_frame. Value is non-zero if the
10263 mini-windows height has been changed. */
10266 echo_area_display (int update_frame_p
)
10268 Lisp_Object mini_window
;
10271 int window_height_changed_p
= 0;
10272 struct frame
*sf
= SELECTED_FRAME ();
10274 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10275 w
= XWINDOW (mini_window
);
10276 f
= XFRAME (WINDOW_FRAME (w
));
10278 /* Don't display if frame is invisible or not yet initialized. */
10279 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10282 #ifdef HAVE_WINDOW_SYSTEM
10283 /* When Emacs starts, selected_frame may be the initial terminal
10284 frame. If we let this through, a message would be displayed on
10286 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10288 #endif /* HAVE_WINDOW_SYSTEM */
10290 /* Redraw garbaged frames. */
10291 if (frame_garbaged
)
10292 clear_garbaged_frames ();
10294 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10296 echo_area_window
= mini_window
;
10297 window_height_changed_p
= display_echo_area (w
);
10298 w
->must_be_updated_p
= 1;
10300 /* Update the display, unless called from redisplay_internal.
10301 Also don't update the screen during redisplay itself. The
10302 update will happen at the end of redisplay, and an update
10303 here could cause confusion. */
10304 if (update_frame_p
&& !redisplaying_p
)
10308 /* If the display update has been interrupted by pending
10309 input, update mode lines in the frame. Due to the
10310 pending input, it might have been that redisplay hasn't
10311 been called, so that mode lines above the echo area are
10312 garbaged. This looks odd, so we prevent it here. */
10313 if (!display_completed
)
10314 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10316 if (window_height_changed_p
10317 /* Don't do this if Emacs is shutting down. Redisplay
10318 needs to run hooks. */
10319 && !NILP (Vrun_hooks
))
10321 /* Must update other windows. Likewise as in other
10322 cases, don't let this update be interrupted by
10324 ptrdiff_t count
= SPECPDL_INDEX ();
10325 specbind (Qredisplay_dont_pause
, Qt
);
10326 windows_or_buffers_changed
= 1;
10327 redisplay_internal ();
10328 unbind_to (count
, Qnil
);
10330 else if (FRAME_WINDOW_P (f
) && n
== 0)
10332 /* Window configuration is the same as before.
10333 Can do with a display update of the echo area,
10334 unless we displayed some mode lines. */
10335 update_single_window (w
, 1);
10336 FRAME_RIF (f
)->flush_display (f
);
10339 update_frame (f
, 1, 1);
10341 /* If cursor is in the echo area, make sure that the next
10342 redisplay displays the minibuffer, so that the cursor will
10343 be replaced with what the minibuffer wants. */
10344 if (cursor_in_echo_area
)
10345 ++windows_or_buffers_changed
;
10348 else if (!EQ (mini_window
, selected_window
))
10349 windows_or_buffers_changed
++;
10351 /* Last displayed message is now the current message. */
10352 echo_area_buffer
[1] = echo_area_buffer
[0];
10353 /* Inform read_char that we're not echoing. */
10354 echo_message_buffer
= Qnil
;
10356 /* Prevent redisplay optimization in redisplay_internal by resetting
10357 this_line_start_pos. This is done because the mini-buffer now
10358 displays the message instead of its buffer text. */
10359 if (EQ (mini_window
, selected_window
))
10360 CHARPOS (this_line_start_pos
) = 0;
10362 return window_height_changed_p
;
10367 /***********************************************************************
10368 Mode Lines and Frame Titles
10369 ***********************************************************************/
10371 /* A buffer for constructing non-propertized mode-line strings and
10372 frame titles in it; allocated from the heap in init_xdisp and
10373 resized as needed in store_mode_line_noprop_char. */
10375 static char *mode_line_noprop_buf
;
10377 /* The buffer's end, and a current output position in it. */
10379 static char *mode_line_noprop_buf_end
;
10380 static char *mode_line_noprop_ptr
;
10382 #define MODE_LINE_NOPROP_LEN(start) \
10383 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10386 MODE_LINE_DISPLAY
= 0,
10390 } mode_line_target
;
10392 /* Alist that caches the results of :propertize.
10393 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10394 static Lisp_Object mode_line_proptrans_alist
;
10396 /* List of strings making up the mode-line. */
10397 static Lisp_Object mode_line_string_list
;
10399 /* Base face property when building propertized mode line string. */
10400 static Lisp_Object mode_line_string_face
;
10401 static Lisp_Object mode_line_string_face_prop
;
10404 /* Unwind data for mode line strings */
10406 static Lisp_Object Vmode_line_unwind_vector
;
10409 format_mode_line_unwind_data (struct buffer
*obuf
,
10411 int save_proptrans
)
10413 Lisp_Object vector
, tmp
;
10415 /* Reduce consing by keeping one vector in
10416 Vwith_echo_area_save_vector. */
10417 vector
= Vmode_line_unwind_vector
;
10418 Vmode_line_unwind_vector
= Qnil
;
10421 vector
= Fmake_vector (make_number (8), Qnil
);
10423 ASET (vector
, 0, make_number (mode_line_target
));
10424 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10425 ASET (vector
, 2, mode_line_string_list
);
10426 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10427 ASET (vector
, 4, mode_line_string_face
);
10428 ASET (vector
, 5, mode_line_string_face_prop
);
10431 XSETBUFFER (tmp
, obuf
);
10434 ASET (vector
, 6, tmp
);
10435 ASET (vector
, 7, owin
);
10441 unwind_format_mode_line (Lisp_Object vector
)
10443 mode_line_target
= XINT (AREF (vector
, 0));
10444 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10445 mode_line_string_list
= AREF (vector
, 2);
10446 if (! EQ (AREF (vector
, 3), Qt
))
10447 mode_line_proptrans_alist
= AREF (vector
, 3);
10448 mode_line_string_face
= AREF (vector
, 4);
10449 mode_line_string_face_prop
= AREF (vector
, 5);
10451 if (!NILP (AREF (vector
, 7)))
10452 /* Select window before buffer, since it may change the buffer. */
10453 Fselect_window (AREF (vector
, 7), Qt
);
10455 if (!NILP (AREF (vector
, 6)))
10457 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10458 ASET (vector
, 6, Qnil
);
10461 Vmode_line_unwind_vector
= vector
;
10466 /* Store a single character C for the frame title in mode_line_noprop_buf.
10467 Re-allocate mode_line_noprop_buf if necessary. */
10470 store_mode_line_noprop_char (char c
)
10472 /* If output position has reached the end of the allocated buffer,
10473 increase the buffer's size. */
10474 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10476 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10477 ptrdiff_t size
= len
;
10478 mode_line_noprop_buf
=
10479 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10480 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10481 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10484 *mode_line_noprop_ptr
++ = c
;
10488 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10489 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10490 characters that yield more columns than PRECISION; PRECISION <= 0
10491 means copy the whole string. Pad with spaces until FIELD_WIDTH
10492 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10493 pad. Called from display_mode_element when it is used to build a
10497 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10499 const unsigned char *str
= (const unsigned char *) string
;
10501 ptrdiff_t dummy
, nbytes
;
10503 /* Copy at most PRECISION chars from STR. */
10504 nbytes
= strlen (string
);
10505 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10507 store_mode_line_noprop_char (*str
++);
10509 /* Fill up with spaces until FIELD_WIDTH reached. */
10510 while (field_width
> 0
10511 && n
< field_width
)
10513 store_mode_line_noprop_char (' ');
10520 /***********************************************************************
10522 ***********************************************************************/
10524 #ifdef HAVE_WINDOW_SYSTEM
10526 /* Set the title of FRAME, if it has changed. The title format is
10527 Vicon_title_format if FRAME is iconified, otherwise it is
10528 frame_title_format. */
10531 x_consider_frame_title (Lisp_Object frame
)
10533 struct frame
*f
= XFRAME (frame
);
10535 if (FRAME_WINDOW_P (f
)
10536 || FRAME_MINIBUF_ONLY_P (f
)
10537 || f
->explicit_name
)
10539 /* Do we have more than one visible frame on this X display? */
10542 ptrdiff_t title_start
;
10546 ptrdiff_t count
= SPECPDL_INDEX ();
10548 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10550 Lisp_Object other_frame
= XCAR (tail
);
10551 struct frame
*tf
= XFRAME (other_frame
);
10554 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10555 && !FRAME_MINIBUF_ONLY_P (tf
)
10556 && !EQ (other_frame
, tip_frame
)
10557 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10561 /* Set global variable indicating that multiple frames exist. */
10562 multiple_frames
= CONSP (tail
);
10564 /* Switch to the buffer of selected window of the frame. Set up
10565 mode_line_target so that display_mode_element will output into
10566 mode_line_noprop_buf; then display the title. */
10567 record_unwind_protect (unwind_format_mode_line
,
10568 format_mode_line_unwind_data
10569 (current_buffer
, selected_window
, 0));
10571 Fselect_window (f
->selected_window
, Qt
);
10572 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10573 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10575 mode_line_target
= MODE_LINE_TITLE
;
10576 title_start
= MODE_LINE_NOPROP_LEN (0);
10577 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10578 NULL
, DEFAULT_FACE_ID
);
10579 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10580 len
= MODE_LINE_NOPROP_LEN (title_start
);
10581 title
= mode_line_noprop_buf
+ title_start
;
10582 unbind_to (count
, Qnil
);
10584 /* Set the title only if it's changed. This avoids consing in
10585 the common case where it hasn't. (If it turns out that we've
10586 already wasted too much time by walking through the list with
10587 display_mode_element, then we might need to optimize at a
10588 higher level than this.) */
10589 if (! STRINGP (f
->name
)
10590 || SBYTES (f
->name
) != len
10591 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10592 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10596 #endif /* not HAVE_WINDOW_SYSTEM */
10601 /***********************************************************************
10603 ***********************************************************************/
10606 /* Prepare for redisplay by updating menu-bar item lists when
10607 appropriate. This can call eval. */
10610 prepare_menu_bars (void)
10613 struct gcpro gcpro1
, gcpro2
;
10615 Lisp_Object tooltip_frame
;
10617 #ifdef HAVE_WINDOW_SYSTEM
10618 tooltip_frame
= tip_frame
;
10620 tooltip_frame
= Qnil
;
10623 /* Update all frame titles based on their buffer names, etc. We do
10624 this before the menu bars so that the buffer-menu will show the
10625 up-to-date frame titles. */
10626 #ifdef HAVE_WINDOW_SYSTEM
10627 if (windows_or_buffers_changed
|| update_mode_lines
)
10629 Lisp_Object tail
, frame
;
10631 FOR_EACH_FRAME (tail
, frame
)
10633 f
= XFRAME (frame
);
10634 if (!EQ (frame
, tooltip_frame
)
10635 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10636 x_consider_frame_title (frame
);
10639 #endif /* HAVE_WINDOW_SYSTEM */
10641 /* Update the menu bar item lists, if appropriate. This has to be
10642 done before any actual redisplay or generation of display lines. */
10643 all_windows
= (update_mode_lines
10644 || buffer_shared
> 1
10645 || windows_or_buffers_changed
);
10648 Lisp_Object tail
, frame
;
10649 ptrdiff_t count
= SPECPDL_INDEX ();
10650 /* 1 means that update_menu_bar has run its hooks
10651 so any further calls to update_menu_bar shouldn't do so again. */
10652 int menu_bar_hooks_run
= 0;
10654 record_unwind_save_match_data ();
10656 FOR_EACH_FRAME (tail
, frame
)
10658 f
= XFRAME (frame
);
10660 /* Ignore tooltip frame. */
10661 if (EQ (frame
, tooltip_frame
))
10664 /* If a window on this frame changed size, report that to
10665 the user and clear the size-change flag. */
10666 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10668 Lisp_Object functions
;
10670 /* Clear flag first in case we get an error below. */
10671 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10672 functions
= Vwindow_size_change_functions
;
10673 GCPRO2 (tail
, functions
);
10675 while (CONSP (functions
))
10677 if (!EQ (XCAR (functions
), Qt
))
10678 call1 (XCAR (functions
), frame
);
10679 functions
= XCDR (functions
);
10685 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10686 #ifdef HAVE_WINDOW_SYSTEM
10687 update_tool_bar (f
, 0);
10690 if (windows_or_buffers_changed
10692 ns_set_doc_edited (f
, Fbuffer_modified_p
10693 (XWINDOW (f
->selected_window
)->buffer
));
10698 unbind_to (count
, Qnil
);
10702 struct frame
*sf
= SELECTED_FRAME ();
10703 update_menu_bar (sf
, 1, 0);
10704 #ifdef HAVE_WINDOW_SYSTEM
10705 update_tool_bar (sf
, 1);
10711 /* Update the menu bar item list for frame F. This has to be done
10712 before we start to fill in any display lines, because it can call
10715 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10717 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10718 already ran the menu bar hooks for this redisplay, so there
10719 is no need to run them again. The return value is the
10720 updated value of this flag, to pass to the next call. */
10723 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10725 Lisp_Object window
;
10726 register struct window
*w
;
10728 /* If called recursively during a menu update, do nothing. This can
10729 happen when, for instance, an activate-menubar-hook causes a
10731 if (inhibit_menubar_update
)
10734 window
= FRAME_SELECTED_WINDOW (f
);
10735 w
= XWINDOW (window
);
10737 if (FRAME_WINDOW_P (f
)
10739 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10740 || defined (HAVE_NS) || defined (USE_GTK)
10741 FRAME_EXTERNAL_MENU_BAR (f
)
10743 FRAME_MENU_BAR_LINES (f
) > 0
10745 : FRAME_MENU_BAR_LINES (f
) > 0)
10747 /* If the user has switched buffers or windows, we need to
10748 recompute to reflect the new bindings. But we'll
10749 recompute when update_mode_lines is set too; that means
10750 that people can use force-mode-line-update to request
10751 that the menu bar be recomputed. The adverse effect on
10752 the rest of the redisplay algorithm is about the same as
10753 windows_or_buffers_changed anyway. */
10754 if (windows_or_buffers_changed
10755 /* This used to test w->update_mode_line, but we believe
10756 there is no need to recompute the menu in that case. */
10757 || update_mode_lines
10758 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10759 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10760 != !NILP (w
->last_had_star
))
10761 || ((!NILP (Vtransient_mark_mode
)
10762 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10763 != !NILP (w
->region_showing
)))
10765 struct buffer
*prev
= current_buffer
;
10766 ptrdiff_t count
= SPECPDL_INDEX ();
10768 specbind (Qinhibit_menubar_update
, Qt
);
10770 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10771 if (save_match_data
)
10772 record_unwind_save_match_data ();
10773 if (NILP (Voverriding_local_map_menu_flag
))
10775 specbind (Qoverriding_terminal_local_map
, Qnil
);
10776 specbind (Qoverriding_local_map
, Qnil
);
10781 /* Run the Lucid hook. */
10782 safe_run_hooks (Qactivate_menubar_hook
);
10784 /* If it has changed current-menubar from previous value,
10785 really recompute the menu-bar from the value. */
10786 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10787 call0 (Qrecompute_lucid_menubar
);
10789 safe_run_hooks (Qmenu_bar_update_hook
);
10794 XSETFRAME (Vmenu_updating_frame
, f
);
10795 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10797 /* Redisplay the menu bar in case we changed it. */
10798 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10799 || defined (HAVE_NS) || defined (USE_GTK)
10800 if (FRAME_WINDOW_P (f
))
10802 #if defined (HAVE_NS)
10803 /* All frames on Mac OS share the same menubar. So only
10804 the selected frame should be allowed to set it. */
10805 if (f
== SELECTED_FRAME ())
10807 set_frame_menubar (f
, 0, 0);
10810 /* On a terminal screen, the menu bar is an ordinary screen
10811 line, and this makes it get updated. */
10812 w
->update_mode_line
= Qt
;
10813 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10814 /* In the non-toolkit version, the menu bar is an ordinary screen
10815 line, and this makes it get updated. */
10816 w
->update_mode_line
= Qt
;
10817 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10819 unbind_to (count
, Qnil
);
10820 set_buffer_internal_1 (prev
);
10829 /***********************************************************************
10831 ***********************************************************************/
10833 #ifdef HAVE_WINDOW_SYSTEM
10836 Nominal cursor position -- where to draw output.
10837 HPOS and VPOS are window relative glyph matrix coordinates.
10838 X and Y are window relative pixel coordinates. */
10840 struct cursor_pos output_cursor
;
10844 Set the global variable output_cursor to CURSOR. All cursor
10845 positions are relative to updated_window. */
10848 set_output_cursor (struct cursor_pos
*cursor
)
10850 output_cursor
.hpos
= cursor
->hpos
;
10851 output_cursor
.vpos
= cursor
->vpos
;
10852 output_cursor
.x
= cursor
->x
;
10853 output_cursor
.y
= cursor
->y
;
10858 Set a nominal cursor position.
10860 HPOS and VPOS are column/row positions in a window glyph matrix. X
10861 and Y are window text area relative pixel positions.
10863 If this is done during an update, updated_window will contain the
10864 window that is being updated and the position is the future output
10865 cursor position for that window. If updated_window is null, use
10866 selected_window and display the cursor at the given position. */
10869 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10873 /* If updated_window is not set, work on selected_window. */
10874 if (updated_window
)
10875 w
= updated_window
;
10877 w
= XWINDOW (selected_window
);
10879 /* Set the output cursor. */
10880 output_cursor
.hpos
= hpos
;
10881 output_cursor
.vpos
= vpos
;
10882 output_cursor
.x
= x
;
10883 output_cursor
.y
= y
;
10885 /* If not called as part of an update, really display the cursor.
10886 This will also set the cursor position of W. */
10887 if (updated_window
== NULL
)
10890 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10891 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10892 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10897 #endif /* HAVE_WINDOW_SYSTEM */
10900 /***********************************************************************
10902 ***********************************************************************/
10904 #ifdef HAVE_WINDOW_SYSTEM
10906 /* Where the mouse was last time we reported a mouse event. */
10908 FRAME_PTR last_mouse_frame
;
10910 /* Tool-bar item index of the item on which a mouse button was pressed
10913 int last_tool_bar_item
;
10917 update_tool_bar_unwind (Lisp_Object frame
)
10919 selected_frame
= frame
;
10923 /* Update the tool-bar item list for frame F. This has to be done
10924 before we start to fill in any display lines. Called from
10925 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10926 and restore it here. */
10929 update_tool_bar (struct frame
*f
, int save_match_data
)
10931 #if defined (USE_GTK) || defined (HAVE_NS)
10932 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10934 int do_update
= WINDOWP (f
->tool_bar_window
)
10935 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10940 Lisp_Object window
;
10943 window
= FRAME_SELECTED_WINDOW (f
);
10944 w
= XWINDOW (window
);
10946 /* If the user has switched buffers or windows, we need to
10947 recompute to reflect the new bindings. But we'll
10948 recompute when update_mode_lines is set too; that means
10949 that people can use force-mode-line-update to request
10950 that the menu bar be recomputed. The adverse effect on
10951 the rest of the redisplay algorithm is about the same as
10952 windows_or_buffers_changed anyway. */
10953 if (windows_or_buffers_changed
10954 || !NILP (w
->update_mode_line
)
10955 || update_mode_lines
10956 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10957 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10958 != !NILP (w
->last_had_star
))
10959 || ((!NILP (Vtransient_mark_mode
)
10960 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10961 != !NILP (w
->region_showing
)))
10963 struct buffer
*prev
= current_buffer
;
10964 ptrdiff_t count
= SPECPDL_INDEX ();
10965 Lisp_Object frame
, new_tool_bar
;
10966 int new_n_tool_bar
;
10967 struct gcpro gcpro1
;
10969 /* Set current_buffer to the buffer of the selected
10970 window of the frame, so that we get the right local
10972 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10974 /* Save match data, if we must. */
10975 if (save_match_data
)
10976 record_unwind_save_match_data ();
10978 /* Make sure that we don't accidentally use bogus keymaps. */
10979 if (NILP (Voverriding_local_map_menu_flag
))
10981 specbind (Qoverriding_terminal_local_map
, Qnil
);
10982 specbind (Qoverriding_local_map
, Qnil
);
10985 GCPRO1 (new_tool_bar
);
10987 /* We must temporarily set the selected frame to this frame
10988 before calling tool_bar_items, because the calculation of
10989 the tool-bar keymap uses the selected frame (see
10990 `tool-bar-make-keymap' in tool-bar.el). */
10991 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10992 XSETFRAME (frame
, f
);
10993 selected_frame
= frame
;
10995 /* Build desired tool-bar items from keymaps. */
10996 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10999 /* Redisplay the tool-bar if we changed it. */
11000 if (new_n_tool_bar
!= f
->n_tool_bar_items
11001 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11003 /* Redisplay that happens asynchronously due to an expose event
11004 may access f->tool_bar_items. Make sure we update both
11005 variables within BLOCK_INPUT so no such event interrupts. */
11007 f
->tool_bar_items
= new_tool_bar
;
11008 f
->n_tool_bar_items
= new_n_tool_bar
;
11009 w
->update_mode_line
= Qt
;
11015 unbind_to (count
, Qnil
);
11016 set_buffer_internal_1 (prev
);
11022 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11023 F's desired tool-bar contents. F->tool_bar_items must have
11024 been set up previously by calling prepare_menu_bars. */
11027 build_desired_tool_bar_string (struct frame
*f
)
11029 int i
, size
, size_needed
;
11030 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11031 Lisp_Object image
, plist
, props
;
11033 image
= plist
= props
= Qnil
;
11034 GCPRO3 (image
, plist
, props
);
11036 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11037 Otherwise, make a new string. */
11039 /* The size of the string we might be able to reuse. */
11040 size
= (STRINGP (f
->desired_tool_bar_string
)
11041 ? SCHARS (f
->desired_tool_bar_string
)
11044 /* We need one space in the string for each image. */
11045 size_needed
= f
->n_tool_bar_items
;
11047 /* Reuse f->desired_tool_bar_string, if possible. */
11048 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11049 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11050 make_number (' '));
11053 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11054 Fremove_text_properties (make_number (0), make_number (size
),
11055 props
, f
->desired_tool_bar_string
);
11058 /* Put a `display' property on the string for the images to display,
11059 put a `menu_item' property on tool-bar items with a value that
11060 is the index of the item in F's tool-bar item vector. */
11061 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11063 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11065 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11066 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11067 int hmargin
, vmargin
, relief
, idx
, end
;
11069 /* If image is a vector, choose the image according to the
11071 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11072 if (VECTORP (image
))
11076 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11077 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11080 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11081 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11083 xassert (ASIZE (image
) >= idx
);
11084 image
= AREF (image
, idx
);
11089 /* Ignore invalid image specifications. */
11090 if (!valid_image_p (image
))
11093 /* Display the tool-bar button pressed, or depressed. */
11094 plist
= Fcopy_sequence (XCDR (image
));
11096 /* Compute margin and relief to draw. */
11097 relief
= (tool_bar_button_relief
>= 0
11098 ? tool_bar_button_relief
11099 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11100 hmargin
= vmargin
= relief
;
11102 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11103 INT_MAX
- max (hmargin
, vmargin
)))
11105 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11106 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11108 else if (CONSP (Vtool_bar_button_margin
))
11110 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11111 INT_MAX
- hmargin
))
11112 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11114 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11115 INT_MAX
- vmargin
))
11116 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11119 if (auto_raise_tool_bar_buttons_p
)
11121 /* Add a `:relief' property to the image spec if the item is
11125 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11132 /* If image is selected, display it pressed, i.e. with a
11133 negative relief. If it's not selected, display it with a
11135 plist
= Fplist_put (plist
, QCrelief
,
11137 ? make_number (-relief
)
11138 : make_number (relief
)));
11143 /* Put a margin around the image. */
11144 if (hmargin
|| vmargin
)
11146 if (hmargin
== vmargin
)
11147 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11149 plist
= Fplist_put (plist
, QCmargin
,
11150 Fcons (make_number (hmargin
),
11151 make_number (vmargin
)));
11154 /* If button is not enabled, and we don't have special images
11155 for the disabled state, make the image appear disabled by
11156 applying an appropriate algorithm to it. */
11157 if (!enabled_p
&& idx
< 0)
11158 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11160 /* Put a `display' text property on the string for the image to
11161 display. Put a `menu-item' property on the string that gives
11162 the start of this item's properties in the tool-bar items
11164 image
= Fcons (Qimage
, plist
);
11165 props
= list4 (Qdisplay
, image
,
11166 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11168 /* Let the last image hide all remaining spaces in the tool bar
11169 string. The string can be longer than needed when we reuse a
11170 previous string. */
11171 if (i
+ 1 == f
->n_tool_bar_items
)
11172 end
= SCHARS (f
->desired_tool_bar_string
);
11175 Fadd_text_properties (make_number (i
), make_number (end
),
11176 props
, f
->desired_tool_bar_string
);
11184 /* Display one line of the tool-bar of frame IT->f.
11186 HEIGHT specifies the desired height of the tool-bar line.
11187 If the actual height of the glyph row is less than HEIGHT, the
11188 row's height is increased to HEIGHT, and the icons are centered
11189 vertically in the new height.
11191 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11192 count a final empty row in case the tool-bar width exactly matches
11197 display_tool_bar_line (struct it
*it
, int height
)
11199 struct glyph_row
*row
= it
->glyph_row
;
11200 int max_x
= it
->last_visible_x
;
11201 struct glyph
*last
;
11203 prepare_desired_row (row
);
11204 row
->y
= it
->current_y
;
11206 /* Note that this isn't made use of if the face hasn't a box,
11207 so there's no need to check the face here. */
11208 it
->start_of_box_run_p
= 1;
11210 while (it
->current_x
< max_x
)
11212 int x
, n_glyphs_before
, i
, nglyphs
;
11213 struct it it_before
;
11215 /* Get the next display element. */
11216 if (!get_next_display_element (it
))
11218 /* Don't count empty row if we are counting needed tool-bar lines. */
11219 if (height
< 0 && !it
->hpos
)
11224 /* Produce glyphs. */
11225 n_glyphs_before
= row
->used
[TEXT_AREA
];
11228 PRODUCE_GLYPHS (it
);
11230 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11232 x
= it_before
.current_x
;
11233 while (i
< nglyphs
)
11235 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11237 if (x
+ glyph
->pixel_width
> max_x
)
11239 /* Glyph doesn't fit on line. Backtrack. */
11240 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11242 /* If this is the only glyph on this line, it will never fit on the
11243 tool-bar, so skip it. But ensure there is at least one glyph,
11244 so we don't accidentally disable the tool-bar. */
11245 if (n_glyphs_before
== 0
11246 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11252 x
+= glyph
->pixel_width
;
11256 /* Stop at line end. */
11257 if (ITERATOR_AT_END_OF_LINE_P (it
))
11260 set_iterator_to_next (it
, 1);
11265 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11267 /* Use default face for the border below the tool bar.
11269 FIXME: When auto-resize-tool-bars is grow-only, there is
11270 no additional border below the possibly empty tool-bar lines.
11271 So to make the extra empty lines look "normal", we have to
11272 use the tool-bar face for the border too. */
11273 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11274 it
->face_id
= DEFAULT_FACE_ID
;
11276 extend_face_to_end_of_line (it
);
11277 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11278 last
->right_box_line_p
= 1;
11279 if (last
== row
->glyphs
[TEXT_AREA
])
11280 last
->left_box_line_p
= 1;
11282 /* Make line the desired height and center it vertically. */
11283 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11285 /* Don't add more than one line height. */
11286 height
%= FRAME_LINE_HEIGHT (it
->f
);
11287 it
->max_ascent
+= height
/ 2;
11288 it
->max_descent
+= (height
+ 1) / 2;
11291 compute_line_metrics (it
);
11293 /* If line is empty, make it occupy the rest of the tool-bar. */
11294 if (!row
->displays_text_p
)
11296 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11297 row
->visible_height
= row
->height
;
11298 row
->ascent
= row
->phys_ascent
= 0;
11299 row
->extra_line_spacing
= 0;
11302 row
->full_width_p
= 1;
11303 row
->continued_p
= 0;
11304 row
->truncated_on_left_p
= 0;
11305 row
->truncated_on_right_p
= 0;
11307 it
->current_x
= it
->hpos
= 0;
11308 it
->current_y
+= row
->height
;
11314 /* Max tool-bar height. */
11316 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11317 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11319 /* Value is the number of screen lines needed to make all tool-bar
11320 items of frame F visible. The number of actual rows needed is
11321 returned in *N_ROWS if non-NULL. */
11324 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11326 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11328 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11329 the desired matrix, so use (unused) mode-line row as temporary row to
11330 avoid destroying the first tool-bar row. */
11331 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11333 /* Initialize an iterator for iteration over
11334 F->desired_tool_bar_string in the tool-bar window of frame F. */
11335 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11336 it
.first_visible_x
= 0;
11337 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11338 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11339 it
.paragraph_embedding
= L2R
;
11341 while (!ITERATOR_AT_END_P (&it
))
11343 clear_glyph_row (temp_row
);
11344 it
.glyph_row
= temp_row
;
11345 display_tool_bar_line (&it
, -1);
11347 clear_glyph_row (temp_row
);
11349 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11351 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11353 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11357 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11359 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11360 (Lisp_Object frame
)
11367 frame
= selected_frame
;
11369 CHECK_FRAME (frame
);
11370 f
= XFRAME (frame
);
11372 if (WINDOWP (f
->tool_bar_window
)
11373 && (w
= XWINDOW (f
->tool_bar_window
),
11374 WINDOW_TOTAL_LINES (w
) > 0))
11376 update_tool_bar (f
, 1);
11377 if (f
->n_tool_bar_items
)
11379 build_desired_tool_bar_string (f
);
11380 nlines
= tool_bar_lines_needed (f
, NULL
);
11384 return make_number (nlines
);
11388 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11389 height should be changed. */
11392 redisplay_tool_bar (struct frame
*f
)
11396 struct glyph_row
*row
;
11398 #if defined (USE_GTK) || defined (HAVE_NS)
11399 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11400 update_frame_tool_bar (f
);
11404 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11405 do anything. This means you must start with tool-bar-lines
11406 non-zero to get the auto-sizing effect. Or in other words, you
11407 can turn off tool-bars by specifying tool-bar-lines zero. */
11408 if (!WINDOWP (f
->tool_bar_window
)
11409 || (w
= XWINDOW (f
->tool_bar_window
),
11410 WINDOW_TOTAL_LINES (w
) == 0))
11413 /* Set up an iterator for the tool-bar window. */
11414 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11415 it
.first_visible_x
= 0;
11416 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11417 row
= it
.glyph_row
;
11419 /* Build a string that represents the contents of the tool-bar. */
11420 build_desired_tool_bar_string (f
);
11421 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11422 /* FIXME: This should be controlled by a user option. But it
11423 doesn't make sense to have an R2L tool bar if the menu bar cannot
11424 be drawn also R2L, and making the menu bar R2L is tricky due
11425 toolkit-specific code that implements it. If an R2L tool bar is
11426 ever supported, display_tool_bar_line should also be augmented to
11427 call unproduce_glyphs like display_line and display_string
11429 it
.paragraph_embedding
= L2R
;
11431 if (f
->n_tool_bar_rows
== 0)
11435 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11436 nlines
!= WINDOW_TOTAL_LINES (w
)))
11439 int old_height
= WINDOW_TOTAL_LINES (w
);
11441 XSETFRAME (frame
, f
);
11442 Fmodify_frame_parameters (frame
,
11443 Fcons (Fcons (Qtool_bar_lines
,
11444 make_number (nlines
)),
11446 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11448 clear_glyph_matrix (w
->desired_matrix
);
11449 fonts_changed_p
= 1;
11455 /* Display as many lines as needed to display all tool-bar items. */
11457 if (f
->n_tool_bar_rows
> 0)
11459 int border
, rows
, height
, extra
;
11461 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11462 border
= XINT (Vtool_bar_border
);
11463 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11464 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11465 else if (EQ (Vtool_bar_border
, Qborder_width
))
11466 border
= f
->border_width
;
11472 rows
= f
->n_tool_bar_rows
;
11473 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11474 extra
= it
.last_visible_y
- border
- height
* rows
;
11476 while (it
.current_y
< it
.last_visible_y
)
11479 if (extra
> 0 && rows
-- > 0)
11481 h
= (extra
+ rows
- 1) / rows
;
11484 display_tool_bar_line (&it
, height
+ h
);
11489 while (it
.current_y
< it
.last_visible_y
)
11490 display_tool_bar_line (&it
, 0);
11493 /* It doesn't make much sense to try scrolling in the tool-bar
11494 window, so don't do it. */
11495 w
->desired_matrix
->no_scrolling_p
= 1;
11496 w
->must_be_updated_p
= 1;
11498 if (!NILP (Vauto_resize_tool_bars
))
11500 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11501 int change_height_p
= 0;
11503 /* If we couldn't display everything, change the tool-bar's
11504 height if there is room for more. */
11505 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11506 && it
.current_y
< max_tool_bar_height
)
11507 change_height_p
= 1;
11509 row
= it
.glyph_row
- 1;
11511 /* If there are blank lines at the end, except for a partially
11512 visible blank line at the end that is smaller than
11513 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11514 if (!row
->displays_text_p
11515 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11516 change_height_p
= 1;
11518 /* If row displays tool-bar items, but is partially visible,
11519 change the tool-bar's height. */
11520 if (row
->displays_text_p
11521 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11522 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11523 change_height_p
= 1;
11525 /* Resize windows as needed by changing the `tool-bar-lines'
11526 frame parameter. */
11527 if (change_height_p
)
11530 int old_height
= WINDOW_TOTAL_LINES (w
);
11532 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11534 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11535 && !f
->minimize_tool_bar_window_p
)
11536 ? (nlines
> old_height
)
11537 : (nlines
!= old_height
));
11538 f
->minimize_tool_bar_window_p
= 0;
11540 if (change_height_p
)
11542 XSETFRAME (frame
, f
);
11543 Fmodify_frame_parameters (frame
,
11544 Fcons (Fcons (Qtool_bar_lines
,
11545 make_number (nlines
)),
11547 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11549 clear_glyph_matrix (w
->desired_matrix
);
11550 f
->n_tool_bar_rows
= nrows
;
11551 fonts_changed_p
= 1;
11558 f
->minimize_tool_bar_window_p
= 0;
11563 /* Get information about the tool-bar item which is displayed in GLYPH
11564 on frame F. Return in *PROP_IDX the index where tool-bar item
11565 properties start in F->tool_bar_items. Value is zero if
11566 GLYPH doesn't display a tool-bar item. */
11569 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11575 /* This function can be called asynchronously, which means we must
11576 exclude any possibility that Fget_text_property signals an
11578 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11579 charpos
= max (0, charpos
);
11581 /* Get the text property `menu-item' at pos. The value of that
11582 property is the start index of this item's properties in
11583 F->tool_bar_items. */
11584 prop
= Fget_text_property (make_number (charpos
),
11585 Qmenu_item
, f
->current_tool_bar_string
);
11586 if (INTEGERP (prop
))
11588 *prop_idx
= XINT (prop
);
11598 /* Get information about the tool-bar item at position X/Y on frame F.
11599 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11600 the current matrix of the tool-bar window of F, or NULL if not
11601 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11602 item in F->tool_bar_items. Value is
11604 -1 if X/Y is not on a tool-bar item
11605 0 if X/Y is on the same item that was highlighted before.
11609 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11610 int *hpos
, int *vpos
, int *prop_idx
)
11612 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11613 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11616 /* Find the glyph under X/Y. */
11617 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11618 if (*glyph
== NULL
)
11621 /* Get the start of this tool-bar item's properties in
11622 f->tool_bar_items. */
11623 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11626 /* Is mouse on the highlighted item? */
11627 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11628 && *vpos
>= hlinfo
->mouse_face_beg_row
11629 && *vpos
<= hlinfo
->mouse_face_end_row
11630 && (*vpos
> hlinfo
->mouse_face_beg_row
11631 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11632 && (*vpos
< hlinfo
->mouse_face_end_row
11633 || *hpos
< hlinfo
->mouse_face_end_col
11634 || hlinfo
->mouse_face_past_end
))
11642 Handle mouse button event on the tool-bar of frame F, at
11643 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11644 0 for button release. MODIFIERS is event modifiers for button
11648 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11651 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11652 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11653 int hpos
, vpos
, prop_idx
;
11654 struct glyph
*glyph
;
11655 Lisp_Object enabled_p
;
11657 /* If not on the highlighted tool-bar item, return. */
11658 frame_to_window_pixel_xy (w
, &x
, &y
);
11659 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11662 /* If item is disabled, do nothing. */
11663 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11664 if (NILP (enabled_p
))
11669 /* Show item in pressed state. */
11670 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11671 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11672 last_tool_bar_item
= prop_idx
;
11676 Lisp_Object key
, frame
;
11677 struct input_event event
;
11678 EVENT_INIT (event
);
11680 /* Show item in released state. */
11681 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11682 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11684 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11686 XSETFRAME (frame
, f
);
11687 event
.kind
= TOOL_BAR_EVENT
;
11688 event
.frame_or_window
= frame
;
11690 kbd_buffer_store_event (&event
);
11692 event
.kind
= TOOL_BAR_EVENT
;
11693 event
.frame_or_window
= frame
;
11695 event
.modifiers
= modifiers
;
11696 kbd_buffer_store_event (&event
);
11697 last_tool_bar_item
= -1;
11702 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11703 tool-bar window-relative coordinates X/Y. Called from
11704 note_mouse_highlight. */
11707 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11709 Lisp_Object window
= f
->tool_bar_window
;
11710 struct window
*w
= XWINDOW (window
);
11711 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11712 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11714 struct glyph
*glyph
;
11715 struct glyph_row
*row
;
11717 Lisp_Object enabled_p
;
11719 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11720 int mouse_down_p
, rc
;
11722 /* Function note_mouse_highlight is called with negative X/Y
11723 values when mouse moves outside of the frame. */
11724 if (x
<= 0 || y
<= 0)
11726 clear_mouse_face (hlinfo
);
11730 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11733 /* Not on tool-bar item. */
11734 clear_mouse_face (hlinfo
);
11738 /* On same tool-bar item as before. */
11739 goto set_help_echo
;
11741 clear_mouse_face (hlinfo
);
11743 /* Mouse is down, but on different tool-bar item? */
11744 mouse_down_p
= (dpyinfo
->grabbed
11745 && f
== last_mouse_frame
11746 && FRAME_LIVE_P (f
));
11748 && last_tool_bar_item
!= prop_idx
)
11751 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11752 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11754 /* If tool-bar item is not enabled, don't highlight it. */
11755 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11756 if (!NILP (enabled_p
))
11758 /* Compute the x-position of the glyph. In front and past the
11759 image is a space. We include this in the highlighted area. */
11760 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11761 for (i
= x
= 0; i
< hpos
; ++i
)
11762 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11764 /* Record this as the current active region. */
11765 hlinfo
->mouse_face_beg_col
= hpos
;
11766 hlinfo
->mouse_face_beg_row
= vpos
;
11767 hlinfo
->mouse_face_beg_x
= x
;
11768 hlinfo
->mouse_face_beg_y
= row
->y
;
11769 hlinfo
->mouse_face_past_end
= 0;
11771 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11772 hlinfo
->mouse_face_end_row
= vpos
;
11773 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11774 hlinfo
->mouse_face_end_y
= row
->y
;
11775 hlinfo
->mouse_face_window
= window
;
11776 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11778 /* Display it as active. */
11779 show_mouse_face (hlinfo
, draw
);
11780 hlinfo
->mouse_face_image_state
= draw
;
11785 /* Set help_echo_string to a help string to display for this tool-bar item.
11786 XTread_socket does the rest. */
11787 help_echo_object
= help_echo_window
= Qnil
;
11788 help_echo_pos
= -1;
11789 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11790 if (NILP (help_echo_string
))
11791 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11794 #endif /* HAVE_WINDOW_SYSTEM */
11798 /************************************************************************
11799 Horizontal scrolling
11800 ************************************************************************/
11802 static int hscroll_window_tree (Lisp_Object
);
11803 static int hscroll_windows (Lisp_Object
);
11805 /* For all leaf windows in the window tree rooted at WINDOW, set their
11806 hscroll value so that PT is (i) visible in the window, and (ii) so
11807 that it is not within a certain margin at the window's left and
11808 right border. Value is non-zero if any window's hscroll has been
11812 hscroll_window_tree (Lisp_Object window
)
11814 int hscrolled_p
= 0;
11815 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11816 int hscroll_step_abs
= 0;
11817 double hscroll_step_rel
= 0;
11819 if (hscroll_relative_p
)
11821 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11822 if (hscroll_step_rel
< 0)
11824 hscroll_relative_p
= 0;
11825 hscroll_step_abs
= 0;
11828 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
11830 hscroll_step_abs
= XINT (Vhscroll_step
);
11831 if (hscroll_step_abs
< 0)
11832 hscroll_step_abs
= 0;
11835 hscroll_step_abs
= 0;
11837 while (WINDOWP (window
))
11839 struct window
*w
= XWINDOW (window
);
11841 if (WINDOWP (w
->hchild
))
11842 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11843 else if (WINDOWP (w
->vchild
))
11844 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11845 else if (w
->cursor
.vpos
>= 0)
11848 int text_area_width
;
11849 struct glyph_row
*current_cursor_row
11850 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11851 struct glyph_row
*desired_cursor_row
11852 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11853 struct glyph_row
*cursor_row
11854 = (desired_cursor_row
->enabled_p
11855 ? desired_cursor_row
11856 : current_cursor_row
);
11858 text_area_width
= window_box_width (w
, TEXT_AREA
);
11860 /* Scroll when cursor is inside this scroll margin. */
11861 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11863 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11864 && ((XFASTINT (w
->hscroll
)
11865 && w
->cursor
.x
<= h_margin
)
11866 || (cursor_row
->enabled_p
11867 && cursor_row
->truncated_on_right_p
11868 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11872 struct buffer
*saved_current_buffer
;
11876 /* Find point in a display of infinite width. */
11877 saved_current_buffer
= current_buffer
;
11878 current_buffer
= XBUFFER (w
->buffer
);
11880 if (w
== XWINDOW (selected_window
))
11884 pt
= marker_position (w
->pointm
);
11885 pt
= max (BEGV
, pt
);
11889 /* Move iterator to pt starting at cursor_row->start in
11890 a line with infinite width. */
11891 init_to_row_start (&it
, w
, cursor_row
);
11892 it
.last_visible_x
= INFINITY
;
11893 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11894 current_buffer
= saved_current_buffer
;
11896 /* Position cursor in window. */
11897 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11898 hscroll
= max (0, (it
.current_x
11899 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11900 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11901 : (text_area_width
/ 2))))
11902 / FRAME_COLUMN_WIDTH (it
.f
);
11903 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11905 if (hscroll_relative_p
)
11906 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11909 wanted_x
= text_area_width
11910 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11913 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11917 if (hscroll_relative_p
)
11918 wanted_x
= text_area_width
* hscroll_step_rel
11921 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11924 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11926 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11928 /* Don't prevent redisplay optimizations if hscroll
11929 hasn't changed, as it will unnecessarily slow down
11931 if (XFASTINT (w
->hscroll
) != hscroll
)
11933 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11934 w
->hscroll
= make_number (hscroll
);
11943 /* Value is non-zero if hscroll of any leaf window has been changed. */
11944 return hscrolled_p
;
11948 /* Set hscroll so that cursor is visible and not inside horizontal
11949 scroll margins for all windows in the tree rooted at WINDOW. See
11950 also hscroll_window_tree above. Value is non-zero if any window's
11951 hscroll has been changed. If it has, desired matrices on the frame
11952 of WINDOW are cleared. */
11955 hscroll_windows (Lisp_Object window
)
11957 int hscrolled_p
= hscroll_window_tree (window
);
11959 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11960 return hscrolled_p
;
11965 /************************************************************************
11967 ************************************************************************/
11969 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11970 to a non-zero value. This is sometimes handy to have in a debugger
11975 /* First and last unchanged row for try_window_id. */
11977 static int debug_first_unchanged_at_end_vpos
;
11978 static int debug_last_unchanged_at_beg_vpos
;
11980 /* Delta vpos and y. */
11982 static int debug_dvpos
, debug_dy
;
11984 /* Delta in characters and bytes for try_window_id. */
11986 static ptrdiff_t debug_delta
, debug_delta_bytes
;
11988 /* Values of window_end_pos and window_end_vpos at the end of
11991 static ptrdiff_t debug_end_vpos
;
11993 /* Append a string to W->desired_matrix->method. FMT is a printf
11994 format string. If trace_redisplay_p is non-zero also printf the
11995 resulting string to stderr. */
11997 static void debug_method_add (struct window
*, char const *, ...)
11998 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12001 debug_method_add (struct window
*w
, char const *fmt
, ...)
12004 char *method
= w
->desired_matrix
->method
;
12005 int len
= strlen (method
);
12006 int size
= sizeof w
->desired_matrix
->method
;
12007 int remaining
= size
- len
- 1;
12010 va_start (ap
, fmt
);
12011 vsprintf (buffer
, fmt
, ap
);
12013 if (len
&& remaining
)
12016 --remaining
, ++len
;
12019 strncpy (method
+ len
, buffer
, remaining
);
12021 if (trace_redisplay_p
)
12022 fprintf (stderr
, "%p (%s): %s\n",
12024 ((BUFFERP (w
->buffer
)
12025 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12026 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12031 #endif /* GLYPH_DEBUG */
12034 /* Value is non-zero if all changes in window W, which displays
12035 current_buffer, are in the text between START and END. START is a
12036 buffer position, END is given as a distance from Z. Used in
12037 redisplay_internal for display optimization. */
12040 text_outside_line_unchanged_p (struct window
*w
,
12041 ptrdiff_t start
, ptrdiff_t end
)
12043 int unchanged_p
= 1;
12045 /* If text or overlays have changed, see where. */
12046 if (XFASTINT (w
->last_modified
) < MODIFF
12047 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12049 /* Gap in the line? */
12050 if (GPT
< start
|| Z
- GPT
< end
)
12053 /* Changes start in front of the line, or end after it? */
12055 && (BEG_UNCHANGED
< start
- 1
12056 || END_UNCHANGED
< end
))
12059 /* If selective display, can't optimize if changes start at the
12060 beginning of the line. */
12062 && INTEGERP (BVAR (current_buffer
, selective_display
))
12063 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12064 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12067 /* If there are overlays at the start or end of the line, these
12068 may have overlay strings with newlines in them. A change at
12069 START, for instance, may actually concern the display of such
12070 overlay strings as well, and they are displayed on different
12071 lines. So, quickly rule out this case. (For the future, it
12072 might be desirable to implement something more telling than
12073 just BEG/END_UNCHANGED.) */
12076 if (BEG
+ BEG_UNCHANGED
== start
12077 && overlay_touches_p (start
))
12079 if (END_UNCHANGED
== end
12080 && overlay_touches_p (Z
- end
))
12084 /* Under bidi reordering, adding or deleting a character in the
12085 beginning of a paragraph, before the first strong directional
12086 character, can change the base direction of the paragraph (unless
12087 the buffer specifies a fixed paragraph direction), which will
12088 require to redisplay the whole paragraph. It might be worthwhile
12089 to find the paragraph limits and widen the range of redisplayed
12090 lines to that, but for now just give up this optimization. */
12091 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12092 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12096 return unchanged_p
;
12100 /* Do a frame update, taking possible shortcuts into account. This is
12101 the main external entry point for redisplay.
12103 If the last redisplay displayed an echo area message and that message
12104 is no longer requested, we clear the echo area or bring back the
12105 mini-buffer if that is in use. */
12110 redisplay_internal ();
12115 overlay_arrow_string_or_property (Lisp_Object var
)
12119 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12122 return Voverlay_arrow_string
;
12125 /* Return 1 if there are any overlay-arrows in current_buffer. */
12127 overlay_arrow_in_current_buffer_p (void)
12131 for (vlist
= Voverlay_arrow_variable_list
;
12133 vlist
= XCDR (vlist
))
12135 Lisp_Object var
= XCAR (vlist
);
12138 if (!SYMBOLP (var
))
12140 val
= find_symbol_value (var
);
12142 && current_buffer
== XMARKER (val
)->buffer
)
12149 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12153 overlay_arrows_changed_p (void)
12157 for (vlist
= Voverlay_arrow_variable_list
;
12159 vlist
= XCDR (vlist
))
12161 Lisp_Object var
= XCAR (vlist
);
12162 Lisp_Object val
, pstr
;
12164 if (!SYMBOLP (var
))
12166 val
= find_symbol_value (var
);
12167 if (!MARKERP (val
))
12169 if (! EQ (COERCE_MARKER (val
),
12170 Fget (var
, Qlast_arrow_position
))
12171 || ! (pstr
= overlay_arrow_string_or_property (var
),
12172 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12178 /* Mark overlay arrows to be updated on next redisplay. */
12181 update_overlay_arrows (int up_to_date
)
12185 for (vlist
= Voverlay_arrow_variable_list
;
12187 vlist
= XCDR (vlist
))
12189 Lisp_Object var
= XCAR (vlist
);
12191 if (!SYMBOLP (var
))
12194 if (up_to_date
> 0)
12196 Lisp_Object val
= find_symbol_value (var
);
12197 Fput (var
, Qlast_arrow_position
,
12198 COERCE_MARKER (val
));
12199 Fput (var
, Qlast_arrow_string
,
12200 overlay_arrow_string_or_property (var
));
12202 else if (up_to_date
< 0
12203 || !NILP (Fget (var
, Qlast_arrow_position
)))
12205 Fput (var
, Qlast_arrow_position
, Qt
);
12206 Fput (var
, Qlast_arrow_string
, Qt
);
12212 /* Return overlay arrow string to display at row.
12213 Return integer (bitmap number) for arrow bitmap in left fringe.
12214 Return nil if no overlay arrow. */
12217 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12221 for (vlist
= Voverlay_arrow_variable_list
;
12223 vlist
= XCDR (vlist
))
12225 Lisp_Object var
= XCAR (vlist
);
12228 if (!SYMBOLP (var
))
12231 val
= find_symbol_value (var
);
12234 && current_buffer
== XMARKER (val
)->buffer
12235 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12237 if (FRAME_WINDOW_P (it
->f
)
12238 /* FIXME: if ROW->reversed_p is set, this should test
12239 the right fringe, not the left one. */
12240 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12242 #ifdef HAVE_WINDOW_SYSTEM
12243 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12246 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12247 return make_number (fringe_bitmap
);
12250 return make_number (-1); /* Use default arrow bitmap */
12252 return overlay_arrow_string_or_property (var
);
12259 /* Return 1 if point moved out of or into a composition. Otherwise
12260 return 0. PREV_BUF and PREV_PT are the last point buffer and
12261 position. BUF and PT are the current point buffer and position. */
12264 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12265 struct buffer
*buf
, ptrdiff_t pt
)
12267 ptrdiff_t start
, end
;
12269 Lisp_Object buffer
;
12271 XSETBUFFER (buffer
, buf
);
12272 /* Check a composition at the last point if point moved within the
12274 if (prev_buf
== buf
)
12277 /* Point didn't move. */
12280 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12281 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12282 && COMPOSITION_VALID_P (start
, end
, prop
)
12283 && start
< prev_pt
&& end
> prev_pt
)
12284 /* The last point was within the composition. Return 1 iff
12285 point moved out of the composition. */
12286 return (pt
<= start
|| pt
>= end
);
12289 /* Check a composition at the current point. */
12290 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12291 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12292 && COMPOSITION_VALID_P (start
, end
, prop
)
12293 && start
< pt
&& end
> pt
);
12297 /* Reconsider the setting of B->clip_changed which is displayed
12301 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12303 if (b
->clip_changed
12304 && !NILP (w
->window_end_valid
)
12305 && w
->current_matrix
->buffer
== b
12306 && w
->current_matrix
->zv
== BUF_ZV (b
)
12307 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12308 b
->clip_changed
= 0;
12310 /* If display wasn't paused, and W is not a tool bar window, see if
12311 point has been moved into or out of a composition. In that case,
12312 we set b->clip_changed to 1 to force updating the screen. If
12313 b->clip_changed has already been set to 1, we can skip this
12315 if (!b
->clip_changed
12316 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12320 if (w
== XWINDOW (selected_window
))
12323 pt
= marker_position (w
->pointm
);
12325 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12326 || pt
!= XINT (w
->last_point
))
12327 && check_point_in_composition (w
->current_matrix
->buffer
,
12328 XINT (w
->last_point
),
12329 XBUFFER (w
->buffer
), pt
))
12330 b
->clip_changed
= 1;
12335 /* Select FRAME to forward the values of frame-local variables into C
12336 variables so that the redisplay routines can access those values
12340 select_frame_for_redisplay (Lisp_Object frame
)
12342 Lisp_Object tail
, tem
;
12343 Lisp_Object old
= selected_frame
;
12344 struct Lisp_Symbol
*sym
;
12346 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12348 selected_frame
= frame
;
12351 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12352 if (CONSP (XCAR (tail
))
12353 && (tem
= XCAR (XCAR (tail
)),
12355 && (sym
= indirect_variable (XSYMBOL (tem
)),
12356 sym
->redirect
== SYMBOL_LOCALIZED
)
12357 && sym
->val
.blv
->frame_local
)
12358 /* Use find_symbol_value rather than Fsymbol_value
12359 to avoid an error if it is void. */
12360 find_symbol_value (tem
);
12361 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12365 #define STOP_POLLING \
12366 do { if (! polling_stopped_here) stop_polling (); \
12367 polling_stopped_here = 1; } while (0)
12369 #define RESUME_POLLING \
12370 do { if (polling_stopped_here) start_polling (); \
12371 polling_stopped_here = 0; } while (0)
12374 /* Perhaps in the future avoid recentering windows if it
12375 is not necessary; currently that causes some problems. */
12378 redisplay_internal (void)
12380 struct window
*w
= XWINDOW (selected_window
);
12384 int must_finish
= 0;
12385 struct text_pos tlbufpos
, tlendpos
;
12386 int number_of_visible_frames
;
12387 ptrdiff_t count
, count1
;
12389 int polling_stopped_here
= 0;
12390 Lisp_Object old_frame
= selected_frame
;
12392 /* Non-zero means redisplay has to consider all windows on all
12393 frames. Zero means, only selected_window is considered. */
12394 int consider_all_windows_p
;
12396 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12398 /* No redisplay if running in batch mode or frame is not yet fully
12399 initialized, or redisplay is explicitly turned off by setting
12400 Vinhibit_redisplay. */
12401 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12402 || !NILP (Vinhibit_redisplay
))
12405 /* Don't examine these until after testing Vinhibit_redisplay.
12406 When Emacs is shutting down, perhaps because its connection to
12407 X has dropped, we should not look at them at all. */
12408 fr
= XFRAME (w
->frame
);
12409 sf
= SELECTED_FRAME ();
12411 if (!fr
->glyphs_initialized_p
)
12414 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12415 if (popup_activated ())
12419 /* I don't think this happens but let's be paranoid. */
12420 if (redisplaying_p
)
12423 /* Record a function that resets redisplaying_p to its old value
12424 when we leave this function. */
12425 count
= SPECPDL_INDEX ();
12426 record_unwind_protect (unwind_redisplay
,
12427 Fcons (make_number (redisplaying_p
), selected_frame
));
12429 specbind (Qinhibit_free_realized_faces
, Qnil
);
12432 Lisp_Object tail
, frame
;
12434 FOR_EACH_FRAME (tail
, frame
)
12436 struct frame
*f
= XFRAME (frame
);
12437 f
->already_hscrolled_p
= 0;
12442 /* Remember the currently selected window. */
12445 if (!EQ (old_frame
, selected_frame
)
12446 && FRAME_LIVE_P (XFRAME (old_frame
)))
12447 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12448 selected_frame and selected_window to be temporarily out-of-sync so
12449 when we come back here via `goto retry', we need to resync because we
12450 may need to run Elisp code (via prepare_menu_bars). */
12451 select_frame_for_redisplay (old_frame
);
12454 reconsider_clip_changes (w
, current_buffer
);
12455 last_escape_glyph_frame
= NULL
;
12456 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12457 last_glyphless_glyph_frame
= NULL
;
12458 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12460 /* If new fonts have been loaded that make a glyph matrix adjustment
12461 necessary, do it. */
12462 if (fonts_changed_p
)
12464 adjust_glyphs (NULL
);
12465 ++windows_or_buffers_changed
;
12466 fonts_changed_p
= 0;
12469 /* If face_change_count is non-zero, init_iterator will free all
12470 realized faces, which includes the faces referenced from current
12471 matrices. So, we can't reuse current matrices in this case. */
12472 if (face_change_count
)
12473 ++windows_or_buffers_changed
;
12475 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12476 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12478 /* Since frames on a single ASCII terminal share the same
12479 display area, displaying a different frame means redisplay
12480 the whole thing. */
12481 windows_or_buffers_changed
++;
12482 SET_FRAME_GARBAGED (sf
);
12484 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12486 FRAME_TTY (sf
)->previous_frame
= sf
;
12489 /* Set the visible flags for all frames. Do this before checking
12490 for resized or garbaged frames; they want to know if their frames
12491 are visible. See the comment in frame.h for
12492 FRAME_SAMPLE_VISIBILITY. */
12494 Lisp_Object tail
, frame
;
12496 number_of_visible_frames
= 0;
12498 FOR_EACH_FRAME (tail
, frame
)
12500 struct frame
*f
= XFRAME (frame
);
12502 FRAME_SAMPLE_VISIBILITY (f
);
12503 if (FRAME_VISIBLE_P (f
))
12504 ++number_of_visible_frames
;
12505 clear_desired_matrices (f
);
12509 /* Notice any pending interrupt request to change frame size. */
12510 do_pending_window_change (1);
12512 /* do_pending_window_change could change the selected_window due to
12513 frame resizing which makes the selected window too small. */
12514 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12517 reconsider_clip_changes (w
, current_buffer
);
12520 /* Clear frames marked as garbaged. */
12521 if (frame_garbaged
)
12522 clear_garbaged_frames ();
12524 /* Build menubar and tool-bar items. */
12525 if (NILP (Vmemory_full
))
12526 prepare_menu_bars ();
12528 if (windows_or_buffers_changed
)
12529 update_mode_lines
++;
12531 /* Detect case that we need to write or remove a star in the mode line. */
12532 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12534 w
->update_mode_line
= Qt
;
12535 if (buffer_shared
> 1)
12536 update_mode_lines
++;
12539 /* Avoid invocation of point motion hooks by `current_column' below. */
12540 count1
= SPECPDL_INDEX ();
12541 specbind (Qinhibit_point_motion_hooks
, Qt
);
12543 /* If %c is in the mode line, update it if needed. */
12544 if (!NILP (w
->column_number_displayed
)
12545 /* This alternative quickly identifies a common case
12546 where no change is needed. */
12547 && !(PT
== XFASTINT (w
->last_point
)
12548 && XFASTINT (w
->last_modified
) >= MODIFF
12549 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12550 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12551 w
->update_mode_line
= Qt
;
12553 unbind_to (count1
, Qnil
);
12555 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12557 /* The variable buffer_shared is set in redisplay_window and
12558 indicates that we redisplay a buffer in different windows. See
12560 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12561 || cursor_type_changed
);
12563 /* If specs for an arrow have changed, do thorough redisplay
12564 to ensure we remove any arrow that should no longer exist. */
12565 if (overlay_arrows_changed_p ())
12566 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12568 /* Normally the message* functions will have already displayed and
12569 updated the echo area, but the frame may have been trashed, or
12570 the update may have been preempted, so display the echo area
12571 again here. Checking message_cleared_p captures the case that
12572 the echo area should be cleared. */
12573 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12574 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12575 || (message_cleared_p
12576 && minibuf_level
== 0
12577 /* If the mini-window is currently selected, this means the
12578 echo-area doesn't show through. */
12579 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12581 int window_height_changed_p
= echo_area_display (0);
12584 /* If we don't display the current message, don't clear the
12585 message_cleared_p flag, because, if we did, we wouldn't clear
12586 the echo area in the next redisplay which doesn't preserve
12588 if (!display_last_displayed_message_p
)
12589 message_cleared_p
= 0;
12591 if (fonts_changed_p
)
12593 else if (window_height_changed_p
)
12595 consider_all_windows_p
= 1;
12596 ++update_mode_lines
;
12597 ++windows_or_buffers_changed
;
12599 /* If window configuration was changed, frames may have been
12600 marked garbaged. Clear them or we will experience
12601 surprises wrt scrolling. */
12602 if (frame_garbaged
)
12603 clear_garbaged_frames ();
12606 else if (EQ (selected_window
, minibuf_window
)
12607 && (current_buffer
->clip_changed
12608 || XFASTINT (w
->last_modified
) < MODIFF
12609 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12610 && resize_mini_window (w
, 0))
12612 /* Resized active mini-window to fit the size of what it is
12613 showing if its contents might have changed. */
12615 /* FIXME: this causes all frames to be updated, which seems unnecessary
12616 since only the current frame needs to be considered. This function needs
12617 to be rewritten with two variables, consider_all_windows and
12618 consider_all_frames. */
12619 consider_all_windows_p
= 1;
12620 ++windows_or_buffers_changed
;
12621 ++update_mode_lines
;
12623 /* If window configuration was changed, frames may have been
12624 marked garbaged. Clear them or we will experience
12625 surprises wrt scrolling. */
12626 if (frame_garbaged
)
12627 clear_garbaged_frames ();
12631 /* If showing the region, and mark has changed, we must redisplay
12632 the whole window. The assignment to this_line_start_pos prevents
12633 the optimization directly below this if-statement. */
12634 if (((!NILP (Vtransient_mark_mode
)
12635 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12636 != !NILP (w
->region_showing
))
12637 || (!NILP (w
->region_showing
)
12638 && !EQ (w
->region_showing
,
12639 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12640 CHARPOS (this_line_start_pos
) = 0;
12642 /* Optimize the case that only the line containing the cursor in the
12643 selected window has changed. Variables starting with this_ are
12644 set in display_line and record information about the line
12645 containing the cursor. */
12646 tlbufpos
= this_line_start_pos
;
12647 tlendpos
= this_line_end_pos
;
12648 if (!consider_all_windows_p
12649 && CHARPOS (tlbufpos
) > 0
12650 && NILP (w
->update_mode_line
)
12651 && !current_buffer
->clip_changed
12652 && !current_buffer
->prevent_redisplay_optimizations_p
12653 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12654 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12655 /* Make sure recorded data applies to current buffer, etc. */
12656 && this_line_buffer
== current_buffer
12657 && current_buffer
== XBUFFER (w
->buffer
)
12658 && NILP (w
->force_start
)
12659 && NILP (w
->optional_new_start
)
12660 /* Point must be on the line that we have info recorded about. */
12661 && PT
>= CHARPOS (tlbufpos
)
12662 && PT
<= Z
- CHARPOS (tlendpos
)
12663 /* All text outside that line, including its final newline,
12664 must be unchanged. */
12665 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12666 CHARPOS (tlendpos
)))
12668 if (CHARPOS (tlbufpos
) > BEGV
12669 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12670 && (CHARPOS (tlbufpos
) == ZV
12671 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12672 /* Former continuation line has disappeared by becoming empty. */
12674 else if (XFASTINT (w
->last_modified
) < MODIFF
12675 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12676 || MINI_WINDOW_P (w
))
12678 /* We have to handle the case of continuation around a
12679 wide-column character (see the comment in indent.c around
12682 For instance, in the following case:
12684 -------- Insert --------
12685 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12686 J_I_ ==> J_I_ `^^' are cursors.
12690 As we have to redraw the line above, we cannot use this
12694 int line_height_before
= this_line_pixel_height
;
12696 /* Note that start_display will handle the case that the
12697 line starting at tlbufpos is a continuation line. */
12698 start_display (&it
, w
, tlbufpos
);
12700 /* Implementation note: It this still necessary? */
12701 if (it
.current_x
!= this_line_start_x
)
12704 TRACE ((stderr
, "trying display optimization 1\n"));
12705 w
->cursor
.vpos
= -1;
12706 overlay_arrow_seen
= 0;
12707 it
.vpos
= this_line_vpos
;
12708 it
.current_y
= this_line_y
;
12709 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12710 display_line (&it
);
12712 /* If line contains point, is not continued,
12713 and ends at same distance from eob as before, we win. */
12714 if (w
->cursor
.vpos
>= 0
12715 /* Line is not continued, otherwise this_line_start_pos
12716 would have been set to 0 in display_line. */
12717 && CHARPOS (this_line_start_pos
)
12718 /* Line ends as before. */
12719 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12720 /* Line has same height as before. Otherwise other lines
12721 would have to be shifted up or down. */
12722 && this_line_pixel_height
== line_height_before
)
12724 /* If this is not the window's last line, we must adjust
12725 the charstarts of the lines below. */
12726 if (it
.current_y
< it
.last_visible_y
)
12728 struct glyph_row
*row
12729 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12730 ptrdiff_t delta
, delta_bytes
;
12732 /* We used to distinguish between two cases here,
12733 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12734 when the line ends in a newline or the end of the
12735 buffer's accessible portion. But both cases did
12736 the same, so they were collapsed. */
12738 - CHARPOS (tlendpos
)
12739 - MATRIX_ROW_START_CHARPOS (row
));
12740 delta_bytes
= (Z_BYTE
12741 - BYTEPOS (tlendpos
)
12742 - MATRIX_ROW_START_BYTEPOS (row
));
12744 increment_matrix_positions (w
->current_matrix
,
12745 this_line_vpos
+ 1,
12746 w
->current_matrix
->nrows
,
12747 delta
, delta_bytes
);
12750 /* If this row displays text now but previously didn't,
12751 or vice versa, w->window_end_vpos may have to be
12753 if ((it
.glyph_row
- 1)->displays_text_p
)
12755 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12756 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12758 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12759 && this_line_vpos
> 0)
12760 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12761 w
->window_end_valid
= Qnil
;
12763 /* Update hint: No need to try to scroll in update_window. */
12764 w
->desired_matrix
->no_scrolling_p
= 1;
12767 *w
->desired_matrix
->method
= 0;
12768 debug_method_add (w
, "optimization 1");
12770 #ifdef HAVE_WINDOW_SYSTEM
12771 update_window_fringes (w
, 0);
12778 else if (/* Cursor position hasn't changed. */
12779 PT
== XFASTINT (w
->last_point
)
12780 /* Make sure the cursor was last displayed
12781 in this window. Otherwise we have to reposition it. */
12782 && 0 <= w
->cursor
.vpos
12783 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12787 do_pending_window_change (1);
12788 /* If selected_window changed, redisplay again. */
12789 if (WINDOWP (selected_window
)
12790 && (w
= XWINDOW (selected_window
)) != sw
)
12793 /* We used to always goto end_of_redisplay here, but this
12794 isn't enough if we have a blinking cursor. */
12795 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12796 goto end_of_redisplay
;
12800 /* If highlighting the region, or if the cursor is in the echo area,
12801 then we can't just move the cursor. */
12802 else if (! (!NILP (Vtransient_mark_mode
)
12803 && !NILP (BVAR (current_buffer
, mark_active
)))
12804 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12805 || highlight_nonselected_windows
)
12806 && NILP (w
->region_showing
)
12807 && NILP (Vshow_trailing_whitespace
)
12808 && !cursor_in_echo_area
)
12811 struct glyph_row
*row
;
12813 /* Skip from tlbufpos to PT and see where it is. Note that
12814 PT may be in invisible text. If so, we will end at the
12815 next visible position. */
12816 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12817 NULL
, DEFAULT_FACE_ID
);
12818 it
.current_x
= this_line_start_x
;
12819 it
.current_y
= this_line_y
;
12820 it
.vpos
= this_line_vpos
;
12822 /* The call to move_it_to stops in front of PT, but
12823 moves over before-strings. */
12824 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12826 if (it
.vpos
== this_line_vpos
12827 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12830 xassert (this_line_vpos
== it
.vpos
);
12831 xassert (this_line_y
== it
.current_y
);
12832 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12834 *w
->desired_matrix
->method
= 0;
12835 debug_method_add (w
, "optimization 3");
12844 /* Text changed drastically or point moved off of line. */
12845 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12848 CHARPOS (this_line_start_pos
) = 0;
12849 consider_all_windows_p
|= buffer_shared
> 1;
12850 ++clear_face_cache_count
;
12851 #ifdef HAVE_WINDOW_SYSTEM
12852 ++clear_image_cache_count
;
12855 /* Build desired matrices, and update the display. If
12856 consider_all_windows_p is non-zero, do it for all windows on all
12857 frames. Otherwise do it for selected_window, only. */
12859 if (consider_all_windows_p
)
12861 Lisp_Object tail
, frame
;
12863 FOR_EACH_FRAME (tail
, frame
)
12864 XFRAME (frame
)->updated_p
= 0;
12866 /* Recompute # windows showing selected buffer. This will be
12867 incremented each time such a window is displayed. */
12870 FOR_EACH_FRAME (tail
, frame
)
12872 struct frame
*f
= XFRAME (frame
);
12874 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12876 if (! EQ (frame
, selected_frame
))
12877 /* Select the frame, for the sake of frame-local
12879 select_frame_for_redisplay (frame
);
12881 /* Mark all the scroll bars to be removed; we'll redeem
12882 the ones we want when we redisplay their windows. */
12883 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12884 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12886 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12887 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12889 /* The X error handler may have deleted that frame. */
12890 if (!FRAME_LIVE_P (f
))
12893 /* Any scroll bars which redisplay_windows should have
12894 nuked should now go away. */
12895 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12896 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12898 /* If fonts changed, display again. */
12899 /* ??? rms: I suspect it is a mistake to jump all the way
12900 back to retry here. It should just retry this frame. */
12901 if (fonts_changed_p
)
12904 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12906 /* See if we have to hscroll. */
12907 if (!f
->already_hscrolled_p
)
12909 f
->already_hscrolled_p
= 1;
12910 if (hscroll_windows (f
->root_window
))
12914 /* Prevent various kinds of signals during display
12915 update. stdio is not robust about handling
12916 signals, which can cause an apparent I/O
12918 if (interrupt_input
)
12919 unrequest_sigio ();
12922 /* Update the display. */
12923 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12924 pending
|= update_frame (f
, 0, 0);
12930 if (!EQ (old_frame
, selected_frame
)
12931 && FRAME_LIVE_P (XFRAME (old_frame
)))
12932 /* We played a bit fast-and-loose above and allowed selected_frame
12933 and selected_window to be temporarily out-of-sync but let's make
12934 sure this stays contained. */
12935 select_frame_for_redisplay (old_frame
);
12936 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12940 /* Do the mark_window_display_accurate after all windows have
12941 been redisplayed because this call resets flags in buffers
12942 which are needed for proper redisplay. */
12943 FOR_EACH_FRAME (tail
, frame
)
12945 struct frame
*f
= XFRAME (frame
);
12948 mark_window_display_accurate (f
->root_window
, 1);
12949 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12950 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12955 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12957 Lisp_Object mini_window
;
12958 struct frame
*mini_frame
;
12960 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12961 /* Use list_of_error, not Qerror, so that
12962 we catch only errors and don't run the debugger. */
12963 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12965 redisplay_window_error
);
12967 /* Compare desired and current matrices, perform output. */
12970 /* If fonts changed, display again. */
12971 if (fonts_changed_p
)
12974 /* Prevent various kinds of signals during display update.
12975 stdio is not robust about handling signals,
12976 which can cause an apparent I/O error. */
12977 if (interrupt_input
)
12978 unrequest_sigio ();
12981 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12983 if (hscroll_windows (selected_window
))
12986 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12987 pending
= update_frame (sf
, 0, 0);
12990 /* We may have called echo_area_display at the top of this
12991 function. If the echo area is on another frame, that may
12992 have put text on a frame other than the selected one, so the
12993 above call to update_frame would not have caught it. Catch
12995 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12996 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12998 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13000 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13001 pending
|= update_frame (mini_frame
, 0, 0);
13002 if (!pending
&& hscroll_windows (mini_window
))
13007 /* If display was paused because of pending input, make sure we do a
13008 thorough update the next time. */
13011 /* Prevent the optimization at the beginning of
13012 redisplay_internal that tries a single-line update of the
13013 line containing the cursor in the selected window. */
13014 CHARPOS (this_line_start_pos
) = 0;
13016 /* Let the overlay arrow be updated the next time. */
13017 update_overlay_arrows (0);
13019 /* If we pause after scrolling, some rows in the current
13020 matrices of some windows are not valid. */
13021 if (!WINDOW_FULL_WIDTH_P (w
)
13022 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13023 update_mode_lines
= 1;
13027 if (!consider_all_windows_p
)
13029 /* This has already been done above if
13030 consider_all_windows_p is set. */
13031 mark_window_display_accurate_1 (w
, 1);
13033 /* Say overlay arrows are up to date. */
13034 update_overlay_arrows (1);
13036 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13037 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13040 update_mode_lines
= 0;
13041 windows_or_buffers_changed
= 0;
13042 cursor_type_changed
= 0;
13045 /* Start SIGIO interrupts coming again. Having them off during the
13046 code above makes it less likely one will discard output, but not
13047 impossible, since there might be stuff in the system buffer here.
13048 But it is much hairier to try to do anything about that. */
13049 if (interrupt_input
)
13053 /* If a frame has become visible which was not before, redisplay
13054 again, so that we display it. Expose events for such a frame
13055 (which it gets when becoming visible) don't call the parts of
13056 redisplay constructing glyphs, so simply exposing a frame won't
13057 display anything in this case. So, we have to display these
13058 frames here explicitly. */
13061 Lisp_Object tail
, frame
;
13064 FOR_EACH_FRAME (tail
, frame
)
13066 int this_is_visible
= 0;
13068 if (XFRAME (frame
)->visible
)
13069 this_is_visible
= 1;
13070 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13071 if (XFRAME (frame
)->visible
)
13072 this_is_visible
= 1;
13074 if (this_is_visible
)
13078 if (new_count
!= number_of_visible_frames
)
13079 windows_or_buffers_changed
++;
13082 /* Change frame size now if a change is pending. */
13083 do_pending_window_change (1);
13085 /* If we just did a pending size change, or have additional
13086 visible frames, or selected_window changed, redisplay again. */
13087 if ((windows_or_buffers_changed
&& !pending
)
13088 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13091 /* Clear the face and image caches.
13093 We used to do this only if consider_all_windows_p. But the cache
13094 needs to be cleared if a timer creates images in the current
13095 buffer (e.g. the test case in Bug#6230). */
13097 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13099 clear_face_cache (0);
13100 clear_face_cache_count
= 0;
13103 #ifdef HAVE_WINDOW_SYSTEM
13104 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13106 clear_image_caches (Qnil
);
13107 clear_image_cache_count
= 0;
13109 #endif /* HAVE_WINDOW_SYSTEM */
13112 unbind_to (count
, Qnil
);
13117 /* Redisplay, but leave alone any recent echo area message unless
13118 another message has been requested in its place.
13120 This is useful in situations where you need to redisplay but no
13121 user action has occurred, making it inappropriate for the message
13122 area to be cleared. See tracking_off and
13123 wait_reading_process_output for examples of these situations.
13125 FROM_WHERE is an integer saying from where this function was
13126 called. This is useful for debugging. */
13129 redisplay_preserve_echo_area (int from_where
)
13131 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13133 if (!NILP (echo_area_buffer
[1]))
13135 /* We have a previously displayed message, but no current
13136 message. Redisplay the previous message. */
13137 display_last_displayed_message_p
= 1;
13138 redisplay_internal ();
13139 display_last_displayed_message_p
= 0;
13142 redisplay_internal ();
13144 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13145 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13146 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13150 /* Function registered with record_unwind_protect in
13151 redisplay_internal. Reset redisplaying_p to the value it had
13152 before redisplay_internal was called, and clear
13153 prevent_freeing_realized_faces_p. It also selects the previously
13154 selected frame, unless it has been deleted (by an X connection
13155 failure during redisplay, for example). */
13158 unwind_redisplay (Lisp_Object val
)
13160 Lisp_Object old_redisplaying_p
, old_frame
;
13162 old_redisplaying_p
= XCAR (val
);
13163 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13164 old_frame
= XCDR (val
);
13165 if (! EQ (old_frame
, selected_frame
)
13166 && FRAME_LIVE_P (XFRAME (old_frame
)))
13167 select_frame_for_redisplay (old_frame
);
13172 /* Mark the display of window W as accurate or inaccurate. If
13173 ACCURATE_P is non-zero mark display of W as accurate. If
13174 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13175 redisplay_internal is called. */
13178 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13180 if (BUFFERP (w
->buffer
))
13182 struct buffer
*b
= XBUFFER (w
->buffer
);
13185 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13186 w
->last_overlay_modified
13187 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13189 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13193 b
->clip_changed
= 0;
13194 b
->prevent_redisplay_optimizations_p
= 0;
13196 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13197 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13198 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13199 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13201 w
->current_matrix
->buffer
= b
;
13202 w
->current_matrix
->begv
= BUF_BEGV (b
);
13203 w
->current_matrix
->zv
= BUF_ZV (b
);
13205 w
->last_cursor
= w
->cursor
;
13206 w
->last_cursor_off_p
= w
->cursor_off_p
;
13208 if (w
== XWINDOW (selected_window
))
13209 w
->last_point
= make_number (BUF_PT (b
));
13211 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13217 w
->window_end_valid
= w
->buffer
;
13218 w
->update_mode_line
= Qnil
;
13223 /* Mark the display of windows in the window tree rooted at WINDOW as
13224 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13225 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13226 be redisplayed the next time redisplay_internal is called. */
13229 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13233 for (; !NILP (window
); window
= w
->next
)
13235 w
= XWINDOW (window
);
13236 mark_window_display_accurate_1 (w
, accurate_p
);
13238 if (!NILP (w
->vchild
))
13239 mark_window_display_accurate (w
->vchild
, accurate_p
);
13240 if (!NILP (w
->hchild
))
13241 mark_window_display_accurate (w
->hchild
, accurate_p
);
13246 update_overlay_arrows (1);
13250 /* Force a thorough redisplay the next time by setting
13251 last_arrow_position and last_arrow_string to t, which is
13252 unequal to any useful value of Voverlay_arrow_... */
13253 update_overlay_arrows (-1);
13258 /* Return value in display table DP (Lisp_Char_Table *) for character
13259 C. Since a display table doesn't have any parent, we don't have to
13260 follow parent. Do not call this function directly but use the
13261 macro DISP_CHAR_VECTOR. */
13264 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13268 if (ASCII_CHAR_P (c
))
13271 if (SUB_CHAR_TABLE_P (val
))
13272 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13278 XSETCHAR_TABLE (table
, dp
);
13279 val
= char_table_ref (table
, c
);
13288 /***********************************************************************
13290 ***********************************************************************/
13292 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13295 redisplay_windows (Lisp_Object window
)
13297 while (!NILP (window
))
13299 struct window
*w
= XWINDOW (window
);
13301 if (!NILP (w
->hchild
))
13302 redisplay_windows (w
->hchild
);
13303 else if (!NILP (w
->vchild
))
13304 redisplay_windows (w
->vchild
);
13305 else if (!NILP (w
->buffer
))
13307 displayed_buffer
= XBUFFER (w
->buffer
);
13308 /* Use list_of_error, not Qerror, so that
13309 we catch only errors and don't run the debugger. */
13310 internal_condition_case_1 (redisplay_window_0
, window
,
13312 redisplay_window_error
);
13320 redisplay_window_error (Lisp_Object ignore
)
13322 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13327 redisplay_window_0 (Lisp_Object window
)
13329 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13330 redisplay_window (window
, 0);
13335 redisplay_window_1 (Lisp_Object window
)
13337 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13338 redisplay_window (window
, 1);
13343 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13344 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13345 which positions recorded in ROW differ from current buffer
13348 Return 0 if cursor is not on this row, 1 otherwise. */
13351 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13352 struct glyph_matrix
*matrix
,
13353 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13356 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13357 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13358 struct glyph
*cursor
= NULL
;
13359 /* The last known character position in row. */
13360 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13362 ptrdiff_t pt_old
= PT
- delta
;
13363 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13364 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13365 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13366 /* A glyph beyond the edge of TEXT_AREA which we should never
13368 struct glyph
*glyphs_end
= end
;
13369 /* Non-zero means we've found a match for cursor position, but that
13370 glyph has the avoid_cursor_p flag set. */
13371 int match_with_avoid_cursor
= 0;
13372 /* Non-zero means we've seen at least one glyph that came from a
13374 int string_seen
= 0;
13375 /* Largest and smalles buffer positions seen so far during scan of
13377 ptrdiff_t bpos_max
= pos_before
;
13378 ptrdiff_t bpos_min
= pos_after
;
13379 /* Last buffer position covered by an overlay string with an integer
13380 `cursor' property. */
13381 ptrdiff_t bpos_covered
= 0;
13382 /* Non-zero means the display string on which to display the cursor
13383 comes from a text property, not from an overlay. */
13384 int string_from_text_prop
= 0;
13386 /* Skip over glyphs not having an object at the start and the end of
13387 the row. These are special glyphs like truncation marks on
13388 terminal frames. */
13389 if (row
->displays_text_p
)
13391 if (!row
->reversed_p
)
13394 && INTEGERP (glyph
->object
)
13395 && glyph
->charpos
< 0)
13397 x
+= glyph
->pixel_width
;
13401 && INTEGERP ((end
- 1)->object
)
13402 /* CHARPOS is zero for blanks and stretch glyphs
13403 inserted by extend_face_to_end_of_line. */
13404 && (end
- 1)->charpos
<= 0)
13406 glyph_before
= glyph
- 1;
13413 /* If the glyph row is reversed, we need to process it from back
13414 to front, so swap the edge pointers. */
13415 glyphs_end
= end
= glyph
- 1;
13416 glyph
+= row
->used
[TEXT_AREA
] - 1;
13418 while (glyph
> end
+ 1
13419 && INTEGERP (glyph
->object
)
13420 && glyph
->charpos
< 0)
13423 x
-= glyph
->pixel_width
;
13425 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13427 /* By default, in reversed rows we put the cursor on the
13428 rightmost (first in the reading order) glyph. */
13429 for (g
= end
+ 1; g
< glyph
; g
++)
13430 x
+= g
->pixel_width
;
13432 && INTEGERP ((end
+ 1)->object
)
13433 && (end
+ 1)->charpos
<= 0)
13435 glyph_before
= glyph
+ 1;
13439 else if (row
->reversed_p
)
13441 /* In R2L rows that don't display text, put the cursor on the
13442 rightmost glyph. Case in point: an empty last line that is
13443 part of an R2L paragraph. */
13445 /* Avoid placing the cursor on the last glyph of the row, where
13446 on terminal frames we hold the vertical border between
13447 adjacent windows. */
13448 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13449 && !WINDOW_RIGHTMOST_P (w
)
13450 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13452 x
= -1; /* will be computed below, at label compute_x */
13455 /* Step 1: Try to find the glyph whose character position
13456 corresponds to point. If that's not possible, find 2 glyphs
13457 whose character positions are the closest to point, one before
13458 point, the other after it. */
13459 if (!row
->reversed_p
)
13460 while (/* not marched to end of glyph row */
13462 /* glyph was not inserted by redisplay for internal purposes */
13463 && !INTEGERP (glyph
->object
))
13465 if (BUFFERP (glyph
->object
))
13467 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13469 if (glyph
->charpos
> bpos_max
)
13470 bpos_max
= glyph
->charpos
;
13471 if (glyph
->charpos
< bpos_min
)
13472 bpos_min
= glyph
->charpos
;
13473 if (!glyph
->avoid_cursor_p
)
13475 /* If we hit point, we've found the glyph on which to
13476 display the cursor. */
13479 match_with_avoid_cursor
= 0;
13482 /* See if we've found a better approximation to
13483 POS_BEFORE or to POS_AFTER. Note that we want the
13484 first (leftmost) glyph of all those that are the
13485 closest from below, and the last (rightmost) of all
13486 those from above. */
13487 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13489 pos_before
= glyph
->charpos
;
13490 glyph_before
= glyph
;
13492 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13494 pos_after
= glyph
->charpos
;
13495 glyph_after
= glyph
;
13498 else if (dpos
== 0)
13499 match_with_avoid_cursor
= 1;
13501 else if (STRINGP (glyph
->object
))
13503 Lisp_Object chprop
;
13504 ptrdiff_t glyph_pos
= glyph
->charpos
;
13506 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13508 if (INTEGERP (chprop
))
13510 bpos_covered
= bpos_max
+ XINT (chprop
);
13511 /* If the `cursor' property covers buffer positions up
13512 to and including point, we should display cursor on
13513 this glyph. Note that overlays and text properties
13514 with string values stop bidi reordering, so every
13515 buffer position to the left of the string is always
13516 smaller than any position to the right of the
13517 string. Therefore, if a `cursor' property on one
13518 of the string's characters has an integer value, we
13519 will break out of the loop below _before_ we get to
13520 the position match above. IOW, integer values of
13521 the `cursor' property override the "exact match for
13522 point" strategy of positioning the cursor. */
13523 /* Implementation note: bpos_max == pt_old when, e.g.,
13524 we are in an empty line, where bpos_max is set to
13525 MATRIX_ROW_START_CHARPOS, see above. */
13526 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13535 x
+= glyph
->pixel_width
;
13538 else if (glyph
> end
) /* row is reversed */
13539 while (!INTEGERP (glyph
->object
))
13541 if (BUFFERP (glyph
->object
))
13543 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13545 if (glyph
->charpos
> bpos_max
)
13546 bpos_max
= glyph
->charpos
;
13547 if (glyph
->charpos
< bpos_min
)
13548 bpos_min
= glyph
->charpos
;
13549 if (!glyph
->avoid_cursor_p
)
13553 match_with_avoid_cursor
= 0;
13556 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13558 pos_before
= glyph
->charpos
;
13559 glyph_before
= glyph
;
13561 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13563 pos_after
= glyph
->charpos
;
13564 glyph_after
= glyph
;
13567 else if (dpos
== 0)
13568 match_with_avoid_cursor
= 1;
13570 else if (STRINGP (glyph
->object
))
13572 Lisp_Object chprop
;
13573 ptrdiff_t glyph_pos
= glyph
->charpos
;
13575 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13577 if (INTEGERP (chprop
))
13579 bpos_covered
= bpos_max
+ XINT (chprop
);
13580 /* If the `cursor' property covers buffer positions up
13581 to and including point, we should display cursor on
13583 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13592 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13594 x
--; /* can't use any pixel_width */
13597 x
-= glyph
->pixel_width
;
13600 /* Step 2: If we didn't find an exact match for point, we need to
13601 look for a proper place to put the cursor among glyphs between
13602 GLYPH_BEFORE and GLYPH_AFTER. */
13603 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13604 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13605 && bpos_covered
< pt_old
)
13607 /* An empty line has a single glyph whose OBJECT is zero and
13608 whose CHARPOS is the position of a newline on that line.
13609 Note that on a TTY, there are more glyphs after that, which
13610 were produced by extend_face_to_end_of_line, but their
13611 CHARPOS is zero or negative. */
13613 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13614 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13616 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13618 ptrdiff_t ellipsis_pos
;
13620 /* Scan back over the ellipsis glyphs. */
13621 if (!row
->reversed_p
)
13623 ellipsis_pos
= (glyph
- 1)->charpos
;
13624 while (glyph
> row
->glyphs
[TEXT_AREA
]
13625 && (glyph
- 1)->charpos
== ellipsis_pos
)
13626 glyph
--, x
-= glyph
->pixel_width
;
13627 /* That loop always goes one position too far, including
13628 the glyph before the ellipsis. So scan forward over
13630 x
+= glyph
->pixel_width
;
13633 else /* row is reversed */
13635 ellipsis_pos
= (glyph
+ 1)->charpos
;
13636 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13637 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13638 glyph
++, x
+= glyph
->pixel_width
;
13639 x
-= glyph
->pixel_width
;
13643 else if (match_with_avoid_cursor
13644 /* A truncated row may not include PT among its
13645 character positions. Setting the cursor inside the
13646 scroll margin will trigger recalculation of hscroll
13647 in hscroll_window_tree. */
13648 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13649 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13650 /* Zero-width characters produce no glyphs. */
13653 && (row
->reversed_p
13654 ? glyph_after
> glyphs_end
13655 : glyph_after
< glyphs_end
)))
13657 cursor
= glyph_after
;
13660 else if (string_seen
)
13662 int incr
= row
->reversed_p
? -1 : +1;
13664 /* Need to find the glyph that came out of a string which is
13665 present at point. That glyph is somewhere between
13666 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13667 positioned between POS_BEFORE and POS_AFTER in the
13669 struct glyph
*start
, *stop
;
13670 ptrdiff_t pos
= pos_before
;
13674 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13675 correspond to POS_BEFORE and POS_AFTER, respectively. We
13676 need START and STOP in the order that corresponds to the
13677 row's direction as given by its reversed_p flag. If the
13678 directionality of characters between POS_BEFORE and
13679 POS_AFTER is the opposite of the row's base direction,
13680 these characters will have been reordered for display,
13681 and we need to reverse START and STOP. */
13682 if (!row
->reversed_p
)
13684 start
= min (glyph_before
, glyph_after
);
13685 stop
= max (glyph_before
, glyph_after
);
13689 start
= max (glyph_before
, glyph_after
);
13690 stop
= min (glyph_before
, glyph_after
);
13692 for (glyph
= start
+ incr
;
13693 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13696 /* Any glyphs that come from the buffer are here because
13697 of bidi reordering. Skip them, and only pay
13698 attention to glyphs that came from some string. */
13699 if (STRINGP (glyph
->object
))
13703 /* If the display property covers the newline, we
13704 need to search for it one position farther. */
13705 ptrdiff_t lim
= pos_after
13706 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13708 string_from_text_prop
= 0;
13709 str
= glyph
->object
;
13710 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13711 if (tem
== 0 /* from overlay */
13714 /* If the string from which this glyph came is
13715 found in the buffer at point, then we've
13716 found the glyph we've been looking for. If
13717 it comes from an overlay (tem == 0), and it
13718 has the `cursor' property on one of its
13719 glyphs, record that glyph as a candidate for
13720 displaying the cursor. (As in the
13721 unidirectional version, we will display the
13722 cursor on the last candidate we find.) */
13723 if (tem
== 0 || tem
== pt_old
)
13725 /* The glyphs from this string could have
13726 been reordered. Find the one with the
13727 smallest string position. Or there could
13728 be a character in the string with the
13729 `cursor' property, which means display
13730 cursor on that character's glyph. */
13731 ptrdiff_t strpos
= glyph
->charpos
;
13736 string_from_text_prop
= 1;
13739 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13740 && EQ (glyph
->object
, str
);
13744 ptrdiff_t gpos
= glyph
->charpos
;
13746 cprop
= Fget_char_property (make_number (gpos
),
13754 if (tem
&& glyph
->charpos
< strpos
)
13756 strpos
= glyph
->charpos
;
13765 pos
= tem
+ 1; /* don't find previous instances */
13767 /* This string is not what we want; skip all of the
13768 glyphs that came from it. */
13769 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13770 && EQ (glyph
->object
, str
))
13777 /* If we reached the end of the line, and END was from a string,
13778 the cursor is not on this line. */
13780 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13781 && STRINGP (end
->object
)
13782 && row
->continued_p
)
13788 if (cursor
!= NULL
)
13794 /* Need to compute x that corresponds to GLYPH. */
13795 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13797 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13799 x
+= g
->pixel_width
;
13803 /* ROW could be part of a continued line, which, under bidi
13804 reordering, might have other rows whose start and end charpos
13805 occlude point. Only set w->cursor if we found a better
13806 approximation to the cursor position than we have from previously
13807 examined candidate rows belonging to the same continued line. */
13808 if (/* we already have a candidate row */
13809 w
->cursor
.vpos
>= 0
13810 /* that candidate is not the row we are processing */
13811 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13812 /* Make sure cursor.vpos specifies a row whose start and end
13813 charpos occlude point, and it is valid candidate for being a
13814 cursor-row. This is because some callers of this function
13815 leave cursor.vpos at the row where the cursor was displayed
13816 during the last redisplay cycle. */
13817 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13818 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13819 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13822 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13824 /* Don't consider glyphs that are outside TEXT_AREA. */
13825 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13827 /* Keep the candidate whose buffer position is the closest to
13828 point or has the `cursor' property. */
13829 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13830 w
->cursor
.hpos
>= 0
13831 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13832 && ((BUFFERP (g1
->object
)
13833 && (g1
->charpos
== pt_old
/* an exact match always wins */
13834 || (BUFFERP (glyph
->object
)
13835 && eabs (g1
->charpos
- pt_old
)
13836 < eabs (glyph
->charpos
- pt_old
))))
13837 /* previous candidate is a glyph from a string that has
13838 a non-nil `cursor' property */
13839 || (STRINGP (g1
->object
)
13840 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13841 Qcursor
, g1
->object
))
13842 /* pevious candidate is from the same display
13843 string as this one, and the display string
13844 came from a text property */
13845 || (EQ (g1
->object
, glyph
->object
)
13846 && string_from_text_prop
)
13847 /* this candidate is from newline and its
13848 position is not an exact match */
13849 || (INTEGERP (glyph
->object
)
13850 && glyph
->charpos
!= pt_old
)))))
13852 /* If this candidate gives an exact match, use that. */
13853 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13854 /* If this candidate is a glyph created for the
13855 terminating newline of a line, and point is on that
13856 newline, it wins because it's an exact match. */
13857 || (!row
->continued_p
13858 && INTEGERP (glyph
->object
)
13859 && glyph
->charpos
== 0
13860 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
13861 /* Otherwise, keep the candidate that comes from a row
13862 spanning less buffer positions. This may win when one or
13863 both candidate positions are on glyphs that came from
13864 display strings, for which we cannot compare buffer
13866 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13867 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13868 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13871 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13873 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13874 w
->cursor
.y
= row
->y
+ dy
;
13876 if (w
== XWINDOW (selected_window
))
13878 if (!row
->continued_p
13879 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13882 this_line_buffer
= XBUFFER (w
->buffer
);
13884 CHARPOS (this_line_start_pos
)
13885 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13886 BYTEPOS (this_line_start_pos
)
13887 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13889 CHARPOS (this_line_end_pos
)
13890 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13891 BYTEPOS (this_line_end_pos
)
13892 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13894 this_line_y
= w
->cursor
.y
;
13895 this_line_pixel_height
= row
->height
;
13896 this_line_vpos
= w
->cursor
.vpos
;
13897 this_line_start_x
= row
->x
;
13900 CHARPOS (this_line_start_pos
) = 0;
13907 /* Run window scroll functions, if any, for WINDOW with new window
13908 start STARTP. Sets the window start of WINDOW to that position.
13910 We assume that the window's buffer is really current. */
13912 static inline struct text_pos
13913 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13915 struct window
*w
= XWINDOW (window
);
13916 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13918 if (current_buffer
!= XBUFFER (w
->buffer
))
13921 if (!NILP (Vwindow_scroll_functions
))
13923 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13924 make_number (CHARPOS (startp
)));
13925 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13926 /* In case the hook functions switch buffers. */
13927 if (current_buffer
!= XBUFFER (w
->buffer
))
13928 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13935 /* Make sure the line containing the cursor is fully visible.
13936 A value of 1 means there is nothing to be done.
13937 (Either the line is fully visible, or it cannot be made so,
13938 or we cannot tell.)
13940 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13941 is higher than window.
13943 A value of 0 means the caller should do scrolling
13944 as if point had gone off the screen. */
13947 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13949 struct glyph_matrix
*matrix
;
13950 struct glyph_row
*row
;
13953 if (!make_cursor_line_fully_visible_p
)
13956 /* It's not always possible to find the cursor, e.g, when a window
13957 is full of overlay strings. Don't do anything in that case. */
13958 if (w
->cursor
.vpos
< 0)
13961 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13962 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13964 /* If the cursor row is not partially visible, there's nothing to do. */
13965 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13968 /* If the row the cursor is in is taller than the window's height,
13969 it's not clear what to do, so do nothing. */
13970 window_height
= window_box_height (w
);
13971 if (row
->height
>= window_height
)
13973 if (!force_p
|| MINI_WINDOW_P (w
)
13974 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13981 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13982 non-zero means only WINDOW is redisplayed in redisplay_internal.
13983 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13984 in redisplay_window to bring a partially visible line into view in
13985 the case that only the cursor has moved.
13987 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13988 last screen line's vertical height extends past the end of the screen.
13992 1 if scrolling succeeded
13994 0 if scrolling didn't find point.
13996 -1 if new fonts have been loaded so that we must interrupt
13997 redisplay, adjust glyph matrices, and try again. */
14003 SCROLLING_NEED_LARGER_MATRICES
14006 /* If scroll-conservatively is more than this, never recenter.
14008 If you change this, don't forget to update the doc string of
14009 `scroll-conservatively' and the Emacs manual. */
14010 #define SCROLL_LIMIT 100
14013 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14014 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14015 int temp_scroll_step
, int last_line_misfit
)
14017 struct window
*w
= XWINDOW (window
);
14018 struct frame
*f
= XFRAME (w
->frame
);
14019 struct text_pos pos
, startp
;
14021 int this_scroll_margin
, scroll_max
, rc
, height
;
14022 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14023 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14024 Lisp_Object aggressive
;
14025 /* We will never try scrolling more than this number of lines. */
14026 int scroll_limit
= SCROLL_LIMIT
;
14029 debug_method_add (w
, "try_scrolling");
14032 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14034 /* Compute scroll margin height in pixels. We scroll when point is
14035 within this distance from the top or bottom of the window. */
14036 if (scroll_margin
> 0)
14037 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14038 * FRAME_LINE_HEIGHT (f
);
14040 this_scroll_margin
= 0;
14042 /* Force arg_scroll_conservatively to have a reasonable value, to
14043 avoid scrolling too far away with slow move_it_* functions. Note
14044 that the user can supply scroll-conservatively equal to
14045 `most-positive-fixnum', which can be larger than INT_MAX. */
14046 if (arg_scroll_conservatively
> scroll_limit
)
14048 arg_scroll_conservatively
= scroll_limit
+ 1;
14049 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14051 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14052 /* Compute how much we should try to scroll maximally to bring
14053 point into view. */
14054 scroll_max
= (max (scroll_step
,
14055 max (arg_scroll_conservatively
, temp_scroll_step
))
14056 * FRAME_LINE_HEIGHT (f
));
14057 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14058 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14059 /* We're trying to scroll because of aggressive scrolling but no
14060 scroll_step is set. Choose an arbitrary one. */
14061 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14067 /* Decide whether to scroll down. */
14068 if (PT
> CHARPOS (startp
))
14070 int scroll_margin_y
;
14072 /* Compute the pixel ypos of the scroll margin, then move it to
14073 either that ypos or PT, whichever comes first. */
14074 start_display (&it
, w
, startp
);
14075 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14076 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14077 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14078 (MOVE_TO_POS
| MOVE_TO_Y
));
14080 if (PT
> CHARPOS (it
.current
.pos
))
14082 int y0
= line_bottom_y (&it
);
14083 /* Compute how many pixels below window bottom to stop searching
14084 for PT. This avoids costly search for PT that is far away if
14085 the user limited scrolling by a small number of lines, but
14086 always finds PT if scroll_conservatively is set to a large
14087 number, such as most-positive-fixnum. */
14088 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14089 int y_to_move
= it
.last_visible_y
+ slack
;
14091 /* Compute the distance from the scroll margin to PT or to
14092 the scroll limit, whichever comes first. This should
14093 include the height of the cursor line, to make that line
14095 move_it_to (&it
, PT
, -1, y_to_move
,
14096 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14097 dy
= line_bottom_y (&it
) - y0
;
14099 if (dy
> scroll_max
)
14100 return SCROLLING_FAILED
;
14108 /* Point is in or below the bottom scroll margin, so move the
14109 window start down. If scrolling conservatively, move it just
14110 enough down to make point visible. If scroll_step is set,
14111 move it down by scroll_step. */
14112 if (arg_scroll_conservatively
)
14114 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14115 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14116 else if (scroll_step
|| temp_scroll_step
)
14117 amount_to_scroll
= scroll_max
;
14120 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14121 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14122 if (NUMBERP (aggressive
))
14124 double float_amount
= XFLOATINT (aggressive
) * height
;
14125 amount_to_scroll
= float_amount
;
14126 if (amount_to_scroll
== 0 && float_amount
> 0)
14127 amount_to_scroll
= 1;
14128 /* Don't let point enter the scroll margin near top of
14130 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14131 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14135 if (amount_to_scroll
<= 0)
14136 return SCROLLING_FAILED
;
14138 start_display (&it
, w
, startp
);
14139 if (arg_scroll_conservatively
<= scroll_limit
)
14140 move_it_vertically (&it
, amount_to_scroll
);
14143 /* Extra precision for users who set scroll-conservatively
14144 to a large number: make sure the amount we scroll
14145 the window start is never less than amount_to_scroll,
14146 which was computed as distance from window bottom to
14147 point. This matters when lines at window top and lines
14148 below window bottom have different height. */
14150 void *it1data
= NULL
;
14151 /* We use a temporary it1 because line_bottom_y can modify
14152 its argument, if it moves one line down; see there. */
14155 SAVE_IT (it1
, it
, it1data
);
14156 start_y
= line_bottom_y (&it1
);
14158 RESTORE_IT (&it
, &it
, it1data
);
14159 move_it_by_lines (&it
, 1);
14160 SAVE_IT (it1
, it
, it1data
);
14161 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14164 /* If STARTP is unchanged, move it down another screen line. */
14165 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14166 move_it_by_lines (&it
, 1);
14167 startp
= it
.current
.pos
;
14171 struct text_pos scroll_margin_pos
= startp
;
14173 /* See if point is inside the scroll margin at the top of the
14175 if (this_scroll_margin
)
14177 start_display (&it
, w
, startp
);
14178 move_it_vertically (&it
, this_scroll_margin
);
14179 scroll_margin_pos
= it
.current
.pos
;
14182 if (PT
< CHARPOS (scroll_margin_pos
))
14184 /* Point is in the scroll margin at the top of the window or
14185 above what is displayed in the window. */
14188 /* Compute the vertical distance from PT to the scroll
14189 margin position. Move as far as scroll_max allows, or
14190 one screenful, or 10 screen lines, whichever is largest.
14191 Give up if distance is greater than scroll_max. */
14192 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14193 start_display (&it
, w
, pos
);
14195 y_to_move
= max (it
.last_visible_y
,
14196 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14197 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14199 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14200 dy
= it
.current_y
- y0
;
14201 if (dy
> scroll_max
)
14202 return SCROLLING_FAILED
;
14204 /* Compute new window start. */
14205 start_display (&it
, w
, startp
);
14207 if (arg_scroll_conservatively
)
14208 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14209 max (scroll_step
, temp_scroll_step
));
14210 else if (scroll_step
|| temp_scroll_step
)
14211 amount_to_scroll
= scroll_max
;
14214 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14215 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14216 if (NUMBERP (aggressive
))
14218 double float_amount
= XFLOATINT (aggressive
) * height
;
14219 amount_to_scroll
= float_amount
;
14220 if (amount_to_scroll
== 0 && float_amount
> 0)
14221 amount_to_scroll
= 1;
14222 amount_to_scroll
-=
14223 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14224 /* Don't let point enter the scroll margin near
14225 bottom of the window. */
14226 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14227 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14231 if (amount_to_scroll
<= 0)
14232 return SCROLLING_FAILED
;
14234 move_it_vertically_backward (&it
, amount_to_scroll
);
14235 startp
= it
.current
.pos
;
14239 /* Run window scroll functions. */
14240 startp
= run_window_scroll_functions (window
, startp
);
14242 /* Display the window. Give up if new fonts are loaded, or if point
14244 if (!try_window (window
, startp
, 0))
14245 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14246 else if (w
->cursor
.vpos
< 0)
14248 clear_glyph_matrix (w
->desired_matrix
);
14249 rc
= SCROLLING_FAILED
;
14253 /* Maybe forget recorded base line for line number display. */
14254 if (!just_this_one_p
14255 || current_buffer
->clip_changed
14256 || BEG_UNCHANGED
< CHARPOS (startp
))
14257 w
->base_line_number
= Qnil
;
14259 /* If cursor ends up on a partially visible line,
14260 treat that as being off the bottom of the screen. */
14261 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14262 /* It's possible that the cursor is on the first line of the
14263 buffer, which is partially obscured due to a vscroll
14264 (Bug#7537). In that case, avoid looping forever . */
14265 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14267 clear_glyph_matrix (w
->desired_matrix
);
14268 ++extra_scroll_margin_lines
;
14271 rc
= SCROLLING_SUCCESS
;
14278 /* Compute a suitable window start for window W if display of W starts
14279 on a continuation line. Value is non-zero if a new window start
14282 The new window start will be computed, based on W's width, starting
14283 from the start of the continued line. It is the start of the
14284 screen line with the minimum distance from the old start W->start. */
14287 compute_window_start_on_continuation_line (struct window
*w
)
14289 struct text_pos pos
, start_pos
;
14290 int window_start_changed_p
= 0;
14292 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14294 /* If window start is on a continuation line... Window start may be
14295 < BEGV in case there's invisible text at the start of the
14296 buffer (M-x rmail, for example). */
14297 if (CHARPOS (start_pos
) > BEGV
14298 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14301 struct glyph_row
*row
;
14303 /* Handle the case that the window start is out of range. */
14304 if (CHARPOS (start_pos
) < BEGV
)
14305 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14306 else if (CHARPOS (start_pos
) > ZV
)
14307 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14309 /* Find the start of the continued line. This should be fast
14310 because scan_buffer is fast (newline cache). */
14311 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14312 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14313 row
, DEFAULT_FACE_ID
);
14314 reseat_at_previous_visible_line_start (&it
);
14316 /* If the line start is "too far" away from the window start,
14317 say it takes too much time to compute a new window start. */
14318 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14319 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14321 int min_distance
, distance
;
14323 /* Move forward by display lines to find the new window
14324 start. If window width was enlarged, the new start can
14325 be expected to be > the old start. If window width was
14326 decreased, the new window start will be < the old start.
14327 So, we're looking for the display line start with the
14328 minimum distance from the old window start. */
14329 pos
= it
.current
.pos
;
14330 min_distance
= INFINITY
;
14331 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14332 distance
< min_distance
)
14334 min_distance
= distance
;
14335 pos
= it
.current
.pos
;
14336 move_it_by_lines (&it
, 1);
14339 /* Set the window start there. */
14340 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14341 window_start_changed_p
= 1;
14345 return window_start_changed_p
;
14349 /* Try cursor movement in case text has not changed in window WINDOW,
14350 with window start STARTP. Value is
14352 CURSOR_MOVEMENT_SUCCESS if successful
14354 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14356 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14357 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14358 we want to scroll as if scroll-step were set to 1. See the code.
14360 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14361 which case we have to abort this redisplay, and adjust matrices
14366 CURSOR_MOVEMENT_SUCCESS
,
14367 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14368 CURSOR_MOVEMENT_MUST_SCROLL
,
14369 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14373 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14375 struct window
*w
= XWINDOW (window
);
14376 struct frame
*f
= XFRAME (w
->frame
);
14377 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14380 if (inhibit_try_cursor_movement
)
14384 /* Handle case where text has not changed, only point, and it has
14385 not moved off the frame. */
14386 if (/* Point may be in this window. */
14387 PT
>= CHARPOS (startp
)
14388 /* Selective display hasn't changed. */
14389 && !current_buffer
->clip_changed
14390 /* Function force-mode-line-update is used to force a thorough
14391 redisplay. It sets either windows_or_buffers_changed or
14392 update_mode_lines. So don't take a shortcut here for these
14394 && !update_mode_lines
14395 && !windows_or_buffers_changed
14396 && !cursor_type_changed
14397 /* Can't use this case if highlighting a region. When a
14398 region exists, cursor movement has to do more than just
14400 && !(!NILP (Vtransient_mark_mode
)
14401 && !NILP (BVAR (current_buffer
, mark_active
)))
14402 && NILP (w
->region_showing
)
14403 && NILP (Vshow_trailing_whitespace
)
14404 /* Right after splitting windows, last_point may be nil. */
14405 && INTEGERP (w
->last_point
)
14406 /* This code is not used for mini-buffer for the sake of the case
14407 of redisplaying to replace an echo area message; since in
14408 that case the mini-buffer contents per se are usually
14409 unchanged. This code is of no real use in the mini-buffer
14410 since the handling of this_line_start_pos, etc., in redisplay
14411 handles the same cases. */
14412 && !EQ (window
, minibuf_window
)
14413 /* When splitting windows or for new windows, it happens that
14414 redisplay is called with a nil window_end_vpos or one being
14415 larger than the window. This should really be fixed in
14416 window.c. I don't have this on my list, now, so we do
14417 approximately the same as the old redisplay code. --gerd. */
14418 && INTEGERP (w
->window_end_vpos
)
14419 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14420 && (FRAME_WINDOW_P (f
)
14421 || !overlay_arrow_in_current_buffer_p ()))
14423 int this_scroll_margin
, top_scroll_margin
;
14424 struct glyph_row
*row
= NULL
;
14427 debug_method_add (w
, "cursor movement");
14430 /* Scroll if point within this distance from the top or bottom
14431 of the window. This is a pixel value. */
14432 if (scroll_margin
> 0)
14434 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14435 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14438 this_scroll_margin
= 0;
14440 top_scroll_margin
= this_scroll_margin
;
14441 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14442 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14444 /* Start with the row the cursor was displayed during the last
14445 not paused redisplay. Give up if that row is not valid. */
14446 if (w
->last_cursor
.vpos
< 0
14447 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14448 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14451 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14452 if (row
->mode_line_p
)
14454 if (!row
->enabled_p
)
14455 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14458 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14460 int scroll_p
= 0, must_scroll
= 0;
14461 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14463 if (PT
> XFASTINT (w
->last_point
))
14465 /* Point has moved forward. */
14466 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14467 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14469 xassert (row
->enabled_p
);
14473 /* If the end position of a row equals the start
14474 position of the next row, and PT is at that position,
14475 we would rather display cursor in the next line. */
14476 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14477 && MATRIX_ROW_END_CHARPOS (row
) == PT
14478 && row
< w
->current_matrix
->rows
14479 + w
->current_matrix
->nrows
- 1
14480 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14481 && !cursor_row_p (row
))
14484 /* If within the scroll margin, scroll. Note that
14485 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14486 the next line would be drawn, and that
14487 this_scroll_margin can be zero. */
14488 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14489 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14490 /* Line is completely visible last line in window
14491 and PT is to be set in the next line. */
14492 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14493 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14494 && !row
->ends_at_zv_p
14495 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14498 else if (PT
< XFASTINT (w
->last_point
))
14500 /* Cursor has to be moved backward. Note that PT >=
14501 CHARPOS (startp) because of the outer if-statement. */
14502 while (!row
->mode_line_p
14503 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14504 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14505 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14506 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14507 row
> w
->current_matrix
->rows
14508 && (row
-1)->ends_in_newline_from_string_p
))))
14509 && (row
->y
> top_scroll_margin
14510 || CHARPOS (startp
) == BEGV
))
14512 xassert (row
->enabled_p
);
14516 /* Consider the following case: Window starts at BEGV,
14517 there is invisible, intangible text at BEGV, so that
14518 display starts at some point START > BEGV. It can
14519 happen that we are called with PT somewhere between
14520 BEGV and START. Try to handle that case. */
14521 if (row
< w
->current_matrix
->rows
14522 || row
->mode_line_p
)
14524 row
= w
->current_matrix
->rows
;
14525 if (row
->mode_line_p
)
14529 /* Due to newlines in overlay strings, we may have to
14530 skip forward over overlay strings. */
14531 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14532 && MATRIX_ROW_END_CHARPOS (row
) == PT
14533 && !cursor_row_p (row
))
14536 /* If within the scroll margin, scroll. */
14537 if (row
->y
< top_scroll_margin
14538 && CHARPOS (startp
) != BEGV
)
14543 /* Cursor did not move. So don't scroll even if cursor line
14544 is partially visible, as it was so before. */
14545 rc
= CURSOR_MOVEMENT_SUCCESS
;
14548 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14549 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14551 /* if PT is not in the glyph row, give up. */
14552 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14555 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14556 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14558 /* If rows are bidi-reordered and point moved, back up
14559 until we find a row that does not belong to a
14560 continuation line. This is because we must consider
14561 all rows of a continued line as candidates for the
14562 new cursor positioning, since row start and end
14563 positions change non-linearly with vertical position
14565 /* FIXME: Revisit this when glyph ``spilling'' in
14566 continuation lines' rows is implemented for
14567 bidi-reordered rows. */
14568 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14570 xassert (row
->enabled_p
);
14572 /* If we hit the beginning of the displayed portion
14573 without finding the first row of a continued
14575 if (row
<= w
->current_matrix
->rows
)
14577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14585 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14586 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14587 && make_cursor_line_fully_visible_p
)
14589 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14590 && !row
->ends_at_zv_p
14591 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14592 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14593 else if (row
->height
> window_box_height (w
))
14595 /* If we end up in a partially visible line, let's
14596 make it fully visible, except when it's taller
14597 than the window, in which case we can't do much
14600 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14604 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14605 if (!cursor_row_fully_visible_p (w
, 0, 1))
14606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14608 rc
= CURSOR_MOVEMENT_SUCCESS
;
14612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14613 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14614 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14616 /* With bidi-reordered rows, there could be more than
14617 one candidate row whose start and end positions
14618 occlude point. We need to let set_cursor_from_row
14619 find the best candidate. */
14620 /* FIXME: Revisit this when glyph ``spilling'' in
14621 continuation lines' rows is implemented for
14622 bidi-reordered rows. */
14627 int at_zv_p
= 0, exact_match_p
= 0;
14629 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14630 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14631 && cursor_row_p (row
))
14632 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14634 /* As soon as we've found the exact match for point,
14635 or the first suitable row whose ends_at_zv_p flag
14636 is set, we are done. */
14638 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14640 && w
->cursor
.hpos
>= 0
14641 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14644 struct glyph_row
*candidate
=
14645 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14647 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14648 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14651 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14652 || (INTEGERP (g
->object
)
14653 && (g
->charpos
== PT
14654 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14656 if (rv
&& (at_zv_p
|| exact_match_p
))
14658 rc
= CURSOR_MOVEMENT_SUCCESS
;
14661 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14665 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14666 || row
->continued_p
)
14667 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14668 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14669 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14670 /* If we didn't find any candidate rows, or exited the
14671 loop before all the candidates were examined, signal
14672 to the caller that this method failed. */
14673 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14675 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14676 && !row
->continued_p
))
14677 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14679 rc
= CURSOR_MOVEMENT_SUCCESS
;
14685 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14687 rc
= CURSOR_MOVEMENT_SUCCESS
;
14692 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14693 && MATRIX_ROW_START_CHARPOS (row
) == PT
14694 && cursor_row_p (row
));
14702 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14706 set_vertical_scroll_bar (struct window
*w
)
14708 ptrdiff_t start
, end
, whole
;
14710 /* Calculate the start and end positions for the current window.
14711 At some point, it would be nice to choose between scrollbars
14712 which reflect the whole buffer size, with special markers
14713 indicating narrowing, and scrollbars which reflect only the
14716 Note that mini-buffers sometimes aren't displaying any text. */
14717 if (!MINI_WINDOW_P (w
)
14718 || (w
== XWINDOW (minibuf_window
)
14719 && NILP (echo_area_buffer
[0])))
14721 struct buffer
*buf
= XBUFFER (w
->buffer
);
14722 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14723 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14724 /* I don't think this is guaranteed to be right. For the
14725 moment, we'll pretend it is. */
14726 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14730 if (whole
< (end
- start
))
14731 whole
= end
- start
;
14734 start
= end
= whole
= 0;
14736 /* Indicate what this scroll bar ought to be displaying now. */
14737 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14738 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14739 (w
, end
- start
, whole
, start
);
14743 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14744 selected_window is redisplayed.
14746 We can return without actually redisplaying the window if
14747 fonts_changed_p is nonzero. In that case, redisplay_internal will
14751 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14753 struct window
*w
= XWINDOW (window
);
14754 struct frame
*f
= XFRAME (w
->frame
);
14755 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14756 struct buffer
*old
= current_buffer
;
14757 struct text_pos lpoint
, opoint
, startp
;
14758 int update_mode_line
;
14761 /* Record it now because it's overwritten. */
14762 int current_matrix_up_to_date_p
= 0;
14763 int used_current_matrix_p
= 0;
14764 /* This is less strict than current_matrix_up_to_date_p.
14765 It indictes that the buffer contents and narrowing are unchanged. */
14766 int buffer_unchanged_p
= 0;
14767 int temp_scroll_step
= 0;
14768 ptrdiff_t count
= SPECPDL_INDEX ();
14770 int centering_position
= -1;
14771 int last_line_misfit
= 0;
14772 ptrdiff_t beg_unchanged
, end_unchanged
;
14774 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14777 /* W must be a leaf window here. */
14778 xassert (!NILP (w
->buffer
));
14780 *w
->desired_matrix
->method
= 0;
14784 reconsider_clip_changes (w
, buffer
);
14786 /* Has the mode line to be updated? */
14787 update_mode_line
= (!NILP (w
->update_mode_line
)
14788 || update_mode_lines
14789 || buffer
->clip_changed
14790 || buffer
->prevent_redisplay_optimizations_p
);
14792 if (MINI_WINDOW_P (w
))
14794 if (w
== XWINDOW (echo_area_window
)
14795 && !NILP (echo_area_buffer
[0]))
14797 if (update_mode_line
)
14798 /* We may have to update a tty frame's menu bar or a
14799 tool-bar. Example `M-x C-h C-h C-g'. */
14800 goto finish_menu_bars
;
14802 /* We've already displayed the echo area glyphs in this window. */
14803 goto finish_scroll_bars
;
14805 else if ((w
!= XWINDOW (minibuf_window
)
14806 || minibuf_level
== 0)
14807 /* When buffer is nonempty, redisplay window normally. */
14808 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14809 /* Quail displays non-mini buffers in minibuffer window.
14810 In that case, redisplay the window normally. */
14811 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14813 /* W is a mini-buffer window, but it's not active, so clear
14815 int yb
= window_text_bottom_y (w
);
14816 struct glyph_row
*row
;
14819 for (y
= 0, row
= w
->desired_matrix
->rows
;
14821 y
+= row
->height
, ++row
)
14822 blank_row (w
, row
, y
);
14823 goto finish_scroll_bars
;
14826 clear_glyph_matrix (w
->desired_matrix
);
14829 /* Otherwise set up data on this window; select its buffer and point
14831 /* Really select the buffer, for the sake of buffer-local
14833 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14835 current_matrix_up_to_date_p
14836 = (!NILP (w
->window_end_valid
)
14837 && !current_buffer
->clip_changed
14838 && !current_buffer
->prevent_redisplay_optimizations_p
14839 && XFASTINT (w
->last_modified
) >= MODIFF
14840 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14842 /* Run the window-bottom-change-functions
14843 if it is possible that the text on the screen has changed
14844 (either due to modification of the text, or any other reason). */
14845 if (!current_matrix_up_to_date_p
14846 && !NILP (Vwindow_text_change_functions
))
14848 safe_run_hooks (Qwindow_text_change_functions
);
14852 beg_unchanged
= BEG_UNCHANGED
;
14853 end_unchanged
= END_UNCHANGED
;
14855 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14857 specbind (Qinhibit_point_motion_hooks
, Qt
);
14860 = (!NILP (w
->window_end_valid
)
14861 && !current_buffer
->clip_changed
14862 && XFASTINT (w
->last_modified
) >= MODIFF
14863 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14865 /* When windows_or_buffers_changed is non-zero, we can't rely on
14866 the window end being valid, so set it to nil there. */
14867 if (windows_or_buffers_changed
)
14869 /* If window starts on a continuation line, maybe adjust the
14870 window start in case the window's width changed. */
14871 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14872 compute_window_start_on_continuation_line (w
);
14874 w
->window_end_valid
= Qnil
;
14877 /* Some sanity checks. */
14878 CHECK_WINDOW_END (w
);
14879 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14881 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14884 /* If %c is in mode line, update it if needed. */
14885 if (!NILP (w
->column_number_displayed
)
14886 /* This alternative quickly identifies a common case
14887 where no change is needed. */
14888 && !(PT
== XFASTINT (w
->last_point
)
14889 && XFASTINT (w
->last_modified
) >= MODIFF
14890 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14891 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14892 update_mode_line
= 1;
14894 /* Count number of windows showing the selected buffer. An indirect
14895 buffer counts as its base buffer. */
14896 if (!just_this_one_p
)
14898 struct buffer
*current_base
, *window_base
;
14899 current_base
= current_buffer
;
14900 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14901 if (current_base
->base_buffer
)
14902 current_base
= current_base
->base_buffer
;
14903 if (window_base
->base_buffer
)
14904 window_base
= window_base
->base_buffer
;
14905 if (current_base
== window_base
)
14909 /* Point refers normally to the selected window. For any other
14910 window, set up appropriate value. */
14911 if (!EQ (window
, selected_window
))
14913 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
14914 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
14918 new_pt_byte
= BEGV_BYTE
;
14919 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14921 else if (new_pt
> (ZV
- 1))
14924 new_pt_byte
= ZV_BYTE
;
14925 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14928 /* We don't use SET_PT so that the point-motion hooks don't run. */
14929 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14932 /* If any of the character widths specified in the display table
14933 have changed, invalidate the width run cache. It's true that
14934 this may be a bit late to catch such changes, but the rest of
14935 redisplay goes (non-fatally) haywire when the display table is
14936 changed, so why should we worry about doing any better? */
14937 if (current_buffer
->width_run_cache
)
14939 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14941 if (! disptab_matches_widthtab (disptab
,
14942 XVECTOR (BVAR (current_buffer
, width_table
))))
14944 invalidate_region_cache (current_buffer
,
14945 current_buffer
->width_run_cache
,
14947 recompute_width_table (current_buffer
, disptab
);
14951 /* If window-start is screwed up, choose a new one. */
14952 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14955 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14957 /* If someone specified a new starting point but did not insist,
14958 check whether it can be used. */
14959 if (!NILP (w
->optional_new_start
)
14960 && CHARPOS (startp
) >= BEGV
14961 && CHARPOS (startp
) <= ZV
)
14963 w
->optional_new_start
= Qnil
;
14964 start_display (&it
, w
, startp
);
14965 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14966 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14967 if (IT_CHARPOS (it
) == PT
)
14968 w
->force_start
= Qt
;
14969 /* IT may overshoot PT if text at PT is invisible. */
14970 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14971 w
->force_start
= Qt
;
14976 /* Handle case where place to start displaying has been specified,
14977 unless the specified location is outside the accessible range. */
14978 if (!NILP (w
->force_start
)
14979 || w
->frozen_window_start_p
)
14981 /* We set this later on if we have to adjust point. */
14984 w
->force_start
= Qnil
;
14986 w
->window_end_valid
= Qnil
;
14988 /* Forget any recorded base line for line number display. */
14989 if (!buffer_unchanged_p
)
14990 w
->base_line_number
= Qnil
;
14992 /* Redisplay the mode line. Select the buffer properly for that.
14993 Also, run the hook window-scroll-functions
14994 because we have scrolled. */
14995 /* Note, we do this after clearing force_start because
14996 if there's an error, it is better to forget about force_start
14997 than to get into an infinite loop calling the hook functions
14998 and having them get more errors. */
14999 if (!update_mode_line
15000 || ! NILP (Vwindow_scroll_functions
))
15002 update_mode_line
= 1;
15003 w
->update_mode_line
= Qt
;
15004 startp
= run_window_scroll_functions (window
, startp
);
15007 w
->last_modified
= make_number (0);
15008 w
->last_overlay_modified
= make_number (0);
15009 if (CHARPOS (startp
) < BEGV
)
15010 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15011 else if (CHARPOS (startp
) > ZV
)
15012 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15014 /* Redisplay, then check if cursor has been set during the
15015 redisplay. Give up if new fonts were loaded. */
15016 /* We used to issue a CHECK_MARGINS argument to try_window here,
15017 but this causes scrolling to fail when point begins inside
15018 the scroll margin (bug#148) -- cyd */
15019 if (!try_window (window
, startp
, 0))
15021 w
->force_start
= Qt
;
15022 clear_glyph_matrix (w
->desired_matrix
);
15023 goto need_larger_matrices
;
15026 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15028 /* If point does not appear, try to move point so it does
15029 appear. The desired matrix has been built above, so we
15030 can use it here. */
15031 new_vpos
= window_box_height (w
) / 2;
15034 if (!cursor_row_fully_visible_p (w
, 0, 0))
15036 /* Point does appear, but on a line partly visible at end of window.
15037 Move it back to a fully-visible line. */
15038 new_vpos
= window_box_height (w
);
15041 /* If we need to move point for either of the above reasons,
15042 now actually do it. */
15045 struct glyph_row
*row
;
15047 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15048 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15051 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15052 MATRIX_ROW_START_BYTEPOS (row
));
15054 if (w
!= XWINDOW (selected_window
))
15055 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15056 else if (current_buffer
== old
)
15057 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15059 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15061 /* If we are highlighting the region, then we just changed
15062 the region, so redisplay to show it. */
15063 if (!NILP (Vtransient_mark_mode
)
15064 && !NILP (BVAR (current_buffer
, mark_active
)))
15066 clear_glyph_matrix (w
->desired_matrix
);
15067 if (!try_window (window
, startp
, 0))
15068 goto need_larger_matrices
;
15073 debug_method_add (w
, "forced window start");
15078 /* Handle case where text has not changed, only point, and it has
15079 not moved off the frame, and we are not retrying after hscroll.
15080 (current_matrix_up_to_date_p is nonzero when retrying.) */
15081 if (current_matrix_up_to_date_p
15082 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15083 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15087 case CURSOR_MOVEMENT_SUCCESS
:
15088 used_current_matrix_p
= 1;
15091 case CURSOR_MOVEMENT_MUST_SCROLL
:
15092 goto try_to_scroll
;
15098 /* If current starting point was originally the beginning of a line
15099 but no longer is, find a new starting point. */
15100 else if (!NILP (w
->start_at_line_beg
)
15101 && !(CHARPOS (startp
) <= BEGV
15102 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15105 debug_method_add (w
, "recenter 1");
15110 /* Try scrolling with try_window_id. Value is > 0 if update has
15111 been done, it is -1 if we know that the same window start will
15112 not work. It is 0 if unsuccessful for some other reason. */
15113 else if ((tem
= try_window_id (w
)) != 0)
15116 debug_method_add (w
, "try_window_id %d", tem
);
15119 if (fonts_changed_p
)
15120 goto need_larger_matrices
;
15124 /* Otherwise try_window_id has returned -1 which means that we
15125 don't want the alternative below this comment to execute. */
15127 else if (CHARPOS (startp
) >= BEGV
15128 && CHARPOS (startp
) <= ZV
15129 && PT
>= CHARPOS (startp
)
15130 && (CHARPOS (startp
) < ZV
15131 /* Avoid starting at end of buffer. */
15132 || CHARPOS (startp
) == BEGV
15133 || (XFASTINT (w
->last_modified
) >= MODIFF
15134 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15136 int d1
, d2
, d3
, d4
, d5
, d6
;
15138 /* If first window line is a continuation line, and window start
15139 is inside the modified region, but the first change is before
15140 current window start, we must select a new window start.
15142 However, if this is the result of a down-mouse event (e.g. by
15143 extending the mouse-drag-overlay), we don't want to select a
15144 new window start, since that would change the position under
15145 the mouse, resulting in an unwanted mouse-movement rather
15146 than a simple mouse-click. */
15147 if (NILP (w
->start_at_line_beg
)
15148 && NILP (do_mouse_tracking
)
15149 && CHARPOS (startp
) > BEGV
15150 && CHARPOS (startp
) > BEG
+ beg_unchanged
15151 && CHARPOS (startp
) <= Z
- end_unchanged
15152 /* Even if w->start_at_line_beg is nil, a new window may
15153 start at a line_beg, since that's how set_buffer_window
15154 sets it. So, we need to check the return value of
15155 compute_window_start_on_continuation_line. (See also
15157 && XMARKER (w
->start
)->buffer
== current_buffer
15158 && compute_window_start_on_continuation_line (w
)
15159 /* It doesn't make sense to force the window start like we
15160 do at label force_start if it is already known that point
15161 will not be visible in the resulting window, because
15162 doing so will move point from its correct position
15163 instead of scrolling the window to bring point into view.
15165 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15167 w
->force_start
= Qt
;
15168 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15173 debug_method_add (w
, "same window start");
15176 /* Try to redisplay starting at same place as before.
15177 If point has not moved off frame, accept the results. */
15178 if (!current_matrix_up_to_date_p
15179 /* Don't use try_window_reusing_current_matrix in this case
15180 because a window scroll function can have changed the
15182 || !NILP (Vwindow_scroll_functions
)
15183 || MINI_WINDOW_P (w
)
15184 || !(used_current_matrix_p
15185 = try_window_reusing_current_matrix (w
)))
15187 IF_DEBUG (debug_method_add (w
, "1"));
15188 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15189 /* -1 means we need to scroll.
15190 0 means we need new matrices, but fonts_changed_p
15191 is set in that case, so we will detect it below. */
15192 goto try_to_scroll
;
15195 if (fonts_changed_p
)
15196 goto need_larger_matrices
;
15198 if (w
->cursor
.vpos
>= 0)
15200 if (!just_this_one_p
15201 || current_buffer
->clip_changed
15202 || BEG_UNCHANGED
< CHARPOS (startp
))
15203 /* Forget any recorded base line for line number display. */
15204 w
->base_line_number
= Qnil
;
15206 if (!cursor_row_fully_visible_p (w
, 1, 0))
15208 clear_glyph_matrix (w
->desired_matrix
);
15209 last_line_misfit
= 1;
15211 /* Drop through and scroll. */
15216 clear_glyph_matrix (w
->desired_matrix
);
15221 w
->last_modified
= make_number (0);
15222 w
->last_overlay_modified
= make_number (0);
15224 /* Redisplay the mode line. Select the buffer properly for that. */
15225 if (!update_mode_line
)
15227 update_mode_line
= 1;
15228 w
->update_mode_line
= Qt
;
15231 /* Try to scroll by specified few lines. */
15232 if ((scroll_conservatively
15233 || emacs_scroll_step
15234 || temp_scroll_step
15235 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15236 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15237 && CHARPOS (startp
) >= BEGV
15238 && CHARPOS (startp
) <= ZV
)
15240 /* The function returns -1 if new fonts were loaded, 1 if
15241 successful, 0 if not successful. */
15242 int ss
= try_scrolling (window
, just_this_one_p
,
15243 scroll_conservatively
,
15245 temp_scroll_step
, last_line_misfit
);
15248 case SCROLLING_SUCCESS
:
15251 case SCROLLING_NEED_LARGER_MATRICES
:
15252 goto need_larger_matrices
;
15254 case SCROLLING_FAILED
:
15262 /* Finally, just choose a place to start which positions point
15263 according to user preferences. */
15268 debug_method_add (w
, "recenter");
15271 /* w->vscroll = 0; */
15273 /* Forget any previously recorded base line for line number display. */
15274 if (!buffer_unchanged_p
)
15275 w
->base_line_number
= Qnil
;
15277 /* Determine the window start relative to point. */
15278 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15279 it
.current_y
= it
.last_visible_y
;
15280 if (centering_position
< 0)
15284 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15286 ptrdiff_t margin_pos
= CHARPOS (startp
);
15288 Lisp_Object aggressive
;
15290 /* If there is a scroll margin at the top of the window, find
15291 its character position. */
15293 /* Cannot call start_display if startp is not in the
15294 accessible region of the buffer. This can happen when we
15295 have just switched to a different buffer and/or changed
15296 its restriction. In that case, startp is initialized to
15297 the character position 1 (BEG) because we did not yet
15298 have chance to display the buffer even once. */
15299 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15302 void *it1data
= NULL
;
15304 SAVE_IT (it1
, it
, it1data
);
15305 start_display (&it1
, w
, startp
);
15306 move_it_vertically (&it1
, margin
);
15307 margin_pos
= IT_CHARPOS (it1
);
15308 RESTORE_IT (&it
, &it
, it1data
);
15310 scrolling_up
= PT
> margin_pos
;
15313 ? BVAR (current_buffer
, scroll_up_aggressively
)
15314 : BVAR (current_buffer
, scroll_down_aggressively
);
15316 if (!MINI_WINDOW_P (w
)
15317 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15321 /* Setting scroll-conservatively overrides
15322 scroll-*-aggressively. */
15323 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15325 double float_amount
= XFLOATINT (aggressive
);
15327 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15328 if (pt_offset
== 0 && float_amount
> 0)
15333 /* Compute how much to move the window start backward from
15334 point so that point will be displayed where the user
15338 centering_position
= it
.last_visible_y
;
15340 centering_position
-= pt_offset
;
15341 centering_position
-=
15342 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15343 + WINDOW_HEADER_LINE_HEIGHT (w
);
15344 /* Don't let point enter the scroll margin near top of
15346 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15347 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15350 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15353 /* Set the window start half the height of the window backward
15355 centering_position
= window_box_height (w
) / 2;
15357 move_it_vertically_backward (&it
, centering_position
);
15359 xassert (IT_CHARPOS (it
) >= BEGV
);
15361 /* The function move_it_vertically_backward may move over more
15362 than the specified y-distance. If it->w is small, e.g. a
15363 mini-buffer window, we may end up in front of the window's
15364 display area. Start displaying at the start of the line
15365 containing PT in this case. */
15366 if (it
.current_y
<= 0)
15368 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15369 move_it_vertically_backward (&it
, 0);
15373 it
.current_x
= it
.hpos
= 0;
15375 /* Set the window start position here explicitly, to avoid an
15376 infinite loop in case the functions in window-scroll-functions
15378 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15380 /* Run scroll hooks. */
15381 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15383 /* Redisplay the window. */
15384 if (!current_matrix_up_to_date_p
15385 || windows_or_buffers_changed
15386 || cursor_type_changed
15387 /* Don't use try_window_reusing_current_matrix in this case
15388 because it can have changed the buffer. */
15389 || !NILP (Vwindow_scroll_functions
)
15390 || !just_this_one_p
15391 || MINI_WINDOW_P (w
)
15392 || !(used_current_matrix_p
15393 = try_window_reusing_current_matrix (w
)))
15394 try_window (window
, startp
, 0);
15396 /* If new fonts have been loaded (due to fontsets), give up. We
15397 have to start a new redisplay since we need to re-adjust glyph
15399 if (fonts_changed_p
)
15400 goto need_larger_matrices
;
15402 /* If cursor did not appear assume that the middle of the window is
15403 in the first line of the window. Do it again with the next line.
15404 (Imagine a window of height 100, displaying two lines of height
15405 60. Moving back 50 from it->last_visible_y will end in the first
15407 if (w
->cursor
.vpos
< 0)
15409 if (!NILP (w
->window_end_valid
)
15410 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15412 clear_glyph_matrix (w
->desired_matrix
);
15413 move_it_by_lines (&it
, 1);
15414 try_window (window
, it
.current
.pos
, 0);
15416 else if (PT
< IT_CHARPOS (it
))
15418 clear_glyph_matrix (w
->desired_matrix
);
15419 move_it_by_lines (&it
, -1);
15420 try_window (window
, it
.current
.pos
, 0);
15424 /* Not much we can do about it. */
15428 /* Consider the following case: Window starts at BEGV, there is
15429 invisible, intangible text at BEGV, so that display starts at
15430 some point START > BEGV. It can happen that we are called with
15431 PT somewhere between BEGV and START. Try to handle that case. */
15432 if (w
->cursor
.vpos
< 0)
15434 struct glyph_row
*row
= w
->current_matrix
->rows
;
15435 if (row
->mode_line_p
)
15437 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15440 if (!cursor_row_fully_visible_p (w
, 0, 0))
15442 /* If vscroll is enabled, disable it and try again. */
15446 clear_glyph_matrix (w
->desired_matrix
);
15450 /* If centering point failed to make the whole line visible,
15451 put point at the top instead. That has to make the whole line
15452 visible, if it can be done. */
15453 if (centering_position
== 0)
15456 clear_glyph_matrix (w
->desired_matrix
);
15457 centering_position
= 0;
15463 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15464 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15465 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15468 /* Display the mode line, if we must. */
15469 if ((update_mode_line
15470 /* If window not full width, must redo its mode line
15471 if (a) the window to its side is being redone and
15472 (b) we do a frame-based redisplay. This is a consequence
15473 of how inverted lines are drawn in frame-based redisplay. */
15474 || (!just_this_one_p
15475 && !FRAME_WINDOW_P (f
)
15476 && !WINDOW_FULL_WIDTH_P (w
))
15477 /* Line number to display. */
15478 || INTEGERP (w
->base_line_pos
)
15479 /* Column number is displayed and different from the one displayed. */
15480 || (!NILP (w
->column_number_displayed
)
15481 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15482 /* This means that the window has a mode line. */
15483 && (WINDOW_WANTS_MODELINE_P (w
)
15484 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15486 display_mode_lines (w
);
15488 /* If mode line height has changed, arrange for a thorough
15489 immediate redisplay using the correct mode line height. */
15490 if (WINDOW_WANTS_MODELINE_P (w
)
15491 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15493 fonts_changed_p
= 1;
15494 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15495 = DESIRED_MODE_LINE_HEIGHT (w
);
15498 /* If header line height has changed, arrange for a thorough
15499 immediate redisplay using the correct header line height. */
15500 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15501 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15503 fonts_changed_p
= 1;
15504 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15505 = DESIRED_HEADER_LINE_HEIGHT (w
);
15508 if (fonts_changed_p
)
15509 goto need_larger_matrices
;
15512 if (!line_number_displayed
15513 && !BUFFERP (w
->base_line_pos
))
15515 w
->base_line_pos
= Qnil
;
15516 w
->base_line_number
= Qnil
;
15521 /* When we reach a frame's selected window, redo the frame's menu bar. */
15522 if (update_mode_line
15523 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15525 int redisplay_menu_p
= 0;
15527 if (FRAME_WINDOW_P (f
))
15529 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15530 || defined (HAVE_NS) || defined (USE_GTK)
15531 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15533 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15537 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15539 if (redisplay_menu_p
)
15540 display_menu_bar (w
);
15542 #ifdef HAVE_WINDOW_SYSTEM
15543 if (FRAME_WINDOW_P (f
))
15545 #if defined (USE_GTK) || defined (HAVE_NS)
15546 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15547 redisplay_tool_bar (f
);
15549 if (WINDOWP (f
->tool_bar_window
)
15550 && (FRAME_TOOL_BAR_LINES (f
) > 0
15551 || !NILP (Vauto_resize_tool_bars
))
15552 && redisplay_tool_bar (f
))
15553 ignore_mouse_drag_p
= 1;
15559 #ifdef HAVE_WINDOW_SYSTEM
15560 if (FRAME_WINDOW_P (f
)
15561 && update_window_fringes (w
, (just_this_one_p
15562 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15563 || w
->pseudo_window_p
)))
15567 if (draw_window_fringes (w
, 1))
15568 x_draw_vertical_border (w
);
15572 #endif /* HAVE_WINDOW_SYSTEM */
15574 /* We go to this label, with fonts_changed_p nonzero,
15575 if it is necessary to try again using larger glyph matrices.
15576 We have to redeem the scroll bar even in this case,
15577 because the loop in redisplay_internal expects that. */
15578 need_larger_matrices
:
15580 finish_scroll_bars
:
15582 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15584 /* Set the thumb's position and size. */
15585 set_vertical_scroll_bar (w
);
15587 /* Note that we actually used the scroll bar attached to this
15588 window, so it shouldn't be deleted at the end of redisplay. */
15589 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15590 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15593 /* Restore current_buffer and value of point in it. The window
15594 update may have changed the buffer, so first make sure `opoint'
15595 is still valid (Bug#6177). */
15596 if (CHARPOS (opoint
) < BEGV
)
15597 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15598 else if (CHARPOS (opoint
) > ZV
)
15599 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15601 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15603 set_buffer_internal_1 (old
);
15604 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15605 shorter. This can be caused by log truncation in *Messages*. */
15606 if (CHARPOS (lpoint
) <= ZV
)
15607 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15609 unbind_to (count
, Qnil
);
15613 /* Build the complete desired matrix of WINDOW with a window start
15614 buffer position POS.
15616 Value is 1 if successful. It is zero if fonts were loaded during
15617 redisplay which makes re-adjusting glyph matrices necessary, and -1
15618 if point would appear in the scroll margins.
15619 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15620 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15624 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15626 struct window
*w
= XWINDOW (window
);
15628 struct glyph_row
*last_text_row
= NULL
;
15629 struct frame
*f
= XFRAME (w
->frame
);
15631 /* Make POS the new window start. */
15632 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15634 /* Mark cursor position as unknown. No overlay arrow seen. */
15635 w
->cursor
.vpos
= -1;
15636 overlay_arrow_seen
= 0;
15638 /* Initialize iterator and info to start at POS. */
15639 start_display (&it
, w
, pos
);
15641 /* Display all lines of W. */
15642 while (it
.current_y
< it
.last_visible_y
)
15644 if (display_line (&it
))
15645 last_text_row
= it
.glyph_row
- 1;
15646 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15650 /* Don't let the cursor end in the scroll margins. */
15651 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15652 && !MINI_WINDOW_P (w
))
15654 int this_scroll_margin
;
15656 if (scroll_margin
> 0)
15658 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15659 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15662 this_scroll_margin
= 0;
15664 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15665 && w
->cursor
.y
< this_scroll_margin
15666 && CHARPOS (pos
) > BEGV
15667 && IT_CHARPOS (it
) < ZV
)
15668 /* rms: considering make_cursor_line_fully_visible_p here
15669 seems to give wrong results. We don't want to recenter
15670 when the last line is partly visible, we want to allow
15671 that case to be handled in the usual way. */
15672 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15674 w
->cursor
.vpos
= -1;
15675 clear_glyph_matrix (w
->desired_matrix
);
15680 /* If bottom moved off end of frame, change mode line percentage. */
15681 if (XFASTINT (w
->window_end_pos
) <= 0
15682 && Z
!= IT_CHARPOS (it
))
15683 w
->update_mode_line
= Qt
;
15685 /* Set window_end_pos to the offset of the last character displayed
15686 on the window from the end of current_buffer. Set
15687 window_end_vpos to its row number. */
15690 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15691 w
->window_end_bytepos
15692 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15694 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15696 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15697 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15698 ->displays_text_p
);
15702 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15703 w
->window_end_pos
= make_number (Z
- ZV
);
15704 w
->window_end_vpos
= make_number (0);
15707 /* But that is not valid info until redisplay finishes. */
15708 w
->window_end_valid
= Qnil
;
15714 /************************************************************************
15715 Window redisplay reusing current matrix when buffer has not changed
15716 ************************************************************************/
15718 /* Try redisplay of window W showing an unchanged buffer with a
15719 different window start than the last time it was displayed by
15720 reusing its current matrix. Value is non-zero if successful.
15721 W->start is the new window start. */
15724 try_window_reusing_current_matrix (struct window
*w
)
15726 struct frame
*f
= XFRAME (w
->frame
);
15727 struct glyph_row
*bottom_row
;
15730 struct text_pos start
, new_start
;
15731 int nrows_scrolled
, i
;
15732 struct glyph_row
*last_text_row
;
15733 struct glyph_row
*last_reused_text_row
;
15734 struct glyph_row
*start_row
;
15735 int start_vpos
, min_y
, max_y
;
15738 if (inhibit_try_window_reusing
)
15742 if (/* This function doesn't handle terminal frames. */
15743 !FRAME_WINDOW_P (f
)
15744 /* Don't try to reuse the display if windows have been split
15746 || windows_or_buffers_changed
15747 || cursor_type_changed
)
15750 /* Can't do this if region may have changed. */
15751 if ((!NILP (Vtransient_mark_mode
)
15752 && !NILP (BVAR (current_buffer
, mark_active
)))
15753 || !NILP (w
->region_showing
)
15754 || !NILP (Vshow_trailing_whitespace
))
15757 /* If top-line visibility has changed, give up. */
15758 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15759 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15762 /* Give up if old or new display is scrolled vertically. We could
15763 make this function handle this, but right now it doesn't. */
15764 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15765 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15768 /* The variable new_start now holds the new window start. The old
15769 start `start' can be determined from the current matrix. */
15770 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15771 start
= start_row
->minpos
;
15772 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15774 /* Clear the desired matrix for the display below. */
15775 clear_glyph_matrix (w
->desired_matrix
);
15777 if (CHARPOS (new_start
) <= CHARPOS (start
))
15779 /* Don't use this method if the display starts with an ellipsis
15780 displayed for invisible text. It's not easy to handle that case
15781 below, and it's certainly not worth the effort since this is
15782 not a frequent case. */
15783 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15786 IF_DEBUG (debug_method_add (w
, "twu1"));
15788 /* Display up to a row that can be reused. The variable
15789 last_text_row is set to the last row displayed that displays
15790 text. Note that it.vpos == 0 if or if not there is a
15791 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15792 start_display (&it
, w
, new_start
);
15793 w
->cursor
.vpos
= -1;
15794 last_text_row
= last_reused_text_row
= NULL
;
15796 while (it
.current_y
< it
.last_visible_y
15797 && !fonts_changed_p
)
15799 /* If we have reached into the characters in the START row,
15800 that means the line boundaries have changed. So we
15801 can't start copying with the row START. Maybe it will
15802 work to start copying with the following row. */
15803 while (IT_CHARPOS (it
) > CHARPOS (start
))
15805 /* Advance to the next row as the "start". */
15807 start
= start_row
->minpos
;
15808 /* If there are no more rows to try, or just one, give up. */
15809 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15810 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15811 || CHARPOS (start
) == ZV
)
15813 clear_glyph_matrix (w
->desired_matrix
);
15817 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15819 /* If we have reached alignment,
15820 we can copy the rest of the rows. */
15821 if (IT_CHARPOS (it
) == CHARPOS (start
))
15824 if (display_line (&it
))
15825 last_text_row
= it
.glyph_row
- 1;
15828 /* A value of current_y < last_visible_y means that we stopped
15829 at the previous window start, which in turn means that we
15830 have at least one reusable row. */
15831 if (it
.current_y
< it
.last_visible_y
)
15833 struct glyph_row
*row
;
15835 /* IT.vpos always starts from 0; it counts text lines. */
15836 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15838 /* Find PT if not already found in the lines displayed. */
15839 if (w
->cursor
.vpos
< 0)
15841 int dy
= it
.current_y
- start_row
->y
;
15843 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15844 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15846 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15847 dy
, nrows_scrolled
);
15850 clear_glyph_matrix (w
->desired_matrix
);
15855 /* Scroll the display. Do it before the current matrix is
15856 changed. The problem here is that update has not yet
15857 run, i.e. part of the current matrix is not up to date.
15858 scroll_run_hook will clear the cursor, and use the
15859 current matrix to get the height of the row the cursor is
15861 run
.current_y
= start_row
->y
;
15862 run
.desired_y
= it
.current_y
;
15863 run
.height
= it
.last_visible_y
- it
.current_y
;
15865 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15868 FRAME_RIF (f
)->update_window_begin_hook (w
);
15869 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15870 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15871 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15875 /* Shift current matrix down by nrows_scrolled lines. */
15876 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15877 rotate_matrix (w
->current_matrix
,
15879 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15882 /* Disable lines that must be updated. */
15883 for (i
= 0; i
< nrows_scrolled
; ++i
)
15884 (start_row
+ i
)->enabled_p
= 0;
15886 /* Re-compute Y positions. */
15887 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15888 max_y
= it
.last_visible_y
;
15889 for (row
= start_row
+ nrows_scrolled
;
15893 row
->y
= it
.current_y
;
15894 row
->visible_height
= row
->height
;
15896 if (row
->y
< min_y
)
15897 row
->visible_height
-= min_y
- row
->y
;
15898 if (row
->y
+ row
->height
> max_y
)
15899 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15900 if (row
->fringe_bitmap_periodic_p
)
15901 row
->redraw_fringe_bitmaps_p
= 1;
15903 it
.current_y
+= row
->height
;
15905 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15906 last_reused_text_row
= row
;
15907 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15911 /* Disable lines in the current matrix which are now
15912 below the window. */
15913 for (++row
; row
< bottom_row
; ++row
)
15914 row
->enabled_p
= row
->mode_line_p
= 0;
15917 /* Update window_end_pos etc.; last_reused_text_row is the last
15918 reused row from the current matrix containing text, if any.
15919 The value of last_text_row is the last displayed line
15920 containing text. */
15921 if (last_reused_text_row
)
15923 w
->window_end_bytepos
15924 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15926 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15928 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15929 w
->current_matrix
));
15931 else if (last_text_row
)
15933 w
->window_end_bytepos
15934 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15936 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15938 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15942 /* This window must be completely empty. */
15943 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15944 w
->window_end_pos
= make_number (Z
- ZV
);
15945 w
->window_end_vpos
= make_number (0);
15947 w
->window_end_valid
= Qnil
;
15949 /* Update hint: don't try scrolling again in update_window. */
15950 w
->desired_matrix
->no_scrolling_p
= 1;
15953 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15957 else if (CHARPOS (new_start
) > CHARPOS (start
))
15959 struct glyph_row
*pt_row
, *row
;
15960 struct glyph_row
*first_reusable_row
;
15961 struct glyph_row
*first_row_to_display
;
15963 int yb
= window_text_bottom_y (w
);
15965 /* Find the row starting at new_start, if there is one. Don't
15966 reuse a partially visible line at the end. */
15967 first_reusable_row
= start_row
;
15968 while (first_reusable_row
->enabled_p
15969 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15970 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15971 < CHARPOS (new_start
)))
15972 ++first_reusable_row
;
15974 /* Give up if there is no row to reuse. */
15975 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15976 || !first_reusable_row
->enabled_p
15977 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15978 != CHARPOS (new_start
)))
15981 /* We can reuse fully visible rows beginning with
15982 first_reusable_row to the end of the window. Set
15983 first_row_to_display to the first row that cannot be reused.
15984 Set pt_row to the row containing point, if there is any. */
15986 for (first_row_to_display
= first_reusable_row
;
15987 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15988 ++first_row_to_display
)
15990 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15991 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15992 pt_row
= first_row_to_display
;
15995 /* Start displaying at the start of first_row_to_display. */
15996 xassert (first_row_to_display
->y
< yb
);
15997 init_to_row_start (&it
, w
, first_row_to_display
);
15999 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16001 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16003 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16004 + WINDOW_HEADER_LINE_HEIGHT (w
));
16006 /* Display lines beginning with first_row_to_display in the
16007 desired matrix. Set last_text_row to the last row displayed
16008 that displays text. */
16009 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16010 if (pt_row
== NULL
)
16011 w
->cursor
.vpos
= -1;
16012 last_text_row
= NULL
;
16013 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16014 if (display_line (&it
))
16015 last_text_row
= it
.glyph_row
- 1;
16017 /* If point is in a reused row, adjust y and vpos of the cursor
16021 w
->cursor
.vpos
-= nrows_scrolled
;
16022 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16025 /* Give up if point isn't in a row displayed or reused. (This
16026 also handles the case where w->cursor.vpos < nrows_scrolled
16027 after the calls to display_line, which can happen with scroll
16028 margins. See bug#1295.) */
16029 if (w
->cursor
.vpos
< 0)
16031 clear_glyph_matrix (w
->desired_matrix
);
16035 /* Scroll the display. */
16036 run
.current_y
= first_reusable_row
->y
;
16037 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16038 run
.height
= it
.last_visible_y
- run
.current_y
;
16039 dy
= run
.current_y
- run
.desired_y
;
16044 FRAME_RIF (f
)->update_window_begin_hook (w
);
16045 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16046 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16047 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16051 /* Adjust Y positions of reused rows. */
16052 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16053 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16054 max_y
= it
.last_visible_y
;
16055 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16058 row
->visible_height
= row
->height
;
16059 if (row
->y
< min_y
)
16060 row
->visible_height
-= min_y
- row
->y
;
16061 if (row
->y
+ row
->height
> max_y
)
16062 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16063 if (row
->fringe_bitmap_periodic_p
)
16064 row
->redraw_fringe_bitmaps_p
= 1;
16067 /* Scroll the current matrix. */
16068 xassert (nrows_scrolled
> 0);
16069 rotate_matrix (w
->current_matrix
,
16071 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16074 /* Disable rows not reused. */
16075 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16076 row
->enabled_p
= 0;
16078 /* Point may have moved to a different line, so we cannot assume that
16079 the previous cursor position is valid; locate the correct row. */
16082 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16083 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16087 w
->cursor
.y
= row
->y
;
16089 if (row
< bottom_row
)
16091 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16092 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16094 /* Can't use this optimization with bidi-reordered glyph
16095 rows, unless cursor is already at point. */
16096 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16098 if (!(w
->cursor
.hpos
>= 0
16099 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16100 && BUFFERP (glyph
->object
)
16101 && glyph
->charpos
== PT
))
16106 && (!BUFFERP (glyph
->object
)
16107 || glyph
->charpos
< PT
);
16111 w
->cursor
.x
+= glyph
->pixel_width
;
16116 /* Adjust window end. A null value of last_text_row means that
16117 the window end is in reused rows which in turn means that
16118 only its vpos can have changed. */
16121 w
->window_end_bytepos
16122 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16124 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16126 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16131 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16134 w
->window_end_valid
= Qnil
;
16135 w
->desired_matrix
->no_scrolling_p
= 1;
16138 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16148 /************************************************************************
16149 Window redisplay reusing current matrix when buffer has changed
16150 ************************************************************************/
16152 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16153 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16154 ptrdiff_t *, ptrdiff_t *);
16155 static struct glyph_row
*
16156 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16157 struct glyph_row
*);
16160 /* Return the last row in MATRIX displaying text. If row START is
16161 non-null, start searching with that row. IT gives the dimensions
16162 of the display. Value is null if matrix is empty; otherwise it is
16163 a pointer to the row found. */
16165 static struct glyph_row
*
16166 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16167 struct glyph_row
*start
)
16169 struct glyph_row
*row
, *row_found
;
16171 /* Set row_found to the last row in IT->w's current matrix
16172 displaying text. The loop looks funny but think of partially
16175 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16176 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16178 xassert (row
->enabled_p
);
16180 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16189 /* Return the last row in the current matrix of W that is not affected
16190 by changes at the start of current_buffer that occurred since W's
16191 current matrix was built. Value is null if no such row exists.
16193 BEG_UNCHANGED us the number of characters unchanged at the start of
16194 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16195 first changed character in current_buffer. Characters at positions <
16196 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16197 when the current matrix was built. */
16199 static struct glyph_row
*
16200 find_last_unchanged_at_beg_row (struct window
*w
)
16202 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16203 struct glyph_row
*row
;
16204 struct glyph_row
*row_found
= NULL
;
16205 int yb
= window_text_bottom_y (w
);
16207 /* Find the last row displaying unchanged text. */
16208 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16209 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16210 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16213 if (/* If row ends before first_changed_pos, it is unchanged,
16214 except in some case. */
16215 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16216 /* When row ends in ZV and we write at ZV it is not
16218 && !row
->ends_at_zv_p
16219 /* When first_changed_pos is the end of a continued line,
16220 row is not unchanged because it may be no longer
16222 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16223 && (row
->continued_p
16224 || row
->exact_window_width_line_p
)))
16227 /* Stop if last visible row. */
16228 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16236 /* Find the first glyph row in the current matrix of W that is not
16237 affected by changes at the end of current_buffer since the
16238 time W's current matrix was built.
16240 Return in *DELTA the number of chars by which buffer positions in
16241 unchanged text at the end of current_buffer must be adjusted.
16243 Return in *DELTA_BYTES the corresponding number of bytes.
16245 Value is null if no such row exists, i.e. all rows are affected by
16248 static struct glyph_row
*
16249 find_first_unchanged_at_end_row (struct window
*w
,
16250 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16252 struct glyph_row
*row
;
16253 struct glyph_row
*row_found
= NULL
;
16255 *delta
= *delta_bytes
= 0;
16257 /* Display must not have been paused, otherwise the current matrix
16258 is not up to date. */
16259 eassert (!NILP (w
->window_end_valid
));
16261 /* A value of window_end_pos >= END_UNCHANGED means that the window
16262 end is in the range of changed text. If so, there is no
16263 unchanged row at the end of W's current matrix. */
16264 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16267 /* Set row to the last row in W's current matrix displaying text. */
16268 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16270 /* If matrix is entirely empty, no unchanged row exists. */
16271 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16273 /* The value of row is the last glyph row in the matrix having a
16274 meaningful buffer position in it. The end position of row
16275 corresponds to window_end_pos. This allows us to translate
16276 buffer positions in the current matrix to current buffer
16277 positions for characters not in changed text. */
16279 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16280 ptrdiff_t Z_BYTE_old
=
16281 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16282 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16283 struct glyph_row
*first_text_row
16284 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16286 *delta
= Z
- Z_old
;
16287 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16289 /* Set last_unchanged_pos to the buffer position of the last
16290 character in the buffer that has not been changed. Z is the
16291 index + 1 of the last character in current_buffer, i.e. by
16292 subtracting END_UNCHANGED we get the index of the last
16293 unchanged character, and we have to add BEG to get its buffer
16295 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16296 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16298 /* Search backward from ROW for a row displaying a line that
16299 starts at a minimum position >= last_unchanged_pos_old. */
16300 for (; row
> first_text_row
; --row
)
16302 /* This used to abort, but it can happen.
16303 It is ok to just stop the search instead here. KFS. */
16304 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16307 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16312 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16318 /* Make sure that glyph rows in the current matrix of window W
16319 reference the same glyph memory as corresponding rows in the
16320 frame's frame matrix. This function is called after scrolling W's
16321 current matrix on a terminal frame in try_window_id and
16322 try_window_reusing_current_matrix. */
16325 sync_frame_with_window_matrix_rows (struct window
*w
)
16327 struct frame
*f
= XFRAME (w
->frame
);
16328 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16330 /* Preconditions: W must be a leaf window and full-width. Its frame
16331 must have a frame matrix. */
16332 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16333 xassert (WINDOW_FULL_WIDTH_P (w
));
16334 xassert (!FRAME_WINDOW_P (f
));
16336 /* If W is a full-width window, glyph pointers in W's current matrix
16337 have, by definition, to be the same as glyph pointers in the
16338 corresponding frame matrix. Note that frame matrices have no
16339 marginal areas (see build_frame_matrix). */
16340 window_row
= w
->current_matrix
->rows
;
16341 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16342 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16343 while (window_row
< window_row_end
)
16345 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16346 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16348 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16349 frame_row
->glyphs
[TEXT_AREA
] = start
;
16350 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16351 frame_row
->glyphs
[LAST_AREA
] = end
;
16353 /* Disable frame rows whose corresponding window rows have
16354 been disabled in try_window_id. */
16355 if (!window_row
->enabled_p
)
16356 frame_row
->enabled_p
= 0;
16358 ++window_row
, ++frame_row
;
16363 /* Find the glyph row in window W containing CHARPOS. Consider all
16364 rows between START and END (not inclusive). END null means search
16365 all rows to the end of the display area of W. Value is the row
16366 containing CHARPOS or null. */
16369 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16370 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16372 struct glyph_row
*row
= start
;
16373 struct glyph_row
*best_row
= NULL
;
16374 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16377 /* If we happen to start on a header-line, skip that. */
16378 if (row
->mode_line_p
)
16381 if ((end
&& row
>= end
) || !row
->enabled_p
)
16384 last_y
= window_text_bottom_y (w
) - dy
;
16388 /* Give up if we have gone too far. */
16389 if (end
&& row
>= end
)
16391 /* This formerly returned if they were equal.
16392 I think that both quantities are of a "last plus one" type;
16393 if so, when they are equal, the row is within the screen. -- rms. */
16394 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16397 /* If it is in this row, return this row. */
16398 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16399 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16400 /* The end position of a row equals the start
16401 position of the next row. If CHARPOS is there, we
16402 would rather display it in the next line, except
16403 when this line ends in ZV. */
16404 && !row
->ends_at_zv_p
16405 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16406 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16410 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16411 || (!best_row
&& !row
->continued_p
))
16413 /* In bidi-reordered rows, there could be several rows
16414 occluding point, all of them belonging to the same
16415 continued line. We need to find the row which fits
16416 CHARPOS the best. */
16417 for (g
= row
->glyphs
[TEXT_AREA
];
16418 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16421 if (!STRINGP (g
->object
))
16423 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16425 mindif
= eabs (g
->charpos
- charpos
);
16427 /* Exact match always wins. */
16434 else if (best_row
&& !row
->continued_p
)
16441 /* Try to redisplay window W by reusing its existing display. W's
16442 current matrix must be up to date when this function is called,
16443 i.e. window_end_valid must not be nil.
16447 1 if display has been updated
16448 0 if otherwise unsuccessful
16449 -1 if redisplay with same window start is known not to succeed
16451 The following steps are performed:
16453 1. Find the last row in the current matrix of W that is not
16454 affected by changes at the start of current_buffer. If no such row
16457 2. Find the first row in W's current matrix that is not affected by
16458 changes at the end of current_buffer. Maybe there is no such row.
16460 3. Display lines beginning with the row + 1 found in step 1 to the
16461 row found in step 2 or, if step 2 didn't find a row, to the end of
16464 4. If cursor is not known to appear on the window, give up.
16466 5. If display stopped at the row found in step 2, scroll the
16467 display and current matrix as needed.
16469 6. Maybe display some lines at the end of W, if we must. This can
16470 happen under various circumstances, like a partially visible line
16471 becoming fully visible, or because newly displayed lines are displayed
16472 in smaller font sizes.
16474 7. Update W's window end information. */
16477 try_window_id (struct window
*w
)
16479 struct frame
*f
= XFRAME (w
->frame
);
16480 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16481 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16482 struct glyph_row
*last_unchanged_at_beg_row
;
16483 struct glyph_row
*first_unchanged_at_end_row
;
16484 struct glyph_row
*row
;
16485 struct glyph_row
*bottom_row
;
16488 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
16490 struct text_pos start_pos
;
16492 int first_unchanged_at_end_vpos
= 0;
16493 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16494 struct text_pos start
;
16495 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
16498 if (inhibit_try_window_id
)
16502 /* This is handy for debugging. */
16504 #define GIVE_UP(X) \
16506 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16510 #define GIVE_UP(X) return 0
16513 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16515 /* Don't use this for mini-windows because these can show
16516 messages and mini-buffers, and we don't handle that here. */
16517 if (MINI_WINDOW_P (w
))
16520 /* This flag is used to prevent redisplay optimizations. */
16521 if (windows_or_buffers_changed
|| cursor_type_changed
)
16524 /* Verify that narrowing has not changed.
16525 Also verify that we were not told to prevent redisplay optimizations.
16526 It would be nice to further
16527 reduce the number of cases where this prevents try_window_id. */
16528 if (current_buffer
->clip_changed
16529 || current_buffer
->prevent_redisplay_optimizations_p
)
16532 /* Window must either use window-based redisplay or be full width. */
16533 if (!FRAME_WINDOW_P (f
)
16534 && (!FRAME_LINE_INS_DEL_OK (f
)
16535 || !WINDOW_FULL_WIDTH_P (w
)))
16538 /* Give up if point is known NOT to appear in W. */
16539 if (PT
< CHARPOS (start
))
16542 /* Another way to prevent redisplay optimizations. */
16543 if (XFASTINT (w
->last_modified
) == 0)
16546 /* Verify that window is not hscrolled. */
16547 if (XFASTINT (w
->hscroll
) != 0)
16550 /* Verify that display wasn't paused. */
16551 if (NILP (w
->window_end_valid
))
16554 /* Can't use this if highlighting a region because a cursor movement
16555 will do more than just set the cursor. */
16556 if (!NILP (Vtransient_mark_mode
)
16557 && !NILP (BVAR (current_buffer
, mark_active
)))
16560 /* Likewise if highlighting trailing whitespace. */
16561 if (!NILP (Vshow_trailing_whitespace
))
16564 /* Likewise if showing a region. */
16565 if (!NILP (w
->region_showing
))
16568 /* Can't use this if overlay arrow position and/or string have
16570 if (overlay_arrows_changed_p ())
16573 /* When word-wrap is on, adding a space to the first word of a
16574 wrapped line can change the wrap position, altering the line
16575 above it. It might be worthwhile to handle this more
16576 intelligently, but for now just redisplay from scratch. */
16577 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16580 /* Under bidi reordering, adding or deleting a character in the
16581 beginning of a paragraph, before the first strong directional
16582 character, can change the base direction of the paragraph (unless
16583 the buffer specifies a fixed paragraph direction), which will
16584 require to redisplay the whole paragraph. It might be worthwhile
16585 to find the paragraph limits and widen the range of redisplayed
16586 lines to that, but for now just give up this optimization and
16587 redisplay from scratch. */
16588 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16589 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16592 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16593 only if buffer has really changed. The reason is that the gap is
16594 initially at Z for freshly visited files. The code below would
16595 set end_unchanged to 0 in that case. */
16596 if (MODIFF
> SAVE_MODIFF
16597 /* This seems to happen sometimes after saving a buffer. */
16598 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16600 if (GPT
- BEG
< BEG_UNCHANGED
)
16601 BEG_UNCHANGED
= GPT
- BEG
;
16602 if (Z
- GPT
< END_UNCHANGED
)
16603 END_UNCHANGED
= Z
- GPT
;
16606 /* The position of the first and last character that has been changed. */
16607 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16608 last_changed_charpos
= Z
- END_UNCHANGED
;
16610 /* If window starts after a line end, and the last change is in
16611 front of that newline, then changes don't affect the display.
16612 This case happens with stealth-fontification. Note that although
16613 the display is unchanged, glyph positions in the matrix have to
16614 be adjusted, of course. */
16615 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16616 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16617 && ((last_changed_charpos
< CHARPOS (start
)
16618 && CHARPOS (start
) == BEGV
)
16619 || (last_changed_charpos
< CHARPOS (start
) - 1
16620 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16622 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16623 struct glyph_row
*r0
;
16625 /* Compute how many chars/bytes have been added to or removed
16626 from the buffer. */
16627 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16628 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16629 Z_delta
= Z
- Z_old
;
16630 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16632 /* Give up if PT is not in the window. Note that it already has
16633 been checked at the start of try_window_id that PT is not in
16634 front of the window start. */
16635 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16638 /* If window start is unchanged, we can reuse the whole matrix
16639 as is, after adjusting glyph positions. No need to compute
16640 the window end again, since its offset from Z hasn't changed. */
16641 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16642 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16643 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16644 /* PT must not be in a partially visible line. */
16645 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16646 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16648 /* Adjust positions in the glyph matrix. */
16649 if (Z_delta
|| Z_delta_bytes
)
16651 struct glyph_row
*r1
16652 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16653 increment_matrix_positions (w
->current_matrix
,
16654 MATRIX_ROW_VPOS (r0
, current_matrix
),
16655 MATRIX_ROW_VPOS (r1
, current_matrix
),
16656 Z_delta
, Z_delta_bytes
);
16659 /* Set the cursor. */
16660 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16662 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16669 /* Handle the case that changes are all below what is displayed in
16670 the window, and that PT is in the window. This shortcut cannot
16671 be taken if ZV is visible in the window, and text has been added
16672 there that is visible in the window. */
16673 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16674 /* ZV is not visible in the window, or there are no
16675 changes at ZV, actually. */
16676 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16677 || first_changed_charpos
== last_changed_charpos
))
16679 struct glyph_row
*r0
;
16681 /* Give up if PT is not in the window. Note that it already has
16682 been checked at the start of try_window_id that PT is not in
16683 front of the window start. */
16684 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16687 /* If window start is unchanged, we can reuse the whole matrix
16688 as is, without changing glyph positions since no text has
16689 been added/removed in front of the window end. */
16690 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16691 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16692 /* PT must not be in a partially visible line. */
16693 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16694 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16696 /* We have to compute the window end anew since text
16697 could have been added/removed after it. */
16699 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16700 w
->window_end_bytepos
16701 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16703 /* Set the cursor. */
16704 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16706 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16713 /* Give up if window start is in the changed area.
16715 The condition used to read
16717 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16719 but why that was tested escapes me at the moment. */
16720 if (CHARPOS (start
) >= first_changed_charpos
16721 && CHARPOS (start
) <= last_changed_charpos
)
16724 /* Check that window start agrees with the start of the first glyph
16725 row in its current matrix. Check this after we know the window
16726 start is not in changed text, otherwise positions would not be
16728 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16729 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16732 /* Give up if the window ends in strings. Overlay strings
16733 at the end are difficult to handle, so don't try. */
16734 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16735 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16738 /* Compute the position at which we have to start displaying new
16739 lines. Some of the lines at the top of the window might be
16740 reusable because they are not displaying changed text. Find the
16741 last row in W's current matrix not affected by changes at the
16742 start of current_buffer. Value is null if changes start in the
16743 first line of window. */
16744 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16745 if (last_unchanged_at_beg_row
)
16747 /* Avoid starting to display in the moddle of a character, a TAB
16748 for instance. This is easier than to set up the iterator
16749 exactly, and it's not a frequent case, so the additional
16750 effort wouldn't really pay off. */
16751 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16752 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16753 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16754 --last_unchanged_at_beg_row
;
16756 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16759 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16761 start_pos
= it
.current
.pos
;
16763 /* Start displaying new lines in the desired matrix at the same
16764 vpos we would use in the current matrix, i.e. below
16765 last_unchanged_at_beg_row. */
16766 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16768 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16769 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16771 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16775 /* There are no reusable lines at the start of the window.
16776 Start displaying in the first text line. */
16777 start_display (&it
, w
, start
);
16778 it
.vpos
= it
.first_vpos
;
16779 start_pos
= it
.current
.pos
;
16782 /* Find the first row that is not affected by changes at the end of
16783 the buffer. Value will be null if there is no unchanged row, in
16784 which case we must redisplay to the end of the window. delta
16785 will be set to the value by which buffer positions beginning with
16786 first_unchanged_at_end_row have to be adjusted due to text
16788 first_unchanged_at_end_row
16789 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16790 IF_DEBUG (debug_delta
= delta
);
16791 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16793 /* Set stop_pos to the buffer position up to which we will have to
16794 display new lines. If first_unchanged_at_end_row != NULL, this
16795 is the buffer position of the start of the line displayed in that
16796 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16797 that we don't stop at a buffer position. */
16799 if (first_unchanged_at_end_row
)
16801 xassert (last_unchanged_at_beg_row
== NULL
16802 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16804 /* If this is a continuation line, move forward to the next one
16805 that isn't. Changes in lines above affect this line.
16806 Caution: this may move first_unchanged_at_end_row to a row
16807 not displaying text. */
16808 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16809 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16810 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16811 < it
.last_visible_y
))
16812 ++first_unchanged_at_end_row
;
16814 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16815 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16816 >= it
.last_visible_y
))
16817 first_unchanged_at_end_row
= NULL
;
16820 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16822 first_unchanged_at_end_vpos
16823 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16824 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16827 else if (last_unchanged_at_beg_row
== NULL
)
16833 /* Either there is no unchanged row at the end, or the one we have
16834 now displays text. This is a necessary condition for the window
16835 end pos calculation at the end of this function. */
16836 xassert (first_unchanged_at_end_row
== NULL
16837 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16839 debug_last_unchanged_at_beg_vpos
16840 = (last_unchanged_at_beg_row
16841 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16843 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16845 #endif /* GLYPH_DEBUG != 0 */
16848 /* Display new lines. Set last_text_row to the last new line
16849 displayed which has text on it, i.e. might end up as being the
16850 line where the window_end_vpos is. */
16851 w
->cursor
.vpos
= -1;
16852 last_text_row
= NULL
;
16853 overlay_arrow_seen
= 0;
16854 while (it
.current_y
< it
.last_visible_y
16855 && !fonts_changed_p
16856 && (first_unchanged_at_end_row
== NULL
16857 || IT_CHARPOS (it
) < stop_pos
))
16859 if (display_line (&it
))
16860 last_text_row
= it
.glyph_row
- 1;
16863 if (fonts_changed_p
)
16867 /* Compute differences in buffer positions, y-positions etc. for
16868 lines reused at the bottom of the window. Compute what we can
16870 if (first_unchanged_at_end_row
16871 /* No lines reused because we displayed everything up to the
16872 bottom of the window. */
16873 && it
.current_y
< it
.last_visible_y
)
16876 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16878 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16879 run
.current_y
= first_unchanged_at_end_row
->y
;
16880 run
.desired_y
= run
.current_y
+ dy
;
16881 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16885 delta
= delta_bytes
= dvpos
= dy
16886 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16887 first_unchanged_at_end_row
= NULL
;
16889 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16892 /* Find the cursor if not already found. We have to decide whether
16893 PT will appear on this window (it sometimes doesn't, but this is
16894 not a very frequent case.) This decision has to be made before
16895 the current matrix is altered. A value of cursor.vpos < 0 means
16896 that PT is either in one of the lines beginning at
16897 first_unchanged_at_end_row or below the window. Don't care for
16898 lines that might be displayed later at the window end; as
16899 mentioned, this is not a frequent case. */
16900 if (w
->cursor
.vpos
< 0)
16902 /* Cursor in unchanged rows at the top? */
16903 if (PT
< CHARPOS (start_pos
)
16904 && last_unchanged_at_beg_row
)
16906 row
= row_containing_pos (w
, PT
,
16907 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16908 last_unchanged_at_beg_row
+ 1, 0);
16910 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16913 /* Start from first_unchanged_at_end_row looking for PT. */
16914 else if (first_unchanged_at_end_row
)
16916 row
= row_containing_pos (w
, PT
- delta
,
16917 first_unchanged_at_end_row
, NULL
, 0);
16919 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16920 delta_bytes
, dy
, dvpos
);
16923 /* Give up if cursor was not found. */
16924 if (w
->cursor
.vpos
< 0)
16926 clear_glyph_matrix (w
->desired_matrix
);
16931 /* Don't let the cursor end in the scroll margins. */
16933 int this_scroll_margin
, cursor_height
;
16935 this_scroll_margin
=
16936 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
16937 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16938 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16940 if ((w
->cursor
.y
< this_scroll_margin
16941 && CHARPOS (start
) > BEGV
)
16942 /* Old redisplay didn't take scroll margin into account at the bottom,
16943 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16944 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16945 ? cursor_height
+ this_scroll_margin
16946 : 1)) > it
.last_visible_y
)
16948 w
->cursor
.vpos
= -1;
16949 clear_glyph_matrix (w
->desired_matrix
);
16954 /* Scroll the display. Do it before changing the current matrix so
16955 that xterm.c doesn't get confused about where the cursor glyph is
16957 if (dy
&& run
.height
)
16961 if (FRAME_WINDOW_P (f
))
16963 FRAME_RIF (f
)->update_window_begin_hook (w
);
16964 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16965 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16966 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16970 /* Terminal frame. In this case, dvpos gives the number of
16971 lines to scroll by; dvpos < 0 means scroll up. */
16973 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16974 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16975 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16976 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16977 + window_internal_height (w
));
16979 #if defined (HAVE_GPM) || defined (MSDOS)
16980 x_clear_window_mouse_face (w
);
16982 /* Perform the operation on the screen. */
16985 /* Scroll last_unchanged_at_beg_row to the end of the
16986 window down dvpos lines. */
16987 set_terminal_window (f
, end
);
16989 /* On dumb terminals delete dvpos lines at the end
16990 before inserting dvpos empty lines. */
16991 if (!FRAME_SCROLL_REGION_OK (f
))
16992 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16994 /* Insert dvpos empty lines in front of
16995 last_unchanged_at_beg_row. */
16996 ins_del_lines (f
, from
, dvpos
);
16998 else if (dvpos
< 0)
17000 /* Scroll up last_unchanged_at_beg_vpos to the end of
17001 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17002 set_terminal_window (f
, end
);
17004 /* Delete dvpos lines in front of
17005 last_unchanged_at_beg_vpos. ins_del_lines will set
17006 the cursor to the given vpos and emit |dvpos| delete
17008 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17010 /* On a dumb terminal insert dvpos empty lines at the
17012 if (!FRAME_SCROLL_REGION_OK (f
))
17013 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17016 set_terminal_window (f
, 0);
17022 /* Shift reused rows of the current matrix to the right position.
17023 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17025 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17026 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17029 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17030 bottom_vpos
, dvpos
);
17031 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17034 else if (dvpos
> 0)
17036 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17037 bottom_vpos
, dvpos
);
17038 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17039 first_unchanged_at_end_vpos
+ dvpos
, 0);
17042 /* For frame-based redisplay, make sure that current frame and window
17043 matrix are in sync with respect to glyph memory. */
17044 if (!FRAME_WINDOW_P (f
))
17045 sync_frame_with_window_matrix_rows (w
);
17047 /* Adjust buffer positions in reused rows. */
17048 if (delta
|| delta_bytes
)
17049 increment_matrix_positions (current_matrix
,
17050 first_unchanged_at_end_vpos
+ dvpos
,
17051 bottom_vpos
, delta
, delta_bytes
);
17053 /* Adjust Y positions. */
17055 shift_glyph_matrix (w
, current_matrix
,
17056 first_unchanged_at_end_vpos
+ dvpos
,
17059 if (first_unchanged_at_end_row
)
17061 first_unchanged_at_end_row
+= dvpos
;
17062 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17063 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17064 first_unchanged_at_end_row
= NULL
;
17067 /* If scrolling up, there may be some lines to display at the end of
17069 last_text_row_at_end
= NULL
;
17072 /* Scrolling up can leave for example a partially visible line
17073 at the end of the window to be redisplayed. */
17074 /* Set last_row to the glyph row in the current matrix where the
17075 window end line is found. It has been moved up or down in
17076 the matrix by dvpos. */
17077 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17078 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17080 /* If last_row is the window end line, it should display text. */
17081 xassert (last_row
->displays_text_p
);
17083 /* If window end line was partially visible before, begin
17084 displaying at that line. Otherwise begin displaying with the
17085 line following it. */
17086 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17088 init_to_row_start (&it
, w
, last_row
);
17089 it
.vpos
= last_vpos
;
17090 it
.current_y
= last_row
->y
;
17094 init_to_row_end (&it
, w
, last_row
);
17095 it
.vpos
= 1 + last_vpos
;
17096 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17100 /* We may start in a continuation line. If so, we have to
17101 get the right continuation_lines_width and current_x. */
17102 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17103 it
.hpos
= it
.current_x
= 0;
17105 /* Display the rest of the lines at the window end. */
17106 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17107 while (it
.current_y
< it
.last_visible_y
17108 && !fonts_changed_p
)
17110 /* Is it always sure that the display agrees with lines in
17111 the current matrix? I don't think so, so we mark rows
17112 displayed invalid in the current matrix by setting their
17113 enabled_p flag to zero. */
17114 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17115 if (display_line (&it
))
17116 last_text_row_at_end
= it
.glyph_row
- 1;
17120 /* Update window_end_pos and window_end_vpos. */
17121 if (first_unchanged_at_end_row
17122 && !last_text_row_at_end
)
17124 /* Window end line if one of the preserved rows from the current
17125 matrix. Set row to the last row displaying text in current
17126 matrix starting at first_unchanged_at_end_row, after
17128 xassert (first_unchanged_at_end_row
->displays_text_p
);
17129 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17130 first_unchanged_at_end_row
);
17131 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17133 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17134 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17136 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17137 xassert (w
->window_end_bytepos
>= 0);
17138 IF_DEBUG (debug_method_add (w
, "A"));
17140 else if (last_text_row_at_end
)
17143 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17144 w
->window_end_bytepos
17145 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17147 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17148 xassert (w
->window_end_bytepos
>= 0);
17149 IF_DEBUG (debug_method_add (w
, "B"));
17151 else if (last_text_row
)
17153 /* We have displayed either to the end of the window or at the
17154 end of the window, i.e. the last row with text is to be found
17155 in the desired matrix. */
17157 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17158 w
->window_end_bytepos
17159 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17161 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17162 xassert (w
->window_end_bytepos
>= 0);
17164 else if (first_unchanged_at_end_row
== NULL
17165 && last_text_row
== NULL
17166 && last_text_row_at_end
== NULL
)
17168 /* Displayed to end of window, but no line containing text was
17169 displayed. Lines were deleted at the end of the window. */
17170 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17171 int vpos
= XFASTINT (w
->window_end_vpos
);
17172 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17173 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17176 row
== NULL
&& vpos
>= first_vpos
;
17177 --vpos
, --current_row
, --desired_row
)
17179 if (desired_row
->enabled_p
)
17181 if (desired_row
->displays_text_p
)
17184 else if (current_row
->displays_text_p
)
17188 xassert (row
!= NULL
);
17189 w
->window_end_vpos
= make_number (vpos
+ 1);
17190 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17191 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17192 xassert (w
->window_end_bytepos
>= 0);
17193 IF_DEBUG (debug_method_add (w
, "C"));
17198 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17199 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17201 /* Record that display has not been completed. */
17202 w
->window_end_valid
= Qnil
;
17203 w
->desired_matrix
->no_scrolling_p
= 1;
17211 /***********************************************************************
17212 More debugging support
17213 ***********************************************************************/
17217 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17218 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17219 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17222 /* Dump the contents of glyph matrix MATRIX on stderr.
17224 GLYPHS 0 means don't show glyph contents.
17225 GLYPHS 1 means show glyphs in short form
17226 GLYPHS > 1 means show glyphs in long form. */
17229 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17232 for (i
= 0; i
< matrix
->nrows
; ++i
)
17233 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17237 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17238 the glyph row and area where the glyph comes from. */
17241 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17243 if (glyph
->type
== CHAR_GLYPH
)
17246 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17247 glyph
- row
->glyphs
[TEXT_AREA
],
17250 (BUFFERP (glyph
->object
)
17252 : (STRINGP (glyph
->object
)
17255 glyph
->pixel_width
,
17257 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17261 glyph
->left_box_line_p
,
17262 glyph
->right_box_line_p
);
17264 else if (glyph
->type
== STRETCH_GLYPH
)
17267 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17268 glyph
- row
->glyphs
[TEXT_AREA
],
17271 (BUFFERP (glyph
->object
)
17273 : (STRINGP (glyph
->object
)
17276 glyph
->pixel_width
,
17280 glyph
->left_box_line_p
,
17281 glyph
->right_box_line_p
);
17283 else if (glyph
->type
== IMAGE_GLYPH
)
17286 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17287 glyph
- row
->glyphs
[TEXT_AREA
],
17290 (BUFFERP (glyph
->object
)
17292 : (STRINGP (glyph
->object
)
17295 glyph
->pixel_width
,
17299 glyph
->left_box_line_p
,
17300 glyph
->right_box_line_p
);
17302 else if (glyph
->type
== COMPOSITE_GLYPH
)
17305 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17306 glyph
- row
->glyphs
[TEXT_AREA
],
17309 (BUFFERP (glyph
->object
)
17311 : (STRINGP (glyph
->object
)
17314 glyph
->pixel_width
,
17316 if (glyph
->u
.cmp
.automatic
)
17319 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17320 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17322 glyph
->left_box_line_p
,
17323 glyph
->right_box_line_p
);
17328 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17329 GLYPHS 0 means don't show glyph contents.
17330 GLYPHS 1 means show glyphs in short form
17331 GLYPHS > 1 means show glyphs in long form. */
17334 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17338 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17339 fprintf (stderr
, "======================================================================\n");
17341 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17342 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17344 MATRIX_ROW_START_CHARPOS (row
),
17345 MATRIX_ROW_END_CHARPOS (row
),
17346 row
->used
[TEXT_AREA
],
17347 row
->contains_overlapping_glyphs_p
,
17349 row
->truncated_on_left_p
,
17350 row
->truncated_on_right_p
,
17352 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17353 row
->displays_text_p
,
17356 row
->ends_in_middle_of_char_p
,
17357 row
->starts_in_middle_of_char_p
,
17363 row
->visible_height
,
17366 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17367 row
->end
.overlay_string_index
,
17368 row
->continuation_lines_width
);
17369 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17370 CHARPOS (row
->start
.string_pos
),
17371 CHARPOS (row
->end
.string_pos
));
17372 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17373 row
->end
.dpvec_index
);
17380 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17382 struct glyph
*glyph
= row
->glyphs
[area
];
17383 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17385 /* Glyph for a line end in text. */
17386 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17389 if (glyph
< glyph_end
)
17390 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17392 for (; glyph
< glyph_end
; ++glyph
)
17393 dump_glyph (row
, glyph
, area
);
17396 else if (glyphs
== 1)
17400 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17402 char *s
= (char *) alloca (row
->used
[area
] + 1);
17405 for (i
= 0; i
< row
->used
[area
]; ++i
)
17407 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17408 if (glyph
->type
== CHAR_GLYPH
17409 && glyph
->u
.ch
< 0x80
17410 && glyph
->u
.ch
>= ' ')
17411 s
[i
] = glyph
->u
.ch
;
17417 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17423 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17424 Sdump_glyph_matrix
, 0, 1, "p",
17425 doc
: /* Dump the current matrix of the selected window to stderr.
17426 Shows contents of glyph row structures. With non-nil
17427 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17428 glyphs in short form, otherwise show glyphs in long form. */)
17429 (Lisp_Object glyphs
)
17431 struct window
*w
= XWINDOW (selected_window
);
17432 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17434 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17435 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17436 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17437 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17438 fprintf (stderr
, "=============================================\n");
17439 dump_glyph_matrix (w
->current_matrix
,
17440 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
17445 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17446 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17449 struct frame
*f
= XFRAME (selected_frame
);
17450 dump_glyph_matrix (f
->current_matrix
, 1);
17455 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17456 doc
: /* Dump glyph row ROW to stderr.
17457 GLYPH 0 means don't dump glyphs.
17458 GLYPH 1 means dump glyphs in short form.
17459 GLYPH > 1 or omitted means dump glyphs in long form. */)
17460 (Lisp_Object row
, Lisp_Object glyphs
)
17462 struct glyph_matrix
*matrix
;
17465 CHECK_NUMBER (row
);
17466 matrix
= XWINDOW (selected_window
)->current_matrix
;
17468 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17469 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17471 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17476 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17477 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17478 GLYPH 0 means don't dump glyphs.
17479 GLYPH 1 means dump glyphs in short form.
17480 GLYPH > 1 or omitted means dump glyphs in long form. */)
17481 (Lisp_Object row
, Lisp_Object glyphs
)
17483 struct frame
*sf
= SELECTED_FRAME ();
17484 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17487 CHECK_NUMBER (row
);
17489 if (vpos
>= 0 && vpos
< m
->nrows
)
17490 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17491 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17496 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17497 doc
: /* Toggle tracing of redisplay.
17498 With ARG, turn tracing on if and only if ARG is positive. */)
17502 trace_redisplay_p
= !trace_redisplay_p
;
17505 arg
= Fprefix_numeric_value (arg
);
17506 trace_redisplay_p
= XINT (arg
) > 0;
17513 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17514 doc
: /* Like `format', but print result to stderr.
17515 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17516 (ptrdiff_t nargs
, Lisp_Object
*args
)
17518 Lisp_Object s
= Fformat (nargs
, args
);
17519 fprintf (stderr
, "%s", SDATA (s
));
17523 #endif /* GLYPH_DEBUG */
17527 /***********************************************************************
17528 Building Desired Matrix Rows
17529 ***********************************************************************/
17531 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17532 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17534 static struct glyph_row
*
17535 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17537 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17538 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17539 struct buffer
*old
= current_buffer
;
17540 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17541 int arrow_len
= SCHARS (overlay_arrow_string
);
17542 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17543 const unsigned char *p
;
17546 int n_glyphs_before
;
17548 set_buffer_temp (buffer
);
17549 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17550 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17551 SET_TEXT_POS (it
.position
, 0, 0);
17553 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17555 while (p
< arrow_end
)
17557 Lisp_Object face
, ilisp
;
17559 /* Get the next character. */
17561 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17564 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17565 if (! ASCII_CHAR_P (it
.c
))
17566 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17570 /* Get its face. */
17571 ilisp
= make_number (p
- arrow_string
);
17572 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17573 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17575 /* Compute its width, get its glyphs. */
17576 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17577 SET_TEXT_POS (it
.position
, -1, -1);
17578 PRODUCE_GLYPHS (&it
);
17580 /* If this character doesn't fit any more in the line, we have
17581 to remove some glyphs. */
17582 if (it
.current_x
> it
.last_visible_x
)
17584 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17589 set_buffer_temp (old
);
17590 return it
.glyph_row
;
17594 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17595 glyphs are only inserted for terminal frames since we can't really
17596 win with truncation glyphs when partially visible glyphs are
17597 involved. Which glyphs to insert is determined by
17598 produce_special_glyphs. */
17601 insert_left_trunc_glyphs (struct it
*it
)
17603 struct it truncate_it
;
17604 struct glyph
*from
, *end
, *to
, *toend
;
17606 xassert (!FRAME_WINDOW_P (it
->f
));
17608 /* Get the truncation glyphs. */
17610 truncate_it
.current_x
= 0;
17611 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17612 truncate_it
.glyph_row
= &scratch_glyph_row
;
17613 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17614 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17615 truncate_it
.object
= make_number (0);
17616 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17618 /* Overwrite glyphs from IT with truncation glyphs. */
17619 if (!it
->glyph_row
->reversed_p
)
17621 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17622 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17623 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17624 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17629 /* There may be padding glyphs left over. Overwrite them too. */
17630 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17632 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17638 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17642 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17643 that back to front. */
17644 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17645 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17646 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17647 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17649 while (from
>= end
&& to
>= toend
)
17651 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17654 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17655 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17656 while (from
>= end
&& to
>= toend
)
17661 /* Need to free some room before prepending additional
17663 int move_by
= from
- end
+ 1;
17664 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17665 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17667 for ( ; g
>= g0
; g
--)
17669 while (from
>= end
)
17671 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17677 /* Compute the pixel height and width of IT->glyph_row.
17679 Most of the time, ascent and height of a display line will be equal
17680 to the max_ascent and max_height values of the display iterator
17681 structure. This is not the case if
17683 1. We hit ZV without displaying anything. In this case, max_ascent
17684 and max_height will be zero.
17686 2. We have some glyphs that don't contribute to the line height.
17687 (The glyph row flag contributes_to_line_height_p is for future
17688 pixmap extensions).
17690 The first case is easily covered by using default values because in
17691 these cases, the line height does not really matter, except that it
17692 must not be zero. */
17695 compute_line_metrics (struct it
*it
)
17697 struct glyph_row
*row
= it
->glyph_row
;
17699 if (FRAME_WINDOW_P (it
->f
))
17701 int i
, min_y
, max_y
;
17703 /* The line may consist of one space only, that was added to
17704 place the cursor on it. If so, the row's height hasn't been
17706 if (row
->height
== 0)
17708 if (it
->max_ascent
+ it
->max_descent
== 0)
17709 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17710 row
->ascent
= it
->max_ascent
;
17711 row
->height
= it
->max_ascent
+ it
->max_descent
;
17712 row
->phys_ascent
= it
->max_phys_ascent
;
17713 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17714 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17717 /* Compute the width of this line. */
17718 row
->pixel_width
= row
->x
;
17719 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17720 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17722 xassert (row
->pixel_width
>= 0);
17723 xassert (row
->ascent
>= 0 && row
->height
> 0);
17725 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17726 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17728 /* If first line's physical ascent is larger than its logical
17729 ascent, use the physical ascent, and make the row taller.
17730 This makes accented characters fully visible. */
17731 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17732 && row
->phys_ascent
> row
->ascent
)
17734 row
->height
+= row
->phys_ascent
- row
->ascent
;
17735 row
->ascent
= row
->phys_ascent
;
17738 /* Compute how much of the line is visible. */
17739 row
->visible_height
= row
->height
;
17741 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17742 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17744 if (row
->y
< min_y
)
17745 row
->visible_height
-= min_y
- row
->y
;
17746 if (row
->y
+ row
->height
> max_y
)
17747 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17751 row
->pixel_width
= row
->used
[TEXT_AREA
];
17752 if (row
->continued_p
)
17753 row
->pixel_width
-= it
->continuation_pixel_width
;
17754 else if (row
->truncated_on_right_p
)
17755 row
->pixel_width
-= it
->truncation_pixel_width
;
17756 row
->ascent
= row
->phys_ascent
= 0;
17757 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17758 row
->extra_line_spacing
= 0;
17761 /* Compute a hash code for this row. */
17765 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17766 for (i
= 0; i
< row
->used
[area
]; ++i
)
17767 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17768 + row
->glyphs
[area
][i
].u
.val
17769 + row
->glyphs
[area
][i
].face_id
17770 + row
->glyphs
[area
][i
].padding_p
17771 + (row
->glyphs
[area
][i
].type
<< 2));
17774 it
->max_ascent
= it
->max_descent
= 0;
17775 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17779 /* Append one space to the glyph row of iterator IT if doing a
17780 window-based redisplay. The space has the same face as
17781 IT->face_id. Value is non-zero if a space was added.
17783 This function is called to make sure that there is always one glyph
17784 at the end of a glyph row that the cursor can be set on under
17785 window-systems. (If there weren't such a glyph we would not know
17786 how wide and tall a box cursor should be displayed).
17788 At the same time this space let's a nicely handle clearing to the
17789 end of the line if the row ends in italic text. */
17792 append_space_for_newline (struct it
*it
, int default_face_p
)
17794 if (FRAME_WINDOW_P (it
->f
))
17796 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17798 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17799 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17801 /* Save some values that must not be changed.
17802 Must save IT->c and IT->len because otherwise
17803 ITERATOR_AT_END_P wouldn't work anymore after
17804 append_space_for_newline has been called. */
17805 enum display_element_type saved_what
= it
->what
;
17806 int saved_c
= it
->c
, saved_len
= it
->len
;
17807 int saved_char_to_display
= it
->char_to_display
;
17808 int saved_x
= it
->current_x
;
17809 int saved_face_id
= it
->face_id
;
17810 struct text_pos saved_pos
;
17811 Lisp_Object saved_object
;
17814 saved_object
= it
->object
;
17815 saved_pos
= it
->position
;
17817 it
->what
= IT_CHARACTER
;
17818 memset (&it
->position
, 0, sizeof it
->position
);
17819 it
->object
= make_number (0);
17820 it
->c
= it
->char_to_display
= ' ';
17823 if (default_face_p
)
17824 it
->face_id
= DEFAULT_FACE_ID
;
17825 else if (it
->face_before_selective_p
)
17826 it
->face_id
= it
->saved_face_id
;
17827 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17828 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17830 PRODUCE_GLYPHS (it
);
17832 it
->override_ascent
= -1;
17833 it
->constrain_row_ascent_descent_p
= 0;
17834 it
->current_x
= saved_x
;
17835 it
->object
= saved_object
;
17836 it
->position
= saved_pos
;
17837 it
->what
= saved_what
;
17838 it
->face_id
= saved_face_id
;
17839 it
->len
= saved_len
;
17841 it
->char_to_display
= saved_char_to_display
;
17850 /* Extend the face of the last glyph in the text area of IT->glyph_row
17851 to the end of the display line. Called from display_line. If the
17852 glyph row is empty, add a space glyph to it so that we know the
17853 face to draw. Set the glyph row flag fill_line_p. If the glyph
17854 row is R2L, prepend a stretch glyph to cover the empty space to the
17855 left of the leftmost glyph. */
17858 extend_face_to_end_of_line (struct it
*it
)
17861 struct frame
*f
= it
->f
;
17863 /* If line is already filled, do nothing. Non window-system frames
17864 get a grace of one more ``pixel'' because their characters are
17865 1-``pixel'' wide, so they hit the equality too early. This grace
17866 is needed only for R2L rows that are not continued, to produce
17867 one extra blank where we could display the cursor. */
17868 if (it
->current_x
>= it
->last_visible_x
17869 + (!FRAME_WINDOW_P (f
)
17870 && it
->glyph_row
->reversed_p
17871 && !it
->glyph_row
->continued_p
))
17874 /* Face extension extends the background and box of IT->face_id
17875 to the end of the line. If the background equals the background
17876 of the frame, we don't have to do anything. */
17877 if (it
->face_before_selective_p
)
17878 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17880 face
= FACE_FROM_ID (f
, it
->face_id
);
17882 if (FRAME_WINDOW_P (f
)
17883 && it
->glyph_row
->displays_text_p
17884 && face
->box
== FACE_NO_BOX
17885 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17887 && !it
->glyph_row
->reversed_p
)
17890 /* Set the glyph row flag indicating that the face of the last glyph
17891 in the text area has to be drawn to the end of the text area. */
17892 it
->glyph_row
->fill_line_p
= 1;
17894 /* If current character of IT is not ASCII, make sure we have the
17895 ASCII face. This will be automatically undone the next time
17896 get_next_display_element returns a multibyte character. Note
17897 that the character will always be single byte in unibyte
17899 if (!ASCII_CHAR_P (it
->c
))
17901 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17904 if (FRAME_WINDOW_P (f
))
17906 /* If the row is empty, add a space with the current face of IT,
17907 so that we know which face to draw. */
17908 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17910 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17911 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17912 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17914 #ifdef HAVE_WINDOW_SYSTEM
17915 if (it
->glyph_row
->reversed_p
)
17917 /* Prepend a stretch glyph to the row, such that the
17918 rightmost glyph will be drawn flushed all the way to the
17919 right margin of the window. The stretch glyph that will
17920 occupy the empty space, if any, to the left of the
17922 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17923 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17924 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17926 int row_width
, stretch_ascent
, stretch_width
;
17927 struct text_pos saved_pos
;
17928 int saved_face_id
, saved_avoid_cursor
;
17930 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17931 row_width
+= g
->pixel_width
;
17932 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17933 if (stretch_width
> 0)
17936 (((it
->ascent
+ it
->descent
)
17937 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17938 saved_pos
= it
->position
;
17939 memset (&it
->position
, 0, sizeof it
->position
);
17940 saved_avoid_cursor
= it
->avoid_cursor_p
;
17941 it
->avoid_cursor_p
= 1;
17942 saved_face_id
= it
->face_id
;
17943 /* The last row's stretch glyph should get the default
17944 face, to avoid painting the rest of the window with
17945 the region face, if the region ends at ZV. */
17946 if (it
->glyph_row
->ends_at_zv_p
)
17947 it
->face_id
= DEFAULT_FACE_ID
;
17949 it
->face_id
= face
->id
;
17950 append_stretch_glyph (it
, make_number (0), stretch_width
,
17951 it
->ascent
+ it
->descent
, stretch_ascent
);
17952 it
->position
= saved_pos
;
17953 it
->avoid_cursor_p
= saved_avoid_cursor
;
17954 it
->face_id
= saved_face_id
;
17957 #endif /* HAVE_WINDOW_SYSTEM */
17961 /* Save some values that must not be changed. */
17962 int saved_x
= it
->current_x
;
17963 struct text_pos saved_pos
;
17964 Lisp_Object saved_object
;
17965 enum display_element_type saved_what
= it
->what
;
17966 int saved_face_id
= it
->face_id
;
17968 saved_object
= it
->object
;
17969 saved_pos
= it
->position
;
17971 it
->what
= IT_CHARACTER
;
17972 memset (&it
->position
, 0, sizeof it
->position
);
17973 it
->object
= make_number (0);
17974 it
->c
= it
->char_to_display
= ' ';
17976 /* The last row's blank glyphs should get the default face, to
17977 avoid painting the rest of the window with the region face,
17978 if the region ends at ZV. */
17979 if (it
->glyph_row
->ends_at_zv_p
)
17980 it
->face_id
= DEFAULT_FACE_ID
;
17982 it
->face_id
= face
->id
;
17984 PRODUCE_GLYPHS (it
);
17986 while (it
->current_x
<= it
->last_visible_x
)
17987 PRODUCE_GLYPHS (it
);
17989 /* Don't count these blanks really. It would let us insert a left
17990 truncation glyph below and make us set the cursor on them, maybe. */
17991 it
->current_x
= saved_x
;
17992 it
->object
= saved_object
;
17993 it
->position
= saved_pos
;
17994 it
->what
= saved_what
;
17995 it
->face_id
= saved_face_id
;
18000 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18001 trailing whitespace. */
18004 trailing_whitespace_p (ptrdiff_t charpos
)
18006 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18009 while (bytepos
< ZV_BYTE
18010 && (c
= FETCH_CHAR (bytepos
),
18011 c
== ' ' || c
== '\t'))
18014 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18016 if (bytepos
!= PT_BYTE
)
18023 /* Highlight trailing whitespace, if any, in ROW. */
18026 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18028 int used
= row
->used
[TEXT_AREA
];
18032 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18033 struct glyph
*glyph
= start
+ used
- 1;
18035 if (row
->reversed_p
)
18037 /* Right-to-left rows need to be processed in the opposite
18038 direction, so swap the edge pointers. */
18040 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18043 /* Skip over glyphs inserted to display the cursor at the
18044 end of a line, for extending the face of the last glyph
18045 to the end of the line on terminals, and for truncation
18046 and continuation glyphs. */
18047 if (!row
->reversed_p
)
18049 while (glyph
>= start
18050 && glyph
->type
== CHAR_GLYPH
18051 && INTEGERP (glyph
->object
))
18056 while (glyph
<= start
18057 && glyph
->type
== CHAR_GLYPH
18058 && INTEGERP (glyph
->object
))
18062 /* If last glyph is a space or stretch, and it's trailing
18063 whitespace, set the face of all trailing whitespace glyphs in
18064 IT->glyph_row to `trailing-whitespace'. */
18065 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18066 && BUFFERP (glyph
->object
)
18067 && (glyph
->type
== STRETCH_GLYPH
18068 || (glyph
->type
== CHAR_GLYPH
18069 && glyph
->u
.ch
== ' '))
18070 && trailing_whitespace_p (glyph
->charpos
))
18072 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18076 if (!row
->reversed_p
)
18078 while (glyph
>= start
18079 && BUFFERP (glyph
->object
)
18080 && (glyph
->type
== STRETCH_GLYPH
18081 || (glyph
->type
== CHAR_GLYPH
18082 && glyph
->u
.ch
== ' ')))
18083 (glyph
--)->face_id
= face_id
;
18087 while (glyph
<= start
18088 && BUFFERP (glyph
->object
)
18089 && (glyph
->type
== STRETCH_GLYPH
18090 || (glyph
->type
== CHAR_GLYPH
18091 && glyph
->u
.ch
== ' ')))
18092 (glyph
++)->face_id
= face_id
;
18099 /* Value is non-zero if glyph row ROW should be
18100 used to hold the cursor. */
18103 cursor_row_p (struct glyph_row
*row
)
18107 if (PT
== CHARPOS (row
->end
.pos
)
18108 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18110 /* Suppose the row ends on a string.
18111 Unless the row is continued, that means it ends on a newline
18112 in the string. If it's anything other than a display string
18113 (e.g. a before-string from an overlay), we don't want the
18114 cursor there. (This heuristic seems to give the optimal
18115 behavior for the various types of multi-line strings.) */
18116 if (CHARPOS (row
->end
.string_pos
) >= 0)
18118 if (row
->continued_p
)
18122 /* Check for `display' property. */
18123 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18124 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18125 struct glyph
*glyph
;
18128 for (glyph
= end
; glyph
>= beg
; --glyph
)
18129 if (STRINGP (glyph
->object
))
18132 = Fget_char_property (make_number (PT
),
18136 && display_prop_string_p (prop
, glyph
->object
));
18141 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18143 /* If the row ends in middle of a real character,
18144 and the line is continued, we want the cursor here.
18145 That's because CHARPOS (ROW->end.pos) would equal
18146 PT if PT is before the character. */
18147 if (!row
->ends_in_ellipsis_p
)
18148 result
= row
->continued_p
;
18150 /* If the row ends in an ellipsis, then
18151 CHARPOS (ROW->end.pos) will equal point after the
18152 invisible text. We want that position to be displayed
18153 after the ellipsis. */
18156 /* If the row ends at ZV, display the cursor at the end of that
18157 row instead of at the start of the row below. */
18158 else if (row
->ends_at_zv_p
)
18169 /* Push the property PROP so that it will be rendered at the current
18170 position in IT. Return 1 if PROP was successfully pushed, 0
18171 otherwise. Called from handle_line_prefix to handle the
18172 `line-prefix' and `wrap-prefix' properties. */
18175 push_display_prop (struct it
*it
, Lisp_Object prop
)
18177 struct text_pos pos
=
18178 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18180 xassert (it
->method
== GET_FROM_BUFFER
18181 || it
->method
== GET_FROM_STRING
);
18183 /* We need to save the current buffer/string position, so it will be
18184 restored by pop_it, because iterate_out_of_display_property
18185 depends on that being set correctly, but some situations leave
18186 it->position not yet set when this function is called. */
18187 push_it (it
, &pos
);
18189 if (STRINGP (prop
))
18191 if (SCHARS (prop
) == 0)
18198 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18199 it
->current
.overlay_string_index
= -1;
18200 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18201 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18202 it
->method
= GET_FROM_STRING
;
18203 it
->stop_charpos
= 0;
18205 it
->base_level_stop
= 0;
18207 /* Force paragraph direction to be that of the parent
18209 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18210 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18212 it
->paragraph_embedding
= L2R
;
18214 /* Set up the bidi iterator for this display string. */
18217 it
->bidi_it
.string
.lstring
= it
->string
;
18218 it
->bidi_it
.string
.s
= NULL
;
18219 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18220 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18221 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18222 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18223 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18226 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18228 it
->method
= GET_FROM_STRETCH
;
18231 #ifdef HAVE_WINDOW_SYSTEM
18232 else if (IMAGEP (prop
))
18234 it
->what
= IT_IMAGE
;
18235 it
->image_id
= lookup_image (it
->f
, prop
);
18236 it
->method
= GET_FROM_IMAGE
;
18238 #endif /* HAVE_WINDOW_SYSTEM */
18241 pop_it (it
); /* bogus display property, give up */
18248 /* Return the character-property PROP at the current position in IT. */
18251 get_it_property (struct it
*it
, Lisp_Object prop
)
18253 Lisp_Object position
;
18255 if (STRINGP (it
->object
))
18256 position
= make_number (IT_STRING_CHARPOS (*it
));
18257 else if (BUFFERP (it
->object
))
18258 position
= make_number (IT_CHARPOS (*it
));
18262 return Fget_char_property (position
, prop
, it
->object
);
18265 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18268 handle_line_prefix (struct it
*it
)
18270 Lisp_Object prefix
;
18272 if (it
->continuation_lines_width
> 0)
18274 prefix
= get_it_property (it
, Qwrap_prefix
);
18276 prefix
= Vwrap_prefix
;
18280 prefix
= get_it_property (it
, Qline_prefix
);
18282 prefix
= Vline_prefix
;
18284 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18286 /* If the prefix is wider than the window, and we try to wrap
18287 it, it would acquire its own wrap prefix, and so on till the
18288 iterator stack overflows. So, don't wrap the prefix. */
18289 it
->line_wrap
= TRUNCATE
;
18290 it
->avoid_cursor_p
= 1;
18296 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18297 only for R2L lines from display_line and display_string, when they
18298 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18299 the line/string needs to be continued on the next glyph row. */
18301 unproduce_glyphs (struct it
*it
, int n
)
18303 struct glyph
*glyph
, *end
;
18305 xassert (it
->glyph_row
);
18306 xassert (it
->glyph_row
->reversed_p
);
18307 xassert (it
->area
== TEXT_AREA
);
18308 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18310 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18311 n
= it
->glyph_row
->used
[TEXT_AREA
];
18312 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18313 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18314 for ( ; glyph
< end
; glyph
++)
18315 glyph
[-n
] = *glyph
;
18318 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18319 and ROW->maxpos. */
18321 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18322 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18323 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18325 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18326 lines' rows is implemented for bidi-reordered rows. */
18328 /* ROW->minpos is the value of min_pos, the minimal buffer position
18329 we have in ROW, or ROW->start.pos if that is smaller. */
18330 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18331 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18333 /* We didn't find buffer positions smaller than ROW->start, or
18334 didn't find _any_ valid buffer positions in any of the glyphs,
18335 so we must trust the iterator's computed positions. */
18336 row
->minpos
= row
->start
.pos
;
18339 max_pos
= CHARPOS (it
->current
.pos
);
18340 max_bpos
= BYTEPOS (it
->current
.pos
);
18343 /* Here are the various use-cases for ending the row, and the
18344 corresponding values for ROW->maxpos:
18346 Line ends in a newline from buffer eol_pos + 1
18347 Line is continued from buffer max_pos + 1
18348 Line is truncated on right it->current.pos
18349 Line ends in a newline from string max_pos
18350 Line is continued from string max_pos
18351 Line is continued from display vector max_pos
18352 Line is entirely from a string min_pos == max_pos
18353 Line is entirely from a display vector min_pos == max_pos
18354 Line that ends at ZV ZV
18356 If you discover other use-cases, please add them here as
18358 if (row
->ends_at_zv_p
)
18359 row
->maxpos
= it
->current
.pos
;
18360 else if (row
->used
[TEXT_AREA
])
18362 if (row
->ends_in_newline_from_string_p
)
18363 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18364 else if (CHARPOS (it
->eol_pos
) > 0)
18365 SET_TEXT_POS (row
->maxpos
,
18366 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18367 else if (row
->continued_p
)
18369 /* If max_pos is different from IT's current position, it
18370 means IT->method does not belong to the display element
18371 at max_pos. However, it also means that the display
18372 element at max_pos was displayed in its entirety on this
18373 line, which is equivalent to saying that the next line
18374 starts at the next buffer position. */
18375 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18376 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18379 INC_BOTH (max_pos
, max_bpos
);
18380 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18383 else if (row
->truncated_on_right_p
)
18384 /* display_line already called reseat_at_next_visible_line_start,
18385 which puts the iterator at the beginning of the next line, in
18386 the logical order. */
18387 row
->maxpos
= it
->current
.pos
;
18388 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18389 /* A line that is entirely from a string/image/stretch... */
18390 row
->maxpos
= row
->minpos
;
18395 row
->maxpos
= it
->current
.pos
;
18398 /* Construct the glyph row IT->glyph_row in the desired matrix of
18399 IT->w from text at the current position of IT. See dispextern.h
18400 for an overview of struct it. Value is non-zero if
18401 IT->glyph_row displays text, as opposed to a line displaying ZV
18405 display_line (struct it
*it
)
18407 struct glyph_row
*row
= it
->glyph_row
;
18408 Lisp_Object overlay_arrow_string
;
18410 void *wrap_data
= NULL
;
18411 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18412 int wrap_row_used
= -1;
18413 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18414 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18415 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18416 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18417 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18419 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
18420 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18422 /* We always start displaying at hpos zero even if hscrolled. */
18423 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18425 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18426 >= it
->w
->desired_matrix
->nrows
)
18428 it
->w
->nrows_scale_factor
++;
18429 fonts_changed_p
= 1;
18433 /* Is IT->w showing the region? */
18434 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18436 /* Clear the result glyph row and enable it. */
18437 prepare_desired_row (row
);
18439 row
->y
= it
->current_y
;
18440 row
->start
= it
->start
;
18441 row
->continuation_lines_width
= it
->continuation_lines_width
;
18442 row
->displays_text_p
= 1;
18443 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18444 it
->starts_in_middle_of_char_p
= 0;
18446 /* Arrange the overlays nicely for our purposes. Usually, we call
18447 display_line on only one line at a time, in which case this
18448 can't really hurt too much, or we call it on lines which appear
18449 one after another in the buffer, in which case all calls to
18450 recenter_overlay_lists but the first will be pretty cheap. */
18451 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18453 /* Move over display elements that are not visible because we are
18454 hscrolled. This may stop at an x-position < IT->first_visible_x
18455 if the first glyph is partially visible or if we hit a line end. */
18456 if (it
->current_x
< it
->first_visible_x
)
18458 this_line_min_pos
= row
->start
.pos
;
18459 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18460 MOVE_TO_POS
| MOVE_TO_X
);
18461 /* Record the smallest positions seen while we moved over
18462 display elements that are not visible. This is needed by
18463 redisplay_internal for optimizing the case where the cursor
18464 stays inside the same line. The rest of this function only
18465 considers positions that are actually displayed, so
18466 RECORD_MAX_MIN_POS will not otherwise record positions that
18467 are hscrolled to the left of the left edge of the window. */
18468 min_pos
= CHARPOS (this_line_min_pos
);
18469 min_bpos
= BYTEPOS (this_line_min_pos
);
18473 /* We only do this when not calling `move_it_in_display_line_to'
18474 above, because move_it_in_display_line_to calls
18475 handle_line_prefix itself. */
18476 handle_line_prefix (it
);
18479 /* Get the initial row height. This is either the height of the
18480 text hscrolled, if there is any, or zero. */
18481 row
->ascent
= it
->max_ascent
;
18482 row
->height
= it
->max_ascent
+ it
->max_descent
;
18483 row
->phys_ascent
= it
->max_phys_ascent
;
18484 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18485 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18487 /* Utility macro to record max and min buffer positions seen until now. */
18488 #define RECORD_MAX_MIN_POS(IT) \
18491 int composition_p = (IT)->what == IT_COMPOSITION; \
18492 ptrdiff_t current_pos = \
18493 composition_p ? (IT)->cmp_it.charpos \
18494 : IT_CHARPOS (*(IT)); \
18495 ptrdiff_t current_bpos = \
18496 composition_p ? CHAR_TO_BYTE (current_pos) \
18497 : IT_BYTEPOS (*(IT)); \
18498 if (current_pos < min_pos) \
18500 min_pos = current_pos; \
18501 min_bpos = current_bpos; \
18503 if (IT_CHARPOS (*it) > max_pos) \
18505 max_pos = IT_CHARPOS (*it); \
18506 max_bpos = IT_BYTEPOS (*it); \
18511 /* Loop generating characters. The loop is left with IT on the next
18512 character to display. */
18515 int n_glyphs_before
, hpos_before
, x_before
;
18517 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18519 /* Retrieve the next thing to display. Value is zero if end of
18521 if (!get_next_display_element (it
))
18523 /* Maybe add a space at the end of this line that is used to
18524 display the cursor there under X. Set the charpos of the
18525 first glyph of blank lines not corresponding to any text
18527 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18528 row
->exact_window_width_line_p
= 1;
18529 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18530 || row
->used
[TEXT_AREA
] == 0)
18532 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18533 row
->displays_text_p
= 0;
18535 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18536 && (!MINI_WINDOW_P (it
->w
)
18537 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18538 row
->indicate_empty_line_p
= 1;
18541 it
->continuation_lines_width
= 0;
18542 row
->ends_at_zv_p
= 1;
18543 /* A row that displays right-to-left text must always have
18544 its last face extended all the way to the end of line,
18545 even if this row ends in ZV, because we still write to
18546 the screen left to right. */
18547 if (row
->reversed_p
)
18548 extend_face_to_end_of_line (it
);
18552 /* Now, get the metrics of what we want to display. This also
18553 generates glyphs in `row' (which is IT->glyph_row). */
18554 n_glyphs_before
= row
->used
[TEXT_AREA
];
18557 /* Remember the line height so far in case the next element doesn't
18558 fit on the line. */
18559 if (it
->line_wrap
!= TRUNCATE
)
18561 ascent
= it
->max_ascent
;
18562 descent
= it
->max_descent
;
18563 phys_ascent
= it
->max_phys_ascent
;
18564 phys_descent
= it
->max_phys_descent
;
18566 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18568 if (IT_DISPLAYING_WHITESPACE (it
))
18572 SAVE_IT (wrap_it
, *it
, wrap_data
);
18574 wrap_row_used
= row
->used
[TEXT_AREA
];
18575 wrap_row_ascent
= row
->ascent
;
18576 wrap_row_height
= row
->height
;
18577 wrap_row_phys_ascent
= row
->phys_ascent
;
18578 wrap_row_phys_height
= row
->phys_height
;
18579 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18580 wrap_row_min_pos
= min_pos
;
18581 wrap_row_min_bpos
= min_bpos
;
18582 wrap_row_max_pos
= max_pos
;
18583 wrap_row_max_bpos
= max_bpos
;
18589 PRODUCE_GLYPHS (it
);
18591 /* If this display element was in marginal areas, continue with
18593 if (it
->area
!= TEXT_AREA
)
18595 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18596 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18597 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18598 row
->phys_height
= max (row
->phys_height
,
18599 it
->max_phys_ascent
+ it
->max_phys_descent
);
18600 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18601 it
->max_extra_line_spacing
);
18602 set_iterator_to_next (it
, 1);
18606 /* Does the display element fit on the line? If we truncate
18607 lines, we should draw past the right edge of the window. If
18608 we don't truncate, we want to stop so that we can display the
18609 continuation glyph before the right margin. If lines are
18610 continued, there are two possible strategies for characters
18611 resulting in more than 1 glyph (e.g. tabs): Display as many
18612 glyphs as possible in this line and leave the rest for the
18613 continuation line, or display the whole element in the next
18614 line. Original redisplay did the former, so we do it also. */
18615 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18616 hpos_before
= it
->hpos
;
18619 if (/* Not a newline. */
18621 /* Glyphs produced fit entirely in the line. */
18622 && it
->current_x
< it
->last_visible_x
)
18624 it
->hpos
+= nglyphs
;
18625 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18626 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18627 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18628 row
->phys_height
= max (row
->phys_height
,
18629 it
->max_phys_ascent
+ it
->max_phys_descent
);
18630 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18631 it
->max_extra_line_spacing
);
18632 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18633 row
->x
= x
- it
->first_visible_x
;
18634 /* Record the maximum and minimum buffer positions seen so
18635 far in glyphs that will be displayed by this row. */
18637 RECORD_MAX_MIN_POS (it
);
18642 struct glyph
*glyph
;
18644 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18646 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18647 new_x
= x
+ glyph
->pixel_width
;
18649 if (/* Lines are continued. */
18650 it
->line_wrap
!= TRUNCATE
18651 && (/* Glyph doesn't fit on the line. */
18652 new_x
> it
->last_visible_x
18653 /* Or it fits exactly on a window system frame. */
18654 || (new_x
== it
->last_visible_x
18655 && FRAME_WINDOW_P (it
->f
))))
18657 /* End of a continued line. */
18660 || (new_x
== it
->last_visible_x
18661 && FRAME_WINDOW_P (it
->f
)))
18663 /* Current glyph is the only one on the line or
18664 fits exactly on the line. We must continue
18665 the line because we can't draw the cursor
18666 after the glyph. */
18667 row
->continued_p
= 1;
18668 it
->current_x
= new_x
;
18669 it
->continuation_lines_width
+= new_x
;
18671 /* Record the maximum and minimum buffer
18672 positions seen so far in glyphs that will be
18673 displayed by this row. */
18675 RECORD_MAX_MIN_POS (it
);
18676 if (i
== nglyphs
- 1)
18678 /* If line-wrap is on, check if a previous
18679 wrap point was found. */
18680 if (wrap_row_used
> 0
18681 /* Even if there is a previous wrap
18682 point, continue the line here as
18683 usual, if (i) the previous character
18684 was a space or tab AND (ii) the
18685 current character is not. */
18687 || IT_DISPLAYING_WHITESPACE (it
)))
18690 set_iterator_to_next (it
, 1);
18691 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18693 if (!get_next_display_element (it
))
18695 row
->exact_window_width_line_p
= 1;
18696 it
->continuation_lines_width
= 0;
18697 row
->continued_p
= 0;
18698 row
->ends_at_zv_p
= 1;
18700 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18702 row
->continued_p
= 0;
18703 row
->exact_window_width_line_p
= 1;
18708 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18709 && !FRAME_WINDOW_P (it
->f
))
18711 /* A padding glyph that doesn't fit on this line.
18712 This means the whole character doesn't fit
18714 if (row
->reversed_p
)
18715 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18716 - n_glyphs_before
);
18717 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18719 /* Fill the rest of the row with continuation
18720 glyphs like in 20.x. */
18721 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18722 < row
->glyphs
[1 + TEXT_AREA
])
18723 produce_special_glyphs (it
, IT_CONTINUATION
);
18725 row
->continued_p
= 1;
18726 it
->current_x
= x_before
;
18727 it
->continuation_lines_width
+= x_before
;
18729 /* Restore the height to what it was before the
18730 element not fitting on the line. */
18731 it
->max_ascent
= ascent
;
18732 it
->max_descent
= descent
;
18733 it
->max_phys_ascent
= phys_ascent
;
18734 it
->max_phys_descent
= phys_descent
;
18736 else if (wrap_row_used
> 0)
18739 if (row
->reversed_p
)
18740 unproduce_glyphs (it
,
18741 row
->used
[TEXT_AREA
] - wrap_row_used
);
18742 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18743 it
->continuation_lines_width
+= wrap_x
;
18744 row
->used
[TEXT_AREA
] = wrap_row_used
;
18745 row
->ascent
= wrap_row_ascent
;
18746 row
->height
= wrap_row_height
;
18747 row
->phys_ascent
= wrap_row_phys_ascent
;
18748 row
->phys_height
= wrap_row_phys_height
;
18749 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18750 min_pos
= wrap_row_min_pos
;
18751 min_bpos
= wrap_row_min_bpos
;
18752 max_pos
= wrap_row_max_pos
;
18753 max_bpos
= wrap_row_max_bpos
;
18754 row
->continued_p
= 1;
18755 row
->ends_at_zv_p
= 0;
18756 row
->exact_window_width_line_p
= 0;
18757 it
->continuation_lines_width
+= x
;
18759 /* Make sure that a non-default face is extended
18760 up to the right margin of the window. */
18761 extend_face_to_end_of_line (it
);
18763 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18765 /* A TAB that extends past the right edge of the
18766 window. This produces a single glyph on
18767 window system frames. We leave the glyph in
18768 this row and let it fill the row, but don't
18769 consume the TAB. */
18770 it
->continuation_lines_width
+= it
->last_visible_x
;
18771 row
->ends_in_middle_of_char_p
= 1;
18772 row
->continued_p
= 1;
18773 glyph
->pixel_width
= it
->last_visible_x
- x
;
18774 it
->starts_in_middle_of_char_p
= 1;
18778 /* Something other than a TAB that draws past
18779 the right edge of the window. Restore
18780 positions to values before the element. */
18781 if (row
->reversed_p
)
18782 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18783 - (n_glyphs_before
+ i
));
18784 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18786 /* Display continuation glyphs. */
18787 if (!FRAME_WINDOW_P (it
->f
))
18788 produce_special_glyphs (it
, IT_CONTINUATION
);
18789 row
->continued_p
= 1;
18791 it
->current_x
= x_before
;
18792 it
->continuation_lines_width
+= x
;
18793 extend_face_to_end_of_line (it
);
18795 if (nglyphs
> 1 && i
> 0)
18797 row
->ends_in_middle_of_char_p
= 1;
18798 it
->starts_in_middle_of_char_p
= 1;
18801 /* Restore the height to what it was before the
18802 element not fitting on the line. */
18803 it
->max_ascent
= ascent
;
18804 it
->max_descent
= descent
;
18805 it
->max_phys_ascent
= phys_ascent
;
18806 it
->max_phys_descent
= phys_descent
;
18811 else if (new_x
> it
->first_visible_x
)
18813 /* Increment number of glyphs actually displayed. */
18816 /* Record the maximum and minimum buffer positions
18817 seen so far in glyphs that will be displayed by
18820 RECORD_MAX_MIN_POS (it
);
18822 if (x
< it
->first_visible_x
)
18823 /* Glyph is partially visible, i.e. row starts at
18824 negative X position. */
18825 row
->x
= x
- it
->first_visible_x
;
18829 /* Glyph is completely off the left margin of the
18830 window. This should not happen because of the
18831 move_it_in_display_line at the start of this
18832 function, unless the text display area of the
18833 window is empty. */
18834 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18838 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18839 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18840 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18841 row
->phys_height
= max (row
->phys_height
,
18842 it
->max_phys_ascent
+ it
->max_phys_descent
);
18843 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18844 it
->max_extra_line_spacing
);
18846 /* End of this display line if row is continued. */
18847 if (row
->continued_p
|| row
->ends_at_zv_p
)
18852 /* Is this a line end? If yes, we're also done, after making
18853 sure that a non-default face is extended up to the right
18854 margin of the window. */
18855 if (ITERATOR_AT_END_OF_LINE_P (it
))
18857 int used_before
= row
->used
[TEXT_AREA
];
18859 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18861 /* Add a space at the end of the line that is used to
18862 display the cursor there. */
18863 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18864 append_space_for_newline (it
, 0);
18866 /* Extend the face to the end of the line. */
18867 extend_face_to_end_of_line (it
);
18869 /* Make sure we have the position. */
18870 if (used_before
== 0)
18871 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18873 /* Record the position of the newline, for use in
18875 it
->eol_pos
= it
->current
.pos
;
18877 /* Consume the line end. This skips over invisible lines. */
18878 set_iterator_to_next (it
, 1);
18879 it
->continuation_lines_width
= 0;
18883 /* Proceed with next display element. Note that this skips
18884 over lines invisible because of selective display. */
18885 set_iterator_to_next (it
, 1);
18887 /* If we truncate lines, we are done when the last displayed
18888 glyphs reach past the right margin of the window. */
18889 if (it
->line_wrap
== TRUNCATE
18890 && (FRAME_WINDOW_P (it
->f
)
18891 ? (it
->current_x
>= it
->last_visible_x
)
18892 : (it
->current_x
> it
->last_visible_x
)))
18894 /* Maybe add truncation glyphs. */
18895 if (!FRAME_WINDOW_P (it
->f
))
18899 if (!row
->reversed_p
)
18901 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18902 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18907 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18908 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18910 /* Remove any padding glyphs at the front of ROW, to
18911 make room for the truncation glyphs we will be
18912 adding below. The loop below always inserts at
18913 least one truncation glyph, so also remove the
18914 last glyph added to ROW. */
18915 unproduce_glyphs (it
, i
+ 1);
18916 /* Adjust i for the loop below. */
18917 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18920 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18922 row
->used
[TEXT_AREA
] = i
;
18923 produce_special_glyphs (it
, IT_TRUNCATION
);
18926 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18928 /* Don't truncate if we can overflow newline into fringe. */
18929 if (!get_next_display_element (it
))
18931 it
->continuation_lines_width
= 0;
18932 row
->ends_at_zv_p
= 1;
18933 row
->exact_window_width_line_p
= 1;
18936 if (ITERATOR_AT_END_OF_LINE_P (it
))
18938 row
->exact_window_width_line_p
= 1;
18939 goto at_end_of_line
;
18943 row
->truncated_on_right_p
= 1;
18944 it
->continuation_lines_width
= 0;
18945 reseat_at_next_visible_line_start (it
, 0);
18946 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18947 it
->hpos
= hpos_before
;
18948 it
->current_x
= x_before
;
18954 bidi_unshelve_cache (wrap_data
, 1);
18956 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18957 at the left window margin. */
18958 if (it
->first_visible_x
18959 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18961 if (!FRAME_WINDOW_P (it
->f
))
18962 insert_left_trunc_glyphs (it
);
18963 row
->truncated_on_left_p
= 1;
18966 /* Remember the position at which this line ends.
18968 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18969 cannot be before the call to find_row_edges below, since that is
18970 where these positions are determined. */
18971 row
->end
= it
->current
;
18974 row
->minpos
= row
->start
.pos
;
18975 row
->maxpos
= row
->end
.pos
;
18979 /* ROW->minpos and ROW->maxpos must be the smallest and
18980 `1 + the largest' buffer positions in ROW. But if ROW was
18981 bidi-reordered, these two positions can be anywhere in the
18982 row, so we must determine them now. */
18983 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18986 /* If the start of this line is the overlay arrow-position, then
18987 mark this glyph row as the one containing the overlay arrow.
18988 This is clearly a mess with variable size fonts. It would be
18989 better to let it be displayed like cursors under X. */
18990 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18991 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18992 !NILP (overlay_arrow_string
)))
18994 /* Overlay arrow in window redisplay is a fringe bitmap. */
18995 if (STRINGP (overlay_arrow_string
))
18997 struct glyph_row
*arrow_row
18998 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18999 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19000 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19001 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19002 struct glyph
*p2
, *end
;
19004 /* Copy the arrow glyphs. */
19005 while (glyph
< arrow_end
)
19008 /* Throw away padding glyphs. */
19010 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19011 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19017 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19022 xassert (INTEGERP (overlay_arrow_string
));
19023 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19025 overlay_arrow_seen
= 1;
19028 /* Compute pixel dimensions of this line. */
19029 compute_line_metrics (it
);
19031 /* Record whether this row ends inside an ellipsis. */
19032 row
->ends_in_ellipsis_p
19033 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19034 && it
->ellipsis_p
);
19036 /* Save fringe bitmaps in this row. */
19037 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19038 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19039 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19040 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19042 it
->left_user_fringe_bitmap
= 0;
19043 it
->left_user_fringe_face_id
= 0;
19044 it
->right_user_fringe_bitmap
= 0;
19045 it
->right_user_fringe_face_id
= 0;
19047 /* Maybe set the cursor. */
19048 cvpos
= it
->w
->cursor
.vpos
;
19050 /* In bidi-reordered rows, keep checking for proper cursor
19051 position even if one has been found already, because buffer
19052 positions in such rows change non-linearly with ROW->VPOS,
19053 when a line is continued. One exception: when we are at ZV,
19054 display cursor on the first suitable glyph row, since all
19055 the empty rows after that also have their position set to ZV. */
19056 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19057 lines' rows is implemented for bidi-reordered rows. */
19059 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19060 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19061 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19062 && cursor_row_p (row
))
19063 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19065 /* Highlight trailing whitespace. */
19066 if (!NILP (Vshow_trailing_whitespace
))
19067 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19069 /* Prepare for the next line. This line starts horizontally at (X
19070 HPOS) = (0 0). Vertical positions are incremented. As a
19071 convenience for the caller, IT->glyph_row is set to the next
19073 it
->current_x
= it
->hpos
= 0;
19074 it
->current_y
+= row
->height
;
19075 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19078 /* The next row should by default use the same value of the
19079 reversed_p flag as this one. set_iterator_to_next decides when
19080 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19081 the flag accordingly. */
19082 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19083 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19084 it
->start
= row
->end
;
19085 return row
->displays_text_p
;
19087 #undef RECORD_MAX_MIN_POS
19090 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19091 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19092 doc
: /* Return paragraph direction at point in BUFFER.
19093 Value is either `left-to-right' or `right-to-left'.
19094 If BUFFER is omitted or nil, it defaults to the current buffer.
19096 Paragraph direction determines how the text in the paragraph is displayed.
19097 In left-to-right paragraphs, text begins at the left margin of the window
19098 and the reading direction is generally left to right. In right-to-left
19099 paragraphs, text begins at the right margin and is read from right to left.
19101 See also `bidi-paragraph-direction'. */)
19102 (Lisp_Object buffer
)
19104 struct buffer
*buf
= current_buffer
;
19105 struct buffer
*old
= buf
;
19107 if (! NILP (buffer
))
19109 CHECK_BUFFER (buffer
);
19110 buf
= XBUFFER (buffer
);
19113 if (NILP (BVAR (buf
, bidi_display_reordering
))
19114 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19115 return Qleft_to_right
;
19116 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19117 return BVAR (buf
, bidi_paragraph_direction
);
19120 /* Determine the direction from buffer text. We could try to
19121 use current_matrix if it is up to date, but this seems fast
19122 enough as it is. */
19123 struct bidi_it itb
;
19124 ptrdiff_t pos
= BUF_PT (buf
);
19125 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19128 set_buffer_temp (buf
);
19129 /* bidi_paragraph_init finds the base direction of the paragraph
19130 by searching forward from paragraph start. We need the base
19131 direction of the current or _previous_ paragraph, so we need
19132 to make sure we are within that paragraph. To that end, find
19133 the previous non-empty line. */
19134 if (pos
>= ZV
&& pos
> BEGV
)
19137 bytepos
= CHAR_TO_BYTE (pos
);
19139 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19140 || c
== ' ' || c
== '\t' || c
== '\f')
19142 if (bytepos
<= BEGV_BYTE
)
19147 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19150 itb
.bytepos
= bytepos
;
19152 itb
.string
.s
= NULL
;
19153 itb
.string
.lstring
= Qnil
;
19154 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
19156 itb
.separator_limit
= -1;
19157 itb
.paragraph_dir
= NEUTRAL_DIR
;
19159 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19160 set_buffer_temp (old
);
19161 switch (itb
.paragraph_dir
)
19164 return Qleft_to_right
;
19167 return Qright_to_left
;
19177 /***********************************************************************
19179 ***********************************************************************/
19181 /* Redisplay the menu bar in the frame for window W.
19183 The menu bar of X frames that don't have X toolkit support is
19184 displayed in a special window W->frame->menu_bar_window.
19186 The menu bar of terminal frames is treated specially as far as
19187 glyph matrices are concerned. Menu bar lines are not part of
19188 windows, so the update is done directly on the frame matrix rows
19189 for the menu bar. */
19192 display_menu_bar (struct window
*w
)
19194 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19199 /* Don't do all this for graphical frames. */
19201 if (FRAME_W32_P (f
))
19204 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19210 if (FRAME_NS_P (f
))
19212 #endif /* HAVE_NS */
19214 #ifdef USE_X_TOOLKIT
19215 xassert (!FRAME_WINDOW_P (f
));
19216 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19217 it
.first_visible_x
= 0;
19218 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19219 #else /* not USE_X_TOOLKIT */
19220 if (FRAME_WINDOW_P (f
))
19222 /* Menu bar lines are displayed in the desired matrix of the
19223 dummy window menu_bar_window. */
19224 struct window
*menu_w
;
19225 xassert (WINDOWP (f
->menu_bar_window
));
19226 menu_w
= XWINDOW (f
->menu_bar_window
);
19227 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19229 it
.first_visible_x
= 0;
19230 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19234 /* This is a TTY frame, i.e. character hpos/vpos are used as
19236 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19238 it
.first_visible_x
= 0;
19239 it
.last_visible_x
= FRAME_COLS (f
);
19241 #endif /* not USE_X_TOOLKIT */
19243 /* FIXME: This should be controlled by a user option. See the
19244 comments in redisplay_tool_bar and display_mode_line about
19246 it
.paragraph_embedding
= L2R
;
19248 if (! mode_line_inverse_video
)
19249 /* Force the menu-bar to be displayed in the default face. */
19250 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19252 /* Clear all rows of the menu bar. */
19253 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19255 struct glyph_row
*row
= it
.glyph_row
+ i
;
19256 clear_glyph_row (row
);
19257 row
->enabled_p
= 1;
19258 row
->full_width_p
= 1;
19261 /* Display all items of the menu bar. */
19262 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19263 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19265 Lisp_Object string
;
19267 /* Stop at nil string. */
19268 string
= AREF (items
, i
+ 1);
19272 /* Remember where item was displayed. */
19273 ASET (items
, i
+ 3, make_number (it
.hpos
));
19275 /* Display the item, pad with one space. */
19276 if (it
.current_x
< it
.last_visible_x
)
19277 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19278 SCHARS (string
) + 1, 0, 0, -1);
19281 /* Fill out the line with spaces. */
19282 if (it
.current_x
< it
.last_visible_x
)
19283 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19285 /* Compute the total height of the lines. */
19286 compute_line_metrics (&it
);
19291 /***********************************************************************
19293 ***********************************************************************/
19295 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19296 FORCE is non-zero, redisplay mode lines unconditionally.
19297 Otherwise, redisplay only mode lines that are garbaged. Value is
19298 the number of windows whose mode lines were redisplayed. */
19301 redisplay_mode_lines (Lisp_Object window
, int force
)
19305 while (!NILP (window
))
19307 struct window
*w
= XWINDOW (window
);
19309 if (WINDOWP (w
->hchild
))
19310 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19311 else if (WINDOWP (w
->vchild
))
19312 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19314 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19315 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19317 struct text_pos lpoint
;
19318 struct buffer
*old
= current_buffer
;
19320 /* Set the window's buffer for the mode line display. */
19321 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19322 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19324 /* Point refers normally to the selected window. For any
19325 other window, set up appropriate value. */
19326 if (!EQ (window
, selected_window
))
19328 struct text_pos pt
;
19330 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19331 if (CHARPOS (pt
) < BEGV
)
19332 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19333 else if (CHARPOS (pt
) > (ZV
- 1))
19334 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19336 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19339 /* Display mode lines. */
19340 clear_glyph_matrix (w
->desired_matrix
);
19341 if (display_mode_lines (w
))
19344 w
->must_be_updated_p
= 1;
19347 /* Restore old settings. */
19348 set_buffer_internal_1 (old
);
19349 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19359 /* Display the mode and/or header line of window W. Value is the
19360 sum number of mode lines and header lines displayed. */
19363 display_mode_lines (struct window
*w
)
19365 Lisp_Object old_selected_window
, old_selected_frame
;
19368 old_selected_frame
= selected_frame
;
19369 selected_frame
= w
->frame
;
19370 old_selected_window
= selected_window
;
19371 XSETWINDOW (selected_window
, w
);
19373 /* These will be set while the mode line specs are processed. */
19374 line_number_displayed
= 0;
19375 w
->column_number_displayed
= Qnil
;
19377 if (WINDOW_WANTS_MODELINE_P (w
))
19379 struct window
*sel_w
= XWINDOW (old_selected_window
);
19381 /* Select mode line face based on the real selected window. */
19382 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19383 BVAR (current_buffer
, mode_line_format
));
19387 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19389 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19390 BVAR (current_buffer
, header_line_format
));
19394 selected_frame
= old_selected_frame
;
19395 selected_window
= old_selected_window
;
19400 /* Display mode or header line of window W. FACE_ID specifies which
19401 line to display; it is either MODE_LINE_FACE_ID or
19402 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19403 display. Value is the pixel height of the mode/header line
19407 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19411 ptrdiff_t count
= SPECPDL_INDEX ();
19413 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19414 /* Don't extend on a previously drawn mode-line.
19415 This may happen if called from pos_visible_p. */
19416 it
.glyph_row
->enabled_p
= 0;
19417 prepare_desired_row (it
.glyph_row
);
19419 it
.glyph_row
->mode_line_p
= 1;
19421 if (! mode_line_inverse_video
)
19422 /* Force the mode-line to be displayed in the default face. */
19423 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19425 /* FIXME: This should be controlled by a user option. But
19426 supporting such an option is not trivial, since the mode line is
19427 made up of many separate strings. */
19428 it
.paragraph_embedding
= L2R
;
19430 record_unwind_protect (unwind_format_mode_line
,
19431 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19433 mode_line_target
= MODE_LINE_DISPLAY
;
19435 /* Temporarily make frame's keyboard the current kboard so that
19436 kboard-local variables in the mode_line_format will get the right
19438 push_kboard (FRAME_KBOARD (it
.f
));
19439 record_unwind_save_match_data ();
19440 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19443 unbind_to (count
, Qnil
);
19445 /* Fill up with spaces. */
19446 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19448 compute_line_metrics (&it
);
19449 it
.glyph_row
->full_width_p
= 1;
19450 it
.glyph_row
->continued_p
= 0;
19451 it
.glyph_row
->truncated_on_left_p
= 0;
19452 it
.glyph_row
->truncated_on_right_p
= 0;
19454 /* Make a 3D mode-line have a shadow at its right end. */
19455 face
= FACE_FROM_ID (it
.f
, face_id
);
19456 extend_face_to_end_of_line (&it
);
19457 if (face
->box
!= FACE_NO_BOX
)
19459 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19460 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19461 last
->right_box_line_p
= 1;
19464 return it
.glyph_row
->height
;
19467 /* Move element ELT in LIST to the front of LIST.
19468 Return the updated list. */
19471 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19473 register Lisp_Object tail
, prev
;
19474 register Lisp_Object tem
;
19478 while (CONSP (tail
))
19484 /* Splice out the link TAIL. */
19486 list
= XCDR (tail
);
19488 Fsetcdr (prev
, XCDR (tail
));
19490 /* Now make it the first. */
19491 Fsetcdr (tail
, list
);
19496 tail
= XCDR (tail
);
19500 /* Not found--return unchanged LIST. */
19504 /* Contribute ELT to the mode line for window IT->w. How it
19505 translates into text depends on its data type.
19507 IT describes the display environment in which we display, as usual.
19509 DEPTH is the depth in recursion. It is used to prevent
19510 infinite recursion here.
19512 FIELD_WIDTH is the number of characters the display of ELT should
19513 occupy in the mode line, and PRECISION is the maximum number of
19514 characters to display from ELT's representation. See
19515 display_string for details.
19517 Returns the hpos of the end of the text generated by ELT.
19519 PROPS is a property list to add to any string we encounter.
19521 If RISKY is nonzero, remove (disregard) any properties in any string
19522 we encounter, and ignore :eval and :propertize.
19524 The global variable `mode_line_target' determines whether the
19525 output is passed to `store_mode_line_noprop',
19526 `store_mode_line_string', or `display_string'. */
19529 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19530 Lisp_Object elt
, Lisp_Object props
, int risky
)
19532 int n
= 0, field
, prec
;
19537 elt
= build_string ("*too-deep*");
19541 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19545 /* A string: output it and check for %-constructs within it. */
19547 ptrdiff_t offset
= 0;
19549 if (SCHARS (elt
) > 0
19550 && (!NILP (props
) || risky
))
19552 Lisp_Object oprops
, aelt
;
19553 oprops
= Ftext_properties_at (make_number (0), elt
);
19555 /* If the starting string's properties are not what
19556 we want, translate the string. Also, if the string
19557 is risky, do that anyway. */
19559 if (NILP (Fequal (props
, oprops
)) || risky
)
19561 /* If the starting string has properties,
19562 merge the specified ones onto the existing ones. */
19563 if (! NILP (oprops
) && !risky
)
19567 oprops
= Fcopy_sequence (oprops
);
19569 while (CONSP (tem
))
19571 oprops
= Fplist_put (oprops
, XCAR (tem
),
19572 XCAR (XCDR (tem
)));
19573 tem
= XCDR (XCDR (tem
));
19578 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19579 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19581 /* AELT is what we want. Move it to the front
19582 without consing. */
19584 mode_line_proptrans_alist
19585 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19591 /* If AELT has the wrong props, it is useless.
19592 so get rid of it. */
19594 mode_line_proptrans_alist
19595 = Fdelq (aelt
, mode_line_proptrans_alist
);
19597 elt
= Fcopy_sequence (elt
);
19598 Fset_text_properties (make_number (0), Flength (elt
),
19600 /* Add this item to mode_line_proptrans_alist. */
19601 mode_line_proptrans_alist
19602 = Fcons (Fcons (elt
, props
),
19603 mode_line_proptrans_alist
);
19604 /* Truncate mode_line_proptrans_alist
19605 to at most 50 elements. */
19606 tem
= Fnthcdr (make_number (50),
19607 mode_line_proptrans_alist
);
19609 XSETCDR (tem
, Qnil
);
19618 prec
= precision
- n
;
19619 switch (mode_line_target
)
19621 case MODE_LINE_NOPROP
:
19622 case MODE_LINE_TITLE
:
19623 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19625 case MODE_LINE_STRING
:
19626 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19628 case MODE_LINE_DISPLAY
:
19629 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19630 0, prec
, 0, STRING_MULTIBYTE (elt
));
19637 /* Handle the non-literal case. */
19639 while ((precision
<= 0 || n
< precision
)
19640 && SREF (elt
, offset
) != 0
19641 && (mode_line_target
!= MODE_LINE_DISPLAY
19642 || it
->current_x
< it
->last_visible_x
))
19644 ptrdiff_t last_offset
= offset
;
19646 /* Advance to end of string or next format specifier. */
19647 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19650 if (offset
- 1 != last_offset
)
19652 ptrdiff_t nchars
, nbytes
;
19654 /* Output to end of string or up to '%'. Field width
19655 is length of string. Don't output more than
19656 PRECISION allows us. */
19659 prec
= c_string_width (SDATA (elt
) + last_offset
,
19660 offset
- last_offset
, precision
- n
,
19663 switch (mode_line_target
)
19665 case MODE_LINE_NOPROP
:
19666 case MODE_LINE_TITLE
:
19667 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19669 case MODE_LINE_STRING
:
19671 ptrdiff_t bytepos
= last_offset
;
19672 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
19673 ptrdiff_t endpos
= (precision
<= 0
19674 ? string_byte_to_char (elt
, offset
)
19675 : charpos
+ nchars
);
19677 n
+= store_mode_line_string (NULL
,
19678 Fsubstring (elt
, make_number (charpos
),
19679 make_number (endpos
)),
19683 case MODE_LINE_DISPLAY
:
19685 ptrdiff_t bytepos
= last_offset
;
19686 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
19688 if (precision
<= 0)
19689 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19690 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19692 STRING_MULTIBYTE (elt
));
19697 else /* c == '%' */
19699 ptrdiff_t percent_position
= offset
;
19701 /* Get the specified minimum width. Zero means
19704 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19705 field
= field
* 10 + c
- '0';
19707 /* Don't pad beyond the total padding allowed. */
19708 if (field_width
- n
> 0 && field
> field_width
- n
)
19709 field
= field_width
- n
;
19711 /* Note that either PRECISION <= 0 or N < PRECISION. */
19712 prec
= precision
- n
;
19715 n
+= display_mode_element (it
, depth
, field
, prec
,
19716 Vglobal_mode_string
, props
,
19721 ptrdiff_t bytepos
, charpos
;
19723 Lisp_Object string
;
19725 bytepos
= percent_position
;
19726 charpos
= (STRING_MULTIBYTE (elt
)
19727 ? string_byte_to_char (elt
, bytepos
)
19729 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19730 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19732 switch (mode_line_target
)
19734 case MODE_LINE_NOPROP
:
19735 case MODE_LINE_TITLE
:
19736 n
+= store_mode_line_noprop (spec
, field
, prec
);
19738 case MODE_LINE_STRING
:
19740 Lisp_Object tem
= build_string (spec
);
19741 props
= Ftext_properties_at (make_number (charpos
), elt
);
19742 /* Should only keep face property in props */
19743 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19746 case MODE_LINE_DISPLAY
:
19748 int nglyphs_before
, nwritten
;
19750 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19751 nwritten
= display_string (spec
, string
, elt
,
19756 /* Assign to the glyphs written above the
19757 string where the `%x' came from, position
19761 struct glyph
*glyph
19762 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19766 for (i
= 0; i
< nwritten
; ++i
)
19768 glyph
[i
].object
= elt
;
19769 glyph
[i
].charpos
= charpos
;
19786 /* A symbol: process the value of the symbol recursively
19787 as if it appeared here directly. Avoid error if symbol void.
19788 Special case: if value of symbol is a string, output the string
19791 register Lisp_Object tem
;
19793 /* If the variable is not marked as risky to set
19794 then its contents are risky to use. */
19795 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19798 tem
= Fboundp (elt
);
19801 tem
= Fsymbol_value (elt
);
19802 /* If value is a string, output that string literally:
19803 don't check for % within it. */
19807 if (!EQ (tem
, elt
))
19809 /* Give up right away for nil or t. */
19819 register Lisp_Object car
, tem
;
19821 /* A cons cell: five distinct cases.
19822 If first element is :eval or :propertize, do something special.
19823 If first element is a string or a cons, process all the elements
19824 and effectively concatenate them.
19825 If first element is a negative number, truncate displaying cdr to
19826 at most that many characters. If positive, pad (with spaces)
19827 to at least that many characters.
19828 If first element is a symbol, process the cadr or caddr recursively
19829 according to whether the symbol's value is non-nil or nil. */
19831 if (EQ (car
, QCeval
))
19833 /* An element of the form (:eval FORM) means evaluate FORM
19834 and use the result as mode line elements. */
19839 if (CONSP (XCDR (elt
)))
19842 spec
= safe_eval (XCAR (XCDR (elt
)));
19843 n
+= display_mode_element (it
, depth
, field_width
- n
,
19844 precision
- n
, spec
, props
,
19848 else if (EQ (car
, QCpropertize
))
19850 /* An element of the form (:propertize ELT PROPS...)
19851 means display ELT but applying properties PROPS. */
19856 if (CONSP (XCDR (elt
)))
19857 n
+= display_mode_element (it
, depth
, field_width
- n
,
19858 precision
- n
, XCAR (XCDR (elt
)),
19859 XCDR (XCDR (elt
)), risky
);
19861 else if (SYMBOLP (car
))
19863 tem
= Fboundp (car
);
19867 /* elt is now the cdr, and we know it is a cons cell.
19868 Use its car if CAR has a non-nil value. */
19871 tem
= Fsymbol_value (car
);
19878 /* Symbol's value is nil (or symbol is unbound)
19879 Get the cddr of the original list
19880 and if possible find the caddr and use that. */
19884 else if (!CONSP (elt
))
19889 else if (INTEGERP (car
))
19891 register int lim
= XINT (car
);
19895 /* Negative int means reduce maximum width. */
19896 if (precision
<= 0)
19899 precision
= min (precision
, -lim
);
19903 /* Padding specified. Don't let it be more than
19904 current maximum. */
19906 lim
= min (precision
, lim
);
19908 /* If that's more padding than already wanted, queue it.
19909 But don't reduce padding already specified even if
19910 that is beyond the current truncation point. */
19911 field_width
= max (lim
, field_width
);
19915 else if (STRINGP (car
) || CONSP (car
))
19917 Lisp_Object halftail
= elt
;
19921 && (precision
<= 0 || n
< precision
))
19923 n
+= display_mode_element (it
, depth
,
19924 /* Do padding only after the last
19925 element in the list. */
19926 (! CONSP (XCDR (elt
))
19929 precision
- n
, XCAR (elt
),
19933 if ((len
& 1) == 0)
19934 halftail
= XCDR (halftail
);
19935 /* Check for cycle. */
19936 if (EQ (halftail
, elt
))
19945 elt
= build_string ("*invalid*");
19949 /* Pad to FIELD_WIDTH. */
19950 if (field_width
> 0 && n
< field_width
)
19952 switch (mode_line_target
)
19954 case MODE_LINE_NOPROP
:
19955 case MODE_LINE_TITLE
:
19956 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19958 case MODE_LINE_STRING
:
19959 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19961 case MODE_LINE_DISPLAY
:
19962 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19971 /* Store a mode-line string element in mode_line_string_list.
19973 If STRING is non-null, display that C string. Otherwise, the Lisp
19974 string LISP_STRING is displayed.
19976 FIELD_WIDTH is the minimum number of output glyphs to produce.
19977 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19978 with spaces. FIELD_WIDTH <= 0 means don't pad.
19980 PRECISION is the maximum number of characters to output from
19981 STRING. PRECISION <= 0 means don't truncate the string.
19983 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19984 properties to the string.
19986 PROPS are the properties to add to the string.
19987 The mode_line_string_face face property is always added to the string.
19991 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19992 int field_width
, int precision
, Lisp_Object props
)
19997 if (string
!= NULL
)
19999 len
= strlen (string
);
20000 if (precision
> 0 && len
> precision
)
20002 lisp_string
= make_string (string
, len
);
20004 props
= mode_line_string_face_prop
;
20005 else if (!NILP (mode_line_string_face
))
20007 Lisp_Object face
= Fplist_get (props
, Qface
);
20008 props
= Fcopy_sequence (props
);
20010 face
= mode_line_string_face
;
20012 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20013 props
= Fplist_put (props
, Qface
, face
);
20015 Fadd_text_properties (make_number (0), make_number (len
),
20016 props
, lisp_string
);
20020 len
= XFASTINT (Flength (lisp_string
));
20021 if (precision
> 0 && len
> precision
)
20024 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20027 if (!NILP (mode_line_string_face
))
20031 props
= Ftext_properties_at (make_number (0), lisp_string
);
20032 face
= Fplist_get (props
, Qface
);
20034 face
= mode_line_string_face
;
20036 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20037 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20039 lisp_string
= Fcopy_sequence (lisp_string
);
20042 Fadd_text_properties (make_number (0), make_number (len
),
20043 props
, lisp_string
);
20048 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20052 if (field_width
> len
)
20054 field_width
-= len
;
20055 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20057 Fadd_text_properties (make_number (0), make_number (field_width
),
20058 props
, lisp_string
);
20059 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20067 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20069 doc
: /* Format a string out of a mode line format specification.
20070 First arg FORMAT specifies the mode line format (see `mode-line-format'
20071 for details) to use.
20073 By default, the format is evaluated for the currently selected window.
20075 Optional second arg FACE specifies the face property to put on all
20076 characters for which no face is specified. The value nil means the
20077 default face. The value t means whatever face the window's mode line
20078 currently uses (either `mode-line' or `mode-line-inactive',
20079 depending on whether the window is the selected window or not).
20080 An integer value means the value string has no text
20083 Optional third and fourth args WINDOW and BUFFER specify the window
20084 and buffer to use as the context for the formatting (defaults
20085 are the selected window and the WINDOW's buffer). */)
20086 (Lisp_Object format
, Lisp_Object face
,
20087 Lisp_Object window
, Lisp_Object buffer
)
20092 struct buffer
*old_buffer
= NULL
;
20094 int no_props
= INTEGERP (face
);
20095 ptrdiff_t count
= SPECPDL_INDEX ();
20097 int string_start
= 0;
20100 window
= selected_window
;
20101 CHECK_WINDOW (window
);
20102 w
= XWINDOW (window
);
20105 buffer
= w
->buffer
;
20106 CHECK_BUFFER (buffer
);
20108 /* Make formatting the modeline a non-op when noninteractive, otherwise
20109 there will be problems later caused by a partially initialized frame. */
20110 if (NILP (format
) || noninteractive
)
20111 return empty_unibyte_string
;
20116 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20117 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20118 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20119 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20120 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20121 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20122 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20125 if (XBUFFER (buffer
) != current_buffer
)
20126 old_buffer
= current_buffer
;
20128 /* Save things including mode_line_proptrans_alist,
20129 and set that to nil so that we don't alter the outer value. */
20130 record_unwind_protect (unwind_format_mode_line
,
20131 format_mode_line_unwind_data
20132 (old_buffer
, selected_window
, 1));
20133 mode_line_proptrans_alist
= Qnil
;
20135 Fselect_window (window
, Qt
);
20137 set_buffer_internal_1 (XBUFFER (buffer
));
20139 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20143 mode_line_target
= MODE_LINE_NOPROP
;
20144 mode_line_string_face_prop
= Qnil
;
20145 mode_line_string_list
= Qnil
;
20146 string_start
= MODE_LINE_NOPROP_LEN (0);
20150 mode_line_target
= MODE_LINE_STRING
;
20151 mode_line_string_list
= Qnil
;
20152 mode_line_string_face
= face
;
20153 mode_line_string_face_prop
20154 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20157 push_kboard (FRAME_KBOARD (it
.f
));
20158 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20163 len
= MODE_LINE_NOPROP_LEN (string_start
);
20164 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20168 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20169 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20170 empty_unibyte_string
);
20173 unbind_to (count
, Qnil
);
20177 /* Write a null-terminated, right justified decimal representation of
20178 the positive integer D to BUF using a minimal field width WIDTH. */
20181 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20183 register char *p
= buf
;
20191 *p
++ = d
% 10 + '0';
20196 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20207 /* Write a null-terminated, right justified decimal and "human
20208 readable" representation of the nonnegative integer D to BUF using
20209 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20211 static const char power_letter
[] =
20225 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
20227 /* We aim to represent the nonnegative integer D as
20228 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20229 ptrdiff_t quotient
= d
;
20231 /* -1 means: do not use TENTHS. */
20235 /* Length of QUOTIENT.TENTHS as a string. */
20241 if (1000 <= quotient
)
20243 /* Scale to the appropriate EXPONENT. */
20246 remainder
= quotient
% 1000;
20250 while (1000 <= quotient
);
20252 /* Round to nearest and decide whether to use TENTHS or not. */
20255 tenths
= remainder
/ 100;
20256 if (50 <= remainder
% 100)
20263 if (quotient
== 10)
20271 if (500 <= remainder
)
20273 if (quotient
< 999)
20284 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20285 if (tenths
== -1 && quotient
<= 99)
20292 p
= psuffix
= buf
+ max (width
, length
);
20294 /* Print EXPONENT. */
20295 *psuffix
++ = power_letter
[exponent
];
20298 /* Print TENTHS. */
20301 *--p
= '0' + tenths
;
20305 /* Print QUOTIENT. */
20308 int digit
= quotient
% 10;
20309 *--p
= '0' + digit
;
20311 while ((quotient
/= 10) != 0);
20313 /* Print leading spaces. */
20318 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20319 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20320 type of CODING_SYSTEM. Return updated pointer into BUF. */
20322 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20325 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20328 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20329 const unsigned char *eol_str
;
20331 /* The EOL conversion we are using. */
20332 Lisp_Object eoltype
;
20334 val
= CODING_SYSTEM_SPEC (coding_system
);
20337 if (!VECTORP (val
)) /* Not yet decided. */
20342 eoltype
= eol_mnemonic_undecided
;
20343 /* Don't mention EOL conversion if it isn't decided. */
20348 Lisp_Object eolvalue
;
20350 attrs
= AREF (val
, 0);
20351 eolvalue
= AREF (val
, 2);
20354 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20358 /* The EOL conversion that is normal on this system. */
20360 if (NILP (eolvalue
)) /* Not yet decided. */
20361 eoltype
= eol_mnemonic_undecided
;
20362 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20363 eoltype
= eol_mnemonic_undecided
;
20364 else /* eolvalue is Qunix, Qdos, or Qmac. */
20365 eoltype
= (EQ (eolvalue
, Qunix
)
20366 ? eol_mnemonic_unix
20367 : (EQ (eolvalue
, Qdos
) == 1
20368 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20374 /* Mention the EOL conversion if it is not the usual one. */
20375 if (STRINGP (eoltype
))
20377 eol_str
= SDATA (eoltype
);
20378 eol_str_len
= SBYTES (eoltype
);
20380 else if (CHARACTERP (eoltype
))
20382 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20383 int c
= XFASTINT (eoltype
);
20384 eol_str_len
= CHAR_STRING (c
, tmp
);
20389 eol_str
= invalid_eol_type
;
20390 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20392 memcpy (buf
, eol_str
, eol_str_len
);
20393 buf
+= eol_str_len
;
20399 /* Return a string for the output of a mode line %-spec for window W,
20400 generated by character C. FIELD_WIDTH > 0 means pad the string
20401 returned with spaces to that value. Return a Lisp string in
20402 *STRING if the resulting string is taken from that Lisp string.
20404 Note we operate on the current buffer for most purposes,
20405 the exception being w->base_line_pos. */
20407 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20409 static const char *
20410 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20411 Lisp_Object
*string
)
20414 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20415 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20416 struct buffer
*b
= current_buffer
;
20424 if (!NILP (BVAR (b
, read_only
)))
20426 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20431 /* This differs from %* only for a modified read-only buffer. */
20432 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20434 if (!NILP (BVAR (b
, read_only
)))
20439 /* This differs from %* in ignoring read-only-ness. */
20440 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20452 if (command_loop_level
> 5)
20454 p
= decode_mode_spec_buf
;
20455 for (i
= 0; i
< command_loop_level
; i
++)
20458 return decode_mode_spec_buf
;
20466 if (command_loop_level
> 5)
20468 p
= decode_mode_spec_buf
;
20469 for (i
= 0; i
< command_loop_level
; i
++)
20472 return decode_mode_spec_buf
;
20479 /* Let lots_of_dashes be a string of infinite length. */
20480 if (mode_line_target
== MODE_LINE_NOPROP
||
20481 mode_line_target
== MODE_LINE_STRING
)
20483 if (field_width
<= 0
20484 || field_width
> sizeof (lots_of_dashes
))
20486 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20487 decode_mode_spec_buf
[i
] = '-';
20488 decode_mode_spec_buf
[i
] = '\0';
20489 return decode_mode_spec_buf
;
20492 return lots_of_dashes
;
20496 obj
= BVAR (b
, name
);
20500 /* %c and %l are ignored in `frame-title-format'.
20501 (In redisplay_internal, the frame title is drawn _before_ the
20502 windows are updated, so the stuff which depends on actual
20503 window contents (such as %l) may fail to render properly, or
20504 even crash emacs.) */
20505 if (mode_line_target
== MODE_LINE_TITLE
)
20509 ptrdiff_t col
= current_column ();
20510 w
->column_number_displayed
= make_number (col
);
20511 pint2str (decode_mode_spec_buf
, field_width
, col
);
20512 return decode_mode_spec_buf
;
20516 #ifndef SYSTEM_MALLOC
20518 if (NILP (Vmemory_full
))
20521 return "!MEM FULL! ";
20528 /* %F displays the frame name. */
20529 if (!NILP (f
->title
))
20530 return SSDATA (f
->title
);
20531 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20532 return SSDATA (f
->name
);
20536 obj
= BVAR (b
, filename
);
20541 ptrdiff_t size
= ZV
- BEGV
;
20542 pint2str (decode_mode_spec_buf
, field_width
, size
);
20543 return decode_mode_spec_buf
;
20548 ptrdiff_t size
= ZV
- BEGV
;
20549 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20550 return decode_mode_spec_buf
;
20555 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20556 ptrdiff_t topline
, nlines
, height
;
20559 /* %c and %l are ignored in `frame-title-format'. */
20560 if (mode_line_target
== MODE_LINE_TITLE
)
20563 startpos
= XMARKER (w
->start
)->charpos
;
20564 startpos_byte
= marker_byte_position (w
->start
);
20565 height
= WINDOW_TOTAL_LINES (w
);
20567 /* If we decided that this buffer isn't suitable for line numbers,
20568 don't forget that too fast. */
20569 if (EQ (w
->base_line_pos
, w
->buffer
))
20571 /* But do forget it, if the window shows a different buffer now. */
20572 else if (BUFFERP (w
->base_line_pos
))
20573 w
->base_line_pos
= Qnil
;
20575 /* If the buffer is very big, don't waste time. */
20576 if (INTEGERP (Vline_number_display_limit
)
20577 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20579 w
->base_line_pos
= Qnil
;
20580 w
->base_line_number
= Qnil
;
20584 if (INTEGERP (w
->base_line_number
)
20585 && INTEGERP (w
->base_line_pos
)
20586 && XFASTINT (w
->base_line_pos
) <= startpos
)
20588 line
= XFASTINT (w
->base_line_number
);
20589 linepos
= XFASTINT (w
->base_line_pos
);
20590 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20595 linepos
= BUF_BEGV (b
);
20596 linepos_byte
= BUF_BEGV_BYTE (b
);
20599 /* Count lines from base line to window start position. */
20600 nlines
= display_count_lines (linepos_byte
,
20604 topline
= nlines
+ line
;
20606 /* Determine a new base line, if the old one is too close
20607 or too far away, or if we did not have one.
20608 "Too close" means it's plausible a scroll-down would
20609 go back past it. */
20610 if (startpos
== BUF_BEGV (b
))
20612 w
->base_line_number
= make_number (topline
);
20613 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20615 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20616 || linepos
== BUF_BEGV (b
))
20618 ptrdiff_t limit
= BUF_BEGV (b
);
20619 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
20620 ptrdiff_t position
;
20621 ptrdiff_t distance
=
20622 (height
* 2 + 30) * line_number_display_limit_width
;
20624 if (startpos
- distance
> limit
)
20626 limit
= startpos
- distance
;
20627 limit_byte
= CHAR_TO_BYTE (limit
);
20630 nlines
= display_count_lines (startpos_byte
,
20632 - (height
* 2 + 30),
20634 /* If we couldn't find the lines we wanted within
20635 line_number_display_limit_width chars per line,
20636 give up on line numbers for this window. */
20637 if (position
== limit_byte
&& limit
== startpos
- distance
)
20639 w
->base_line_pos
= w
->buffer
;
20640 w
->base_line_number
= Qnil
;
20644 w
->base_line_number
= make_number (topline
- nlines
);
20645 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20648 /* Now count lines from the start pos to point. */
20649 nlines
= display_count_lines (startpos_byte
,
20650 PT_BYTE
, PT
, &junk
);
20652 /* Record that we did display the line number. */
20653 line_number_displayed
= 1;
20655 /* Make the string to show. */
20656 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20657 return decode_mode_spec_buf
;
20660 char* p
= decode_mode_spec_buf
;
20661 int pad
= field_width
- 2;
20667 return decode_mode_spec_buf
;
20673 obj
= BVAR (b
, mode_name
);
20677 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20683 ptrdiff_t pos
= marker_position (w
->start
);
20684 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
20686 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20688 if (pos
<= BUF_BEGV (b
))
20693 else if (pos
<= BUF_BEGV (b
))
20697 if (total
> 1000000)
20698 /* Do it differently for a large value, to avoid overflow. */
20699 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20701 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20702 /* We can't normally display a 3-digit number,
20703 so get us a 2-digit number that is close. */
20706 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20707 return decode_mode_spec_buf
;
20711 /* Display percentage of size above the bottom of the screen. */
20714 ptrdiff_t toppos
= marker_position (w
->start
);
20715 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20716 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
20718 if (botpos
>= BUF_ZV (b
))
20720 if (toppos
<= BUF_BEGV (b
))
20727 if (total
> 1000000)
20728 /* Do it differently for a large value, to avoid overflow. */
20729 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20731 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20732 /* We can't normally display a 3-digit number,
20733 so get us a 2-digit number that is close. */
20736 if (toppos
<= BUF_BEGV (b
))
20737 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20739 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20740 return decode_mode_spec_buf
;
20745 /* status of process */
20746 obj
= Fget_buffer_process (Fcurrent_buffer ());
20748 return "no process";
20750 obj
= Fsymbol_name (Fprocess_status (obj
));
20756 ptrdiff_t count
= inhibit_garbage_collection ();
20757 Lisp_Object val
= call1 (intern ("file-remote-p"),
20758 BVAR (current_buffer
, directory
));
20759 unbind_to (count
, Qnil
);
20767 case 't': /* indicate TEXT or BINARY */
20771 /* coding-system (not including end-of-line format) */
20773 /* coding-system (including end-of-line type) */
20775 int eol_flag
= (c
== 'Z');
20776 char *p
= decode_mode_spec_buf
;
20778 if (! FRAME_WINDOW_P (f
))
20780 /* No need to mention EOL here--the terminal never needs
20781 to do EOL conversion. */
20782 p
= decode_mode_spec_coding (CODING_ID_NAME
20783 (FRAME_KEYBOARD_CODING (f
)->id
),
20785 p
= decode_mode_spec_coding (CODING_ID_NAME
20786 (FRAME_TERMINAL_CODING (f
)->id
),
20789 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20792 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20793 #ifdef subprocesses
20794 obj
= Fget_buffer_process (Fcurrent_buffer ());
20795 if (PROCESSP (obj
))
20797 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20799 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20802 #endif /* subprocesses */
20805 return decode_mode_spec_buf
;
20812 return SSDATA (obj
);
20819 /* Count up to COUNT lines starting from START_BYTE.
20820 But don't go beyond LIMIT_BYTE.
20821 Return the number of lines thus found (always nonnegative).
20823 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20826 display_count_lines (ptrdiff_t start_byte
,
20827 ptrdiff_t limit_byte
, ptrdiff_t count
,
20828 ptrdiff_t *byte_pos_ptr
)
20830 register unsigned char *cursor
;
20831 unsigned char *base
;
20833 register ptrdiff_t ceiling
;
20834 register unsigned char *ceiling_addr
;
20835 ptrdiff_t orig_count
= count
;
20837 /* If we are not in selective display mode,
20838 check only for newlines. */
20839 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20840 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20844 while (start_byte
< limit_byte
)
20846 ceiling
= BUFFER_CEILING_OF (start_byte
);
20847 ceiling
= min (limit_byte
- 1, ceiling
);
20848 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20849 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20852 if (selective_display
)
20853 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20856 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20859 if (cursor
!= ceiling_addr
)
20863 start_byte
+= cursor
- base
+ 1;
20864 *byte_pos_ptr
= start_byte
;
20868 if (++cursor
== ceiling_addr
)
20874 start_byte
+= cursor
- base
;
20879 while (start_byte
> limit_byte
)
20881 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20882 ceiling
= max (limit_byte
, ceiling
);
20883 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20884 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20887 if (selective_display
)
20888 while (--cursor
!= ceiling_addr
20889 && *cursor
!= '\n' && *cursor
!= 015)
20892 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20895 if (cursor
!= ceiling_addr
)
20899 start_byte
+= cursor
- base
+ 1;
20900 *byte_pos_ptr
= start_byte
;
20901 /* When scanning backwards, we should
20902 not count the newline posterior to which we stop. */
20903 return - orig_count
- 1;
20909 /* Here we add 1 to compensate for the last decrement
20910 of CURSOR, which took it past the valid range. */
20911 start_byte
+= cursor
- base
+ 1;
20915 *byte_pos_ptr
= limit_byte
;
20918 return - orig_count
+ count
;
20919 return orig_count
- count
;
20925 /***********************************************************************
20927 ***********************************************************************/
20929 /* Display a NUL-terminated string, starting with index START.
20931 If STRING is non-null, display that C string. Otherwise, the Lisp
20932 string LISP_STRING is displayed. There's a case that STRING is
20933 non-null and LISP_STRING is not nil. It means STRING is a string
20934 data of LISP_STRING. In that case, we display LISP_STRING while
20935 ignoring its text properties.
20937 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20938 FACE_STRING. Display STRING or LISP_STRING with the face at
20939 FACE_STRING_POS in FACE_STRING:
20941 Display the string in the environment given by IT, but use the
20942 standard display table, temporarily.
20944 FIELD_WIDTH is the minimum number of output glyphs to produce.
20945 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20946 with spaces. If STRING has more characters, more than FIELD_WIDTH
20947 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20949 PRECISION is the maximum number of characters to output from
20950 STRING. PRECISION < 0 means don't truncate the string.
20952 This is roughly equivalent to printf format specifiers:
20954 FIELD_WIDTH PRECISION PRINTF
20955 ----------------------------------------
20961 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20962 display them, and < 0 means obey the current buffer's value of
20963 enable_multibyte_characters.
20965 Value is the number of columns displayed. */
20968 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20969 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
20970 int field_width
, int precision
, int max_x
, int multibyte
)
20972 int hpos_at_start
= it
->hpos
;
20973 int saved_face_id
= it
->face_id
;
20974 struct glyph_row
*row
= it
->glyph_row
;
20975 ptrdiff_t it_charpos
;
20977 /* Initialize the iterator IT for iteration over STRING beginning
20978 with index START. */
20979 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20980 precision
, field_width
, multibyte
);
20981 if (string
&& STRINGP (lisp_string
))
20982 /* LISP_STRING is the one returned by decode_mode_spec. We should
20983 ignore its text properties. */
20984 it
->stop_charpos
= it
->end_charpos
;
20986 /* If displaying STRING, set up the face of the iterator from
20987 FACE_STRING, if that's given. */
20988 if (STRINGP (face_string
))
20994 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20995 0, it
->region_beg_charpos
,
20996 it
->region_end_charpos
,
20997 &endptr
, it
->base_face_id
, 0);
20998 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20999 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21002 /* Set max_x to the maximum allowed X position. Don't let it go
21003 beyond the right edge of the window. */
21005 max_x
= it
->last_visible_x
;
21007 max_x
= min (max_x
, it
->last_visible_x
);
21009 /* Skip over display elements that are not visible. because IT->w is
21011 if (it
->current_x
< it
->first_visible_x
)
21012 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21013 MOVE_TO_POS
| MOVE_TO_X
);
21015 row
->ascent
= it
->max_ascent
;
21016 row
->height
= it
->max_ascent
+ it
->max_descent
;
21017 row
->phys_ascent
= it
->max_phys_ascent
;
21018 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21019 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21021 if (STRINGP (it
->string
))
21022 it_charpos
= IT_STRING_CHARPOS (*it
);
21024 it_charpos
= IT_CHARPOS (*it
);
21026 /* This condition is for the case that we are called with current_x
21027 past last_visible_x. */
21028 while (it
->current_x
< max_x
)
21030 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21032 /* Get the next display element. */
21033 if (!get_next_display_element (it
))
21036 /* Produce glyphs. */
21037 x_before
= it
->current_x
;
21038 n_glyphs_before
= row
->used
[TEXT_AREA
];
21039 PRODUCE_GLYPHS (it
);
21041 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21044 while (i
< nglyphs
)
21046 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21048 if (it
->line_wrap
!= TRUNCATE
21049 && x
+ glyph
->pixel_width
> max_x
)
21051 /* End of continued line or max_x reached. */
21052 if (CHAR_GLYPH_PADDING_P (*glyph
))
21054 /* A wide character is unbreakable. */
21055 if (row
->reversed_p
)
21056 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21057 - n_glyphs_before
);
21058 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21059 it
->current_x
= x_before
;
21063 if (row
->reversed_p
)
21064 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21065 - (n_glyphs_before
+ i
));
21066 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21071 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21073 /* Glyph is at least partially visible. */
21075 if (x
< it
->first_visible_x
)
21076 row
->x
= x
- it
->first_visible_x
;
21080 /* Glyph is off the left margin of the display area.
21081 Should not happen. */
21085 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21086 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21087 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21088 row
->phys_height
= max (row
->phys_height
,
21089 it
->max_phys_ascent
+ it
->max_phys_descent
);
21090 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21091 it
->max_extra_line_spacing
);
21092 x
+= glyph
->pixel_width
;
21096 /* Stop if max_x reached. */
21100 /* Stop at line ends. */
21101 if (ITERATOR_AT_END_OF_LINE_P (it
))
21103 it
->continuation_lines_width
= 0;
21107 set_iterator_to_next (it
, 1);
21108 if (STRINGP (it
->string
))
21109 it_charpos
= IT_STRING_CHARPOS (*it
);
21111 it_charpos
= IT_CHARPOS (*it
);
21113 /* Stop if truncating at the right edge. */
21114 if (it
->line_wrap
== TRUNCATE
21115 && it
->current_x
>= it
->last_visible_x
)
21117 /* Add truncation mark, but don't do it if the line is
21118 truncated at a padding space. */
21119 if (it_charpos
< it
->string_nchars
)
21121 if (!FRAME_WINDOW_P (it
->f
))
21125 if (it
->current_x
> it
->last_visible_x
)
21127 if (!row
->reversed_p
)
21129 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21130 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21135 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21136 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21138 unproduce_glyphs (it
, ii
+ 1);
21139 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21141 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21143 row
->used
[TEXT_AREA
] = ii
;
21144 produce_special_glyphs (it
, IT_TRUNCATION
);
21147 produce_special_glyphs (it
, IT_TRUNCATION
);
21149 row
->truncated_on_right_p
= 1;
21155 /* Maybe insert a truncation at the left. */
21156 if (it
->first_visible_x
21159 if (!FRAME_WINDOW_P (it
->f
))
21160 insert_left_trunc_glyphs (it
);
21161 row
->truncated_on_left_p
= 1;
21164 it
->face_id
= saved_face_id
;
21166 /* Value is number of columns displayed. */
21167 return it
->hpos
- hpos_at_start
;
21172 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21173 appears as an element of LIST or as the car of an element of LIST.
21174 If PROPVAL is a list, compare each element against LIST in that
21175 way, and return 1/2 if any element of PROPVAL is found in LIST.
21176 Otherwise return 0. This function cannot quit.
21177 The return value is 2 if the text is invisible but with an ellipsis
21178 and 1 if it's invisible and without an ellipsis. */
21181 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21183 register Lisp_Object tail
, proptail
;
21185 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21187 register Lisp_Object tem
;
21189 if (EQ (propval
, tem
))
21191 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21192 return NILP (XCDR (tem
)) ? 1 : 2;
21195 if (CONSP (propval
))
21197 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21199 Lisp_Object propelt
;
21200 propelt
= XCAR (proptail
);
21201 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21203 register Lisp_Object tem
;
21205 if (EQ (propelt
, tem
))
21207 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21208 return NILP (XCDR (tem
)) ? 1 : 2;
21216 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21217 doc
: /* Non-nil if the property makes the text invisible.
21218 POS-OR-PROP can be a marker or number, in which case it is taken to be
21219 a position in the current buffer and the value of the `invisible' property
21220 is checked; or it can be some other value, which is then presumed to be the
21221 value of the `invisible' property of the text of interest.
21222 The non-nil value returned can be t for truly invisible text or something
21223 else if the text is replaced by an ellipsis. */)
21224 (Lisp_Object pos_or_prop
)
21227 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21228 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21230 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21231 return (invis
== 0 ? Qnil
21233 : make_number (invis
));
21236 /* Calculate a width or height in pixels from a specification using
21237 the following elements:
21240 NUM - a (fractional) multiple of the default font width/height
21241 (NUM) - specifies exactly NUM pixels
21242 UNIT - a fixed number of pixels, see below.
21243 ELEMENT - size of a display element in pixels, see below.
21244 (NUM . SPEC) - equals NUM * SPEC
21245 (+ SPEC SPEC ...) - add pixel values
21246 (- SPEC SPEC ...) - subtract pixel values
21247 (- SPEC) - negate pixel value
21250 INT or FLOAT - a number constant
21251 SYMBOL - use symbol's (buffer local) variable binding.
21254 in - pixels per inch *)
21255 mm - pixels per 1/1000 meter *)
21256 cm - pixels per 1/100 meter *)
21257 width - width of current font in pixels.
21258 height - height of current font in pixels.
21260 *) using the ratio(s) defined in display-pixels-per-inch.
21264 left-fringe - left fringe width in pixels
21265 right-fringe - right fringe width in pixels
21267 left-margin - left margin width in pixels
21268 right-margin - right margin width in pixels
21270 scroll-bar - scroll-bar area width in pixels
21274 Pixels corresponding to 5 inches:
21277 Total width of non-text areas on left side of window (if scroll-bar is on left):
21278 '(space :width (+ left-fringe left-margin scroll-bar))
21280 Align to first text column (in header line):
21281 '(space :align-to 0)
21283 Align to middle of text area minus half the width of variable `my-image'
21284 containing a loaded image:
21285 '(space :align-to (0.5 . (- text my-image)))
21287 Width of left margin minus width of 1 character in the default font:
21288 '(space :width (- left-margin 1))
21290 Width of left margin minus width of 2 characters in the current font:
21291 '(space :width (- left-margin (2 . width)))
21293 Center 1 character over left-margin (in header line):
21294 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21296 Different ways to express width of left fringe plus left margin minus one pixel:
21297 '(space :width (- (+ left-fringe left-margin) (1)))
21298 '(space :width (+ left-fringe left-margin (- (1))))
21299 '(space :width (+ left-fringe left-margin (-1)))
21303 #define NUMVAL(X) \
21304 ((INTEGERP (X) || FLOATP (X)) \
21309 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21310 struct font
*font
, int width_p
, int *align_to
)
21314 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21315 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21318 return OK_PIXELS (0);
21320 xassert (FRAME_LIVE_P (it
->f
));
21322 if (SYMBOLP (prop
))
21324 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21326 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21328 if (unit
[0] == 'i' && unit
[1] == 'n')
21330 else if (unit
[0] == 'm' && unit
[1] == 'm')
21332 else if (unit
[0] == 'c' && unit
[1] == 'm')
21339 #ifdef HAVE_WINDOW_SYSTEM
21340 if (FRAME_WINDOW_P (it
->f
)
21342 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21343 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21345 return OK_PIXELS (ppi
/ pixels
);
21348 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21349 || (CONSP (Vdisplay_pixels_per_inch
)
21351 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21352 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21354 return OK_PIXELS (ppi
/ pixels
);
21360 #ifdef HAVE_WINDOW_SYSTEM
21361 if (EQ (prop
, Qheight
))
21362 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21363 if (EQ (prop
, Qwidth
))
21364 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21366 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21367 return OK_PIXELS (1);
21370 if (EQ (prop
, Qtext
))
21371 return OK_PIXELS (width_p
21372 ? window_box_width (it
->w
, TEXT_AREA
)
21373 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21375 if (align_to
&& *align_to
< 0)
21378 if (EQ (prop
, Qleft
))
21379 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21380 if (EQ (prop
, Qright
))
21381 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21382 if (EQ (prop
, Qcenter
))
21383 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21384 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21385 if (EQ (prop
, Qleft_fringe
))
21386 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21387 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21388 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21389 if (EQ (prop
, Qright_fringe
))
21390 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21391 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21392 : window_box_right_offset (it
->w
, TEXT_AREA
));
21393 if (EQ (prop
, Qleft_margin
))
21394 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21395 if (EQ (prop
, Qright_margin
))
21396 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21397 if (EQ (prop
, Qscroll_bar
))
21398 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21400 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21401 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21402 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21407 if (EQ (prop
, Qleft_fringe
))
21408 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21409 if (EQ (prop
, Qright_fringe
))
21410 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21411 if (EQ (prop
, Qleft_margin
))
21412 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21413 if (EQ (prop
, Qright_margin
))
21414 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21415 if (EQ (prop
, Qscroll_bar
))
21416 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21419 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21422 if (INTEGERP (prop
) || FLOATP (prop
))
21424 int base_unit
= (width_p
21425 ? FRAME_COLUMN_WIDTH (it
->f
)
21426 : FRAME_LINE_HEIGHT (it
->f
));
21427 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21432 Lisp_Object car
= XCAR (prop
);
21433 Lisp_Object cdr
= XCDR (prop
);
21437 #ifdef HAVE_WINDOW_SYSTEM
21438 if (FRAME_WINDOW_P (it
->f
)
21439 && valid_image_p (prop
))
21441 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21442 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21444 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21447 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21453 while (CONSP (cdr
))
21455 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21456 font
, width_p
, align_to
))
21459 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21464 if (EQ (car
, Qminus
))
21466 return OK_PIXELS (pixels
);
21469 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21472 if (INTEGERP (car
) || FLOATP (car
))
21475 pixels
= XFLOATINT (car
);
21477 return OK_PIXELS (pixels
);
21478 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21479 font
, width_p
, align_to
))
21480 return OK_PIXELS (pixels
* fact
);
21491 /***********************************************************************
21493 ***********************************************************************/
21495 #ifdef HAVE_WINDOW_SYSTEM
21500 dump_glyph_string (struct glyph_string
*s
)
21502 fprintf (stderr
, "glyph string\n");
21503 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21504 s
->x
, s
->y
, s
->width
, s
->height
);
21505 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21506 fprintf (stderr
, " hl = %d\n", s
->hl
);
21507 fprintf (stderr
, " left overhang = %d, right = %d\n",
21508 s
->left_overhang
, s
->right_overhang
);
21509 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21510 fprintf (stderr
, " extends to end of line = %d\n",
21511 s
->extends_to_end_of_line_p
);
21512 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21513 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21516 #endif /* GLYPH_DEBUG */
21518 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21519 of XChar2b structures for S; it can't be allocated in
21520 init_glyph_string because it must be allocated via `alloca'. W
21521 is the window on which S is drawn. ROW and AREA are the glyph row
21522 and area within the row from which S is constructed. START is the
21523 index of the first glyph structure covered by S. HL is a
21524 face-override for drawing S. */
21527 #define OPTIONAL_HDC(hdc) HDC hdc,
21528 #define DECLARE_HDC(hdc) HDC hdc;
21529 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21530 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21533 #ifndef OPTIONAL_HDC
21534 #define OPTIONAL_HDC(hdc)
21535 #define DECLARE_HDC(hdc)
21536 #define ALLOCATE_HDC(hdc, f)
21537 #define RELEASE_HDC(hdc, f)
21541 init_glyph_string (struct glyph_string
*s
,
21543 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21544 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21546 memset (s
, 0, sizeof *s
);
21548 s
->f
= XFRAME (w
->frame
);
21552 s
->display
= FRAME_X_DISPLAY (s
->f
);
21553 s
->window
= FRAME_X_WINDOW (s
->f
);
21554 s
->char2b
= char2b
;
21558 s
->first_glyph
= row
->glyphs
[area
] + start
;
21559 s
->height
= row
->height
;
21560 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21561 s
->ybase
= s
->y
+ row
->ascent
;
21565 /* Append the list of glyph strings with head H and tail T to the list
21566 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21569 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21570 struct glyph_string
*h
, struct glyph_string
*t
)
21584 /* Prepend the list of glyph strings with head H and tail T to the
21585 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21589 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21590 struct glyph_string
*h
, struct glyph_string
*t
)
21604 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21605 Set *HEAD and *TAIL to the resulting list. */
21608 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21609 struct glyph_string
*s
)
21611 s
->next
= s
->prev
= NULL
;
21612 append_glyph_string_lists (head
, tail
, s
, s
);
21616 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21617 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21618 make sure that X resources for the face returned are allocated.
21619 Value is a pointer to a realized face that is ready for display if
21620 DISPLAY_P is non-zero. */
21622 static inline struct face
*
21623 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21624 XChar2b
*char2b
, int display_p
)
21626 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21630 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21632 if (code
!= FONT_INVALID_CODE
)
21633 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21635 STORE_XCHAR2B (char2b
, 0, 0);
21638 /* Make sure X resources of the face are allocated. */
21639 #ifdef HAVE_X_WINDOWS
21643 xassert (face
!= NULL
);
21644 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21651 /* Get face and two-byte form of character glyph GLYPH on frame F.
21652 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21653 a pointer to a realized face that is ready for display. */
21655 static inline struct face
*
21656 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21657 XChar2b
*char2b
, int *two_byte_p
)
21661 xassert (glyph
->type
== CHAR_GLYPH
);
21662 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21671 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21672 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21674 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21676 if (code
!= FONT_INVALID_CODE
)
21677 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21679 STORE_XCHAR2B (char2b
, 0, 0);
21682 /* Make sure X resources of the face are allocated. */
21683 xassert (face
!= NULL
);
21684 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21689 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21690 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21693 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21697 if (CHAR_BYTE8_P (c
))
21698 code
= CHAR_TO_BYTE8 (c
);
21700 code
= font
->driver
->encode_char (font
, c
);
21702 if (code
== FONT_INVALID_CODE
)
21704 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21709 /* Fill glyph string S with composition components specified by S->cmp.
21711 BASE_FACE is the base face of the composition.
21712 S->cmp_from is the index of the first component for S.
21714 OVERLAPS non-zero means S should draw the foreground only, and use
21715 its physical height for clipping. See also draw_glyphs.
21717 Value is the index of a component not in S. */
21720 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21724 /* For all glyphs of this composition, starting at the offset
21725 S->cmp_from, until we reach the end of the definition or encounter a
21726 glyph that requires the different face, add it to S. */
21731 s
->for_overlaps
= overlaps
;
21734 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21736 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21738 /* TAB in a composition means display glyphs with padding space
21739 on the left or right. */
21742 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21745 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21752 s
->font
= s
->face
->font
;
21754 else if (s
->face
!= face
)
21762 /* All glyph strings for the same composition has the same width,
21763 i.e. the width set for the first component of the composition. */
21764 s
->width
= s
->first_glyph
->pixel_width
;
21766 /* If the specified font could not be loaded, use the frame's
21767 default font, but record the fact that we couldn't load it in
21768 the glyph string so that we can draw rectangles for the
21769 characters of the glyph string. */
21770 if (s
->font
== NULL
)
21772 s
->font_not_found_p
= 1;
21773 s
->font
= FRAME_FONT (s
->f
);
21776 /* Adjust base line for subscript/superscript text. */
21777 s
->ybase
+= s
->first_glyph
->voffset
;
21779 /* This glyph string must always be drawn with 16-bit functions. */
21786 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21787 int start
, int end
, int overlaps
)
21789 struct glyph
*glyph
, *last
;
21790 Lisp_Object lgstring
;
21793 s
->for_overlaps
= overlaps
;
21794 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21795 last
= s
->row
->glyphs
[s
->area
] + end
;
21796 s
->cmp_id
= glyph
->u
.cmp
.id
;
21797 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21798 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21799 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21800 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21801 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21803 while (glyph
< last
21804 && glyph
->u
.cmp
.automatic
21805 && glyph
->u
.cmp
.id
== s
->cmp_id
21806 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21807 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21809 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21811 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21812 unsigned code
= LGLYPH_CODE (lglyph
);
21814 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21816 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21817 return glyph
- s
->row
->glyphs
[s
->area
];
21821 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21822 See the comment of fill_glyph_string for arguments.
21823 Value is the index of the first glyph not in S. */
21827 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21828 int start
, int end
, int overlaps
)
21830 struct glyph
*glyph
, *last
;
21833 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21834 s
->for_overlaps
= overlaps
;
21835 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21836 last
= s
->row
->glyphs
[s
->area
] + end
;
21837 voffset
= glyph
->voffset
;
21838 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21839 s
->font
= s
->face
->font
;
21841 s
->width
= glyph
->pixel_width
;
21843 while (glyph
< last
21844 && glyph
->type
== GLYPHLESS_GLYPH
21845 && glyph
->voffset
== voffset
21846 && glyph
->face_id
== face_id
)
21849 s
->width
+= glyph
->pixel_width
;
21852 s
->ybase
+= voffset
;
21853 return glyph
- s
->row
->glyphs
[s
->area
];
21857 /* Fill glyph string S from a sequence of character glyphs.
21859 FACE_ID is the face id of the string. START is the index of the
21860 first glyph to consider, END is the index of the last + 1.
21861 OVERLAPS non-zero means S should draw the foreground only, and use
21862 its physical height for clipping. See also draw_glyphs.
21864 Value is the index of the first glyph not in S. */
21867 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21868 int start
, int end
, int overlaps
)
21870 struct glyph
*glyph
, *last
;
21872 int glyph_not_available_p
;
21874 xassert (s
->f
== XFRAME (s
->w
->frame
));
21875 xassert (s
->nchars
== 0);
21876 xassert (start
>= 0 && end
> start
);
21878 s
->for_overlaps
= overlaps
;
21879 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21880 last
= s
->row
->glyphs
[s
->area
] + end
;
21881 voffset
= glyph
->voffset
;
21882 s
->padding_p
= glyph
->padding_p
;
21883 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21885 while (glyph
< last
21886 && glyph
->type
== CHAR_GLYPH
21887 && glyph
->voffset
== voffset
21888 /* Same face id implies same font, nowadays. */
21889 && glyph
->face_id
== face_id
21890 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21894 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21895 s
->char2b
+ s
->nchars
,
21897 s
->two_byte_p
= two_byte_p
;
21899 xassert (s
->nchars
<= end
- start
);
21900 s
->width
+= glyph
->pixel_width
;
21901 if (glyph
++->padding_p
!= s
->padding_p
)
21905 s
->font
= s
->face
->font
;
21907 /* If the specified font could not be loaded, use the frame's font,
21908 but record the fact that we couldn't load it in
21909 S->font_not_found_p so that we can draw rectangles for the
21910 characters of the glyph string. */
21911 if (s
->font
== NULL
|| glyph_not_available_p
)
21913 s
->font_not_found_p
= 1;
21914 s
->font
= FRAME_FONT (s
->f
);
21917 /* Adjust base line for subscript/superscript text. */
21918 s
->ybase
+= voffset
;
21920 xassert (s
->face
&& s
->face
->gc
);
21921 return glyph
- s
->row
->glyphs
[s
->area
];
21925 /* Fill glyph string S from image glyph S->first_glyph. */
21928 fill_image_glyph_string (struct glyph_string
*s
)
21930 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21931 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21933 s
->slice
= s
->first_glyph
->slice
.img
;
21934 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21935 s
->font
= s
->face
->font
;
21936 s
->width
= s
->first_glyph
->pixel_width
;
21938 /* Adjust base line for subscript/superscript text. */
21939 s
->ybase
+= s
->first_glyph
->voffset
;
21943 /* Fill glyph string S from a sequence of stretch glyphs.
21945 START is the index of the first glyph to consider,
21946 END is the index of the last + 1.
21948 Value is the index of the first glyph not in S. */
21951 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21953 struct glyph
*glyph
, *last
;
21954 int voffset
, face_id
;
21956 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21958 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21959 last
= s
->row
->glyphs
[s
->area
] + end
;
21960 face_id
= glyph
->face_id
;
21961 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21962 s
->font
= s
->face
->font
;
21963 s
->width
= glyph
->pixel_width
;
21965 voffset
= glyph
->voffset
;
21969 && glyph
->type
== STRETCH_GLYPH
21970 && glyph
->voffset
== voffset
21971 && glyph
->face_id
== face_id
);
21973 s
->width
+= glyph
->pixel_width
;
21975 /* Adjust base line for subscript/superscript text. */
21976 s
->ybase
+= voffset
;
21978 /* The case that face->gc == 0 is handled when drawing the glyph
21979 string by calling PREPARE_FACE_FOR_DISPLAY. */
21981 return glyph
- s
->row
->glyphs
[s
->area
];
21984 static struct font_metrics
*
21985 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21987 static struct font_metrics metrics
;
21988 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21990 if (! font
|| code
== FONT_INVALID_CODE
)
21992 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21997 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21998 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21999 assumed to be zero. */
22002 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22004 *left
= *right
= 0;
22006 if (glyph
->type
== CHAR_GLYPH
)
22010 struct font_metrics
*pcm
;
22012 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22013 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22015 if (pcm
->rbearing
> pcm
->width
)
22016 *right
= pcm
->rbearing
- pcm
->width
;
22017 if (pcm
->lbearing
< 0)
22018 *left
= -pcm
->lbearing
;
22021 else if (glyph
->type
== COMPOSITE_GLYPH
)
22023 if (! glyph
->u
.cmp
.automatic
)
22025 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22027 if (cmp
->rbearing
> cmp
->pixel_width
)
22028 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22029 if (cmp
->lbearing
< 0)
22030 *left
= - cmp
->lbearing
;
22034 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22035 struct font_metrics metrics
;
22037 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22038 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22039 if (metrics
.rbearing
> metrics
.width
)
22040 *right
= metrics
.rbearing
- metrics
.width
;
22041 if (metrics
.lbearing
< 0)
22042 *left
= - metrics
.lbearing
;
22048 /* Return the index of the first glyph preceding glyph string S that
22049 is overwritten by S because of S's left overhang. Value is -1
22050 if no glyphs are overwritten. */
22053 left_overwritten (struct glyph_string
*s
)
22057 if (s
->left_overhang
)
22060 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22061 int first
= s
->first_glyph
- glyphs
;
22063 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22064 x
-= glyphs
[i
].pixel_width
;
22075 /* Return the index of the first glyph preceding glyph string S that
22076 is overwriting S because of its right overhang. Value is -1 if no
22077 glyph in front of S overwrites S. */
22080 left_overwriting (struct glyph_string
*s
)
22083 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22084 int first
= s
->first_glyph
- glyphs
;
22088 for (i
= first
- 1; i
>= 0; --i
)
22091 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22094 x
-= glyphs
[i
].pixel_width
;
22101 /* Return the index of the last glyph following glyph string S that is
22102 overwritten by S because of S's right overhang. Value is -1 if
22103 no such glyph is found. */
22106 right_overwritten (struct glyph_string
*s
)
22110 if (s
->right_overhang
)
22113 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22114 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22115 int end
= s
->row
->used
[s
->area
];
22117 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22118 x
+= glyphs
[i
].pixel_width
;
22127 /* Return the index of the last glyph following glyph string S that
22128 overwrites S because of its left overhang. Value is negative
22129 if no such glyph is found. */
22132 right_overwriting (struct glyph_string
*s
)
22135 int end
= s
->row
->used
[s
->area
];
22136 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22137 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22141 for (i
= first
; i
< end
; ++i
)
22144 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22147 x
+= glyphs
[i
].pixel_width
;
22154 /* Set background width of glyph string S. START is the index of the
22155 first glyph following S. LAST_X is the right-most x-position + 1
22156 in the drawing area. */
22159 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22161 /* If the face of this glyph string has to be drawn to the end of
22162 the drawing area, set S->extends_to_end_of_line_p. */
22164 if (start
== s
->row
->used
[s
->area
]
22165 && s
->area
== TEXT_AREA
22166 && ((s
->row
->fill_line_p
22167 && (s
->hl
== DRAW_NORMAL_TEXT
22168 || s
->hl
== DRAW_IMAGE_RAISED
22169 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22170 || s
->hl
== DRAW_MOUSE_FACE
))
22171 s
->extends_to_end_of_line_p
= 1;
22173 /* If S extends its face to the end of the line, set its
22174 background_width to the distance to the right edge of the drawing
22176 if (s
->extends_to_end_of_line_p
)
22177 s
->background_width
= last_x
- s
->x
+ 1;
22179 s
->background_width
= s
->width
;
22183 /* Compute overhangs and x-positions for glyph string S and its
22184 predecessors, or successors. X is the starting x-position for S.
22185 BACKWARD_P non-zero means process predecessors. */
22188 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22194 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22195 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22205 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22206 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22216 /* The following macros are only called from draw_glyphs below.
22217 They reference the following parameters of that function directly:
22218 `w', `row', `area', and `overlap_p'
22219 as well as the following local variables:
22220 `s', `f', and `hdc' (in W32) */
22223 /* On W32, silently add local `hdc' variable to argument list of
22224 init_glyph_string. */
22225 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22226 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22228 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22229 init_glyph_string (s, char2b, w, row, area, start, hl)
22232 /* Add a glyph string for a stretch glyph to the list of strings
22233 between HEAD and TAIL. START is the index of the stretch glyph in
22234 row area AREA of glyph row ROW. END is the index of the last glyph
22235 in that glyph row area. X is the current output position assigned
22236 to the new glyph string constructed. HL overrides that face of the
22237 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22238 is the right-most x-position of the drawing area. */
22240 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22241 and below -- keep them on one line. */
22242 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22245 s = (struct glyph_string *) alloca (sizeof *s); \
22246 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22247 START = fill_stretch_glyph_string (s, START, END); \
22248 append_glyph_string (&HEAD, &TAIL, s); \
22254 /* Add a glyph string for an image glyph to the list of strings
22255 between HEAD and TAIL. START is the index of the image glyph in
22256 row area AREA of glyph row ROW. END is the index of the last glyph
22257 in that glyph row area. X is the current output position assigned
22258 to the new glyph string constructed. HL overrides that face of the
22259 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22260 is the right-most x-position of the drawing area. */
22262 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22265 s = (struct glyph_string *) alloca (sizeof *s); \
22266 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22267 fill_image_glyph_string (s); \
22268 append_glyph_string (&HEAD, &TAIL, s); \
22275 /* Add a glyph string for a sequence of character glyphs to the list
22276 of strings between HEAD and TAIL. START is the index of the first
22277 glyph in row area AREA of glyph row ROW that is part of the new
22278 glyph string. END is the index of the last glyph in that glyph row
22279 area. X is the current output position assigned to the new glyph
22280 string constructed. HL overrides that face of the glyph; e.g. it
22281 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22282 right-most x-position of the drawing area. */
22284 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22290 face_id = (row)->glyphs[area][START].face_id; \
22292 s = (struct glyph_string *) alloca (sizeof *s); \
22293 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22294 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22295 append_glyph_string (&HEAD, &TAIL, s); \
22297 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22302 /* Add a glyph string for a composite sequence to the list of strings
22303 between HEAD and TAIL. START is the index of the first glyph in
22304 row area AREA of glyph row ROW that is part of the new glyph
22305 string. END is the index of the last glyph in that glyph row area.
22306 X is the current output position assigned to the new glyph string
22307 constructed. HL overrides that face of the glyph; e.g. it is
22308 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22309 x-position of the drawing area. */
22311 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22313 int face_id = (row)->glyphs[area][START].face_id; \
22314 struct face *base_face = FACE_FROM_ID (f, face_id); \
22315 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22316 struct composition *cmp = composition_table[cmp_id]; \
22318 struct glyph_string *first_s IF_LINT (= NULL); \
22321 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22323 /* Make glyph_strings for each glyph sequence that is drawable by \
22324 the same face, and append them to HEAD/TAIL. */ \
22325 for (n = 0; n < cmp->glyph_len;) \
22327 s = (struct glyph_string *) alloca (sizeof *s); \
22328 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22329 append_glyph_string (&(HEAD), &(TAIL), s); \
22335 n = fill_composite_glyph_string (s, base_face, overlaps); \
22343 /* Add a glyph string for a glyph-string sequence to the list of strings
22344 between HEAD and TAIL. */
22346 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22350 Lisp_Object gstring; \
22352 face_id = (row)->glyphs[area][START].face_id; \
22353 gstring = (composition_gstring_from_id \
22354 ((row)->glyphs[area][START].u.cmp.id)); \
22355 s = (struct glyph_string *) alloca (sizeof *s); \
22356 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22357 * LGSTRING_GLYPH_LEN (gstring)); \
22358 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22359 append_glyph_string (&(HEAD), &(TAIL), s); \
22361 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22365 /* Add a glyph string for a sequence of glyphless character's glyphs
22366 to the list of strings between HEAD and TAIL. The meanings of
22367 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22369 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22374 face_id = (row)->glyphs[area][START].face_id; \
22376 s = (struct glyph_string *) alloca (sizeof *s); \
22377 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22378 append_glyph_string (&HEAD, &TAIL, s); \
22380 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22386 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22387 of AREA of glyph row ROW on window W between indices START and END.
22388 HL overrides the face for drawing glyph strings, e.g. it is
22389 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22390 x-positions of the drawing area.
22392 This is an ugly monster macro construct because we must use alloca
22393 to allocate glyph strings (because draw_glyphs can be called
22394 asynchronously). */
22396 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22399 HEAD = TAIL = NULL; \
22400 while (START < END) \
22402 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22403 switch (first_glyph->type) \
22406 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22410 case COMPOSITE_GLYPH: \
22411 if (first_glyph->u.cmp.automatic) \
22412 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22415 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22419 case STRETCH_GLYPH: \
22420 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22424 case IMAGE_GLYPH: \
22425 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22429 case GLYPHLESS_GLYPH: \
22430 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22440 set_glyph_string_background_width (s, START, LAST_X); \
22447 /* Draw glyphs between START and END in AREA of ROW on window W,
22448 starting at x-position X. X is relative to AREA in W. HL is a
22449 face-override with the following meaning:
22451 DRAW_NORMAL_TEXT draw normally
22452 DRAW_CURSOR draw in cursor face
22453 DRAW_MOUSE_FACE draw in mouse face.
22454 DRAW_INVERSE_VIDEO draw in mode line face
22455 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22456 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22458 If OVERLAPS is non-zero, draw only the foreground of characters and
22459 clip to the physical height of ROW. Non-zero value also defines
22460 the overlapping part to be drawn:
22462 OVERLAPS_PRED overlap with preceding rows
22463 OVERLAPS_SUCC overlap with succeeding rows
22464 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22465 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22467 Value is the x-position reached, relative to AREA of W. */
22470 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22471 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
22472 enum draw_glyphs_face hl
, int overlaps
)
22474 struct glyph_string
*head
, *tail
;
22475 struct glyph_string
*s
;
22476 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22477 int i
, j
, x_reached
, last_x
, area_left
= 0;
22478 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22481 ALLOCATE_HDC (hdc
, f
);
22483 /* Let's rather be paranoid than getting a SEGV. */
22484 end
= min (end
, row
->used
[area
]);
22485 start
= max (0, start
);
22486 start
= min (end
, start
);
22488 /* Translate X to frame coordinates. Set last_x to the right
22489 end of the drawing area. */
22490 if (row
->full_width_p
)
22492 /* X is relative to the left edge of W, without scroll bars
22494 area_left
= WINDOW_LEFT_EDGE_X (w
);
22495 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22499 area_left
= window_box_left (w
, area
);
22500 last_x
= area_left
+ window_box_width (w
, area
);
22504 /* Build a doubly-linked list of glyph_string structures between
22505 head and tail from what we have to draw. Note that the macro
22506 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22507 the reason we use a separate variable `i'. */
22509 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22511 x_reached
= tail
->x
+ tail
->background_width
;
22515 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22516 the row, redraw some glyphs in front or following the glyph
22517 strings built above. */
22518 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22520 struct glyph_string
*h
, *t
;
22521 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22522 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22523 int check_mouse_face
= 0;
22526 /* If mouse highlighting is on, we may need to draw adjacent
22527 glyphs using mouse-face highlighting. */
22528 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22530 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22532 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22533 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22535 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22537 check_mouse_face
= 1;
22538 mouse_beg_col
= (row
== mouse_beg_row
)
22539 ? hlinfo
->mouse_face_beg_col
: 0;
22540 mouse_end_col
= (row
== mouse_end_row
)
22541 ? hlinfo
->mouse_face_end_col
22542 : row
->used
[TEXT_AREA
];
22546 /* Compute overhangs for all glyph strings. */
22547 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22548 for (s
= head
; s
; s
= s
->next
)
22549 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22551 /* Prepend glyph strings for glyphs in front of the first glyph
22552 string that are overwritten because of the first glyph
22553 string's left overhang. The background of all strings
22554 prepended must be drawn because the first glyph string
22556 i
= left_overwritten (head
);
22559 enum draw_glyphs_face overlap_hl
;
22561 /* If this row contains mouse highlighting, attempt to draw
22562 the overlapped glyphs with the correct highlight. This
22563 code fails if the overlap encompasses more than one glyph
22564 and mouse-highlight spans only some of these glyphs.
22565 However, making it work perfectly involves a lot more
22566 code, and I don't know if the pathological case occurs in
22567 practice, so we'll stick to this for now. --- cyd */
22568 if (check_mouse_face
22569 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22570 overlap_hl
= DRAW_MOUSE_FACE
;
22572 overlap_hl
= DRAW_NORMAL_TEXT
;
22575 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22576 overlap_hl
, dummy_x
, last_x
);
22578 compute_overhangs_and_x (t
, head
->x
, 1);
22579 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22583 /* Prepend glyph strings for glyphs in front of the first glyph
22584 string that overwrite that glyph string because of their
22585 right overhang. For these strings, only the foreground must
22586 be drawn, because it draws over the glyph string at `head'.
22587 The background must not be drawn because this would overwrite
22588 right overhangs of preceding glyphs for which no glyph
22590 i
= left_overwriting (head
);
22593 enum draw_glyphs_face overlap_hl
;
22595 if (check_mouse_face
22596 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22597 overlap_hl
= DRAW_MOUSE_FACE
;
22599 overlap_hl
= DRAW_NORMAL_TEXT
;
22602 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22603 overlap_hl
, dummy_x
, last_x
);
22604 for (s
= h
; s
; s
= s
->next
)
22605 s
->background_filled_p
= 1;
22606 compute_overhangs_and_x (t
, head
->x
, 1);
22607 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22610 /* Append glyphs strings for glyphs following the last glyph
22611 string tail that are overwritten by tail. The background of
22612 these strings has to be drawn because tail's foreground draws
22614 i
= right_overwritten (tail
);
22617 enum draw_glyphs_face overlap_hl
;
22619 if (check_mouse_face
22620 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22621 overlap_hl
= DRAW_MOUSE_FACE
;
22623 overlap_hl
= DRAW_NORMAL_TEXT
;
22625 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22626 overlap_hl
, x
, last_x
);
22627 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22628 we don't have `end = i;' here. */
22629 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22630 append_glyph_string_lists (&head
, &tail
, h
, t
);
22634 /* Append glyph strings for glyphs following the last glyph
22635 string tail that overwrite tail. The foreground of such
22636 glyphs has to be drawn because it writes into the background
22637 of tail. The background must not be drawn because it could
22638 paint over the foreground of following glyphs. */
22639 i
= right_overwriting (tail
);
22642 enum draw_glyphs_face overlap_hl
;
22643 if (check_mouse_face
22644 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22645 overlap_hl
= DRAW_MOUSE_FACE
;
22647 overlap_hl
= DRAW_NORMAL_TEXT
;
22650 i
++; /* We must include the Ith glyph. */
22651 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22652 overlap_hl
, x
, last_x
);
22653 for (s
= h
; s
; s
= s
->next
)
22654 s
->background_filled_p
= 1;
22655 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22656 append_glyph_string_lists (&head
, &tail
, h
, t
);
22658 if (clip_head
|| clip_tail
)
22659 for (s
= head
; s
; s
= s
->next
)
22661 s
->clip_head
= clip_head
;
22662 s
->clip_tail
= clip_tail
;
22666 /* Draw all strings. */
22667 for (s
= head
; s
; s
= s
->next
)
22668 FRAME_RIF (f
)->draw_glyph_string (s
);
22671 /* When focus a sole frame and move horizontally, this sets on_p to 0
22672 causing a failure to erase prev cursor position. */
22673 if (area
== TEXT_AREA
22674 && !row
->full_width_p
22675 /* When drawing overlapping rows, only the glyph strings'
22676 foreground is drawn, which doesn't erase a cursor
22680 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22681 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22682 : (tail
? tail
->x
+ tail
->background_width
: x
));
22686 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22687 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22691 /* Value is the x-position up to which drawn, relative to AREA of W.
22692 This doesn't include parts drawn because of overhangs. */
22693 if (row
->full_width_p
)
22694 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22696 x_reached
-= area_left
;
22698 RELEASE_HDC (hdc
, f
);
22703 /* Expand row matrix if too narrow. Don't expand if area
22706 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22708 if (!fonts_changed_p \
22709 && (it->glyph_row->glyphs[area] \
22710 < it->glyph_row->glyphs[area + 1])) \
22712 it->w->ncols_scale_factor++; \
22713 fonts_changed_p = 1; \
22717 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22718 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22721 append_glyph (struct it
*it
)
22723 struct glyph
*glyph
;
22724 enum glyph_row_area area
= it
->area
;
22726 xassert (it
->glyph_row
);
22727 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22729 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22730 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22732 /* If the glyph row is reversed, we need to prepend the glyph
22733 rather than append it. */
22734 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22738 /* Make room for the additional glyph. */
22739 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22741 glyph
= it
->glyph_row
->glyphs
[area
];
22743 glyph
->charpos
= CHARPOS (it
->position
);
22744 glyph
->object
= it
->object
;
22745 if (it
->pixel_width
> 0)
22747 glyph
->pixel_width
= it
->pixel_width
;
22748 glyph
->padding_p
= 0;
22752 /* Assure at least 1-pixel width. Otherwise, cursor can't
22753 be displayed correctly. */
22754 glyph
->pixel_width
= 1;
22755 glyph
->padding_p
= 1;
22757 glyph
->ascent
= it
->ascent
;
22758 glyph
->descent
= it
->descent
;
22759 glyph
->voffset
= it
->voffset
;
22760 glyph
->type
= CHAR_GLYPH
;
22761 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22762 glyph
->multibyte_p
= it
->multibyte_p
;
22763 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22764 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22765 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22766 || it
->phys_descent
> it
->descent
);
22767 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22768 glyph
->face_id
= it
->face_id
;
22769 glyph
->u
.ch
= it
->char_to_display
;
22770 glyph
->slice
.img
= null_glyph_slice
;
22771 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22774 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22775 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22777 glyph
->bidi_type
= it
->bidi_it
.type
;
22781 glyph
->resolved_level
= 0;
22782 glyph
->bidi_type
= UNKNOWN_BT
;
22784 ++it
->glyph_row
->used
[area
];
22787 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22790 /* Store one glyph for the composition IT->cmp_it.id in
22791 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22795 append_composite_glyph (struct it
*it
)
22797 struct glyph
*glyph
;
22798 enum glyph_row_area area
= it
->area
;
22800 xassert (it
->glyph_row
);
22802 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22803 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22805 /* If the glyph row is reversed, we need to prepend the glyph
22806 rather than append it. */
22807 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22811 /* Make room for the new glyph. */
22812 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22814 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22816 glyph
->charpos
= it
->cmp_it
.charpos
;
22817 glyph
->object
= it
->object
;
22818 glyph
->pixel_width
= it
->pixel_width
;
22819 glyph
->ascent
= it
->ascent
;
22820 glyph
->descent
= it
->descent
;
22821 glyph
->voffset
= it
->voffset
;
22822 glyph
->type
= COMPOSITE_GLYPH
;
22823 if (it
->cmp_it
.ch
< 0)
22825 glyph
->u
.cmp
.automatic
= 0;
22826 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22827 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22831 glyph
->u
.cmp
.automatic
= 1;
22832 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22833 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22834 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22836 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22837 glyph
->multibyte_p
= it
->multibyte_p
;
22838 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22839 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22840 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22841 || it
->phys_descent
> it
->descent
);
22842 glyph
->padding_p
= 0;
22843 glyph
->glyph_not_available_p
= 0;
22844 glyph
->face_id
= it
->face_id
;
22845 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22848 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22849 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22851 glyph
->bidi_type
= it
->bidi_it
.type
;
22853 ++it
->glyph_row
->used
[area
];
22856 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22860 /* Change IT->ascent and IT->height according to the setting of
22864 take_vertical_position_into_account (struct it
*it
)
22868 if (it
->voffset
< 0)
22869 /* Increase the ascent so that we can display the text higher
22871 it
->ascent
-= it
->voffset
;
22873 /* Increase the descent so that we can display the text lower
22875 it
->descent
+= it
->voffset
;
22880 /* Produce glyphs/get display metrics for the image IT is loaded with.
22881 See the description of struct display_iterator in dispextern.h for
22882 an overview of struct display_iterator. */
22885 produce_image_glyph (struct it
*it
)
22889 int glyph_ascent
, crop
;
22890 struct glyph_slice slice
;
22892 xassert (it
->what
== IT_IMAGE
);
22894 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22896 /* Make sure X resources of the face is loaded. */
22897 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22899 if (it
->image_id
< 0)
22901 /* Fringe bitmap. */
22902 it
->ascent
= it
->phys_ascent
= 0;
22903 it
->descent
= it
->phys_descent
= 0;
22904 it
->pixel_width
= 0;
22909 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22911 /* Make sure X resources of the image is loaded. */
22912 prepare_image_for_display (it
->f
, img
);
22914 slice
.x
= slice
.y
= 0;
22915 slice
.width
= img
->width
;
22916 slice
.height
= img
->height
;
22918 if (INTEGERP (it
->slice
.x
))
22919 slice
.x
= XINT (it
->slice
.x
);
22920 else if (FLOATP (it
->slice
.x
))
22921 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22923 if (INTEGERP (it
->slice
.y
))
22924 slice
.y
= XINT (it
->slice
.y
);
22925 else if (FLOATP (it
->slice
.y
))
22926 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22928 if (INTEGERP (it
->slice
.width
))
22929 slice
.width
= XINT (it
->slice
.width
);
22930 else if (FLOATP (it
->slice
.width
))
22931 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22933 if (INTEGERP (it
->slice
.height
))
22934 slice
.height
= XINT (it
->slice
.height
);
22935 else if (FLOATP (it
->slice
.height
))
22936 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22938 if (slice
.x
>= img
->width
)
22939 slice
.x
= img
->width
;
22940 if (slice
.y
>= img
->height
)
22941 slice
.y
= img
->height
;
22942 if (slice
.x
+ slice
.width
>= img
->width
)
22943 slice
.width
= img
->width
- slice
.x
;
22944 if (slice
.y
+ slice
.height
> img
->height
)
22945 slice
.height
= img
->height
- slice
.y
;
22947 if (slice
.width
== 0 || slice
.height
== 0)
22950 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22952 it
->descent
= slice
.height
- glyph_ascent
;
22954 it
->descent
+= img
->vmargin
;
22955 if (slice
.y
+ slice
.height
== img
->height
)
22956 it
->descent
+= img
->vmargin
;
22957 it
->phys_descent
= it
->descent
;
22959 it
->pixel_width
= slice
.width
;
22961 it
->pixel_width
+= img
->hmargin
;
22962 if (slice
.x
+ slice
.width
== img
->width
)
22963 it
->pixel_width
+= img
->hmargin
;
22965 /* It's quite possible for images to have an ascent greater than
22966 their height, so don't get confused in that case. */
22967 if (it
->descent
< 0)
22972 if (face
->box
!= FACE_NO_BOX
)
22974 if (face
->box_line_width
> 0)
22977 it
->ascent
+= face
->box_line_width
;
22978 if (slice
.y
+ slice
.height
== img
->height
)
22979 it
->descent
+= face
->box_line_width
;
22982 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22983 it
->pixel_width
+= eabs (face
->box_line_width
);
22984 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22985 it
->pixel_width
+= eabs (face
->box_line_width
);
22988 take_vertical_position_into_account (it
);
22990 /* Automatically crop wide image glyphs at right edge so we can
22991 draw the cursor on same display row. */
22992 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22993 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22995 it
->pixel_width
-= crop
;
22996 slice
.width
-= crop
;
23001 struct glyph
*glyph
;
23002 enum glyph_row_area area
= it
->area
;
23004 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23005 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23007 glyph
->charpos
= CHARPOS (it
->position
);
23008 glyph
->object
= it
->object
;
23009 glyph
->pixel_width
= it
->pixel_width
;
23010 glyph
->ascent
= glyph_ascent
;
23011 glyph
->descent
= it
->descent
;
23012 glyph
->voffset
= it
->voffset
;
23013 glyph
->type
= IMAGE_GLYPH
;
23014 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23015 glyph
->multibyte_p
= it
->multibyte_p
;
23016 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23017 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23018 glyph
->overlaps_vertically_p
= 0;
23019 glyph
->padding_p
= 0;
23020 glyph
->glyph_not_available_p
= 0;
23021 glyph
->face_id
= it
->face_id
;
23022 glyph
->u
.img_id
= img
->id
;
23023 glyph
->slice
.img
= slice
;
23024 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23027 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23028 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23030 glyph
->bidi_type
= it
->bidi_it
.type
;
23032 ++it
->glyph_row
->used
[area
];
23035 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23040 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23041 of the glyph, WIDTH and HEIGHT are the width and height of the
23042 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23045 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23046 int width
, int height
, int ascent
)
23048 struct glyph
*glyph
;
23049 enum glyph_row_area area
= it
->area
;
23051 xassert (ascent
>= 0 && ascent
<= height
);
23053 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23054 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23056 /* If the glyph row is reversed, we need to prepend the glyph
23057 rather than append it. */
23058 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23062 /* Make room for the additional glyph. */
23063 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23065 glyph
= it
->glyph_row
->glyphs
[area
];
23067 glyph
->charpos
= CHARPOS (it
->position
);
23068 glyph
->object
= object
;
23069 glyph
->pixel_width
= width
;
23070 glyph
->ascent
= ascent
;
23071 glyph
->descent
= height
- ascent
;
23072 glyph
->voffset
= it
->voffset
;
23073 glyph
->type
= STRETCH_GLYPH
;
23074 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23075 glyph
->multibyte_p
= it
->multibyte_p
;
23076 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23077 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23078 glyph
->overlaps_vertically_p
= 0;
23079 glyph
->padding_p
= 0;
23080 glyph
->glyph_not_available_p
= 0;
23081 glyph
->face_id
= it
->face_id
;
23082 glyph
->u
.stretch
.ascent
= ascent
;
23083 glyph
->u
.stretch
.height
= height
;
23084 glyph
->slice
.img
= null_glyph_slice
;
23085 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23088 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23089 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23091 glyph
->bidi_type
= it
->bidi_it
.type
;
23095 glyph
->resolved_level
= 0;
23096 glyph
->bidi_type
= UNKNOWN_BT
;
23098 ++it
->glyph_row
->used
[area
];
23101 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23104 #endif /* HAVE_WINDOW_SYSTEM */
23106 /* Produce a stretch glyph for iterator IT. IT->object is the value
23107 of the glyph property displayed. The value must be a list
23108 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23111 1. `:width WIDTH' specifies that the space should be WIDTH *
23112 canonical char width wide. WIDTH may be an integer or floating
23115 2. `:relative-width FACTOR' specifies that the width of the stretch
23116 should be computed from the width of the first character having the
23117 `glyph' property, and should be FACTOR times that width.
23119 3. `:align-to HPOS' specifies that the space should be wide enough
23120 to reach HPOS, a value in canonical character units.
23122 Exactly one of the above pairs must be present.
23124 4. `:height HEIGHT' specifies that the height of the stretch produced
23125 should be HEIGHT, measured in canonical character units.
23127 5. `:relative-height FACTOR' specifies that the height of the
23128 stretch should be FACTOR times the height of the characters having
23129 the glyph property.
23131 Either none or exactly one of 4 or 5 must be present.
23133 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23134 of the stretch should be used for the ascent of the stretch.
23135 ASCENT must be in the range 0 <= ASCENT <= 100. */
23138 produce_stretch_glyph (struct it
*it
)
23140 /* (space :width WIDTH :height HEIGHT ...) */
23141 Lisp_Object prop
, plist
;
23142 int width
= 0, height
= 0, align_to
= -1;
23143 int zero_width_ok_p
= 0;
23146 struct face
*face
= NULL
;
23147 struct font
*font
= NULL
;
23149 #ifdef HAVE_WINDOW_SYSTEM
23150 int zero_height_ok_p
= 0;
23152 if (FRAME_WINDOW_P (it
->f
))
23154 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23155 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23156 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23160 /* List should start with `space'. */
23161 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23162 plist
= XCDR (it
->object
);
23164 /* Compute the width of the stretch. */
23165 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23166 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23168 /* Absolute width `:width WIDTH' specified and valid. */
23169 zero_width_ok_p
= 1;
23172 #ifdef HAVE_WINDOW_SYSTEM
23173 else if (FRAME_WINDOW_P (it
->f
)
23174 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23176 /* Relative width `:relative-width FACTOR' specified and valid.
23177 Compute the width of the characters having the `glyph'
23180 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23183 if (it
->multibyte_p
)
23184 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23187 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23188 if (! ASCII_CHAR_P (it2
.c
))
23189 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23192 it2
.glyph_row
= NULL
;
23193 it2
.what
= IT_CHARACTER
;
23194 x_produce_glyphs (&it2
);
23195 width
= NUMVAL (prop
) * it2
.pixel_width
;
23197 #endif /* HAVE_WINDOW_SYSTEM */
23198 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23199 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23201 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23202 align_to
= (align_to
< 0
23204 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23205 else if (align_to
< 0)
23206 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23207 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23208 zero_width_ok_p
= 1;
23211 /* Nothing specified -> width defaults to canonical char width. */
23212 width
= FRAME_COLUMN_WIDTH (it
->f
);
23214 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23217 #ifdef HAVE_WINDOW_SYSTEM
23218 /* Compute height. */
23219 if (FRAME_WINDOW_P (it
->f
))
23221 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23222 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23225 zero_height_ok_p
= 1;
23227 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23229 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23231 height
= FONT_HEIGHT (font
);
23233 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23236 /* Compute percentage of height used for ascent. If
23237 `:ascent ASCENT' is present and valid, use that. Otherwise,
23238 derive the ascent from the font in use. */
23239 if (prop
= Fplist_get (plist
, QCascent
),
23240 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23241 ascent
= height
* NUMVAL (prop
) / 100.0;
23242 else if (!NILP (prop
)
23243 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23244 ascent
= min (max (0, (int)tem
), height
);
23246 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23249 #endif /* HAVE_WINDOW_SYSTEM */
23252 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23253 && it
->current_x
+ width
> it
->last_visible_x
)
23254 width
= it
->last_visible_x
- it
->current_x
- 1;
23256 if (width
> 0 && height
> 0 && it
->glyph_row
)
23258 Lisp_Object o_object
= it
->object
;
23259 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23262 if (!STRINGP (object
))
23263 object
= it
->w
->buffer
;
23264 #ifdef HAVE_WINDOW_SYSTEM
23265 if (FRAME_WINDOW_P (it
->f
))
23267 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23268 it
->pixel_width
= width
;
23269 it
->ascent
= it
->phys_ascent
= ascent
;
23270 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23271 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23272 take_vertical_position_into_account (it
);
23277 it
->object
= object
;
23278 it
->char_to_display
= ' ';
23279 it
->pixel_width
= it
->len
= 1;
23281 tty_append_glyph (it
);
23282 it
->object
= o_object
;
23287 #ifdef HAVE_WINDOW_SYSTEM
23289 /* Calculate line-height and line-spacing properties.
23290 An integer value specifies explicit pixel value.
23291 A float value specifies relative value to current face height.
23292 A cons (float . face-name) specifies relative value to
23293 height of specified face font.
23295 Returns height in pixels, or nil. */
23299 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23300 int boff
, int override
)
23302 Lisp_Object face_name
= Qnil
;
23303 int ascent
, descent
, height
;
23305 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23310 face_name
= XCAR (val
);
23312 if (!NUMBERP (val
))
23313 val
= make_number (1);
23314 if (NILP (face_name
))
23316 height
= it
->ascent
+ it
->descent
;
23321 if (NILP (face_name
))
23323 font
= FRAME_FONT (it
->f
);
23324 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23326 else if (EQ (face_name
, Qt
))
23335 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23337 return make_number (-1);
23339 face
= FACE_FROM_ID (it
->f
, face_id
);
23342 return make_number (-1);
23343 boff
= font
->baseline_offset
;
23344 if (font
->vertical_centering
)
23345 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23348 ascent
= FONT_BASE (font
) + boff
;
23349 descent
= FONT_DESCENT (font
) - boff
;
23353 it
->override_ascent
= ascent
;
23354 it
->override_descent
= descent
;
23355 it
->override_boff
= boff
;
23358 height
= ascent
+ descent
;
23362 height
= (int)(XFLOAT_DATA (val
) * height
);
23363 else if (INTEGERP (val
))
23364 height
*= XINT (val
);
23366 return make_number (height
);
23370 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23371 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23372 and only if this is for a character for which no font was found.
23374 If the display method (it->glyphless_method) is
23375 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23376 length of the acronym or the hexadecimal string, UPPER_XOFF and
23377 UPPER_YOFF are pixel offsets for the upper part of the string,
23378 LOWER_XOFF and LOWER_YOFF are for the lower part.
23380 For the other display methods, LEN through LOWER_YOFF are zero. */
23383 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23384 short upper_xoff
, short upper_yoff
,
23385 short lower_xoff
, short lower_yoff
)
23387 struct glyph
*glyph
;
23388 enum glyph_row_area area
= it
->area
;
23390 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23391 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23393 /* If the glyph row is reversed, we need to prepend the glyph
23394 rather than append it. */
23395 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23399 /* Make room for the additional glyph. */
23400 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23402 glyph
= it
->glyph_row
->glyphs
[area
];
23404 glyph
->charpos
= CHARPOS (it
->position
);
23405 glyph
->object
= it
->object
;
23406 glyph
->pixel_width
= it
->pixel_width
;
23407 glyph
->ascent
= it
->ascent
;
23408 glyph
->descent
= it
->descent
;
23409 glyph
->voffset
= it
->voffset
;
23410 glyph
->type
= GLYPHLESS_GLYPH
;
23411 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23412 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23413 glyph
->u
.glyphless
.len
= len
;
23414 glyph
->u
.glyphless
.ch
= it
->c
;
23415 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23416 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23417 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23418 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23419 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23420 glyph
->multibyte_p
= it
->multibyte_p
;
23421 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23422 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23423 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23424 || it
->phys_descent
> it
->descent
);
23425 glyph
->padding_p
= 0;
23426 glyph
->glyph_not_available_p
= 0;
23427 glyph
->face_id
= face_id
;
23428 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23431 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23432 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23434 glyph
->bidi_type
= it
->bidi_it
.type
;
23436 ++it
->glyph_row
->used
[area
];
23439 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23443 /* Produce a glyph for a glyphless character for iterator IT.
23444 IT->glyphless_method specifies which method to use for displaying
23445 the character. See the description of enum
23446 glyphless_display_method in dispextern.h for the detail.
23448 FOR_NO_FONT is nonzero if and only if this is for a character for
23449 which no font was found. ACRONYM, if non-nil, is an acronym string
23450 for the character. */
23453 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23458 int base_width
, base_height
, width
, height
;
23459 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23462 /* Get the metrics of the base font. We always refer to the current
23464 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23465 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23466 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23467 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23468 base_height
= it
->ascent
+ it
->descent
;
23469 base_width
= font
->average_width
;
23471 /* Get a face ID for the glyph by utilizing a cache (the same way as
23472 done for `escape-glyph' in get_next_display_element). */
23473 if (it
->f
== last_glyphless_glyph_frame
23474 && it
->face_id
== last_glyphless_glyph_face_id
)
23476 face_id
= last_glyphless_glyph_merged_face_id
;
23480 /* Merge the `glyphless-char' face into the current face. */
23481 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23482 last_glyphless_glyph_frame
= it
->f
;
23483 last_glyphless_glyph_face_id
= it
->face_id
;
23484 last_glyphless_glyph_merged_face_id
= face_id
;
23487 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23489 it
->pixel_width
= THIN_SPACE_WIDTH
;
23491 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23493 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23495 width
= CHAR_WIDTH (it
->c
);
23498 else if (width
> 4)
23500 it
->pixel_width
= base_width
* width
;
23502 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23508 unsigned int code
[6];
23510 int ascent
, descent
;
23511 struct font_metrics metrics_upper
, metrics_lower
;
23513 face
= FACE_FROM_ID (it
->f
, face_id
);
23514 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23515 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23517 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23519 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23520 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23521 if (CONSP (acronym
))
23522 acronym
= XCAR (acronym
);
23523 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23527 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23528 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23531 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23532 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23533 upper_len
= (len
+ 1) / 2;
23534 font
->driver
->text_extents (font
, code
, upper_len
,
23536 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23541 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23542 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23543 upper_xoff
= upper_yoff
= 2; /* the typical case */
23544 if (base_width
>= width
)
23546 /* Align the upper to the left, the lower to the right. */
23547 it
->pixel_width
= base_width
;
23548 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23552 /* Center the shorter one. */
23553 it
->pixel_width
= width
;
23554 if (metrics_upper
.width
>= metrics_lower
.width
)
23555 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23558 /* FIXME: This code doesn't look right. It formerly was
23559 missing the "lower_xoff = 0;", which couldn't have
23560 been right since it left lower_xoff uninitialized. */
23562 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23566 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23567 top, bottom, and between upper and lower strings. */
23568 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23569 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23570 /* Center vertically.
23571 H:base_height, D:base_descent
23572 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23574 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23575 descent = D - H/2 + h/2;
23576 lower_yoff = descent - 2 - ld;
23577 upper_yoff = lower_yoff - la - 1 - ud; */
23578 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23579 descent
= it
->descent
- (base_height
- height
) / 2;
23580 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23581 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23582 - metrics_upper
.descent
);
23583 /* Don't make the height shorter than the base height. */
23584 if (height
> base_height
)
23586 it
->ascent
= ascent
;
23587 it
->descent
= descent
;
23591 it
->phys_ascent
= it
->ascent
;
23592 it
->phys_descent
= it
->descent
;
23594 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23595 upper_xoff
, upper_yoff
,
23596 lower_xoff
, lower_yoff
);
23598 take_vertical_position_into_account (it
);
23603 Produce glyphs/get display metrics for the display element IT is
23604 loaded with. See the description of struct it in dispextern.h
23605 for an overview of struct it. */
23608 x_produce_glyphs (struct it
*it
)
23610 int extra_line_spacing
= it
->extra_line_spacing
;
23612 it
->glyph_not_available_p
= 0;
23614 if (it
->what
== IT_CHARACTER
)
23617 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23618 struct font
*font
= face
->font
;
23619 struct font_metrics
*pcm
= NULL
;
23620 int boff
; /* baseline offset */
23624 /* When no suitable font is found, display this character by
23625 the method specified in the first extra slot of
23626 Vglyphless_char_display. */
23627 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23629 xassert (it
->what
== IT_GLYPHLESS
);
23630 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23634 boff
= font
->baseline_offset
;
23635 if (font
->vertical_centering
)
23636 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23638 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23644 if (it
->override_ascent
>= 0)
23646 it
->ascent
= it
->override_ascent
;
23647 it
->descent
= it
->override_descent
;
23648 boff
= it
->override_boff
;
23652 it
->ascent
= FONT_BASE (font
) + boff
;
23653 it
->descent
= FONT_DESCENT (font
) - boff
;
23656 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23658 pcm
= get_per_char_metric (font
, &char2b
);
23659 if (pcm
->width
== 0
23660 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23666 it
->phys_ascent
= pcm
->ascent
+ boff
;
23667 it
->phys_descent
= pcm
->descent
- boff
;
23668 it
->pixel_width
= pcm
->width
;
23672 it
->glyph_not_available_p
= 1;
23673 it
->phys_ascent
= it
->ascent
;
23674 it
->phys_descent
= it
->descent
;
23675 it
->pixel_width
= font
->space_width
;
23678 if (it
->constrain_row_ascent_descent_p
)
23680 if (it
->descent
> it
->max_descent
)
23682 it
->ascent
+= it
->descent
- it
->max_descent
;
23683 it
->descent
= it
->max_descent
;
23685 if (it
->ascent
> it
->max_ascent
)
23687 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23688 it
->ascent
= it
->max_ascent
;
23690 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23691 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23692 extra_line_spacing
= 0;
23695 /* If this is a space inside a region of text with
23696 `space-width' property, change its width. */
23697 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23699 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23701 /* If face has a box, add the box thickness to the character
23702 height. If character has a box line to the left and/or
23703 right, add the box line width to the character's width. */
23704 if (face
->box
!= FACE_NO_BOX
)
23706 int thick
= face
->box_line_width
;
23710 it
->ascent
+= thick
;
23711 it
->descent
+= thick
;
23716 if (it
->start_of_box_run_p
)
23717 it
->pixel_width
+= thick
;
23718 if (it
->end_of_box_run_p
)
23719 it
->pixel_width
+= thick
;
23722 /* If face has an overline, add the height of the overline
23723 (1 pixel) and a 1 pixel margin to the character height. */
23724 if (face
->overline_p
)
23725 it
->ascent
+= overline_margin
;
23727 if (it
->constrain_row_ascent_descent_p
)
23729 if (it
->ascent
> it
->max_ascent
)
23730 it
->ascent
= it
->max_ascent
;
23731 if (it
->descent
> it
->max_descent
)
23732 it
->descent
= it
->max_descent
;
23735 take_vertical_position_into_account (it
);
23737 /* If we have to actually produce glyphs, do it. */
23742 /* Translate a space with a `space-width' property
23743 into a stretch glyph. */
23744 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23745 / FONT_HEIGHT (font
));
23746 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23747 it
->ascent
+ it
->descent
, ascent
);
23752 /* If characters with lbearing or rbearing are displayed
23753 in this line, record that fact in a flag of the
23754 glyph row. This is used to optimize X output code. */
23755 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23756 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23758 if (! stretched_p
&& it
->pixel_width
== 0)
23759 /* We assure that all visible glyphs have at least 1-pixel
23761 it
->pixel_width
= 1;
23763 else if (it
->char_to_display
== '\n')
23765 /* A newline has no width, but we need the height of the
23766 line. But if previous part of the line sets a height,
23767 don't increase that height */
23769 Lisp_Object height
;
23770 Lisp_Object total_height
= Qnil
;
23772 it
->override_ascent
= -1;
23773 it
->pixel_width
= 0;
23776 height
= get_it_property (it
, Qline_height
);
23777 /* Split (line-height total-height) list */
23779 && CONSP (XCDR (height
))
23780 && NILP (XCDR (XCDR (height
))))
23782 total_height
= XCAR (XCDR (height
));
23783 height
= XCAR (height
);
23785 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23787 if (it
->override_ascent
>= 0)
23789 it
->ascent
= it
->override_ascent
;
23790 it
->descent
= it
->override_descent
;
23791 boff
= it
->override_boff
;
23795 it
->ascent
= FONT_BASE (font
) + boff
;
23796 it
->descent
= FONT_DESCENT (font
) - boff
;
23799 if (EQ (height
, Qt
))
23801 if (it
->descent
> it
->max_descent
)
23803 it
->ascent
+= it
->descent
- it
->max_descent
;
23804 it
->descent
= it
->max_descent
;
23806 if (it
->ascent
> it
->max_ascent
)
23808 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23809 it
->ascent
= it
->max_ascent
;
23811 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23812 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23813 it
->constrain_row_ascent_descent_p
= 1;
23814 extra_line_spacing
= 0;
23818 Lisp_Object spacing
;
23820 it
->phys_ascent
= it
->ascent
;
23821 it
->phys_descent
= it
->descent
;
23823 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23824 && face
->box
!= FACE_NO_BOX
23825 && face
->box_line_width
> 0)
23827 it
->ascent
+= face
->box_line_width
;
23828 it
->descent
+= face
->box_line_width
;
23831 && XINT (height
) > it
->ascent
+ it
->descent
)
23832 it
->ascent
= XINT (height
) - it
->descent
;
23834 if (!NILP (total_height
))
23835 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23838 spacing
= get_it_property (it
, Qline_spacing
);
23839 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23841 if (INTEGERP (spacing
))
23843 extra_line_spacing
= XINT (spacing
);
23844 if (!NILP (total_height
))
23845 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23849 else /* i.e. (it->char_to_display == '\t') */
23851 if (font
->space_width
> 0)
23853 int tab_width
= it
->tab_width
* font
->space_width
;
23854 int x
= it
->current_x
+ it
->continuation_lines_width
;
23855 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23857 /* If the distance from the current position to the next tab
23858 stop is less than a space character width, use the
23859 tab stop after that. */
23860 if (next_tab_x
- x
< font
->space_width
)
23861 next_tab_x
+= tab_width
;
23863 it
->pixel_width
= next_tab_x
- x
;
23865 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23866 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23870 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23871 it
->ascent
+ it
->descent
, it
->ascent
);
23876 it
->pixel_width
= 0;
23881 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23883 /* A static composition.
23885 Note: A composition is represented as one glyph in the
23886 glyph matrix. There are no padding glyphs.
23888 Important note: pixel_width, ascent, and descent are the
23889 values of what is drawn by draw_glyphs (i.e. the values of
23890 the overall glyphs composed). */
23891 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23892 int boff
; /* baseline offset */
23893 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23894 int glyph_len
= cmp
->glyph_len
;
23895 struct font
*font
= face
->font
;
23899 /* If we have not yet calculated pixel size data of glyphs of
23900 the composition for the current face font, calculate them
23901 now. Theoretically, we have to check all fonts for the
23902 glyphs, but that requires much time and memory space. So,
23903 here we check only the font of the first glyph. This may
23904 lead to incorrect display, but it's very rare, and C-l
23905 (recenter-top-bottom) can correct the display anyway. */
23906 if (! cmp
->font
|| cmp
->font
!= font
)
23908 /* Ascent and descent of the font of the first character
23909 of this composition (adjusted by baseline offset).
23910 Ascent and descent of overall glyphs should not be less
23911 than these, respectively. */
23912 int font_ascent
, font_descent
, font_height
;
23913 /* Bounding box of the overall glyphs. */
23914 int leftmost
, rightmost
, lowest
, highest
;
23915 int lbearing
, rbearing
;
23916 int i
, width
, ascent
, descent
;
23917 int left_padded
= 0, right_padded
= 0;
23918 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23920 struct font_metrics
*pcm
;
23921 int font_not_found_p
;
23924 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23925 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23927 if (glyph_len
< cmp
->glyph_len
)
23929 for (i
= 0; i
< glyph_len
; i
++)
23931 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23933 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23938 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23939 : IT_CHARPOS (*it
));
23940 /* If no suitable font is found, use the default font. */
23941 font_not_found_p
= font
== NULL
;
23942 if (font_not_found_p
)
23944 face
= face
->ascii_face
;
23947 boff
= font
->baseline_offset
;
23948 if (font
->vertical_centering
)
23949 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23950 font_ascent
= FONT_BASE (font
) + boff
;
23951 font_descent
= FONT_DESCENT (font
) - boff
;
23952 font_height
= FONT_HEIGHT (font
);
23954 cmp
->font
= (void *) font
;
23957 if (! font_not_found_p
)
23959 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23961 pcm
= get_per_char_metric (font
, &char2b
);
23964 /* Initialize the bounding box. */
23967 width
= pcm
->width
;
23968 ascent
= pcm
->ascent
;
23969 descent
= pcm
->descent
;
23970 lbearing
= pcm
->lbearing
;
23971 rbearing
= pcm
->rbearing
;
23975 width
= font
->space_width
;
23976 ascent
= FONT_BASE (font
);
23977 descent
= FONT_DESCENT (font
);
23984 lowest
= - descent
+ boff
;
23985 highest
= ascent
+ boff
;
23987 if (! font_not_found_p
23988 && font
->default_ascent
23989 && CHAR_TABLE_P (Vuse_default_ascent
)
23990 && !NILP (Faref (Vuse_default_ascent
,
23991 make_number (it
->char_to_display
))))
23992 highest
= font
->default_ascent
+ boff
;
23994 /* Draw the first glyph at the normal position. It may be
23995 shifted to right later if some other glyphs are drawn
23997 cmp
->offsets
[i
* 2] = 0;
23998 cmp
->offsets
[i
* 2 + 1] = boff
;
23999 cmp
->lbearing
= lbearing
;
24000 cmp
->rbearing
= rbearing
;
24002 /* Set cmp->offsets for the remaining glyphs. */
24003 for (i
++; i
< glyph_len
; i
++)
24005 int left
, right
, btm
, top
;
24006 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24008 struct face
*this_face
;
24012 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24013 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24014 font
= this_face
->font
;
24020 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24022 pcm
= get_per_char_metric (font
, &char2b
);
24025 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24028 width
= pcm
->width
;
24029 ascent
= pcm
->ascent
;
24030 descent
= pcm
->descent
;
24031 lbearing
= pcm
->lbearing
;
24032 rbearing
= pcm
->rbearing
;
24033 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24035 /* Relative composition with or without
24036 alternate chars. */
24037 left
= (leftmost
+ rightmost
- width
) / 2;
24038 btm
= - descent
+ boff
;
24039 if (font
->relative_compose
24040 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24041 || NILP (Faref (Vignore_relative_composition
,
24042 make_number (ch
)))))
24045 if (- descent
>= font
->relative_compose
)
24046 /* One extra pixel between two glyphs. */
24048 else if (ascent
<= 0)
24049 /* One extra pixel between two glyphs. */
24050 btm
= lowest
- 1 - ascent
- descent
;
24055 /* A composition rule is specified by an integer
24056 value that encodes global and new reference
24057 points (GREF and NREF). GREF and NREF are
24058 specified by numbers as below:
24060 0---1---2 -- ascent
24064 9--10--11 -- center
24066 ---3---4---5--- baseline
24068 6---7---8 -- descent
24070 int rule
= COMPOSITION_RULE (cmp
, i
);
24071 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24073 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24074 grefx
= gref
% 3, nrefx
= nref
% 3;
24075 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24077 xoff
= font_height
* (xoff
- 128) / 256;
24079 yoff
= font_height
* (yoff
- 128) / 256;
24082 + grefx
* (rightmost
- leftmost
) / 2
24083 - nrefx
* width
/ 2
24086 btm
= ((grefy
== 0 ? highest
24088 : grefy
== 2 ? lowest
24089 : (highest
+ lowest
) / 2)
24090 - (nrefy
== 0 ? ascent
+ descent
24091 : nrefy
== 1 ? descent
- boff
24093 : (ascent
+ descent
) / 2)
24097 cmp
->offsets
[i
* 2] = left
;
24098 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24100 /* Update the bounding box of the overall glyphs. */
24103 right
= left
+ width
;
24104 if (left
< leftmost
)
24106 if (right
> rightmost
)
24109 top
= btm
+ descent
+ ascent
;
24115 if (cmp
->lbearing
> left
+ lbearing
)
24116 cmp
->lbearing
= left
+ lbearing
;
24117 if (cmp
->rbearing
< left
+ rbearing
)
24118 cmp
->rbearing
= left
+ rbearing
;
24122 /* If there are glyphs whose x-offsets are negative,
24123 shift all glyphs to the right and make all x-offsets
24127 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24128 cmp
->offsets
[i
* 2] -= leftmost
;
24129 rightmost
-= leftmost
;
24130 cmp
->lbearing
-= leftmost
;
24131 cmp
->rbearing
-= leftmost
;
24134 if (left_padded
&& cmp
->lbearing
< 0)
24136 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24137 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24138 rightmost
-= cmp
->lbearing
;
24139 cmp
->rbearing
-= cmp
->lbearing
;
24142 if (right_padded
&& rightmost
< cmp
->rbearing
)
24144 rightmost
= cmp
->rbearing
;
24147 cmp
->pixel_width
= rightmost
;
24148 cmp
->ascent
= highest
;
24149 cmp
->descent
= - lowest
;
24150 if (cmp
->ascent
< font_ascent
)
24151 cmp
->ascent
= font_ascent
;
24152 if (cmp
->descent
< font_descent
)
24153 cmp
->descent
= font_descent
;
24157 && (cmp
->lbearing
< 0
24158 || cmp
->rbearing
> cmp
->pixel_width
))
24159 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24161 it
->pixel_width
= cmp
->pixel_width
;
24162 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24163 it
->descent
= it
->phys_descent
= cmp
->descent
;
24164 if (face
->box
!= FACE_NO_BOX
)
24166 int thick
= face
->box_line_width
;
24170 it
->ascent
+= thick
;
24171 it
->descent
+= thick
;
24176 if (it
->start_of_box_run_p
)
24177 it
->pixel_width
+= thick
;
24178 if (it
->end_of_box_run_p
)
24179 it
->pixel_width
+= thick
;
24182 /* If face has an overline, add the height of the overline
24183 (1 pixel) and a 1 pixel margin to the character height. */
24184 if (face
->overline_p
)
24185 it
->ascent
+= overline_margin
;
24187 take_vertical_position_into_account (it
);
24188 if (it
->ascent
< 0)
24190 if (it
->descent
< 0)
24194 append_composite_glyph (it
);
24196 else if (it
->what
== IT_COMPOSITION
)
24198 /* A dynamic (automatic) composition. */
24199 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24200 Lisp_Object gstring
;
24201 struct font_metrics metrics
;
24205 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24207 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24210 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24211 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24212 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24213 it
->descent
= it
->phys_descent
= metrics
.descent
;
24214 if (face
->box
!= FACE_NO_BOX
)
24216 int thick
= face
->box_line_width
;
24220 it
->ascent
+= thick
;
24221 it
->descent
+= thick
;
24226 if (it
->start_of_box_run_p
)
24227 it
->pixel_width
+= thick
;
24228 if (it
->end_of_box_run_p
)
24229 it
->pixel_width
+= thick
;
24231 /* If face has an overline, add the height of the overline
24232 (1 pixel) and a 1 pixel margin to the character height. */
24233 if (face
->overline_p
)
24234 it
->ascent
+= overline_margin
;
24235 take_vertical_position_into_account (it
);
24236 if (it
->ascent
< 0)
24238 if (it
->descent
< 0)
24242 append_composite_glyph (it
);
24244 else if (it
->what
== IT_GLYPHLESS
)
24245 produce_glyphless_glyph (it
, 0, Qnil
);
24246 else if (it
->what
== IT_IMAGE
)
24247 produce_image_glyph (it
);
24248 else if (it
->what
== IT_STRETCH
)
24249 produce_stretch_glyph (it
);
24252 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24253 because this isn't true for images with `:ascent 100'. */
24254 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24255 if (it
->area
== TEXT_AREA
)
24256 it
->current_x
+= it
->pixel_width
;
24258 if (extra_line_spacing
> 0)
24260 it
->descent
+= extra_line_spacing
;
24261 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24262 it
->max_extra_line_spacing
= extra_line_spacing
;
24265 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24266 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24267 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24268 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24272 Output LEN glyphs starting at START at the nominal cursor position.
24273 Advance the nominal cursor over the text. The global variable
24274 updated_window contains the window being updated, updated_row is
24275 the glyph row being updated, and updated_area is the area of that
24276 row being updated. */
24279 x_write_glyphs (struct glyph
*start
, int len
)
24283 xassert (updated_window
&& updated_row
);
24286 /* Write glyphs. */
24288 hpos
= start
- updated_row
->glyphs
[updated_area
];
24289 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24290 updated_row
, updated_area
,
24292 DRAW_NORMAL_TEXT
, 0);
24294 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24295 if (updated_area
== TEXT_AREA
24296 && updated_window
->phys_cursor_on_p
24297 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24298 && updated_window
->phys_cursor
.hpos
>= hpos
24299 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24300 updated_window
->phys_cursor_on_p
= 0;
24304 /* Advance the output cursor. */
24305 output_cursor
.hpos
+= len
;
24306 output_cursor
.x
= x
;
24311 Insert LEN glyphs from START at the nominal cursor position. */
24314 x_insert_glyphs (struct glyph
*start
, int len
)
24318 int line_height
, shift_by_width
, shifted_region_width
;
24319 struct glyph_row
*row
;
24320 struct glyph
*glyph
;
24321 int frame_x
, frame_y
;
24324 xassert (updated_window
&& updated_row
);
24326 w
= updated_window
;
24327 f
= XFRAME (WINDOW_FRAME (w
));
24329 /* Get the height of the line we are in. */
24331 line_height
= row
->height
;
24333 /* Get the width of the glyphs to insert. */
24334 shift_by_width
= 0;
24335 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24336 shift_by_width
+= glyph
->pixel_width
;
24338 /* Get the width of the region to shift right. */
24339 shifted_region_width
= (window_box_width (w
, updated_area
)
24344 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24345 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24347 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24348 line_height
, shift_by_width
);
24350 /* Write the glyphs. */
24351 hpos
= start
- row
->glyphs
[updated_area
];
24352 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24354 DRAW_NORMAL_TEXT
, 0);
24356 /* Advance the output cursor. */
24357 output_cursor
.hpos
+= len
;
24358 output_cursor
.x
+= shift_by_width
;
24364 Erase the current text line from the nominal cursor position
24365 (inclusive) to pixel column TO_X (exclusive). The idea is that
24366 everything from TO_X onward is already erased.
24368 TO_X is a pixel position relative to updated_area of
24369 updated_window. TO_X == -1 means clear to the end of this area. */
24372 x_clear_end_of_line (int to_x
)
24375 struct window
*w
= updated_window
;
24376 int max_x
, min_y
, max_y
;
24377 int from_x
, from_y
, to_y
;
24379 xassert (updated_window
&& updated_row
);
24380 f
= XFRAME (w
->frame
);
24382 if (updated_row
->full_width_p
)
24383 max_x
= WINDOW_TOTAL_WIDTH (w
);
24385 max_x
= window_box_width (w
, updated_area
);
24386 max_y
= window_text_bottom_y (w
);
24388 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24389 of window. For TO_X > 0, truncate to end of drawing area. */
24395 to_x
= min (to_x
, max_x
);
24397 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24399 /* Notice if the cursor will be cleared by this operation. */
24400 if (!updated_row
->full_width_p
)
24401 notice_overwritten_cursor (w
, updated_area
,
24402 output_cursor
.x
, -1,
24404 MATRIX_ROW_BOTTOM_Y (updated_row
));
24406 from_x
= output_cursor
.x
;
24408 /* Translate to frame coordinates. */
24409 if (updated_row
->full_width_p
)
24411 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24412 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24416 int area_left
= window_box_left (w
, updated_area
);
24417 from_x
+= area_left
;
24421 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24422 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24423 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24425 /* Prevent inadvertently clearing to end of the X window. */
24426 if (to_x
> from_x
&& to_y
> from_y
)
24429 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24430 to_x
- from_x
, to_y
- from_y
);
24435 #endif /* HAVE_WINDOW_SYSTEM */
24439 /***********************************************************************
24441 ***********************************************************************/
24443 /* Value is the internal representation of the specified cursor type
24444 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24445 of the bar cursor. */
24447 static enum text_cursor_kinds
24448 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24450 enum text_cursor_kinds type
;
24455 if (EQ (arg
, Qbox
))
24456 return FILLED_BOX_CURSOR
;
24458 if (EQ (arg
, Qhollow
))
24459 return HOLLOW_BOX_CURSOR
;
24461 if (EQ (arg
, Qbar
))
24468 && EQ (XCAR (arg
), Qbar
)
24469 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
24471 *width
= XINT (XCDR (arg
));
24475 if (EQ (arg
, Qhbar
))
24478 return HBAR_CURSOR
;
24482 && EQ (XCAR (arg
), Qhbar
)
24483 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
24485 *width
= XINT (XCDR (arg
));
24486 return HBAR_CURSOR
;
24489 /* Treat anything unknown as "hollow box cursor".
24490 It was bad to signal an error; people have trouble fixing
24491 .Xdefaults with Emacs, when it has something bad in it. */
24492 type
= HOLLOW_BOX_CURSOR
;
24497 /* Set the default cursor types for specified frame. */
24499 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24504 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24505 FRAME_CURSOR_WIDTH (f
) = width
;
24507 /* By default, set up the blink-off state depending on the on-state. */
24509 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24512 FRAME_BLINK_OFF_CURSOR (f
)
24513 = get_specified_cursor_type (XCDR (tem
), &width
);
24514 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24517 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24521 #ifdef HAVE_WINDOW_SYSTEM
24523 /* Return the cursor we want to be displayed in window W. Return
24524 width of bar/hbar cursor through WIDTH arg. Return with
24525 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24526 (i.e. if the `system caret' should track this cursor).
24528 In a mini-buffer window, we want the cursor only to appear if we
24529 are reading input from this window. For the selected window, we
24530 want the cursor type given by the frame parameter or buffer local
24531 setting of cursor-type. If explicitly marked off, draw no cursor.
24532 In all other cases, we want a hollow box cursor. */
24534 static enum text_cursor_kinds
24535 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24536 int *active_cursor
)
24538 struct frame
*f
= XFRAME (w
->frame
);
24539 struct buffer
*b
= XBUFFER (w
->buffer
);
24540 int cursor_type
= DEFAULT_CURSOR
;
24541 Lisp_Object alt_cursor
;
24542 int non_selected
= 0;
24544 *active_cursor
= 1;
24547 if (cursor_in_echo_area
24548 && FRAME_HAS_MINIBUF_P (f
)
24549 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24551 if (w
== XWINDOW (echo_area_window
))
24553 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24555 *width
= FRAME_CURSOR_WIDTH (f
);
24556 return FRAME_DESIRED_CURSOR (f
);
24559 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24562 *active_cursor
= 0;
24566 /* Detect a nonselected window or nonselected frame. */
24567 else if (w
!= XWINDOW (f
->selected_window
)
24568 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24570 *active_cursor
= 0;
24572 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24578 /* Never display a cursor in a window in which cursor-type is nil. */
24579 if (NILP (BVAR (b
, cursor_type
)))
24582 /* Get the normal cursor type for this window. */
24583 if (EQ (BVAR (b
, cursor_type
), Qt
))
24585 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24586 *width
= FRAME_CURSOR_WIDTH (f
);
24589 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24591 /* Use cursor-in-non-selected-windows instead
24592 for non-selected window or frame. */
24595 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24596 if (!EQ (Qt
, alt_cursor
))
24597 return get_specified_cursor_type (alt_cursor
, width
);
24598 /* t means modify the normal cursor type. */
24599 if (cursor_type
== FILLED_BOX_CURSOR
)
24600 cursor_type
= HOLLOW_BOX_CURSOR
;
24601 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24603 return cursor_type
;
24606 /* Use normal cursor if not blinked off. */
24607 if (!w
->cursor_off_p
)
24609 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24611 if (cursor_type
== FILLED_BOX_CURSOR
)
24613 /* Using a block cursor on large images can be very annoying.
24614 So use a hollow cursor for "large" images.
24615 If image is not transparent (no mask), also use hollow cursor. */
24616 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24617 if (img
!= NULL
&& IMAGEP (img
->spec
))
24619 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24620 where N = size of default frame font size.
24621 This should cover most of the "tiny" icons people may use. */
24623 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24624 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24625 cursor_type
= HOLLOW_BOX_CURSOR
;
24628 else if (cursor_type
!= NO_CURSOR
)
24630 /* Display current only supports BOX and HOLLOW cursors for images.
24631 So for now, unconditionally use a HOLLOW cursor when cursor is
24632 not a solid box cursor. */
24633 cursor_type
= HOLLOW_BOX_CURSOR
;
24636 return cursor_type
;
24639 /* Cursor is blinked off, so determine how to "toggle" it. */
24641 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24642 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24643 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24645 /* Then see if frame has specified a specific blink off cursor type. */
24646 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24648 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24649 return FRAME_BLINK_OFF_CURSOR (f
);
24653 /* Some people liked having a permanently visible blinking cursor,
24654 while others had very strong opinions against it. So it was
24655 decided to remove it. KFS 2003-09-03 */
24657 /* Finally perform built-in cursor blinking:
24658 filled box <-> hollow box
24659 wide [h]bar <-> narrow [h]bar
24660 narrow [h]bar <-> no cursor
24661 other type <-> no cursor */
24663 if (cursor_type
== FILLED_BOX_CURSOR
)
24664 return HOLLOW_BOX_CURSOR
;
24666 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24669 return cursor_type
;
24677 /* Notice when the text cursor of window W has been completely
24678 overwritten by a drawing operation that outputs glyphs in AREA
24679 starting at X0 and ending at X1 in the line starting at Y0 and
24680 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24681 the rest of the line after X0 has been written. Y coordinates
24682 are window-relative. */
24685 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24686 int x0
, int x1
, int y0
, int y1
)
24688 int cx0
, cx1
, cy0
, cy1
;
24689 struct glyph_row
*row
;
24691 if (!w
->phys_cursor_on_p
)
24693 if (area
!= TEXT_AREA
)
24696 if (w
->phys_cursor
.vpos
< 0
24697 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24698 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24699 !(row
->enabled_p
&& row
->displays_text_p
)))
24702 if (row
->cursor_in_fringe_p
)
24704 row
->cursor_in_fringe_p
= 0;
24705 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24706 w
->phys_cursor_on_p
= 0;
24710 cx0
= w
->phys_cursor
.x
;
24711 cx1
= cx0
+ w
->phys_cursor_width
;
24712 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24715 /* The cursor image will be completely removed from the
24716 screen if the output area intersects the cursor area in
24717 y-direction. When we draw in [y0 y1[, and some part of
24718 the cursor is at y < y0, that part must have been drawn
24719 before. When scrolling, the cursor is erased before
24720 actually scrolling, so we don't come here. When not
24721 scrolling, the rows above the old cursor row must have
24722 changed, and in this case these rows must have written
24723 over the cursor image.
24725 Likewise if part of the cursor is below y1, with the
24726 exception of the cursor being in the first blank row at
24727 the buffer and window end because update_text_area
24728 doesn't draw that row. (Except when it does, but
24729 that's handled in update_text_area.) */
24731 cy0
= w
->phys_cursor
.y
;
24732 cy1
= cy0
+ w
->phys_cursor_height
;
24733 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24736 w
->phys_cursor_on_p
= 0;
24739 #endif /* HAVE_WINDOW_SYSTEM */
24742 /************************************************************************
24744 ************************************************************************/
24746 #ifdef HAVE_WINDOW_SYSTEM
24749 Fix the display of area AREA of overlapping row ROW in window W
24750 with respect to the overlapping part OVERLAPS. */
24753 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24754 enum glyph_row_area area
, int overlaps
)
24761 for (i
= 0; i
< row
->used
[area
];)
24763 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24765 int start
= i
, start_x
= x
;
24769 x
+= row
->glyphs
[area
][i
].pixel_width
;
24772 while (i
< row
->used
[area
]
24773 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24775 draw_glyphs (w
, start_x
, row
, area
,
24777 DRAW_NORMAL_TEXT
, overlaps
);
24781 x
+= row
->glyphs
[area
][i
].pixel_width
;
24791 Draw the cursor glyph of window W in glyph row ROW. See the
24792 comment of draw_glyphs for the meaning of HL. */
24795 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24796 enum draw_glyphs_face hl
)
24798 /* If cursor hpos is out of bounds, don't draw garbage. This can
24799 happen in mini-buffer windows when switching between echo area
24800 glyphs and mini-buffer. */
24801 if ((row
->reversed_p
24802 ? (w
->phys_cursor
.hpos
>= 0)
24803 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24805 int on_p
= w
->phys_cursor_on_p
;
24807 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24808 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24810 w
->phys_cursor_on_p
= on_p
;
24812 if (hl
== DRAW_CURSOR
)
24813 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24814 /* When we erase the cursor, and ROW is overlapped by other
24815 rows, make sure that these overlapping parts of other rows
24817 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24819 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24821 if (row
> w
->current_matrix
->rows
24822 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24823 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24824 OVERLAPS_ERASED_CURSOR
);
24826 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24827 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24828 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24829 OVERLAPS_ERASED_CURSOR
);
24836 Erase the image of a cursor of window W from the screen. */
24839 erase_phys_cursor (struct window
*w
)
24841 struct frame
*f
= XFRAME (w
->frame
);
24842 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24843 int hpos
= w
->phys_cursor
.hpos
;
24844 int vpos
= w
->phys_cursor
.vpos
;
24845 int mouse_face_here_p
= 0;
24846 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24847 struct glyph_row
*cursor_row
;
24848 struct glyph
*cursor_glyph
;
24849 enum draw_glyphs_face hl
;
24851 /* No cursor displayed or row invalidated => nothing to do on the
24853 if (w
->phys_cursor_type
== NO_CURSOR
)
24854 goto mark_cursor_off
;
24856 /* VPOS >= active_glyphs->nrows means that window has been resized.
24857 Don't bother to erase the cursor. */
24858 if (vpos
>= active_glyphs
->nrows
)
24859 goto mark_cursor_off
;
24861 /* If row containing cursor is marked invalid, there is nothing we
24863 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24864 if (!cursor_row
->enabled_p
)
24865 goto mark_cursor_off
;
24867 /* If line spacing is > 0, old cursor may only be partially visible in
24868 window after split-window. So adjust visible height. */
24869 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24870 window_text_bottom_y (w
) - cursor_row
->y
);
24872 /* If row is completely invisible, don't attempt to delete a cursor which
24873 isn't there. This can happen if cursor is at top of a window, and
24874 we switch to a buffer with a header line in that window. */
24875 if (cursor_row
->visible_height
<= 0)
24876 goto mark_cursor_off
;
24878 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24879 if (cursor_row
->cursor_in_fringe_p
)
24881 cursor_row
->cursor_in_fringe_p
= 0;
24882 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24883 goto mark_cursor_off
;
24886 /* This can happen when the new row is shorter than the old one.
24887 In this case, either draw_glyphs or clear_end_of_line
24888 should have cleared the cursor. Note that we wouldn't be
24889 able to erase the cursor in this case because we don't have a
24890 cursor glyph at hand. */
24891 if ((cursor_row
->reversed_p
24892 ? (w
->phys_cursor
.hpos
< 0)
24893 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24894 goto mark_cursor_off
;
24896 /* If the cursor is in the mouse face area, redisplay that when
24897 we clear the cursor. */
24898 if (! NILP (hlinfo
->mouse_face_window
)
24899 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24900 /* Don't redraw the cursor's spot in mouse face if it is at the
24901 end of a line (on a newline). The cursor appears there, but
24902 mouse highlighting does not. */
24903 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24904 mouse_face_here_p
= 1;
24906 /* Maybe clear the display under the cursor. */
24907 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24910 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24913 cursor_glyph
= get_phys_cursor_glyph (w
);
24914 if (cursor_glyph
== NULL
)
24915 goto mark_cursor_off
;
24917 width
= cursor_glyph
->pixel_width
;
24918 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24919 x
= w
->phys_cursor
.x
;
24921 width
-= left_x
- x
;
24922 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24923 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24924 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24927 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24930 /* Erase the cursor by redrawing the character underneath it. */
24931 if (mouse_face_here_p
)
24932 hl
= DRAW_MOUSE_FACE
;
24934 hl
= DRAW_NORMAL_TEXT
;
24935 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24938 w
->phys_cursor_on_p
= 0;
24939 w
->phys_cursor_type
= NO_CURSOR
;
24944 Display or clear cursor of window W. If ON is zero, clear the
24945 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24946 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24949 display_and_set_cursor (struct window
*w
, int on
,
24950 int hpos
, int vpos
, int x
, int y
)
24952 struct frame
*f
= XFRAME (w
->frame
);
24953 int new_cursor_type
;
24954 int new_cursor_width
;
24956 struct glyph_row
*glyph_row
;
24957 struct glyph
*glyph
;
24959 /* This is pointless on invisible frames, and dangerous on garbaged
24960 windows and frames; in the latter case, the frame or window may
24961 be in the midst of changing its size, and x and y may be off the
24963 if (! FRAME_VISIBLE_P (f
)
24964 || FRAME_GARBAGED_P (f
)
24965 || vpos
>= w
->current_matrix
->nrows
24966 || hpos
>= w
->current_matrix
->matrix_w
)
24969 /* If cursor is off and we want it off, return quickly. */
24970 if (!on
&& !w
->phys_cursor_on_p
)
24973 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24974 /* If cursor row is not enabled, we don't really know where to
24975 display the cursor. */
24976 if (!glyph_row
->enabled_p
)
24978 w
->phys_cursor_on_p
= 0;
24983 if (!glyph_row
->exact_window_width_line_p
24984 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24985 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24987 xassert (interrupt_input_blocked
);
24989 /* Set new_cursor_type to the cursor we want to be displayed. */
24990 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24991 &new_cursor_width
, &active_cursor
);
24993 /* If cursor is currently being shown and we don't want it to be or
24994 it is in the wrong place, or the cursor type is not what we want,
24996 if (w
->phys_cursor_on_p
24998 || w
->phys_cursor
.x
!= x
24999 || w
->phys_cursor
.y
!= y
25000 || new_cursor_type
!= w
->phys_cursor_type
25001 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25002 && new_cursor_width
!= w
->phys_cursor_width
)))
25003 erase_phys_cursor (w
);
25005 /* Don't check phys_cursor_on_p here because that flag is only set
25006 to zero in some cases where we know that the cursor has been
25007 completely erased, to avoid the extra work of erasing the cursor
25008 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25009 still not be visible, or it has only been partly erased. */
25012 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25013 w
->phys_cursor_height
= glyph_row
->height
;
25015 /* Set phys_cursor_.* before x_draw_.* is called because some
25016 of them may need the information. */
25017 w
->phys_cursor
.x
= x
;
25018 w
->phys_cursor
.y
= glyph_row
->y
;
25019 w
->phys_cursor
.hpos
= hpos
;
25020 w
->phys_cursor
.vpos
= vpos
;
25023 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25024 new_cursor_type
, new_cursor_width
,
25025 on
, active_cursor
);
25029 /* Switch the display of W's cursor on or off, according to the value
25033 update_window_cursor (struct window
*w
, int on
)
25035 /* Don't update cursor in windows whose frame is in the process
25036 of being deleted. */
25037 if (w
->current_matrix
)
25040 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25041 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25047 /* Call update_window_cursor with parameter ON_P on all leaf windows
25048 in the window tree rooted at W. */
25051 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25055 if (!NILP (w
->hchild
))
25056 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25057 else if (!NILP (w
->vchild
))
25058 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25060 update_window_cursor (w
, on_p
);
25062 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25068 Display the cursor on window W, or clear it, according to ON_P.
25069 Don't change the cursor's position. */
25072 x_update_cursor (struct frame
*f
, int on_p
)
25074 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25079 Clear the cursor of window W to background color, and mark the
25080 cursor as not shown. This is used when the text where the cursor
25081 is about to be rewritten. */
25084 x_clear_cursor (struct window
*w
)
25086 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25087 update_window_cursor (w
, 0);
25090 #endif /* HAVE_WINDOW_SYSTEM */
25092 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25095 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25096 int start_hpos
, int end_hpos
,
25097 enum draw_glyphs_face draw
)
25099 #ifdef HAVE_WINDOW_SYSTEM
25100 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25102 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25106 #if defined (HAVE_GPM) || defined (MSDOS)
25107 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25111 /* Display the active region described by mouse_face_* according to DRAW. */
25114 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25116 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25117 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25119 if (/* If window is in the process of being destroyed, don't bother
25121 w
->current_matrix
!= NULL
25122 /* Don't update mouse highlight if hidden */
25123 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25124 /* Recognize when we are called to operate on rows that don't exist
25125 anymore. This can happen when a window is split. */
25126 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25128 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25129 struct glyph_row
*row
, *first
, *last
;
25131 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25132 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25134 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25136 int start_hpos
, end_hpos
, start_x
;
25138 /* For all but the first row, the highlight starts at column 0. */
25141 /* R2L rows have BEG and END in reversed order, but the
25142 screen drawing geometry is always left to right. So
25143 we need to mirror the beginning and end of the
25144 highlighted area in R2L rows. */
25145 if (!row
->reversed_p
)
25147 start_hpos
= hlinfo
->mouse_face_beg_col
;
25148 start_x
= hlinfo
->mouse_face_beg_x
;
25150 else if (row
== last
)
25152 start_hpos
= hlinfo
->mouse_face_end_col
;
25153 start_x
= hlinfo
->mouse_face_end_x
;
25161 else if (row
->reversed_p
&& row
== last
)
25163 start_hpos
= hlinfo
->mouse_face_end_col
;
25164 start_x
= hlinfo
->mouse_face_end_x
;
25174 if (!row
->reversed_p
)
25175 end_hpos
= hlinfo
->mouse_face_end_col
;
25176 else if (row
== first
)
25177 end_hpos
= hlinfo
->mouse_face_beg_col
;
25180 end_hpos
= row
->used
[TEXT_AREA
];
25181 if (draw
== DRAW_NORMAL_TEXT
)
25182 row
->fill_line_p
= 1; /* Clear to end of line */
25185 else if (row
->reversed_p
&& row
== first
)
25186 end_hpos
= hlinfo
->mouse_face_beg_col
;
25189 end_hpos
= row
->used
[TEXT_AREA
];
25190 if (draw
== DRAW_NORMAL_TEXT
)
25191 row
->fill_line_p
= 1; /* Clear to end of line */
25194 if (end_hpos
> start_hpos
)
25196 draw_row_with_mouse_face (w
, start_x
, row
,
25197 start_hpos
, end_hpos
, draw
);
25200 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25204 #ifdef HAVE_WINDOW_SYSTEM
25205 /* When we've written over the cursor, arrange for it to
25206 be displayed again. */
25207 if (FRAME_WINDOW_P (f
)
25208 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25211 display_and_set_cursor (w
, 1,
25212 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25213 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25216 #endif /* HAVE_WINDOW_SYSTEM */
25219 #ifdef HAVE_WINDOW_SYSTEM
25220 /* Change the mouse cursor. */
25221 if (FRAME_WINDOW_P (f
))
25223 if (draw
== DRAW_NORMAL_TEXT
25224 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25225 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25226 else if (draw
== DRAW_MOUSE_FACE
)
25227 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25229 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25231 #endif /* HAVE_WINDOW_SYSTEM */
25235 Clear out the mouse-highlighted active region.
25236 Redraw it un-highlighted first. Value is non-zero if mouse
25237 face was actually drawn unhighlighted. */
25240 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25244 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25246 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25250 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25251 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25252 hlinfo
->mouse_face_window
= Qnil
;
25253 hlinfo
->mouse_face_overlay
= Qnil
;
25257 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25258 within the mouse face on that window. */
25260 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25262 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25264 /* Quickly resolve the easy cases. */
25265 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25266 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25268 if (vpos
< hlinfo
->mouse_face_beg_row
25269 || vpos
> hlinfo
->mouse_face_end_row
)
25271 if (vpos
> hlinfo
->mouse_face_beg_row
25272 && vpos
< hlinfo
->mouse_face_end_row
)
25275 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25277 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25279 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25282 else if ((vpos
== hlinfo
->mouse_face_beg_row
25283 && hpos
>= hlinfo
->mouse_face_beg_col
)
25284 || (vpos
== hlinfo
->mouse_face_end_row
25285 && hpos
< hlinfo
->mouse_face_end_col
))
25290 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25292 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25295 else if ((vpos
== hlinfo
->mouse_face_beg_row
25296 && hpos
<= hlinfo
->mouse_face_beg_col
)
25297 || (vpos
== hlinfo
->mouse_face_end_row
25298 && hpos
> hlinfo
->mouse_face_end_col
))
25306 Non-zero if physical cursor of window W is within mouse face. */
25309 cursor_in_mouse_face_p (struct window
*w
)
25311 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25316 /* Find the glyph rows START_ROW and END_ROW of window W that display
25317 characters between buffer positions START_CHARPOS and END_CHARPOS
25318 (excluding END_CHARPOS). This is similar to row_containing_pos,
25319 but is more accurate when bidi reordering makes buffer positions
25320 change non-linearly with glyph rows. */
25322 rows_from_pos_range (struct window
*w
,
25323 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
25324 struct glyph_row
**start
, struct glyph_row
**end
)
25326 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25327 int last_y
= window_text_bottom_y (w
);
25328 struct glyph_row
*row
;
25333 while (!first
->enabled_p
25334 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25337 /* Find the START row. */
25339 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25342 /* A row can potentially be the START row if the range of the
25343 characters it displays intersects the range
25344 [START_CHARPOS..END_CHARPOS). */
25345 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25346 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25347 /* See the commentary in row_containing_pos, for the
25348 explanation of the complicated way to check whether
25349 some position is beyond the end of the characters
25350 displayed by a row. */
25351 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25352 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25353 && !row
->ends_at_zv_p
25354 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25355 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25356 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25357 && !row
->ends_at_zv_p
25358 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25360 /* Found a candidate row. Now make sure at least one of the
25361 glyphs it displays has a charpos from the range
25362 [START_CHARPOS..END_CHARPOS).
25364 This is not obvious because bidi reordering could make
25365 buffer positions of a row be 1,2,3,102,101,100, and if we
25366 want to highlight characters in [50..60), we don't want
25367 this row, even though [50..60) does intersect [1..103),
25368 the range of character positions given by the row's start
25369 and end positions. */
25370 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25371 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25375 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25376 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25385 /* Find the END row. */
25387 /* If the last row is partially visible, start looking for END
25388 from that row, instead of starting from FIRST. */
25389 && !(row
->enabled_p
25390 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25392 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25394 struct glyph_row
*next
= row
+ 1;
25396 if (!next
->enabled_p
25397 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25398 /* The first row >= START whose range of displayed characters
25399 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25400 is the row END + 1. */
25401 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25402 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25403 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25404 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25405 && !next
->ends_at_zv_p
25406 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25407 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25408 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25409 && !next
->ends_at_zv_p
25410 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25417 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25418 but none of the characters it displays are in the range, it is
25420 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25421 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25425 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25426 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25439 /* This function sets the mouse_face_* elements of HLINFO, assuming
25440 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25441 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25442 for the overlay or run of text properties specifying the mouse
25443 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25444 before-string and after-string that must also be highlighted.
25445 COVER_STRING, if non-nil, is a display string that may cover some
25446 or all of the highlighted text. */
25449 mouse_face_from_buffer_pos (Lisp_Object window
,
25450 Mouse_HLInfo
*hlinfo
,
25451 ptrdiff_t mouse_charpos
,
25452 ptrdiff_t start_charpos
,
25453 ptrdiff_t end_charpos
,
25454 Lisp_Object before_string
,
25455 Lisp_Object after_string
,
25456 Lisp_Object cover_string
)
25458 struct window
*w
= XWINDOW (window
);
25459 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25460 struct glyph_row
*r1
, *r2
;
25461 struct glyph
*glyph
, *end
;
25462 ptrdiff_t ignore
, pos
;
25465 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25466 xassert (NILP (before_string
) || STRINGP (before_string
));
25467 xassert (NILP (after_string
) || STRINGP (after_string
));
25469 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25470 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25472 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25473 /* If the before-string or display-string contains newlines,
25474 rows_from_pos_range skips to its last row. Move back. */
25475 if (!NILP (before_string
) || !NILP (cover_string
))
25477 struct glyph_row
*prev
;
25478 while ((prev
= r1
- 1, prev
>= first
)
25479 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25480 && prev
->used
[TEXT_AREA
] > 0)
25482 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25483 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25484 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25486 || !(EQ (glyph
->object
, before_string
)
25487 || EQ (glyph
->object
, cover_string
)))
25494 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25495 hlinfo
->mouse_face_past_end
= 1;
25497 else if (!NILP (after_string
))
25499 /* If the after-string has newlines, advance to its last row. */
25500 struct glyph_row
*next
;
25501 struct glyph_row
*last
25502 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25504 for (next
= r2
+ 1;
25506 && next
->used
[TEXT_AREA
] > 0
25507 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25511 /* The rest of the display engine assumes that mouse_face_beg_row is
25512 either above below mouse_face_end_row or identical to it. But
25513 with bidi-reordered continued lines, the row for START_CHARPOS
25514 could be below the row for END_CHARPOS. If so, swap the rows and
25515 store them in correct order. */
25518 struct glyph_row
*tem
= r2
;
25524 hlinfo
->mouse_face_beg_y
= r1
->y
;
25525 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25526 hlinfo
->mouse_face_end_y
= r2
->y
;
25527 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25529 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25530 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25531 could be anywhere in the row and in any order. The strategy
25532 below is to find the leftmost and the rightmost glyph that
25533 belongs to either of these 3 strings, or whose position is
25534 between START_CHARPOS and END_CHARPOS, and highlight all the
25535 glyphs between those two. This may cover more than just the text
25536 between START_CHARPOS and END_CHARPOS if the range of characters
25537 strides the bidi level boundary, e.g. if the beginning is in R2L
25538 text while the end is in L2R text or vice versa. */
25539 if (!r1
->reversed_p
)
25541 /* This row is in a left to right paragraph. Scan it left to
25543 glyph
= r1
->glyphs
[TEXT_AREA
];
25544 end
= glyph
+ r1
->used
[TEXT_AREA
];
25547 /* Skip truncation glyphs at the start of the glyph row. */
25548 if (r1
->displays_text_p
)
25550 && INTEGERP (glyph
->object
)
25551 && glyph
->charpos
< 0;
25553 x
+= glyph
->pixel_width
;
25555 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25556 or COVER_STRING, and the first glyph from buffer whose
25557 position is between START_CHARPOS and END_CHARPOS. */
25559 && !INTEGERP (glyph
->object
)
25560 && !EQ (glyph
->object
, cover_string
)
25561 && !(BUFFERP (glyph
->object
)
25562 && (glyph
->charpos
>= start_charpos
25563 && glyph
->charpos
< end_charpos
));
25566 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25567 are present at buffer positions between START_CHARPOS and
25568 END_CHARPOS, or if they come from an overlay. */
25569 if (EQ (glyph
->object
, before_string
))
25571 pos
= string_buffer_position (before_string
,
25573 /* If pos == 0, it means before_string came from an
25574 overlay, not from a buffer position. */
25575 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25578 else if (EQ (glyph
->object
, after_string
))
25580 pos
= string_buffer_position (after_string
, end_charpos
);
25581 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25584 x
+= glyph
->pixel_width
;
25586 hlinfo
->mouse_face_beg_x
= x
;
25587 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25591 /* This row is in a right to left paragraph. Scan it right to
25595 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25596 glyph
= end
+ r1
->used
[TEXT_AREA
];
25598 /* Skip truncation glyphs at the start of the glyph row. */
25599 if (r1
->displays_text_p
)
25601 && INTEGERP (glyph
->object
)
25602 && glyph
->charpos
< 0;
25606 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25607 or COVER_STRING, and the first glyph from buffer whose
25608 position is between START_CHARPOS and END_CHARPOS. */
25610 && !INTEGERP (glyph
->object
)
25611 && !EQ (glyph
->object
, cover_string
)
25612 && !(BUFFERP (glyph
->object
)
25613 && (glyph
->charpos
>= start_charpos
25614 && glyph
->charpos
< end_charpos
));
25617 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25618 are present at buffer positions between START_CHARPOS and
25619 END_CHARPOS, or if they come from an overlay. */
25620 if (EQ (glyph
->object
, before_string
))
25622 pos
= string_buffer_position (before_string
, start_charpos
);
25623 /* If pos == 0, it means before_string came from an
25624 overlay, not from a buffer position. */
25625 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25628 else if (EQ (glyph
->object
, after_string
))
25630 pos
= string_buffer_position (after_string
, end_charpos
);
25631 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25636 glyph
++; /* first glyph to the right of the highlighted area */
25637 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25638 x
+= g
->pixel_width
;
25639 hlinfo
->mouse_face_beg_x
= x
;
25640 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25643 /* If the highlight ends in a different row, compute GLYPH and END
25644 for the end row. Otherwise, reuse the values computed above for
25645 the row where the highlight begins. */
25648 if (!r2
->reversed_p
)
25650 glyph
= r2
->glyphs
[TEXT_AREA
];
25651 end
= glyph
+ r2
->used
[TEXT_AREA
];
25656 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25657 glyph
= end
+ r2
->used
[TEXT_AREA
];
25661 if (!r2
->reversed_p
)
25663 /* Skip truncation and continuation glyphs near the end of the
25664 row, and also blanks and stretch glyphs inserted by
25665 extend_face_to_end_of_line. */
25667 && INTEGERP ((end
- 1)->object
)
25668 && (end
- 1)->charpos
<= 0)
25670 /* Scan the rest of the glyph row from the end, looking for the
25671 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25672 COVER_STRING, or whose position is between START_CHARPOS
25676 && !INTEGERP (end
->object
)
25677 && !EQ (end
->object
, cover_string
)
25678 && !(BUFFERP (end
->object
)
25679 && (end
->charpos
>= start_charpos
25680 && end
->charpos
< end_charpos
));
25683 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25684 are present at buffer positions between START_CHARPOS and
25685 END_CHARPOS, or if they come from an overlay. */
25686 if (EQ (end
->object
, before_string
))
25688 pos
= string_buffer_position (before_string
, start_charpos
);
25689 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25692 else if (EQ (end
->object
, after_string
))
25694 pos
= string_buffer_position (after_string
, end_charpos
);
25695 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25699 /* Find the X coordinate of the last glyph to be highlighted. */
25700 for (; glyph
<= end
; ++glyph
)
25701 x
+= glyph
->pixel_width
;
25703 hlinfo
->mouse_face_end_x
= x
;
25704 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25708 /* Skip truncation and continuation glyphs near the end of the
25709 row, and also blanks and stretch glyphs inserted by
25710 extend_face_to_end_of_line. */
25714 && INTEGERP (end
->object
)
25715 && end
->charpos
<= 0)
25717 x
+= end
->pixel_width
;
25720 /* Scan the rest of the glyph row from the end, looking for the
25721 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25722 COVER_STRING, or whose position is between START_CHARPOS
25726 && !INTEGERP (end
->object
)
25727 && !EQ (end
->object
, cover_string
)
25728 && !(BUFFERP (end
->object
)
25729 && (end
->charpos
>= start_charpos
25730 && end
->charpos
< end_charpos
));
25733 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25734 are present at buffer positions between START_CHARPOS and
25735 END_CHARPOS, or if they come from an overlay. */
25736 if (EQ (end
->object
, before_string
))
25738 pos
= string_buffer_position (before_string
, start_charpos
);
25739 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25742 else if (EQ (end
->object
, after_string
))
25744 pos
= string_buffer_position (after_string
, end_charpos
);
25745 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25748 x
+= end
->pixel_width
;
25750 hlinfo
->mouse_face_end_x
= x
;
25751 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25754 hlinfo
->mouse_face_window
= window
;
25755 hlinfo
->mouse_face_face_id
25756 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25758 !hlinfo
->mouse_face_hidden
, -1);
25759 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25762 /* The following function is not used anymore (replaced with
25763 mouse_face_from_string_pos), but I leave it here for the time
25764 being, in case someone would. */
25766 #if 0 /* not used */
25768 /* Find the position of the glyph for position POS in OBJECT in
25769 window W's current matrix, and return in *X, *Y the pixel
25770 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25772 RIGHT_P non-zero means return the position of the right edge of the
25773 glyph, RIGHT_P zero means return the left edge position.
25775 If no glyph for POS exists in the matrix, return the position of
25776 the glyph with the next smaller position that is in the matrix, if
25777 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25778 exists in the matrix, return the position of the glyph with the
25779 next larger position in OBJECT.
25781 Value is non-zero if a glyph was found. */
25784 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
25785 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25787 int yb
= window_text_bottom_y (w
);
25788 struct glyph_row
*r
;
25789 struct glyph
*best_glyph
= NULL
;
25790 struct glyph_row
*best_row
= NULL
;
25793 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25794 r
->enabled_p
&& r
->y
< yb
;
25797 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25798 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25801 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25802 if (EQ (g
->object
, object
))
25804 if (g
->charpos
== pos
)
25811 else if (best_glyph
== NULL
25812 || ((eabs (g
->charpos
- pos
)
25813 < eabs (best_glyph
->charpos
- pos
))
25816 : g
->charpos
> pos
)))
25830 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25834 *x
+= best_glyph
->pixel_width
;
25839 *vpos
= best_row
- w
->current_matrix
->rows
;
25842 return best_glyph
!= NULL
;
25844 #endif /* not used */
25846 /* Find the positions of the first and the last glyphs in window W's
25847 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25848 (assumed to be a string), and return in HLINFO's mouse_face_*
25849 members the pixel and column/row coordinates of those glyphs. */
25852 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25853 Lisp_Object object
,
25854 ptrdiff_t startpos
, ptrdiff_t endpos
)
25856 int yb
= window_text_bottom_y (w
);
25857 struct glyph_row
*r
;
25858 struct glyph
*g
, *e
;
25862 /* Find the glyph row with at least one position in the range
25863 [STARTPOS..ENDPOS], and the first glyph in that row whose
25864 position belongs to that range. */
25865 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25866 r
->enabled_p
&& r
->y
< yb
;
25869 if (!r
->reversed_p
)
25871 g
= r
->glyphs
[TEXT_AREA
];
25872 e
= g
+ r
->used
[TEXT_AREA
];
25873 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25874 if (EQ (g
->object
, object
)
25875 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25877 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25878 hlinfo
->mouse_face_beg_y
= r
->y
;
25879 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25880 hlinfo
->mouse_face_beg_x
= gx
;
25889 e
= r
->glyphs
[TEXT_AREA
];
25890 g
= e
+ r
->used
[TEXT_AREA
];
25891 for ( ; g
> e
; --g
)
25892 if (EQ ((g
-1)->object
, object
)
25893 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25895 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25896 hlinfo
->mouse_face_beg_y
= r
->y
;
25897 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25898 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25899 gx
+= g1
->pixel_width
;
25900 hlinfo
->mouse_face_beg_x
= gx
;
25912 /* Starting with the next row, look for the first row which does NOT
25913 include any glyphs whose positions are in the range. */
25914 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25916 g
= r
->glyphs
[TEXT_AREA
];
25917 e
= g
+ r
->used
[TEXT_AREA
];
25919 for ( ; g
< e
; ++g
)
25920 if (EQ (g
->object
, object
)
25921 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25930 /* The highlighted region ends on the previous row. */
25933 /* Set the end row and its vertical pixel coordinate. */
25934 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25935 hlinfo
->mouse_face_end_y
= r
->y
;
25937 /* Compute and set the end column and the end column's horizontal
25938 pixel coordinate. */
25939 if (!r
->reversed_p
)
25941 g
= r
->glyphs
[TEXT_AREA
];
25942 e
= g
+ r
->used
[TEXT_AREA
];
25943 for ( ; e
> g
; --e
)
25944 if (EQ ((e
-1)->object
, object
)
25945 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25947 hlinfo
->mouse_face_end_col
= e
- g
;
25949 for (gx
= r
->x
; g
< e
; ++g
)
25950 gx
+= g
->pixel_width
;
25951 hlinfo
->mouse_face_end_x
= gx
;
25955 e
= r
->glyphs
[TEXT_AREA
];
25956 g
= e
+ r
->used
[TEXT_AREA
];
25957 for (gx
= r
->x
; e
< g
; ++e
)
25959 if (EQ (e
->object
, object
)
25960 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25962 gx
+= e
->pixel_width
;
25964 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25965 hlinfo
->mouse_face_end_x
= gx
;
25969 #ifdef HAVE_WINDOW_SYSTEM
25971 /* See if position X, Y is within a hot-spot of an image. */
25974 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25976 if (!CONSP (hot_spot
))
25979 if (EQ (XCAR (hot_spot
), Qrect
))
25981 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25982 Lisp_Object rect
= XCDR (hot_spot
);
25986 if (!CONSP (XCAR (rect
)))
25988 if (!CONSP (XCDR (rect
)))
25990 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25992 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25994 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25996 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26000 else if (EQ (XCAR (hot_spot
), Qcircle
))
26002 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26003 Lisp_Object circ
= XCDR (hot_spot
);
26004 Lisp_Object lr
, lx0
, ly0
;
26006 && CONSP (XCAR (circ
))
26007 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26008 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26009 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26011 double r
= XFLOATINT (lr
);
26012 double dx
= XINT (lx0
) - x
;
26013 double dy
= XINT (ly0
) - y
;
26014 return (dx
* dx
+ dy
* dy
<= r
* r
);
26017 else if (EQ (XCAR (hot_spot
), Qpoly
))
26019 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26020 if (VECTORP (XCDR (hot_spot
)))
26022 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26023 Lisp_Object
*poly
= v
->contents
;
26024 ptrdiff_t n
= v
->header
.size
;
26027 Lisp_Object lx
, ly
;
26030 /* Need an even number of coordinates, and at least 3 edges. */
26031 if (n
< 6 || n
& 1)
26034 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26035 If count is odd, we are inside polygon. Pixels on edges
26036 may or may not be included depending on actual geometry of the
26038 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26039 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26041 x0
= XINT (lx
), y0
= XINT (ly
);
26042 for (i
= 0; i
< n
; i
+= 2)
26044 int x1
= x0
, y1
= y0
;
26045 if ((lx
= poly
[i
], !INTEGERP (lx
))
26046 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26048 x0
= XINT (lx
), y0
= XINT (ly
);
26050 /* Does this segment cross the X line? */
26058 if (y
> y0
&& y
> y1
)
26060 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26070 find_hot_spot (Lisp_Object map
, int x
, int y
)
26072 while (CONSP (map
))
26074 if (CONSP (XCAR (map
))
26075 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26083 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26085 doc
: /* Lookup in image map MAP coordinates X and Y.
26086 An image map is an alist where each element has the format (AREA ID PLIST).
26087 An AREA is specified as either a rectangle, a circle, or a polygon:
26088 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26089 pixel coordinates of the upper left and bottom right corners.
26090 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26091 and the radius of the circle; r may be a float or integer.
26092 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26093 vector describes one corner in the polygon.
26094 Returns the alist element for the first matching AREA in MAP. */)
26095 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26103 return find_hot_spot (map
,
26104 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
26105 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
26109 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26111 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26113 /* Do not change cursor shape while dragging mouse. */
26114 if (!NILP (do_mouse_tracking
))
26117 if (!NILP (pointer
))
26119 if (EQ (pointer
, Qarrow
))
26120 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26121 else if (EQ (pointer
, Qhand
))
26122 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26123 else if (EQ (pointer
, Qtext
))
26124 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26125 else if (EQ (pointer
, intern ("hdrag")))
26126 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26127 #ifdef HAVE_X_WINDOWS
26128 else if (EQ (pointer
, intern ("vdrag")))
26129 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26131 else if (EQ (pointer
, intern ("hourglass")))
26132 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26133 else if (EQ (pointer
, Qmodeline
))
26134 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26136 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26139 if (cursor
!= No_Cursor
)
26140 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26143 #endif /* HAVE_WINDOW_SYSTEM */
26145 /* Take proper action when mouse has moved to the mode or header line
26146 or marginal area AREA of window W, x-position X and y-position Y.
26147 X is relative to the start of the text display area of W, so the
26148 width of bitmap areas and scroll bars must be subtracted to get a
26149 position relative to the start of the mode line. */
26152 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26153 enum window_part area
)
26155 struct window
*w
= XWINDOW (window
);
26156 struct frame
*f
= XFRAME (w
->frame
);
26157 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26158 #ifdef HAVE_WINDOW_SYSTEM
26159 Display_Info
*dpyinfo
;
26161 Cursor cursor
= No_Cursor
;
26162 Lisp_Object pointer
= Qnil
;
26163 int dx
, dy
, width
, height
;
26165 Lisp_Object string
, object
= Qnil
;
26166 Lisp_Object pos
, help
;
26168 Lisp_Object mouse_face
;
26169 int original_x_pixel
= x
;
26170 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26171 struct glyph_row
*row
;
26173 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26178 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26179 returns them in row/column units! */
26180 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26181 &object
, &dx
, &dy
, &width
, &height
);
26183 row
= (area
== ON_MODE_LINE
26184 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26185 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26187 /* Find the glyph under the mouse pointer. */
26188 if (row
->mode_line_p
&& row
->enabled_p
)
26190 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26191 end
= glyph
+ row
->used
[TEXT_AREA
];
26193 for (x0
= original_x_pixel
;
26194 glyph
< end
&& x0
>= glyph
->pixel_width
;
26196 x0
-= glyph
->pixel_width
;
26204 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26205 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26206 returns them in row/column units! */
26207 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26208 &object
, &dx
, &dy
, &width
, &height
);
26213 #ifdef HAVE_WINDOW_SYSTEM
26214 if (IMAGEP (object
))
26216 Lisp_Object image_map
, hotspot
;
26217 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26219 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26221 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26225 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26226 If so, we could look for mouse-enter, mouse-leave
26227 properties in PLIST (and do something...). */
26228 hotspot
= XCDR (hotspot
);
26229 if (CONSP (hotspot
)
26230 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26232 pointer
= Fplist_get (plist
, Qpointer
);
26233 if (NILP (pointer
))
26235 help
= Fplist_get (plist
, Qhelp_echo
);
26238 help_echo_string
= help
;
26239 /* Is this correct? ++kfs */
26240 XSETWINDOW (help_echo_window
, w
);
26241 help_echo_object
= w
->buffer
;
26242 help_echo_pos
= charpos
;
26246 if (NILP (pointer
))
26247 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26249 #endif /* HAVE_WINDOW_SYSTEM */
26251 if (STRINGP (string
))
26253 pos
= make_number (charpos
);
26254 /* If we're on a string with `help-echo' text property, arrange
26255 for the help to be displayed. This is done by setting the
26256 global variable help_echo_string to the help string. */
26259 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26262 help_echo_string
= help
;
26263 XSETWINDOW (help_echo_window
, w
);
26264 help_echo_object
= string
;
26265 help_echo_pos
= charpos
;
26269 #ifdef HAVE_WINDOW_SYSTEM
26270 if (FRAME_WINDOW_P (f
))
26272 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26273 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26274 if (NILP (pointer
))
26275 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26277 /* Change the mouse pointer according to what is under X/Y. */
26279 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26282 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26283 if (!KEYMAPP (map
))
26284 map
= Fget_text_property (pos
, Qkeymap
, string
);
26285 if (!KEYMAPP (map
))
26286 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26291 /* Change the mouse face according to what is under X/Y. */
26292 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26293 if (!NILP (mouse_face
)
26294 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26299 struct glyph
* tmp_glyph
;
26303 int total_pixel_width
;
26304 ptrdiff_t begpos
, endpos
, ignore
;
26308 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26309 Qmouse_face
, string
, Qnil
);
26315 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26317 endpos
= SCHARS (string
);
26321 /* Calculate the glyph position GPOS of GLYPH in the
26322 displayed string, relative to the beginning of the
26323 highlighted part of the string.
26325 Note: GPOS is different from CHARPOS. CHARPOS is the
26326 position of GLYPH in the internal string object. A mode
26327 line string format has structures which are converted to
26328 a flattened string by the Emacs Lisp interpreter. The
26329 internal string is an element of those structures. The
26330 displayed string is the flattened string. */
26331 tmp_glyph
= row_start_glyph
;
26332 while (tmp_glyph
< glyph
26333 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26334 && begpos
<= tmp_glyph
->charpos
26335 && tmp_glyph
->charpos
< endpos
)))
26337 gpos
= glyph
- tmp_glyph
;
26339 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26340 the highlighted part of the displayed string to which
26341 GLYPH belongs. Note: GSEQ_LENGTH is different from
26342 SCHARS (STRING), because the latter returns the length of
26343 the internal string. */
26344 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26346 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26347 && begpos
<= tmp_glyph
->charpos
26348 && tmp_glyph
->charpos
< endpos
));
26351 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26353 /* Calculate the total pixel width of all the glyphs between
26354 the beginning of the highlighted area and GLYPH. */
26355 total_pixel_width
= 0;
26356 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26357 total_pixel_width
+= tmp_glyph
->pixel_width
;
26359 /* Pre calculation of re-rendering position. Note: X is in
26360 column units here, after the call to mode_line_string or
26361 marginal_area_string. */
26363 vpos
= (area
== ON_MODE_LINE
26364 ? (w
->current_matrix
)->nrows
- 1
26367 /* If GLYPH's position is included in the region that is
26368 already drawn in mouse face, we have nothing to do. */
26369 if ( EQ (window
, hlinfo
->mouse_face_window
)
26370 && (!row
->reversed_p
26371 ? (hlinfo
->mouse_face_beg_col
<= hpos
26372 && hpos
< hlinfo
->mouse_face_end_col
)
26373 /* In R2L rows we swap BEG and END, see below. */
26374 : (hlinfo
->mouse_face_end_col
<= hpos
26375 && hpos
< hlinfo
->mouse_face_beg_col
))
26376 && hlinfo
->mouse_face_beg_row
== vpos
)
26379 if (clear_mouse_face (hlinfo
))
26380 cursor
= No_Cursor
;
26382 if (!row
->reversed_p
)
26384 hlinfo
->mouse_face_beg_col
= hpos
;
26385 hlinfo
->mouse_face_beg_x
= original_x_pixel
26386 - (total_pixel_width
+ dx
);
26387 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26388 hlinfo
->mouse_face_end_x
= 0;
26392 /* In R2L rows, show_mouse_face expects BEG and END
26393 coordinates to be swapped. */
26394 hlinfo
->mouse_face_end_col
= hpos
;
26395 hlinfo
->mouse_face_end_x
= original_x_pixel
26396 - (total_pixel_width
+ dx
);
26397 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26398 hlinfo
->mouse_face_beg_x
= 0;
26401 hlinfo
->mouse_face_beg_row
= vpos
;
26402 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26403 hlinfo
->mouse_face_beg_y
= 0;
26404 hlinfo
->mouse_face_end_y
= 0;
26405 hlinfo
->mouse_face_past_end
= 0;
26406 hlinfo
->mouse_face_window
= window
;
26408 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26414 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26416 if (NILP (pointer
))
26419 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26420 clear_mouse_face (hlinfo
);
26422 #ifdef HAVE_WINDOW_SYSTEM
26423 if (FRAME_WINDOW_P (f
))
26424 define_frame_cursor1 (f
, cursor
, pointer
);
26430 Take proper action when the mouse has moved to position X, Y on
26431 frame F as regards highlighting characters that have mouse-face
26432 properties. Also de-highlighting chars where the mouse was before.
26433 X and Y can be negative or out of range. */
26436 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26438 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26439 enum window_part part
;
26440 Lisp_Object window
;
26442 Cursor cursor
= No_Cursor
;
26443 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26446 /* When a menu is active, don't highlight because this looks odd. */
26447 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26448 if (popup_activated ())
26452 if (NILP (Vmouse_highlight
)
26453 || !f
->glyphs_initialized_p
26454 || f
->pointer_invisible
)
26457 hlinfo
->mouse_face_mouse_x
= x
;
26458 hlinfo
->mouse_face_mouse_y
= y
;
26459 hlinfo
->mouse_face_mouse_frame
= f
;
26461 if (hlinfo
->mouse_face_defer
)
26464 if (gc_in_progress
)
26466 hlinfo
->mouse_face_deferred_gc
= 1;
26470 /* Which window is that in? */
26471 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26473 /* If we were displaying active text in another window, clear that.
26474 Also clear if we move out of text area in same window. */
26475 if (! EQ (window
, hlinfo
->mouse_face_window
)
26476 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26477 && !NILP (hlinfo
->mouse_face_window
)))
26478 clear_mouse_face (hlinfo
);
26480 /* Not on a window -> return. */
26481 if (!WINDOWP (window
))
26484 /* Reset help_echo_string. It will get recomputed below. */
26485 help_echo_string
= Qnil
;
26487 /* Convert to window-relative pixel coordinates. */
26488 w
= XWINDOW (window
);
26489 frame_to_window_pixel_xy (w
, &x
, &y
);
26491 #ifdef HAVE_WINDOW_SYSTEM
26492 /* Handle tool-bar window differently since it doesn't display a
26494 if (EQ (window
, f
->tool_bar_window
))
26496 note_tool_bar_highlight (f
, x
, y
);
26501 /* Mouse is on the mode, header line or margin? */
26502 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26503 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26505 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26509 #ifdef HAVE_WINDOW_SYSTEM
26510 if (part
== ON_VERTICAL_BORDER
)
26512 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26513 help_echo_string
= build_string ("drag-mouse-1: resize");
26515 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26516 || part
== ON_SCROLL_BAR
)
26517 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26519 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26522 /* Are we in a window whose display is up to date?
26523 And verify the buffer's text has not changed. */
26524 b
= XBUFFER (w
->buffer
);
26525 if (part
== ON_TEXT
26526 && EQ (w
->window_end_valid
, w
->buffer
)
26527 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26528 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26530 int hpos
, vpos
, dx
, dy
, area
;
26532 struct glyph
*glyph
;
26533 Lisp_Object object
;
26534 Lisp_Object mouse_face
= Qnil
, position
;
26535 Lisp_Object
*overlay_vec
= NULL
;
26536 ptrdiff_t i
, noverlays
;
26537 struct buffer
*obuf
;
26538 ptrdiff_t obegv
, ozv
;
26541 /* Find the glyph under X/Y. */
26542 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26544 #ifdef HAVE_WINDOW_SYSTEM
26545 /* Look for :pointer property on image. */
26546 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26548 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26549 if (img
!= NULL
&& IMAGEP (img
->spec
))
26551 Lisp_Object image_map
, hotspot
;
26552 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26554 && (hotspot
= find_hot_spot (image_map
,
26555 glyph
->slice
.img
.x
+ dx
,
26556 glyph
->slice
.img
.y
+ dy
),
26558 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26562 /* Could check XCAR (hotspot) to see if we enter/leave
26564 If so, we could look for mouse-enter, mouse-leave
26565 properties in PLIST (and do something...). */
26566 hotspot
= XCDR (hotspot
);
26567 if (CONSP (hotspot
)
26568 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26570 pointer
= Fplist_get (plist
, Qpointer
);
26571 if (NILP (pointer
))
26573 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26574 if (!NILP (help_echo_string
))
26576 help_echo_window
= window
;
26577 help_echo_object
= glyph
->object
;
26578 help_echo_pos
= glyph
->charpos
;
26582 if (NILP (pointer
))
26583 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26586 #endif /* HAVE_WINDOW_SYSTEM */
26588 /* Clear mouse face if X/Y not over text. */
26590 || area
!= TEXT_AREA
26591 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26592 /* Glyph's OBJECT is an integer for glyphs inserted by the
26593 display engine for its internal purposes, like truncation
26594 and continuation glyphs and blanks beyond the end of
26595 line's text on text terminals. If we are over such a
26596 glyph, we are not over any text. */
26597 || INTEGERP (glyph
->object
)
26598 /* R2L rows have a stretch glyph at their front, which
26599 stands for no text, whereas L2R rows have no glyphs at
26600 all beyond the end of text. Treat such stretch glyphs
26601 like we do with NULL glyphs in L2R rows. */
26602 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26603 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26604 && glyph
->type
== STRETCH_GLYPH
26605 && glyph
->avoid_cursor_p
))
26607 if (clear_mouse_face (hlinfo
))
26608 cursor
= No_Cursor
;
26609 #ifdef HAVE_WINDOW_SYSTEM
26610 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26612 if (area
!= TEXT_AREA
)
26613 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26615 pointer
= Vvoid_text_area_pointer
;
26621 pos
= glyph
->charpos
;
26622 object
= glyph
->object
;
26623 if (!STRINGP (object
) && !BUFFERP (object
))
26626 /* If we get an out-of-range value, return now; avoid an error. */
26627 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26630 /* Make the window's buffer temporarily current for
26631 overlays_at and compute_char_face. */
26632 obuf
= current_buffer
;
26633 current_buffer
= b
;
26639 /* Is this char mouse-active or does it have help-echo? */
26640 position
= make_number (pos
);
26642 if (BUFFERP (object
))
26644 /* Put all the overlays we want in a vector in overlay_vec. */
26645 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26646 /* Sort overlays into increasing priority order. */
26647 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26652 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26655 cursor
= No_Cursor
;
26657 /* Check mouse-face highlighting. */
26659 /* If there exists an overlay with mouse-face overlapping
26660 the one we are currently highlighting, we have to
26661 check if we enter the overlapping overlay, and then
26662 highlight only that. */
26663 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26664 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26666 /* Find the highest priority overlay with a mouse-face. */
26667 Lisp_Object overlay
= Qnil
;
26668 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26670 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26671 if (!NILP (mouse_face
))
26672 overlay
= overlay_vec
[i
];
26675 /* If we're highlighting the same overlay as before, there's
26676 no need to do that again. */
26677 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26678 goto check_help_echo
;
26679 hlinfo
->mouse_face_overlay
= overlay
;
26681 /* Clear the display of the old active region, if any. */
26682 if (clear_mouse_face (hlinfo
))
26683 cursor
= No_Cursor
;
26685 /* If no overlay applies, get a text property. */
26686 if (NILP (overlay
))
26687 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26689 /* Next, compute the bounds of the mouse highlighting and
26691 if (!NILP (mouse_face
) && STRINGP (object
))
26693 /* The mouse-highlighting comes from a display string
26694 with a mouse-face. */
26698 s
= Fprevious_single_property_change
26699 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26700 e
= Fnext_single_property_change
26701 (position
, Qmouse_face
, object
, Qnil
);
26703 s
= make_number (0);
26705 e
= make_number (SCHARS (object
) - 1);
26706 mouse_face_from_string_pos (w
, hlinfo
, object
,
26707 XINT (s
), XINT (e
));
26708 hlinfo
->mouse_face_past_end
= 0;
26709 hlinfo
->mouse_face_window
= window
;
26710 hlinfo
->mouse_face_face_id
26711 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26712 glyph
->face_id
, 1);
26713 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26714 cursor
= No_Cursor
;
26718 /* The mouse-highlighting, if any, comes from an overlay
26719 or text property in the buffer. */
26720 Lisp_Object buffer
IF_LINT (= Qnil
);
26721 Lisp_Object cover_string
IF_LINT (= Qnil
);
26723 if (STRINGP (object
))
26725 /* If we are on a display string with no mouse-face,
26726 check if the text under it has one. */
26727 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26728 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
26729 pos
= string_buffer_position (object
, start
);
26732 mouse_face
= get_char_property_and_overlay
26733 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26734 buffer
= w
->buffer
;
26735 cover_string
= object
;
26741 cover_string
= Qnil
;
26744 if (!NILP (mouse_face
))
26746 Lisp_Object before
, after
;
26747 Lisp_Object before_string
, after_string
;
26748 /* To correctly find the limits of mouse highlight
26749 in a bidi-reordered buffer, we must not use the
26750 optimization of limiting the search in
26751 previous-single-property-change and
26752 next-single-property-change, because
26753 rows_from_pos_range needs the real start and end
26754 positions to DTRT in this case. That's because
26755 the first row visible in a window does not
26756 necessarily display the character whose position
26757 is the smallest. */
26759 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26760 ? Fmarker_position (w
->start
)
26763 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26764 ? make_number (BUF_Z (XBUFFER (buffer
))
26765 - XFASTINT (w
->window_end_pos
))
26768 if (NILP (overlay
))
26770 /* Handle the text property case. */
26771 before
= Fprevious_single_property_change
26772 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26773 after
= Fnext_single_property_change
26774 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26775 before_string
= after_string
= Qnil
;
26779 /* Handle the overlay case. */
26780 before
= Foverlay_start (overlay
);
26781 after
= Foverlay_end (overlay
);
26782 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26783 after_string
= Foverlay_get (overlay
, Qafter_string
);
26785 if (!STRINGP (before_string
)) before_string
= Qnil
;
26786 if (!STRINGP (after_string
)) after_string
= Qnil
;
26789 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26792 before_string
, after_string
,
26794 cursor
= No_Cursor
;
26801 /* Look for a `help-echo' property. */
26802 if (NILP (help_echo_string
)) {
26803 Lisp_Object help
, overlay
;
26805 /* Check overlays first. */
26806 help
= overlay
= Qnil
;
26807 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26809 overlay
= overlay_vec
[i
];
26810 help
= Foverlay_get (overlay
, Qhelp_echo
);
26815 help_echo_string
= help
;
26816 help_echo_window
= window
;
26817 help_echo_object
= overlay
;
26818 help_echo_pos
= pos
;
26822 Lisp_Object obj
= glyph
->object
;
26823 ptrdiff_t charpos
= glyph
->charpos
;
26825 /* Try text properties. */
26828 && charpos
< SCHARS (obj
))
26830 help
= Fget_text_property (make_number (charpos
),
26834 /* If the string itself doesn't specify a help-echo,
26835 see if the buffer text ``under'' it does. */
26836 struct glyph_row
*r
26837 = MATRIX_ROW (w
->current_matrix
, vpos
);
26838 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
26839 ptrdiff_t p
= string_buffer_position (obj
, start
);
26842 help
= Fget_char_property (make_number (p
),
26843 Qhelp_echo
, w
->buffer
);
26852 else if (BUFFERP (obj
)
26855 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26860 help_echo_string
= help
;
26861 help_echo_window
= window
;
26862 help_echo_object
= obj
;
26863 help_echo_pos
= charpos
;
26868 #ifdef HAVE_WINDOW_SYSTEM
26869 /* Look for a `pointer' property. */
26870 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26872 /* Check overlays first. */
26873 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26874 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26876 if (NILP (pointer
))
26878 Lisp_Object obj
= glyph
->object
;
26879 ptrdiff_t charpos
= glyph
->charpos
;
26881 /* Try text properties. */
26884 && charpos
< SCHARS (obj
))
26886 pointer
= Fget_text_property (make_number (charpos
),
26888 if (NILP (pointer
))
26890 /* If the string itself doesn't specify a pointer,
26891 see if the buffer text ``under'' it does. */
26892 struct glyph_row
*r
26893 = MATRIX_ROW (w
->current_matrix
, vpos
);
26894 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
26895 ptrdiff_t p
= string_buffer_position (obj
, start
);
26897 pointer
= Fget_char_property (make_number (p
),
26898 Qpointer
, w
->buffer
);
26901 else if (BUFFERP (obj
)
26904 pointer
= Fget_text_property (make_number (charpos
),
26908 #endif /* HAVE_WINDOW_SYSTEM */
26912 current_buffer
= obuf
;
26917 #ifdef HAVE_WINDOW_SYSTEM
26918 if (FRAME_WINDOW_P (f
))
26919 define_frame_cursor1 (f
, cursor
, pointer
);
26921 /* This is here to prevent a compiler error, about "label at end of
26922 compound statement". */
26929 Clear any mouse-face on window W. This function is part of the
26930 redisplay interface, and is called from try_window_id and similar
26931 functions to ensure the mouse-highlight is off. */
26934 x_clear_window_mouse_face (struct window
*w
)
26936 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26937 Lisp_Object window
;
26940 XSETWINDOW (window
, w
);
26941 if (EQ (window
, hlinfo
->mouse_face_window
))
26942 clear_mouse_face (hlinfo
);
26948 Just discard the mouse face information for frame F, if any.
26949 This is used when the size of F is changed. */
26952 cancel_mouse_face (struct frame
*f
)
26954 Lisp_Object window
;
26955 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26957 window
= hlinfo
->mouse_face_window
;
26958 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26960 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26961 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26962 hlinfo
->mouse_face_window
= Qnil
;
26968 /***********************************************************************
26970 ***********************************************************************/
26972 #ifdef HAVE_WINDOW_SYSTEM
26974 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26975 which intersects rectangle R. R is in window-relative coordinates. */
26978 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26979 enum glyph_row_area area
)
26981 struct glyph
*first
= row
->glyphs
[area
];
26982 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26983 struct glyph
*last
;
26984 int first_x
, start_x
, x
;
26986 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26987 /* If row extends face to end of line write the whole line. */
26988 draw_glyphs (w
, 0, row
, area
,
26989 0, row
->used
[area
],
26990 DRAW_NORMAL_TEXT
, 0);
26993 /* Set START_X to the window-relative start position for drawing glyphs of
26994 AREA. The first glyph of the text area can be partially visible.
26995 The first glyphs of other areas cannot. */
26996 start_x
= window_box_left_offset (w
, area
);
26998 if (area
== TEXT_AREA
)
27001 /* Find the first glyph that must be redrawn. */
27003 && x
+ first
->pixel_width
< r
->x
)
27005 x
+= first
->pixel_width
;
27009 /* Find the last one. */
27013 && x
< r
->x
+ r
->width
)
27015 x
+= last
->pixel_width
;
27021 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27022 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27023 DRAW_NORMAL_TEXT
, 0);
27028 /* Redraw the parts of the glyph row ROW on window W intersecting
27029 rectangle R. R is in window-relative coordinates. Value is
27030 non-zero if mouse-face was overwritten. */
27033 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27035 xassert (row
->enabled_p
);
27037 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27038 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27039 0, row
->used
[TEXT_AREA
],
27040 DRAW_NORMAL_TEXT
, 0);
27043 if (row
->used
[LEFT_MARGIN_AREA
])
27044 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27045 if (row
->used
[TEXT_AREA
])
27046 expose_area (w
, row
, r
, TEXT_AREA
);
27047 if (row
->used
[RIGHT_MARGIN_AREA
])
27048 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27049 draw_row_fringe_bitmaps (w
, row
);
27052 return row
->mouse_face_p
;
27056 /* Redraw those parts of glyphs rows during expose event handling that
27057 overlap other rows. Redrawing of an exposed line writes over parts
27058 of lines overlapping that exposed line; this function fixes that.
27060 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27061 row in W's current matrix that is exposed and overlaps other rows.
27062 LAST_OVERLAPPING_ROW is the last such row. */
27065 expose_overlaps (struct window
*w
,
27066 struct glyph_row
*first_overlapping_row
,
27067 struct glyph_row
*last_overlapping_row
,
27070 struct glyph_row
*row
;
27072 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27073 if (row
->overlapping_p
)
27075 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27078 if (row
->used
[LEFT_MARGIN_AREA
])
27079 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27081 if (row
->used
[TEXT_AREA
])
27082 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27084 if (row
->used
[RIGHT_MARGIN_AREA
])
27085 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27091 /* Return non-zero if W's cursor intersects rectangle R. */
27094 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27096 XRectangle cr
, result
;
27097 struct glyph
*cursor_glyph
;
27098 struct glyph_row
*row
;
27100 if (w
->phys_cursor
.vpos
>= 0
27101 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27102 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27104 && row
->cursor_in_fringe_p
)
27106 /* Cursor is in the fringe. */
27107 cr
.x
= window_box_right_offset (w
,
27108 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27109 ? RIGHT_MARGIN_AREA
27112 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27113 cr
.height
= row
->height
;
27114 return x_intersect_rectangles (&cr
, r
, &result
);
27117 cursor_glyph
= get_phys_cursor_glyph (w
);
27120 /* r is relative to W's box, but w->phys_cursor.x is relative
27121 to left edge of W's TEXT area. Adjust it. */
27122 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27123 cr
.y
= w
->phys_cursor
.y
;
27124 cr
.width
= cursor_glyph
->pixel_width
;
27125 cr
.height
= w
->phys_cursor_height
;
27126 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27127 I assume the effect is the same -- and this is portable. */
27128 return x_intersect_rectangles (&cr
, r
, &result
);
27130 /* If we don't understand the format, pretend we're not in the hot-spot. */
27136 Draw a vertical window border to the right of window W if W doesn't
27137 have vertical scroll bars. */
27140 x_draw_vertical_border (struct window
*w
)
27142 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27144 /* We could do better, if we knew what type of scroll-bar the adjacent
27145 windows (on either side) have... But we don't :-(
27146 However, I think this works ok. ++KFS 2003-04-25 */
27148 /* Redraw borders between horizontally adjacent windows. Don't
27149 do it for frames with vertical scroll bars because either the
27150 right scroll bar of a window, or the left scroll bar of its
27151 neighbor will suffice as a border. */
27152 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27155 if (!WINDOW_RIGHTMOST_P (w
)
27156 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27158 int x0
, x1
, y0
, y1
;
27160 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27163 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27166 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27168 else if (!WINDOW_LEFTMOST_P (w
)
27169 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27171 int x0
, x1
, y0
, y1
;
27173 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27176 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27179 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27184 /* Redraw the part of window W intersection rectangle FR. Pixel
27185 coordinates in FR are frame-relative. Call this function with
27186 input blocked. Value is non-zero if the exposure overwrites
27190 expose_window (struct window
*w
, XRectangle
*fr
)
27192 struct frame
*f
= XFRAME (w
->frame
);
27194 int mouse_face_overwritten_p
= 0;
27196 /* If window is not yet fully initialized, do nothing. This can
27197 happen when toolkit scroll bars are used and a window is split.
27198 Reconfiguring the scroll bar will generate an expose for a newly
27200 if (w
->current_matrix
== NULL
)
27203 /* When we're currently updating the window, display and current
27204 matrix usually don't agree. Arrange for a thorough display
27206 if (w
== updated_window
)
27208 SET_FRAME_GARBAGED (f
);
27212 /* Frame-relative pixel rectangle of W. */
27213 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27214 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27215 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27216 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27218 if (x_intersect_rectangles (fr
, &wr
, &r
))
27220 int yb
= window_text_bottom_y (w
);
27221 struct glyph_row
*row
;
27222 int cursor_cleared_p
;
27223 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27225 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27226 r
.x
, r
.y
, r
.width
, r
.height
));
27228 /* Convert to window coordinates. */
27229 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27230 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27232 /* Turn off the cursor. */
27233 if (!w
->pseudo_window_p
27234 && phys_cursor_in_rect_p (w
, &r
))
27236 x_clear_cursor (w
);
27237 cursor_cleared_p
= 1;
27240 cursor_cleared_p
= 0;
27242 /* Update lines intersecting rectangle R. */
27243 first_overlapping_row
= last_overlapping_row
= NULL
;
27244 for (row
= w
->current_matrix
->rows
;
27249 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27251 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27252 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27253 || (r
.y
>= y0
&& r
.y
< y1
)
27254 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27256 /* A header line may be overlapping, but there is no need
27257 to fix overlapping areas for them. KFS 2005-02-12 */
27258 if (row
->overlapping_p
&& !row
->mode_line_p
)
27260 if (first_overlapping_row
== NULL
)
27261 first_overlapping_row
= row
;
27262 last_overlapping_row
= row
;
27266 if (expose_line (w
, row
, &r
))
27267 mouse_face_overwritten_p
= 1;
27270 else if (row
->overlapping_p
)
27272 /* We must redraw a row overlapping the exposed area. */
27274 ? y0
+ row
->phys_height
> r
.y
27275 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27277 if (first_overlapping_row
== NULL
)
27278 first_overlapping_row
= row
;
27279 last_overlapping_row
= row
;
27287 /* Display the mode line if there is one. */
27288 if (WINDOW_WANTS_MODELINE_P (w
)
27289 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27291 && row
->y
< r
.y
+ r
.height
)
27293 if (expose_line (w
, row
, &r
))
27294 mouse_face_overwritten_p
= 1;
27297 if (!w
->pseudo_window_p
)
27299 /* Fix the display of overlapping rows. */
27300 if (first_overlapping_row
)
27301 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27304 /* Draw border between windows. */
27305 x_draw_vertical_border (w
);
27307 /* Turn the cursor on again. */
27308 if (cursor_cleared_p
)
27309 update_window_cursor (w
, 1);
27313 return mouse_face_overwritten_p
;
27318 /* Redraw (parts) of all windows in the window tree rooted at W that
27319 intersect R. R contains frame pixel coordinates. Value is
27320 non-zero if the exposure overwrites mouse-face. */
27323 expose_window_tree (struct window
*w
, XRectangle
*r
)
27325 struct frame
*f
= XFRAME (w
->frame
);
27326 int mouse_face_overwritten_p
= 0;
27328 while (w
&& !FRAME_GARBAGED_P (f
))
27330 if (!NILP (w
->hchild
))
27331 mouse_face_overwritten_p
27332 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27333 else if (!NILP (w
->vchild
))
27334 mouse_face_overwritten_p
27335 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27337 mouse_face_overwritten_p
|= expose_window (w
, r
);
27339 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27342 return mouse_face_overwritten_p
;
27347 Redisplay an exposed area of frame F. X and Y are the upper-left
27348 corner of the exposed rectangle. W and H are width and height of
27349 the exposed area. All are pixel values. W or H zero means redraw
27350 the entire frame. */
27353 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27356 int mouse_face_overwritten_p
= 0;
27358 TRACE ((stderr
, "expose_frame "));
27360 /* No need to redraw if frame will be redrawn soon. */
27361 if (FRAME_GARBAGED_P (f
))
27363 TRACE ((stderr
, " garbaged\n"));
27367 /* If basic faces haven't been realized yet, there is no point in
27368 trying to redraw anything. This can happen when we get an expose
27369 event while Emacs is starting, e.g. by moving another window. */
27370 if (FRAME_FACE_CACHE (f
) == NULL
27371 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27373 TRACE ((stderr
, " no faces\n"));
27377 if (w
== 0 || h
== 0)
27380 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27381 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27391 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27392 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27394 if (WINDOWP (f
->tool_bar_window
))
27395 mouse_face_overwritten_p
27396 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27398 #ifdef HAVE_X_WINDOWS
27400 #ifndef USE_X_TOOLKIT
27401 if (WINDOWP (f
->menu_bar_window
))
27402 mouse_face_overwritten_p
27403 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27404 #endif /* not USE_X_TOOLKIT */
27408 /* Some window managers support a focus-follows-mouse style with
27409 delayed raising of frames. Imagine a partially obscured frame,
27410 and moving the mouse into partially obscured mouse-face on that
27411 frame. The visible part of the mouse-face will be highlighted,
27412 then the WM raises the obscured frame. With at least one WM, KDE
27413 2.1, Emacs is not getting any event for the raising of the frame
27414 (even tried with SubstructureRedirectMask), only Expose events.
27415 These expose events will draw text normally, i.e. not
27416 highlighted. Which means we must redo the highlight here.
27417 Subsume it under ``we love X''. --gerd 2001-08-15 */
27418 /* Included in Windows version because Windows most likely does not
27419 do the right thing if any third party tool offers
27420 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27421 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27423 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27424 if (f
== hlinfo
->mouse_face_mouse_frame
)
27426 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27427 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27428 clear_mouse_face (hlinfo
);
27429 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27436 Determine the intersection of two rectangles R1 and R2. Return
27437 the intersection in *RESULT. Value is non-zero if RESULT is not
27441 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27443 XRectangle
*left
, *right
;
27444 XRectangle
*upper
, *lower
;
27445 int intersection_p
= 0;
27447 /* Rearrange so that R1 is the left-most rectangle. */
27449 left
= r1
, right
= r2
;
27451 left
= r2
, right
= r1
;
27453 /* X0 of the intersection is right.x0, if this is inside R1,
27454 otherwise there is no intersection. */
27455 if (right
->x
<= left
->x
+ left
->width
)
27457 result
->x
= right
->x
;
27459 /* The right end of the intersection is the minimum of
27460 the right ends of left and right. */
27461 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27464 /* Same game for Y. */
27466 upper
= r1
, lower
= r2
;
27468 upper
= r2
, lower
= r1
;
27470 /* The upper end of the intersection is lower.y0, if this is inside
27471 of upper. Otherwise, there is no intersection. */
27472 if (lower
->y
<= upper
->y
+ upper
->height
)
27474 result
->y
= lower
->y
;
27476 /* The lower end of the intersection is the minimum of the lower
27477 ends of upper and lower. */
27478 result
->height
= (min (lower
->y
+ lower
->height
,
27479 upper
->y
+ upper
->height
)
27481 intersection_p
= 1;
27485 return intersection_p
;
27488 #endif /* HAVE_WINDOW_SYSTEM */
27491 /***********************************************************************
27493 ***********************************************************************/
27496 syms_of_xdisp (void)
27498 Vwith_echo_area_save_vector
= Qnil
;
27499 staticpro (&Vwith_echo_area_save_vector
);
27501 Vmessage_stack
= Qnil
;
27502 staticpro (&Vmessage_stack
);
27504 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27506 message_dolog_marker1
= Fmake_marker ();
27507 staticpro (&message_dolog_marker1
);
27508 message_dolog_marker2
= Fmake_marker ();
27509 staticpro (&message_dolog_marker2
);
27510 message_dolog_marker3
= Fmake_marker ();
27511 staticpro (&message_dolog_marker3
);
27514 defsubr (&Sdump_frame_glyph_matrix
);
27515 defsubr (&Sdump_glyph_matrix
);
27516 defsubr (&Sdump_glyph_row
);
27517 defsubr (&Sdump_tool_bar_row
);
27518 defsubr (&Strace_redisplay
);
27519 defsubr (&Strace_to_stderr
);
27521 #ifdef HAVE_WINDOW_SYSTEM
27522 defsubr (&Stool_bar_lines_needed
);
27523 defsubr (&Slookup_image_map
);
27525 defsubr (&Sformat_mode_line
);
27526 defsubr (&Sinvisible_p
);
27527 defsubr (&Scurrent_bidi_paragraph_direction
);
27529 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27530 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27531 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27532 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27533 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27534 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27535 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27536 DEFSYM (Qeval
, "eval");
27537 DEFSYM (QCdata
, ":data");
27538 DEFSYM (Qdisplay
, "display");
27539 DEFSYM (Qspace_width
, "space-width");
27540 DEFSYM (Qraise
, "raise");
27541 DEFSYM (Qslice
, "slice");
27542 DEFSYM (Qspace
, "space");
27543 DEFSYM (Qmargin
, "margin");
27544 DEFSYM (Qpointer
, "pointer");
27545 DEFSYM (Qleft_margin
, "left-margin");
27546 DEFSYM (Qright_margin
, "right-margin");
27547 DEFSYM (Qcenter
, "center");
27548 DEFSYM (Qline_height
, "line-height");
27549 DEFSYM (QCalign_to
, ":align-to");
27550 DEFSYM (QCrelative_width
, ":relative-width");
27551 DEFSYM (QCrelative_height
, ":relative-height");
27552 DEFSYM (QCeval
, ":eval");
27553 DEFSYM (QCpropertize
, ":propertize");
27554 DEFSYM (QCfile
, ":file");
27555 DEFSYM (Qfontified
, "fontified");
27556 DEFSYM (Qfontification_functions
, "fontification-functions");
27557 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27558 DEFSYM (Qescape_glyph
, "escape-glyph");
27559 DEFSYM (Qnobreak_space
, "nobreak-space");
27560 DEFSYM (Qimage
, "image");
27561 DEFSYM (Qtext
, "text");
27562 DEFSYM (Qboth
, "both");
27563 DEFSYM (Qboth_horiz
, "both-horiz");
27564 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27565 DEFSYM (QCmap
, ":map");
27566 DEFSYM (QCpointer
, ":pointer");
27567 DEFSYM (Qrect
, "rect");
27568 DEFSYM (Qcircle
, "circle");
27569 DEFSYM (Qpoly
, "poly");
27570 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27571 DEFSYM (Qgrow_only
, "grow-only");
27572 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27573 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27574 DEFSYM (Qposition
, "position");
27575 DEFSYM (Qbuffer_position
, "buffer-position");
27576 DEFSYM (Qobject
, "object");
27577 DEFSYM (Qbar
, "bar");
27578 DEFSYM (Qhbar
, "hbar");
27579 DEFSYM (Qbox
, "box");
27580 DEFSYM (Qhollow
, "hollow");
27581 DEFSYM (Qhand
, "hand");
27582 DEFSYM (Qarrow
, "arrow");
27583 DEFSYM (Qtext
, "text");
27584 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27586 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27587 Fcons (intern_c_string ("void-variable"), Qnil
)),
27589 staticpro (&list_of_error
);
27591 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27592 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27593 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27594 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27596 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27597 staticpro (&echo_buffer
[0]);
27598 staticpro (&echo_buffer
[1]);
27600 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27601 staticpro (&echo_area_buffer
[0]);
27602 staticpro (&echo_area_buffer
[1]);
27604 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27605 staticpro (&Vmessages_buffer_name
);
27607 mode_line_proptrans_alist
= Qnil
;
27608 staticpro (&mode_line_proptrans_alist
);
27609 mode_line_string_list
= Qnil
;
27610 staticpro (&mode_line_string_list
);
27611 mode_line_string_face
= Qnil
;
27612 staticpro (&mode_line_string_face
);
27613 mode_line_string_face_prop
= Qnil
;
27614 staticpro (&mode_line_string_face_prop
);
27615 Vmode_line_unwind_vector
= Qnil
;
27616 staticpro (&Vmode_line_unwind_vector
);
27618 help_echo_string
= Qnil
;
27619 staticpro (&help_echo_string
);
27620 help_echo_object
= Qnil
;
27621 staticpro (&help_echo_object
);
27622 help_echo_window
= Qnil
;
27623 staticpro (&help_echo_window
);
27624 previous_help_echo_string
= Qnil
;
27625 staticpro (&previous_help_echo_string
);
27626 help_echo_pos
= -1;
27628 DEFSYM (Qright_to_left
, "right-to-left");
27629 DEFSYM (Qleft_to_right
, "left-to-right");
27631 #ifdef HAVE_WINDOW_SYSTEM
27632 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27633 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27634 For example, if a block cursor is over a tab, it will be drawn as
27635 wide as that tab on the display. */);
27636 x_stretch_cursor_p
= 0;
27639 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27640 doc
: /* *Non-nil means highlight trailing whitespace.
27641 The face used for trailing whitespace is `trailing-whitespace'. */);
27642 Vshow_trailing_whitespace
= Qnil
;
27644 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27645 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27646 A value of t means highlight the character itself (for nobreak space,
27647 use face `nobreak-space').
27648 A value of nil means no highlighting.
27649 Other values mean display the escape glyph followed by an ordinary
27650 space or ordinary hyphen. */);
27651 Vnobreak_char_display
= Qt
;
27653 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27654 doc
: /* *The pointer shape to show in void text areas.
27655 A value of nil means to show the text pointer. Other options are `arrow',
27656 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27657 Vvoid_text_area_pointer
= Qarrow
;
27659 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27660 doc
: /* Non-nil means don't actually do any redisplay.
27661 This is used for internal purposes. */);
27662 Vinhibit_redisplay
= Qnil
;
27664 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27665 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27666 Vglobal_mode_string
= Qnil
;
27668 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27669 doc
: /* Marker for where to display an arrow on top of the buffer text.
27670 This must be the beginning of a line in order to work.
27671 See also `overlay-arrow-string'. */);
27672 Voverlay_arrow_position
= Qnil
;
27674 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27675 doc
: /* String to display as an arrow in non-window frames.
27676 See also `overlay-arrow-position'. */);
27677 Voverlay_arrow_string
= make_pure_c_string ("=>");
27679 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27680 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27681 The symbols on this list are examined during redisplay to determine
27682 where to display overlay arrows. */);
27683 Voverlay_arrow_variable_list
27684 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27686 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27687 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27688 If that fails to bring point back on frame, point is centered instead.
27689 If this is zero, point is always centered after it moves off frame.
27690 If you want scrolling to always be a line at a time, you should set
27691 `scroll-conservatively' to a large value rather than set this to 1. */);
27693 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27694 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27695 If point moves off-screen, redisplay will scroll by up to
27696 `scroll-conservatively' lines in order to bring point just barely
27697 onto the screen again. If that cannot be done, then redisplay
27698 recenters point as usual.
27700 If the value is greater than 100, redisplay will never recenter point,
27701 but will always scroll just enough text to bring point into view, even
27702 if you move far away.
27704 A value of zero means always recenter point if it moves off screen. */);
27705 scroll_conservatively
= 0;
27707 DEFVAR_INT ("scroll-margin", scroll_margin
,
27708 doc
: /* *Number of lines of margin at the top and bottom of a window.
27709 Recenter the window whenever point gets within this many lines
27710 of the top or bottom of the window. */);
27713 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27714 doc
: /* Pixels per inch value for non-window system displays.
27715 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27716 Vdisplay_pixels_per_inch
= make_float (72.0);
27719 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27722 DEFVAR_LISP ("truncate-partial-width-windows",
27723 Vtruncate_partial_width_windows
,
27724 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27725 For an integer value, truncate lines in each window narrower than the
27726 full frame width, provided the window width is less than that integer;
27727 otherwise, respect the value of `truncate-lines'.
27729 For any other non-nil value, truncate lines in all windows that do
27730 not span the full frame width.
27732 A value of nil means to respect the value of `truncate-lines'.
27734 If `word-wrap' is enabled, you might want to reduce this. */);
27735 Vtruncate_partial_width_windows
= make_number (50);
27737 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27738 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27739 Any other value means to use the appropriate face, `mode-line',
27740 `header-line', or `menu' respectively. */);
27741 mode_line_inverse_video
= 1;
27743 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27744 doc
: /* *Maximum buffer size for which line number should be displayed.
27745 If the buffer is bigger than this, the line number does not appear
27746 in the mode line. A value of nil means no limit. */);
27747 Vline_number_display_limit
= Qnil
;
27749 DEFVAR_INT ("line-number-display-limit-width",
27750 line_number_display_limit_width
,
27751 doc
: /* *Maximum line width (in characters) for line number display.
27752 If the average length of the lines near point is bigger than this, then the
27753 line number may be omitted from the mode line. */);
27754 line_number_display_limit_width
= 200;
27756 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27757 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27758 highlight_nonselected_windows
= 0;
27760 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27761 doc
: /* Non-nil if more than one frame is visible on this display.
27762 Minibuffer-only frames don't count, but iconified frames do.
27763 This variable is not guaranteed to be accurate except while processing
27764 `frame-title-format' and `icon-title-format'. */);
27766 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27767 doc
: /* Template for displaying the title bar of visible frames.
27768 \(Assuming the window manager supports this feature.)
27770 This variable has the same structure as `mode-line-format', except that
27771 the %c and %l constructs are ignored. It is used only on frames for
27772 which no explicit name has been set \(see `modify-frame-parameters'). */);
27774 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27775 doc
: /* Template for displaying the title bar of an iconified frame.
27776 \(Assuming the window manager supports this feature.)
27777 This variable has the same structure as `mode-line-format' (which see),
27778 and is used only on frames for which no explicit name has been set
27779 \(see `modify-frame-parameters'). */);
27781 = Vframe_title_format
27782 = pure_cons (intern_c_string ("multiple-frames"),
27783 pure_cons (make_pure_c_string ("%b"),
27784 pure_cons (pure_cons (empty_unibyte_string
,
27785 pure_cons (intern_c_string ("invocation-name"),
27786 pure_cons (make_pure_c_string ("@"),
27787 pure_cons (intern_c_string ("system-name"),
27791 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27792 doc
: /* Maximum number of lines to keep in the message log buffer.
27793 If nil, disable message logging. If t, log messages but don't truncate
27794 the buffer when it becomes large. */);
27795 Vmessage_log_max
= make_number (100);
27797 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27798 doc
: /* Functions called before redisplay, if window sizes have changed.
27799 The value should be a list of functions that take one argument.
27800 Just before redisplay, for each frame, if any of its windows have changed
27801 size since the last redisplay, or have been split or deleted,
27802 all the functions in the list are called, with the frame as argument. */);
27803 Vwindow_size_change_functions
= Qnil
;
27805 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27806 doc
: /* List of functions to call before redisplaying a window with scrolling.
27807 Each function is called with two arguments, the window and its new
27808 display-start position. Note that these functions are also called by
27809 `set-window-buffer'. Also note that the value of `window-end' is not
27810 valid when these functions are called. */);
27811 Vwindow_scroll_functions
= Qnil
;
27813 DEFVAR_LISP ("window-text-change-functions",
27814 Vwindow_text_change_functions
,
27815 doc
: /* Functions to call in redisplay when text in the window might change. */);
27816 Vwindow_text_change_functions
= Qnil
;
27818 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27819 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27820 Each function is called with two arguments, the window and the end trigger value.
27821 See `set-window-redisplay-end-trigger'. */);
27822 Vredisplay_end_trigger_functions
= Qnil
;
27824 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27825 doc
: /* *Non-nil means autoselect window with mouse pointer.
27826 If nil, do not autoselect windows.
27827 A positive number means delay autoselection by that many seconds: a
27828 window is autoselected only after the mouse has remained in that
27829 window for the duration of the delay.
27830 A negative number has a similar effect, but causes windows to be
27831 autoselected only after the mouse has stopped moving. \(Because of
27832 the way Emacs compares mouse events, you will occasionally wait twice
27833 that time before the window gets selected.\)
27834 Any other value means to autoselect window instantaneously when the
27835 mouse pointer enters it.
27837 Autoselection selects the minibuffer only if it is active, and never
27838 unselects the minibuffer if it is active.
27840 When customizing this variable make sure that the actual value of
27841 `focus-follows-mouse' matches the behavior of your window manager. */);
27842 Vmouse_autoselect_window
= Qnil
;
27844 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27845 doc
: /* *Non-nil means automatically resize tool-bars.
27846 This dynamically changes the tool-bar's height to the minimum height
27847 that is needed to make all tool-bar items visible.
27848 If value is `grow-only', the tool-bar's height is only increased
27849 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27850 Vauto_resize_tool_bars
= Qt
;
27852 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27853 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27854 auto_raise_tool_bar_buttons_p
= 1;
27856 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27857 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27858 make_cursor_line_fully_visible_p
= 1;
27860 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27861 doc
: /* *Border below tool-bar in pixels.
27862 If an integer, use it as the height of the border.
27863 If it is one of `internal-border-width' or `border-width', use the
27864 value of the corresponding frame parameter.
27865 Otherwise, no border is added below the tool-bar. */);
27866 Vtool_bar_border
= Qinternal_border_width
;
27868 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27869 doc
: /* *Margin around tool-bar buttons in pixels.
27870 If an integer, use that for both horizontal and vertical margins.
27871 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27872 HORZ specifying the horizontal margin, and VERT specifying the
27873 vertical margin. */);
27874 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27876 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27877 doc
: /* *Relief thickness of tool-bar buttons. */);
27878 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27880 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27881 doc
: /* Tool bar style to use.
27883 image - show images only
27884 text - show text only
27885 both - show both, text below image
27886 both-horiz - show text to the right of the image
27887 text-image-horiz - show text to the left of the image
27888 any other - use system default or image if no system default. */);
27889 Vtool_bar_style
= Qnil
;
27891 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27892 doc
: /* *Maximum number of characters a label can have to be shown.
27893 The tool bar style must also show labels for this to have any effect, see
27894 `tool-bar-style'. */);
27895 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27897 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27898 doc
: /* List of functions to call to fontify regions of text.
27899 Each function is called with one argument POS. Functions must
27900 fontify a region starting at POS in the current buffer, and give
27901 fontified regions the property `fontified'. */);
27902 Vfontification_functions
= Qnil
;
27903 Fmake_variable_buffer_local (Qfontification_functions
);
27905 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27906 unibyte_display_via_language_environment
,
27907 doc
: /* *Non-nil means display unibyte text according to language environment.
27908 Specifically, this means that raw bytes in the range 160-255 decimal
27909 are displayed by converting them to the equivalent multibyte characters
27910 according to the current language environment. As a result, they are
27911 displayed according to the current fontset.
27913 Note that this variable affects only how these bytes are displayed,
27914 but does not change the fact they are interpreted as raw bytes. */);
27915 unibyte_display_via_language_environment
= 0;
27917 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27918 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27919 If a float, it specifies a fraction of the mini-window frame's height.
27920 If an integer, it specifies a number of lines. */);
27921 Vmax_mini_window_height
= make_float (0.25);
27923 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27924 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27925 A value of nil means don't automatically resize mini-windows.
27926 A value of t means resize them to fit the text displayed in them.
27927 A value of `grow-only', the default, means let mini-windows grow only;
27928 they return to their normal size when the minibuffer is closed, or the
27929 echo area becomes empty. */);
27930 Vresize_mini_windows
= Qgrow_only
;
27932 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27933 doc
: /* Alist specifying how to blink the cursor off.
27934 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27935 `cursor-type' frame-parameter or variable equals ON-STATE,
27936 comparing using `equal', Emacs uses OFF-STATE to specify
27937 how to blink it off. ON-STATE and OFF-STATE are values for
27938 the `cursor-type' frame parameter.
27940 If a frame's ON-STATE has no entry in this list,
27941 the frame's other specifications determine how to blink the cursor off. */);
27942 Vblink_cursor_alist
= Qnil
;
27944 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27945 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27946 If non-nil, windows are automatically scrolled horizontally to make
27947 point visible. */);
27948 automatic_hscrolling_p
= 1;
27949 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27951 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27952 doc
: /* *How many columns away from the window edge point is allowed to get
27953 before automatic hscrolling will horizontally scroll the window. */);
27954 hscroll_margin
= 5;
27956 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27957 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27958 When point is less than `hscroll-margin' columns from the window
27959 edge, automatic hscrolling will scroll the window by the amount of columns
27960 determined by this variable. If its value is a positive integer, scroll that
27961 many columns. If it's a positive floating-point number, it specifies the
27962 fraction of the window's width to scroll. If it's nil or zero, point will be
27963 centered horizontally after the scroll. Any other value, including negative
27964 numbers, are treated as if the value were zero.
27966 Automatic hscrolling always moves point outside the scroll margin, so if
27967 point was more than scroll step columns inside the margin, the window will
27968 scroll more than the value given by the scroll step.
27970 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27971 and `scroll-right' overrides this variable's effect. */);
27972 Vhscroll_step
= make_number (0);
27974 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27975 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27976 Bind this around calls to `message' to let it take effect. */);
27977 message_truncate_lines
= 0;
27979 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27980 doc
: /* Normal hook run to update the menu bar definitions.
27981 Redisplay runs this hook before it redisplays the menu bar.
27982 This is used to update submenus such as Buffers,
27983 whose contents depend on various data. */);
27984 Vmenu_bar_update_hook
= Qnil
;
27986 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27987 doc
: /* Frame for which we are updating a menu.
27988 The enable predicate for a menu binding should check this variable. */);
27989 Vmenu_updating_frame
= Qnil
;
27991 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27992 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27993 inhibit_menubar_update
= 0;
27995 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27996 doc
: /* Prefix prepended to all continuation lines at display time.
27997 The value may be a string, an image, or a stretch-glyph; it is
27998 interpreted in the same way as the value of a `display' text property.
28000 This variable is overridden by any `wrap-prefix' text or overlay
28003 To add a prefix to non-continuation lines, use `line-prefix'. */);
28004 Vwrap_prefix
= Qnil
;
28005 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28006 Fmake_variable_buffer_local (Qwrap_prefix
);
28008 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28009 doc
: /* Prefix prepended to all non-continuation lines at display time.
28010 The value may be a string, an image, or a stretch-glyph; it is
28011 interpreted in the same way as the value of a `display' text property.
28013 This variable is overridden by any `line-prefix' text or overlay
28016 To add a prefix to continuation lines, use `wrap-prefix'. */);
28017 Vline_prefix
= Qnil
;
28018 DEFSYM (Qline_prefix
, "line-prefix");
28019 Fmake_variable_buffer_local (Qline_prefix
);
28021 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28022 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28023 inhibit_eval_during_redisplay
= 0;
28025 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28026 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28027 inhibit_free_realized_faces
= 0;
28030 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28031 doc
: /* Inhibit try_window_id display optimization. */);
28032 inhibit_try_window_id
= 0;
28034 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28035 doc
: /* Inhibit try_window_reusing display optimization. */);
28036 inhibit_try_window_reusing
= 0;
28038 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28039 doc
: /* Inhibit try_cursor_movement display optimization. */);
28040 inhibit_try_cursor_movement
= 0;
28041 #endif /* GLYPH_DEBUG */
28043 DEFVAR_INT ("overline-margin", overline_margin
,
28044 doc
: /* *Space between overline and text, in pixels.
28045 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28046 margin to the caracter height. */);
28047 overline_margin
= 2;
28049 DEFVAR_INT ("underline-minimum-offset",
28050 underline_minimum_offset
,
28051 doc
: /* Minimum distance between baseline and underline.
28052 This can improve legibility of underlined text at small font sizes,
28053 particularly when using variable `x-use-underline-position-properties'
28054 with fonts that specify an UNDERLINE_POSITION relatively close to the
28055 baseline. The default value is 1. */);
28056 underline_minimum_offset
= 1;
28058 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28059 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28060 This feature only works when on a window system that can change
28061 cursor shapes. */);
28062 display_hourglass_p
= 1;
28064 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28065 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28066 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28068 hourglass_atimer
= NULL
;
28069 hourglass_shown_p
= 0;
28071 DEFSYM (Qglyphless_char
, "glyphless-char");
28072 DEFSYM (Qhex_code
, "hex-code");
28073 DEFSYM (Qempty_box
, "empty-box");
28074 DEFSYM (Qthin_space
, "thin-space");
28075 DEFSYM (Qzero_width
, "zero-width");
28077 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28078 /* Intern this now in case it isn't already done.
28079 Setting this variable twice is harmless.
28080 But don't staticpro it here--that is done in alloc.c. */
28081 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28082 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28084 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28085 doc
: /* Char-table defining glyphless characters.
28086 Each element, if non-nil, should be one of the following:
28087 an ASCII acronym string: display this string in a box
28088 `hex-code': display the hexadecimal code of a character in a box
28089 `empty-box': display as an empty box
28090 `thin-space': display as 1-pixel width space
28091 `zero-width': don't display
28092 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28093 display method for graphical terminals and text terminals respectively.
28094 GRAPHICAL and TEXT should each have one of the values listed above.
28096 The char-table has one extra slot to control the display of a character for
28097 which no font is found. This slot only takes effect on graphical terminals.
28098 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28099 `thin-space'. The default is `empty-box'. */);
28100 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28101 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28106 /* Initialize this module when Emacs starts. */
28111 current_header_line_height
= current_mode_line_height
= -1;
28113 CHARPOS (this_line_start_pos
) = 0;
28115 if (!noninteractive
)
28117 struct window
*m
= XWINDOW (minibuf_window
);
28118 Lisp_Object frame
= m
->frame
;
28119 struct frame
*f
= XFRAME (frame
);
28120 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28121 struct window
*r
= XWINDOW (root
);
28124 echo_area_window
= minibuf_window
;
28126 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28127 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28128 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28129 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28130 XSETFASTINT (m
->total_lines
, 1);
28131 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28133 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28134 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28135 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28137 /* The default ellipsis glyphs `...'. */
28138 for (i
= 0; i
< 3; ++i
)
28139 default_invis_vector
[i
] = make_number ('.');
28143 /* Allocate the buffer for frame titles.
28144 Also used for `format-mode-line'. */
28146 mode_line_noprop_buf
= (char *) xmalloc (size
);
28147 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28148 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28149 mode_line_target
= MODE_LINE_DISPLAY
;
28152 help_echo_showing_p
= 0;
28155 /* Since w32 does not support atimers, it defines its own implementation of
28156 the following three functions in w32fns.c. */
28159 /* Platform-independent portion of hourglass implementation. */
28161 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28163 hourglass_started (void)
28165 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28168 /* Cancel a currently active hourglass timer, and start a new one. */
28170 start_hourglass (void)
28172 #if defined (HAVE_WINDOW_SYSTEM)
28174 int secs
= DEFAULT_HOURGLASS_DELAY
, usecs
= 0;
28176 cancel_hourglass ();
28178 if (NUMBERP (Vhourglass_delay
))
28180 double duration
= extract_float (Vhourglass_delay
);
28182 duration_to_sec_usec (duration
, &secs
, &usecs
);
28185 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28186 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28187 show_hourglass
, NULL
);
28192 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28195 cancel_hourglass (void)
28197 #if defined (HAVE_WINDOW_SYSTEM)
28198 if (hourglass_atimer
)
28200 cancel_atimer (hourglass_atimer
);
28201 hourglass_atimer
= NULL
;
28204 if (hourglass_shown_p
)
28208 #endif /* ! WINDOWSNT */