1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 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"
284 #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 /* These setters are used only in this file, so they can be private. */
370 wset_base_line_number (struct window
*w
, Lisp_Object val
)
372 w
->base_line_number
= val
;
375 wset_base_line_pos (struct window
*w
, Lisp_Object val
)
377 w
->base_line_pos
= val
;
380 wset_column_number_displayed (struct window
*w
, Lisp_Object val
)
382 w
->column_number_displayed
= val
;
385 wset_region_showing (struct window
*w
, Lisp_Object val
)
387 w
->region_showing
= val
;
390 #ifdef HAVE_WINDOW_SYSTEM
392 /* Test if overflow newline into fringe. Called with iterator IT
393 at or past right window margin, and with IT->current_x set. */
395 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
396 (!NILP (Voverflow_newline_into_fringe) \
397 && FRAME_WINDOW_P ((IT)->f) \
398 && ((IT)->bidi_it.paragraph_dir == R2L \
399 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
400 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
401 && (IT)->current_x == (IT)->last_visible_x \
402 && (IT)->line_wrap != WORD_WRAP)
404 #else /* !HAVE_WINDOW_SYSTEM */
405 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
406 #endif /* HAVE_WINDOW_SYSTEM */
408 /* Test if the display element loaded in IT, or the underlying buffer
409 or string character, is a space or a TAB character. This is used
410 to determine where word wrapping can occur. */
412 #define IT_DISPLAYING_WHITESPACE(it) \
413 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
414 || ((STRINGP (it->string) \
415 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
416 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
418 && (it->s[IT_BYTEPOS (*it)] == ' ' \
419 || it->s[IT_BYTEPOS (*it)] == '\t')) \
420 || (IT_BYTEPOS (*it) < ZV_BYTE \
421 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
422 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
424 /* Name of the face used to highlight trailing whitespace. */
426 static Lisp_Object Qtrailing_whitespace
;
428 /* Name and number of the face used to highlight escape glyphs. */
430 static Lisp_Object Qescape_glyph
;
432 /* Name and number of the face used to highlight non-breaking spaces. */
434 static Lisp_Object Qnobreak_space
;
436 /* The symbol `image' which is the car of the lists used to represent
437 images in Lisp. Also a tool bar style. */
441 /* The image map types. */
443 static Lisp_Object QCpointer
;
444 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
446 /* Tool bar styles */
447 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
449 /* Non-zero means print newline to stdout before next mini-buffer
452 int noninteractive_need_newline
;
454 /* Non-zero means print newline to message log before next message. */
456 static int message_log_need_newline
;
458 /* Three markers that message_dolog uses.
459 It could allocate them itself, but that causes trouble
460 in handling memory-full errors. */
461 static Lisp_Object message_dolog_marker1
;
462 static Lisp_Object message_dolog_marker2
;
463 static Lisp_Object message_dolog_marker3
;
465 /* The buffer position of the first character appearing entirely or
466 partially on the line of the selected window which contains the
467 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
468 redisplay optimization in redisplay_internal. */
470 static struct text_pos this_line_start_pos
;
472 /* Number of characters past the end of the line above, including the
473 terminating newline. */
475 static struct text_pos this_line_end_pos
;
477 /* The vertical positions and the height of this line. */
479 static int this_line_vpos
;
480 static int this_line_y
;
481 static int this_line_pixel_height
;
483 /* X position at which this display line starts. Usually zero;
484 negative if first character is partially visible. */
486 static int this_line_start_x
;
488 /* The smallest character position seen by move_it_* functions as they
489 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
490 hscrolled lines, see display_line. */
492 static struct text_pos this_line_min_pos
;
494 /* Buffer that this_line_.* variables are referring to. */
496 static struct buffer
*this_line_buffer
;
499 /* Values of those variables at last redisplay are stored as
500 properties on `overlay-arrow-position' symbol. However, if
501 Voverlay_arrow_position is a marker, last-arrow-position is its
502 numerical position. */
504 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
506 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
507 properties on a symbol in overlay-arrow-variable-list. */
509 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
511 Lisp_Object Qmenu_bar_update_hook
;
513 /* Nonzero if an overlay arrow has been displayed in this window. */
515 static int overlay_arrow_seen
;
517 /* Number of windows showing the buffer of the selected window (or
518 another buffer with the same base buffer). keyboard.c refers to
523 /* Vector containing glyphs for an ellipsis `...'. */
525 static Lisp_Object default_invis_vector
[3];
527 /* This is the window where the echo area message was displayed. It
528 is always a mini-buffer window, but it may not be the same window
529 currently active as a mini-buffer. */
531 Lisp_Object echo_area_window
;
533 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
534 pushes the current message and the value of
535 message_enable_multibyte on the stack, the function restore_message
536 pops the stack and displays MESSAGE again. */
538 static Lisp_Object Vmessage_stack
;
540 /* Nonzero means multibyte characters were enabled when the echo area
541 message was specified. */
543 static int message_enable_multibyte
;
545 /* Nonzero if we should redraw the mode lines on the next redisplay. */
547 int update_mode_lines
;
549 /* Nonzero if window sizes or contents have changed since last
550 redisplay that finished. */
552 int windows_or_buffers_changed
;
554 /* Nonzero means a frame's cursor type has been changed. */
556 int cursor_type_changed
;
558 /* Nonzero after display_mode_line if %l was used and it displayed a
561 static int line_number_displayed
;
563 /* The name of the *Messages* buffer, a string. */
565 static Lisp_Object Vmessages_buffer_name
;
567 /* Current, index 0, and last displayed echo area message. Either
568 buffers from echo_buffers, or nil to indicate no message. */
570 Lisp_Object echo_area_buffer
[2];
572 /* The buffers referenced from echo_area_buffer. */
574 static Lisp_Object echo_buffer
[2];
576 /* A vector saved used in with_area_buffer to reduce consing. */
578 static Lisp_Object Vwith_echo_area_save_vector
;
580 /* Non-zero means display_echo_area should display the last echo area
581 message again. Set by redisplay_preserve_echo_area. */
583 static int display_last_displayed_message_p
;
585 /* Nonzero if echo area is being used by print; zero if being used by
588 static int message_buf_print
;
590 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
592 static Lisp_Object Qinhibit_menubar_update
;
593 static Lisp_Object Qmessage_truncate_lines
;
595 /* Set to 1 in clear_message to make redisplay_internal aware
596 of an emptied echo area. */
598 static int message_cleared_p
;
600 /* A scratch glyph row with contents used for generating truncation
601 glyphs. Also used in direct_output_for_insert. */
603 #define MAX_SCRATCH_GLYPHS 100
604 static struct glyph_row scratch_glyph_row
;
605 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
607 /* Ascent and height of the last line processed by move_it_to. */
609 static int last_max_ascent
, last_height
;
611 /* Non-zero if there's a help-echo in the echo area. */
613 int help_echo_showing_p
;
615 /* If >= 0, computed, exact values of mode-line and header-line height
616 to use in the macros CURRENT_MODE_LINE_HEIGHT and
617 CURRENT_HEADER_LINE_HEIGHT. */
619 int current_mode_line_height
, current_header_line_height
;
621 /* The maximum distance to look ahead for text properties. Values
622 that are too small let us call compute_char_face and similar
623 functions too often which is expensive. Values that are too large
624 let us call compute_char_face and alike too often because we
625 might not be interested in text properties that far away. */
627 #define TEXT_PROP_DISTANCE_LIMIT 100
629 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
630 iterator state and later restore it. This is needed because the
631 bidi iterator on bidi.c keeps a stacked cache of its states, which
632 is really a singleton. When we use scratch iterator objects to
633 move around the buffer, we can cause the bidi cache to be pushed or
634 popped, and therefore we need to restore the cache state when we
635 return to the original iterator. */
636 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
639 bidi_unshelve_cache (CACHE, 1); \
641 CACHE = bidi_shelve_cache (); \
644 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
646 if (pITORIG != pITCOPY) \
647 *(pITORIG) = *(pITCOPY); \
648 bidi_unshelve_cache (CACHE, 0); \
654 /* Non-zero means print traces of redisplay if compiled with
655 GLYPH_DEBUG defined. */
657 int trace_redisplay_p
;
659 #endif /* GLYPH_DEBUG */
661 #ifdef DEBUG_TRACE_MOVE
662 /* Non-zero means trace with TRACE_MOVE to stderr. */
665 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
667 #define TRACE_MOVE(x) (void) 0
670 static Lisp_Object Qauto_hscroll_mode
;
672 /* Buffer being redisplayed -- for redisplay_window_error. */
674 static struct buffer
*displayed_buffer
;
676 /* Value returned from text property handlers (see below). */
681 HANDLED_RECOMPUTE_PROPS
,
682 HANDLED_OVERLAY_STRING_CONSUMED
,
686 /* A description of text properties that redisplay is interested
691 /* The name of the property. */
694 /* A unique index for the property. */
697 /* A handler function called to set up iterator IT from the property
698 at IT's current position. Value is used to steer handle_stop. */
699 enum prop_handled (*handler
) (struct it
*it
);
702 static enum prop_handled
handle_face_prop (struct it
*);
703 static enum prop_handled
handle_invisible_prop (struct it
*);
704 static enum prop_handled
handle_display_prop (struct it
*);
705 static enum prop_handled
handle_composition_prop (struct it
*);
706 static enum prop_handled
handle_overlay_change (struct it
*);
707 static enum prop_handled
handle_fontified_prop (struct it
*);
709 /* Properties handled by iterators. */
711 static struct props it_props
[] =
713 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
714 /* Handle `face' before `display' because some sub-properties of
715 `display' need to know the face. */
716 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
717 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
718 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
719 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
723 /* Value is the position described by X. If X is a marker, value is
724 the marker_position of X. Otherwise, value is X. */
726 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
728 /* Enumeration returned by some move_it_.* functions internally. */
732 /* Not used. Undefined value. */
735 /* Move ended at the requested buffer position or ZV. */
736 MOVE_POS_MATCH_OR_ZV
,
738 /* Move ended at the requested X pixel position. */
741 /* Move within a line ended at the end of a line that must be
745 /* Move within a line ended at the end of a line that would
746 be displayed truncated. */
749 /* Move within a line ended at a line end. */
753 /* This counter is used to clear the face cache every once in a while
754 in redisplay_internal. It is incremented for each redisplay.
755 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
758 #define CLEAR_FACE_CACHE_COUNT 500
759 static int clear_face_cache_count
;
761 /* Similarly for the image cache. */
763 #ifdef HAVE_WINDOW_SYSTEM
764 #define CLEAR_IMAGE_CACHE_COUNT 101
765 static int clear_image_cache_count
;
767 /* Null glyph slice */
768 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
771 /* Non-zero while redisplay_internal is in progress. */
775 static Lisp_Object Qinhibit_free_realized_faces
;
776 static Lisp_Object Qmode_line_default_help_echo
;
778 /* If a string, XTread_socket generates an event to display that string.
779 (The display is done in read_char.) */
781 Lisp_Object help_echo_string
;
782 Lisp_Object help_echo_window
;
783 Lisp_Object help_echo_object
;
784 ptrdiff_t help_echo_pos
;
786 /* Temporary variable for XTread_socket. */
788 Lisp_Object previous_help_echo_string
;
790 /* Platform-independent portion of hourglass implementation. */
792 /* Non-zero means an hourglass cursor is currently shown. */
793 int hourglass_shown_p
;
795 /* If non-null, an asynchronous timer that, when it expires, displays
796 an hourglass cursor on all frames. */
797 struct atimer
*hourglass_atimer
;
799 /* Name of the face used to display glyphless characters. */
800 Lisp_Object Qglyphless_char
;
802 /* Symbol for the purpose of Vglyphless_char_display. */
803 static Lisp_Object Qglyphless_char_display
;
805 /* Method symbols for Vglyphless_char_display. */
806 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
808 /* Default pixel width of `thin-space' display method. */
809 #define THIN_SPACE_WIDTH 1
811 /* Default number of seconds to wait before displaying an hourglass
813 #define DEFAULT_HOURGLASS_DELAY 1
816 /* Function prototypes. */
818 static void setup_for_ellipsis (struct it
*, int);
819 static void set_iterator_to_next (struct it
*, int);
820 static void mark_window_display_accurate_1 (struct window
*, int);
821 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
822 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
823 static int cursor_row_p (struct glyph_row
*);
824 static int redisplay_mode_lines (Lisp_Object
, int);
825 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
827 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
829 static void handle_line_prefix (struct it
*);
831 static void pint2str (char *, int, ptrdiff_t);
832 static void pint2hrstr (char *, int, ptrdiff_t);
833 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
835 static void reconsider_clip_changes (struct window
*, struct buffer
*);
836 static int text_outside_line_unchanged_p (struct window
*,
837 ptrdiff_t, ptrdiff_t);
838 static void store_mode_line_noprop_char (char);
839 static int store_mode_line_noprop (const char *, int, int);
840 static void handle_stop (struct it
*);
841 static void handle_stop_backwards (struct it
*, ptrdiff_t);
842 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
843 static void ensure_echo_area_buffers (void);
844 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
845 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
846 static int with_echo_area_buffer (struct window
*, int,
847 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
848 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
849 static void clear_garbaged_frames (void);
850 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
851 static void pop_message (void);
852 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
853 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
854 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
855 static int display_echo_area (struct window
*);
856 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
857 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
858 static Lisp_Object
unwind_redisplay (Lisp_Object
);
859 static int string_char_and_length (const unsigned char *, int *);
860 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
862 static int compute_window_start_on_continuation_line (struct window
*);
863 static void insert_left_trunc_glyphs (struct it
*);
864 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
866 static void extend_face_to_end_of_line (struct it
*);
867 static int append_space_for_newline (struct it
*, int);
868 static int cursor_row_fully_visible_p (struct window
*, int, int);
869 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
870 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
871 static int trailing_whitespace_p (ptrdiff_t);
872 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
873 static void push_it (struct it
*, struct text_pos
*);
874 static void iterate_out_of_display_property (struct it
*);
875 static void pop_it (struct it
*);
876 static void sync_frame_with_window_matrix_rows (struct window
*);
877 static void select_frame_for_redisplay (Lisp_Object
);
878 static void redisplay_internal (void);
879 static int echo_area_display (int);
880 static void redisplay_windows (Lisp_Object
);
881 static void redisplay_window (Lisp_Object
, int);
882 static Lisp_Object
redisplay_window_error (Lisp_Object
);
883 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
884 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
885 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
886 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
888 static int update_menu_bar (struct frame
*, int, int);
889 static int try_window_reusing_current_matrix (struct window
*);
890 static int try_window_id (struct window
*);
891 static int display_line (struct it
*);
892 static int display_mode_lines (struct window
*);
893 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
894 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
895 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
896 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
897 static void display_menu_bar (struct window
*);
898 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
900 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
901 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
902 static void compute_line_metrics (struct it
*);
903 static void run_redisplay_end_trigger_hook (struct it
*);
904 static int get_overlay_strings (struct it
*, ptrdiff_t);
905 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
906 static void next_overlay_string (struct it
*);
907 static void reseat (struct it
*, struct text_pos
, int);
908 static void reseat_1 (struct it
*, struct text_pos
, int);
909 static void back_to_previous_visible_line_start (struct it
*);
910 void reseat_at_previous_visible_line_start (struct it
*);
911 static void reseat_at_next_visible_line_start (struct it
*, int);
912 static int next_element_from_ellipsis (struct it
*);
913 static int next_element_from_display_vector (struct it
*);
914 static int next_element_from_string (struct it
*);
915 static int next_element_from_c_string (struct it
*);
916 static int next_element_from_buffer (struct it
*);
917 static int next_element_from_composition (struct it
*);
918 static int next_element_from_image (struct it
*);
919 static int next_element_from_stretch (struct it
*);
920 static void load_overlay_strings (struct it
*, ptrdiff_t);
921 static int init_from_display_pos (struct it
*, struct window
*,
922 struct display_pos
*);
923 static void reseat_to_string (struct it
*, const char *,
924 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
925 static int get_next_display_element (struct it
*);
926 static enum move_it_result
927 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
928 enum move_operation_enum
);
929 void move_it_vertically_backward (struct it
*, int);
930 static void init_to_row_start (struct it
*, struct window
*,
932 static int init_to_row_end (struct it
*, struct window
*,
934 static void back_to_previous_line_start (struct it
*);
935 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
936 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
937 Lisp_Object
, ptrdiff_t);
938 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
939 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
940 static ptrdiff_t number_of_chars (const char *, int);
941 static void compute_stop_pos (struct it
*);
942 static void compute_string_pos (struct text_pos
*, struct text_pos
,
944 static int face_before_or_after_it_pos (struct it
*, int);
945 static ptrdiff_t next_overlay_change (ptrdiff_t);
946 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
947 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
948 static int handle_single_display_spec (struct it
*, Lisp_Object
,
949 Lisp_Object
, Lisp_Object
,
950 struct text_pos
*, ptrdiff_t, int, int);
951 static int underlying_face_id (struct it
*);
952 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
955 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
956 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
958 #ifdef HAVE_WINDOW_SYSTEM
960 static void x_consider_frame_title (Lisp_Object
);
961 static int tool_bar_lines_needed (struct frame
*, int *);
962 static void update_tool_bar (struct frame
*, int);
963 static void build_desired_tool_bar_string (struct frame
*f
);
964 static int redisplay_tool_bar (struct frame
*);
965 static void display_tool_bar_line (struct it
*, int);
966 static void notice_overwritten_cursor (struct window
*,
969 static void append_stretch_glyph (struct it
*, Lisp_Object
,
973 #endif /* HAVE_WINDOW_SYSTEM */
975 static void produce_special_glyphs (struct it
*, enum display_element_type
);
976 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
977 static int coords_in_mouse_face_p (struct window
*, int, int);
981 /***********************************************************************
982 Window display dimensions
983 ***********************************************************************/
985 /* Return the bottom boundary y-position for text lines in window W.
986 This is the first y position at which a line cannot start.
987 It is relative to the top of the window.
989 This is the height of W minus the height of a mode line, if any. */
992 window_text_bottom_y (struct window
*w
)
994 int height
= WINDOW_TOTAL_HEIGHT (w
);
996 if (WINDOW_WANTS_MODELINE_P (w
))
997 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1001 /* Return the pixel width of display area AREA of window W. AREA < 0
1002 means return the total width of W, not including fringes to
1003 the left and right of the window. */
1006 window_box_width (struct window
*w
, int area
)
1008 int cols
= XFASTINT (w
->total_cols
);
1011 if (!w
->pseudo_window_p
)
1013 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1015 if (area
== TEXT_AREA
)
1017 if (INTEGERP (w
->left_margin_cols
))
1018 cols
-= XFASTINT (w
->left_margin_cols
);
1019 if (INTEGERP (w
->right_margin_cols
))
1020 cols
-= XFASTINT (w
->right_margin_cols
);
1021 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1023 else if (area
== LEFT_MARGIN_AREA
)
1025 cols
= (INTEGERP (w
->left_margin_cols
)
1026 ? XFASTINT (w
->left_margin_cols
) : 0);
1029 else if (area
== RIGHT_MARGIN_AREA
)
1031 cols
= (INTEGERP (w
->right_margin_cols
)
1032 ? XFASTINT (w
->right_margin_cols
) : 0);
1037 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1041 /* Return the pixel height of the display area of window W, not
1042 including mode lines of W, if any. */
1045 window_box_height (struct window
*w
)
1047 struct frame
*f
= XFRAME (w
->frame
);
1048 int height
= WINDOW_TOTAL_HEIGHT (w
);
1050 eassert (height
>= 0);
1052 /* Note: the code below that determines the mode-line/header-line
1053 height is essentially the same as that contained in the macro
1054 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1055 the appropriate glyph row has its `mode_line_p' flag set,
1056 and if it doesn't, uses estimate_mode_line_height instead. */
1058 if (WINDOW_WANTS_MODELINE_P (w
))
1060 struct glyph_row
*ml_row
1061 = (w
->current_matrix
&& w
->current_matrix
->rows
1062 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1064 if (ml_row
&& ml_row
->mode_line_p
)
1065 height
-= ml_row
->height
;
1067 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1070 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1072 struct glyph_row
*hl_row
1073 = (w
->current_matrix
&& w
->current_matrix
->rows
1074 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1076 if (hl_row
&& hl_row
->mode_line_p
)
1077 height
-= hl_row
->height
;
1079 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1082 /* With a very small font and a mode-line that's taller than
1083 default, we might end up with a negative height. */
1084 return max (0, height
);
1087 /* Return the window-relative coordinate of the left edge of display
1088 area AREA of window W. AREA < 0 means return the left edge of the
1089 whole window, to the right of the left fringe of W. */
1092 window_box_left_offset (struct window
*w
, int area
)
1096 if (w
->pseudo_window_p
)
1099 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1101 if (area
== TEXT_AREA
)
1102 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1103 + window_box_width (w
, LEFT_MARGIN_AREA
));
1104 else if (area
== RIGHT_MARGIN_AREA
)
1105 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1106 + window_box_width (w
, LEFT_MARGIN_AREA
)
1107 + window_box_width (w
, TEXT_AREA
)
1108 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1110 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1111 else if (area
== LEFT_MARGIN_AREA
1112 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1113 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1119 /* Return the window-relative coordinate of the right edge of display
1120 area AREA of window W. AREA < 0 means return the right edge of the
1121 whole window, to the left of the right fringe of W. */
1124 window_box_right_offset (struct window
*w
, int area
)
1126 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1129 /* Return the frame-relative coordinate of the left edge of display
1130 area AREA of window W. AREA < 0 means return the left edge of the
1131 whole window, to the right of the left fringe of W. */
1134 window_box_left (struct window
*w
, int area
)
1136 struct frame
*f
= XFRAME (w
->frame
);
1139 if (w
->pseudo_window_p
)
1140 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1142 x
= (WINDOW_LEFT_EDGE_X (w
)
1143 + window_box_left_offset (w
, area
));
1149 /* Return the frame-relative coordinate of the right edge of display
1150 area AREA of window W. AREA < 0 means return the right edge of the
1151 whole window, to the left of the right fringe of W. */
1154 window_box_right (struct window
*w
, int area
)
1156 return window_box_left (w
, area
) + window_box_width (w
, area
);
1159 /* Get the bounding box of the display area AREA of window W, without
1160 mode lines, in frame-relative coordinates. AREA < 0 means the
1161 whole window, not including the left and right fringes of
1162 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1163 coordinates of the upper-left corner of the box. Return in
1164 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1167 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1168 int *box_width
, int *box_height
)
1171 *box_width
= window_box_width (w
, area
);
1173 *box_height
= window_box_height (w
);
1175 *box_x
= window_box_left (w
, area
);
1178 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1179 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1180 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines. AREA < 0 means the whole window, not including the
1187 left and right fringe of the window. Return in *TOP_LEFT_X
1188 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1189 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1190 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1194 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1195 int *bottom_right_x
, int *bottom_right_y
)
1197 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1199 *bottom_right_x
+= *top_left_x
;
1200 *bottom_right_y
+= *top_left_y
;
1205 /***********************************************************************
1207 ***********************************************************************/
1209 /* Return the bottom y-position of the line the iterator IT is in.
1210 This can modify IT's settings. */
1213 line_bottom_y (struct it
*it
)
1215 int line_height
= it
->max_ascent
+ it
->max_descent
;
1216 int line_top_y
= it
->current_y
;
1218 if (line_height
== 0)
1221 line_height
= last_height
;
1222 else if (IT_CHARPOS (*it
) < ZV
)
1224 move_it_by_lines (it
, 1);
1225 line_height
= (it
->max_ascent
|| it
->max_descent
1226 ? it
->max_ascent
+ it
->max_descent
1231 struct glyph_row
*row
= it
->glyph_row
;
1233 /* Use the default character height. */
1234 it
->glyph_row
= NULL
;
1235 it
->what
= IT_CHARACTER
;
1238 PRODUCE_GLYPHS (it
);
1239 line_height
= it
->ascent
+ it
->descent
;
1240 it
->glyph_row
= row
;
1244 return line_top_y
+ line_height
;
1247 /* Subroutine of pos_visible_p below. Extracts a display string, if
1248 any, from the display spec given as its argument. */
1250 string_from_display_spec (Lisp_Object spec
)
1254 while (CONSP (spec
))
1256 if (STRINGP (XCAR (spec
)))
1261 else if (VECTORP (spec
))
1265 for (i
= 0; i
< ASIZE (spec
); i
++)
1267 if (STRINGP (AREF (spec
, i
)))
1268 return AREF (spec
, i
);
1277 /* Limit insanely large values of W->hscroll on frame F to the largest
1278 value that will still prevent first_visible_x and last_visible_x of
1279 'struct it' from overflowing an int. */
1281 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1283 ptrdiff_t window_hscroll
= w
->hscroll
;
1284 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1285 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1287 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1288 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1290 return window_hscroll
;
1293 /* Return 1 if position CHARPOS is visible in window W.
1294 CHARPOS < 0 means return info about WINDOW_END position.
1295 If visible, set *X and *Y to pixel coordinates of top left corner.
1296 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1297 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1300 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1301 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1304 void *itdata
= bidi_shelve_cache ();
1305 struct text_pos top
;
1307 struct buffer
*old_buffer
= NULL
;
1309 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1312 if (XBUFFER (w
->buffer
) != current_buffer
)
1314 old_buffer
= current_buffer
;
1315 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1318 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1319 /* Scrolling a minibuffer window via scroll bar when the echo area
1320 shows long text sometimes resets the minibuffer contents behind
1322 if (CHARPOS (top
) > ZV
)
1323 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1325 /* Compute exact mode line heights. */
1326 if (WINDOW_WANTS_MODELINE_P (w
))
1327 current_mode_line_height
1328 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1329 BVAR (current_buffer
, mode_line_format
));
1331 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1332 current_header_line_height
1333 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1334 BVAR (current_buffer
, header_line_format
));
1336 start_display (&it
, w
, top
);
1337 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1338 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1341 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1342 && IT_CHARPOS (it
) >= charpos
)
1343 /* When scanning backwards under bidi iteration, move_it_to
1344 stops at or _before_ CHARPOS, because it stops at or to
1345 the _right_ of the character at CHARPOS. */
1346 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1347 && IT_CHARPOS (it
) <= charpos
)))
1349 /* We have reached CHARPOS, or passed it. How the call to
1350 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1351 or covered by a display property, move_it_to stops at the end
1352 of the invisible text, to the right of CHARPOS. (ii) If
1353 CHARPOS is in a display vector, move_it_to stops on its last
1355 int top_x
= it
.current_x
;
1356 int top_y
= it
.current_y
;
1357 /* Calling line_bottom_y may change it.method, it.position, etc. */
1358 enum it_method it_method
= it
.method
;
1359 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1360 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1362 if (top_y
< window_top_y
)
1363 visible_p
= bottom_y
> window_top_y
;
1364 else if (top_y
< it
.last_visible_y
)
1366 if (bottom_y
>= it
.last_visible_y
1367 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1368 && IT_CHARPOS (it
) < charpos
)
1370 /* When the last line of the window is scanned backwards
1371 under bidi iteration, we could be duped into thinking
1372 that we have passed CHARPOS, when in fact move_it_to
1373 simply stopped short of CHARPOS because it reached
1374 last_visible_y. To see if that's what happened, we call
1375 move_it_to again with a slightly larger vertical limit,
1376 and see if it actually moved vertically; if it did, we
1377 didn't really reach CHARPOS, which is beyond window end. */
1378 struct it save_it
= it
;
1379 /* Why 10? because we don't know how many canonical lines
1380 will the height of the next line(s) be. So we guess. */
1381 int ten_more_lines
=
1382 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1384 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1385 MOVE_TO_POS
| MOVE_TO_Y
);
1386 if (it
.current_y
> top_y
)
1393 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1395 /* We stopped on the last glyph of a display vector.
1396 Try and recompute. Hack alert! */
1397 if (charpos
< 2 || top
.charpos
>= charpos
)
1398 top_x
= it
.glyph_row
->x
;
1402 start_display (&it2
, w
, top
);
1403 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1404 get_next_display_element (&it2
);
1405 PRODUCE_GLYPHS (&it2
);
1406 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1407 || it2
.current_x
> it2
.last_visible_x
)
1408 top_x
= it
.glyph_row
->x
;
1411 top_x
= it2
.current_x
;
1412 top_y
= it2
.current_y
;
1416 else if (IT_CHARPOS (it
) != charpos
)
1418 Lisp_Object cpos
= make_number (charpos
);
1419 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1420 Lisp_Object string
= string_from_display_spec (spec
);
1421 int newline_in_string
= 0;
1423 if (STRINGP (string
))
1425 const char *s
= SSDATA (string
);
1426 const char *e
= s
+ SBYTES (string
);
1431 newline_in_string
= 1;
1436 /* The tricky code below is needed because there's a
1437 discrepancy between move_it_to and how we set cursor
1438 when the display line ends in a newline from a
1439 display string. move_it_to will stop _after_ such
1440 display strings, whereas set_cursor_from_row
1441 conspires with cursor_row_p to place the cursor on
1442 the first glyph produced from the display string. */
1444 /* We have overshoot PT because it is covered by a
1445 display property whose value is a string. If the
1446 string includes embedded newlines, we are also in the
1447 wrong display line. Backtrack to the correct line,
1448 where the display string begins. */
1449 if (newline_in_string
)
1451 Lisp_Object startpos
, endpos
;
1452 EMACS_INT start
, end
;
1456 /* Find the first and the last buffer positions
1457 covered by the display string. */
1459 Fnext_single_char_property_change (cpos
, Qdisplay
,
1462 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1464 start
= XFASTINT (startpos
);
1465 end
= XFASTINT (endpos
);
1466 /* Move to the last buffer position before the
1467 display property. */
1468 start_display (&it3
, w
, top
);
1469 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1470 /* Move forward one more line if the position before
1471 the display string is a newline or if it is the
1472 rightmost character on a line that is
1473 continued or word-wrapped. */
1474 if (it3
.method
== GET_FROM_BUFFER
1476 move_it_by_lines (&it3
, 1);
1477 else if (move_it_in_display_line_to (&it3
, -1,
1481 == MOVE_LINE_CONTINUED
)
1483 move_it_by_lines (&it3
, 1);
1484 /* When we are under word-wrap, the #$@%!
1485 move_it_by_lines moves 2 lines, so we need to
1487 if (it3
.line_wrap
== WORD_WRAP
)
1488 move_it_by_lines (&it3
, -1);
1491 /* Record the vertical coordinate of the display
1492 line where we wound up. */
1493 top_y
= it3
.current_y
;
1496 /* When characters are reordered for display,
1497 the character displayed to the left of the
1498 display string could be _after_ the display
1499 property in the logical order. Use the
1500 smallest vertical position of these two. */
1501 start_display (&it3
, w
, top
);
1502 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1503 if (it3
.current_y
< top_y
)
1504 top_y
= it3
.current_y
;
1506 /* Move from the top of the window to the beginning
1507 of the display line where the display string
1509 start_display (&it3
, w
, top
);
1510 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1511 /* If it3_moved stays zero after the 'while' loop
1512 below, that means we already were at a newline
1513 before the loop (e.g., the display string begins
1514 with a newline), so we don't need to (and cannot)
1515 inspect the glyphs of it3.glyph_row, because
1516 PRODUCE_GLYPHS will not produce anything for a
1517 newline, and thus it3.glyph_row stays at its
1518 stale content it got at top of the window. */
1520 /* Finally, advance the iterator until we hit the
1521 first display element whose character position is
1522 CHARPOS, or until the first newline from the
1523 display string, which signals the end of the
1525 while (get_next_display_element (&it3
))
1527 PRODUCE_GLYPHS (&it3
);
1528 if (IT_CHARPOS (it3
) == charpos
1529 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1532 set_iterator_to_next (&it3
, 0);
1534 top_x
= it3
.current_x
- it3
.pixel_width
;
1535 /* Normally, we would exit the above loop because we
1536 found the display element whose character
1537 position is CHARPOS. For the contingency that we
1538 didn't, and stopped at the first newline from the
1539 display string, move back over the glyphs
1540 produced from the string, until we find the
1541 rightmost glyph not from the string. */
1543 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1545 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1546 + it3
.glyph_row
->used
[TEXT_AREA
];
1548 while (EQ ((g
- 1)->object
, string
))
1551 top_x
-= g
->pixel_width
;
1553 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1554 + it3
.glyph_row
->used
[TEXT_AREA
]);
1560 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1561 *rtop
= max (0, window_top_y
- top_y
);
1562 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1563 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1564 - max (top_y
, window_top_y
)));
1570 /* We were asked to provide info about WINDOW_END. */
1572 void *it2data
= NULL
;
1574 SAVE_IT (it2
, it
, it2data
);
1575 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1576 move_it_by_lines (&it
, 1);
1577 if (charpos
< IT_CHARPOS (it
)
1578 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1581 RESTORE_IT (&it2
, &it2
, it2data
);
1582 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1584 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1585 *rtop
= max (0, -it2
.current_y
);
1586 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1587 - it
.last_visible_y
));
1588 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1590 - max (it2
.current_y
,
1591 WINDOW_HEADER_LINE_HEIGHT (w
))));
1595 bidi_unshelve_cache (it2data
, 1);
1597 bidi_unshelve_cache (itdata
, 0);
1600 set_buffer_internal_1 (old_buffer
);
1602 current_header_line_height
= current_mode_line_height
= -1;
1604 if (visible_p
&& w
->hscroll
> 0)
1606 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1607 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1610 /* Debugging code. */
1612 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1613 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1615 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1622 /* Return the next character from STR. Return in *LEN the length of
1623 the character. This is like STRING_CHAR_AND_LENGTH but never
1624 returns an invalid character. If we find one, we return a `?', but
1625 with the length of the invalid character. */
1628 string_char_and_length (const unsigned char *str
, int *len
)
1632 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1633 if (!CHAR_VALID_P (c
))
1634 /* We may not change the length here because other places in Emacs
1635 don't use this function, i.e. they silently accept invalid
1644 /* Given a position POS containing a valid character and byte position
1645 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1647 static struct text_pos
1648 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1650 eassert (STRINGP (string
) && nchars
>= 0);
1652 if (STRING_MULTIBYTE (string
))
1654 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1659 string_char_and_length (p
, &len
);
1662 BYTEPOS (pos
) += len
;
1666 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1672 /* Value is the text position, i.e. character and byte position,
1673 for character position CHARPOS in STRING. */
1675 static inline struct text_pos
1676 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1678 struct text_pos pos
;
1679 eassert (STRINGP (string
));
1680 eassert (charpos
>= 0);
1681 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1686 /* Value is a text position, i.e. character and byte position, for
1687 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1688 means recognize multibyte characters. */
1690 static struct text_pos
1691 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1693 struct text_pos pos
;
1695 eassert (s
!= NULL
);
1696 eassert (charpos
>= 0);
1702 SET_TEXT_POS (pos
, 0, 0);
1705 string_char_and_length ((const unsigned char *) s
, &len
);
1708 BYTEPOS (pos
) += len
;
1712 SET_TEXT_POS (pos
, charpos
, charpos
);
1718 /* Value is the number of characters in C string S. MULTIBYTE_P
1719 non-zero means recognize multibyte characters. */
1722 number_of_chars (const char *s
, int multibyte_p
)
1728 ptrdiff_t rest
= strlen (s
);
1730 const unsigned char *p
= (const unsigned char *) s
;
1732 for (nchars
= 0; rest
> 0; ++nchars
)
1734 string_char_and_length (p
, &len
);
1735 rest
-= len
, p
+= len
;
1739 nchars
= strlen (s
);
1745 /* Compute byte position NEWPOS->bytepos corresponding to
1746 NEWPOS->charpos. POS is a known position in string STRING.
1747 NEWPOS->charpos must be >= POS.charpos. */
1750 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1752 eassert (STRINGP (string
));
1753 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1755 if (STRING_MULTIBYTE (string
))
1756 *newpos
= string_pos_nchars_ahead (pos
, string
,
1757 CHARPOS (*newpos
) - CHARPOS (pos
));
1759 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1763 Return an estimation of the pixel height of mode or header lines on
1764 frame F. FACE_ID specifies what line's height to estimate. */
1767 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1769 #ifdef HAVE_WINDOW_SYSTEM
1770 if (FRAME_WINDOW_P (f
))
1772 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1774 /* This function is called so early when Emacs starts that the face
1775 cache and mode line face are not yet initialized. */
1776 if (FRAME_FACE_CACHE (f
))
1778 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1782 height
= FONT_HEIGHT (face
->font
);
1783 if (face
->box_line_width
> 0)
1784 height
+= 2 * face
->box_line_width
;
1795 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1796 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1797 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1798 not force the value into range. */
1801 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1802 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1805 #ifdef HAVE_WINDOW_SYSTEM
1806 if (FRAME_WINDOW_P (f
))
1808 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1809 even for negative values. */
1811 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1813 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1815 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1816 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1819 STORE_NATIVE_RECT (*bounds
,
1820 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1821 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1822 FRAME_COLUMN_WIDTH (f
) - 1,
1823 FRAME_LINE_HEIGHT (f
) - 1);
1829 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1830 pix_x
= FRAME_TOTAL_COLS (f
);
1834 else if (pix_y
> FRAME_LINES (f
))
1835 pix_y
= FRAME_LINES (f
);
1845 /* Find the glyph under window-relative coordinates X/Y in window W.
1846 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1847 strings. Return in *HPOS and *VPOS the row and column number of
1848 the glyph found. Return in *AREA the glyph area containing X.
1849 Value is a pointer to the glyph found or null if X/Y is not on
1850 text, or we can't tell because W's current matrix is not up to
1855 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1856 int *dx
, int *dy
, int *area
)
1858 struct glyph
*glyph
, *end
;
1859 struct glyph_row
*row
= NULL
;
1862 /* Find row containing Y. Give up if some row is not enabled. */
1863 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1865 row
= MATRIX_ROW (w
->current_matrix
, i
);
1866 if (!row
->enabled_p
)
1868 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1875 /* Give up if Y is not in the window. */
1876 if (i
== w
->current_matrix
->nrows
)
1879 /* Get the glyph area containing X. */
1880 if (w
->pseudo_window_p
)
1887 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1889 *area
= LEFT_MARGIN_AREA
;
1890 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1892 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1895 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1899 *area
= RIGHT_MARGIN_AREA
;
1900 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1904 /* Find glyph containing X. */
1905 glyph
= row
->glyphs
[*area
];
1906 end
= glyph
+ row
->used
[*area
];
1908 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1910 x
-= glyph
->pixel_width
;
1920 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1923 *hpos
= glyph
- row
->glyphs
[*area
];
1927 /* Convert frame-relative x/y to coordinates relative to window W.
1928 Takes pseudo-windows into account. */
1931 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1933 if (w
->pseudo_window_p
)
1935 /* A pseudo-window is always full-width, and starts at the
1936 left edge of the frame, plus a frame border. */
1937 struct frame
*f
= XFRAME (w
->frame
);
1938 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1939 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1943 *x
-= WINDOW_LEFT_EDGE_X (w
);
1944 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1948 #ifdef HAVE_WINDOW_SYSTEM
1951 Return in RECTS[] at most N clipping rectangles for glyph string S.
1952 Return the number of stored rectangles. */
1955 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1962 if (s
->row
->full_width_p
)
1964 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1965 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1966 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1968 /* Unless displaying a mode or menu bar line, which are always
1969 fully visible, clip to the visible part of the row. */
1970 if (s
->w
->pseudo_window_p
)
1971 r
.height
= s
->row
->visible_height
;
1973 r
.height
= s
->height
;
1977 /* This is a text line that may be partially visible. */
1978 r
.x
= window_box_left (s
->w
, s
->area
);
1979 r
.width
= window_box_width (s
->w
, s
->area
);
1980 r
.height
= s
->row
->visible_height
;
1984 if (r
.x
< s
->clip_head
->x
)
1986 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1987 r
.width
-= s
->clip_head
->x
- r
.x
;
1990 r
.x
= s
->clip_head
->x
;
1993 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1995 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1996 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2001 /* If S draws overlapping rows, it's sufficient to use the top and
2002 bottom of the window for clipping because this glyph string
2003 intentionally draws over other lines. */
2004 if (s
->for_overlaps
)
2006 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2007 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2009 /* Alas, the above simple strategy does not work for the
2010 environments with anti-aliased text: if the same text is
2011 drawn onto the same place multiple times, it gets thicker.
2012 If the overlap we are processing is for the erased cursor, we
2013 take the intersection with the rectangle of the cursor. */
2014 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2016 XRectangle rc
, r_save
= r
;
2018 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2019 rc
.y
= s
->w
->phys_cursor
.y
;
2020 rc
.width
= s
->w
->phys_cursor_width
;
2021 rc
.height
= s
->w
->phys_cursor_height
;
2023 x_intersect_rectangles (&r_save
, &rc
, &r
);
2028 /* Don't use S->y for clipping because it doesn't take partially
2029 visible lines into account. For example, it can be negative for
2030 partially visible lines at the top of a window. */
2031 if (!s
->row
->full_width_p
2032 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2033 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2035 r
.y
= max (0, s
->row
->y
);
2038 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2040 /* If drawing the cursor, don't let glyph draw outside its
2041 advertised boundaries. Cleartype does this under some circumstances. */
2042 if (s
->hl
== DRAW_CURSOR
)
2044 struct glyph
*glyph
= s
->first_glyph
;
2049 r
.width
-= s
->x
- r
.x
;
2052 r
.width
= min (r
.width
, glyph
->pixel_width
);
2054 /* If r.y is below window bottom, ensure that we still see a cursor. */
2055 height
= min (glyph
->ascent
+ glyph
->descent
,
2056 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2057 max_y
= window_text_bottom_y (s
->w
) - height
;
2058 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2059 if (s
->ybase
- glyph
->ascent
> max_y
)
2066 /* Don't draw cursor glyph taller than our actual glyph. */
2067 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2068 if (height
< r
.height
)
2070 max_y
= r
.y
+ r
.height
;
2071 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2072 r
.height
= min (max_y
- r
.y
, height
);
2079 XRectangle r_save
= r
;
2081 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2085 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2086 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2088 #ifdef CONVERT_FROM_XRECT
2089 CONVERT_FROM_XRECT (r
, *rects
);
2097 /* If we are processing overlapping and allowed to return
2098 multiple clipping rectangles, we exclude the row of the glyph
2099 string from the clipping rectangle. This is to avoid drawing
2100 the same text on the environment with anti-aliasing. */
2101 #ifdef CONVERT_FROM_XRECT
2104 XRectangle
*rs
= rects
;
2106 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2108 if (s
->for_overlaps
& OVERLAPS_PRED
)
2111 if (r
.y
+ r
.height
> row_y
)
2114 rs
[i
].height
= row_y
- r
.y
;
2120 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2123 if (r
.y
< row_y
+ s
->row
->visible_height
)
2125 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2127 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2128 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2137 #ifdef CONVERT_FROM_XRECT
2138 for (i
= 0; i
< n
; i
++)
2139 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2146 Return in *NR the clipping rectangle for glyph string S. */
2149 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2151 get_glyph_string_clip_rects (s
, nr
, 1);
2156 Return the position and height of the phys cursor in window W.
2157 Set w->phys_cursor_width to width of phys cursor.
2161 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2162 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2164 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2165 int x
, y
, wd
, h
, h0
, y0
;
2167 /* Compute the width of the rectangle to draw. If on a stretch
2168 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2169 rectangle as wide as the glyph, but use a canonical character
2171 wd
= glyph
->pixel_width
- 1;
2172 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2176 x
= w
->phys_cursor
.x
;
2183 if (glyph
->type
== STRETCH_GLYPH
2184 && !x_stretch_cursor_p
)
2185 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2186 w
->phys_cursor_width
= wd
;
2188 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2190 /* If y is below window bottom, ensure that we still see a cursor. */
2191 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2193 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2194 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2196 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2199 h
= max (h
- (y0
- y
) + 1, h0
);
2204 y0
= window_text_bottom_y (w
) - h0
;
2212 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2213 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2218 * Remember which glyph the mouse is over.
2222 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2226 struct glyph_row
*r
, *gr
, *end_row
;
2227 enum window_part part
;
2228 enum glyph_row_area area
;
2229 int x
, y
, width
, height
;
2231 /* Try to determine frame pixel position and size of the glyph under
2232 frame pixel coordinates X/Y on frame F. */
2234 if (!f
->glyphs_initialized_p
2235 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2238 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2239 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2243 w
= XWINDOW (window
);
2244 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2245 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2247 x
= window_relative_x_coord (w
, part
, gx
);
2248 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2250 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2251 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2253 if (w
->pseudo_window_p
)
2256 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2262 case ON_LEFT_MARGIN
:
2263 area
= LEFT_MARGIN_AREA
;
2266 case ON_RIGHT_MARGIN
:
2267 area
= RIGHT_MARGIN_AREA
;
2270 case ON_HEADER_LINE
:
2272 gr
= (part
== ON_HEADER_LINE
2273 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2274 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2277 goto text_glyph_row_found
;
2284 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2285 if (r
->y
+ r
->height
> y
)
2291 text_glyph_row_found
:
2294 struct glyph
*g
= gr
->glyphs
[area
];
2295 struct glyph
*end
= g
+ gr
->used
[area
];
2297 height
= gr
->height
;
2298 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2299 if (gx
+ g
->pixel_width
> x
)
2304 if (g
->type
== IMAGE_GLYPH
)
2306 /* Don't remember when mouse is over image, as
2307 image may have hot-spots. */
2308 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2311 width
= g
->pixel_width
;
2315 /* Use nominal char spacing at end of line. */
2317 gx
+= (x
/ width
) * width
;
2320 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2321 gx
+= window_box_left_offset (w
, area
);
2325 /* Use nominal line height at end of window. */
2326 gx
= (x
/ width
) * width
;
2328 gy
+= (y
/ height
) * height
;
2332 case ON_LEFT_FRINGE
:
2333 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2334 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2335 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2336 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2339 case ON_RIGHT_FRINGE
:
2340 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2341 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2342 : window_box_right_offset (w
, TEXT_AREA
));
2343 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2347 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2349 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2350 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2351 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2353 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2357 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2358 if (r
->y
+ r
->height
> y
)
2365 height
= gr
->height
;
2368 /* Use nominal line height at end of window. */
2370 gy
+= (y
/ height
) * height
;
2377 /* If there is no glyph under the mouse, then we divide the screen
2378 into a grid of the smallest glyph in the frame, and use that
2381 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2382 round down even for negative values. */
2388 gx
= (gx
/ width
) * width
;
2389 gy
= (gy
/ height
) * height
;
2394 gx
+= WINDOW_LEFT_EDGE_X (w
);
2395 gy
+= WINDOW_TOP_EDGE_Y (w
);
2398 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2400 /* Visible feedback for debugging. */
2403 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2404 f
->output_data
.x
->normal_gc
,
2405 gx
, gy
, width
, height
);
2411 #endif /* HAVE_WINDOW_SYSTEM */
2414 /***********************************************************************
2415 Lisp form evaluation
2416 ***********************************************************************/
2418 /* Error handler for safe_eval and safe_call. */
2421 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2423 add_to_log ("Error during redisplay: %S signalled %S",
2424 Flist (nargs
, args
), arg
);
2428 /* Call function FUNC with the rest of NARGS - 1 arguments
2429 following. Return the result, or nil if something went
2430 wrong. Prevent redisplay during the evaluation. */
2433 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2437 if (inhibit_eval_during_redisplay
)
2443 ptrdiff_t count
= SPECPDL_INDEX ();
2444 struct gcpro gcpro1
;
2445 Lisp_Object
*args
= alloca (nargs
* word_size
);
2448 va_start (ap
, func
);
2449 for (i
= 1; i
< nargs
; i
++)
2450 args
[i
] = va_arg (ap
, Lisp_Object
);
2454 gcpro1
.nvars
= nargs
;
2455 specbind (Qinhibit_redisplay
, Qt
);
2456 /* Use Qt to ensure debugger does not run,
2457 so there is no possibility of wanting to redisplay. */
2458 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2461 val
= unbind_to (count
, val
);
2468 /* Call function FN with one argument ARG.
2469 Return the result, or nil if something went wrong. */
2472 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2474 return safe_call (2, fn
, arg
);
2477 static Lisp_Object Qeval
;
2480 safe_eval (Lisp_Object sexpr
)
2482 return safe_call1 (Qeval
, sexpr
);
2485 /* Call function FN with two arguments ARG1 and ARG2.
2486 Return the result, or nil if something went wrong. */
2489 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2491 return safe_call (3, fn
, arg1
, arg2
);
2496 /***********************************************************************
2498 ***********************************************************************/
2502 /* Define CHECK_IT to perform sanity checks on iterators.
2503 This is for debugging. It is too slow to do unconditionally. */
2506 check_it (struct it
*it
)
2508 if (it
->method
== GET_FROM_STRING
)
2510 eassert (STRINGP (it
->string
));
2511 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2515 eassert (IT_STRING_CHARPOS (*it
) < 0);
2516 if (it
->method
== GET_FROM_BUFFER
)
2518 /* Check that character and byte positions agree. */
2519 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2524 eassert (it
->current
.dpvec_index
>= 0);
2526 eassert (it
->current
.dpvec_index
< 0);
2529 #define CHECK_IT(IT) check_it ((IT))
2533 #define CHECK_IT(IT) (void) 0
2538 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2540 /* Check that the window end of window W is what we expect it
2541 to be---the last row in the current matrix displaying text. */
2544 check_window_end (struct window
*w
)
2546 if (!MINI_WINDOW_P (w
)
2547 && !NILP (w
->window_end_valid
))
2549 struct glyph_row
*row
;
2550 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2551 XFASTINT (w
->window_end_vpos
)),
2553 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2554 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2558 #define CHECK_WINDOW_END(W) check_window_end ((W))
2562 #define CHECK_WINDOW_END(W) (void) 0
2564 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2568 /***********************************************************************
2569 Iterator initialization
2570 ***********************************************************************/
2572 /* Initialize IT for displaying current_buffer in window W, starting
2573 at character position CHARPOS. CHARPOS < 0 means that no buffer
2574 position is specified which is useful when the iterator is assigned
2575 a position later. BYTEPOS is the byte position corresponding to
2576 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2578 If ROW is not null, calls to produce_glyphs with IT as parameter
2579 will produce glyphs in that row.
2581 BASE_FACE_ID is the id of a base face to use. It must be one of
2582 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2583 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2584 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2586 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2587 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2588 will be initialized to use the corresponding mode line glyph row of
2589 the desired matrix of W. */
2592 init_iterator (struct it
*it
, struct window
*w
,
2593 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2594 struct glyph_row
*row
, enum face_id base_face_id
)
2596 int highlight_region_p
;
2597 enum face_id remapped_base_face_id
= base_face_id
;
2599 /* Some precondition checks. */
2600 eassert (w
!= NULL
&& it
!= NULL
);
2601 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2604 /* If face attributes have been changed since the last redisplay,
2605 free realized faces now because they depend on face definitions
2606 that might have changed. Don't free faces while there might be
2607 desired matrices pending which reference these faces. */
2608 if (face_change_count
&& !inhibit_free_realized_faces
)
2610 face_change_count
= 0;
2611 free_all_realized_faces (Qnil
);
2614 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2615 if (! NILP (Vface_remapping_alist
))
2616 remapped_base_face_id
2617 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2619 /* Use one of the mode line rows of W's desired matrix if
2623 if (base_face_id
== MODE_LINE_FACE_ID
2624 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2625 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2626 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2627 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2631 memset (it
, 0, sizeof *it
);
2632 it
->current
.overlay_string_index
= -1;
2633 it
->current
.dpvec_index
= -1;
2634 it
->base_face_id
= remapped_base_face_id
;
2636 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2637 it
->paragraph_embedding
= L2R
;
2638 it
->bidi_it
.string
.lstring
= Qnil
;
2639 it
->bidi_it
.string
.s
= NULL
;
2640 it
->bidi_it
.string
.bufpos
= 0;
2642 /* The window in which we iterate over current_buffer: */
2643 XSETWINDOW (it
->window
, w
);
2645 it
->f
= XFRAME (w
->frame
);
2649 /* Extra space between lines (on window systems only). */
2650 if (base_face_id
== DEFAULT_FACE_ID
2651 && FRAME_WINDOW_P (it
->f
))
2653 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2654 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2655 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2656 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2657 * FRAME_LINE_HEIGHT (it
->f
));
2658 else if (it
->f
->extra_line_spacing
> 0)
2659 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2660 it
->max_extra_line_spacing
= 0;
2663 /* If realized faces have been removed, e.g. because of face
2664 attribute changes of named faces, recompute them. When running
2665 in batch mode, the face cache of the initial frame is null. If
2666 we happen to get called, make a dummy face cache. */
2667 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2668 init_frame_faces (it
->f
);
2669 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2670 recompute_basic_faces (it
->f
);
2672 /* Current value of the `slice', `space-width', and 'height' properties. */
2673 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2674 it
->space_width
= Qnil
;
2675 it
->font_height
= Qnil
;
2676 it
->override_ascent
= -1;
2678 /* Are control characters displayed as `^C'? */
2679 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2681 /* -1 means everything between a CR and the following line end
2682 is invisible. >0 means lines indented more than this value are
2684 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2686 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2688 : (!NILP (BVAR (current_buffer
, selective_display
))
2690 it
->selective_display_ellipsis_p
2691 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2693 /* Display table to use. */
2694 it
->dp
= window_display_table (w
);
2696 /* Are multibyte characters enabled in current_buffer? */
2697 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2699 /* Non-zero if we should highlight the region. */
2701 = (!NILP (Vtransient_mark_mode
)
2702 && !NILP (BVAR (current_buffer
, mark_active
))
2703 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2705 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2706 start and end of a visible region in window IT->w. Set both to
2707 -1 to indicate no region. */
2708 if (highlight_region_p
2709 /* Maybe highlight only in selected window. */
2710 && (/* Either show region everywhere. */
2711 highlight_nonselected_windows
2712 /* Or show region in the selected window. */
2713 || w
== XWINDOW (selected_window
)
2714 /* Or show the region if we are in the mini-buffer and W is
2715 the window the mini-buffer refers to. */
2716 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2717 && WINDOWP (minibuf_selected_window
)
2718 && w
== XWINDOW (minibuf_selected_window
))))
2720 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2721 it
->region_beg_charpos
= min (PT
, markpos
);
2722 it
->region_end_charpos
= max (PT
, markpos
);
2725 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2727 /* Get the position at which the redisplay_end_trigger hook should
2728 be run, if it is to be run at all. */
2729 if (MARKERP (w
->redisplay_end_trigger
)
2730 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2731 it
->redisplay_end_trigger_charpos
2732 = marker_position (w
->redisplay_end_trigger
);
2733 else if (INTEGERP (w
->redisplay_end_trigger
))
2734 it
->redisplay_end_trigger_charpos
=
2735 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2737 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2739 /* Are lines in the display truncated? */
2740 if (base_face_id
!= DEFAULT_FACE_ID
2742 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2743 && ((!NILP (Vtruncate_partial_width_windows
)
2744 && !INTEGERP (Vtruncate_partial_width_windows
))
2745 || (INTEGERP (Vtruncate_partial_width_windows
)
2746 && (WINDOW_TOTAL_COLS (it
->w
)
2747 < XINT (Vtruncate_partial_width_windows
))))))
2748 it
->line_wrap
= TRUNCATE
;
2749 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2750 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2751 ? WINDOW_WRAP
: WORD_WRAP
;
2753 it
->line_wrap
= TRUNCATE
;
2755 /* Get dimensions of truncation and continuation glyphs. These are
2756 displayed as fringe bitmaps under X, but we need them for such
2757 frames when the fringes are turned off. But leave the dimensions
2758 zero for tooltip frames, as these glyphs look ugly there and also
2759 sabotage calculations of tooltip dimensions in x-show-tip. */
2760 #ifdef HAVE_WINDOW_SYSTEM
2761 if (!(FRAME_WINDOW_P (it
->f
)
2762 && FRAMEP (tip_frame
)
2763 && it
->f
== XFRAME (tip_frame
)))
2766 if (it
->line_wrap
== TRUNCATE
)
2768 /* We will need the truncation glyph. */
2769 eassert (it
->glyph_row
== NULL
);
2770 produce_special_glyphs (it
, IT_TRUNCATION
);
2771 it
->truncation_pixel_width
= it
->pixel_width
;
2775 /* We will need the continuation glyph. */
2776 eassert (it
->glyph_row
== NULL
);
2777 produce_special_glyphs (it
, IT_CONTINUATION
);
2778 it
->continuation_pixel_width
= it
->pixel_width
;
2782 /* Reset these values to zero because the produce_special_glyphs
2783 above has changed them. */
2784 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2785 it
->phys_ascent
= it
->phys_descent
= 0;
2787 /* Set this after getting the dimensions of truncation and
2788 continuation glyphs, so that we don't produce glyphs when calling
2789 produce_special_glyphs, above. */
2790 it
->glyph_row
= row
;
2791 it
->area
= TEXT_AREA
;
2793 /* Forget any previous info about this row being reversed. */
2795 it
->glyph_row
->reversed_p
= 0;
2797 /* Get the dimensions of the display area. The display area
2798 consists of the visible window area plus a horizontally scrolled
2799 part to the left of the window. All x-values are relative to the
2800 start of this total display area. */
2801 if (base_face_id
!= DEFAULT_FACE_ID
)
2803 /* Mode lines, menu bar in terminal frames. */
2804 it
->first_visible_x
= 0;
2805 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2809 it
->first_visible_x
=
2810 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2811 it
->last_visible_x
= (it
->first_visible_x
2812 + window_box_width (w
, TEXT_AREA
));
2814 /* If we truncate lines, leave room for the truncation glyph(s) at
2815 the right margin. Otherwise, leave room for the continuation
2816 glyph(s). Done only if the window has no fringes. Since we
2817 don't know at this point whether there will be any R2L lines in
2818 the window, we reserve space for truncation/continuation glyphs
2819 even if only one of the fringes is absent. */
2820 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2821 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2823 if (it
->line_wrap
== TRUNCATE
)
2824 it
->last_visible_x
-= it
->truncation_pixel_width
;
2826 it
->last_visible_x
-= it
->continuation_pixel_width
;
2829 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2830 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2833 /* Leave room for a border glyph. */
2834 if (!FRAME_WINDOW_P (it
->f
)
2835 && !WINDOW_RIGHTMOST_P (it
->w
))
2836 it
->last_visible_x
-= 1;
2838 it
->last_visible_y
= window_text_bottom_y (w
);
2840 /* For mode lines and alike, arrange for the first glyph having a
2841 left box line if the face specifies a box. */
2842 if (base_face_id
!= DEFAULT_FACE_ID
)
2846 it
->face_id
= remapped_base_face_id
;
2848 /* If we have a boxed mode line, make the first character appear
2849 with a left box line. */
2850 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2851 if (face
->box
!= FACE_NO_BOX
)
2852 it
->start_of_box_run_p
= 1;
2855 /* If a buffer position was specified, set the iterator there,
2856 getting overlays and face properties from that position. */
2857 if (charpos
>= BUF_BEG (current_buffer
))
2859 it
->end_charpos
= ZV
;
2860 IT_CHARPOS (*it
) = charpos
;
2862 /* We will rely on `reseat' to set this up properly, via
2863 handle_face_prop. */
2864 it
->face_id
= it
->base_face_id
;
2866 /* Compute byte position if not specified. */
2867 if (bytepos
< charpos
)
2868 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2870 IT_BYTEPOS (*it
) = bytepos
;
2872 it
->start
= it
->current
;
2873 /* Do we need to reorder bidirectional text? Not if this is a
2874 unibyte buffer: by definition, none of the single-byte
2875 characters are strong R2L, so no reordering is needed. And
2876 bidi.c doesn't support unibyte buffers anyway. Also, don't
2877 reorder while we are loading loadup.el, since the tables of
2878 character properties needed for reordering are not yet
2882 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2885 /* If we are to reorder bidirectional text, init the bidi
2889 /* Note the paragraph direction that this buffer wants to
2891 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2893 it
->paragraph_embedding
= L2R
;
2894 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2896 it
->paragraph_embedding
= R2L
;
2898 it
->paragraph_embedding
= NEUTRAL_DIR
;
2899 bidi_unshelve_cache (NULL
, 0);
2900 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2904 /* Compute faces etc. */
2905 reseat (it
, it
->current
.pos
, 1);
2912 /* Initialize IT for the display of window W with window start POS. */
2915 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2917 struct glyph_row
*row
;
2918 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2920 row
= w
->desired_matrix
->rows
+ first_vpos
;
2921 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2922 it
->first_vpos
= first_vpos
;
2924 /* Don't reseat to previous visible line start if current start
2925 position is in a string or image. */
2926 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2928 int start_at_line_beg_p
;
2929 int first_y
= it
->current_y
;
2931 /* If window start is not at a line start, skip forward to POS to
2932 get the correct continuation lines width. */
2933 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2934 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2935 if (!start_at_line_beg_p
)
2939 reseat_at_previous_visible_line_start (it
);
2940 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2942 new_x
= it
->current_x
+ it
->pixel_width
;
2944 /* If lines are continued, this line may end in the middle
2945 of a multi-glyph character (e.g. a control character
2946 displayed as \003, or in the middle of an overlay
2947 string). In this case move_it_to above will not have
2948 taken us to the start of the continuation line but to the
2949 end of the continued line. */
2950 if (it
->current_x
> 0
2951 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2952 && (/* And glyph doesn't fit on the line. */
2953 new_x
> it
->last_visible_x
2954 /* Or it fits exactly and we're on a window
2956 || (new_x
== it
->last_visible_x
2957 && FRAME_WINDOW_P (it
->f
)
2958 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2959 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2960 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2962 if ((it
->current
.dpvec_index
>= 0
2963 || it
->current
.overlay_string_index
>= 0)
2964 /* If we are on a newline from a display vector or
2965 overlay string, then we are already at the end of
2966 a screen line; no need to go to the next line in
2967 that case, as this line is not really continued.
2968 (If we do go to the next line, C-e will not DTRT.) */
2971 set_iterator_to_next (it
, 1);
2972 move_it_in_display_line_to (it
, -1, -1, 0);
2975 it
->continuation_lines_width
+= it
->current_x
;
2977 /* If the character at POS is displayed via a display
2978 vector, move_it_to above stops at the final glyph of
2979 IT->dpvec. To make the caller redisplay that character
2980 again (a.k.a. start at POS), we need to reset the
2981 dpvec_index to the beginning of IT->dpvec. */
2982 else if (it
->current
.dpvec_index
>= 0)
2983 it
->current
.dpvec_index
= 0;
2985 /* We're starting a new display line, not affected by the
2986 height of the continued line, so clear the appropriate
2987 fields in the iterator structure. */
2988 it
->max_ascent
= it
->max_descent
= 0;
2989 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2991 it
->current_y
= first_y
;
2993 it
->current_x
= it
->hpos
= 0;
2999 /* Return 1 if POS is a position in ellipses displayed for invisible
3000 text. W is the window we display, for text property lookup. */
3003 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3005 Lisp_Object prop
, window
;
3007 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3009 /* If POS specifies a position in a display vector, this might
3010 be for an ellipsis displayed for invisible text. We won't
3011 get the iterator set up for delivering that ellipsis unless
3012 we make sure that it gets aware of the invisible text. */
3013 if (pos
->dpvec_index
>= 0
3014 && pos
->overlay_string_index
< 0
3015 && CHARPOS (pos
->string_pos
) < 0
3017 && (XSETWINDOW (window
, w
),
3018 prop
= Fget_char_property (make_number (charpos
),
3019 Qinvisible
, window
),
3020 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3022 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3024 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3031 /* Initialize IT for stepping through current_buffer in window W,
3032 starting at position POS that includes overlay string and display
3033 vector/ control character translation position information. Value
3034 is zero if there are overlay strings with newlines at POS. */
3037 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3039 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3040 int i
, overlay_strings_with_newlines
= 0;
3042 /* If POS specifies a position in a display vector, this might
3043 be for an ellipsis displayed for invisible text. We won't
3044 get the iterator set up for delivering that ellipsis unless
3045 we make sure that it gets aware of the invisible text. */
3046 if (in_ellipses_for_invisible_text_p (pos
, w
))
3052 /* Keep in mind: the call to reseat in init_iterator skips invisible
3053 text, so we might end up at a position different from POS. This
3054 is only a problem when POS is a row start after a newline and an
3055 overlay starts there with an after-string, and the overlay has an
3056 invisible property. Since we don't skip invisible text in
3057 display_line and elsewhere immediately after consuming the
3058 newline before the row start, such a POS will not be in a string,
3059 but the call to init_iterator below will move us to the
3061 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3063 /* This only scans the current chunk -- it should scan all chunks.
3064 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3065 to 16 in 22.1 to make this a lesser problem. */
3066 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3068 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3069 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3071 while (s
< e
&& *s
!= '\n')
3076 overlay_strings_with_newlines
= 1;
3081 /* If position is within an overlay string, set up IT to the right
3083 if (pos
->overlay_string_index
>= 0)
3087 /* If the first overlay string happens to have a `display'
3088 property for an image, the iterator will be set up for that
3089 image, and we have to undo that setup first before we can
3090 correct the overlay string index. */
3091 if (it
->method
== GET_FROM_IMAGE
)
3094 /* We already have the first chunk of overlay strings in
3095 IT->overlay_strings. Load more until the one for
3096 pos->overlay_string_index is in IT->overlay_strings. */
3097 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3099 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3100 it
->current
.overlay_string_index
= 0;
3103 load_overlay_strings (it
, 0);
3104 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3108 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3109 relative_index
= (it
->current
.overlay_string_index
3110 % OVERLAY_STRING_CHUNK_SIZE
);
3111 it
->string
= it
->overlay_strings
[relative_index
];
3112 eassert (STRINGP (it
->string
));
3113 it
->current
.string_pos
= pos
->string_pos
;
3114 it
->method
= GET_FROM_STRING
;
3117 if (CHARPOS (pos
->string_pos
) >= 0)
3119 /* Recorded position is not in an overlay string, but in another
3120 string. This can only be a string from a `display' property.
3121 IT should already be filled with that string. */
3122 it
->current
.string_pos
= pos
->string_pos
;
3123 eassert (STRINGP (it
->string
));
3126 /* Restore position in display vector translations, control
3127 character translations or ellipses. */
3128 if (pos
->dpvec_index
>= 0)
3130 if (it
->dpvec
== NULL
)
3131 get_next_display_element (it
);
3132 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3133 it
->current
.dpvec_index
= pos
->dpvec_index
;
3137 return !overlay_strings_with_newlines
;
3141 /* Initialize IT for stepping through current_buffer in window W
3142 starting at ROW->start. */
3145 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3147 init_from_display_pos (it
, w
, &row
->start
);
3148 it
->start
= row
->start
;
3149 it
->continuation_lines_width
= row
->continuation_lines_width
;
3154 /* Initialize IT for stepping through current_buffer in window W
3155 starting in the line following ROW, i.e. starting at ROW->end.
3156 Value is zero if there are overlay strings with newlines at ROW's
3160 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3164 if (init_from_display_pos (it
, w
, &row
->end
))
3166 if (row
->continued_p
)
3167 it
->continuation_lines_width
3168 = row
->continuation_lines_width
+ row
->pixel_width
;
3179 /***********************************************************************
3181 ***********************************************************************/
3183 /* Called when IT reaches IT->stop_charpos. Handle text property and
3184 overlay changes. Set IT->stop_charpos to the next position where
3188 handle_stop (struct it
*it
)
3190 enum prop_handled handled
;
3191 int handle_overlay_change_p
;
3195 it
->current
.dpvec_index
= -1;
3196 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3197 it
->ignore_overlay_strings_at_pos_p
= 0;
3200 /* Use face of preceding text for ellipsis (if invisible) */
3201 if (it
->selective_display_ellipsis_p
)
3202 it
->saved_face_id
= it
->face_id
;
3206 handled
= HANDLED_NORMALLY
;
3208 /* Call text property handlers. */
3209 for (p
= it_props
; p
->handler
; ++p
)
3211 handled
= p
->handler (it
);
3213 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3215 else if (handled
== HANDLED_RETURN
)
3217 /* We still want to show before and after strings from
3218 overlays even if the actual buffer text is replaced. */
3219 if (!handle_overlay_change_p
3221 /* Don't call get_overlay_strings_1 if we already
3222 have overlay strings loaded, because doing so
3223 will load them again and push the iterator state
3224 onto the stack one more time, which is not
3225 expected by the rest of the code that processes
3227 || (it
->current
.overlay_string_index
< 0
3228 ? !get_overlay_strings_1 (it
, 0, 0)
3232 setup_for_ellipsis (it
, 0);
3233 /* When handling a display spec, we might load an
3234 empty string. In that case, discard it here. We
3235 used to discard it in handle_single_display_spec,
3236 but that causes get_overlay_strings_1, above, to
3237 ignore overlay strings that we must check. */
3238 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3242 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3246 it
->ignore_overlay_strings_at_pos_p
= 1;
3247 it
->string_from_display_prop_p
= 0;
3248 it
->from_disp_prop_p
= 0;
3249 handle_overlay_change_p
= 0;
3251 handled
= HANDLED_RECOMPUTE_PROPS
;
3254 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3255 handle_overlay_change_p
= 0;
3258 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3260 /* Don't check for overlay strings below when set to deliver
3261 characters from a display vector. */
3262 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3263 handle_overlay_change_p
= 0;
3265 /* Handle overlay changes.
3266 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3267 if it finds overlays. */
3268 if (handle_overlay_change_p
)
3269 handled
= handle_overlay_change (it
);
3274 setup_for_ellipsis (it
, 0);
3278 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3280 /* Determine where to stop next. */
3281 if (handled
== HANDLED_NORMALLY
)
3282 compute_stop_pos (it
);
3286 /* Compute IT->stop_charpos from text property and overlay change
3287 information for IT's current position. */
3290 compute_stop_pos (struct it
*it
)
3292 register INTERVAL iv
, next_iv
;
3293 Lisp_Object object
, limit
, position
;
3294 ptrdiff_t charpos
, bytepos
;
3296 if (STRINGP (it
->string
))
3298 /* Strings are usually short, so don't limit the search for
3300 it
->stop_charpos
= it
->end_charpos
;
3301 object
= it
->string
;
3303 charpos
= IT_STRING_CHARPOS (*it
);
3304 bytepos
= IT_STRING_BYTEPOS (*it
);
3310 /* If end_charpos is out of range for some reason, such as a
3311 misbehaving display function, rationalize it (Bug#5984). */
3312 if (it
->end_charpos
> ZV
)
3313 it
->end_charpos
= ZV
;
3314 it
->stop_charpos
= it
->end_charpos
;
3316 /* If next overlay change is in front of the current stop pos
3317 (which is IT->end_charpos), stop there. Note: value of
3318 next_overlay_change is point-max if no overlay change
3320 charpos
= IT_CHARPOS (*it
);
3321 bytepos
= IT_BYTEPOS (*it
);
3322 pos
= next_overlay_change (charpos
);
3323 if (pos
< it
->stop_charpos
)
3324 it
->stop_charpos
= pos
;
3326 /* If showing the region, we have to stop at the region
3327 start or end because the face might change there. */
3328 if (it
->region_beg_charpos
> 0)
3330 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3331 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3332 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3333 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3336 /* Set up variables for computing the stop position from text
3337 property changes. */
3338 XSETBUFFER (object
, current_buffer
);
3339 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3342 /* Get the interval containing IT's position. Value is a null
3343 interval if there isn't such an interval. */
3344 position
= make_number (charpos
);
3345 iv
= validate_interval_range (object
, &position
, &position
, 0);
3348 Lisp_Object values_here
[LAST_PROP_IDX
];
3351 /* Get properties here. */
3352 for (p
= it_props
; p
->handler
; ++p
)
3353 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3355 /* Look for an interval following iv that has different
3357 for (next_iv
= next_interval (iv
);
3360 || XFASTINT (limit
) > next_iv
->position
));
3361 next_iv
= next_interval (next_iv
))
3363 for (p
= it_props
; p
->handler
; ++p
)
3365 Lisp_Object new_value
;
3367 new_value
= textget (next_iv
->plist
, *p
->name
);
3368 if (!EQ (values_here
[p
->idx
], new_value
))
3378 if (INTEGERP (limit
)
3379 && next_iv
->position
>= XFASTINT (limit
))
3380 /* No text property change up to limit. */
3381 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3383 /* Text properties change in next_iv. */
3384 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3388 if (it
->cmp_it
.id
< 0)
3390 ptrdiff_t stoppos
= it
->end_charpos
;
3392 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3394 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3395 stoppos
, it
->string
);
3398 eassert (STRINGP (it
->string
)
3399 || (it
->stop_charpos
>= BEGV
3400 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3404 /* Return the position of the next overlay change after POS in
3405 current_buffer. Value is point-max if no overlay change
3406 follows. This is like `next-overlay-change' but doesn't use
3410 next_overlay_change (ptrdiff_t pos
)
3412 ptrdiff_t i
, noverlays
;
3414 Lisp_Object
*overlays
;
3416 /* Get all overlays at the given position. */
3417 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3419 /* If any of these overlays ends before endpos,
3420 use its ending point instead. */
3421 for (i
= 0; i
< noverlays
; ++i
)
3426 oend
= OVERLAY_END (overlays
[i
]);
3427 oendpos
= OVERLAY_POSITION (oend
);
3428 endpos
= min (endpos
, oendpos
);
3434 /* How many characters forward to search for a display property or
3435 display string. Searching too far forward makes the bidi display
3436 sluggish, especially in small windows. */
3437 #define MAX_DISP_SCAN 250
3439 /* Return the character position of a display string at or after
3440 position specified by POSITION. If no display string exists at or
3441 after POSITION, return ZV. A display string is either an overlay
3442 with `display' property whose value is a string, or a `display'
3443 text property whose value is a string. STRING is data about the
3444 string to iterate; if STRING->lstring is nil, we are iterating a
3445 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3446 on a GUI frame. DISP_PROP is set to zero if we searched
3447 MAX_DISP_SCAN characters forward without finding any display
3448 strings, non-zero otherwise. It is set to 2 if the display string
3449 uses any kind of `(space ...)' spec that will produce a stretch of
3450 white space in the text area. */
3452 compute_display_string_pos (struct text_pos
*position
,
3453 struct bidi_string_data
*string
,
3454 int frame_window_p
, int *disp_prop
)
3456 /* OBJECT = nil means current buffer. */
3457 Lisp_Object object
=
3458 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3459 Lisp_Object pos
, spec
, limpos
;
3460 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3461 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3462 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3463 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3465 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3466 struct text_pos tpos
;
3472 /* We don't support display properties whose values are strings
3473 that have display string properties. */
3474 || string
->from_disp_str
3475 /* C strings cannot have display properties. */
3476 || (string
->s
&& !STRINGP (object
)))
3482 /* If the character at CHARPOS is where the display string begins,
3484 pos
= make_number (charpos
);
3485 if (STRINGP (object
))
3486 bufpos
= string
->bufpos
;
3490 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3492 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3495 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3503 /* Look forward for the first character with a `display' property
3504 that will replace the underlying text when displayed. */
3505 limpos
= make_number (lim
);
3507 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3508 CHARPOS (tpos
) = XFASTINT (pos
);
3509 if (CHARPOS (tpos
) >= lim
)
3514 if (STRINGP (object
))
3515 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3517 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3518 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3519 if (!STRINGP (object
))
3520 bufpos
= CHARPOS (tpos
);
3521 } while (NILP (spec
)
3522 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3523 bufpos
, frame_window_p
)));
3527 return CHARPOS (tpos
);
3530 /* Return the character position of the end of the display string that
3531 started at CHARPOS. If there's no display string at CHARPOS,
3532 return -1. A display string is either an overlay with `display'
3533 property whose value is a string or a `display' text property whose
3534 value is a string. */
3536 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3538 /* OBJECT = nil means current buffer. */
3539 Lisp_Object object
=
3540 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3541 Lisp_Object pos
= make_number (charpos
);
3543 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3545 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3548 /* It could happen that the display property or overlay was removed
3549 since we found it in compute_display_string_pos above. One way
3550 this can happen is if JIT font-lock was called (through
3551 handle_fontified_prop), and jit-lock-functions remove text
3552 properties or overlays from the portion of buffer that includes
3553 CHARPOS. Muse mode is known to do that, for example. In this
3554 case, we return -1 to the caller, to signal that no display
3555 string is actually present at CHARPOS. See bidi_fetch_char for
3556 how this is handled.
3558 An alternative would be to never look for display properties past
3559 it->stop_charpos. But neither compute_display_string_pos nor
3560 bidi_fetch_char that calls it know or care where the next
3562 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3565 /* Look forward for the first character where the `display' property
3567 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3569 return XFASTINT (pos
);
3574 /***********************************************************************
3576 ***********************************************************************/
3578 /* Handle changes in the `fontified' property of the current buffer by
3579 calling hook functions from Qfontification_functions to fontify
3582 static enum prop_handled
3583 handle_fontified_prop (struct it
*it
)
3585 Lisp_Object prop
, pos
;
3586 enum prop_handled handled
= HANDLED_NORMALLY
;
3588 if (!NILP (Vmemory_full
))
3591 /* Get the value of the `fontified' property at IT's current buffer
3592 position. (The `fontified' property doesn't have a special
3593 meaning in strings.) If the value is nil, call functions from
3594 Qfontification_functions. */
3595 if (!STRINGP (it
->string
)
3597 && !NILP (Vfontification_functions
)
3598 && !NILP (Vrun_hooks
)
3599 && (pos
= make_number (IT_CHARPOS (*it
)),
3600 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3601 /* Ignore the special cased nil value always present at EOB since
3602 no amount of fontifying will be able to change it. */
3603 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3605 ptrdiff_t count
= SPECPDL_INDEX ();
3607 struct buffer
*obuf
= current_buffer
;
3608 int begv
= BEGV
, zv
= ZV
;
3609 int old_clip_changed
= current_buffer
->clip_changed
;
3611 val
= Vfontification_functions
;
3612 specbind (Qfontification_functions
, Qnil
);
3614 eassert (it
->end_charpos
== ZV
);
3616 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3617 safe_call1 (val
, pos
);
3620 Lisp_Object fns
, fn
;
3621 struct gcpro gcpro1
, gcpro2
;
3626 for (; CONSP (val
); val
= XCDR (val
))
3632 /* A value of t indicates this hook has a local
3633 binding; it means to run the global binding too.
3634 In a global value, t should not occur. If it
3635 does, we must ignore it to avoid an endless
3637 for (fns
= Fdefault_value (Qfontification_functions
);
3643 safe_call1 (fn
, pos
);
3647 safe_call1 (fn
, pos
);
3653 unbind_to (count
, Qnil
);
3655 /* Fontification functions routinely call `save-restriction'.
3656 Normally, this tags clip_changed, which can confuse redisplay
3657 (see discussion in Bug#6671). Since we don't perform any
3658 special handling of fontification changes in the case where
3659 `save-restriction' isn't called, there's no point doing so in
3660 this case either. So, if the buffer's restrictions are
3661 actually left unchanged, reset clip_changed. */
3662 if (obuf
== current_buffer
)
3664 if (begv
== BEGV
&& zv
== ZV
)
3665 current_buffer
->clip_changed
= old_clip_changed
;
3667 /* There isn't much we can reasonably do to protect against
3668 misbehaving fontification, but here's a fig leaf. */
3669 else if (!NILP (BVAR (obuf
, name
)))
3670 set_buffer_internal_1 (obuf
);
3672 /* The fontification code may have added/removed text.
3673 It could do even a lot worse, but let's at least protect against
3674 the most obvious case where only the text past `pos' gets changed',
3675 as is/was done in grep.el where some escapes sequences are turned
3676 into face properties (bug#7876). */
3677 it
->end_charpos
= ZV
;
3679 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3680 something. This avoids an endless loop if they failed to
3681 fontify the text for which reason ever. */
3682 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3683 handled
= HANDLED_RECOMPUTE_PROPS
;
3691 /***********************************************************************
3693 ***********************************************************************/
3695 /* Set up iterator IT from face properties at its current position.
3696 Called from handle_stop. */
3698 static enum prop_handled
3699 handle_face_prop (struct it
*it
)
3702 ptrdiff_t next_stop
;
3704 if (!STRINGP (it
->string
))
3707 = face_at_buffer_position (it
->w
,
3709 it
->region_beg_charpos
,
3710 it
->region_end_charpos
,
3713 + TEXT_PROP_DISTANCE_LIMIT
),
3714 0, it
->base_face_id
);
3716 /* Is this a start of a run of characters with box face?
3717 Caveat: this can be called for a freshly initialized
3718 iterator; face_id is -1 in this case. We know that the new
3719 face will not change until limit, i.e. if the new face has a
3720 box, all characters up to limit will have one. But, as
3721 usual, we don't know whether limit is really the end. */
3722 if (new_face_id
!= it
->face_id
)
3724 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3726 /* If new face has a box but old face has not, this is
3727 the start of a run of characters with box, i.e. it has
3728 a shadow on the left side. The value of face_id of the
3729 iterator will be -1 if this is the initial call that gets
3730 the face. In this case, we have to look in front of IT's
3731 position and see whether there is a face != new_face_id. */
3732 it
->start_of_box_run_p
3733 = (new_face
->box
!= FACE_NO_BOX
3734 && (it
->face_id
>= 0
3735 || IT_CHARPOS (*it
) == BEG
3736 || new_face_id
!= face_before_it_pos (it
)));
3737 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3745 Lisp_Object from_overlay
3746 = (it
->current
.overlay_string_index
>= 0
3747 ? it
->string_overlays
[it
->current
.overlay_string_index
3748 % OVERLAY_STRING_CHUNK_SIZE
]
3751 /* See if we got to this string directly or indirectly from
3752 an overlay property. That includes the before-string or
3753 after-string of an overlay, strings in display properties
3754 provided by an overlay, their text properties, etc.
3756 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3757 if (! NILP (from_overlay
))
3758 for (i
= it
->sp
- 1; i
>= 0; i
--)
3760 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3762 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3763 % OVERLAY_STRING_CHUNK_SIZE
];
3764 else if (! NILP (it
->stack
[i
].from_overlay
))
3765 from_overlay
= it
->stack
[i
].from_overlay
;
3767 if (!NILP (from_overlay
))
3771 if (! NILP (from_overlay
))
3773 bufpos
= IT_CHARPOS (*it
);
3774 /* For a string from an overlay, the base face depends
3775 only on text properties and ignores overlays. */
3777 = face_for_overlay_string (it
->w
,
3779 it
->region_beg_charpos
,
3780 it
->region_end_charpos
,
3783 + TEXT_PROP_DISTANCE_LIMIT
),
3791 /* For strings from a `display' property, use the face at
3792 IT's current buffer position as the base face to merge
3793 with, so that overlay strings appear in the same face as
3794 surrounding text, unless they specify their own
3796 base_face_id
= it
->string_from_prefix_prop_p
3798 : underlying_face_id (it
);
3801 new_face_id
= face_at_string_position (it
->w
,
3803 IT_STRING_CHARPOS (*it
),
3805 it
->region_beg_charpos
,
3806 it
->region_end_charpos
,
3810 /* Is this a start of a run of characters with box? Caveat:
3811 this can be called for a freshly allocated iterator; face_id
3812 is -1 is this case. We know that the new face will not
3813 change until the next check pos, i.e. if the new face has a
3814 box, all characters up to that position will have a
3815 box. But, as usual, we don't know whether that position
3816 is really the end. */
3817 if (new_face_id
!= it
->face_id
)
3819 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3820 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3822 /* If new face has a box but old face hasn't, this is the
3823 start of a run of characters with box, i.e. it has a
3824 shadow on the left side. */
3825 it
->start_of_box_run_p
3826 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3827 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3831 it
->face_id
= new_face_id
;
3832 return HANDLED_NORMALLY
;
3836 /* Return the ID of the face ``underlying'' IT's current position,
3837 which is in a string. If the iterator is associated with a
3838 buffer, return the face at IT's current buffer position.
3839 Otherwise, use the iterator's base_face_id. */
3842 underlying_face_id (struct it
*it
)
3844 int face_id
= it
->base_face_id
, i
;
3846 eassert (STRINGP (it
->string
));
3848 for (i
= it
->sp
- 1; i
>= 0; --i
)
3849 if (NILP (it
->stack
[i
].string
))
3850 face_id
= it
->stack
[i
].face_id
;
3856 /* Compute the face one character before or after the current position
3857 of IT, in the visual order. BEFORE_P non-zero means get the face
3858 in front (to the left in L2R paragraphs, to the right in R2L
3859 paragraphs) of IT's screen position. Value is the ID of the face. */
3862 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3865 ptrdiff_t next_check_charpos
;
3867 void *it_copy_data
= NULL
;
3869 eassert (it
->s
== NULL
);
3871 if (STRINGP (it
->string
))
3873 ptrdiff_t bufpos
, charpos
;
3876 /* No face change past the end of the string (for the case
3877 we are padding with spaces). No face change before the
3879 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3880 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3885 /* Set charpos to the position before or after IT's current
3886 position, in the logical order, which in the non-bidi
3887 case is the same as the visual order. */
3889 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3890 else if (it
->what
== IT_COMPOSITION
)
3891 /* For composition, we must check the character after the
3893 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3895 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3901 /* With bidi iteration, the character before the current
3902 in the visual order cannot be found by simple
3903 iteration, because "reverse" reordering is not
3904 supported. Instead, we need to use the move_it_*
3905 family of functions. */
3906 /* Ignore face changes before the first visible
3907 character on this display line. */
3908 if (it
->current_x
<= it
->first_visible_x
)
3910 SAVE_IT (it_copy
, *it
, it_copy_data
);
3911 /* Implementation note: Since move_it_in_display_line
3912 works in the iterator geometry, and thinks the first
3913 character is always the leftmost, even in R2L lines,
3914 we don't need to distinguish between the R2L and L2R
3916 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3917 it_copy
.current_x
- 1, MOVE_TO_X
);
3918 charpos
= IT_STRING_CHARPOS (it_copy
);
3919 RESTORE_IT (it
, it
, it_copy_data
);
3923 /* Set charpos to the string position of the character
3924 that comes after IT's current position in the visual
3926 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3930 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3932 charpos
= it_copy
.bidi_it
.charpos
;
3935 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3937 if (it
->current
.overlay_string_index
>= 0)
3938 bufpos
= IT_CHARPOS (*it
);
3942 base_face_id
= underlying_face_id (it
);
3944 /* Get the face for ASCII, or unibyte. */
3945 face_id
= face_at_string_position (it
->w
,
3949 it
->region_beg_charpos
,
3950 it
->region_end_charpos
,
3951 &next_check_charpos
,
3954 /* Correct the face for charsets different from ASCII. Do it
3955 for the multibyte case only. The face returned above is
3956 suitable for unibyte text if IT->string is unibyte. */
3957 if (STRING_MULTIBYTE (it
->string
))
3959 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3960 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3962 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3964 c
= string_char_and_length (p
, &len
);
3965 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3970 struct text_pos pos
;
3972 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3973 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3976 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3977 pos
= it
->current
.pos
;
3982 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3985 if (it
->what
== IT_COMPOSITION
)
3987 /* For composition, we must check the position after
3989 pos
.charpos
+= it
->cmp_it
.nchars
;
3990 pos
.bytepos
+= it
->len
;
3993 INC_TEXT_POS (pos
, it
->multibyte_p
);
4000 /* With bidi iteration, the character before the current
4001 in the visual order cannot be found by simple
4002 iteration, because "reverse" reordering is not
4003 supported. Instead, we need to use the move_it_*
4004 family of functions. */
4005 /* Ignore face changes before the first visible
4006 character on this display line. */
4007 if (it
->current_x
<= it
->first_visible_x
)
4009 SAVE_IT (it_copy
, *it
, it_copy_data
);
4010 /* Implementation note: Since move_it_in_display_line
4011 works in the iterator geometry, and thinks the first
4012 character is always the leftmost, even in R2L lines,
4013 we don't need to distinguish between the R2L and L2R
4015 move_it_in_display_line (&it_copy
, ZV
,
4016 it_copy
.current_x
- 1, MOVE_TO_X
);
4017 pos
= it_copy
.current
.pos
;
4018 RESTORE_IT (it
, it
, it_copy_data
);
4022 /* Set charpos to the buffer position of the character
4023 that comes after IT's current position in the visual
4025 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4029 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4032 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4035 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4037 /* Determine face for CHARSET_ASCII, or unibyte. */
4038 face_id
= face_at_buffer_position (it
->w
,
4040 it
->region_beg_charpos
,
4041 it
->region_end_charpos
,
4042 &next_check_charpos
,
4045 /* Correct the face for charsets different from ASCII. Do it
4046 for the multibyte case only. The face returned above is
4047 suitable for unibyte text if current_buffer is unibyte. */
4048 if (it
->multibyte_p
)
4050 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4051 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4052 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4061 /***********************************************************************
4063 ***********************************************************************/
4065 /* Set up iterator IT from invisible properties at its current
4066 position. Called from handle_stop. */
4068 static enum prop_handled
4069 handle_invisible_prop (struct it
*it
)
4071 enum prop_handled handled
= HANDLED_NORMALLY
;
4073 if (STRINGP (it
->string
))
4075 Lisp_Object prop
, end_charpos
, limit
, charpos
;
4077 /* Get the value of the invisible text property at the
4078 current position. Value will be nil if there is no such
4080 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4081 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4084 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4088 handled
= HANDLED_RECOMPUTE_PROPS
;
4090 /* Get the position at which the next change of the
4091 invisible text property can be found in IT->string.
4092 Value will be nil if the property value is the same for
4093 all the rest of IT->string. */
4094 XSETINT (limit
, SCHARS (it
->string
));
4095 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4098 /* Text at current position is invisible. The next
4099 change in the property is at position end_charpos.
4100 Move IT's current position to that position. */
4101 if (INTEGERP (end_charpos
)
4102 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
4104 struct text_pos old
;
4107 old
= it
->current
.string_pos
;
4108 oldpos
= CHARPOS (old
);
4111 if (it
->bidi_it
.first_elt
4112 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4113 bidi_paragraph_init (it
->paragraph_embedding
,
4115 /* Bidi-iterate out of the invisible text. */
4118 bidi_move_to_visually_next (&it
->bidi_it
);
4120 while (oldpos
<= it
->bidi_it
.charpos
4121 && it
->bidi_it
.charpos
< endpos
);
4123 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4124 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4125 if (IT_CHARPOS (*it
) >= endpos
)
4126 it
->prev_stop
= endpos
;
4130 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4131 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4136 /* The rest of the string is invisible. If this is an
4137 overlay string, proceed with the next overlay string
4138 or whatever comes and return a character from there. */
4139 if (it
->current
.overlay_string_index
>= 0)
4141 next_overlay_string (it
);
4142 /* Don't check for overlay strings when we just
4143 finished processing them. */
4144 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4148 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4149 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4157 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4158 Lisp_Object pos
, prop
, overlay
;
4160 /* First of all, is there invisible text at this position? */
4161 tem
= start_charpos
= IT_CHARPOS (*it
);
4162 pos
= make_number (tem
);
4163 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4165 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4167 /* If we are on invisible text, skip over it. */
4168 if (invis_p
&& start_charpos
< it
->end_charpos
)
4170 /* Record whether we have to display an ellipsis for the
4172 int display_ellipsis_p
= invis_p
== 2;
4174 handled
= HANDLED_RECOMPUTE_PROPS
;
4176 /* Loop skipping over invisible text. The loop is left at
4177 ZV or with IT on the first char being visible again. */
4180 /* Try to skip some invisible text. Return value is the
4181 position reached which can be equal to where we start
4182 if there is nothing invisible there. This skips both
4183 over invisible text properties and overlays with
4184 invisible property. */
4185 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4187 /* If we skipped nothing at all we weren't at invisible
4188 text in the first place. If everything to the end of
4189 the buffer was skipped, end the loop. */
4190 if (newpos
== tem
|| newpos
>= ZV
)
4194 /* We skipped some characters but not necessarily
4195 all there are. Check if we ended up on visible
4196 text. Fget_char_property returns the property of
4197 the char before the given position, i.e. if we
4198 get invis_p = 0, this means that the char at
4199 newpos is visible. */
4200 pos
= make_number (newpos
);
4201 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4202 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4205 /* If we ended up on invisible text, proceed to
4206 skip starting with next_stop. */
4210 /* If there are adjacent invisible texts, don't lose the
4211 second one's ellipsis. */
4213 display_ellipsis_p
= 1;
4217 /* The position newpos is now either ZV or on visible text. */
4220 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4222 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4224 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4226 /* If the invisible text ends on a newline or on a
4227 character after a newline, we can avoid the costly,
4228 character by character, bidi iteration to NEWPOS, and
4229 instead simply reseat the iterator there. That's
4230 because all bidi reordering information is tossed at
4231 the newline. This is a big win for modes that hide
4232 complete lines, like Outline, Org, etc. */
4233 if (on_newline
|| after_newline
)
4235 struct text_pos tpos
;
4236 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4238 SET_TEXT_POS (tpos
, newpos
, bpos
);
4239 reseat_1 (it
, tpos
, 0);
4240 /* If we reseat on a newline/ZV, we need to prep the
4241 bidi iterator for advancing to the next character
4242 after the newline/EOB, keeping the current paragraph
4243 direction (so that PRODUCE_GLYPHS does TRT wrt
4244 prepending/appending glyphs to a glyph row). */
4247 it
->bidi_it
.first_elt
= 0;
4248 it
->bidi_it
.paragraph_dir
= pdir
;
4249 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4250 it
->bidi_it
.nchars
= 1;
4251 it
->bidi_it
.ch_len
= 1;
4254 else /* Must use the slow method. */
4256 /* With bidi iteration, the region of invisible text
4257 could start and/or end in the middle of a
4258 non-base embedding level. Therefore, we need to
4259 skip invisible text using the bidi iterator,
4260 starting at IT's current position, until we find
4261 ourselves outside of the invisible text.
4262 Skipping invisible text _after_ bidi iteration
4263 avoids affecting the visual order of the
4264 displayed text when invisible properties are
4265 added or removed. */
4266 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4268 /* If we were `reseat'ed to a new paragraph,
4269 determine the paragraph base direction. We
4270 need to do it now because
4271 next_element_from_buffer may not have a
4272 chance to do it, if we are going to skip any
4273 text at the beginning, which resets the
4275 bidi_paragraph_init (it
->paragraph_embedding
,
4280 bidi_move_to_visually_next (&it
->bidi_it
);
4282 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4283 && it
->bidi_it
.charpos
< newpos
);
4284 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4285 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4286 /* If we overstepped NEWPOS, record its position in
4287 the iterator, so that we skip invisible text if
4288 later the bidi iteration lands us in the
4289 invisible region again. */
4290 if (IT_CHARPOS (*it
) >= newpos
)
4291 it
->prev_stop
= newpos
;
4296 IT_CHARPOS (*it
) = newpos
;
4297 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4300 /* If there are before-strings at the start of invisible
4301 text, and the text is invisible because of a text
4302 property, arrange to show before-strings because 20.x did
4303 it that way. (If the text is invisible because of an
4304 overlay property instead of a text property, this is
4305 already handled in the overlay code.) */
4307 && get_overlay_strings (it
, it
->stop_charpos
))
4309 handled
= HANDLED_RECOMPUTE_PROPS
;
4310 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4312 else if (display_ellipsis_p
)
4314 /* Make sure that the glyphs of the ellipsis will get
4315 correct `charpos' values. If we would not update
4316 it->position here, the glyphs would belong to the
4317 last visible character _before_ the invisible
4318 text, which confuses `set_cursor_from_row'.
4320 We use the last invisible position instead of the
4321 first because this way the cursor is always drawn on
4322 the first "." of the ellipsis, whenever PT is inside
4323 the invisible text. Otherwise the cursor would be
4324 placed _after_ the ellipsis when the point is after the
4325 first invisible character. */
4326 if (!STRINGP (it
->object
))
4328 it
->position
.charpos
= newpos
- 1;
4329 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4332 /* Let the ellipsis display before
4333 considering any properties of the following char.
4334 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4335 handled
= HANDLED_RETURN
;
4344 /* Make iterator IT return `...' next.
4345 Replaces LEN characters from buffer. */
4348 setup_for_ellipsis (struct it
*it
, int len
)
4350 /* Use the display table definition for `...'. Invalid glyphs
4351 will be handled by the method returning elements from dpvec. */
4352 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4354 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4355 it
->dpvec
= v
->contents
;
4356 it
->dpend
= v
->contents
+ v
->header
.size
;
4360 /* Default `...'. */
4361 it
->dpvec
= default_invis_vector
;
4362 it
->dpend
= default_invis_vector
+ 3;
4365 it
->dpvec_char_len
= len
;
4366 it
->current
.dpvec_index
= 0;
4367 it
->dpvec_face_id
= -1;
4369 /* Remember the current face id in case glyphs specify faces.
4370 IT's face is restored in set_iterator_to_next.
4371 saved_face_id was set to preceding char's face in handle_stop. */
4372 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4373 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4375 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4381 /***********************************************************************
4383 ***********************************************************************/
4385 /* Set up iterator IT from `display' property at its current position.
4386 Called from handle_stop.
4387 We return HANDLED_RETURN if some part of the display property
4388 overrides the display of the buffer text itself.
4389 Otherwise we return HANDLED_NORMALLY. */
4391 static enum prop_handled
4392 handle_display_prop (struct it
*it
)
4394 Lisp_Object propval
, object
, overlay
;
4395 struct text_pos
*position
;
4397 /* Nonzero if some property replaces the display of the text itself. */
4398 int display_replaced_p
= 0;
4400 if (STRINGP (it
->string
))
4402 object
= it
->string
;
4403 position
= &it
->current
.string_pos
;
4404 bufpos
= CHARPOS (it
->current
.pos
);
4408 XSETWINDOW (object
, it
->w
);
4409 position
= &it
->current
.pos
;
4410 bufpos
= CHARPOS (*position
);
4413 /* Reset those iterator values set from display property values. */
4414 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4415 it
->space_width
= Qnil
;
4416 it
->font_height
= Qnil
;
4419 /* We don't support recursive `display' properties, i.e. string
4420 values that have a string `display' property, that have a string
4421 `display' property etc. */
4422 if (!it
->string_from_display_prop_p
)
4423 it
->area
= TEXT_AREA
;
4425 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4426 Qdisplay
, object
, &overlay
);
4428 return HANDLED_NORMALLY
;
4429 /* Now OVERLAY is the overlay that gave us this property, or nil
4430 if it was a text property. */
4432 if (!STRINGP (it
->string
))
4433 object
= it
->w
->buffer
;
4435 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4437 FRAME_WINDOW_P (it
->f
));
4439 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4442 /* Subroutine of handle_display_prop. Returns non-zero if the display
4443 specification in SPEC is a replacing specification, i.e. it would
4444 replace the text covered by `display' property with something else,
4445 such as an image or a display string. If SPEC includes any kind or
4446 `(space ...) specification, the value is 2; this is used by
4447 compute_display_string_pos, which see.
4449 See handle_single_display_spec for documentation of arguments.
4450 frame_window_p is non-zero if the window being redisplayed is on a
4451 GUI frame; this argument is used only if IT is NULL, see below.
4453 IT can be NULL, if this is called by the bidi reordering code
4454 through compute_display_string_pos, which see. In that case, this
4455 function only examines SPEC, but does not otherwise "handle" it, in
4456 the sense that it doesn't set up members of IT from the display
4459 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4460 Lisp_Object overlay
, struct text_pos
*position
,
4461 ptrdiff_t bufpos
, int frame_window_p
)
4463 int replacing_p
= 0;
4467 /* Simple specifications. */
4468 && !EQ (XCAR (spec
), Qimage
)
4469 && !EQ (XCAR (spec
), Qspace
)
4470 && !EQ (XCAR (spec
), Qwhen
)
4471 && !EQ (XCAR (spec
), Qslice
)
4472 && !EQ (XCAR (spec
), Qspace_width
)
4473 && !EQ (XCAR (spec
), Qheight
)
4474 && !EQ (XCAR (spec
), Qraise
)
4475 /* Marginal area specifications. */
4476 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4477 && !EQ (XCAR (spec
), Qleft_fringe
)
4478 && !EQ (XCAR (spec
), Qright_fringe
)
4479 && !NILP (XCAR (spec
)))
4481 for (; CONSP (spec
); spec
= XCDR (spec
))
4483 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4484 overlay
, position
, bufpos
,
4485 replacing_p
, frame_window_p
)))
4488 /* If some text in a string is replaced, `position' no
4489 longer points to the position of `object'. */
4490 if (!it
|| STRINGP (object
))
4495 else if (VECTORP (spec
))
4498 for (i
= 0; i
< ASIZE (spec
); ++i
)
4499 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4500 overlay
, position
, bufpos
,
4501 replacing_p
, frame_window_p
)))
4504 /* If some text in a string is replaced, `position' no
4505 longer points to the position of `object'. */
4506 if (!it
|| STRINGP (object
))
4512 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4513 position
, bufpos
, 0,
4521 /* Value is the position of the end of the `display' property starting
4522 at START_POS in OBJECT. */
4524 static struct text_pos
4525 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4528 struct text_pos end_pos
;
4530 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4531 Qdisplay
, object
, Qnil
);
4532 CHARPOS (end_pos
) = XFASTINT (end
);
4533 if (STRINGP (object
))
4534 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4536 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4542 /* Set up IT from a single `display' property specification SPEC. OBJECT
4543 is the object in which the `display' property was found. *POSITION
4544 is the position in OBJECT at which the `display' property was found.
4545 BUFPOS is the buffer position of OBJECT (different from POSITION if
4546 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4547 previously saw a display specification which already replaced text
4548 display with something else, for example an image; we ignore such
4549 properties after the first one has been processed.
4551 OVERLAY is the overlay this `display' property came from,
4552 or nil if it was a text property.
4554 If SPEC is a `space' or `image' specification, and in some other
4555 cases too, set *POSITION to the position where the `display'
4558 If IT is NULL, only examine the property specification in SPEC, but
4559 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4560 is intended to be displayed in a window on a GUI frame.
4562 Value is non-zero if something was found which replaces the display
4563 of buffer or string text. */
4566 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4567 Lisp_Object overlay
, struct text_pos
*position
,
4568 ptrdiff_t bufpos
, int display_replaced_p
,
4572 Lisp_Object location
, value
;
4573 struct text_pos start_pos
= *position
;
4576 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4577 If the result is non-nil, use VALUE instead of SPEC. */
4579 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4588 if (!NILP (form
) && !EQ (form
, Qt
))
4590 ptrdiff_t count
= SPECPDL_INDEX ();
4591 struct gcpro gcpro1
;
4593 /* Bind `object' to the object having the `display' property, a
4594 buffer or string. Bind `position' to the position in the
4595 object where the property was found, and `buffer-position'
4596 to the current position in the buffer. */
4599 XSETBUFFER (object
, current_buffer
);
4600 specbind (Qobject
, object
);
4601 specbind (Qposition
, make_number (CHARPOS (*position
)));
4602 specbind (Qbuffer_position
, make_number (bufpos
));
4604 form
= safe_eval (form
);
4606 unbind_to (count
, Qnil
);
4612 /* Handle `(height HEIGHT)' specifications. */
4614 && EQ (XCAR (spec
), Qheight
)
4615 && CONSP (XCDR (spec
)))
4619 if (!FRAME_WINDOW_P (it
->f
))
4622 it
->font_height
= XCAR (XCDR (spec
));
4623 if (!NILP (it
->font_height
))
4625 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4626 int new_height
= -1;
4628 if (CONSP (it
->font_height
)
4629 && (EQ (XCAR (it
->font_height
), Qplus
)
4630 || EQ (XCAR (it
->font_height
), Qminus
))
4631 && CONSP (XCDR (it
->font_height
))
4632 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4634 /* `(+ N)' or `(- N)' where N is an integer. */
4635 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4636 if (EQ (XCAR (it
->font_height
), Qplus
))
4638 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4640 else if (FUNCTIONP (it
->font_height
))
4642 /* Call function with current height as argument.
4643 Value is the new height. */
4645 height
= safe_call1 (it
->font_height
,
4646 face
->lface
[LFACE_HEIGHT_INDEX
]);
4647 if (NUMBERP (height
))
4648 new_height
= XFLOATINT (height
);
4650 else if (NUMBERP (it
->font_height
))
4652 /* Value is a multiple of the canonical char height. */
4655 f
= FACE_FROM_ID (it
->f
,
4656 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4657 new_height
= (XFLOATINT (it
->font_height
)
4658 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4662 /* Evaluate IT->font_height with `height' bound to the
4663 current specified height to get the new height. */
4664 ptrdiff_t count
= SPECPDL_INDEX ();
4666 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4667 value
= safe_eval (it
->font_height
);
4668 unbind_to (count
, Qnil
);
4670 if (NUMBERP (value
))
4671 new_height
= XFLOATINT (value
);
4675 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4682 /* Handle `(space-width WIDTH)'. */
4684 && EQ (XCAR (spec
), Qspace_width
)
4685 && CONSP (XCDR (spec
)))
4689 if (!FRAME_WINDOW_P (it
->f
))
4692 value
= XCAR (XCDR (spec
));
4693 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4694 it
->space_width
= value
;
4700 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4702 && EQ (XCAR (spec
), Qslice
))
4708 if (!FRAME_WINDOW_P (it
->f
))
4711 if (tem
= XCDR (spec
), CONSP (tem
))
4713 it
->slice
.x
= XCAR (tem
);
4714 if (tem
= XCDR (tem
), CONSP (tem
))
4716 it
->slice
.y
= XCAR (tem
);
4717 if (tem
= XCDR (tem
), CONSP (tem
))
4719 it
->slice
.width
= XCAR (tem
);
4720 if (tem
= XCDR (tem
), CONSP (tem
))
4721 it
->slice
.height
= XCAR (tem
);
4730 /* Handle `(raise FACTOR)'. */
4732 && EQ (XCAR (spec
), Qraise
)
4733 && CONSP (XCDR (spec
)))
4737 if (!FRAME_WINDOW_P (it
->f
))
4740 #ifdef HAVE_WINDOW_SYSTEM
4741 value
= XCAR (XCDR (spec
));
4742 if (NUMBERP (value
))
4744 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4745 it
->voffset
= - (XFLOATINT (value
)
4746 * (FONT_HEIGHT (face
->font
)));
4748 #endif /* HAVE_WINDOW_SYSTEM */
4754 /* Don't handle the other kinds of display specifications
4755 inside a string that we got from a `display' property. */
4756 if (it
&& it
->string_from_display_prop_p
)
4759 /* Characters having this form of property are not displayed, so
4760 we have to find the end of the property. */
4763 start_pos
= *position
;
4764 *position
= display_prop_end (it
, object
, start_pos
);
4768 /* Stop the scan at that end position--we assume that all
4769 text properties change there. */
4771 it
->stop_charpos
= position
->charpos
;
4773 /* Handle `(left-fringe BITMAP [FACE])'
4774 and `(right-fringe BITMAP [FACE])'. */
4776 && (EQ (XCAR (spec
), Qleft_fringe
)
4777 || EQ (XCAR (spec
), Qright_fringe
))
4778 && CONSP (XCDR (spec
)))
4784 if (!FRAME_WINDOW_P (it
->f
))
4785 /* If we return here, POSITION has been advanced
4786 across the text with this property. */
4788 /* Synchronize the bidi iterator with POSITION. This is
4789 needed because we are not going to push the iterator
4790 on behalf of this display property, so there will be
4791 no pop_it call to do this synchronization for us. */
4794 it
->position
= *position
;
4795 iterate_out_of_display_property (it
);
4796 *position
= it
->position
;
4801 else if (!frame_window_p
)
4804 #ifdef HAVE_WINDOW_SYSTEM
4805 value
= XCAR (XCDR (spec
));
4806 if (!SYMBOLP (value
)
4807 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4808 /* If we return here, POSITION has been advanced
4809 across the text with this property. */
4811 if (it
&& it
->bidi_p
)
4813 it
->position
= *position
;
4814 iterate_out_of_display_property (it
);
4815 *position
= it
->position
;
4822 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4824 if (CONSP (XCDR (XCDR (spec
))))
4826 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4827 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4833 /* Save current settings of IT so that we can restore them
4834 when we are finished with the glyph property value. */
4835 push_it (it
, position
);
4837 it
->area
= TEXT_AREA
;
4838 it
->what
= IT_IMAGE
;
4839 it
->image_id
= -1; /* no image */
4840 it
->position
= start_pos
;
4841 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4842 it
->method
= GET_FROM_IMAGE
;
4843 it
->from_overlay
= Qnil
;
4844 it
->face_id
= face_id
;
4845 it
->from_disp_prop_p
= 1;
4847 /* Say that we haven't consumed the characters with
4848 `display' property yet. The call to pop_it in
4849 set_iterator_to_next will clean this up. */
4850 *position
= start_pos
;
4852 if (EQ (XCAR (spec
), Qleft_fringe
))
4854 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4855 it
->left_user_fringe_face_id
= face_id
;
4859 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4860 it
->right_user_fringe_face_id
= face_id
;
4863 #endif /* HAVE_WINDOW_SYSTEM */
4867 /* Prepare to handle `((margin left-margin) ...)',
4868 `((margin right-margin) ...)' and `((margin nil) ...)'
4869 prefixes for display specifications. */
4870 location
= Qunbound
;
4871 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4875 value
= XCDR (spec
);
4877 value
= XCAR (value
);
4880 if (EQ (XCAR (tem
), Qmargin
)
4881 && (tem
= XCDR (tem
),
4882 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4884 || EQ (tem
, Qleft_margin
)
4885 || EQ (tem
, Qright_margin
))))
4889 if (EQ (location
, Qunbound
))
4895 /* After this point, VALUE is the property after any
4896 margin prefix has been stripped. It must be a string,
4897 an image specification, or `(space ...)'.
4899 LOCATION specifies where to display: `left-margin',
4900 `right-margin' or nil. */
4902 valid_p
= (STRINGP (value
)
4903 #ifdef HAVE_WINDOW_SYSTEM
4904 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4905 && valid_image_p (value
))
4906 #endif /* not HAVE_WINDOW_SYSTEM */
4907 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4909 if (valid_p
&& !display_replaced_p
)
4915 /* Callers need to know whether the display spec is any kind
4916 of `(space ...)' spec that is about to affect text-area
4918 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4923 /* Save current settings of IT so that we can restore them
4924 when we are finished with the glyph property value. */
4925 push_it (it
, position
);
4926 it
->from_overlay
= overlay
;
4927 it
->from_disp_prop_p
= 1;
4929 if (NILP (location
))
4930 it
->area
= TEXT_AREA
;
4931 else if (EQ (location
, Qleft_margin
))
4932 it
->area
= LEFT_MARGIN_AREA
;
4934 it
->area
= RIGHT_MARGIN_AREA
;
4936 if (STRINGP (value
))
4939 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4940 it
->current
.overlay_string_index
= -1;
4941 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4942 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4943 it
->method
= GET_FROM_STRING
;
4944 it
->stop_charpos
= 0;
4946 it
->base_level_stop
= 0;
4947 it
->string_from_display_prop_p
= 1;
4948 /* Say that we haven't consumed the characters with
4949 `display' property yet. The call to pop_it in
4950 set_iterator_to_next will clean this up. */
4951 if (BUFFERP (object
))
4952 *position
= start_pos
;
4954 /* Force paragraph direction to be that of the parent
4955 object. If the parent object's paragraph direction is
4956 not yet determined, default to L2R. */
4957 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4958 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4960 it
->paragraph_embedding
= L2R
;
4962 /* Set up the bidi iterator for this display string. */
4965 it
->bidi_it
.string
.lstring
= it
->string
;
4966 it
->bidi_it
.string
.s
= NULL
;
4967 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4968 it
->bidi_it
.string
.bufpos
= bufpos
;
4969 it
->bidi_it
.string
.from_disp_str
= 1;
4970 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4971 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4974 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4976 it
->method
= GET_FROM_STRETCH
;
4978 *position
= it
->position
= start_pos
;
4979 retval
= 1 + (it
->area
== TEXT_AREA
);
4981 #ifdef HAVE_WINDOW_SYSTEM
4984 it
->what
= IT_IMAGE
;
4985 it
->image_id
= lookup_image (it
->f
, value
);
4986 it
->position
= start_pos
;
4987 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4988 it
->method
= GET_FROM_IMAGE
;
4990 /* Say that we haven't consumed the characters with
4991 `display' property yet. The call to pop_it in
4992 set_iterator_to_next will clean this up. */
4993 *position
= start_pos
;
4995 #endif /* HAVE_WINDOW_SYSTEM */
5000 /* Invalid property or property not supported. Restore
5001 POSITION to what it was before. */
5002 *position
= start_pos
;
5006 /* Check if PROP is a display property value whose text should be
5007 treated as intangible. OVERLAY is the overlay from which PROP
5008 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5009 specify the buffer position covered by PROP. */
5012 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5013 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5015 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5016 struct text_pos position
;
5018 SET_TEXT_POS (position
, charpos
, bytepos
);
5019 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5020 &position
, charpos
, frame_window_p
);
5024 /* Return 1 if PROP is a display sub-property value containing STRING.
5026 Implementation note: this and the following function are really
5027 special cases of handle_display_spec and
5028 handle_single_display_spec, and should ideally use the same code.
5029 Until they do, these two pairs must be consistent and must be
5030 modified in sync. */
5033 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5035 if (EQ (string
, prop
))
5038 /* Skip over `when FORM'. */
5039 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5044 /* Actually, the condition following `when' should be eval'ed,
5045 like handle_single_display_spec does, and we should return
5046 zero if it evaluates to nil. However, this function is
5047 called only when the buffer was already displayed and some
5048 glyph in the glyph matrix was found to come from a display
5049 string. Therefore, the condition was already evaluated, and
5050 the result was non-nil, otherwise the display string wouldn't
5051 have been displayed and we would have never been called for
5052 this property. Thus, we can skip the evaluation and assume
5053 its result is non-nil. */
5058 /* Skip over `margin LOCATION'. */
5059 if (EQ (XCAR (prop
), Qmargin
))
5070 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5074 /* Return 1 if STRING appears in the `display' property PROP. */
5077 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5080 && !EQ (XCAR (prop
), Qwhen
)
5081 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5083 /* A list of sub-properties. */
5084 while (CONSP (prop
))
5086 if (single_display_spec_string_p (XCAR (prop
), string
))
5091 else if (VECTORP (prop
))
5093 /* A vector of sub-properties. */
5095 for (i
= 0; i
< ASIZE (prop
); ++i
)
5096 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5100 return single_display_spec_string_p (prop
, string
);
5105 /* Look for STRING in overlays and text properties in the current
5106 buffer, between character positions FROM and TO (excluding TO).
5107 BACK_P non-zero means look back (in this case, TO is supposed to be
5109 Value is the first character position where STRING was found, or
5110 zero if it wasn't found before hitting TO.
5112 This function may only use code that doesn't eval because it is
5113 called asynchronously from note_mouse_highlight. */
5116 string_buffer_position_lim (Lisp_Object string
,
5117 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5119 Lisp_Object limit
, prop
, pos
;
5122 pos
= make_number (max (from
, BEGV
));
5124 if (!back_p
) /* looking forward */
5126 limit
= make_number (min (to
, ZV
));
5127 while (!found
&& !EQ (pos
, limit
))
5129 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5130 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5133 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5137 else /* looking back */
5139 limit
= make_number (max (to
, BEGV
));
5140 while (!found
&& !EQ (pos
, limit
))
5142 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5143 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5146 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5151 return found
? XINT (pos
) : 0;
5154 /* Determine which buffer position in current buffer STRING comes from.
5155 AROUND_CHARPOS is an approximate position where it could come from.
5156 Value is the buffer position or 0 if it couldn't be determined.
5158 This function is necessary because we don't record buffer positions
5159 in glyphs generated from strings (to keep struct glyph small).
5160 This function may only use code that doesn't eval because it is
5161 called asynchronously from note_mouse_highlight. */
5164 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5166 const int MAX_DISTANCE
= 1000;
5167 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5168 around_charpos
+ MAX_DISTANCE
,
5172 found
= string_buffer_position_lim (string
, around_charpos
,
5173 around_charpos
- MAX_DISTANCE
, 1);
5179 /***********************************************************************
5180 `composition' property
5181 ***********************************************************************/
5183 /* Set up iterator IT from `composition' property at its current
5184 position. Called from handle_stop. */
5186 static enum prop_handled
5187 handle_composition_prop (struct it
*it
)
5189 Lisp_Object prop
, string
;
5190 ptrdiff_t pos
, pos_byte
, start
, end
;
5192 if (STRINGP (it
->string
))
5196 pos
= IT_STRING_CHARPOS (*it
);
5197 pos_byte
= IT_STRING_BYTEPOS (*it
);
5198 string
= it
->string
;
5199 s
= SDATA (string
) + pos_byte
;
5200 it
->c
= STRING_CHAR (s
);
5204 pos
= IT_CHARPOS (*it
);
5205 pos_byte
= IT_BYTEPOS (*it
);
5207 it
->c
= FETCH_CHAR (pos_byte
);
5210 /* If there's a valid composition and point is not inside of the
5211 composition (in the case that the composition is from the current
5212 buffer), draw a glyph composed from the composition components. */
5213 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5214 && COMPOSITION_VALID_P (start
, end
, prop
)
5215 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5218 /* As we can't handle this situation (perhaps font-lock added
5219 a new composition), we just return here hoping that next
5220 redisplay will detect this composition much earlier. */
5221 return HANDLED_NORMALLY
;
5224 if (STRINGP (it
->string
))
5225 pos_byte
= string_char_to_byte (it
->string
, start
);
5227 pos_byte
= CHAR_TO_BYTE (start
);
5229 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5232 if (it
->cmp_it
.id
>= 0)
5235 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5236 it
->cmp_it
.nglyphs
= -1;
5240 return HANDLED_NORMALLY
;
5245 /***********************************************************************
5247 ***********************************************************************/
5249 /* The following structure is used to record overlay strings for
5250 later sorting in load_overlay_strings. */
5252 struct overlay_entry
5254 Lisp_Object overlay
;
5261 /* Set up iterator IT from overlay strings at its current position.
5262 Called from handle_stop. */
5264 static enum prop_handled
5265 handle_overlay_change (struct it
*it
)
5267 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5268 return HANDLED_RECOMPUTE_PROPS
;
5270 return HANDLED_NORMALLY
;
5274 /* Set up the next overlay string for delivery by IT, if there is an
5275 overlay string to deliver. Called by set_iterator_to_next when the
5276 end of the current overlay string is reached. If there are more
5277 overlay strings to display, IT->string and
5278 IT->current.overlay_string_index are set appropriately here.
5279 Otherwise IT->string is set to nil. */
5282 next_overlay_string (struct it
*it
)
5284 ++it
->current
.overlay_string_index
;
5285 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5287 /* No more overlay strings. Restore IT's settings to what
5288 they were before overlay strings were processed, and
5289 continue to deliver from current_buffer. */
5291 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5294 || (NILP (it
->string
)
5295 && it
->method
== GET_FROM_BUFFER
5296 && it
->stop_charpos
>= BEGV
5297 && it
->stop_charpos
<= it
->end_charpos
));
5298 it
->current
.overlay_string_index
= -1;
5299 it
->n_overlay_strings
= 0;
5300 it
->overlay_strings_charpos
= -1;
5301 /* If there's an empty display string on the stack, pop the
5302 stack, to resync the bidi iterator with IT's position. Such
5303 empty strings are pushed onto the stack in
5304 get_overlay_strings_1. */
5305 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5308 /* If we're at the end of the buffer, record that we have
5309 processed the overlay strings there already, so that
5310 next_element_from_buffer doesn't try it again. */
5311 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5312 it
->overlay_strings_at_end_processed_p
= 1;
5316 /* There are more overlay strings to process. If
5317 IT->current.overlay_string_index has advanced to a position
5318 where we must load IT->overlay_strings with more strings, do
5319 it. We must load at the IT->overlay_strings_charpos where
5320 IT->n_overlay_strings was originally computed; when invisible
5321 text is present, this might not be IT_CHARPOS (Bug#7016). */
5322 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5324 if (it
->current
.overlay_string_index
&& i
== 0)
5325 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5327 /* Initialize IT to deliver display elements from the overlay
5329 it
->string
= it
->overlay_strings
[i
];
5330 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5331 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5332 it
->method
= GET_FROM_STRING
;
5333 it
->stop_charpos
= 0;
5334 if (it
->cmp_it
.stop_pos
>= 0)
5335 it
->cmp_it
.stop_pos
= 0;
5337 it
->base_level_stop
= 0;
5339 /* Set up the bidi iterator for this overlay string. */
5342 it
->bidi_it
.string
.lstring
= it
->string
;
5343 it
->bidi_it
.string
.s
= NULL
;
5344 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5345 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5346 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5347 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5348 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5356 /* Compare two overlay_entry structures E1 and E2. Used as a
5357 comparison function for qsort in load_overlay_strings. Overlay
5358 strings for the same position are sorted so that
5360 1. All after-strings come in front of before-strings, except
5361 when they come from the same overlay.
5363 2. Within after-strings, strings are sorted so that overlay strings
5364 from overlays with higher priorities come first.
5366 2. Within before-strings, strings are sorted so that overlay
5367 strings from overlays with higher priorities come last.
5369 Value is analogous to strcmp. */
5373 compare_overlay_entries (const void *e1
, const void *e2
)
5375 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5376 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5379 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5381 /* Let after-strings appear in front of before-strings if
5382 they come from different overlays. */
5383 if (EQ (entry1
->overlay
, entry2
->overlay
))
5384 result
= entry1
->after_string_p
? 1 : -1;
5386 result
= entry1
->after_string_p
? -1 : 1;
5388 else if (entry1
->priority
!= entry2
->priority
)
5390 if (entry1
->after_string_p
)
5391 /* After-strings sorted in order of decreasing priority. */
5392 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5394 /* Before-strings sorted in order of increasing priority. */
5395 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5404 /* Load the vector IT->overlay_strings with overlay strings from IT's
5405 current buffer position, or from CHARPOS if that is > 0. Set
5406 IT->n_overlays to the total number of overlay strings found.
5408 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5409 a time. On entry into load_overlay_strings,
5410 IT->current.overlay_string_index gives the number of overlay
5411 strings that have already been loaded by previous calls to this
5414 IT->add_overlay_start contains an additional overlay start
5415 position to consider for taking overlay strings from, if non-zero.
5416 This position comes into play when the overlay has an `invisible'
5417 property, and both before and after-strings. When we've skipped to
5418 the end of the overlay, because of its `invisible' property, we
5419 nevertheless want its before-string to appear.
5420 IT->add_overlay_start will contain the overlay start position
5423 Overlay strings are sorted so that after-string strings come in
5424 front of before-string strings. Within before and after-strings,
5425 strings are sorted by overlay priority. See also function
5426 compare_overlay_entries. */
5429 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5431 Lisp_Object overlay
, window
, str
, invisible
;
5432 struct Lisp_Overlay
*ov
;
5433 ptrdiff_t start
, end
;
5434 ptrdiff_t size
= 20;
5435 ptrdiff_t n
= 0, i
, j
;
5437 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5441 charpos
= IT_CHARPOS (*it
);
5443 /* Append the overlay string STRING of overlay OVERLAY to vector
5444 `entries' which has size `size' and currently contains `n'
5445 elements. AFTER_P non-zero means STRING is an after-string of
5447 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5450 Lisp_Object priority; \
5454 struct overlay_entry *old = entries; \
5455 SAFE_NALLOCA (entries, 2, size); \
5456 memcpy (entries, old, size * sizeof *entries); \
5460 entries[n].string = (STRING); \
5461 entries[n].overlay = (OVERLAY); \
5462 priority = Foverlay_get ((OVERLAY), Qpriority); \
5463 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5464 entries[n].after_string_p = (AFTER_P); \
5469 /* Process overlay before the overlay center. */
5470 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5472 XSETMISC (overlay
, ov
);
5473 eassert (OVERLAYP (overlay
));
5474 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5475 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5480 /* Skip this overlay if it doesn't start or end at IT's current
5482 if (end
!= charpos
&& start
!= charpos
)
5485 /* Skip this overlay if it doesn't apply to IT->w. */
5486 window
= Foverlay_get (overlay
, Qwindow
);
5487 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5490 /* If the text ``under'' the overlay is invisible, both before-
5491 and after-strings from this overlay are visible; start and
5492 end position are indistinguishable. */
5493 invisible
= Foverlay_get (overlay
, Qinvisible
);
5494 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5496 /* If overlay has a non-empty before-string, record it. */
5497 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5498 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5500 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5502 /* If overlay has a non-empty after-string, record it. */
5503 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5504 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5506 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5509 /* Process overlays after the overlay center. */
5510 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5512 XSETMISC (overlay
, ov
);
5513 eassert (OVERLAYP (overlay
));
5514 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5515 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5517 if (start
> charpos
)
5520 /* Skip this overlay if it doesn't start or end at IT's current
5522 if (end
!= charpos
&& start
!= charpos
)
5525 /* Skip this overlay if it doesn't apply to IT->w. */
5526 window
= Foverlay_get (overlay
, Qwindow
);
5527 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5530 /* If the text ``under'' the overlay is invisible, it has a zero
5531 dimension, and both before- and after-strings apply. */
5532 invisible
= Foverlay_get (overlay
, Qinvisible
);
5533 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5535 /* If overlay has a non-empty before-string, record it. */
5536 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5537 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5539 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5541 /* If overlay has a non-empty after-string, record it. */
5542 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5543 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5545 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5548 #undef RECORD_OVERLAY_STRING
5552 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5554 /* Record number of overlay strings, and where we computed it. */
5555 it
->n_overlay_strings
= n
;
5556 it
->overlay_strings_charpos
= charpos
;
5558 /* IT->current.overlay_string_index is the number of overlay strings
5559 that have already been consumed by IT. Copy some of the
5560 remaining overlay strings to IT->overlay_strings. */
5562 j
= it
->current
.overlay_string_index
;
5563 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5565 it
->overlay_strings
[i
] = entries
[j
].string
;
5566 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5574 /* Get the first chunk of overlay strings at IT's current buffer
5575 position, or at CHARPOS if that is > 0. Value is non-zero if at
5576 least one overlay string was found. */
5579 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5581 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5582 process. This fills IT->overlay_strings with strings, and sets
5583 IT->n_overlay_strings to the total number of strings to process.
5584 IT->pos.overlay_string_index has to be set temporarily to zero
5585 because load_overlay_strings needs this; it must be set to -1
5586 when no overlay strings are found because a zero value would
5587 indicate a position in the first overlay string. */
5588 it
->current
.overlay_string_index
= 0;
5589 load_overlay_strings (it
, charpos
);
5591 /* If we found overlay strings, set up IT to deliver display
5592 elements from the first one. Otherwise set up IT to deliver
5593 from current_buffer. */
5594 if (it
->n_overlay_strings
)
5596 /* Make sure we know settings in current_buffer, so that we can
5597 restore meaningful values when we're done with the overlay
5600 compute_stop_pos (it
);
5601 eassert (it
->face_id
>= 0);
5603 /* Save IT's settings. They are restored after all overlay
5604 strings have been processed. */
5605 eassert (!compute_stop_p
|| it
->sp
== 0);
5607 /* When called from handle_stop, there might be an empty display
5608 string loaded. In that case, don't bother saving it. But
5609 don't use this optimization with the bidi iterator, since we
5610 need the corresponding pop_it call to resync the bidi
5611 iterator's position with IT's position, after we are done
5612 with the overlay strings. (The corresponding call to pop_it
5613 in case of an empty display string is in
5614 next_overlay_string.) */
5616 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5619 /* Set up IT to deliver display elements from the first overlay
5621 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5622 it
->string
= it
->overlay_strings
[0];
5623 it
->from_overlay
= Qnil
;
5624 it
->stop_charpos
= 0;
5625 eassert (STRINGP (it
->string
));
5626 it
->end_charpos
= SCHARS (it
->string
);
5628 it
->base_level_stop
= 0;
5629 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5630 it
->method
= GET_FROM_STRING
;
5631 it
->from_disp_prop_p
= 0;
5633 /* Force paragraph direction to be that of the parent
5635 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5636 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5638 it
->paragraph_embedding
= L2R
;
5640 /* Set up the bidi iterator for this overlay string. */
5643 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5645 it
->bidi_it
.string
.lstring
= it
->string
;
5646 it
->bidi_it
.string
.s
= NULL
;
5647 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5648 it
->bidi_it
.string
.bufpos
= pos
;
5649 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5650 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5651 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5656 it
->current
.overlay_string_index
= -1;
5661 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5664 it
->method
= GET_FROM_BUFFER
;
5666 (void) get_overlay_strings_1 (it
, charpos
, 1);
5670 /* Value is non-zero if we found at least one overlay string. */
5671 return STRINGP (it
->string
);
5676 /***********************************************************************
5677 Saving and restoring state
5678 ***********************************************************************/
5680 /* Save current settings of IT on IT->stack. Called, for example,
5681 before setting up IT for an overlay string, to be able to restore
5682 IT's settings to what they were after the overlay string has been
5683 processed. If POSITION is non-NULL, it is the position to save on
5684 the stack instead of IT->position. */
5687 push_it (struct it
*it
, struct text_pos
*position
)
5689 struct iterator_stack_entry
*p
;
5691 eassert (it
->sp
< IT_STACK_SIZE
);
5692 p
= it
->stack
+ it
->sp
;
5694 p
->stop_charpos
= it
->stop_charpos
;
5695 p
->prev_stop
= it
->prev_stop
;
5696 p
->base_level_stop
= it
->base_level_stop
;
5697 p
->cmp_it
= it
->cmp_it
;
5698 eassert (it
->face_id
>= 0);
5699 p
->face_id
= it
->face_id
;
5700 p
->string
= it
->string
;
5701 p
->method
= it
->method
;
5702 p
->from_overlay
= it
->from_overlay
;
5705 case GET_FROM_IMAGE
:
5706 p
->u
.image
.object
= it
->object
;
5707 p
->u
.image
.image_id
= it
->image_id
;
5708 p
->u
.image
.slice
= it
->slice
;
5710 case GET_FROM_STRETCH
:
5711 p
->u
.stretch
.object
= it
->object
;
5714 p
->position
= position
? *position
: it
->position
;
5715 p
->current
= it
->current
;
5716 p
->end_charpos
= it
->end_charpos
;
5717 p
->string_nchars
= it
->string_nchars
;
5719 p
->multibyte_p
= it
->multibyte_p
;
5720 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5721 p
->space_width
= it
->space_width
;
5722 p
->font_height
= it
->font_height
;
5723 p
->voffset
= it
->voffset
;
5724 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5725 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5726 p
->display_ellipsis_p
= 0;
5727 p
->line_wrap
= it
->line_wrap
;
5728 p
->bidi_p
= it
->bidi_p
;
5729 p
->paragraph_embedding
= it
->paragraph_embedding
;
5730 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5733 /* Save the state of the bidi iterator as well. */
5735 bidi_push_it (&it
->bidi_it
);
5739 iterate_out_of_display_property (struct it
*it
)
5741 int buffer_p
= !STRINGP (it
->string
);
5742 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5743 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5745 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5747 /* Maybe initialize paragraph direction. If we are at the beginning
5748 of a new paragraph, next_element_from_buffer may not have a
5749 chance to do that. */
5750 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5751 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5752 /* prev_stop can be zero, so check against BEGV as well. */
5753 while (it
->bidi_it
.charpos
>= bob
5754 && it
->prev_stop
<= it
->bidi_it
.charpos
5755 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5756 && it
->bidi_it
.charpos
< eob
)
5757 bidi_move_to_visually_next (&it
->bidi_it
);
5758 /* Record the stop_pos we just crossed, for when we cross it
5760 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5761 it
->prev_stop
= CHARPOS (it
->position
);
5762 /* If we ended up not where pop_it put us, resync IT's
5763 positional members with the bidi iterator. */
5764 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5765 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5767 it
->current
.pos
= it
->position
;
5769 it
->current
.string_pos
= it
->position
;
5772 /* Restore IT's settings from IT->stack. Called, for example, when no
5773 more overlay strings must be processed, and we return to delivering
5774 display elements from a buffer, or when the end of a string from a
5775 `display' property is reached and we return to delivering display
5776 elements from an overlay string, or from a buffer. */
5779 pop_it (struct it
*it
)
5781 struct iterator_stack_entry
*p
;
5782 int from_display_prop
= it
->from_disp_prop_p
;
5784 eassert (it
->sp
> 0);
5786 p
= it
->stack
+ it
->sp
;
5787 it
->stop_charpos
= p
->stop_charpos
;
5788 it
->prev_stop
= p
->prev_stop
;
5789 it
->base_level_stop
= p
->base_level_stop
;
5790 it
->cmp_it
= p
->cmp_it
;
5791 it
->face_id
= p
->face_id
;
5792 it
->current
= p
->current
;
5793 it
->position
= p
->position
;
5794 it
->string
= p
->string
;
5795 it
->from_overlay
= p
->from_overlay
;
5796 if (NILP (it
->string
))
5797 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5798 it
->method
= p
->method
;
5801 case GET_FROM_IMAGE
:
5802 it
->image_id
= p
->u
.image
.image_id
;
5803 it
->object
= p
->u
.image
.object
;
5804 it
->slice
= p
->u
.image
.slice
;
5806 case GET_FROM_STRETCH
:
5807 it
->object
= p
->u
.stretch
.object
;
5809 case GET_FROM_BUFFER
:
5810 it
->object
= it
->w
->buffer
;
5812 case GET_FROM_STRING
:
5813 it
->object
= it
->string
;
5815 case GET_FROM_DISPLAY_VECTOR
:
5817 it
->method
= GET_FROM_C_STRING
;
5818 else if (STRINGP (it
->string
))
5819 it
->method
= GET_FROM_STRING
;
5822 it
->method
= GET_FROM_BUFFER
;
5823 it
->object
= it
->w
->buffer
;
5826 it
->end_charpos
= p
->end_charpos
;
5827 it
->string_nchars
= p
->string_nchars
;
5829 it
->multibyte_p
= p
->multibyte_p
;
5830 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5831 it
->space_width
= p
->space_width
;
5832 it
->font_height
= p
->font_height
;
5833 it
->voffset
= p
->voffset
;
5834 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5835 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5836 it
->line_wrap
= p
->line_wrap
;
5837 it
->bidi_p
= p
->bidi_p
;
5838 it
->paragraph_embedding
= p
->paragraph_embedding
;
5839 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5842 bidi_pop_it (&it
->bidi_it
);
5843 /* Bidi-iterate until we get out of the portion of text, if any,
5844 covered by a `display' text property or by an overlay with
5845 `display' property. (We cannot just jump there, because the
5846 internal coherency of the bidi iterator state can not be
5847 preserved across such jumps.) We also must determine the
5848 paragraph base direction if the overlay we just processed is
5849 at the beginning of a new paragraph. */
5850 if (from_display_prop
5851 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5852 iterate_out_of_display_property (it
);
5854 eassert ((BUFFERP (it
->object
)
5855 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5856 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5857 || (STRINGP (it
->object
)
5858 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5859 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5860 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5866 /***********************************************************************
5868 ***********************************************************************/
5870 /* Set IT's current position to the previous line start. */
5873 back_to_previous_line_start (struct it
*it
)
5875 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5876 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5880 /* Move IT to the next line start.
5882 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5883 we skipped over part of the text (as opposed to moving the iterator
5884 continuously over the text). Otherwise, don't change the value
5887 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5888 iterator on the newline, if it was found.
5890 Newlines may come from buffer text, overlay strings, or strings
5891 displayed via the `display' property. That's the reason we can't
5892 simply use find_next_newline_no_quit.
5894 Note that this function may not skip over invisible text that is so
5895 because of text properties and immediately follows a newline. If
5896 it would, function reseat_at_next_visible_line_start, when called
5897 from set_iterator_to_next, would effectively make invisible
5898 characters following a newline part of the wrong glyph row, which
5899 leads to wrong cursor motion. */
5902 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5903 struct bidi_it
*bidi_it_prev
)
5905 ptrdiff_t old_selective
;
5906 int newline_found_p
, n
;
5907 const int MAX_NEWLINE_DISTANCE
= 500;
5909 /* If already on a newline, just consume it to avoid unintended
5910 skipping over invisible text below. */
5911 if (it
->what
== IT_CHARACTER
5913 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5915 if (it
->bidi_p
&& bidi_it_prev
)
5916 *bidi_it_prev
= it
->bidi_it
;
5917 set_iterator_to_next (it
, 0);
5922 /* Don't handle selective display in the following. It's (a)
5923 unnecessary because it's done by the caller, and (b) leads to an
5924 infinite recursion because next_element_from_ellipsis indirectly
5925 calls this function. */
5926 old_selective
= it
->selective
;
5929 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5930 from buffer text. */
5931 for (n
= newline_found_p
= 0;
5932 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5933 n
+= STRINGP (it
->string
) ? 0 : 1)
5935 if (!get_next_display_element (it
))
5937 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5938 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5939 *bidi_it_prev
= it
->bidi_it
;
5940 set_iterator_to_next (it
, 0);
5943 /* If we didn't find a newline near enough, see if we can use a
5945 if (!newline_found_p
)
5947 ptrdiff_t start
= IT_CHARPOS (*it
);
5948 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5951 eassert (!STRINGP (it
->string
));
5953 /* If there isn't any `display' property in sight, and no
5954 overlays, we can just use the position of the newline in
5956 if (it
->stop_charpos
>= limit
5957 || ((pos
= Fnext_single_property_change (make_number (start
),
5959 make_number (limit
)),
5961 && next_overlay_change (start
) == ZV
))
5965 IT_CHARPOS (*it
) = limit
;
5966 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5970 struct bidi_it bprev
;
5972 /* Help bidi.c avoid expensive searches for display
5973 properties and overlays, by telling it that there are
5974 none up to `limit'. */
5975 if (it
->bidi_it
.disp_pos
< limit
)
5977 it
->bidi_it
.disp_pos
= limit
;
5978 it
->bidi_it
.disp_prop
= 0;
5981 bprev
= it
->bidi_it
;
5982 bidi_move_to_visually_next (&it
->bidi_it
);
5983 } while (it
->bidi_it
.charpos
!= limit
);
5984 IT_CHARPOS (*it
) = limit
;
5985 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5987 *bidi_it_prev
= bprev
;
5989 *skipped_p
= newline_found_p
= 1;
5993 while (get_next_display_element (it
)
5994 && !newline_found_p
)
5996 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5997 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5998 *bidi_it_prev
= it
->bidi_it
;
5999 set_iterator_to_next (it
, 0);
6004 it
->selective
= old_selective
;
6005 return newline_found_p
;
6009 /* Set IT's current position to the previous visible line start. Skip
6010 invisible text that is so either due to text properties or due to
6011 selective display. Caution: this does not change IT->current_x and
6015 back_to_previous_visible_line_start (struct it
*it
)
6017 while (IT_CHARPOS (*it
) > BEGV
)
6019 back_to_previous_line_start (it
);
6021 if (IT_CHARPOS (*it
) <= BEGV
)
6024 /* If selective > 0, then lines indented more than its value are
6026 if (it
->selective
> 0
6027 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6031 /* Check the newline before point for invisibility. */
6034 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6035 Qinvisible
, it
->window
);
6036 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6040 if (IT_CHARPOS (*it
) <= BEGV
)
6045 void *it2data
= NULL
;
6048 Lisp_Object val
, overlay
;
6050 SAVE_IT (it2
, *it
, it2data
);
6052 /* If newline is part of a composition, continue from start of composition */
6053 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6054 && beg
< IT_CHARPOS (*it
))
6057 /* If newline is replaced by a display property, find start of overlay
6058 or interval and continue search from that point. */
6059 pos
= --IT_CHARPOS (it2
);
6062 bidi_unshelve_cache (NULL
, 0);
6063 it2
.string_from_display_prop_p
= 0;
6064 it2
.from_disp_prop_p
= 0;
6065 if (handle_display_prop (&it2
) == HANDLED_RETURN
6066 && !NILP (val
= get_char_property_and_overlay
6067 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6068 && (OVERLAYP (overlay
)
6069 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6070 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6072 RESTORE_IT (it
, it
, it2data
);
6076 /* Newline is not replaced by anything -- so we are done. */
6077 RESTORE_IT (it
, it
, it2data
);
6083 IT_CHARPOS (*it
) = beg
;
6084 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6088 it
->continuation_lines_width
= 0;
6090 eassert (IT_CHARPOS (*it
) >= BEGV
);
6091 eassert (IT_CHARPOS (*it
) == BEGV
6092 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6097 /* Reseat iterator IT at the previous visible line start. Skip
6098 invisible text that is so either due to text properties or due to
6099 selective display. At the end, update IT's overlay information,
6100 face information etc. */
6103 reseat_at_previous_visible_line_start (struct it
*it
)
6105 back_to_previous_visible_line_start (it
);
6106 reseat (it
, it
->current
.pos
, 1);
6111 /* Reseat iterator IT on the next visible line start in the current
6112 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6113 preceding the line start. Skip over invisible text that is so
6114 because of selective display. Compute faces, overlays etc at the
6115 new position. Note that this function does not skip over text that
6116 is invisible because of text properties. */
6119 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6121 int newline_found_p
, skipped_p
= 0;
6122 struct bidi_it bidi_it_prev
;
6124 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6126 /* Skip over lines that are invisible because they are indented
6127 more than the value of IT->selective. */
6128 if (it
->selective
> 0)
6129 while (IT_CHARPOS (*it
) < ZV
6130 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6133 eassert (IT_BYTEPOS (*it
) == BEGV
6134 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6136 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6139 /* Position on the newline if that's what's requested. */
6140 if (on_newline_p
&& newline_found_p
)
6142 if (STRINGP (it
->string
))
6144 if (IT_STRING_CHARPOS (*it
) > 0)
6148 --IT_STRING_CHARPOS (*it
);
6149 --IT_STRING_BYTEPOS (*it
);
6153 /* We need to restore the bidi iterator to the state
6154 it had on the newline, and resync the IT's
6155 position with that. */
6156 it
->bidi_it
= bidi_it_prev
;
6157 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6158 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6162 else if (IT_CHARPOS (*it
) > BEGV
)
6171 /* We need to restore the bidi iterator to the state it
6172 had on the newline and resync IT with that. */
6173 it
->bidi_it
= bidi_it_prev
;
6174 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6175 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6177 reseat (it
, it
->current
.pos
, 0);
6181 reseat (it
, it
->current
.pos
, 0);
6188 /***********************************************************************
6189 Changing an iterator's position
6190 ***********************************************************************/
6192 /* Change IT's current position to POS in current_buffer. If FORCE_P
6193 is non-zero, always check for text properties at the new position.
6194 Otherwise, text properties are only looked up if POS >=
6195 IT->check_charpos of a property. */
6198 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6200 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6202 reseat_1 (it
, pos
, 0);
6204 /* Determine where to check text properties. Avoid doing it
6205 where possible because text property lookup is very expensive. */
6207 || CHARPOS (pos
) > it
->stop_charpos
6208 || CHARPOS (pos
) < original_pos
)
6212 /* For bidi iteration, we need to prime prev_stop and
6213 base_level_stop with our best estimations. */
6214 /* Implementation note: Of course, POS is not necessarily a
6215 stop position, so assigning prev_pos to it is a lie; we
6216 should have called compute_stop_backwards. However, if
6217 the current buffer does not include any R2L characters,
6218 that call would be a waste of cycles, because the
6219 iterator will never move back, and thus never cross this
6220 "fake" stop position. So we delay that backward search
6221 until the time we really need it, in next_element_from_buffer. */
6222 if (CHARPOS (pos
) != it
->prev_stop
)
6223 it
->prev_stop
= CHARPOS (pos
);
6224 if (CHARPOS (pos
) < it
->base_level_stop
)
6225 it
->base_level_stop
= 0; /* meaning it's unknown */
6231 it
->prev_stop
= it
->base_level_stop
= 0;
6240 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6241 IT->stop_pos to POS, also. */
6244 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6246 /* Don't call this function when scanning a C string. */
6247 eassert (it
->s
== NULL
);
6249 /* POS must be a reasonable value. */
6250 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6252 it
->current
.pos
= it
->position
= pos
;
6253 it
->end_charpos
= ZV
;
6255 it
->current
.dpvec_index
= -1;
6256 it
->current
.overlay_string_index
= -1;
6257 IT_STRING_CHARPOS (*it
) = -1;
6258 IT_STRING_BYTEPOS (*it
) = -1;
6260 it
->method
= GET_FROM_BUFFER
;
6261 it
->object
= it
->w
->buffer
;
6262 it
->area
= TEXT_AREA
;
6263 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6265 it
->string_from_display_prop_p
= 0;
6266 it
->string_from_prefix_prop_p
= 0;
6268 it
->from_disp_prop_p
= 0;
6269 it
->face_before_selective_p
= 0;
6272 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6274 bidi_unshelve_cache (NULL
, 0);
6275 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6276 it
->bidi_it
.string
.s
= NULL
;
6277 it
->bidi_it
.string
.lstring
= Qnil
;
6278 it
->bidi_it
.string
.bufpos
= 0;
6279 it
->bidi_it
.string
.unibyte
= 0;
6284 it
->stop_charpos
= CHARPOS (pos
);
6285 it
->base_level_stop
= CHARPOS (pos
);
6290 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6291 If S is non-null, it is a C string to iterate over. Otherwise,
6292 STRING gives a Lisp string to iterate over.
6294 If PRECISION > 0, don't return more then PRECISION number of
6295 characters from the string.
6297 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6298 characters have been returned. FIELD_WIDTH < 0 means an infinite
6301 MULTIBYTE = 0 means disable processing of multibyte characters,
6302 MULTIBYTE > 0 means enable it,
6303 MULTIBYTE < 0 means use IT->multibyte_p.
6305 IT must be initialized via a prior call to init_iterator before
6306 calling this function. */
6309 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6310 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6313 /* No region in strings. */
6314 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6316 /* No text property checks performed by default, but see below. */
6317 it
->stop_charpos
= -1;
6319 /* Set iterator position and end position. */
6320 memset (&it
->current
, 0, sizeof it
->current
);
6321 it
->current
.overlay_string_index
= -1;
6322 it
->current
.dpvec_index
= -1;
6323 eassert (charpos
>= 0);
6325 /* If STRING is specified, use its multibyteness, otherwise use the
6326 setting of MULTIBYTE, if specified. */
6328 it
->multibyte_p
= multibyte
> 0;
6330 /* Bidirectional reordering of strings is controlled by the default
6331 value of bidi-display-reordering. Don't try to reorder while
6332 loading loadup.el, as the necessary character property tables are
6333 not yet available. */
6336 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6340 eassert (STRINGP (string
));
6341 it
->string
= string
;
6343 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6344 it
->method
= GET_FROM_STRING
;
6345 it
->current
.string_pos
= string_pos (charpos
, string
);
6349 it
->bidi_it
.string
.lstring
= string
;
6350 it
->bidi_it
.string
.s
= NULL
;
6351 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6352 it
->bidi_it
.string
.bufpos
= 0;
6353 it
->bidi_it
.string
.from_disp_str
= 0;
6354 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6355 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6356 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6361 it
->s
= (const unsigned char *) s
;
6364 /* Note that we use IT->current.pos, not it->current.string_pos,
6365 for displaying C strings. */
6366 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6367 if (it
->multibyte_p
)
6369 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6370 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6374 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6375 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6380 it
->bidi_it
.string
.lstring
= Qnil
;
6381 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6382 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6383 it
->bidi_it
.string
.bufpos
= 0;
6384 it
->bidi_it
.string
.from_disp_str
= 0;
6385 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6386 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6389 it
->method
= GET_FROM_C_STRING
;
6392 /* PRECISION > 0 means don't return more than PRECISION characters
6394 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6396 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6398 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6401 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6402 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6403 FIELD_WIDTH < 0 means infinite field width. This is useful for
6404 padding with `-' at the end of a mode line. */
6405 if (field_width
< 0)
6406 field_width
= INFINITY
;
6407 /* Implementation note: We deliberately don't enlarge
6408 it->bidi_it.string.schars here to fit it->end_charpos, because
6409 the bidi iterator cannot produce characters out of thin air. */
6410 if (field_width
> it
->end_charpos
- charpos
)
6411 it
->end_charpos
= charpos
+ field_width
;
6413 /* Use the standard display table for displaying strings. */
6414 if (DISP_TABLE_P (Vstandard_display_table
))
6415 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6417 it
->stop_charpos
= charpos
;
6418 it
->prev_stop
= charpos
;
6419 it
->base_level_stop
= 0;
6422 it
->bidi_it
.first_elt
= 1;
6423 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6424 it
->bidi_it
.disp_pos
= -1;
6426 if (s
== NULL
&& it
->multibyte_p
)
6428 ptrdiff_t endpos
= SCHARS (it
->string
);
6429 if (endpos
> it
->end_charpos
)
6430 endpos
= it
->end_charpos
;
6431 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6439 /***********************************************************************
6441 ***********************************************************************/
6443 /* Map enum it_method value to corresponding next_element_from_* function. */
6445 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6447 next_element_from_buffer
,
6448 next_element_from_display_vector
,
6449 next_element_from_string
,
6450 next_element_from_c_string
,
6451 next_element_from_image
,
6452 next_element_from_stretch
6455 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6458 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6459 (possibly with the following characters). */
6461 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6462 ((IT)->cmp_it.id >= 0 \
6463 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6464 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6465 END_CHARPOS, (IT)->w, \
6466 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6470 /* Lookup the char-table Vglyphless_char_display for character C (-1
6471 if we want information for no-font case), and return the display
6472 method symbol. By side-effect, update it->what and
6473 it->glyphless_method. This function is called from
6474 get_next_display_element for each character element, and from
6475 x_produce_glyphs when no suitable font was found. */
6478 lookup_glyphless_char_display (int c
, struct it
*it
)
6480 Lisp_Object glyphless_method
= Qnil
;
6482 if (CHAR_TABLE_P (Vglyphless_char_display
)
6483 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6487 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6488 if (CONSP (glyphless_method
))
6489 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6490 ? XCAR (glyphless_method
)
6491 : XCDR (glyphless_method
);
6494 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6498 if (NILP (glyphless_method
))
6501 /* The default is to display the character by a proper font. */
6503 /* The default for the no-font case is to display an empty box. */
6504 glyphless_method
= Qempty_box
;
6506 if (EQ (glyphless_method
, Qzero_width
))
6509 return glyphless_method
;
6510 /* This method can't be used for the no-font case. */
6511 glyphless_method
= Qempty_box
;
6513 if (EQ (glyphless_method
, Qthin_space
))
6514 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6515 else if (EQ (glyphless_method
, Qempty_box
))
6516 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6517 else if (EQ (glyphless_method
, Qhex_code
))
6518 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6519 else if (STRINGP (glyphless_method
))
6520 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6523 /* Invalid value. We use the default method. */
6524 glyphless_method
= Qnil
;
6527 it
->what
= IT_GLYPHLESS
;
6528 return glyphless_method
;
6531 /* Load IT's display element fields with information about the next
6532 display element from the current position of IT. Value is zero if
6533 end of buffer (or C string) is reached. */
6535 static struct frame
*last_escape_glyph_frame
= NULL
;
6536 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6537 static int last_escape_glyph_merged_face_id
= 0;
6539 struct frame
*last_glyphless_glyph_frame
= NULL
;
6540 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6541 int last_glyphless_glyph_merged_face_id
= 0;
6544 get_next_display_element (struct it
*it
)
6546 /* Non-zero means that we found a display element. Zero means that
6547 we hit the end of what we iterate over. Performance note: the
6548 function pointer `method' used here turns out to be faster than
6549 using a sequence of if-statements. */
6553 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6555 if (it
->what
== IT_CHARACTER
)
6557 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6558 and only if (a) the resolved directionality of that character
6560 /* FIXME: Do we need an exception for characters from display
6562 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6563 it
->c
= bidi_mirror_char (it
->c
);
6564 /* Map via display table or translate control characters.
6565 IT->c, IT->len etc. have been set to the next character by
6566 the function call above. If we have a display table, and it
6567 contains an entry for IT->c, translate it. Don't do this if
6568 IT->c itself comes from a display table, otherwise we could
6569 end up in an infinite recursion. (An alternative could be to
6570 count the recursion depth of this function and signal an
6571 error when a certain maximum depth is reached.) Is it worth
6573 if (success_p
&& it
->dpvec
== NULL
)
6576 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6577 int nonascii_space_p
= 0;
6578 int nonascii_hyphen_p
= 0;
6579 int c
= it
->c
; /* This is the character to display. */
6581 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6583 eassert (SINGLE_BYTE_CHAR_P (c
));
6584 if (unibyte_display_via_language_environment
)
6586 c
= DECODE_CHAR (unibyte
, c
);
6588 c
= BYTE8_TO_CHAR (it
->c
);
6591 c
= BYTE8_TO_CHAR (it
->c
);
6595 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6598 struct Lisp_Vector
*v
= XVECTOR (dv
);
6600 /* Return the first character from the display table
6601 entry, if not empty. If empty, don't display the
6602 current character. */
6605 it
->dpvec_char_len
= it
->len
;
6606 it
->dpvec
= v
->contents
;
6607 it
->dpend
= v
->contents
+ v
->header
.size
;
6608 it
->current
.dpvec_index
= 0;
6609 it
->dpvec_face_id
= -1;
6610 it
->saved_face_id
= it
->face_id
;
6611 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6616 set_iterator_to_next (it
, 0);
6621 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6623 if (it
->what
== IT_GLYPHLESS
)
6625 /* Don't display this character. */
6626 set_iterator_to_next (it
, 0);
6630 /* If `nobreak-char-display' is non-nil, we display
6631 non-ASCII spaces and hyphens specially. */
6632 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6635 nonascii_space_p
= 1;
6636 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6637 nonascii_hyphen_p
= 1;
6640 /* Translate control characters into `\003' or `^C' form.
6641 Control characters coming from a display table entry are
6642 currently not translated because we use IT->dpvec to hold
6643 the translation. This could easily be changed but I
6644 don't believe that it is worth doing.
6646 The characters handled by `nobreak-char-display' must be
6649 Non-printable characters and raw-byte characters are also
6650 translated to octal form. */
6651 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6652 ? (it
->area
!= TEXT_AREA
6653 /* In mode line, treat \n, \t like other crl chars. */
6656 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6657 || (c
!= '\n' && c
!= '\t'))
6659 || nonascii_hyphen_p
6661 || ! CHAR_PRINTABLE_P (c
))))
6663 /* C is a control character, non-ASCII space/hyphen,
6664 raw-byte, or a non-printable character which must be
6665 displayed either as '\003' or as `^C' where the '\\'
6666 and '^' can be defined in the display table. Fill
6667 IT->ctl_chars with glyphs for what we have to
6668 display. Then, set IT->dpvec to these glyphs. */
6675 /* Handle control characters with ^. */
6677 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6681 g
= '^'; /* default glyph for Control */
6682 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6684 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6686 g
= GLYPH_CODE_CHAR (gc
);
6687 lface_id
= GLYPH_CODE_FACE (gc
);
6691 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6693 else if (it
->f
== last_escape_glyph_frame
6694 && it
->face_id
== last_escape_glyph_face_id
)
6696 face_id
= last_escape_glyph_merged_face_id
;
6700 /* Merge the escape-glyph face into the current face. */
6701 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6703 last_escape_glyph_frame
= it
->f
;
6704 last_escape_glyph_face_id
= it
->face_id
;
6705 last_escape_glyph_merged_face_id
= face_id
;
6708 XSETINT (it
->ctl_chars
[0], g
);
6709 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6711 goto display_control
;
6714 /* Handle non-ascii space in the mode where it only gets
6717 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6719 /* Merge `nobreak-space' into the current face. */
6720 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6722 XSETINT (it
->ctl_chars
[0], ' ');
6724 goto display_control
;
6727 /* Handle sequences that start with the "escape glyph". */
6729 /* the default escape glyph is \. */
6730 escape_glyph
= '\\';
6733 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6735 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6736 lface_id
= GLYPH_CODE_FACE (gc
);
6740 /* The display table specified a face.
6741 Merge it into face_id and also into escape_glyph. */
6742 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6745 else if (it
->f
== last_escape_glyph_frame
6746 && it
->face_id
== last_escape_glyph_face_id
)
6748 face_id
= last_escape_glyph_merged_face_id
;
6752 /* Merge the escape-glyph face into the current face. */
6753 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6755 last_escape_glyph_frame
= it
->f
;
6756 last_escape_glyph_face_id
= it
->face_id
;
6757 last_escape_glyph_merged_face_id
= face_id
;
6760 /* Draw non-ASCII hyphen with just highlighting: */
6762 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6764 XSETINT (it
->ctl_chars
[0], '-');
6766 goto display_control
;
6769 /* Draw non-ASCII space/hyphen with escape glyph: */
6771 if (nonascii_space_p
|| nonascii_hyphen_p
)
6773 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6774 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6776 goto display_control
;
6783 if (CHAR_BYTE8_P (c
))
6784 /* Display \200 instead of \17777600. */
6785 c
= CHAR_TO_BYTE8 (c
);
6786 len
= sprintf (str
, "%03o", c
);
6788 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6789 for (i
= 0; i
< len
; i
++)
6790 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6795 /* Set up IT->dpvec and return first character from it. */
6796 it
->dpvec_char_len
= it
->len
;
6797 it
->dpvec
= it
->ctl_chars
;
6798 it
->dpend
= it
->dpvec
+ ctl_len
;
6799 it
->current
.dpvec_index
= 0;
6800 it
->dpvec_face_id
= face_id
;
6801 it
->saved_face_id
= it
->face_id
;
6802 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6806 it
->char_to_display
= c
;
6810 it
->char_to_display
= it
->c
;
6814 /* Adjust face id for a multibyte character. There are no multibyte
6815 character in unibyte text. */
6816 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6819 && FRAME_WINDOW_P (it
->f
))
6821 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6823 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6825 /* Automatic composition with glyph-string. */
6826 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6828 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6832 ptrdiff_t pos
= (it
->s
? -1
6833 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6834 : IT_CHARPOS (*it
));
6837 if (it
->what
== IT_CHARACTER
)
6838 c
= it
->char_to_display
;
6841 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6845 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6846 /* TAB in a composition means display glyphs with
6847 padding space on the left or right. */
6848 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6851 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6856 /* Is this character the last one of a run of characters with
6857 box? If yes, set IT->end_of_box_run_p to 1. */
6861 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6863 int face_id
= underlying_face_id (it
);
6864 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6868 if (face
->box
== FACE_NO_BOX
)
6870 /* If the box comes from face properties in a
6871 display string, check faces in that string. */
6872 int string_face_id
= face_after_it_pos (it
);
6873 it
->end_of_box_run_p
6874 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6877 /* Otherwise, the box comes from the underlying face.
6878 If this is the last string character displayed, check
6879 the next buffer location. */
6880 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6881 && (it
->current
.overlay_string_index
6882 == it
->n_overlay_strings
- 1))
6886 struct text_pos pos
= it
->current
.pos
;
6887 INC_TEXT_POS (pos
, it
->multibyte_p
);
6889 next_face_id
= face_at_buffer_position
6890 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6891 it
->region_end_charpos
, &ignore
,
6892 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6894 it
->end_of_box_run_p
6895 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6902 int face_id
= face_after_it_pos (it
);
6903 it
->end_of_box_run_p
6904 = (face_id
!= it
->face_id
6905 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6908 /* If we reached the end of the object we've been iterating (e.g., a
6909 display string or an overlay string), and there's something on
6910 IT->stack, proceed with what's on the stack. It doesn't make
6911 sense to return zero if there's unprocessed stuff on the stack,
6912 because otherwise that stuff will never be displayed. */
6913 if (!success_p
&& it
->sp
> 0)
6915 set_iterator_to_next (it
, 0);
6916 success_p
= get_next_display_element (it
);
6919 /* Value is 0 if end of buffer or string reached. */
6924 /* Move IT to the next display element.
6926 RESEAT_P non-zero means if called on a newline in buffer text,
6927 skip to the next visible line start.
6929 Functions get_next_display_element and set_iterator_to_next are
6930 separate because I find this arrangement easier to handle than a
6931 get_next_display_element function that also increments IT's
6932 position. The way it is we can first look at an iterator's current
6933 display element, decide whether it fits on a line, and if it does,
6934 increment the iterator position. The other way around we probably
6935 would either need a flag indicating whether the iterator has to be
6936 incremented the next time, or we would have to implement a
6937 decrement position function which would not be easy to write. */
6940 set_iterator_to_next (struct it
*it
, int reseat_p
)
6942 /* Reset flags indicating start and end of a sequence of characters
6943 with box. Reset them at the start of this function because
6944 moving the iterator to a new position might set them. */
6945 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6949 case GET_FROM_BUFFER
:
6950 /* The current display element of IT is a character from
6951 current_buffer. Advance in the buffer, and maybe skip over
6952 invisible lines that are so because of selective display. */
6953 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6954 reseat_at_next_visible_line_start (it
, 0);
6955 else if (it
->cmp_it
.id
>= 0)
6957 /* We are currently getting glyphs from a composition. */
6962 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6963 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6964 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6966 it
->cmp_it
.from
= it
->cmp_it
.to
;
6971 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6973 it
->end_charpos
, Qnil
);
6976 else if (! it
->cmp_it
.reversed_p
)
6978 /* Composition created while scanning forward. */
6979 /* Update IT's char/byte positions to point to the first
6980 character of the next grapheme cluster, or to the
6981 character visually after the current composition. */
6982 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6983 bidi_move_to_visually_next (&it
->bidi_it
);
6984 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6985 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6987 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6989 /* Proceed to the next grapheme cluster. */
6990 it
->cmp_it
.from
= it
->cmp_it
.to
;
6994 /* No more grapheme clusters in this composition.
6995 Find the next stop position. */
6996 ptrdiff_t stop
= it
->end_charpos
;
6997 if (it
->bidi_it
.scan_dir
< 0)
6998 /* Now we are scanning backward and don't know
7001 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7002 IT_BYTEPOS (*it
), stop
, Qnil
);
7007 /* Composition created while scanning backward. */
7008 /* Update IT's char/byte positions to point to the last
7009 character of the previous grapheme cluster, or the
7010 character visually after the current composition. */
7011 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7012 bidi_move_to_visually_next (&it
->bidi_it
);
7013 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7014 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7015 if (it
->cmp_it
.from
> 0)
7017 /* Proceed to the previous grapheme cluster. */
7018 it
->cmp_it
.to
= it
->cmp_it
.from
;
7022 /* No more grapheme clusters in this composition.
7023 Find the next stop position. */
7024 ptrdiff_t stop
= it
->end_charpos
;
7025 if (it
->bidi_it
.scan_dir
< 0)
7026 /* Now we are scanning backward and don't know
7029 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7030 IT_BYTEPOS (*it
), stop
, Qnil
);
7036 eassert (it
->len
!= 0);
7040 IT_BYTEPOS (*it
) += it
->len
;
7041 IT_CHARPOS (*it
) += 1;
7045 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7046 /* If this is a new paragraph, determine its base
7047 direction (a.k.a. its base embedding level). */
7048 if (it
->bidi_it
.new_paragraph
)
7049 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7050 bidi_move_to_visually_next (&it
->bidi_it
);
7051 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7052 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7053 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7055 /* As the scan direction was changed, we must
7056 re-compute the stop position for composition. */
7057 ptrdiff_t stop
= it
->end_charpos
;
7058 if (it
->bidi_it
.scan_dir
< 0)
7060 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7061 IT_BYTEPOS (*it
), stop
, Qnil
);
7064 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7068 case GET_FROM_C_STRING
:
7069 /* Current display element of IT is from a C string. */
7071 /* If the string position is beyond string's end, it means
7072 next_element_from_c_string is padding the string with
7073 blanks, in which case we bypass the bidi iterator,
7074 because it cannot deal with such virtual characters. */
7075 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7077 IT_BYTEPOS (*it
) += it
->len
;
7078 IT_CHARPOS (*it
) += 1;
7082 bidi_move_to_visually_next (&it
->bidi_it
);
7083 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7084 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7088 case GET_FROM_DISPLAY_VECTOR
:
7089 /* Current display element of IT is from a display table entry.
7090 Advance in the display table definition. Reset it to null if
7091 end reached, and continue with characters from buffers/
7093 ++it
->current
.dpvec_index
;
7095 /* Restore face of the iterator to what they were before the
7096 display vector entry (these entries may contain faces). */
7097 it
->face_id
= it
->saved_face_id
;
7099 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7101 int recheck_faces
= it
->ellipsis_p
;
7104 it
->method
= GET_FROM_C_STRING
;
7105 else if (STRINGP (it
->string
))
7106 it
->method
= GET_FROM_STRING
;
7109 it
->method
= GET_FROM_BUFFER
;
7110 it
->object
= it
->w
->buffer
;
7114 it
->current
.dpvec_index
= -1;
7116 /* Skip over characters which were displayed via IT->dpvec. */
7117 if (it
->dpvec_char_len
< 0)
7118 reseat_at_next_visible_line_start (it
, 1);
7119 else if (it
->dpvec_char_len
> 0)
7121 if (it
->method
== GET_FROM_STRING
7122 && it
->n_overlay_strings
> 0)
7123 it
->ignore_overlay_strings_at_pos_p
= 1;
7124 it
->len
= it
->dpvec_char_len
;
7125 set_iterator_to_next (it
, reseat_p
);
7128 /* Maybe recheck faces after display vector */
7130 it
->stop_charpos
= IT_CHARPOS (*it
);
7134 case GET_FROM_STRING
:
7135 /* Current display element is a character from a Lisp string. */
7136 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7137 /* Don't advance past string end. These conditions are true
7138 when set_iterator_to_next is called at the end of
7139 get_next_display_element, in which case the Lisp string is
7140 already exhausted, and all we want is pop the iterator
7142 if (it
->current
.overlay_string_index
>= 0)
7144 /* This is an overlay string, so there's no padding with
7145 spaces, and the number of characters in the string is
7146 where the string ends. */
7147 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7148 goto consider_string_end
;
7152 /* Not an overlay string. There could be padding, so test
7153 against it->end_charpos . */
7154 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7155 goto consider_string_end
;
7157 if (it
->cmp_it
.id
>= 0)
7163 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7164 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7165 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7166 it
->cmp_it
.from
= it
->cmp_it
.to
;
7170 composition_compute_stop_pos (&it
->cmp_it
,
7171 IT_STRING_CHARPOS (*it
),
7172 IT_STRING_BYTEPOS (*it
),
7173 it
->end_charpos
, it
->string
);
7176 else if (! it
->cmp_it
.reversed_p
)
7178 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7179 bidi_move_to_visually_next (&it
->bidi_it
);
7180 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7181 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7183 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7184 it
->cmp_it
.from
= it
->cmp_it
.to
;
7187 ptrdiff_t stop
= it
->end_charpos
;
7188 if (it
->bidi_it
.scan_dir
< 0)
7190 composition_compute_stop_pos (&it
->cmp_it
,
7191 IT_STRING_CHARPOS (*it
),
7192 IT_STRING_BYTEPOS (*it
), stop
,
7198 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7199 bidi_move_to_visually_next (&it
->bidi_it
);
7200 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7201 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7202 if (it
->cmp_it
.from
> 0)
7203 it
->cmp_it
.to
= it
->cmp_it
.from
;
7206 ptrdiff_t stop
= it
->end_charpos
;
7207 if (it
->bidi_it
.scan_dir
< 0)
7209 composition_compute_stop_pos (&it
->cmp_it
,
7210 IT_STRING_CHARPOS (*it
),
7211 IT_STRING_BYTEPOS (*it
), stop
,
7219 /* If the string position is beyond string's end, it
7220 means next_element_from_string is padding the string
7221 with blanks, in which case we bypass the bidi
7222 iterator, because it cannot deal with such virtual
7224 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7226 IT_STRING_BYTEPOS (*it
) += it
->len
;
7227 IT_STRING_CHARPOS (*it
) += 1;
7231 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7233 bidi_move_to_visually_next (&it
->bidi_it
);
7234 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7235 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7236 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7238 ptrdiff_t stop
= it
->end_charpos
;
7240 if (it
->bidi_it
.scan_dir
< 0)
7242 composition_compute_stop_pos (&it
->cmp_it
,
7243 IT_STRING_CHARPOS (*it
),
7244 IT_STRING_BYTEPOS (*it
), stop
,
7250 consider_string_end
:
7252 if (it
->current
.overlay_string_index
>= 0)
7254 /* IT->string is an overlay string. Advance to the
7255 next, if there is one. */
7256 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7259 next_overlay_string (it
);
7261 setup_for_ellipsis (it
, 0);
7266 /* IT->string is not an overlay string. If we reached
7267 its end, and there is something on IT->stack, proceed
7268 with what is on the stack. This can be either another
7269 string, this time an overlay string, or a buffer. */
7270 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7274 if (it
->method
== GET_FROM_STRING
)
7275 goto consider_string_end
;
7280 case GET_FROM_IMAGE
:
7281 case GET_FROM_STRETCH
:
7282 /* The position etc with which we have to proceed are on
7283 the stack. The position may be at the end of a string,
7284 if the `display' property takes up the whole string. */
7285 eassert (it
->sp
> 0);
7287 if (it
->method
== GET_FROM_STRING
)
7288 goto consider_string_end
;
7292 /* There are no other methods defined, so this should be a bug. */
7296 eassert (it
->method
!= GET_FROM_STRING
7297 || (STRINGP (it
->string
)
7298 && IT_STRING_CHARPOS (*it
) >= 0));
7301 /* Load IT's display element fields with information about the next
7302 display element which comes from a display table entry or from the
7303 result of translating a control character to one of the forms `^C'
7306 IT->dpvec holds the glyphs to return as characters.
7307 IT->saved_face_id holds the face id before the display vector--it
7308 is restored into IT->face_id in set_iterator_to_next. */
7311 next_element_from_display_vector (struct it
*it
)
7316 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7318 it
->face_id
= it
->saved_face_id
;
7320 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7321 That seemed totally bogus - so I changed it... */
7322 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7324 if (GLYPH_CODE_P (gc
))
7326 it
->c
= GLYPH_CODE_CHAR (gc
);
7327 it
->len
= CHAR_BYTES (it
->c
);
7329 /* The entry may contain a face id to use. Such a face id is
7330 the id of a Lisp face, not a realized face. A face id of
7331 zero means no face is specified. */
7332 if (it
->dpvec_face_id
>= 0)
7333 it
->face_id
= it
->dpvec_face_id
;
7336 int lface_id
= GLYPH_CODE_FACE (gc
);
7338 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7343 /* Display table entry is invalid. Return a space. */
7344 it
->c
= ' ', it
->len
= 1;
7346 /* Don't change position and object of the iterator here. They are
7347 still the values of the character that had this display table
7348 entry or was translated, and that's what we want. */
7349 it
->what
= IT_CHARACTER
;
7353 /* Get the first element of string/buffer in the visual order, after
7354 being reseated to a new position in a string or a buffer. */
7356 get_visually_first_element (struct it
*it
)
7358 int string_p
= STRINGP (it
->string
) || it
->s
;
7359 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7360 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7362 if (STRINGP (it
->string
))
7364 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7365 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7369 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7370 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7373 if (it
->bidi_it
.charpos
== eob
)
7375 /* Nothing to do, but reset the FIRST_ELT flag, like
7376 bidi_paragraph_init does, because we are not going to
7378 it
->bidi_it
.first_elt
= 0;
7380 else if (it
->bidi_it
.charpos
== bob
7382 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7383 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7385 /* If we are at the beginning of a line/string, we can produce
7386 the next element right away. */
7387 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7388 bidi_move_to_visually_next (&it
->bidi_it
);
7392 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7394 /* We need to prime the bidi iterator starting at the line's or
7395 string's beginning, before we will be able to produce the
7398 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7401 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7403 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7405 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7408 /* Now return to buffer/string position where we were asked
7409 to get the next display element, and produce that. */
7410 bidi_move_to_visually_next (&it
->bidi_it
);
7412 while (it
->bidi_it
.bytepos
!= orig_bytepos
7413 && it
->bidi_it
.charpos
< eob
);
7416 /* Adjust IT's position information to where we ended up. */
7417 if (STRINGP (it
->string
))
7419 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7420 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7424 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7425 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7428 if (STRINGP (it
->string
) || !it
->s
)
7430 ptrdiff_t stop
, charpos
, bytepos
;
7432 if (STRINGP (it
->string
))
7435 stop
= SCHARS (it
->string
);
7436 if (stop
> it
->end_charpos
)
7437 stop
= it
->end_charpos
;
7438 charpos
= IT_STRING_CHARPOS (*it
);
7439 bytepos
= IT_STRING_BYTEPOS (*it
);
7443 stop
= it
->end_charpos
;
7444 charpos
= IT_CHARPOS (*it
);
7445 bytepos
= IT_BYTEPOS (*it
);
7447 if (it
->bidi_it
.scan_dir
< 0)
7449 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7454 /* Load IT with the next display element from Lisp string IT->string.
7455 IT->current.string_pos is the current position within the string.
7456 If IT->current.overlay_string_index >= 0, the Lisp string is an
7460 next_element_from_string (struct it
*it
)
7462 struct text_pos position
;
7464 eassert (STRINGP (it
->string
));
7465 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7466 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7467 position
= it
->current
.string_pos
;
7469 /* With bidi reordering, the character to display might not be the
7470 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7471 that we were reseat()ed to a new string, whose paragraph
7472 direction is not known. */
7473 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7475 get_visually_first_element (it
);
7476 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7479 /* Time to check for invisible text? */
7480 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7482 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7485 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7486 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7488 /* With bidi non-linear iteration, we could find
7489 ourselves far beyond the last computed stop_charpos,
7490 with several other stop positions in between that we
7491 missed. Scan them all now, in buffer's logical
7492 order, until we find and handle the last stop_charpos
7493 that precedes our current position. */
7494 handle_stop_backwards (it
, it
->stop_charpos
);
7495 return GET_NEXT_DISPLAY_ELEMENT (it
);
7501 /* Take note of the stop position we just moved
7502 across, for when we will move back across it. */
7503 it
->prev_stop
= it
->stop_charpos
;
7504 /* If we are at base paragraph embedding level, take
7505 note of the last stop position seen at this
7507 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7508 it
->base_level_stop
= it
->stop_charpos
;
7512 /* Since a handler may have changed IT->method, we must
7514 return GET_NEXT_DISPLAY_ELEMENT (it
);
7518 /* If we are before prev_stop, we may have overstepped
7519 on our way backwards a stop_pos, and if so, we need
7520 to handle that stop_pos. */
7521 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7522 /* We can sometimes back up for reasons that have nothing
7523 to do with bidi reordering. E.g., compositions. The
7524 code below is only needed when we are above the base
7525 embedding level, so test for that explicitly. */
7526 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7528 /* If we lost track of base_level_stop, we have no better
7529 place for handle_stop_backwards to start from than string
7530 beginning. This happens, e.g., when we were reseated to
7531 the previous screenful of text by vertical-motion. */
7532 if (it
->base_level_stop
<= 0
7533 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7534 it
->base_level_stop
= 0;
7535 handle_stop_backwards (it
, it
->base_level_stop
);
7536 return GET_NEXT_DISPLAY_ELEMENT (it
);
7540 if (it
->current
.overlay_string_index
>= 0)
7542 /* Get the next character from an overlay string. In overlay
7543 strings, there is no field width or padding with spaces to
7545 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7550 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7551 IT_STRING_BYTEPOS (*it
),
7552 it
->bidi_it
.scan_dir
< 0
7554 : SCHARS (it
->string
))
7555 && next_element_from_composition (it
))
7559 else if (STRING_MULTIBYTE (it
->string
))
7561 const unsigned char *s
= (SDATA (it
->string
)
7562 + IT_STRING_BYTEPOS (*it
));
7563 it
->c
= string_char_and_length (s
, &it
->len
);
7567 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7573 /* Get the next character from a Lisp string that is not an
7574 overlay string. Such strings come from the mode line, for
7575 example. We may have to pad with spaces, or truncate the
7576 string. See also next_element_from_c_string. */
7577 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7582 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7584 /* Pad with spaces. */
7585 it
->c
= ' ', it
->len
= 1;
7586 CHARPOS (position
) = BYTEPOS (position
) = -1;
7588 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7589 IT_STRING_BYTEPOS (*it
),
7590 it
->bidi_it
.scan_dir
< 0
7592 : it
->string_nchars
)
7593 && next_element_from_composition (it
))
7597 else if (STRING_MULTIBYTE (it
->string
))
7599 const unsigned char *s
= (SDATA (it
->string
)
7600 + IT_STRING_BYTEPOS (*it
));
7601 it
->c
= string_char_and_length (s
, &it
->len
);
7605 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7610 /* Record what we have and where it came from. */
7611 it
->what
= IT_CHARACTER
;
7612 it
->object
= it
->string
;
7613 it
->position
= position
;
7618 /* Load IT with next display element from C string IT->s.
7619 IT->string_nchars is the maximum number of characters to return
7620 from the string. IT->end_charpos may be greater than
7621 IT->string_nchars when this function is called, in which case we
7622 may have to return padding spaces. Value is zero if end of string
7623 reached, including padding spaces. */
7626 next_element_from_c_string (struct it
*it
)
7631 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7632 it
->what
= IT_CHARACTER
;
7633 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7636 /* With bidi reordering, the character to display might not be the
7637 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7638 we were reseated to a new string, whose paragraph direction is
7640 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7641 get_visually_first_element (it
);
7643 /* IT's position can be greater than IT->string_nchars in case a
7644 field width or precision has been specified when the iterator was
7646 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7648 /* End of the game. */
7652 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7654 /* Pad with spaces. */
7655 it
->c
= ' ', it
->len
= 1;
7656 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7658 else if (it
->multibyte_p
)
7659 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7661 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7667 /* Set up IT to return characters from an ellipsis, if appropriate.
7668 The definition of the ellipsis glyphs may come from a display table
7669 entry. This function fills IT with the first glyph from the
7670 ellipsis if an ellipsis is to be displayed. */
7673 next_element_from_ellipsis (struct it
*it
)
7675 if (it
->selective_display_ellipsis_p
)
7676 setup_for_ellipsis (it
, it
->len
);
7679 /* The face at the current position may be different from the
7680 face we find after the invisible text. Remember what it
7681 was in IT->saved_face_id, and signal that it's there by
7682 setting face_before_selective_p. */
7683 it
->saved_face_id
= it
->face_id
;
7684 it
->method
= GET_FROM_BUFFER
;
7685 it
->object
= it
->w
->buffer
;
7686 reseat_at_next_visible_line_start (it
, 1);
7687 it
->face_before_selective_p
= 1;
7690 return GET_NEXT_DISPLAY_ELEMENT (it
);
7694 /* Deliver an image display element. The iterator IT is already
7695 filled with image information (done in handle_display_prop). Value
7700 next_element_from_image (struct it
*it
)
7702 it
->what
= IT_IMAGE
;
7703 it
->ignore_overlay_strings_at_pos_p
= 0;
7708 /* Fill iterator IT with next display element from a stretch glyph
7709 property. IT->object is the value of the text property. Value is
7713 next_element_from_stretch (struct it
*it
)
7715 it
->what
= IT_STRETCH
;
7719 /* Scan backwards from IT's current position until we find a stop
7720 position, or until BEGV. This is called when we find ourself
7721 before both the last known prev_stop and base_level_stop while
7722 reordering bidirectional text. */
7725 compute_stop_pos_backwards (struct it
*it
)
7727 const int SCAN_BACK_LIMIT
= 1000;
7728 struct text_pos pos
;
7729 struct display_pos save_current
= it
->current
;
7730 struct text_pos save_position
= it
->position
;
7731 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7732 ptrdiff_t where_we_are
= charpos
;
7733 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7734 ptrdiff_t save_end_pos
= it
->end_charpos
;
7736 eassert (NILP (it
->string
) && !it
->s
);
7737 eassert (it
->bidi_p
);
7741 it
->end_charpos
= min (charpos
+ 1, ZV
);
7742 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7743 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7744 reseat_1 (it
, pos
, 0);
7745 compute_stop_pos (it
);
7746 /* We must advance forward, right? */
7747 if (it
->stop_charpos
<= charpos
)
7750 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7752 if (it
->stop_charpos
<= where_we_are
)
7753 it
->prev_stop
= it
->stop_charpos
;
7755 it
->prev_stop
= BEGV
;
7757 it
->current
= save_current
;
7758 it
->position
= save_position
;
7759 it
->stop_charpos
= save_stop_pos
;
7760 it
->end_charpos
= save_end_pos
;
7763 /* Scan forward from CHARPOS in the current buffer/string, until we
7764 find a stop position > current IT's position. Then handle the stop
7765 position before that. This is called when we bump into a stop
7766 position while reordering bidirectional text. CHARPOS should be
7767 the last previously processed stop_pos (or BEGV/0, if none were
7768 processed yet) whose position is less that IT's current
7772 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7774 int bufp
= !STRINGP (it
->string
);
7775 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7776 struct display_pos save_current
= it
->current
;
7777 struct text_pos save_position
= it
->position
;
7778 struct text_pos pos1
;
7779 ptrdiff_t next_stop
;
7781 /* Scan in strict logical order. */
7782 eassert (it
->bidi_p
);
7786 it
->prev_stop
= charpos
;
7789 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7790 reseat_1 (it
, pos1
, 0);
7793 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7794 compute_stop_pos (it
);
7795 /* We must advance forward, right? */
7796 if (it
->stop_charpos
<= it
->prev_stop
)
7798 charpos
= it
->stop_charpos
;
7800 while (charpos
<= where_we_are
);
7803 it
->current
= save_current
;
7804 it
->position
= save_position
;
7805 next_stop
= it
->stop_charpos
;
7806 it
->stop_charpos
= it
->prev_stop
;
7808 it
->stop_charpos
= next_stop
;
7811 /* Load IT with the next display element from current_buffer. Value
7812 is zero if end of buffer reached. IT->stop_charpos is the next
7813 position at which to stop and check for text properties or buffer
7817 next_element_from_buffer (struct it
*it
)
7821 eassert (IT_CHARPOS (*it
) >= BEGV
);
7822 eassert (NILP (it
->string
) && !it
->s
);
7823 eassert (!it
->bidi_p
7824 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7825 && it
->bidi_it
.string
.s
== NULL
));
7827 /* With bidi reordering, the character to display might not be the
7828 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7829 we were reseat()ed to a new buffer position, which is potentially
7830 a different paragraph. */
7831 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7833 get_visually_first_element (it
);
7834 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7837 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7839 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7841 int overlay_strings_follow_p
;
7843 /* End of the game, except when overlay strings follow that
7844 haven't been returned yet. */
7845 if (it
->overlay_strings_at_end_processed_p
)
7846 overlay_strings_follow_p
= 0;
7849 it
->overlay_strings_at_end_processed_p
= 1;
7850 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7853 if (overlay_strings_follow_p
)
7854 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7858 it
->position
= it
->current
.pos
;
7862 else if (!(!it
->bidi_p
7863 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7864 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7866 /* With bidi non-linear iteration, we could find ourselves
7867 far beyond the last computed stop_charpos, with several
7868 other stop positions in between that we missed. Scan
7869 them all now, in buffer's logical order, until we find
7870 and handle the last stop_charpos that precedes our
7871 current position. */
7872 handle_stop_backwards (it
, it
->stop_charpos
);
7873 return GET_NEXT_DISPLAY_ELEMENT (it
);
7879 /* Take note of the stop position we just moved across,
7880 for when we will move back across it. */
7881 it
->prev_stop
= it
->stop_charpos
;
7882 /* If we are at base paragraph embedding level, take
7883 note of the last stop position seen at this
7885 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7886 it
->base_level_stop
= it
->stop_charpos
;
7889 return GET_NEXT_DISPLAY_ELEMENT (it
);
7893 /* If we are before prev_stop, we may have overstepped on
7894 our way backwards a stop_pos, and if so, we need to
7895 handle that stop_pos. */
7896 && IT_CHARPOS (*it
) < it
->prev_stop
7897 /* We can sometimes back up for reasons that have nothing
7898 to do with bidi reordering. E.g., compositions. The
7899 code below is only needed when we are above the base
7900 embedding level, so test for that explicitly. */
7901 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7903 if (it
->base_level_stop
<= 0
7904 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7906 /* If we lost track of base_level_stop, we need to find
7907 prev_stop by looking backwards. This happens, e.g., when
7908 we were reseated to the previous screenful of text by
7910 it
->base_level_stop
= BEGV
;
7911 compute_stop_pos_backwards (it
);
7912 handle_stop_backwards (it
, it
->prev_stop
);
7915 handle_stop_backwards (it
, it
->base_level_stop
);
7916 return GET_NEXT_DISPLAY_ELEMENT (it
);
7920 /* No face changes, overlays etc. in sight, so just return a
7921 character from current_buffer. */
7925 /* Maybe run the redisplay end trigger hook. Performance note:
7926 This doesn't seem to cost measurable time. */
7927 if (it
->redisplay_end_trigger_charpos
7929 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7930 run_redisplay_end_trigger_hook (it
);
7932 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7933 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7935 && next_element_from_composition (it
))
7940 /* Get the next character, maybe multibyte. */
7941 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7942 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7943 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7945 it
->c
= *p
, it
->len
= 1;
7947 /* Record what we have and where it came from. */
7948 it
->what
= IT_CHARACTER
;
7949 it
->object
= it
->w
->buffer
;
7950 it
->position
= it
->current
.pos
;
7952 /* Normally we return the character found above, except when we
7953 really want to return an ellipsis for selective display. */
7958 /* A value of selective > 0 means hide lines indented more
7959 than that number of columns. */
7960 if (it
->selective
> 0
7961 && IT_CHARPOS (*it
) + 1 < ZV
7962 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7963 IT_BYTEPOS (*it
) + 1,
7966 success_p
= next_element_from_ellipsis (it
);
7967 it
->dpvec_char_len
= -1;
7970 else if (it
->c
== '\r' && it
->selective
== -1)
7972 /* A value of selective == -1 means that everything from the
7973 CR to the end of the line is invisible, with maybe an
7974 ellipsis displayed for it. */
7975 success_p
= next_element_from_ellipsis (it
);
7976 it
->dpvec_char_len
= -1;
7981 /* Value is zero if end of buffer reached. */
7982 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7987 /* Run the redisplay end trigger hook for IT. */
7990 run_redisplay_end_trigger_hook (struct it
*it
)
7992 Lisp_Object args
[3];
7994 /* IT->glyph_row should be non-null, i.e. we should be actually
7995 displaying something, or otherwise we should not run the hook. */
7996 eassert (it
->glyph_row
);
7998 /* Set up hook arguments. */
7999 args
[0] = Qredisplay_end_trigger_functions
;
8000 args
[1] = it
->window
;
8001 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8002 it
->redisplay_end_trigger_charpos
= 0;
8004 /* Since we are *trying* to run these functions, don't try to run
8005 them again, even if they get an error. */
8006 wset_redisplay_end_trigger (it
->w
, Qnil
);
8007 Frun_hook_with_args (3, args
);
8009 /* Notice if it changed the face of the character we are on. */
8010 handle_face_prop (it
);
8014 /* Deliver a composition display element. Unlike the other
8015 next_element_from_XXX, this function is not registered in the array
8016 get_next_element[]. It is called from next_element_from_buffer and
8017 next_element_from_string when necessary. */
8020 next_element_from_composition (struct it
*it
)
8022 it
->what
= IT_COMPOSITION
;
8023 it
->len
= it
->cmp_it
.nbytes
;
8024 if (STRINGP (it
->string
))
8028 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8029 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8032 it
->position
= it
->current
.string_pos
;
8033 it
->object
= it
->string
;
8034 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8035 IT_STRING_BYTEPOS (*it
), it
->string
);
8041 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8042 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8045 if (it
->bidi_it
.new_paragraph
)
8046 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8047 /* Resync the bidi iterator with IT's new position.
8048 FIXME: this doesn't support bidirectional text. */
8049 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8050 bidi_move_to_visually_next (&it
->bidi_it
);
8054 it
->position
= it
->current
.pos
;
8055 it
->object
= it
->w
->buffer
;
8056 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8057 IT_BYTEPOS (*it
), Qnil
);
8064 /***********************************************************************
8065 Moving an iterator without producing glyphs
8066 ***********************************************************************/
8068 /* Check if iterator is at a position corresponding to a valid buffer
8069 position after some move_it_ call. */
8071 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8072 ((it)->method == GET_FROM_STRING \
8073 ? IT_STRING_CHARPOS (*it) == 0 \
8077 /* Move iterator IT to a specified buffer or X position within one
8078 line on the display without producing glyphs.
8080 OP should be a bit mask including some or all of these bits:
8081 MOVE_TO_X: Stop upon reaching x-position TO_X.
8082 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8083 Regardless of OP's value, stop upon reaching the end of the display line.
8085 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8086 This means, in particular, that TO_X includes window's horizontal
8089 The return value has several possible values that
8090 say what condition caused the scan to stop:
8092 MOVE_POS_MATCH_OR_ZV
8093 - when TO_POS or ZV was reached.
8096 -when TO_X was reached before TO_POS or ZV were reached.
8099 - when we reached the end of the display area and the line must
8103 - when we reached the end of the display area and the line is
8107 - when we stopped at a line end, i.e. a newline or a CR and selective
8110 static enum move_it_result
8111 move_it_in_display_line_to (struct it
*it
,
8112 ptrdiff_t to_charpos
, int to_x
,
8113 enum move_operation_enum op
)
8115 enum move_it_result result
= MOVE_UNDEFINED
;
8116 struct glyph_row
*saved_glyph_row
;
8117 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8118 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8119 void *ppos_data
= NULL
;
8121 enum it_method prev_method
= it
->method
;
8122 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8123 int saw_smaller_pos
= prev_pos
< to_charpos
;
8125 /* Don't produce glyphs in produce_glyphs. */
8126 saved_glyph_row
= it
->glyph_row
;
8127 it
->glyph_row
= NULL
;
8129 /* Use wrap_it to save a copy of IT wherever a word wrap could
8130 occur. Use atpos_it to save a copy of IT at the desired buffer
8131 position, if found, so that we can scan ahead and check if the
8132 word later overshoots the window edge. Use atx_it similarly, for
8138 /* Use ppos_it under bidi reordering to save a copy of IT for the
8139 position > CHARPOS that is the closest to CHARPOS. We restore
8140 that position in IT when we have scanned the entire display line
8141 without finding a match for CHARPOS and all the character
8142 positions are greater than CHARPOS. */
8145 SAVE_IT (ppos_it
, *it
, ppos_data
);
8146 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8147 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8148 SAVE_IT (ppos_it
, *it
, ppos_data
);
8151 #define BUFFER_POS_REACHED_P() \
8152 ((op & MOVE_TO_POS) != 0 \
8153 && BUFFERP (it->object) \
8154 && (IT_CHARPOS (*it) == to_charpos \
8156 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8157 && IT_CHARPOS (*it) > to_charpos) \
8158 || (it->what == IT_COMPOSITION \
8159 && ((IT_CHARPOS (*it) > to_charpos \
8160 && to_charpos >= it->cmp_it.charpos) \
8161 || (IT_CHARPOS (*it) < to_charpos \
8162 && to_charpos <= it->cmp_it.charpos)))) \
8163 && (it->method == GET_FROM_BUFFER \
8164 || (it->method == GET_FROM_DISPLAY_VECTOR \
8165 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8167 /* If there's a line-/wrap-prefix, handle it. */
8168 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8169 && it
->current_y
< it
->last_visible_y
)
8170 handle_line_prefix (it
);
8172 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8173 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8177 int x
, i
, ascent
= 0, descent
= 0;
8179 /* Utility macro to reset an iterator with x, ascent, and descent. */
8180 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8181 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8182 (IT)->max_descent = descent)
8184 /* Stop if we move beyond TO_CHARPOS (after an image or a
8185 display string or stretch glyph). */
8186 if ((op
& MOVE_TO_POS
) != 0
8187 && BUFFERP (it
->object
)
8188 && it
->method
== GET_FROM_BUFFER
8190 /* When the iterator is at base embedding level, we
8191 are guaranteed that characters are delivered for
8192 display in strictly increasing order of their
8193 buffer positions. */
8194 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8195 && IT_CHARPOS (*it
) > to_charpos
)
8197 && (prev_method
== GET_FROM_IMAGE
8198 || prev_method
== GET_FROM_STRETCH
8199 || prev_method
== GET_FROM_STRING
)
8200 /* Passed TO_CHARPOS from left to right. */
8201 && ((prev_pos
< to_charpos
8202 && IT_CHARPOS (*it
) > to_charpos
)
8203 /* Passed TO_CHARPOS from right to left. */
8204 || (prev_pos
> to_charpos
8205 && IT_CHARPOS (*it
) < to_charpos
)))))
8207 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8209 result
= MOVE_POS_MATCH_OR_ZV
;
8212 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8213 /* If wrap_it is valid, the current position might be in a
8214 word that is wrapped. So, save the iterator in
8215 atpos_it and continue to see if wrapping happens. */
8216 SAVE_IT (atpos_it
, *it
, atpos_data
);
8219 /* Stop when ZV reached.
8220 We used to stop here when TO_CHARPOS reached as well, but that is
8221 too soon if this glyph does not fit on this line. So we handle it
8222 explicitly below. */
8223 if (!get_next_display_element (it
))
8225 result
= MOVE_POS_MATCH_OR_ZV
;
8229 if (it
->line_wrap
== TRUNCATE
)
8231 if (BUFFER_POS_REACHED_P ())
8233 result
= MOVE_POS_MATCH_OR_ZV
;
8239 if (it
->line_wrap
== WORD_WRAP
)
8241 if (IT_DISPLAYING_WHITESPACE (it
))
8245 /* We have reached a glyph that follows one or more
8246 whitespace characters. If the position is
8247 already found, we are done. */
8248 if (atpos_it
.sp
>= 0)
8250 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8251 result
= MOVE_POS_MATCH_OR_ZV
;
8256 RESTORE_IT (it
, &atx_it
, atx_data
);
8257 result
= MOVE_X_REACHED
;
8260 /* Otherwise, we can wrap here. */
8261 SAVE_IT (wrap_it
, *it
, wrap_data
);
8267 /* Remember the line height for the current line, in case
8268 the next element doesn't fit on the line. */
8269 ascent
= it
->max_ascent
;
8270 descent
= it
->max_descent
;
8272 /* The call to produce_glyphs will get the metrics of the
8273 display element IT is loaded with. Record the x-position
8274 before this display element, in case it doesn't fit on the
8278 PRODUCE_GLYPHS (it
);
8280 if (it
->area
!= TEXT_AREA
)
8282 prev_method
= it
->method
;
8283 if (it
->method
== GET_FROM_BUFFER
)
8284 prev_pos
= IT_CHARPOS (*it
);
8285 set_iterator_to_next (it
, 1);
8286 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8287 SET_TEXT_POS (this_line_min_pos
,
8288 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8290 && (op
& MOVE_TO_POS
)
8291 && IT_CHARPOS (*it
) > to_charpos
8292 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8293 SAVE_IT (ppos_it
, *it
, ppos_data
);
8297 /* The number of glyphs we get back in IT->nglyphs will normally
8298 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8299 character on a terminal frame, or (iii) a line end. For the
8300 second case, IT->nglyphs - 1 padding glyphs will be present.
8301 (On X frames, there is only one glyph produced for a
8302 composite character.)
8304 The behavior implemented below means, for continuation lines,
8305 that as many spaces of a TAB as fit on the current line are
8306 displayed there. For terminal frames, as many glyphs of a
8307 multi-glyph character are displayed in the current line, too.
8308 This is what the old redisplay code did, and we keep it that
8309 way. Under X, the whole shape of a complex character must
8310 fit on the line or it will be completely displayed in the
8313 Note that both for tabs and padding glyphs, all glyphs have
8317 /* More than one glyph or glyph doesn't fit on line. All
8318 glyphs have the same width. */
8319 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8321 int x_before_this_char
= x
;
8322 int hpos_before_this_char
= it
->hpos
;
8324 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8326 new_x
= x
+ single_glyph_width
;
8328 /* We want to leave anything reaching TO_X to the caller. */
8329 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8331 if (BUFFER_POS_REACHED_P ())
8333 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8334 goto buffer_pos_reached
;
8335 if (atpos_it
.sp
< 0)
8337 SAVE_IT (atpos_it
, *it
, atpos_data
);
8338 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8343 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8346 result
= MOVE_X_REACHED
;
8351 SAVE_IT (atx_it
, *it
, atx_data
);
8352 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8357 if (/* Lines are continued. */
8358 it
->line_wrap
!= TRUNCATE
8359 && (/* And glyph doesn't fit on the line. */
8360 new_x
> it
->last_visible_x
8361 /* Or it fits exactly and we're on a window
8363 || (new_x
== it
->last_visible_x
8364 && FRAME_WINDOW_P (it
->f
)
8365 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8366 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8367 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8369 if (/* IT->hpos == 0 means the very first glyph
8370 doesn't fit on the line, e.g. a wide image. */
8372 || (new_x
== it
->last_visible_x
8373 && FRAME_WINDOW_P (it
->f
)))
8376 it
->current_x
= new_x
;
8378 /* The character's last glyph just barely fits
8380 if (i
== it
->nglyphs
- 1)
8382 /* If this is the destination position,
8383 return a position *before* it in this row,
8384 now that we know it fits in this row. */
8385 if (BUFFER_POS_REACHED_P ())
8387 if (it
->line_wrap
!= WORD_WRAP
8390 it
->hpos
= hpos_before_this_char
;
8391 it
->current_x
= x_before_this_char
;
8392 result
= MOVE_POS_MATCH_OR_ZV
;
8395 if (it
->line_wrap
== WORD_WRAP
8398 SAVE_IT (atpos_it
, *it
, atpos_data
);
8399 atpos_it
.current_x
= x_before_this_char
;
8400 atpos_it
.hpos
= hpos_before_this_char
;
8404 prev_method
= it
->method
;
8405 if (it
->method
== GET_FROM_BUFFER
)
8406 prev_pos
= IT_CHARPOS (*it
);
8407 set_iterator_to_next (it
, 1);
8408 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8409 SET_TEXT_POS (this_line_min_pos
,
8410 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8411 /* On graphical terminals, newlines may
8412 "overflow" into the fringe if
8413 overflow-newline-into-fringe is non-nil.
8414 On text terminals, and on graphical
8415 terminals with no right margin, newlines
8416 may overflow into the last glyph on the
8418 if (!FRAME_WINDOW_P (it
->f
)
8420 && it
->bidi_it
.paragraph_dir
== R2L
)
8421 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8422 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8423 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8425 if (!get_next_display_element (it
))
8427 result
= MOVE_POS_MATCH_OR_ZV
;
8430 if (BUFFER_POS_REACHED_P ())
8432 if (ITERATOR_AT_END_OF_LINE_P (it
))
8433 result
= MOVE_POS_MATCH_OR_ZV
;
8435 result
= MOVE_LINE_CONTINUED
;
8438 if (ITERATOR_AT_END_OF_LINE_P (it
))
8440 result
= MOVE_NEWLINE_OR_CR
;
8447 IT_RESET_X_ASCENT_DESCENT (it
);
8449 if (wrap_it
.sp
>= 0)
8451 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8456 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8458 result
= MOVE_LINE_CONTINUED
;
8462 if (BUFFER_POS_REACHED_P ())
8464 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8465 goto buffer_pos_reached
;
8466 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8468 SAVE_IT (atpos_it
, *it
, atpos_data
);
8469 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8473 if (new_x
> it
->first_visible_x
)
8475 /* Glyph is visible. Increment number of glyphs that
8476 would be displayed. */
8481 if (result
!= MOVE_UNDEFINED
)
8484 else if (BUFFER_POS_REACHED_P ())
8487 IT_RESET_X_ASCENT_DESCENT (it
);
8488 result
= MOVE_POS_MATCH_OR_ZV
;
8491 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8493 /* Stop when TO_X specified and reached. This check is
8494 necessary here because of lines consisting of a line end,
8495 only. The line end will not produce any glyphs and we
8496 would never get MOVE_X_REACHED. */
8497 eassert (it
->nglyphs
== 0);
8498 result
= MOVE_X_REACHED
;
8502 /* Is this a line end? If yes, we're done. */
8503 if (ITERATOR_AT_END_OF_LINE_P (it
))
8505 /* If we are past TO_CHARPOS, but never saw any character
8506 positions smaller than TO_CHARPOS, return
8507 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8509 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8511 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8513 if (IT_CHARPOS (ppos_it
) < ZV
)
8515 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8516 result
= MOVE_POS_MATCH_OR_ZV
;
8519 goto buffer_pos_reached
;
8521 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8522 && IT_CHARPOS (*it
) > to_charpos
)
8523 goto buffer_pos_reached
;
8525 result
= MOVE_NEWLINE_OR_CR
;
8528 result
= MOVE_NEWLINE_OR_CR
;
8532 prev_method
= it
->method
;
8533 if (it
->method
== GET_FROM_BUFFER
)
8534 prev_pos
= IT_CHARPOS (*it
);
8535 /* The current display element has been consumed. Advance
8537 set_iterator_to_next (it
, 1);
8538 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8539 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8540 if (IT_CHARPOS (*it
) < to_charpos
)
8541 saw_smaller_pos
= 1;
8543 && (op
& MOVE_TO_POS
)
8544 && IT_CHARPOS (*it
) >= to_charpos
8545 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8546 SAVE_IT (ppos_it
, *it
, ppos_data
);
8548 /* Stop if lines are truncated and IT's current x-position is
8549 past the right edge of the window now. */
8550 if (it
->line_wrap
== TRUNCATE
8551 && it
->current_x
>= it
->last_visible_x
)
8553 if (!FRAME_WINDOW_P (it
->f
)
8554 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8555 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8556 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8557 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8561 if ((at_eob_p
= !get_next_display_element (it
))
8562 || BUFFER_POS_REACHED_P ()
8563 /* If we are past TO_CHARPOS, but never saw any
8564 character positions smaller than TO_CHARPOS,
8565 return MOVE_POS_MATCH_OR_ZV, like the
8566 unidirectional display did. */
8567 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8569 && IT_CHARPOS (*it
) > to_charpos
))
8572 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8573 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8574 result
= MOVE_POS_MATCH_OR_ZV
;
8577 if (ITERATOR_AT_END_OF_LINE_P (it
))
8579 result
= MOVE_NEWLINE_OR_CR
;
8583 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8585 && IT_CHARPOS (*it
) > to_charpos
)
8587 if (IT_CHARPOS (ppos_it
) < ZV
)
8588 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8589 result
= MOVE_POS_MATCH_OR_ZV
;
8592 result
= MOVE_LINE_TRUNCATED
;
8595 #undef IT_RESET_X_ASCENT_DESCENT
8598 #undef BUFFER_POS_REACHED_P
8600 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8601 restore the saved iterator. */
8602 if (atpos_it
.sp
>= 0)
8603 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8604 else if (atx_it
.sp
>= 0)
8605 RESTORE_IT (it
, &atx_it
, atx_data
);
8610 bidi_unshelve_cache (atpos_data
, 1);
8612 bidi_unshelve_cache (atx_data
, 1);
8614 bidi_unshelve_cache (wrap_data
, 1);
8616 bidi_unshelve_cache (ppos_data
, 1);
8618 /* Restore the iterator settings altered at the beginning of this
8620 it
->glyph_row
= saved_glyph_row
;
8624 /* For external use. */
8626 move_it_in_display_line (struct it
*it
,
8627 ptrdiff_t to_charpos
, int to_x
,
8628 enum move_operation_enum op
)
8630 if (it
->line_wrap
== WORD_WRAP
8631 && (op
& MOVE_TO_X
))
8634 void *save_data
= NULL
;
8637 SAVE_IT (save_it
, *it
, save_data
);
8638 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8639 /* When word-wrap is on, TO_X may lie past the end
8640 of a wrapped line. Then it->current is the
8641 character on the next line, so backtrack to the
8642 space before the wrap point. */
8643 if (skip
== MOVE_LINE_CONTINUED
)
8645 int prev_x
= max (it
->current_x
- 1, 0);
8646 RESTORE_IT (it
, &save_it
, save_data
);
8647 move_it_in_display_line_to
8648 (it
, -1, prev_x
, MOVE_TO_X
);
8651 bidi_unshelve_cache (save_data
, 1);
8654 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8658 /* Move IT forward until it satisfies one or more of the criteria in
8659 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8661 OP is a bit-mask that specifies where to stop, and in particular,
8662 which of those four position arguments makes a difference. See the
8663 description of enum move_operation_enum.
8665 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8666 screen line, this function will set IT to the next position that is
8667 displayed to the right of TO_CHARPOS on the screen. */
8670 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8672 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8673 int line_height
, line_start_x
= 0, reached
= 0;
8674 void *backup_data
= NULL
;
8678 if (op
& MOVE_TO_VPOS
)
8680 /* If no TO_CHARPOS and no TO_X specified, stop at the
8681 start of the line TO_VPOS. */
8682 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8684 if (it
->vpos
== to_vpos
)
8690 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8694 /* TO_VPOS >= 0 means stop at TO_X in the line at
8695 TO_VPOS, or at TO_POS, whichever comes first. */
8696 if (it
->vpos
== to_vpos
)
8702 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8704 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8709 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8711 /* We have reached TO_X but not in the line we want. */
8712 skip
= move_it_in_display_line_to (it
, to_charpos
,
8714 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8722 else if (op
& MOVE_TO_Y
)
8724 struct it it_backup
;
8726 if (it
->line_wrap
== WORD_WRAP
)
8727 SAVE_IT (it_backup
, *it
, backup_data
);
8729 /* TO_Y specified means stop at TO_X in the line containing
8730 TO_Y---or at TO_CHARPOS if this is reached first. The
8731 problem is that we can't really tell whether the line
8732 contains TO_Y before we have completely scanned it, and
8733 this may skip past TO_X. What we do is to first scan to
8736 If TO_X is not specified, use a TO_X of zero. The reason
8737 is to make the outcome of this function more predictable.
8738 If we didn't use TO_X == 0, we would stop at the end of
8739 the line which is probably not what a caller would expect
8741 skip
= move_it_in_display_line_to
8742 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8743 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8745 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8746 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8748 else if (skip
== MOVE_X_REACHED
)
8750 /* If TO_X was reached, we want to know whether TO_Y is
8751 in the line. We know this is the case if the already
8752 scanned glyphs make the line tall enough. Otherwise,
8753 we must check by scanning the rest of the line. */
8754 line_height
= it
->max_ascent
+ it
->max_descent
;
8755 if (to_y
>= it
->current_y
8756 && to_y
< it
->current_y
+ line_height
)
8761 SAVE_IT (it_backup
, *it
, backup_data
);
8762 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8763 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8765 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8766 line_height
= it
->max_ascent
+ it
->max_descent
;
8767 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8769 if (to_y
>= it
->current_y
8770 && to_y
< it
->current_y
+ line_height
)
8772 /* If TO_Y is in this line and TO_X was reached
8773 above, we scanned too far. We have to restore
8774 IT's settings to the ones before skipping. But
8775 keep the more accurate values of max_ascent and
8776 max_descent we've found while skipping the rest
8777 of the line, for the sake of callers, such as
8778 pos_visible_p, that need to know the line
8780 int max_ascent
= it
->max_ascent
;
8781 int max_descent
= it
->max_descent
;
8783 RESTORE_IT (it
, &it_backup
, backup_data
);
8784 it
->max_ascent
= max_ascent
;
8785 it
->max_descent
= max_descent
;
8791 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8797 /* Check whether TO_Y is in this line. */
8798 line_height
= it
->max_ascent
+ it
->max_descent
;
8799 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8801 if (to_y
>= it
->current_y
8802 && to_y
< it
->current_y
+ line_height
)
8804 /* When word-wrap is on, TO_X may lie past the end
8805 of a wrapped line. Then it->current is the
8806 character on the next line, so backtrack to the
8807 space before the wrap point. */
8808 if (skip
== MOVE_LINE_CONTINUED
8809 && it
->line_wrap
== WORD_WRAP
)
8811 int prev_x
= max (it
->current_x
- 1, 0);
8812 RESTORE_IT (it
, &it_backup
, backup_data
);
8813 skip
= move_it_in_display_line_to
8814 (it
, -1, prev_x
, MOVE_TO_X
);
8823 else if (BUFFERP (it
->object
)
8824 && (it
->method
== GET_FROM_BUFFER
8825 || it
->method
== GET_FROM_STRETCH
)
8826 && IT_CHARPOS (*it
) >= to_charpos
8827 /* Under bidi iteration, a call to set_iterator_to_next
8828 can scan far beyond to_charpos if the initial
8829 portion of the next line needs to be reordered. In
8830 that case, give move_it_in_display_line_to another
8833 && it
->bidi_it
.scan_dir
== -1))
8834 skip
= MOVE_POS_MATCH_OR_ZV
;
8836 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8840 case MOVE_POS_MATCH_OR_ZV
:
8844 case MOVE_NEWLINE_OR_CR
:
8845 set_iterator_to_next (it
, 1);
8846 it
->continuation_lines_width
= 0;
8849 case MOVE_LINE_TRUNCATED
:
8850 it
->continuation_lines_width
= 0;
8851 reseat_at_next_visible_line_start (it
, 0);
8852 if ((op
& MOVE_TO_POS
) != 0
8853 && IT_CHARPOS (*it
) > to_charpos
)
8860 case MOVE_LINE_CONTINUED
:
8861 /* For continued lines ending in a tab, some of the glyphs
8862 associated with the tab are displayed on the current
8863 line. Since it->current_x does not include these glyphs,
8864 we use it->last_visible_x instead. */
8867 it
->continuation_lines_width
+= it
->last_visible_x
;
8868 /* When moving by vpos, ensure that the iterator really
8869 advances to the next line (bug#847, bug#969). Fixme:
8870 do we need to do this in other circumstances? */
8871 if (it
->current_x
!= it
->last_visible_x
8872 && (op
& MOVE_TO_VPOS
)
8873 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8875 line_start_x
= it
->current_x
+ it
->pixel_width
8876 - it
->last_visible_x
;
8877 set_iterator_to_next (it
, 0);
8881 it
->continuation_lines_width
+= it
->current_x
;
8888 /* Reset/increment for the next run. */
8889 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8890 it
->current_x
= line_start_x
;
8893 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8895 last_height
= it
->max_ascent
+ it
->max_descent
;
8896 last_max_ascent
= it
->max_ascent
;
8897 it
->max_ascent
= it
->max_descent
= 0;
8902 /* On text terminals, we may stop at the end of a line in the middle
8903 of a multi-character glyph. If the glyph itself is continued,
8904 i.e. it is actually displayed on the next line, don't treat this
8905 stopping point as valid; move to the next line instead (unless
8906 that brings us offscreen). */
8907 if (!FRAME_WINDOW_P (it
->f
)
8909 && IT_CHARPOS (*it
) == to_charpos
8910 && it
->what
== IT_CHARACTER
8912 && it
->line_wrap
== WINDOW_WRAP
8913 && it
->current_x
== it
->last_visible_x
- 1
8916 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8918 it
->continuation_lines_width
+= it
->current_x
;
8919 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8920 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8922 last_height
= it
->max_ascent
+ it
->max_descent
;
8923 last_max_ascent
= it
->max_ascent
;
8927 bidi_unshelve_cache (backup_data
, 1);
8929 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8933 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8935 If DY > 0, move IT backward at least that many pixels. DY = 0
8936 means move IT backward to the preceding line start or BEGV. This
8937 function may move over more than DY pixels if IT->current_y - DY
8938 ends up in the middle of a line; in this case IT->current_y will be
8939 set to the top of the line moved to. */
8942 move_it_vertically_backward (struct it
*it
, int dy
)
8946 void *it2data
= NULL
, *it3data
= NULL
;
8947 ptrdiff_t start_pos
;
8952 start_pos
= IT_CHARPOS (*it
);
8954 /* Estimate how many newlines we must move back. */
8955 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8957 /* Set the iterator's position that many lines back. */
8958 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8959 back_to_previous_visible_line_start (it
);
8961 /* Reseat the iterator here. When moving backward, we don't want
8962 reseat to skip forward over invisible text, set up the iterator
8963 to deliver from overlay strings at the new position etc. So,
8964 use reseat_1 here. */
8965 reseat_1 (it
, it
->current
.pos
, 1);
8967 /* We are now surely at a line start. */
8968 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8969 reordering is in effect. */
8970 it
->continuation_lines_width
= 0;
8972 /* Move forward and see what y-distance we moved. First move to the
8973 start of the next line so that we get its height. We need this
8974 height to be able to tell whether we reached the specified
8976 SAVE_IT (it2
, *it
, it2data
);
8977 it2
.max_ascent
= it2
.max_descent
= 0;
8980 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8981 MOVE_TO_POS
| MOVE_TO_VPOS
);
8983 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8984 /* If we are in a display string which starts at START_POS,
8985 and that display string includes a newline, and we are
8986 right after that newline (i.e. at the beginning of a
8987 display line), exit the loop, because otherwise we will
8988 infloop, since move_it_to will see that it is already at
8989 START_POS and will not move. */
8990 || (it2
.method
== GET_FROM_STRING
8991 && IT_CHARPOS (it2
) == start_pos
8992 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8993 eassert (IT_CHARPOS (*it
) >= BEGV
);
8994 SAVE_IT (it3
, it2
, it3data
);
8996 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8997 eassert (IT_CHARPOS (*it
) >= BEGV
);
8998 /* H is the actual vertical distance from the position in *IT
8999 and the starting position. */
9000 h
= it2
.current_y
- it
->current_y
;
9001 /* NLINES is the distance in number of lines. */
9002 nlines
= it2
.vpos
- it
->vpos
;
9004 /* Correct IT's y and vpos position
9005 so that they are relative to the starting point. */
9011 /* DY == 0 means move to the start of the screen line. The
9012 value of nlines is > 0 if continuation lines were involved,
9013 or if the original IT position was at start of a line. */
9014 RESTORE_IT (it
, it
, it2data
);
9016 move_it_by_lines (it
, nlines
);
9017 /* The above code moves us to some position NLINES down,
9018 usually to its first glyph (leftmost in an L2R line), but
9019 that's not necessarily the start of the line, under bidi
9020 reordering. We want to get to the character position
9021 that is immediately after the newline of the previous
9024 && !it
->continuation_lines_width
9025 && !STRINGP (it
->string
)
9026 && IT_CHARPOS (*it
) > BEGV
9027 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9030 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9032 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9034 bidi_unshelve_cache (it3data
, 1);
9038 /* The y-position we try to reach, relative to *IT.
9039 Note that H has been subtracted in front of the if-statement. */
9040 int target_y
= it
->current_y
+ h
- dy
;
9041 int y0
= it3
.current_y
;
9045 RESTORE_IT (&it3
, &it3
, it3data
);
9046 y1
= line_bottom_y (&it3
);
9047 line_height
= y1
- y0
;
9048 RESTORE_IT (it
, it
, it2data
);
9049 /* If we did not reach target_y, try to move further backward if
9050 we can. If we moved too far backward, try to move forward. */
9051 if (target_y
< it
->current_y
9052 /* This is heuristic. In a window that's 3 lines high, with
9053 a line height of 13 pixels each, recentering with point
9054 on the bottom line will try to move -39/2 = 19 pixels
9055 backward. Try to avoid moving into the first line. */
9056 && (it
->current_y
- target_y
9057 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9058 && IT_CHARPOS (*it
) > BEGV
)
9060 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9061 target_y
- it
->current_y
));
9062 dy
= it
->current_y
- target_y
;
9063 goto move_further_back
;
9065 else if (target_y
>= it
->current_y
+ line_height
9066 && IT_CHARPOS (*it
) < ZV
)
9068 /* Should move forward by at least one line, maybe more.
9070 Note: Calling move_it_by_lines can be expensive on
9071 terminal frames, where compute_motion is used (via
9072 vmotion) to do the job, when there are very long lines
9073 and truncate-lines is nil. That's the reason for
9074 treating terminal frames specially here. */
9076 if (!FRAME_WINDOW_P (it
->f
))
9077 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9082 move_it_by_lines (it
, 1);
9084 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9091 /* Move IT by a specified amount of pixel lines DY. DY negative means
9092 move backwards. DY = 0 means move to start of screen line. At the
9093 end, IT will be on the start of a screen line. */
9096 move_it_vertically (struct it
*it
, int dy
)
9099 move_it_vertically_backward (it
, -dy
);
9102 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9103 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9104 MOVE_TO_POS
| MOVE_TO_Y
);
9105 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9107 /* If buffer ends in ZV without a newline, move to the start of
9108 the line to satisfy the post-condition. */
9109 if (IT_CHARPOS (*it
) == ZV
9111 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9112 move_it_by_lines (it
, 0);
9117 /* Move iterator IT past the end of the text line it is in. */
9120 move_it_past_eol (struct it
*it
)
9122 enum move_it_result rc
;
9124 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9125 if (rc
== MOVE_NEWLINE_OR_CR
)
9126 set_iterator_to_next (it
, 0);
9130 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9131 negative means move up. DVPOS == 0 means move to the start of the
9134 Optimization idea: If we would know that IT->f doesn't use
9135 a face with proportional font, we could be faster for
9136 truncate-lines nil. */
9139 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9142 /* The commented-out optimization uses vmotion on terminals. This
9143 gives bad results, because elements like it->what, on which
9144 callers such as pos_visible_p rely, aren't updated. */
9145 /* struct position pos;
9146 if (!FRAME_WINDOW_P (it->f))
9148 struct text_pos textpos;
9150 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9151 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9152 reseat (it, textpos, 1);
9153 it->vpos += pos.vpos;
9154 it->current_y += pos.vpos;
9160 /* DVPOS == 0 means move to the start of the screen line. */
9161 move_it_vertically_backward (it
, 0);
9162 /* Let next call to line_bottom_y calculate real line height */
9167 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9168 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9170 /* Only move to the next buffer position if we ended up in a
9171 string from display property, not in an overlay string
9172 (before-string or after-string). That is because the
9173 latter don't conceal the underlying buffer position, so
9174 we can ask to move the iterator to the exact position we
9175 are interested in. Note that, even if we are already at
9176 IT_CHARPOS (*it), the call below is not a no-op, as it
9177 will detect that we are at the end of the string, pop the
9178 iterator, and compute it->current_x and it->hpos
9180 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9181 -1, -1, -1, MOVE_TO_POS
);
9187 void *it2data
= NULL
;
9188 ptrdiff_t start_charpos
, i
;
9190 /* Start at the beginning of the screen line containing IT's
9191 position. This may actually move vertically backwards,
9192 in case of overlays, so adjust dvpos accordingly. */
9194 move_it_vertically_backward (it
, 0);
9197 /* Go back -DVPOS visible lines and reseat the iterator there. */
9198 start_charpos
= IT_CHARPOS (*it
);
9199 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9200 back_to_previous_visible_line_start (it
);
9201 reseat (it
, it
->current
.pos
, 1);
9203 /* Move further back if we end up in a string or an image. */
9204 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9206 /* First try to move to start of display line. */
9208 move_it_vertically_backward (it
, 0);
9210 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9212 /* If start of line is still in string or image,
9213 move further back. */
9214 back_to_previous_visible_line_start (it
);
9215 reseat (it
, it
->current
.pos
, 1);
9219 it
->current_x
= it
->hpos
= 0;
9221 /* Above call may have moved too far if continuation lines
9222 are involved. Scan forward and see if it did. */
9223 SAVE_IT (it2
, *it
, it2data
);
9224 it2
.vpos
= it2
.current_y
= 0;
9225 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9226 it
->vpos
-= it2
.vpos
;
9227 it
->current_y
-= it2
.current_y
;
9228 it
->current_x
= it
->hpos
= 0;
9230 /* If we moved too far back, move IT some lines forward. */
9231 if (it2
.vpos
> -dvpos
)
9233 int delta
= it2
.vpos
+ dvpos
;
9235 RESTORE_IT (&it2
, &it2
, it2data
);
9236 SAVE_IT (it2
, *it
, it2data
);
9237 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9238 /* Move back again if we got too far ahead. */
9239 if (IT_CHARPOS (*it
) >= start_charpos
)
9240 RESTORE_IT (it
, &it2
, it2data
);
9242 bidi_unshelve_cache (it2data
, 1);
9245 RESTORE_IT (it
, it
, it2data
);
9249 /* Return 1 if IT points into the middle of a display vector. */
9252 in_display_vector_p (struct it
*it
)
9254 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9255 && it
->current
.dpvec_index
> 0
9256 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9260 /***********************************************************************
9262 ***********************************************************************/
9265 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9269 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9271 Lisp_Object args
[3];
9272 Lisp_Object msg
, fmt
;
9275 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9278 /* Do nothing if called asynchronously. Inserting text into
9279 a buffer may call after-change-functions and alike and
9280 that would means running Lisp asynchronously. */
9281 if (handling_signal
)
9285 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9287 args
[0] = fmt
= build_string (format
);
9290 msg
= Fformat (3, args
);
9292 len
= SBYTES (msg
) + 1;
9293 buffer
= SAFE_ALLOCA (len
);
9294 memcpy (buffer
, SDATA (msg
), len
);
9296 message_dolog (buffer
, len
- 1, 1, 0);
9303 /* Output a newline in the *Messages* buffer if "needs" one. */
9306 message_log_maybe_newline (void)
9308 if (message_log_need_newline
)
9309 message_dolog ("", 0, 1, 0);
9313 /* Add a string M of length NBYTES to the message log, optionally
9314 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9315 nonzero, means interpret the contents of M as multibyte. This
9316 function calls low-level routines in order to bypass text property
9317 hooks, etc. which might not be safe to run.
9319 This may GC (insert may run before/after change hooks),
9320 so the buffer M must NOT point to a Lisp string. */
9323 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9325 const unsigned char *msg
= (const unsigned char *) m
;
9327 if (!NILP (Vmemory_full
))
9330 if (!NILP (Vmessage_log_max
))
9332 struct buffer
*oldbuf
;
9333 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9334 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9335 ptrdiff_t point_at_end
= 0;
9336 ptrdiff_t zv_at_end
= 0;
9337 Lisp_Object old_deactivate_mark
, tem
;
9338 struct gcpro gcpro1
;
9340 old_deactivate_mark
= Vdeactivate_mark
;
9341 oldbuf
= current_buffer
;
9342 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9343 bset_undo_list (current_buffer
, Qt
);
9345 oldpoint
= message_dolog_marker1
;
9346 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9347 oldbegv
= message_dolog_marker2
;
9348 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9349 oldzv
= message_dolog_marker3
;
9350 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9351 GCPRO1 (old_deactivate_mark
);
9359 BEGV_BYTE
= BEG_BYTE
;
9362 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9364 /* Insert the string--maybe converting multibyte to single byte
9365 or vice versa, so that all the text fits the buffer. */
9367 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9373 /* Convert a multibyte string to single-byte
9374 for the *Message* buffer. */
9375 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9377 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9378 work
[0] = (ASCII_CHAR_P (c
)
9380 : multibyte_char_to_unibyte (c
));
9381 insert_1_both (work
, 1, 1, 1, 0, 0);
9384 else if (! multibyte
9385 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9389 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9390 /* Convert a single-byte string to multibyte
9391 for the *Message* buffer. */
9392 for (i
= 0; i
< nbytes
; i
++)
9395 MAKE_CHAR_MULTIBYTE (c
);
9396 char_bytes
= CHAR_STRING (c
, str
);
9397 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9401 insert_1 (m
, nbytes
, 1, 0, 0);
9405 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9407 insert_1 ("\n", 1, 1, 0, 0);
9409 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9411 this_bol_byte
= PT_BYTE
;
9413 /* See if this line duplicates the previous one.
9414 If so, combine duplicates. */
9417 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9419 prev_bol_byte
= PT_BYTE
;
9421 dups
= message_log_check_duplicate (prev_bol_byte
,
9425 del_range_both (prev_bol
, prev_bol_byte
,
9426 this_bol
, this_bol_byte
, 0);
9429 char dupstr
[sizeof " [ times]"
9430 + INT_STRLEN_BOUND (printmax_t
)];
9432 /* If you change this format, don't forget to also
9433 change message_log_check_duplicate. */
9434 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9435 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9436 insert_1 (dupstr
, duplen
, 1, 0, 1);
9441 /* If we have more than the desired maximum number of lines
9442 in the *Messages* buffer now, delete the oldest ones.
9443 This is safe because we don't have undo in this buffer. */
9445 if (NATNUMP (Vmessage_log_max
))
9447 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9448 -XFASTINT (Vmessage_log_max
) - 1, 0);
9449 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9452 BEGV
= XMARKER (oldbegv
)->charpos
;
9453 BEGV_BYTE
= marker_byte_position (oldbegv
);
9462 ZV
= XMARKER (oldzv
)->charpos
;
9463 ZV_BYTE
= marker_byte_position (oldzv
);
9467 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9469 /* We can't do Fgoto_char (oldpoint) because it will run some
9471 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9472 XMARKER (oldpoint
)->bytepos
);
9475 unchain_marker (XMARKER (oldpoint
));
9476 unchain_marker (XMARKER (oldbegv
));
9477 unchain_marker (XMARKER (oldzv
));
9479 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9480 set_buffer_internal (oldbuf
);
9482 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9483 message_log_need_newline
= !nlflag
;
9484 Vdeactivate_mark
= old_deactivate_mark
;
9489 /* We are at the end of the buffer after just having inserted a newline.
9490 (Note: We depend on the fact we won't be crossing the gap.)
9491 Check to see if the most recent message looks a lot like the previous one.
9492 Return 0 if different, 1 if the new one should just replace it, or a
9493 value N > 1 if we should also append " [N times]". */
9496 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9499 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9501 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9502 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9504 for (i
= 0; i
< len
; i
++)
9506 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9514 if (*p1
++ == ' ' && *p1
++ == '[')
9517 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9518 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9525 /* Display an echo area message M with a specified length of NBYTES
9526 bytes. The string may include null characters. If M is 0, clear
9527 out any existing message, and let the mini-buffer text show
9530 This may GC, so the buffer M must NOT point to a Lisp string. */
9533 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9535 /* First flush out any partial line written with print. */
9536 message_log_maybe_newline ();
9538 message_dolog (m
, nbytes
, 1, multibyte
);
9539 message2_nolog (m
, nbytes
, multibyte
);
9543 /* The non-logging counterpart of message2. */
9546 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9548 struct frame
*sf
= SELECTED_FRAME ();
9549 message_enable_multibyte
= multibyte
;
9551 if (FRAME_INITIAL_P (sf
))
9553 if (noninteractive_need_newline
)
9554 putc ('\n', stderr
);
9555 noninteractive_need_newline
= 0;
9557 fwrite (m
, nbytes
, 1, stderr
);
9558 if (cursor_in_echo_area
== 0)
9559 fprintf (stderr
, "\n");
9562 /* A null message buffer means that the frame hasn't really been
9563 initialized yet. Error messages get reported properly by
9564 cmd_error, so this must be just an informative message; toss it. */
9565 else if (INTERACTIVE
9566 && sf
->glyphs_initialized_p
9567 && FRAME_MESSAGE_BUF (sf
))
9569 Lisp_Object mini_window
;
9572 /* Get the frame containing the mini-buffer
9573 that the selected frame is using. */
9574 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9575 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9577 FRAME_SAMPLE_VISIBILITY (f
);
9578 if (FRAME_VISIBLE_P (sf
)
9579 && ! FRAME_VISIBLE_P (f
))
9580 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9584 set_message (m
, Qnil
, nbytes
, multibyte
);
9585 if (minibuffer_auto_raise
)
9586 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9589 clear_message (1, 1);
9591 do_pending_window_change (0);
9592 echo_area_display (1);
9593 do_pending_window_change (0);
9594 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9595 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9600 /* Display an echo area message M with a specified length of NBYTES
9601 bytes. The string may include null characters. If M is not a
9602 string, clear out any existing message, and let the mini-buffer
9605 This function cancels echoing. */
9608 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9610 struct gcpro gcpro1
;
9613 clear_message (1,1);
9616 /* First flush out any partial line written with print. */
9617 message_log_maybe_newline ();
9621 char *buffer
= SAFE_ALLOCA (nbytes
);
9622 memcpy (buffer
, SDATA (m
), nbytes
);
9623 message_dolog (buffer
, nbytes
, 1, multibyte
);
9626 message3_nolog (m
, nbytes
, multibyte
);
9632 /* The non-logging version of message3.
9633 This does not cancel echoing, because it is used for echoing.
9634 Perhaps we need to make a separate function for echoing
9635 and make this cancel echoing. */
9638 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9640 struct frame
*sf
= SELECTED_FRAME ();
9641 message_enable_multibyte
= multibyte
;
9643 if (FRAME_INITIAL_P (sf
))
9645 if (noninteractive_need_newline
)
9646 putc ('\n', stderr
);
9647 noninteractive_need_newline
= 0;
9649 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9650 if (cursor_in_echo_area
== 0)
9651 fprintf (stderr
, "\n");
9654 /* A null message buffer means that the frame hasn't really been
9655 initialized yet. Error messages get reported properly by
9656 cmd_error, so this must be just an informative message; toss it. */
9657 else if (INTERACTIVE
9658 && sf
->glyphs_initialized_p
9659 && FRAME_MESSAGE_BUF (sf
))
9661 Lisp_Object mini_window
;
9665 /* Get the frame containing the mini-buffer
9666 that the selected frame is using. */
9667 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9668 frame
= XWINDOW (mini_window
)->frame
;
9671 FRAME_SAMPLE_VISIBILITY (f
);
9672 if (FRAME_VISIBLE_P (sf
)
9673 && !FRAME_VISIBLE_P (f
))
9674 Fmake_frame_visible (frame
);
9676 if (STRINGP (m
) && SCHARS (m
) > 0)
9678 set_message (NULL
, m
, nbytes
, multibyte
);
9679 if (minibuffer_auto_raise
)
9680 Fraise_frame (frame
);
9681 /* Assume we are not echoing.
9682 (If we are, echo_now will override this.) */
9683 echo_message_buffer
= Qnil
;
9686 clear_message (1, 1);
9688 do_pending_window_change (0);
9689 echo_area_display (1);
9690 do_pending_window_change (0);
9691 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9692 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9697 /* Display a null-terminated echo area message M. If M is 0, clear
9698 out any existing message, and let the mini-buffer text show through.
9700 The buffer M must continue to exist until after the echo area gets
9701 cleared or some other message gets displayed there. Do not pass
9702 text that is stored in a Lisp string. Do not pass text in a buffer
9703 that was alloca'd. */
9706 message1 (const char *m
)
9708 message2 (m
, (m
? strlen (m
) : 0), 0);
9712 /* The non-logging counterpart of message1. */
9715 message1_nolog (const char *m
)
9717 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9720 /* Display a message M which contains a single %s
9721 which gets replaced with STRING. */
9724 message_with_string (const char *m
, Lisp_Object string
, int log
)
9726 CHECK_STRING (string
);
9732 if (noninteractive_need_newline
)
9733 putc ('\n', stderr
);
9734 noninteractive_need_newline
= 0;
9735 fprintf (stderr
, m
, SDATA (string
));
9736 if (!cursor_in_echo_area
)
9737 fprintf (stderr
, "\n");
9741 else if (INTERACTIVE
)
9743 /* The frame whose minibuffer we're going to display the message on.
9744 It may be larger than the selected frame, so we need
9745 to use its buffer, not the selected frame's buffer. */
9746 Lisp_Object mini_window
;
9747 struct frame
*f
, *sf
= SELECTED_FRAME ();
9749 /* Get the frame containing the minibuffer
9750 that the selected frame is using. */
9751 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9752 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9754 /* A null message buffer means that the frame hasn't really been
9755 initialized yet. Error messages get reported properly by
9756 cmd_error, so this must be just an informative message; toss it. */
9757 if (FRAME_MESSAGE_BUF (f
))
9759 Lisp_Object args
[2], msg
;
9760 struct gcpro gcpro1
, gcpro2
;
9762 args
[0] = build_string (m
);
9763 args
[1] = msg
= string
;
9764 GCPRO2 (args
[0], msg
);
9767 msg
= Fformat (2, args
);
9770 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9772 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9776 /* Print should start at the beginning of the message
9777 buffer next time. */
9778 message_buf_print
= 0;
9784 /* Dump an informative message to the minibuf. If M is 0, clear out
9785 any existing message, and let the mini-buffer text show through. */
9788 vmessage (const char *m
, va_list ap
)
9794 if (noninteractive_need_newline
)
9795 putc ('\n', stderr
);
9796 noninteractive_need_newline
= 0;
9797 vfprintf (stderr
, m
, ap
);
9798 if (cursor_in_echo_area
== 0)
9799 fprintf (stderr
, "\n");
9803 else if (INTERACTIVE
)
9805 /* The frame whose mini-buffer we're going to display the message
9806 on. It may be larger than the selected frame, so we need to
9807 use its buffer, not the selected frame's buffer. */
9808 Lisp_Object mini_window
;
9809 struct frame
*f
, *sf
= SELECTED_FRAME ();
9811 /* Get the frame containing the mini-buffer
9812 that the selected frame is using. */
9813 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9814 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9816 /* A null message buffer means that the frame hasn't really been
9817 initialized yet. Error messages get reported properly by
9818 cmd_error, so this must be just an informative message; toss
9820 if (FRAME_MESSAGE_BUF (f
))
9826 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9827 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9829 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9834 /* Print should start at the beginning of the message
9835 buffer next time. */
9836 message_buf_print
= 0;
9842 message (const char *m
, ...)
9852 /* The non-logging version of message. */
9855 message_nolog (const char *m
, ...)
9857 Lisp_Object old_log_max
;
9860 old_log_max
= Vmessage_log_max
;
9861 Vmessage_log_max
= Qnil
;
9863 Vmessage_log_max
= old_log_max
;
9869 /* Display the current message in the current mini-buffer. This is
9870 only called from error handlers in process.c, and is not time
9874 update_echo_area (void)
9876 if (!NILP (echo_area_buffer
[0]))
9879 string
= Fcurrent_message ();
9880 message3 (string
, SBYTES (string
),
9881 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9886 /* Make sure echo area buffers in `echo_buffers' are live.
9887 If they aren't, make new ones. */
9890 ensure_echo_area_buffers (void)
9894 for (i
= 0; i
< 2; ++i
)
9895 if (!BUFFERP (echo_buffer
[i
])
9896 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9899 Lisp_Object old_buffer
;
9902 old_buffer
= echo_buffer
[i
];
9903 echo_buffer
[i
] = Fget_buffer_create
9904 (make_formatted_string (name
, " *Echo Area %d*", i
));
9905 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9906 /* to force word wrap in echo area -
9907 it was decided to postpone this*/
9908 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9910 for (j
= 0; j
< 2; ++j
)
9911 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9912 echo_area_buffer
[j
] = echo_buffer
[i
];
9917 /* Call FN with args A1..A4 with either the current or last displayed
9918 echo_area_buffer as current buffer.
9920 WHICH zero means use the current message buffer
9921 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9922 from echo_buffer[] and clear it.
9924 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9925 suitable buffer from echo_buffer[] and clear it.
9927 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9928 that the current message becomes the last displayed one, make
9929 choose a suitable buffer for echo_area_buffer[0], and clear it.
9931 Value is what FN returns. */
9934 with_echo_area_buffer (struct window
*w
, int which
,
9935 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9936 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9939 int this_one
, the_other
, clear_buffer_p
, rc
;
9940 ptrdiff_t count
= SPECPDL_INDEX ();
9942 /* If buffers aren't live, make new ones. */
9943 ensure_echo_area_buffers ();
9948 this_one
= 0, the_other
= 1;
9950 this_one
= 1, the_other
= 0;
9953 this_one
= 0, the_other
= 1;
9956 /* We need a fresh one in case the current echo buffer equals
9957 the one containing the last displayed echo area message. */
9958 if (!NILP (echo_area_buffer
[this_one
])
9959 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9960 echo_area_buffer
[this_one
] = Qnil
;
9963 /* Choose a suitable buffer from echo_buffer[] is we don't
9965 if (NILP (echo_area_buffer
[this_one
]))
9967 echo_area_buffer
[this_one
]
9968 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9969 ? echo_buffer
[the_other
]
9970 : echo_buffer
[this_one
]);
9974 buffer
= echo_area_buffer
[this_one
];
9976 /* Don't get confused by reusing the buffer used for echoing
9977 for a different purpose. */
9978 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9981 record_unwind_protect (unwind_with_echo_area_buffer
,
9982 with_echo_area_buffer_unwind_data (w
));
9984 /* Make the echo area buffer current. Note that for display
9985 purposes, it is not necessary that the displayed window's buffer
9986 == current_buffer, except for text property lookup. So, let's
9987 only set that buffer temporarily here without doing a full
9988 Fset_window_buffer. We must also change w->pointm, though,
9989 because otherwise an assertions in unshow_buffer fails, and Emacs
9991 set_buffer_internal_1 (XBUFFER (buffer
));
9994 wset_buffer (w
, buffer
);
9995 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9998 bset_undo_list (current_buffer
, Qt
);
9999 bset_read_only (current_buffer
, Qnil
);
10000 specbind (Qinhibit_read_only
, Qt
);
10001 specbind (Qinhibit_modification_hooks
, Qt
);
10003 if (clear_buffer_p
&& Z
> BEG
)
10004 del_range (BEG
, Z
);
10006 eassert (BEGV
>= BEG
);
10007 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10009 rc
= fn (a1
, a2
, a3
, a4
);
10011 eassert (BEGV
>= BEG
);
10012 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10014 unbind_to (count
, Qnil
);
10019 /* Save state that should be preserved around the call to the function
10020 FN called in with_echo_area_buffer. */
10023 with_echo_area_buffer_unwind_data (struct window
*w
)
10026 Lisp_Object vector
, tmp
;
10028 /* Reduce consing by keeping one vector in
10029 Vwith_echo_area_save_vector. */
10030 vector
= Vwith_echo_area_save_vector
;
10031 Vwith_echo_area_save_vector
= Qnil
;
10034 vector
= Fmake_vector (make_number (7), Qnil
);
10036 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10037 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10038 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10042 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10043 ASET (vector
, i
, w
->buffer
); ++i
;
10044 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10045 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10050 for (; i
< end
; ++i
)
10051 ASET (vector
, i
, Qnil
);
10054 eassert (i
== ASIZE (vector
));
10059 /* Restore global state from VECTOR which was created by
10060 with_echo_area_buffer_unwind_data. */
10063 unwind_with_echo_area_buffer (Lisp_Object vector
)
10065 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10066 Vdeactivate_mark
= AREF (vector
, 1);
10067 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10069 if (WINDOWP (AREF (vector
, 3)))
10072 Lisp_Object buffer
, charpos
, bytepos
;
10074 w
= XWINDOW (AREF (vector
, 3));
10075 buffer
= AREF (vector
, 4);
10076 charpos
= AREF (vector
, 5);
10077 bytepos
= AREF (vector
, 6);
10079 wset_buffer (w
, buffer
);
10080 set_marker_both (w
->pointm
, buffer
,
10081 XFASTINT (charpos
), XFASTINT (bytepos
));
10084 Vwith_echo_area_save_vector
= vector
;
10089 /* Set up the echo area for use by print functions. MULTIBYTE_P
10090 non-zero means we will print multibyte. */
10093 setup_echo_area_for_printing (int multibyte_p
)
10095 /* If we can't find an echo area any more, exit. */
10096 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10097 Fkill_emacs (Qnil
);
10099 ensure_echo_area_buffers ();
10101 if (!message_buf_print
)
10103 /* A message has been output since the last time we printed.
10104 Choose a fresh echo area buffer. */
10105 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10106 echo_area_buffer
[0] = echo_buffer
[1];
10108 echo_area_buffer
[0] = echo_buffer
[0];
10110 /* Switch to that buffer and clear it. */
10111 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10112 bset_truncate_lines (current_buffer
, Qnil
);
10116 ptrdiff_t count
= SPECPDL_INDEX ();
10117 specbind (Qinhibit_read_only
, Qt
);
10118 /* Note that undo recording is always disabled. */
10119 del_range (BEG
, Z
);
10120 unbind_to (count
, Qnil
);
10122 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10124 /* Set up the buffer for the multibyteness we need. */
10126 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10127 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10129 /* Raise the frame containing the echo area. */
10130 if (minibuffer_auto_raise
)
10132 struct frame
*sf
= SELECTED_FRAME ();
10133 Lisp_Object mini_window
;
10134 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10135 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10138 message_log_maybe_newline ();
10139 message_buf_print
= 1;
10143 if (NILP (echo_area_buffer
[0]))
10145 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10146 echo_area_buffer
[0] = echo_buffer
[1];
10148 echo_area_buffer
[0] = echo_buffer
[0];
10151 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10153 /* Someone switched buffers between print requests. */
10154 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10155 bset_truncate_lines (current_buffer
, Qnil
);
10161 /* Display an echo area message in window W. Value is non-zero if W's
10162 height is changed. If display_last_displayed_message_p is
10163 non-zero, display the message that was last displayed, otherwise
10164 display the current message. */
10167 display_echo_area (struct window
*w
)
10169 int i
, no_message_p
, window_height_changed_p
;
10171 /* Temporarily disable garbage collections while displaying the echo
10172 area. This is done because a GC can print a message itself.
10173 That message would modify the echo area buffer's contents while a
10174 redisplay of the buffer is going on, and seriously confuse
10176 ptrdiff_t count
= inhibit_garbage_collection ();
10178 /* If there is no message, we must call display_echo_area_1
10179 nevertheless because it resizes the window. But we will have to
10180 reset the echo_area_buffer in question to nil at the end because
10181 with_echo_area_buffer will sets it to an empty buffer. */
10182 i
= display_last_displayed_message_p
? 1 : 0;
10183 no_message_p
= NILP (echo_area_buffer
[i
]);
10185 window_height_changed_p
10186 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10187 display_echo_area_1
,
10188 (intptr_t) w
, Qnil
, 0, 0);
10191 echo_area_buffer
[i
] = Qnil
;
10193 unbind_to (count
, Qnil
);
10194 return window_height_changed_p
;
10198 /* Helper for display_echo_area. Display the current buffer which
10199 contains the current echo area message in window W, a mini-window,
10200 a pointer to which is passed in A1. A2..A4 are currently not used.
10201 Change the height of W so that all of the message is displayed.
10202 Value is non-zero if height of W was changed. */
10205 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10208 struct window
*w
= (struct window
*) i1
;
10209 Lisp_Object window
;
10210 struct text_pos start
;
10211 int window_height_changed_p
= 0;
10213 /* Do this before displaying, so that we have a large enough glyph
10214 matrix for the display. If we can't get enough space for the
10215 whole text, display the last N lines. That works by setting w->start. */
10216 window_height_changed_p
= resize_mini_window (w
, 0);
10218 /* Use the starting position chosen by resize_mini_window. */
10219 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10222 clear_glyph_matrix (w
->desired_matrix
);
10223 XSETWINDOW (window
, w
);
10224 try_window (window
, start
, 0);
10226 return window_height_changed_p
;
10230 /* Resize the echo area window to exactly the size needed for the
10231 currently displayed message, if there is one. If a mini-buffer
10232 is active, don't shrink it. */
10235 resize_echo_area_exactly (void)
10237 if (BUFFERP (echo_area_buffer
[0])
10238 && WINDOWP (echo_area_window
))
10240 struct window
*w
= XWINDOW (echo_area_window
);
10242 Lisp_Object resize_exactly
;
10244 if (minibuf_level
== 0)
10245 resize_exactly
= Qt
;
10247 resize_exactly
= Qnil
;
10249 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10250 (intptr_t) w
, resize_exactly
,
10254 ++windows_or_buffers_changed
;
10255 ++update_mode_lines
;
10256 redisplay_internal ();
10262 /* Callback function for with_echo_area_buffer, when used from
10263 resize_echo_area_exactly. A1 contains a pointer to the window to
10264 resize, EXACTLY non-nil means resize the mini-window exactly to the
10265 size of the text displayed. A3 and A4 are not used. Value is what
10266 resize_mini_window returns. */
10269 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10272 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10276 /* Resize mini-window W to fit the size of its contents. EXACT_P
10277 means size the window exactly to the size needed. Otherwise, it's
10278 only enlarged until W's buffer is empty.
10280 Set W->start to the right place to begin display. If the whole
10281 contents fit, start at the beginning. Otherwise, start so as
10282 to make the end of the contents appear. This is particularly
10283 important for y-or-n-p, but seems desirable generally.
10285 Value is non-zero if the window height has been changed. */
10288 resize_mini_window (struct window
*w
, int exact_p
)
10290 struct frame
*f
= XFRAME (w
->frame
);
10291 int window_height_changed_p
= 0;
10293 eassert (MINI_WINDOW_P (w
));
10295 /* By default, start display at the beginning. */
10296 set_marker_both (w
->start
, w
->buffer
,
10297 BUF_BEGV (XBUFFER (w
->buffer
)),
10298 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10300 /* Don't resize windows while redisplaying a window; it would
10301 confuse redisplay functions when the size of the window they are
10302 displaying changes from under them. Such a resizing can happen,
10303 for instance, when which-func prints a long message while
10304 we are running fontification-functions. We're running these
10305 functions with safe_call which binds inhibit-redisplay to t. */
10306 if (!NILP (Vinhibit_redisplay
))
10309 /* Nil means don't try to resize. */
10310 if (NILP (Vresize_mini_windows
)
10311 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10314 if (!FRAME_MINIBUF_ONLY_P (f
))
10317 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10318 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10320 EMACS_INT max_height
;
10321 int unit
= FRAME_LINE_HEIGHT (f
);
10322 struct text_pos start
;
10323 struct buffer
*old_current_buffer
= NULL
;
10325 if (current_buffer
!= XBUFFER (w
->buffer
))
10327 old_current_buffer
= current_buffer
;
10328 set_buffer_internal (XBUFFER (w
->buffer
));
10331 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10333 /* Compute the max. number of lines specified by the user. */
10334 if (FLOATP (Vmax_mini_window_height
))
10335 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10336 else if (INTEGERP (Vmax_mini_window_height
))
10337 max_height
= XINT (Vmax_mini_window_height
);
10339 max_height
= total_height
/ 4;
10341 /* Correct that max. height if it's bogus. */
10342 max_height
= max (1, max_height
);
10343 max_height
= min (total_height
, max_height
);
10345 /* Find out the height of the text in the window. */
10346 if (it
.line_wrap
== TRUNCATE
)
10351 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10352 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10353 height
= it
.current_y
+ last_height
;
10355 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10356 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10357 height
= (height
+ unit
- 1) / unit
;
10360 /* Compute a suitable window start. */
10361 if (height
> max_height
)
10363 height
= max_height
;
10364 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10365 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10366 start
= it
.current
.pos
;
10369 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10370 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10372 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10374 /* Let it grow only, until we display an empty message, in which
10375 case the window shrinks again. */
10376 if (height
> WINDOW_TOTAL_LINES (w
))
10378 int old_height
= WINDOW_TOTAL_LINES (w
);
10379 freeze_window_starts (f
, 1);
10380 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10381 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10383 else if (height
< WINDOW_TOTAL_LINES (w
)
10384 && (exact_p
|| BEGV
== ZV
))
10386 int old_height
= WINDOW_TOTAL_LINES (w
);
10387 freeze_window_starts (f
, 0);
10388 shrink_mini_window (w
);
10389 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10394 /* Always resize to exact size needed. */
10395 if (height
> WINDOW_TOTAL_LINES (w
))
10397 int old_height
= WINDOW_TOTAL_LINES (w
);
10398 freeze_window_starts (f
, 1);
10399 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10400 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10402 else if (height
< WINDOW_TOTAL_LINES (w
))
10404 int old_height
= WINDOW_TOTAL_LINES (w
);
10405 freeze_window_starts (f
, 0);
10406 shrink_mini_window (w
);
10410 freeze_window_starts (f
, 1);
10411 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10414 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10418 if (old_current_buffer
)
10419 set_buffer_internal (old_current_buffer
);
10422 return window_height_changed_p
;
10426 /* Value is the current message, a string, or nil if there is no
10427 current message. */
10430 current_message (void)
10434 if (!BUFFERP (echo_area_buffer
[0]))
10438 with_echo_area_buffer (0, 0, current_message_1
,
10439 (intptr_t) &msg
, Qnil
, 0, 0);
10441 echo_area_buffer
[0] = Qnil
;
10449 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10452 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10455 *msg
= make_buffer_string (BEG
, Z
, 1);
10462 /* Push the current message on Vmessage_stack for later restoration
10463 by restore_message. Value is non-zero if the current message isn't
10464 empty. This is a relatively infrequent operation, so it's not
10465 worth optimizing. */
10468 push_message (void)
10471 msg
= current_message ();
10472 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10473 return STRINGP (msg
);
10477 /* Restore message display from the top of Vmessage_stack. */
10480 restore_message (void)
10484 eassert (CONSP (Vmessage_stack
));
10485 msg
= XCAR (Vmessage_stack
);
10487 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10489 message3_nolog (msg
, 0, 0);
10493 /* Handler for record_unwind_protect calling pop_message. */
10496 pop_message_unwind (Lisp_Object dummy
)
10502 /* Pop the top-most entry off Vmessage_stack. */
10507 eassert (CONSP (Vmessage_stack
));
10508 Vmessage_stack
= XCDR (Vmessage_stack
);
10512 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10513 exits. If the stack is not empty, we have a missing pop_message
10517 check_message_stack (void)
10519 if (!NILP (Vmessage_stack
))
10524 /* Truncate to NCHARS what will be displayed in the echo area the next
10525 time we display it---but don't redisplay it now. */
10528 truncate_echo_area (ptrdiff_t nchars
)
10531 echo_area_buffer
[0] = Qnil
;
10532 /* A null message buffer means that the frame hasn't really been
10533 initialized yet. Error messages get reported properly by
10534 cmd_error, so this must be just an informative message; toss it. */
10535 else if (!noninteractive
10537 && !NILP (echo_area_buffer
[0]))
10539 struct frame
*sf
= SELECTED_FRAME ();
10540 if (FRAME_MESSAGE_BUF (sf
))
10541 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10546 /* Helper function for truncate_echo_area. Truncate the current
10547 message to at most NCHARS characters. */
10550 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10552 if (BEG
+ nchars
< Z
)
10553 del_range (BEG
+ nchars
, Z
);
10555 echo_area_buffer
[0] = Qnil
;
10560 /* Set the current message to a substring of S or STRING.
10562 If STRING is a Lisp string, set the message to the first NBYTES
10563 bytes from STRING. NBYTES zero means use the whole string. If
10564 STRING is multibyte, the message will be displayed multibyte.
10566 If S is not null, set the message to the first LEN bytes of S. LEN
10567 zero means use the whole string. MULTIBYTE_P non-zero means S is
10568 multibyte. Display the message multibyte in that case.
10570 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10571 to t before calling set_message_1 (which calls insert).
10575 set_message (const char *s
, Lisp_Object string
,
10576 ptrdiff_t nbytes
, int multibyte_p
)
10578 message_enable_multibyte
10579 = ((s
&& multibyte_p
)
10580 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10582 with_echo_area_buffer (0, -1, set_message_1
,
10583 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10584 message_buf_print
= 0;
10585 help_echo_showing_p
= 0;
10589 /* Helper function for set_message. Arguments have the same meaning
10590 as there, with A1 corresponding to S and A2 corresponding to STRING
10591 This function is called with the echo area buffer being
10595 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10598 const char *s
= (const char *) i1
;
10599 const unsigned char *msg
= (const unsigned char *) s
;
10600 Lisp_Object string
= a2
;
10602 /* Change multibyteness of the echo buffer appropriately. */
10603 if (message_enable_multibyte
10604 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10605 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10607 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10608 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10609 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10611 /* Insert new message at BEG. */
10612 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10614 if (STRINGP (string
))
10619 nbytes
= SBYTES (string
);
10620 nchars
= string_byte_to_char (string
, nbytes
);
10622 /* This function takes care of single/multibyte conversion. We
10623 just have to ensure that the echo area buffer has the right
10624 setting of enable_multibyte_characters. */
10625 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10630 nbytes
= strlen (s
);
10632 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10634 /* Convert from multi-byte to single-byte. */
10639 /* Convert a multibyte string to single-byte. */
10640 for (i
= 0; i
< nbytes
; i
+= n
)
10642 c
= string_char_and_length (msg
+ i
, &n
);
10643 work
[0] = (ASCII_CHAR_P (c
)
10645 : multibyte_char_to_unibyte (c
));
10646 insert_1_both (work
, 1, 1, 1, 0, 0);
10649 else if (!multibyte_p
10650 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10652 /* Convert from single-byte to multi-byte. */
10655 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10657 /* Convert a single-byte string to multibyte. */
10658 for (i
= 0; i
< nbytes
; i
++)
10661 MAKE_CHAR_MULTIBYTE (c
);
10662 n
= CHAR_STRING (c
, str
);
10663 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10667 insert_1 (s
, nbytes
, 1, 0, 0);
10674 /* Clear messages. CURRENT_P non-zero means clear the current
10675 message. LAST_DISPLAYED_P non-zero means clear the message
10679 clear_message (int current_p
, int last_displayed_p
)
10683 echo_area_buffer
[0] = Qnil
;
10684 message_cleared_p
= 1;
10687 if (last_displayed_p
)
10688 echo_area_buffer
[1] = Qnil
;
10690 message_buf_print
= 0;
10693 /* Clear garbaged frames.
10695 This function is used where the old redisplay called
10696 redraw_garbaged_frames which in turn called redraw_frame which in
10697 turn called clear_frame. The call to clear_frame was a source of
10698 flickering. I believe a clear_frame is not necessary. It should
10699 suffice in the new redisplay to invalidate all current matrices,
10700 and ensure a complete redisplay of all windows. */
10703 clear_garbaged_frames (void)
10705 if (frame_garbaged
)
10707 Lisp_Object tail
, frame
;
10708 int changed_count
= 0;
10710 FOR_EACH_FRAME (tail
, frame
)
10712 struct frame
*f
= XFRAME (frame
);
10714 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10718 Fredraw_frame (frame
);
10719 f
->force_flush_display_p
= 1;
10721 clear_current_matrices (f
);
10728 frame_garbaged
= 0;
10730 ++windows_or_buffers_changed
;
10735 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10736 is non-zero update selected_frame. Value is non-zero if the
10737 mini-windows height has been changed. */
10740 echo_area_display (int update_frame_p
)
10742 Lisp_Object mini_window
;
10745 int window_height_changed_p
= 0;
10746 struct frame
*sf
= SELECTED_FRAME ();
10748 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10749 w
= XWINDOW (mini_window
);
10750 f
= XFRAME (WINDOW_FRAME (w
));
10752 /* Don't display if frame is invisible or not yet initialized. */
10753 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10756 #ifdef HAVE_WINDOW_SYSTEM
10757 /* When Emacs starts, selected_frame may be the initial terminal
10758 frame. If we let this through, a message would be displayed on
10760 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10762 #endif /* HAVE_WINDOW_SYSTEM */
10764 /* Redraw garbaged frames. */
10765 if (frame_garbaged
)
10766 clear_garbaged_frames ();
10768 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10770 echo_area_window
= mini_window
;
10771 window_height_changed_p
= display_echo_area (w
);
10772 w
->must_be_updated_p
= 1;
10774 /* Update the display, unless called from redisplay_internal.
10775 Also don't update the screen during redisplay itself. The
10776 update will happen at the end of redisplay, and an update
10777 here could cause confusion. */
10778 if (update_frame_p
&& !redisplaying_p
)
10782 /* If the display update has been interrupted by pending
10783 input, update mode lines in the frame. Due to the
10784 pending input, it might have been that redisplay hasn't
10785 been called, so that mode lines above the echo area are
10786 garbaged. This looks odd, so we prevent it here. */
10787 if (!display_completed
)
10788 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10790 if (window_height_changed_p
10791 /* Don't do this if Emacs is shutting down. Redisplay
10792 needs to run hooks. */
10793 && !NILP (Vrun_hooks
))
10795 /* Must update other windows. Likewise as in other
10796 cases, don't let this update be interrupted by
10798 ptrdiff_t count
= SPECPDL_INDEX ();
10799 specbind (Qredisplay_dont_pause
, Qt
);
10800 windows_or_buffers_changed
= 1;
10801 redisplay_internal ();
10802 unbind_to (count
, Qnil
);
10804 else if (FRAME_WINDOW_P (f
) && n
== 0)
10806 /* Window configuration is the same as before.
10807 Can do with a display update of the echo area,
10808 unless we displayed some mode lines. */
10809 update_single_window (w
, 1);
10810 FRAME_RIF (f
)->flush_display (f
);
10813 update_frame (f
, 1, 1);
10815 /* If cursor is in the echo area, make sure that the next
10816 redisplay displays the minibuffer, so that the cursor will
10817 be replaced with what the minibuffer wants. */
10818 if (cursor_in_echo_area
)
10819 ++windows_or_buffers_changed
;
10822 else if (!EQ (mini_window
, selected_window
))
10823 windows_or_buffers_changed
++;
10825 /* Last displayed message is now the current message. */
10826 echo_area_buffer
[1] = echo_area_buffer
[0];
10827 /* Inform read_char that we're not echoing. */
10828 echo_message_buffer
= Qnil
;
10830 /* Prevent redisplay optimization in redisplay_internal by resetting
10831 this_line_start_pos. This is done because the mini-buffer now
10832 displays the message instead of its buffer text. */
10833 if (EQ (mini_window
, selected_window
))
10834 CHARPOS (this_line_start_pos
) = 0;
10836 return window_height_changed_p
;
10841 /***********************************************************************
10842 Mode Lines and Frame Titles
10843 ***********************************************************************/
10845 /* A buffer for constructing non-propertized mode-line strings and
10846 frame titles in it; allocated from the heap in init_xdisp and
10847 resized as needed in store_mode_line_noprop_char. */
10849 static char *mode_line_noprop_buf
;
10851 /* The buffer's end, and a current output position in it. */
10853 static char *mode_line_noprop_buf_end
;
10854 static char *mode_line_noprop_ptr
;
10856 #define MODE_LINE_NOPROP_LEN(start) \
10857 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10860 MODE_LINE_DISPLAY
= 0,
10864 } mode_line_target
;
10866 /* Alist that caches the results of :propertize.
10867 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10868 static Lisp_Object mode_line_proptrans_alist
;
10870 /* List of strings making up the mode-line. */
10871 static Lisp_Object mode_line_string_list
;
10873 /* Base face property when building propertized mode line string. */
10874 static Lisp_Object mode_line_string_face
;
10875 static Lisp_Object mode_line_string_face_prop
;
10878 /* Unwind data for mode line strings */
10880 static Lisp_Object Vmode_line_unwind_vector
;
10883 format_mode_line_unwind_data (struct frame
*target_frame
,
10884 struct buffer
*obuf
,
10886 int save_proptrans
)
10888 Lisp_Object vector
, tmp
;
10890 /* Reduce consing by keeping one vector in
10891 Vwith_echo_area_save_vector. */
10892 vector
= Vmode_line_unwind_vector
;
10893 Vmode_line_unwind_vector
= Qnil
;
10896 vector
= Fmake_vector (make_number (10), Qnil
);
10898 ASET (vector
, 0, make_number (mode_line_target
));
10899 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10900 ASET (vector
, 2, mode_line_string_list
);
10901 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10902 ASET (vector
, 4, mode_line_string_face
);
10903 ASET (vector
, 5, mode_line_string_face_prop
);
10906 XSETBUFFER (tmp
, obuf
);
10909 ASET (vector
, 6, tmp
);
10910 ASET (vector
, 7, owin
);
10913 /* Similarly to `with-selected-window', if the operation selects
10914 a window on another frame, we must restore that frame's
10915 selected window, and (for a tty) the top-frame. */
10916 ASET (vector
, 8, target_frame
->selected_window
);
10917 if (FRAME_TERMCAP_P (target_frame
))
10918 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10925 unwind_format_mode_line (Lisp_Object vector
)
10927 Lisp_Object old_window
= AREF (vector
, 7);
10928 Lisp_Object target_frame_window
= AREF (vector
, 8);
10929 Lisp_Object old_top_frame
= AREF (vector
, 9);
10931 mode_line_target
= XINT (AREF (vector
, 0));
10932 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10933 mode_line_string_list
= AREF (vector
, 2);
10934 if (! EQ (AREF (vector
, 3), Qt
))
10935 mode_line_proptrans_alist
= AREF (vector
, 3);
10936 mode_line_string_face
= AREF (vector
, 4);
10937 mode_line_string_face_prop
= AREF (vector
, 5);
10939 /* Select window before buffer, since it may change the buffer. */
10940 if (!NILP (old_window
))
10942 /* If the operation that we are unwinding had selected a window
10943 on a different frame, reset its frame-selected-window. For a
10944 text terminal, reset its top-frame if necessary. */
10945 if (!NILP (target_frame_window
))
10948 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10950 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10951 Fselect_window (target_frame_window
, Qt
);
10953 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10954 Fselect_frame (old_top_frame
, Qt
);
10957 Fselect_window (old_window
, Qt
);
10960 if (!NILP (AREF (vector
, 6)))
10962 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10963 ASET (vector
, 6, Qnil
);
10966 Vmode_line_unwind_vector
= vector
;
10971 /* Store a single character C for the frame title in mode_line_noprop_buf.
10972 Re-allocate mode_line_noprop_buf if necessary. */
10975 store_mode_line_noprop_char (char c
)
10977 /* If output position has reached the end of the allocated buffer,
10978 increase the buffer's size. */
10979 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10981 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10982 ptrdiff_t size
= len
;
10983 mode_line_noprop_buf
=
10984 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10985 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10986 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10989 *mode_line_noprop_ptr
++ = c
;
10993 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10994 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10995 characters that yield more columns than PRECISION; PRECISION <= 0
10996 means copy the whole string. Pad with spaces until FIELD_WIDTH
10997 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10998 pad. Called from display_mode_element when it is used to build a
11002 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11004 const unsigned char *str
= (const unsigned char *) string
;
11006 ptrdiff_t dummy
, nbytes
;
11008 /* Copy at most PRECISION chars from STR. */
11009 nbytes
= strlen (string
);
11010 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11012 store_mode_line_noprop_char (*str
++);
11014 /* Fill up with spaces until FIELD_WIDTH reached. */
11015 while (field_width
> 0
11016 && n
< field_width
)
11018 store_mode_line_noprop_char (' ');
11025 /***********************************************************************
11027 ***********************************************************************/
11029 #ifdef HAVE_WINDOW_SYSTEM
11031 /* Set the title of FRAME, if it has changed. The title format is
11032 Vicon_title_format if FRAME is iconified, otherwise it is
11033 frame_title_format. */
11036 x_consider_frame_title (Lisp_Object frame
)
11038 struct frame
*f
= XFRAME (frame
);
11040 if (FRAME_WINDOW_P (f
)
11041 || FRAME_MINIBUF_ONLY_P (f
)
11042 || f
->explicit_name
)
11044 /* Do we have more than one visible frame on this X display? */
11047 ptrdiff_t title_start
;
11051 ptrdiff_t count
= SPECPDL_INDEX ();
11053 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11055 Lisp_Object other_frame
= XCAR (tail
);
11056 struct frame
*tf
= XFRAME (other_frame
);
11059 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11060 && !FRAME_MINIBUF_ONLY_P (tf
)
11061 && !EQ (other_frame
, tip_frame
)
11062 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11066 /* Set global variable indicating that multiple frames exist. */
11067 multiple_frames
= CONSP (tail
);
11069 /* Switch to the buffer of selected window of the frame. Set up
11070 mode_line_target so that display_mode_element will output into
11071 mode_line_noprop_buf; then display the title. */
11072 record_unwind_protect (unwind_format_mode_line
,
11073 format_mode_line_unwind_data
11074 (f
, current_buffer
, selected_window
, 0));
11076 Fselect_window (f
->selected_window
, Qt
);
11077 set_buffer_internal_1
11078 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11079 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11081 mode_line_target
= MODE_LINE_TITLE
;
11082 title_start
= MODE_LINE_NOPROP_LEN (0);
11083 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11084 NULL
, DEFAULT_FACE_ID
);
11085 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11086 len
= MODE_LINE_NOPROP_LEN (title_start
);
11087 title
= mode_line_noprop_buf
+ title_start
;
11088 unbind_to (count
, Qnil
);
11090 /* Set the title only if it's changed. This avoids consing in
11091 the common case where it hasn't. (If it turns out that we've
11092 already wasted too much time by walking through the list with
11093 display_mode_element, then we might need to optimize at a
11094 higher level than this.) */
11095 if (! STRINGP (f
->name
)
11096 || SBYTES (f
->name
) != len
11097 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11098 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11102 #endif /* not HAVE_WINDOW_SYSTEM */
11105 /***********************************************************************
11107 ***********************************************************************/
11110 /* Prepare for redisplay by updating menu-bar item lists when
11111 appropriate. This can call eval. */
11114 prepare_menu_bars (void)
11117 struct gcpro gcpro1
, gcpro2
;
11119 Lisp_Object tooltip_frame
;
11121 #ifdef HAVE_WINDOW_SYSTEM
11122 tooltip_frame
= tip_frame
;
11124 tooltip_frame
= Qnil
;
11127 /* Update all frame titles based on their buffer names, etc. We do
11128 this before the menu bars so that the buffer-menu will show the
11129 up-to-date frame titles. */
11130 #ifdef HAVE_WINDOW_SYSTEM
11131 if (windows_or_buffers_changed
|| update_mode_lines
)
11133 Lisp_Object tail
, frame
;
11135 FOR_EACH_FRAME (tail
, frame
)
11137 f
= XFRAME (frame
);
11138 if (!EQ (frame
, tooltip_frame
)
11139 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11140 x_consider_frame_title (frame
);
11143 #endif /* HAVE_WINDOW_SYSTEM */
11145 /* Update the menu bar item lists, if appropriate. This has to be
11146 done before any actual redisplay or generation of display lines. */
11147 all_windows
= (update_mode_lines
11148 || buffer_shared
> 1
11149 || windows_or_buffers_changed
);
11152 Lisp_Object tail
, frame
;
11153 ptrdiff_t count
= SPECPDL_INDEX ();
11154 /* 1 means that update_menu_bar has run its hooks
11155 so any further calls to update_menu_bar shouldn't do so again. */
11156 int menu_bar_hooks_run
= 0;
11158 record_unwind_save_match_data ();
11160 FOR_EACH_FRAME (tail
, frame
)
11162 f
= XFRAME (frame
);
11164 /* Ignore tooltip frame. */
11165 if (EQ (frame
, tooltip_frame
))
11168 /* If a window on this frame changed size, report that to
11169 the user and clear the size-change flag. */
11170 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11172 Lisp_Object functions
;
11174 /* Clear flag first in case we get an error below. */
11175 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11176 functions
= Vwindow_size_change_functions
;
11177 GCPRO2 (tail
, functions
);
11179 while (CONSP (functions
))
11181 if (!EQ (XCAR (functions
), Qt
))
11182 call1 (XCAR (functions
), frame
);
11183 functions
= XCDR (functions
);
11189 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11190 #ifdef HAVE_WINDOW_SYSTEM
11191 update_tool_bar (f
, 0);
11194 if (windows_or_buffers_changed
11197 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11202 unbind_to (count
, Qnil
);
11206 struct frame
*sf
= SELECTED_FRAME ();
11207 update_menu_bar (sf
, 1, 0);
11208 #ifdef HAVE_WINDOW_SYSTEM
11209 update_tool_bar (sf
, 1);
11215 /* Update the menu bar item list for frame F. This has to be done
11216 before we start to fill in any display lines, because it can call
11219 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11221 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11222 already ran the menu bar hooks for this redisplay, so there
11223 is no need to run them again. The return value is the
11224 updated value of this flag, to pass to the next call. */
11227 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11229 Lisp_Object window
;
11230 register struct window
*w
;
11232 /* If called recursively during a menu update, do nothing. This can
11233 happen when, for instance, an activate-menubar-hook causes a
11235 if (inhibit_menubar_update
)
11238 window
= FRAME_SELECTED_WINDOW (f
);
11239 w
= XWINDOW (window
);
11241 if (FRAME_WINDOW_P (f
)
11243 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11244 || defined (HAVE_NS) || defined (USE_GTK)
11245 FRAME_EXTERNAL_MENU_BAR (f
)
11247 FRAME_MENU_BAR_LINES (f
) > 0
11249 : FRAME_MENU_BAR_LINES (f
) > 0)
11251 /* If the user has switched buffers or windows, we need to
11252 recompute to reflect the new bindings. But we'll
11253 recompute when update_mode_lines is set too; that means
11254 that people can use force-mode-line-update to request
11255 that the menu bar be recomputed. The adverse effect on
11256 the rest of the redisplay algorithm is about the same as
11257 windows_or_buffers_changed anyway. */
11258 if (windows_or_buffers_changed
11259 /* This used to test w->update_mode_line, but we believe
11260 there is no need to recompute the menu in that case. */
11261 || update_mode_lines
11262 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11263 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11264 != w
->last_had_star
)
11265 || ((!NILP (Vtransient_mark_mode
)
11266 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11267 != !NILP (w
->region_showing
)))
11269 struct buffer
*prev
= current_buffer
;
11270 ptrdiff_t count
= SPECPDL_INDEX ();
11272 specbind (Qinhibit_menubar_update
, Qt
);
11274 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11275 if (save_match_data
)
11276 record_unwind_save_match_data ();
11277 if (NILP (Voverriding_local_map_menu_flag
))
11279 specbind (Qoverriding_terminal_local_map
, Qnil
);
11280 specbind (Qoverriding_local_map
, Qnil
);
11285 /* Run the Lucid hook. */
11286 safe_run_hooks (Qactivate_menubar_hook
);
11288 /* If it has changed current-menubar from previous value,
11289 really recompute the menu-bar from the value. */
11290 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11291 call0 (Qrecompute_lucid_menubar
);
11293 safe_run_hooks (Qmenu_bar_update_hook
);
11298 XSETFRAME (Vmenu_updating_frame
, f
);
11299 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11301 /* Redisplay the menu bar in case we changed it. */
11302 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11303 || defined (HAVE_NS) || defined (USE_GTK)
11304 if (FRAME_WINDOW_P (f
))
11306 #if defined (HAVE_NS)
11307 /* All frames on Mac OS share the same menubar. So only
11308 the selected frame should be allowed to set it. */
11309 if (f
== SELECTED_FRAME ())
11311 set_frame_menubar (f
, 0, 0);
11314 /* On a terminal screen, the menu bar is an ordinary screen
11315 line, and this makes it get updated. */
11316 w
->update_mode_line
= 1;
11317 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11318 /* In the non-toolkit version, the menu bar is an ordinary screen
11319 line, and this makes it get updated. */
11320 w
->update_mode_line
= 1;
11321 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11323 unbind_to (count
, Qnil
);
11324 set_buffer_internal_1 (prev
);
11333 /***********************************************************************
11335 ***********************************************************************/
11337 #ifdef HAVE_WINDOW_SYSTEM
11340 Nominal cursor position -- where to draw output.
11341 HPOS and VPOS are window relative glyph matrix coordinates.
11342 X and Y are window relative pixel coordinates. */
11344 struct cursor_pos output_cursor
;
11348 Set the global variable output_cursor to CURSOR. All cursor
11349 positions are relative to updated_window. */
11352 set_output_cursor (struct cursor_pos
*cursor
)
11354 output_cursor
.hpos
= cursor
->hpos
;
11355 output_cursor
.vpos
= cursor
->vpos
;
11356 output_cursor
.x
= cursor
->x
;
11357 output_cursor
.y
= cursor
->y
;
11362 Set a nominal cursor position.
11364 HPOS and VPOS are column/row positions in a window glyph matrix. X
11365 and Y are window text area relative pixel positions.
11367 If this is done during an update, updated_window will contain the
11368 window that is being updated and the position is the future output
11369 cursor position for that window. If updated_window is null, use
11370 selected_window and display the cursor at the given position. */
11373 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11377 /* If updated_window is not set, work on selected_window. */
11378 if (updated_window
)
11379 w
= updated_window
;
11381 w
= XWINDOW (selected_window
);
11383 /* Set the output cursor. */
11384 output_cursor
.hpos
= hpos
;
11385 output_cursor
.vpos
= vpos
;
11386 output_cursor
.x
= x
;
11387 output_cursor
.y
= y
;
11389 /* If not called as part of an update, really display the cursor.
11390 This will also set the cursor position of W. */
11391 if (updated_window
== NULL
)
11394 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11395 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11396 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11401 #endif /* HAVE_WINDOW_SYSTEM */
11404 /***********************************************************************
11406 ***********************************************************************/
11408 #ifdef HAVE_WINDOW_SYSTEM
11410 /* Where the mouse was last time we reported a mouse event. */
11412 FRAME_PTR last_mouse_frame
;
11414 /* Tool-bar item index of the item on which a mouse button was pressed
11417 int last_tool_bar_item
;
11421 update_tool_bar_unwind (Lisp_Object frame
)
11423 selected_frame
= frame
;
11427 /* Update the tool-bar item list for frame F. This has to be done
11428 before we start to fill in any display lines. Called from
11429 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11430 and restore it here. */
11433 update_tool_bar (struct frame
*f
, int save_match_data
)
11435 #if defined (USE_GTK) || defined (HAVE_NS)
11436 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11438 int do_update
= WINDOWP (f
->tool_bar_window
)
11439 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11444 Lisp_Object window
;
11447 window
= FRAME_SELECTED_WINDOW (f
);
11448 w
= XWINDOW (window
);
11450 /* If the user has switched buffers or windows, we need to
11451 recompute to reflect the new bindings. But we'll
11452 recompute when update_mode_lines is set too; that means
11453 that people can use force-mode-line-update to request
11454 that the menu bar be recomputed. The adverse effect on
11455 the rest of the redisplay algorithm is about the same as
11456 windows_or_buffers_changed anyway. */
11457 if (windows_or_buffers_changed
11458 || w
->update_mode_line
11459 || update_mode_lines
11460 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11461 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11462 != w
->last_had_star
)
11463 || ((!NILP (Vtransient_mark_mode
)
11464 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11465 != !NILP (w
->region_showing
)))
11467 struct buffer
*prev
= current_buffer
;
11468 ptrdiff_t count
= SPECPDL_INDEX ();
11469 Lisp_Object frame
, new_tool_bar
;
11470 int new_n_tool_bar
;
11471 struct gcpro gcpro1
;
11473 /* Set current_buffer to the buffer of the selected
11474 window of the frame, so that we get the right local
11476 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11478 /* Save match data, if we must. */
11479 if (save_match_data
)
11480 record_unwind_save_match_data ();
11482 /* Make sure that we don't accidentally use bogus keymaps. */
11483 if (NILP (Voverriding_local_map_menu_flag
))
11485 specbind (Qoverriding_terminal_local_map
, Qnil
);
11486 specbind (Qoverriding_local_map
, Qnil
);
11489 GCPRO1 (new_tool_bar
);
11491 /* We must temporarily set the selected frame to this frame
11492 before calling tool_bar_items, because the calculation of
11493 the tool-bar keymap uses the selected frame (see
11494 `tool-bar-make-keymap' in tool-bar.el). */
11495 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11496 XSETFRAME (frame
, f
);
11497 selected_frame
= frame
;
11499 /* Build desired tool-bar items from keymaps. */
11501 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11504 /* Redisplay the tool-bar if we changed it. */
11505 if (new_n_tool_bar
!= f
->n_tool_bar_items
11506 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11508 /* Redisplay that happens asynchronously due to an expose event
11509 may access f->tool_bar_items. Make sure we update both
11510 variables within BLOCK_INPUT so no such event interrupts. */
11512 fset_tool_bar_items (f
, new_tool_bar
);
11513 f
->n_tool_bar_items
= new_n_tool_bar
;
11514 w
->update_mode_line
= 1;
11520 unbind_to (count
, Qnil
);
11521 set_buffer_internal_1 (prev
);
11527 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11528 F's desired tool-bar contents. F->tool_bar_items must have
11529 been set up previously by calling prepare_menu_bars. */
11532 build_desired_tool_bar_string (struct frame
*f
)
11534 int i
, size
, size_needed
;
11535 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11536 Lisp_Object image
, plist
, props
;
11538 image
= plist
= props
= Qnil
;
11539 GCPRO3 (image
, plist
, props
);
11541 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11542 Otherwise, make a new string. */
11544 /* The size of the string we might be able to reuse. */
11545 size
= (STRINGP (f
->desired_tool_bar_string
)
11546 ? SCHARS (f
->desired_tool_bar_string
)
11549 /* We need one space in the string for each image. */
11550 size_needed
= f
->n_tool_bar_items
;
11552 /* Reuse f->desired_tool_bar_string, if possible. */
11553 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11554 fset_desired_tool_bar_string
11555 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11558 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11559 Fremove_text_properties (make_number (0), make_number (size
),
11560 props
, f
->desired_tool_bar_string
);
11563 /* Put a `display' property on the string for the images to display,
11564 put a `menu_item' property on tool-bar items with a value that
11565 is the index of the item in F's tool-bar item vector. */
11566 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11568 #define PROP(IDX) \
11569 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11571 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11572 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11573 int hmargin
, vmargin
, relief
, idx
, end
;
11575 /* If image is a vector, choose the image according to the
11577 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11578 if (VECTORP (image
))
11582 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11583 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11586 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11587 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11589 eassert (ASIZE (image
) >= idx
);
11590 image
= AREF (image
, idx
);
11595 /* Ignore invalid image specifications. */
11596 if (!valid_image_p (image
))
11599 /* Display the tool-bar button pressed, or depressed. */
11600 plist
= Fcopy_sequence (XCDR (image
));
11602 /* Compute margin and relief to draw. */
11603 relief
= (tool_bar_button_relief
>= 0
11604 ? tool_bar_button_relief
11605 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11606 hmargin
= vmargin
= relief
;
11608 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11609 INT_MAX
- max (hmargin
, vmargin
)))
11611 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11612 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11614 else if (CONSP (Vtool_bar_button_margin
))
11616 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11617 INT_MAX
- hmargin
))
11618 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11620 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11621 INT_MAX
- vmargin
))
11622 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11625 if (auto_raise_tool_bar_buttons_p
)
11627 /* Add a `:relief' property to the image spec if the item is
11631 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11638 /* If image is selected, display it pressed, i.e. with a
11639 negative relief. If it's not selected, display it with a
11641 plist
= Fplist_put (plist
, QCrelief
,
11643 ? make_number (-relief
)
11644 : make_number (relief
)));
11649 /* Put a margin around the image. */
11650 if (hmargin
|| vmargin
)
11652 if (hmargin
== vmargin
)
11653 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11655 plist
= Fplist_put (plist
, QCmargin
,
11656 Fcons (make_number (hmargin
),
11657 make_number (vmargin
)));
11660 /* If button is not enabled, and we don't have special images
11661 for the disabled state, make the image appear disabled by
11662 applying an appropriate algorithm to it. */
11663 if (!enabled_p
&& idx
< 0)
11664 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11666 /* Put a `display' text property on the string for the image to
11667 display. Put a `menu-item' property on the string that gives
11668 the start of this item's properties in the tool-bar items
11670 image
= Fcons (Qimage
, plist
);
11671 props
= list4 (Qdisplay
, image
,
11672 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11674 /* Let the last image hide all remaining spaces in the tool bar
11675 string. The string can be longer than needed when we reuse a
11676 previous string. */
11677 if (i
+ 1 == f
->n_tool_bar_items
)
11678 end
= SCHARS (f
->desired_tool_bar_string
);
11681 Fadd_text_properties (make_number (i
), make_number (end
),
11682 props
, f
->desired_tool_bar_string
);
11690 /* Display one line of the tool-bar of frame IT->f.
11692 HEIGHT specifies the desired height of the tool-bar line.
11693 If the actual height of the glyph row is less than HEIGHT, the
11694 row's height is increased to HEIGHT, and the icons are centered
11695 vertically in the new height.
11697 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11698 count a final empty row in case the tool-bar width exactly matches
11703 display_tool_bar_line (struct it
*it
, int height
)
11705 struct glyph_row
*row
= it
->glyph_row
;
11706 int max_x
= it
->last_visible_x
;
11707 struct glyph
*last
;
11709 prepare_desired_row (row
);
11710 row
->y
= it
->current_y
;
11712 /* Note that this isn't made use of if the face hasn't a box,
11713 so there's no need to check the face here. */
11714 it
->start_of_box_run_p
= 1;
11716 while (it
->current_x
< max_x
)
11718 int x
, n_glyphs_before
, i
, nglyphs
;
11719 struct it it_before
;
11721 /* Get the next display element. */
11722 if (!get_next_display_element (it
))
11724 /* Don't count empty row if we are counting needed tool-bar lines. */
11725 if (height
< 0 && !it
->hpos
)
11730 /* Produce glyphs. */
11731 n_glyphs_before
= row
->used
[TEXT_AREA
];
11734 PRODUCE_GLYPHS (it
);
11736 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11738 x
= it_before
.current_x
;
11739 while (i
< nglyphs
)
11741 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11743 if (x
+ glyph
->pixel_width
> max_x
)
11745 /* Glyph doesn't fit on line. Backtrack. */
11746 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11748 /* If this is the only glyph on this line, it will never fit on the
11749 tool-bar, so skip it. But ensure there is at least one glyph,
11750 so we don't accidentally disable the tool-bar. */
11751 if (n_glyphs_before
== 0
11752 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11758 x
+= glyph
->pixel_width
;
11762 /* Stop at line end. */
11763 if (ITERATOR_AT_END_OF_LINE_P (it
))
11766 set_iterator_to_next (it
, 1);
11771 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11773 /* Use default face for the border below the tool bar.
11775 FIXME: When auto-resize-tool-bars is grow-only, there is
11776 no additional border below the possibly empty tool-bar lines.
11777 So to make the extra empty lines look "normal", we have to
11778 use the tool-bar face for the border too. */
11779 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11780 it
->face_id
= DEFAULT_FACE_ID
;
11782 extend_face_to_end_of_line (it
);
11783 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11784 last
->right_box_line_p
= 1;
11785 if (last
== row
->glyphs
[TEXT_AREA
])
11786 last
->left_box_line_p
= 1;
11788 /* Make line the desired height and center it vertically. */
11789 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11791 /* Don't add more than one line height. */
11792 height
%= FRAME_LINE_HEIGHT (it
->f
);
11793 it
->max_ascent
+= height
/ 2;
11794 it
->max_descent
+= (height
+ 1) / 2;
11797 compute_line_metrics (it
);
11799 /* If line is empty, make it occupy the rest of the tool-bar. */
11800 if (!row
->displays_text_p
)
11802 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11803 row
->visible_height
= row
->height
;
11804 row
->ascent
= row
->phys_ascent
= 0;
11805 row
->extra_line_spacing
= 0;
11808 row
->full_width_p
= 1;
11809 row
->continued_p
= 0;
11810 row
->truncated_on_left_p
= 0;
11811 row
->truncated_on_right_p
= 0;
11813 it
->current_x
= it
->hpos
= 0;
11814 it
->current_y
+= row
->height
;
11820 /* Max tool-bar height. */
11822 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11823 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11825 /* Value is the number of screen lines needed to make all tool-bar
11826 items of frame F visible. The number of actual rows needed is
11827 returned in *N_ROWS if non-NULL. */
11830 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11832 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11834 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11835 the desired matrix, so use (unused) mode-line row as temporary row to
11836 avoid destroying the first tool-bar row. */
11837 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11839 /* Initialize an iterator for iteration over
11840 F->desired_tool_bar_string in the tool-bar window of frame F. */
11841 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11842 it
.first_visible_x
= 0;
11843 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11844 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11845 it
.paragraph_embedding
= L2R
;
11847 while (!ITERATOR_AT_END_P (&it
))
11849 clear_glyph_row (temp_row
);
11850 it
.glyph_row
= temp_row
;
11851 display_tool_bar_line (&it
, -1);
11853 clear_glyph_row (temp_row
);
11855 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11857 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11859 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11863 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11865 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11866 (Lisp_Object frame
)
11873 frame
= selected_frame
;
11875 CHECK_FRAME (frame
);
11876 f
= XFRAME (frame
);
11878 if (WINDOWP (f
->tool_bar_window
)
11879 && (w
= XWINDOW (f
->tool_bar_window
),
11880 WINDOW_TOTAL_LINES (w
) > 0))
11882 update_tool_bar (f
, 1);
11883 if (f
->n_tool_bar_items
)
11885 build_desired_tool_bar_string (f
);
11886 nlines
= tool_bar_lines_needed (f
, NULL
);
11890 return make_number (nlines
);
11894 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11895 height should be changed. */
11898 redisplay_tool_bar (struct frame
*f
)
11902 struct glyph_row
*row
;
11904 #if defined (USE_GTK) || defined (HAVE_NS)
11905 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11906 update_frame_tool_bar (f
);
11910 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11911 do anything. This means you must start with tool-bar-lines
11912 non-zero to get the auto-sizing effect. Or in other words, you
11913 can turn off tool-bars by specifying tool-bar-lines zero. */
11914 if (!WINDOWP (f
->tool_bar_window
)
11915 || (w
= XWINDOW (f
->tool_bar_window
),
11916 WINDOW_TOTAL_LINES (w
) == 0))
11919 /* Set up an iterator for the tool-bar window. */
11920 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11921 it
.first_visible_x
= 0;
11922 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11923 row
= it
.glyph_row
;
11925 /* Build a string that represents the contents of the tool-bar. */
11926 build_desired_tool_bar_string (f
);
11927 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11928 /* FIXME: This should be controlled by a user option. But it
11929 doesn't make sense to have an R2L tool bar if the menu bar cannot
11930 be drawn also R2L, and making the menu bar R2L is tricky due
11931 toolkit-specific code that implements it. If an R2L tool bar is
11932 ever supported, display_tool_bar_line should also be augmented to
11933 call unproduce_glyphs like display_line and display_string
11935 it
.paragraph_embedding
= L2R
;
11937 if (f
->n_tool_bar_rows
== 0)
11941 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11942 nlines
!= WINDOW_TOTAL_LINES (w
)))
11945 int old_height
= WINDOW_TOTAL_LINES (w
);
11947 XSETFRAME (frame
, f
);
11948 Fmodify_frame_parameters (frame
,
11949 Fcons (Fcons (Qtool_bar_lines
,
11950 make_number (nlines
)),
11952 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11954 clear_glyph_matrix (w
->desired_matrix
);
11955 fonts_changed_p
= 1;
11961 /* Display as many lines as needed to display all tool-bar items. */
11963 if (f
->n_tool_bar_rows
> 0)
11965 int border
, rows
, height
, extra
;
11967 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11968 border
= XINT (Vtool_bar_border
);
11969 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11970 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11971 else if (EQ (Vtool_bar_border
, Qborder_width
))
11972 border
= f
->border_width
;
11978 rows
= f
->n_tool_bar_rows
;
11979 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11980 extra
= it
.last_visible_y
- border
- height
* rows
;
11982 while (it
.current_y
< it
.last_visible_y
)
11985 if (extra
> 0 && rows
-- > 0)
11987 h
= (extra
+ rows
- 1) / rows
;
11990 display_tool_bar_line (&it
, height
+ h
);
11995 while (it
.current_y
< it
.last_visible_y
)
11996 display_tool_bar_line (&it
, 0);
11999 /* It doesn't make much sense to try scrolling in the tool-bar
12000 window, so don't do it. */
12001 w
->desired_matrix
->no_scrolling_p
= 1;
12002 w
->must_be_updated_p
= 1;
12004 if (!NILP (Vauto_resize_tool_bars
))
12006 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12007 int change_height_p
= 0;
12009 /* If we couldn't display everything, change the tool-bar's
12010 height if there is room for more. */
12011 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12012 && it
.current_y
< max_tool_bar_height
)
12013 change_height_p
= 1;
12015 row
= it
.glyph_row
- 1;
12017 /* If there are blank lines at the end, except for a partially
12018 visible blank line at the end that is smaller than
12019 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12020 if (!row
->displays_text_p
12021 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12022 change_height_p
= 1;
12024 /* If row displays tool-bar items, but is partially visible,
12025 change the tool-bar's height. */
12026 if (row
->displays_text_p
12027 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12028 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12029 change_height_p
= 1;
12031 /* Resize windows as needed by changing the `tool-bar-lines'
12032 frame parameter. */
12033 if (change_height_p
)
12036 int old_height
= WINDOW_TOTAL_LINES (w
);
12038 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12040 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12041 && !f
->minimize_tool_bar_window_p
)
12042 ? (nlines
> old_height
)
12043 : (nlines
!= old_height
));
12044 f
->minimize_tool_bar_window_p
= 0;
12046 if (change_height_p
)
12048 XSETFRAME (frame
, f
);
12049 Fmodify_frame_parameters (frame
,
12050 Fcons (Fcons (Qtool_bar_lines
,
12051 make_number (nlines
)),
12053 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12055 clear_glyph_matrix (w
->desired_matrix
);
12056 f
->n_tool_bar_rows
= nrows
;
12057 fonts_changed_p
= 1;
12064 f
->minimize_tool_bar_window_p
= 0;
12069 /* Get information about the tool-bar item which is displayed in GLYPH
12070 on frame F. Return in *PROP_IDX the index where tool-bar item
12071 properties start in F->tool_bar_items. Value is zero if
12072 GLYPH doesn't display a tool-bar item. */
12075 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12081 /* This function can be called asynchronously, which means we must
12082 exclude any possibility that Fget_text_property signals an
12084 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12085 charpos
= max (0, charpos
);
12087 /* Get the text property `menu-item' at pos. The value of that
12088 property is the start index of this item's properties in
12089 F->tool_bar_items. */
12090 prop
= Fget_text_property (make_number (charpos
),
12091 Qmenu_item
, f
->current_tool_bar_string
);
12092 if (INTEGERP (prop
))
12094 *prop_idx
= XINT (prop
);
12104 /* Get information about the tool-bar item at position X/Y on frame F.
12105 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12106 the current matrix of the tool-bar window of F, or NULL if not
12107 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12108 item in F->tool_bar_items. Value is
12110 -1 if X/Y is not on a tool-bar item
12111 0 if X/Y is on the same item that was highlighted before.
12115 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12116 int *hpos
, int *vpos
, int *prop_idx
)
12118 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12119 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12122 /* Find the glyph under X/Y. */
12123 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12124 if (*glyph
== NULL
)
12127 /* Get the start of this tool-bar item's properties in
12128 f->tool_bar_items. */
12129 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12132 /* Is mouse on the highlighted item? */
12133 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12134 && *vpos
>= hlinfo
->mouse_face_beg_row
12135 && *vpos
<= hlinfo
->mouse_face_end_row
12136 && (*vpos
> hlinfo
->mouse_face_beg_row
12137 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12138 && (*vpos
< hlinfo
->mouse_face_end_row
12139 || *hpos
< hlinfo
->mouse_face_end_col
12140 || hlinfo
->mouse_face_past_end
))
12148 Handle mouse button event on the tool-bar of frame F, at
12149 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12150 0 for button release. MODIFIERS is event modifiers for button
12154 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12157 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12158 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12159 int hpos
, vpos
, prop_idx
;
12160 struct glyph
*glyph
;
12161 Lisp_Object enabled_p
;
12163 /* If not on the highlighted tool-bar item, return. */
12164 frame_to_window_pixel_xy (w
, &x
, &y
);
12165 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12168 /* If item is disabled, do nothing. */
12169 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12170 if (NILP (enabled_p
))
12175 /* Show item in pressed state. */
12176 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12177 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12178 last_tool_bar_item
= prop_idx
;
12182 Lisp_Object key
, frame
;
12183 struct input_event event
;
12184 EVENT_INIT (event
);
12186 /* Show item in released state. */
12187 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12188 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12190 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12192 XSETFRAME (frame
, f
);
12193 event
.kind
= TOOL_BAR_EVENT
;
12194 event
.frame_or_window
= frame
;
12196 kbd_buffer_store_event (&event
);
12198 event
.kind
= TOOL_BAR_EVENT
;
12199 event
.frame_or_window
= frame
;
12201 event
.modifiers
= modifiers
;
12202 kbd_buffer_store_event (&event
);
12203 last_tool_bar_item
= -1;
12208 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12209 tool-bar window-relative coordinates X/Y. Called from
12210 note_mouse_highlight. */
12213 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12215 Lisp_Object window
= f
->tool_bar_window
;
12216 struct window
*w
= XWINDOW (window
);
12217 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12218 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12220 struct glyph
*glyph
;
12221 struct glyph_row
*row
;
12223 Lisp_Object enabled_p
;
12225 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12226 int mouse_down_p
, rc
;
12228 /* Function note_mouse_highlight is called with negative X/Y
12229 values when mouse moves outside of the frame. */
12230 if (x
<= 0 || y
<= 0)
12232 clear_mouse_face (hlinfo
);
12236 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12239 /* Not on tool-bar item. */
12240 clear_mouse_face (hlinfo
);
12244 /* On same tool-bar item as before. */
12245 goto set_help_echo
;
12247 clear_mouse_face (hlinfo
);
12249 /* Mouse is down, but on different tool-bar item? */
12250 mouse_down_p
= (dpyinfo
->grabbed
12251 && f
== last_mouse_frame
12252 && FRAME_LIVE_P (f
));
12254 && last_tool_bar_item
!= prop_idx
)
12257 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12258 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12260 /* If tool-bar item is not enabled, don't highlight it. */
12261 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12262 if (!NILP (enabled_p
))
12264 /* Compute the x-position of the glyph. In front and past the
12265 image is a space. We include this in the highlighted area. */
12266 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12267 for (i
= x
= 0; i
< hpos
; ++i
)
12268 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12270 /* Record this as the current active region. */
12271 hlinfo
->mouse_face_beg_col
= hpos
;
12272 hlinfo
->mouse_face_beg_row
= vpos
;
12273 hlinfo
->mouse_face_beg_x
= x
;
12274 hlinfo
->mouse_face_beg_y
= row
->y
;
12275 hlinfo
->mouse_face_past_end
= 0;
12277 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12278 hlinfo
->mouse_face_end_row
= vpos
;
12279 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12280 hlinfo
->mouse_face_end_y
= row
->y
;
12281 hlinfo
->mouse_face_window
= window
;
12282 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12284 /* Display it as active. */
12285 show_mouse_face (hlinfo
, draw
);
12286 hlinfo
->mouse_face_image_state
= draw
;
12291 /* Set help_echo_string to a help string to display for this tool-bar item.
12292 XTread_socket does the rest. */
12293 help_echo_object
= help_echo_window
= Qnil
;
12294 help_echo_pos
= -1;
12295 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12296 if (NILP (help_echo_string
))
12297 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12300 #endif /* HAVE_WINDOW_SYSTEM */
12304 /************************************************************************
12305 Horizontal scrolling
12306 ************************************************************************/
12308 static int hscroll_window_tree (Lisp_Object
);
12309 static int hscroll_windows (Lisp_Object
);
12311 /* For all leaf windows in the window tree rooted at WINDOW, set their
12312 hscroll value so that PT is (i) visible in the window, and (ii) so
12313 that it is not within a certain margin at the window's left and
12314 right border. Value is non-zero if any window's hscroll has been
12318 hscroll_window_tree (Lisp_Object window
)
12320 int hscrolled_p
= 0;
12321 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12322 int hscroll_step_abs
= 0;
12323 double hscroll_step_rel
= 0;
12325 if (hscroll_relative_p
)
12327 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12328 if (hscroll_step_rel
< 0)
12330 hscroll_relative_p
= 0;
12331 hscroll_step_abs
= 0;
12334 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12336 hscroll_step_abs
= XINT (Vhscroll_step
);
12337 if (hscroll_step_abs
< 0)
12338 hscroll_step_abs
= 0;
12341 hscroll_step_abs
= 0;
12343 while (WINDOWP (window
))
12345 struct window
*w
= XWINDOW (window
);
12347 if (WINDOWP (w
->hchild
))
12348 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12349 else if (WINDOWP (w
->vchild
))
12350 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12351 else if (w
->cursor
.vpos
>= 0)
12354 int text_area_width
;
12355 struct glyph_row
*current_cursor_row
12356 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12357 struct glyph_row
*desired_cursor_row
12358 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12359 struct glyph_row
*cursor_row
12360 = (desired_cursor_row
->enabled_p
12361 ? desired_cursor_row
12362 : current_cursor_row
);
12363 int row_r2l_p
= cursor_row
->reversed_p
;
12365 text_area_width
= window_box_width (w
, TEXT_AREA
);
12367 /* Scroll when cursor is inside this scroll margin. */
12368 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12370 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12371 /* For left-to-right rows, hscroll when cursor is either
12372 (i) inside the right hscroll margin, or (ii) if it is
12373 inside the left margin and the window is already
12377 && w
->cursor
.x
<= h_margin
)
12378 || (cursor_row
->enabled_p
12379 && cursor_row
->truncated_on_right_p
12380 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12381 /* For right-to-left rows, the logic is similar,
12382 except that rules for scrolling to left and right
12383 are reversed. E.g., if cursor.x <= h_margin, we
12384 need to hscroll "to the right" unconditionally,
12385 and that will scroll the screen to the left so as
12386 to reveal the next portion of the row. */
12388 && ((cursor_row
->enabled_p
12389 /* FIXME: It is confusing to set the
12390 truncated_on_right_p flag when R2L rows
12391 are actually truncated on the left. */
12392 && cursor_row
->truncated_on_right_p
12393 && w
->cursor
.x
<= h_margin
)
12395 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12399 struct buffer
*saved_current_buffer
;
12403 /* Find point in a display of infinite width. */
12404 saved_current_buffer
= current_buffer
;
12405 current_buffer
= XBUFFER (w
->buffer
);
12407 if (w
== XWINDOW (selected_window
))
12411 pt
= marker_position (w
->pointm
);
12412 pt
= max (BEGV
, pt
);
12416 /* Move iterator to pt starting at cursor_row->start in
12417 a line with infinite width. */
12418 init_to_row_start (&it
, w
, cursor_row
);
12419 it
.last_visible_x
= INFINITY
;
12420 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12421 current_buffer
= saved_current_buffer
;
12423 /* Position cursor in window. */
12424 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12425 hscroll
= max (0, (it
.current_x
12426 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12427 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12428 : (text_area_width
/ 2))))
12429 / FRAME_COLUMN_WIDTH (it
.f
);
12430 else if ((!row_r2l_p
12431 && w
->cursor
.x
>= text_area_width
- h_margin
)
12432 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12434 if (hscroll_relative_p
)
12435 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12438 wanted_x
= text_area_width
12439 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12442 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12446 if (hscroll_relative_p
)
12447 wanted_x
= text_area_width
* hscroll_step_rel
12450 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12453 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12455 hscroll
= max (hscroll
, w
->min_hscroll
);
12457 /* Don't prevent redisplay optimizations if hscroll
12458 hasn't changed, as it will unnecessarily slow down
12460 if (w
->hscroll
!= hscroll
)
12462 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12463 w
->hscroll
= hscroll
;
12472 /* Value is non-zero if hscroll of any leaf window has been changed. */
12473 return hscrolled_p
;
12477 /* Set hscroll so that cursor is visible and not inside horizontal
12478 scroll margins for all windows in the tree rooted at WINDOW. See
12479 also hscroll_window_tree above. Value is non-zero if any window's
12480 hscroll has been changed. If it has, desired matrices on the frame
12481 of WINDOW are cleared. */
12484 hscroll_windows (Lisp_Object window
)
12486 int hscrolled_p
= hscroll_window_tree (window
);
12488 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12489 return hscrolled_p
;
12494 /************************************************************************
12496 ************************************************************************/
12498 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12499 to a non-zero value. This is sometimes handy to have in a debugger
12504 /* First and last unchanged row for try_window_id. */
12506 static int debug_first_unchanged_at_end_vpos
;
12507 static int debug_last_unchanged_at_beg_vpos
;
12509 /* Delta vpos and y. */
12511 static int debug_dvpos
, debug_dy
;
12513 /* Delta in characters and bytes for try_window_id. */
12515 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12517 /* Values of window_end_pos and window_end_vpos at the end of
12520 static ptrdiff_t debug_end_vpos
;
12522 /* Append a string to W->desired_matrix->method. FMT is a printf
12523 format string. If trace_redisplay_p is non-zero also printf the
12524 resulting string to stderr. */
12526 static void debug_method_add (struct window
*, char const *, ...)
12527 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12530 debug_method_add (struct window
*w
, char const *fmt
, ...)
12532 char *method
= w
->desired_matrix
->method
;
12533 int len
= strlen (method
);
12534 int size
= sizeof w
->desired_matrix
->method
;
12535 int remaining
= size
- len
- 1;
12538 if (len
&& remaining
)
12541 --remaining
, ++len
;
12544 va_start (ap
, fmt
);
12545 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12548 if (trace_redisplay_p
)
12549 fprintf (stderr
, "%p (%s): %s\n",
12551 ((BUFFERP (w
->buffer
)
12552 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12553 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12558 #endif /* GLYPH_DEBUG */
12561 /* Value is non-zero if all changes in window W, which displays
12562 current_buffer, are in the text between START and END. START is a
12563 buffer position, END is given as a distance from Z. Used in
12564 redisplay_internal for display optimization. */
12567 text_outside_line_unchanged_p (struct window
*w
,
12568 ptrdiff_t start
, ptrdiff_t end
)
12570 int unchanged_p
= 1;
12572 /* If text or overlays have changed, see where. */
12573 if (w
->last_modified
< MODIFF
12574 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12576 /* Gap in the line? */
12577 if (GPT
< start
|| Z
- GPT
< end
)
12580 /* Changes start in front of the line, or end after it? */
12582 && (BEG_UNCHANGED
< start
- 1
12583 || END_UNCHANGED
< end
))
12586 /* If selective display, can't optimize if changes start at the
12587 beginning of the line. */
12589 && INTEGERP (BVAR (current_buffer
, selective_display
))
12590 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12591 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12594 /* If there are overlays at the start or end of the line, these
12595 may have overlay strings with newlines in them. A change at
12596 START, for instance, may actually concern the display of such
12597 overlay strings as well, and they are displayed on different
12598 lines. So, quickly rule out this case. (For the future, it
12599 might be desirable to implement something more telling than
12600 just BEG/END_UNCHANGED.) */
12603 if (BEG
+ BEG_UNCHANGED
== start
12604 && overlay_touches_p (start
))
12606 if (END_UNCHANGED
== end
12607 && overlay_touches_p (Z
- end
))
12611 /* Under bidi reordering, adding or deleting a character in the
12612 beginning of a paragraph, before the first strong directional
12613 character, can change the base direction of the paragraph (unless
12614 the buffer specifies a fixed paragraph direction), which will
12615 require to redisplay the whole paragraph. It might be worthwhile
12616 to find the paragraph limits and widen the range of redisplayed
12617 lines to that, but for now just give up this optimization. */
12618 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12619 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12623 return unchanged_p
;
12627 /* Do a frame update, taking possible shortcuts into account. This is
12628 the main external entry point for redisplay.
12630 If the last redisplay displayed an echo area message and that message
12631 is no longer requested, we clear the echo area or bring back the
12632 mini-buffer if that is in use. */
12637 redisplay_internal ();
12642 overlay_arrow_string_or_property (Lisp_Object var
)
12646 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12649 return Voverlay_arrow_string
;
12652 /* Return 1 if there are any overlay-arrows in current_buffer. */
12654 overlay_arrow_in_current_buffer_p (void)
12658 for (vlist
= Voverlay_arrow_variable_list
;
12660 vlist
= XCDR (vlist
))
12662 Lisp_Object var
= XCAR (vlist
);
12665 if (!SYMBOLP (var
))
12667 val
= find_symbol_value (var
);
12669 && current_buffer
== XMARKER (val
)->buffer
)
12676 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12680 overlay_arrows_changed_p (void)
12684 for (vlist
= Voverlay_arrow_variable_list
;
12686 vlist
= XCDR (vlist
))
12688 Lisp_Object var
= XCAR (vlist
);
12689 Lisp_Object val
, pstr
;
12691 if (!SYMBOLP (var
))
12693 val
= find_symbol_value (var
);
12694 if (!MARKERP (val
))
12696 if (! EQ (COERCE_MARKER (val
),
12697 Fget (var
, Qlast_arrow_position
))
12698 || ! (pstr
= overlay_arrow_string_or_property (var
),
12699 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12705 /* Mark overlay arrows to be updated on next redisplay. */
12708 update_overlay_arrows (int up_to_date
)
12712 for (vlist
= Voverlay_arrow_variable_list
;
12714 vlist
= XCDR (vlist
))
12716 Lisp_Object var
= XCAR (vlist
);
12718 if (!SYMBOLP (var
))
12721 if (up_to_date
> 0)
12723 Lisp_Object val
= find_symbol_value (var
);
12724 Fput (var
, Qlast_arrow_position
,
12725 COERCE_MARKER (val
));
12726 Fput (var
, Qlast_arrow_string
,
12727 overlay_arrow_string_or_property (var
));
12729 else if (up_to_date
< 0
12730 || !NILP (Fget (var
, Qlast_arrow_position
)))
12732 Fput (var
, Qlast_arrow_position
, Qt
);
12733 Fput (var
, Qlast_arrow_string
, Qt
);
12739 /* Return overlay arrow string to display at row.
12740 Return integer (bitmap number) for arrow bitmap in left fringe.
12741 Return nil if no overlay arrow. */
12744 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12748 for (vlist
= Voverlay_arrow_variable_list
;
12750 vlist
= XCDR (vlist
))
12752 Lisp_Object var
= XCAR (vlist
);
12755 if (!SYMBOLP (var
))
12758 val
= find_symbol_value (var
);
12761 && current_buffer
== XMARKER (val
)->buffer
12762 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12764 if (FRAME_WINDOW_P (it
->f
)
12765 /* FIXME: if ROW->reversed_p is set, this should test
12766 the right fringe, not the left one. */
12767 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12769 #ifdef HAVE_WINDOW_SYSTEM
12770 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12773 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12774 return make_number (fringe_bitmap
);
12777 return make_number (-1); /* Use default arrow bitmap */
12779 return overlay_arrow_string_or_property (var
);
12786 /* Return 1 if point moved out of or into a composition. Otherwise
12787 return 0. PREV_BUF and PREV_PT are the last point buffer and
12788 position. BUF and PT are the current point buffer and position. */
12791 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12792 struct buffer
*buf
, ptrdiff_t pt
)
12794 ptrdiff_t start
, end
;
12796 Lisp_Object buffer
;
12798 XSETBUFFER (buffer
, buf
);
12799 /* Check a composition at the last point if point moved within the
12801 if (prev_buf
== buf
)
12804 /* Point didn't move. */
12807 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12808 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12809 && COMPOSITION_VALID_P (start
, end
, prop
)
12810 && start
< prev_pt
&& end
> prev_pt
)
12811 /* The last point was within the composition. Return 1 iff
12812 point moved out of the composition. */
12813 return (pt
<= start
|| pt
>= end
);
12816 /* Check a composition at the current point. */
12817 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12818 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12819 && COMPOSITION_VALID_P (start
, end
, prop
)
12820 && start
< pt
&& end
> pt
);
12824 /* Reconsider the setting of B->clip_changed which is displayed
12828 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12830 if (b
->clip_changed
12831 && !NILP (w
->window_end_valid
)
12832 && w
->current_matrix
->buffer
== b
12833 && w
->current_matrix
->zv
== BUF_ZV (b
)
12834 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12835 b
->clip_changed
= 0;
12837 /* If display wasn't paused, and W is not a tool bar window, see if
12838 point has been moved into or out of a composition. In that case,
12839 we set b->clip_changed to 1 to force updating the screen. If
12840 b->clip_changed has already been set to 1, we can skip this
12842 if (!b
->clip_changed
12843 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12847 if (w
== XWINDOW (selected_window
))
12850 pt
= marker_position (w
->pointm
);
12852 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12853 || pt
!= w
->last_point
)
12854 && check_point_in_composition (w
->current_matrix
->buffer
,
12856 XBUFFER (w
->buffer
), pt
))
12857 b
->clip_changed
= 1;
12862 /* Select FRAME to forward the values of frame-local variables into C
12863 variables so that the redisplay routines can access those values
12867 select_frame_for_redisplay (Lisp_Object frame
)
12869 Lisp_Object tail
, tem
;
12870 Lisp_Object old
= selected_frame
;
12871 struct Lisp_Symbol
*sym
;
12873 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12875 selected_frame
= frame
;
12878 for (tail
= XFRAME (frame
)->param_alist
;
12879 CONSP (tail
); tail
= XCDR (tail
))
12880 if (CONSP (XCAR (tail
))
12881 && (tem
= XCAR (XCAR (tail
)),
12883 && (sym
= indirect_variable (XSYMBOL (tem
)),
12884 sym
->redirect
== SYMBOL_LOCALIZED
)
12885 && sym
->val
.blv
->frame_local
)
12886 /* Use find_symbol_value rather than Fsymbol_value
12887 to avoid an error if it is void. */
12888 find_symbol_value (tem
);
12889 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12893 #define STOP_POLLING \
12894 do { if (! polling_stopped_here) stop_polling (); \
12895 polling_stopped_here = 1; } while (0)
12897 #define RESUME_POLLING \
12898 do { if (polling_stopped_here) start_polling (); \
12899 polling_stopped_here = 0; } while (0)
12902 /* Perhaps in the future avoid recentering windows if it
12903 is not necessary; currently that causes some problems. */
12906 redisplay_internal (void)
12908 struct window
*w
= XWINDOW (selected_window
);
12912 int must_finish
= 0;
12913 struct text_pos tlbufpos
, tlendpos
;
12914 int number_of_visible_frames
;
12915 ptrdiff_t count
, count1
;
12917 int polling_stopped_here
= 0;
12918 Lisp_Object old_frame
= selected_frame
;
12920 /* Non-zero means redisplay has to consider all windows on all
12921 frames. Zero means, only selected_window is considered. */
12922 int consider_all_windows_p
;
12924 /* Non-zero means redisplay has to redisplay the miniwindow */
12925 int update_miniwindow_p
= 0;
12927 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12929 /* No redisplay if running in batch mode or frame is not yet fully
12930 initialized, or redisplay is explicitly turned off by setting
12931 Vinhibit_redisplay. */
12932 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12933 || !NILP (Vinhibit_redisplay
))
12936 /* Don't examine these until after testing Vinhibit_redisplay.
12937 When Emacs is shutting down, perhaps because its connection to
12938 X has dropped, we should not look at them at all. */
12939 fr
= XFRAME (w
->frame
);
12940 sf
= SELECTED_FRAME ();
12942 if (!fr
->glyphs_initialized_p
)
12945 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12946 if (popup_activated ())
12950 /* I don't think this happens but let's be paranoid. */
12951 if (redisplaying_p
)
12954 /* Record a function that resets redisplaying_p to its old value
12955 when we leave this function. */
12956 count
= SPECPDL_INDEX ();
12957 record_unwind_protect (unwind_redisplay
,
12958 Fcons (make_number (redisplaying_p
), selected_frame
));
12960 specbind (Qinhibit_free_realized_faces
, Qnil
);
12963 Lisp_Object tail
, frame
;
12965 FOR_EACH_FRAME (tail
, frame
)
12967 struct frame
*f
= XFRAME (frame
);
12968 f
->already_hscrolled_p
= 0;
12973 /* Remember the currently selected window. */
12976 if (!EQ (old_frame
, selected_frame
)
12977 && FRAME_LIVE_P (XFRAME (old_frame
)))
12978 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12979 selected_frame and selected_window to be temporarily out-of-sync so
12980 when we come back here via `goto retry', we need to resync because we
12981 may need to run Elisp code (via prepare_menu_bars). */
12982 select_frame_for_redisplay (old_frame
);
12985 reconsider_clip_changes (w
, current_buffer
);
12986 last_escape_glyph_frame
= NULL
;
12987 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12988 last_glyphless_glyph_frame
= NULL
;
12989 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12991 /* If new fonts have been loaded that make a glyph matrix adjustment
12992 necessary, do it. */
12993 if (fonts_changed_p
)
12995 adjust_glyphs (NULL
);
12996 ++windows_or_buffers_changed
;
12997 fonts_changed_p
= 0;
13000 /* If face_change_count is non-zero, init_iterator will free all
13001 realized faces, which includes the faces referenced from current
13002 matrices. So, we can't reuse current matrices in this case. */
13003 if (face_change_count
)
13004 ++windows_or_buffers_changed
;
13006 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13007 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13009 /* Since frames on a single ASCII terminal share the same
13010 display area, displaying a different frame means redisplay
13011 the whole thing. */
13012 windows_or_buffers_changed
++;
13013 SET_FRAME_GARBAGED (sf
);
13015 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13017 FRAME_TTY (sf
)->previous_frame
= sf
;
13020 /* Set the visible flags for all frames. Do this before checking
13021 for resized or garbaged frames; they want to know if their frames
13022 are visible. See the comment in frame.h for
13023 FRAME_SAMPLE_VISIBILITY. */
13025 Lisp_Object tail
, frame
;
13027 number_of_visible_frames
= 0;
13029 FOR_EACH_FRAME (tail
, frame
)
13031 struct frame
*f
= XFRAME (frame
);
13033 FRAME_SAMPLE_VISIBILITY (f
);
13034 if (FRAME_VISIBLE_P (f
))
13035 ++number_of_visible_frames
;
13036 clear_desired_matrices (f
);
13040 /* Notice any pending interrupt request to change frame size. */
13041 do_pending_window_change (1);
13043 /* do_pending_window_change could change the selected_window due to
13044 frame resizing which makes the selected window too small. */
13045 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13048 reconsider_clip_changes (w
, current_buffer
);
13051 /* Clear frames marked as garbaged. */
13052 if (frame_garbaged
)
13053 clear_garbaged_frames ();
13055 /* Build menubar and tool-bar items. */
13056 if (NILP (Vmemory_full
))
13057 prepare_menu_bars ();
13059 if (windows_or_buffers_changed
)
13060 update_mode_lines
++;
13062 /* Detect case that we need to write or remove a star in the mode line. */
13063 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13065 w
->update_mode_line
= 1;
13066 if (buffer_shared
> 1)
13067 update_mode_lines
++;
13070 /* Avoid invocation of point motion hooks by `current_column' below. */
13071 count1
= SPECPDL_INDEX ();
13072 specbind (Qinhibit_point_motion_hooks
, Qt
);
13074 /* If %c is in the mode line, update it if needed. */
13075 if (!NILP (w
->column_number_displayed
)
13076 /* This alternative quickly identifies a common case
13077 where no change is needed. */
13078 && !(PT
== w
->last_point
13079 && w
->last_modified
>= MODIFF
13080 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13081 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13082 w
->update_mode_line
= 1;
13084 unbind_to (count1
, Qnil
);
13086 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13088 /* The variable buffer_shared is set in redisplay_window and
13089 indicates that we redisplay a buffer in different windows. See
13091 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13092 || cursor_type_changed
);
13094 /* If specs for an arrow have changed, do thorough redisplay
13095 to ensure we remove any arrow that should no longer exist. */
13096 if (overlay_arrows_changed_p ())
13097 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13099 /* Normally the message* functions will have already displayed and
13100 updated the echo area, but the frame may have been trashed, or
13101 the update may have been preempted, so display the echo area
13102 again here. Checking message_cleared_p captures the case that
13103 the echo area should be cleared. */
13104 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13105 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13106 || (message_cleared_p
13107 && minibuf_level
== 0
13108 /* If the mini-window is currently selected, this means the
13109 echo-area doesn't show through. */
13110 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13112 int window_height_changed_p
= echo_area_display (0);
13114 if (message_cleared_p
)
13115 update_miniwindow_p
= 1;
13119 /* If we don't display the current message, don't clear the
13120 message_cleared_p flag, because, if we did, we wouldn't clear
13121 the echo area in the next redisplay which doesn't preserve
13123 if (!display_last_displayed_message_p
)
13124 message_cleared_p
= 0;
13126 if (fonts_changed_p
)
13128 else if (window_height_changed_p
)
13130 consider_all_windows_p
= 1;
13131 ++update_mode_lines
;
13132 ++windows_or_buffers_changed
;
13134 /* If window configuration was changed, frames may have been
13135 marked garbaged. Clear them or we will experience
13136 surprises wrt scrolling. */
13137 if (frame_garbaged
)
13138 clear_garbaged_frames ();
13141 else if (EQ (selected_window
, minibuf_window
)
13142 && (current_buffer
->clip_changed
13143 || w
->last_modified
< MODIFF
13144 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13145 && resize_mini_window (w
, 0))
13147 /* Resized active mini-window to fit the size of what it is
13148 showing if its contents might have changed. */
13150 /* FIXME: this causes all frames to be updated, which seems unnecessary
13151 since only the current frame needs to be considered. This function needs
13152 to be rewritten with two variables, consider_all_windows and
13153 consider_all_frames. */
13154 consider_all_windows_p
= 1;
13155 ++windows_or_buffers_changed
;
13156 ++update_mode_lines
;
13158 /* If window configuration was changed, frames may have been
13159 marked garbaged. Clear them or we will experience
13160 surprises wrt scrolling. */
13161 if (frame_garbaged
)
13162 clear_garbaged_frames ();
13166 /* If showing the region, and mark has changed, we must redisplay
13167 the whole window. The assignment to this_line_start_pos prevents
13168 the optimization directly below this if-statement. */
13169 if (((!NILP (Vtransient_mark_mode
)
13170 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13171 != !NILP (w
->region_showing
))
13172 || (!NILP (w
->region_showing
)
13173 && !EQ (w
->region_showing
,
13174 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13175 CHARPOS (this_line_start_pos
) = 0;
13177 /* Optimize the case that only the line containing the cursor in the
13178 selected window has changed. Variables starting with this_ are
13179 set in display_line and record information about the line
13180 containing the cursor. */
13181 tlbufpos
= this_line_start_pos
;
13182 tlendpos
= this_line_end_pos
;
13183 if (!consider_all_windows_p
13184 && CHARPOS (tlbufpos
) > 0
13185 && !w
->update_mode_line
13186 && !current_buffer
->clip_changed
13187 && !current_buffer
->prevent_redisplay_optimizations_p
13188 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13189 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13190 /* Make sure recorded data applies to current buffer, etc. */
13191 && this_line_buffer
== current_buffer
13192 && current_buffer
== XBUFFER (w
->buffer
)
13194 && !w
->optional_new_start
13195 /* Point must be on the line that we have info recorded about. */
13196 && PT
>= CHARPOS (tlbufpos
)
13197 && PT
<= Z
- CHARPOS (tlendpos
)
13198 /* All text outside that line, including its final newline,
13199 must be unchanged. */
13200 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13201 CHARPOS (tlendpos
)))
13203 if (CHARPOS (tlbufpos
) > BEGV
13204 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13205 && (CHARPOS (tlbufpos
) == ZV
13206 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13207 /* Former continuation line has disappeared by becoming empty. */
13209 else if (w
->last_modified
< MODIFF
13210 || w
->last_overlay_modified
< OVERLAY_MODIFF
13211 || MINI_WINDOW_P (w
))
13213 /* We have to handle the case of continuation around a
13214 wide-column character (see the comment in indent.c around
13217 For instance, in the following case:
13219 -------- Insert --------
13220 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13221 J_I_ ==> J_I_ `^^' are cursors.
13225 As we have to redraw the line above, we cannot use this
13229 int line_height_before
= this_line_pixel_height
;
13231 /* Note that start_display will handle the case that the
13232 line starting at tlbufpos is a continuation line. */
13233 start_display (&it
, w
, tlbufpos
);
13235 /* Implementation note: It this still necessary? */
13236 if (it
.current_x
!= this_line_start_x
)
13239 TRACE ((stderr
, "trying display optimization 1\n"));
13240 w
->cursor
.vpos
= -1;
13241 overlay_arrow_seen
= 0;
13242 it
.vpos
= this_line_vpos
;
13243 it
.current_y
= this_line_y
;
13244 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13245 display_line (&it
);
13247 /* If line contains point, is not continued,
13248 and ends at same distance from eob as before, we win. */
13249 if (w
->cursor
.vpos
>= 0
13250 /* Line is not continued, otherwise this_line_start_pos
13251 would have been set to 0 in display_line. */
13252 && CHARPOS (this_line_start_pos
)
13253 /* Line ends as before. */
13254 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13255 /* Line has same height as before. Otherwise other lines
13256 would have to be shifted up or down. */
13257 && this_line_pixel_height
== line_height_before
)
13259 /* If this is not the window's last line, we must adjust
13260 the charstarts of the lines below. */
13261 if (it
.current_y
< it
.last_visible_y
)
13263 struct glyph_row
*row
13264 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13265 ptrdiff_t delta
, delta_bytes
;
13267 /* We used to distinguish between two cases here,
13268 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13269 when the line ends in a newline or the end of the
13270 buffer's accessible portion. But both cases did
13271 the same, so they were collapsed. */
13273 - CHARPOS (tlendpos
)
13274 - MATRIX_ROW_START_CHARPOS (row
));
13275 delta_bytes
= (Z_BYTE
13276 - BYTEPOS (tlendpos
)
13277 - MATRIX_ROW_START_BYTEPOS (row
));
13279 increment_matrix_positions (w
->current_matrix
,
13280 this_line_vpos
+ 1,
13281 w
->current_matrix
->nrows
,
13282 delta
, delta_bytes
);
13285 /* If this row displays text now but previously didn't,
13286 or vice versa, w->window_end_vpos may have to be
13288 if ((it
.glyph_row
- 1)->displays_text_p
)
13290 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13291 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13293 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13294 && this_line_vpos
> 0)
13295 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13296 wset_window_end_valid (w
, Qnil
);
13298 /* Update hint: No need to try to scroll in update_window. */
13299 w
->desired_matrix
->no_scrolling_p
= 1;
13302 *w
->desired_matrix
->method
= 0;
13303 debug_method_add (w
, "optimization 1");
13305 #ifdef HAVE_WINDOW_SYSTEM
13306 update_window_fringes (w
, 0);
13313 else if (/* Cursor position hasn't changed. */
13314 PT
== w
->last_point
13315 /* Make sure the cursor was last displayed
13316 in this window. Otherwise we have to reposition it. */
13317 && 0 <= w
->cursor
.vpos
13318 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13322 do_pending_window_change (1);
13323 /* If selected_window changed, redisplay again. */
13324 if (WINDOWP (selected_window
)
13325 && (w
= XWINDOW (selected_window
)) != sw
)
13328 /* We used to always goto end_of_redisplay here, but this
13329 isn't enough if we have a blinking cursor. */
13330 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13331 goto end_of_redisplay
;
13335 /* If highlighting the region, or if the cursor is in the echo area,
13336 then we can't just move the cursor. */
13337 else if (! (!NILP (Vtransient_mark_mode
)
13338 && !NILP (BVAR (current_buffer
, mark_active
)))
13339 && (EQ (selected_window
,
13340 BVAR (current_buffer
, last_selected_window
))
13341 || highlight_nonselected_windows
)
13342 && NILP (w
->region_showing
)
13343 && NILP (Vshow_trailing_whitespace
)
13344 && !cursor_in_echo_area
)
13347 struct glyph_row
*row
;
13349 /* Skip from tlbufpos to PT and see where it is. Note that
13350 PT may be in invisible text. If so, we will end at the
13351 next visible position. */
13352 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13353 NULL
, DEFAULT_FACE_ID
);
13354 it
.current_x
= this_line_start_x
;
13355 it
.current_y
= this_line_y
;
13356 it
.vpos
= this_line_vpos
;
13358 /* The call to move_it_to stops in front of PT, but
13359 moves over before-strings. */
13360 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13362 if (it
.vpos
== this_line_vpos
13363 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13366 eassert (this_line_vpos
== it
.vpos
);
13367 eassert (this_line_y
== it
.current_y
);
13368 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13370 *w
->desired_matrix
->method
= 0;
13371 debug_method_add (w
, "optimization 3");
13380 /* Text changed drastically or point moved off of line. */
13381 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13384 CHARPOS (this_line_start_pos
) = 0;
13385 consider_all_windows_p
|= buffer_shared
> 1;
13386 ++clear_face_cache_count
;
13387 #ifdef HAVE_WINDOW_SYSTEM
13388 ++clear_image_cache_count
;
13391 /* Build desired matrices, and update the display. If
13392 consider_all_windows_p is non-zero, do it for all windows on all
13393 frames. Otherwise do it for selected_window, only. */
13395 if (consider_all_windows_p
)
13397 Lisp_Object tail
, frame
;
13399 FOR_EACH_FRAME (tail
, frame
)
13400 XFRAME (frame
)->updated_p
= 0;
13402 /* Recompute # windows showing selected buffer. This will be
13403 incremented each time such a window is displayed. */
13406 FOR_EACH_FRAME (tail
, frame
)
13408 struct frame
*f
= XFRAME (frame
);
13410 /* We don't have to do anything for unselected terminal
13412 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13413 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13416 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13418 if (! EQ (frame
, selected_frame
))
13419 /* Select the frame, for the sake of frame-local
13421 select_frame_for_redisplay (frame
);
13423 /* Mark all the scroll bars to be removed; we'll redeem
13424 the ones we want when we redisplay their windows. */
13425 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13426 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13428 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13429 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13431 /* The X error handler may have deleted that frame. */
13432 if (!FRAME_LIVE_P (f
))
13435 /* Any scroll bars which redisplay_windows should have
13436 nuked should now go away. */
13437 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13438 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13440 /* If fonts changed, display again. */
13441 /* ??? rms: I suspect it is a mistake to jump all the way
13442 back to retry here. It should just retry this frame. */
13443 if (fonts_changed_p
)
13446 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13448 /* See if we have to hscroll. */
13449 if (!f
->already_hscrolled_p
)
13451 f
->already_hscrolled_p
= 1;
13452 if (hscroll_windows (f
->root_window
))
13456 /* Prevent various kinds of signals during display
13457 update. stdio is not robust about handling
13458 signals, which can cause an apparent I/O
13460 if (interrupt_input
)
13461 unrequest_sigio ();
13464 /* Update the display. */
13465 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13466 pending
|= update_frame (f
, 0, 0);
13472 if (!EQ (old_frame
, selected_frame
)
13473 && FRAME_LIVE_P (XFRAME (old_frame
)))
13474 /* We played a bit fast-and-loose above and allowed selected_frame
13475 and selected_window to be temporarily out-of-sync but let's make
13476 sure this stays contained. */
13477 select_frame_for_redisplay (old_frame
);
13478 eassert (EQ (XFRAME (selected_frame
)->selected_window
,
13483 /* Do the mark_window_display_accurate after all windows have
13484 been redisplayed because this call resets flags in buffers
13485 which are needed for proper redisplay. */
13486 FOR_EACH_FRAME (tail
, frame
)
13488 struct frame
*f
= XFRAME (frame
);
13491 mark_window_display_accurate (f
->root_window
, 1);
13492 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13493 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13498 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13500 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13501 struct frame
*mini_frame
;
13503 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13504 /* Use list_of_error, not Qerror, so that
13505 we catch only errors and don't run the debugger. */
13506 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13508 redisplay_window_error
);
13509 if (update_miniwindow_p
)
13510 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13512 redisplay_window_error
);
13514 /* Compare desired and current matrices, perform output. */
13517 /* If fonts changed, display again. */
13518 if (fonts_changed_p
)
13521 /* Prevent various kinds of signals during display update.
13522 stdio is not robust about handling signals,
13523 which can cause an apparent I/O error. */
13524 if (interrupt_input
)
13525 unrequest_sigio ();
13528 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13530 if (hscroll_windows (selected_window
))
13533 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13534 pending
= update_frame (sf
, 0, 0);
13537 /* We may have called echo_area_display at the top of this
13538 function. If the echo area is on another frame, that may
13539 have put text on a frame other than the selected one, so the
13540 above call to update_frame would not have caught it. Catch
13542 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13543 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13545 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13547 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13548 pending
|= update_frame (mini_frame
, 0, 0);
13549 if (!pending
&& hscroll_windows (mini_window
))
13554 /* If display was paused because of pending input, make sure we do a
13555 thorough update the next time. */
13558 /* Prevent the optimization at the beginning of
13559 redisplay_internal that tries a single-line update of the
13560 line containing the cursor in the selected window. */
13561 CHARPOS (this_line_start_pos
) = 0;
13563 /* Let the overlay arrow be updated the next time. */
13564 update_overlay_arrows (0);
13566 /* If we pause after scrolling, some rows in the current
13567 matrices of some windows are not valid. */
13568 if (!WINDOW_FULL_WIDTH_P (w
)
13569 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13570 update_mode_lines
= 1;
13574 if (!consider_all_windows_p
)
13576 /* This has already been done above if
13577 consider_all_windows_p is set. */
13578 mark_window_display_accurate_1 (w
, 1);
13580 /* Say overlay arrows are up to date. */
13581 update_overlay_arrows (1);
13583 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13584 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13587 update_mode_lines
= 0;
13588 windows_or_buffers_changed
= 0;
13589 cursor_type_changed
= 0;
13592 /* Start SIGIO interrupts coming again. Having them off during the
13593 code above makes it less likely one will discard output, but not
13594 impossible, since there might be stuff in the system buffer here.
13595 But it is much hairier to try to do anything about that. */
13596 if (interrupt_input
)
13600 /* If a frame has become visible which was not before, redisplay
13601 again, so that we display it. Expose events for such a frame
13602 (which it gets when becoming visible) don't call the parts of
13603 redisplay constructing glyphs, so simply exposing a frame won't
13604 display anything in this case. So, we have to display these
13605 frames here explicitly. */
13608 Lisp_Object tail
, frame
;
13611 FOR_EACH_FRAME (tail
, frame
)
13613 int this_is_visible
= 0;
13615 if (XFRAME (frame
)->visible
)
13616 this_is_visible
= 1;
13617 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13618 if (XFRAME (frame
)->visible
)
13619 this_is_visible
= 1;
13621 if (this_is_visible
)
13625 if (new_count
!= number_of_visible_frames
)
13626 windows_or_buffers_changed
++;
13629 /* Change frame size now if a change is pending. */
13630 do_pending_window_change (1);
13632 /* If we just did a pending size change, or have additional
13633 visible frames, or selected_window changed, redisplay again. */
13634 if ((windows_or_buffers_changed
&& !pending
)
13635 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13638 /* Clear the face and image caches.
13640 We used to do this only if consider_all_windows_p. But the cache
13641 needs to be cleared if a timer creates images in the current
13642 buffer (e.g. the test case in Bug#6230). */
13644 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13646 clear_face_cache (0);
13647 clear_face_cache_count
= 0;
13650 #ifdef HAVE_WINDOW_SYSTEM
13651 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13653 clear_image_caches (Qnil
);
13654 clear_image_cache_count
= 0;
13656 #endif /* HAVE_WINDOW_SYSTEM */
13659 unbind_to (count
, Qnil
);
13664 /* Redisplay, but leave alone any recent echo area message unless
13665 another message has been requested in its place.
13667 This is useful in situations where you need to redisplay but no
13668 user action has occurred, making it inappropriate for the message
13669 area to be cleared. See tracking_off and
13670 wait_reading_process_output for examples of these situations.
13672 FROM_WHERE is an integer saying from where this function was
13673 called. This is useful for debugging. */
13676 redisplay_preserve_echo_area (int from_where
)
13678 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13680 if (!NILP (echo_area_buffer
[1]))
13682 /* We have a previously displayed message, but no current
13683 message. Redisplay the previous message. */
13684 display_last_displayed_message_p
= 1;
13685 redisplay_internal ();
13686 display_last_displayed_message_p
= 0;
13689 redisplay_internal ();
13691 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13692 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13693 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13697 /* Function registered with record_unwind_protect in
13698 redisplay_internal. Reset redisplaying_p to the value it had
13699 before redisplay_internal was called, and clear
13700 prevent_freeing_realized_faces_p. It also selects the previously
13701 selected frame, unless it has been deleted (by an X connection
13702 failure during redisplay, for example). */
13705 unwind_redisplay (Lisp_Object val
)
13707 Lisp_Object old_redisplaying_p
, old_frame
;
13709 old_redisplaying_p
= XCAR (val
);
13710 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13711 old_frame
= XCDR (val
);
13712 if (! EQ (old_frame
, selected_frame
)
13713 && FRAME_LIVE_P (XFRAME (old_frame
)))
13714 select_frame_for_redisplay (old_frame
);
13719 /* Mark the display of window W as accurate or inaccurate. If
13720 ACCURATE_P is non-zero mark display of W as accurate. If
13721 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13722 redisplay_internal is called. */
13725 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13727 if (BUFFERP (w
->buffer
))
13729 struct buffer
*b
= XBUFFER (w
->buffer
);
13731 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13732 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13734 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13738 b
->clip_changed
= 0;
13739 b
->prevent_redisplay_optimizations_p
= 0;
13741 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13742 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13743 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13744 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13746 w
->current_matrix
->buffer
= b
;
13747 w
->current_matrix
->begv
= BUF_BEGV (b
);
13748 w
->current_matrix
->zv
= BUF_ZV (b
);
13750 w
->last_cursor
= w
->cursor
;
13751 w
->last_cursor_off_p
= w
->cursor_off_p
;
13753 if (w
== XWINDOW (selected_window
))
13754 w
->last_point
= BUF_PT (b
);
13756 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13762 wset_window_end_valid (w
, w
->buffer
);
13763 w
->update_mode_line
= 0;
13768 /* Mark the display of windows in the window tree rooted at WINDOW as
13769 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13770 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13771 be redisplayed the next time redisplay_internal is called. */
13774 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13778 for (; !NILP (window
); window
= w
->next
)
13780 w
= XWINDOW (window
);
13781 mark_window_display_accurate_1 (w
, accurate_p
);
13783 if (!NILP (w
->vchild
))
13784 mark_window_display_accurate (w
->vchild
, accurate_p
);
13785 if (!NILP (w
->hchild
))
13786 mark_window_display_accurate (w
->hchild
, accurate_p
);
13791 update_overlay_arrows (1);
13795 /* Force a thorough redisplay the next time by setting
13796 last_arrow_position and last_arrow_string to t, which is
13797 unequal to any useful value of Voverlay_arrow_... */
13798 update_overlay_arrows (-1);
13803 /* Return value in display table DP (Lisp_Char_Table *) for character
13804 C. Since a display table doesn't have any parent, we don't have to
13805 follow parent. Do not call this function directly but use the
13806 macro DISP_CHAR_VECTOR. */
13809 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13813 if (ASCII_CHAR_P (c
))
13816 if (SUB_CHAR_TABLE_P (val
))
13817 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13823 XSETCHAR_TABLE (table
, dp
);
13824 val
= char_table_ref (table
, c
);
13833 /***********************************************************************
13835 ***********************************************************************/
13837 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13840 redisplay_windows (Lisp_Object window
)
13842 while (!NILP (window
))
13844 struct window
*w
= XWINDOW (window
);
13846 if (!NILP (w
->hchild
))
13847 redisplay_windows (w
->hchild
);
13848 else if (!NILP (w
->vchild
))
13849 redisplay_windows (w
->vchild
);
13850 else if (!NILP (w
->buffer
))
13852 displayed_buffer
= XBUFFER (w
->buffer
);
13853 /* Use list_of_error, not Qerror, so that
13854 we catch only errors and don't run the debugger. */
13855 internal_condition_case_1 (redisplay_window_0
, window
,
13857 redisplay_window_error
);
13865 redisplay_window_error (Lisp_Object ignore
)
13867 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13872 redisplay_window_0 (Lisp_Object window
)
13874 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13875 redisplay_window (window
, 0);
13880 redisplay_window_1 (Lisp_Object window
)
13882 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13883 redisplay_window (window
, 1);
13888 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13889 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13890 which positions recorded in ROW differ from current buffer
13893 Return 0 if cursor is not on this row, 1 otherwise. */
13896 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13897 struct glyph_matrix
*matrix
,
13898 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13901 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13902 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13903 struct glyph
*cursor
= NULL
;
13904 /* The last known character position in row. */
13905 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13907 ptrdiff_t pt_old
= PT
- delta
;
13908 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13909 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13910 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13911 /* A glyph beyond the edge of TEXT_AREA which we should never
13913 struct glyph
*glyphs_end
= end
;
13914 /* Non-zero means we've found a match for cursor position, but that
13915 glyph has the avoid_cursor_p flag set. */
13916 int match_with_avoid_cursor
= 0;
13917 /* Non-zero means we've seen at least one glyph that came from a
13919 int string_seen
= 0;
13920 /* Largest and smallest buffer positions seen so far during scan of
13922 ptrdiff_t bpos_max
= pos_before
;
13923 ptrdiff_t bpos_min
= pos_after
;
13924 /* Last buffer position covered by an overlay string with an integer
13925 `cursor' property. */
13926 ptrdiff_t bpos_covered
= 0;
13927 /* Non-zero means the display string on which to display the cursor
13928 comes from a text property, not from an overlay. */
13929 int string_from_text_prop
= 0;
13931 /* Don't even try doing anything if called for a mode-line or
13932 header-line row, since the rest of the code isn't prepared to
13933 deal with such calamities. */
13934 eassert (!row
->mode_line_p
);
13935 if (row
->mode_line_p
)
13938 /* Skip over glyphs not having an object at the start and the end of
13939 the row. These are special glyphs like truncation marks on
13940 terminal frames. */
13941 if (row
->displays_text_p
)
13943 if (!row
->reversed_p
)
13946 && INTEGERP (glyph
->object
)
13947 && glyph
->charpos
< 0)
13949 x
+= glyph
->pixel_width
;
13953 && INTEGERP ((end
- 1)->object
)
13954 /* CHARPOS is zero for blanks and stretch glyphs
13955 inserted by extend_face_to_end_of_line. */
13956 && (end
- 1)->charpos
<= 0)
13958 glyph_before
= glyph
- 1;
13965 /* If the glyph row is reversed, we need to process it from back
13966 to front, so swap the edge pointers. */
13967 glyphs_end
= end
= glyph
- 1;
13968 glyph
+= row
->used
[TEXT_AREA
] - 1;
13970 while (glyph
> end
+ 1
13971 && INTEGERP (glyph
->object
)
13972 && glyph
->charpos
< 0)
13975 x
-= glyph
->pixel_width
;
13977 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13979 /* By default, in reversed rows we put the cursor on the
13980 rightmost (first in the reading order) glyph. */
13981 for (g
= end
+ 1; g
< glyph
; g
++)
13982 x
+= g
->pixel_width
;
13984 && INTEGERP ((end
+ 1)->object
)
13985 && (end
+ 1)->charpos
<= 0)
13987 glyph_before
= glyph
+ 1;
13991 else if (row
->reversed_p
)
13993 /* In R2L rows that don't display text, put the cursor on the
13994 rightmost glyph. Case in point: an empty last line that is
13995 part of an R2L paragraph. */
13997 /* Avoid placing the cursor on the last glyph of the row, where
13998 on terminal frames we hold the vertical border between
13999 adjacent windows. */
14000 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14001 && !WINDOW_RIGHTMOST_P (w
)
14002 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14004 x
= -1; /* will be computed below, at label compute_x */
14007 /* Step 1: Try to find the glyph whose character position
14008 corresponds to point. If that's not possible, find 2 glyphs
14009 whose character positions are the closest to point, one before
14010 point, the other after it. */
14011 if (!row
->reversed_p
)
14012 while (/* not marched to end of glyph row */
14014 /* glyph was not inserted by redisplay for internal purposes */
14015 && !INTEGERP (glyph
->object
))
14017 if (BUFFERP (glyph
->object
))
14019 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14021 if (glyph
->charpos
> bpos_max
)
14022 bpos_max
= glyph
->charpos
;
14023 if (glyph
->charpos
< bpos_min
)
14024 bpos_min
= glyph
->charpos
;
14025 if (!glyph
->avoid_cursor_p
)
14027 /* If we hit point, we've found the glyph on which to
14028 display the cursor. */
14031 match_with_avoid_cursor
= 0;
14034 /* See if we've found a better approximation to
14035 POS_BEFORE or to POS_AFTER. */
14036 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14038 pos_before
= glyph
->charpos
;
14039 glyph_before
= glyph
;
14041 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14043 pos_after
= glyph
->charpos
;
14044 glyph_after
= glyph
;
14047 else if (dpos
== 0)
14048 match_with_avoid_cursor
= 1;
14050 else if (STRINGP (glyph
->object
))
14052 Lisp_Object chprop
;
14053 ptrdiff_t glyph_pos
= glyph
->charpos
;
14055 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14057 if (!NILP (chprop
))
14059 /* If the string came from a `display' text property,
14060 look up the buffer position of that property and
14061 use that position to update bpos_max, as if we
14062 actually saw such a position in one of the row's
14063 glyphs. This helps with supporting integer values
14064 of `cursor' property on the display string in
14065 situations where most or all of the row's buffer
14066 text is completely covered by display properties,
14067 so that no glyph with valid buffer positions is
14068 ever seen in the row. */
14069 ptrdiff_t prop_pos
=
14070 string_buffer_position_lim (glyph
->object
, pos_before
,
14073 if (prop_pos
>= pos_before
)
14074 bpos_max
= prop_pos
- 1;
14076 if (INTEGERP (chprop
))
14078 bpos_covered
= bpos_max
+ XINT (chprop
);
14079 /* If the `cursor' property covers buffer positions up
14080 to and including point, we should display cursor on
14081 this glyph. Note that, if a `cursor' property on one
14082 of the string's characters has an integer value, we
14083 will break out of the loop below _before_ we get to
14084 the position match above. IOW, integer values of
14085 the `cursor' property override the "exact match for
14086 point" strategy of positioning the cursor. */
14087 /* Implementation note: bpos_max == pt_old when, e.g.,
14088 we are in an empty line, where bpos_max is set to
14089 MATRIX_ROW_START_CHARPOS, see above. */
14090 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14099 x
+= glyph
->pixel_width
;
14102 else if (glyph
> end
) /* row is reversed */
14103 while (!INTEGERP (glyph
->object
))
14105 if (BUFFERP (glyph
->object
))
14107 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14109 if (glyph
->charpos
> bpos_max
)
14110 bpos_max
= glyph
->charpos
;
14111 if (glyph
->charpos
< bpos_min
)
14112 bpos_min
= glyph
->charpos
;
14113 if (!glyph
->avoid_cursor_p
)
14117 match_with_avoid_cursor
= 0;
14120 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14122 pos_before
= glyph
->charpos
;
14123 glyph_before
= glyph
;
14125 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14127 pos_after
= glyph
->charpos
;
14128 glyph_after
= glyph
;
14131 else if (dpos
== 0)
14132 match_with_avoid_cursor
= 1;
14134 else if (STRINGP (glyph
->object
))
14136 Lisp_Object chprop
;
14137 ptrdiff_t glyph_pos
= glyph
->charpos
;
14139 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14141 if (!NILP (chprop
))
14143 ptrdiff_t prop_pos
=
14144 string_buffer_position_lim (glyph
->object
, pos_before
,
14147 if (prop_pos
>= pos_before
)
14148 bpos_max
= prop_pos
- 1;
14150 if (INTEGERP (chprop
))
14152 bpos_covered
= bpos_max
+ XINT (chprop
);
14153 /* If the `cursor' property covers buffer positions up
14154 to and including point, we should display cursor on
14156 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14165 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14167 x
--; /* can't use any pixel_width */
14170 x
-= glyph
->pixel_width
;
14173 /* Step 2: If we didn't find an exact match for point, we need to
14174 look for a proper place to put the cursor among glyphs between
14175 GLYPH_BEFORE and GLYPH_AFTER. */
14176 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14177 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14178 && bpos_covered
< pt_old
)
14180 /* An empty line has a single glyph whose OBJECT is zero and
14181 whose CHARPOS is the position of a newline on that line.
14182 Note that on a TTY, there are more glyphs after that, which
14183 were produced by extend_face_to_end_of_line, but their
14184 CHARPOS is zero or negative. */
14186 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14187 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14189 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14191 ptrdiff_t ellipsis_pos
;
14193 /* Scan back over the ellipsis glyphs. */
14194 if (!row
->reversed_p
)
14196 ellipsis_pos
= (glyph
- 1)->charpos
;
14197 while (glyph
> row
->glyphs
[TEXT_AREA
]
14198 && (glyph
- 1)->charpos
== ellipsis_pos
)
14199 glyph
--, x
-= glyph
->pixel_width
;
14200 /* That loop always goes one position too far, including
14201 the glyph before the ellipsis. So scan forward over
14203 x
+= glyph
->pixel_width
;
14206 else /* row is reversed */
14208 ellipsis_pos
= (glyph
+ 1)->charpos
;
14209 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14210 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14211 glyph
++, x
+= glyph
->pixel_width
;
14212 x
-= glyph
->pixel_width
;
14216 else if (match_with_avoid_cursor
)
14218 cursor
= glyph_after
;
14221 else if (string_seen
)
14223 int incr
= row
->reversed_p
? -1 : +1;
14225 /* Need to find the glyph that came out of a string which is
14226 present at point. That glyph is somewhere between
14227 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14228 positioned between POS_BEFORE and POS_AFTER in the
14230 struct glyph
*start
, *stop
;
14231 ptrdiff_t pos
= pos_before
;
14235 /* If the row ends in a newline from a display string,
14236 reordering could have moved the glyphs belonging to the
14237 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14238 in this case we extend the search to the last glyph in
14239 the row that was not inserted by redisplay. */
14240 if (row
->ends_in_newline_from_string_p
)
14243 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14246 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14247 correspond to POS_BEFORE and POS_AFTER, respectively. We
14248 need START and STOP in the order that corresponds to the
14249 row's direction as given by its reversed_p flag. If the
14250 directionality of characters between POS_BEFORE and
14251 POS_AFTER is the opposite of the row's base direction,
14252 these characters will have been reordered for display,
14253 and we need to reverse START and STOP. */
14254 if (!row
->reversed_p
)
14256 start
= min (glyph_before
, glyph_after
);
14257 stop
= max (glyph_before
, glyph_after
);
14261 start
= max (glyph_before
, glyph_after
);
14262 stop
= min (glyph_before
, glyph_after
);
14264 for (glyph
= start
+ incr
;
14265 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14268 /* Any glyphs that come from the buffer are here because
14269 of bidi reordering. Skip them, and only pay
14270 attention to glyphs that came from some string. */
14271 if (STRINGP (glyph
->object
))
14275 /* If the display property covers the newline, we
14276 need to search for it one position farther. */
14277 ptrdiff_t lim
= pos_after
14278 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14280 string_from_text_prop
= 0;
14281 str
= glyph
->object
;
14282 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14283 if (tem
== 0 /* from overlay */
14286 /* If the string from which this glyph came is
14287 found in the buffer at point, or at position
14288 that is closer to point than pos_after, then
14289 we've found the glyph we've been looking for.
14290 If it comes from an overlay (tem == 0), and
14291 it has the `cursor' property on one of its
14292 glyphs, record that glyph as a candidate for
14293 displaying the cursor. (As in the
14294 unidirectional version, we will display the
14295 cursor on the last candidate we find.) */
14298 || (tem
- pt_old
> 0 && tem
< pos_after
))
14300 /* The glyphs from this string could have
14301 been reordered. Find the one with the
14302 smallest string position. Or there could
14303 be a character in the string with the
14304 `cursor' property, which means display
14305 cursor on that character's glyph. */
14306 ptrdiff_t strpos
= glyph
->charpos
;
14311 string_from_text_prop
= 1;
14314 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14315 && EQ (glyph
->object
, str
);
14319 ptrdiff_t gpos
= glyph
->charpos
;
14321 cprop
= Fget_char_property (make_number (gpos
),
14329 if (tem
&& glyph
->charpos
< strpos
)
14331 strpos
= glyph
->charpos
;
14337 || (tem
- pt_old
> 0 && tem
< pos_after
))
14341 pos
= tem
+ 1; /* don't find previous instances */
14343 /* This string is not what we want; skip all of the
14344 glyphs that came from it. */
14345 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14346 && EQ (glyph
->object
, str
))
14353 /* If we reached the end of the line, and END was from a string,
14354 the cursor is not on this line. */
14356 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14357 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14358 && STRINGP (end
->object
)
14359 && row
->continued_p
)
14362 /* A truncated row may not include PT among its character positions.
14363 Setting the cursor inside the scroll margin will trigger
14364 recalculation of hscroll in hscroll_window_tree. But if a
14365 display string covers point, defer to the string-handling
14366 code below to figure this out. */
14367 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14369 cursor
= glyph_before
;
14372 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14373 /* Zero-width characters produce no glyphs. */
14375 && (row
->reversed_p
14376 ? glyph_after
> glyphs_end
14377 : glyph_after
< glyphs_end
)))
14379 cursor
= glyph_after
;
14385 if (cursor
!= NULL
)
14387 else if (glyph
== glyphs_end
14388 && pos_before
== pos_after
14389 && STRINGP ((row
->reversed_p
14390 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14391 : row
->glyphs
[TEXT_AREA
])->object
))
14393 /* If all the glyphs of this row came from strings, put the
14394 cursor on the first glyph of the row. This avoids having the
14395 cursor outside of the text area in this very rare and hard
14399 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14400 : row
->glyphs
[TEXT_AREA
];
14406 /* Need to compute x that corresponds to GLYPH. */
14407 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14409 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14411 x
+= g
->pixel_width
;
14415 /* ROW could be part of a continued line, which, under bidi
14416 reordering, might have other rows whose start and end charpos
14417 occlude point. Only set w->cursor if we found a better
14418 approximation to the cursor position than we have from previously
14419 examined candidate rows belonging to the same continued line. */
14420 if (/* we already have a candidate row */
14421 w
->cursor
.vpos
>= 0
14422 /* that candidate is not the row we are processing */
14423 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14424 /* Make sure cursor.vpos specifies a row whose start and end
14425 charpos occlude point, and it is valid candidate for being a
14426 cursor-row. This is because some callers of this function
14427 leave cursor.vpos at the row where the cursor was displayed
14428 during the last redisplay cycle. */
14429 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14430 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14431 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14434 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14436 /* Don't consider glyphs that are outside TEXT_AREA. */
14437 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14439 /* Keep the candidate whose buffer position is the closest to
14440 point or has the `cursor' property. */
14441 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14442 w
->cursor
.hpos
>= 0
14443 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14444 && ((BUFFERP (g1
->object
)
14445 && (g1
->charpos
== pt_old
/* an exact match always wins */
14446 || (BUFFERP (glyph
->object
)
14447 && eabs (g1
->charpos
- pt_old
)
14448 < eabs (glyph
->charpos
- pt_old
))))
14449 /* previous candidate is a glyph from a string that has
14450 a non-nil `cursor' property */
14451 || (STRINGP (g1
->object
)
14452 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14453 Qcursor
, g1
->object
))
14454 /* previous candidate is from the same display
14455 string as this one, and the display string
14456 came from a text property */
14457 || (EQ (g1
->object
, glyph
->object
)
14458 && string_from_text_prop
)
14459 /* this candidate is from newline and its
14460 position is not an exact match */
14461 || (INTEGERP (glyph
->object
)
14462 && glyph
->charpos
!= pt_old
)))))
14464 /* If this candidate gives an exact match, use that. */
14465 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14466 /* If this candidate is a glyph created for the
14467 terminating newline of a line, and point is on that
14468 newline, it wins because it's an exact match. */
14469 || (!row
->continued_p
14470 && INTEGERP (glyph
->object
)
14471 && glyph
->charpos
== 0
14472 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14473 /* Otherwise, keep the candidate that comes from a row
14474 spanning less buffer positions. This may win when one or
14475 both candidate positions are on glyphs that came from
14476 display strings, for which we cannot compare buffer
14478 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14479 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14480 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14483 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14485 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14486 w
->cursor
.y
= row
->y
+ dy
;
14488 if (w
== XWINDOW (selected_window
))
14490 if (!row
->continued_p
14491 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14494 this_line_buffer
= XBUFFER (w
->buffer
);
14496 CHARPOS (this_line_start_pos
)
14497 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14498 BYTEPOS (this_line_start_pos
)
14499 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14501 CHARPOS (this_line_end_pos
)
14502 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14503 BYTEPOS (this_line_end_pos
)
14504 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14506 this_line_y
= w
->cursor
.y
;
14507 this_line_pixel_height
= row
->height
;
14508 this_line_vpos
= w
->cursor
.vpos
;
14509 this_line_start_x
= row
->x
;
14512 CHARPOS (this_line_start_pos
) = 0;
14519 /* Run window scroll functions, if any, for WINDOW with new window
14520 start STARTP. Sets the window start of WINDOW to that position.
14522 We assume that the window's buffer is really current. */
14524 static inline struct text_pos
14525 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14527 struct window
*w
= XWINDOW (window
);
14528 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14530 if (current_buffer
!= XBUFFER (w
->buffer
))
14533 if (!NILP (Vwindow_scroll_functions
))
14535 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14536 make_number (CHARPOS (startp
)));
14537 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14538 /* In case the hook functions switch buffers. */
14539 if (current_buffer
!= XBUFFER (w
->buffer
))
14540 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14547 /* Make sure the line containing the cursor is fully visible.
14548 A value of 1 means there is nothing to be done.
14549 (Either the line is fully visible, or it cannot be made so,
14550 or we cannot tell.)
14552 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14553 is higher than window.
14555 A value of 0 means the caller should do scrolling
14556 as if point had gone off the screen. */
14559 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14561 struct glyph_matrix
*matrix
;
14562 struct glyph_row
*row
;
14565 if (!make_cursor_line_fully_visible_p
)
14568 /* It's not always possible to find the cursor, e.g, when a window
14569 is full of overlay strings. Don't do anything in that case. */
14570 if (w
->cursor
.vpos
< 0)
14573 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14574 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14576 /* If the cursor row is not partially visible, there's nothing to do. */
14577 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14580 /* If the row the cursor is in is taller than the window's height,
14581 it's not clear what to do, so do nothing. */
14582 window_height
= window_box_height (w
);
14583 if (row
->height
>= window_height
)
14585 if (!force_p
|| MINI_WINDOW_P (w
)
14586 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14593 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14594 non-zero means only WINDOW is redisplayed in redisplay_internal.
14595 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14596 in redisplay_window to bring a partially visible line into view in
14597 the case that only the cursor has moved.
14599 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14600 last screen line's vertical height extends past the end of the screen.
14604 1 if scrolling succeeded
14606 0 if scrolling didn't find point.
14608 -1 if new fonts have been loaded so that we must interrupt
14609 redisplay, adjust glyph matrices, and try again. */
14615 SCROLLING_NEED_LARGER_MATRICES
14618 /* If scroll-conservatively is more than this, never recenter.
14620 If you change this, don't forget to update the doc string of
14621 `scroll-conservatively' and the Emacs manual. */
14622 #define SCROLL_LIMIT 100
14625 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14626 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14627 int temp_scroll_step
, int last_line_misfit
)
14629 struct window
*w
= XWINDOW (window
);
14630 struct frame
*f
= XFRAME (w
->frame
);
14631 struct text_pos pos
, startp
;
14633 int this_scroll_margin
, scroll_max
, rc
, height
;
14634 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14635 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14636 Lisp_Object aggressive
;
14637 /* We will never try scrolling more than this number of lines. */
14638 int scroll_limit
= SCROLL_LIMIT
;
14641 debug_method_add (w
, "try_scrolling");
14644 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14646 /* Compute scroll margin height in pixels. We scroll when point is
14647 within this distance from the top or bottom of the window. */
14648 if (scroll_margin
> 0)
14649 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14650 * FRAME_LINE_HEIGHT (f
);
14652 this_scroll_margin
= 0;
14654 /* Force arg_scroll_conservatively to have a reasonable value, to
14655 avoid scrolling too far away with slow move_it_* functions. Note
14656 that the user can supply scroll-conservatively equal to
14657 `most-positive-fixnum', which can be larger than INT_MAX. */
14658 if (arg_scroll_conservatively
> scroll_limit
)
14660 arg_scroll_conservatively
= scroll_limit
+ 1;
14661 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14663 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14664 /* Compute how much we should try to scroll maximally to bring
14665 point into view. */
14666 scroll_max
= (max (scroll_step
,
14667 max (arg_scroll_conservatively
, temp_scroll_step
))
14668 * FRAME_LINE_HEIGHT (f
));
14669 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14670 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14671 /* We're trying to scroll because of aggressive scrolling but no
14672 scroll_step is set. Choose an arbitrary one. */
14673 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14679 /* Decide whether to scroll down. */
14680 if (PT
> CHARPOS (startp
))
14682 int scroll_margin_y
;
14684 /* Compute the pixel ypos of the scroll margin, then move IT to
14685 either that ypos or PT, whichever comes first. */
14686 start_display (&it
, w
, startp
);
14687 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14688 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14689 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14690 (MOVE_TO_POS
| MOVE_TO_Y
));
14692 if (PT
> CHARPOS (it
.current
.pos
))
14694 int y0
= line_bottom_y (&it
);
14695 /* Compute how many pixels below window bottom to stop searching
14696 for PT. This avoids costly search for PT that is far away if
14697 the user limited scrolling by a small number of lines, but
14698 always finds PT if scroll_conservatively is set to a large
14699 number, such as most-positive-fixnum. */
14700 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14701 int y_to_move
= it
.last_visible_y
+ slack
;
14703 /* Compute the distance from the scroll margin to PT or to
14704 the scroll limit, whichever comes first. This should
14705 include the height of the cursor line, to make that line
14707 move_it_to (&it
, PT
, -1, y_to_move
,
14708 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14709 dy
= line_bottom_y (&it
) - y0
;
14711 if (dy
> scroll_max
)
14712 return SCROLLING_FAILED
;
14721 /* Point is in or below the bottom scroll margin, so move the
14722 window start down. If scrolling conservatively, move it just
14723 enough down to make point visible. If scroll_step is set,
14724 move it down by scroll_step. */
14725 if (arg_scroll_conservatively
)
14727 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14728 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14729 else if (scroll_step
|| temp_scroll_step
)
14730 amount_to_scroll
= scroll_max
;
14733 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14734 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14735 if (NUMBERP (aggressive
))
14737 double float_amount
= XFLOATINT (aggressive
) * height
;
14738 amount_to_scroll
= float_amount
;
14739 if (amount_to_scroll
== 0 && float_amount
> 0)
14740 amount_to_scroll
= 1;
14741 /* Don't let point enter the scroll margin near top of
14743 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14744 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14748 if (amount_to_scroll
<= 0)
14749 return SCROLLING_FAILED
;
14751 start_display (&it
, w
, startp
);
14752 if (arg_scroll_conservatively
<= scroll_limit
)
14753 move_it_vertically (&it
, amount_to_scroll
);
14756 /* Extra precision for users who set scroll-conservatively
14757 to a large number: make sure the amount we scroll
14758 the window start is never less than amount_to_scroll,
14759 which was computed as distance from window bottom to
14760 point. This matters when lines at window top and lines
14761 below window bottom have different height. */
14763 void *it1data
= NULL
;
14764 /* We use a temporary it1 because line_bottom_y can modify
14765 its argument, if it moves one line down; see there. */
14768 SAVE_IT (it1
, it
, it1data
);
14769 start_y
= line_bottom_y (&it1
);
14771 RESTORE_IT (&it
, &it
, it1data
);
14772 move_it_by_lines (&it
, 1);
14773 SAVE_IT (it1
, it
, it1data
);
14774 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14777 /* If STARTP is unchanged, move it down another screen line. */
14778 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14779 move_it_by_lines (&it
, 1);
14780 startp
= it
.current
.pos
;
14784 struct text_pos scroll_margin_pos
= startp
;
14786 /* See if point is inside the scroll margin at the top of the
14788 if (this_scroll_margin
)
14790 start_display (&it
, w
, startp
);
14791 move_it_vertically (&it
, this_scroll_margin
);
14792 scroll_margin_pos
= it
.current
.pos
;
14795 if (PT
< CHARPOS (scroll_margin_pos
))
14797 /* Point is in the scroll margin at the top of the window or
14798 above what is displayed in the window. */
14801 /* Compute the vertical distance from PT to the scroll
14802 margin position. Move as far as scroll_max allows, or
14803 one screenful, or 10 screen lines, whichever is largest.
14804 Give up if distance is greater than scroll_max. */
14805 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14806 start_display (&it
, w
, pos
);
14808 y_to_move
= max (it
.last_visible_y
,
14809 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14810 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14812 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14813 dy
= it
.current_y
- y0
;
14814 if (dy
> scroll_max
)
14815 return SCROLLING_FAILED
;
14817 /* Compute new window start. */
14818 start_display (&it
, w
, startp
);
14820 if (arg_scroll_conservatively
)
14821 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14822 max (scroll_step
, temp_scroll_step
));
14823 else if (scroll_step
|| temp_scroll_step
)
14824 amount_to_scroll
= scroll_max
;
14827 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14828 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14829 if (NUMBERP (aggressive
))
14831 double float_amount
= XFLOATINT (aggressive
) * height
;
14832 amount_to_scroll
= float_amount
;
14833 if (amount_to_scroll
== 0 && float_amount
> 0)
14834 amount_to_scroll
= 1;
14835 amount_to_scroll
-=
14836 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14837 /* Don't let point enter the scroll margin near
14838 bottom of the window. */
14839 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14840 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14844 if (amount_to_scroll
<= 0)
14845 return SCROLLING_FAILED
;
14847 move_it_vertically_backward (&it
, amount_to_scroll
);
14848 startp
= it
.current
.pos
;
14852 /* Run window scroll functions. */
14853 startp
= run_window_scroll_functions (window
, startp
);
14855 /* Display the window. Give up if new fonts are loaded, or if point
14857 if (!try_window (window
, startp
, 0))
14858 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14859 else if (w
->cursor
.vpos
< 0)
14861 clear_glyph_matrix (w
->desired_matrix
);
14862 rc
= SCROLLING_FAILED
;
14866 /* Maybe forget recorded base line for line number display. */
14867 if (!just_this_one_p
14868 || current_buffer
->clip_changed
14869 || BEG_UNCHANGED
< CHARPOS (startp
))
14870 wset_base_line_number (w
, Qnil
);
14872 /* If cursor ends up on a partially visible line,
14873 treat that as being off the bottom of the screen. */
14874 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14875 /* It's possible that the cursor is on the first line of the
14876 buffer, which is partially obscured due to a vscroll
14877 (Bug#7537). In that case, avoid looping forever . */
14878 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14880 clear_glyph_matrix (w
->desired_matrix
);
14881 ++extra_scroll_margin_lines
;
14884 rc
= SCROLLING_SUCCESS
;
14891 /* Compute a suitable window start for window W if display of W starts
14892 on a continuation line. Value is non-zero if a new window start
14895 The new window start will be computed, based on W's width, starting
14896 from the start of the continued line. It is the start of the
14897 screen line with the minimum distance from the old start W->start. */
14900 compute_window_start_on_continuation_line (struct window
*w
)
14902 struct text_pos pos
, start_pos
;
14903 int window_start_changed_p
= 0;
14905 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14907 /* If window start is on a continuation line... Window start may be
14908 < BEGV in case there's invisible text at the start of the
14909 buffer (M-x rmail, for example). */
14910 if (CHARPOS (start_pos
) > BEGV
14911 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14914 struct glyph_row
*row
;
14916 /* Handle the case that the window start is out of range. */
14917 if (CHARPOS (start_pos
) < BEGV
)
14918 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14919 else if (CHARPOS (start_pos
) > ZV
)
14920 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14922 /* Find the start of the continued line. This should be fast
14923 because scan_buffer is fast (newline cache). */
14924 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14925 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14926 row
, DEFAULT_FACE_ID
);
14927 reseat_at_previous_visible_line_start (&it
);
14929 /* If the line start is "too far" away from the window start,
14930 say it takes too much time to compute a new window start. */
14931 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14932 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14934 int min_distance
, distance
;
14936 /* Move forward by display lines to find the new window
14937 start. If window width was enlarged, the new start can
14938 be expected to be > the old start. If window width was
14939 decreased, the new window start will be < the old start.
14940 So, we're looking for the display line start with the
14941 minimum distance from the old window start. */
14942 pos
= it
.current
.pos
;
14943 min_distance
= INFINITY
;
14944 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14945 distance
< min_distance
)
14947 min_distance
= distance
;
14948 pos
= it
.current
.pos
;
14949 move_it_by_lines (&it
, 1);
14952 /* Set the window start there. */
14953 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14954 window_start_changed_p
= 1;
14958 return window_start_changed_p
;
14962 /* Try cursor movement in case text has not changed in window WINDOW,
14963 with window start STARTP. Value is
14965 CURSOR_MOVEMENT_SUCCESS if successful
14967 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14969 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14970 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14971 we want to scroll as if scroll-step were set to 1. See the code.
14973 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14974 which case we have to abort this redisplay, and adjust matrices
14979 CURSOR_MOVEMENT_SUCCESS
,
14980 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14981 CURSOR_MOVEMENT_MUST_SCROLL
,
14982 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14986 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14988 struct window
*w
= XWINDOW (window
);
14989 struct frame
*f
= XFRAME (w
->frame
);
14990 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14993 if (inhibit_try_cursor_movement
)
14997 /* Previously, there was a check for Lisp integer in the
14998 if-statement below. Now, this field is converted to
14999 ptrdiff_t, thus zero means invalid position in a buffer. */
15000 eassert (w
->last_point
> 0);
15002 /* Handle case where text has not changed, only point, and it has
15003 not moved off the frame. */
15004 if (/* Point may be in this window. */
15005 PT
>= CHARPOS (startp
)
15006 /* Selective display hasn't changed. */
15007 && !current_buffer
->clip_changed
15008 /* Function force-mode-line-update is used to force a thorough
15009 redisplay. It sets either windows_or_buffers_changed or
15010 update_mode_lines. So don't take a shortcut here for these
15012 && !update_mode_lines
15013 && !windows_or_buffers_changed
15014 && !cursor_type_changed
15015 /* Can't use this case if highlighting a region. When a
15016 region exists, cursor movement has to do more than just
15018 && !(!NILP (Vtransient_mark_mode
)
15019 && !NILP (BVAR (current_buffer
, mark_active
)))
15020 && NILP (w
->region_showing
)
15021 && NILP (Vshow_trailing_whitespace
)
15022 /* This code is not used for mini-buffer for the sake of the case
15023 of redisplaying to replace an echo area message; since in
15024 that case the mini-buffer contents per se are usually
15025 unchanged. This code is of no real use in the mini-buffer
15026 since the handling of this_line_start_pos, etc., in redisplay
15027 handles the same cases. */
15028 && !EQ (window
, minibuf_window
)
15029 /* When splitting windows or for new windows, it happens that
15030 redisplay is called with a nil window_end_vpos or one being
15031 larger than the window. This should really be fixed in
15032 window.c. I don't have this on my list, now, so we do
15033 approximately the same as the old redisplay code. --gerd. */
15034 && INTEGERP (w
->window_end_vpos
)
15035 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15036 && (FRAME_WINDOW_P (f
)
15037 || !overlay_arrow_in_current_buffer_p ()))
15039 int this_scroll_margin
, top_scroll_margin
;
15040 struct glyph_row
*row
= NULL
;
15043 debug_method_add (w
, "cursor movement");
15046 /* Scroll if point within this distance from the top or bottom
15047 of the window. This is a pixel value. */
15048 if (scroll_margin
> 0)
15050 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15051 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15054 this_scroll_margin
= 0;
15056 top_scroll_margin
= this_scroll_margin
;
15057 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15058 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15060 /* Start with the row the cursor was displayed during the last
15061 not paused redisplay. Give up if that row is not valid. */
15062 if (w
->last_cursor
.vpos
< 0
15063 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15064 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15067 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15068 if (row
->mode_line_p
)
15070 if (!row
->enabled_p
)
15071 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15074 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15076 int scroll_p
= 0, must_scroll
= 0;
15077 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15079 if (PT
> w
->last_point
)
15081 /* Point has moved forward. */
15082 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15083 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15085 eassert (row
->enabled_p
);
15089 /* If the end position of a row equals the start
15090 position of the next row, and PT is at that position,
15091 we would rather display cursor in the next line. */
15092 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15093 && MATRIX_ROW_END_CHARPOS (row
) == PT
15094 && row
< w
->current_matrix
->rows
15095 + w
->current_matrix
->nrows
- 1
15096 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15097 && !cursor_row_p (row
))
15100 /* If within the scroll margin, scroll. Note that
15101 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15102 the next line would be drawn, and that
15103 this_scroll_margin can be zero. */
15104 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15105 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15106 /* Line is completely visible last line in window
15107 and PT is to be set in the next line. */
15108 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15109 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15110 && !row
->ends_at_zv_p
15111 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15114 else if (PT
< w
->last_point
)
15116 /* Cursor has to be moved backward. Note that PT >=
15117 CHARPOS (startp) because of the outer if-statement. */
15118 while (!row
->mode_line_p
15119 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15120 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15121 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15122 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15123 row
> w
->current_matrix
->rows
15124 && (row
-1)->ends_in_newline_from_string_p
))))
15125 && (row
->y
> top_scroll_margin
15126 || CHARPOS (startp
) == BEGV
))
15128 eassert (row
->enabled_p
);
15132 /* Consider the following case: Window starts at BEGV,
15133 there is invisible, intangible text at BEGV, so that
15134 display starts at some point START > BEGV. It can
15135 happen that we are called with PT somewhere between
15136 BEGV and START. Try to handle that case. */
15137 if (row
< w
->current_matrix
->rows
15138 || row
->mode_line_p
)
15140 row
= w
->current_matrix
->rows
;
15141 if (row
->mode_line_p
)
15145 /* Due to newlines in overlay strings, we may have to
15146 skip forward over overlay strings. */
15147 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15148 && MATRIX_ROW_END_CHARPOS (row
) == PT
15149 && !cursor_row_p (row
))
15152 /* If within the scroll margin, scroll. */
15153 if (row
->y
< top_scroll_margin
15154 && CHARPOS (startp
) != BEGV
)
15159 /* Cursor did not move. So don't scroll even if cursor line
15160 is partially visible, as it was so before. */
15161 rc
= CURSOR_MOVEMENT_SUCCESS
;
15164 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15165 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15167 /* if PT is not in the glyph row, give up. */
15168 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15171 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15172 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15174 struct glyph_row
*row1
;
15176 /* If rows are bidi-reordered and point moved, back up
15177 until we find a row that does not belong to a
15178 continuation line. This is because we must consider
15179 all rows of a continued line as candidates for the
15180 new cursor positioning, since row start and end
15181 positions change non-linearly with vertical position
15183 /* FIXME: Revisit this when glyph ``spilling'' in
15184 continuation lines' rows is implemented for
15185 bidi-reordered rows. */
15186 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15187 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15190 /* If we hit the beginning of the displayed portion
15191 without finding the first row of a continued
15195 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15198 eassert (row
->enabled_p
);
15203 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15204 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15205 /* Make sure this isn't a header line by any chance, since
15206 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15207 && !row
->mode_line_p
15208 && make_cursor_line_fully_visible_p
)
15210 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15211 && !row
->ends_at_zv_p
15212 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15213 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15214 else if (row
->height
> window_box_height (w
))
15216 /* If we end up in a partially visible line, let's
15217 make it fully visible, except when it's taller
15218 than the window, in which case we can't do much
15221 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15225 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15226 if (!cursor_row_fully_visible_p (w
, 0, 1))
15227 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15229 rc
= CURSOR_MOVEMENT_SUCCESS
;
15233 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15234 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15235 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15237 /* With bidi-reordered rows, there could be more than
15238 one candidate row whose start and end positions
15239 occlude point. We need to let set_cursor_from_row
15240 find the best candidate. */
15241 /* FIXME: Revisit this when glyph ``spilling'' in
15242 continuation lines' rows is implemented for
15243 bidi-reordered rows. */
15248 int at_zv_p
= 0, exact_match_p
= 0;
15250 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15251 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15252 && cursor_row_p (row
))
15253 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15255 /* As soon as we've found the exact match for point,
15256 or the first suitable row whose ends_at_zv_p flag
15257 is set, we are done. */
15259 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15261 && w
->cursor
.hpos
>= 0
15262 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15265 struct glyph_row
*candidate
=
15266 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15268 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15269 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15272 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15273 || (INTEGERP (g
->object
)
15274 && (g
->charpos
== PT
15275 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15277 if (rv
&& (at_zv_p
|| exact_match_p
))
15279 rc
= CURSOR_MOVEMENT_SUCCESS
;
15282 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15286 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15287 || row
->continued_p
)
15288 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15289 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15290 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15291 /* If we didn't find any candidate rows, or exited the
15292 loop before all the candidates were examined, signal
15293 to the caller that this method failed. */
15294 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15296 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15297 && !row
->continued_p
))
15298 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15300 rc
= CURSOR_MOVEMENT_SUCCESS
;
15306 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15308 rc
= CURSOR_MOVEMENT_SUCCESS
;
15313 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15314 && MATRIX_ROW_START_CHARPOS (row
) == PT
15315 && cursor_row_p (row
));
15323 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15327 set_vertical_scroll_bar (struct window
*w
)
15329 ptrdiff_t start
, end
, whole
;
15331 /* Calculate the start and end positions for the current window.
15332 At some point, it would be nice to choose between scrollbars
15333 which reflect the whole buffer size, with special markers
15334 indicating narrowing, and scrollbars which reflect only the
15337 Note that mini-buffers sometimes aren't displaying any text. */
15338 if (!MINI_WINDOW_P (w
)
15339 || (w
== XWINDOW (minibuf_window
)
15340 && NILP (echo_area_buffer
[0])))
15342 struct buffer
*buf
= XBUFFER (w
->buffer
);
15343 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15344 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15345 /* I don't think this is guaranteed to be right. For the
15346 moment, we'll pretend it is. */
15347 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15351 if (whole
< (end
- start
))
15352 whole
= end
- start
;
15355 start
= end
= whole
= 0;
15357 /* Indicate what this scroll bar ought to be displaying now. */
15358 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15359 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15360 (w
, end
- start
, whole
, start
);
15364 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15365 selected_window is redisplayed.
15367 We can return without actually redisplaying the window if
15368 fonts_changed_p is nonzero. In that case, redisplay_internal will
15372 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15374 struct window
*w
= XWINDOW (window
);
15375 struct frame
*f
= XFRAME (w
->frame
);
15376 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15377 struct buffer
*old
= current_buffer
;
15378 struct text_pos lpoint
, opoint
, startp
;
15379 int update_mode_line
;
15382 /* Record it now because it's overwritten. */
15383 int current_matrix_up_to_date_p
= 0;
15384 int used_current_matrix_p
= 0;
15385 /* This is less strict than current_matrix_up_to_date_p.
15386 It indicates that the buffer contents and narrowing are unchanged. */
15387 int buffer_unchanged_p
= 0;
15388 int temp_scroll_step
= 0;
15389 ptrdiff_t count
= SPECPDL_INDEX ();
15391 int centering_position
= -1;
15392 int last_line_misfit
= 0;
15393 ptrdiff_t beg_unchanged
, end_unchanged
;
15395 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15398 /* W must be a leaf window here. */
15399 eassert (!NILP (w
->buffer
));
15401 *w
->desired_matrix
->method
= 0;
15405 reconsider_clip_changes (w
, buffer
);
15407 /* Has the mode line to be updated? */
15408 update_mode_line
= (w
->update_mode_line
15409 || update_mode_lines
15410 || buffer
->clip_changed
15411 || buffer
->prevent_redisplay_optimizations_p
);
15413 if (MINI_WINDOW_P (w
))
15415 if (w
== XWINDOW (echo_area_window
)
15416 && !NILP (echo_area_buffer
[0]))
15418 if (update_mode_line
)
15419 /* We may have to update a tty frame's menu bar or a
15420 tool-bar. Example `M-x C-h C-h C-g'. */
15421 goto finish_menu_bars
;
15423 /* We've already displayed the echo area glyphs in this window. */
15424 goto finish_scroll_bars
;
15426 else if ((w
!= XWINDOW (minibuf_window
)
15427 || minibuf_level
== 0)
15428 /* When buffer is nonempty, redisplay window normally. */
15429 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15430 /* Quail displays non-mini buffers in minibuffer window.
15431 In that case, redisplay the window normally. */
15432 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15434 /* W is a mini-buffer window, but it's not active, so clear
15436 int yb
= window_text_bottom_y (w
);
15437 struct glyph_row
*row
;
15440 for (y
= 0, row
= w
->desired_matrix
->rows
;
15442 y
+= row
->height
, ++row
)
15443 blank_row (w
, row
, y
);
15444 goto finish_scroll_bars
;
15447 clear_glyph_matrix (w
->desired_matrix
);
15450 /* Otherwise set up data on this window; select its buffer and point
15452 /* Really select the buffer, for the sake of buffer-local
15454 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15456 current_matrix_up_to_date_p
15457 = (!NILP (w
->window_end_valid
)
15458 && !current_buffer
->clip_changed
15459 && !current_buffer
->prevent_redisplay_optimizations_p
15460 && w
->last_modified
>= MODIFF
15461 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15463 /* Run the window-bottom-change-functions
15464 if it is possible that the text on the screen has changed
15465 (either due to modification of the text, or any other reason). */
15466 if (!current_matrix_up_to_date_p
15467 && !NILP (Vwindow_text_change_functions
))
15469 safe_run_hooks (Qwindow_text_change_functions
);
15473 beg_unchanged
= BEG_UNCHANGED
;
15474 end_unchanged
= END_UNCHANGED
;
15476 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15478 specbind (Qinhibit_point_motion_hooks
, Qt
);
15481 = (!NILP (w
->window_end_valid
)
15482 && !current_buffer
->clip_changed
15483 && w
->last_modified
>= MODIFF
15484 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15486 /* When windows_or_buffers_changed is non-zero, we can't rely on
15487 the window end being valid, so set it to nil there. */
15488 if (windows_or_buffers_changed
)
15490 /* If window starts on a continuation line, maybe adjust the
15491 window start in case the window's width changed. */
15492 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15493 compute_window_start_on_continuation_line (w
);
15495 wset_window_end_valid (w
, Qnil
);
15498 /* Some sanity checks. */
15499 CHECK_WINDOW_END (w
);
15500 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15502 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15505 /* If %c is in mode line, update it if needed. */
15506 if (!NILP (w
->column_number_displayed
)
15507 /* This alternative quickly identifies a common case
15508 where no change is needed. */
15509 && !(PT
== w
->last_point
15510 && w
->last_modified
>= MODIFF
15511 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15512 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15513 update_mode_line
= 1;
15515 /* Count number of windows showing the selected buffer. An indirect
15516 buffer counts as its base buffer. */
15517 if (!just_this_one_p
)
15519 struct buffer
*current_base
, *window_base
;
15520 current_base
= current_buffer
;
15521 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15522 if (current_base
->base_buffer
)
15523 current_base
= current_base
->base_buffer
;
15524 if (window_base
->base_buffer
)
15525 window_base
= window_base
->base_buffer
;
15526 if (current_base
== window_base
)
15530 /* Point refers normally to the selected window. For any other
15531 window, set up appropriate value. */
15532 if (!EQ (window
, selected_window
))
15534 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15535 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15539 new_pt_byte
= BEGV_BYTE
;
15540 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15542 else if (new_pt
> (ZV
- 1))
15545 new_pt_byte
= ZV_BYTE
;
15546 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15549 /* We don't use SET_PT so that the point-motion hooks don't run. */
15550 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15553 /* If any of the character widths specified in the display table
15554 have changed, invalidate the width run cache. It's true that
15555 this may be a bit late to catch such changes, but the rest of
15556 redisplay goes (non-fatally) haywire when the display table is
15557 changed, so why should we worry about doing any better? */
15558 if (current_buffer
->width_run_cache
)
15560 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15562 if (! disptab_matches_widthtab
15563 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15565 invalidate_region_cache (current_buffer
,
15566 current_buffer
->width_run_cache
,
15568 recompute_width_table (current_buffer
, disptab
);
15572 /* If window-start is screwed up, choose a new one. */
15573 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15576 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15578 /* If someone specified a new starting point but did not insist,
15579 check whether it can be used. */
15580 if (w
->optional_new_start
15581 && CHARPOS (startp
) >= BEGV
15582 && CHARPOS (startp
) <= ZV
)
15584 w
->optional_new_start
= 0;
15585 start_display (&it
, w
, startp
);
15586 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15587 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15588 if (IT_CHARPOS (it
) == PT
)
15589 w
->force_start
= 1;
15590 /* IT may overshoot PT if text at PT is invisible. */
15591 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15592 w
->force_start
= 1;
15597 /* Handle case where place to start displaying has been specified,
15598 unless the specified location is outside the accessible range. */
15599 if (w
->force_start
|| w
->frozen_window_start_p
)
15601 /* We set this later on if we have to adjust point. */
15604 w
->force_start
= 0;
15606 wset_window_end_valid (w
, Qnil
);
15608 /* Forget any recorded base line for line number display. */
15609 if (!buffer_unchanged_p
)
15610 wset_base_line_number (w
, Qnil
);
15612 /* Redisplay the mode line. Select the buffer properly for that.
15613 Also, run the hook window-scroll-functions
15614 because we have scrolled. */
15615 /* Note, we do this after clearing force_start because
15616 if there's an error, it is better to forget about force_start
15617 than to get into an infinite loop calling the hook functions
15618 and having them get more errors. */
15619 if (!update_mode_line
15620 || ! NILP (Vwindow_scroll_functions
))
15622 update_mode_line
= 1;
15623 w
->update_mode_line
= 1;
15624 startp
= run_window_scroll_functions (window
, startp
);
15627 w
->last_modified
= 0;
15628 w
->last_overlay_modified
= 0;
15629 if (CHARPOS (startp
) < BEGV
)
15630 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15631 else if (CHARPOS (startp
) > ZV
)
15632 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15634 /* Redisplay, then check if cursor has been set during the
15635 redisplay. Give up if new fonts were loaded. */
15636 /* We used to issue a CHECK_MARGINS argument to try_window here,
15637 but this causes scrolling to fail when point begins inside
15638 the scroll margin (bug#148) -- cyd */
15639 if (!try_window (window
, startp
, 0))
15641 w
->force_start
= 1;
15642 clear_glyph_matrix (w
->desired_matrix
);
15643 goto need_larger_matrices
;
15646 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15648 /* If point does not appear, try to move point so it does
15649 appear. The desired matrix has been built above, so we
15650 can use it here. */
15651 new_vpos
= window_box_height (w
) / 2;
15654 if (!cursor_row_fully_visible_p (w
, 0, 0))
15656 /* Point does appear, but on a line partly visible at end of window.
15657 Move it back to a fully-visible line. */
15658 new_vpos
= window_box_height (w
);
15661 /* If we need to move point for either of the above reasons,
15662 now actually do it. */
15665 struct glyph_row
*row
;
15667 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15668 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15671 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15672 MATRIX_ROW_START_BYTEPOS (row
));
15674 if (w
!= XWINDOW (selected_window
))
15675 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15676 else if (current_buffer
== old
)
15677 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15679 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15681 /* If we are highlighting the region, then we just changed
15682 the region, so redisplay to show it. */
15683 if (!NILP (Vtransient_mark_mode
)
15684 && !NILP (BVAR (current_buffer
, mark_active
)))
15686 clear_glyph_matrix (w
->desired_matrix
);
15687 if (!try_window (window
, startp
, 0))
15688 goto need_larger_matrices
;
15693 debug_method_add (w
, "forced window start");
15698 /* Handle case where text has not changed, only point, and it has
15699 not moved off the frame, and we are not retrying after hscroll.
15700 (current_matrix_up_to_date_p is nonzero when retrying.) */
15701 if (current_matrix_up_to_date_p
15702 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15703 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15707 case CURSOR_MOVEMENT_SUCCESS
:
15708 used_current_matrix_p
= 1;
15711 case CURSOR_MOVEMENT_MUST_SCROLL
:
15712 goto try_to_scroll
;
15718 /* If current starting point was originally the beginning of a line
15719 but no longer is, find a new starting point. */
15720 else if (w
->start_at_line_beg
15721 && !(CHARPOS (startp
) <= BEGV
15722 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15725 debug_method_add (w
, "recenter 1");
15730 /* Try scrolling with try_window_id. Value is > 0 if update has
15731 been done, it is -1 if we know that the same window start will
15732 not work. It is 0 if unsuccessful for some other reason. */
15733 else if ((tem
= try_window_id (w
)) != 0)
15736 debug_method_add (w
, "try_window_id %d", tem
);
15739 if (fonts_changed_p
)
15740 goto need_larger_matrices
;
15744 /* Otherwise try_window_id has returned -1 which means that we
15745 don't want the alternative below this comment to execute. */
15747 else if (CHARPOS (startp
) >= BEGV
15748 && CHARPOS (startp
) <= ZV
15749 && PT
>= CHARPOS (startp
)
15750 && (CHARPOS (startp
) < ZV
15751 /* Avoid starting at end of buffer. */
15752 || CHARPOS (startp
) == BEGV
15753 || (w
->last_modified
>= MODIFF
15754 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15756 int d1
, d2
, d3
, d4
, d5
, d6
;
15758 /* If first window line is a continuation line, and window start
15759 is inside the modified region, but the first change is before
15760 current window start, we must select a new window start.
15762 However, if this is the result of a down-mouse event (e.g. by
15763 extending the mouse-drag-overlay), we don't want to select a
15764 new window start, since that would change the position under
15765 the mouse, resulting in an unwanted mouse-movement rather
15766 than a simple mouse-click. */
15767 if (!w
->start_at_line_beg
15768 && NILP (do_mouse_tracking
)
15769 && CHARPOS (startp
) > BEGV
15770 && CHARPOS (startp
) > BEG
+ beg_unchanged
15771 && CHARPOS (startp
) <= Z
- end_unchanged
15772 /* Even if w->start_at_line_beg is nil, a new window may
15773 start at a line_beg, since that's how set_buffer_window
15774 sets it. So, we need to check the return value of
15775 compute_window_start_on_continuation_line. (See also
15777 && XMARKER (w
->start
)->buffer
== current_buffer
15778 && compute_window_start_on_continuation_line (w
)
15779 /* It doesn't make sense to force the window start like we
15780 do at label force_start if it is already known that point
15781 will not be visible in the resulting window, because
15782 doing so will move point from its correct position
15783 instead of scrolling the window to bring point into view.
15785 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15787 w
->force_start
= 1;
15788 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15793 debug_method_add (w
, "same window start");
15796 /* Try to redisplay starting at same place as before.
15797 If point has not moved off frame, accept the results. */
15798 if (!current_matrix_up_to_date_p
15799 /* Don't use try_window_reusing_current_matrix in this case
15800 because a window scroll function can have changed the
15802 || !NILP (Vwindow_scroll_functions
)
15803 || MINI_WINDOW_P (w
)
15804 || !(used_current_matrix_p
15805 = try_window_reusing_current_matrix (w
)))
15807 IF_DEBUG (debug_method_add (w
, "1"));
15808 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15809 /* -1 means we need to scroll.
15810 0 means we need new matrices, but fonts_changed_p
15811 is set in that case, so we will detect it below. */
15812 goto try_to_scroll
;
15815 if (fonts_changed_p
)
15816 goto need_larger_matrices
;
15818 if (w
->cursor
.vpos
>= 0)
15820 if (!just_this_one_p
15821 || current_buffer
->clip_changed
15822 || BEG_UNCHANGED
< CHARPOS (startp
))
15823 /* Forget any recorded base line for line number display. */
15824 wset_base_line_number (w
, Qnil
);
15826 if (!cursor_row_fully_visible_p (w
, 1, 0))
15828 clear_glyph_matrix (w
->desired_matrix
);
15829 last_line_misfit
= 1;
15831 /* Drop through and scroll. */
15836 clear_glyph_matrix (w
->desired_matrix
);
15841 w
->last_modified
= 0;
15842 w
->last_overlay_modified
= 0;
15844 /* Redisplay the mode line. Select the buffer properly for that. */
15845 if (!update_mode_line
)
15847 update_mode_line
= 1;
15848 w
->update_mode_line
= 1;
15851 /* Try to scroll by specified few lines. */
15852 if ((scroll_conservatively
15853 || emacs_scroll_step
15854 || temp_scroll_step
15855 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15856 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15857 && CHARPOS (startp
) >= BEGV
15858 && CHARPOS (startp
) <= ZV
)
15860 /* The function returns -1 if new fonts were loaded, 1 if
15861 successful, 0 if not successful. */
15862 int ss
= try_scrolling (window
, just_this_one_p
,
15863 scroll_conservatively
,
15865 temp_scroll_step
, last_line_misfit
);
15868 case SCROLLING_SUCCESS
:
15871 case SCROLLING_NEED_LARGER_MATRICES
:
15872 goto need_larger_matrices
;
15874 case SCROLLING_FAILED
:
15882 /* Finally, just choose a place to start which positions point
15883 according to user preferences. */
15888 debug_method_add (w
, "recenter");
15891 /* w->vscroll = 0; */
15893 /* Forget any previously recorded base line for line number display. */
15894 if (!buffer_unchanged_p
)
15895 wset_base_line_number (w
, Qnil
);
15897 /* Determine the window start relative to point. */
15898 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15899 it
.current_y
= it
.last_visible_y
;
15900 if (centering_position
< 0)
15904 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15906 ptrdiff_t margin_pos
= CHARPOS (startp
);
15907 Lisp_Object aggressive
;
15910 /* If there is a scroll margin at the top of the window, find
15911 its character position. */
15913 /* Cannot call start_display if startp is not in the
15914 accessible region of the buffer. This can happen when we
15915 have just switched to a different buffer and/or changed
15916 its restriction. In that case, startp is initialized to
15917 the character position 1 (BEGV) because we did not yet
15918 have chance to display the buffer even once. */
15919 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15922 void *it1data
= NULL
;
15924 SAVE_IT (it1
, it
, it1data
);
15925 start_display (&it1
, w
, startp
);
15926 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15927 margin_pos
= IT_CHARPOS (it1
);
15928 RESTORE_IT (&it
, &it
, it1data
);
15930 scrolling_up
= PT
> margin_pos
;
15933 ? BVAR (current_buffer
, scroll_up_aggressively
)
15934 : BVAR (current_buffer
, scroll_down_aggressively
);
15936 if (!MINI_WINDOW_P (w
)
15937 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15941 /* Setting scroll-conservatively overrides
15942 scroll-*-aggressively. */
15943 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15945 double float_amount
= XFLOATINT (aggressive
);
15947 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15948 if (pt_offset
== 0 && float_amount
> 0)
15950 if (pt_offset
&& margin
> 0)
15953 /* Compute how much to move the window start backward from
15954 point so that point will be displayed where the user
15958 centering_position
= it
.last_visible_y
;
15960 centering_position
-= pt_offset
;
15961 centering_position
-=
15962 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15963 + WINDOW_HEADER_LINE_HEIGHT (w
);
15964 /* Don't let point enter the scroll margin near top of
15966 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15967 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15970 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15973 /* Set the window start half the height of the window backward
15975 centering_position
= window_box_height (w
) / 2;
15977 move_it_vertically_backward (&it
, centering_position
);
15979 eassert (IT_CHARPOS (it
) >= BEGV
);
15981 /* The function move_it_vertically_backward may move over more
15982 than the specified y-distance. If it->w is small, e.g. a
15983 mini-buffer window, we may end up in front of the window's
15984 display area. Start displaying at the start of the line
15985 containing PT in this case. */
15986 if (it
.current_y
<= 0)
15988 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15989 move_it_vertically_backward (&it
, 0);
15993 it
.current_x
= it
.hpos
= 0;
15995 /* Set the window start position here explicitly, to avoid an
15996 infinite loop in case the functions in window-scroll-functions
15998 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16000 /* Run scroll hooks. */
16001 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16003 /* Redisplay the window. */
16004 if (!current_matrix_up_to_date_p
16005 || windows_or_buffers_changed
16006 || cursor_type_changed
16007 /* Don't use try_window_reusing_current_matrix in this case
16008 because it can have changed the buffer. */
16009 || !NILP (Vwindow_scroll_functions
)
16010 || !just_this_one_p
16011 || MINI_WINDOW_P (w
)
16012 || !(used_current_matrix_p
16013 = try_window_reusing_current_matrix (w
)))
16014 try_window (window
, startp
, 0);
16016 /* If new fonts have been loaded (due to fontsets), give up. We
16017 have to start a new redisplay since we need to re-adjust glyph
16019 if (fonts_changed_p
)
16020 goto need_larger_matrices
;
16022 /* If cursor did not appear assume that the middle of the window is
16023 in the first line of the window. Do it again with the next line.
16024 (Imagine a window of height 100, displaying two lines of height
16025 60. Moving back 50 from it->last_visible_y will end in the first
16027 if (w
->cursor
.vpos
< 0)
16029 if (!NILP (w
->window_end_valid
)
16030 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16032 clear_glyph_matrix (w
->desired_matrix
);
16033 move_it_by_lines (&it
, 1);
16034 try_window (window
, it
.current
.pos
, 0);
16036 else if (PT
< IT_CHARPOS (it
))
16038 clear_glyph_matrix (w
->desired_matrix
);
16039 move_it_by_lines (&it
, -1);
16040 try_window (window
, it
.current
.pos
, 0);
16044 /* Not much we can do about it. */
16048 /* Consider the following case: Window starts at BEGV, there is
16049 invisible, intangible text at BEGV, so that display starts at
16050 some point START > BEGV. It can happen that we are called with
16051 PT somewhere between BEGV and START. Try to handle that case. */
16052 if (w
->cursor
.vpos
< 0)
16054 struct glyph_row
*row
= w
->current_matrix
->rows
;
16055 if (row
->mode_line_p
)
16057 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16060 if (!cursor_row_fully_visible_p (w
, 0, 0))
16062 /* If vscroll is enabled, disable it and try again. */
16066 clear_glyph_matrix (w
->desired_matrix
);
16070 /* Users who set scroll-conservatively to a large number want
16071 point just above/below the scroll margin. If we ended up
16072 with point's row partially visible, move the window start to
16073 make that row fully visible and out of the margin. */
16074 if (scroll_conservatively
> SCROLL_LIMIT
)
16078 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16080 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16082 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16083 clear_glyph_matrix (w
->desired_matrix
);
16084 if (1 == try_window (window
, it
.current
.pos
,
16085 TRY_WINDOW_CHECK_MARGINS
))
16089 /* If centering point failed to make the whole line visible,
16090 put point at the top instead. That has to make the whole line
16091 visible, if it can be done. */
16092 if (centering_position
== 0)
16095 clear_glyph_matrix (w
->desired_matrix
);
16096 centering_position
= 0;
16102 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16103 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16104 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16106 /* Display the mode line, if we must. */
16107 if ((update_mode_line
16108 /* If window not full width, must redo its mode line
16109 if (a) the window to its side is being redone and
16110 (b) we do a frame-based redisplay. This is a consequence
16111 of how inverted lines are drawn in frame-based redisplay. */
16112 || (!just_this_one_p
16113 && !FRAME_WINDOW_P (f
)
16114 && !WINDOW_FULL_WIDTH_P (w
))
16115 /* Line number to display. */
16116 || INTEGERP (w
->base_line_pos
)
16117 /* Column number is displayed and different from the one displayed. */
16118 || (!NILP (w
->column_number_displayed
)
16119 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16120 /* This means that the window has a mode line. */
16121 && (WINDOW_WANTS_MODELINE_P (w
)
16122 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16124 display_mode_lines (w
);
16126 /* If mode line height has changed, arrange for a thorough
16127 immediate redisplay using the correct mode line height. */
16128 if (WINDOW_WANTS_MODELINE_P (w
)
16129 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16131 fonts_changed_p
= 1;
16132 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16133 = DESIRED_MODE_LINE_HEIGHT (w
);
16136 /* If header line height has changed, arrange for a thorough
16137 immediate redisplay using the correct header line height. */
16138 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16139 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16141 fonts_changed_p
= 1;
16142 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16143 = DESIRED_HEADER_LINE_HEIGHT (w
);
16146 if (fonts_changed_p
)
16147 goto need_larger_matrices
;
16150 if (!line_number_displayed
16151 && !BUFFERP (w
->base_line_pos
))
16153 wset_base_line_pos (w
, Qnil
);
16154 wset_base_line_number (w
, Qnil
);
16159 /* When we reach a frame's selected window, redo the frame's menu bar. */
16160 if (update_mode_line
16161 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16163 int redisplay_menu_p
= 0;
16165 if (FRAME_WINDOW_P (f
))
16167 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16168 || defined (HAVE_NS) || defined (USE_GTK)
16169 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16171 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16175 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16177 if (redisplay_menu_p
)
16178 display_menu_bar (w
);
16180 #ifdef HAVE_WINDOW_SYSTEM
16181 if (FRAME_WINDOW_P (f
))
16183 #if defined (USE_GTK) || defined (HAVE_NS)
16184 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16185 redisplay_tool_bar (f
);
16187 if (WINDOWP (f
->tool_bar_window
)
16188 && (FRAME_TOOL_BAR_LINES (f
) > 0
16189 || !NILP (Vauto_resize_tool_bars
))
16190 && redisplay_tool_bar (f
))
16191 ignore_mouse_drag_p
= 1;
16197 #ifdef HAVE_WINDOW_SYSTEM
16198 if (FRAME_WINDOW_P (f
)
16199 && update_window_fringes (w
, (just_this_one_p
16200 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16201 || w
->pseudo_window_p
)))
16205 if (draw_window_fringes (w
, 1))
16206 x_draw_vertical_border (w
);
16210 #endif /* HAVE_WINDOW_SYSTEM */
16212 /* We go to this label, with fonts_changed_p nonzero,
16213 if it is necessary to try again using larger glyph matrices.
16214 We have to redeem the scroll bar even in this case,
16215 because the loop in redisplay_internal expects that. */
16216 need_larger_matrices
:
16218 finish_scroll_bars
:
16220 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16222 /* Set the thumb's position and size. */
16223 set_vertical_scroll_bar (w
);
16225 /* Note that we actually used the scroll bar attached to this
16226 window, so it shouldn't be deleted at the end of redisplay. */
16227 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16228 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16231 /* Restore current_buffer and value of point in it. The window
16232 update may have changed the buffer, so first make sure `opoint'
16233 is still valid (Bug#6177). */
16234 if (CHARPOS (opoint
) < BEGV
)
16235 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16236 else if (CHARPOS (opoint
) > ZV
)
16237 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16239 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16241 set_buffer_internal_1 (old
);
16242 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16243 shorter. This can be caused by log truncation in *Messages*. */
16244 if (CHARPOS (lpoint
) <= ZV
)
16245 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16247 unbind_to (count
, Qnil
);
16251 /* Build the complete desired matrix of WINDOW with a window start
16252 buffer position POS.
16254 Value is 1 if successful. It is zero if fonts were loaded during
16255 redisplay which makes re-adjusting glyph matrices necessary, and -1
16256 if point would appear in the scroll margins.
16257 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16258 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16262 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16264 struct window
*w
= XWINDOW (window
);
16266 struct glyph_row
*last_text_row
= NULL
;
16267 struct frame
*f
= XFRAME (w
->frame
);
16269 /* Make POS the new window start. */
16270 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16272 /* Mark cursor position as unknown. No overlay arrow seen. */
16273 w
->cursor
.vpos
= -1;
16274 overlay_arrow_seen
= 0;
16276 /* Initialize iterator and info to start at POS. */
16277 start_display (&it
, w
, pos
);
16279 /* Display all lines of W. */
16280 while (it
.current_y
< it
.last_visible_y
)
16282 if (display_line (&it
))
16283 last_text_row
= it
.glyph_row
- 1;
16284 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16288 /* Don't let the cursor end in the scroll margins. */
16289 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16290 && !MINI_WINDOW_P (w
))
16292 int this_scroll_margin
;
16294 if (scroll_margin
> 0)
16296 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16297 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16300 this_scroll_margin
= 0;
16302 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16303 && w
->cursor
.y
< this_scroll_margin
16304 && CHARPOS (pos
) > BEGV
16305 && IT_CHARPOS (it
) < ZV
)
16306 /* rms: considering make_cursor_line_fully_visible_p here
16307 seems to give wrong results. We don't want to recenter
16308 when the last line is partly visible, we want to allow
16309 that case to be handled in the usual way. */
16310 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16312 w
->cursor
.vpos
= -1;
16313 clear_glyph_matrix (w
->desired_matrix
);
16318 /* If bottom moved off end of frame, change mode line percentage. */
16319 if (XFASTINT (w
->window_end_pos
) <= 0
16320 && Z
!= IT_CHARPOS (it
))
16321 w
->update_mode_line
= 1;
16323 /* Set window_end_pos to the offset of the last character displayed
16324 on the window from the end of current_buffer. Set
16325 window_end_vpos to its row number. */
16328 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16329 w
->window_end_bytepos
16330 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16331 wset_window_end_pos
16332 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16333 wset_window_end_vpos
16334 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16336 (MATRIX_ROW (w
->desired_matrix
,
16337 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16341 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16342 wset_window_end_pos (w
, make_number (Z
- ZV
));
16343 wset_window_end_vpos (w
, make_number (0));
16346 /* But that is not valid info until redisplay finishes. */
16347 wset_window_end_valid (w
, Qnil
);
16353 /************************************************************************
16354 Window redisplay reusing current matrix when buffer has not changed
16355 ************************************************************************/
16357 /* Try redisplay of window W showing an unchanged buffer with a
16358 different window start than the last time it was displayed by
16359 reusing its current matrix. Value is non-zero if successful.
16360 W->start is the new window start. */
16363 try_window_reusing_current_matrix (struct window
*w
)
16365 struct frame
*f
= XFRAME (w
->frame
);
16366 struct glyph_row
*bottom_row
;
16369 struct text_pos start
, new_start
;
16370 int nrows_scrolled
, i
;
16371 struct glyph_row
*last_text_row
;
16372 struct glyph_row
*last_reused_text_row
;
16373 struct glyph_row
*start_row
;
16374 int start_vpos
, min_y
, max_y
;
16377 if (inhibit_try_window_reusing
)
16381 if (/* This function doesn't handle terminal frames. */
16382 !FRAME_WINDOW_P (f
)
16383 /* Don't try to reuse the display if windows have been split
16385 || windows_or_buffers_changed
16386 || cursor_type_changed
)
16389 /* Can't do this if region may have changed. */
16390 if ((!NILP (Vtransient_mark_mode
)
16391 && !NILP (BVAR (current_buffer
, mark_active
)))
16392 || !NILP (w
->region_showing
)
16393 || !NILP (Vshow_trailing_whitespace
))
16396 /* If top-line visibility has changed, give up. */
16397 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16398 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16401 /* Give up if old or new display is scrolled vertically. We could
16402 make this function handle this, but right now it doesn't. */
16403 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16404 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16407 /* The variable new_start now holds the new window start. The old
16408 start `start' can be determined from the current matrix. */
16409 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16410 start
= start_row
->minpos
;
16411 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16413 /* Clear the desired matrix for the display below. */
16414 clear_glyph_matrix (w
->desired_matrix
);
16416 if (CHARPOS (new_start
) <= CHARPOS (start
))
16418 /* Don't use this method if the display starts with an ellipsis
16419 displayed for invisible text. It's not easy to handle that case
16420 below, and it's certainly not worth the effort since this is
16421 not a frequent case. */
16422 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16425 IF_DEBUG (debug_method_add (w
, "twu1"));
16427 /* Display up to a row that can be reused. The variable
16428 last_text_row is set to the last row displayed that displays
16429 text. Note that it.vpos == 0 if or if not there is a
16430 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16431 start_display (&it
, w
, new_start
);
16432 w
->cursor
.vpos
= -1;
16433 last_text_row
= last_reused_text_row
= NULL
;
16435 while (it
.current_y
< it
.last_visible_y
16436 && !fonts_changed_p
)
16438 /* If we have reached into the characters in the START row,
16439 that means the line boundaries have changed. So we
16440 can't start copying with the row START. Maybe it will
16441 work to start copying with the following row. */
16442 while (IT_CHARPOS (it
) > CHARPOS (start
))
16444 /* Advance to the next row as the "start". */
16446 start
= start_row
->minpos
;
16447 /* If there are no more rows to try, or just one, give up. */
16448 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16449 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16450 || CHARPOS (start
) == ZV
)
16452 clear_glyph_matrix (w
->desired_matrix
);
16456 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16458 /* If we have reached alignment, we can copy the rest of the
16460 if (IT_CHARPOS (it
) == CHARPOS (start
)
16461 /* Don't accept "alignment" inside a display vector,
16462 since start_row could have started in the middle of
16463 that same display vector (thus their character
16464 positions match), and we have no way of telling if
16465 that is the case. */
16466 && it
.current
.dpvec_index
< 0)
16469 if (display_line (&it
))
16470 last_text_row
= it
.glyph_row
- 1;
16474 /* A value of current_y < last_visible_y means that we stopped
16475 at the previous window start, which in turn means that we
16476 have at least one reusable row. */
16477 if (it
.current_y
< it
.last_visible_y
)
16479 struct glyph_row
*row
;
16481 /* IT.vpos always starts from 0; it counts text lines. */
16482 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16484 /* Find PT if not already found in the lines displayed. */
16485 if (w
->cursor
.vpos
< 0)
16487 int dy
= it
.current_y
- start_row
->y
;
16489 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16490 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16492 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16493 dy
, nrows_scrolled
);
16496 clear_glyph_matrix (w
->desired_matrix
);
16501 /* Scroll the display. Do it before the current matrix is
16502 changed. The problem here is that update has not yet
16503 run, i.e. part of the current matrix is not up to date.
16504 scroll_run_hook will clear the cursor, and use the
16505 current matrix to get the height of the row the cursor is
16507 run
.current_y
= start_row
->y
;
16508 run
.desired_y
= it
.current_y
;
16509 run
.height
= it
.last_visible_y
- it
.current_y
;
16511 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16514 FRAME_RIF (f
)->update_window_begin_hook (w
);
16515 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16516 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16517 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16521 /* Shift current matrix down by nrows_scrolled lines. */
16522 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16523 rotate_matrix (w
->current_matrix
,
16525 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16528 /* Disable lines that must be updated. */
16529 for (i
= 0; i
< nrows_scrolled
; ++i
)
16530 (start_row
+ i
)->enabled_p
= 0;
16532 /* Re-compute Y positions. */
16533 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16534 max_y
= it
.last_visible_y
;
16535 for (row
= start_row
+ nrows_scrolled
;
16539 row
->y
= it
.current_y
;
16540 row
->visible_height
= row
->height
;
16542 if (row
->y
< min_y
)
16543 row
->visible_height
-= min_y
- row
->y
;
16544 if (row
->y
+ row
->height
> max_y
)
16545 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16546 if (row
->fringe_bitmap_periodic_p
)
16547 row
->redraw_fringe_bitmaps_p
= 1;
16549 it
.current_y
+= row
->height
;
16551 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16552 last_reused_text_row
= row
;
16553 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16557 /* Disable lines in the current matrix which are now
16558 below the window. */
16559 for (++row
; row
< bottom_row
; ++row
)
16560 row
->enabled_p
= row
->mode_line_p
= 0;
16563 /* Update window_end_pos etc.; last_reused_text_row is the last
16564 reused row from the current matrix containing text, if any.
16565 The value of last_text_row is the last displayed line
16566 containing text. */
16567 if (last_reused_text_row
)
16569 w
->window_end_bytepos
16570 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16571 wset_window_end_pos
16573 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16574 wset_window_end_vpos
16575 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16576 w
->current_matrix
)));
16578 else if (last_text_row
)
16580 w
->window_end_bytepos
16581 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16582 wset_window_end_pos
16583 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16584 wset_window_end_vpos
16585 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16586 w
->desired_matrix
)));
16590 /* This window must be completely empty. */
16591 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16592 wset_window_end_pos (w
, make_number (Z
- ZV
));
16593 wset_window_end_vpos (w
, make_number (0));
16595 wset_window_end_valid (w
, Qnil
);
16597 /* Update hint: don't try scrolling again in update_window. */
16598 w
->desired_matrix
->no_scrolling_p
= 1;
16601 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16605 else if (CHARPOS (new_start
) > CHARPOS (start
))
16607 struct glyph_row
*pt_row
, *row
;
16608 struct glyph_row
*first_reusable_row
;
16609 struct glyph_row
*first_row_to_display
;
16611 int yb
= window_text_bottom_y (w
);
16613 /* Find the row starting at new_start, if there is one. Don't
16614 reuse a partially visible line at the end. */
16615 first_reusable_row
= start_row
;
16616 while (first_reusable_row
->enabled_p
16617 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16618 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16619 < CHARPOS (new_start
)))
16620 ++first_reusable_row
;
16622 /* Give up if there is no row to reuse. */
16623 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16624 || !first_reusable_row
->enabled_p
16625 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16626 != CHARPOS (new_start
)))
16629 /* We can reuse fully visible rows beginning with
16630 first_reusable_row to the end of the window. Set
16631 first_row_to_display to the first row that cannot be reused.
16632 Set pt_row to the row containing point, if there is any. */
16634 for (first_row_to_display
= first_reusable_row
;
16635 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16636 ++first_row_to_display
)
16638 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16639 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16640 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16641 && first_row_to_display
->ends_at_zv_p
16642 && pt_row
== NULL
)))
16643 pt_row
= first_row_to_display
;
16646 /* Start displaying at the start of first_row_to_display. */
16647 eassert (first_row_to_display
->y
< yb
);
16648 init_to_row_start (&it
, w
, first_row_to_display
);
16650 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16652 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16654 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16655 + WINDOW_HEADER_LINE_HEIGHT (w
));
16657 /* Display lines beginning with first_row_to_display in the
16658 desired matrix. Set last_text_row to the last row displayed
16659 that displays text. */
16660 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16661 if (pt_row
== NULL
)
16662 w
->cursor
.vpos
= -1;
16663 last_text_row
= NULL
;
16664 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16665 if (display_line (&it
))
16666 last_text_row
= it
.glyph_row
- 1;
16668 /* If point is in a reused row, adjust y and vpos of the cursor
16672 w
->cursor
.vpos
-= nrows_scrolled
;
16673 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16676 /* Give up if point isn't in a row displayed or reused. (This
16677 also handles the case where w->cursor.vpos < nrows_scrolled
16678 after the calls to display_line, which can happen with scroll
16679 margins. See bug#1295.) */
16680 if (w
->cursor
.vpos
< 0)
16682 clear_glyph_matrix (w
->desired_matrix
);
16686 /* Scroll the display. */
16687 run
.current_y
= first_reusable_row
->y
;
16688 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16689 run
.height
= it
.last_visible_y
- run
.current_y
;
16690 dy
= run
.current_y
- run
.desired_y
;
16695 FRAME_RIF (f
)->update_window_begin_hook (w
);
16696 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16697 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16698 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16702 /* Adjust Y positions of reused rows. */
16703 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16704 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16705 max_y
= it
.last_visible_y
;
16706 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16709 row
->visible_height
= row
->height
;
16710 if (row
->y
< min_y
)
16711 row
->visible_height
-= min_y
- row
->y
;
16712 if (row
->y
+ row
->height
> max_y
)
16713 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16714 if (row
->fringe_bitmap_periodic_p
)
16715 row
->redraw_fringe_bitmaps_p
= 1;
16718 /* Scroll the current matrix. */
16719 eassert (nrows_scrolled
> 0);
16720 rotate_matrix (w
->current_matrix
,
16722 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16725 /* Disable rows not reused. */
16726 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16727 row
->enabled_p
= 0;
16729 /* Point may have moved to a different line, so we cannot assume that
16730 the previous cursor position is valid; locate the correct row. */
16733 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16735 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16736 && !row
->ends_at_zv_p
;
16740 w
->cursor
.y
= row
->y
;
16742 if (row
< bottom_row
)
16744 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16745 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16747 /* Can't use this optimization with bidi-reordered glyph
16748 rows, unless cursor is already at point. */
16749 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16751 if (!(w
->cursor
.hpos
>= 0
16752 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16753 && BUFFERP (glyph
->object
)
16754 && glyph
->charpos
== PT
))
16759 && (!BUFFERP (glyph
->object
)
16760 || glyph
->charpos
< PT
);
16764 w
->cursor
.x
+= glyph
->pixel_width
;
16769 /* Adjust window end. A null value of last_text_row means that
16770 the window end is in reused rows which in turn means that
16771 only its vpos can have changed. */
16774 w
->window_end_bytepos
16775 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16776 wset_window_end_pos
16777 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16778 wset_window_end_vpos
16779 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16780 w
->desired_matrix
)));
16784 wset_window_end_vpos
16785 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16788 wset_window_end_valid (w
, Qnil
);
16789 w
->desired_matrix
->no_scrolling_p
= 1;
16792 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16802 /************************************************************************
16803 Window redisplay reusing current matrix when buffer has changed
16804 ************************************************************************/
16806 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16807 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16808 ptrdiff_t *, ptrdiff_t *);
16809 static struct glyph_row
*
16810 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16811 struct glyph_row
*);
16814 /* Return the last row in MATRIX displaying text. If row START is
16815 non-null, start searching with that row. IT gives the dimensions
16816 of the display. Value is null if matrix is empty; otherwise it is
16817 a pointer to the row found. */
16819 static struct glyph_row
*
16820 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16821 struct glyph_row
*start
)
16823 struct glyph_row
*row
, *row_found
;
16825 /* Set row_found to the last row in IT->w's current matrix
16826 displaying text. The loop looks funny but think of partially
16829 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16830 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16832 eassert (row
->enabled_p
);
16834 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16843 /* Return the last row in the current matrix of W that is not affected
16844 by changes at the start of current_buffer that occurred since W's
16845 current matrix was built. Value is null if no such row exists.
16847 BEG_UNCHANGED us the number of characters unchanged at the start of
16848 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16849 first changed character in current_buffer. Characters at positions <
16850 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16851 when the current matrix was built. */
16853 static struct glyph_row
*
16854 find_last_unchanged_at_beg_row (struct window
*w
)
16856 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16857 struct glyph_row
*row
;
16858 struct glyph_row
*row_found
= NULL
;
16859 int yb
= window_text_bottom_y (w
);
16861 /* Find the last row displaying unchanged text. */
16862 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16863 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16864 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16867 if (/* If row ends before first_changed_pos, it is unchanged,
16868 except in some case. */
16869 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16870 /* When row ends in ZV and we write at ZV it is not
16872 && !row
->ends_at_zv_p
16873 /* When first_changed_pos is the end of a continued line,
16874 row is not unchanged because it may be no longer
16876 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16877 && (row
->continued_p
16878 || row
->exact_window_width_line_p
))
16879 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16880 needs to be recomputed, so don't consider this row as
16881 unchanged. This happens when the last line was
16882 bidi-reordered and was killed immediately before this
16883 redisplay cycle. In that case, ROW->end stores the
16884 buffer position of the first visual-order character of
16885 the killed text, which is now beyond ZV. */
16886 && CHARPOS (row
->end
.pos
) <= ZV
)
16889 /* Stop if last visible row. */
16890 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16898 /* Find the first glyph row in the current matrix of W that is not
16899 affected by changes at the end of current_buffer since the
16900 time W's current matrix was built.
16902 Return in *DELTA the number of chars by which buffer positions in
16903 unchanged text at the end of current_buffer must be adjusted.
16905 Return in *DELTA_BYTES the corresponding number of bytes.
16907 Value is null if no such row exists, i.e. all rows are affected by
16910 static struct glyph_row
*
16911 find_first_unchanged_at_end_row (struct window
*w
,
16912 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16914 struct glyph_row
*row
;
16915 struct glyph_row
*row_found
= NULL
;
16917 *delta
= *delta_bytes
= 0;
16919 /* Display must not have been paused, otherwise the current matrix
16920 is not up to date. */
16921 eassert (!NILP (w
->window_end_valid
));
16923 /* A value of window_end_pos >= END_UNCHANGED means that the window
16924 end is in the range of changed text. If so, there is no
16925 unchanged row at the end of W's current matrix. */
16926 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16929 /* Set row to the last row in W's current matrix displaying text. */
16930 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16932 /* If matrix is entirely empty, no unchanged row exists. */
16933 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16935 /* The value of row is the last glyph row in the matrix having a
16936 meaningful buffer position in it. The end position of row
16937 corresponds to window_end_pos. This allows us to translate
16938 buffer positions in the current matrix to current buffer
16939 positions for characters not in changed text. */
16941 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16942 ptrdiff_t Z_BYTE_old
=
16943 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16944 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16945 struct glyph_row
*first_text_row
16946 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16948 *delta
= Z
- Z_old
;
16949 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16951 /* Set last_unchanged_pos to the buffer position of the last
16952 character in the buffer that has not been changed. Z is the
16953 index + 1 of the last character in current_buffer, i.e. by
16954 subtracting END_UNCHANGED we get the index of the last
16955 unchanged character, and we have to add BEG to get its buffer
16957 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16958 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16960 /* Search backward from ROW for a row displaying a line that
16961 starts at a minimum position >= last_unchanged_pos_old. */
16962 for (; row
> first_text_row
; --row
)
16964 /* This used to abort, but it can happen.
16965 It is ok to just stop the search instead here. KFS. */
16966 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16969 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16974 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16980 /* Make sure that glyph rows in the current matrix of window W
16981 reference the same glyph memory as corresponding rows in the
16982 frame's frame matrix. This function is called after scrolling W's
16983 current matrix on a terminal frame in try_window_id and
16984 try_window_reusing_current_matrix. */
16987 sync_frame_with_window_matrix_rows (struct window
*w
)
16989 struct frame
*f
= XFRAME (w
->frame
);
16990 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16992 /* Preconditions: W must be a leaf window and full-width. Its frame
16993 must have a frame matrix. */
16994 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16995 eassert (WINDOW_FULL_WIDTH_P (w
));
16996 eassert (!FRAME_WINDOW_P (f
));
16998 /* If W is a full-width window, glyph pointers in W's current matrix
16999 have, by definition, to be the same as glyph pointers in the
17000 corresponding frame matrix. Note that frame matrices have no
17001 marginal areas (see build_frame_matrix). */
17002 window_row
= w
->current_matrix
->rows
;
17003 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17004 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17005 while (window_row
< window_row_end
)
17007 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17008 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17010 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17011 frame_row
->glyphs
[TEXT_AREA
] = start
;
17012 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17013 frame_row
->glyphs
[LAST_AREA
] = end
;
17015 /* Disable frame rows whose corresponding window rows have
17016 been disabled in try_window_id. */
17017 if (!window_row
->enabled_p
)
17018 frame_row
->enabled_p
= 0;
17020 ++window_row
, ++frame_row
;
17025 /* Find the glyph row in window W containing CHARPOS. Consider all
17026 rows between START and END (not inclusive). END null means search
17027 all rows to the end of the display area of W. Value is the row
17028 containing CHARPOS or null. */
17031 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17032 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17034 struct glyph_row
*row
= start
;
17035 struct glyph_row
*best_row
= NULL
;
17036 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17039 /* If we happen to start on a header-line, skip that. */
17040 if (row
->mode_line_p
)
17043 if ((end
&& row
>= end
) || !row
->enabled_p
)
17046 last_y
= window_text_bottom_y (w
) - dy
;
17050 /* Give up if we have gone too far. */
17051 if (end
&& row
>= end
)
17053 /* This formerly returned if they were equal.
17054 I think that both quantities are of a "last plus one" type;
17055 if so, when they are equal, the row is within the screen. -- rms. */
17056 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17059 /* If it is in this row, return this row. */
17060 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17061 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17062 /* The end position of a row equals the start
17063 position of the next row. If CHARPOS is there, we
17064 would rather display it in the next line, except
17065 when this line ends in ZV. */
17066 && !row
->ends_at_zv_p
17067 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17068 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17072 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17073 || (!best_row
&& !row
->continued_p
))
17075 /* In bidi-reordered rows, there could be several rows
17076 occluding point, all of them belonging to the same
17077 continued line. We need to find the row which fits
17078 CHARPOS the best. */
17079 for (g
= row
->glyphs
[TEXT_AREA
];
17080 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17083 if (!STRINGP (g
->object
))
17085 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17087 mindif
= eabs (g
->charpos
- charpos
);
17089 /* Exact match always wins. */
17096 else if (best_row
&& !row
->continued_p
)
17103 /* Try to redisplay window W by reusing its existing display. W's
17104 current matrix must be up to date when this function is called,
17105 i.e. window_end_valid must not be nil.
17109 1 if display has been updated
17110 0 if otherwise unsuccessful
17111 -1 if redisplay with same window start is known not to succeed
17113 The following steps are performed:
17115 1. Find the last row in the current matrix of W that is not
17116 affected by changes at the start of current_buffer. If no such row
17119 2. Find the first row in W's current matrix that is not affected by
17120 changes at the end of current_buffer. Maybe there is no such row.
17122 3. Display lines beginning with the row + 1 found in step 1 to the
17123 row found in step 2 or, if step 2 didn't find a row, to the end of
17126 4. If cursor is not known to appear on the window, give up.
17128 5. If display stopped at the row found in step 2, scroll the
17129 display and current matrix as needed.
17131 6. Maybe display some lines at the end of W, if we must. This can
17132 happen under various circumstances, like a partially visible line
17133 becoming fully visible, or because newly displayed lines are displayed
17134 in smaller font sizes.
17136 7. Update W's window end information. */
17139 try_window_id (struct window
*w
)
17141 struct frame
*f
= XFRAME (w
->frame
);
17142 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17143 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17144 struct glyph_row
*last_unchanged_at_beg_row
;
17145 struct glyph_row
*first_unchanged_at_end_row
;
17146 struct glyph_row
*row
;
17147 struct glyph_row
*bottom_row
;
17150 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17152 struct text_pos start_pos
;
17154 int first_unchanged_at_end_vpos
= 0;
17155 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17156 struct text_pos start
;
17157 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17160 if (inhibit_try_window_id
)
17164 /* This is handy for debugging. */
17166 #define GIVE_UP(X) \
17168 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17172 #define GIVE_UP(X) return 0
17175 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17177 /* Don't use this for mini-windows because these can show
17178 messages and mini-buffers, and we don't handle that here. */
17179 if (MINI_WINDOW_P (w
))
17182 /* This flag is used to prevent redisplay optimizations. */
17183 if (windows_or_buffers_changed
|| cursor_type_changed
)
17186 /* Verify that narrowing has not changed.
17187 Also verify that we were not told to prevent redisplay optimizations.
17188 It would be nice to further
17189 reduce the number of cases where this prevents try_window_id. */
17190 if (current_buffer
->clip_changed
17191 || current_buffer
->prevent_redisplay_optimizations_p
)
17194 /* Window must either use window-based redisplay or be full width. */
17195 if (!FRAME_WINDOW_P (f
)
17196 && (!FRAME_LINE_INS_DEL_OK (f
)
17197 || !WINDOW_FULL_WIDTH_P (w
)))
17200 /* Give up if point is known NOT to appear in W. */
17201 if (PT
< CHARPOS (start
))
17204 /* Another way to prevent redisplay optimizations. */
17205 if (w
->last_modified
== 0)
17208 /* Verify that window is not hscrolled. */
17209 if (w
->hscroll
!= 0)
17212 /* Verify that display wasn't paused. */
17213 if (NILP (w
->window_end_valid
))
17216 /* Can't use this if highlighting a region because a cursor movement
17217 will do more than just set the cursor. */
17218 if (!NILP (Vtransient_mark_mode
)
17219 && !NILP (BVAR (current_buffer
, mark_active
)))
17222 /* Likewise if highlighting trailing whitespace. */
17223 if (!NILP (Vshow_trailing_whitespace
))
17226 /* Likewise if showing a region. */
17227 if (!NILP (w
->region_showing
))
17230 /* Can't use this if overlay arrow position and/or string have
17232 if (overlay_arrows_changed_p ())
17235 /* When word-wrap is on, adding a space to the first word of a
17236 wrapped line can change the wrap position, altering the line
17237 above it. It might be worthwhile to handle this more
17238 intelligently, but for now just redisplay from scratch. */
17239 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17242 /* Under bidi reordering, adding or deleting a character in the
17243 beginning of a paragraph, before the first strong directional
17244 character, can change the base direction of the paragraph (unless
17245 the buffer specifies a fixed paragraph direction), which will
17246 require to redisplay the whole paragraph. It might be worthwhile
17247 to find the paragraph limits and widen the range of redisplayed
17248 lines to that, but for now just give up this optimization and
17249 redisplay from scratch. */
17250 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17251 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17254 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17255 only if buffer has really changed. The reason is that the gap is
17256 initially at Z for freshly visited files. The code below would
17257 set end_unchanged to 0 in that case. */
17258 if (MODIFF
> SAVE_MODIFF
17259 /* This seems to happen sometimes after saving a buffer. */
17260 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17262 if (GPT
- BEG
< BEG_UNCHANGED
)
17263 BEG_UNCHANGED
= GPT
- BEG
;
17264 if (Z
- GPT
< END_UNCHANGED
)
17265 END_UNCHANGED
= Z
- GPT
;
17268 /* The position of the first and last character that has been changed. */
17269 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17270 last_changed_charpos
= Z
- END_UNCHANGED
;
17272 /* If window starts after a line end, and the last change is in
17273 front of that newline, then changes don't affect the display.
17274 This case happens with stealth-fontification. Note that although
17275 the display is unchanged, glyph positions in the matrix have to
17276 be adjusted, of course. */
17277 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17278 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17279 && ((last_changed_charpos
< CHARPOS (start
)
17280 && CHARPOS (start
) == BEGV
)
17281 || (last_changed_charpos
< CHARPOS (start
) - 1
17282 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17284 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17285 struct glyph_row
*r0
;
17287 /* Compute how many chars/bytes have been added to or removed
17288 from the buffer. */
17289 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17290 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17291 Z_delta
= Z
- Z_old
;
17292 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17294 /* Give up if PT is not in the window. Note that it already has
17295 been checked at the start of try_window_id that PT is not in
17296 front of the window start. */
17297 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17300 /* If window start is unchanged, we can reuse the whole matrix
17301 as is, after adjusting glyph positions. No need to compute
17302 the window end again, since its offset from Z hasn't changed. */
17303 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17304 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17305 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17306 /* PT must not be in a partially visible line. */
17307 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17308 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17310 /* Adjust positions in the glyph matrix. */
17311 if (Z_delta
|| Z_delta_bytes
)
17313 struct glyph_row
*r1
17314 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17315 increment_matrix_positions (w
->current_matrix
,
17316 MATRIX_ROW_VPOS (r0
, current_matrix
),
17317 MATRIX_ROW_VPOS (r1
, current_matrix
),
17318 Z_delta
, Z_delta_bytes
);
17321 /* Set the cursor. */
17322 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17324 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17331 /* Handle the case that changes are all below what is displayed in
17332 the window, and that PT is in the window. This shortcut cannot
17333 be taken if ZV is visible in the window, and text has been added
17334 there that is visible in the window. */
17335 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17336 /* ZV is not visible in the window, or there are no
17337 changes at ZV, actually. */
17338 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17339 || first_changed_charpos
== last_changed_charpos
))
17341 struct glyph_row
*r0
;
17343 /* Give up if PT is not in the window. Note that it already has
17344 been checked at the start of try_window_id that PT is not in
17345 front of the window start. */
17346 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17349 /* If window start is unchanged, we can reuse the whole matrix
17350 as is, without changing glyph positions since no text has
17351 been added/removed in front of the window end. */
17352 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17353 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17354 /* PT must not be in a partially visible line. */
17355 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17356 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17358 /* We have to compute the window end anew since text
17359 could have been added/removed after it. */
17360 wset_window_end_pos
17361 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17362 w
->window_end_bytepos
17363 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17365 /* Set the cursor. */
17366 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17368 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17375 /* Give up if window start is in the changed area.
17377 The condition used to read
17379 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17381 but why that was tested escapes me at the moment. */
17382 if (CHARPOS (start
) >= first_changed_charpos
17383 && CHARPOS (start
) <= last_changed_charpos
)
17386 /* Check that window start agrees with the start of the first glyph
17387 row in its current matrix. Check this after we know the window
17388 start is not in changed text, otherwise positions would not be
17390 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17391 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17394 /* Give up if the window ends in strings. Overlay strings
17395 at the end are difficult to handle, so don't try. */
17396 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17397 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17400 /* Compute the position at which we have to start displaying new
17401 lines. Some of the lines at the top of the window might be
17402 reusable because they are not displaying changed text. Find the
17403 last row in W's current matrix not affected by changes at the
17404 start of current_buffer. Value is null if changes start in the
17405 first line of window. */
17406 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17407 if (last_unchanged_at_beg_row
)
17409 /* Avoid starting to display in the middle of a character, a TAB
17410 for instance. This is easier than to set up the iterator
17411 exactly, and it's not a frequent case, so the additional
17412 effort wouldn't really pay off. */
17413 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17414 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17415 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17416 --last_unchanged_at_beg_row
;
17418 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17421 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17423 start_pos
= it
.current
.pos
;
17425 /* Start displaying new lines in the desired matrix at the same
17426 vpos we would use in the current matrix, i.e. below
17427 last_unchanged_at_beg_row. */
17428 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17430 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17431 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17433 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17437 /* There are no reusable lines at the start of the window.
17438 Start displaying in the first text line. */
17439 start_display (&it
, w
, start
);
17440 it
.vpos
= it
.first_vpos
;
17441 start_pos
= it
.current
.pos
;
17444 /* Find the first row that is not affected by changes at the end of
17445 the buffer. Value will be null if there is no unchanged row, in
17446 which case we must redisplay to the end of the window. delta
17447 will be set to the value by which buffer positions beginning with
17448 first_unchanged_at_end_row have to be adjusted due to text
17450 first_unchanged_at_end_row
17451 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17452 IF_DEBUG (debug_delta
= delta
);
17453 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17455 /* Set stop_pos to the buffer position up to which we will have to
17456 display new lines. If first_unchanged_at_end_row != NULL, this
17457 is the buffer position of the start of the line displayed in that
17458 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17459 that we don't stop at a buffer position. */
17461 if (first_unchanged_at_end_row
)
17463 eassert (last_unchanged_at_beg_row
== NULL
17464 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17466 /* If this is a continuation line, move forward to the next one
17467 that isn't. Changes in lines above affect this line.
17468 Caution: this may move first_unchanged_at_end_row to a row
17469 not displaying text. */
17470 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17471 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17472 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17473 < it
.last_visible_y
))
17474 ++first_unchanged_at_end_row
;
17476 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17477 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17478 >= it
.last_visible_y
))
17479 first_unchanged_at_end_row
= NULL
;
17482 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17484 first_unchanged_at_end_vpos
17485 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17486 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17489 else if (last_unchanged_at_beg_row
== NULL
)
17495 /* Either there is no unchanged row at the end, or the one we have
17496 now displays text. This is a necessary condition for the window
17497 end pos calculation at the end of this function. */
17498 eassert (first_unchanged_at_end_row
== NULL
17499 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17501 debug_last_unchanged_at_beg_vpos
17502 = (last_unchanged_at_beg_row
17503 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17505 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17507 #endif /* GLYPH_DEBUG */
17510 /* Display new lines. Set last_text_row to the last new line
17511 displayed which has text on it, i.e. might end up as being the
17512 line where the window_end_vpos is. */
17513 w
->cursor
.vpos
= -1;
17514 last_text_row
= NULL
;
17515 overlay_arrow_seen
= 0;
17516 while (it
.current_y
< it
.last_visible_y
17517 && !fonts_changed_p
17518 && (first_unchanged_at_end_row
== NULL
17519 || IT_CHARPOS (it
) < stop_pos
))
17521 if (display_line (&it
))
17522 last_text_row
= it
.glyph_row
- 1;
17525 if (fonts_changed_p
)
17529 /* Compute differences in buffer positions, y-positions etc. for
17530 lines reused at the bottom of the window. Compute what we can
17532 if (first_unchanged_at_end_row
17533 /* No lines reused because we displayed everything up to the
17534 bottom of the window. */
17535 && it
.current_y
< it
.last_visible_y
)
17538 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17540 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17541 run
.current_y
= first_unchanged_at_end_row
->y
;
17542 run
.desired_y
= run
.current_y
+ dy
;
17543 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17547 delta
= delta_bytes
= dvpos
= dy
17548 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17549 first_unchanged_at_end_row
= NULL
;
17551 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17554 /* Find the cursor if not already found. We have to decide whether
17555 PT will appear on this window (it sometimes doesn't, but this is
17556 not a very frequent case.) This decision has to be made before
17557 the current matrix is altered. A value of cursor.vpos < 0 means
17558 that PT is either in one of the lines beginning at
17559 first_unchanged_at_end_row or below the window. Don't care for
17560 lines that might be displayed later at the window end; as
17561 mentioned, this is not a frequent case. */
17562 if (w
->cursor
.vpos
< 0)
17564 /* Cursor in unchanged rows at the top? */
17565 if (PT
< CHARPOS (start_pos
)
17566 && last_unchanged_at_beg_row
)
17568 row
= row_containing_pos (w
, PT
,
17569 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17570 last_unchanged_at_beg_row
+ 1, 0);
17572 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17575 /* Start from first_unchanged_at_end_row looking for PT. */
17576 else if (first_unchanged_at_end_row
)
17578 row
= row_containing_pos (w
, PT
- delta
,
17579 first_unchanged_at_end_row
, NULL
, 0);
17581 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17582 delta_bytes
, dy
, dvpos
);
17585 /* Give up if cursor was not found. */
17586 if (w
->cursor
.vpos
< 0)
17588 clear_glyph_matrix (w
->desired_matrix
);
17593 /* Don't let the cursor end in the scroll margins. */
17595 int this_scroll_margin
, cursor_height
;
17597 this_scroll_margin
=
17598 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17599 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17600 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17602 if ((w
->cursor
.y
< this_scroll_margin
17603 && CHARPOS (start
) > BEGV
)
17604 /* Old redisplay didn't take scroll margin into account at the bottom,
17605 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17606 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17607 ? cursor_height
+ this_scroll_margin
17608 : 1)) > it
.last_visible_y
)
17610 w
->cursor
.vpos
= -1;
17611 clear_glyph_matrix (w
->desired_matrix
);
17616 /* Scroll the display. Do it before changing the current matrix so
17617 that xterm.c doesn't get confused about where the cursor glyph is
17619 if (dy
&& run
.height
)
17623 if (FRAME_WINDOW_P (f
))
17625 FRAME_RIF (f
)->update_window_begin_hook (w
);
17626 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17627 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17628 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17632 /* Terminal frame. In this case, dvpos gives the number of
17633 lines to scroll by; dvpos < 0 means scroll up. */
17635 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17636 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17637 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17638 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17639 + window_internal_height (w
));
17641 #if defined (HAVE_GPM) || defined (MSDOS)
17642 x_clear_window_mouse_face (w
);
17644 /* Perform the operation on the screen. */
17647 /* Scroll last_unchanged_at_beg_row to the end of the
17648 window down dvpos lines. */
17649 set_terminal_window (f
, end
);
17651 /* On dumb terminals delete dvpos lines at the end
17652 before inserting dvpos empty lines. */
17653 if (!FRAME_SCROLL_REGION_OK (f
))
17654 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17656 /* Insert dvpos empty lines in front of
17657 last_unchanged_at_beg_row. */
17658 ins_del_lines (f
, from
, dvpos
);
17660 else if (dvpos
< 0)
17662 /* Scroll up last_unchanged_at_beg_vpos to the end of
17663 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17664 set_terminal_window (f
, end
);
17666 /* Delete dvpos lines in front of
17667 last_unchanged_at_beg_vpos. ins_del_lines will set
17668 the cursor to the given vpos and emit |dvpos| delete
17670 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17672 /* On a dumb terminal insert dvpos empty lines at the
17674 if (!FRAME_SCROLL_REGION_OK (f
))
17675 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17678 set_terminal_window (f
, 0);
17684 /* Shift reused rows of the current matrix to the right position.
17685 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17687 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17688 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17691 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17692 bottom_vpos
, dvpos
);
17693 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17696 else if (dvpos
> 0)
17698 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17699 bottom_vpos
, dvpos
);
17700 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17701 first_unchanged_at_end_vpos
+ dvpos
, 0);
17704 /* For frame-based redisplay, make sure that current frame and window
17705 matrix are in sync with respect to glyph memory. */
17706 if (!FRAME_WINDOW_P (f
))
17707 sync_frame_with_window_matrix_rows (w
);
17709 /* Adjust buffer positions in reused rows. */
17710 if (delta
|| delta_bytes
)
17711 increment_matrix_positions (current_matrix
,
17712 first_unchanged_at_end_vpos
+ dvpos
,
17713 bottom_vpos
, delta
, delta_bytes
);
17715 /* Adjust Y positions. */
17717 shift_glyph_matrix (w
, current_matrix
,
17718 first_unchanged_at_end_vpos
+ dvpos
,
17721 if (first_unchanged_at_end_row
)
17723 first_unchanged_at_end_row
+= dvpos
;
17724 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17725 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17726 first_unchanged_at_end_row
= NULL
;
17729 /* If scrolling up, there may be some lines to display at the end of
17731 last_text_row_at_end
= NULL
;
17734 /* Scrolling up can leave for example a partially visible line
17735 at the end of the window to be redisplayed. */
17736 /* Set last_row to the glyph row in the current matrix where the
17737 window end line is found. It has been moved up or down in
17738 the matrix by dvpos. */
17739 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17740 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17742 /* If last_row is the window end line, it should display text. */
17743 eassert (last_row
->displays_text_p
);
17745 /* If window end line was partially visible before, begin
17746 displaying at that line. Otherwise begin displaying with the
17747 line following it. */
17748 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17750 init_to_row_start (&it
, w
, last_row
);
17751 it
.vpos
= last_vpos
;
17752 it
.current_y
= last_row
->y
;
17756 init_to_row_end (&it
, w
, last_row
);
17757 it
.vpos
= 1 + last_vpos
;
17758 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17762 /* We may start in a continuation line. If so, we have to
17763 get the right continuation_lines_width and current_x. */
17764 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17765 it
.hpos
= it
.current_x
= 0;
17767 /* Display the rest of the lines at the window end. */
17768 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17769 while (it
.current_y
< it
.last_visible_y
17770 && !fonts_changed_p
)
17772 /* Is it always sure that the display agrees with lines in
17773 the current matrix? I don't think so, so we mark rows
17774 displayed invalid in the current matrix by setting their
17775 enabled_p flag to zero. */
17776 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17777 if (display_line (&it
))
17778 last_text_row_at_end
= it
.glyph_row
- 1;
17782 /* Update window_end_pos and window_end_vpos. */
17783 if (first_unchanged_at_end_row
17784 && !last_text_row_at_end
)
17786 /* Window end line if one of the preserved rows from the current
17787 matrix. Set row to the last row displaying text in current
17788 matrix starting at first_unchanged_at_end_row, after
17790 eassert (first_unchanged_at_end_row
->displays_text_p
);
17791 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17792 first_unchanged_at_end_row
);
17793 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17795 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17796 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17797 wset_window_end_vpos
17798 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17799 eassert (w
->window_end_bytepos
>= 0);
17800 IF_DEBUG (debug_method_add (w
, "A"));
17802 else if (last_text_row_at_end
)
17804 wset_window_end_pos
17805 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17806 w
->window_end_bytepos
17807 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17808 wset_window_end_vpos
17809 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17811 eassert (w
->window_end_bytepos
>= 0);
17812 IF_DEBUG (debug_method_add (w
, "B"));
17814 else if (last_text_row
)
17816 /* We have displayed either to the end of the window or at the
17817 end of the window, i.e. the last row with text is to be found
17818 in the desired matrix. */
17819 wset_window_end_pos
17820 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17821 w
->window_end_bytepos
17822 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17823 wset_window_end_vpos
17824 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17825 eassert (w
->window_end_bytepos
>= 0);
17827 else if (first_unchanged_at_end_row
== NULL
17828 && last_text_row
== NULL
17829 && last_text_row_at_end
== NULL
)
17831 /* Displayed to end of window, but no line containing text was
17832 displayed. Lines were deleted at the end of the window. */
17833 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17834 int vpos
= XFASTINT (w
->window_end_vpos
);
17835 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17836 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17839 row
== NULL
&& vpos
>= first_vpos
;
17840 --vpos
, --current_row
, --desired_row
)
17842 if (desired_row
->enabled_p
)
17844 if (desired_row
->displays_text_p
)
17847 else if (current_row
->displays_text_p
)
17851 eassert (row
!= NULL
);
17852 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17853 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17854 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17855 eassert (w
->window_end_bytepos
>= 0);
17856 IF_DEBUG (debug_method_add (w
, "C"));
17861 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17862 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17864 /* Record that display has not been completed. */
17865 wset_window_end_valid (w
, Qnil
);
17866 w
->desired_matrix
->no_scrolling_p
= 1;
17874 /***********************************************************************
17875 More debugging support
17876 ***********************************************************************/
17880 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17881 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17882 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17885 /* Dump the contents of glyph matrix MATRIX on stderr.
17887 GLYPHS 0 means don't show glyph contents.
17888 GLYPHS 1 means show glyphs in short form
17889 GLYPHS > 1 means show glyphs in long form. */
17892 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17895 for (i
= 0; i
< matrix
->nrows
; ++i
)
17896 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17900 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17901 the glyph row and area where the glyph comes from. */
17904 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17906 if (glyph
->type
== CHAR_GLYPH
)
17909 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17910 glyph
- row
->glyphs
[TEXT_AREA
],
17913 (BUFFERP (glyph
->object
)
17915 : (STRINGP (glyph
->object
)
17918 glyph
->pixel_width
,
17920 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17924 glyph
->left_box_line_p
,
17925 glyph
->right_box_line_p
);
17927 else if (glyph
->type
== STRETCH_GLYPH
)
17930 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17931 glyph
- row
->glyphs
[TEXT_AREA
],
17934 (BUFFERP (glyph
->object
)
17936 : (STRINGP (glyph
->object
)
17939 glyph
->pixel_width
,
17943 glyph
->left_box_line_p
,
17944 glyph
->right_box_line_p
);
17946 else if (glyph
->type
== IMAGE_GLYPH
)
17949 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17950 glyph
- row
->glyphs
[TEXT_AREA
],
17953 (BUFFERP (glyph
->object
)
17955 : (STRINGP (glyph
->object
)
17958 glyph
->pixel_width
,
17962 glyph
->left_box_line_p
,
17963 glyph
->right_box_line_p
);
17965 else if (glyph
->type
== COMPOSITE_GLYPH
)
17968 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17969 glyph
- row
->glyphs
[TEXT_AREA
],
17972 (BUFFERP (glyph
->object
)
17974 : (STRINGP (glyph
->object
)
17977 glyph
->pixel_width
,
17979 if (glyph
->u
.cmp
.automatic
)
17982 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17983 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17985 glyph
->left_box_line_p
,
17986 glyph
->right_box_line_p
);
17991 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17992 GLYPHS 0 means don't show glyph contents.
17993 GLYPHS 1 means show glyphs in short form
17994 GLYPHS > 1 means show glyphs in long form. */
17997 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18001 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18002 fprintf (stderr
, "======================================================================\n");
18004 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18005 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18007 MATRIX_ROW_START_CHARPOS (row
),
18008 MATRIX_ROW_END_CHARPOS (row
),
18009 row
->used
[TEXT_AREA
],
18010 row
->contains_overlapping_glyphs_p
,
18012 row
->truncated_on_left_p
,
18013 row
->truncated_on_right_p
,
18015 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18016 row
->displays_text_p
,
18019 row
->ends_in_middle_of_char_p
,
18020 row
->starts_in_middle_of_char_p
,
18026 row
->visible_height
,
18029 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18030 row
->end
.overlay_string_index
,
18031 row
->continuation_lines_width
);
18032 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18033 CHARPOS (row
->start
.string_pos
),
18034 CHARPOS (row
->end
.string_pos
));
18035 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18036 row
->end
.dpvec_index
);
18043 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18045 struct glyph
*glyph
= row
->glyphs
[area
];
18046 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18048 /* Glyph for a line end in text. */
18049 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18052 if (glyph
< glyph_end
)
18053 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18055 for (; glyph
< glyph_end
; ++glyph
)
18056 dump_glyph (row
, glyph
, area
);
18059 else if (glyphs
== 1)
18063 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18065 char *s
= alloca (row
->used
[area
] + 1);
18068 for (i
= 0; i
< row
->used
[area
]; ++i
)
18070 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18071 if (glyph
->type
== CHAR_GLYPH
18072 && glyph
->u
.ch
< 0x80
18073 && glyph
->u
.ch
>= ' ')
18074 s
[i
] = glyph
->u
.ch
;
18080 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18086 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18087 Sdump_glyph_matrix
, 0, 1, "p",
18088 doc
: /* Dump the current matrix of the selected window to stderr.
18089 Shows contents of glyph row structures. With non-nil
18090 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18091 glyphs in short form, otherwise show glyphs in long form. */)
18092 (Lisp_Object glyphs
)
18094 struct window
*w
= XWINDOW (selected_window
);
18095 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18097 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18098 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18099 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18100 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18101 fprintf (stderr
, "=============================================\n");
18102 dump_glyph_matrix (w
->current_matrix
,
18103 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18108 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18109 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18112 struct frame
*f
= XFRAME (selected_frame
);
18113 dump_glyph_matrix (f
->current_matrix
, 1);
18118 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18119 doc
: /* Dump glyph row ROW to stderr.
18120 GLYPH 0 means don't dump glyphs.
18121 GLYPH 1 means dump glyphs in short form.
18122 GLYPH > 1 or omitted means dump glyphs in long form. */)
18123 (Lisp_Object row
, Lisp_Object glyphs
)
18125 struct glyph_matrix
*matrix
;
18128 CHECK_NUMBER (row
);
18129 matrix
= XWINDOW (selected_window
)->current_matrix
;
18131 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18132 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18134 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18139 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18140 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18141 GLYPH 0 means don't dump glyphs.
18142 GLYPH 1 means dump glyphs in short form.
18143 GLYPH > 1 or omitted means dump glyphs in long form. */)
18144 (Lisp_Object row
, Lisp_Object glyphs
)
18146 struct frame
*sf
= SELECTED_FRAME ();
18147 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18150 CHECK_NUMBER (row
);
18152 if (vpos
>= 0 && vpos
< m
->nrows
)
18153 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18154 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18159 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18160 doc
: /* Toggle tracing of redisplay.
18161 With ARG, turn tracing on if and only if ARG is positive. */)
18165 trace_redisplay_p
= !trace_redisplay_p
;
18168 arg
= Fprefix_numeric_value (arg
);
18169 trace_redisplay_p
= XINT (arg
) > 0;
18176 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18177 doc
: /* Like `format', but print result to stderr.
18178 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18179 (ptrdiff_t nargs
, Lisp_Object
*args
)
18181 Lisp_Object s
= Fformat (nargs
, args
);
18182 fprintf (stderr
, "%s", SDATA (s
));
18186 #endif /* GLYPH_DEBUG */
18190 /***********************************************************************
18191 Building Desired Matrix Rows
18192 ***********************************************************************/
18194 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18195 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18197 static struct glyph_row
*
18198 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18200 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18201 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18202 struct buffer
*old
= current_buffer
;
18203 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18204 int arrow_len
= SCHARS (overlay_arrow_string
);
18205 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18206 const unsigned char *p
;
18209 int n_glyphs_before
;
18211 set_buffer_temp (buffer
);
18212 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18213 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18214 SET_TEXT_POS (it
.position
, 0, 0);
18216 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18218 while (p
< arrow_end
)
18220 Lisp_Object face
, ilisp
;
18222 /* Get the next character. */
18224 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18227 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18228 if (! ASCII_CHAR_P (it
.c
))
18229 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18233 /* Get its face. */
18234 ilisp
= make_number (p
- arrow_string
);
18235 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18236 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18238 /* Compute its width, get its glyphs. */
18239 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18240 SET_TEXT_POS (it
.position
, -1, -1);
18241 PRODUCE_GLYPHS (&it
);
18243 /* If this character doesn't fit any more in the line, we have
18244 to remove some glyphs. */
18245 if (it
.current_x
> it
.last_visible_x
)
18247 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18252 set_buffer_temp (old
);
18253 return it
.glyph_row
;
18257 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18258 glyphs to insert is determined by produce_special_glyphs. */
18261 insert_left_trunc_glyphs (struct it
*it
)
18263 struct it truncate_it
;
18264 struct glyph
*from
, *end
, *to
, *toend
;
18266 eassert (!FRAME_WINDOW_P (it
->f
)
18267 || (!it
->glyph_row
->reversed_p
18268 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18269 || (it
->glyph_row
->reversed_p
18270 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18272 /* Get the truncation glyphs. */
18274 truncate_it
.current_x
= 0;
18275 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18276 truncate_it
.glyph_row
= &scratch_glyph_row
;
18277 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18278 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18279 truncate_it
.object
= make_number (0);
18280 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18282 /* Overwrite glyphs from IT with truncation glyphs. */
18283 if (!it
->glyph_row
->reversed_p
)
18285 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18287 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18288 end
= from
+ tused
;
18289 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18290 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18291 if (FRAME_WINDOW_P (it
->f
))
18293 /* On GUI frames, when variable-size fonts are displayed,
18294 the truncation glyphs may need more pixels than the row's
18295 glyphs they overwrite. We overwrite more glyphs to free
18296 enough screen real estate, and enlarge the stretch glyph
18297 on the right (see display_line), if there is one, to
18298 preserve the screen position of the truncation glyphs on
18301 struct glyph
*g
= to
;
18304 /* The first glyph could be partially visible, in which case
18305 it->glyph_row->x will be negative. But we want the left
18306 truncation glyphs to be aligned at the left margin of the
18307 window, so we override the x coordinate at which the row
18309 it
->glyph_row
->x
= 0;
18310 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18312 w
+= g
->pixel_width
;
18315 if (g
- to
- tused
> 0)
18317 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18318 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18320 used
= it
->glyph_row
->used
[TEXT_AREA
];
18321 if (it
->glyph_row
->truncated_on_right_p
18322 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18323 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18326 int extra
= w
- it
->truncation_pixel_width
;
18328 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18335 /* There may be padding glyphs left over. Overwrite them too. */
18336 if (!FRAME_WINDOW_P (it
->f
))
18338 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18340 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18347 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18351 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18353 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18354 that back to front. */
18355 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18356 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18357 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18358 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18359 if (FRAME_WINDOW_P (it
->f
))
18362 struct glyph
*g
= to
;
18364 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18366 w
+= g
->pixel_width
;
18369 if (to
- g
- tused
> 0)
18371 if (it
->glyph_row
->truncated_on_right_p
18372 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18373 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18375 int extra
= w
- it
->truncation_pixel_width
;
18377 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18381 while (from
>= end
&& to
>= toend
)
18383 if (!FRAME_WINDOW_P (it
->f
))
18385 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18388 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18389 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18390 while (from
>= end
&& to
>= toend
)
18396 /* Need to free some room before prepending additional
18398 int move_by
= from
- end
+ 1;
18399 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18400 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18402 for ( ; g
>= g0
; g
--)
18404 while (from
>= end
)
18406 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18411 /* Compute the hash code for ROW. */
18413 row_hash (struct glyph_row
*row
)
18416 unsigned hashval
= 0;
18418 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18419 for (k
= 0; k
< row
->used
[area
]; ++k
)
18420 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18421 + row
->glyphs
[area
][k
].u
.val
18422 + row
->glyphs
[area
][k
].face_id
18423 + row
->glyphs
[area
][k
].padding_p
18424 + (row
->glyphs
[area
][k
].type
<< 2));
18429 /* Compute the pixel height and width of IT->glyph_row.
18431 Most of the time, ascent and height of a display line will be equal
18432 to the max_ascent and max_height values of the display iterator
18433 structure. This is not the case if
18435 1. We hit ZV without displaying anything. In this case, max_ascent
18436 and max_height will be zero.
18438 2. We have some glyphs that don't contribute to the line height.
18439 (The glyph row flag contributes_to_line_height_p is for future
18440 pixmap extensions).
18442 The first case is easily covered by using default values because in
18443 these cases, the line height does not really matter, except that it
18444 must not be zero. */
18447 compute_line_metrics (struct it
*it
)
18449 struct glyph_row
*row
= it
->glyph_row
;
18451 if (FRAME_WINDOW_P (it
->f
))
18453 int i
, min_y
, max_y
;
18455 /* The line may consist of one space only, that was added to
18456 place the cursor on it. If so, the row's height hasn't been
18458 if (row
->height
== 0)
18460 if (it
->max_ascent
+ it
->max_descent
== 0)
18461 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18462 row
->ascent
= it
->max_ascent
;
18463 row
->height
= it
->max_ascent
+ it
->max_descent
;
18464 row
->phys_ascent
= it
->max_phys_ascent
;
18465 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18466 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18469 /* Compute the width of this line. */
18470 row
->pixel_width
= row
->x
;
18471 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18472 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18474 eassert (row
->pixel_width
>= 0);
18475 eassert (row
->ascent
>= 0 && row
->height
> 0);
18477 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18478 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18480 /* If first line's physical ascent is larger than its logical
18481 ascent, use the physical ascent, and make the row taller.
18482 This makes accented characters fully visible. */
18483 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18484 && row
->phys_ascent
> row
->ascent
)
18486 row
->height
+= row
->phys_ascent
- row
->ascent
;
18487 row
->ascent
= row
->phys_ascent
;
18490 /* Compute how much of the line is visible. */
18491 row
->visible_height
= row
->height
;
18493 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18494 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18496 if (row
->y
< min_y
)
18497 row
->visible_height
-= min_y
- row
->y
;
18498 if (row
->y
+ row
->height
> max_y
)
18499 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18503 row
->pixel_width
= row
->used
[TEXT_AREA
];
18504 if (row
->continued_p
)
18505 row
->pixel_width
-= it
->continuation_pixel_width
;
18506 else if (row
->truncated_on_right_p
)
18507 row
->pixel_width
-= it
->truncation_pixel_width
;
18508 row
->ascent
= row
->phys_ascent
= 0;
18509 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18510 row
->extra_line_spacing
= 0;
18513 /* Compute a hash code for this row. */
18514 row
->hash
= row_hash (row
);
18516 it
->max_ascent
= it
->max_descent
= 0;
18517 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18521 /* Append one space to the glyph row of iterator IT if doing a
18522 window-based redisplay. The space has the same face as
18523 IT->face_id. Value is non-zero if a space was added.
18525 This function is called to make sure that there is always one glyph
18526 at the end of a glyph row that the cursor can be set on under
18527 window-systems. (If there weren't such a glyph we would not know
18528 how wide and tall a box cursor should be displayed).
18530 At the same time this space let's a nicely handle clearing to the
18531 end of the line if the row ends in italic text. */
18534 append_space_for_newline (struct it
*it
, int default_face_p
)
18536 if (FRAME_WINDOW_P (it
->f
))
18538 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18540 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18541 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18543 /* Save some values that must not be changed.
18544 Must save IT->c and IT->len because otherwise
18545 ITERATOR_AT_END_P wouldn't work anymore after
18546 append_space_for_newline has been called. */
18547 enum display_element_type saved_what
= it
->what
;
18548 int saved_c
= it
->c
, saved_len
= it
->len
;
18549 int saved_char_to_display
= it
->char_to_display
;
18550 int saved_x
= it
->current_x
;
18551 int saved_face_id
= it
->face_id
;
18552 struct text_pos saved_pos
;
18553 Lisp_Object saved_object
;
18556 saved_object
= it
->object
;
18557 saved_pos
= it
->position
;
18559 it
->what
= IT_CHARACTER
;
18560 memset (&it
->position
, 0, sizeof it
->position
);
18561 it
->object
= make_number (0);
18562 it
->c
= it
->char_to_display
= ' ';
18565 /* If the default face was remapped, be sure to use the
18566 remapped face for the appended newline. */
18567 if (default_face_p
)
18568 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18569 else if (it
->face_before_selective_p
)
18570 it
->face_id
= it
->saved_face_id
;
18571 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18572 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18574 PRODUCE_GLYPHS (it
);
18576 it
->override_ascent
= -1;
18577 it
->constrain_row_ascent_descent_p
= 0;
18578 it
->current_x
= saved_x
;
18579 it
->object
= saved_object
;
18580 it
->position
= saved_pos
;
18581 it
->what
= saved_what
;
18582 it
->face_id
= saved_face_id
;
18583 it
->len
= saved_len
;
18585 it
->char_to_display
= saved_char_to_display
;
18594 /* Extend the face of the last glyph in the text area of IT->glyph_row
18595 to the end of the display line. Called from display_line. If the
18596 glyph row is empty, add a space glyph to it so that we know the
18597 face to draw. Set the glyph row flag fill_line_p. If the glyph
18598 row is R2L, prepend a stretch glyph to cover the empty space to the
18599 left of the leftmost glyph. */
18602 extend_face_to_end_of_line (struct it
*it
)
18604 struct face
*face
, *default_face
;
18605 struct frame
*f
= it
->f
;
18607 /* If line is already filled, do nothing. Non window-system frames
18608 get a grace of one more ``pixel'' because their characters are
18609 1-``pixel'' wide, so they hit the equality too early. This grace
18610 is needed only for R2L rows that are not continued, to produce
18611 one extra blank where we could display the cursor. */
18612 if (it
->current_x
>= it
->last_visible_x
18613 + (!FRAME_WINDOW_P (f
)
18614 && it
->glyph_row
->reversed_p
18615 && !it
->glyph_row
->continued_p
))
18618 /* The default face, possibly remapped. */
18619 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18621 /* Face extension extends the background and box of IT->face_id
18622 to the end of the line. If the background equals the background
18623 of the frame, we don't have to do anything. */
18624 if (it
->face_before_selective_p
)
18625 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18627 face
= FACE_FROM_ID (f
, it
->face_id
);
18629 if (FRAME_WINDOW_P (f
)
18630 && it
->glyph_row
->displays_text_p
18631 && face
->box
== FACE_NO_BOX
18632 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18634 && !it
->glyph_row
->reversed_p
)
18637 /* Set the glyph row flag indicating that the face of the last glyph
18638 in the text area has to be drawn to the end of the text area. */
18639 it
->glyph_row
->fill_line_p
= 1;
18641 /* If current character of IT is not ASCII, make sure we have the
18642 ASCII face. This will be automatically undone the next time
18643 get_next_display_element returns a multibyte character. Note
18644 that the character will always be single byte in unibyte
18646 if (!ASCII_CHAR_P (it
->c
))
18648 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18651 if (FRAME_WINDOW_P (f
))
18653 /* If the row is empty, add a space with the current face of IT,
18654 so that we know which face to draw. */
18655 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18657 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18658 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18659 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18661 #ifdef HAVE_WINDOW_SYSTEM
18662 if (it
->glyph_row
->reversed_p
)
18664 /* Prepend a stretch glyph to the row, such that the
18665 rightmost glyph will be drawn flushed all the way to the
18666 right margin of the window. The stretch glyph that will
18667 occupy the empty space, if any, to the left of the
18669 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18670 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18671 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18673 int row_width
, stretch_ascent
, stretch_width
;
18674 struct text_pos saved_pos
;
18675 int saved_face_id
, saved_avoid_cursor
;
18677 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18678 row_width
+= g
->pixel_width
;
18679 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18680 if (stretch_width
> 0)
18683 (((it
->ascent
+ it
->descent
)
18684 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18685 saved_pos
= it
->position
;
18686 memset (&it
->position
, 0, sizeof it
->position
);
18687 saved_avoid_cursor
= it
->avoid_cursor_p
;
18688 it
->avoid_cursor_p
= 1;
18689 saved_face_id
= it
->face_id
;
18690 /* The last row's stretch glyph should get the default
18691 face, to avoid painting the rest of the window with
18692 the region face, if the region ends at ZV. */
18693 if (it
->glyph_row
->ends_at_zv_p
)
18694 it
->face_id
= default_face
->id
;
18696 it
->face_id
= face
->id
;
18697 append_stretch_glyph (it
, make_number (0), stretch_width
,
18698 it
->ascent
+ it
->descent
, stretch_ascent
);
18699 it
->position
= saved_pos
;
18700 it
->avoid_cursor_p
= saved_avoid_cursor
;
18701 it
->face_id
= saved_face_id
;
18704 #endif /* HAVE_WINDOW_SYSTEM */
18708 /* Save some values that must not be changed. */
18709 int saved_x
= it
->current_x
;
18710 struct text_pos saved_pos
;
18711 Lisp_Object saved_object
;
18712 enum display_element_type saved_what
= it
->what
;
18713 int saved_face_id
= it
->face_id
;
18715 saved_object
= it
->object
;
18716 saved_pos
= it
->position
;
18718 it
->what
= IT_CHARACTER
;
18719 memset (&it
->position
, 0, sizeof it
->position
);
18720 it
->object
= make_number (0);
18721 it
->c
= it
->char_to_display
= ' ';
18723 /* The last row's blank glyphs should get the default face, to
18724 avoid painting the rest of the window with the region face,
18725 if the region ends at ZV. */
18726 if (it
->glyph_row
->ends_at_zv_p
)
18727 it
->face_id
= default_face
->id
;
18729 it
->face_id
= face
->id
;
18731 PRODUCE_GLYPHS (it
);
18733 while (it
->current_x
<= it
->last_visible_x
)
18734 PRODUCE_GLYPHS (it
);
18736 /* Don't count these blanks really. It would let us insert a left
18737 truncation glyph below and make us set the cursor on them, maybe. */
18738 it
->current_x
= saved_x
;
18739 it
->object
= saved_object
;
18740 it
->position
= saved_pos
;
18741 it
->what
= saved_what
;
18742 it
->face_id
= saved_face_id
;
18747 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18748 trailing whitespace. */
18751 trailing_whitespace_p (ptrdiff_t charpos
)
18753 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18756 while (bytepos
< ZV_BYTE
18757 && (c
= FETCH_CHAR (bytepos
),
18758 c
== ' ' || c
== '\t'))
18761 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18763 if (bytepos
!= PT_BYTE
)
18770 /* Highlight trailing whitespace, if any, in ROW. */
18773 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18775 int used
= row
->used
[TEXT_AREA
];
18779 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18780 struct glyph
*glyph
= start
+ used
- 1;
18782 if (row
->reversed_p
)
18784 /* Right-to-left rows need to be processed in the opposite
18785 direction, so swap the edge pointers. */
18787 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18790 /* Skip over glyphs inserted to display the cursor at the
18791 end of a line, for extending the face of the last glyph
18792 to the end of the line on terminals, and for truncation
18793 and continuation glyphs. */
18794 if (!row
->reversed_p
)
18796 while (glyph
>= start
18797 && glyph
->type
== CHAR_GLYPH
18798 && INTEGERP (glyph
->object
))
18803 while (glyph
<= start
18804 && glyph
->type
== CHAR_GLYPH
18805 && INTEGERP (glyph
->object
))
18809 /* If last glyph is a space or stretch, and it's trailing
18810 whitespace, set the face of all trailing whitespace glyphs in
18811 IT->glyph_row to `trailing-whitespace'. */
18812 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18813 && BUFFERP (glyph
->object
)
18814 && (glyph
->type
== STRETCH_GLYPH
18815 || (glyph
->type
== CHAR_GLYPH
18816 && glyph
->u
.ch
== ' '))
18817 && trailing_whitespace_p (glyph
->charpos
))
18819 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18823 if (!row
->reversed_p
)
18825 while (glyph
>= start
18826 && BUFFERP (glyph
->object
)
18827 && (glyph
->type
== STRETCH_GLYPH
18828 || (glyph
->type
== CHAR_GLYPH
18829 && glyph
->u
.ch
== ' ')))
18830 (glyph
--)->face_id
= face_id
;
18834 while (glyph
<= start
18835 && BUFFERP (glyph
->object
)
18836 && (glyph
->type
== STRETCH_GLYPH
18837 || (glyph
->type
== CHAR_GLYPH
18838 && glyph
->u
.ch
== ' ')))
18839 (glyph
++)->face_id
= face_id
;
18846 /* Value is non-zero if glyph row ROW should be
18847 used to hold the cursor. */
18850 cursor_row_p (struct glyph_row
*row
)
18854 if (PT
== CHARPOS (row
->end
.pos
)
18855 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18857 /* Suppose the row ends on a string.
18858 Unless the row is continued, that means it ends on a newline
18859 in the string. If it's anything other than a display string
18860 (e.g., a before-string from an overlay), we don't want the
18861 cursor there. (This heuristic seems to give the optimal
18862 behavior for the various types of multi-line strings.)
18863 One exception: if the string has `cursor' property on one of
18864 its characters, we _do_ want the cursor there. */
18865 if (CHARPOS (row
->end
.string_pos
) >= 0)
18867 if (row
->continued_p
)
18871 /* Check for `display' property. */
18872 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18873 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18874 struct glyph
*glyph
;
18877 for (glyph
= end
; glyph
>= beg
; --glyph
)
18878 if (STRINGP (glyph
->object
))
18881 = Fget_char_property (make_number (PT
),
18885 && display_prop_string_p (prop
, glyph
->object
));
18886 /* If there's a `cursor' property on one of the
18887 string's characters, this row is a cursor row,
18888 even though this is not a display string. */
18891 Lisp_Object s
= glyph
->object
;
18893 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18895 ptrdiff_t gpos
= glyph
->charpos
;
18897 if (!NILP (Fget_char_property (make_number (gpos
),
18909 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18911 /* If the row ends in middle of a real character,
18912 and the line is continued, we want the cursor here.
18913 That's because CHARPOS (ROW->end.pos) would equal
18914 PT if PT is before the character. */
18915 if (!row
->ends_in_ellipsis_p
)
18916 result
= row
->continued_p
;
18918 /* If the row ends in an ellipsis, then
18919 CHARPOS (ROW->end.pos) will equal point after the
18920 invisible text. We want that position to be displayed
18921 after the ellipsis. */
18924 /* If the row ends at ZV, display the cursor at the end of that
18925 row instead of at the start of the row below. */
18926 else if (row
->ends_at_zv_p
)
18937 /* Push the property PROP so that it will be rendered at the current
18938 position in IT. Return 1 if PROP was successfully pushed, 0
18939 otherwise. Called from handle_line_prefix to handle the
18940 `line-prefix' and `wrap-prefix' properties. */
18943 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18945 struct text_pos pos
=
18946 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18948 eassert (it
->method
== GET_FROM_BUFFER
18949 || it
->method
== GET_FROM_DISPLAY_VECTOR
18950 || it
->method
== GET_FROM_STRING
);
18952 /* We need to save the current buffer/string position, so it will be
18953 restored by pop_it, because iterate_out_of_display_property
18954 depends on that being set correctly, but some situations leave
18955 it->position not yet set when this function is called. */
18956 push_it (it
, &pos
);
18958 if (STRINGP (prop
))
18960 if (SCHARS (prop
) == 0)
18967 it
->string_from_prefix_prop_p
= 1;
18968 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18969 it
->current
.overlay_string_index
= -1;
18970 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18971 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18972 it
->method
= GET_FROM_STRING
;
18973 it
->stop_charpos
= 0;
18975 it
->base_level_stop
= 0;
18977 /* Force paragraph direction to be that of the parent
18979 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18980 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18982 it
->paragraph_embedding
= L2R
;
18984 /* Set up the bidi iterator for this display string. */
18987 it
->bidi_it
.string
.lstring
= it
->string
;
18988 it
->bidi_it
.string
.s
= NULL
;
18989 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18990 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18991 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18992 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18993 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18996 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18998 it
->method
= GET_FROM_STRETCH
;
19001 #ifdef HAVE_WINDOW_SYSTEM
19002 else if (IMAGEP (prop
))
19004 it
->what
= IT_IMAGE
;
19005 it
->image_id
= lookup_image (it
->f
, prop
);
19006 it
->method
= GET_FROM_IMAGE
;
19008 #endif /* HAVE_WINDOW_SYSTEM */
19011 pop_it (it
); /* bogus display property, give up */
19018 /* Return the character-property PROP at the current position in IT. */
19021 get_it_property (struct it
*it
, Lisp_Object prop
)
19023 Lisp_Object position
;
19025 if (STRINGP (it
->object
))
19026 position
= make_number (IT_STRING_CHARPOS (*it
));
19027 else if (BUFFERP (it
->object
))
19028 position
= make_number (IT_CHARPOS (*it
));
19032 return Fget_char_property (position
, prop
, it
->object
);
19035 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19038 handle_line_prefix (struct it
*it
)
19040 Lisp_Object prefix
;
19042 if (it
->continuation_lines_width
> 0)
19044 prefix
= get_it_property (it
, Qwrap_prefix
);
19046 prefix
= Vwrap_prefix
;
19050 prefix
= get_it_property (it
, Qline_prefix
);
19052 prefix
= Vline_prefix
;
19054 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19056 /* If the prefix is wider than the window, and we try to wrap
19057 it, it would acquire its own wrap prefix, and so on till the
19058 iterator stack overflows. So, don't wrap the prefix. */
19059 it
->line_wrap
= TRUNCATE
;
19060 it
->avoid_cursor_p
= 1;
19066 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19067 only for R2L lines from display_line and display_string, when they
19068 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19069 the line/string needs to be continued on the next glyph row. */
19071 unproduce_glyphs (struct it
*it
, int n
)
19073 struct glyph
*glyph
, *end
;
19075 eassert (it
->glyph_row
);
19076 eassert (it
->glyph_row
->reversed_p
);
19077 eassert (it
->area
== TEXT_AREA
);
19078 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19080 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19081 n
= it
->glyph_row
->used
[TEXT_AREA
];
19082 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19083 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19084 for ( ; glyph
< end
; glyph
++)
19085 glyph
[-n
] = *glyph
;
19088 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19089 and ROW->maxpos. */
19091 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19092 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19093 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19095 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19096 lines' rows is implemented for bidi-reordered rows. */
19098 /* ROW->minpos is the value of min_pos, the minimal buffer position
19099 we have in ROW, or ROW->start.pos if that is smaller. */
19100 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19101 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19103 /* We didn't find buffer positions smaller than ROW->start, or
19104 didn't find _any_ valid buffer positions in any of the glyphs,
19105 so we must trust the iterator's computed positions. */
19106 row
->minpos
= row
->start
.pos
;
19109 max_pos
= CHARPOS (it
->current
.pos
);
19110 max_bpos
= BYTEPOS (it
->current
.pos
);
19113 /* Here are the various use-cases for ending the row, and the
19114 corresponding values for ROW->maxpos:
19116 Line ends in a newline from buffer eol_pos + 1
19117 Line is continued from buffer max_pos + 1
19118 Line is truncated on right it->current.pos
19119 Line ends in a newline from string max_pos + 1(*)
19120 (*) + 1 only when line ends in a forward scan
19121 Line is continued from string max_pos
19122 Line is continued from display vector max_pos
19123 Line is entirely from a string min_pos == max_pos
19124 Line is entirely from a display vector min_pos == max_pos
19125 Line that ends at ZV ZV
19127 If you discover other use-cases, please add them here as
19129 if (row
->ends_at_zv_p
)
19130 row
->maxpos
= it
->current
.pos
;
19131 else if (row
->used
[TEXT_AREA
])
19133 int seen_this_string
= 0;
19134 struct glyph_row
*r1
= row
- 1;
19136 /* Did we see the same display string on the previous row? */
19137 if (STRINGP (it
->object
)
19138 /* this is not the first row */
19139 && row
> it
->w
->desired_matrix
->rows
19140 /* previous row is not the header line */
19141 && !r1
->mode_line_p
19142 /* previous row also ends in a newline from a string */
19143 && r1
->ends_in_newline_from_string_p
)
19145 struct glyph
*start
, *end
;
19147 /* Search for the last glyph of the previous row that came
19148 from buffer or string. Depending on whether the row is
19149 L2R or R2L, we need to process it front to back or the
19150 other way round. */
19151 if (!r1
->reversed_p
)
19153 start
= r1
->glyphs
[TEXT_AREA
];
19154 end
= start
+ r1
->used
[TEXT_AREA
];
19155 /* Glyphs inserted by redisplay have an integer (zero)
19156 as their object. */
19158 && INTEGERP ((end
- 1)->object
)
19159 && (end
- 1)->charpos
<= 0)
19163 if (EQ ((end
- 1)->object
, it
->object
))
19164 seen_this_string
= 1;
19167 /* If all the glyphs of the previous row were inserted
19168 by redisplay, it means the previous row was
19169 produced from a single newline, which is only
19170 possible if that newline came from the same string
19171 as the one which produced this ROW. */
19172 seen_this_string
= 1;
19176 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19177 start
= end
+ r1
->used
[TEXT_AREA
];
19179 && INTEGERP ((end
+ 1)->object
)
19180 && (end
+ 1)->charpos
<= 0)
19184 if (EQ ((end
+ 1)->object
, it
->object
))
19185 seen_this_string
= 1;
19188 seen_this_string
= 1;
19191 /* Take note of each display string that covers a newline only
19192 once, the first time we see it. This is for when a display
19193 string includes more than one newline in it. */
19194 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19196 /* If we were scanning the buffer forward when we displayed
19197 the string, we want to account for at least one buffer
19198 position that belongs to this row (position covered by
19199 the display string), so that cursor positioning will
19200 consider this row as a candidate when point is at the end
19201 of the visual line represented by this row. This is not
19202 required when scanning back, because max_pos will already
19203 have a much larger value. */
19204 if (CHARPOS (row
->end
.pos
) > max_pos
)
19205 INC_BOTH (max_pos
, max_bpos
);
19206 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19208 else if (CHARPOS (it
->eol_pos
) > 0)
19209 SET_TEXT_POS (row
->maxpos
,
19210 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19211 else if (row
->continued_p
)
19213 /* If max_pos is different from IT's current position, it
19214 means IT->method does not belong to the display element
19215 at max_pos. However, it also means that the display
19216 element at max_pos was displayed in its entirety on this
19217 line, which is equivalent to saying that the next line
19218 starts at the next buffer position. */
19219 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19220 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19223 INC_BOTH (max_pos
, max_bpos
);
19224 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19227 else if (row
->truncated_on_right_p
)
19228 /* display_line already called reseat_at_next_visible_line_start,
19229 which puts the iterator at the beginning of the next line, in
19230 the logical order. */
19231 row
->maxpos
= it
->current
.pos
;
19232 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19233 /* A line that is entirely from a string/image/stretch... */
19234 row
->maxpos
= row
->minpos
;
19239 row
->maxpos
= it
->current
.pos
;
19242 /* Construct the glyph row IT->glyph_row in the desired matrix of
19243 IT->w from text at the current position of IT. See dispextern.h
19244 for an overview of struct it. Value is non-zero if
19245 IT->glyph_row displays text, as opposed to a line displaying ZV
19249 display_line (struct it
*it
)
19251 struct glyph_row
*row
= it
->glyph_row
;
19252 Lisp_Object overlay_arrow_string
;
19254 void *wrap_data
= NULL
;
19255 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19256 int wrap_row_used
= -1;
19257 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19258 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19259 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19260 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19261 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19263 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19264 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19266 /* We always start displaying at hpos zero even if hscrolled. */
19267 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19269 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19270 >= it
->w
->desired_matrix
->nrows
)
19272 it
->w
->nrows_scale_factor
++;
19273 fonts_changed_p
= 1;
19277 /* Is IT->w showing the region? */
19278 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19280 /* Clear the result glyph row and enable it. */
19281 prepare_desired_row (row
);
19283 row
->y
= it
->current_y
;
19284 row
->start
= it
->start
;
19285 row
->continuation_lines_width
= it
->continuation_lines_width
;
19286 row
->displays_text_p
= 1;
19287 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19288 it
->starts_in_middle_of_char_p
= 0;
19290 /* Arrange the overlays nicely for our purposes. Usually, we call
19291 display_line on only one line at a time, in which case this
19292 can't really hurt too much, or we call it on lines which appear
19293 one after another in the buffer, in which case all calls to
19294 recenter_overlay_lists but the first will be pretty cheap. */
19295 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19297 /* Move over display elements that are not visible because we are
19298 hscrolled. This may stop at an x-position < IT->first_visible_x
19299 if the first glyph is partially visible or if we hit a line end. */
19300 if (it
->current_x
< it
->first_visible_x
)
19302 enum move_it_result move_result
;
19304 this_line_min_pos
= row
->start
.pos
;
19305 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19306 MOVE_TO_POS
| MOVE_TO_X
);
19307 /* If we are under a large hscroll, move_it_in_display_line_to
19308 could hit the end of the line without reaching
19309 it->first_visible_x. Pretend that we did reach it. This is
19310 especially important on a TTY, where we will call
19311 extend_face_to_end_of_line, which needs to know how many
19312 blank glyphs to produce. */
19313 if (it
->current_x
< it
->first_visible_x
19314 && (move_result
== MOVE_NEWLINE_OR_CR
19315 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19316 it
->current_x
= it
->first_visible_x
;
19318 /* Record the smallest positions seen while we moved over
19319 display elements that are not visible. This is needed by
19320 redisplay_internal for optimizing the case where the cursor
19321 stays inside the same line. The rest of this function only
19322 considers positions that are actually displayed, so
19323 RECORD_MAX_MIN_POS will not otherwise record positions that
19324 are hscrolled to the left of the left edge of the window. */
19325 min_pos
= CHARPOS (this_line_min_pos
);
19326 min_bpos
= BYTEPOS (this_line_min_pos
);
19330 /* We only do this when not calling `move_it_in_display_line_to'
19331 above, because move_it_in_display_line_to calls
19332 handle_line_prefix itself. */
19333 handle_line_prefix (it
);
19336 /* Get the initial row height. This is either the height of the
19337 text hscrolled, if there is any, or zero. */
19338 row
->ascent
= it
->max_ascent
;
19339 row
->height
= it
->max_ascent
+ it
->max_descent
;
19340 row
->phys_ascent
= it
->max_phys_ascent
;
19341 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19342 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19344 /* Utility macro to record max and min buffer positions seen until now. */
19345 #define RECORD_MAX_MIN_POS(IT) \
19348 int composition_p = !STRINGP ((IT)->string) \
19349 && ((IT)->what == IT_COMPOSITION); \
19350 ptrdiff_t current_pos = \
19351 composition_p ? (IT)->cmp_it.charpos \
19352 : IT_CHARPOS (*(IT)); \
19353 ptrdiff_t current_bpos = \
19354 composition_p ? CHAR_TO_BYTE (current_pos) \
19355 : IT_BYTEPOS (*(IT)); \
19356 if (current_pos < min_pos) \
19358 min_pos = current_pos; \
19359 min_bpos = current_bpos; \
19361 if (IT_CHARPOS (*it) > max_pos) \
19363 max_pos = IT_CHARPOS (*it); \
19364 max_bpos = IT_BYTEPOS (*it); \
19369 /* Loop generating characters. The loop is left with IT on the next
19370 character to display. */
19373 int n_glyphs_before
, hpos_before
, x_before
;
19375 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19377 /* Retrieve the next thing to display. Value is zero if end of
19379 if (!get_next_display_element (it
))
19381 /* Maybe add a space at the end of this line that is used to
19382 display the cursor there under X. Set the charpos of the
19383 first glyph of blank lines not corresponding to any text
19385 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19386 row
->exact_window_width_line_p
= 1;
19387 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19388 || row
->used
[TEXT_AREA
] == 0)
19390 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19391 row
->displays_text_p
= 0;
19393 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19394 && (!MINI_WINDOW_P (it
->w
)
19395 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19396 row
->indicate_empty_line_p
= 1;
19399 it
->continuation_lines_width
= 0;
19400 row
->ends_at_zv_p
= 1;
19401 /* A row that displays right-to-left text must always have
19402 its last face extended all the way to the end of line,
19403 even if this row ends in ZV, because we still write to
19404 the screen left to right. We also need to extend the
19405 last face if the default face is remapped to some
19406 different face, otherwise the functions that clear
19407 portions of the screen will clear with the default face's
19408 background color. */
19409 if (row
->reversed_p
19410 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19411 extend_face_to_end_of_line (it
);
19415 /* Now, get the metrics of what we want to display. This also
19416 generates glyphs in `row' (which is IT->glyph_row). */
19417 n_glyphs_before
= row
->used
[TEXT_AREA
];
19420 /* Remember the line height so far in case the next element doesn't
19421 fit on the line. */
19422 if (it
->line_wrap
!= TRUNCATE
)
19424 ascent
= it
->max_ascent
;
19425 descent
= it
->max_descent
;
19426 phys_ascent
= it
->max_phys_ascent
;
19427 phys_descent
= it
->max_phys_descent
;
19429 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19431 if (IT_DISPLAYING_WHITESPACE (it
))
19435 SAVE_IT (wrap_it
, *it
, wrap_data
);
19437 wrap_row_used
= row
->used
[TEXT_AREA
];
19438 wrap_row_ascent
= row
->ascent
;
19439 wrap_row_height
= row
->height
;
19440 wrap_row_phys_ascent
= row
->phys_ascent
;
19441 wrap_row_phys_height
= row
->phys_height
;
19442 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19443 wrap_row_min_pos
= min_pos
;
19444 wrap_row_min_bpos
= min_bpos
;
19445 wrap_row_max_pos
= max_pos
;
19446 wrap_row_max_bpos
= max_bpos
;
19452 PRODUCE_GLYPHS (it
);
19454 /* If this display element was in marginal areas, continue with
19456 if (it
->area
!= TEXT_AREA
)
19458 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19459 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19460 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19461 row
->phys_height
= max (row
->phys_height
,
19462 it
->max_phys_ascent
+ it
->max_phys_descent
);
19463 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19464 it
->max_extra_line_spacing
);
19465 set_iterator_to_next (it
, 1);
19469 /* Does the display element fit on the line? If we truncate
19470 lines, we should draw past the right edge of the window. If
19471 we don't truncate, we want to stop so that we can display the
19472 continuation glyph before the right margin. If lines are
19473 continued, there are two possible strategies for characters
19474 resulting in more than 1 glyph (e.g. tabs): Display as many
19475 glyphs as possible in this line and leave the rest for the
19476 continuation line, or display the whole element in the next
19477 line. Original redisplay did the former, so we do it also. */
19478 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19479 hpos_before
= it
->hpos
;
19482 if (/* Not a newline. */
19484 /* Glyphs produced fit entirely in the line. */
19485 && it
->current_x
< it
->last_visible_x
)
19487 it
->hpos
+= nglyphs
;
19488 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19489 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19490 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19491 row
->phys_height
= max (row
->phys_height
,
19492 it
->max_phys_ascent
+ it
->max_phys_descent
);
19493 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19494 it
->max_extra_line_spacing
);
19495 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19496 row
->x
= x
- it
->first_visible_x
;
19497 /* Record the maximum and minimum buffer positions seen so
19498 far in glyphs that will be displayed by this row. */
19500 RECORD_MAX_MIN_POS (it
);
19505 struct glyph
*glyph
;
19507 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19509 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19510 new_x
= x
+ glyph
->pixel_width
;
19512 if (/* Lines are continued. */
19513 it
->line_wrap
!= TRUNCATE
19514 && (/* Glyph doesn't fit on the line. */
19515 new_x
> it
->last_visible_x
19516 /* Or it fits exactly on a window system frame. */
19517 || (new_x
== it
->last_visible_x
19518 && FRAME_WINDOW_P (it
->f
)
19519 && (row
->reversed_p
19520 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19521 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19523 /* End of a continued line. */
19526 || (new_x
== it
->last_visible_x
19527 && FRAME_WINDOW_P (it
->f
)
19528 && (row
->reversed_p
19529 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19530 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19532 /* Current glyph is the only one on the line or
19533 fits exactly on the line. We must continue
19534 the line because we can't draw the cursor
19535 after the glyph. */
19536 row
->continued_p
= 1;
19537 it
->current_x
= new_x
;
19538 it
->continuation_lines_width
+= new_x
;
19540 if (i
== nglyphs
- 1)
19542 /* If line-wrap is on, check if a previous
19543 wrap point was found. */
19544 if (wrap_row_used
> 0
19545 /* Even if there is a previous wrap
19546 point, continue the line here as
19547 usual, if (i) the previous character
19548 was a space or tab AND (ii) the
19549 current character is not. */
19551 || IT_DISPLAYING_WHITESPACE (it
)))
19554 /* Record the maximum and minimum buffer
19555 positions seen so far in glyphs that will be
19556 displayed by this row. */
19558 RECORD_MAX_MIN_POS (it
);
19559 set_iterator_to_next (it
, 1);
19560 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19562 if (!get_next_display_element (it
))
19564 row
->exact_window_width_line_p
= 1;
19565 it
->continuation_lines_width
= 0;
19566 row
->continued_p
= 0;
19567 row
->ends_at_zv_p
= 1;
19569 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19571 row
->continued_p
= 0;
19572 row
->exact_window_width_line_p
= 1;
19576 else if (it
->bidi_p
)
19577 RECORD_MAX_MIN_POS (it
);
19579 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19580 && !FRAME_WINDOW_P (it
->f
))
19582 /* A padding glyph that doesn't fit on this line.
19583 This means the whole character doesn't fit
19585 if (row
->reversed_p
)
19586 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19587 - n_glyphs_before
);
19588 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19590 /* Fill the rest of the row with continuation
19591 glyphs like in 20.x. */
19592 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19593 < row
->glyphs
[1 + TEXT_AREA
])
19594 produce_special_glyphs (it
, IT_CONTINUATION
);
19596 row
->continued_p
= 1;
19597 it
->current_x
= x_before
;
19598 it
->continuation_lines_width
+= x_before
;
19600 /* Restore the height to what it was before the
19601 element not fitting on the line. */
19602 it
->max_ascent
= ascent
;
19603 it
->max_descent
= descent
;
19604 it
->max_phys_ascent
= phys_ascent
;
19605 it
->max_phys_descent
= phys_descent
;
19607 else if (wrap_row_used
> 0)
19610 if (row
->reversed_p
)
19611 unproduce_glyphs (it
,
19612 row
->used
[TEXT_AREA
] - wrap_row_used
);
19613 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19614 it
->continuation_lines_width
+= wrap_x
;
19615 row
->used
[TEXT_AREA
] = wrap_row_used
;
19616 row
->ascent
= wrap_row_ascent
;
19617 row
->height
= wrap_row_height
;
19618 row
->phys_ascent
= wrap_row_phys_ascent
;
19619 row
->phys_height
= wrap_row_phys_height
;
19620 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19621 min_pos
= wrap_row_min_pos
;
19622 min_bpos
= wrap_row_min_bpos
;
19623 max_pos
= wrap_row_max_pos
;
19624 max_bpos
= wrap_row_max_bpos
;
19625 row
->continued_p
= 1;
19626 row
->ends_at_zv_p
= 0;
19627 row
->exact_window_width_line_p
= 0;
19628 it
->continuation_lines_width
+= x
;
19630 /* Make sure that a non-default face is extended
19631 up to the right margin of the window. */
19632 extend_face_to_end_of_line (it
);
19634 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19636 /* A TAB that extends past the right edge of the
19637 window. This produces a single glyph on
19638 window system frames. We leave the glyph in
19639 this row and let it fill the row, but don't
19640 consume the TAB. */
19641 if ((row
->reversed_p
19642 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19643 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19644 produce_special_glyphs (it
, IT_CONTINUATION
);
19645 it
->continuation_lines_width
+= it
->last_visible_x
;
19646 row
->ends_in_middle_of_char_p
= 1;
19647 row
->continued_p
= 1;
19648 glyph
->pixel_width
= it
->last_visible_x
- x
;
19649 it
->starts_in_middle_of_char_p
= 1;
19653 /* Something other than a TAB that draws past
19654 the right edge of the window. Restore
19655 positions to values before the element. */
19656 if (row
->reversed_p
)
19657 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19658 - (n_glyphs_before
+ i
));
19659 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19661 /* Display continuation glyphs. */
19662 it
->current_x
= x_before
;
19663 it
->continuation_lines_width
+= x
;
19664 if (!FRAME_WINDOW_P (it
->f
)
19665 || (row
->reversed_p
19666 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19667 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19668 produce_special_glyphs (it
, IT_CONTINUATION
);
19669 row
->continued_p
= 1;
19671 extend_face_to_end_of_line (it
);
19673 if (nglyphs
> 1 && i
> 0)
19675 row
->ends_in_middle_of_char_p
= 1;
19676 it
->starts_in_middle_of_char_p
= 1;
19679 /* Restore the height to what it was before the
19680 element not fitting on the line. */
19681 it
->max_ascent
= ascent
;
19682 it
->max_descent
= descent
;
19683 it
->max_phys_ascent
= phys_ascent
;
19684 it
->max_phys_descent
= phys_descent
;
19689 else if (new_x
> it
->first_visible_x
)
19691 /* Increment number of glyphs actually displayed. */
19694 /* Record the maximum and minimum buffer positions
19695 seen so far in glyphs that will be displayed by
19698 RECORD_MAX_MIN_POS (it
);
19700 if (x
< it
->first_visible_x
)
19701 /* Glyph is partially visible, i.e. row starts at
19702 negative X position. */
19703 row
->x
= x
- it
->first_visible_x
;
19707 /* Glyph is completely off the left margin of the
19708 window. This should not happen because of the
19709 move_it_in_display_line at the start of this
19710 function, unless the text display area of the
19711 window is empty. */
19712 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19715 /* Even if this display element produced no glyphs at all,
19716 we want to record its position. */
19717 if (it
->bidi_p
&& nglyphs
== 0)
19718 RECORD_MAX_MIN_POS (it
);
19720 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19721 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19722 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19723 row
->phys_height
= max (row
->phys_height
,
19724 it
->max_phys_ascent
+ it
->max_phys_descent
);
19725 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19726 it
->max_extra_line_spacing
);
19728 /* End of this display line if row is continued. */
19729 if (row
->continued_p
|| row
->ends_at_zv_p
)
19734 /* Is this a line end? If yes, we're also done, after making
19735 sure that a non-default face is extended up to the right
19736 margin of the window. */
19737 if (ITERATOR_AT_END_OF_LINE_P (it
))
19739 int used_before
= row
->used
[TEXT_AREA
];
19741 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19743 /* Add a space at the end of the line that is used to
19744 display the cursor there. */
19745 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19746 append_space_for_newline (it
, 0);
19748 /* Extend the face to the end of the line. */
19749 extend_face_to_end_of_line (it
);
19751 /* Make sure we have the position. */
19752 if (used_before
== 0)
19753 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19755 /* Record the position of the newline, for use in
19757 it
->eol_pos
= it
->current
.pos
;
19759 /* Consume the line end. This skips over invisible lines. */
19760 set_iterator_to_next (it
, 1);
19761 it
->continuation_lines_width
= 0;
19765 /* Proceed with next display element. Note that this skips
19766 over lines invisible because of selective display. */
19767 set_iterator_to_next (it
, 1);
19769 /* If we truncate lines, we are done when the last displayed
19770 glyphs reach past the right margin of the window. */
19771 if (it
->line_wrap
== TRUNCATE
19772 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19773 ? (it
->current_x
>= it
->last_visible_x
)
19774 : (it
->current_x
> it
->last_visible_x
)))
19776 /* Maybe add truncation glyphs. */
19777 if (!FRAME_WINDOW_P (it
->f
)
19778 || (row
->reversed_p
19779 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19780 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19784 if (!row
->reversed_p
)
19786 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19787 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19792 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19793 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19795 /* Remove any padding glyphs at the front of ROW, to
19796 make room for the truncation glyphs we will be
19797 adding below. The loop below always inserts at
19798 least one truncation glyph, so also remove the
19799 last glyph added to ROW. */
19800 unproduce_glyphs (it
, i
+ 1);
19801 /* Adjust i for the loop below. */
19802 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19805 it
->current_x
= x_before
;
19806 if (!FRAME_WINDOW_P (it
->f
))
19808 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19810 row
->used
[TEXT_AREA
] = i
;
19811 produce_special_glyphs (it
, IT_TRUNCATION
);
19816 row
->used
[TEXT_AREA
] = i
;
19817 produce_special_glyphs (it
, IT_TRUNCATION
);
19820 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19822 /* Don't truncate if we can overflow newline into fringe. */
19823 if (!get_next_display_element (it
))
19825 it
->continuation_lines_width
= 0;
19826 row
->ends_at_zv_p
= 1;
19827 row
->exact_window_width_line_p
= 1;
19830 if (ITERATOR_AT_END_OF_LINE_P (it
))
19832 row
->exact_window_width_line_p
= 1;
19833 goto at_end_of_line
;
19835 it
->current_x
= x_before
;
19838 row
->truncated_on_right_p
= 1;
19839 it
->continuation_lines_width
= 0;
19840 reseat_at_next_visible_line_start (it
, 0);
19841 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19842 it
->hpos
= hpos_before
;
19848 bidi_unshelve_cache (wrap_data
, 1);
19850 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19851 at the left window margin. */
19852 if (it
->first_visible_x
19853 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19855 if (!FRAME_WINDOW_P (it
->f
)
19856 || (row
->reversed_p
19857 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19858 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19859 insert_left_trunc_glyphs (it
);
19860 row
->truncated_on_left_p
= 1;
19863 /* Remember the position at which this line ends.
19865 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19866 cannot be before the call to find_row_edges below, since that is
19867 where these positions are determined. */
19868 row
->end
= it
->current
;
19871 row
->minpos
= row
->start
.pos
;
19872 row
->maxpos
= row
->end
.pos
;
19876 /* ROW->minpos and ROW->maxpos must be the smallest and
19877 `1 + the largest' buffer positions in ROW. But if ROW was
19878 bidi-reordered, these two positions can be anywhere in the
19879 row, so we must determine them now. */
19880 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19883 /* If the start of this line is the overlay arrow-position, then
19884 mark this glyph row as the one containing the overlay arrow.
19885 This is clearly a mess with variable size fonts. It would be
19886 better to let it be displayed like cursors under X. */
19887 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19888 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19889 !NILP (overlay_arrow_string
)))
19891 /* Overlay arrow in window redisplay is a fringe bitmap. */
19892 if (STRINGP (overlay_arrow_string
))
19894 struct glyph_row
*arrow_row
19895 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19896 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19897 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19898 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19899 struct glyph
*p2
, *end
;
19901 /* Copy the arrow glyphs. */
19902 while (glyph
< arrow_end
)
19905 /* Throw away padding glyphs. */
19907 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19908 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19914 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19919 eassert (INTEGERP (overlay_arrow_string
));
19920 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19922 overlay_arrow_seen
= 1;
19925 /* Highlight trailing whitespace. */
19926 if (!NILP (Vshow_trailing_whitespace
))
19927 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19929 /* Compute pixel dimensions of this line. */
19930 compute_line_metrics (it
);
19932 /* Implementation note: No changes in the glyphs of ROW or in their
19933 faces can be done past this point, because compute_line_metrics
19934 computes ROW's hash value and stores it within the glyph_row
19937 /* Record whether this row ends inside an ellipsis. */
19938 row
->ends_in_ellipsis_p
19939 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19940 && it
->ellipsis_p
);
19942 /* Save fringe bitmaps in this row. */
19943 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19944 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19945 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19946 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19948 it
->left_user_fringe_bitmap
= 0;
19949 it
->left_user_fringe_face_id
= 0;
19950 it
->right_user_fringe_bitmap
= 0;
19951 it
->right_user_fringe_face_id
= 0;
19953 /* Maybe set the cursor. */
19954 cvpos
= it
->w
->cursor
.vpos
;
19956 /* In bidi-reordered rows, keep checking for proper cursor
19957 position even if one has been found already, because buffer
19958 positions in such rows change non-linearly with ROW->VPOS,
19959 when a line is continued. One exception: when we are at ZV,
19960 display cursor on the first suitable glyph row, since all
19961 the empty rows after that also have their position set to ZV. */
19962 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19963 lines' rows is implemented for bidi-reordered rows. */
19965 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19966 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19967 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19968 && cursor_row_p (row
))
19969 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19971 /* Prepare for the next line. This line starts horizontally at (X
19972 HPOS) = (0 0). Vertical positions are incremented. As a
19973 convenience for the caller, IT->glyph_row is set to the next
19975 it
->current_x
= it
->hpos
= 0;
19976 it
->current_y
+= row
->height
;
19977 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19980 /* The next row should by default use the same value of the
19981 reversed_p flag as this one. set_iterator_to_next decides when
19982 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19983 the flag accordingly. */
19984 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19985 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19986 it
->start
= row
->end
;
19987 return row
->displays_text_p
;
19989 #undef RECORD_MAX_MIN_POS
19992 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19993 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19994 doc
: /* Return paragraph direction at point in BUFFER.
19995 Value is either `left-to-right' or `right-to-left'.
19996 If BUFFER is omitted or nil, it defaults to the current buffer.
19998 Paragraph direction determines how the text in the paragraph is displayed.
19999 In left-to-right paragraphs, text begins at the left margin of the window
20000 and the reading direction is generally left to right. In right-to-left
20001 paragraphs, text begins at the right margin and is read from right to left.
20003 See also `bidi-paragraph-direction'. */)
20004 (Lisp_Object buffer
)
20006 struct buffer
*buf
= current_buffer
;
20007 struct buffer
*old
= buf
;
20009 if (! NILP (buffer
))
20011 CHECK_BUFFER (buffer
);
20012 buf
= XBUFFER (buffer
);
20015 if (NILP (BVAR (buf
, bidi_display_reordering
))
20016 || NILP (BVAR (buf
, enable_multibyte_characters
))
20017 /* When we are loading loadup.el, the character property tables
20018 needed for bidi iteration are not yet available. */
20019 || !NILP (Vpurify_flag
))
20020 return Qleft_to_right
;
20021 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20022 return BVAR (buf
, bidi_paragraph_direction
);
20025 /* Determine the direction from buffer text. We could try to
20026 use current_matrix if it is up to date, but this seems fast
20027 enough as it is. */
20028 struct bidi_it itb
;
20029 ptrdiff_t pos
= BUF_PT (buf
);
20030 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20032 void *itb_data
= bidi_shelve_cache ();
20034 set_buffer_temp (buf
);
20035 /* bidi_paragraph_init finds the base direction of the paragraph
20036 by searching forward from paragraph start. We need the base
20037 direction of the current or _previous_ paragraph, so we need
20038 to make sure we are within that paragraph. To that end, find
20039 the previous non-empty line. */
20040 if (pos
>= ZV
&& pos
> BEGV
)
20043 bytepos
= CHAR_TO_BYTE (pos
);
20045 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20046 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20048 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20049 || c
== ' ' || c
== '\t' || c
== '\f')
20051 if (bytepos
<= BEGV_BYTE
)
20056 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20059 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20060 itb
.paragraph_dir
= NEUTRAL_DIR
;
20061 itb
.string
.s
= NULL
;
20062 itb
.string
.lstring
= Qnil
;
20063 itb
.string
.bufpos
= 0;
20064 itb
.string
.unibyte
= 0;
20065 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20066 bidi_unshelve_cache (itb_data
, 0);
20067 set_buffer_temp (old
);
20068 switch (itb
.paragraph_dir
)
20071 return Qleft_to_right
;
20074 return Qright_to_left
;
20084 /***********************************************************************
20086 ***********************************************************************/
20088 /* Redisplay the menu bar in the frame for window W.
20090 The menu bar of X frames that don't have X toolkit support is
20091 displayed in a special window W->frame->menu_bar_window.
20093 The menu bar of terminal frames is treated specially as far as
20094 glyph matrices are concerned. Menu bar lines are not part of
20095 windows, so the update is done directly on the frame matrix rows
20096 for the menu bar. */
20099 display_menu_bar (struct window
*w
)
20101 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20106 /* Don't do all this for graphical frames. */
20108 if (FRAME_W32_P (f
))
20111 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20117 if (FRAME_NS_P (f
))
20119 #endif /* HAVE_NS */
20121 #ifdef USE_X_TOOLKIT
20122 eassert (!FRAME_WINDOW_P (f
));
20123 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20124 it
.first_visible_x
= 0;
20125 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20126 #else /* not USE_X_TOOLKIT */
20127 if (FRAME_WINDOW_P (f
))
20129 /* Menu bar lines are displayed in the desired matrix of the
20130 dummy window menu_bar_window. */
20131 struct window
*menu_w
;
20132 eassert (WINDOWP (f
->menu_bar_window
));
20133 menu_w
= XWINDOW (f
->menu_bar_window
);
20134 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20136 it
.first_visible_x
= 0;
20137 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20141 /* This is a TTY frame, i.e. character hpos/vpos are used as
20143 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20145 it
.first_visible_x
= 0;
20146 it
.last_visible_x
= FRAME_COLS (f
);
20148 #endif /* not USE_X_TOOLKIT */
20150 /* FIXME: This should be controlled by a user option. See the
20151 comments in redisplay_tool_bar and display_mode_line about
20153 it
.paragraph_embedding
= L2R
;
20155 if (! mode_line_inverse_video
)
20156 /* Force the menu-bar to be displayed in the default face. */
20157 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20159 /* Clear all rows of the menu bar. */
20160 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20162 struct glyph_row
*row
= it
.glyph_row
+ i
;
20163 clear_glyph_row (row
);
20164 row
->enabled_p
= 1;
20165 row
->full_width_p
= 1;
20168 /* Display all items of the menu bar. */
20169 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20170 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20172 Lisp_Object string
;
20174 /* Stop at nil string. */
20175 string
= AREF (items
, i
+ 1);
20179 /* Remember where item was displayed. */
20180 ASET (items
, i
+ 3, make_number (it
.hpos
));
20182 /* Display the item, pad with one space. */
20183 if (it
.current_x
< it
.last_visible_x
)
20184 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20185 SCHARS (string
) + 1, 0, 0, -1);
20188 /* Fill out the line with spaces. */
20189 if (it
.current_x
< it
.last_visible_x
)
20190 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20192 /* Compute the total height of the lines. */
20193 compute_line_metrics (&it
);
20198 /***********************************************************************
20200 ***********************************************************************/
20202 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20203 FORCE is non-zero, redisplay mode lines unconditionally.
20204 Otherwise, redisplay only mode lines that are garbaged. Value is
20205 the number of windows whose mode lines were redisplayed. */
20208 redisplay_mode_lines (Lisp_Object window
, int force
)
20212 while (!NILP (window
))
20214 struct window
*w
= XWINDOW (window
);
20216 if (WINDOWP (w
->hchild
))
20217 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20218 else if (WINDOWP (w
->vchild
))
20219 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20221 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20222 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20224 struct text_pos lpoint
;
20225 struct buffer
*old
= current_buffer
;
20227 /* Set the window's buffer for the mode line display. */
20228 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20229 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20231 /* Point refers normally to the selected window. For any
20232 other window, set up appropriate value. */
20233 if (!EQ (window
, selected_window
))
20235 struct text_pos pt
;
20237 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20238 if (CHARPOS (pt
) < BEGV
)
20239 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20240 else if (CHARPOS (pt
) > (ZV
- 1))
20241 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20243 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20246 /* Display mode lines. */
20247 clear_glyph_matrix (w
->desired_matrix
);
20248 if (display_mode_lines (w
))
20251 w
->must_be_updated_p
= 1;
20254 /* Restore old settings. */
20255 set_buffer_internal_1 (old
);
20256 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20266 /* Display the mode and/or header line of window W. Value is the
20267 sum number of mode lines and header lines displayed. */
20270 display_mode_lines (struct window
*w
)
20272 Lisp_Object old_selected_window
, old_selected_frame
;
20275 old_selected_frame
= selected_frame
;
20276 selected_frame
= w
->frame
;
20277 old_selected_window
= selected_window
;
20278 XSETWINDOW (selected_window
, w
);
20280 /* These will be set while the mode line specs are processed. */
20281 line_number_displayed
= 0;
20282 wset_column_number_displayed (w
, Qnil
);
20284 if (WINDOW_WANTS_MODELINE_P (w
))
20286 struct window
*sel_w
= XWINDOW (old_selected_window
);
20288 /* Select mode line face based on the real selected window. */
20289 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20290 BVAR (current_buffer
, mode_line_format
));
20294 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20296 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20297 BVAR (current_buffer
, header_line_format
));
20301 selected_frame
= old_selected_frame
;
20302 selected_window
= old_selected_window
;
20307 /* Display mode or header line of window W. FACE_ID specifies which
20308 line to display; it is either MODE_LINE_FACE_ID or
20309 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20310 display. Value is the pixel height of the mode/header line
20314 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20318 ptrdiff_t count
= SPECPDL_INDEX ();
20320 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20321 /* Don't extend on a previously drawn mode-line.
20322 This may happen if called from pos_visible_p. */
20323 it
.glyph_row
->enabled_p
= 0;
20324 prepare_desired_row (it
.glyph_row
);
20326 it
.glyph_row
->mode_line_p
= 1;
20328 if (! mode_line_inverse_video
)
20329 /* Force the mode-line to be displayed in the default face. */
20330 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20332 /* FIXME: This should be controlled by a user option. But
20333 supporting such an option is not trivial, since the mode line is
20334 made up of many separate strings. */
20335 it
.paragraph_embedding
= L2R
;
20337 record_unwind_protect (unwind_format_mode_line
,
20338 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20340 mode_line_target
= MODE_LINE_DISPLAY
;
20342 /* Temporarily make frame's keyboard the current kboard so that
20343 kboard-local variables in the mode_line_format will get the right
20345 push_kboard (FRAME_KBOARD (it
.f
));
20346 record_unwind_save_match_data ();
20347 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20350 unbind_to (count
, Qnil
);
20352 /* Fill up with spaces. */
20353 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20355 compute_line_metrics (&it
);
20356 it
.glyph_row
->full_width_p
= 1;
20357 it
.glyph_row
->continued_p
= 0;
20358 it
.glyph_row
->truncated_on_left_p
= 0;
20359 it
.glyph_row
->truncated_on_right_p
= 0;
20361 /* Make a 3D mode-line have a shadow at its right end. */
20362 face
= FACE_FROM_ID (it
.f
, face_id
);
20363 extend_face_to_end_of_line (&it
);
20364 if (face
->box
!= FACE_NO_BOX
)
20366 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20367 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20368 last
->right_box_line_p
= 1;
20371 return it
.glyph_row
->height
;
20374 /* Move element ELT in LIST to the front of LIST.
20375 Return the updated list. */
20378 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20380 register Lisp_Object tail
, prev
;
20381 register Lisp_Object tem
;
20385 while (CONSP (tail
))
20391 /* Splice out the link TAIL. */
20393 list
= XCDR (tail
);
20395 Fsetcdr (prev
, XCDR (tail
));
20397 /* Now make it the first. */
20398 Fsetcdr (tail
, list
);
20403 tail
= XCDR (tail
);
20407 /* Not found--return unchanged LIST. */
20411 /* Contribute ELT to the mode line for window IT->w. How it
20412 translates into text depends on its data type.
20414 IT describes the display environment in which we display, as usual.
20416 DEPTH is the depth in recursion. It is used to prevent
20417 infinite recursion here.
20419 FIELD_WIDTH is the number of characters the display of ELT should
20420 occupy in the mode line, and PRECISION is the maximum number of
20421 characters to display from ELT's representation. See
20422 display_string for details.
20424 Returns the hpos of the end of the text generated by ELT.
20426 PROPS is a property list to add to any string we encounter.
20428 If RISKY is nonzero, remove (disregard) any properties in any string
20429 we encounter, and ignore :eval and :propertize.
20431 The global variable `mode_line_target' determines whether the
20432 output is passed to `store_mode_line_noprop',
20433 `store_mode_line_string', or `display_string'. */
20436 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20437 Lisp_Object elt
, Lisp_Object props
, int risky
)
20439 int n
= 0, field
, prec
;
20444 elt
= build_string ("*too-deep*");
20448 switch (XTYPE (elt
))
20452 /* A string: output it and check for %-constructs within it. */
20454 ptrdiff_t offset
= 0;
20456 if (SCHARS (elt
) > 0
20457 && (!NILP (props
) || risky
))
20459 Lisp_Object oprops
, aelt
;
20460 oprops
= Ftext_properties_at (make_number (0), elt
);
20462 /* If the starting string's properties are not what
20463 we want, translate the string. Also, if the string
20464 is risky, do that anyway. */
20466 if (NILP (Fequal (props
, oprops
)) || risky
)
20468 /* If the starting string has properties,
20469 merge the specified ones onto the existing ones. */
20470 if (! NILP (oprops
) && !risky
)
20474 oprops
= Fcopy_sequence (oprops
);
20476 while (CONSP (tem
))
20478 oprops
= Fplist_put (oprops
, XCAR (tem
),
20479 XCAR (XCDR (tem
)));
20480 tem
= XCDR (XCDR (tem
));
20485 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20486 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20488 /* AELT is what we want. Move it to the front
20489 without consing. */
20491 mode_line_proptrans_alist
20492 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20498 /* If AELT has the wrong props, it is useless.
20499 so get rid of it. */
20501 mode_line_proptrans_alist
20502 = Fdelq (aelt
, mode_line_proptrans_alist
);
20504 elt
= Fcopy_sequence (elt
);
20505 Fset_text_properties (make_number (0), Flength (elt
),
20507 /* Add this item to mode_line_proptrans_alist. */
20508 mode_line_proptrans_alist
20509 = Fcons (Fcons (elt
, props
),
20510 mode_line_proptrans_alist
);
20511 /* Truncate mode_line_proptrans_alist
20512 to at most 50 elements. */
20513 tem
= Fnthcdr (make_number (50),
20514 mode_line_proptrans_alist
);
20516 XSETCDR (tem
, Qnil
);
20525 prec
= precision
- n
;
20526 switch (mode_line_target
)
20528 case MODE_LINE_NOPROP
:
20529 case MODE_LINE_TITLE
:
20530 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20532 case MODE_LINE_STRING
:
20533 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20535 case MODE_LINE_DISPLAY
:
20536 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20537 0, prec
, 0, STRING_MULTIBYTE (elt
));
20544 /* Handle the non-literal case. */
20546 while ((precision
<= 0 || n
< precision
)
20547 && SREF (elt
, offset
) != 0
20548 && (mode_line_target
!= MODE_LINE_DISPLAY
20549 || it
->current_x
< it
->last_visible_x
))
20551 ptrdiff_t last_offset
= offset
;
20553 /* Advance to end of string or next format specifier. */
20554 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20557 if (offset
- 1 != last_offset
)
20559 ptrdiff_t nchars
, nbytes
;
20561 /* Output to end of string or up to '%'. Field width
20562 is length of string. Don't output more than
20563 PRECISION allows us. */
20566 prec
= c_string_width (SDATA (elt
) + last_offset
,
20567 offset
- last_offset
, precision
- n
,
20570 switch (mode_line_target
)
20572 case MODE_LINE_NOPROP
:
20573 case MODE_LINE_TITLE
:
20574 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20576 case MODE_LINE_STRING
:
20578 ptrdiff_t bytepos
= last_offset
;
20579 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20580 ptrdiff_t endpos
= (precision
<= 0
20581 ? string_byte_to_char (elt
, offset
)
20582 : charpos
+ nchars
);
20584 n
+= store_mode_line_string (NULL
,
20585 Fsubstring (elt
, make_number (charpos
),
20586 make_number (endpos
)),
20590 case MODE_LINE_DISPLAY
:
20592 ptrdiff_t bytepos
= last_offset
;
20593 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20595 if (precision
<= 0)
20596 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20597 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20599 STRING_MULTIBYTE (elt
));
20604 else /* c == '%' */
20606 ptrdiff_t percent_position
= offset
;
20608 /* Get the specified minimum width. Zero means
20611 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20612 field
= field
* 10 + c
- '0';
20614 /* Don't pad beyond the total padding allowed. */
20615 if (field_width
- n
> 0 && field
> field_width
- n
)
20616 field
= field_width
- n
;
20618 /* Note that either PRECISION <= 0 or N < PRECISION. */
20619 prec
= precision
- n
;
20622 n
+= display_mode_element (it
, depth
, field
, prec
,
20623 Vglobal_mode_string
, props
,
20628 ptrdiff_t bytepos
, charpos
;
20630 Lisp_Object string
;
20632 bytepos
= percent_position
;
20633 charpos
= (STRING_MULTIBYTE (elt
)
20634 ? string_byte_to_char (elt
, bytepos
)
20636 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20637 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20639 switch (mode_line_target
)
20641 case MODE_LINE_NOPROP
:
20642 case MODE_LINE_TITLE
:
20643 n
+= store_mode_line_noprop (spec
, field
, prec
);
20645 case MODE_LINE_STRING
:
20647 Lisp_Object tem
= build_string (spec
);
20648 props
= Ftext_properties_at (make_number (charpos
), elt
);
20649 /* Should only keep face property in props */
20650 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20653 case MODE_LINE_DISPLAY
:
20655 int nglyphs_before
, nwritten
;
20657 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20658 nwritten
= display_string (spec
, string
, elt
,
20663 /* Assign to the glyphs written above the
20664 string where the `%x' came from, position
20668 struct glyph
*glyph
20669 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20673 for (i
= 0; i
< nwritten
; ++i
)
20675 glyph
[i
].object
= elt
;
20676 glyph
[i
].charpos
= charpos
;
20693 /* A symbol: process the value of the symbol recursively
20694 as if it appeared here directly. Avoid error if symbol void.
20695 Special case: if value of symbol is a string, output the string
20698 register Lisp_Object tem
;
20700 /* If the variable is not marked as risky to set
20701 then its contents are risky to use. */
20702 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20705 tem
= Fboundp (elt
);
20708 tem
= Fsymbol_value (elt
);
20709 /* If value is a string, output that string literally:
20710 don't check for % within it. */
20714 if (!EQ (tem
, elt
))
20716 /* Give up right away for nil or t. */
20726 register Lisp_Object car
, tem
;
20728 /* A cons cell: five distinct cases.
20729 If first element is :eval or :propertize, do something special.
20730 If first element is a string or a cons, process all the elements
20731 and effectively concatenate them.
20732 If first element is a negative number, truncate displaying cdr to
20733 at most that many characters. If positive, pad (with spaces)
20734 to at least that many characters.
20735 If first element is a symbol, process the cadr or caddr recursively
20736 according to whether the symbol's value is non-nil or nil. */
20738 if (EQ (car
, QCeval
))
20740 /* An element of the form (:eval FORM) means evaluate FORM
20741 and use the result as mode line elements. */
20746 if (CONSP (XCDR (elt
)))
20749 spec
= safe_eval (XCAR (XCDR (elt
)));
20750 n
+= display_mode_element (it
, depth
, field_width
- n
,
20751 precision
- n
, spec
, props
,
20755 else if (EQ (car
, QCpropertize
))
20757 /* An element of the form (:propertize ELT PROPS...)
20758 means display ELT but applying properties PROPS. */
20763 if (CONSP (XCDR (elt
)))
20764 n
+= display_mode_element (it
, depth
, field_width
- n
,
20765 precision
- n
, XCAR (XCDR (elt
)),
20766 XCDR (XCDR (elt
)), risky
);
20768 else if (SYMBOLP (car
))
20770 tem
= Fboundp (car
);
20774 /* elt is now the cdr, and we know it is a cons cell.
20775 Use its car if CAR has a non-nil value. */
20778 tem
= Fsymbol_value (car
);
20785 /* Symbol's value is nil (or symbol is unbound)
20786 Get the cddr of the original list
20787 and if possible find the caddr and use that. */
20791 else if (!CONSP (elt
))
20796 else if (INTEGERP (car
))
20798 register int lim
= XINT (car
);
20802 /* Negative int means reduce maximum width. */
20803 if (precision
<= 0)
20806 precision
= min (precision
, -lim
);
20810 /* Padding specified. Don't let it be more than
20811 current maximum. */
20813 lim
= min (precision
, lim
);
20815 /* If that's more padding than already wanted, queue it.
20816 But don't reduce padding already specified even if
20817 that is beyond the current truncation point. */
20818 field_width
= max (lim
, field_width
);
20822 else if (STRINGP (car
) || CONSP (car
))
20824 Lisp_Object halftail
= elt
;
20828 && (precision
<= 0 || n
< precision
))
20830 n
+= display_mode_element (it
, depth
,
20831 /* Do padding only after the last
20832 element in the list. */
20833 (! CONSP (XCDR (elt
))
20836 precision
- n
, XCAR (elt
),
20840 if ((len
& 1) == 0)
20841 halftail
= XCDR (halftail
);
20842 /* Check for cycle. */
20843 if (EQ (halftail
, elt
))
20852 elt
= build_string ("*invalid*");
20856 /* Pad to FIELD_WIDTH. */
20857 if (field_width
> 0 && n
< field_width
)
20859 switch (mode_line_target
)
20861 case MODE_LINE_NOPROP
:
20862 case MODE_LINE_TITLE
:
20863 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20865 case MODE_LINE_STRING
:
20866 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20868 case MODE_LINE_DISPLAY
:
20869 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20878 /* Store a mode-line string element in mode_line_string_list.
20880 If STRING is non-null, display that C string. Otherwise, the Lisp
20881 string LISP_STRING is displayed.
20883 FIELD_WIDTH is the minimum number of output glyphs to produce.
20884 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20885 with spaces. FIELD_WIDTH <= 0 means don't pad.
20887 PRECISION is the maximum number of characters to output from
20888 STRING. PRECISION <= 0 means don't truncate the string.
20890 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20891 properties to the string.
20893 PROPS are the properties to add to the string.
20894 The mode_line_string_face face property is always added to the string.
20898 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20899 int field_width
, int precision
, Lisp_Object props
)
20904 if (string
!= NULL
)
20906 len
= strlen (string
);
20907 if (precision
> 0 && len
> precision
)
20909 lisp_string
= make_string (string
, len
);
20911 props
= mode_line_string_face_prop
;
20912 else if (!NILP (mode_line_string_face
))
20914 Lisp_Object face
= Fplist_get (props
, Qface
);
20915 props
= Fcopy_sequence (props
);
20917 face
= mode_line_string_face
;
20919 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20920 props
= Fplist_put (props
, Qface
, face
);
20922 Fadd_text_properties (make_number (0), make_number (len
),
20923 props
, lisp_string
);
20927 len
= XFASTINT (Flength (lisp_string
));
20928 if (precision
> 0 && len
> precision
)
20931 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20934 if (!NILP (mode_line_string_face
))
20938 props
= Ftext_properties_at (make_number (0), lisp_string
);
20939 face
= Fplist_get (props
, Qface
);
20941 face
= mode_line_string_face
;
20943 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20944 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20946 lisp_string
= Fcopy_sequence (lisp_string
);
20949 Fadd_text_properties (make_number (0), make_number (len
),
20950 props
, lisp_string
);
20955 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20959 if (field_width
> len
)
20961 field_width
-= len
;
20962 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20964 Fadd_text_properties (make_number (0), make_number (field_width
),
20965 props
, lisp_string
);
20966 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20974 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20976 doc
: /* Format a string out of a mode line format specification.
20977 First arg FORMAT specifies the mode line format (see `mode-line-format'
20978 for details) to use.
20980 By default, the format is evaluated for the currently selected window.
20982 Optional second arg FACE specifies the face property to put on all
20983 characters for which no face is specified. The value nil means the
20984 default face. The value t means whatever face the window's mode line
20985 currently uses (either `mode-line' or `mode-line-inactive',
20986 depending on whether the window is the selected window or not).
20987 An integer value means the value string has no text
20990 Optional third and fourth args WINDOW and BUFFER specify the window
20991 and buffer to use as the context for the formatting (defaults
20992 are the selected window and the WINDOW's buffer). */)
20993 (Lisp_Object format
, Lisp_Object face
,
20994 Lisp_Object window
, Lisp_Object buffer
)
20999 struct buffer
*old_buffer
= NULL
;
21001 int no_props
= INTEGERP (face
);
21002 ptrdiff_t count
= SPECPDL_INDEX ();
21004 int string_start
= 0;
21007 window
= selected_window
;
21008 CHECK_WINDOW (window
);
21009 w
= XWINDOW (window
);
21012 buffer
= w
->buffer
;
21013 CHECK_BUFFER (buffer
);
21015 /* Make formatting the modeline a non-op when noninteractive, otherwise
21016 there will be problems later caused by a partially initialized frame. */
21017 if (NILP (format
) || noninteractive
)
21018 return empty_unibyte_string
;
21023 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21024 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21025 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21026 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21027 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21028 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21029 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21032 if (XBUFFER (buffer
) != current_buffer
)
21033 old_buffer
= current_buffer
;
21035 /* Save things including mode_line_proptrans_alist,
21036 and set that to nil so that we don't alter the outer value. */
21037 record_unwind_protect (unwind_format_mode_line
,
21038 format_mode_line_unwind_data
21039 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
21040 old_buffer
, selected_window
, 1));
21041 mode_line_proptrans_alist
= Qnil
;
21043 Fselect_window (window
, Qt
);
21045 set_buffer_internal_1 (XBUFFER (buffer
));
21047 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21051 mode_line_target
= MODE_LINE_NOPROP
;
21052 mode_line_string_face_prop
= Qnil
;
21053 mode_line_string_list
= Qnil
;
21054 string_start
= MODE_LINE_NOPROP_LEN (0);
21058 mode_line_target
= MODE_LINE_STRING
;
21059 mode_line_string_list
= Qnil
;
21060 mode_line_string_face
= face
;
21061 mode_line_string_face_prop
21062 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21065 push_kboard (FRAME_KBOARD (it
.f
));
21066 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21071 len
= MODE_LINE_NOPROP_LEN (string_start
);
21072 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21076 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21077 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21078 empty_unibyte_string
);
21081 unbind_to (count
, Qnil
);
21085 /* Write a null-terminated, right justified decimal representation of
21086 the positive integer D to BUF using a minimal field width WIDTH. */
21089 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21091 register char *p
= buf
;
21099 *p
++ = d
% 10 + '0';
21104 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21115 /* Write a null-terminated, right justified decimal and "human
21116 readable" representation of the nonnegative integer D to BUF using
21117 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21119 static const char power_letter
[] =
21133 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21135 /* We aim to represent the nonnegative integer D as
21136 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21137 ptrdiff_t quotient
= d
;
21139 /* -1 means: do not use TENTHS. */
21143 /* Length of QUOTIENT.TENTHS as a string. */
21149 if (1000 <= quotient
)
21151 /* Scale to the appropriate EXPONENT. */
21154 remainder
= quotient
% 1000;
21158 while (1000 <= quotient
);
21160 /* Round to nearest and decide whether to use TENTHS or not. */
21163 tenths
= remainder
/ 100;
21164 if (50 <= remainder
% 100)
21171 if (quotient
== 10)
21179 if (500 <= remainder
)
21181 if (quotient
< 999)
21192 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21193 if (tenths
== -1 && quotient
<= 99)
21200 p
= psuffix
= buf
+ max (width
, length
);
21202 /* Print EXPONENT. */
21203 *psuffix
++ = power_letter
[exponent
];
21206 /* Print TENTHS. */
21209 *--p
= '0' + tenths
;
21213 /* Print QUOTIENT. */
21216 int digit
= quotient
% 10;
21217 *--p
= '0' + digit
;
21219 while ((quotient
/= 10) != 0);
21221 /* Print leading spaces. */
21226 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21227 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21228 type of CODING_SYSTEM. Return updated pointer into BUF. */
21230 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21233 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21236 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21237 const unsigned char *eol_str
;
21239 /* The EOL conversion we are using. */
21240 Lisp_Object eoltype
;
21242 val
= CODING_SYSTEM_SPEC (coding_system
);
21245 if (!VECTORP (val
)) /* Not yet decided. */
21247 *buf
++ = multibyte
? '-' : ' ';
21249 eoltype
= eol_mnemonic_undecided
;
21250 /* Don't mention EOL conversion if it isn't decided. */
21255 Lisp_Object eolvalue
;
21257 attrs
= AREF (val
, 0);
21258 eolvalue
= AREF (val
, 2);
21261 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21266 /* The EOL conversion that is normal on this system. */
21268 if (NILP (eolvalue
)) /* Not yet decided. */
21269 eoltype
= eol_mnemonic_undecided
;
21270 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21271 eoltype
= eol_mnemonic_undecided
;
21272 else /* eolvalue is Qunix, Qdos, or Qmac. */
21273 eoltype
= (EQ (eolvalue
, Qunix
)
21274 ? eol_mnemonic_unix
21275 : (EQ (eolvalue
, Qdos
) == 1
21276 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21282 /* Mention the EOL conversion if it is not the usual one. */
21283 if (STRINGP (eoltype
))
21285 eol_str
= SDATA (eoltype
);
21286 eol_str_len
= SBYTES (eoltype
);
21288 else if (CHARACTERP (eoltype
))
21290 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21291 int c
= XFASTINT (eoltype
);
21292 eol_str_len
= CHAR_STRING (c
, tmp
);
21297 eol_str
= invalid_eol_type
;
21298 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21300 memcpy (buf
, eol_str
, eol_str_len
);
21301 buf
+= eol_str_len
;
21307 /* Return a string for the output of a mode line %-spec for window W,
21308 generated by character C. FIELD_WIDTH > 0 means pad the string
21309 returned with spaces to that value. Return a Lisp string in
21310 *STRING if the resulting string is taken from that Lisp string.
21312 Note we operate on the current buffer for most purposes,
21313 the exception being w->base_line_pos. */
21315 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21317 static const char *
21318 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21319 Lisp_Object
*string
)
21322 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21323 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21324 struct buffer
*b
= current_buffer
;
21332 if (!NILP (BVAR (b
, read_only
)))
21334 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21339 /* This differs from %* only for a modified read-only buffer. */
21340 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21342 if (!NILP (BVAR (b
, read_only
)))
21347 /* This differs from %* in ignoring read-only-ness. */
21348 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21360 if (command_loop_level
> 5)
21362 p
= decode_mode_spec_buf
;
21363 for (i
= 0; i
< command_loop_level
; i
++)
21366 return decode_mode_spec_buf
;
21374 if (command_loop_level
> 5)
21376 p
= decode_mode_spec_buf
;
21377 for (i
= 0; i
< command_loop_level
; i
++)
21380 return decode_mode_spec_buf
;
21387 /* Let lots_of_dashes be a string of infinite length. */
21388 if (mode_line_target
== MODE_LINE_NOPROP
||
21389 mode_line_target
== MODE_LINE_STRING
)
21391 if (field_width
<= 0
21392 || field_width
> sizeof (lots_of_dashes
))
21394 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21395 decode_mode_spec_buf
[i
] = '-';
21396 decode_mode_spec_buf
[i
] = '\0';
21397 return decode_mode_spec_buf
;
21400 return lots_of_dashes
;
21404 obj
= BVAR (b
, name
);
21408 /* %c and %l are ignored in `frame-title-format'.
21409 (In redisplay_internal, the frame title is drawn _before_ the
21410 windows are updated, so the stuff which depends on actual
21411 window contents (such as %l) may fail to render properly, or
21412 even crash emacs.) */
21413 if (mode_line_target
== MODE_LINE_TITLE
)
21417 ptrdiff_t col
= current_column ();
21418 wset_column_number_displayed (w
, make_number (col
));
21419 pint2str (decode_mode_spec_buf
, field_width
, col
);
21420 return decode_mode_spec_buf
;
21424 #ifndef SYSTEM_MALLOC
21426 if (NILP (Vmemory_full
))
21429 return "!MEM FULL! ";
21436 /* %F displays the frame name. */
21437 if (!NILP (f
->title
))
21438 return SSDATA (f
->title
);
21439 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21440 return SSDATA (f
->name
);
21444 obj
= BVAR (b
, filename
);
21449 ptrdiff_t size
= ZV
- BEGV
;
21450 pint2str (decode_mode_spec_buf
, field_width
, size
);
21451 return decode_mode_spec_buf
;
21456 ptrdiff_t size
= ZV
- BEGV
;
21457 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21458 return decode_mode_spec_buf
;
21463 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21464 ptrdiff_t topline
, nlines
, height
;
21467 /* %c and %l are ignored in `frame-title-format'. */
21468 if (mode_line_target
== MODE_LINE_TITLE
)
21471 startpos
= XMARKER (w
->start
)->charpos
;
21472 startpos_byte
= marker_byte_position (w
->start
);
21473 height
= WINDOW_TOTAL_LINES (w
);
21475 /* If we decided that this buffer isn't suitable for line numbers,
21476 don't forget that too fast. */
21477 if (EQ (w
->base_line_pos
, w
->buffer
))
21479 /* But do forget it, if the window shows a different buffer now. */
21480 else if (BUFFERP (w
->base_line_pos
))
21481 wset_base_line_pos (w
, Qnil
);
21483 /* If the buffer is very big, don't waste time. */
21484 if (INTEGERP (Vline_number_display_limit
)
21485 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21487 wset_base_line_pos (w
, Qnil
);
21488 wset_base_line_number (w
, Qnil
);
21492 if (INTEGERP (w
->base_line_number
)
21493 && INTEGERP (w
->base_line_pos
)
21494 && XFASTINT (w
->base_line_pos
) <= startpos
)
21496 line
= XFASTINT (w
->base_line_number
);
21497 linepos
= XFASTINT (w
->base_line_pos
);
21498 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21503 linepos
= BUF_BEGV (b
);
21504 linepos_byte
= BUF_BEGV_BYTE (b
);
21507 /* Count lines from base line to window start position. */
21508 nlines
= display_count_lines (linepos_byte
,
21512 topline
= nlines
+ line
;
21514 /* Determine a new base line, if the old one is too close
21515 or too far away, or if we did not have one.
21516 "Too close" means it's plausible a scroll-down would
21517 go back past it. */
21518 if (startpos
== BUF_BEGV (b
))
21520 wset_base_line_number (w
, make_number (topline
));
21521 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21523 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21524 || linepos
== BUF_BEGV (b
))
21526 ptrdiff_t limit
= BUF_BEGV (b
);
21527 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21528 ptrdiff_t position
;
21529 ptrdiff_t distance
=
21530 (height
* 2 + 30) * line_number_display_limit_width
;
21532 if (startpos
- distance
> limit
)
21534 limit
= startpos
- distance
;
21535 limit_byte
= CHAR_TO_BYTE (limit
);
21538 nlines
= display_count_lines (startpos_byte
,
21540 - (height
* 2 + 30),
21542 /* If we couldn't find the lines we wanted within
21543 line_number_display_limit_width chars per line,
21544 give up on line numbers for this window. */
21545 if (position
== limit_byte
&& limit
== startpos
- distance
)
21547 wset_base_line_pos (w
, w
->buffer
);
21548 wset_base_line_number (w
, Qnil
);
21552 wset_base_line_number (w
, make_number (topline
- nlines
));
21553 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21556 /* Now count lines from the start pos to point. */
21557 nlines
= display_count_lines (startpos_byte
,
21558 PT_BYTE
, PT
, &junk
);
21560 /* Record that we did display the line number. */
21561 line_number_displayed
= 1;
21563 /* Make the string to show. */
21564 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21565 return decode_mode_spec_buf
;
21568 char* p
= decode_mode_spec_buf
;
21569 int pad
= field_width
- 2;
21575 return decode_mode_spec_buf
;
21581 obj
= BVAR (b
, mode_name
);
21585 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21591 ptrdiff_t pos
= marker_position (w
->start
);
21592 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21594 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21596 if (pos
<= BUF_BEGV (b
))
21601 else if (pos
<= BUF_BEGV (b
))
21605 if (total
> 1000000)
21606 /* Do it differently for a large value, to avoid overflow. */
21607 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21609 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21610 /* We can't normally display a 3-digit number,
21611 so get us a 2-digit number that is close. */
21614 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21615 return decode_mode_spec_buf
;
21619 /* Display percentage of size above the bottom of the screen. */
21622 ptrdiff_t toppos
= marker_position (w
->start
);
21623 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21624 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21626 if (botpos
>= BUF_ZV (b
))
21628 if (toppos
<= BUF_BEGV (b
))
21635 if (total
> 1000000)
21636 /* Do it differently for a large value, to avoid overflow. */
21637 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21639 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21640 /* We can't normally display a 3-digit number,
21641 so get us a 2-digit number that is close. */
21644 if (toppos
<= BUF_BEGV (b
))
21645 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21647 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21648 return decode_mode_spec_buf
;
21653 /* status of process */
21654 obj
= Fget_buffer_process (Fcurrent_buffer ());
21656 return "no process";
21658 obj
= Fsymbol_name (Fprocess_status (obj
));
21664 ptrdiff_t count
= inhibit_garbage_collection ();
21665 Lisp_Object val
= call1 (intern ("file-remote-p"),
21666 BVAR (current_buffer
, directory
));
21667 unbind_to (count
, Qnil
);
21675 case 't': /* indicate TEXT or BINARY */
21679 /* coding-system (not including end-of-line format) */
21681 /* coding-system (including end-of-line type) */
21683 int eol_flag
= (c
== 'Z');
21684 char *p
= decode_mode_spec_buf
;
21686 if (! FRAME_WINDOW_P (f
))
21688 /* No need to mention EOL here--the terminal never needs
21689 to do EOL conversion. */
21690 p
= decode_mode_spec_coding (CODING_ID_NAME
21691 (FRAME_KEYBOARD_CODING (f
)->id
),
21693 p
= decode_mode_spec_coding (CODING_ID_NAME
21694 (FRAME_TERMINAL_CODING (f
)->id
),
21697 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21700 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21701 #ifdef subprocesses
21702 obj
= Fget_buffer_process (Fcurrent_buffer ());
21703 if (PROCESSP (obj
))
21705 p
= decode_mode_spec_coding
21706 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21707 p
= decode_mode_spec_coding
21708 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21710 #endif /* subprocesses */
21713 return decode_mode_spec_buf
;
21720 return SSDATA (obj
);
21727 /* Count up to COUNT lines starting from START_BYTE.
21728 But don't go beyond LIMIT_BYTE.
21729 Return the number of lines thus found (always nonnegative).
21731 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21734 display_count_lines (ptrdiff_t start_byte
,
21735 ptrdiff_t limit_byte
, ptrdiff_t count
,
21736 ptrdiff_t *byte_pos_ptr
)
21738 register unsigned char *cursor
;
21739 unsigned char *base
;
21741 register ptrdiff_t ceiling
;
21742 register unsigned char *ceiling_addr
;
21743 ptrdiff_t orig_count
= count
;
21745 /* If we are not in selective display mode,
21746 check only for newlines. */
21747 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21748 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21752 while (start_byte
< limit_byte
)
21754 ceiling
= BUFFER_CEILING_OF (start_byte
);
21755 ceiling
= min (limit_byte
- 1, ceiling
);
21756 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21757 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21760 if (selective_display
)
21761 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21764 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21767 if (cursor
!= ceiling_addr
)
21771 start_byte
+= cursor
- base
+ 1;
21772 *byte_pos_ptr
= start_byte
;
21776 if (++cursor
== ceiling_addr
)
21782 start_byte
+= cursor
- base
;
21787 while (start_byte
> limit_byte
)
21789 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21790 ceiling
= max (limit_byte
, ceiling
);
21791 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21792 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21795 if (selective_display
)
21796 while (--cursor
!= ceiling_addr
21797 && *cursor
!= '\n' && *cursor
!= 015)
21800 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21803 if (cursor
!= ceiling_addr
)
21807 start_byte
+= cursor
- base
+ 1;
21808 *byte_pos_ptr
= start_byte
;
21809 /* When scanning backwards, we should
21810 not count the newline posterior to which we stop. */
21811 return - orig_count
- 1;
21817 /* Here we add 1 to compensate for the last decrement
21818 of CURSOR, which took it past the valid range. */
21819 start_byte
+= cursor
- base
+ 1;
21823 *byte_pos_ptr
= limit_byte
;
21826 return - orig_count
+ count
;
21827 return orig_count
- count
;
21833 /***********************************************************************
21835 ***********************************************************************/
21837 /* Display a NUL-terminated string, starting with index START.
21839 If STRING is non-null, display that C string. Otherwise, the Lisp
21840 string LISP_STRING is displayed. There's a case that STRING is
21841 non-null and LISP_STRING is not nil. It means STRING is a string
21842 data of LISP_STRING. In that case, we display LISP_STRING while
21843 ignoring its text properties.
21845 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21846 FACE_STRING. Display STRING or LISP_STRING with the face at
21847 FACE_STRING_POS in FACE_STRING:
21849 Display the string in the environment given by IT, but use the
21850 standard display table, temporarily.
21852 FIELD_WIDTH is the minimum number of output glyphs to produce.
21853 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21854 with spaces. If STRING has more characters, more than FIELD_WIDTH
21855 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21857 PRECISION is the maximum number of characters to output from
21858 STRING. PRECISION < 0 means don't truncate the string.
21860 This is roughly equivalent to printf format specifiers:
21862 FIELD_WIDTH PRECISION PRINTF
21863 ----------------------------------------
21869 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21870 display them, and < 0 means obey the current buffer's value of
21871 enable_multibyte_characters.
21873 Value is the number of columns displayed. */
21876 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21877 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21878 int field_width
, int precision
, int max_x
, int multibyte
)
21880 int hpos_at_start
= it
->hpos
;
21881 int saved_face_id
= it
->face_id
;
21882 struct glyph_row
*row
= it
->glyph_row
;
21883 ptrdiff_t it_charpos
;
21885 /* Initialize the iterator IT for iteration over STRING beginning
21886 with index START. */
21887 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21888 precision
, field_width
, multibyte
);
21889 if (string
&& STRINGP (lisp_string
))
21890 /* LISP_STRING is the one returned by decode_mode_spec. We should
21891 ignore its text properties. */
21892 it
->stop_charpos
= it
->end_charpos
;
21894 /* If displaying STRING, set up the face of the iterator from
21895 FACE_STRING, if that's given. */
21896 if (STRINGP (face_string
))
21902 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21903 0, it
->region_beg_charpos
,
21904 it
->region_end_charpos
,
21905 &endptr
, it
->base_face_id
, 0);
21906 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21907 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21910 /* Set max_x to the maximum allowed X position. Don't let it go
21911 beyond the right edge of the window. */
21913 max_x
= it
->last_visible_x
;
21915 max_x
= min (max_x
, it
->last_visible_x
);
21917 /* Skip over display elements that are not visible. because IT->w is
21919 if (it
->current_x
< it
->first_visible_x
)
21920 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21921 MOVE_TO_POS
| MOVE_TO_X
);
21923 row
->ascent
= it
->max_ascent
;
21924 row
->height
= it
->max_ascent
+ it
->max_descent
;
21925 row
->phys_ascent
= it
->max_phys_ascent
;
21926 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21927 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21929 if (STRINGP (it
->string
))
21930 it_charpos
= IT_STRING_CHARPOS (*it
);
21932 it_charpos
= IT_CHARPOS (*it
);
21934 /* This condition is for the case that we are called with current_x
21935 past last_visible_x. */
21936 while (it
->current_x
< max_x
)
21938 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21940 /* Get the next display element. */
21941 if (!get_next_display_element (it
))
21944 /* Produce glyphs. */
21945 x_before
= it
->current_x
;
21946 n_glyphs_before
= row
->used
[TEXT_AREA
];
21947 PRODUCE_GLYPHS (it
);
21949 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21952 while (i
< nglyphs
)
21954 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21956 if (it
->line_wrap
!= TRUNCATE
21957 && x
+ glyph
->pixel_width
> max_x
)
21959 /* End of continued line or max_x reached. */
21960 if (CHAR_GLYPH_PADDING_P (*glyph
))
21962 /* A wide character is unbreakable. */
21963 if (row
->reversed_p
)
21964 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21965 - n_glyphs_before
);
21966 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21967 it
->current_x
= x_before
;
21971 if (row
->reversed_p
)
21972 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21973 - (n_glyphs_before
+ i
));
21974 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21979 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21981 /* Glyph is at least partially visible. */
21983 if (x
< it
->first_visible_x
)
21984 row
->x
= x
- it
->first_visible_x
;
21988 /* Glyph is off the left margin of the display area.
21989 Should not happen. */
21993 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21994 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21995 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21996 row
->phys_height
= max (row
->phys_height
,
21997 it
->max_phys_ascent
+ it
->max_phys_descent
);
21998 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21999 it
->max_extra_line_spacing
);
22000 x
+= glyph
->pixel_width
;
22004 /* Stop if max_x reached. */
22008 /* Stop at line ends. */
22009 if (ITERATOR_AT_END_OF_LINE_P (it
))
22011 it
->continuation_lines_width
= 0;
22015 set_iterator_to_next (it
, 1);
22016 if (STRINGP (it
->string
))
22017 it_charpos
= IT_STRING_CHARPOS (*it
);
22019 it_charpos
= IT_CHARPOS (*it
);
22021 /* Stop if truncating at the right edge. */
22022 if (it
->line_wrap
== TRUNCATE
22023 && it
->current_x
>= it
->last_visible_x
)
22025 /* Add truncation mark, but don't do it if the line is
22026 truncated at a padding space. */
22027 if (it_charpos
< it
->string_nchars
)
22029 if (!FRAME_WINDOW_P (it
->f
))
22033 if (it
->current_x
> it
->last_visible_x
)
22035 if (!row
->reversed_p
)
22037 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22038 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22043 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22044 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22046 unproduce_glyphs (it
, ii
+ 1);
22047 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22049 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22051 row
->used
[TEXT_AREA
] = ii
;
22052 produce_special_glyphs (it
, IT_TRUNCATION
);
22055 produce_special_glyphs (it
, IT_TRUNCATION
);
22057 row
->truncated_on_right_p
= 1;
22063 /* Maybe insert a truncation at the left. */
22064 if (it
->first_visible_x
22067 if (!FRAME_WINDOW_P (it
->f
)
22068 || (row
->reversed_p
22069 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22070 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22071 insert_left_trunc_glyphs (it
);
22072 row
->truncated_on_left_p
= 1;
22075 it
->face_id
= saved_face_id
;
22077 /* Value is number of columns displayed. */
22078 return it
->hpos
- hpos_at_start
;
22083 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22084 appears as an element of LIST or as the car of an element of LIST.
22085 If PROPVAL is a list, compare each element against LIST in that
22086 way, and return 1/2 if any element of PROPVAL is found in LIST.
22087 Otherwise return 0. This function cannot quit.
22088 The return value is 2 if the text is invisible but with an ellipsis
22089 and 1 if it's invisible and without an ellipsis. */
22092 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22094 register Lisp_Object tail
, proptail
;
22096 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22098 register Lisp_Object tem
;
22100 if (EQ (propval
, tem
))
22102 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22103 return NILP (XCDR (tem
)) ? 1 : 2;
22106 if (CONSP (propval
))
22108 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22110 Lisp_Object propelt
;
22111 propelt
= XCAR (proptail
);
22112 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22114 register Lisp_Object tem
;
22116 if (EQ (propelt
, tem
))
22118 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22119 return NILP (XCDR (tem
)) ? 1 : 2;
22127 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22128 doc
: /* Non-nil if the property makes the text invisible.
22129 POS-OR-PROP can be a marker or number, in which case it is taken to be
22130 a position in the current buffer and the value of the `invisible' property
22131 is checked; or it can be some other value, which is then presumed to be the
22132 value of the `invisible' property of the text of interest.
22133 The non-nil value returned can be t for truly invisible text or something
22134 else if the text is replaced by an ellipsis. */)
22135 (Lisp_Object pos_or_prop
)
22138 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22139 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22141 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22142 return (invis
== 0 ? Qnil
22144 : make_number (invis
));
22147 /* Calculate a width or height in pixels from a specification using
22148 the following elements:
22151 NUM - a (fractional) multiple of the default font width/height
22152 (NUM) - specifies exactly NUM pixels
22153 UNIT - a fixed number of pixels, see below.
22154 ELEMENT - size of a display element in pixels, see below.
22155 (NUM . SPEC) - equals NUM * SPEC
22156 (+ SPEC SPEC ...) - add pixel values
22157 (- SPEC SPEC ...) - subtract pixel values
22158 (- SPEC) - negate pixel value
22161 INT or FLOAT - a number constant
22162 SYMBOL - use symbol's (buffer local) variable binding.
22165 in - pixels per inch *)
22166 mm - pixels per 1/1000 meter *)
22167 cm - pixels per 1/100 meter *)
22168 width - width of current font in pixels.
22169 height - height of current font in pixels.
22171 *) using the ratio(s) defined in display-pixels-per-inch.
22175 left-fringe - left fringe width in pixels
22176 right-fringe - right fringe width in pixels
22178 left-margin - left margin width in pixels
22179 right-margin - right margin width in pixels
22181 scroll-bar - scroll-bar area width in pixels
22185 Pixels corresponding to 5 inches:
22188 Total width of non-text areas on left side of window (if scroll-bar is on left):
22189 '(space :width (+ left-fringe left-margin scroll-bar))
22191 Align to first text column (in header line):
22192 '(space :align-to 0)
22194 Align to middle of text area minus half the width of variable `my-image'
22195 containing a loaded image:
22196 '(space :align-to (0.5 . (- text my-image)))
22198 Width of left margin minus width of 1 character in the default font:
22199 '(space :width (- left-margin 1))
22201 Width of left margin minus width of 2 characters in the current font:
22202 '(space :width (- left-margin (2 . width)))
22204 Center 1 character over left-margin (in header line):
22205 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22207 Different ways to express width of left fringe plus left margin minus one pixel:
22208 '(space :width (- (+ left-fringe left-margin) (1)))
22209 '(space :width (+ left-fringe left-margin (- (1))))
22210 '(space :width (+ left-fringe left-margin (-1)))
22214 #define NUMVAL(X) \
22215 ((INTEGERP (X) || FLOATP (X)) \
22220 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22221 struct font
*font
, int width_p
, int *align_to
)
22225 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22226 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22229 return OK_PIXELS (0);
22231 eassert (FRAME_LIVE_P (it
->f
));
22233 if (SYMBOLP (prop
))
22235 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22237 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22239 if (unit
[0] == 'i' && unit
[1] == 'n')
22241 else if (unit
[0] == 'm' && unit
[1] == 'm')
22243 else if (unit
[0] == 'c' && unit
[1] == 'm')
22250 #ifdef HAVE_WINDOW_SYSTEM
22251 if (FRAME_WINDOW_P (it
->f
)
22253 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22254 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22256 return OK_PIXELS (ppi
/ pixels
);
22259 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22260 || (CONSP (Vdisplay_pixels_per_inch
)
22262 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22263 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22265 return OK_PIXELS (ppi
/ pixels
);
22271 #ifdef HAVE_WINDOW_SYSTEM
22272 if (EQ (prop
, Qheight
))
22273 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22274 if (EQ (prop
, Qwidth
))
22275 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22277 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22278 return OK_PIXELS (1);
22281 if (EQ (prop
, Qtext
))
22282 return OK_PIXELS (width_p
22283 ? window_box_width (it
->w
, TEXT_AREA
)
22284 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22286 if (align_to
&& *align_to
< 0)
22289 if (EQ (prop
, Qleft
))
22290 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22291 if (EQ (prop
, Qright
))
22292 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22293 if (EQ (prop
, Qcenter
))
22294 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22295 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22296 if (EQ (prop
, Qleft_fringe
))
22297 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22298 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22299 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22300 if (EQ (prop
, Qright_fringe
))
22301 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22302 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22303 : window_box_right_offset (it
->w
, TEXT_AREA
));
22304 if (EQ (prop
, Qleft_margin
))
22305 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22306 if (EQ (prop
, Qright_margin
))
22307 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22308 if (EQ (prop
, Qscroll_bar
))
22309 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22311 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22312 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22313 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22318 if (EQ (prop
, Qleft_fringe
))
22319 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22320 if (EQ (prop
, Qright_fringe
))
22321 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22322 if (EQ (prop
, Qleft_margin
))
22323 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22324 if (EQ (prop
, Qright_margin
))
22325 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22326 if (EQ (prop
, Qscroll_bar
))
22327 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22330 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22331 if (EQ (prop
, Qunbound
))
22335 if (INTEGERP (prop
) || FLOATP (prop
))
22337 int base_unit
= (width_p
22338 ? FRAME_COLUMN_WIDTH (it
->f
)
22339 : FRAME_LINE_HEIGHT (it
->f
));
22340 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22345 Lisp_Object car
= XCAR (prop
);
22346 Lisp_Object cdr
= XCDR (prop
);
22350 #ifdef HAVE_WINDOW_SYSTEM
22351 if (FRAME_WINDOW_P (it
->f
)
22352 && valid_image_p (prop
))
22354 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22355 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22357 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22360 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22366 while (CONSP (cdr
))
22368 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22369 font
, width_p
, align_to
))
22372 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22377 if (EQ (car
, Qminus
))
22379 return OK_PIXELS (pixels
);
22382 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22383 if (EQ (car
, Qunbound
))
22387 if (INTEGERP (car
) || FLOATP (car
))
22390 pixels
= XFLOATINT (car
);
22392 return OK_PIXELS (pixels
);
22393 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22394 font
, width_p
, align_to
))
22395 return OK_PIXELS (pixels
* fact
);
22406 /***********************************************************************
22408 ***********************************************************************/
22410 #ifdef HAVE_WINDOW_SYSTEM
22415 dump_glyph_string (struct glyph_string
*s
)
22417 fprintf (stderr
, "glyph string\n");
22418 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22419 s
->x
, s
->y
, s
->width
, s
->height
);
22420 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22421 fprintf (stderr
, " hl = %d\n", s
->hl
);
22422 fprintf (stderr
, " left overhang = %d, right = %d\n",
22423 s
->left_overhang
, s
->right_overhang
);
22424 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22425 fprintf (stderr
, " extends to end of line = %d\n",
22426 s
->extends_to_end_of_line_p
);
22427 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22428 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22431 #endif /* GLYPH_DEBUG */
22433 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22434 of XChar2b structures for S; it can't be allocated in
22435 init_glyph_string because it must be allocated via `alloca'. W
22436 is the window on which S is drawn. ROW and AREA are the glyph row
22437 and area within the row from which S is constructed. START is the
22438 index of the first glyph structure covered by S. HL is a
22439 face-override for drawing S. */
22442 #define OPTIONAL_HDC(hdc) HDC hdc,
22443 #define DECLARE_HDC(hdc) HDC hdc;
22444 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22445 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22448 #ifndef OPTIONAL_HDC
22449 #define OPTIONAL_HDC(hdc)
22450 #define DECLARE_HDC(hdc)
22451 #define ALLOCATE_HDC(hdc, f)
22452 #define RELEASE_HDC(hdc, f)
22456 init_glyph_string (struct glyph_string
*s
,
22458 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22459 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22461 memset (s
, 0, sizeof *s
);
22463 s
->f
= XFRAME (w
->frame
);
22467 s
->display
= FRAME_X_DISPLAY (s
->f
);
22468 s
->window
= FRAME_X_WINDOW (s
->f
);
22469 s
->char2b
= char2b
;
22473 s
->first_glyph
= row
->glyphs
[area
] + start
;
22474 s
->height
= row
->height
;
22475 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22476 s
->ybase
= s
->y
+ row
->ascent
;
22480 /* Append the list of glyph strings with head H and tail T to the list
22481 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22484 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22485 struct glyph_string
*h
, struct glyph_string
*t
)
22499 /* Prepend the list of glyph strings with head H and tail T to the
22500 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22504 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22505 struct glyph_string
*h
, struct glyph_string
*t
)
22519 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22520 Set *HEAD and *TAIL to the resulting list. */
22523 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22524 struct glyph_string
*s
)
22526 s
->next
= s
->prev
= NULL
;
22527 append_glyph_string_lists (head
, tail
, s
, s
);
22531 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22532 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22533 make sure that X resources for the face returned are allocated.
22534 Value is a pointer to a realized face that is ready for display if
22535 DISPLAY_P is non-zero. */
22537 static inline struct face
*
22538 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22539 XChar2b
*char2b
, int display_p
)
22541 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22545 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22547 if (code
!= FONT_INVALID_CODE
)
22548 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22550 STORE_XCHAR2B (char2b
, 0, 0);
22553 /* Make sure X resources of the face are allocated. */
22554 #ifdef HAVE_X_WINDOWS
22558 eassert (face
!= NULL
);
22559 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22566 /* Get face and two-byte form of character glyph GLYPH on frame F.
22567 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22568 a pointer to a realized face that is ready for display. */
22570 static inline struct face
*
22571 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22572 XChar2b
*char2b
, int *two_byte_p
)
22576 eassert (glyph
->type
== CHAR_GLYPH
);
22577 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22586 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22587 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22589 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22591 if (code
!= FONT_INVALID_CODE
)
22592 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22594 STORE_XCHAR2B (char2b
, 0, 0);
22597 /* Make sure X resources of the face are allocated. */
22598 eassert (face
!= NULL
);
22599 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22604 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22605 Return 1 if FONT has a glyph for C, otherwise return 0. */
22608 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22612 if (CHAR_BYTE8_P (c
))
22613 code
= CHAR_TO_BYTE8 (c
);
22615 code
= font
->driver
->encode_char (font
, c
);
22617 if (code
== FONT_INVALID_CODE
)
22619 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22624 /* Fill glyph string S with composition components specified by S->cmp.
22626 BASE_FACE is the base face of the composition.
22627 S->cmp_from is the index of the first component for S.
22629 OVERLAPS non-zero means S should draw the foreground only, and use
22630 its physical height for clipping. See also draw_glyphs.
22632 Value is the index of a component not in S. */
22635 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22639 /* For all glyphs of this composition, starting at the offset
22640 S->cmp_from, until we reach the end of the definition or encounter a
22641 glyph that requires the different face, add it to S. */
22646 s
->for_overlaps
= overlaps
;
22649 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22651 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22653 /* TAB in a composition means display glyphs with padding space
22654 on the left or right. */
22657 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22660 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22667 s
->font
= s
->face
->font
;
22669 else if (s
->face
!= face
)
22677 if (s
->face
== NULL
)
22679 s
->face
= base_face
->ascii_face
;
22680 s
->font
= s
->face
->font
;
22683 /* All glyph strings for the same composition has the same width,
22684 i.e. the width set for the first component of the composition. */
22685 s
->width
= s
->first_glyph
->pixel_width
;
22687 /* If the specified font could not be loaded, use the frame's
22688 default font, but record the fact that we couldn't load it in
22689 the glyph string so that we can draw rectangles for the
22690 characters of the glyph string. */
22691 if (s
->font
== NULL
)
22693 s
->font_not_found_p
= 1;
22694 s
->font
= FRAME_FONT (s
->f
);
22697 /* Adjust base line for subscript/superscript text. */
22698 s
->ybase
+= s
->first_glyph
->voffset
;
22700 /* This glyph string must always be drawn with 16-bit functions. */
22707 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22708 int start
, int end
, int overlaps
)
22710 struct glyph
*glyph
, *last
;
22711 Lisp_Object lgstring
;
22714 s
->for_overlaps
= overlaps
;
22715 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22716 last
= s
->row
->glyphs
[s
->area
] + end
;
22717 s
->cmp_id
= glyph
->u
.cmp
.id
;
22718 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22719 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22720 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22721 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22722 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22724 while (glyph
< last
22725 && glyph
->u
.cmp
.automatic
22726 && glyph
->u
.cmp
.id
== s
->cmp_id
22727 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22728 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22730 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22732 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22733 unsigned code
= LGLYPH_CODE (lglyph
);
22735 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22737 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22738 return glyph
- s
->row
->glyphs
[s
->area
];
22742 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22743 See the comment of fill_glyph_string for arguments.
22744 Value is the index of the first glyph not in S. */
22748 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22749 int start
, int end
, int overlaps
)
22751 struct glyph
*glyph
, *last
;
22754 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22755 s
->for_overlaps
= overlaps
;
22756 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22757 last
= s
->row
->glyphs
[s
->area
] + end
;
22758 voffset
= glyph
->voffset
;
22759 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22760 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22762 s
->width
= glyph
->pixel_width
;
22764 while (glyph
< last
22765 && glyph
->type
== GLYPHLESS_GLYPH
22766 && glyph
->voffset
== voffset
22767 && glyph
->face_id
== face_id
)
22770 s
->width
+= glyph
->pixel_width
;
22773 s
->ybase
+= voffset
;
22774 return glyph
- s
->row
->glyphs
[s
->area
];
22778 /* Fill glyph string S from a sequence of character glyphs.
22780 FACE_ID is the face id of the string. START is the index of the
22781 first glyph to consider, END is the index of the last + 1.
22782 OVERLAPS non-zero means S should draw the foreground only, and use
22783 its physical height for clipping. See also draw_glyphs.
22785 Value is the index of the first glyph not in S. */
22788 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22789 int start
, int end
, int overlaps
)
22791 struct glyph
*glyph
, *last
;
22793 int glyph_not_available_p
;
22795 eassert (s
->f
== XFRAME (s
->w
->frame
));
22796 eassert (s
->nchars
== 0);
22797 eassert (start
>= 0 && end
> start
);
22799 s
->for_overlaps
= overlaps
;
22800 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22801 last
= s
->row
->glyphs
[s
->area
] + end
;
22802 voffset
= glyph
->voffset
;
22803 s
->padding_p
= glyph
->padding_p
;
22804 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22806 while (glyph
< last
22807 && glyph
->type
== CHAR_GLYPH
22808 && glyph
->voffset
== voffset
22809 /* Same face id implies same font, nowadays. */
22810 && glyph
->face_id
== face_id
22811 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22815 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22816 s
->char2b
+ s
->nchars
,
22818 s
->two_byte_p
= two_byte_p
;
22820 eassert (s
->nchars
<= end
- start
);
22821 s
->width
+= glyph
->pixel_width
;
22822 if (glyph
++->padding_p
!= s
->padding_p
)
22826 s
->font
= s
->face
->font
;
22828 /* If the specified font could not be loaded, use the frame's font,
22829 but record the fact that we couldn't load it in
22830 S->font_not_found_p so that we can draw rectangles for the
22831 characters of the glyph string. */
22832 if (s
->font
== NULL
|| glyph_not_available_p
)
22834 s
->font_not_found_p
= 1;
22835 s
->font
= FRAME_FONT (s
->f
);
22838 /* Adjust base line for subscript/superscript text. */
22839 s
->ybase
+= voffset
;
22841 eassert (s
->face
&& s
->face
->gc
);
22842 return glyph
- s
->row
->glyphs
[s
->area
];
22846 /* Fill glyph string S from image glyph S->first_glyph. */
22849 fill_image_glyph_string (struct glyph_string
*s
)
22851 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22852 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22854 s
->slice
= s
->first_glyph
->slice
.img
;
22855 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22856 s
->font
= s
->face
->font
;
22857 s
->width
= s
->first_glyph
->pixel_width
;
22859 /* Adjust base line for subscript/superscript text. */
22860 s
->ybase
+= s
->first_glyph
->voffset
;
22864 /* Fill glyph string S from a sequence of stretch glyphs.
22866 START is the index of the first glyph to consider,
22867 END is the index of the last + 1.
22869 Value is the index of the first glyph not in S. */
22872 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22874 struct glyph
*glyph
, *last
;
22875 int voffset
, face_id
;
22877 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22879 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22880 last
= s
->row
->glyphs
[s
->area
] + end
;
22881 face_id
= glyph
->face_id
;
22882 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22883 s
->font
= s
->face
->font
;
22884 s
->width
= glyph
->pixel_width
;
22886 voffset
= glyph
->voffset
;
22890 && glyph
->type
== STRETCH_GLYPH
22891 && glyph
->voffset
== voffset
22892 && glyph
->face_id
== face_id
);
22894 s
->width
+= glyph
->pixel_width
;
22896 /* Adjust base line for subscript/superscript text. */
22897 s
->ybase
+= voffset
;
22899 /* The case that face->gc == 0 is handled when drawing the glyph
22900 string by calling PREPARE_FACE_FOR_DISPLAY. */
22902 return glyph
- s
->row
->glyphs
[s
->area
];
22905 static struct font_metrics
*
22906 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22908 static struct font_metrics metrics
;
22909 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22911 if (! font
|| code
== FONT_INVALID_CODE
)
22913 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22918 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22919 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22920 assumed to be zero. */
22923 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22925 *left
= *right
= 0;
22927 if (glyph
->type
== CHAR_GLYPH
)
22931 struct font_metrics
*pcm
;
22933 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22934 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22936 if (pcm
->rbearing
> pcm
->width
)
22937 *right
= pcm
->rbearing
- pcm
->width
;
22938 if (pcm
->lbearing
< 0)
22939 *left
= -pcm
->lbearing
;
22942 else if (glyph
->type
== COMPOSITE_GLYPH
)
22944 if (! glyph
->u
.cmp
.automatic
)
22946 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22948 if (cmp
->rbearing
> cmp
->pixel_width
)
22949 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22950 if (cmp
->lbearing
< 0)
22951 *left
= - cmp
->lbearing
;
22955 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22956 struct font_metrics metrics
;
22958 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22959 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22960 if (metrics
.rbearing
> metrics
.width
)
22961 *right
= metrics
.rbearing
- metrics
.width
;
22962 if (metrics
.lbearing
< 0)
22963 *left
= - metrics
.lbearing
;
22969 /* Return the index of the first glyph preceding glyph string S that
22970 is overwritten by S because of S's left overhang. Value is -1
22971 if no glyphs are overwritten. */
22974 left_overwritten (struct glyph_string
*s
)
22978 if (s
->left_overhang
)
22981 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22982 int first
= s
->first_glyph
- glyphs
;
22984 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22985 x
-= glyphs
[i
].pixel_width
;
22996 /* Return the index of the first glyph preceding glyph string S that
22997 is overwriting S because of its right overhang. Value is -1 if no
22998 glyph in front of S overwrites S. */
23001 left_overwriting (struct glyph_string
*s
)
23004 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23005 int first
= s
->first_glyph
- glyphs
;
23009 for (i
= first
- 1; i
>= 0; --i
)
23012 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23015 x
-= glyphs
[i
].pixel_width
;
23022 /* Return the index of the last glyph following glyph string S that is
23023 overwritten by S because of S's right overhang. Value is -1 if
23024 no such glyph is found. */
23027 right_overwritten (struct glyph_string
*s
)
23031 if (s
->right_overhang
)
23034 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23035 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
23036 int end
= s
->row
->used
[s
->area
];
23038 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23039 x
+= glyphs
[i
].pixel_width
;
23048 /* Return the index of the last glyph following glyph string S that
23049 overwrites S because of its left overhang. Value is negative
23050 if no such glyph is found. */
23053 right_overwriting (struct glyph_string
*s
)
23056 int end
= s
->row
->used
[s
->area
];
23057 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23058 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
23062 for (i
= first
; i
< end
; ++i
)
23065 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23068 x
+= glyphs
[i
].pixel_width
;
23075 /* Set background width of glyph string S. START is the index of the
23076 first glyph following S. LAST_X is the right-most x-position + 1
23077 in the drawing area. */
23080 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23082 /* If the face of this glyph string has to be drawn to the end of
23083 the drawing area, set S->extends_to_end_of_line_p. */
23085 if (start
== s
->row
->used
[s
->area
]
23086 && s
->area
== TEXT_AREA
23087 && ((s
->row
->fill_line_p
23088 && (s
->hl
== DRAW_NORMAL_TEXT
23089 || s
->hl
== DRAW_IMAGE_RAISED
23090 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23091 || s
->hl
== DRAW_MOUSE_FACE
))
23092 s
->extends_to_end_of_line_p
= 1;
23094 /* If S extends its face to the end of the line, set its
23095 background_width to the distance to the right edge of the drawing
23097 if (s
->extends_to_end_of_line_p
)
23098 s
->background_width
= last_x
- s
->x
+ 1;
23100 s
->background_width
= s
->width
;
23104 /* Compute overhangs and x-positions for glyph string S and its
23105 predecessors, or successors. X is the starting x-position for S.
23106 BACKWARD_P non-zero means process predecessors. */
23109 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23115 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23116 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23126 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23127 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23137 /* The following macros are only called from draw_glyphs below.
23138 They reference the following parameters of that function directly:
23139 `w', `row', `area', and `overlap_p'
23140 as well as the following local variables:
23141 `s', `f', and `hdc' (in W32) */
23144 /* On W32, silently add local `hdc' variable to argument list of
23145 init_glyph_string. */
23146 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23147 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23149 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23150 init_glyph_string (s, char2b, w, row, area, start, hl)
23153 /* Add a glyph string for a stretch glyph to the list of strings
23154 between HEAD and TAIL. START is the index of the stretch glyph in
23155 row area AREA of glyph row ROW. END is the index of the last glyph
23156 in that glyph row area. X is the current output position assigned
23157 to the new glyph string constructed. HL overrides that face of the
23158 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23159 is the right-most x-position of the drawing area. */
23161 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23162 and below -- keep them on one line. */
23163 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23166 s = alloca (sizeof *s); \
23167 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23168 START = fill_stretch_glyph_string (s, START, END); \
23169 append_glyph_string (&HEAD, &TAIL, s); \
23175 /* Add a glyph string for an image glyph to the list of strings
23176 between HEAD and TAIL. START is the index of the image glyph in
23177 row area AREA of glyph row ROW. END is the index of the last glyph
23178 in that glyph row area. X is the current output position assigned
23179 to the new glyph string constructed. HL overrides that face of the
23180 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23181 is the right-most x-position of the drawing area. */
23183 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23186 s = alloca (sizeof *s); \
23187 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23188 fill_image_glyph_string (s); \
23189 append_glyph_string (&HEAD, &TAIL, s); \
23196 /* Add a glyph string for a sequence of character glyphs to the list
23197 of strings between HEAD and TAIL. START is the index of the first
23198 glyph in row area AREA of glyph row ROW that is part of the new
23199 glyph string. END is the index of the last glyph in that glyph row
23200 area. X is the current output position assigned to the new glyph
23201 string constructed. HL overrides that face of the glyph; e.g. it
23202 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23203 right-most x-position of the drawing area. */
23205 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23211 face_id = (row)->glyphs[area][START].face_id; \
23213 s = alloca (sizeof *s); \
23214 char2b = alloca ((END - START) * sizeof *char2b); \
23215 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23216 append_glyph_string (&HEAD, &TAIL, s); \
23218 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23223 /* Add a glyph string for a composite sequence to the list of strings
23224 between HEAD and TAIL. START is the index of the first glyph in
23225 row area AREA of glyph row ROW that is part of the new glyph
23226 string. END is the index of the last glyph in that glyph row area.
23227 X is the current output position assigned to the new glyph string
23228 constructed. HL overrides that face of the glyph; e.g. it is
23229 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23230 x-position of the drawing area. */
23232 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23234 int face_id = (row)->glyphs[area][START].face_id; \
23235 struct face *base_face = FACE_FROM_ID (f, face_id); \
23236 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23237 struct composition *cmp = composition_table[cmp_id]; \
23239 struct glyph_string *first_s = NULL; \
23242 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23244 /* Make glyph_strings for each glyph sequence that is drawable by \
23245 the same face, and append them to HEAD/TAIL. */ \
23246 for (n = 0; n < cmp->glyph_len;) \
23248 s = alloca (sizeof *s); \
23249 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23250 append_glyph_string (&(HEAD), &(TAIL), s); \
23256 n = fill_composite_glyph_string (s, base_face, overlaps); \
23264 /* Add a glyph string for a glyph-string sequence to the list of strings
23265 between HEAD and TAIL. */
23267 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23271 Lisp_Object gstring; \
23273 face_id = (row)->glyphs[area][START].face_id; \
23274 gstring = (composition_gstring_from_id \
23275 ((row)->glyphs[area][START].u.cmp.id)); \
23276 s = alloca (sizeof *s); \
23277 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23278 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23279 append_glyph_string (&(HEAD), &(TAIL), s); \
23281 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23285 /* Add a glyph string for a sequence of glyphless character's glyphs
23286 to the list of strings between HEAD and TAIL. The meanings of
23287 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23289 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23294 face_id = (row)->glyphs[area][START].face_id; \
23296 s = alloca (sizeof *s); \
23297 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23298 append_glyph_string (&HEAD, &TAIL, s); \
23300 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23306 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23307 of AREA of glyph row ROW on window W between indices START and END.
23308 HL overrides the face for drawing glyph strings, e.g. it is
23309 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23310 x-positions of the drawing area.
23312 This is an ugly monster macro construct because we must use alloca
23313 to allocate glyph strings (because draw_glyphs can be called
23314 asynchronously). */
23316 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23319 HEAD = TAIL = NULL; \
23320 while (START < END) \
23322 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23323 switch (first_glyph->type) \
23326 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23330 case COMPOSITE_GLYPH: \
23331 if (first_glyph->u.cmp.automatic) \
23332 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23335 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23339 case STRETCH_GLYPH: \
23340 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23344 case IMAGE_GLYPH: \
23345 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23349 case GLYPHLESS_GLYPH: \
23350 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23360 set_glyph_string_background_width (s, START, LAST_X); \
23367 /* Draw glyphs between START and END in AREA of ROW on window W,
23368 starting at x-position X. X is relative to AREA in W. HL is a
23369 face-override with the following meaning:
23371 DRAW_NORMAL_TEXT draw normally
23372 DRAW_CURSOR draw in cursor face
23373 DRAW_MOUSE_FACE draw in mouse face.
23374 DRAW_INVERSE_VIDEO draw in mode line face
23375 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23376 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23378 If OVERLAPS is non-zero, draw only the foreground of characters and
23379 clip to the physical height of ROW. Non-zero value also defines
23380 the overlapping part to be drawn:
23382 OVERLAPS_PRED overlap with preceding rows
23383 OVERLAPS_SUCC overlap with succeeding rows
23384 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23385 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23387 Value is the x-position reached, relative to AREA of W. */
23390 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23391 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23392 enum draw_glyphs_face hl
, int overlaps
)
23394 struct glyph_string
*head
, *tail
;
23395 struct glyph_string
*s
;
23396 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23397 int i
, j
, x_reached
, last_x
, area_left
= 0;
23398 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23401 ALLOCATE_HDC (hdc
, f
);
23403 /* Let's rather be paranoid than getting a SEGV. */
23404 end
= min (end
, row
->used
[area
]);
23405 start
= max (0, start
);
23406 start
= min (end
, start
);
23408 /* Translate X to frame coordinates. Set last_x to the right
23409 end of the drawing area. */
23410 if (row
->full_width_p
)
23412 /* X is relative to the left edge of W, without scroll bars
23414 area_left
= WINDOW_LEFT_EDGE_X (w
);
23415 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23419 area_left
= window_box_left (w
, area
);
23420 last_x
= area_left
+ window_box_width (w
, area
);
23424 /* Build a doubly-linked list of glyph_string structures between
23425 head and tail from what we have to draw. Note that the macro
23426 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23427 the reason we use a separate variable `i'. */
23429 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23431 x_reached
= tail
->x
+ tail
->background_width
;
23435 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23436 the row, redraw some glyphs in front or following the glyph
23437 strings built above. */
23438 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23440 struct glyph_string
*h
, *t
;
23441 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23442 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23443 int check_mouse_face
= 0;
23446 /* If mouse highlighting is on, we may need to draw adjacent
23447 glyphs using mouse-face highlighting. */
23448 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23450 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23452 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23453 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23455 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23457 check_mouse_face
= 1;
23458 mouse_beg_col
= (row
== mouse_beg_row
)
23459 ? hlinfo
->mouse_face_beg_col
: 0;
23460 mouse_end_col
= (row
== mouse_end_row
)
23461 ? hlinfo
->mouse_face_end_col
23462 : row
->used
[TEXT_AREA
];
23466 /* Compute overhangs for all glyph strings. */
23467 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23468 for (s
= head
; s
; s
= s
->next
)
23469 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23471 /* Prepend glyph strings for glyphs in front of the first glyph
23472 string that are overwritten because of the first glyph
23473 string's left overhang. The background of all strings
23474 prepended must be drawn because the first glyph string
23476 i
= left_overwritten (head
);
23479 enum draw_glyphs_face overlap_hl
;
23481 /* If this row contains mouse highlighting, attempt to draw
23482 the overlapped glyphs with the correct highlight. This
23483 code fails if the overlap encompasses more than one glyph
23484 and mouse-highlight spans only some of these glyphs.
23485 However, making it work perfectly involves a lot more
23486 code, and I don't know if the pathological case occurs in
23487 practice, so we'll stick to this for now. --- cyd */
23488 if (check_mouse_face
23489 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23490 overlap_hl
= DRAW_MOUSE_FACE
;
23492 overlap_hl
= DRAW_NORMAL_TEXT
;
23495 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23496 overlap_hl
, dummy_x
, last_x
);
23498 compute_overhangs_and_x (t
, head
->x
, 1);
23499 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23503 /* Prepend glyph strings for glyphs in front of the first glyph
23504 string that overwrite that glyph string because of their
23505 right overhang. For these strings, only the foreground must
23506 be drawn, because it draws over the glyph string at `head'.
23507 The background must not be drawn because this would overwrite
23508 right overhangs of preceding glyphs for which no glyph
23510 i
= left_overwriting (head
);
23513 enum draw_glyphs_face overlap_hl
;
23515 if (check_mouse_face
23516 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23517 overlap_hl
= DRAW_MOUSE_FACE
;
23519 overlap_hl
= DRAW_NORMAL_TEXT
;
23522 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23523 overlap_hl
, dummy_x
, last_x
);
23524 for (s
= h
; s
; s
= s
->next
)
23525 s
->background_filled_p
= 1;
23526 compute_overhangs_and_x (t
, head
->x
, 1);
23527 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23530 /* Append glyphs strings for glyphs following the last glyph
23531 string tail that are overwritten by tail. The background of
23532 these strings has to be drawn because tail's foreground draws
23534 i
= right_overwritten (tail
);
23537 enum draw_glyphs_face overlap_hl
;
23539 if (check_mouse_face
23540 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23541 overlap_hl
= DRAW_MOUSE_FACE
;
23543 overlap_hl
= DRAW_NORMAL_TEXT
;
23545 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23546 overlap_hl
, x
, last_x
);
23547 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23548 we don't have `end = i;' here. */
23549 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23550 append_glyph_string_lists (&head
, &tail
, h
, t
);
23554 /* Append glyph strings for glyphs following the last glyph
23555 string tail that overwrite tail. The foreground of such
23556 glyphs has to be drawn because it writes into the background
23557 of tail. The background must not be drawn because it could
23558 paint over the foreground of following glyphs. */
23559 i
= right_overwriting (tail
);
23562 enum draw_glyphs_face overlap_hl
;
23563 if (check_mouse_face
23564 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23565 overlap_hl
= DRAW_MOUSE_FACE
;
23567 overlap_hl
= DRAW_NORMAL_TEXT
;
23570 i
++; /* We must include the Ith glyph. */
23571 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23572 overlap_hl
, x
, last_x
);
23573 for (s
= h
; s
; s
= s
->next
)
23574 s
->background_filled_p
= 1;
23575 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23576 append_glyph_string_lists (&head
, &tail
, h
, t
);
23578 if (clip_head
|| clip_tail
)
23579 for (s
= head
; s
; s
= s
->next
)
23581 s
->clip_head
= clip_head
;
23582 s
->clip_tail
= clip_tail
;
23586 /* Draw all strings. */
23587 for (s
= head
; s
; s
= s
->next
)
23588 FRAME_RIF (f
)->draw_glyph_string (s
);
23591 /* When focus a sole frame and move horizontally, this sets on_p to 0
23592 causing a failure to erase prev cursor position. */
23593 if (area
== TEXT_AREA
23594 && !row
->full_width_p
23595 /* When drawing overlapping rows, only the glyph strings'
23596 foreground is drawn, which doesn't erase a cursor
23600 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23601 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23602 : (tail
? tail
->x
+ tail
->background_width
: x
));
23606 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23607 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23611 /* Value is the x-position up to which drawn, relative to AREA of W.
23612 This doesn't include parts drawn because of overhangs. */
23613 if (row
->full_width_p
)
23614 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23616 x_reached
-= area_left
;
23618 RELEASE_HDC (hdc
, f
);
23623 /* Expand row matrix if too narrow. Don't expand if area
23626 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23628 if (!fonts_changed_p \
23629 && (it->glyph_row->glyphs[area] \
23630 < it->glyph_row->glyphs[area + 1])) \
23632 it->w->ncols_scale_factor++; \
23633 fonts_changed_p = 1; \
23637 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23638 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23641 append_glyph (struct it
*it
)
23643 struct glyph
*glyph
;
23644 enum glyph_row_area area
= it
->area
;
23646 eassert (it
->glyph_row
);
23647 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23649 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23650 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23652 /* If the glyph row is reversed, we need to prepend the glyph
23653 rather than append it. */
23654 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23658 /* Make room for the additional glyph. */
23659 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23661 glyph
= it
->glyph_row
->glyphs
[area
];
23663 glyph
->charpos
= CHARPOS (it
->position
);
23664 glyph
->object
= it
->object
;
23665 if (it
->pixel_width
> 0)
23667 glyph
->pixel_width
= it
->pixel_width
;
23668 glyph
->padding_p
= 0;
23672 /* Assure at least 1-pixel width. Otherwise, cursor can't
23673 be displayed correctly. */
23674 glyph
->pixel_width
= 1;
23675 glyph
->padding_p
= 1;
23677 glyph
->ascent
= it
->ascent
;
23678 glyph
->descent
= it
->descent
;
23679 glyph
->voffset
= it
->voffset
;
23680 glyph
->type
= CHAR_GLYPH
;
23681 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23682 glyph
->multibyte_p
= it
->multibyte_p
;
23683 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23684 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23685 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23686 || it
->phys_descent
> it
->descent
);
23687 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23688 glyph
->face_id
= it
->face_id
;
23689 glyph
->u
.ch
= it
->char_to_display
;
23690 glyph
->slice
.img
= null_glyph_slice
;
23691 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23694 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23695 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23697 glyph
->bidi_type
= it
->bidi_it
.type
;
23701 glyph
->resolved_level
= 0;
23702 glyph
->bidi_type
= UNKNOWN_BT
;
23704 ++it
->glyph_row
->used
[area
];
23707 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23710 /* Store one glyph for the composition IT->cmp_it.id in
23711 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23715 append_composite_glyph (struct it
*it
)
23717 struct glyph
*glyph
;
23718 enum glyph_row_area area
= it
->area
;
23720 eassert (it
->glyph_row
);
23722 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23723 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23725 /* If the glyph row is reversed, we need to prepend the glyph
23726 rather than append it. */
23727 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23731 /* Make room for the new glyph. */
23732 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23734 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23736 glyph
->charpos
= it
->cmp_it
.charpos
;
23737 glyph
->object
= it
->object
;
23738 glyph
->pixel_width
= it
->pixel_width
;
23739 glyph
->ascent
= it
->ascent
;
23740 glyph
->descent
= it
->descent
;
23741 glyph
->voffset
= it
->voffset
;
23742 glyph
->type
= COMPOSITE_GLYPH
;
23743 if (it
->cmp_it
.ch
< 0)
23745 glyph
->u
.cmp
.automatic
= 0;
23746 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23747 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23751 glyph
->u
.cmp
.automatic
= 1;
23752 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23753 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23754 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23756 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23757 glyph
->multibyte_p
= it
->multibyte_p
;
23758 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23759 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23760 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23761 || it
->phys_descent
> it
->descent
);
23762 glyph
->padding_p
= 0;
23763 glyph
->glyph_not_available_p
= 0;
23764 glyph
->face_id
= it
->face_id
;
23765 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23768 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23769 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23771 glyph
->bidi_type
= it
->bidi_it
.type
;
23773 ++it
->glyph_row
->used
[area
];
23776 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23780 /* Change IT->ascent and IT->height according to the setting of
23784 take_vertical_position_into_account (struct it
*it
)
23788 if (it
->voffset
< 0)
23789 /* Increase the ascent so that we can display the text higher
23791 it
->ascent
-= it
->voffset
;
23793 /* Increase the descent so that we can display the text lower
23795 it
->descent
+= it
->voffset
;
23800 /* Produce glyphs/get display metrics for the image IT is loaded with.
23801 See the description of struct display_iterator in dispextern.h for
23802 an overview of struct display_iterator. */
23805 produce_image_glyph (struct it
*it
)
23809 int glyph_ascent
, crop
;
23810 struct glyph_slice slice
;
23812 eassert (it
->what
== IT_IMAGE
);
23814 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23816 /* Make sure X resources of the face is loaded. */
23817 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23819 if (it
->image_id
< 0)
23821 /* Fringe bitmap. */
23822 it
->ascent
= it
->phys_ascent
= 0;
23823 it
->descent
= it
->phys_descent
= 0;
23824 it
->pixel_width
= 0;
23829 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23831 /* Make sure X resources of the image is loaded. */
23832 prepare_image_for_display (it
->f
, img
);
23834 slice
.x
= slice
.y
= 0;
23835 slice
.width
= img
->width
;
23836 slice
.height
= img
->height
;
23838 if (INTEGERP (it
->slice
.x
))
23839 slice
.x
= XINT (it
->slice
.x
);
23840 else if (FLOATP (it
->slice
.x
))
23841 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23843 if (INTEGERP (it
->slice
.y
))
23844 slice
.y
= XINT (it
->slice
.y
);
23845 else if (FLOATP (it
->slice
.y
))
23846 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23848 if (INTEGERP (it
->slice
.width
))
23849 slice
.width
= XINT (it
->slice
.width
);
23850 else if (FLOATP (it
->slice
.width
))
23851 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23853 if (INTEGERP (it
->slice
.height
))
23854 slice
.height
= XINT (it
->slice
.height
);
23855 else if (FLOATP (it
->slice
.height
))
23856 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23858 if (slice
.x
>= img
->width
)
23859 slice
.x
= img
->width
;
23860 if (slice
.y
>= img
->height
)
23861 slice
.y
= img
->height
;
23862 if (slice
.x
+ slice
.width
>= img
->width
)
23863 slice
.width
= img
->width
- slice
.x
;
23864 if (slice
.y
+ slice
.height
> img
->height
)
23865 slice
.height
= img
->height
- slice
.y
;
23867 if (slice
.width
== 0 || slice
.height
== 0)
23870 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23872 it
->descent
= slice
.height
- glyph_ascent
;
23874 it
->descent
+= img
->vmargin
;
23875 if (slice
.y
+ slice
.height
== img
->height
)
23876 it
->descent
+= img
->vmargin
;
23877 it
->phys_descent
= it
->descent
;
23879 it
->pixel_width
= slice
.width
;
23881 it
->pixel_width
+= img
->hmargin
;
23882 if (slice
.x
+ slice
.width
== img
->width
)
23883 it
->pixel_width
+= img
->hmargin
;
23885 /* It's quite possible for images to have an ascent greater than
23886 their height, so don't get confused in that case. */
23887 if (it
->descent
< 0)
23892 if (face
->box
!= FACE_NO_BOX
)
23894 if (face
->box_line_width
> 0)
23897 it
->ascent
+= face
->box_line_width
;
23898 if (slice
.y
+ slice
.height
== img
->height
)
23899 it
->descent
+= face
->box_line_width
;
23902 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23903 it
->pixel_width
+= eabs (face
->box_line_width
);
23904 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23905 it
->pixel_width
+= eabs (face
->box_line_width
);
23908 take_vertical_position_into_account (it
);
23910 /* Automatically crop wide image glyphs at right edge so we can
23911 draw the cursor on same display row. */
23912 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23913 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23915 it
->pixel_width
-= crop
;
23916 slice
.width
-= crop
;
23921 struct glyph
*glyph
;
23922 enum glyph_row_area area
= it
->area
;
23924 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23925 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23927 glyph
->charpos
= CHARPOS (it
->position
);
23928 glyph
->object
= it
->object
;
23929 glyph
->pixel_width
= it
->pixel_width
;
23930 glyph
->ascent
= glyph_ascent
;
23931 glyph
->descent
= it
->descent
;
23932 glyph
->voffset
= it
->voffset
;
23933 glyph
->type
= IMAGE_GLYPH
;
23934 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23935 glyph
->multibyte_p
= it
->multibyte_p
;
23936 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23937 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23938 glyph
->overlaps_vertically_p
= 0;
23939 glyph
->padding_p
= 0;
23940 glyph
->glyph_not_available_p
= 0;
23941 glyph
->face_id
= it
->face_id
;
23942 glyph
->u
.img_id
= img
->id
;
23943 glyph
->slice
.img
= slice
;
23944 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23947 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23948 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23950 glyph
->bidi_type
= it
->bidi_it
.type
;
23952 ++it
->glyph_row
->used
[area
];
23955 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23960 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23961 of the glyph, WIDTH and HEIGHT are the width and height of the
23962 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23965 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23966 int width
, int height
, int ascent
)
23968 struct glyph
*glyph
;
23969 enum glyph_row_area area
= it
->area
;
23971 eassert (ascent
>= 0 && ascent
<= height
);
23973 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23974 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23976 /* If the glyph row is reversed, we need to prepend the glyph
23977 rather than append it. */
23978 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23982 /* Make room for the additional glyph. */
23983 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23985 glyph
= it
->glyph_row
->glyphs
[area
];
23987 glyph
->charpos
= CHARPOS (it
->position
);
23988 glyph
->object
= object
;
23989 glyph
->pixel_width
= width
;
23990 glyph
->ascent
= ascent
;
23991 glyph
->descent
= height
- ascent
;
23992 glyph
->voffset
= it
->voffset
;
23993 glyph
->type
= STRETCH_GLYPH
;
23994 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23995 glyph
->multibyte_p
= it
->multibyte_p
;
23996 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23997 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23998 glyph
->overlaps_vertically_p
= 0;
23999 glyph
->padding_p
= 0;
24000 glyph
->glyph_not_available_p
= 0;
24001 glyph
->face_id
= it
->face_id
;
24002 glyph
->u
.stretch
.ascent
= ascent
;
24003 glyph
->u
.stretch
.height
= height
;
24004 glyph
->slice
.img
= null_glyph_slice
;
24005 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24008 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24009 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24011 glyph
->bidi_type
= it
->bidi_it
.type
;
24015 glyph
->resolved_level
= 0;
24016 glyph
->bidi_type
= UNKNOWN_BT
;
24018 ++it
->glyph_row
->used
[area
];
24021 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24024 #endif /* HAVE_WINDOW_SYSTEM */
24026 /* Produce a stretch glyph for iterator IT. IT->object is the value
24027 of the glyph property displayed. The value must be a list
24028 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24031 1. `:width WIDTH' specifies that the space should be WIDTH *
24032 canonical char width wide. WIDTH may be an integer or floating
24035 2. `:relative-width FACTOR' specifies that the width of the stretch
24036 should be computed from the width of the first character having the
24037 `glyph' property, and should be FACTOR times that width.
24039 3. `:align-to HPOS' specifies that the space should be wide enough
24040 to reach HPOS, a value in canonical character units.
24042 Exactly one of the above pairs must be present.
24044 4. `:height HEIGHT' specifies that the height of the stretch produced
24045 should be HEIGHT, measured in canonical character units.
24047 5. `:relative-height FACTOR' specifies that the height of the
24048 stretch should be FACTOR times the height of the characters having
24049 the glyph property.
24051 Either none or exactly one of 4 or 5 must be present.
24053 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24054 of the stretch should be used for the ascent of the stretch.
24055 ASCENT must be in the range 0 <= ASCENT <= 100. */
24058 produce_stretch_glyph (struct it
*it
)
24060 /* (space :width WIDTH :height HEIGHT ...) */
24061 Lisp_Object prop
, plist
;
24062 int width
= 0, height
= 0, align_to
= -1;
24063 int zero_width_ok_p
= 0;
24066 struct face
*face
= NULL
;
24067 struct font
*font
= NULL
;
24069 #ifdef HAVE_WINDOW_SYSTEM
24070 int zero_height_ok_p
= 0;
24072 if (FRAME_WINDOW_P (it
->f
))
24074 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24075 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24076 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24080 /* List should start with `space'. */
24081 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24082 plist
= XCDR (it
->object
);
24084 /* Compute the width of the stretch. */
24085 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24086 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24088 /* Absolute width `:width WIDTH' specified and valid. */
24089 zero_width_ok_p
= 1;
24092 #ifdef HAVE_WINDOW_SYSTEM
24093 else if (FRAME_WINDOW_P (it
->f
)
24094 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24096 /* Relative width `:relative-width FACTOR' specified and valid.
24097 Compute the width of the characters having the `glyph'
24100 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24103 if (it
->multibyte_p
)
24104 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24107 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24108 if (! ASCII_CHAR_P (it2
.c
))
24109 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24112 it2
.glyph_row
= NULL
;
24113 it2
.what
= IT_CHARACTER
;
24114 x_produce_glyphs (&it2
);
24115 width
= NUMVAL (prop
) * it2
.pixel_width
;
24117 #endif /* HAVE_WINDOW_SYSTEM */
24118 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24119 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24121 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24122 align_to
= (align_to
< 0
24124 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24125 else if (align_to
< 0)
24126 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24127 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24128 zero_width_ok_p
= 1;
24131 /* Nothing specified -> width defaults to canonical char width. */
24132 width
= FRAME_COLUMN_WIDTH (it
->f
);
24134 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24137 #ifdef HAVE_WINDOW_SYSTEM
24138 /* Compute height. */
24139 if (FRAME_WINDOW_P (it
->f
))
24141 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24142 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24145 zero_height_ok_p
= 1;
24147 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24149 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24151 height
= FONT_HEIGHT (font
);
24153 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24156 /* Compute percentage of height used for ascent. If
24157 `:ascent ASCENT' is present and valid, use that. Otherwise,
24158 derive the ascent from the font in use. */
24159 if (prop
= Fplist_get (plist
, QCascent
),
24160 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24161 ascent
= height
* NUMVAL (prop
) / 100.0;
24162 else if (!NILP (prop
)
24163 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24164 ascent
= min (max (0, (int)tem
), height
);
24166 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24169 #endif /* HAVE_WINDOW_SYSTEM */
24172 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24173 && it
->current_x
+ width
> it
->last_visible_x
)
24175 width
= it
->last_visible_x
- it
->current_x
;
24176 #ifdef HAVE_WINDOW_SYSTEM
24177 /* Subtract one more pixel from the stretch width, but only on
24178 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24179 width
-= FRAME_WINDOW_P (it
->f
);
24183 if (width
> 0 && height
> 0 && it
->glyph_row
)
24185 Lisp_Object o_object
= it
->object
;
24186 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24189 if (!STRINGP (object
))
24190 object
= it
->w
->buffer
;
24191 #ifdef HAVE_WINDOW_SYSTEM
24192 if (FRAME_WINDOW_P (it
->f
))
24193 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24197 it
->object
= object
;
24198 it
->char_to_display
= ' ';
24199 it
->pixel_width
= it
->len
= 1;
24201 tty_append_glyph (it
);
24202 it
->object
= o_object
;
24206 it
->pixel_width
= width
;
24207 #ifdef HAVE_WINDOW_SYSTEM
24208 if (FRAME_WINDOW_P (it
->f
))
24210 it
->ascent
= it
->phys_ascent
= ascent
;
24211 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24212 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24213 take_vertical_position_into_account (it
);
24217 it
->nglyphs
= width
;
24220 /* Get information about special display element WHAT in an
24221 environment described by IT. WHAT is one of IT_TRUNCATION or
24222 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24223 non-null glyph_row member. This function ensures that fields like
24224 face_id, c, len of IT are left untouched. */
24227 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24234 temp_it
.object
= make_number (0);
24235 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24237 if (what
== IT_CONTINUATION
)
24239 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24240 if (it
->bidi_it
.paragraph_dir
== R2L
)
24241 SET_GLYPH_FROM_CHAR (glyph
, '/');
24243 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24245 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24247 /* FIXME: Should we mirror GC for R2L lines? */
24248 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24249 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24252 else if (what
== IT_TRUNCATION
)
24254 /* Truncation glyph. */
24255 SET_GLYPH_FROM_CHAR (glyph
, '$');
24257 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24259 /* FIXME: Should we mirror GC for R2L lines? */
24260 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24261 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24267 #ifdef HAVE_WINDOW_SYSTEM
24268 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24269 is turned off, we precede the truncation/continuation glyphs by a
24270 stretch glyph whose width is computed such that these special
24271 glyphs are aligned at the window margin, even when very different
24272 fonts are used in different glyph rows. */
24273 if (FRAME_WINDOW_P (temp_it
.f
)
24274 /* init_iterator calls this with it->glyph_row == NULL, and it
24275 wants only the pixel width of the truncation/continuation
24277 && temp_it
.glyph_row
24278 /* insert_left_trunc_glyphs calls us at the beginning of the
24279 row, and it has its own calculation of the stretch glyph
24281 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24282 && (temp_it
.glyph_row
->reversed_p
24283 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24284 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24286 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24288 if (stretch_width
> 0)
24290 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24291 struct font
*font
=
24292 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24293 int stretch_ascent
=
24294 (((temp_it
.ascent
+ temp_it
.descent
)
24295 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24297 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24298 temp_it
.ascent
+ temp_it
.descent
,
24305 temp_it
.what
= IT_CHARACTER
;
24307 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24308 temp_it
.face_id
= GLYPH_FACE (glyph
);
24309 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24311 PRODUCE_GLYPHS (&temp_it
);
24312 it
->pixel_width
= temp_it
.pixel_width
;
24313 it
->nglyphs
= temp_it
.pixel_width
;
24316 #ifdef HAVE_WINDOW_SYSTEM
24318 /* Calculate line-height and line-spacing properties.
24319 An integer value specifies explicit pixel value.
24320 A float value specifies relative value to current face height.
24321 A cons (float . face-name) specifies relative value to
24322 height of specified face font.
24324 Returns height in pixels, or nil. */
24328 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24329 int boff
, int override
)
24331 Lisp_Object face_name
= Qnil
;
24332 int ascent
, descent
, height
;
24334 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24339 face_name
= XCAR (val
);
24341 if (!NUMBERP (val
))
24342 val
= make_number (1);
24343 if (NILP (face_name
))
24345 height
= it
->ascent
+ it
->descent
;
24350 if (NILP (face_name
))
24352 font
= FRAME_FONT (it
->f
);
24353 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24355 else if (EQ (face_name
, Qt
))
24364 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24366 return make_number (-1);
24368 face
= FACE_FROM_ID (it
->f
, face_id
);
24371 return make_number (-1);
24372 boff
= font
->baseline_offset
;
24373 if (font
->vertical_centering
)
24374 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24377 ascent
= FONT_BASE (font
) + boff
;
24378 descent
= FONT_DESCENT (font
) - boff
;
24382 it
->override_ascent
= ascent
;
24383 it
->override_descent
= descent
;
24384 it
->override_boff
= boff
;
24387 height
= ascent
+ descent
;
24391 height
= (int)(XFLOAT_DATA (val
) * height
);
24392 else if (INTEGERP (val
))
24393 height
*= XINT (val
);
24395 return make_number (height
);
24399 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24400 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24401 and only if this is for a character for which no font was found.
24403 If the display method (it->glyphless_method) is
24404 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24405 length of the acronym or the hexadecimal string, UPPER_XOFF and
24406 UPPER_YOFF are pixel offsets for the upper part of the string,
24407 LOWER_XOFF and LOWER_YOFF are for the lower part.
24409 For the other display methods, LEN through LOWER_YOFF are zero. */
24412 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24413 short upper_xoff
, short upper_yoff
,
24414 short lower_xoff
, short lower_yoff
)
24416 struct glyph
*glyph
;
24417 enum glyph_row_area area
= it
->area
;
24419 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24420 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24422 /* If the glyph row is reversed, we need to prepend the glyph
24423 rather than append it. */
24424 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24428 /* Make room for the additional glyph. */
24429 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24431 glyph
= it
->glyph_row
->glyphs
[area
];
24433 glyph
->charpos
= CHARPOS (it
->position
);
24434 glyph
->object
= it
->object
;
24435 glyph
->pixel_width
= it
->pixel_width
;
24436 glyph
->ascent
= it
->ascent
;
24437 glyph
->descent
= it
->descent
;
24438 glyph
->voffset
= it
->voffset
;
24439 glyph
->type
= GLYPHLESS_GLYPH
;
24440 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24441 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24442 glyph
->u
.glyphless
.len
= len
;
24443 glyph
->u
.glyphless
.ch
= it
->c
;
24444 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24445 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24446 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24447 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24448 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24449 glyph
->multibyte_p
= it
->multibyte_p
;
24450 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24451 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24452 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24453 || it
->phys_descent
> it
->descent
);
24454 glyph
->padding_p
= 0;
24455 glyph
->glyph_not_available_p
= 0;
24456 glyph
->face_id
= face_id
;
24457 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24460 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24461 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24463 glyph
->bidi_type
= it
->bidi_it
.type
;
24465 ++it
->glyph_row
->used
[area
];
24468 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24472 /* Produce a glyph for a glyphless character for iterator IT.
24473 IT->glyphless_method specifies which method to use for displaying
24474 the character. See the description of enum
24475 glyphless_display_method in dispextern.h for the detail.
24477 FOR_NO_FONT is nonzero if and only if this is for a character for
24478 which no font was found. ACRONYM, if non-nil, is an acronym string
24479 for the character. */
24482 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24487 int base_width
, base_height
, width
, height
;
24488 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24491 /* Get the metrics of the base font. We always refer to the current
24493 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24494 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24495 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24496 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24497 base_height
= it
->ascent
+ it
->descent
;
24498 base_width
= font
->average_width
;
24500 /* Get a face ID for the glyph by utilizing a cache (the same way as
24501 done for `escape-glyph' in get_next_display_element). */
24502 if (it
->f
== last_glyphless_glyph_frame
24503 && it
->face_id
== last_glyphless_glyph_face_id
)
24505 face_id
= last_glyphless_glyph_merged_face_id
;
24509 /* Merge the `glyphless-char' face into the current face. */
24510 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24511 last_glyphless_glyph_frame
= it
->f
;
24512 last_glyphless_glyph_face_id
= it
->face_id
;
24513 last_glyphless_glyph_merged_face_id
= face_id
;
24516 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24518 it
->pixel_width
= THIN_SPACE_WIDTH
;
24520 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24522 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24524 width
= CHAR_WIDTH (it
->c
);
24527 else if (width
> 4)
24529 it
->pixel_width
= base_width
* width
;
24531 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24537 unsigned int code
[6];
24539 int ascent
, descent
;
24540 struct font_metrics metrics_upper
, metrics_lower
;
24542 face
= FACE_FROM_ID (it
->f
, face_id
);
24543 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24544 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24546 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24548 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24549 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24550 if (CONSP (acronym
))
24551 acronym
= XCAR (acronym
);
24552 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24556 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24557 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24560 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24561 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24562 upper_len
= (len
+ 1) / 2;
24563 font
->driver
->text_extents (font
, code
, upper_len
,
24565 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24570 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24571 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24572 upper_xoff
= upper_yoff
= 2; /* the typical case */
24573 if (base_width
>= width
)
24575 /* Align the upper to the left, the lower to the right. */
24576 it
->pixel_width
= base_width
;
24577 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24581 /* Center the shorter one. */
24582 it
->pixel_width
= width
;
24583 if (metrics_upper
.width
>= metrics_lower
.width
)
24584 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24587 /* FIXME: This code doesn't look right. It formerly was
24588 missing the "lower_xoff = 0;", which couldn't have
24589 been right since it left lower_xoff uninitialized. */
24591 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24595 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24596 top, bottom, and between upper and lower strings. */
24597 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24598 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24599 /* Center vertically.
24600 H:base_height, D:base_descent
24601 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24603 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24604 descent = D - H/2 + h/2;
24605 lower_yoff = descent - 2 - ld;
24606 upper_yoff = lower_yoff - la - 1 - ud; */
24607 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24608 descent
= it
->descent
- (base_height
- height
) / 2;
24609 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24610 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24611 - metrics_upper
.descent
);
24612 /* Don't make the height shorter than the base height. */
24613 if (height
> base_height
)
24615 it
->ascent
= ascent
;
24616 it
->descent
= descent
;
24620 it
->phys_ascent
= it
->ascent
;
24621 it
->phys_descent
= it
->descent
;
24623 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24624 upper_xoff
, upper_yoff
,
24625 lower_xoff
, lower_yoff
);
24627 take_vertical_position_into_account (it
);
24632 Produce glyphs/get display metrics for the display element IT is
24633 loaded with. See the description of struct it in dispextern.h
24634 for an overview of struct it. */
24637 x_produce_glyphs (struct it
*it
)
24639 int extra_line_spacing
= it
->extra_line_spacing
;
24641 it
->glyph_not_available_p
= 0;
24643 if (it
->what
== IT_CHARACTER
)
24646 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24647 struct font
*font
= face
->font
;
24648 struct font_metrics
*pcm
= NULL
;
24649 int boff
; /* baseline offset */
24653 /* When no suitable font is found, display this character by
24654 the method specified in the first extra slot of
24655 Vglyphless_char_display. */
24656 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24658 eassert (it
->what
== IT_GLYPHLESS
);
24659 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24663 boff
= font
->baseline_offset
;
24664 if (font
->vertical_centering
)
24665 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24667 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24673 if (it
->override_ascent
>= 0)
24675 it
->ascent
= it
->override_ascent
;
24676 it
->descent
= it
->override_descent
;
24677 boff
= it
->override_boff
;
24681 it
->ascent
= FONT_BASE (font
) + boff
;
24682 it
->descent
= FONT_DESCENT (font
) - boff
;
24685 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24687 pcm
= get_per_char_metric (font
, &char2b
);
24688 if (pcm
->width
== 0
24689 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24695 it
->phys_ascent
= pcm
->ascent
+ boff
;
24696 it
->phys_descent
= pcm
->descent
- boff
;
24697 it
->pixel_width
= pcm
->width
;
24701 it
->glyph_not_available_p
= 1;
24702 it
->phys_ascent
= it
->ascent
;
24703 it
->phys_descent
= it
->descent
;
24704 it
->pixel_width
= font
->space_width
;
24707 if (it
->constrain_row_ascent_descent_p
)
24709 if (it
->descent
> it
->max_descent
)
24711 it
->ascent
+= it
->descent
- it
->max_descent
;
24712 it
->descent
= it
->max_descent
;
24714 if (it
->ascent
> it
->max_ascent
)
24716 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24717 it
->ascent
= it
->max_ascent
;
24719 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24720 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24721 extra_line_spacing
= 0;
24724 /* If this is a space inside a region of text with
24725 `space-width' property, change its width. */
24726 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24728 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24730 /* If face has a box, add the box thickness to the character
24731 height. If character has a box line to the left and/or
24732 right, add the box line width to the character's width. */
24733 if (face
->box
!= FACE_NO_BOX
)
24735 int thick
= face
->box_line_width
;
24739 it
->ascent
+= thick
;
24740 it
->descent
+= thick
;
24745 if (it
->start_of_box_run_p
)
24746 it
->pixel_width
+= thick
;
24747 if (it
->end_of_box_run_p
)
24748 it
->pixel_width
+= thick
;
24751 /* If face has an overline, add the height of the overline
24752 (1 pixel) and a 1 pixel margin to the character height. */
24753 if (face
->overline_p
)
24754 it
->ascent
+= overline_margin
;
24756 if (it
->constrain_row_ascent_descent_p
)
24758 if (it
->ascent
> it
->max_ascent
)
24759 it
->ascent
= it
->max_ascent
;
24760 if (it
->descent
> it
->max_descent
)
24761 it
->descent
= it
->max_descent
;
24764 take_vertical_position_into_account (it
);
24766 /* If we have to actually produce glyphs, do it. */
24771 /* Translate a space with a `space-width' property
24772 into a stretch glyph. */
24773 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24774 / FONT_HEIGHT (font
));
24775 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24776 it
->ascent
+ it
->descent
, ascent
);
24781 /* If characters with lbearing or rbearing are displayed
24782 in this line, record that fact in a flag of the
24783 glyph row. This is used to optimize X output code. */
24784 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24785 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24787 if (! stretched_p
&& it
->pixel_width
== 0)
24788 /* We assure that all visible glyphs have at least 1-pixel
24790 it
->pixel_width
= 1;
24792 else if (it
->char_to_display
== '\n')
24794 /* A newline has no width, but we need the height of the
24795 line. But if previous part of the line sets a height,
24796 don't increase that height */
24798 Lisp_Object height
;
24799 Lisp_Object total_height
= Qnil
;
24801 it
->override_ascent
= -1;
24802 it
->pixel_width
= 0;
24805 height
= get_it_property (it
, Qline_height
);
24806 /* Split (line-height total-height) list */
24808 && CONSP (XCDR (height
))
24809 && NILP (XCDR (XCDR (height
))))
24811 total_height
= XCAR (XCDR (height
));
24812 height
= XCAR (height
);
24814 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24816 if (it
->override_ascent
>= 0)
24818 it
->ascent
= it
->override_ascent
;
24819 it
->descent
= it
->override_descent
;
24820 boff
= it
->override_boff
;
24824 it
->ascent
= FONT_BASE (font
) + boff
;
24825 it
->descent
= FONT_DESCENT (font
) - boff
;
24828 if (EQ (height
, Qt
))
24830 if (it
->descent
> it
->max_descent
)
24832 it
->ascent
+= it
->descent
- it
->max_descent
;
24833 it
->descent
= it
->max_descent
;
24835 if (it
->ascent
> it
->max_ascent
)
24837 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24838 it
->ascent
= it
->max_ascent
;
24840 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24841 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24842 it
->constrain_row_ascent_descent_p
= 1;
24843 extra_line_spacing
= 0;
24847 Lisp_Object spacing
;
24849 it
->phys_ascent
= it
->ascent
;
24850 it
->phys_descent
= it
->descent
;
24852 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24853 && face
->box
!= FACE_NO_BOX
24854 && face
->box_line_width
> 0)
24856 it
->ascent
+= face
->box_line_width
;
24857 it
->descent
+= face
->box_line_width
;
24860 && XINT (height
) > it
->ascent
+ it
->descent
)
24861 it
->ascent
= XINT (height
) - it
->descent
;
24863 if (!NILP (total_height
))
24864 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24867 spacing
= get_it_property (it
, Qline_spacing
);
24868 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24870 if (INTEGERP (spacing
))
24872 extra_line_spacing
= XINT (spacing
);
24873 if (!NILP (total_height
))
24874 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24878 else /* i.e. (it->char_to_display == '\t') */
24880 if (font
->space_width
> 0)
24882 int tab_width
= it
->tab_width
* font
->space_width
;
24883 int x
= it
->current_x
+ it
->continuation_lines_width
;
24884 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24886 /* If the distance from the current position to the next tab
24887 stop is less than a space character width, use the
24888 tab stop after that. */
24889 if (next_tab_x
- x
< font
->space_width
)
24890 next_tab_x
+= tab_width
;
24892 it
->pixel_width
= next_tab_x
- x
;
24894 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24895 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24899 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24900 it
->ascent
+ it
->descent
, it
->ascent
);
24905 it
->pixel_width
= 0;
24910 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24912 /* A static composition.
24914 Note: A composition is represented as one glyph in the
24915 glyph matrix. There are no padding glyphs.
24917 Important note: pixel_width, ascent, and descent are the
24918 values of what is drawn by draw_glyphs (i.e. the values of
24919 the overall glyphs composed). */
24920 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24921 int boff
; /* baseline offset */
24922 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24923 int glyph_len
= cmp
->glyph_len
;
24924 struct font
*font
= face
->font
;
24928 /* If we have not yet calculated pixel size data of glyphs of
24929 the composition for the current face font, calculate them
24930 now. Theoretically, we have to check all fonts for the
24931 glyphs, but that requires much time and memory space. So,
24932 here we check only the font of the first glyph. This may
24933 lead to incorrect display, but it's very rare, and C-l
24934 (recenter-top-bottom) can correct the display anyway. */
24935 if (! cmp
->font
|| cmp
->font
!= font
)
24937 /* Ascent and descent of the font of the first character
24938 of this composition (adjusted by baseline offset).
24939 Ascent and descent of overall glyphs should not be less
24940 than these, respectively. */
24941 int font_ascent
, font_descent
, font_height
;
24942 /* Bounding box of the overall glyphs. */
24943 int leftmost
, rightmost
, lowest
, highest
;
24944 int lbearing
, rbearing
;
24945 int i
, width
, ascent
, descent
;
24946 int left_padded
= 0, right_padded
= 0;
24947 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24949 struct font_metrics
*pcm
;
24950 int font_not_found_p
;
24953 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24954 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24956 if (glyph_len
< cmp
->glyph_len
)
24958 for (i
= 0; i
< glyph_len
; i
++)
24960 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24962 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24967 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24968 : IT_CHARPOS (*it
));
24969 /* If no suitable font is found, use the default font. */
24970 font_not_found_p
= font
== NULL
;
24971 if (font_not_found_p
)
24973 face
= face
->ascii_face
;
24976 boff
= font
->baseline_offset
;
24977 if (font
->vertical_centering
)
24978 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24979 font_ascent
= FONT_BASE (font
) + boff
;
24980 font_descent
= FONT_DESCENT (font
) - boff
;
24981 font_height
= FONT_HEIGHT (font
);
24986 if (! font_not_found_p
)
24988 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24990 pcm
= get_per_char_metric (font
, &char2b
);
24993 /* Initialize the bounding box. */
24996 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24997 ascent
= pcm
->ascent
;
24998 descent
= pcm
->descent
;
24999 lbearing
= pcm
->lbearing
;
25000 rbearing
= pcm
->rbearing
;
25004 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25005 ascent
= FONT_BASE (font
);
25006 descent
= FONT_DESCENT (font
);
25013 lowest
= - descent
+ boff
;
25014 highest
= ascent
+ boff
;
25016 if (! font_not_found_p
25017 && font
->default_ascent
25018 && CHAR_TABLE_P (Vuse_default_ascent
)
25019 && !NILP (Faref (Vuse_default_ascent
,
25020 make_number (it
->char_to_display
))))
25021 highest
= font
->default_ascent
+ boff
;
25023 /* Draw the first glyph at the normal position. It may be
25024 shifted to right later if some other glyphs are drawn
25026 cmp
->offsets
[i
* 2] = 0;
25027 cmp
->offsets
[i
* 2 + 1] = boff
;
25028 cmp
->lbearing
= lbearing
;
25029 cmp
->rbearing
= rbearing
;
25031 /* Set cmp->offsets for the remaining glyphs. */
25032 for (i
++; i
< glyph_len
; i
++)
25034 int left
, right
, btm
, top
;
25035 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25037 struct face
*this_face
;
25041 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25042 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25043 font
= this_face
->font
;
25049 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25051 pcm
= get_per_char_metric (font
, &char2b
);
25054 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25057 width
= pcm
->width
;
25058 ascent
= pcm
->ascent
;
25059 descent
= pcm
->descent
;
25060 lbearing
= pcm
->lbearing
;
25061 rbearing
= pcm
->rbearing
;
25062 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25064 /* Relative composition with or without
25065 alternate chars. */
25066 left
= (leftmost
+ rightmost
- width
) / 2;
25067 btm
= - descent
+ boff
;
25068 if (font
->relative_compose
25069 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25070 || NILP (Faref (Vignore_relative_composition
,
25071 make_number (ch
)))))
25074 if (- descent
>= font
->relative_compose
)
25075 /* One extra pixel between two glyphs. */
25077 else if (ascent
<= 0)
25078 /* One extra pixel between two glyphs. */
25079 btm
= lowest
- 1 - ascent
- descent
;
25084 /* A composition rule is specified by an integer
25085 value that encodes global and new reference
25086 points (GREF and NREF). GREF and NREF are
25087 specified by numbers as below:
25089 0---1---2 -- ascent
25093 9--10--11 -- center
25095 ---3---4---5--- baseline
25097 6---7---8 -- descent
25099 int rule
= COMPOSITION_RULE (cmp
, i
);
25100 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25102 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25103 grefx
= gref
% 3, nrefx
= nref
% 3;
25104 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25106 xoff
= font_height
* (xoff
- 128) / 256;
25108 yoff
= font_height
* (yoff
- 128) / 256;
25111 + grefx
* (rightmost
- leftmost
) / 2
25112 - nrefx
* width
/ 2
25115 btm
= ((grefy
== 0 ? highest
25117 : grefy
== 2 ? lowest
25118 : (highest
+ lowest
) / 2)
25119 - (nrefy
== 0 ? ascent
+ descent
25120 : nrefy
== 1 ? descent
- boff
25122 : (ascent
+ descent
) / 2)
25126 cmp
->offsets
[i
* 2] = left
;
25127 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25129 /* Update the bounding box of the overall glyphs. */
25132 right
= left
+ width
;
25133 if (left
< leftmost
)
25135 if (right
> rightmost
)
25138 top
= btm
+ descent
+ ascent
;
25144 if (cmp
->lbearing
> left
+ lbearing
)
25145 cmp
->lbearing
= left
+ lbearing
;
25146 if (cmp
->rbearing
< left
+ rbearing
)
25147 cmp
->rbearing
= left
+ rbearing
;
25151 /* If there are glyphs whose x-offsets are negative,
25152 shift all glyphs to the right and make all x-offsets
25156 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25157 cmp
->offsets
[i
* 2] -= leftmost
;
25158 rightmost
-= leftmost
;
25159 cmp
->lbearing
-= leftmost
;
25160 cmp
->rbearing
-= leftmost
;
25163 if (left_padded
&& cmp
->lbearing
< 0)
25165 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25166 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25167 rightmost
-= cmp
->lbearing
;
25168 cmp
->rbearing
-= cmp
->lbearing
;
25171 if (right_padded
&& rightmost
< cmp
->rbearing
)
25173 rightmost
= cmp
->rbearing
;
25176 cmp
->pixel_width
= rightmost
;
25177 cmp
->ascent
= highest
;
25178 cmp
->descent
= - lowest
;
25179 if (cmp
->ascent
< font_ascent
)
25180 cmp
->ascent
= font_ascent
;
25181 if (cmp
->descent
< font_descent
)
25182 cmp
->descent
= font_descent
;
25186 && (cmp
->lbearing
< 0
25187 || cmp
->rbearing
> cmp
->pixel_width
))
25188 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25190 it
->pixel_width
= cmp
->pixel_width
;
25191 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25192 it
->descent
= it
->phys_descent
= cmp
->descent
;
25193 if (face
->box
!= FACE_NO_BOX
)
25195 int thick
= face
->box_line_width
;
25199 it
->ascent
+= thick
;
25200 it
->descent
+= thick
;
25205 if (it
->start_of_box_run_p
)
25206 it
->pixel_width
+= thick
;
25207 if (it
->end_of_box_run_p
)
25208 it
->pixel_width
+= thick
;
25211 /* If face has an overline, add the height of the overline
25212 (1 pixel) and a 1 pixel margin to the character height. */
25213 if (face
->overline_p
)
25214 it
->ascent
+= overline_margin
;
25216 take_vertical_position_into_account (it
);
25217 if (it
->ascent
< 0)
25219 if (it
->descent
< 0)
25222 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25223 append_composite_glyph (it
);
25225 else if (it
->what
== IT_COMPOSITION
)
25227 /* A dynamic (automatic) composition. */
25228 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25229 Lisp_Object gstring
;
25230 struct font_metrics metrics
;
25234 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25236 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25239 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25240 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25241 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25242 it
->descent
= it
->phys_descent
= metrics
.descent
;
25243 if (face
->box
!= FACE_NO_BOX
)
25245 int thick
= face
->box_line_width
;
25249 it
->ascent
+= thick
;
25250 it
->descent
+= thick
;
25255 if (it
->start_of_box_run_p
)
25256 it
->pixel_width
+= thick
;
25257 if (it
->end_of_box_run_p
)
25258 it
->pixel_width
+= thick
;
25260 /* If face has an overline, add the height of the overline
25261 (1 pixel) and a 1 pixel margin to the character height. */
25262 if (face
->overline_p
)
25263 it
->ascent
+= overline_margin
;
25264 take_vertical_position_into_account (it
);
25265 if (it
->ascent
< 0)
25267 if (it
->descent
< 0)
25271 append_composite_glyph (it
);
25273 else if (it
->what
== IT_GLYPHLESS
)
25274 produce_glyphless_glyph (it
, 0, Qnil
);
25275 else if (it
->what
== IT_IMAGE
)
25276 produce_image_glyph (it
);
25277 else if (it
->what
== IT_STRETCH
)
25278 produce_stretch_glyph (it
);
25281 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25282 because this isn't true for images with `:ascent 100'. */
25283 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25284 if (it
->area
== TEXT_AREA
)
25285 it
->current_x
+= it
->pixel_width
;
25287 if (extra_line_spacing
> 0)
25289 it
->descent
+= extra_line_spacing
;
25290 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25291 it
->max_extra_line_spacing
= extra_line_spacing
;
25294 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25295 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25296 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25297 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25301 Output LEN glyphs starting at START at the nominal cursor position.
25302 Advance the nominal cursor over the text. The global variable
25303 updated_window contains the window being updated, updated_row is
25304 the glyph row being updated, and updated_area is the area of that
25305 row being updated. */
25308 x_write_glyphs (struct glyph
*start
, int len
)
25310 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25312 eassert (updated_window
&& updated_row
);
25313 /* When the window is hscrolled, cursor hpos can legitimately be out
25314 of bounds, but we draw the cursor at the corresponding window
25315 margin in that case. */
25316 if (!updated_row
->reversed_p
&& chpos
< 0)
25318 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25319 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25323 /* Write glyphs. */
25325 hpos
= start
- updated_row
->glyphs
[updated_area
];
25326 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25327 updated_row
, updated_area
,
25329 DRAW_NORMAL_TEXT
, 0);
25331 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25332 if (updated_area
== TEXT_AREA
25333 && updated_window
->phys_cursor_on_p
25334 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25336 && chpos
< hpos
+ len
)
25337 updated_window
->phys_cursor_on_p
= 0;
25341 /* Advance the output cursor. */
25342 output_cursor
.hpos
+= len
;
25343 output_cursor
.x
= x
;
25348 Insert LEN glyphs from START at the nominal cursor position. */
25351 x_insert_glyphs (struct glyph
*start
, int len
)
25355 int line_height
, shift_by_width
, shifted_region_width
;
25356 struct glyph_row
*row
;
25357 struct glyph
*glyph
;
25358 int frame_x
, frame_y
;
25361 eassert (updated_window
&& updated_row
);
25363 w
= updated_window
;
25364 f
= XFRAME (WINDOW_FRAME (w
));
25366 /* Get the height of the line we are in. */
25368 line_height
= row
->height
;
25370 /* Get the width of the glyphs to insert. */
25371 shift_by_width
= 0;
25372 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25373 shift_by_width
+= glyph
->pixel_width
;
25375 /* Get the width of the region to shift right. */
25376 shifted_region_width
= (window_box_width (w
, updated_area
)
25381 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25382 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25384 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25385 line_height
, shift_by_width
);
25387 /* Write the glyphs. */
25388 hpos
= start
- row
->glyphs
[updated_area
];
25389 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25391 DRAW_NORMAL_TEXT
, 0);
25393 /* Advance the output cursor. */
25394 output_cursor
.hpos
+= len
;
25395 output_cursor
.x
+= shift_by_width
;
25401 Erase the current text line from the nominal cursor position
25402 (inclusive) to pixel column TO_X (exclusive). The idea is that
25403 everything from TO_X onward is already erased.
25405 TO_X is a pixel position relative to updated_area of
25406 updated_window. TO_X == -1 means clear to the end of this area. */
25409 x_clear_end_of_line (int to_x
)
25412 struct window
*w
= updated_window
;
25413 int max_x
, min_y
, max_y
;
25414 int from_x
, from_y
, to_y
;
25416 eassert (updated_window
&& updated_row
);
25417 f
= XFRAME (w
->frame
);
25419 if (updated_row
->full_width_p
)
25420 max_x
= WINDOW_TOTAL_WIDTH (w
);
25422 max_x
= window_box_width (w
, updated_area
);
25423 max_y
= window_text_bottom_y (w
);
25425 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25426 of window. For TO_X > 0, truncate to end of drawing area. */
25432 to_x
= min (to_x
, max_x
);
25434 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25436 /* Notice if the cursor will be cleared by this operation. */
25437 if (!updated_row
->full_width_p
)
25438 notice_overwritten_cursor (w
, updated_area
,
25439 output_cursor
.x
, -1,
25441 MATRIX_ROW_BOTTOM_Y (updated_row
));
25443 from_x
= output_cursor
.x
;
25445 /* Translate to frame coordinates. */
25446 if (updated_row
->full_width_p
)
25448 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25449 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25453 int area_left
= window_box_left (w
, updated_area
);
25454 from_x
+= area_left
;
25458 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25459 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25460 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25462 /* Prevent inadvertently clearing to end of the X window. */
25463 if (to_x
> from_x
&& to_y
> from_y
)
25466 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25467 to_x
- from_x
, to_y
- from_y
);
25472 #endif /* HAVE_WINDOW_SYSTEM */
25476 /***********************************************************************
25478 ***********************************************************************/
25480 /* Value is the internal representation of the specified cursor type
25481 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25482 of the bar cursor. */
25484 static enum text_cursor_kinds
25485 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25487 enum text_cursor_kinds type
;
25492 if (EQ (arg
, Qbox
))
25493 return FILLED_BOX_CURSOR
;
25495 if (EQ (arg
, Qhollow
))
25496 return HOLLOW_BOX_CURSOR
;
25498 if (EQ (arg
, Qbar
))
25505 && EQ (XCAR (arg
), Qbar
)
25506 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25508 *width
= XINT (XCDR (arg
));
25512 if (EQ (arg
, Qhbar
))
25515 return HBAR_CURSOR
;
25519 && EQ (XCAR (arg
), Qhbar
)
25520 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25522 *width
= XINT (XCDR (arg
));
25523 return HBAR_CURSOR
;
25526 /* Treat anything unknown as "hollow box cursor".
25527 It was bad to signal an error; people have trouble fixing
25528 .Xdefaults with Emacs, when it has something bad in it. */
25529 type
= HOLLOW_BOX_CURSOR
;
25534 /* Set the default cursor types for specified frame. */
25536 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25541 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25542 FRAME_CURSOR_WIDTH (f
) = width
;
25544 /* By default, set up the blink-off state depending on the on-state. */
25546 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25549 FRAME_BLINK_OFF_CURSOR (f
)
25550 = get_specified_cursor_type (XCDR (tem
), &width
);
25551 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25554 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25558 #ifdef HAVE_WINDOW_SYSTEM
25560 /* Return the cursor we want to be displayed in window W. Return
25561 width of bar/hbar cursor through WIDTH arg. Return with
25562 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25563 (i.e. if the `system caret' should track this cursor).
25565 In a mini-buffer window, we want the cursor only to appear if we
25566 are reading input from this window. For the selected window, we
25567 want the cursor type given by the frame parameter or buffer local
25568 setting of cursor-type. If explicitly marked off, draw no cursor.
25569 In all other cases, we want a hollow box cursor. */
25571 static enum text_cursor_kinds
25572 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25573 int *active_cursor
)
25575 struct frame
*f
= XFRAME (w
->frame
);
25576 struct buffer
*b
= XBUFFER (w
->buffer
);
25577 int cursor_type
= DEFAULT_CURSOR
;
25578 Lisp_Object alt_cursor
;
25579 int non_selected
= 0;
25581 *active_cursor
= 1;
25584 if (cursor_in_echo_area
25585 && FRAME_HAS_MINIBUF_P (f
)
25586 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25588 if (w
== XWINDOW (echo_area_window
))
25590 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25592 *width
= FRAME_CURSOR_WIDTH (f
);
25593 return FRAME_DESIRED_CURSOR (f
);
25596 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25599 *active_cursor
= 0;
25603 /* Detect a nonselected window or nonselected frame. */
25604 else if (w
!= XWINDOW (f
->selected_window
)
25605 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25607 *active_cursor
= 0;
25609 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25615 /* Never display a cursor in a window in which cursor-type is nil. */
25616 if (NILP (BVAR (b
, cursor_type
)))
25619 /* Get the normal cursor type for this window. */
25620 if (EQ (BVAR (b
, cursor_type
), Qt
))
25622 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25623 *width
= FRAME_CURSOR_WIDTH (f
);
25626 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25628 /* Use cursor-in-non-selected-windows instead
25629 for non-selected window or frame. */
25632 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25633 if (!EQ (Qt
, alt_cursor
))
25634 return get_specified_cursor_type (alt_cursor
, width
);
25635 /* t means modify the normal cursor type. */
25636 if (cursor_type
== FILLED_BOX_CURSOR
)
25637 cursor_type
= HOLLOW_BOX_CURSOR
;
25638 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25640 return cursor_type
;
25643 /* Use normal cursor if not blinked off. */
25644 if (!w
->cursor_off_p
)
25646 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25648 if (cursor_type
== FILLED_BOX_CURSOR
)
25650 /* Using a block cursor on large images can be very annoying.
25651 So use a hollow cursor for "large" images.
25652 If image is not transparent (no mask), also use hollow cursor. */
25653 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25654 if (img
!= NULL
&& IMAGEP (img
->spec
))
25656 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25657 where N = size of default frame font size.
25658 This should cover most of the "tiny" icons people may use. */
25660 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25661 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25662 cursor_type
= HOLLOW_BOX_CURSOR
;
25665 else if (cursor_type
!= NO_CURSOR
)
25667 /* Display current only supports BOX and HOLLOW cursors for images.
25668 So for now, unconditionally use a HOLLOW cursor when cursor is
25669 not a solid box cursor. */
25670 cursor_type
= HOLLOW_BOX_CURSOR
;
25673 return cursor_type
;
25676 /* Cursor is blinked off, so determine how to "toggle" it. */
25678 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25679 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25680 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25682 /* Then see if frame has specified a specific blink off cursor type. */
25683 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25685 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25686 return FRAME_BLINK_OFF_CURSOR (f
);
25690 /* Some people liked having a permanently visible blinking cursor,
25691 while others had very strong opinions against it. So it was
25692 decided to remove it. KFS 2003-09-03 */
25694 /* Finally perform built-in cursor blinking:
25695 filled box <-> hollow box
25696 wide [h]bar <-> narrow [h]bar
25697 narrow [h]bar <-> no cursor
25698 other type <-> no cursor */
25700 if (cursor_type
== FILLED_BOX_CURSOR
)
25701 return HOLLOW_BOX_CURSOR
;
25703 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25706 return cursor_type
;
25714 /* Notice when the text cursor of window W has been completely
25715 overwritten by a drawing operation that outputs glyphs in AREA
25716 starting at X0 and ending at X1 in the line starting at Y0 and
25717 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25718 the rest of the line after X0 has been written. Y coordinates
25719 are window-relative. */
25722 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25723 int x0
, int x1
, int y0
, int y1
)
25725 int cx0
, cx1
, cy0
, cy1
;
25726 struct glyph_row
*row
;
25728 if (!w
->phys_cursor_on_p
)
25730 if (area
!= TEXT_AREA
)
25733 if (w
->phys_cursor
.vpos
< 0
25734 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25735 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25736 !(row
->enabled_p
&& row
->displays_text_p
)))
25739 if (row
->cursor_in_fringe_p
)
25741 row
->cursor_in_fringe_p
= 0;
25742 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25743 w
->phys_cursor_on_p
= 0;
25747 cx0
= w
->phys_cursor
.x
;
25748 cx1
= cx0
+ w
->phys_cursor_width
;
25749 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25752 /* The cursor image will be completely removed from the
25753 screen if the output area intersects the cursor area in
25754 y-direction. When we draw in [y0 y1[, and some part of
25755 the cursor is at y < y0, that part must have been drawn
25756 before. When scrolling, the cursor is erased before
25757 actually scrolling, so we don't come here. When not
25758 scrolling, the rows above the old cursor row must have
25759 changed, and in this case these rows must have written
25760 over the cursor image.
25762 Likewise if part of the cursor is below y1, with the
25763 exception of the cursor being in the first blank row at
25764 the buffer and window end because update_text_area
25765 doesn't draw that row. (Except when it does, but
25766 that's handled in update_text_area.) */
25768 cy0
= w
->phys_cursor
.y
;
25769 cy1
= cy0
+ w
->phys_cursor_height
;
25770 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25773 w
->phys_cursor_on_p
= 0;
25776 #endif /* HAVE_WINDOW_SYSTEM */
25779 /************************************************************************
25781 ************************************************************************/
25783 #ifdef HAVE_WINDOW_SYSTEM
25786 Fix the display of area AREA of overlapping row ROW in window W
25787 with respect to the overlapping part OVERLAPS. */
25790 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25791 enum glyph_row_area area
, int overlaps
)
25798 for (i
= 0; i
< row
->used
[area
];)
25800 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25802 int start
= i
, start_x
= x
;
25806 x
+= row
->glyphs
[area
][i
].pixel_width
;
25809 while (i
< row
->used
[area
]
25810 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25812 draw_glyphs (w
, start_x
, row
, area
,
25814 DRAW_NORMAL_TEXT
, overlaps
);
25818 x
+= row
->glyphs
[area
][i
].pixel_width
;
25828 Draw the cursor glyph of window W in glyph row ROW. See the
25829 comment of draw_glyphs for the meaning of HL. */
25832 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25833 enum draw_glyphs_face hl
)
25835 /* If cursor hpos is out of bounds, don't draw garbage. This can
25836 happen in mini-buffer windows when switching between echo area
25837 glyphs and mini-buffer. */
25838 if ((row
->reversed_p
25839 ? (w
->phys_cursor
.hpos
>= 0)
25840 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25842 int on_p
= w
->phys_cursor_on_p
;
25844 int hpos
= w
->phys_cursor
.hpos
;
25846 /* When the window is hscrolled, cursor hpos can legitimately be
25847 out of bounds, but we draw the cursor at the corresponding
25848 window margin in that case. */
25849 if (!row
->reversed_p
&& hpos
< 0)
25851 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25852 hpos
= row
->used
[TEXT_AREA
] - 1;
25854 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25856 w
->phys_cursor_on_p
= on_p
;
25858 if (hl
== DRAW_CURSOR
)
25859 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25860 /* When we erase the cursor, and ROW is overlapped by other
25861 rows, make sure that these overlapping parts of other rows
25863 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25865 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25867 if (row
> w
->current_matrix
->rows
25868 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25869 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25870 OVERLAPS_ERASED_CURSOR
);
25872 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25873 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25874 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25875 OVERLAPS_ERASED_CURSOR
);
25882 Erase the image of a cursor of window W from the screen. */
25885 erase_phys_cursor (struct window
*w
)
25887 struct frame
*f
= XFRAME (w
->frame
);
25888 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25889 int hpos
= w
->phys_cursor
.hpos
;
25890 int vpos
= w
->phys_cursor
.vpos
;
25891 int mouse_face_here_p
= 0;
25892 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25893 struct glyph_row
*cursor_row
;
25894 struct glyph
*cursor_glyph
;
25895 enum draw_glyphs_face hl
;
25897 /* No cursor displayed or row invalidated => nothing to do on the
25899 if (w
->phys_cursor_type
== NO_CURSOR
)
25900 goto mark_cursor_off
;
25902 /* VPOS >= active_glyphs->nrows means that window has been resized.
25903 Don't bother to erase the cursor. */
25904 if (vpos
>= active_glyphs
->nrows
)
25905 goto mark_cursor_off
;
25907 /* If row containing cursor is marked invalid, there is nothing we
25909 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25910 if (!cursor_row
->enabled_p
)
25911 goto mark_cursor_off
;
25913 /* If line spacing is > 0, old cursor may only be partially visible in
25914 window after split-window. So adjust visible height. */
25915 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25916 window_text_bottom_y (w
) - cursor_row
->y
);
25918 /* If row is completely invisible, don't attempt to delete a cursor which
25919 isn't there. This can happen if cursor is at top of a window, and
25920 we switch to a buffer with a header line in that window. */
25921 if (cursor_row
->visible_height
<= 0)
25922 goto mark_cursor_off
;
25924 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25925 if (cursor_row
->cursor_in_fringe_p
)
25927 cursor_row
->cursor_in_fringe_p
= 0;
25928 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25929 goto mark_cursor_off
;
25932 /* This can happen when the new row is shorter than the old one.
25933 In this case, either draw_glyphs or clear_end_of_line
25934 should have cleared the cursor. Note that we wouldn't be
25935 able to erase the cursor in this case because we don't have a
25936 cursor glyph at hand. */
25937 if ((cursor_row
->reversed_p
25938 ? (w
->phys_cursor
.hpos
< 0)
25939 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25940 goto mark_cursor_off
;
25942 /* When the window is hscrolled, cursor hpos can legitimately be out
25943 of bounds, but we draw the cursor at the corresponding window
25944 margin in that case. */
25945 if (!cursor_row
->reversed_p
&& hpos
< 0)
25947 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25948 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25950 /* If the cursor is in the mouse face area, redisplay that when
25951 we clear the cursor. */
25952 if (! NILP (hlinfo
->mouse_face_window
)
25953 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25954 /* Don't redraw the cursor's spot in mouse face if it is at the
25955 end of a line (on a newline). The cursor appears there, but
25956 mouse highlighting does not. */
25957 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25958 mouse_face_here_p
= 1;
25960 /* Maybe clear the display under the cursor. */
25961 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25964 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25967 cursor_glyph
= get_phys_cursor_glyph (w
);
25968 if (cursor_glyph
== NULL
)
25969 goto mark_cursor_off
;
25971 width
= cursor_glyph
->pixel_width
;
25972 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25973 x
= w
->phys_cursor
.x
;
25975 width
-= left_x
- x
;
25976 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25977 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25978 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25981 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25984 /* Erase the cursor by redrawing the character underneath it. */
25985 if (mouse_face_here_p
)
25986 hl
= DRAW_MOUSE_FACE
;
25988 hl
= DRAW_NORMAL_TEXT
;
25989 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25992 w
->phys_cursor_on_p
= 0;
25993 w
->phys_cursor_type
= NO_CURSOR
;
25998 Display or clear cursor of window W. If ON is zero, clear the
25999 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26000 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26003 display_and_set_cursor (struct window
*w
, int on
,
26004 int hpos
, int vpos
, int x
, int y
)
26006 struct frame
*f
= XFRAME (w
->frame
);
26007 int new_cursor_type
;
26008 int new_cursor_width
;
26010 struct glyph_row
*glyph_row
;
26011 struct glyph
*glyph
;
26013 /* This is pointless on invisible frames, and dangerous on garbaged
26014 windows and frames; in the latter case, the frame or window may
26015 be in the midst of changing its size, and x and y may be off the
26017 if (! FRAME_VISIBLE_P (f
)
26018 || FRAME_GARBAGED_P (f
)
26019 || vpos
>= w
->current_matrix
->nrows
26020 || hpos
>= w
->current_matrix
->matrix_w
)
26023 /* If cursor is off and we want it off, return quickly. */
26024 if (!on
&& !w
->phys_cursor_on_p
)
26027 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26028 /* If cursor row is not enabled, we don't really know where to
26029 display the cursor. */
26030 if (!glyph_row
->enabled_p
)
26032 w
->phys_cursor_on_p
= 0;
26037 if (!glyph_row
->exact_window_width_line_p
26038 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26039 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26041 eassert (interrupt_input_blocked
);
26043 /* Set new_cursor_type to the cursor we want to be displayed. */
26044 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26045 &new_cursor_width
, &active_cursor
);
26047 /* If cursor is currently being shown and we don't want it to be or
26048 it is in the wrong place, or the cursor type is not what we want,
26050 if (w
->phys_cursor_on_p
26052 || w
->phys_cursor
.x
!= x
26053 || w
->phys_cursor
.y
!= y
26054 || new_cursor_type
!= w
->phys_cursor_type
26055 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26056 && new_cursor_width
!= w
->phys_cursor_width
)))
26057 erase_phys_cursor (w
);
26059 /* Don't check phys_cursor_on_p here because that flag is only set
26060 to zero in some cases where we know that the cursor has been
26061 completely erased, to avoid the extra work of erasing the cursor
26062 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26063 still not be visible, or it has only been partly erased. */
26066 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26067 w
->phys_cursor_height
= glyph_row
->height
;
26069 /* Set phys_cursor_.* before x_draw_.* is called because some
26070 of them may need the information. */
26071 w
->phys_cursor
.x
= x
;
26072 w
->phys_cursor
.y
= glyph_row
->y
;
26073 w
->phys_cursor
.hpos
= hpos
;
26074 w
->phys_cursor
.vpos
= vpos
;
26077 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26078 new_cursor_type
, new_cursor_width
,
26079 on
, active_cursor
);
26083 /* Switch the display of W's cursor on or off, according to the value
26087 update_window_cursor (struct window
*w
, int on
)
26089 /* Don't update cursor in windows whose frame is in the process
26090 of being deleted. */
26091 if (w
->current_matrix
)
26093 int hpos
= w
->phys_cursor
.hpos
;
26094 int vpos
= w
->phys_cursor
.vpos
;
26095 struct glyph_row
*row
;
26097 if (vpos
>= w
->current_matrix
->nrows
26098 || hpos
>= w
->current_matrix
->matrix_w
)
26101 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26103 /* When the window is hscrolled, cursor hpos can legitimately be
26104 out of bounds, but we draw the cursor at the corresponding
26105 window margin in that case. */
26106 if (!row
->reversed_p
&& hpos
< 0)
26108 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26109 hpos
= row
->used
[TEXT_AREA
] - 1;
26112 display_and_set_cursor (w
, on
, hpos
, vpos
,
26113 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26119 /* Call update_window_cursor with parameter ON_P on all leaf windows
26120 in the window tree rooted at W. */
26123 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26127 if (!NILP (w
->hchild
))
26128 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26129 else if (!NILP (w
->vchild
))
26130 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26132 update_window_cursor (w
, on_p
);
26134 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26140 Display the cursor on window W, or clear it, according to ON_P.
26141 Don't change the cursor's position. */
26144 x_update_cursor (struct frame
*f
, int on_p
)
26146 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26151 Clear the cursor of window W to background color, and mark the
26152 cursor as not shown. This is used when the text where the cursor
26153 is about to be rewritten. */
26156 x_clear_cursor (struct window
*w
)
26158 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26159 update_window_cursor (w
, 0);
26162 #endif /* HAVE_WINDOW_SYSTEM */
26164 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26167 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26168 int start_hpos
, int end_hpos
,
26169 enum draw_glyphs_face draw
)
26171 #ifdef HAVE_WINDOW_SYSTEM
26172 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26174 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26178 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26179 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26183 /* Display the active region described by mouse_face_* according to DRAW. */
26186 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26188 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26189 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26191 if (/* If window is in the process of being destroyed, don't bother
26193 w
->current_matrix
!= NULL
26194 /* Don't update mouse highlight if hidden */
26195 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26196 /* Recognize when we are called to operate on rows that don't exist
26197 anymore. This can happen when a window is split. */
26198 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26200 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26201 struct glyph_row
*row
, *first
, *last
;
26203 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26204 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26206 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26208 int start_hpos
, end_hpos
, start_x
;
26210 /* For all but the first row, the highlight starts at column 0. */
26213 /* R2L rows have BEG and END in reversed order, but the
26214 screen drawing geometry is always left to right. So
26215 we need to mirror the beginning and end of the
26216 highlighted area in R2L rows. */
26217 if (!row
->reversed_p
)
26219 start_hpos
= hlinfo
->mouse_face_beg_col
;
26220 start_x
= hlinfo
->mouse_face_beg_x
;
26222 else if (row
== last
)
26224 start_hpos
= hlinfo
->mouse_face_end_col
;
26225 start_x
= hlinfo
->mouse_face_end_x
;
26233 else if (row
->reversed_p
&& row
== last
)
26235 start_hpos
= hlinfo
->mouse_face_end_col
;
26236 start_x
= hlinfo
->mouse_face_end_x
;
26246 if (!row
->reversed_p
)
26247 end_hpos
= hlinfo
->mouse_face_end_col
;
26248 else if (row
== first
)
26249 end_hpos
= hlinfo
->mouse_face_beg_col
;
26252 end_hpos
= row
->used
[TEXT_AREA
];
26253 if (draw
== DRAW_NORMAL_TEXT
)
26254 row
->fill_line_p
= 1; /* Clear to end of line */
26257 else if (row
->reversed_p
&& row
== first
)
26258 end_hpos
= hlinfo
->mouse_face_beg_col
;
26261 end_hpos
= row
->used
[TEXT_AREA
];
26262 if (draw
== DRAW_NORMAL_TEXT
)
26263 row
->fill_line_p
= 1; /* Clear to end of line */
26266 if (end_hpos
> start_hpos
)
26268 draw_row_with_mouse_face (w
, start_x
, row
,
26269 start_hpos
, end_hpos
, draw
);
26272 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26276 #ifdef HAVE_WINDOW_SYSTEM
26277 /* When we've written over the cursor, arrange for it to
26278 be displayed again. */
26279 if (FRAME_WINDOW_P (f
)
26280 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26282 int hpos
= w
->phys_cursor
.hpos
;
26284 /* When the window is hscrolled, cursor hpos can legitimately be
26285 out of bounds, but we draw the cursor at the corresponding
26286 window margin in that case. */
26287 if (!row
->reversed_p
&& hpos
< 0)
26289 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26290 hpos
= row
->used
[TEXT_AREA
] - 1;
26293 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26294 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26297 #endif /* HAVE_WINDOW_SYSTEM */
26300 #ifdef HAVE_WINDOW_SYSTEM
26301 /* Change the mouse cursor. */
26302 if (FRAME_WINDOW_P (f
))
26304 if (draw
== DRAW_NORMAL_TEXT
26305 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26306 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26307 else if (draw
== DRAW_MOUSE_FACE
)
26308 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26310 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26312 #endif /* HAVE_WINDOW_SYSTEM */
26316 Clear out the mouse-highlighted active region.
26317 Redraw it un-highlighted first. Value is non-zero if mouse
26318 face was actually drawn unhighlighted. */
26321 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26325 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26327 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26331 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26332 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26333 hlinfo
->mouse_face_window
= Qnil
;
26334 hlinfo
->mouse_face_overlay
= Qnil
;
26338 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26339 within the mouse face on that window. */
26341 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26343 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26345 /* Quickly resolve the easy cases. */
26346 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26347 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26349 if (vpos
< hlinfo
->mouse_face_beg_row
26350 || vpos
> hlinfo
->mouse_face_end_row
)
26352 if (vpos
> hlinfo
->mouse_face_beg_row
26353 && vpos
< hlinfo
->mouse_face_end_row
)
26356 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26358 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26360 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26363 else if ((vpos
== hlinfo
->mouse_face_beg_row
26364 && hpos
>= hlinfo
->mouse_face_beg_col
)
26365 || (vpos
== hlinfo
->mouse_face_end_row
26366 && hpos
< hlinfo
->mouse_face_end_col
))
26371 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26373 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26376 else if ((vpos
== hlinfo
->mouse_face_beg_row
26377 && hpos
<= hlinfo
->mouse_face_beg_col
)
26378 || (vpos
== hlinfo
->mouse_face_end_row
26379 && hpos
> hlinfo
->mouse_face_end_col
))
26387 Non-zero if physical cursor of window W is within mouse face. */
26390 cursor_in_mouse_face_p (struct window
*w
)
26392 int hpos
= w
->phys_cursor
.hpos
;
26393 int vpos
= w
->phys_cursor
.vpos
;
26394 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26396 /* When the window is hscrolled, cursor hpos can legitimately be out
26397 of bounds, but we draw the cursor at the corresponding window
26398 margin in that case. */
26399 if (!row
->reversed_p
&& hpos
< 0)
26401 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26402 hpos
= row
->used
[TEXT_AREA
] - 1;
26404 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26409 /* Find the glyph rows START_ROW and END_ROW of window W that display
26410 characters between buffer positions START_CHARPOS and END_CHARPOS
26411 (excluding END_CHARPOS). DISP_STRING is a display string that
26412 covers these buffer positions. This is similar to
26413 row_containing_pos, but is more accurate when bidi reordering makes
26414 buffer positions change non-linearly with glyph rows. */
26416 rows_from_pos_range (struct window
*w
,
26417 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26418 Lisp_Object disp_string
,
26419 struct glyph_row
**start
, struct glyph_row
**end
)
26421 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26422 int last_y
= window_text_bottom_y (w
);
26423 struct glyph_row
*row
;
26428 while (!first
->enabled_p
26429 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26432 /* Find the START row. */
26434 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26437 /* A row can potentially be the START row if the range of the
26438 characters it displays intersects the range
26439 [START_CHARPOS..END_CHARPOS). */
26440 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26441 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26442 /* See the commentary in row_containing_pos, for the
26443 explanation of the complicated way to check whether
26444 some position is beyond the end of the characters
26445 displayed by a row. */
26446 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26447 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26448 && !row
->ends_at_zv_p
26449 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26450 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26451 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26452 && !row
->ends_at_zv_p
26453 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26455 /* Found a candidate row. Now make sure at least one of the
26456 glyphs it displays has a charpos from the range
26457 [START_CHARPOS..END_CHARPOS).
26459 This is not obvious because bidi reordering could make
26460 buffer positions of a row be 1,2,3,102,101,100, and if we
26461 want to highlight characters in [50..60), we don't want
26462 this row, even though [50..60) does intersect [1..103),
26463 the range of character positions given by the row's start
26464 and end positions. */
26465 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26466 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26470 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26471 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26472 /* A glyph that comes from DISP_STRING is by
26473 definition to be highlighted. */
26474 || EQ (g
->object
, disp_string
))
26483 /* Find the END row. */
26485 /* If the last row is partially visible, start looking for END
26486 from that row, instead of starting from FIRST. */
26487 && !(row
->enabled_p
26488 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26490 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26492 struct glyph_row
*next
= row
+ 1;
26493 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26495 if (!next
->enabled_p
26496 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26497 /* The first row >= START whose range of displayed characters
26498 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26499 is the row END + 1. */
26500 || (start_charpos
< next_start
26501 && end_charpos
< next_start
)
26502 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26503 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26504 && !next
->ends_at_zv_p
26505 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26506 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26507 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26508 && !next
->ends_at_zv_p
26509 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26516 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26517 but none of the characters it displays are in the range, it is
26519 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26520 struct glyph
*s
= g
;
26521 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26525 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26526 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26527 /* If the buffer position of the first glyph in
26528 the row is equal to END_CHARPOS, it means
26529 the last character to be highlighted is the
26530 newline of ROW, and we must consider NEXT as
26532 || (((!next
->reversed_p
&& g
== s
)
26533 || (next
->reversed_p
&& g
== e
- 1))
26534 && (g
->charpos
== end_charpos
26535 /* Special case for when NEXT is an
26536 empty line at ZV. */
26537 || (g
->charpos
== -1
26538 && !row
->ends_at_zv_p
26539 && next_start
== end_charpos
)))))
26540 /* A glyph that comes from DISP_STRING is by
26541 definition to be highlighted. */
26542 || EQ (g
->object
, disp_string
))
26551 /* The first row that ends at ZV must be the last to be
26553 else if (next
->ends_at_zv_p
)
26562 /* This function sets the mouse_face_* elements of HLINFO, assuming
26563 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26564 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26565 for the overlay or run of text properties specifying the mouse
26566 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26567 before-string and after-string that must also be highlighted.
26568 DISP_STRING, if non-nil, is a display string that may cover some
26569 or all of the highlighted text. */
26572 mouse_face_from_buffer_pos (Lisp_Object window
,
26573 Mouse_HLInfo
*hlinfo
,
26574 ptrdiff_t mouse_charpos
,
26575 ptrdiff_t start_charpos
,
26576 ptrdiff_t end_charpos
,
26577 Lisp_Object before_string
,
26578 Lisp_Object after_string
,
26579 Lisp_Object disp_string
)
26581 struct window
*w
= XWINDOW (window
);
26582 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26583 struct glyph_row
*r1
, *r2
;
26584 struct glyph
*glyph
, *end
;
26585 ptrdiff_t ignore
, pos
;
26588 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26589 eassert (NILP (before_string
) || STRINGP (before_string
));
26590 eassert (NILP (after_string
) || STRINGP (after_string
));
26592 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26593 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26595 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26596 /* If the before-string or display-string contains newlines,
26597 rows_from_pos_range skips to its last row. Move back. */
26598 if (!NILP (before_string
) || !NILP (disp_string
))
26600 struct glyph_row
*prev
;
26601 while ((prev
= r1
- 1, prev
>= first
)
26602 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26603 && prev
->used
[TEXT_AREA
] > 0)
26605 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26606 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26607 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26609 || !(EQ (glyph
->object
, before_string
)
26610 || EQ (glyph
->object
, disp_string
)))
26617 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26618 hlinfo
->mouse_face_past_end
= 1;
26620 else if (!NILP (after_string
))
26622 /* If the after-string has newlines, advance to its last row. */
26623 struct glyph_row
*next
;
26624 struct glyph_row
*last
26625 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26627 for (next
= r2
+ 1;
26629 && next
->used
[TEXT_AREA
] > 0
26630 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26634 /* The rest of the display engine assumes that mouse_face_beg_row is
26635 either above mouse_face_end_row or identical to it. But with
26636 bidi-reordered continued lines, the row for START_CHARPOS could
26637 be below the row for END_CHARPOS. If so, swap the rows and store
26638 them in correct order. */
26641 struct glyph_row
*tem
= r2
;
26647 hlinfo
->mouse_face_beg_y
= r1
->y
;
26648 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26649 hlinfo
->mouse_face_end_y
= r2
->y
;
26650 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26652 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26653 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26654 could be anywhere in the row and in any order. The strategy
26655 below is to find the leftmost and the rightmost glyph that
26656 belongs to either of these 3 strings, or whose position is
26657 between START_CHARPOS and END_CHARPOS, and highlight all the
26658 glyphs between those two. This may cover more than just the text
26659 between START_CHARPOS and END_CHARPOS if the range of characters
26660 strides the bidi level boundary, e.g. if the beginning is in R2L
26661 text while the end is in L2R text or vice versa. */
26662 if (!r1
->reversed_p
)
26664 /* This row is in a left to right paragraph. Scan it left to
26666 glyph
= r1
->glyphs
[TEXT_AREA
];
26667 end
= glyph
+ r1
->used
[TEXT_AREA
];
26670 /* Skip truncation glyphs at the start of the glyph row. */
26671 if (r1
->displays_text_p
)
26673 && INTEGERP (glyph
->object
)
26674 && glyph
->charpos
< 0;
26676 x
+= glyph
->pixel_width
;
26678 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26679 or DISP_STRING, and the first glyph from buffer whose
26680 position is between START_CHARPOS and END_CHARPOS. */
26682 && !INTEGERP (glyph
->object
)
26683 && !EQ (glyph
->object
, disp_string
)
26684 && !(BUFFERP (glyph
->object
)
26685 && (glyph
->charpos
>= start_charpos
26686 && glyph
->charpos
< end_charpos
));
26689 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26690 are present at buffer positions between START_CHARPOS and
26691 END_CHARPOS, or if they come from an overlay. */
26692 if (EQ (glyph
->object
, before_string
))
26694 pos
= string_buffer_position (before_string
,
26696 /* If pos == 0, it means before_string came from an
26697 overlay, not from a buffer position. */
26698 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26701 else if (EQ (glyph
->object
, after_string
))
26703 pos
= string_buffer_position (after_string
, end_charpos
);
26704 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26707 x
+= glyph
->pixel_width
;
26709 hlinfo
->mouse_face_beg_x
= x
;
26710 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26714 /* This row is in a right to left paragraph. Scan it right to
26718 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26719 glyph
= end
+ r1
->used
[TEXT_AREA
];
26721 /* Skip truncation glyphs at the start of the glyph row. */
26722 if (r1
->displays_text_p
)
26724 && INTEGERP (glyph
->object
)
26725 && glyph
->charpos
< 0;
26729 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26730 or DISP_STRING, and the first glyph from buffer whose
26731 position is between START_CHARPOS and END_CHARPOS. */
26733 && !INTEGERP (glyph
->object
)
26734 && !EQ (glyph
->object
, disp_string
)
26735 && !(BUFFERP (glyph
->object
)
26736 && (glyph
->charpos
>= start_charpos
26737 && glyph
->charpos
< end_charpos
));
26740 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26741 are present at buffer positions between START_CHARPOS and
26742 END_CHARPOS, or if they come from an overlay. */
26743 if (EQ (glyph
->object
, before_string
))
26745 pos
= string_buffer_position (before_string
, start_charpos
);
26746 /* If pos == 0, it means before_string came from an
26747 overlay, not from a buffer position. */
26748 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26751 else if (EQ (glyph
->object
, after_string
))
26753 pos
= string_buffer_position (after_string
, end_charpos
);
26754 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26759 glyph
++; /* first glyph to the right of the highlighted area */
26760 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26761 x
+= g
->pixel_width
;
26762 hlinfo
->mouse_face_beg_x
= x
;
26763 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26766 /* If the highlight ends in a different row, compute GLYPH and END
26767 for the end row. Otherwise, reuse the values computed above for
26768 the row where the highlight begins. */
26771 if (!r2
->reversed_p
)
26773 glyph
= r2
->glyphs
[TEXT_AREA
];
26774 end
= glyph
+ r2
->used
[TEXT_AREA
];
26779 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26780 glyph
= end
+ r2
->used
[TEXT_AREA
];
26784 if (!r2
->reversed_p
)
26786 /* Skip truncation and continuation glyphs near the end of the
26787 row, and also blanks and stretch glyphs inserted by
26788 extend_face_to_end_of_line. */
26790 && INTEGERP ((end
- 1)->object
))
26792 /* Scan the rest of the glyph row from the end, looking for the
26793 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26794 DISP_STRING, or whose position is between START_CHARPOS
26798 && !INTEGERP (end
->object
)
26799 && !EQ (end
->object
, disp_string
)
26800 && !(BUFFERP (end
->object
)
26801 && (end
->charpos
>= start_charpos
26802 && end
->charpos
< end_charpos
));
26805 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26806 are present at buffer positions between START_CHARPOS and
26807 END_CHARPOS, or if they come from an overlay. */
26808 if (EQ (end
->object
, before_string
))
26810 pos
= string_buffer_position (before_string
, start_charpos
);
26811 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26814 else if (EQ (end
->object
, after_string
))
26816 pos
= string_buffer_position (after_string
, end_charpos
);
26817 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26821 /* Find the X coordinate of the last glyph to be highlighted. */
26822 for (; glyph
<= end
; ++glyph
)
26823 x
+= glyph
->pixel_width
;
26825 hlinfo
->mouse_face_end_x
= x
;
26826 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26830 /* Skip truncation and continuation glyphs near the end of the
26831 row, and also blanks and stretch glyphs inserted by
26832 extend_face_to_end_of_line. */
26836 && INTEGERP (end
->object
))
26838 x
+= end
->pixel_width
;
26841 /* Scan the rest of the glyph row from the end, looking for the
26842 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26843 DISP_STRING, or whose position is between START_CHARPOS
26847 && !INTEGERP (end
->object
)
26848 && !EQ (end
->object
, disp_string
)
26849 && !(BUFFERP (end
->object
)
26850 && (end
->charpos
>= start_charpos
26851 && end
->charpos
< end_charpos
));
26854 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26855 are present at buffer positions between START_CHARPOS and
26856 END_CHARPOS, or if they come from an overlay. */
26857 if (EQ (end
->object
, before_string
))
26859 pos
= string_buffer_position (before_string
, start_charpos
);
26860 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26863 else if (EQ (end
->object
, after_string
))
26865 pos
= string_buffer_position (after_string
, end_charpos
);
26866 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26869 x
+= end
->pixel_width
;
26871 /* If we exited the above loop because we arrived at the last
26872 glyph of the row, and its buffer position is still not in
26873 range, it means the last character in range is the preceding
26874 newline. Bump the end column and x values to get past the
26877 && BUFFERP (end
->object
)
26878 && (end
->charpos
< start_charpos
26879 || end
->charpos
>= end_charpos
))
26881 x
+= end
->pixel_width
;
26884 hlinfo
->mouse_face_end_x
= x
;
26885 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26888 hlinfo
->mouse_face_window
= window
;
26889 hlinfo
->mouse_face_face_id
26890 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26892 !hlinfo
->mouse_face_hidden
, -1);
26893 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26896 /* The following function is not used anymore (replaced with
26897 mouse_face_from_string_pos), but I leave it here for the time
26898 being, in case someone would. */
26900 #if 0 /* not used */
26902 /* Find the position of the glyph for position POS in OBJECT in
26903 window W's current matrix, and return in *X, *Y the pixel
26904 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26906 RIGHT_P non-zero means return the position of the right edge of the
26907 glyph, RIGHT_P zero means return the left edge position.
26909 If no glyph for POS exists in the matrix, return the position of
26910 the glyph with the next smaller position that is in the matrix, if
26911 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26912 exists in the matrix, return the position of the glyph with the
26913 next larger position in OBJECT.
26915 Value is non-zero if a glyph was found. */
26918 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26919 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26921 int yb
= window_text_bottom_y (w
);
26922 struct glyph_row
*r
;
26923 struct glyph
*best_glyph
= NULL
;
26924 struct glyph_row
*best_row
= NULL
;
26927 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26928 r
->enabled_p
&& r
->y
< yb
;
26931 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26932 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26935 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26936 if (EQ (g
->object
, object
))
26938 if (g
->charpos
== pos
)
26945 else if (best_glyph
== NULL
26946 || ((eabs (g
->charpos
- pos
)
26947 < eabs (best_glyph
->charpos
- pos
))
26950 : g
->charpos
> pos
)))
26964 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26968 *x
+= best_glyph
->pixel_width
;
26973 *vpos
= best_row
- w
->current_matrix
->rows
;
26976 return best_glyph
!= NULL
;
26978 #endif /* not used */
26980 /* Find the positions of the first and the last glyphs in window W's
26981 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26982 (assumed to be a string), and return in HLINFO's mouse_face_*
26983 members the pixel and column/row coordinates of those glyphs. */
26986 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26987 Lisp_Object object
,
26988 ptrdiff_t startpos
, ptrdiff_t endpos
)
26990 int yb
= window_text_bottom_y (w
);
26991 struct glyph_row
*r
;
26992 struct glyph
*g
, *e
;
26996 /* Find the glyph row with at least one position in the range
26997 [STARTPOS..ENDPOS], and the first glyph in that row whose
26998 position belongs to that range. */
26999 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27000 r
->enabled_p
&& r
->y
< yb
;
27003 if (!r
->reversed_p
)
27005 g
= r
->glyphs
[TEXT_AREA
];
27006 e
= g
+ r
->used
[TEXT_AREA
];
27007 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27008 if (EQ (g
->object
, object
)
27009 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27011 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27012 hlinfo
->mouse_face_beg_y
= r
->y
;
27013 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27014 hlinfo
->mouse_face_beg_x
= gx
;
27023 e
= r
->glyphs
[TEXT_AREA
];
27024 g
= e
+ r
->used
[TEXT_AREA
];
27025 for ( ; g
> e
; --g
)
27026 if (EQ ((g
-1)->object
, object
)
27027 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27029 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27030 hlinfo
->mouse_face_beg_y
= r
->y
;
27031 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27032 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27033 gx
+= g1
->pixel_width
;
27034 hlinfo
->mouse_face_beg_x
= gx
;
27046 /* Starting with the next row, look for the first row which does NOT
27047 include any glyphs whose positions are in the range. */
27048 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27050 g
= r
->glyphs
[TEXT_AREA
];
27051 e
= g
+ r
->used
[TEXT_AREA
];
27053 for ( ; g
< e
; ++g
)
27054 if (EQ (g
->object
, object
)
27055 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27064 /* The highlighted region ends on the previous row. */
27067 /* Set the end row and its vertical pixel coordinate. */
27068 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27069 hlinfo
->mouse_face_end_y
= r
->y
;
27071 /* Compute and set the end column and the end column's horizontal
27072 pixel coordinate. */
27073 if (!r
->reversed_p
)
27075 g
= r
->glyphs
[TEXT_AREA
];
27076 e
= g
+ r
->used
[TEXT_AREA
];
27077 for ( ; e
> g
; --e
)
27078 if (EQ ((e
-1)->object
, object
)
27079 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27081 hlinfo
->mouse_face_end_col
= e
- g
;
27083 for (gx
= r
->x
; g
< e
; ++g
)
27084 gx
+= g
->pixel_width
;
27085 hlinfo
->mouse_face_end_x
= gx
;
27089 e
= r
->glyphs
[TEXT_AREA
];
27090 g
= e
+ r
->used
[TEXT_AREA
];
27091 for (gx
= r
->x
; e
< g
; ++e
)
27093 if (EQ (e
->object
, object
)
27094 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27096 gx
+= e
->pixel_width
;
27098 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27099 hlinfo
->mouse_face_end_x
= gx
;
27103 #ifdef HAVE_WINDOW_SYSTEM
27105 /* See if position X, Y is within a hot-spot of an image. */
27108 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27110 if (!CONSP (hot_spot
))
27113 if (EQ (XCAR (hot_spot
), Qrect
))
27115 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27116 Lisp_Object rect
= XCDR (hot_spot
);
27120 if (!CONSP (XCAR (rect
)))
27122 if (!CONSP (XCDR (rect
)))
27124 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27126 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27128 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27130 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27134 else if (EQ (XCAR (hot_spot
), Qcircle
))
27136 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27137 Lisp_Object circ
= XCDR (hot_spot
);
27138 Lisp_Object lr
, lx0
, ly0
;
27140 && CONSP (XCAR (circ
))
27141 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27142 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27143 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27145 double r
= XFLOATINT (lr
);
27146 double dx
= XINT (lx0
) - x
;
27147 double dy
= XINT (ly0
) - y
;
27148 return (dx
* dx
+ dy
* dy
<= r
* r
);
27151 else if (EQ (XCAR (hot_spot
), Qpoly
))
27153 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27154 if (VECTORP (XCDR (hot_spot
)))
27156 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27157 Lisp_Object
*poly
= v
->contents
;
27158 ptrdiff_t n
= v
->header
.size
;
27161 Lisp_Object lx
, ly
;
27164 /* Need an even number of coordinates, and at least 3 edges. */
27165 if (n
< 6 || n
& 1)
27168 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27169 If count is odd, we are inside polygon. Pixels on edges
27170 may or may not be included depending on actual geometry of the
27172 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27173 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27175 x0
= XINT (lx
), y0
= XINT (ly
);
27176 for (i
= 0; i
< n
; i
+= 2)
27178 int x1
= x0
, y1
= y0
;
27179 if ((lx
= poly
[i
], !INTEGERP (lx
))
27180 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27182 x0
= XINT (lx
), y0
= XINT (ly
);
27184 /* Does this segment cross the X line? */
27192 if (y
> y0
&& y
> y1
)
27194 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27204 find_hot_spot (Lisp_Object map
, int x
, int y
)
27206 while (CONSP (map
))
27208 if (CONSP (XCAR (map
))
27209 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27217 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27219 doc
: /* Lookup in image map MAP coordinates X and Y.
27220 An image map is an alist where each element has the format (AREA ID PLIST).
27221 An AREA is specified as either a rectangle, a circle, or a polygon:
27222 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27223 pixel coordinates of the upper left and bottom right corners.
27224 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27225 and the radius of the circle; r may be a float or integer.
27226 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27227 vector describes one corner in the polygon.
27228 Returns the alist element for the first matching AREA in MAP. */)
27229 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27237 return find_hot_spot (map
,
27238 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27239 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27243 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27245 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27247 /* Do not change cursor shape while dragging mouse. */
27248 if (!NILP (do_mouse_tracking
))
27251 if (!NILP (pointer
))
27253 if (EQ (pointer
, Qarrow
))
27254 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27255 else if (EQ (pointer
, Qhand
))
27256 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27257 else if (EQ (pointer
, Qtext
))
27258 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27259 else if (EQ (pointer
, intern ("hdrag")))
27260 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27261 #ifdef HAVE_X_WINDOWS
27262 else if (EQ (pointer
, intern ("vdrag")))
27263 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27265 else if (EQ (pointer
, intern ("hourglass")))
27266 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27267 else if (EQ (pointer
, Qmodeline
))
27268 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27270 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27273 if (cursor
!= No_Cursor
)
27274 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27277 #endif /* HAVE_WINDOW_SYSTEM */
27279 /* Take proper action when mouse has moved to the mode or header line
27280 or marginal area AREA of window W, x-position X and y-position Y.
27281 X is relative to the start of the text display area of W, so the
27282 width of bitmap areas and scroll bars must be subtracted to get a
27283 position relative to the start of the mode line. */
27286 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27287 enum window_part area
)
27289 struct window
*w
= XWINDOW (window
);
27290 struct frame
*f
= XFRAME (w
->frame
);
27291 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27292 #ifdef HAVE_WINDOW_SYSTEM
27293 Display_Info
*dpyinfo
;
27295 Cursor cursor
= No_Cursor
;
27296 Lisp_Object pointer
= Qnil
;
27297 int dx
, dy
, width
, height
;
27299 Lisp_Object string
, object
= Qnil
;
27300 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27302 Lisp_Object mouse_face
;
27303 int original_x_pixel
= x
;
27304 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27305 struct glyph_row
*row
IF_LINT (= 0);
27307 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27312 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27313 returns them in row/column units! */
27314 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27315 &object
, &dx
, &dy
, &width
, &height
);
27317 row
= (area
== ON_MODE_LINE
27318 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27319 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27321 /* Find the glyph under the mouse pointer. */
27322 if (row
->mode_line_p
&& row
->enabled_p
)
27324 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27325 end
= glyph
+ row
->used
[TEXT_AREA
];
27327 for (x0
= original_x_pixel
;
27328 glyph
< end
&& x0
>= glyph
->pixel_width
;
27330 x0
-= glyph
->pixel_width
;
27338 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27339 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27340 returns them in row/column units! */
27341 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27342 &object
, &dx
, &dy
, &width
, &height
);
27347 #ifdef HAVE_WINDOW_SYSTEM
27348 if (IMAGEP (object
))
27350 Lisp_Object image_map
, hotspot
;
27351 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27353 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27355 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27359 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27360 If so, we could look for mouse-enter, mouse-leave
27361 properties in PLIST (and do something...). */
27362 hotspot
= XCDR (hotspot
);
27363 if (CONSP (hotspot
)
27364 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27366 pointer
= Fplist_get (plist
, Qpointer
);
27367 if (NILP (pointer
))
27369 help
= Fplist_get (plist
, Qhelp_echo
);
27372 help_echo_string
= help
;
27373 XSETWINDOW (help_echo_window
, w
);
27374 help_echo_object
= w
->buffer
;
27375 help_echo_pos
= charpos
;
27379 if (NILP (pointer
))
27380 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27382 #endif /* HAVE_WINDOW_SYSTEM */
27384 if (STRINGP (string
))
27385 pos
= make_number (charpos
);
27387 /* Set the help text and mouse pointer. If the mouse is on a part
27388 of the mode line without any text (e.g. past the right edge of
27389 the mode line text), use the default help text and pointer. */
27390 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27392 /* Arrange to display the help by setting the global variables
27393 help_echo_string, help_echo_object, and help_echo_pos. */
27396 if (STRINGP (string
))
27397 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27401 help_echo_string
= help
;
27402 XSETWINDOW (help_echo_window
, w
);
27403 help_echo_object
= string
;
27404 help_echo_pos
= charpos
;
27406 else if (area
== ON_MODE_LINE
)
27408 Lisp_Object default_help
27409 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27412 if (STRINGP (default_help
))
27414 help_echo_string
= default_help
;
27415 XSETWINDOW (help_echo_window
, w
);
27416 help_echo_object
= Qnil
;
27417 help_echo_pos
= -1;
27422 #ifdef HAVE_WINDOW_SYSTEM
27423 /* Change the mouse pointer according to what is under it. */
27424 if (FRAME_WINDOW_P (f
))
27426 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27427 if (STRINGP (string
))
27429 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27431 if (NILP (pointer
))
27432 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27434 /* Change the mouse pointer according to what is under X/Y. */
27436 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27439 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27440 if (!KEYMAPP (map
))
27441 map
= Fget_text_property (pos
, Qkeymap
, string
);
27442 if (!KEYMAPP (map
))
27443 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27447 /* Default mode-line pointer. */
27448 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27453 /* Change the mouse face according to what is under X/Y. */
27454 if (STRINGP (string
))
27456 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27457 if (!NILP (mouse_face
)
27458 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27463 struct glyph
* tmp_glyph
;
27467 int total_pixel_width
;
27468 ptrdiff_t begpos
, endpos
, ignore
;
27472 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27473 Qmouse_face
, string
, Qnil
);
27479 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27481 endpos
= SCHARS (string
);
27485 /* Calculate the glyph position GPOS of GLYPH in the
27486 displayed string, relative to the beginning of the
27487 highlighted part of the string.
27489 Note: GPOS is different from CHARPOS. CHARPOS is the
27490 position of GLYPH in the internal string object. A mode
27491 line string format has structures which are converted to
27492 a flattened string by the Emacs Lisp interpreter. The
27493 internal string is an element of those structures. The
27494 displayed string is the flattened string. */
27495 tmp_glyph
= row_start_glyph
;
27496 while (tmp_glyph
< glyph
27497 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27498 && begpos
<= tmp_glyph
->charpos
27499 && tmp_glyph
->charpos
< endpos
)))
27501 gpos
= glyph
- tmp_glyph
;
27503 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27504 the highlighted part of the displayed string to which
27505 GLYPH belongs. Note: GSEQ_LENGTH is different from
27506 SCHARS (STRING), because the latter returns the length of
27507 the internal string. */
27508 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27510 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27511 && begpos
<= tmp_glyph
->charpos
27512 && tmp_glyph
->charpos
< endpos
));
27515 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27517 /* Calculate the total pixel width of all the glyphs between
27518 the beginning of the highlighted area and GLYPH. */
27519 total_pixel_width
= 0;
27520 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27521 total_pixel_width
+= tmp_glyph
->pixel_width
;
27523 /* Pre calculation of re-rendering position. Note: X is in
27524 column units here, after the call to mode_line_string or
27525 marginal_area_string. */
27527 vpos
= (area
== ON_MODE_LINE
27528 ? (w
->current_matrix
)->nrows
- 1
27531 /* If GLYPH's position is included in the region that is
27532 already drawn in mouse face, we have nothing to do. */
27533 if ( EQ (window
, hlinfo
->mouse_face_window
)
27534 && (!row
->reversed_p
27535 ? (hlinfo
->mouse_face_beg_col
<= hpos
27536 && hpos
< hlinfo
->mouse_face_end_col
)
27537 /* In R2L rows we swap BEG and END, see below. */
27538 : (hlinfo
->mouse_face_end_col
<= hpos
27539 && hpos
< hlinfo
->mouse_face_beg_col
))
27540 && hlinfo
->mouse_face_beg_row
== vpos
)
27543 if (clear_mouse_face (hlinfo
))
27544 cursor
= No_Cursor
;
27546 if (!row
->reversed_p
)
27548 hlinfo
->mouse_face_beg_col
= hpos
;
27549 hlinfo
->mouse_face_beg_x
= original_x_pixel
27550 - (total_pixel_width
+ dx
);
27551 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27552 hlinfo
->mouse_face_end_x
= 0;
27556 /* In R2L rows, show_mouse_face expects BEG and END
27557 coordinates to be swapped. */
27558 hlinfo
->mouse_face_end_col
= hpos
;
27559 hlinfo
->mouse_face_end_x
= original_x_pixel
27560 - (total_pixel_width
+ dx
);
27561 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27562 hlinfo
->mouse_face_beg_x
= 0;
27565 hlinfo
->mouse_face_beg_row
= vpos
;
27566 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27567 hlinfo
->mouse_face_beg_y
= 0;
27568 hlinfo
->mouse_face_end_y
= 0;
27569 hlinfo
->mouse_face_past_end
= 0;
27570 hlinfo
->mouse_face_window
= window
;
27572 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27578 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27580 if (NILP (pointer
))
27583 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27584 clear_mouse_face (hlinfo
);
27586 #ifdef HAVE_WINDOW_SYSTEM
27587 if (FRAME_WINDOW_P (f
))
27588 define_frame_cursor1 (f
, cursor
, pointer
);
27594 Take proper action when the mouse has moved to position X, Y on
27595 frame F as regards highlighting characters that have mouse-face
27596 properties. Also de-highlighting chars where the mouse was before.
27597 X and Y can be negative or out of range. */
27600 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27603 enum window_part part
= ON_NOTHING
;
27604 Lisp_Object window
;
27606 Cursor cursor
= No_Cursor
;
27607 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27610 /* When a menu is active, don't highlight because this looks odd. */
27611 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27612 if (popup_activated ())
27616 if (NILP (Vmouse_highlight
)
27617 || !f
->glyphs_initialized_p
27618 || f
->pointer_invisible
)
27621 hlinfo
->mouse_face_mouse_x
= x
;
27622 hlinfo
->mouse_face_mouse_y
= y
;
27623 hlinfo
->mouse_face_mouse_frame
= f
;
27625 if (hlinfo
->mouse_face_defer
)
27628 if (gc_in_progress
)
27630 hlinfo
->mouse_face_deferred_gc
= 1;
27634 /* Which window is that in? */
27635 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27637 /* If displaying active text in another window, clear that. */
27638 if (! EQ (window
, hlinfo
->mouse_face_window
)
27639 /* Also clear if we move out of text area in same window. */
27640 || (!NILP (hlinfo
->mouse_face_window
)
27643 && part
!= ON_MODE_LINE
27644 && part
!= ON_HEADER_LINE
))
27645 clear_mouse_face (hlinfo
);
27647 /* Not on a window -> return. */
27648 if (!WINDOWP (window
))
27651 /* Reset help_echo_string. It will get recomputed below. */
27652 help_echo_string
= Qnil
;
27654 /* Convert to window-relative pixel coordinates. */
27655 w
= XWINDOW (window
);
27656 frame_to_window_pixel_xy (w
, &x
, &y
);
27658 #ifdef HAVE_WINDOW_SYSTEM
27659 /* Handle tool-bar window differently since it doesn't display a
27661 if (EQ (window
, f
->tool_bar_window
))
27663 note_tool_bar_highlight (f
, x
, y
);
27668 /* Mouse is on the mode, header line or margin? */
27669 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27670 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27672 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27676 #ifdef HAVE_WINDOW_SYSTEM
27677 if (part
== ON_VERTICAL_BORDER
)
27679 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27680 help_echo_string
= build_string ("drag-mouse-1: resize");
27682 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27683 || part
== ON_SCROLL_BAR
)
27684 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27686 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27689 /* Are we in a window whose display is up to date?
27690 And verify the buffer's text has not changed. */
27691 b
= XBUFFER (w
->buffer
);
27692 if (part
== ON_TEXT
27693 && EQ (w
->window_end_valid
, w
->buffer
)
27694 && w
->last_modified
== BUF_MODIFF (b
)
27695 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27697 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27699 struct glyph
*glyph
;
27700 Lisp_Object object
;
27701 Lisp_Object mouse_face
= Qnil
, position
;
27702 Lisp_Object
*overlay_vec
= NULL
;
27703 ptrdiff_t i
, noverlays
;
27704 struct buffer
*obuf
;
27705 ptrdiff_t obegv
, ozv
;
27708 /* Find the glyph under X/Y. */
27709 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27711 #ifdef HAVE_WINDOW_SYSTEM
27712 /* Look for :pointer property on image. */
27713 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27715 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27716 if (img
!= NULL
&& IMAGEP (img
->spec
))
27718 Lisp_Object image_map
, hotspot
;
27719 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27721 && (hotspot
= find_hot_spot (image_map
,
27722 glyph
->slice
.img
.x
+ dx
,
27723 glyph
->slice
.img
.y
+ dy
),
27725 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27729 /* Could check XCAR (hotspot) to see if we enter/leave
27731 If so, we could look for mouse-enter, mouse-leave
27732 properties in PLIST (and do something...). */
27733 hotspot
= XCDR (hotspot
);
27734 if (CONSP (hotspot
)
27735 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27737 pointer
= Fplist_get (plist
, Qpointer
);
27738 if (NILP (pointer
))
27740 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27741 if (!NILP (help_echo_string
))
27743 help_echo_window
= window
;
27744 help_echo_object
= glyph
->object
;
27745 help_echo_pos
= glyph
->charpos
;
27749 if (NILP (pointer
))
27750 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27753 #endif /* HAVE_WINDOW_SYSTEM */
27755 /* Clear mouse face if X/Y not over text. */
27757 || area
!= TEXT_AREA
27758 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27759 /* Glyph's OBJECT is an integer for glyphs inserted by the
27760 display engine for its internal purposes, like truncation
27761 and continuation glyphs and blanks beyond the end of
27762 line's text on text terminals. If we are over such a
27763 glyph, we are not over any text. */
27764 || INTEGERP (glyph
->object
)
27765 /* R2L rows have a stretch glyph at their front, which
27766 stands for no text, whereas L2R rows have no glyphs at
27767 all beyond the end of text. Treat such stretch glyphs
27768 like we do with NULL glyphs in L2R rows. */
27769 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27770 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27771 && glyph
->type
== STRETCH_GLYPH
27772 && glyph
->avoid_cursor_p
))
27774 if (clear_mouse_face (hlinfo
))
27775 cursor
= No_Cursor
;
27776 #ifdef HAVE_WINDOW_SYSTEM
27777 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27779 if (area
!= TEXT_AREA
)
27780 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27782 pointer
= Vvoid_text_area_pointer
;
27788 pos
= glyph
->charpos
;
27789 object
= glyph
->object
;
27790 if (!STRINGP (object
) && !BUFFERP (object
))
27793 /* If we get an out-of-range value, return now; avoid an error. */
27794 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27797 /* Make the window's buffer temporarily current for
27798 overlays_at and compute_char_face. */
27799 obuf
= current_buffer
;
27800 current_buffer
= b
;
27806 /* Is this char mouse-active or does it have help-echo? */
27807 position
= make_number (pos
);
27809 if (BUFFERP (object
))
27811 /* Put all the overlays we want in a vector in overlay_vec. */
27812 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27813 /* Sort overlays into increasing priority order. */
27814 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27819 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27822 cursor
= No_Cursor
;
27824 /* Check mouse-face highlighting. */
27826 /* If there exists an overlay with mouse-face overlapping
27827 the one we are currently highlighting, we have to
27828 check if we enter the overlapping overlay, and then
27829 highlight only that. */
27830 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27831 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27833 /* Find the highest priority overlay with a mouse-face. */
27834 Lisp_Object overlay
= Qnil
;
27835 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27837 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27838 if (!NILP (mouse_face
))
27839 overlay
= overlay_vec
[i
];
27842 /* If we're highlighting the same overlay as before, there's
27843 no need to do that again. */
27844 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27845 goto check_help_echo
;
27846 hlinfo
->mouse_face_overlay
= overlay
;
27848 /* Clear the display of the old active region, if any. */
27849 if (clear_mouse_face (hlinfo
))
27850 cursor
= No_Cursor
;
27852 /* If no overlay applies, get a text property. */
27853 if (NILP (overlay
))
27854 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27856 /* Next, compute the bounds of the mouse highlighting and
27858 if (!NILP (mouse_face
) && STRINGP (object
))
27860 /* The mouse-highlighting comes from a display string
27861 with a mouse-face. */
27865 s
= Fprevious_single_property_change
27866 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27867 e
= Fnext_single_property_change
27868 (position
, Qmouse_face
, object
, Qnil
);
27870 s
= make_number (0);
27872 e
= make_number (SCHARS (object
) - 1);
27873 mouse_face_from_string_pos (w
, hlinfo
, object
,
27874 XINT (s
), XINT (e
));
27875 hlinfo
->mouse_face_past_end
= 0;
27876 hlinfo
->mouse_face_window
= window
;
27877 hlinfo
->mouse_face_face_id
27878 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27879 glyph
->face_id
, 1);
27880 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27881 cursor
= No_Cursor
;
27885 /* The mouse-highlighting, if any, comes from an overlay
27886 or text property in the buffer. */
27887 Lisp_Object buffer
IF_LINT (= Qnil
);
27888 Lisp_Object disp_string
IF_LINT (= Qnil
);
27890 if (STRINGP (object
))
27892 /* If we are on a display string with no mouse-face,
27893 check if the text under it has one. */
27894 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27895 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27896 pos
= string_buffer_position (object
, start
);
27899 mouse_face
= get_char_property_and_overlay
27900 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27901 buffer
= w
->buffer
;
27902 disp_string
= object
;
27908 disp_string
= Qnil
;
27911 if (!NILP (mouse_face
))
27913 Lisp_Object before
, after
;
27914 Lisp_Object before_string
, after_string
;
27915 /* To correctly find the limits of mouse highlight
27916 in a bidi-reordered buffer, we must not use the
27917 optimization of limiting the search in
27918 previous-single-property-change and
27919 next-single-property-change, because
27920 rows_from_pos_range needs the real start and end
27921 positions to DTRT in this case. That's because
27922 the first row visible in a window does not
27923 necessarily display the character whose position
27924 is the smallest. */
27926 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27927 ? Fmarker_position (w
->start
)
27930 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27931 ? make_number (BUF_Z (XBUFFER (buffer
))
27932 - XFASTINT (w
->window_end_pos
))
27935 if (NILP (overlay
))
27937 /* Handle the text property case. */
27938 before
= Fprevious_single_property_change
27939 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27940 after
= Fnext_single_property_change
27941 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27942 before_string
= after_string
= Qnil
;
27946 /* Handle the overlay case. */
27947 before
= Foverlay_start (overlay
);
27948 after
= Foverlay_end (overlay
);
27949 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27950 after_string
= Foverlay_get (overlay
, Qafter_string
);
27952 if (!STRINGP (before_string
)) before_string
= Qnil
;
27953 if (!STRINGP (after_string
)) after_string
= Qnil
;
27956 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27959 : XFASTINT (before
),
27961 ? BUF_Z (XBUFFER (buffer
))
27962 : XFASTINT (after
),
27963 before_string
, after_string
,
27965 cursor
= No_Cursor
;
27972 /* Look for a `help-echo' property. */
27973 if (NILP (help_echo_string
)) {
27974 Lisp_Object help
, overlay
;
27976 /* Check overlays first. */
27977 help
= overlay
= Qnil
;
27978 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27980 overlay
= overlay_vec
[i
];
27981 help
= Foverlay_get (overlay
, Qhelp_echo
);
27986 help_echo_string
= help
;
27987 help_echo_window
= window
;
27988 help_echo_object
= overlay
;
27989 help_echo_pos
= pos
;
27993 Lisp_Object obj
= glyph
->object
;
27994 ptrdiff_t charpos
= glyph
->charpos
;
27996 /* Try text properties. */
27999 && charpos
< SCHARS (obj
))
28001 help
= Fget_text_property (make_number (charpos
),
28005 /* If the string itself doesn't specify a help-echo,
28006 see if the buffer text ``under'' it does. */
28007 struct glyph_row
*r
28008 = MATRIX_ROW (w
->current_matrix
, vpos
);
28009 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28010 ptrdiff_t p
= string_buffer_position (obj
, start
);
28013 help
= Fget_char_property (make_number (p
),
28014 Qhelp_echo
, w
->buffer
);
28023 else if (BUFFERP (obj
)
28026 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28031 help_echo_string
= help
;
28032 help_echo_window
= window
;
28033 help_echo_object
= obj
;
28034 help_echo_pos
= charpos
;
28039 #ifdef HAVE_WINDOW_SYSTEM
28040 /* Look for a `pointer' property. */
28041 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28043 /* Check overlays first. */
28044 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28045 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28047 if (NILP (pointer
))
28049 Lisp_Object obj
= glyph
->object
;
28050 ptrdiff_t charpos
= glyph
->charpos
;
28052 /* Try text properties. */
28055 && charpos
< SCHARS (obj
))
28057 pointer
= Fget_text_property (make_number (charpos
),
28059 if (NILP (pointer
))
28061 /* If the string itself doesn't specify a pointer,
28062 see if the buffer text ``under'' it does. */
28063 struct glyph_row
*r
28064 = MATRIX_ROW (w
->current_matrix
, vpos
);
28065 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28066 ptrdiff_t p
= string_buffer_position (obj
, start
);
28068 pointer
= Fget_char_property (make_number (p
),
28069 Qpointer
, w
->buffer
);
28072 else if (BUFFERP (obj
)
28075 pointer
= Fget_text_property (make_number (charpos
),
28079 #endif /* HAVE_WINDOW_SYSTEM */
28083 current_buffer
= obuf
;
28088 #ifdef HAVE_WINDOW_SYSTEM
28089 if (FRAME_WINDOW_P (f
))
28090 define_frame_cursor1 (f
, cursor
, pointer
);
28092 /* This is here to prevent a compiler error, about "label at end of
28093 compound statement". */
28100 Clear any mouse-face on window W. This function is part of the
28101 redisplay interface, and is called from try_window_id and similar
28102 functions to ensure the mouse-highlight is off. */
28105 x_clear_window_mouse_face (struct window
*w
)
28107 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28108 Lisp_Object window
;
28111 XSETWINDOW (window
, w
);
28112 if (EQ (window
, hlinfo
->mouse_face_window
))
28113 clear_mouse_face (hlinfo
);
28119 Just discard the mouse face information for frame F, if any.
28120 This is used when the size of F is changed. */
28123 cancel_mouse_face (struct frame
*f
)
28125 Lisp_Object window
;
28126 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28128 window
= hlinfo
->mouse_face_window
;
28129 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28131 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28132 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28133 hlinfo
->mouse_face_window
= Qnil
;
28139 /***********************************************************************
28141 ***********************************************************************/
28143 #ifdef HAVE_WINDOW_SYSTEM
28145 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28146 which intersects rectangle R. R is in window-relative coordinates. */
28149 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28150 enum glyph_row_area area
)
28152 struct glyph
*first
= row
->glyphs
[area
];
28153 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28154 struct glyph
*last
;
28155 int first_x
, start_x
, x
;
28157 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28158 /* If row extends face to end of line write the whole line. */
28159 draw_glyphs (w
, 0, row
, area
,
28160 0, row
->used
[area
],
28161 DRAW_NORMAL_TEXT
, 0);
28164 /* Set START_X to the window-relative start position for drawing glyphs of
28165 AREA. The first glyph of the text area can be partially visible.
28166 The first glyphs of other areas cannot. */
28167 start_x
= window_box_left_offset (w
, area
);
28169 if (area
== TEXT_AREA
)
28172 /* Find the first glyph that must be redrawn. */
28174 && x
+ first
->pixel_width
< r
->x
)
28176 x
+= first
->pixel_width
;
28180 /* Find the last one. */
28184 && x
< r
->x
+ r
->width
)
28186 x
+= last
->pixel_width
;
28192 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28193 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28194 DRAW_NORMAL_TEXT
, 0);
28199 /* Redraw the parts of the glyph row ROW on window W intersecting
28200 rectangle R. R is in window-relative coordinates. Value is
28201 non-zero if mouse-face was overwritten. */
28204 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28206 eassert (row
->enabled_p
);
28208 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28209 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28210 0, row
->used
[TEXT_AREA
],
28211 DRAW_NORMAL_TEXT
, 0);
28214 if (row
->used
[LEFT_MARGIN_AREA
])
28215 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28216 if (row
->used
[TEXT_AREA
])
28217 expose_area (w
, row
, r
, TEXT_AREA
);
28218 if (row
->used
[RIGHT_MARGIN_AREA
])
28219 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28220 draw_row_fringe_bitmaps (w
, row
);
28223 return row
->mouse_face_p
;
28227 /* Redraw those parts of glyphs rows during expose event handling that
28228 overlap other rows. Redrawing of an exposed line writes over parts
28229 of lines overlapping that exposed line; this function fixes that.
28231 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28232 row in W's current matrix that is exposed and overlaps other rows.
28233 LAST_OVERLAPPING_ROW is the last such row. */
28236 expose_overlaps (struct window
*w
,
28237 struct glyph_row
*first_overlapping_row
,
28238 struct glyph_row
*last_overlapping_row
,
28241 struct glyph_row
*row
;
28243 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28244 if (row
->overlapping_p
)
28246 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28249 if (row
->used
[LEFT_MARGIN_AREA
])
28250 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28252 if (row
->used
[TEXT_AREA
])
28253 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28255 if (row
->used
[RIGHT_MARGIN_AREA
])
28256 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28262 /* Return non-zero if W's cursor intersects rectangle R. */
28265 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28267 XRectangle cr
, result
;
28268 struct glyph
*cursor_glyph
;
28269 struct glyph_row
*row
;
28271 if (w
->phys_cursor
.vpos
>= 0
28272 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28273 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28275 && row
->cursor_in_fringe_p
)
28277 /* Cursor is in the fringe. */
28278 cr
.x
= window_box_right_offset (w
,
28279 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28280 ? RIGHT_MARGIN_AREA
28283 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28284 cr
.height
= row
->height
;
28285 return x_intersect_rectangles (&cr
, r
, &result
);
28288 cursor_glyph
= get_phys_cursor_glyph (w
);
28291 /* r is relative to W's box, but w->phys_cursor.x is relative
28292 to left edge of W's TEXT area. Adjust it. */
28293 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28294 cr
.y
= w
->phys_cursor
.y
;
28295 cr
.width
= cursor_glyph
->pixel_width
;
28296 cr
.height
= w
->phys_cursor_height
;
28297 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28298 I assume the effect is the same -- and this is portable. */
28299 return x_intersect_rectangles (&cr
, r
, &result
);
28301 /* If we don't understand the format, pretend we're not in the hot-spot. */
28307 Draw a vertical window border to the right of window W if W doesn't
28308 have vertical scroll bars. */
28311 x_draw_vertical_border (struct window
*w
)
28313 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28315 /* We could do better, if we knew what type of scroll-bar the adjacent
28316 windows (on either side) have... But we don't :-(
28317 However, I think this works ok. ++KFS 2003-04-25 */
28319 /* Redraw borders between horizontally adjacent windows. Don't
28320 do it for frames with vertical scroll bars because either the
28321 right scroll bar of a window, or the left scroll bar of its
28322 neighbor will suffice as a border. */
28323 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28326 if (!WINDOW_RIGHTMOST_P (w
)
28327 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28329 int x0
, x1
, y0
, y1
;
28331 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28334 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28337 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28339 else if (!WINDOW_LEFTMOST_P (w
)
28340 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28342 int x0
, x1
, y0
, y1
;
28344 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28347 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28350 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28355 /* Redraw the part of window W intersection rectangle FR. Pixel
28356 coordinates in FR are frame-relative. Call this function with
28357 input blocked. Value is non-zero if the exposure overwrites
28361 expose_window (struct window
*w
, XRectangle
*fr
)
28363 struct frame
*f
= XFRAME (w
->frame
);
28365 int mouse_face_overwritten_p
= 0;
28367 /* If window is not yet fully initialized, do nothing. This can
28368 happen when toolkit scroll bars are used and a window is split.
28369 Reconfiguring the scroll bar will generate an expose for a newly
28371 if (w
->current_matrix
== NULL
)
28374 /* When we're currently updating the window, display and current
28375 matrix usually don't agree. Arrange for a thorough display
28377 if (w
== updated_window
)
28379 SET_FRAME_GARBAGED (f
);
28383 /* Frame-relative pixel rectangle of W. */
28384 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28385 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28386 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28387 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28389 if (x_intersect_rectangles (fr
, &wr
, &r
))
28391 int yb
= window_text_bottom_y (w
);
28392 struct glyph_row
*row
;
28393 int cursor_cleared_p
, phys_cursor_on_p
;
28394 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28396 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28397 r
.x
, r
.y
, r
.width
, r
.height
));
28399 /* Convert to window coordinates. */
28400 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28401 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28403 /* Turn off the cursor. */
28404 if (!w
->pseudo_window_p
28405 && phys_cursor_in_rect_p (w
, &r
))
28407 x_clear_cursor (w
);
28408 cursor_cleared_p
= 1;
28411 cursor_cleared_p
= 0;
28413 /* If the row containing the cursor extends face to end of line,
28414 then expose_area might overwrite the cursor outside the
28415 rectangle and thus notice_overwritten_cursor might clear
28416 w->phys_cursor_on_p. We remember the original value and
28417 check later if it is changed. */
28418 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28420 /* Update lines intersecting rectangle R. */
28421 first_overlapping_row
= last_overlapping_row
= NULL
;
28422 for (row
= w
->current_matrix
->rows
;
28427 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28429 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28430 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28431 || (r
.y
>= y0
&& r
.y
< y1
)
28432 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28434 /* A header line may be overlapping, but there is no need
28435 to fix overlapping areas for them. KFS 2005-02-12 */
28436 if (row
->overlapping_p
&& !row
->mode_line_p
)
28438 if (first_overlapping_row
== NULL
)
28439 first_overlapping_row
= row
;
28440 last_overlapping_row
= row
;
28444 if (expose_line (w
, row
, &r
))
28445 mouse_face_overwritten_p
= 1;
28448 else if (row
->overlapping_p
)
28450 /* We must redraw a row overlapping the exposed area. */
28452 ? y0
+ row
->phys_height
> r
.y
28453 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28455 if (first_overlapping_row
== NULL
)
28456 first_overlapping_row
= row
;
28457 last_overlapping_row
= row
;
28465 /* Display the mode line if there is one. */
28466 if (WINDOW_WANTS_MODELINE_P (w
)
28467 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28469 && row
->y
< r
.y
+ r
.height
)
28471 if (expose_line (w
, row
, &r
))
28472 mouse_face_overwritten_p
= 1;
28475 if (!w
->pseudo_window_p
)
28477 /* Fix the display of overlapping rows. */
28478 if (first_overlapping_row
)
28479 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28482 /* Draw border between windows. */
28483 x_draw_vertical_border (w
);
28485 /* Turn the cursor on again. */
28486 if (cursor_cleared_p
28487 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28488 update_window_cursor (w
, 1);
28492 return mouse_face_overwritten_p
;
28497 /* Redraw (parts) of all windows in the window tree rooted at W that
28498 intersect R. R contains frame pixel coordinates. Value is
28499 non-zero if the exposure overwrites mouse-face. */
28502 expose_window_tree (struct window
*w
, XRectangle
*r
)
28504 struct frame
*f
= XFRAME (w
->frame
);
28505 int mouse_face_overwritten_p
= 0;
28507 while (w
&& !FRAME_GARBAGED_P (f
))
28509 if (!NILP (w
->hchild
))
28510 mouse_face_overwritten_p
28511 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28512 else if (!NILP (w
->vchild
))
28513 mouse_face_overwritten_p
28514 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28516 mouse_face_overwritten_p
|= expose_window (w
, r
);
28518 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28521 return mouse_face_overwritten_p
;
28526 Redisplay an exposed area of frame F. X and Y are the upper-left
28527 corner of the exposed rectangle. W and H are width and height of
28528 the exposed area. All are pixel values. W or H zero means redraw
28529 the entire frame. */
28532 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28535 int mouse_face_overwritten_p
= 0;
28537 TRACE ((stderr
, "expose_frame "));
28539 /* No need to redraw if frame will be redrawn soon. */
28540 if (FRAME_GARBAGED_P (f
))
28542 TRACE ((stderr
, " garbaged\n"));
28546 /* If basic faces haven't been realized yet, there is no point in
28547 trying to redraw anything. This can happen when we get an expose
28548 event while Emacs is starting, e.g. by moving another window. */
28549 if (FRAME_FACE_CACHE (f
) == NULL
28550 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28552 TRACE ((stderr
, " no faces\n"));
28556 if (w
== 0 || h
== 0)
28559 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28560 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28570 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28571 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28573 if (WINDOWP (f
->tool_bar_window
))
28574 mouse_face_overwritten_p
28575 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28577 #ifdef HAVE_X_WINDOWS
28579 #ifndef USE_X_TOOLKIT
28580 if (WINDOWP (f
->menu_bar_window
))
28581 mouse_face_overwritten_p
28582 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28583 #endif /* not USE_X_TOOLKIT */
28587 /* Some window managers support a focus-follows-mouse style with
28588 delayed raising of frames. Imagine a partially obscured frame,
28589 and moving the mouse into partially obscured mouse-face on that
28590 frame. The visible part of the mouse-face will be highlighted,
28591 then the WM raises the obscured frame. With at least one WM, KDE
28592 2.1, Emacs is not getting any event for the raising of the frame
28593 (even tried with SubstructureRedirectMask), only Expose events.
28594 These expose events will draw text normally, i.e. not
28595 highlighted. Which means we must redo the highlight here.
28596 Subsume it under ``we love X''. --gerd 2001-08-15 */
28597 /* Included in Windows version because Windows most likely does not
28598 do the right thing if any third party tool offers
28599 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28600 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28603 if (f
== hlinfo
->mouse_face_mouse_frame
)
28605 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28606 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28607 clear_mouse_face (hlinfo
);
28608 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28615 Determine the intersection of two rectangles R1 and R2. Return
28616 the intersection in *RESULT. Value is non-zero if RESULT is not
28620 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28622 XRectangle
*left
, *right
;
28623 XRectangle
*upper
, *lower
;
28624 int intersection_p
= 0;
28626 /* Rearrange so that R1 is the left-most rectangle. */
28628 left
= r1
, right
= r2
;
28630 left
= r2
, right
= r1
;
28632 /* X0 of the intersection is right.x0, if this is inside R1,
28633 otherwise there is no intersection. */
28634 if (right
->x
<= left
->x
+ left
->width
)
28636 result
->x
= right
->x
;
28638 /* The right end of the intersection is the minimum of
28639 the right ends of left and right. */
28640 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28643 /* Same game for Y. */
28645 upper
= r1
, lower
= r2
;
28647 upper
= r2
, lower
= r1
;
28649 /* The upper end of the intersection is lower.y0, if this is inside
28650 of upper. Otherwise, there is no intersection. */
28651 if (lower
->y
<= upper
->y
+ upper
->height
)
28653 result
->y
= lower
->y
;
28655 /* The lower end of the intersection is the minimum of the lower
28656 ends of upper and lower. */
28657 result
->height
= (min (lower
->y
+ lower
->height
,
28658 upper
->y
+ upper
->height
)
28660 intersection_p
= 1;
28664 return intersection_p
;
28667 #endif /* HAVE_WINDOW_SYSTEM */
28670 /***********************************************************************
28672 ***********************************************************************/
28675 syms_of_xdisp (void)
28677 Vwith_echo_area_save_vector
= Qnil
;
28678 staticpro (&Vwith_echo_area_save_vector
);
28680 Vmessage_stack
= Qnil
;
28681 staticpro (&Vmessage_stack
);
28683 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28685 message_dolog_marker1
= Fmake_marker ();
28686 staticpro (&message_dolog_marker1
);
28687 message_dolog_marker2
= Fmake_marker ();
28688 staticpro (&message_dolog_marker2
);
28689 message_dolog_marker3
= Fmake_marker ();
28690 staticpro (&message_dolog_marker3
);
28693 defsubr (&Sdump_frame_glyph_matrix
);
28694 defsubr (&Sdump_glyph_matrix
);
28695 defsubr (&Sdump_glyph_row
);
28696 defsubr (&Sdump_tool_bar_row
);
28697 defsubr (&Strace_redisplay
);
28698 defsubr (&Strace_to_stderr
);
28700 #ifdef HAVE_WINDOW_SYSTEM
28701 defsubr (&Stool_bar_lines_needed
);
28702 defsubr (&Slookup_image_map
);
28704 defsubr (&Sformat_mode_line
);
28705 defsubr (&Sinvisible_p
);
28706 defsubr (&Scurrent_bidi_paragraph_direction
);
28708 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28709 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28710 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28711 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28712 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28713 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28714 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28715 DEFSYM (Qeval
, "eval");
28716 DEFSYM (QCdata
, ":data");
28717 DEFSYM (Qdisplay
, "display");
28718 DEFSYM (Qspace_width
, "space-width");
28719 DEFSYM (Qraise
, "raise");
28720 DEFSYM (Qslice
, "slice");
28721 DEFSYM (Qspace
, "space");
28722 DEFSYM (Qmargin
, "margin");
28723 DEFSYM (Qpointer
, "pointer");
28724 DEFSYM (Qleft_margin
, "left-margin");
28725 DEFSYM (Qright_margin
, "right-margin");
28726 DEFSYM (Qcenter
, "center");
28727 DEFSYM (Qline_height
, "line-height");
28728 DEFSYM (QCalign_to
, ":align-to");
28729 DEFSYM (QCrelative_width
, ":relative-width");
28730 DEFSYM (QCrelative_height
, ":relative-height");
28731 DEFSYM (QCeval
, ":eval");
28732 DEFSYM (QCpropertize
, ":propertize");
28733 DEFSYM (QCfile
, ":file");
28734 DEFSYM (Qfontified
, "fontified");
28735 DEFSYM (Qfontification_functions
, "fontification-functions");
28736 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28737 DEFSYM (Qescape_glyph
, "escape-glyph");
28738 DEFSYM (Qnobreak_space
, "nobreak-space");
28739 DEFSYM (Qimage
, "image");
28740 DEFSYM (Qtext
, "text");
28741 DEFSYM (Qboth
, "both");
28742 DEFSYM (Qboth_horiz
, "both-horiz");
28743 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28744 DEFSYM (QCmap
, ":map");
28745 DEFSYM (QCpointer
, ":pointer");
28746 DEFSYM (Qrect
, "rect");
28747 DEFSYM (Qcircle
, "circle");
28748 DEFSYM (Qpoly
, "poly");
28749 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28750 DEFSYM (Qgrow_only
, "grow-only");
28751 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28752 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28753 DEFSYM (Qposition
, "position");
28754 DEFSYM (Qbuffer_position
, "buffer-position");
28755 DEFSYM (Qobject
, "object");
28756 DEFSYM (Qbar
, "bar");
28757 DEFSYM (Qhbar
, "hbar");
28758 DEFSYM (Qbox
, "box");
28759 DEFSYM (Qhollow
, "hollow");
28760 DEFSYM (Qhand
, "hand");
28761 DEFSYM (Qarrow
, "arrow");
28762 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28764 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28765 Fcons (intern_c_string ("void-variable"), Qnil
)),
28767 staticpro (&list_of_error
);
28769 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28770 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28771 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28772 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28774 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28775 staticpro (&echo_buffer
[0]);
28776 staticpro (&echo_buffer
[1]);
28778 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28779 staticpro (&echo_area_buffer
[0]);
28780 staticpro (&echo_area_buffer
[1]);
28782 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28783 staticpro (&Vmessages_buffer_name
);
28785 mode_line_proptrans_alist
= Qnil
;
28786 staticpro (&mode_line_proptrans_alist
);
28787 mode_line_string_list
= Qnil
;
28788 staticpro (&mode_line_string_list
);
28789 mode_line_string_face
= Qnil
;
28790 staticpro (&mode_line_string_face
);
28791 mode_line_string_face_prop
= Qnil
;
28792 staticpro (&mode_line_string_face_prop
);
28793 Vmode_line_unwind_vector
= Qnil
;
28794 staticpro (&Vmode_line_unwind_vector
);
28796 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28798 help_echo_string
= Qnil
;
28799 staticpro (&help_echo_string
);
28800 help_echo_object
= Qnil
;
28801 staticpro (&help_echo_object
);
28802 help_echo_window
= Qnil
;
28803 staticpro (&help_echo_window
);
28804 previous_help_echo_string
= Qnil
;
28805 staticpro (&previous_help_echo_string
);
28806 help_echo_pos
= -1;
28808 DEFSYM (Qright_to_left
, "right-to-left");
28809 DEFSYM (Qleft_to_right
, "left-to-right");
28811 #ifdef HAVE_WINDOW_SYSTEM
28812 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28813 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28814 For example, if a block cursor is over a tab, it will be drawn as
28815 wide as that tab on the display. */);
28816 x_stretch_cursor_p
= 0;
28819 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28820 doc
: /* Non-nil means highlight trailing whitespace.
28821 The face used for trailing whitespace is `trailing-whitespace'. */);
28822 Vshow_trailing_whitespace
= Qnil
;
28824 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28825 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28826 If the value is t, Emacs highlights non-ASCII chars which have the
28827 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28828 or `escape-glyph' face respectively.
28830 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28831 U+2011 (non-breaking hyphen) are affected.
28833 Any other non-nil value means to display these characters as a escape
28834 glyph followed by an ordinary space or hyphen.
28836 A value of nil means no special handling of these characters. */);
28837 Vnobreak_char_display
= Qt
;
28839 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28840 doc
: /* The pointer shape to show in void text areas.
28841 A value of nil means to show the text pointer. Other options are `arrow',
28842 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28843 Vvoid_text_area_pointer
= Qarrow
;
28845 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28846 doc
: /* Non-nil means don't actually do any redisplay.
28847 This is used for internal purposes. */);
28848 Vinhibit_redisplay
= Qnil
;
28850 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28851 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28852 Vglobal_mode_string
= Qnil
;
28854 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28855 doc
: /* Marker for where to display an arrow on top of the buffer text.
28856 This must be the beginning of a line in order to work.
28857 See also `overlay-arrow-string'. */);
28858 Voverlay_arrow_position
= Qnil
;
28860 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28861 doc
: /* String to display as an arrow in non-window frames.
28862 See also `overlay-arrow-position'. */);
28863 Voverlay_arrow_string
= build_pure_c_string ("=>");
28865 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28866 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28867 The symbols on this list are examined during redisplay to determine
28868 where to display overlay arrows. */);
28869 Voverlay_arrow_variable_list
28870 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28872 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28873 doc
: /* The number of lines to try scrolling a window by when point moves out.
28874 If that fails to bring point back on frame, point is centered instead.
28875 If this is zero, point is always centered after it moves off frame.
28876 If you want scrolling to always be a line at a time, you should set
28877 `scroll-conservatively' to a large value rather than set this to 1. */);
28879 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28880 doc
: /* Scroll up to this many lines, to bring point back on screen.
28881 If point moves off-screen, redisplay will scroll by up to
28882 `scroll-conservatively' lines in order to bring point just barely
28883 onto the screen again. If that cannot be done, then redisplay
28884 recenters point as usual.
28886 If the value is greater than 100, redisplay will never recenter point,
28887 but will always scroll just enough text to bring point into view, even
28888 if you move far away.
28890 A value of zero means always recenter point if it moves off screen. */);
28891 scroll_conservatively
= 0;
28893 DEFVAR_INT ("scroll-margin", scroll_margin
,
28894 doc
: /* Number of lines of margin at the top and bottom of a window.
28895 Recenter the window whenever point gets within this many lines
28896 of the top or bottom of the window. */);
28899 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28900 doc
: /* Pixels per inch value for non-window system displays.
28901 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28902 Vdisplay_pixels_per_inch
= make_float (72.0);
28905 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28908 DEFVAR_LISP ("truncate-partial-width-windows",
28909 Vtruncate_partial_width_windows
,
28910 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28911 For an integer value, truncate lines in each window narrower than the
28912 full frame width, provided the window width is less than that integer;
28913 otherwise, respect the value of `truncate-lines'.
28915 For any other non-nil value, truncate lines in all windows that do
28916 not span the full frame width.
28918 A value of nil means to respect the value of `truncate-lines'.
28920 If `word-wrap' is enabled, you might want to reduce this. */);
28921 Vtruncate_partial_width_windows
= make_number (50);
28923 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28924 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28925 Any other value means to use the appropriate face, `mode-line',
28926 `header-line', or `menu' respectively. */);
28927 mode_line_inverse_video
= 1;
28929 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28930 doc
: /* Maximum buffer size for which line number should be displayed.
28931 If the buffer is bigger than this, the line number does not appear
28932 in the mode line. A value of nil means no limit. */);
28933 Vline_number_display_limit
= Qnil
;
28935 DEFVAR_INT ("line-number-display-limit-width",
28936 line_number_display_limit_width
,
28937 doc
: /* Maximum line width (in characters) for line number display.
28938 If the average length of the lines near point is bigger than this, then the
28939 line number may be omitted from the mode line. */);
28940 line_number_display_limit_width
= 200;
28942 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28943 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28944 highlight_nonselected_windows
= 0;
28946 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28947 doc
: /* Non-nil if more than one frame is visible on this display.
28948 Minibuffer-only frames don't count, but iconified frames do.
28949 This variable is not guaranteed to be accurate except while processing
28950 `frame-title-format' and `icon-title-format'. */);
28952 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28953 doc
: /* Template for displaying the title bar of visible frames.
28954 \(Assuming the window manager supports this feature.)
28956 This variable has the same structure as `mode-line-format', except that
28957 the %c and %l constructs are ignored. It is used only on frames for
28958 which no explicit name has been set \(see `modify-frame-parameters'). */);
28960 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28961 doc
: /* Template for displaying the title bar of an iconified frame.
28962 \(Assuming the window manager supports this feature.)
28963 This variable has the same structure as `mode-line-format' (which see),
28964 and is used only on frames for which no explicit name has been set
28965 \(see `modify-frame-parameters'). */);
28967 = Vframe_title_format
28968 = listn (CONSTYPE_PURE
, 3,
28969 intern_c_string ("multiple-frames"),
28970 build_pure_c_string ("%b"),
28971 listn (CONSTYPE_PURE
, 4,
28972 empty_unibyte_string
,
28973 intern_c_string ("invocation-name"),
28974 build_pure_c_string ("@"),
28975 intern_c_string ("system-name")));
28977 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28978 doc
: /* Maximum number of lines to keep in the message log buffer.
28979 If nil, disable message logging. If t, log messages but don't truncate
28980 the buffer when it becomes large. */);
28981 Vmessage_log_max
= make_number (100);
28983 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28984 doc
: /* Functions called before redisplay, if window sizes have changed.
28985 The value should be a list of functions that take one argument.
28986 Just before redisplay, for each frame, if any of its windows have changed
28987 size since the last redisplay, or have been split or deleted,
28988 all the functions in the list are called, with the frame as argument. */);
28989 Vwindow_size_change_functions
= Qnil
;
28991 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28992 doc
: /* List of functions to call before redisplaying a window with scrolling.
28993 Each function is called with two arguments, the window and its new
28994 display-start position. Note that these functions are also called by
28995 `set-window-buffer'. Also note that the value of `window-end' is not
28996 valid when these functions are called.
28998 Warning: Do not use this feature to alter the way the window
28999 is scrolled. It is not designed for that, and such use probably won't
29001 Vwindow_scroll_functions
= Qnil
;
29003 DEFVAR_LISP ("window-text-change-functions",
29004 Vwindow_text_change_functions
,
29005 doc
: /* Functions to call in redisplay when text in the window might change. */);
29006 Vwindow_text_change_functions
= Qnil
;
29008 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29009 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29010 Each function is called with two arguments, the window and the end trigger value.
29011 See `set-window-redisplay-end-trigger'. */);
29012 Vredisplay_end_trigger_functions
= Qnil
;
29014 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29015 doc
: /* Non-nil means autoselect window with mouse pointer.
29016 If nil, do not autoselect windows.
29017 A positive number means delay autoselection by that many seconds: a
29018 window is autoselected only after the mouse has remained in that
29019 window for the duration of the delay.
29020 A negative number has a similar effect, but causes windows to be
29021 autoselected only after the mouse has stopped moving. \(Because of
29022 the way Emacs compares mouse events, you will occasionally wait twice
29023 that time before the window gets selected.\)
29024 Any other value means to autoselect window instantaneously when the
29025 mouse pointer enters it.
29027 Autoselection selects the minibuffer only if it is active, and never
29028 unselects the minibuffer if it is active.
29030 When customizing this variable make sure that the actual value of
29031 `focus-follows-mouse' matches the behavior of your window manager. */);
29032 Vmouse_autoselect_window
= Qnil
;
29034 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29035 doc
: /* Non-nil means automatically resize tool-bars.
29036 This dynamically changes the tool-bar's height to the minimum height
29037 that is needed to make all tool-bar items visible.
29038 If value is `grow-only', the tool-bar's height is only increased
29039 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29040 Vauto_resize_tool_bars
= Qt
;
29042 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29043 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29044 auto_raise_tool_bar_buttons_p
= 1;
29046 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29047 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29048 make_cursor_line_fully_visible_p
= 1;
29050 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29051 doc
: /* Border below tool-bar in pixels.
29052 If an integer, use it as the height of the border.
29053 If it is one of `internal-border-width' or `border-width', use the
29054 value of the corresponding frame parameter.
29055 Otherwise, no border is added below the tool-bar. */);
29056 Vtool_bar_border
= Qinternal_border_width
;
29058 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29059 doc
: /* Margin around tool-bar buttons in pixels.
29060 If an integer, use that for both horizontal and vertical margins.
29061 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29062 HORZ specifying the horizontal margin, and VERT specifying the
29063 vertical margin. */);
29064 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29066 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29067 doc
: /* Relief thickness of tool-bar buttons. */);
29068 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29070 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29071 doc
: /* Tool bar style to use.
29073 image - show images only
29074 text - show text only
29075 both - show both, text below image
29076 both-horiz - show text to the right of the image
29077 text-image-horiz - show text to the left of the image
29078 any other - use system default or image if no system default.
29080 This variable only affects the GTK+ toolkit version of Emacs. */);
29081 Vtool_bar_style
= Qnil
;
29083 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29084 doc
: /* Maximum number of characters a label can have to be shown.
29085 The tool bar style must also show labels for this to have any effect, see
29086 `tool-bar-style'. */);
29087 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29089 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29090 doc
: /* List of functions to call to fontify regions of text.
29091 Each function is called with one argument POS. Functions must
29092 fontify a region starting at POS in the current buffer, and give
29093 fontified regions the property `fontified'. */);
29094 Vfontification_functions
= Qnil
;
29095 Fmake_variable_buffer_local (Qfontification_functions
);
29097 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29098 unibyte_display_via_language_environment
,
29099 doc
: /* Non-nil means display unibyte text according to language environment.
29100 Specifically, this means that raw bytes in the range 160-255 decimal
29101 are displayed by converting them to the equivalent multibyte characters
29102 according to the current language environment. As a result, they are
29103 displayed according to the current fontset.
29105 Note that this variable affects only how these bytes are displayed,
29106 but does not change the fact they are interpreted as raw bytes. */);
29107 unibyte_display_via_language_environment
= 0;
29109 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29110 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29111 If a float, it specifies a fraction of the mini-window frame's height.
29112 If an integer, it specifies a number of lines. */);
29113 Vmax_mini_window_height
= make_float (0.25);
29115 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29116 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29117 A value of nil means don't automatically resize mini-windows.
29118 A value of t means resize them to fit the text displayed in them.
29119 A value of `grow-only', the default, means let mini-windows grow only;
29120 they return to their normal size when the minibuffer is closed, or the
29121 echo area becomes empty. */);
29122 Vresize_mini_windows
= Qgrow_only
;
29124 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29125 doc
: /* Alist specifying how to blink the cursor off.
29126 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29127 `cursor-type' frame-parameter or variable equals ON-STATE,
29128 comparing using `equal', Emacs uses OFF-STATE to specify
29129 how to blink it off. ON-STATE and OFF-STATE are values for
29130 the `cursor-type' frame parameter.
29132 If a frame's ON-STATE has no entry in this list,
29133 the frame's other specifications determine how to blink the cursor off. */);
29134 Vblink_cursor_alist
= Qnil
;
29136 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29137 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29138 If non-nil, windows are automatically scrolled horizontally to make
29139 point visible. */);
29140 automatic_hscrolling_p
= 1;
29141 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29143 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29144 doc
: /* How many columns away from the window edge point is allowed to get
29145 before automatic hscrolling will horizontally scroll the window. */);
29146 hscroll_margin
= 5;
29148 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29149 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29150 When point is less than `hscroll-margin' columns from the window
29151 edge, automatic hscrolling will scroll the window by the amount of columns
29152 determined by this variable. If its value is a positive integer, scroll that
29153 many columns. If it's a positive floating-point number, it specifies the
29154 fraction of the window's width to scroll. If it's nil or zero, point will be
29155 centered horizontally after the scroll. Any other value, including negative
29156 numbers, are treated as if the value were zero.
29158 Automatic hscrolling always moves point outside the scroll margin, so if
29159 point was more than scroll step columns inside the margin, the window will
29160 scroll more than the value given by the scroll step.
29162 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29163 and `scroll-right' overrides this variable's effect. */);
29164 Vhscroll_step
= make_number (0);
29166 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29167 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29168 Bind this around calls to `message' to let it take effect. */);
29169 message_truncate_lines
= 0;
29171 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29172 doc
: /* Normal hook run to update the menu bar definitions.
29173 Redisplay runs this hook before it redisplays the menu bar.
29174 This is used to update submenus such as Buffers,
29175 whose contents depend on various data. */);
29176 Vmenu_bar_update_hook
= Qnil
;
29178 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29179 doc
: /* Frame for which we are updating a menu.
29180 The enable predicate for a menu binding should check this variable. */);
29181 Vmenu_updating_frame
= Qnil
;
29183 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29184 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29185 inhibit_menubar_update
= 0;
29187 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29188 doc
: /* Prefix prepended to all continuation lines at display time.
29189 The value may be a string, an image, or a stretch-glyph; it is
29190 interpreted in the same way as the value of a `display' text property.
29192 This variable is overridden by any `wrap-prefix' text or overlay
29195 To add a prefix to non-continuation lines, use `line-prefix'. */);
29196 Vwrap_prefix
= Qnil
;
29197 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29198 Fmake_variable_buffer_local (Qwrap_prefix
);
29200 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29201 doc
: /* Prefix prepended to all non-continuation lines at display time.
29202 The value may be a string, an image, or a stretch-glyph; it is
29203 interpreted in the same way as the value of a `display' text property.
29205 This variable is overridden by any `line-prefix' text or overlay
29208 To add a prefix to continuation lines, use `wrap-prefix'. */);
29209 Vline_prefix
= Qnil
;
29210 DEFSYM (Qline_prefix
, "line-prefix");
29211 Fmake_variable_buffer_local (Qline_prefix
);
29213 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29214 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29215 inhibit_eval_during_redisplay
= 0;
29217 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29218 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29219 inhibit_free_realized_faces
= 0;
29222 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29223 doc
: /* Inhibit try_window_id display optimization. */);
29224 inhibit_try_window_id
= 0;
29226 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29227 doc
: /* Inhibit try_window_reusing display optimization. */);
29228 inhibit_try_window_reusing
= 0;
29230 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29231 doc
: /* Inhibit try_cursor_movement display optimization. */);
29232 inhibit_try_cursor_movement
= 0;
29233 #endif /* GLYPH_DEBUG */
29235 DEFVAR_INT ("overline-margin", overline_margin
,
29236 doc
: /* Space between overline and text, in pixels.
29237 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29238 margin to the character height. */);
29239 overline_margin
= 2;
29241 DEFVAR_INT ("underline-minimum-offset",
29242 underline_minimum_offset
,
29243 doc
: /* Minimum distance between baseline and underline.
29244 This can improve legibility of underlined text at small font sizes,
29245 particularly when using variable `x-use-underline-position-properties'
29246 with fonts that specify an UNDERLINE_POSITION relatively close to the
29247 baseline. The default value is 1. */);
29248 underline_minimum_offset
= 1;
29250 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29251 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29252 This feature only works when on a window system that can change
29253 cursor shapes. */);
29254 display_hourglass_p
= 1;
29256 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29257 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29258 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29260 hourglass_atimer
= NULL
;
29261 hourglass_shown_p
= 0;
29263 DEFSYM (Qglyphless_char
, "glyphless-char");
29264 DEFSYM (Qhex_code
, "hex-code");
29265 DEFSYM (Qempty_box
, "empty-box");
29266 DEFSYM (Qthin_space
, "thin-space");
29267 DEFSYM (Qzero_width
, "zero-width");
29269 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29270 /* Intern this now in case it isn't already done.
29271 Setting this variable twice is harmless.
29272 But don't staticpro it here--that is done in alloc.c. */
29273 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29274 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29276 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29277 doc
: /* Char-table defining glyphless characters.
29278 Each element, if non-nil, should be one of the following:
29279 an ASCII acronym string: display this string in a box
29280 `hex-code': display the hexadecimal code of a character in a box
29281 `empty-box': display as an empty box
29282 `thin-space': display as 1-pixel width space
29283 `zero-width': don't display
29284 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29285 display method for graphical terminals and text terminals respectively.
29286 GRAPHICAL and TEXT should each have one of the values listed above.
29288 The char-table has one extra slot to control the display of a character for
29289 which no font is found. This slot only takes effect on graphical terminals.
29290 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29291 `thin-space'. The default is `empty-box'. */);
29292 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29293 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29298 /* Initialize this module when Emacs starts. */
29303 current_header_line_height
= current_mode_line_height
= -1;
29305 CHARPOS (this_line_start_pos
) = 0;
29307 if (!noninteractive
)
29309 struct window
*m
= XWINDOW (minibuf_window
);
29310 Lisp_Object frame
= m
->frame
;
29311 struct frame
*f
= XFRAME (frame
);
29312 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29313 struct window
*r
= XWINDOW (root
);
29316 echo_area_window
= minibuf_window
;
29318 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29320 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29321 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29322 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29323 wset_total_lines (m
, make_number (1));
29324 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29326 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29327 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29328 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29330 /* The default ellipsis glyphs `...'. */
29331 for (i
= 0; i
< 3; ++i
)
29332 default_invis_vector
[i
] = make_number ('.');
29336 /* Allocate the buffer for frame titles.
29337 Also used for `format-mode-line'. */
29339 mode_line_noprop_buf
= xmalloc (size
);
29340 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29341 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29342 mode_line_target
= MODE_LINE_DISPLAY
;
29345 help_echo_showing_p
= 0;
29348 /* Since w32 does not support atimers, it defines its own implementation of
29349 the following three functions in w32fns.c. */
29352 /* Platform-independent portion of hourglass implementation. */
29354 /* Cancel a currently active hourglass timer, and start a new one. */
29356 start_hourglass (void)
29358 #if defined (HAVE_WINDOW_SYSTEM)
29361 cancel_hourglass ();
29363 if (INTEGERP (Vhourglass_delay
)
29364 && XINT (Vhourglass_delay
) > 0)
29365 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29366 TYPE_MAXIMUM (time_t)),
29368 else if (FLOATP (Vhourglass_delay
)
29369 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29370 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29372 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29374 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29375 show_hourglass
, NULL
);
29380 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29383 cancel_hourglass (void)
29385 #if defined (HAVE_WINDOW_SYSTEM)
29386 if (hourglass_atimer
)
29388 cancel_atimer (hourglass_atimer
);
29389 hourglass_atimer
= NULL
;
29392 if (hourglass_shown_p
)
29396 #endif /* ! WINDOWSNT */