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
319 #ifndef FRAME_X_OUTPUT
320 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #define INFINITY 10000000
325 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
326 Lisp_Object Qwindow_scroll_functions
;
327 static Lisp_Object Qwindow_text_change_functions
;
328 static Lisp_Object Qredisplay_end_trigger_functions
;
329 Lisp_Object Qinhibit_point_motion_hooks
;
330 static Lisp_Object QCeval
, QCpropertize
;
331 Lisp_Object QCfile
, QCdata
;
332 static Lisp_Object Qfontified
;
333 static Lisp_Object Qgrow_only
;
334 static Lisp_Object Qinhibit_eval_during_redisplay
;
335 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
336 static Lisp_Object Qright_to_left
, Qleft_to_right
;
339 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
341 /* Pointer shapes. */
342 static Lisp_Object Qarrow
, Qhand
;
345 /* Holds the list (error). */
346 static Lisp_Object list_of_error
;
348 static Lisp_Object Qfontification_functions
;
350 static Lisp_Object Qwrap_prefix
;
351 static Lisp_Object Qline_prefix
;
352 static Lisp_Object Qredisplay_internal
;
354 /* Non-nil means don't actually do any redisplay. */
356 Lisp_Object Qinhibit_redisplay
;
358 /* Names of text properties relevant for redisplay. */
360 Lisp_Object Qdisplay
;
362 Lisp_Object Qspace
, QCalign_to
;
363 static Lisp_Object QCrelative_width
, QCrelative_height
;
364 Lisp_Object Qleft_margin
, Qright_margin
;
365 static Lisp_Object Qspace_width
, Qraise
;
366 static Lisp_Object Qslice
;
368 static Lisp_Object Qmargin
, Qpointer
;
369 static Lisp_Object Qline_height
;
371 /* These setters are used only in this file, so they can be private. */
373 wset_base_line_number (struct window
*w
, Lisp_Object val
)
375 w
->base_line_number
= val
;
378 wset_base_line_pos (struct window
*w
, Lisp_Object val
)
380 w
->base_line_pos
= val
;
383 wset_column_number_displayed (struct window
*w
, Lisp_Object val
)
385 w
->column_number_displayed
= val
;
388 wset_region_showing (struct window
*w
, Lisp_Object val
)
390 w
->region_showing
= val
;
393 #ifdef HAVE_WINDOW_SYSTEM
395 /* Test if overflow newline into fringe. Called with iterator IT
396 at or past right window margin, and with IT->current_x set. */
398 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
399 (!NILP (Voverflow_newline_into_fringe) \
400 && FRAME_WINDOW_P ((IT)->f) \
401 && ((IT)->bidi_it.paragraph_dir == R2L \
402 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
403 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
404 && (IT)->current_x == (IT)->last_visible_x \
405 && (IT)->line_wrap != WORD_WRAP)
407 #else /* !HAVE_WINDOW_SYSTEM */
408 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
409 #endif /* HAVE_WINDOW_SYSTEM */
411 /* Test if the display element loaded in IT, or the underlying buffer
412 or string character, is a space or a TAB character. This is used
413 to determine where word wrapping can occur. */
415 #define IT_DISPLAYING_WHITESPACE(it) \
416 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
417 || ((STRINGP (it->string) \
418 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
419 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
421 && (it->s[IT_BYTEPOS (*it)] == ' ' \
422 || it->s[IT_BYTEPOS (*it)] == '\t')) \
423 || (IT_BYTEPOS (*it) < ZV_BYTE \
424 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
425 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
427 /* Name of the face used to highlight trailing whitespace. */
429 static Lisp_Object Qtrailing_whitespace
;
431 /* Name and number of the face used to highlight escape glyphs. */
433 static Lisp_Object Qescape_glyph
;
435 /* Name and number of the face used to highlight non-breaking spaces. */
437 static Lisp_Object Qnobreak_space
;
439 /* The symbol `image' which is the car of the lists used to represent
440 images in Lisp. Also a tool bar style. */
444 /* The image map types. */
446 static Lisp_Object QCpointer
;
447 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
449 /* Tool bar styles */
450 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
452 /* Non-zero means print newline to stdout before next mini-buffer
455 int noninteractive_need_newline
;
457 /* Non-zero means print newline to message log before next message. */
459 static int message_log_need_newline
;
461 /* Three markers that message_dolog uses.
462 It could allocate them itself, but that causes trouble
463 in handling memory-full errors. */
464 static Lisp_Object message_dolog_marker1
;
465 static Lisp_Object message_dolog_marker2
;
466 static Lisp_Object message_dolog_marker3
;
468 /* The buffer position of the first character appearing entirely or
469 partially on the line of the selected window which contains the
470 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
471 redisplay optimization in redisplay_internal. */
473 static struct text_pos this_line_start_pos
;
475 /* Number of characters past the end of the line above, including the
476 terminating newline. */
478 static struct text_pos this_line_end_pos
;
480 /* The vertical positions and the height of this line. */
482 static int this_line_vpos
;
483 static int this_line_y
;
484 static int this_line_pixel_height
;
486 /* X position at which this display line starts. Usually zero;
487 negative if first character is partially visible. */
489 static int this_line_start_x
;
491 /* The smallest character position seen by move_it_* functions as they
492 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
493 hscrolled lines, see display_line. */
495 static struct text_pos this_line_min_pos
;
497 /* Buffer that this_line_.* variables are referring to. */
499 static struct buffer
*this_line_buffer
;
502 /* Values of those variables at last redisplay are stored as
503 properties on `overlay-arrow-position' symbol. However, if
504 Voverlay_arrow_position is a marker, last-arrow-position is its
505 numerical position. */
507 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
509 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
510 properties on a symbol in overlay-arrow-variable-list. */
512 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
514 Lisp_Object Qmenu_bar_update_hook
;
516 /* Nonzero if an overlay arrow has been displayed in this window. */
518 static int overlay_arrow_seen
;
520 /* Vector containing glyphs for an ellipsis `...'. */
522 static Lisp_Object default_invis_vector
[3];
524 /* This is the window where the echo area message was displayed. It
525 is always a mini-buffer window, but it may not be the same window
526 currently active as a mini-buffer. */
528 Lisp_Object echo_area_window
;
530 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
531 pushes the current message and the value of
532 message_enable_multibyte on the stack, the function restore_message
533 pops the stack and displays MESSAGE again. */
535 static Lisp_Object Vmessage_stack
;
537 /* Nonzero means multibyte characters were enabled when the echo area
538 message was specified. */
540 static int message_enable_multibyte
;
542 /* Nonzero if we should redraw the mode lines on the next redisplay. */
544 int update_mode_lines
;
546 /* Nonzero if window sizes or contents have changed since last
547 redisplay that finished. */
549 int windows_or_buffers_changed
;
551 /* Nonzero means a frame's cursor type has been changed. */
553 int cursor_type_changed
;
555 /* Nonzero after display_mode_line if %l was used and it displayed a
558 static int line_number_displayed
;
560 /* The name of the *Messages* buffer, a string. */
562 static Lisp_Object Vmessages_buffer_name
;
564 /* Current, index 0, and last displayed echo area message. Either
565 buffers from echo_buffers, or nil to indicate no message. */
567 Lisp_Object echo_area_buffer
[2];
569 /* The buffers referenced from echo_area_buffer. */
571 static Lisp_Object echo_buffer
[2];
573 /* A vector saved used in with_area_buffer to reduce consing. */
575 static Lisp_Object Vwith_echo_area_save_vector
;
577 /* Non-zero means display_echo_area should display the last echo area
578 message again. Set by redisplay_preserve_echo_area. */
580 static int display_last_displayed_message_p
;
582 /* Nonzero if echo area is being used by print; zero if being used by
585 static int message_buf_print
;
587 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
589 static Lisp_Object Qinhibit_menubar_update
;
590 static Lisp_Object Qmessage_truncate_lines
;
592 /* Set to 1 in clear_message to make redisplay_internal aware
593 of an emptied echo area. */
595 static int message_cleared_p
;
597 /* A scratch glyph row with contents used for generating truncation
598 glyphs. Also used in direct_output_for_insert. */
600 #define MAX_SCRATCH_GLYPHS 100
601 static struct glyph_row scratch_glyph_row
;
602 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
604 /* Ascent and height of the last line processed by move_it_to. */
606 static int last_max_ascent
, last_height
;
608 /* Non-zero if there's a help-echo in the echo area. */
610 int help_echo_showing_p
;
612 /* If >= 0, computed, exact values of mode-line and header-line height
613 to use in the macros CURRENT_MODE_LINE_HEIGHT and
614 CURRENT_HEADER_LINE_HEIGHT. */
616 int current_mode_line_height
, current_header_line_height
;
618 /* The maximum distance to look ahead for text properties. Values
619 that are too small let us call compute_char_face and similar
620 functions too often which is expensive. Values that are too large
621 let us call compute_char_face and alike too often because we
622 might not be interested in text properties that far away. */
624 #define TEXT_PROP_DISTANCE_LIMIT 100
626 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
627 iterator state and later restore it. This is needed because the
628 bidi iterator on bidi.c keeps a stacked cache of its states, which
629 is really a singleton. When we use scratch iterator objects to
630 move around the buffer, we can cause the bidi cache to be pushed or
631 popped, and therefore we need to restore the cache state when we
632 return to the original iterator. */
633 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
636 bidi_unshelve_cache (CACHE, 1); \
638 CACHE = bidi_shelve_cache (); \
641 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
643 if (pITORIG != pITCOPY) \
644 *(pITORIG) = *(pITCOPY); \
645 bidi_unshelve_cache (CACHE, 0); \
651 /* Non-zero means print traces of redisplay if compiled with
652 GLYPH_DEBUG defined. */
654 int trace_redisplay_p
;
656 #endif /* GLYPH_DEBUG */
658 #ifdef DEBUG_TRACE_MOVE
659 /* Non-zero means trace with TRACE_MOVE to stderr. */
662 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
664 #define TRACE_MOVE(x) (void) 0
667 static Lisp_Object Qauto_hscroll_mode
;
669 /* Buffer being redisplayed -- for redisplay_window_error. */
671 static struct buffer
*displayed_buffer
;
673 /* Value returned from text property handlers (see below). */
678 HANDLED_RECOMPUTE_PROPS
,
679 HANDLED_OVERLAY_STRING_CONSUMED
,
683 /* A description of text properties that redisplay is interested
688 /* The name of the property. */
691 /* A unique index for the property. */
694 /* A handler function called to set up iterator IT from the property
695 at IT's current position. Value is used to steer handle_stop. */
696 enum prop_handled (*handler
) (struct it
*it
);
699 static enum prop_handled
handle_face_prop (struct it
*);
700 static enum prop_handled
handle_invisible_prop (struct it
*);
701 static enum prop_handled
handle_display_prop (struct it
*);
702 static enum prop_handled
handle_composition_prop (struct it
*);
703 static enum prop_handled
handle_overlay_change (struct it
*);
704 static enum prop_handled
handle_fontified_prop (struct it
*);
706 /* Properties handled by iterators. */
708 static struct props it_props
[] =
710 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
711 /* Handle `face' before `display' because some sub-properties of
712 `display' need to know the face. */
713 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
714 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
715 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
716 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
720 /* Value is the position described by X. If X is a marker, value is
721 the marker_position of X. Otherwise, value is X. */
723 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
725 /* Enumeration returned by some move_it_.* functions internally. */
729 /* Not used. Undefined value. */
732 /* Move ended at the requested buffer position or ZV. */
733 MOVE_POS_MATCH_OR_ZV
,
735 /* Move ended at the requested X pixel position. */
738 /* Move within a line ended at the end of a line that must be
742 /* Move within a line ended at the end of a line that would
743 be displayed truncated. */
746 /* Move within a line ended at a line end. */
750 /* This counter is used to clear the face cache every once in a while
751 in redisplay_internal. It is incremented for each redisplay.
752 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
755 #define CLEAR_FACE_CACHE_COUNT 500
756 static int clear_face_cache_count
;
758 /* Similarly for the image cache. */
760 #ifdef HAVE_WINDOW_SYSTEM
761 #define CLEAR_IMAGE_CACHE_COUNT 101
762 static int clear_image_cache_count
;
764 /* Null glyph slice */
765 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
768 /* True while redisplay_internal is in progress. */
772 static Lisp_Object Qinhibit_free_realized_faces
;
773 static Lisp_Object Qmode_line_default_help_echo
;
775 /* If a string, XTread_socket generates an event to display that string.
776 (The display is done in read_char.) */
778 Lisp_Object help_echo_string
;
779 Lisp_Object help_echo_window
;
780 Lisp_Object help_echo_object
;
781 ptrdiff_t help_echo_pos
;
783 /* Temporary variable for XTread_socket. */
785 Lisp_Object previous_help_echo_string
;
787 /* Platform-independent portion of hourglass implementation. */
789 /* Non-zero means an hourglass cursor is currently shown. */
790 int hourglass_shown_p
;
792 /* If non-null, an asynchronous timer that, when it expires, displays
793 an hourglass cursor on all frames. */
794 struct atimer
*hourglass_atimer
;
796 /* Name of the face used to display glyphless characters. */
797 Lisp_Object Qglyphless_char
;
799 /* Symbol for the purpose of Vglyphless_char_display. */
800 static Lisp_Object Qglyphless_char_display
;
802 /* Method symbols for Vglyphless_char_display. */
803 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
805 /* Default pixel width of `thin-space' display method. */
806 #define THIN_SPACE_WIDTH 1
808 /* Default number of seconds to wait before displaying an hourglass
810 #define DEFAULT_HOURGLASS_DELAY 1
813 /* Function prototypes. */
815 static void setup_for_ellipsis (struct it
*, int);
816 static void set_iterator_to_next (struct it
*, int);
817 static void mark_window_display_accurate_1 (struct window
*, int);
818 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
819 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
820 static int cursor_row_p (struct glyph_row
*);
821 static int redisplay_mode_lines (Lisp_Object
, int);
822 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
824 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
826 static void handle_line_prefix (struct it
*);
828 static void pint2str (char *, int, ptrdiff_t);
829 static void pint2hrstr (char *, int, ptrdiff_t);
830 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
832 static void reconsider_clip_changes (struct window
*, struct buffer
*);
833 static int text_outside_line_unchanged_p (struct window
*,
834 ptrdiff_t, ptrdiff_t);
835 static void store_mode_line_noprop_char (char);
836 static int store_mode_line_noprop (const char *, int, int);
837 static void handle_stop (struct it
*);
838 static void handle_stop_backwards (struct it
*, ptrdiff_t);
839 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
840 static void ensure_echo_area_buffers (void);
841 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
842 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
843 static int with_echo_area_buffer (struct window
*, int,
844 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
845 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
846 static void clear_garbaged_frames (void);
847 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
848 static void pop_message (void);
849 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
850 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
851 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
852 static int display_echo_area (struct window
*);
853 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
854 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
855 static Lisp_Object
unwind_redisplay (Lisp_Object
);
856 static int string_char_and_length (const unsigned char *, int *);
857 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
859 static int compute_window_start_on_continuation_line (struct window
*);
860 static void insert_left_trunc_glyphs (struct it
*);
861 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
863 static void extend_face_to_end_of_line (struct it
*);
864 static int append_space_for_newline (struct it
*, int);
865 static int cursor_row_fully_visible_p (struct window
*, int, int);
866 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
867 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
868 static int trailing_whitespace_p (ptrdiff_t);
869 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
870 static void push_it (struct it
*, struct text_pos
*);
871 static void iterate_out_of_display_property (struct it
*);
872 static void pop_it (struct it
*);
873 static void sync_frame_with_window_matrix_rows (struct window
*);
874 static void redisplay_internal (void);
875 static int echo_area_display (int);
876 static void redisplay_windows (Lisp_Object
);
877 static void redisplay_window (Lisp_Object
, int);
878 static Lisp_Object
redisplay_window_error (Lisp_Object
);
879 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
880 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
881 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
882 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
884 static int update_menu_bar (struct frame
*, int, int);
885 static int try_window_reusing_current_matrix (struct window
*);
886 static int try_window_id (struct window
*);
887 static int display_line (struct it
*);
888 static int display_mode_lines (struct window
*);
889 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
890 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
891 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
892 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
893 static void display_menu_bar (struct window
*);
894 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
896 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
897 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
898 static void compute_line_metrics (struct it
*);
899 static void run_redisplay_end_trigger_hook (struct it
*);
900 static int get_overlay_strings (struct it
*, ptrdiff_t);
901 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
902 static void next_overlay_string (struct it
*);
903 static void reseat (struct it
*, struct text_pos
, int);
904 static void reseat_1 (struct it
*, struct text_pos
, int);
905 static void back_to_previous_visible_line_start (struct it
*);
906 void reseat_at_previous_visible_line_start (struct it
*);
907 static void reseat_at_next_visible_line_start (struct it
*, int);
908 static int next_element_from_ellipsis (struct it
*);
909 static int next_element_from_display_vector (struct it
*);
910 static int next_element_from_string (struct it
*);
911 static int next_element_from_c_string (struct it
*);
912 static int next_element_from_buffer (struct it
*);
913 static int next_element_from_composition (struct it
*);
914 static int next_element_from_image (struct it
*);
916 static int next_element_from_xwidget(struct it
*);
918 static int next_element_from_stretch (struct it
*);
919 static void load_overlay_strings (struct it
*, ptrdiff_t);
920 static int init_from_display_pos (struct it
*, struct window
*,
921 struct display_pos
*);
922 static void reseat_to_string (struct it
*, const char *,
923 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
924 static int get_next_display_element (struct it
*);
925 static enum move_it_result
926 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
927 enum move_operation_enum
);
928 void move_it_vertically_backward (struct it
*, int);
929 static void get_visually_first_element (struct it
*);
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 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 signaled %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 */
2566 /* Return mark position if current buffer has the region of non-zero length,
2570 markpos_of_region (void)
2572 if (!NILP (Vtransient_mark_mode
)
2573 && !NILP (BVAR (current_buffer
, mark_active
))
2574 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= NULL
)
2576 ptrdiff_t markpos
= XMARKER (BVAR (current_buffer
, mark
))->charpos
;
2584 /***********************************************************************
2585 Iterator initialization
2586 ***********************************************************************/
2588 /* Initialize IT for displaying current_buffer in window W, starting
2589 at character position CHARPOS. CHARPOS < 0 means that no buffer
2590 position is specified which is useful when the iterator is assigned
2591 a position later. BYTEPOS is the byte position corresponding to
2592 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2594 If ROW is not null, calls to produce_glyphs with IT as parameter
2595 will produce glyphs in that row.
2597 BASE_FACE_ID is the id of a base face to use. It must be one of
2598 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2599 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2600 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2602 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2603 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2604 will be initialized to use the corresponding mode line glyph row of
2605 the desired matrix of W. */
2608 init_iterator (struct it
*it
, struct window
*w
,
2609 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2610 struct glyph_row
*row
, enum face_id base_face_id
)
2613 enum face_id remapped_base_face_id
= base_face_id
;
2615 /* Some precondition checks. */
2616 eassert (w
!= NULL
&& it
!= NULL
);
2617 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2620 /* If face attributes have been changed since the last redisplay,
2621 free realized faces now because they depend on face definitions
2622 that might have changed. Don't free faces while there might be
2623 desired matrices pending which reference these faces. */
2624 if (face_change_count
&& !inhibit_free_realized_faces
)
2626 face_change_count
= 0;
2627 free_all_realized_faces (Qnil
);
2630 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2631 if (! NILP (Vface_remapping_alist
))
2632 remapped_base_face_id
2633 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2635 /* Use one of the mode line rows of W's desired matrix if
2639 if (base_face_id
== MODE_LINE_FACE_ID
2640 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2641 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2642 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2643 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2647 memset (it
, 0, sizeof *it
);
2648 it
->current
.overlay_string_index
= -1;
2649 it
->current
.dpvec_index
= -1;
2650 it
->base_face_id
= remapped_base_face_id
;
2652 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2653 it
->paragraph_embedding
= L2R
;
2654 it
->bidi_it
.string
.lstring
= Qnil
;
2655 it
->bidi_it
.string
.s
= NULL
;
2656 it
->bidi_it
.string
.bufpos
= 0;
2658 /* The window in which we iterate over current_buffer: */
2659 XSETWINDOW (it
->window
, w
);
2661 it
->f
= XFRAME (w
->frame
);
2665 /* Extra space between lines (on window systems only). */
2666 if (base_face_id
== DEFAULT_FACE_ID
2667 && FRAME_WINDOW_P (it
->f
))
2669 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2670 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2671 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2672 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2673 * FRAME_LINE_HEIGHT (it
->f
));
2674 else if (it
->f
->extra_line_spacing
> 0)
2675 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2676 it
->max_extra_line_spacing
= 0;
2679 /* If realized faces have been removed, e.g. because of face
2680 attribute changes of named faces, recompute them. When running
2681 in batch mode, the face cache of the initial frame is null. If
2682 we happen to get called, make a dummy face cache. */
2683 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2684 init_frame_faces (it
->f
);
2685 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2686 recompute_basic_faces (it
->f
);
2688 /* Current value of the `slice', `space-width', and 'height' properties. */
2689 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2690 it
->space_width
= Qnil
;
2691 it
->font_height
= Qnil
;
2692 it
->override_ascent
= -1;
2694 /* Are control characters displayed as `^C'? */
2695 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2697 /* -1 means everything between a CR and the following line end
2698 is invisible. >0 means lines indented more than this value are
2700 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2702 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2704 : (!NILP (BVAR (current_buffer
, selective_display
))
2706 it
->selective_display_ellipsis_p
2707 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2709 /* Display table to use. */
2710 it
->dp
= window_display_table (w
);
2712 /* Are multibyte characters enabled in current_buffer? */
2713 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2715 /* If visible region is of non-zero length, set IT->region_beg_charpos
2716 and IT->region_end_charpos to the start and end of a visible region
2717 in window IT->w. Set both to -1 to indicate no region. */
2718 markpos
= markpos_of_region ();
2720 /* Maybe highlight only in selected window. */
2721 && (/* Either show region everywhere. */
2722 highlight_nonselected_windows
2723 /* Or show region in the selected window. */
2724 || w
== XWINDOW (selected_window
)
2725 /* Or show the region if we are in the mini-buffer and W is
2726 the window the mini-buffer refers to. */
2727 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2728 && WINDOWP (minibuf_selected_window
)
2729 && w
== XWINDOW (minibuf_selected_window
))))
2731 it
->region_beg_charpos
= min (PT
, markpos
);
2732 it
->region_end_charpos
= max (PT
, markpos
);
2735 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2737 /* Get the position at which the redisplay_end_trigger hook should
2738 be run, if it is to be run at all. */
2739 if (MARKERP (w
->redisplay_end_trigger
)
2740 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2741 it
->redisplay_end_trigger_charpos
2742 = marker_position (w
->redisplay_end_trigger
);
2743 else if (INTEGERP (w
->redisplay_end_trigger
))
2744 it
->redisplay_end_trigger_charpos
=
2745 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2747 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2749 /* Are lines in the display truncated? */
2750 if (base_face_id
!= DEFAULT_FACE_ID
2752 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2753 && ((!NILP (Vtruncate_partial_width_windows
)
2754 && !INTEGERP (Vtruncate_partial_width_windows
))
2755 || (INTEGERP (Vtruncate_partial_width_windows
)
2756 && (WINDOW_TOTAL_COLS (it
->w
)
2757 < XINT (Vtruncate_partial_width_windows
))))))
2758 it
->line_wrap
= TRUNCATE
;
2759 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2760 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2761 ? WINDOW_WRAP
: WORD_WRAP
;
2763 it
->line_wrap
= TRUNCATE
;
2765 /* Get dimensions of truncation and continuation glyphs. These are
2766 displayed as fringe bitmaps under X, but we need them for such
2767 frames when the fringes are turned off. But leave the dimensions
2768 zero for tooltip frames, as these glyphs look ugly there and also
2769 sabotage calculations of tooltip dimensions in x-show-tip. */
2770 #ifdef HAVE_WINDOW_SYSTEM
2771 if (!(FRAME_WINDOW_P (it
->f
)
2772 && FRAMEP (tip_frame
)
2773 && it
->f
== XFRAME (tip_frame
)))
2776 if (it
->line_wrap
== TRUNCATE
)
2778 /* We will need the truncation glyph. */
2779 eassert (it
->glyph_row
== NULL
);
2780 produce_special_glyphs (it
, IT_TRUNCATION
);
2781 it
->truncation_pixel_width
= it
->pixel_width
;
2785 /* We will need the continuation glyph. */
2786 eassert (it
->glyph_row
== NULL
);
2787 produce_special_glyphs (it
, IT_CONTINUATION
);
2788 it
->continuation_pixel_width
= it
->pixel_width
;
2792 /* Reset these values to zero because the produce_special_glyphs
2793 above has changed them. */
2794 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2795 it
->phys_ascent
= it
->phys_descent
= 0;
2797 /* Set this after getting the dimensions of truncation and
2798 continuation glyphs, so that we don't produce glyphs when calling
2799 produce_special_glyphs, above. */
2800 it
->glyph_row
= row
;
2801 it
->area
= TEXT_AREA
;
2803 /* Forget any previous info about this row being reversed. */
2805 it
->glyph_row
->reversed_p
= 0;
2807 /* Get the dimensions of the display area. The display area
2808 consists of the visible window area plus a horizontally scrolled
2809 part to the left of the window. All x-values are relative to the
2810 start of this total display area. */
2811 if (base_face_id
!= DEFAULT_FACE_ID
)
2813 /* Mode lines, menu bar in terminal frames. */
2814 it
->first_visible_x
= 0;
2815 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2819 it
->first_visible_x
=
2820 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2821 it
->last_visible_x
= (it
->first_visible_x
2822 + window_box_width (w
, TEXT_AREA
));
2824 /* If we truncate lines, leave room for the truncation glyph(s) at
2825 the right margin. Otherwise, leave room for the continuation
2826 glyph(s). Done only if the window has no fringes. Since we
2827 don't know at this point whether there will be any R2L lines in
2828 the window, we reserve space for truncation/continuation glyphs
2829 even if only one of the fringes is absent. */
2830 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2831 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2833 if (it
->line_wrap
== TRUNCATE
)
2834 it
->last_visible_x
-= it
->truncation_pixel_width
;
2836 it
->last_visible_x
-= it
->continuation_pixel_width
;
2839 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2840 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2843 /* Leave room for a border glyph. */
2844 if (!FRAME_WINDOW_P (it
->f
)
2845 && !WINDOW_RIGHTMOST_P (it
->w
))
2846 it
->last_visible_x
-= 1;
2848 it
->last_visible_y
= window_text_bottom_y (w
);
2850 /* For mode lines and alike, arrange for the first glyph having a
2851 left box line if the face specifies a box. */
2852 if (base_face_id
!= DEFAULT_FACE_ID
)
2856 it
->face_id
= remapped_base_face_id
;
2858 /* If we have a boxed mode line, make the first character appear
2859 with a left box line. */
2860 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2861 if (face
->box
!= FACE_NO_BOX
)
2862 it
->start_of_box_run_p
= 1;
2865 /* If a buffer position was specified, set the iterator there,
2866 getting overlays and face properties from that position. */
2867 if (charpos
>= BUF_BEG (current_buffer
))
2869 it
->end_charpos
= ZV
;
2870 IT_CHARPOS (*it
) = charpos
;
2872 /* We will rely on `reseat' to set this up properly, via
2873 handle_face_prop. */
2874 it
->face_id
= it
->base_face_id
;
2876 /* Compute byte position if not specified. */
2877 if (bytepos
< charpos
)
2878 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2880 IT_BYTEPOS (*it
) = bytepos
;
2882 it
->start
= it
->current
;
2883 /* Do we need to reorder bidirectional text? Not if this is a
2884 unibyte buffer: by definition, none of the single-byte
2885 characters are strong R2L, so no reordering is needed. And
2886 bidi.c doesn't support unibyte buffers anyway. Also, don't
2887 reorder while we are loading loadup.el, since the tables of
2888 character properties needed for reordering are not yet
2892 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2895 /* If we are to reorder bidirectional text, init the bidi
2899 /* Note the paragraph direction that this buffer wants to
2901 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2903 it
->paragraph_embedding
= L2R
;
2904 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2906 it
->paragraph_embedding
= R2L
;
2908 it
->paragraph_embedding
= NEUTRAL_DIR
;
2909 bidi_unshelve_cache (NULL
, 0);
2910 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2914 /* Compute faces etc. */
2915 reseat (it
, it
->current
.pos
, 1);
2922 /* Initialize IT for the display of window W with window start POS. */
2925 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2927 struct glyph_row
*row
;
2928 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2930 row
= w
->desired_matrix
->rows
+ first_vpos
;
2931 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2932 it
->first_vpos
= first_vpos
;
2934 /* Don't reseat to previous visible line start if current start
2935 position is in a string or image. */
2936 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2938 int start_at_line_beg_p
;
2939 int first_y
= it
->current_y
;
2941 /* If window start is not at a line start, skip forward to POS to
2942 get the correct continuation lines width. */
2943 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2944 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2945 if (!start_at_line_beg_p
)
2949 reseat_at_previous_visible_line_start (it
);
2950 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2952 new_x
= it
->current_x
+ it
->pixel_width
;
2954 /* If lines are continued, this line may end in the middle
2955 of a multi-glyph character (e.g. a control character
2956 displayed as \003, or in the middle of an overlay
2957 string). In this case move_it_to above will not have
2958 taken us to the start of the continuation line but to the
2959 end of the continued line. */
2960 if (it
->current_x
> 0
2961 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2962 && (/* And glyph doesn't fit on the line. */
2963 new_x
> it
->last_visible_x
2964 /* Or it fits exactly and we're on a window
2966 || (new_x
== it
->last_visible_x
2967 && FRAME_WINDOW_P (it
->f
)
2968 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2969 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2970 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2972 if ((it
->current
.dpvec_index
>= 0
2973 || it
->current
.overlay_string_index
>= 0)
2974 /* If we are on a newline from a display vector or
2975 overlay string, then we are already at the end of
2976 a screen line; no need to go to the next line in
2977 that case, as this line is not really continued.
2978 (If we do go to the next line, C-e will not DTRT.) */
2981 set_iterator_to_next (it
, 1);
2982 move_it_in_display_line_to (it
, -1, -1, 0);
2985 it
->continuation_lines_width
+= it
->current_x
;
2987 /* If the character at POS is displayed via a display
2988 vector, move_it_to above stops at the final glyph of
2989 IT->dpvec. To make the caller redisplay that character
2990 again (a.k.a. start at POS), we need to reset the
2991 dpvec_index to the beginning of IT->dpvec. */
2992 else if (it
->current
.dpvec_index
>= 0)
2993 it
->current
.dpvec_index
= 0;
2995 /* We're starting a new display line, not affected by the
2996 height of the continued line, so clear the appropriate
2997 fields in the iterator structure. */
2998 it
->max_ascent
= it
->max_descent
= 0;
2999 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3001 it
->current_y
= first_y
;
3003 it
->current_x
= it
->hpos
= 0;
3009 /* Return 1 if POS is a position in ellipses displayed for invisible
3010 text. W is the window we display, for text property lookup. */
3013 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3015 Lisp_Object prop
, window
;
3017 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3019 /* If POS specifies a position in a display vector, this might
3020 be for an ellipsis displayed for invisible text. We won't
3021 get the iterator set up for delivering that ellipsis unless
3022 we make sure that it gets aware of the invisible text. */
3023 if (pos
->dpvec_index
>= 0
3024 && pos
->overlay_string_index
< 0
3025 && CHARPOS (pos
->string_pos
) < 0
3027 && (XSETWINDOW (window
, w
),
3028 prop
= Fget_char_property (make_number (charpos
),
3029 Qinvisible
, window
),
3030 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3032 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3034 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3041 /* Initialize IT for stepping through current_buffer in window W,
3042 starting at position POS that includes overlay string and display
3043 vector/ control character translation position information. Value
3044 is zero if there are overlay strings with newlines at POS. */
3047 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3049 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3050 int i
, overlay_strings_with_newlines
= 0;
3052 /* If POS specifies a position in a display vector, this might
3053 be for an ellipsis displayed for invisible text. We won't
3054 get the iterator set up for delivering that ellipsis unless
3055 we make sure that it gets aware of the invisible text. */
3056 if (in_ellipses_for_invisible_text_p (pos
, w
))
3062 /* Keep in mind: the call to reseat in init_iterator skips invisible
3063 text, so we might end up at a position different from POS. This
3064 is only a problem when POS is a row start after a newline and an
3065 overlay starts there with an after-string, and the overlay has an
3066 invisible property. Since we don't skip invisible text in
3067 display_line and elsewhere immediately after consuming the
3068 newline before the row start, such a POS will not be in a string,
3069 but the call to init_iterator below will move us to the
3071 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3073 /* This only scans the current chunk -- it should scan all chunks.
3074 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3075 to 16 in 22.1 to make this a lesser problem. */
3076 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3078 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3079 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3081 while (s
< e
&& *s
!= '\n')
3086 overlay_strings_with_newlines
= 1;
3091 /* If position is within an overlay string, set up IT to the right
3093 if (pos
->overlay_string_index
>= 0)
3097 /* If the first overlay string happens to have a `display'
3098 property for an image, the iterator will be set up for that
3099 image, and we have to undo that setup first before we can
3100 correct the overlay string index. */
3101 if (it
->method
== GET_FROM_IMAGE
)
3104 /* We already have the first chunk of overlay strings in
3105 IT->overlay_strings. Load more until the one for
3106 pos->overlay_string_index is in IT->overlay_strings. */
3107 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3109 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3110 it
->current
.overlay_string_index
= 0;
3113 load_overlay_strings (it
, 0);
3114 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3118 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3119 relative_index
= (it
->current
.overlay_string_index
3120 % OVERLAY_STRING_CHUNK_SIZE
);
3121 it
->string
= it
->overlay_strings
[relative_index
];
3122 eassert (STRINGP (it
->string
));
3123 it
->current
.string_pos
= pos
->string_pos
;
3124 it
->method
= GET_FROM_STRING
;
3125 it
->end_charpos
= SCHARS (it
->string
);
3126 /* Set up the bidi iterator for this overlay string. */
3129 it
->bidi_it
.string
.lstring
= it
->string
;
3130 it
->bidi_it
.string
.s
= NULL
;
3131 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3132 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3133 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3134 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3135 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3136 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3138 /* Synchronize the state of the bidi iterator with
3139 pos->string_pos. For any string position other than
3140 zero, this will be done automagically when we resume
3141 iteration over the string and get_visually_first_element
3142 is called. But if string_pos is zero, and the string is
3143 to be reordered for display, we need to resync manually,
3144 since it could be that the iteration state recorded in
3145 pos ended at string_pos of 0 moving backwards in string. */
3146 if (CHARPOS (pos
->string_pos
) == 0)
3148 get_visually_first_element (it
);
3149 if (IT_STRING_CHARPOS (*it
) != 0)
3152 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3153 bidi_move_to_visually_next (&it
->bidi_it
);
3154 } while (it
->bidi_it
.charpos
!= 0);
3156 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3157 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3161 if (CHARPOS (pos
->string_pos
) >= 0)
3163 /* Recorded position is not in an overlay string, but in another
3164 string. This can only be a string from a `display' property.
3165 IT should already be filled with that string. */
3166 it
->current
.string_pos
= pos
->string_pos
;
3167 eassert (STRINGP (it
->string
));
3169 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3170 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3173 /* Restore position in display vector translations, control
3174 character translations or ellipses. */
3175 if (pos
->dpvec_index
>= 0)
3177 if (it
->dpvec
== NULL
)
3178 get_next_display_element (it
);
3179 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3180 it
->current
.dpvec_index
= pos
->dpvec_index
;
3184 return !overlay_strings_with_newlines
;
3188 /* Initialize IT for stepping through current_buffer in window W
3189 starting at ROW->start. */
3192 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3194 init_from_display_pos (it
, w
, &row
->start
);
3195 it
->start
= row
->start
;
3196 it
->continuation_lines_width
= row
->continuation_lines_width
;
3201 /* Initialize IT for stepping through current_buffer in window W
3202 starting in the line following ROW, i.e. starting at ROW->end.
3203 Value is zero if there are overlay strings with newlines at ROW's
3207 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3211 if (init_from_display_pos (it
, w
, &row
->end
))
3213 if (row
->continued_p
)
3214 it
->continuation_lines_width
3215 = row
->continuation_lines_width
+ row
->pixel_width
;
3226 /***********************************************************************
3228 ***********************************************************************/
3230 /* Called when IT reaches IT->stop_charpos. Handle text property and
3231 overlay changes. Set IT->stop_charpos to the next position where
3235 handle_stop (struct it
*it
)
3237 enum prop_handled handled
;
3238 int handle_overlay_change_p
;
3242 it
->current
.dpvec_index
= -1;
3243 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3244 it
->ignore_overlay_strings_at_pos_p
= 0;
3247 /* Use face of preceding text for ellipsis (if invisible) */
3248 if (it
->selective_display_ellipsis_p
)
3249 it
->saved_face_id
= it
->face_id
;
3253 handled
= HANDLED_NORMALLY
;
3255 /* Call text property handlers. */
3256 for (p
= it_props
; p
->handler
; ++p
)
3258 handled
= p
->handler (it
);
3260 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3262 else if (handled
== HANDLED_RETURN
)
3264 /* We still want to show before and after strings from
3265 overlays even if the actual buffer text is replaced. */
3266 if (!handle_overlay_change_p
3268 /* Don't call get_overlay_strings_1 if we already
3269 have overlay strings loaded, because doing so
3270 will load them again and push the iterator state
3271 onto the stack one more time, which is not
3272 expected by the rest of the code that processes
3274 || (it
->current
.overlay_string_index
< 0
3275 ? !get_overlay_strings_1 (it
, 0, 0)
3279 setup_for_ellipsis (it
, 0);
3280 /* When handling a display spec, we might load an
3281 empty string. In that case, discard it here. We
3282 used to discard it in handle_single_display_spec,
3283 but that causes get_overlay_strings_1, above, to
3284 ignore overlay strings that we must check. */
3285 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3289 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3293 it
->ignore_overlay_strings_at_pos_p
= 1;
3294 it
->string_from_display_prop_p
= 0;
3295 it
->from_disp_prop_p
= 0;
3296 handle_overlay_change_p
= 0;
3298 handled
= HANDLED_RECOMPUTE_PROPS
;
3301 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3302 handle_overlay_change_p
= 0;
3305 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3307 /* Don't check for overlay strings below when set to deliver
3308 characters from a display vector. */
3309 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3310 handle_overlay_change_p
= 0;
3312 /* Handle overlay changes.
3313 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3314 if it finds overlays. */
3315 if (handle_overlay_change_p
)
3316 handled
= handle_overlay_change (it
);
3321 setup_for_ellipsis (it
, 0);
3325 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3327 /* Determine where to stop next. */
3328 if (handled
== HANDLED_NORMALLY
)
3329 compute_stop_pos (it
);
3333 /* Compute IT->stop_charpos from text property and overlay change
3334 information for IT's current position. */
3337 compute_stop_pos (struct it
*it
)
3339 register INTERVAL iv
, next_iv
;
3340 Lisp_Object object
, limit
, position
;
3341 ptrdiff_t charpos
, bytepos
;
3343 if (STRINGP (it
->string
))
3345 /* Strings are usually short, so don't limit the search for
3347 it
->stop_charpos
= it
->end_charpos
;
3348 object
= it
->string
;
3350 charpos
= IT_STRING_CHARPOS (*it
);
3351 bytepos
= IT_STRING_BYTEPOS (*it
);
3357 /* If end_charpos is out of range for some reason, such as a
3358 misbehaving display function, rationalize it (Bug#5984). */
3359 if (it
->end_charpos
> ZV
)
3360 it
->end_charpos
= ZV
;
3361 it
->stop_charpos
= it
->end_charpos
;
3363 /* If next overlay change is in front of the current stop pos
3364 (which is IT->end_charpos), stop there. Note: value of
3365 next_overlay_change is point-max if no overlay change
3367 charpos
= IT_CHARPOS (*it
);
3368 bytepos
= IT_BYTEPOS (*it
);
3369 pos
= next_overlay_change (charpos
);
3370 if (pos
< it
->stop_charpos
)
3371 it
->stop_charpos
= pos
;
3373 /* If showing the region, we have to stop at the region
3374 start or end because the face might change there. */
3375 if (it
->region_beg_charpos
> 0)
3377 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3378 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3379 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3380 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3383 /* Set up variables for computing the stop position from text
3384 property changes. */
3385 XSETBUFFER (object
, current_buffer
);
3386 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3389 /* Get the interval containing IT's position. Value is a null
3390 interval if there isn't such an interval. */
3391 position
= make_number (charpos
);
3392 iv
= validate_interval_range (object
, &position
, &position
, 0);
3395 Lisp_Object values_here
[LAST_PROP_IDX
];
3398 /* Get properties here. */
3399 for (p
= it_props
; p
->handler
; ++p
)
3400 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3402 /* Look for an interval following iv that has different
3404 for (next_iv
= next_interval (iv
);
3407 || XFASTINT (limit
) > next_iv
->position
));
3408 next_iv
= next_interval (next_iv
))
3410 for (p
= it_props
; p
->handler
; ++p
)
3412 Lisp_Object new_value
;
3414 new_value
= textget (next_iv
->plist
, *p
->name
);
3415 if (!EQ (values_here
[p
->idx
], new_value
))
3425 if (INTEGERP (limit
)
3426 && next_iv
->position
>= XFASTINT (limit
))
3427 /* No text property change up to limit. */
3428 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3430 /* Text properties change in next_iv. */
3431 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3435 if (it
->cmp_it
.id
< 0)
3437 ptrdiff_t stoppos
= it
->end_charpos
;
3439 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3441 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3442 stoppos
, it
->string
);
3445 eassert (STRINGP (it
->string
)
3446 || (it
->stop_charpos
>= BEGV
3447 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3451 /* Return the position of the next overlay change after POS in
3452 current_buffer. Value is point-max if no overlay change
3453 follows. This is like `next-overlay-change' but doesn't use
3457 next_overlay_change (ptrdiff_t pos
)
3459 ptrdiff_t i
, noverlays
;
3461 Lisp_Object
*overlays
;
3463 /* Get all overlays at the given position. */
3464 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3466 /* If any of these overlays ends before endpos,
3467 use its ending point instead. */
3468 for (i
= 0; i
< noverlays
; ++i
)
3473 oend
= OVERLAY_END (overlays
[i
]);
3474 oendpos
= OVERLAY_POSITION (oend
);
3475 endpos
= min (endpos
, oendpos
);
3481 /* How many characters forward to search for a display property or
3482 display string. Searching too far forward makes the bidi display
3483 sluggish, especially in small windows. */
3484 #define MAX_DISP_SCAN 250
3486 /* Return the character position of a display string at or after
3487 position specified by POSITION. If no display string exists at or
3488 after POSITION, return ZV. A display string is either an overlay
3489 with `display' property whose value is a string, or a `display'
3490 text property whose value is a string. STRING is data about the
3491 string to iterate; if STRING->lstring is nil, we are iterating a
3492 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3493 on a GUI frame. DISP_PROP is set to zero if we searched
3494 MAX_DISP_SCAN characters forward without finding any display
3495 strings, non-zero otherwise. It is set to 2 if the display string
3496 uses any kind of `(space ...)' spec that will produce a stretch of
3497 white space in the text area. */
3499 compute_display_string_pos (struct text_pos
*position
,
3500 struct bidi_string_data
*string
,
3501 int frame_window_p
, int *disp_prop
)
3503 /* OBJECT = nil means current buffer. */
3504 Lisp_Object object
=
3505 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3506 Lisp_Object pos
, spec
, limpos
;
3507 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3508 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3509 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3510 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3512 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3513 struct text_pos tpos
;
3519 /* We don't support display properties whose values are strings
3520 that have display string properties. */
3521 || string
->from_disp_str
3522 /* C strings cannot have display properties. */
3523 || (string
->s
&& !STRINGP (object
)))
3529 /* If the character at CHARPOS is where the display string begins,
3531 pos
= make_number (charpos
);
3532 if (STRINGP (object
))
3533 bufpos
= string
->bufpos
;
3537 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3539 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3542 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3550 /* Look forward for the first character with a `display' property
3551 that will replace the underlying text when displayed. */
3552 limpos
= make_number (lim
);
3554 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3555 CHARPOS (tpos
) = XFASTINT (pos
);
3556 if (CHARPOS (tpos
) >= lim
)
3561 if (STRINGP (object
))
3562 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3564 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3565 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3566 if (!STRINGP (object
))
3567 bufpos
= CHARPOS (tpos
);
3568 } while (NILP (spec
)
3569 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3570 bufpos
, frame_window_p
)));
3574 return CHARPOS (tpos
);
3577 /* Return the character position of the end of the display string that
3578 started at CHARPOS. If there's no display string at CHARPOS,
3579 return -1. A display string is either an overlay with `display'
3580 property whose value is a string or a `display' text property whose
3581 value is a string. */
3583 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3585 /* OBJECT = nil means current buffer. */
3586 Lisp_Object object
=
3587 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3588 Lisp_Object pos
= make_number (charpos
);
3590 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3592 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3595 /* It could happen that the display property or overlay was removed
3596 since we found it in compute_display_string_pos above. One way
3597 this can happen is if JIT font-lock was called (through
3598 handle_fontified_prop), and jit-lock-functions remove text
3599 properties or overlays from the portion of buffer that includes
3600 CHARPOS. Muse mode is known to do that, for example. In this
3601 case, we return -1 to the caller, to signal that no display
3602 string is actually present at CHARPOS. See bidi_fetch_char for
3603 how this is handled.
3605 An alternative would be to never look for display properties past
3606 it->stop_charpos. But neither compute_display_string_pos nor
3607 bidi_fetch_char that calls it know or care where the next
3609 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3612 /* Look forward for the first character where the `display' property
3614 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3616 return XFASTINT (pos
);
3621 /***********************************************************************
3623 ***********************************************************************/
3625 /* Handle changes in the `fontified' property of the current buffer by
3626 calling hook functions from Qfontification_functions to fontify
3629 static enum prop_handled
3630 handle_fontified_prop (struct it
*it
)
3632 Lisp_Object prop
, pos
;
3633 enum prop_handled handled
= HANDLED_NORMALLY
;
3635 if (!NILP (Vmemory_full
))
3638 /* Get the value of the `fontified' property at IT's current buffer
3639 position. (The `fontified' property doesn't have a special
3640 meaning in strings.) If the value is nil, call functions from
3641 Qfontification_functions. */
3642 if (!STRINGP (it
->string
)
3644 && !NILP (Vfontification_functions
)
3645 && !NILP (Vrun_hooks
)
3646 && (pos
= make_number (IT_CHARPOS (*it
)),
3647 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3648 /* Ignore the special cased nil value always present at EOB since
3649 no amount of fontifying will be able to change it. */
3650 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3652 ptrdiff_t count
= SPECPDL_INDEX ();
3654 struct buffer
*obuf
= current_buffer
;
3655 int begv
= BEGV
, zv
= ZV
;
3656 int old_clip_changed
= current_buffer
->clip_changed
;
3658 val
= Vfontification_functions
;
3659 specbind (Qfontification_functions
, Qnil
);
3661 eassert (it
->end_charpos
== ZV
);
3663 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3664 safe_call1 (val
, pos
);
3667 Lisp_Object fns
, fn
;
3668 struct gcpro gcpro1
, gcpro2
;
3673 for (; CONSP (val
); val
= XCDR (val
))
3679 /* A value of t indicates this hook has a local
3680 binding; it means to run the global binding too.
3681 In a global value, t should not occur. If it
3682 does, we must ignore it to avoid an endless
3684 for (fns
= Fdefault_value (Qfontification_functions
);
3690 safe_call1 (fn
, pos
);
3694 safe_call1 (fn
, pos
);
3700 unbind_to (count
, Qnil
);
3702 /* Fontification functions routinely call `save-restriction'.
3703 Normally, this tags clip_changed, which can confuse redisplay
3704 (see discussion in Bug#6671). Since we don't perform any
3705 special handling of fontification changes in the case where
3706 `save-restriction' isn't called, there's no point doing so in
3707 this case either. So, if the buffer's restrictions are
3708 actually left unchanged, reset clip_changed. */
3709 if (obuf
== current_buffer
)
3711 if (begv
== BEGV
&& zv
== ZV
)
3712 current_buffer
->clip_changed
= old_clip_changed
;
3714 /* There isn't much we can reasonably do to protect against
3715 misbehaving fontification, but here's a fig leaf. */
3716 else if (BUFFER_LIVE_P (obuf
))
3717 set_buffer_internal_1 (obuf
);
3719 /* The fontification code may have added/removed text.
3720 It could do even a lot worse, but let's at least protect against
3721 the most obvious case where only the text past `pos' gets changed',
3722 as is/was done in grep.el where some escapes sequences are turned
3723 into face properties (bug#7876). */
3724 it
->end_charpos
= ZV
;
3726 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3727 something. This avoids an endless loop if they failed to
3728 fontify the text for which reason ever. */
3729 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3730 handled
= HANDLED_RECOMPUTE_PROPS
;
3738 /***********************************************************************
3740 ***********************************************************************/
3742 /* Set up iterator IT from face properties at its current position.
3743 Called from handle_stop. */
3745 static enum prop_handled
3746 handle_face_prop (struct it
*it
)
3749 ptrdiff_t next_stop
;
3751 if (!STRINGP (it
->string
))
3754 = face_at_buffer_position (it
->w
,
3756 it
->region_beg_charpos
,
3757 it
->region_end_charpos
,
3760 + TEXT_PROP_DISTANCE_LIMIT
),
3761 0, it
->base_face_id
);
3763 /* Is this a start of a run of characters with box face?
3764 Caveat: this can be called for a freshly initialized
3765 iterator; face_id is -1 in this case. We know that the new
3766 face will not change until limit, i.e. if the new face has a
3767 box, all characters up to limit will have one. But, as
3768 usual, we don't know whether limit is really the end. */
3769 if (new_face_id
!= it
->face_id
)
3771 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3772 /* If it->face_id is -1, old_face below will be NULL, see
3773 the definition of FACE_FROM_ID. This will happen if this
3774 is the initial call that gets the face. */
3775 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3777 /* If the value of face_id of the iterator is -1, we have to
3778 look in front of IT's position and see whether there is a
3779 face there that's different from new_face_id. */
3780 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3782 int prev_face_id
= face_before_it_pos (it
);
3784 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3787 /* If the new face has a box, but the old face does not,
3788 this is the start of a run of characters with box face,
3789 i.e. this character has a shadow on the left side. */
3790 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3791 && (old_face
== NULL
|| !old_face
->box
));
3792 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3800 Lisp_Object from_overlay
3801 = (it
->current
.overlay_string_index
>= 0
3802 ? it
->string_overlays
[it
->current
.overlay_string_index
3803 % OVERLAY_STRING_CHUNK_SIZE
]
3806 /* See if we got to this string directly or indirectly from
3807 an overlay property. That includes the before-string or
3808 after-string of an overlay, strings in display properties
3809 provided by an overlay, their text properties, etc.
3811 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3812 if (! NILP (from_overlay
))
3813 for (i
= it
->sp
- 1; i
>= 0; i
--)
3815 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3817 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3818 % OVERLAY_STRING_CHUNK_SIZE
];
3819 else if (! NILP (it
->stack
[i
].from_overlay
))
3820 from_overlay
= it
->stack
[i
].from_overlay
;
3822 if (!NILP (from_overlay
))
3826 if (! NILP (from_overlay
))
3828 bufpos
= IT_CHARPOS (*it
);
3829 /* For a string from an overlay, the base face depends
3830 only on text properties and ignores overlays. */
3832 = face_for_overlay_string (it
->w
,
3834 it
->region_beg_charpos
,
3835 it
->region_end_charpos
,
3838 + TEXT_PROP_DISTANCE_LIMIT
),
3846 /* For strings from a `display' property, use the face at
3847 IT's current buffer position as the base face to merge
3848 with, so that overlay strings appear in the same face as
3849 surrounding text, unless they specify their own
3851 base_face_id
= it
->string_from_prefix_prop_p
3853 : underlying_face_id (it
);
3856 new_face_id
= face_at_string_position (it
->w
,
3858 IT_STRING_CHARPOS (*it
),
3860 it
->region_beg_charpos
,
3861 it
->region_end_charpos
,
3865 /* Is this a start of a run of characters with box? Caveat:
3866 this can be called for a freshly allocated iterator; face_id
3867 is -1 is this case. We know that the new face will not
3868 change until the next check pos, i.e. if the new face has a
3869 box, all characters up to that position will have a
3870 box. But, as usual, we don't know whether that position
3871 is really the end. */
3872 if (new_face_id
!= it
->face_id
)
3874 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3875 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3877 /* If new face has a box but old face hasn't, this is the
3878 start of a run of characters with box, i.e. it has a
3879 shadow on the left side. */
3880 it
->start_of_box_run_p
3881 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3882 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3886 it
->face_id
= new_face_id
;
3887 return HANDLED_NORMALLY
;
3891 /* Return the ID of the face ``underlying'' IT's current position,
3892 which is in a string. If the iterator is associated with a
3893 buffer, return the face at IT's current buffer position.
3894 Otherwise, use the iterator's base_face_id. */
3897 underlying_face_id (struct it
*it
)
3899 int face_id
= it
->base_face_id
, i
;
3901 eassert (STRINGP (it
->string
));
3903 for (i
= it
->sp
- 1; i
>= 0; --i
)
3904 if (NILP (it
->stack
[i
].string
))
3905 face_id
= it
->stack
[i
].face_id
;
3911 /* Compute the face one character before or after the current position
3912 of IT, in the visual order. BEFORE_P non-zero means get the face
3913 in front (to the left in L2R paragraphs, to the right in R2L
3914 paragraphs) of IT's screen position. Value is the ID of the face. */
3917 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3920 ptrdiff_t next_check_charpos
;
3922 void *it_copy_data
= NULL
;
3924 eassert (it
->s
== NULL
);
3926 if (STRINGP (it
->string
))
3928 ptrdiff_t bufpos
, charpos
;
3931 /* No face change past the end of the string (for the case
3932 we are padding with spaces). No face change before the
3934 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3935 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3940 /* Set charpos to the position before or after IT's current
3941 position, in the logical order, which in the non-bidi
3942 case is the same as the visual order. */
3944 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3945 else if (it
->what
== IT_COMPOSITION
)
3946 /* For composition, we must check the character after the
3948 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3950 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3956 /* With bidi iteration, the character before the current
3957 in the visual order cannot be found by simple
3958 iteration, because "reverse" reordering is not
3959 supported. Instead, we need to use the move_it_*
3960 family of functions. */
3961 /* Ignore face changes before the first visible
3962 character on this display line. */
3963 if (it
->current_x
<= it
->first_visible_x
)
3965 SAVE_IT (it_copy
, *it
, it_copy_data
);
3966 /* Implementation note: Since move_it_in_display_line
3967 works in the iterator geometry, and thinks the first
3968 character is always the leftmost, even in R2L lines,
3969 we don't need to distinguish between the R2L and L2R
3971 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3972 it_copy
.current_x
- 1, MOVE_TO_X
);
3973 charpos
= IT_STRING_CHARPOS (it_copy
);
3974 RESTORE_IT (it
, it
, it_copy_data
);
3978 /* Set charpos to the string position of the character
3979 that comes after IT's current position in the visual
3981 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3985 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3987 charpos
= it_copy
.bidi_it
.charpos
;
3990 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3992 if (it
->current
.overlay_string_index
>= 0)
3993 bufpos
= IT_CHARPOS (*it
);
3997 base_face_id
= underlying_face_id (it
);
3999 /* Get the face for ASCII, or unibyte. */
4000 face_id
= face_at_string_position (it
->w
,
4004 it
->region_beg_charpos
,
4005 it
->region_end_charpos
,
4006 &next_check_charpos
,
4009 /* Correct the face for charsets different from ASCII. Do it
4010 for the multibyte case only. The face returned above is
4011 suitable for unibyte text if IT->string is unibyte. */
4012 if (STRING_MULTIBYTE (it
->string
))
4014 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4015 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4017 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4019 c
= string_char_and_length (p
, &len
);
4020 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4025 struct text_pos pos
;
4027 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4028 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4031 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4032 pos
= it
->current
.pos
;
4037 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4040 if (it
->what
== IT_COMPOSITION
)
4042 /* For composition, we must check the position after
4044 pos
.charpos
+= it
->cmp_it
.nchars
;
4045 pos
.bytepos
+= it
->len
;
4048 INC_TEXT_POS (pos
, it
->multibyte_p
);
4055 /* With bidi iteration, the character before the current
4056 in the visual order cannot be found by simple
4057 iteration, because "reverse" reordering is not
4058 supported. Instead, we need to use the move_it_*
4059 family of functions. */
4060 /* Ignore face changes before the first visible
4061 character on this display line. */
4062 if (it
->current_x
<= it
->first_visible_x
)
4064 SAVE_IT (it_copy
, *it
, it_copy_data
);
4065 /* Implementation note: Since move_it_in_display_line
4066 works in the iterator geometry, and thinks the first
4067 character is always the leftmost, even in R2L lines,
4068 we don't need to distinguish between the R2L and L2R
4070 move_it_in_display_line (&it_copy
, ZV
,
4071 it_copy
.current_x
- 1, MOVE_TO_X
);
4072 pos
= it_copy
.current
.pos
;
4073 RESTORE_IT (it
, it
, it_copy_data
);
4077 /* Set charpos to the buffer position of the character
4078 that comes after IT's current position in the visual
4080 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4084 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4087 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4090 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4092 /* Determine face for CHARSET_ASCII, or unibyte. */
4093 face_id
= face_at_buffer_position (it
->w
,
4095 it
->region_beg_charpos
,
4096 it
->region_end_charpos
,
4097 &next_check_charpos
,
4100 /* Correct the face for charsets different from ASCII. Do it
4101 for the multibyte case only. The face returned above is
4102 suitable for unibyte text if current_buffer is unibyte. */
4103 if (it
->multibyte_p
)
4105 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4106 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4107 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4116 /***********************************************************************
4118 ***********************************************************************/
4120 /* Set up iterator IT from invisible properties at its current
4121 position. Called from handle_stop. */
4123 static enum prop_handled
4124 handle_invisible_prop (struct it
*it
)
4126 enum prop_handled handled
= HANDLED_NORMALLY
;
4130 if (STRINGP (it
->string
))
4132 Lisp_Object end_charpos
, limit
, charpos
;
4134 /* Get the value of the invisible text property at the
4135 current position. Value will be nil if there is no such
4137 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4138 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4139 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4141 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4143 /* Record whether we have to display an ellipsis for the
4145 int display_ellipsis_p
= (invis_p
== 2);
4146 ptrdiff_t len
, endpos
;
4148 handled
= HANDLED_RECOMPUTE_PROPS
;
4150 /* Get the position at which the next visible text can be
4151 found in IT->string, if any. */
4152 endpos
= len
= SCHARS (it
->string
);
4153 XSETINT (limit
, len
);
4156 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4158 if (INTEGERP (end_charpos
))
4160 endpos
= XFASTINT (end_charpos
);
4161 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4162 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4164 display_ellipsis_p
= 1;
4167 while (invis_p
&& endpos
< len
);
4169 if (display_ellipsis_p
)
4174 /* Text at END_CHARPOS is visible. Move IT there. */
4175 struct text_pos old
;
4178 old
= it
->current
.string_pos
;
4179 oldpos
= CHARPOS (old
);
4182 if (it
->bidi_it
.first_elt
4183 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4184 bidi_paragraph_init (it
->paragraph_embedding
,
4186 /* Bidi-iterate out of the invisible text. */
4189 bidi_move_to_visually_next (&it
->bidi_it
);
4191 while (oldpos
<= it
->bidi_it
.charpos
4192 && it
->bidi_it
.charpos
< endpos
);
4194 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4195 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4196 if (IT_CHARPOS (*it
) >= endpos
)
4197 it
->prev_stop
= endpos
;
4201 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4202 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4207 /* The rest of the string is invisible. If this is an
4208 overlay string, proceed with the next overlay string
4209 or whatever comes and return a character from there. */
4210 if (it
->current
.overlay_string_index
>= 0
4211 && !display_ellipsis_p
)
4213 next_overlay_string (it
);
4214 /* Don't check for overlay strings when we just
4215 finished processing them. */
4216 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4220 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4221 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4228 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4229 Lisp_Object pos
, overlay
;
4231 /* First of all, is there invisible text at this position? */
4232 tem
= start_charpos
= IT_CHARPOS (*it
);
4233 pos
= make_number (tem
);
4234 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4236 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4238 /* If we are on invisible text, skip over it. */
4239 if (invis_p
&& start_charpos
< it
->end_charpos
)
4241 /* Record whether we have to display an ellipsis for the
4243 int display_ellipsis_p
= invis_p
== 2;
4245 handled
= HANDLED_RECOMPUTE_PROPS
;
4247 /* Loop skipping over invisible text. The loop is left at
4248 ZV or with IT on the first char being visible again. */
4251 /* Try to skip some invisible text. Return value is the
4252 position reached which can be equal to where we start
4253 if there is nothing invisible there. This skips both
4254 over invisible text properties and overlays with
4255 invisible property. */
4256 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4258 /* If we skipped nothing at all we weren't at invisible
4259 text in the first place. If everything to the end of
4260 the buffer was skipped, end the loop. */
4261 if (newpos
== tem
|| newpos
>= ZV
)
4265 /* We skipped some characters but not necessarily
4266 all there are. Check if we ended up on visible
4267 text. Fget_char_property returns the property of
4268 the char before the given position, i.e. if we
4269 get invis_p = 0, this means that the char at
4270 newpos is visible. */
4271 pos
= make_number (newpos
);
4272 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4273 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4276 /* If we ended up on invisible text, proceed to
4277 skip starting with next_stop. */
4281 /* If there are adjacent invisible texts, don't lose the
4282 second one's ellipsis. */
4284 display_ellipsis_p
= 1;
4288 /* The position newpos is now either ZV or on visible text. */
4291 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4293 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4295 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4297 /* If the invisible text ends on a newline or on a
4298 character after a newline, we can avoid the costly,
4299 character by character, bidi iteration to NEWPOS, and
4300 instead simply reseat the iterator there. That's
4301 because all bidi reordering information is tossed at
4302 the newline. This is a big win for modes that hide
4303 complete lines, like Outline, Org, etc. */
4304 if (on_newline
|| after_newline
)
4306 struct text_pos tpos
;
4307 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4309 SET_TEXT_POS (tpos
, newpos
, bpos
);
4310 reseat_1 (it
, tpos
, 0);
4311 /* If we reseat on a newline/ZV, we need to prep the
4312 bidi iterator for advancing to the next character
4313 after the newline/EOB, keeping the current paragraph
4314 direction (so that PRODUCE_GLYPHS does TRT wrt
4315 prepending/appending glyphs to a glyph row). */
4318 it
->bidi_it
.first_elt
= 0;
4319 it
->bidi_it
.paragraph_dir
= pdir
;
4320 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4321 it
->bidi_it
.nchars
= 1;
4322 it
->bidi_it
.ch_len
= 1;
4325 else /* Must use the slow method. */
4327 /* With bidi iteration, the region of invisible text
4328 could start and/or end in the middle of a
4329 non-base embedding level. Therefore, we need to
4330 skip invisible text using the bidi iterator,
4331 starting at IT's current position, until we find
4332 ourselves outside of the invisible text.
4333 Skipping invisible text _after_ bidi iteration
4334 avoids affecting the visual order of the
4335 displayed text when invisible properties are
4336 added or removed. */
4337 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4339 /* If we were `reseat'ed to a new paragraph,
4340 determine the paragraph base direction. We
4341 need to do it now because
4342 next_element_from_buffer may not have a
4343 chance to do it, if we are going to skip any
4344 text at the beginning, which resets the
4346 bidi_paragraph_init (it
->paragraph_embedding
,
4351 bidi_move_to_visually_next (&it
->bidi_it
);
4353 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4354 && it
->bidi_it
.charpos
< newpos
);
4355 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4356 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4357 /* If we overstepped NEWPOS, record its position in
4358 the iterator, so that we skip invisible text if
4359 later the bidi iteration lands us in the
4360 invisible region again. */
4361 if (IT_CHARPOS (*it
) >= newpos
)
4362 it
->prev_stop
= newpos
;
4367 IT_CHARPOS (*it
) = newpos
;
4368 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4371 /* If there are before-strings at the start of invisible
4372 text, and the text is invisible because of a text
4373 property, arrange to show before-strings because 20.x did
4374 it that way. (If the text is invisible because of an
4375 overlay property instead of a text property, this is
4376 already handled in the overlay code.) */
4378 && get_overlay_strings (it
, it
->stop_charpos
))
4380 handled
= HANDLED_RECOMPUTE_PROPS
;
4381 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4383 else if (display_ellipsis_p
)
4385 /* Make sure that the glyphs of the ellipsis will get
4386 correct `charpos' values. If we would not update
4387 it->position here, the glyphs would belong to the
4388 last visible character _before_ the invisible
4389 text, which confuses `set_cursor_from_row'.
4391 We use the last invisible position instead of the
4392 first because this way the cursor is always drawn on
4393 the first "." of the ellipsis, whenever PT is inside
4394 the invisible text. Otherwise the cursor would be
4395 placed _after_ the ellipsis when the point is after the
4396 first invisible character. */
4397 if (!STRINGP (it
->object
))
4399 it
->position
.charpos
= newpos
- 1;
4400 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4403 /* Let the ellipsis display before
4404 considering any properties of the following char.
4405 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4406 handled
= HANDLED_RETURN
;
4415 /* Make iterator IT return `...' next.
4416 Replaces LEN characters from buffer. */
4419 setup_for_ellipsis (struct it
*it
, int len
)
4421 /* Use the display table definition for `...'. Invalid glyphs
4422 will be handled by the method returning elements from dpvec. */
4423 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4425 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4426 it
->dpvec
= v
->contents
;
4427 it
->dpend
= v
->contents
+ v
->header
.size
;
4431 /* Default `...'. */
4432 it
->dpvec
= default_invis_vector
;
4433 it
->dpend
= default_invis_vector
+ 3;
4436 it
->dpvec_char_len
= len
;
4437 it
->current
.dpvec_index
= 0;
4438 it
->dpvec_face_id
= -1;
4440 /* Remember the current face id in case glyphs specify faces.
4441 IT's face is restored in set_iterator_to_next.
4442 saved_face_id was set to preceding char's face in handle_stop. */
4443 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4444 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4446 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4452 /***********************************************************************
4454 ***********************************************************************/
4456 /* Set up iterator IT from `display' property at its current position.
4457 Called from handle_stop.
4458 We return HANDLED_RETURN if some part of the display property
4459 overrides the display of the buffer text itself.
4460 Otherwise we return HANDLED_NORMALLY. */
4462 static enum prop_handled
4463 handle_display_prop (struct it
*it
)
4465 Lisp_Object propval
, object
, overlay
;
4466 struct text_pos
*position
;
4468 /* Nonzero if some property replaces the display of the text itself. */
4469 int display_replaced_p
= 0;
4471 if (STRINGP (it
->string
))
4473 object
= it
->string
;
4474 position
= &it
->current
.string_pos
;
4475 bufpos
= CHARPOS (it
->current
.pos
);
4479 XSETWINDOW (object
, it
->w
);
4480 position
= &it
->current
.pos
;
4481 bufpos
= CHARPOS (*position
);
4484 /* Reset those iterator values set from display property values. */
4485 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4486 it
->space_width
= Qnil
;
4487 it
->font_height
= Qnil
;
4490 /* We don't support recursive `display' properties, i.e. string
4491 values that have a string `display' property, that have a string
4492 `display' property etc. */
4493 if (!it
->string_from_display_prop_p
)
4494 it
->area
= TEXT_AREA
;
4496 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4497 Qdisplay
, object
, &overlay
);
4499 return HANDLED_NORMALLY
;
4500 /* Now OVERLAY is the overlay that gave us this property, or nil
4501 if it was a text property. */
4503 if (!STRINGP (it
->string
))
4504 object
= it
->w
->buffer
;
4506 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4508 FRAME_WINDOW_P (it
->f
));
4510 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4513 /* Subroutine of handle_display_prop. Returns non-zero if the display
4514 specification in SPEC is a replacing specification, i.e. it would
4515 replace the text covered by `display' property with something else,
4516 such as an image or a display string. If SPEC includes any kind or
4517 `(space ...) specification, the value is 2; this is used by
4518 compute_display_string_pos, which see.
4520 See handle_single_display_spec for documentation of arguments.
4521 frame_window_p is non-zero if the window being redisplayed is on a
4522 GUI frame; this argument is used only if IT is NULL, see below.
4524 IT can be NULL, if this is called by the bidi reordering code
4525 through compute_display_string_pos, which see. In that case, this
4526 function only examines SPEC, but does not otherwise "handle" it, in
4527 the sense that it doesn't set up members of IT from the display
4530 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4531 Lisp_Object overlay
, struct text_pos
*position
,
4532 ptrdiff_t bufpos
, int frame_window_p
)
4534 int replacing_p
= 0;
4538 /* Simple specifications. */
4539 && !EQ (XCAR (spec
), Qimage
)
4540 #ifdef HAVE_XWIDGETS
4541 && !EQ (XCAR (spec
), Qxwidget
)
4543 && !EQ (XCAR (spec
), Qspace
)
4544 && !EQ (XCAR (spec
), Qwhen
)
4545 && !EQ (XCAR (spec
), Qslice
)
4546 && !EQ (XCAR (spec
), Qspace_width
)
4547 && !EQ (XCAR (spec
), Qheight
)
4548 && !EQ (XCAR (spec
), Qraise
)
4549 /* Marginal area specifications. */
4550 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4551 && !EQ (XCAR (spec
), Qleft_fringe
)
4552 && !EQ (XCAR (spec
), Qright_fringe
)
4553 && !NILP (XCAR (spec
)))
4555 for (; CONSP (spec
); spec
= XCDR (spec
))
4557 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4558 overlay
, position
, bufpos
,
4559 replacing_p
, frame_window_p
)))
4562 /* If some text in a string is replaced, `position' no
4563 longer points to the position of `object'. */
4564 if (!it
|| STRINGP (object
))
4569 else if (VECTORP (spec
))
4572 for (i
= 0; i
< ASIZE (spec
); ++i
)
4573 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4574 overlay
, position
, bufpos
,
4575 replacing_p
, frame_window_p
)))
4578 /* If some text in a string is replaced, `position' no
4579 longer points to the position of `object'. */
4580 if (!it
|| STRINGP (object
))
4586 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4587 position
, bufpos
, 0,
4595 /* Value is the position of the end of the `display' property starting
4596 at START_POS in OBJECT. */
4598 static struct text_pos
4599 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4602 struct text_pos end_pos
;
4604 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4605 Qdisplay
, object
, Qnil
);
4606 CHARPOS (end_pos
) = XFASTINT (end
);
4607 if (STRINGP (object
))
4608 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4610 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4616 /* Set up IT from a single `display' property specification SPEC. OBJECT
4617 is the object in which the `display' property was found. *POSITION
4618 is the position in OBJECT at which the `display' property was found.
4619 BUFPOS is the buffer position of OBJECT (different from POSITION if
4620 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4621 previously saw a display specification which already replaced text
4622 display with something else, for example an image; we ignore such
4623 properties after the first one has been processed.
4625 OVERLAY is the overlay this `display' property came from,
4626 or nil if it was a text property.
4628 If SPEC is a `space' or `image' specification, and in some other
4629 cases too, set *POSITION to the position where the `display'
4632 If IT is NULL, only examine the property specification in SPEC, but
4633 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4634 is intended to be displayed in a window on a GUI frame.
4636 Value is non-zero if something was found which replaces the display
4637 of buffer or string text. */
4640 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4641 Lisp_Object overlay
, struct text_pos
*position
,
4642 ptrdiff_t bufpos
, int display_replaced_p
,
4646 Lisp_Object location
, value
;
4647 struct text_pos start_pos
= *position
;
4650 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4651 If the result is non-nil, use VALUE instead of SPEC. */
4653 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4662 if (!NILP (form
) && !EQ (form
, Qt
))
4664 ptrdiff_t count
= SPECPDL_INDEX ();
4665 struct gcpro gcpro1
;
4667 /* Bind `object' to the object having the `display' property, a
4668 buffer or string. Bind `position' to the position in the
4669 object where the property was found, and `buffer-position'
4670 to the current position in the buffer. */
4673 XSETBUFFER (object
, current_buffer
);
4674 specbind (Qobject
, object
);
4675 specbind (Qposition
, make_number (CHARPOS (*position
)));
4676 specbind (Qbuffer_position
, make_number (bufpos
));
4678 form
= safe_eval (form
);
4680 unbind_to (count
, Qnil
);
4686 /* Handle `(height HEIGHT)' specifications. */
4688 && EQ (XCAR (spec
), Qheight
)
4689 && CONSP (XCDR (spec
)))
4693 if (!FRAME_WINDOW_P (it
->f
))
4696 it
->font_height
= XCAR (XCDR (spec
));
4697 if (!NILP (it
->font_height
))
4699 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4700 int new_height
= -1;
4702 if (CONSP (it
->font_height
)
4703 && (EQ (XCAR (it
->font_height
), Qplus
)
4704 || EQ (XCAR (it
->font_height
), Qminus
))
4705 && CONSP (XCDR (it
->font_height
))
4706 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4708 /* `(+ N)' or `(- N)' where N is an integer. */
4709 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4710 if (EQ (XCAR (it
->font_height
), Qplus
))
4712 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4714 else if (FUNCTIONP (it
->font_height
))
4716 /* Call function with current height as argument.
4717 Value is the new height. */
4719 height
= safe_call1 (it
->font_height
,
4720 face
->lface
[LFACE_HEIGHT_INDEX
]);
4721 if (NUMBERP (height
))
4722 new_height
= XFLOATINT (height
);
4724 else if (NUMBERP (it
->font_height
))
4726 /* Value is a multiple of the canonical char height. */
4729 f
= FACE_FROM_ID (it
->f
,
4730 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4731 new_height
= (XFLOATINT (it
->font_height
)
4732 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4736 /* Evaluate IT->font_height with `height' bound to the
4737 current specified height to get the new height. */
4738 ptrdiff_t count
= SPECPDL_INDEX ();
4740 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4741 value
= safe_eval (it
->font_height
);
4742 unbind_to (count
, Qnil
);
4744 if (NUMBERP (value
))
4745 new_height
= XFLOATINT (value
);
4749 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4756 /* Handle `(space-width WIDTH)'. */
4758 && EQ (XCAR (spec
), Qspace_width
)
4759 && CONSP (XCDR (spec
)))
4763 if (!FRAME_WINDOW_P (it
->f
))
4766 value
= XCAR (XCDR (spec
));
4767 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4768 it
->space_width
= value
;
4774 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4776 && EQ (XCAR (spec
), Qslice
))
4782 if (!FRAME_WINDOW_P (it
->f
))
4785 if (tem
= XCDR (spec
), CONSP (tem
))
4787 it
->slice
.x
= XCAR (tem
);
4788 if (tem
= XCDR (tem
), CONSP (tem
))
4790 it
->slice
.y
= XCAR (tem
);
4791 if (tem
= XCDR (tem
), CONSP (tem
))
4793 it
->slice
.width
= XCAR (tem
);
4794 if (tem
= XCDR (tem
), CONSP (tem
))
4795 it
->slice
.height
= XCAR (tem
);
4804 /* Handle `(raise FACTOR)'. */
4806 && EQ (XCAR (spec
), Qraise
)
4807 && CONSP (XCDR (spec
)))
4811 if (!FRAME_WINDOW_P (it
->f
))
4814 #ifdef HAVE_WINDOW_SYSTEM
4815 value
= XCAR (XCDR (spec
));
4816 if (NUMBERP (value
))
4818 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4819 it
->voffset
= - (XFLOATINT (value
)
4820 * (FONT_HEIGHT (face
->font
)));
4822 #endif /* HAVE_WINDOW_SYSTEM */
4828 /* Don't handle the other kinds of display specifications
4829 inside a string that we got from a `display' property. */
4830 if (it
&& it
->string_from_display_prop_p
)
4833 /* Characters having this form of property are not displayed, so
4834 we have to find the end of the property. */
4837 start_pos
= *position
;
4838 *position
= display_prop_end (it
, object
, start_pos
);
4842 /* Stop the scan at that end position--we assume that all
4843 text properties change there. */
4845 it
->stop_charpos
= position
->charpos
;
4847 /* Handle `(left-fringe BITMAP [FACE])'
4848 and `(right-fringe BITMAP [FACE])'. */
4850 && (EQ (XCAR (spec
), Qleft_fringe
)
4851 || EQ (XCAR (spec
), Qright_fringe
))
4852 && CONSP (XCDR (spec
)))
4858 if (!FRAME_WINDOW_P (it
->f
))
4859 /* If we return here, POSITION has been advanced
4860 across the text with this property. */
4862 /* Synchronize the bidi iterator with POSITION. This is
4863 needed because we are not going to push the iterator
4864 on behalf of this display property, so there will be
4865 no pop_it call to do this synchronization for us. */
4868 it
->position
= *position
;
4869 iterate_out_of_display_property (it
);
4870 *position
= it
->position
;
4875 else if (!frame_window_p
)
4878 #ifdef HAVE_WINDOW_SYSTEM
4879 value
= XCAR (XCDR (spec
));
4880 if (!SYMBOLP (value
)
4881 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4882 /* If we return here, POSITION has been advanced
4883 across the text with this property. */
4885 if (it
&& it
->bidi_p
)
4887 it
->position
= *position
;
4888 iterate_out_of_display_property (it
);
4889 *position
= it
->position
;
4896 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4898 if (CONSP (XCDR (XCDR (spec
))))
4900 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4901 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4907 /* Save current settings of IT so that we can restore them
4908 when we are finished with the glyph property value. */
4909 push_it (it
, position
);
4911 it
->area
= TEXT_AREA
;
4912 it
->what
= IT_IMAGE
;
4913 it
->image_id
= -1; /* no image */
4914 it
->position
= start_pos
;
4915 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4916 it
->method
= GET_FROM_IMAGE
;
4917 it
->from_overlay
= Qnil
;
4918 it
->face_id
= face_id
;
4919 it
->from_disp_prop_p
= 1;
4921 /* Say that we haven't consumed the characters with
4922 `display' property yet. The call to pop_it in
4923 set_iterator_to_next will clean this up. */
4924 *position
= start_pos
;
4926 if (EQ (XCAR (spec
), Qleft_fringe
))
4928 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4929 it
->left_user_fringe_face_id
= face_id
;
4933 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4934 it
->right_user_fringe_face_id
= face_id
;
4937 #endif /* HAVE_WINDOW_SYSTEM */
4941 /* Prepare to handle `((margin left-margin) ...)',
4942 `((margin right-margin) ...)' and `((margin nil) ...)'
4943 prefixes for display specifications. */
4944 location
= Qunbound
;
4945 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4949 value
= XCDR (spec
);
4951 value
= XCAR (value
);
4954 if (EQ (XCAR (tem
), Qmargin
)
4955 && (tem
= XCDR (tem
),
4956 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4958 || EQ (tem
, Qleft_margin
)
4959 || EQ (tem
, Qright_margin
))))
4963 if (EQ (location
, Qunbound
))
4969 /* After this point, VALUE is the property after any
4970 margin prefix has been stripped. It must be a string,
4971 an image specification, or `(space ...)'.
4973 LOCATION specifies where to display: `left-margin',
4974 `right-margin' or nil. */
4976 valid_p
= (STRINGP (value
)
4977 #ifdef HAVE_WINDOW_SYSTEM
4978 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4979 && valid_image_p (value
))
4980 #endif /* not HAVE_WINDOW_SYSTEM */
4981 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4982 #ifdef HAVE_XWIDGETS
4987 if (valid_p
&& !display_replaced_p
)
4993 /* Callers need to know whether the display spec is any kind
4994 of `(space ...)' spec that is about to affect text-area
4996 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5001 /* Save current settings of IT so that we can restore them
5002 when we are finished with the glyph property value. */
5003 push_it (it
, position
);
5004 it
->from_overlay
= overlay
;
5005 it
->from_disp_prop_p
= 1;
5007 if (NILP (location
))
5008 it
->area
= TEXT_AREA
;
5009 else if (EQ (location
, Qleft_margin
))
5010 it
->area
= LEFT_MARGIN_AREA
;
5012 it
->area
= RIGHT_MARGIN_AREA
;
5014 if (STRINGP (value
))
5017 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5018 it
->current
.overlay_string_index
= -1;
5019 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5020 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5021 it
->method
= GET_FROM_STRING
;
5022 it
->stop_charpos
= 0;
5024 it
->base_level_stop
= 0;
5025 it
->string_from_display_prop_p
= 1;
5026 /* Say that we haven't consumed the characters with
5027 `display' property yet. The call to pop_it in
5028 set_iterator_to_next will clean this up. */
5029 if (BUFFERP (object
))
5030 *position
= start_pos
;
5032 /* Force paragraph direction to be that of the parent
5033 object. If the parent object's paragraph direction is
5034 not yet determined, default to L2R. */
5035 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5036 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5038 it
->paragraph_embedding
= L2R
;
5040 /* Set up the bidi iterator for this display string. */
5043 it
->bidi_it
.string
.lstring
= it
->string
;
5044 it
->bidi_it
.string
.s
= NULL
;
5045 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5046 it
->bidi_it
.string
.bufpos
= bufpos
;
5047 it
->bidi_it
.string
.from_disp_str
= 1;
5048 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5049 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5052 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5054 it
->method
= GET_FROM_STRETCH
;
5056 *position
= it
->position
= start_pos
;
5057 retval
= 1 + (it
->area
== TEXT_AREA
);
5059 #ifdef HAVE_XWIDGETS
5060 else if (XWIDGETP(value
))
5062 //printf("handle_single_display_spec: im an xwidget!!\n");
5063 it
->what
= IT_XWIDGET
;
5064 it
->method
= GET_FROM_XWIDGET
;
5065 it
->position
= start_pos
;
5066 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5067 *position
= start_pos
;
5069 it
->xwidget
= lookup_xwidget(value
);
5072 #ifdef HAVE_WINDOW_SYSTEM
5075 it
->what
= IT_IMAGE
;
5076 it
->image_id
= lookup_image (it
->f
, value
);
5077 it
->position
= start_pos
;
5078 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5079 it
->method
= GET_FROM_IMAGE
;
5081 /* Say that we haven't consumed the characters with
5082 `display' property yet. The call to pop_it in
5083 set_iterator_to_next will clean this up. */
5084 *position
= start_pos
;
5086 #endif /* HAVE_WINDOW_SYSTEM */
5091 /* Invalid property or property not supported. Restore
5092 POSITION to what it was before. */
5093 *position
= start_pos
;
5097 /* Check if PROP is a display property value whose text should be
5098 treated as intangible. OVERLAY is the overlay from which PROP
5099 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5100 specify the buffer position covered by PROP. */
5103 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5104 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5106 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5107 struct text_pos position
;
5109 SET_TEXT_POS (position
, charpos
, bytepos
);
5110 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5111 &position
, charpos
, frame_window_p
);
5115 /* Return 1 if PROP is a display sub-property value containing STRING.
5117 Implementation note: this and the following function are really
5118 special cases of handle_display_spec and
5119 handle_single_display_spec, and should ideally use the same code.
5120 Until they do, these two pairs must be consistent and must be
5121 modified in sync. */
5124 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5126 if (EQ (string
, prop
))
5129 /* Skip over `when FORM'. */
5130 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5135 /* Actually, the condition following `when' should be eval'ed,
5136 like handle_single_display_spec does, and we should return
5137 zero if it evaluates to nil. However, this function is
5138 called only when the buffer was already displayed and some
5139 glyph in the glyph matrix was found to come from a display
5140 string. Therefore, the condition was already evaluated, and
5141 the result was non-nil, otherwise the display string wouldn't
5142 have been displayed and we would have never been called for
5143 this property. Thus, we can skip the evaluation and assume
5144 its result is non-nil. */
5149 /* Skip over `margin LOCATION'. */
5150 if (EQ (XCAR (prop
), Qmargin
))
5161 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5165 /* Return 1 if STRING appears in the `display' property PROP. */
5168 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5171 && !EQ (XCAR (prop
), Qwhen
)
5172 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5174 /* A list of sub-properties. */
5175 while (CONSP (prop
))
5177 if (single_display_spec_string_p (XCAR (prop
), string
))
5182 else if (VECTORP (prop
))
5184 /* A vector of sub-properties. */
5186 for (i
= 0; i
< ASIZE (prop
); ++i
)
5187 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5191 return single_display_spec_string_p (prop
, string
);
5196 /* Look for STRING in overlays and text properties in the current
5197 buffer, between character positions FROM and TO (excluding TO).
5198 BACK_P non-zero means look back (in this case, TO is supposed to be
5200 Value is the first character position where STRING was found, or
5201 zero if it wasn't found before hitting TO.
5203 This function may only use code that doesn't eval because it is
5204 called asynchronously from note_mouse_highlight. */
5207 string_buffer_position_lim (Lisp_Object string
,
5208 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5210 Lisp_Object limit
, prop
, pos
;
5213 pos
= make_number (max (from
, BEGV
));
5215 if (!back_p
) /* looking forward */
5217 limit
= make_number (min (to
, ZV
));
5218 while (!found
&& !EQ (pos
, limit
))
5220 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5221 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5224 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5228 else /* looking back */
5230 limit
= make_number (max (to
, BEGV
));
5231 while (!found
&& !EQ (pos
, limit
))
5233 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5234 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5237 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5242 return found
? XINT (pos
) : 0;
5245 /* Determine which buffer position in current buffer STRING comes from.
5246 AROUND_CHARPOS is an approximate position where it could come from.
5247 Value is the buffer position or 0 if it couldn't be determined.
5249 This function is necessary because we don't record buffer positions
5250 in glyphs generated from strings (to keep struct glyph small).
5251 This function may only use code that doesn't eval because it is
5252 called asynchronously from note_mouse_highlight. */
5255 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5257 const int MAX_DISTANCE
= 1000;
5258 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5259 around_charpos
+ MAX_DISTANCE
,
5263 found
= string_buffer_position_lim (string
, around_charpos
,
5264 around_charpos
- MAX_DISTANCE
, 1);
5270 /***********************************************************************
5271 `composition' property
5272 ***********************************************************************/
5274 /* Set up iterator IT from `composition' property at its current
5275 position. Called from handle_stop. */
5277 static enum prop_handled
5278 handle_composition_prop (struct it
*it
)
5280 Lisp_Object prop
, string
;
5281 ptrdiff_t pos
, pos_byte
, start
, end
;
5283 if (STRINGP (it
->string
))
5287 pos
= IT_STRING_CHARPOS (*it
);
5288 pos_byte
= IT_STRING_BYTEPOS (*it
);
5289 string
= it
->string
;
5290 s
= SDATA (string
) + pos_byte
;
5291 it
->c
= STRING_CHAR (s
);
5295 pos
= IT_CHARPOS (*it
);
5296 pos_byte
= IT_BYTEPOS (*it
);
5298 it
->c
= FETCH_CHAR (pos_byte
);
5301 /* If there's a valid composition and point is not inside of the
5302 composition (in the case that the composition is from the current
5303 buffer), draw a glyph composed from the composition components. */
5304 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5305 && COMPOSITION_VALID_P (start
, end
, prop
)
5306 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5309 /* As we can't handle this situation (perhaps font-lock added
5310 a new composition), we just return here hoping that next
5311 redisplay will detect this composition much earlier. */
5312 return HANDLED_NORMALLY
;
5315 if (STRINGP (it
->string
))
5316 pos_byte
= string_char_to_byte (it
->string
, start
);
5318 pos_byte
= CHAR_TO_BYTE (start
);
5320 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5323 if (it
->cmp_it
.id
>= 0)
5326 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5327 it
->cmp_it
.nglyphs
= -1;
5331 return HANDLED_NORMALLY
;
5336 /***********************************************************************
5338 ***********************************************************************/
5340 /* The following structure is used to record overlay strings for
5341 later sorting in load_overlay_strings. */
5343 struct overlay_entry
5345 Lisp_Object overlay
;
5352 /* Set up iterator IT from overlay strings at its current position.
5353 Called from handle_stop. */
5355 static enum prop_handled
5356 handle_overlay_change (struct it
*it
)
5358 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5359 return HANDLED_RECOMPUTE_PROPS
;
5361 return HANDLED_NORMALLY
;
5365 /* Set up the next overlay string for delivery by IT, if there is an
5366 overlay string to deliver. Called by set_iterator_to_next when the
5367 end of the current overlay string is reached. If there are more
5368 overlay strings to display, IT->string and
5369 IT->current.overlay_string_index are set appropriately here.
5370 Otherwise IT->string is set to nil. */
5373 next_overlay_string (struct it
*it
)
5375 ++it
->current
.overlay_string_index
;
5376 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5378 /* No more overlay strings. Restore IT's settings to what
5379 they were before overlay strings were processed, and
5380 continue to deliver from current_buffer. */
5382 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5385 || (NILP (it
->string
)
5386 && it
->method
== GET_FROM_BUFFER
5387 && it
->stop_charpos
>= BEGV
5388 && it
->stop_charpos
<= it
->end_charpos
));
5389 it
->current
.overlay_string_index
= -1;
5390 it
->n_overlay_strings
= 0;
5391 it
->overlay_strings_charpos
= -1;
5392 /* If there's an empty display string on the stack, pop the
5393 stack, to resync the bidi iterator with IT's position. Such
5394 empty strings are pushed onto the stack in
5395 get_overlay_strings_1. */
5396 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5399 /* If we're at the end of the buffer, record that we have
5400 processed the overlay strings there already, so that
5401 next_element_from_buffer doesn't try it again. */
5402 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5403 it
->overlay_strings_at_end_processed_p
= 1;
5407 /* There are more overlay strings to process. If
5408 IT->current.overlay_string_index has advanced to a position
5409 where we must load IT->overlay_strings with more strings, do
5410 it. We must load at the IT->overlay_strings_charpos where
5411 IT->n_overlay_strings was originally computed; when invisible
5412 text is present, this might not be IT_CHARPOS (Bug#7016). */
5413 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5415 if (it
->current
.overlay_string_index
&& i
== 0)
5416 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5418 /* Initialize IT to deliver display elements from the overlay
5420 it
->string
= it
->overlay_strings
[i
];
5421 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5422 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5423 it
->method
= GET_FROM_STRING
;
5424 it
->stop_charpos
= 0;
5425 it
->end_charpos
= SCHARS (it
->string
);
5426 if (it
->cmp_it
.stop_pos
>= 0)
5427 it
->cmp_it
.stop_pos
= 0;
5429 it
->base_level_stop
= 0;
5431 /* Set up the bidi iterator for this overlay string. */
5434 it
->bidi_it
.string
.lstring
= it
->string
;
5435 it
->bidi_it
.string
.s
= NULL
;
5436 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5437 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5438 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5439 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5440 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5448 /* Compare two overlay_entry structures E1 and E2. Used as a
5449 comparison function for qsort in load_overlay_strings. Overlay
5450 strings for the same position are sorted so that
5452 1. All after-strings come in front of before-strings, except
5453 when they come from the same overlay.
5455 2. Within after-strings, strings are sorted so that overlay strings
5456 from overlays with higher priorities come first.
5458 2. Within before-strings, strings are sorted so that overlay
5459 strings from overlays with higher priorities come last.
5461 Value is analogous to strcmp. */
5465 compare_overlay_entries (const void *e1
, const void *e2
)
5467 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5468 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5471 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5473 /* Let after-strings appear in front of before-strings if
5474 they come from different overlays. */
5475 if (EQ (entry1
->overlay
, entry2
->overlay
))
5476 result
= entry1
->after_string_p
? 1 : -1;
5478 result
= entry1
->after_string_p
? -1 : 1;
5480 else if (entry1
->priority
!= entry2
->priority
)
5482 if (entry1
->after_string_p
)
5483 /* After-strings sorted in order of decreasing priority. */
5484 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5486 /* Before-strings sorted in order of increasing priority. */
5487 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5496 /* Load the vector IT->overlay_strings with overlay strings from IT's
5497 current buffer position, or from CHARPOS if that is > 0. Set
5498 IT->n_overlays to the total number of overlay strings found.
5500 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5501 a time. On entry into load_overlay_strings,
5502 IT->current.overlay_string_index gives the number of overlay
5503 strings that have already been loaded by previous calls to this
5506 IT->add_overlay_start contains an additional overlay start
5507 position to consider for taking overlay strings from, if non-zero.
5508 This position comes into play when the overlay has an `invisible'
5509 property, and both before and after-strings. When we've skipped to
5510 the end of the overlay, because of its `invisible' property, we
5511 nevertheless want its before-string to appear.
5512 IT->add_overlay_start will contain the overlay start position
5515 Overlay strings are sorted so that after-string strings come in
5516 front of before-string strings. Within before and after-strings,
5517 strings are sorted by overlay priority. See also function
5518 compare_overlay_entries. */
5521 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5523 Lisp_Object overlay
, window
, str
, invisible
;
5524 struct Lisp_Overlay
*ov
;
5525 ptrdiff_t start
, end
;
5526 ptrdiff_t size
= 20;
5527 ptrdiff_t n
= 0, i
, j
;
5529 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5533 charpos
= IT_CHARPOS (*it
);
5535 /* Append the overlay string STRING of overlay OVERLAY to vector
5536 `entries' which has size `size' and currently contains `n'
5537 elements. AFTER_P non-zero means STRING is an after-string of
5539 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5542 Lisp_Object priority; \
5546 struct overlay_entry *old = entries; \
5547 SAFE_NALLOCA (entries, 2, size); \
5548 memcpy (entries, old, size * sizeof *entries); \
5552 entries[n].string = (STRING); \
5553 entries[n].overlay = (OVERLAY); \
5554 priority = Foverlay_get ((OVERLAY), Qpriority); \
5555 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5556 entries[n].after_string_p = (AFTER_P); \
5561 /* Process overlay before the overlay center. */
5562 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5564 XSETMISC (overlay
, ov
);
5565 eassert (OVERLAYP (overlay
));
5566 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5567 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5572 /* Skip this overlay if it doesn't start or end at IT's current
5574 if (end
!= charpos
&& start
!= charpos
)
5577 /* Skip this overlay if it doesn't apply to IT->w. */
5578 window
= Foverlay_get (overlay
, Qwindow
);
5579 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5582 /* If the text ``under'' the overlay is invisible, both before-
5583 and after-strings from this overlay are visible; start and
5584 end position are indistinguishable. */
5585 invisible
= Foverlay_get (overlay
, Qinvisible
);
5586 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5588 /* If overlay has a non-empty before-string, record it. */
5589 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5590 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5592 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5594 /* If overlay has a non-empty after-string, record it. */
5595 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5596 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5598 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5601 /* Process overlays after the overlay center. */
5602 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5604 XSETMISC (overlay
, ov
);
5605 eassert (OVERLAYP (overlay
));
5606 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5607 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5609 if (start
> charpos
)
5612 /* Skip this overlay if it doesn't start or end at IT's current
5614 if (end
!= charpos
&& start
!= charpos
)
5617 /* Skip this overlay if it doesn't apply to IT->w. */
5618 window
= Foverlay_get (overlay
, Qwindow
);
5619 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5622 /* If the text ``under'' the overlay is invisible, it has a zero
5623 dimension, and both before- and after-strings apply. */
5624 invisible
= Foverlay_get (overlay
, Qinvisible
);
5625 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5627 /* If overlay has a non-empty before-string, record it. */
5628 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5629 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5631 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5633 /* If overlay has a non-empty after-string, record it. */
5634 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5635 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5637 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5640 #undef RECORD_OVERLAY_STRING
5644 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5646 /* Record number of overlay strings, and where we computed it. */
5647 it
->n_overlay_strings
= n
;
5648 it
->overlay_strings_charpos
= charpos
;
5650 /* IT->current.overlay_string_index is the number of overlay strings
5651 that have already been consumed by IT. Copy some of the
5652 remaining overlay strings to IT->overlay_strings. */
5654 j
= it
->current
.overlay_string_index
;
5655 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5657 it
->overlay_strings
[i
] = entries
[j
].string
;
5658 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5666 /* Get the first chunk of overlay strings at IT's current buffer
5667 position, or at CHARPOS if that is > 0. Value is non-zero if at
5668 least one overlay string was found. */
5671 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5673 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5674 process. This fills IT->overlay_strings with strings, and sets
5675 IT->n_overlay_strings to the total number of strings to process.
5676 IT->pos.overlay_string_index has to be set temporarily to zero
5677 because load_overlay_strings needs this; it must be set to -1
5678 when no overlay strings are found because a zero value would
5679 indicate a position in the first overlay string. */
5680 it
->current
.overlay_string_index
= 0;
5681 load_overlay_strings (it
, charpos
);
5683 /* If we found overlay strings, set up IT to deliver display
5684 elements from the first one. Otherwise set up IT to deliver
5685 from current_buffer. */
5686 if (it
->n_overlay_strings
)
5688 /* Make sure we know settings in current_buffer, so that we can
5689 restore meaningful values when we're done with the overlay
5692 compute_stop_pos (it
);
5693 eassert (it
->face_id
>= 0);
5695 /* Save IT's settings. They are restored after all overlay
5696 strings have been processed. */
5697 eassert (!compute_stop_p
|| it
->sp
== 0);
5699 /* When called from handle_stop, there might be an empty display
5700 string loaded. In that case, don't bother saving it. But
5701 don't use this optimization with the bidi iterator, since we
5702 need the corresponding pop_it call to resync the bidi
5703 iterator's position with IT's position, after we are done
5704 with the overlay strings. (The corresponding call to pop_it
5705 in case of an empty display string is in
5706 next_overlay_string.) */
5708 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5711 /* Set up IT to deliver display elements from the first overlay
5713 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5714 it
->string
= it
->overlay_strings
[0];
5715 it
->from_overlay
= Qnil
;
5716 it
->stop_charpos
= 0;
5717 eassert (STRINGP (it
->string
));
5718 it
->end_charpos
= SCHARS (it
->string
);
5720 it
->base_level_stop
= 0;
5721 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5722 it
->method
= GET_FROM_STRING
;
5723 it
->from_disp_prop_p
= 0;
5725 /* Force paragraph direction to be that of the parent
5727 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5728 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5730 it
->paragraph_embedding
= L2R
;
5732 /* Set up the bidi iterator for this overlay string. */
5735 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5737 it
->bidi_it
.string
.lstring
= it
->string
;
5738 it
->bidi_it
.string
.s
= NULL
;
5739 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5740 it
->bidi_it
.string
.bufpos
= pos
;
5741 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5742 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5743 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5748 it
->current
.overlay_string_index
= -1;
5753 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5756 it
->method
= GET_FROM_BUFFER
;
5758 (void) get_overlay_strings_1 (it
, charpos
, 1);
5762 /* Value is non-zero if we found at least one overlay string. */
5763 return STRINGP (it
->string
);
5768 /***********************************************************************
5769 Saving and restoring state
5770 ***********************************************************************/
5772 /* Save current settings of IT on IT->stack. Called, for example,
5773 before setting up IT for an overlay string, to be able to restore
5774 IT's settings to what they were after the overlay string has been
5775 processed. If POSITION is non-NULL, it is the position to save on
5776 the stack instead of IT->position. */
5779 push_it (struct it
*it
, struct text_pos
*position
)
5781 struct iterator_stack_entry
*p
;
5783 eassert (it
->sp
< IT_STACK_SIZE
);
5784 p
= it
->stack
+ it
->sp
;
5786 p
->stop_charpos
= it
->stop_charpos
;
5787 p
->prev_stop
= it
->prev_stop
;
5788 p
->base_level_stop
= it
->base_level_stop
;
5789 p
->cmp_it
= it
->cmp_it
;
5790 eassert (it
->face_id
>= 0);
5791 p
->face_id
= it
->face_id
;
5792 p
->string
= it
->string
;
5793 p
->method
= it
->method
;
5794 p
->from_overlay
= it
->from_overlay
;
5797 case GET_FROM_IMAGE
:
5798 p
->u
.image
.object
= it
->object
;
5799 p
->u
.image
.image_id
= it
->image_id
;
5800 p
->u
.image
.slice
= it
->slice
;
5802 case GET_FROM_STRETCH
:
5803 p
->u
.stretch
.object
= it
->object
;
5805 #ifdef HAVE_XWIDGETS
5806 case GET_FROM_XWIDGET
:
5807 p
->u
.xwidget
.object
= it
->object
;
5811 p
->position
= position
? *position
: it
->position
;
5812 p
->current
= it
->current
;
5813 p
->end_charpos
= it
->end_charpos
;
5814 p
->string_nchars
= it
->string_nchars
;
5816 p
->multibyte_p
= it
->multibyte_p
;
5817 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5818 p
->space_width
= it
->space_width
;
5819 p
->font_height
= it
->font_height
;
5820 p
->voffset
= it
->voffset
;
5821 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5822 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5823 p
->display_ellipsis_p
= 0;
5824 p
->line_wrap
= it
->line_wrap
;
5825 p
->bidi_p
= it
->bidi_p
;
5826 p
->paragraph_embedding
= it
->paragraph_embedding
;
5827 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5830 /* Save the state of the bidi iterator as well. */
5832 bidi_push_it (&it
->bidi_it
);
5836 iterate_out_of_display_property (struct it
*it
)
5838 int buffer_p
= !STRINGP (it
->string
);
5839 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5840 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5842 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5844 /* Maybe initialize paragraph direction. If we are at the beginning
5845 of a new paragraph, next_element_from_buffer may not have a
5846 chance to do that. */
5847 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5848 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5849 /* prev_stop can be zero, so check against BEGV as well. */
5850 while (it
->bidi_it
.charpos
>= bob
5851 && it
->prev_stop
<= it
->bidi_it
.charpos
5852 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5853 && it
->bidi_it
.charpos
< eob
)
5854 bidi_move_to_visually_next (&it
->bidi_it
);
5855 /* Record the stop_pos we just crossed, for when we cross it
5857 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5858 it
->prev_stop
= CHARPOS (it
->position
);
5859 /* If we ended up not where pop_it put us, resync IT's
5860 positional members with the bidi iterator. */
5861 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5862 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5864 it
->current
.pos
= it
->position
;
5866 it
->current
.string_pos
= it
->position
;
5869 /* Restore IT's settings from IT->stack. Called, for example, when no
5870 more overlay strings must be processed, and we return to delivering
5871 display elements from a buffer, or when the end of a string from a
5872 `display' property is reached and we return to delivering display
5873 elements from an overlay string, or from a buffer. */
5876 pop_it (struct it
*it
)
5878 struct iterator_stack_entry
*p
;
5879 int from_display_prop
= it
->from_disp_prop_p
;
5881 eassert (it
->sp
> 0);
5883 p
= it
->stack
+ it
->sp
;
5884 it
->stop_charpos
= p
->stop_charpos
;
5885 it
->prev_stop
= p
->prev_stop
;
5886 it
->base_level_stop
= p
->base_level_stop
;
5887 it
->cmp_it
= p
->cmp_it
;
5888 it
->face_id
= p
->face_id
;
5889 it
->current
= p
->current
;
5890 it
->position
= p
->position
;
5891 it
->string
= p
->string
;
5892 it
->from_overlay
= p
->from_overlay
;
5893 if (NILP (it
->string
))
5894 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5895 it
->method
= p
->method
;
5898 case GET_FROM_IMAGE
:
5899 it
->image_id
= p
->u
.image
.image_id
;
5900 it
->object
= p
->u
.image
.object
;
5901 it
->slice
= p
->u
.image
.slice
;
5903 #ifdef HAVE_XWIDGETS
5904 case GET_FROM_XWIDGET
:
5905 it
->object
= p
->u
.xwidget
.object
;
5908 case GET_FROM_STRETCH
:
5909 it
->object
= p
->u
.stretch
.object
;
5911 case GET_FROM_BUFFER
:
5912 it
->object
= it
->w
->buffer
;
5914 case GET_FROM_STRING
:
5915 it
->object
= it
->string
;
5917 case GET_FROM_DISPLAY_VECTOR
:
5919 it
->method
= GET_FROM_C_STRING
;
5920 else if (STRINGP (it
->string
))
5921 it
->method
= GET_FROM_STRING
;
5924 it
->method
= GET_FROM_BUFFER
;
5925 it
->object
= it
->w
->buffer
;
5928 it
->end_charpos
= p
->end_charpos
;
5929 it
->string_nchars
= p
->string_nchars
;
5931 it
->multibyte_p
= p
->multibyte_p
;
5932 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5933 it
->space_width
= p
->space_width
;
5934 it
->font_height
= p
->font_height
;
5935 it
->voffset
= p
->voffset
;
5936 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5937 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5938 it
->line_wrap
= p
->line_wrap
;
5939 it
->bidi_p
= p
->bidi_p
;
5940 it
->paragraph_embedding
= p
->paragraph_embedding
;
5941 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5944 bidi_pop_it (&it
->bidi_it
);
5945 /* Bidi-iterate until we get out of the portion of text, if any,
5946 covered by a `display' text property or by an overlay with
5947 `display' property. (We cannot just jump there, because the
5948 internal coherency of the bidi iterator state can not be
5949 preserved across such jumps.) We also must determine the
5950 paragraph base direction if the overlay we just processed is
5951 at the beginning of a new paragraph. */
5952 if (from_display_prop
5953 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5954 iterate_out_of_display_property (it
);
5956 eassert ((BUFFERP (it
->object
)
5957 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5958 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5959 || (STRINGP (it
->object
)
5960 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5961 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5962 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5968 /***********************************************************************
5970 ***********************************************************************/
5972 /* Set IT's current position to the previous line start. */
5975 back_to_previous_line_start (struct it
*it
)
5977 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5978 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5982 /* Move IT to the next line start.
5984 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5985 we skipped over part of the text (as opposed to moving the iterator
5986 continuously over the text). Otherwise, don't change the value
5989 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5990 iterator on the newline, if it was found.
5992 Newlines may come from buffer text, overlay strings, or strings
5993 displayed via the `display' property. That's the reason we can't
5994 simply use find_next_newline_no_quit.
5996 Note that this function may not skip over invisible text that is so
5997 because of text properties and immediately follows a newline. If
5998 it would, function reseat_at_next_visible_line_start, when called
5999 from set_iterator_to_next, would effectively make invisible
6000 characters following a newline part of the wrong glyph row, which
6001 leads to wrong cursor motion. */
6004 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6005 struct bidi_it
*bidi_it_prev
)
6007 ptrdiff_t old_selective
;
6008 int newline_found_p
, n
;
6009 const int MAX_NEWLINE_DISTANCE
= 500;
6011 /* If already on a newline, just consume it to avoid unintended
6012 skipping over invisible text below. */
6013 if (it
->what
== IT_CHARACTER
6015 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6017 if (it
->bidi_p
&& bidi_it_prev
)
6018 *bidi_it_prev
= it
->bidi_it
;
6019 set_iterator_to_next (it
, 0);
6024 /* Don't handle selective display in the following. It's (a)
6025 unnecessary because it's done by the caller, and (b) leads to an
6026 infinite recursion because next_element_from_ellipsis indirectly
6027 calls this function. */
6028 old_selective
= it
->selective
;
6031 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6032 from buffer text. */
6033 for (n
= newline_found_p
= 0;
6034 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6035 n
+= STRINGP (it
->string
) ? 0 : 1)
6037 if (!get_next_display_element (it
))
6039 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6040 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6041 *bidi_it_prev
= it
->bidi_it
;
6042 set_iterator_to_next (it
, 0);
6045 /* If we didn't find a newline near enough, see if we can use a
6047 if (!newline_found_p
)
6049 ptrdiff_t start
= IT_CHARPOS (*it
);
6050 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
6053 eassert (!STRINGP (it
->string
));
6055 /* If there isn't any `display' property in sight, and no
6056 overlays, we can just use the position of the newline in
6058 if (it
->stop_charpos
>= limit
6059 || ((pos
= Fnext_single_property_change (make_number (start
),
6061 make_number (limit
)),
6063 && next_overlay_change (start
) == ZV
))
6067 IT_CHARPOS (*it
) = limit
;
6068 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
6072 struct bidi_it bprev
;
6074 /* Help bidi.c avoid expensive searches for display
6075 properties and overlays, by telling it that there are
6076 none up to `limit'. */
6077 if (it
->bidi_it
.disp_pos
< limit
)
6079 it
->bidi_it
.disp_pos
= limit
;
6080 it
->bidi_it
.disp_prop
= 0;
6083 bprev
= it
->bidi_it
;
6084 bidi_move_to_visually_next (&it
->bidi_it
);
6085 } while (it
->bidi_it
.charpos
!= limit
);
6086 IT_CHARPOS (*it
) = limit
;
6087 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6089 *bidi_it_prev
= bprev
;
6091 *skipped_p
= newline_found_p
= 1;
6095 while (get_next_display_element (it
)
6096 && !newline_found_p
)
6098 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6099 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6100 *bidi_it_prev
= it
->bidi_it
;
6101 set_iterator_to_next (it
, 0);
6106 it
->selective
= old_selective
;
6107 return newline_found_p
;
6111 /* Set IT's current position to the previous visible line start. Skip
6112 invisible text that is so either due to text properties or due to
6113 selective display. Caution: this does not change IT->current_x and
6117 back_to_previous_visible_line_start (struct it
*it
)
6119 while (IT_CHARPOS (*it
) > BEGV
)
6121 back_to_previous_line_start (it
);
6123 if (IT_CHARPOS (*it
) <= BEGV
)
6126 /* If selective > 0, then lines indented more than its value are
6128 if (it
->selective
> 0
6129 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6133 /* Check the newline before point for invisibility. */
6136 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6137 Qinvisible
, it
->window
);
6138 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6142 if (IT_CHARPOS (*it
) <= BEGV
)
6147 void *it2data
= NULL
;
6150 Lisp_Object val
, overlay
;
6152 SAVE_IT (it2
, *it
, it2data
);
6154 /* If newline is part of a composition, continue from start of composition */
6155 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6156 && beg
< IT_CHARPOS (*it
))
6159 /* If newline is replaced by a display property, find start of overlay
6160 or interval and continue search from that point. */
6161 pos
= --IT_CHARPOS (it2
);
6164 bidi_unshelve_cache (NULL
, 0);
6165 it2
.string_from_display_prop_p
= 0;
6166 it2
.from_disp_prop_p
= 0;
6167 if (handle_display_prop (&it2
) == HANDLED_RETURN
6168 && !NILP (val
= get_char_property_and_overlay
6169 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6170 && (OVERLAYP (overlay
)
6171 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6172 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6174 RESTORE_IT (it
, it
, it2data
);
6178 /* Newline is not replaced by anything -- so we are done. */
6179 RESTORE_IT (it
, it
, it2data
);
6185 IT_CHARPOS (*it
) = beg
;
6186 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6190 it
->continuation_lines_width
= 0;
6192 eassert (IT_CHARPOS (*it
) >= BEGV
);
6193 eassert (IT_CHARPOS (*it
) == BEGV
6194 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6199 /* Reseat iterator IT at the previous visible line start. Skip
6200 invisible text that is so either due to text properties or due to
6201 selective display. At the end, update IT's overlay information,
6202 face information etc. */
6205 reseat_at_previous_visible_line_start (struct it
*it
)
6207 back_to_previous_visible_line_start (it
);
6208 reseat (it
, it
->current
.pos
, 1);
6213 /* Reseat iterator IT on the next visible line start in the current
6214 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6215 preceding the line start. Skip over invisible text that is so
6216 because of selective display. Compute faces, overlays etc at the
6217 new position. Note that this function does not skip over text that
6218 is invisible because of text properties. */
6221 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6223 int newline_found_p
, skipped_p
= 0;
6224 struct bidi_it bidi_it_prev
;
6226 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6228 /* Skip over lines that are invisible because they are indented
6229 more than the value of IT->selective. */
6230 if (it
->selective
> 0)
6231 while (IT_CHARPOS (*it
) < ZV
6232 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6235 eassert (IT_BYTEPOS (*it
) == BEGV
6236 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6238 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6241 /* Position on the newline if that's what's requested. */
6242 if (on_newline_p
&& newline_found_p
)
6244 if (STRINGP (it
->string
))
6246 if (IT_STRING_CHARPOS (*it
) > 0)
6250 --IT_STRING_CHARPOS (*it
);
6251 --IT_STRING_BYTEPOS (*it
);
6255 /* We need to restore the bidi iterator to the state
6256 it had on the newline, and resync the IT's
6257 position with that. */
6258 it
->bidi_it
= bidi_it_prev
;
6259 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6260 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6264 else if (IT_CHARPOS (*it
) > BEGV
)
6273 /* We need to restore the bidi iterator to the state it
6274 had on the newline and resync IT with that. */
6275 it
->bidi_it
= bidi_it_prev
;
6276 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6277 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6279 reseat (it
, it
->current
.pos
, 0);
6283 reseat (it
, it
->current
.pos
, 0);
6290 /***********************************************************************
6291 Changing an iterator's position
6292 ***********************************************************************/
6294 /* Change IT's current position to POS in current_buffer. If FORCE_P
6295 is non-zero, always check for text properties at the new position.
6296 Otherwise, text properties are only looked up if POS >=
6297 IT->check_charpos of a property. */
6300 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6302 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6304 reseat_1 (it
, pos
, 0);
6306 /* Determine where to check text properties. Avoid doing it
6307 where possible because text property lookup is very expensive. */
6309 || CHARPOS (pos
) > it
->stop_charpos
6310 || CHARPOS (pos
) < original_pos
)
6314 /* For bidi iteration, we need to prime prev_stop and
6315 base_level_stop with our best estimations. */
6316 /* Implementation note: Of course, POS is not necessarily a
6317 stop position, so assigning prev_pos to it is a lie; we
6318 should have called compute_stop_backwards. However, if
6319 the current buffer does not include any R2L characters,
6320 that call would be a waste of cycles, because the
6321 iterator will never move back, and thus never cross this
6322 "fake" stop position. So we delay that backward search
6323 until the time we really need it, in next_element_from_buffer. */
6324 if (CHARPOS (pos
) != it
->prev_stop
)
6325 it
->prev_stop
= CHARPOS (pos
);
6326 if (CHARPOS (pos
) < it
->base_level_stop
)
6327 it
->base_level_stop
= 0; /* meaning it's unknown */
6333 it
->prev_stop
= it
->base_level_stop
= 0;
6342 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6343 IT->stop_pos to POS, also. */
6346 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6348 /* Don't call this function when scanning a C string. */
6349 eassert (it
->s
== NULL
);
6351 /* POS must be a reasonable value. */
6352 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6354 it
->current
.pos
= it
->position
= pos
;
6355 it
->end_charpos
= ZV
;
6357 it
->current
.dpvec_index
= -1;
6358 it
->current
.overlay_string_index
= -1;
6359 IT_STRING_CHARPOS (*it
) = -1;
6360 IT_STRING_BYTEPOS (*it
) = -1;
6362 it
->method
= GET_FROM_BUFFER
;
6363 it
->object
= it
->w
->buffer
;
6364 it
->area
= TEXT_AREA
;
6365 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6367 it
->string_from_display_prop_p
= 0;
6368 it
->string_from_prefix_prop_p
= 0;
6370 it
->from_disp_prop_p
= 0;
6371 it
->face_before_selective_p
= 0;
6374 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6376 bidi_unshelve_cache (NULL
, 0);
6377 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6378 it
->bidi_it
.string
.s
= NULL
;
6379 it
->bidi_it
.string
.lstring
= Qnil
;
6380 it
->bidi_it
.string
.bufpos
= 0;
6381 it
->bidi_it
.string
.unibyte
= 0;
6386 it
->stop_charpos
= CHARPOS (pos
);
6387 it
->base_level_stop
= CHARPOS (pos
);
6389 /* This make the information stored in it->cmp_it invalidate. */
6394 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6395 If S is non-null, it is a C string to iterate over. Otherwise,
6396 STRING gives a Lisp string to iterate over.
6398 If PRECISION > 0, don't return more then PRECISION number of
6399 characters from the string.
6401 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6402 characters have been returned. FIELD_WIDTH < 0 means an infinite
6405 MULTIBYTE = 0 means disable processing of multibyte characters,
6406 MULTIBYTE > 0 means enable it,
6407 MULTIBYTE < 0 means use IT->multibyte_p.
6409 IT must be initialized via a prior call to init_iterator before
6410 calling this function. */
6413 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6414 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6417 /* No region in strings. */
6418 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6420 /* No text property checks performed by default, but see below. */
6421 it
->stop_charpos
= -1;
6423 /* Set iterator position and end position. */
6424 memset (&it
->current
, 0, sizeof it
->current
);
6425 it
->current
.overlay_string_index
= -1;
6426 it
->current
.dpvec_index
= -1;
6427 eassert (charpos
>= 0);
6429 /* If STRING is specified, use its multibyteness, otherwise use the
6430 setting of MULTIBYTE, if specified. */
6432 it
->multibyte_p
= multibyte
> 0;
6434 /* Bidirectional reordering of strings is controlled by the default
6435 value of bidi-display-reordering. Don't try to reorder while
6436 loading loadup.el, as the necessary character property tables are
6437 not yet available. */
6440 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6444 eassert (STRINGP (string
));
6445 it
->string
= string
;
6447 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6448 it
->method
= GET_FROM_STRING
;
6449 it
->current
.string_pos
= string_pos (charpos
, string
);
6453 it
->bidi_it
.string
.lstring
= string
;
6454 it
->bidi_it
.string
.s
= NULL
;
6455 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6456 it
->bidi_it
.string
.bufpos
= 0;
6457 it
->bidi_it
.string
.from_disp_str
= 0;
6458 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6459 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6460 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6465 it
->s
= (const unsigned char *) s
;
6468 /* Note that we use IT->current.pos, not it->current.string_pos,
6469 for displaying C strings. */
6470 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6471 if (it
->multibyte_p
)
6473 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6474 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6478 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6479 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6484 it
->bidi_it
.string
.lstring
= Qnil
;
6485 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6486 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6487 it
->bidi_it
.string
.bufpos
= 0;
6488 it
->bidi_it
.string
.from_disp_str
= 0;
6489 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6490 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6493 it
->method
= GET_FROM_C_STRING
;
6496 /* PRECISION > 0 means don't return more than PRECISION characters
6498 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6500 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6502 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6505 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6506 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6507 FIELD_WIDTH < 0 means infinite field width. This is useful for
6508 padding with `-' at the end of a mode line. */
6509 if (field_width
< 0)
6510 field_width
= INFINITY
;
6511 /* Implementation note: We deliberately don't enlarge
6512 it->bidi_it.string.schars here to fit it->end_charpos, because
6513 the bidi iterator cannot produce characters out of thin air. */
6514 if (field_width
> it
->end_charpos
- charpos
)
6515 it
->end_charpos
= charpos
+ field_width
;
6517 /* Use the standard display table for displaying strings. */
6518 if (DISP_TABLE_P (Vstandard_display_table
))
6519 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6521 it
->stop_charpos
= charpos
;
6522 it
->prev_stop
= charpos
;
6523 it
->base_level_stop
= 0;
6526 it
->bidi_it
.first_elt
= 1;
6527 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6528 it
->bidi_it
.disp_pos
= -1;
6530 if (s
== NULL
&& it
->multibyte_p
)
6532 ptrdiff_t endpos
= SCHARS (it
->string
);
6533 if (endpos
> it
->end_charpos
)
6534 endpos
= it
->end_charpos
;
6535 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6543 /***********************************************************************
6545 ***********************************************************************/
6547 /* Map enum it_method value to corresponding next_element_from_* function. */
6549 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6551 next_element_from_buffer
,
6552 next_element_from_display_vector
,
6553 next_element_from_string
,
6554 next_element_from_c_string
,
6555 next_element_from_image
,
6556 next_element_from_stretch
6557 #ifdef HAVE_XWIDGETS
6558 ,next_element_from_xwidget
6562 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6565 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6566 (possibly with the following characters). */
6568 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6569 ((IT)->cmp_it.id >= 0 \
6570 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6571 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6572 END_CHARPOS, (IT)->w, \
6573 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6577 /* Lookup the char-table Vglyphless_char_display for character C (-1
6578 if we want information for no-font case), and return the display
6579 method symbol. By side-effect, update it->what and
6580 it->glyphless_method. This function is called from
6581 get_next_display_element for each character element, and from
6582 x_produce_glyphs when no suitable font was found. */
6585 lookup_glyphless_char_display (int c
, struct it
*it
)
6587 Lisp_Object glyphless_method
= Qnil
;
6589 if (CHAR_TABLE_P (Vglyphless_char_display
)
6590 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6594 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6595 if (CONSP (glyphless_method
))
6596 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6597 ? XCAR (glyphless_method
)
6598 : XCDR (glyphless_method
);
6601 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6605 if (NILP (glyphless_method
))
6608 /* The default is to display the character by a proper font. */
6610 /* The default for the no-font case is to display an empty box. */
6611 glyphless_method
= Qempty_box
;
6613 if (EQ (glyphless_method
, Qzero_width
))
6616 return glyphless_method
;
6617 /* This method can't be used for the no-font case. */
6618 glyphless_method
= Qempty_box
;
6620 if (EQ (glyphless_method
, Qthin_space
))
6621 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6622 else if (EQ (glyphless_method
, Qempty_box
))
6623 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6624 else if (EQ (glyphless_method
, Qhex_code
))
6625 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6626 else if (STRINGP (glyphless_method
))
6627 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6630 /* Invalid value. We use the default method. */
6631 glyphless_method
= Qnil
;
6634 it
->what
= IT_GLYPHLESS
;
6635 return glyphless_method
;
6638 /* Load IT's display element fields with information about the next
6639 display element from the current position of IT. Value is zero if
6640 end of buffer (or C string) is reached. */
6642 static struct frame
*last_escape_glyph_frame
= NULL
;
6643 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6644 static int last_escape_glyph_merged_face_id
= 0;
6646 struct frame
*last_glyphless_glyph_frame
= NULL
;
6647 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6648 int last_glyphless_glyph_merged_face_id
= 0;
6651 get_next_display_element (struct it
*it
)
6653 /* Non-zero means that we found a display element. Zero means that
6654 we hit the end of what we iterate over. Performance note: the
6655 function pointer `method' used here turns out to be faster than
6656 using a sequence of if-statements. */
6660 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6662 if (it
->what
== IT_CHARACTER
)
6664 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6665 and only if (a) the resolved directionality of that character
6667 /* FIXME: Do we need an exception for characters from display
6669 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6670 it
->c
= bidi_mirror_char (it
->c
);
6671 /* Map via display table or translate control characters.
6672 IT->c, IT->len etc. have been set to the next character by
6673 the function call above. If we have a display table, and it
6674 contains an entry for IT->c, translate it. Don't do this if
6675 IT->c itself comes from a display table, otherwise we could
6676 end up in an infinite recursion. (An alternative could be to
6677 count the recursion depth of this function and signal an
6678 error when a certain maximum depth is reached.) Is it worth
6680 if (success_p
&& it
->dpvec
== NULL
)
6683 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6684 int nonascii_space_p
= 0;
6685 int nonascii_hyphen_p
= 0;
6686 int c
= it
->c
; /* This is the character to display. */
6688 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6690 eassert (SINGLE_BYTE_CHAR_P (c
));
6691 if (unibyte_display_via_language_environment
)
6693 c
= DECODE_CHAR (unibyte
, c
);
6695 c
= BYTE8_TO_CHAR (it
->c
);
6698 c
= BYTE8_TO_CHAR (it
->c
);
6702 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6705 struct Lisp_Vector
*v
= XVECTOR (dv
);
6707 /* Return the first character from the display table
6708 entry, if not empty. If empty, don't display the
6709 current character. */
6712 it
->dpvec_char_len
= it
->len
;
6713 it
->dpvec
= v
->contents
;
6714 it
->dpend
= v
->contents
+ v
->header
.size
;
6715 it
->current
.dpvec_index
= 0;
6716 it
->dpvec_face_id
= -1;
6717 it
->saved_face_id
= it
->face_id
;
6718 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6723 set_iterator_to_next (it
, 0);
6728 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6730 if (it
->what
== IT_GLYPHLESS
)
6732 /* Don't display this character. */
6733 set_iterator_to_next (it
, 0);
6737 /* If `nobreak-char-display' is non-nil, we display
6738 non-ASCII spaces and hyphens specially. */
6739 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6742 nonascii_space_p
= 1;
6743 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6744 nonascii_hyphen_p
= 1;
6747 /* Translate control characters into `\003' or `^C' form.
6748 Control characters coming from a display table entry are
6749 currently not translated because we use IT->dpvec to hold
6750 the translation. This could easily be changed but I
6751 don't believe that it is worth doing.
6753 The characters handled by `nobreak-char-display' must be
6756 Non-printable characters and raw-byte characters are also
6757 translated to octal form. */
6758 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6759 ? (it
->area
!= TEXT_AREA
6760 /* In mode line, treat \n, \t like other crl chars. */
6763 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6764 || (c
!= '\n' && c
!= '\t'))
6766 || nonascii_hyphen_p
6768 || ! CHAR_PRINTABLE_P (c
))))
6770 /* C is a control character, non-ASCII space/hyphen,
6771 raw-byte, or a non-printable character which must be
6772 displayed either as '\003' or as `^C' where the '\\'
6773 and '^' can be defined in the display table. Fill
6774 IT->ctl_chars with glyphs for what we have to
6775 display. Then, set IT->dpvec to these glyphs. */
6782 /* Handle control characters with ^. */
6784 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6788 g
= '^'; /* default glyph for Control */
6789 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6791 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6793 g
= GLYPH_CODE_CHAR (gc
);
6794 lface_id
= GLYPH_CODE_FACE (gc
);
6798 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6800 else if (it
->f
== last_escape_glyph_frame
6801 && it
->face_id
== last_escape_glyph_face_id
)
6803 face_id
= last_escape_glyph_merged_face_id
;
6807 /* Merge the escape-glyph face into the current face. */
6808 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6810 last_escape_glyph_frame
= it
->f
;
6811 last_escape_glyph_face_id
= it
->face_id
;
6812 last_escape_glyph_merged_face_id
= face_id
;
6815 XSETINT (it
->ctl_chars
[0], g
);
6816 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6818 goto display_control
;
6821 /* Handle non-ascii space in the mode where it only gets
6824 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6826 /* Merge `nobreak-space' into the current face. */
6827 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6829 XSETINT (it
->ctl_chars
[0], ' ');
6831 goto display_control
;
6834 /* Handle sequences that start with the "escape glyph". */
6836 /* the default escape glyph is \. */
6837 escape_glyph
= '\\';
6840 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6842 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6843 lface_id
= GLYPH_CODE_FACE (gc
);
6847 /* The display table specified a face.
6848 Merge it into face_id and also into escape_glyph. */
6849 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6852 else if (it
->f
== last_escape_glyph_frame
6853 && it
->face_id
== last_escape_glyph_face_id
)
6855 face_id
= last_escape_glyph_merged_face_id
;
6859 /* Merge the escape-glyph face into the current face. */
6860 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6862 last_escape_glyph_frame
= it
->f
;
6863 last_escape_glyph_face_id
= it
->face_id
;
6864 last_escape_glyph_merged_face_id
= face_id
;
6867 /* Draw non-ASCII hyphen with just highlighting: */
6869 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6871 XSETINT (it
->ctl_chars
[0], '-');
6873 goto display_control
;
6876 /* Draw non-ASCII space/hyphen with escape glyph: */
6878 if (nonascii_space_p
|| nonascii_hyphen_p
)
6880 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6881 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6883 goto display_control
;
6890 if (CHAR_BYTE8_P (c
))
6891 /* Display \200 instead of \17777600. */
6892 c
= CHAR_TO_BYTE8 (c
);
6893 len
= sprintf (str
, "%03o", c
);
6895 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6896 for (i
= 0; i
< len
; i
++)
6897 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6902 /* Set up IT->dpvec and return first character from it. */
6903 it
->dpvec_char_len
= it
->len
;
6904 it
->dpvec
= it
->ctl_chars
;
6905 it
->dpend
= it
->dpvec
+ ctl_len
;
6906 it
->current
.dpvec_index
= 0;
6907 it
->dpvec_face_id
= face_id
;
6908 it
->saved_face_id
= it
->face_id
;
6909 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6913 it
->char_to_display
= c
;
6917 it
->char_to_display
= it
->c
;
6921 /* Adjust face id for a multibyte character. There are no multibyte
6922 character in unibyte text. */
6923 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6926 && FRAME_WINDOW_P (it
->f
))
6928 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6930 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6932 /* Automatic composition with glyph-string. */
6933 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6935 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6939 ptrdiff_t pos
= (it
->s
? -1
6940 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6941 : IT_CHARPOS (*it
));
6944 if (it
->what
== IT_CHARACTER
)
6945 c
= it
->char_to_display
;
6948 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6952 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6953 /* TAB in a composition means display glyphs with
6954 padding space on the left or right. */
6955 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6958 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6963 /* Is this character the last one of a run of characters with
6964 box? If yes, set IT->end_of_box_run_p to 1. */
6968 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6970 int face_id
= underlying_face_id (it
);
6971 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6975 if (face
->box
== FACE_NO_BOX
)
6977 /* If the box comes from face properties in a
6978 display string, check faces in that string. */
6979 int string_face_id
= face_after_it_pos (it
);
6980 it
->end_of_box_run_p
6981 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6984 /* Otherwise, the box comes from the underlying face.
6985 If this is the last string character displayed, check
6986 the next buffer location. */
6987 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6988 && (it
->current
.overlay_string_index
6989 == it
->n_overlay_strings
- 1))
6993 struct text_pos pos
= it
->current
.pos
;
6994 INC_TEXT_POS (pos
, it
->multibyte_p
);
6996 next_face_id
= face_at_buffer_position
6997 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6998 it
->region_end_charpos
, &ignore
,
6999 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
7001 it
->end_of_box_run_p
7002 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7009 int face_id
= face_after_it_pos (it
);
7010 it
->end_of_box_run_p
7011 = (face_id
!= it
->face_id
7012 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7015 /* If we reached the end of the object we've been iterating (e.g., a
7016 display string or an overlay string), and there's something on
7017 IT->stack, proceed with what's on the stack. It doesn't make
7018 sense to return zero if there's unprocessed stuff on the stack,
7019 because otherwise that stuff will never be displayed. */
7020 if (!success_p
&& it
->sp
> 0)
7022 set_iterator_to_next (it
, 0);
7023 success_p
= get_next_display_element (it
);
7026 /* Value is 0 if end of buffer or string reached. */
7031 /* Move IT to the next display element.
7033 RESEAT_P non-zero means if called on a newline in buffer text,
7034 skip to the next visible line start.
7036 Functions get_next_display_element and set_iterator_to_next are
7037 separate because I find this arrangement easier to handle than a
7038 get_next_display_element function that also increments IT's
7039 position. The way it is we can first look at an iterator's current
7040 display element, decide whether it fits on a line, and if it does,
7041 increment the iterator position. The other way around we probably
7042 would either need a flag indicating whether the iterator has to be
7043 incremented the next time, or we would have to implement a
7044 decrement position function which would not be easy to write. */
7047 set_iterator_to_next (struct it
*it
, int reseat_p
)
7049 /* Reset flags indicating start and end of a sequence of characters
7050 with box. Reset them at the start of this function because
7051 moving the iterator to a new position might set them. */
7052 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7056 case GET_FROM_BUFFER
:
7057 /* The current display element of IT is a character from
7058 current_buffer. Advance in the buffer, and maybe skip over
7059 invisible lines that are so because of selective display. */
7060 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7061 reseat_at_next_visible_line_start (it
, 0);
7062 else if (it
->cmp_it
.id
>= 0)
7064 /* We are currently getting glyphs from a composition. */
7069 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7070 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7071 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7073 it
->cmp_it
.from
= it
->cmp_it
.to
;
7078 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7080 it
->end_charpos
, Qnil
);
7083 else if (! it
->cmp_it
.reversed_p
)
7085 /* Composition created while scanning forward. */
7086 /* Update IT's char/byte positions to point to the first
7087 character of the next grapheme cluster, or to the
7088 character visually after the current composition. */
7089 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7090 bidi_move_to_visually_next (&it
->bidi_it
);
7091 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7092 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7094 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7096 /* Proceed to the next grapheme cluster. */
7097 it
->cmp_it
.from
= it
->cmp_it
.to
;
7101 /* No more grapheme clusters in this composition.
7102 Find the next stop position. */
7103 ptrdiff_t stop
= it
->end_charpos
;
7104 if (it
->bidi_it
.scan_dir
< 0)
7105 /* Now we are scanning backward and don't know
7108 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7109 IT_BYTEPOS (*it
), stop
, Qnil
);
7114 /* Composition created while scanning backward. */
7115 /* Update IT's char/byte positions to point to the last
7116 character of the previous grapheme cluster, or the
7117 character visually after the current composition. */
7118 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7119 bidi_move_to_visually_next (&it
->bidi_it
);
7120 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7121 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7122 if (it
->cmp_it
.from
> 0)
7124 /* Proceed to the previous grapheme cluster. */
7125 it
->cmp_it
.to
= it
->cmp_it
.from
;
7129 /* No more grapheme clusters in this composition.
7130 Find the next stop position. */
7131 ptrdiff_t stop
= it
->end_charpos
;
7132 if (it
->bidi_it
.scan_dir
< 0)
7133 /* Now we are scanning backward and don't know
7136 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7137 IT_BYTEPOS (*it
), stop
, Qnil
);
7143 eassert (it
->len
!= 0);
7147 IT_BYTEPOS (*it
) += it
->len
;
7148 IT_CHARPOS (*it
) += 1;
7152 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7153 /* If this is a new paragraph, determine its base
7154 direction (a.k.a. its base embedding level). */
7155 if (it
->bidi_it
.new_paragraph
)
7156 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7157 bidi_move_to_visually_next (&it
->bidi_it
);
7158 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7159 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7160 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7162 /* As the scan direction was changed, we must
7163 re-compute the stop position for composition. */
7164 ptrdiff_t stop
= it
->end_charpos
;
7165 if (it
->bidi_it
.scan_dir
< 0)
7167 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7168 IT_BYTEPOS (*it
), stop
, Qnil
);
7171 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7175 case GET_FROM_C_STRING
:
7176 /* Current display element of IT is from a C string. */
7178 /* If the string position is beyond string's end, it means
7179 next_element_from_c_string is padding the string with
7180 blanks, in which case we bypass the bidi iterator,
7181 because it cannot deal with such virtual characters. */
7182 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7184 IT_BYTEPOS (*it
) += it
->len
;
7185 IT_CHARPOS (*it
) += 1;
7189 bidi_move_to_visually_next (&it
->bidi_it
);
7190 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7191 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7195 case GET_FROM_DISPLAY_VECTOR
:
7196 /* Current display element of IT is from a display table entry.
7197 Advance in the display table definition. Reset it to null if
7198 end reached, and continue with characters from buffers/
7200 ++it
->current
.dpvec_index
;
7202 /* Restore face of the iterator to what they were before the
7203 display vector entry (these entries may contain faces). */
7204 it
->face_id
= it
->saved_face_id
;
7206 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7208 int recheck_faces
= it
->ellipsis_p
;
7211 it
->method
= GET_FROM_C_STRING
;
7212 else if (STRINGP (it
->string
))
7213 it
->method
= GET_FROM_STRING
;
7216 it
->method
= GET_FROM_BUFFER
;
7217 it
->object
= it
->w
->buffer
;
7221 it
->current
.dpvec_index
= -1;
7223 /* Skip over characters which were displayed via IT->dpvec. */
7224 if (it
->dpvec_char_len
< 0)
7225 reseat_at_next_visible_line_start (it
, 1);
7226 else if (it
->dpvec_char_len
> 0)
7228 if (it
->method
== GET_FROM_STRING
7229 && it
->n_overlay_strings
> 0)
7230 it
->ignore_overlay_strings_at_pos_p
= 1;
7231 it
->len
= it
->dpvec_char_len
;
7232 set_iterator_to_next (it
, reseat_p
);
7235 /* Maybe recheck faces after display vector */
7237 it
->stop_charpos
= IT_CHARPOS (*it
);
7241 case GET_FROM_STRING
:
7242 /* Current display element is a character from a Lisp string. */
7243 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7244 /* Don't advance past string end. These conditions are true
7245 when set_iterator_to_next is called at the end of
7246 get_next_display_element, in which case the Lisp string is
7247 already exhausted, and all we want is pop the iterator
7249 if (it
->current
.overlay_string_index
>= 0)
7251 /* This is an overlay string, so there's no padding with
7252 spaces, and the number of characters in the string is
7253 where the string ends. */
7254 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7255 goto consider_string_end
;
7259 /* Not an overlay string. There could be padding, so test
7260 against it->end_charpos . */
7261 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7262 goto consider_string_end
;
7264 if (it
->cmp_it
.id
>= 0)
7270 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7271 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7272 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7273 it
->cmp_it
.from
= it
->cmp_it
.to
;
7277 composition_compute_stop_pos (&it
->cmp_it
,
7278 IT_STRING_CHARPOS (*it
),
7279 IT_STRING_BYTEPOS (*it
),
7280 it
->end_charpos
, it
->string
);
7283 else if (! it
->cmp_it
.reversed_p
)
7285 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7286 bidi_move_to_visually_next (&it
->bidi_it
);
7287 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7288 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7290 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7291 it
->cmp_it
.from
= it
->cmp_it
.to
;
7294 ptrdiff_t stop
= it
->end_charpos
;
7295 if (it
->bidi_it
.scan_dir
< 0)
7297 composition_compute_stop_pos (&it
->cmp_it
,
7298 IT_STRING_CHARPOS (*it
),
7299 IT_STRING_BYTEPOS (*it
), stop
,
7305 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7306 bidi_move_to_visually_next (&it
->bidi_it
);
7307 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7308 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7309 if (it
->cmp_it
.from
> 0)
7310 it
->cmp_it
.to
= it
->cmp_it
.from
;
7313 ptrdiff_t stop
= it
->end_charpos
;
7314 if (it
->bidi_it
.scan_dir
< 0)
7316 composition_compute_stop_pos (&it
->cmp_it
,
7317 IT_STRING_CHARPOS (*it
),
7318 IT_STRING_BYTEPOS (*it
), stop
,
7326 /* If the string position is beyond string's end, it
7327 means next_element_from_string is padding the string
7328 with blanks, in which case we bypass the bidi
7329 iterator, because it cannot deal with such virtual
7331 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7333 IT_STRING_BYTEPOS (*it
) += it
->len
;
7334 IT_STRING_CHARPOS (*it
) += 1;
7338 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7340 bidi_move_to_visually_next (&it
->bidi_it
);
7341 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7342 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7343 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7345 ptrdiff_t stop
= it
->end_charpos
;
7347 if (it
->bidi_it
.scan_dir
< 0)
7349 composition_compute_stop_pos (&it
->cmp_it
,
7350 IT_STRING_CHARPOS (*it
),
7351 IT_STRING_BYTEPOS (*it
), stop
,
7357 consider_string_end
:
7359 if (it
->current
.overlay_string_index
>= 0)
7361 /* IT->string is an overlay string. Advance to the
7362 next, if there is one. */
7363 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7366 next_overlay_string (it
);
7368 setup_for_ellipsis (it
, 0);
7373 /* IT->string is not an overlay string. If we reached
7374 its end, and there is something on IT->stack, proceed
7375 with what is on the stack. This can be either another
7376 string, this time an overlay string, or a buffer. */
7377 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7381 if (it
->method
== GET_FROM_STRING
)
7382 goto consider_string_end
;
7387 case GET_FROM_IMAGE
:
7388 case GET_FROM_STRETCH
:
7389 #ifdef HAVE_XWIDGETS
7390 case GET_FROM_XWIDGET
:
7392 /* The position etc with which we have to proceed are on
7393 the stack. The position may be at the end of a string,
7394 if the `display' property takes up the whole string. */
7395 eassert (it
->sp
> 0);
7397 if (it
->method
== GET_FROM_STRING
)
7398 goto consider_string_end
;
7402 /* There are no other methods defined, so this should be a bug. */
7406 eassert (it
->method
!= GET_FROM_STRING
7407 || (STRINGP (it
->string
)
7408 && IT_STRING_CHARPOS (*it
) >= 0));
7411 /* Load IT's display element fields with information about the next
7412 display element which comes from a display table entry or from the
7413 result of translating a control character to one of the forms `^C'
7416 IT->dpvec holds the glyphs to return as characters.
7417 IT->saved_face_id holds the face id before the display vector--it
7418 is restored into IT->face_id in set_iterator_to_next. */
7421 next_element_from_display_vector (struct it
*it
)
7426 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7428 it
->face_id
= it
->saved_face_id
;
7430 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7431 That seemed totally bogus - so I changed it... */
7432 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7434 if (GLYPH_CODE_P (gc
))
7436 it
->c
= GLYPH_CODE_CHAR (gc
);
7437 it
->len
= CHAR_BYTES (it
->c
);
7439 /* The entry may contain a face id to use. Such a face id is
7440 the id of a Lisp face, not a realized face. A face id of
7441 zero means no face is specified. */
7442 if (it
->dpvec_face_id
>= 0)
7443 it
->face_id
= it
->dpvec_face_id
;
7446 int lface_id
= GLYPH_CODE_FACE (gc
);
7448 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7453 /* Display table entry is invalid. Return a space. */
7454 it
->c
= ' ', it
->len
= 1;
7456 /* Don't change position and object of the iterator here. They are
7457 still the values of the character that had this display table
7458 entry or was translated, and that's what we want. */
7459 it
->what
= IT_CHARACTER
;
7463 /* Get the first element of string/buffer in the visual order, after
7464 being reseated to a new position in a string or a buffer. */
7466 get_visually_first_element (struct it
*it
)
7468 int string_p
= STRINGP (it
->string
) || it
->s
;
7469 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7470 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7472 if (STRINGP (it
->string
))
7474 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7475 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7479 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7480 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7483 if (it
->bidi_it
.charpos
== eob
)
7485 /* Nothing to do, but reset the FIRST_ELT flag, like
7486 bidi_paragraph_init does, because we are not going to
7488 it
->bidi_it
.first_elt
= 0;
7490 else if (it
->bidi_it
.charpos
== bob
7492 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7493 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7495 /* If we are at the beginning of a line/string, we can produce
7496 the next element right away. */
7497 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7498 bidi_move_to_visually_next (&it
->bidi_it
);
7502 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7504 /* We need to prime the bidi iterator starting at the line's or
7505 string's beginning, before we will be able to produce the
7508 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7511 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7513 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7515 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7518 /* Now return to buffer/string position where we were asked
7519 to get the next display element, and produce that. */
7520 bidi_move_to_visually_next (&it
->bidi_it
);
7522 while (it
->bidi_it
.bytepos
!= orig_bytepos
7523 && it
->bidi_it
.charpos
< eob
);
7526 /* Adjust IT's position information to where we ended up. */
7527 if (STRINGP (it
->string
))
7529 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7530 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7534 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7535 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7538 if (STRINGP (it
->string
) || !it
->s
)
7540 ptrdiff_t stop
, charpos
, bytepos
;
7542 if (STRINGP (it
->string
))
7545 stop
= SCHARS (it
->string
);
7546 if (stop
> it
->end_charpos
)
7547 stop
= it
->end_charpos
;
7548 charpos
= IT_STRING_CHARPOS (*it
);
7549 bytepos
= IT_STRING_BYTEPOS (*it
);
7553 stop
= it
->end_charpos
;
7554 charpos
= IT_CHARPOS (*it
);
7555 bytepos
= IT_BYTEPOS (*it
);
7557 if (it
->bidi_it
.scan_dir
< 0)
7559 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7564 /* Load IT with the next display element from Lisp string IT->string.
7565 IT->current.string_pos is the current position within the string.
7566 If IT->current.overlay_string_index >= 0, the Lisp string is an
7570 next_element_from_string (struct it
*it
)
7572 struct text_pos position
;
7574 eassert (STRINGP (it
->string
));
7575 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7576 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7577 position
= it
->current
.string_pos
;
7579 /* With bidi reordering, the character to display might not be the
7580 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7581 that we were reseat()ed to a new string, whose paragraph
7582 direction is not known. */
7583 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7585 get_visually_first_element (it
);
7586 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7589 /* Time to check for invisible text? */
7590 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7592 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7595 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7596 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7598 /* With bidi non-linear iteration, we could find
7599 ourselves far beyond the last computed stop_charpos,
7600 with several other stop positions in between that we
7601 missed. Scan them all now, in buffer's logical
7602 order, until we find and handle the last stop_charpos
7603 that precedes our current position. */
7604 handle_stop_backwards (it
, it
->stop_charpos
);
7605 return GET_NEXT_DISPLAY_ELEMENT (it
);
7611 /* Take note of the stop position we just moved
7612 across, for when we will move back across it. */
7613 it
->prev_stop
= it
->stop_charpos
;
7614 /* If we are at base paragraph embedding level, take
7615 note of the last stop position seen at this
7617 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7618 it
->base_level_stop
= it
->stop_charpos
;
7622 /* Since a handler may have changed IT->method, we must
7624 return GET_NEXT_DISPLAY_ELEMENT (it
);
7628 /* If we are before prev_stop, we may have overstepped
7629 on our way backwards a stop_pos, and if so, we need
7630 to handle that stop_pos. */
7631 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7632 /* We can sometimes back up for reasons that have nothing
7633 to do with bidi reordering. E.g., compositions. The
7634 code below is only needed when we are above the base
7635 embedding level, so test for that explicitly. */
7636 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7638 /* If we lost track of base_level_stop, we have no better
7639 place for handle_stop_backwards to start from than string
7640 beginning. This happens, e.g., when we were reseated to
7641 the previous screenful of text by vertical-motion. */
7642 if (it
->base_level_stop
<= 0
7643 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7644 it
->base_level_stop
= 0;
7645 handle_stop_backwards (it
, it
->base_level_stop
);
7646 return GET_NEXT_DISPLAY_ELEMENT (it
);
7650 if (it
->current
.overlay_string_index
>= 0)
7652 /* Get the next character from an overlay string. In overlay
7653 strings, there is no field width or padding with spaces to
7655 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7660 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7661 IT_STRING_BYTEPOS (*it
),
7662 it
->bidi_it
.scan_dir
< 0
7664 : SCHARS (it
->string
))
7665 && next_element_from_composition (it
))
7669 else if (STRING_MULTIBYTE (it
->string
))
7671 const unsigned char *s
= (SDATA (it
->string
)
7672 + IT_STRING_BYTEPOS (*it
));
7673 it
->c
= string_char_and_length (s
, &it
->len
);
7677 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7683 /* Get the next character from a Lisp string that is not an
7684 overlay string. Such strings come from the mode line, for
7685 example. We may have to pad with spaces, or truncate the
7686 string. See also next_element_from_c_string. */
7687 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7692 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7694 /* Pad with spaces. */
7695 it
->c
= ' ', it
->len
= 1;
7696 CHARPOS (position
) = BYTEPOS (position
) = -1;
7698 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7699 IT_STRING_BYTEPOS (*it
),
7700 it
->bidi_it
.scan_dir
< 0
7702 : it
->string_nchars
)
7703 && next_element_from_composition (it
))
7707 else if (STRING_MULTIBYTE (it
->string
))
7709 const unsigned char *s
= (SDATA (it
->string
)
7710 + IT_STRING_BYTEPOS (*it
));
7711 it
->c
= string_char_and_length (s
, &it
->len
);
7715 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7720 /* Record what we have and where it came from. */
7721 it
->what
= IT_CHARACTER
;
7722 it
->object
= it
->string
;
7723 it
->position
= position
;
7728 /* Load IT with next display element from C string IT->s.
7729 IT->string_nchars is the maximum number of characters to return
7730 from the string. IT->end_charpos may be greater than
7731 IT->string_nchars when this function is called, in which case we
7732 may have to return padding spaces. Value is zero if end of string
7733 reached, including padding spaces. */
7736 next_element_from_c_string (struct it
*it
)
7741 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7742 it
->what
= IT_CHARACTER
;
7743 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7746 /* With bidi reordering, the character to display might not be the
7747 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7748 we were reseated to a new string, whose paragraph direction is
7750 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7751 get_visually_first_element (it
);
7753 /* IT's position can be greater than IT->string_nchars in case a
7754 field width or precision has been specified when the iterator was
7756 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7758 /* End of the game. */
7762 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7764 /* Pad with spaces. */
7765 it
->c
= ' ', it
->len
= 1;
7766 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7768 else if (it
->multibyte_p
)
7769 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7771 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7777 /* Set up IT to return characters from an ellipsis, if appropriate.
7778 The definition of the ellipsis glyphs may come from a display table
7779 entry. This function fills IT with the first glyph from the
7780 ellipsis if an ellipsis is to be displayed. */
7783 next_element_from_ellipsis (struct it
*it
)
7785 if (it
->selective_display_ellipsis_p
)
7786 setup_for_ellipsis (it
, it
->len
);
7789 /* The face at the current position may be different from the
7790 face we find after the invisible text. Remember what it
7791 was in IT->saved_face_id, and signal that it's there by
7792 setting face_before_selective_p. */
7793 it
->saved_face_id
= it
->face_id
;
7794 it
->method
= GET_FROM_BUFFER
;
7795 it
->object
= it
->w
->buffer
;
7796 reseat_at_next_visible_line_start (it
, 1);
7797 it
->face_before_selective_p
= 1;
7800 return GET_NEXT_DISPLAY_ELEMENT (it
);
7804 /* Deliver an image display element. The iterator IT is already
7805 filled with image information (done in handle_display_prop). Value
7810 next_element_from_image (struct it
*it
)
7812 it
->what
= IT_IMAGE
;
7813 it
->ignore_overlay_strings_at_pos_p
= 0;
7817 #ifdef HAVE_XWIDGETS
7818 /* im not sure about this FIXME JAVE*/
7820 next_element_from_xwidget (struct it
*it
)
7822 it
->what
= IT_XWIDGET
;
7823 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
7824 //this is shaky because why do we set "what" if we dont set the other parts??
7825 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
7831 /* Fill iterator IT with next display element from a stretch glyph
7832 property. IT->object is the value of the text property. Value is
7836 next_element_from_stretch (struct it
*it
)
7838 it
->what
= IT_STRETCH
;
7842 /* Scan backwards from IT's current position until we find a stop
7843 position, or until BEGV. This is called when we find ourself
7844 before both the last known prev_stop and base_level_stop while
7845 reordering bidirectional text. */
7848 compute_stop_pos_backwards (struct it
*it
)
7850 const int SCAN_BACK_LIMIT
= 1000;
7851 struct text_pos pos
;
7852 struct display_pos save_current
= it
->current
;
7853 struct text_pos save_position
= it
->position
;
7854 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7855 ptrdiff_t where_we_are
= charpos
;
7856 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7857 ptrdiff_t save_end_pos
= it
->end_charpos
;
7859 eassert (NILP (it
->string
) && !it
->s
);
7860 eassert (it
->bidi_p
);
7864 it
->end_charpos
= min (charpos
+ 1, ZV
);
7865 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7866 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7867 reseat_1 (it
, pos
, 0);
7868 compute_stop_pos (it
);
7869 /* We must advance forward, right? */
7870 if (it
->stop_charpos
<= charpos
)
7873 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7875 if (it
->stop_charpos
<= where_we_are
)
7876 it
->prev_stop
= it
->stop_charpos
;
7878 it
->prev_stop
= BEGV
;
7880 it
->current
= save_current
;
7881 it
->position
= save_position
;
7882 it
->stop_charpos
= save_stop_pos
;
7883 it
->end_charpos
= save_end_pos
;
7886 /* Scan forward from CHARPOS in the current buffer/string, until we
7887 find a stop position > current IT's position. Then handle the stop
7888 position before that. This is called when we bump into a stop
7889 position while reordering bidirectional text. CHARPOS should be
7890 the last previously processed stop_pos (or BEGV/0, if none were
7891 processed yet) whose position is less that IT's current
7895 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7897 int bufp
= !STRINGP (it
->string
);
7898 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7899 struct display_pos save_current
= it
->current
;
7900 struct text_pos save_position
= it
->position
;
7901 struct text_pos pos1
;
7902 ptrdiff_t next_stop
;
7904 /* Scan in strict logical order. */
7905 eassert (it
->bidi_p
);
7909 it
->prev_stop
= charpos
;
7912 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7913 reseat_1 (it
, pos1
, 0);
7916 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7917 compute_stop_pos (it
);
7918 /* We must advance forward, right? */
7919 if (it
->stop_charpos
<= it
->prev_stop
)
7921 charpos
= it
->stop_charpos
;
7923 while (charpos
<= where_we_are
);
7926 it
->current
= save_current
;
7927 it
->position
= save_position
;
7928 next_stop
= it
->stop_charpos
;
7929 it
->stop_charpos
= it
->prev_stop
;
7931 it
->stop_charpos
= next_stop
;
7934 /* Load IT with the next display element from current_buffer. Value
7935 is zero if end of buffer reached. IT->stop_charpos is the next
7936 position at which to stop and check for text properties or buffer
7940 next_element_from_buffer (struct it
*it
)
7944 eassert (IT_CHARPOS (*it
) >= BEGV
);
7945 eassert (NILP (it
->string
) && !it
->s
);
7946 eassert (!it
->bidi_p
7947 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7948 && it
->bidi_it
.string
.s
== NULL
));
7950 /* With bidi reordering, the character to display might not be the
7951 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7952 we were reseat()ed to a new buffer position, which is potentially
7953 a different paragraph. */
7954 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7956 get_visually_first_element (it
);
7957 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7960 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7962 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7964 int overlay_strings_follow_p
;
7966 /* End of the game, except when overlay strings follow that
7967 haven't been returned yet. */
7968 if (it
->overlay_strings_at_end_processed_p
)
7969 overlay_strings_follow_p
= 0;
7972 it
->overlay_strings_at_end_processed_p
= 1;
7973 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7976 if (overlay_strings_follow_p
)
7977 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7981 it
->position
= it
->current
.pos
;
7985 else if (!(!it
->bidi_p
7986 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7987 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7989 /* With bidi non-linear iteration, we could find ourselves
7990 far beyond the last computed stop_charpos, with several
7991 other stop positions in between that we missed. Scan
7992 them all now, in buffer's logical order, until we find
7993 and handle the last stop_charpos that precedes our
7994 current position. */
7995 handle_stop_backwards (it
, it
->stop_charpos
);
7996 return GET_NEXT_DISPLAY_ELEMENT (it
);
8002 /* Take note of the stop position we just moved across,
8003 for when we will move back across it. */
8004 it
->prev_stop
= it
->stop_charpos
;
8005 /* If we are at base paragraph embedding level, take
8006 note of the last stop position seen at this
8008 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8009 it
->base_level_stop
= it
->stop_charpos
;
8012 return GET_NEXT_DISPLAY_ELEMENT (it
);
8016 /* If we are before prev_stop, we may have overstepped on
8017 our way backwards a stop_pos, and if so, we need to
8018 handle that stop_pos. */
8019 && IT_CHARPOS (*it
) < it
->prev_stop
8020 /* We can sometimes back up for reasons that have nothing
8021 to do with bidi reordering. E.g., compositions. The
8022 code below is only needed when we are above the base
8023 embedding level, so test for that explicitly. */
8024 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8026 if (it
->base_level_stop
<= 0
8027 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8029 /* If we lost track of base_level_stop, we need to find
8030 prev_stop by looking backwards. This happens, e.g., when
8031 we were reseated to the previous screenful of text by
8033 it
->base_level_stop
= BEGV
;
8034 compute_stop_pos_backwards (it
);
8035 handle_stop_backwards (it
, it
->prev_stop
);
8038 handle_stop_backwards (it
, it
->base_level_stop
);
8039 return GET_NEXT_DISPLAY_ELEMENT (it
);
8043 /* No face changes, overlays etc. in sight, so just return a
8044 character from current_buffer. */
8048 /* Maybe run the redisplay end trigger hook. Performance note:
8049 This doesn't seem to cost measurable time. */
8050 if (it
->redisplay_end_trigger_charpos
8052 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8053 run_redisplay_end_trigger_hook (it
);
8055 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8056 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8058 && next_element_from_composition (it
))
8063 /* Get the next character, maybe multibyte. */
8064 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8065 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8066 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8068 it
->c
= *p
, it
->len
= 1;
8070 /* Record what we have and where it came from. */
8071 it
->what
= IT_CHARACTER
;
8072 it
->object
= it
->w
->buffer
;
8073 it
->position
= it
->current
.pos
;
8075 /* Normally we return the character found above, except when we
8076 really want to return an ellipsis for selective display. */
8081 /* A value of selective > 0 means hide lines indented more
8082 than that number of columns. */
8083 if (it
->selective
> 0
8084 && IT_CHARPOS (*it
) + 1 < ZV
8085 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8086 IT_BYTEPOS (*it
) + 1,
8089 success_p
= next_element_from_ellipsis (it
);
8090 it
->dpvec_char_len
= -1;
8093 else if (it
->c
== '\r' && it
->selective
== -1)
8095 /* A value of selective == -1 means that everything from the
8096 CR to the end of the line is invisible, with maybe an
8097 ellipsis displayed for it. */
8098 success_p
= next_element_from_ellipsis (it
);
8099 it
->dpvec_char_len
= -1;
8104 /* Value is zero if end of buffer reached. */
8105 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8110 /* Run the redisplay end trigger hook for IT. */
8113 run_redisplay_end_trigger_hook (struct it
*it
)
8115 Lisp_Object args
[3];
8117 /* IT->glyph_row should be non-null, i.e. we should be actually
8118 displaying something, or otherwise we should not run the hook. */
8119 eassert (it
->glyph_row
);
8121 /* Set up hook arguments. */
8122 args
[0] = Qredisplay_end_trigger_functions
;
8123 args
[1] = it
->window
;
8124 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8125 it
->redisplay_end_trigger_charpos
= 0;
8127 /* Since we are *trying* to run these functions, don't try to run
8128 them again, even if they get an error. */
8129 wset_redisplay_end_trigger (it
->w
, Qnil
);
8130 Frun_hook_with_args (3, args
);
8132 /* Notice if it changed the face of the character we are on. */
8133 handle_face_prop (it
);
8137 /* Deliver a composition display element. Unlike the other
8138 next_element_from_XXX, this function is not registered in the array
8139 get_next_element[]. It is called from next_element_from_buffer and
8140 next_element_from_string when necessary. */
8143 next_element_from_composition (struct it
*it
)
8145 it
->what
= IT_COMPOSITION
;
8146 it
->len
= it
->cmp_it
.nbytes
;
8147 if (STRINGP (it
->string
))
8151 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8152 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8155 it
->position
= it
->current
.string_pos
;
8156 it
->object
= it
->string
;
8157 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8158 IT_STRING_BYTEPOS (*it
), it
->string
);
8164 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8165 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8168 if (it
->bidi_it
.new_paragraph
)
8169 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8170 /* Resync the bidi iterator with IT's new position.
8171 FIXME: this doesn't support bidirectional text. */
8172 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8173 bidi_move_to_visually_next (&it
->bidi_it
);
8177 it
->position
= it
->current
.pos
;
8178 it
->object
= it
->w
->buffer
;
8179 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8180 IT_BYTEPOS (*it
), Qnil
);
8187 /***********************************************************************
8188 Moving an iterator without producing glyphs
8189 ***********************************************************************/
8191 /* Check if iterator is at a position corresponding to a valid buffer
8192 position after some move_it_ call. */
8194 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8195 ((it)->method == GET_FROM_STRING \
8196 ? IT_STRING_CHARPOS (*it) == 0 \
8200 /* Move iterator IT to a specified buffer or X position within one
8201 line on the display without producing glyphs.
8203 OP should be a bit mask including some or all of these bits:
8204 MOVE_TO_X: Stop upon reaching x-position TO_X.
8205 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8206 Regardless of OP's value, stop upon reaching the end of the display line.
8208 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8209 This means, in particular, that TO_X includes window's horizontal
8212 The return value has several possible values that
8213 say what condition caused the scan to stop:
8215 MOVE_POS_MATCH_OR_ZV
8216 - when TO_POS or ZV was reached.
8219 -when TO_X was reached before TO_POS or ZV were reached.
8222 - when we reached the end of the display area and the line must
8226 - when we reached the end of the display area and the line is
8230 - when we stopped at a line end, i.e. a newline or a CR and selective
8233 static enum move_it_result
8234 move_it_in_display_line_to (struct it
*it
,
8235 ptrdiff_t to_charpos
, int to_x
,
8236 enum move_operation_enum op
)
8238 enum move_it_result result
= MOVE_UNDEFINED
;
8239 struct glyph_row
*saved_glyph_row
;
8240 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8241 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8242 void *ppos_data
= NULL
;
8244 enum it_method prev_method
= it
->method
;
8245 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8246 int saw_smaller_pos
= prev_pos
< to_charpos
;
8248 /* Don't produce glyphs in produce_glyphs. */
8249 saved_glyph_row
= it
->glyph_row
;
8250 it
->glyph_row
= NULL
;
8252 /* Use wrap_it to save a copy of IT wherever a word wrap could
8253 occur. Use atpos_it to save a copy of IT at the desired buffer
8254 position, if found, so that we can scan ahead and check if the
8255 word later overshoots the window edge. Use atx_it similarly, for
8261 /* Use ppos_it under bidi reordering to save a copy of IT for the
8262 position > CHARPOS that is the closest to CHARPOS. We restore
8263 that position in IT when we have scanned the entire display line
8264 without finding a match for CHARPOS and all the character
8265 positions are greater than CHARPOS. */
8268 SAVE_IT (ppos_it
, *it
, ppos_data
);
8269 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8270 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8271 SAVE_IT (ppos_it
, *it
, ppos_data
);
8274 #define BUFFER_POS_REACHED_P() \
8275 ((op & MOVE_TO_POS) != 0 \
8276 && BUFFERP (it->object) \
8277 && (IT_CHARPOS (*it) == to_charpos \
8279 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8280 && IT_CHARPOS (*it) > to_charpos) \
8281 || (it->what == IT_COMPOSITION \
8282 && ((IT_CHARPOS (*it) > to_charpos \
8283 && to_charpos >= it->cmp_it.charpos) \
8284 || (IT_CHARPOS (*it) < to_charpos \
8285 && to_charpos <= it->cmp_it.charpos)))) \
8286 && (it->method == GET_FROM_BUFFER \
8287 || (it->method == GET_FROM_DISPLAY_VECTOR \
8288 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8290 /* If there's a line-/wrap-prefix, handle it. */
8291 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8292 && it
->current_y
< it
->last_visible_y
)
8293 handle_line_prefix (it
);
8295 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8296 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8300 int x
, i
, ascent
= 0, descent
= 0;
8302 /* Utility macro to reset an iterator with x, ascent, and descent. */
8303 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8304 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8305 (IT)->max_descent = descent)
8307 /* Stop if we move beyond TO_CHARPOS (after an image or a
8308 display string or stretch glyph). */
8309 if ((op
& MOVE_TO_POS
) != 0
8310 && BUFFERP (it
->object
)
8311 && it
->method
== GET_FROM_BUFFER
8313 /* When the iterator is at base embedding level, we
8314 are guaranteed that characters are delivered for
8315 display in strictly increasing order of their
8316 buffer positions. */
8317 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8318 && IT_CHARPOS (*it
) > to_charpos
)
8320 && (prev_method
== GET_FROM_IMAGE
8321 || prev_method
== GET_FROM_STRETCH
8322 || prev_method
== GET_FROM_STRING
)
8323 /* Passed TO_CHARPOS from left to right. */
8324 && ((prev_pos
< to_charpos
8325 && IT_CHARPOS (*it
) > to_charpos
)
8326 /* Passed TO_CHARPOS from right to left. */
8327 || (prev_pos
> to_charpos
8328 && IT_CHARPOS (*it
) < to_charpos
)))))
8330 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8332 result
= MOVE_POS_MATCH_OR_ZV
;
8335 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8336 /* If wrap_it is valid, the current position might be in a
8337 word that is wrapped. So, save the iterator in
8338 atpos_it and continue to see if wrapping happens. */
8339 SAVE_IT (atpos_it
, *it
, atpos_data
);
8342 /* Stop when ZV reached.
8343 We used to stop here when TO_CHARPOS reached as well, but that is
8344 too soon if this glyph does not fit on this line. So we handle it
8345 explicitly below. */
8346 if (!get_next_display_element (it
))
8348 result
= MOVE_POS_MATCH_OR_ZV
;
8352 if (it
->line_wrap
== TRUNCATE
)
8354 if (BUFFER_POS_REACHED_P ())
8356 result
= MOVE_POS_MATCH_OR_ZV
;
8362 if (it
->line_wrap
== WORD_WRAP
)
8364 if (IT_DISPLAYING_WHITESPACE (it
))
8368 /* We have reached a glyph that follows one or more
8369 whitespace characters. If the position is
8370 already found, we are done. */
8371 if (atpos_it
.sp
>= 0)
8373 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8374 result
= MOVE_POS_MATCH_OR_ZV
;
8379 RESTORE_IT (it
, &atx_it
, atx_data
);
8380 result
= MOVE_X_REACHED
;
8383 /* Otherwise, we can wrap here. */
8384 SAVE_IT (wrap_it
, *it
, wrap_data
);
8390 /* Remember the line height for the current line, in case
8391 the next element doesn't fit on the line. */
8392 ascent
= it
->max_ascent
;
8393 descent
= it
->max_descent
;
8395 /* The call to produce_glyphs will get the metrics of the
8396 display element IT is loaded with. Record the x-position
8397 before this display element, in case it doesn't fit on the
8401 PRODUCE_GLYPHS (it
);
8403 if (it
->area
!= TEXT_AREA
)
8405 prev_method
= it
->method
;
8406 if (it
->method
== GET_FROM_BUFFER
)
8407 prev_pos
= IT_CHARPOS (*it
);
8408 set_iterator_to_next (it
, 1);
8409 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8410 SET_TEXT_POS (this_line_min_pos
,
8411 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8413 && (op
& MOVE_TO_POS
)
8414 && IT_CHARPOS (*it
) > to_charpos
8415 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8416 SAVE_IT (ppos_it
, *it
, ppos_data
);
8420 /* The number of glyphs we get back in IT->nglyphs will normally
8421 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8422 character on a terminal frame, or (iii) a line end. For the
8423 second case, IT->nglyphs - 1 padding glyphs will be present.
8424 (On X frames, there is only one glyph produced for a
8425 composite character.)
8427 The behavior implemented below means, for continuation lines,
8428 that as many spaces of a TAB as fit on the current line are
8429 displayed there. For terminal frames, as many glyphs of a
8430 multi-glyph character are displayed in the current line, too.
8431 This is what the old redisplay code did, and we keep it that
8432 way. Under X, the whole shape of a complex character must
8433 fit on the line or it will be completely displayed in the
8436 Note that both for tabs and padding glyphs, all glyphs have
8440 /* More than one glyph or glyph doesn't fit on line. All
8441 glyphs have the same width. */
8442 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8444 int x_before_this_char
= x
;
8445 int hpos_before_this_char
= it
->hpos
;
8447 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8449 new_x
= x
+ single_glyph_width
;
8451 /* We want to leave anything reaching TO_X to the caller. */
8452 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8454 if (BUFFER_POS_REACHED_P ())
8456 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8457 goto buffer_pos_reached
;
8458 if (atpos_it
.sp
< 0)
8460 SAVE_IT (atpos_it
, *it
, atpos_data
);
8461 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8466 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8469 result
= MOVE_X_REACHED
;
8474 SAVE_IT (atx_it
, *it
, atx_data
);
8475 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8480 if (/* Lines are continued. */
8481 it
->line_wrap
!= TRUNCATE
8482 && (/* And glyph doesn't fit on the line. */
8483 new_x
> it
->last_visible_x
8484 /* Or it fits exactly and we're on a window
8486 || (new_x
== it
->last_visible_x
8487 && FRAME_WINDOW_P (it
->f
)
8488 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8489 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8490 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8492 if (/* IT->hpos == 0 means the very first glyph
8493 doesn't fit on the line, e.g. a wide image. */
8495 || (new_x
== it
->last_visible_x
8496 && FRAME_WINDOW_P (it
->f
)))
8499 it
->current_x
= new_x
;
8501 /* The character's last glyph just barely fits
8503 if (i
== it
->nglyphs
- 1)
8505 /* If this is the destination position,
8506 return a position *before* it in this row,
8507 now that we know it fits in this row. */
8508 if (BUFFER_POS_REACHED_P ())
8510 if (it
->line_wrap
!= WORD_WRAP
8513 it
->hpos
= hpos_before_this_char
;
8514 it
->current_x
= x_before_this_char
;
8515 result
= MOVE_POS_MATCH_OR_ZV
;
8518 if (it
->line_wrap
== WORD_WRAP
8521 SAVE_IT (atpos_it
, *it
, atpos_data
);
8522 atpos_it
.current_x
= x_before_this_char
;
8523 atpos_it
.hpos
= hpos_before_this_char
;
8527 prev_method
= it
->method
;
8528 if (it
->method
== GET_FROM_BUFFER
)
8529 prev_pos
= IT_CHARPOS (*it
);
8530 set_iterator_to_next (it
, 1);
8531 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8532 SET_TEXT_POS (this_line_min_pos
,
8533 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8534 /* On graphical terminals, newlines may
8535 "overflow" into the fringe if
8536 overflow-newline-into-fringe is non-nil.
8537 On text terminals, and on graphical
8538 terminals with no right margin, newlines
8539 may overflow into the last glyph on the
8541 if (!FRAME_WINDOW_P (it
->f
)
8543 && it
->bidi_it
.paragraph_dir
== R2L
)
8544 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8545 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8546 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8548 if (!get_next_display_element (it
))
8550 result
= MOVE_POS_MATCH_OR_ZV
;
8553 if (BUFFER_POS_REACHED_P ())
8555 if (ITERATOR_AT_END_OF_LINE_P (it
))
8556 result
= MOVE_POS_MATCH_OR_ZV
;
8558 result
= MOVE_LINE_CONTINUED
;
8561 if (ITERATOR_AT_END_OF_LINE_P (it
))
8563 result
= MOVE_NEWLINE_OR_CR
;
8570 IT_RESET_X_ASCENT_DESCENT (it
);
8572 if (wrap_it
.sp
>= 0)
8574 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8579 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8581 result
= MOVE_LINE_CONTINUED
;
8585 if (BUFFER_POS_REACHED_P ())
8587 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8588 goto buffer_pos_reached
;
8589 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8591 SAVE_IT (atpos_it
, *it
, atpos_data
);
8592 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8596 if (new_x
> it
->first_visible_x
)
8598 /* Glyph is visible. Increment number of glyphs that
8599 would be displayed. */
8604 if (result
!= MOVE_UNDEFINED
)
8607 else if (BUFFER_POS_REACHED_P ())
8610 IT_RESET_X_ASCENT_DESCENT (it
);
8611 result
= MOVE_POS_MATCH_OR_ZV
;
8614 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8616 /* Stop when TO_X specified and reached. This check is
8617 necessary here because of lines consisting of a line end,
8618 only. The line end will not produce any glyphs and we
8619 would never get MOVE_X_REACHED. */
8620 eassert (it
->nglyphs
== 0);
8621 result
= MOVE_X_REACHED
;
8625 /* Is this a line end? If yes, we're done. */
8626 if (ITERATOR_AT_END_OF_LINE_P (it
))
8628 /* If we are past TO_CHARPOS, but never saw any character
8629 positions smaller than TO_CHARPOS, return
8630 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8632 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8634 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8636 if (IT_CHARPOS (ppos_it
) < ZV
)
8638 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8639 result
= MOVE_POS_MATCH_OR_ZV
;
8642 goto buffer_pos_reached
;
8644 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8645 && IT_CHARPOS (*it
) > to_charpos
)
8646 goto buffer_pos_reached
;
8648 result
= MOVE_NEWLINE_OR_CR
;
8651 result
= MOVE_NEWLINE_OR_CR
;
8655 prev_method
= it
->method
;
8656 if (it
->method
== GET_FROM_BUFFER
)
8657 prev_pos
= IT_CHARPOS (*it
);
8658 /* The current display element has been consumed. Advance
8660 set_iterator_to_next (it
, 1);
8661 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8662 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8663 if (IT_CHARPOS (*it
) < to_charpos
)
8664 saw_smaller_pos
= 1;
8666 && (op
& MOVE_TO_POS
)
8667 && IT_CHARPOS (*it
) >= to_charpos
8668 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8669 SAVE_IT (ppos_it
, *it
, ppos_data
);
8671 /* Stop if lines are truncated and IT's current x-position is
8672 past the right edge of the window now. */
8673 if (it
->line_wrap
== TRUNCATE
8674 && it
->current_x
>= it
->last_visible_x
)
8676 if (!FRAME_WINDOW_P (it
->f
)
8677 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8678 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8679 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8680 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8684 if ((at_eob_p
= !get_next_display_element (it
))
8685 || BUFFER_POS_REACHED_P ()
8686 /* If we are past TO_CHARPOS, but never saw any
8687 character positions smaller than TO_CHARPOS,
8688 return MOVE_POS_MATCH_OR_ZV, like the
8689 unidirectional display did. */
8690 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8692 && IT_CHARPOS (*it
) > to_charpos
))
8695 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8696 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8697 result
= MOVE_POS_MATCH_OR_ZV
;
8700 if (ITERATOR_AT_END_OF_LINE_P (it
))
8702 result
= MOVE_NEWLINE_OR_CR
;
8706 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8708 && IT_CHARPOS (*it
) > to_charpos
)
8710 if (IT_CHARPOS (ppos_it
) < ZV
)
8711 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8712 result
= MOVE_POS_MATCH_OR_ZV
;
8715 result
= MOVE_LINE_TRUNCATED
;
8718 #undef IT_RESET_X_ASCENT_DESCENT
8721 #undef BUFFER_POS_REACHED_P
8723 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8724 restore the saved iterator. */
8725 if (atpos_it
.sp
>= 0)
8726 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8727 else if (atx_it
.sp
>= 0)
8728 RESTORE_IT (it
, &atx_it
, atx_data
);
8733 bidi_unshelve_cache (atpos_data
, 1);
8735 bidi_unshelve_cache (atx_data
, 1);
8737 bidi_unshelve_cache (wrap_data
, 1);
8739 bidi_unshelve_cache (ppos_data
, 1);
8741 /* Restore the iterator settings altered at the beginning of this
8743 it
->glyph_row
= saved_glyph_row
;
8747 /* For external use. */
8749 move_it_in_display_line (struct it
*it
,
8750 ptrdiff_t to_charpos
, int to_x
,
8751 enum move_operation_enum op
)
8753 if (it
->line_wrap
== WORD_WRAP
8754 && (op
& MOVE_TO_X
))
8757 void *save_data
= NULL
;
8760 SAVE_IT (save_it
, *it
, save_data
);
8761 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8762 /* When word-wrap is on, TO_X may lie past the end
8763 of a wrapped line. Then it->current is the
8764 character on the next line, so backtrack to the
8765 space before the wrap point. */
8766 if (skip
== MOVE_LINE_CONTINUED
)
8768 int prev_x
= max (it
->current_x
- 1, 0);
8769 RESTORE_IT (it
, &save_it
, save_data
);
8770 move_it_in_display_line_to
8771 (it
, -1, prev_x
, MOVE_TO_X
);
8774 bidi_unshelve_cache (save_data
, 1);
8777 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8781 /* Move IT forward until it satisfies one or more of the criteria in
8782 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8784 OP is a bit-mask that specifies where to stop, and in particular,
8785 which of those four position arguments makes a difference. See the
8786 description of enum move_operation_enum.
8788 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8789 screen line, this function will set IT to the next position that is
8790 displayed to the right of TO_CHARPOS on the screen. */
8793 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8795 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8796 int line_height
, line_start_x
= 0, reached
= 0;
8797 void *backup_data
= NULL
;
8801 if (op
& MOVE_TO_VPOS
)
8803 /* If no TO_CHARPOS and no TO_X specified, stop at the
8804 start of the line TO_VPOS. */
8805 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8807 if (it
->vpos
== to_vpos
)
8813 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8817 /* TO_VPOS >= 0 means stop at TO_X in the line at
8818 TO_VPOS, or at TO_POS, whichever comes first. */
8819 if (it
->vpos
== to_vpos
)
8825 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8827 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8832 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8834 /* We have reached TO_X but not in the line we want. */
8835 skip
= move_it_in_display_line_to (it
, to_charpos
,
8837 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8845 else if (op
& MOVE_TO_Y
)
8847 struct it it_backup
;
8849 if (it
->line_wrap
== WORD_WRAP
)
8850 SAVE_IT (it_backup
, *it
, backup_data
);
8852 /* TO_Y specified means stop at TO_X in the line containing
8853 TO_Y---or at TO_CHARPOS if this is reached first. The
8854 problem is that we can't really tell whether the line
8855 contains TO_Y before we have completely scanned it, and
8856 this may skip past TO_X. What we do is to first scan to
8859 If TO_X is not specified, use a TO_X of zero. The reason
8860 is to make the outcome of this function more predictable.
8861 If we didn't use TO_X == 0, we would stop at the end of
8862 the line which is probably not what a caller would expect
8864 skip
= move_it_in_display_line_to
8865 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8866 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8868 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8869 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8871 else if (skip
== MOVE_X_REACHED
)
8873 /* If TO_X was reached, we want to know whether TO_Y is
8874 in the line. We know this is the case if the already
8875 scanned glyphs make the line tall enough. Otherwise,
8876 we must check by scanning the rest of the line. */
8877 line_height
= it
->max_ascent
+ it
->max_descent
;
8878 if (to_y
>= it
->current_y
8879 && to_y
< it
->current_y
+ line_height
)
8884 SAVE_IT (it_backup
, *it
, backup_data
);
8885 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8886 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8888 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8889 line_height
= it
->max_ascent
+ it
->max_descent
;
8890 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8892 if (to_y
>= it
->current_y
8893 && to_y
< it
->current_y
+ line_height
)
8895 /* If TO_Y is in this line and TO_X was reached
8896 above, we scanned too far. We have to restore
8897 IT's settings to the ones before skipping. But
8898 keep the more accurate values of max_ascent and
8899 max_descent we've found while skipping the rest
8900 of the line, for the sake of callers, such as
8901 pos_visible_p, that need to know the line
8903 int max_ascent
= it
->max_ascent
;
8904 int max_descent
= it
->max_descent
;
8906 RESTORE_IT (it
, &it_backup
, backup_data
);
8907 it
->max_ascent
= max_ascent
;
8908 it
->max_descent
= max_descent
;
8914 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8920 /* Check whether TO_Y is in this line. */
8921 line_height
= it
->max_ascent
+ it
->max_descent
;
8922 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8924 if (to_y
>= it
->current_y
8925 && to_y
< it
->current_y
+ line_height
)
8927 /* When word-wrap is on, TO_X may lie past the end
8928 of a wrapped line. Then it->current is the
8929 character on the next line, so backtrack to the
8930 space before the wrap point. */
8931 if (skip
== MOVE_LINE_CONTINUED
8932 && it
->line_wrap
== WORD_WRAP
)
8934 int prev_x
= max (it
->current_x
- 1, 0);
8935 RESTORE_IT (it
, &it_backup
, backup_data
);
8936 skip
= move_it_in_display_line_to
8937 (it
, -1, prev_x
, MOVE_TO_X
);
8946 else if (BUFFERP (it
->object
)
8947 && (it
->method
== GET_FROM_BUFFER
8948 || it
->method
== GET_FROM_STRETCH
)
8949 && IT_CHARPOS (*it
) >= to_charpos
8950 /* Under bidi iteration, a call to set_iterator_to_next
8951 can scan far beyond to_charpos if the initial
8952 portion of the next line needs to be reordered. In
8953 that case, give move_it_in_display_line_to another
8956 && it
->bidi_it
.scan_dir
== -1))
8957 skip
= MOVE_POS_MATCH_OR_ZV
;
8959 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8963 case MOVE_POS_MATCH_OR_ZV
:
8967 case MOVE_NEWLINE_OR_CR
:
8968 set_iterator_to_next (it
, 1);
8969 it
->continuation_lines_width
= 0;
8972 case MOVE_LINE_TRUNCATED
:
8973 it
->continuation_lines_width
= 0;
8974 reseat_at_next_visible_line_start (it
, 0);
8975 if ((op
& MOVE_TO_POS
) != 0
8976 && IT_CHARPOS (*it
) > to_charpos
)
8983 case MOVE_LINE_CONTINUED
:
8984 /* For continued lines ending in a tab, some of the glyphs
8985 associated with the tab are displayed on the current
8986 line. Since it->current_x does not include these glyphs,
8987 we use it->last_visible_x instead. */
8990 it
->continuation_lines_width
+= it
->last_visible_x
;
8991 /* When moving by vpos, ensure that the iterator really
8992 advances to the next line (bug#847, bug#969). Fixme:
8993 do we need to do this in other circumstances? */
8994 if (it
->current_x
!= it
->last_visible_x
8995 && (op
& MOVE_TO_VPOS
)
8996 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8998 line_start_x
= it
->current_x
+ it
->pixel_width
8999 - it
->last_visible_x
;
9000 set_iterator_to_next (it
, 0);
9004 it
->continuation_lines_width
+= it
->current_x
;
9011 /* Reset/increment for the next run. */
9012 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9013 it
->current_x
= line_start_x
;
9016 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9018 last_height
= it
->max_ascent
+ it
->max_descent
;
9019 last_max_ascent
= it
->max_ascent
;
9020 it
->max_ascent
= it
->max_descent
= 0;
9025 /* On text terminals, we may stop at the end of a line in the middle
9026 of a multi-character glyph. If the glyph itself is continued,
9027 i.e. it is actually displayed on the next line, don't treat this
9028 stopping point as valid; move to the next line instead (unless
9029 that brings us offscreen). */
9030 if (!FRAME_WINDOW_P (it
->f
)
9032 && IT_CHARPOS (*it
) == to_charpos
9033 && it
->what
== IT_CHARACTER
9035 && it
->line_wrap
== WINDOW_WRAP
9036 && it
->current_x
== it
->last_visible_x
- 1
9039 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
9041 it
->continuation_lines_width
+= it
->current_x
;
9042 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9043 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9045 last_height
= it
->max_ascent
+ it
->max_descent
;
9046 last_max_ascent
= it
->max_ascent
;
9050 bidi_unshelve_cache (backup_data
, 1);
9052 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9056 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9058 If DY > 0, move IT backward at least that many pixels. DY = 0
9059 means move IT backward to the preceding line start or BEGV. This
9060 function may move over more than DY pixels if IT->current_y - DY
9061 ends up in the middle of a line; in this case IT->current_y will be
9062 set to the top of the line moved to. */
9065 move_it_vertically_backward (struct it
*it
, int dy
)
9069 void *it2data
= NULL
, *it3data
= NULL
;
9070 ptrdiff_t start_pos
;
9075 start_pos
= IT_CHARPOS (*it
);
9077 /* Estimate how many newlines we must move back. */
9078 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
9080 /* Set the iterator's position that many lines back. */
9081 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
9082 back_to_previous_visible_line_start (it
);
9084 /* Reseat the iterator here. When moving backward, we don't want
9085 reseat to skip forward over invisible text, set up the iterator
9086 to deliver from overlay strings at the new position etc. So,
9087 use reseat_1 here. */
9088 reseat_1 (it
, it
->current
.pos
, 1);
9090 /* We are now surely at a line start. */
9091 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9092 reordering is in effect. */
9093 it
->continuation_lines_width
= 0;
9095 /* Move forward and see what y-distance we moved. First move to the
9096 start of the next line so that we get its height. We need this
9097 height to be able to tell whether we reached the specified
9099 SAVE_IT (it2
, *it
, it2data
);
9100 it2
.max_ascent
= it2
.max_descent
= 0;
9103 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9104 MOVE_TO_POS
| MOVE_TO_VPOS
);
9106 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9107 /* If we are in a display string which starts at START_POS,
9108 and that display string includes a newline, and we are
9109 right after that newline (i.e. at the beginning of a
9110 display line), exit the loop, because otherwise we will
9111 infloop, since move_it_to will see that it is already at
9112 START_POS and will not move. */
9113 || (it2
.method
== GET_FROM_STRING
9114 && IT_CHARPOS (it2
) == start_pos
9115 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9116 eassert (IT_CHARPOS (*it
) >= BEGV
);
9117 SAVE_IT (it3
, it2
, it3data
);
9119 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9120 eassert (IT_CHARPOS (*it
) >= BEGV
);
9121 /* H is the actual vertical distance from the position in *IT
9122 and the starting position. */
9123 h
= it2
.current_y
- it
->current_y
;
9124 /* NLINES is the distance in number of lines. */
9125 nlines
= it2
.vpos
- it
->vpos
;
9127 /* Correct IT's y and vpos position
9128 so that they are relative to the starting point. */
9134 /* DY == 0 means move to the start of the screen line. The
9135 value of nlines is > 0 if continuation lines were involved,
9136 or if the original IT position was at start of a line. */
9137 RESTORE_IT (it
, it
, it2data
);
9139 move_it_by_lines (it
, nlines
);
9140 /* The above code moves us to some position NLINES down,
9141 usually to its first glyph (leftmost in an L2R line), but
9142 that's not necessarily the start of the line, under bidi
9143 reordering. We want to get to the character position
9144 that is immediately after the newline of the previous
9147 && !it
->continuation_lines_width
9148 && !STRINGP (it
->string
)
9149 && IT_CHARPOS (*it
) > BEGV
9150 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9153 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9155 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9157 bidi_unshelve_cache (it3data
, 1);
9161 /* The y-position we try to reach, relative to *IT.
9162 Note that H has been subtracted in front of the if-statement. */
9163 int target_y
= it
->current_y
+ h
- dy
;
9164 int y0
= it3
.current_y
;
9168 RESTORE_IT (&it3
, &it3
, it3data
);
9169 y1
= line_bottom_y (&it3
);
9170 line_height
= y1
- y0
;
9171 RESTORE_IT (it
, it
, it2data
);
9172 /* If we did not reach target_y, try to move further backward if
9173 we can. If we moved too far backward, try to move forward. */
9174 if (target_y
< it
->current_y
9175 /* This is heuristic. In a window that's 3 lines high, with
9176 a line height of 13 pixels each, recentering with point
9177 on the bottom line will try to move -39/2 = 19 pixels
9178 backward. Try to avoid moving into the first line. */
9179 && (it
->current_y
- target_y
9180 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9181 && IT_CHARPOS (*it
) > BEGV
)
9183 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9184 target_y
- it
->current_y
));
9185 dy
= it
->current_y
- target_y
;
9186 goto move_further_back
;
9188 else if (target_y
>= it
->current_y
+ line_height
9189 && IT_CHARPOS (*it
) < ZV
)
9191 /* Should move forward by at least one line, maybe more.
9193 Note: Calling move_it_by_lines can be expensive on
9194 terminal frames, where compute_motion is used (via
9195 vmotion) to do the job, when there are very long lines
9196 and truncate-lines is nil. That's the reason for
9197 treating terminal frames specially here. */
9199 if (!FRAME_WINDOW_P (it
->f
))
9200 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9205 move_it_by_lines (it
, 1);
9207 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9214 /* Move IT by a specified amount of pixel lines DY. DY negative means
9215 move backwards. DY = 0 means move to start of screen line. At the
9216 end, IT will be on the start of a screen line. */
9219 move_it_vertically (struct it
*it
, int dy
)
9222 move_it_vertically_backward (it
, -dy
);
9225 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9226 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9227 MOVE_TO_POS
| MOVE_TO_Y
);
9228 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9230 /* If buffer ends in ZV without a newline, move to the start of
9231 the line to satisfy the post-condition. */
9232 if (IT_CHARPOS (*it
) == ZV
9234 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9235 move_it_by_lines (it
, 0);
9240 /* Move iterator IT past the end of the text line it is in. */
9243 move_it_past_eol (struct it
*it
)
9245 enum move_it_result rc
;
9247 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9248 if (rc
== MOVE_NEWLINE_OR_CR
)
9249 set_iterator_to_next (it
, 0);
9253 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9254 negative means move up. DVPOS == 0 means move to the start of the
9257 Optimization idea: If we would know that IT->f doesn't use
9258 a face with proportional font, we could be faster for
9259 truncate-lines nil. */
9262 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9265 /* The commented-out optimization uses vmotion on terminals. This
9266 gives bad results, because elements like it->what, on which
9267 callers such as pos_visible_p rely, aren't updated. */
9268 /* struct position pos;
9269 if (!FRAME_WINDOW_P (it->f))
9271 struct text_pos textpos;
9273 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9274 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9275 reseat (it, textpos, 1);
9276 it->vpos += pos.vpos;
9277 it->current_y += pos.vpos;
9283 /* DVPOS == 0 means move to the start of the screen line. */
9284 move_it_vertically_backward (it
, 0);
9285 /* Let next call to line_bottom_y calculate real line height */
9290 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9291 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9293 /* Only move to the next buffer position if we ended up in a
9294 string from display property, not in an overlay string
9295 (before-string or after-string). That is because the
9296 latter don't conceal the underlying buffer position, so
9297 we can ask to move the iterator to the exact position we
9298 are interested in. Note that, even if we are already at
9299 IT_CHARPOS (*it), the call below is not a no-op, as it
9300 will detect that we are at the end of the string, pop the
9301 iterator, and compute it->current_x and it->hpos
9303 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9304 -1, -1, -1, MOVE_TO_POS
);
9310 void *it2data
= NULL
;
9311 ptrdiff_t start_charpos
, i
;
9313 /* Start at the beginning of the screen line containing IT's
9314 position. This may actually move vertically backwards,
9315 in case of overlays, so adjust dvpos accordingly. */
9317 move_it_vertically_backward (it
, 0);
9320 /* Go back -DVPOS visible lines and reseat the iterator there. */
9321 start_charpos
= IT_CHARPOS (*it
);
9322 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9323 back_to_previous_visible_line_start (it
);
9324 reseat (it
, it
->current
.pos
, 1);
9326 /* Move further back if we end up in a string or an image. */
9327 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9329 /* First try to move to start of display line. */
9331 move_it_vertically_backward (it
, 0);
9333 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9335 /* If start of line is still in string or image,
9336 move further back. */
9337 back_to_previous_visible_line_start (it
);
9338 reseat (it
, it
->current
.pos
, 1);
9342 it
->current_x
= it
->hpos
= 0;
9344 /* Above call may have moved too far if continuation lines
9345 are involved. Scan forward and see if it did. */
9346 SAVE_IT (it2
, *it
, it2data
);
9347 it2
.vpos
= it2
.current_y
= 0;
9348 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9349 it
->vpos
-= it2
.vpos
;
9350 it
->current_y
-= it2
.current_y
;
9351 it
->current_x
= it
->hpos
= 0;
9353 /* If we moved too far back, move IT some lines forward. */
9354 if (it2
.vpos
> -dvpos
)
9356 int delta
= it2
.vpos
+ dvpos
;
9358 RESTORE_IT (&it2
, &it2
, it2data
);
9359 SAVE_IT (it2
, *it
, it2data
);
9360 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9361 /* Move back again if we got too far ahead. */
9362 if (IT_CHARPOS (*it
) >= start_charpos
)
9363 RESTORE_IT (it
, &it2
, it2data
);
9365 bidi_unshelve_cache (it2data
, 1);
9368 RESTORE_IT (it
, it
, it2data
);
9372 /* Return 1 if IT points into the middle of a display vector. */
9375 in_display_vector_p (struct it
*it
)
9377 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9378 && it
->current
.dpvec_index
> 0
9379 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9383 /***********************************************************************
9385 ***********************************************************************/
9388 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9392 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9394 Lisp_Object args
[3];
9395 Lisp_Object msg
, fmt
;
9398 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9402 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9404 args
[0] = fmt
= build_string (format
);
9407 msg
= Fformat (3, args
);
9409 len
= SBYTES (msg
) + 1;
9410 buffer
= SAFE_ALLOCA (len
);
9411 memcpy (buffer
, SDATA (msg
), len
);
9413 message_dolog (buffer
, len
- 1, 1, 0);
9420 /* Output a newline in the *Messages* buffer if "needs" one. */
9423 message_log_maybe_newline (void)
9425 if (message_log_need_newline
)
9426 message_dolog ("", 0, 1, 0);
9430 /* Add a string M of length NBYTES to the message log, optionally
9431 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9432 nonzero, means interpret the contents of M as multibyte. This
9433 function calls low-level routines in order to bypass text property
9434 hooks, etc. which might not be safe to run.
9436 This may GC (insert may run before/after change hooks),
9437 so the buffer M must NOT point to a Lisp string. */
9440 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9442 const unsigned char *msg
= (const unsigned char *) m
;
9444 if (!NILP (Vmemory_full
))
9447 if (!NILP (Vmessage_log_max
))
9449 struct buffer
*oldbuf
;
9450 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9451 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9452 ptrdiff_t point_at_end
= 0;
9453 ptrdiff_t zv_at_end
= 0;
9454 Lisp_Object old_deactivate_mark
;
9456 struct gcpro gcpro1
;
9458 old_deactivate_mark
= Vdeactivate_mark
;
9459 oldbuf
= current_buffer
;
9460 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9461 bset_undo_list (current_buffer
, Qt
);
9463 oldpoint
= message_dolog_marker1
;
9464 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9465 oldbegv
= message_dolog_marker2
;
9466 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9467 oldzv
= message_dolog_marker3
;
9468 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9469 GCPRO1 (old_deactivate_mark
);
9477 BEGV_BYTE
= BEG_BYTE
;
9480 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9482 /* Insert the string--maybe converting multibyte to single byte
9483 or vice versa, so that all the text fits the buffer. */
9485 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9491 /* Convert a multibyte string to single-byte
9492 for the *Message* buffer. */
9493 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9495 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9496 work
[0] = (ASCII_CHAR_P (c
)
9498 : multibyte_char_to_unibyte (c
));
9499 insert_1_both (work
, 1, 1, 1, 0, 0);
9502 else if (! multibyte
9503 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9507 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9508 /* Convert a single-byte string to multibyte
9509 for the *Message* buffer. */
9510 for (i
= 0; i
< nbytes
; i
++)
9513 MAKE_CHAR_MULTIBYTE (c
);
9514 char_bytes
= CHAR_STRING (c
, str
);
9515 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9519 insert_1 (m
, nbytes
, 1, 0, 0);
9523 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9525 insert_1 ("\n", 1, 1, 0, 0);
9527 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9529 this_bol_byte
= PT_BYTE
;
9531 /* See if this line duplicates the previous one.
9532 If so, combine duplicates. */
9535 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9537 prev_bol_byte
= PT_BYTE
;
9539 dups
= message_log_check_duplicate (prev_bol_byte
,
9543 del_range_both (prev_bol
, prev_bol_byte
,
9544 this_bol
, this_bol_byte
, 0);
9547 char dupstr
[sizeof " [ times]"
9548 + INT_STRLEN_BOUND (printmax_t
)];
9550 /* If you change this format, don't forget to also
9551 change message_log_check_duplicate. */
9552 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9553 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9554 insert_1 (dupstr
, duplen
, 1, 0, 1);
9559 /* If we have more than the desired maximum number of lines
9560 in the *Messages* buffer now, delete the oldest ones.
9561 This is safe because we don't have undo in this buffer. */
9563 if (NATNUMP (Vmessage_log_max
))
9565 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9566 -XFASTINT (Vmessage_log_max
) - 1, 0);
9567 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9570 BEGV
= marker_position (oldbegv
);
9571 BEGV_BYTE
= marker_byte_position (oldbegv
);
9580 ZV
= marker_position (oldzv
);
9581 ZV_BYTE
= marker_byte_position (oldzv
);
9585 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9587 /* We can't do Fgoto_char (oldpoint) because it will run some
9589 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9590 marker_byte_position (oldpoint
));
9593 unchain_marker (XMARKER (oldpoint
));
9594 unchain_marker (XMARKER (oldbegv
));
9595 unchain_marker (XMARKER (oldzv
));
9597 shown
= buffer_window_count (current_buffer
) > 0;
9598 set_buffer_internal (oldbuf
);
9600 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9601 message_log_need_newline
= !nlflag
;
9602 Vdeactivate_mark
= old_deactivate_mark
;
9607 /* We are at the end of the buffer after just having inserted a newline.
9608 (Note: We depend on the fact we won't be crossing the gap.)
9609 Check to see if the most recent message looks a lot like the previous one.
9610 Return 0 if different, 1 if the new one should just replace it, or a
9611 value N > 1 if we should also append " [N times]". */
9614 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9617 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9619 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9620 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9622 for (i
= 0; i
< len
; i
++)
9624 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9632 if (*p1
++ == ' ' && *p1
++ == '[')
9635 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9636 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9643 /* Display an echo area message M with a specified length of NBYTES
9644 bytes. The string may include null characters. If M is 0, clear
9645 out any existing message, and let the mini-buffer text show
9648 This may GC, so the buffer M must NOT point to a Lisp string. */
9651 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9653 /* First flush out any partial line written with print. */
9654 message_log_maybe_newline ();
9656 message_dolog (m
, nbytes
, 1, multibyte
);
9657 message2_nolog (m
, nbytes
, multibyte
);
9661 /* The non-logging counterpart of message2. */
9664 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9666 struct frame
*sf
= SELECTED_FRAME ();
9667 message_enable_multibyte
= multibyte
;
9669 if (FRAME_INITIAL_P (sf
))
9671 if (noninteractive_need_newline
)
9672 putc ('\n', stderr
);
9673 noninteractive_need_newline
= 0;
9675 fwrite (m
, nbytes
, 1, stderr
);
9676 if (cursor_in_echo_area
== 0)
9677 fprintf (stderr
, "\n");
9680 /* A null message buffer means that the frame hasn't really been
9681 initialized yet. Error messages get reported properly by
9682 cmd_error, so this must be just an informative message; toss it. */
9683 else if (INTERACTIVE
9684 && sf
->glyphs_initialized_p
9685 && FRAME_MESSAGE_BUF (sf
))
9687 Lisp_Object mini_window
;
9690 /* Get the frame containing the mini-buffer
9691 that the selected frame is using. */
9692 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9693 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9695 FRAME_SAMPLE_VISIBILITY (f
);
9696 if (FRAME_VISIBLE_P (sf
)
9697 && ! FRAME_VISIBLE_P (f
))
9698 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9702 set_message (m
, Qnil
, nbytes
, multibyte
);
9703 if (minibuffer_auto_raise
)
9704 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9707 clear_message (1, 1);
9709 do_pending_window_change (0);
9710 echo_area_display (1);
9711 do_pending_window_change (0);
9712 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9713 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9718 /* Display an echo area message M with a specified length of NBYTES
9719 bytes. The string may include null characters. If M is not a
9720 string, clear out any existing message, and let the mini-buffer
9723 This function cancels echoing. */
9726 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9728 struct gcpro gcpro1
;
9731 clear_message (1,1);
9734 /* First flush out any partial line written with print. */
9735 message_log_maybe_newline ();
9739 char *buffer
= SAFE_ALLOCA (nbytes
);
9740 memcpy (buffer
, SDATA (m
), nbytes
);
9741 message_dolog (buffer
, nbytes
, 1, multibyte
);
9744 message3_nolog (m
, nbytes
, multibyte
);
9750 /* The non-logging version of message3.
9751 This does not cancel echoing, because it is used for echoing.
9752 Perhaps we need to make a separate function for echoing
9753 and make this cancel echoing. */
9756 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9758 struct frame
*sf
= SELECTED_FRAME ();
9759 message_enable_multibyte
= multibyte
;
9761 if (FRAME_INITIAL_P (sf
))
9763 if (noninteractive_need_newline
)
9764 putc ('\n', stderr
);
9765 noninteractive_need_newline
= 0;
9767 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9768 if (cursor_in_echo_area
== 0)
9769 fprintf (stderr
, "\n");
9772 /* A null message buffer means that the frame hasn't really been
9773 initialized yet. Error messages get reported properly by
9774 cmd_error, so this must be just an informative message; toss it. */
9775 else if (INTERACTIVE
9776 && sf
->glyphs_initialized_p
9777 && FRAME_MESSAGE_BUF (sf
))
9779 Lisp_Object mini_window
;
9783 /* Get the frame containing the mini-buffer
9784 that the selected frame is using. */
9785 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9786 frame
= XWINDOW (mini_window
)->frame
;
9789 FRAME_SAMPLE_VISIBILITY (f
);
9790 if (FRAME_VISIBLE_P (sf
)
9791 && !FRAME_VISIBLE_P (f
))
9792 Fmake_frame_visible (frame
);
9794 if (STRINGP (m
) && SCHARS (m
) > 0)
9796 set_message (NULL
, m
, nbytes
, multibyte
);
9797 if (minibuffer_auto_raise
)
9798 Fraise_frame (frame
);
9799 /* Assume we are not echoing.
9800 (If we are, echo_now will override this.) */
9801 echo_message_buffer
= Qnil
;
9804 clear_message (1, 1);
9806 do_pending_window_change (0);
9807 echo_area_display (1);
9808 do_pending_window_change (0);
9809 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
9810 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9815 /* Display a null-terminated echo area message M. If M is 0, clear
9816 out any existing message, and let the mini-buffer text show through.
9818 The buffer M must continue to exist until after the echo area gets
9819 cleared or some other message gets displayed there. Do not pass
9820 text that is stored in a Lisp string. Do not pass text in a buffer
9821 that was alloca'd. */
9824 message1 (const char *m
)
9826 message2 (m
, (m
? strlen (m
) : 0), 0);
9830 /* The non-logging counterpart of message1. */
9833 message1_nolog (const char *m
)
9835 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9838 /* Display a message M which contains a single %s
9839 which gets replaced with STRING. */
9842 message_with_string (const char *m
, Lisp_Object string
, int log
)
9844 CHECK_STRING (string
);
9850 if (noninteractive_need_newline
)
9851 putc ('\n', stderr
);
9852 noninteractive_need_newline
= 0;
9853 fprintf (stderr
, m
, SDATA (string
));
9854 if (!cursor_in_echo_area
)
9855 fprintf (stderr
, "\n");
9859 else if (INTERACTIVE
)
9861 /* The frame whose minibuffer we're going to display the message on.
9862 It may be larger than the selected frame, so we need
9863 to use its buffer, not the selected frame's buffer. */
9864 Lisp_Object mini_window
;
9865 struct frame
*f
, *sf
= SELECTED_FRAME ();
9867 /* Get the frame containing the minibuffer
9868 that the selected frame is using. */
9869 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9870 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9872 /* A null message buffer means that the frame hasn't really been
9873 initialized yet. Error messages get reported properly by
9874 cmd_error, so this must be just an informative message; toss it. */
9875 if (FRAME_MESSAGE_BUF (f
))
9877 Lisp_Object args
[2], msg
;
9878 struct gcpro gcpro1
, gcpro2
;
9880 args
[0] = build_string (m
);
9881 args
[1] = msg
= string
;
9882 GCPRO2 (args
[0], msg
);
9885 msg
= Fformat (2, args
);
9888 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9890 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9894 /* Print should start at the beginning of the message
9895 buffer next time. */
9896 message_buf_print
= 0;
9902 /* Dump an informative message to the minibuf. If M is 0, clear out
9903 any existing message, and let the mini-buffer text show through. */
9906 vmessage (const char *m
, va_list ap
)
9912 if (noninteractive_need_newline
)
9913 putc ('\n', stderr
);
9914 noninteractive_need_newline
= 0;
9915 vfprintf (stderr
, m
, ap
);
9916 if (cursor_in_echo_area
== 0)
9917 fprintf (stderr
, "\n");
9921 else if (INTERACTIVE
)
9923 /* The frame whose mini-buffer we're going to display the message
9924 on. It may be larger than the selected frame, so we need to
9925 use its buffer, not the selected frame's buffer. */
9926 Lisp_Object mini_window
;
9927 struct frame
*f
, *sf
= SELECTED_FRAME ();
9929 /* Get the frame containing the mini-buffer
9930 that the selected frame is using. */
9931 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9932 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9934 /* A null message buffer means that the frame hasn't really been
9935 initialized yet. Error messages get reported properly by
9936 cmd_error, so this must be just an informative message; toss
9938 if (FRAME_MESSAGE_BUF (f
))
9944 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9945 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9947 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9952 /* Print should start at the beginning of the message
9953 buffer next time. */
9954 message_buf_print
= 0;
9960 message (const char *m
, ...)
9970 /* The non-logging version of message. */
9973 message_nolog (const char *m
, ...)
9975 Lisp_Object old_log_max
;
9978 old_log_max
= Vmessage_log_max
;
9979 Vmessage_log_max
= Qnil
;
9981 Vmessage_log_max
= old_log_max
;
9987 /* Display the current message in the current mini-buffer. This is
9988 only called from error handlers in process.c, and is not time
9992 update_echo_area (void)
9994 if (!NILP (echo_area_buffer
[0]))
9997 string
= Fcurrent_message ();
9998 message3 (string
, SBYTES (string
),
9999 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
10004 /* Make sure echo area buffers in `echo_buffers' are live.
10005 If they aren't, make new ones. */
10008 ensure_echo_area_buffers (void)
10012 for (i
= 0; i
< 2; ++i
)
10013 if (!BUFFERP (echo_buffer
[i
])
10014 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10017 Lisp_Object old_buffer
;
10020 old_buffer
= echo_buffer
[i
];
10021 echo_buffer
[i
] = Fget_buffer_create
10022 (make_formatted_string (name
, " *Echo Area %d*", i
));
10023 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10024 /* to force word wrap in echo area -
10025 it was decided to postpone this*/
10026 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10028 for (j
= 0; j
< 2; ++j
)
10029 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10030 echo_area_buffer
[j
] = echo_buffer
[i
];
10035 /* Call FN with args A1..A4 with either the current or last displayed
10036 echo_area_buffer as current buffer.
10038 WHICH zero means use the current message buffer
10039 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10040 from echo_buffer[] and clear it.
10042 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10043 suitable buffer from echo_buffer[] and clear it.
10045 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10046 that the current message becomes the last displayed one, make
10047 choose a suitable buffer for echo_area_buffer[0], and clear it.
10049 Value is what FN returns. */
10052 with_echo_area_buffer (struct window
*w
, int which
,
10053 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
10054 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10056 Lisp_Object buffer
;
10057 int this_one
, the_other
, clear_buffer_p
, rc
;
10058 ptrdiff_t count
= SPECPDL_INDEX ();
10060 /* If buffers aren't live, make new ones. */
10061 ensure_echo_area_buffers ();
10063 clear_buffer_p
= 0;
10066 this_one
= 0, the_other
= 1;
10067 else if (which
> 0)
10068 this_one
= 1, the_other
= 0;
10071 this_one
= 0, the_other
= 1;
10072 clear_buffer_p
= 1;
10074 /* We need a fresh one in case the current echo buffer equals
10075 the one containing the last displayed echo area message. */
10076 if (!NILP (echo_area_buffer
[this_one
])
10077 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10078 echo_area_buffer
[this_one
] = Qnil
;
10081 /* Choose a suitable buffer from echo_buffer[] is we don't
10083 if (NILP (echo_area_buffer
[this_one
]))
10085 echo_area_buffer
[this_one
]
10086 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10087 ? echo_buffer
[the_other
]
10088 : echo_buffer
[this_one
]);
10089 clear_buffer_p
= 1;
10092 buffer
= echo_area_buffer
[this_one
];
10094 /* Don't get confused by reusing the buffer used for echoing
10095 for a different purpose. */
10096 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10099 record_unwind_protect (unwind_with_echo_area_buffer
,
10100 with_echo_area_buffer_unwind_data (w
));
10102 /* Make the echo area buffer current. Note that for display
10103 purposes, it is not necessary that the displayed window's buffer
10104 == current_buffer, except for text property lookup. So, let's
10105 only set that buffer temporarily here without doing a full
10106 Fset_window_buffer. We must also change w->pointm, though,
10107 because otherwise an assertions in unshow_buffer fails, and Emacs
10109 set_buffer_internal_1 (XBUFFER (buffer
));
10112 wset_buffer (w
, buffer
);
10113 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10116 bset_undo_list (current_buffer
, Qt
);
10117 bset_read_only (current_buffer
, Qnil
);
10118 specbind (Qinhibit_read_only
, Qt
);
10119 specbind (Qinhibit_modification_hooks
, Qt
);
10121 if (clear_buffer_p
&& Z
> BEG
)
10122 del_range (BEG
, Z
);
10124 eassert (BEGV
>= BEG
);
10125 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10127 rc
= fn (a1
, a2
, a3
, a4
);
10129 eassert (BEGV
>= BEG
);
10130 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10132 unbind_to (count
, Qnil
);
10137 /* Save state that should be preserved around the call to the function
10138 FN called in with_echo_area_buffer. */
10141 with_echo_area_buffer_unwind_data (struct window
*w
)
10144 Lisp_Object vector
, tmp
;
10146 /* Reduce consing by keeping one vector in
10147 Vwith_echo_area_save_vector. */
10148 vector
= Vwith_echo_area_save_vector
;
10149 Vwith_echo_area_save_vector
= Qnil
;
10152 vector
= Fmake_vector (make_number (7), Qnil
);
10154 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10155 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10156 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10160 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10161 ASET (vector
, i
, w
->buffer
); ++i
;
10162 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10163 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10168 for (; i
< end
; ++i
)
10169 ASET (vector
, i
, Qnil
);
10172 eassert (i
== ASIZE (vector
));
10177 /* Restore global state from VECTOR which was created by
10178 with_echo_area_buffer_unwind_data. */
10181 unwind_with_echo_area_buffer (Lisp_Object vector
)
10183 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10184 Vdeactivate_mark
= AREF (vector
, 1);
10185 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10187 if (WINDOWP (AREF (vector
, 3)))
10190 Lisp_Object buffer
, charpos
, bytepos
;
10192 w
= XWINDOW (AREF (vector
, 3));
10193 buffer
= AREF (vector
, 4);
10194 charpos
= AREF (vector
, 5);
10195 bytepos
= AREF (vector
, 6);
10197 wset_buffer (w
, buffer
);
10198 set_marker_both (w
->pointm
, buffer
,
10199 XFASTINT (charpos
), XFASTINT (bytepos
));
10202 Vwith_echo_area_save_vector
= vector
;
10207 /* Set up the echo area for use by print functions. MULTIBYTE_P
10208 non-zero means we will print multibyte. */
10211 setup_echo_area_for_printing (int multibyte_p
)
10213 /* If we can't find an echo area any more, exit. */
10214 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10215 Fkill_emacs (Qnil
);
10217 ensure_echo_area_buffers ();
10219 if (!message_buf_print
)
10221 /* A message has been output since the last time we printed.
10222 Choose a fresh echo area buffer. */
10223 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10224 echo_area_buffer
[0] = echo_buffer
[1];
10226 echo_area_buffer
[0] = echo_buffer
[0];
10228 /* Switch to that buffer and clear it. */
10229 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10230 bset_truncate_lines (current_buffer
, Qnil
);
10234 ptrdiff_t count
= SPECPDL_INDEX ();
10235 specbind (Qinhibit_read_only
, Qt
);
10236 /* Note that undo recording is always disabled. */
10237 del_range (BEG
, Z
);
10238 unbind_to (count
, Qnil
);
10240 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10242 /* Set up the buffer for the multibyteness we need. */
10244 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10245 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10247 /* Raise the frame containing the echo area. */
10248 if (minibuffer_auto_raise
)
10250 struct frame
*sf
= SELECTED_FRAME ();
10251 Lisp_Object mini_window
;
10252 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10253 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10256 message_log_maybe_newline ();
10257 message_buf_print
= 1;
10261 if (NILP (echo_area_buffer
[0]))
10263 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10264 echo_area_buffer
[0] = echo_buffer
[1];
10266 echo_area_buffer
[0] = echo_buffer
[0];
10269 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10271 /* Someone switched buffers between print requests. */
10272 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10273 bset_truncate_lines (current_buffer
, Qnil
);
10279 /* Display an echo area message in window W. Value is non-zero if W's
10280 height is changed. If display_last_displayed_message_p is
10281 non-zero, display the message that was last displayed, otherwise
10282 display the current message. */
10285 display_echo_area (struct window
*w
)
10287 int i
, no_message_p
, window_height_changed_p
;
10289 /* Temporarily disable garbage collections while displaying the echo
10290 area. This is done because a GC can print a message itself.
10291 That message would modify the echo area buffer's contents while a
10292 redisplay of the buffer is going on, and seriously confuse
10294 ptrdiff_t count
= inhibit_garbage_collection ();
10296 /* If there is no message, we must call display_echo_area_1
10297 nevertheless because it resizes the window. But we will have to
10298 reset the echo_area_buffer in question to nil at the end because
10299 with_echo_area_buffer will sets it to an empty buffer. */
10300 i
= display_last_displayed_message_p
? 1 : 0;
10301 no_message_p
= NILP (echo_area_buffer
[i
]);
10303 window_height_changed_p
10304 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10305 display_echo_area_1
,
10306 (intptr_t) w
, Qnil
, 0, 0);
10309 echo_area_buffer
[i
] = Qnil
;
10311 unbind_to (count
, Qnil
);
10312 return window_height_changed_p
;
10316 /* Helper for display_echo_area. Display the current buffer which
10317 contains the current echo area message in window W, a mini-window,
10318 a pointer to which is passed in A1. A2..A4 are currently not used.
10319 Change the height of W so that all of the message is displayed.
10320 Value is non-zero if height of W was changed. */
10323 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10326 struct window
*w
= (struct window
*) i1
;
10327 Lisp_Object window
;
10328 struct text_pos start
;
10329 int window_height_changed_p
= 0;
10331 /* Do this before displaying, so that we have a large enough glyph
10332 matrix for the display. If we can't get enough space for the
10333 whole text, display the last N lines. That works by setting w->start. */
10334 window_height_changed_p
= resize_mini_window (w
, 0);
10336 /* Use the starting position chosen by resize_mini_window. */
10337 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10340 clear_glyph_matrix (w
->desired_matrix
);
10341 XSETWINDOW (window
, w
);
10342 try_window (window
, start
, 0);
10344 return window_height_changed_p
;
10348 /* Resize the echo area window to exactly the size needed for the
10349 currently displayed message, if there is one. If a mini-buffer
10350 is active, don't shrink it. */
10353 resize_echo_area_exactly (void)
10355 if (BUFFERP (echo_area_buffer
[0])
10356 && WINDOWP (echo_area_window
))
10358 struct window
*w
= XWINDOW (echo_area_window
);
10360 Lisp_Object resize_exactly
;
10362 if (minibuf_level
== 0)
10363 resize_exactly
= Qt
;
10365 resize_exactly
= Qnil
;
10367 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10368 (intptr_t) w
, resize_exactly
,
10372 ++windows_or_buffers_changed
;
10373 ++update_mode_lines
;
10374 redisplay_internal ();
10380 /* Callback function for with_echo_area_buffer, when used from
10381 resize_echo_area_exactly. A1 contains a pointer to the window to
10382 resize, EXACTLY non-nil means resize the mini-window exactly to the
10383 size of the text displayed. A3 and A4 are not used. Value is what
10384 resize_mini_window returns. */
10387 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10390 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10394 /* Resize mini-window W to fit the size of its contents. EXACT_P
10395 means size the window exactly to the size needed. Otherwise, it's
10396 only enlarged until W's buffer is empty.
10398 Set W->start to the right place to begin display. If the whole
10399 contents fit, start at the beginning. Otherwise, start so as
10400 to make the end of the contents appear. This is particularly
10401 important for y-or-n-p, but seems desirable generally.
10403 Value is non-zero if the window height has been changed. */
10406 resize_mini_window (struct window
*w
, int exact_p
)
10408 struct frame
*f
= XFRAME (w
->frame
);
10409 int window_height_changed_p
= 0;
10411 eassert (MINI_WINDOW_P (w
));
10413 /* By default, start display at the beginning. */
10414 set_marker_both (w
->start
, w
->buffer
,
10415 BUF_BEGV (XBUFFER (w
->buffer
)),
10416 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10418 /* Don't resize windows while redisplaying a window; it would
10419 confuse redisplay functions when the size of the window they are
10420 displaying changes from under them. Such a resizing can happen,
10421 for instance, when which-func prints a long message while
10422 we are running fontification-functions. We're running these
10423 functions with safe_call which binds inhibit-redisplay to t. */
10424 if (!NILP (Vinhibit_redisplay
))
10427 /* Nil means don't try to resize. */
10428 if (NILP (Vresize_mini_windows
)
10429 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10432 if (!FRAME_MINIBUF_ONLY_P (f
))
10435 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10436 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10438 EMACS_INT max_height
;
10439 int unit
= FRAME_LINE_HEIGHT (f
);
10440 struct text_pos start
;
10441 struct buffer
*old_current_buffer
= NULL
;
10443 if (current_buffer
!= XBUFFER (w
->buffer
))
10445 old_current_buffer
= current_buffer
;
10446 set_buffer_internal (XBUFFER (w
->buffer
));
10449 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10451 /* Compute the max. number of lines specified by the user. */
10452 if (FLOATP (Vmax_mini_window_height
))
10453 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10454 else if (INTEGERP (Vmax_mini_window_height
))
10455 max_height
= XINT (Vmax_mini_window_height
);
10457 max_height
= total_height
/ 4;
10459 /* Correct that max. height if it's bogus. */
10460 max_height
= clip_to_bounds (1, max_height
, total_height
);
10462 /* Find out the height of the text in the window. */
10463 if (it
.line_wrap
== TRUNCATE
)
10468 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10469 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10470 height
= it
.current_y
+ last_height
;
10472 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10473 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10474 height
= (height
+ unit
- 1) / unit
;
10477 /* Compute a suitable window start. */
10478 if (height
> max_height
)
10480 height
= max_height
;
10481 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10482 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10483 start
= it
.current
.pos
;
10486 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10487 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10489 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10491 /* Let it grow only, until we display an empty message, in which
10492 case the window shrinks again. */
10493 if (height
> WINDOW_TOTAL_LINES (w
))
10495 int old_height
= WINDOW_TOTAL_LINES (w
);
10496 freeze_window_starts (f
, 1);
10497 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10498 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10500 else if (height
< WINDOW_TOTAL_LINES (w
)
10501 && (exact_p
|| BEGV
== ZV
))
10503 int old_height
= WINDOW_TOTAL_LINES (w
);
10504 freeze_window_starts (f
, 0);
10505 shrink_mini_window (w
);
10506 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10511 /* Always resize to exact size needed. */
10512 if (height
> WINDOW_TOTAL_LINES (w
))
10514 int old_height
= WINDOW_TOTAL_LINES (w
);
10515 freeze_window_starts (f
, 1);
10516 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10517 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10519 else if (height
< WINDOW_TOTAL_LINES (w
))
10521 int old_height
= WINDOW_TOTAL_LINES (w
);
10522 freeze_window_starts (f
, 0);
10523 shrink_mini_window (w
);
10527 freeze_window_starts (f
, 1);
10528 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10531 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10535 if (old_current_buffer
)
10536 set_buffer_internal (old_current_buffer
);
10539 return window_height_changed_p
;
10543 /* Value is the current message, a string, or nil if there is no
10544 current message. */
10547 current_message (void)
10551 if (!BUFFERP (echo_area_buffer
[0]))
10555 with_echo_area_buffer (0, 0, current_message_1
,
10556 (intptr_t) &msg
, Qnil
, 0, 0);
10558 echo_area_buffer
[0] = Qnil
;
10566 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10569 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10572 *msg
= make_buffer_string (BEG
, Z
, 1);
10579 /* Push the current message on Vmessage_stack for later restoration
10580 by restore_message. Value is non-zero if the current message isn't
10581 empty. This is a relatively infrequent operation, so it's not
10582 worth optimizing. */
10585 push_message (void)
10587 Lisp_Object msg
= current_message ();
10588 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10589 return STRINGP (msg
);
10593 /* Restore message display from the top of Vmessage_stack. */
10596 restore_message (void)
10600 eassert (CONSP (Vmessage_stack
));
10601 msg
= XCAR (Vmessage_stack
);
10603 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10605 message3_nolog (msg
, 0, 0);
10609 /* Handler for record_unwind_protect calling pop_message. */
10612 pop_message_unwind (Lisp_Object dummy
)
10618 /* Pop the top-most entry off Vmessage_stack. */
10623 eassert (CONSP (Vmessage_stack
));
10624 Vmessage_stack
= XCDR (Vmessage_stack
);
10628 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10629 exits. If the stack is not empty, we have a missing pop_message
10633 check_message_stack (void)
10635 if (!NILP (Vmessage_stack
))
10640 /* Truncate to NCHARS what will be displayed in the echo area the next
10641 time we display it---but don't redisplay it now. */
10644 truncate_echo_area (ptrdiff_t nchars
)
10647 echo_area_buffer
[0] = Qnil
;
10648 /* A null message buffer means that the frame hasn't really been
10649 initialized yet. Error messages get reported properly by
10650 cmd_error, so this must be just an informative message; toss it. */
10651 else if (!noninteractive
10653 && !NILP (echo_area_buffer
[0]))
10655 struct frame
*sf
= SELECTED_FRAME ();
10656 if (FRAME_MESSAGE_BUF (sf
))
10657 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10662 /* Helper function for truncate_echo_area. Truncate the current
10663 message to at most NCHARS characters. */
10666 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10668 if (BEG
+ nchars
< Z
)
10669 del_range (BEG
+ nchars
, Z
);
10671 echo_area_buffer
[0] = Qnil
;
10675 /* Set the current message to a substring of S or STRING.
10677 If STRING is a Lisp string, set the message to the first NBYTES
10678 bytes from STRING. NBYTES zero means use the whole string. If
10679 STRING is multibyte, the message will be displayed multibyte.
10681 If S is not null, set the message to the first LEN bytes of S. LEN
10682 zero means use the whole string. MULTIBYTE_P non-zero means S is
10683 multibyte. Display the message multibyte in that case.
10685 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10686 to t before calling set_message_1 (which calls insert).
10690 set_message (const char *s
, Lisp_Object string
,
10691 ptrdiff_t nbytes
, int multibyte_p
)
10693 message_enable_multibyte
10694 = ((s
&& multibyte_p
)
10695 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10697 with_echo_area_buffer (0, -1, set_message_1
,
10698 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10699 message_buf_print
= 0;
10700 help_echo_showing_p
= 0;
10702 if (STRINGP (Vdebug_on_message
)
10703 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10704 call_debugger (list2 (Qerror
, string
));
10708 /* Helper function for set_message. Arguments have the same meaning
10709 as there, with A1 corresponding to S and A2 corresponding to STRING
10710 This function is called with the echo area buffer being
10714 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10717 const char *s
= (const char *) i1
;
10718 const unsigned char *msg
= (const unsigned char *) s
;
10719 Lisp_Object string
= a2
;
10721 /* Change multibyteness of the echo buffer appropriately. */
10722 if (message_enable_multibyte
10723 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10724 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10726 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10727 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10728 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10730 /* Insert new message at BEG. */
10731 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10733 if (STRINGP (string
))
10738 nbytes
= SBYTES (string
);
10739 nchars
= string_byte_to_char (string
, nbytes
);
10741 /* This function takes care of single/multibyte conversion. We
10742 just have to ensure that the echo area buffer has the right
10743 setting of enable_multibyte_characters. */
10744 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10749 nbytes
= strlen (s
);
10751 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10753 /* Convert from multi-byte to single-byte. */
10758 /* Convert a multibyte string to single-byte. */
10759 for (i
= 0; i
< nbytes
; i
+= n
)
10761 c
= string_char_and_length (msg
+ i
, &n
);
10762 work
[0] = (ASCII_CHAR_P (c
)
10764 : multibyte_char_to_unibyte (c
));
10765 insert_1_both (work
, 1, 1, 1, 0, 0);
10768 else if (!multibyte_p
10769 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10771 /* Convert from single-byte to multi-byte. */
10774 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10776 /* Convert a single-byte string to multibyte. */
10777 for (i
= 0; i
< nbytes
; i
++)
10780 MAKE_CHAR_MULTIBYTE (c
);
10781 n
= CHAR_STRING (c
, str
);
10782 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10786 insert_1 (s
, nbytes
, 1, 0, 0);
10793 /* Clear messages. CURRENT_P non-zero means clear the current
10794 message. LAST_DISPLAYED_P non-zero means clear the message
10798 clear_message (int current_p
, int last_displayed_p
)
10802 echo_area_buffer
[0] = Qnil
;
10803 message_cleared_p
= 1;
10806 if (last_displayed_p
)
10807 echo_area_buffer
[1] = Qnil
;
10809 message_buf_print
= 0;
10812 /* Clear garbaged frames.
10814 This function is used where the old redisplay called
10815 redraw_garbaged_frames which in turn called redraw_frame which in
10816 turn called clear_frame. The call to clear_frame was a source of
10817 flickering. I believe a clear_frame is not necessary. It should
10818 suffice in the new redisplay to invalidate all current matrices,
10819 and ensure a complete redisplay of all windows. */
10822 clear_garbaged_frames (void)
10824 if (frame_garbaged
)
10826 Lisp_Object tail
, frame
;
10827 int changed_count
= 0;
10829 FOR_EACH_FRAME (tail
, frame
)
10831 struct frame
*f
= XFRAME (frame
);
10833 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10838 f
->force_flush_display_p
= 1;
10840 clear_current_matrices (f
);
10847 frame_garbaged
= 0;
10849 ++windows_or_buffers_changed
;
10854 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10855 is non-zero update selected_frame. Value is non-zero if the
10856 mini-windows height has been changed. */
10859 echo_area_display (int update_frame_p
)
10861 Lisp_Object mini_window
;
10864 int window_height_changed_p
= 0;
10865 struct frame
*sf
= SELECTED_FRAME ();
10867 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10868 w
= XWINDOW (mini_window
);
10869 f
= XFRAME (WINDOW_FRAME (w
));
10871 /* Don't display if frame is invisible or not yet initialized. */
10872 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10875 #ifdef HAVE_WINDOW_SYSTEM
10876 /* When Emacs starts, selected_frame may be the initial terminal
10877 frame. If we let this through, a message would be displayed on
10879 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10881 #endif /* HAVE_WINDOW_SYSTEM */
10883 /* Redraw garbaged frames. */
10884 clear_garbaged_frames ();
10886 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10888 echo_area_window
= mini_window
;
10889 window_height_changed_p
= display_echo_area (w
);
10890 w
->must_be_updated_p
= 1;
10892 /* Update the display, unless called from redisplay_internal.
10893 Also don't update the screen during redisplay itself. The
10894 update will happen at the end of redisplay, and an update
10895 here could cause confusion. */
10896 if (update_frame_p
&& !redisplaying_p
)
10900 /* If the display update has been interrupted by pending
10901 input, update mode lines in the frame. Due to the
10902 pending input, it might have been that redisplay hasn't
10903 been called, so that mode lines above the echo area are
10904 garbaged. This looks odd, so we prevent it here. */
10905 if (!display_completed
)
10906 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10908 if (window_height_changed_p
10909 /* Don't do this if Emacs is shutting down. Redisplay
10910 needs to run hooks. */
10911 && !NILP (Vrun_hooks
))
10913 /* Must update other windows. Likewise as in other
10914 cases, don't let this update be interrupted by
10916 ptrdiff_t count
= SPECPDL_INDEX ();
10917 specbind (Qredisplay_dont_pause
, Qt
);
10918 windows_or_buffers_changed
= 1;
10919 redisplay_internal ();
10920 unbind_to (count
, Qnil
);
10922 else if (FRAME_WINDOW_P (f
) && n
== 0)
10924 /* Window configuration is the same as before.
10925 Can do with a display update of the echo area,
10926 unless we displayed some mode lines. */
10927 update_single_window (w
, 1);
10928 FRAME_RIF (f
)->flush_display (f
);
10931 update_frame (f
, 1, 1);
10933 /* If cursor is in the echo area, make sure that the next
10934 redisplay displays the minibuffer, so that the cursor will
10935 be replaced with what the minibuffer wants. */
10936 if (cursor_in_echo_area
)
10937 ++windows_or_buffers_changed
;
10940 else if (!EQ (mini_window
, selected_window
))
10941 windows_or_buffers_changed
++;
10943 /* Last displayed message is now the current message. */
10944 echo_area_buffer
[1] = echo_area_buffer
[0];
10945 /* Inform read_char that we're not echoing. */
10946 echo_message_buffer
= Qnil
;
10948 /* Prevent redisplay optimization in redisplay_internal by resetting
10949 this_line_start_pos. This is done because the mini-buffer now
10950 displays the message instead of its buffer text. */
10951 if (EQ (mini_window
, selected_window
))
10952 CHARPOS (this_line_start_pos
) = 0;
10954 return window_height_changed_p
;
10957 /* Nonzero if the current window's buffer is shown in more than one
10958 window and was modified since last redisplay. */
10961 buffer_shared_and_changed (void)
10963 return (buffer_window_count (current_buffer
) > 1
10964 && UNCHANGED_MODIFIED
< MODIFF
);
10967 /* Nonzero if W doesn't reflect the actual state of current buffer due
10968 to its text or overlays change. FIXME: this may be called when
10969 XBUFFER (w->buffer) != current_buffer, which looks suspicious. */
10972 window_outdated (struct window
*w
)
10974 return (w
->last_modified
< MODIFF
10975 || w
->last_overlay_modified
< OVERLAY_MODIFF
);
10978 /* Nonzero if W's buffer was changed but not saved or Transient Mark mode
10979 is enabled and mark of W's buffer was changed since last W's update. */
10982 window_buffer_changed (struct window
*w
)
10984 struct buffer
*b
= XBUFFER (w
->buffer
);
10986 eassert (BUFFER_LIVE_P (b
));
10988 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
)
10989 || ((!NILP (Vtransient_mark_mode
) && !NILP (BVAR (b
, mark_active
)))
10990 != !NILP (w
->region_showing
)));
10993 /* Nonzero if W has %c in its mode line and mode line should be updated. */
10996 mode_line_update_needed (struct window
*w
)
10998 return (!NILP (w
->column_number_displayed
)
10999 && !(PT
== w
->last_point
&& !window_outdated (w
))
11000 && (XFASTINT (w
->column_number_displayed
) != current_column ()));
11003 /***********************************************************************
11004 Mode Lines and Frame Titles
11005 ***********************************************************************/
11007 /* A buffer for constructing non-propertized mode-line strings and
11008 frame titles in it; allocated from the heap in init_xdisp and
11009 resized as needed in store_mode_line_noprop_char. */
11011 static char *mode_line_noprop_buf
;
11013 /* The buffer's end, and a current output position in it. */
11015 static char *mode_line_noprop_buf_end
;
11016 static char *mode_line_noprop_ptr
;
11018 #define MODE_LINE_NOPROP_LEN(start) \
11019 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11022 MODE_LINE_DISPLAY
= 0,
11026 } mode_line_target
;
11028 /* Alist that caches the results of :propertize.
11029 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11030 static Lisp_Object mode_line_proptrans_alist
;
11032 /* List of strings making up the mode-line. */
11033 static Lisp_Object mode_line_string_list
;
11035 /* Base face property when building propertized mode line string. */
11036 static Lisp_Object mode_line_string_face
;
11037 static Lisp_Object mode_line_string_face_prop
;
11040 /* Unwind data for mode line strings */
11042 static Lisp_Object Vmode_line_unwind_vector
;
11045 format_mode_line_unwind_data (struct frame
*target_frame
,
11046 struct buffer
*obuf
,
11048 int save_proptrans
)
11050 Lisp_Object vector
, tmp
;
11052 /* Reduce consing by keeping one vector in
11053 Vwith_echo_area_save_vector. */
11054 vector
= Vmode_line_unwind_vector
;
11055 Vmode_line_unwind_vector
= Qnil
;
11058 vector
= Fmake_vector (make_number (10), Qnil
);
11060 ASET (vector
, 0, make_number (mode_line_target
));
11061 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11062 ASET (vector
, 2, mode_line_string_list
);
11063 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11064 ASET (vector
, 4, mode_line_string_face
);
11065 ASET (vector
, 5, mode_line_string_face_prop
);
11068 XSETBUFFER (tmp
, obuf
);
11071 ASET (vector
, 6, tmp
);
11072 ASET (vector
, 7, owin
);
11075 /* Similarly to `with-selected-window', if the operation selects
11076 a window on another frame, we must restore that frame's
11077 selected window, and (for a tty) the top-frame. */
11078 ASET (vector
, 8, target_frame
->selected_window
);
11079 if (FRAME_TERMCAP_P (target_frame
))
11080 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11087 unwind_format_mode_line (Lisp_Object vector
)
11089 Lisp_Object old_window
= AREF (vector
, 7);
11090 Lisp_Object target_frame_window
= AREF (vector
, 8);
11091 Lisp_Object old_top_frame
= AREF (vector
, 9);
11093 mode_line_target
= XINT (AREF (vector
, 0));
11094 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11095 mode_line_string_list
= AREF (vector
, 2);
11096 if (! EQ (AREF (vector
, 3), Qt
))
11097 mode_line_proptrans_alist
= AREF (vector
, 3);
11098 mode_line_string_face
= AREF (vector
, 4);
11099 mode_line_string_face_prop
= AREF (vector
, 5);
11101 /* Select window before buffer, since it may change the buffer. */
11102 if (!NILP (old_window
))
11104 /* If the operation that we are unwinding had selected a window
11105 on a different frame, reset its frame-selected-window. For a
11106 text terminal, reset its top-frame if necessary. */
11107 if (!NILP (target_frame_window
))
11110 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11112 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11113 Fselect_window (target_frame_window
, Qt
);
11115 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11116 Fselect_frame (old_top_frame
, Qt
);
11119 Fselect_window (old_window
, Qt
);
11122 if (!NILP (AREF (vector
, 6)))
11124 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11125 ASET (vector
, 6, Qnil
);
11128 Vmode_line_unwind_vector
= vector
;
11133 /* Store a single character C for the frame title in mode_line_noprop_buf.
11134 Re-allocate mode_line_noprop_buf if necessary. */
11137 store_mode_line_noprop_char (char c
)
11139 /* If output position has reached the end of the allocated buffer,
11140 increase the buffer's size. */
11141 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11143 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11144 ptrdiff_t size
= len
;
11145 mode_line_noprop_buf
=
11146 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11147 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11148 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11151 *mode_line_noprop_ptr
++ = c
;
11155 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11156 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11157 characters that yield more columns than PRECISION; PRECISION <= 0
11158 means copy the whole string. Pad with spaces until FIELD_WIDTH
11159 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11160 pad. Called from display_mode_element when it is used to build a
11164 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11166 const unsigned char *str
= (const unsigned char *) string
;
11168 ptrdiff_t dummy
, nbytes
;
11170 /* Copy at most PRECISION chars from STR. */
11171 nbytes
= strlen (string
);
11172 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11174 store_mode_line_noprop_char (*str
++);
11176 /* Fill up with spaces until FIELD_WIDTH reached. */
11177 while (field_width
> 0
11178 && n
< field_width
)
11180 store_mode_line_noprop_char (' ');
11187 /***********************************************************************
11189 ***********************************************************************/
11191 #ifdef HAVE_WINDOW_SYSTEM
11193 /* Set the title of FRAME, if it has changed. The title format is
11194 Vicon_title_format if FRAME is iconified, otherwise it is
11195 frame_title_format. */
11198 x_consider_frame_title (Lisp_Object frame
)
11200 struct frame
*f
= XFRAME (frame
);
11202 if (FRAME_WINDOW_P (f
)
11203 || FRAME_MINIBUF_ONLY_P (f
)
11204 || f
->explicit_name
)
11206 /* Do we have more than one visible frame on this X display? */
11207 Lisp_Object tail
, other_frame
, fmt
;
11208 ptrdiff_t title_start
;
11212 ptrdiff_t count
= SPECPDL_INDEX ();
11214 FOR_EACH_FRAME (tail
, other_frame
)
11216 struct frame
*tf
= XFRAME (other_frame
);
11219 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11220 && !FRAME_MINIBUF_ONLY_P (tf
)
11221 && !EQ (other_frame
, tip_frame
)
11222 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11226 /* Set global variable indicating that multiple frames exist. */
11227 multiple_frames
= CONSP (tail
);
11229 /* Switch to the buffer of selected window of the frame. Set up
11230 mode_line_target so that display_mode_element will output into
11231 mode_line_noprop_buf; then display the title. */
11232 record_unwind_protect (unwind_format_mode_line
,
11233 format_mode_line_unwind_data
11234 (f
, current_buffer
, selected_window
, 0));
11236 Fselect_window (f
->selected_window
, Qt
);
11237 set_buffer_internal_1
11238 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11239 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11241 mode_line_target
= MODE_LINE_TITLE
;
11242 title_start
= MODE_LINE_NOPROP_LEN (0);
11243 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11244 NULL
, DEFAULT_FACE_ID
);
11245 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11246 len
= MODE_LINE_NOPROP_LEN (title_start
);
11247 title
= mode_line_noprop_buf
+ title_start
;
11248 unbind_to (count
, Qnil
);
11250 /* Set the title only if it's changed. This avoids consing in
11251 the common case where it hasn't. (If it turns out that we've
11252 already wasted too much time by walking through the list with
11253 display_mode_element, then we might need to optimize at a
11254 higher level than this.) */
11255 if (! STRINGP (f
->name
)
11256 || SBYTES (f
->name
) != len
11257 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11258 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11262 #endif /* not HAVE_WINDOW_SYSTEM */
11265 /***********************************************************************
11267 ***********************************************************************/
11270 /* Prepare for redisplay by updating menu-bar item lists when
11271 appropriate. This can call eval. */
11274 prepare_menu_bars (void)
11277 struct gcpro gcpro1
, gcpro2
;
11279 Lisp_Object tooltip_frame
;
11281 #ifdef HAVE_WINDOW_SYSTEM
11282 tooltip_frame
= tip_frame
;
11284 tooltip_frame
= Qnil
;
11287 /* Update all frame titles based on their buffer names, etc. We do
11288 this before the menu bars so that the buffer-menu will show the
11289 up-to-date frame titles. */
11290 #ifdef HAVE_WINDOW_SYSTEM
11291 if (windows_or_buffers_changed
|| update_mode_lines
)
11293 Lisp_Object tail
, frame
;
11295 FOR_EACH_FRAME (tail
, frame
)
11297 f
= XFRAME (frame
);
11298 if (!EQ (frame
, tooltip_frame
)
11299 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11300 x_consider_frame_title (frame
);
11303 #endif /* HAVE_WINDOW_SYSTEM */
11305 /* Update the menu bar item lists, if appropriate. This has to be
11306 done before any actual redisplay or generation of display lines. */
11307 all_windows
= (update_mode_lines
11308 || buffer_shared_and_changed ()
11309 || windows_or_buffers_changed
);
11312 Lisp_Object tail
, frame
;
11313 ptrdiff_t count
= SPECPDL_INDEX ();
11314 /* 1 means that update_menu_bar has run its hooks
11315 so any further calls to update_menu_bar shouldn't do so again. */
11316 int menu_bar_hooks_run
= 0;
11318 record_unwind_save_match_data ();
11320 FOR_EACH_FRAME (tail
, frame
)
11322 f
= XFRAME (frame
);
11324 /* Ignore tooltip frame. */
11325 if (EQ (frame
, tooltip_frame
))
11328 /* If a window on this frame changed size, report that to
11329 the user and clear the size-change flag. */
11330 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11332 Lisp_Object functions
;
11334 /* Clear flag first in case we get an error below. */
11335 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11336 functions
= Vwindow_size_change_functions
;
11337 GCPRO2 (tail
, functions
);
11339 while (CONSP (functions
))
11341 if (!EQ (XCAR (functions
), Qt
))
11342 call1 (XCAR (functions
), frame
);
11343 functions
= XCDR (functions
);
11349 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11350 #ifdef HAVE_WINDOW_SYSTEM
11351 update_tool_bar (f
, 0);
11354 if (windows_or_buffers_changed
11357 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11362 unbind_to (count
, Qnil
);
11366 struct frame
*sf
= SELECTED_FRAME ();
11367 update_menu_bar (sf
, 1, 0);
11368 #ifdef HAVE_WINDOW_SYSTEM
11369 update_tool_bar (sf
, 1);
11375 /* Update the menu bar item list for frame F. This has to be done
11376 before we start to fill in any display lines, because it can call
11379 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11381 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11382 already ran the menu bar hooks for this redisplay, so there
11383 is no need to run them again. The return value is the
11384 updated value of this flag, to pass to the next call. */
11387 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11389 Lisp_Object window
;
11390 register struct window
*w
;
11392 /* If called recursively during a menu update, do nothing. This can
11393 happen when, for instance, an activate-menubar-hook causes a
11395 if (inhibit_menubar_update
)
11398 window
= FRAME_SELECTED_WINDOW (f
);
11399 w
= XWINDOW (window
);
11401 if (FRAME_WINDOW_P (f
)
11403 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11404 || defined (HAVE_NS) || defined (USE_GTK)
11405 FRAME_EXTERNAL_MENU_BAR (f
)
11407 FRAME_MENU_BAR_LINES (f
) > 0
11409 : FRAME_MENU_BAR_LINES (f
) > 0)
11411 /* If the user has switched buffers or windows, we need to
11412 recompute to reflect the new bindings. But we'll
11413 recompute when update_mode_lines is set too; that means
11414 that people can use force-mode-line-update to request
11415 that the menu bar be recomputed. The adverse effect on
11416 the rest of the redisplay algorithm is about the same as
11417 windows_or_buffers_changed anyway. */
11418 if (windows_or_buffers_changed
11419 /* This used to test w->update_mode_line, but we believe
11420 there is no need to recompute the menu in that case. */
11421 || update_mode_lines
11422 || window_buffer_changed (w
))
11424 struct buffer
*prev
= current_buffer
;
11425 ptrdiff_t count
= SPECPDL_INDEX ();
11427 specbind (Qinhibit_menubar_update
, Qt
);
11429 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11430 if (save_match_data
)
11431 record_unwind_save_match_data ();
11432 if (NILP (Voverriding_local_map_menu_flag
))
11434 specbind (Qoverriding_terminal_local_map
, Qnil
);
11435 specbind (Qoverriding_local_map
, Qnil
);
11440 /* Run the Lucid hook. */
11441 safe_run_hooks (Qactivate_menubar_hook
);
11443 /* If it has changed current-menubar from previous value,
11444 really recompute the menu-bar from the value. */
11445 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11446 call0 (Qrecompute_lucid_menubar
);
11448 safe_run_hooks (Qmenu_bar_update_hook
);
11453 XSETFRAME (Vmenu_updating_frame
, f
);
11454 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11456 /* Redisplay the menu bar in case we changed it. */
11457 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11458 || defined (HAVE_NS) || defined (USE_GTK)
11459 if (FRAME_WINDOW_P (f
))
11461 #if defined (HAVE_NS)
11462 /* All frames on Mac OS share the same menubar. So only
11463 the selected frame should be allowed to set it. */
11464 if (f
== SELECTED_FRAME ())
11466 set_frame_menubar (f
, 0, 0);
11469 /* On a terminal screen, the menu bar is an ordinary screen
11470 line, and this makes it get updated. */
11471 w
->update_mode_line
= 1;
11472 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11473 /* In the non-toolkit version, the menu bar is an ordinary screen
11474 line, and this makes it get updated. */
11475 w
->update_mode_line
= 1;
11476 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11478 unbind_to (count
, Qnil
);
11479 set_buffer_internal_1 (prev
);
11488 /***********************************************************************
11490 ***********************************************************************/
11492 #ifdef HAVE_WINDOW_SYSTEM
11495 Nominal cursor position -- where to draw output.
11496 HPOS and VPOS are window relative glyph matrix coordinates.
11497 X and Y are window relative pixel coordinates. */
11499 struct cursor_pos output_cursor
;
11503 Set the global variable output_cursor to CURSOR. All cursor
11504 positions are relative to updated_window. */
11507 set_output_cursor (struct cursor_pos
*cursor
)
11509 output_cursor
.hpos
= cursor
->hpos
;
11510 output_cursor
.vpos
= cursor
->vpos
;
11511 output_cursor
.x
= cursor
->x
;
11512 output_cursor
.y
= cursor
->y
;
11517 Set a nominal cursor position.
11519 HPOS and VPOS are column/row positions in a window glyph matrix. X
11520 and Y are window text area relative pixel positions.
11522 If this is done during an update, updated_window will contain the
11523 window that is being updated and the position is the future output
11524 cursor position for that window. If updated_window is null, use
11525 selected_window and display the cursor at the given position. */
11528 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11532 /* If updated_window is not set, work on selected_window. */
11533 if (updated_window
)
11534 w
= updated_window
;
11536 w
= XWINDOW (selected_window
);
11538 /* Set the output cursor. */
11539 output_cursor
.hpos
= hpos
;
11540 output_cursor
.vpos
= vpos
;
11541 output_cursor
.x
= x
;
11542 output_cursor
.y
= y
;
11544 /* If not called as part of an update, really display the cursor.
11545 This will also set the cursor position of W. */
11546 if (updated_window
== NULL
)
11549 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11550 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11551 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11556 #endif /* HAVE_WINDOW_SYSTEM */
11559 /***********************************************************************
11561 ***********************************************************************/
11563 #ifdef HAVE_WINDOW_SYSTEM
11565 /* Where the mouse was last time we reported a mouse event. */
11567 FRAME_PTR last_mouse_frame
;
11569 /* Tool-bar item index of the item on which a mouse button was pressed
11572 int last_tool_bar_item
;
11574 /* Select `frame' temporarily without running all the code in
11576 FIXME: Maybe do_switch_frame should be trimmed down similarly
11577 when `norecord' is set. */
11579 fast_set_selected_frame (Lisp_Object frame
)
11581 if (!EQ (selected_frame
, frame
))
11583 selected_frame
= frame
;
11584 selected_window
= XFRAME (frame
)->selected_window
;
11589 /* Update the tool-bar item list for frame F. This has to be done
11590 before we start to fill in any display lines. Called from
11591 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11592 and restore it here. */
11595 update_tool_bar (struct frame
*f
, int save_match_data
)
11597 #if defined (USE_GTK) || defined (HAVE_NS)
11598 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11600 int do_update
= WINDOWP (f
->tool_bar_window
)
11601 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11606 Lisp_Object window
;
11609 window
= FRAME_SELECTED_WINDOW (f
);
11610 w
= XWINDOW (window
);
11612 /* If the user has switched buffers or windows, we need to
11613 recompute to reflect the new bindings. But we'll
11614 recompute when update_mode_lines is set too; that means
11615 that people can use force-mode-line-update to request
11616 that the menu bar be recomputed. The adverse effect on
11617 the rest of the redisplay algorithm is about the same as
11618 windows_or_buffers_changed anyway. */
11619 if (windows_or_buffers_changed
11620 || w
->update_mode_line
11621 || update_mode_lines
11622 || window_buffer_changed (w
))
11624 struct buffer
*prev
= current_buffer
;
11625 ptrdiff_t count
= SPECPDL_INDEX ();
11626 Lisp_Object frame
, new_tool_bar
;
11627 int new_n_tool_bar
;
11628 struct gcpro gcpro1
;
11630 /* Set current_buffer to the buffer of the selected
11631 window of the frame, so that we get the right local
11633 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11635 /* Save match data, if we must. */
11636 if (save_match_data
)
11637 record_unwind_save_match_data ();
11639 /* Make sure that we don't accidentally use bogus keymaps. */
11640 if (NILP (Voverriding_local_map_menu_flag
))
11642 specbind (Qoverriding_terminal_local_map
, Qnil
);
11643 specbind (Qoverriding_local_map
, Qnil
);
11646 GCPRO1 (new_tool_bar
);
11648 /* We must temporarily set the selected frame to this frame
11649 before calling tool_bar_items, because the calculation of
11650 the tool-bar keymap uses the selected frame (see
11651 `tool-bar-make-keymap' in tool-bar.el). */
11652 eassert (EQ (selected_window
,
11653 /* Since we only explicitly preserve selected_frame,
11654 check that selected_window would be redundant. */
11655 XFRAME (selected_frame
)->selected_window
));
11656 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11657 XSETFRAME (frame
, f
);
11658 fast_set_selected_frame (frame
);
11660 /* Build desired tool-bar items from keymaps. */
11662 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11665 /* Redisplay the tool-bar if we changed it. */
11666 if (new_n_tool_bar
!= f
->n_tool_bar_items
11667 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11669 /* Redisplay that happens asynchronously due to an expose event
11670 may access f->tool_bar_items. Make sure we update both
11671 variables within BLOCK_INPUT so no such event interrupts. */
11673 fset_tool_bar_items (f
, new_tool_bar
);
11674 f
->n_tool_bar_items
= new_n_tool_bar
;
11675 w
->update_mode_line
= 1;
11681 unbind_to (count
, Qnil
);
11682 set_buffer_internal_1 (prev
);
11688 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11689 F's desired tool-bar contents. F->tool_bar_items must have
11690 been set up previously by calling prepare_menu_bars. */
11693 build_desired_tool_bar_string (struct frame
*f
)
11695 int i
, size
, size_needed
;
11696 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11697 Lisp_Object image
, plist
, props
;
11699 image
= plist
= props
= Qnil
;
11700 GCPRO3 (image
, plist
, props
);
11702 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11703 Otherwise, make a new string. */
11705 /* The size of the string we might be able to reuse. */
11706 size
= (STRINGP (f
->desired_tool_bar_string
)
11707 ? SCHARS (f
->desired_tool_bar_string
)
11710 /* We need one space in the string for each image. */
11711 size_needed
= f
->n_tool_bar_items
;
11713 /* Reuse f->desired_tool_bar_string, if possible. */
11714 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11715 fset_desired_tool_bar_string
11716 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11719 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11720 Fremove_text_properties (make_number (0), make_number (size
),
11721 props
, f
->desired_tool_bar_string
);
11724 /* Put a `display' property on the string for the images to display,
11725 put a `menu_item' property on tool-bar items with a value that
11726 is the index of the item in F's tool-bar item vector. */
11727 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11729 #define PROP(IDX) \
11730 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11732 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11733 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11734 int hmargin
, vmargin
, relief
, idx
, end
;
11736 /* If image is a vector, choose the image according to the
11738 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11739 if (VECTORP (image
))
11743 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11744 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11747 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11748 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11750 eassert (ASIZE (image
) >= idx
);
11751 image
= AREF (image
, idx
);
11756 /* Ignore invalid image specifications. */
11757 if (!valid_image_p (image
))
11760 /* Display the tool-bar button pressed, or depressed. */
11761 plist
= Fcopy_sequence (XCDR (image
));
11763 /* Compute margin and relief to draw. */
11764 relief
= (tool_bar_button_relief
>= 0
11765 ? tool_bar_button_relief
11766 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11767 hmargin
= vmargin
= relief
;
11769 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11770 INT_MAX
- max (hmargin
, vmargin
)))
11772 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11773 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11775 else if (CONSP (Vtool_bar_button_margin
))
11777 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11778 INT_MAX
- hmargin
))
11779 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11781 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11782 INT_MAX
- vmargin
))
11783 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11786 if (auto_raise_tool_bar_buttons_p
)
11788 /* Add a `:relief' property to the image spec if the item is
11792 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11799 /* If image is selected, display it pressed, i.e. with a
11800 negative relief. If it's not selected, display it with a
11802 plist
= Fplist_put (plist
, QCrelief
,
11804 ? make_number (-relief
)
11805 : make_number (relief
)));
11810 /* Put a margin around the image. */
11811 if (hmargin
|| vmargin
)
11813 if (hmargin
== vmargin
)
11814 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11816 plist
= Fplist_put (plist
, QCmargin
,
11817 Fcons (make_number (hmargin
),
11818 make_number (vmargin
)));
11821 /* If button is not enabled, and we don't have special images
11822 for the disabled state, make the image appear disabled by
11823 applying an appropriate algorithm to it. */
11824 if (!enabled_p
&& idx
< 0)
11825 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11827 /* Put a `display' text property on the string for the image to
11828 display. Put a `menu-item' property on the string that gives
11829 the start of this item's properties in the tool-bar items
11831 image
= Fcons (Qimage
, plist
);
11832 props
= list4 (Qdisplay
, image
,
11833 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11835 /* Let the last image hide all remaining spaces in the tool bar
11836 string. The string can be longer than needed when we reuse a
11837 previous string. */
11838 if (i
+ 1 == f
->n_tool_bar_items
)
11839 end
= SCHARS (f
->desired_tool_bar_string
);
11842 Fadd_text_properties (make_number (i
), make_number (end
),
11843 props
, f
->desired_tool_bar_string
);
11851 /* Display one line of the tool-bar of frame IT->f.
11853 HEIGHT specifies the desired height of the tool-bar line.
11854 If the actual height of the glyph row is less than HEIGHT, the
11855 row's height is increased to HEIGHT, and the icons are centered
11856 vertically in the new height.
11858 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11859 count a final empty row in case the tool-bar width exactly matches
11864 display_tool_bar_line (struct it
*it
, int height
)
11866 struct glyph_row
*row
= it
->glyph_row
;
11867 int max_x
= it
->last_visible_x
;
11868 struct glyph
*last
;
11870 prepare_desired_row (row
);
11871 row
->y
= it
->current_y
;
11873 /* Note that this isn't made use of if the face hasn't a box,
11874 so there's no need to check the face here. */
11875 it
->start_of_box_run_p
= 1;
11877 while (it
->current_x
< max_x
)
11879 int x
, n_glyphs_before
, i
, nglyphs
;
11880 struct it it_before
;
11882 /* Get the next display element. */
11883 if (!get_next_display_element (it
))
11885 /* Don't count empty row if we are counting needed tool-bar lines. */
11886 if (height
< 0 && !it
->hpos
)
11891 /* Produce glyphs. */
11892 n_glyphs_before
= row
->used
[TEXT_AREA
];
11895 PRODUCE_GLYPHS (it
);
11897 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11899 x
= it_before
.current_x
;
11900 while (i
< nglyphs
)
11902 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11904 if (x
+ glyph
->pixel_width
> max_x
)
11906 /* Glyph doesn't fit on line. Backtrack. */
11907 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11909 /* If this is the only glyph on this line, it will never fit on the
11910 tool-bar, so skip it. But ensure there is at least one glyph,
11911 so we don't accidentally disable the tool-bar. */
11912 if (n_glyphs_before
== 0
11913 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11919 x
+= glyph
->pixel_width
;
11923 /* Stop at line end. */
11924 if (ITERATOR_AT_END_OF_LINE_P (it
))
11927 set_iterator_to_next (it
, 1);
11932 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11934 /* Use default face for the border below the tool bar.
11936 FIXME: When auto-resize-tool-bars is grow-only, there is
11937 no additional border below the possibly empty tool-bar lines.
11938 So to make the extra empty lines look "normal", we have to
11939 use the tool-bar face for the border too. */
11940 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11941 it
->face_id
= DEFAULT_FACE_ID
;
11943 extend_face_to_end_of_line (it
);
11944 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11945 last
->right_box_line_p
= 1;
11946 if (last
== row
->glyphs
[TEXT_AREA
])
11947 last
->left_box_line_p
= 1;
11949 /* Make line the desired height and center it vertically. */
11950 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11952 /* Don't add more than one line height. */
11953 height
%= FRAME_LINE_HEIGHT (it
->f
);
11954 it
->max_ascent
+= height
/ 2;
11955 it
->max_descent
+= (height
+ 1) / 2;
11958 compute_line_metrics (it
);
11960 /* If line is empty, make it occupy the rest of the tool-bar. */
11961 if (!row
->displays_text_p
)
11963 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11964 row
->visible_height
= row
->height
;
11965 row
->ascent
= row
->phys_ascent
= 0;
11966 row
->extra_line_spacing
= 0;
11969 row
->full_width_p
= 1;
11970 row
->continued_p
= 0;
11971 row
->truncated_on_left_p
= 0;
11972 row
->truncated_on_right_p
= 0;
11974 it
->current_x
= it
->hpos
= 0;
11975 it
->current_y
+= row
->height
;
11981 /* Max tool-bar height. */
11983 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11984 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11986 /* Value is the number of screen lines needed to make all tool-bar
11987 items of frame F visible. The number of actual rows needed is
11988 returned in *N_ROWS if non-NULL. */
11991 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11993 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11995 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11996 the desired matrix, so use (unused) mode-line row as temporary row to
11997 avoid destroying the first tool-bar row. */
11998 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12000 /* Initialize an iterator for iteration over
12001 F->desired_tool_bar_string in the tool-bar window of frame F. */
12002 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12003 it
.first_visible_x
= 0;
12004 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
12005 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12006 it
.paragraph_embedding
= L2R
;
12008 while (!ITERATOR_AT_END_P (&it
))
12010 clear_glyph_row (temp_row
);
12011 it
.glyph_row
= temp_row
;
12012 display_tool_bar_line (&it
, -1);
12014 clear_glyph_row (temp_row
);
12016 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12018 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12020 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12024 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
12026 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12027 If FRAME is nil or omitted, use the selected frame. */)
12028 (Lisp_Object frame
)
12030 struct frame
*f
= decode_any_frame (frame
);
12034 if (WINDOWP (f
->tool_bar_window
)
12035 && (w
= XWINDOW (f
->tool_bar_window
),
12036 WINDOW_TOTAL_LINES (w
) > 0))
12038 update_tool_bar (f
, 1);
12039 if (f
->n_tool_bar_items
)
12041 build_desired_tool_bar_string (f
);
12042 nlines
= tool_bar_lines_needed (f
, NULL
);
12046 return make_number (nlines
);
12050 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12051 height should be changed. */
12054 redisplay_tool_bar (struct frame
*f
)
12058 struct glyph_row
*row
;
12060 #if defined (USE_GTK) || defined (HAVE_NS)
12061 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12062 update_frame_tool_bar (f
);
12066 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12067 do anything. This means you must start with tool-bar-lines
12068 non-zero to get the auto-sizing effect. Or in other words, you
12069 can turn off tool-bars by specifying tool-bar-lines zero. */
12070 if (!WINDOWP (f
->tool_bar_window
)
12071 || (w
= XWINDOW (f
->tool_bar_window
),
12072 WINDOW_TOTAL_LINES (w
) == 0))
12075 /* Set up an iterator for the tool-bar window. */
12076 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12077 it
.first_visible_x
= 0;
12078 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
12079 row
= it
.glyph_row
;
12081 /* Build a string that represents the contents of the tool-bar. */
12082 build_desired_tool_bar_string (f
);
12083 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12084 /* FIXME: This should be controlled by a user option. But it
12085 doesn't make sense to have an R2L tool bar if the menu bar cannot
12086 be drawn also R2L, and making the menu bar R2L is tricky due
12087 toolkit-specific code that implements it. If an R2L tool bar is
12088 ever supported, display_tool_bar_line should also be augmented to
12089 call unproduce_glyphs like display_line and display_string
12091 it
.paragraph_embedding
= L2R
;
12093 if (f
->n_tool_bar_rows
== 0)
12097 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
12098 nlines
!= WINDOW_TOTAL_LINES (w
)))
12101 int old_height
= WINDOW_TOTAL_LINES (w
);
12103 XSETFRAME (frame
, f
);
12104 Fmodify_frame_parameters (frame
,
12105 Fcons (Fcons (Qtool_bar_lines
,
12106 make_number (nlines
)),
12108 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12110 clear_glyph_matrix (w
->desired_matrix
);
12111 fonts_changed_p
= 1;
12117 /* Display as many lines as needed to display all tool-bar items. */
12119 if (f
->n_tool_bar_rows
> 0)
12121 int border
, rows
, height
, extra
;
12123 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12124 border
= XINT (Vtool_bar_border
);
12125 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12126 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12127 else if (EQ (Vtool_bar_border
, Qborder_width
))
12128 border
= f
->border_width
;
12134 rows
= f
->n_tool_bar_rows
;
12135 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12136 extra
= it
.last_visible_y
- border
- height
* rows
;
12138 while (it
.current_y
< it
.last_visible_y
)
12141 if (extra
> 0 && rows
-- > 0)
12143 h
= (extra
+ rows
- 1) / rows
;
12146 display_tool_bar_line (&it
, height
+ h
);
12151 while (it
.current_y
< it
.last_visible_y
)
12152 display_tool_bar_line (&it
, 0);
12155 /* It doesn't make much sense to try scrolling in the tool-bar
12156 window, so don't do it. */
12157 w
->desired_matrix
->no_scrolling_p
= 1;
12158 w
->must_be_updated_p
= 1;
12160 if (!NILP (Vauto_resize_tool_bars
))
12162 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12163 int change_height_p
= 0;
12165 /* If we couldn't display everything, change the tool-bar's
12166 height if there is room for more. */
12167 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12168 && it
.current_y
< max_tool_bar_height
)
12169 change_height_p
= 1;
12171 row
= it
.glyph_row
- 1;
12173 /* If there are blank lines at the end, except for a partially
12174 visible blank line at the end that is smaller than
12175 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12176 if (!row
->displays_text_p
12177 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12178 change_height_p
= 1;
12180 /* If row displays tool-bar items, but is partially visible,
12181 change the tool-bar's height. */
12182 if (row
->displays_text_p
12183 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12184 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12185 change_height_p
= 1;
12187 /* Resize windows as needed by changing the `tool-bar-lines'
12188 frame parameter. */
12189 if (change_height_p
)
12192 int old_height
= WINDOW_TOTAL_LINES (w
);
12194 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12196 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12197 && !f
->minimize_tool_bar_window_p
)
12198 ? (nlines
> old_height
)
12199 : (nlines
!= old_height
));
12200 f
->minimize_tool_bar_window_p
= 0;
12202 if (change_height_p
)
12204 XSETFRAME (frame
, f
);
12205 Fmodify_frame_parameters (frame
,
12206 Fcons (Fcons (Qtool_bar_lines
,
12207 make_number (nlines
)),
12209 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12211 clear_glyph_matrix (w
->desired_matrix
);
12212 f
->n_tool_bar_rows
= nrows
;
12213 fonts_changed_p
= 1;
12220 f
->minimize_tool_bar_window_p
= 0;
12225 /* Get information about the tool-bar item which is displayed in GLYPH
12226 on frame F. Return in *PROP_IDX the index where tool-bar item
12227 properties start in F->tool_bar_items. Value is zero if
12228 GLYPH doesn't display a tool-bar item. */
12231 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12237 /* This function can be called asynchronously, which means we must
12238 exclude any possibility that Fget_text_property signals an
12240 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12241 charpos
= max (0, charpos
);
12243 /* Get the text property `menu-item' at pos. The value of that
12244 property is the start index of this item's properties in
12245 F->tool_bar_items. */
12246 prop
= Fget_text_property (make_number (charpos
),
12247 Qmenu_item
, f
->current_tool_bar_string
);
12248 if (INTEGERP (prop
))
12250 *prop_idx
= XINT (prop
);
12260 /* Get information about the tool-bar item at position X/Y on frame F.
12261 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12262 the current matrix of the tool-bar window of F, or NULL if not
12263 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12264 item in F->tool_bar_items. Value is
12266 -1 if X/Y is not on a tool-bar item
12267 0 if X/Y is on the same item that was highlighted before.
12271 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12272 int *hpos
, int *vpos
, int *prop_idx
)
12274 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12275 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12278 /* Find the glyph under X/Y. */
12279 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12280 if (*glyph
== NULL
)
12283 /* Get the start of this tool-bar item's properties in
12284 f->tool_bar_items. */
12285 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12288 /* Is mouse on the highlighted item? */
12289 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12290 && *vpos
>= hlinfo
->mouse_face_beg_row
12291 && *vpos
<= hlinfo
->mouse_face_end_row
12292 && (*vpos
> hlinfo
->mouse_face_beg_row
12293 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12294 && (*vpos
< hlinfo
->mouse_face_end_row
12295 || *hpos
< hlinfo
->mouse_face_end_col
12296 || hlinfo
->mouse_face_past_end
))
12304 Handle mouse button event on the tool-bar of frame F, at
12305 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12306 0 for button release. MODIFIERS is event modifiers for button
12310 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12313 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12314 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12315 int hpos
, vpos
, prop_idx
;
12316 struct glyph
*glyph
;
12317 Lisp_Object enabled_p
;
12319 /* If not on the highlighted tool-bar item, return. */
12320 frame_to_window_pixel_xy (w
, &x
, &y
);
12321 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12324 /* If item is disabled, do nothing. */
12325 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12326 if (NILP (enabled_p
))
12331 /* Show item in pressed state. */
12332 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12333 last_tool_bar_item
= prop_idx
;
12337 Lisp_Object key
, frame
;
12338 struct input_event event
;
12339 EVENT_INIT (event
);
12341 /* Show item in released state. */
12342 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12344 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12346 XSETFRAME (frame
, f
);
12347 event
.kind
= TOOL_BAR_EVENT
;
12348 event
.frame_or_window
= frame
;
12350 kbd_buffer_store_event (&event
);
12352 event
.kind
= TOOL_BAR_EVENT
;
12353 event
.frame_or_window
= frame
;
12355 event
.modifiers
= modifiers
;
12356 kbd_buffer_store_event (&event
);
12357 last_tool_bar_item
= -1;
12362 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12363 tool-bar window-relative coordinates X/Y. Called from
12364 note_mouse_highlight. */
12367 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12369 Lisp_Object window
= f
->tool_bar_window
;
12370 struct window
*w
= XWINDOW (window
);
12371 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12372 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12374 struct glyph
*glyph
;
12375 struct glyph_row
*row
;
12377 Lisp_Object enabled_p
;
12379 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12380 int mouse_down_p
, rc
;
12382 /* Function note_mouse_highlight is called with negative X/Y
12383 values when mouse moves outside of the frame. */
12384 if (x
<= 0 || y
<= 0)
12386 clear_mouse_face (hlinfo
);
12390 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12393 /* Not on tool-bar item. */
12394 clear_mouse_face (hlinfo
);
12398 /* On same tool-bar item as before. */
12399 goto set_help_echo
;
12401 clear_mouse_face (hlinfo
);
12403 /* Mouse is down, but on different tool-bar item? */
12404 mouse_down_p
= (dpyinfo
->grabbed
12405 && f
== last_mouse_frame
12406 && FRAME_LIVE_P (f
));
12408 && last_tool_bar_item
!= prop_idx
)
12411 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12413 /* If tool-bar item is not enabled, don't highlight it. */
12414 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12415 if (!NILP (enabled_p
))
12417 /* Compute the x-position of the glyph. In front and past the
12418 image is a space. We include this in the highlighted area. */
12419 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12420 for (i
= x
= 0; i
< hpos
; ++i
)
12421 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12423 /* Record this as the current active region. */
12424 hlinfo
->mouse_face_beg_col
= hpos
;
12425 hlinfo
->mouse_face_beg_row
= vpos
;
12426 hlinfo
->mouse_face_beg_x
= x
;
12427 hlinfo
->mouse_face_beg_y
= row
->y
;
12428 hlinfo
->mouse_face_past_end
= 0;
12430 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12431 hlinfo
->mouse_face_end_row
= vpos
;
12432 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12433 hlinfo
->mouse_face_end_y
= row
->y
;
12434 hlinfo
->mouse_face_window
= window
;
12435 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12437 /* Display it as active. */
12438 show_mouse_face (hlinfo
, draw
);
12443 /* Set help_echo_string to a help string to display for this tool-bar item.
12444 XTread_socket does the rest. */
12445 help_echo_object
= help_echo_window
= Qnil
;
12446 help_echo_pos
= -1;
12447 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12448 if (NILP (help_echo_string
))
12449 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12452 #endif /* HAVE_WINDOW_SYSTEM */
12456 /************************************************************************
12457 Horizontal scrolling
12458 ************************************************************************/
12460 static int hscroll_window_tree (Lisp_Object
);
12461 static int hscroll_windows (Lisp_Object
);
12463 /* For all leaf windows in the window tree rooted at WINDOW, set their
12464 hscroll value so that PT is (i) visible in the window, and (ii) so
12465 that it is not within a certain margin at the window's left and
12466 right border. Value is non-zero if any window's hscroll has been
12470 hscroll_window_tree (Lisp_Object window
)
12472 int hscrolled_p
= 0;
12473 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12474 int hscroll_step_abs
= 0;
12475 double hscroll_step_rel
= 0;
12477 if (hscroll_relative_p
)
12479 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12480 if (hscroll_step_rel
< 0)
12482 hscroll_relative_p
= 0;
12483 hscroll_step_abs
= 0;
12486 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12488 hscroll_step_abs
= XINT (Vhscroll_step
);
12489 if (hscroll_step_abs
< 0)
12490 hscroll_step_abs
= 0;
12493 hscroll_step_abs
= 0;
12495 while (WINDOWP (window
))
12497 struct window
*w
= XWINDOW (window
);
12499 if (WINDOWP (w
->hchild
))
12500 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12501 else if (WINDOWP (w
->vchild
))
12502 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12503 else if (w
->cursor
.vpos
>= 0)
12506 int text_area_width
;
12507 struct glyph_row
*current_cursor_row
12508 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12509 struct glyph_row
*desired_cursor_row
12510 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12511 struct glyph_row
*cursor_row
12512 = (desired_cursor_row
->enabled_p
12513 ? desired_cursor_row
12514 : current_cursor_row
);
12515 int row_r2l_p
= cursor_row
->reversed_p
;
12517 text_area_width
= window_box_width (w
, TEXT_AREA
);
12519 /* Scroll when cursor is inside this scroll margin. */
12520 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12522 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12523 /* For left-to-right rows, hscroll when cursor is either
12524 (i) inside the right hscroll margin, or (ii) if it is
12525 inside the left margin and the window is already
12529 && w
->cursor
.x
<= h_margin
)
12530 || (cursor_row
->enabled_p
12531 && cursor_row
->truncated_on_right_p
12532 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12533 /* For right-to-left rows, the logic is similar,
12534 except that rules for scrolling to left and right
12535 are reversed. E.g., if cursor.x <= h_margin, we
12536 need to hscroll "to the right" unconditionally,
12537 and that will scroll the screen to the left so as
12538 to reveal the next portion of the row. */
12540 && ((cursor_row
->enabled_p
12541 /* FIXME: It is confusing to set the
12542 truncated_on_right_p flag when R2L rows
12543 are actually truncated on the left. */
12544 && cursor_row
->truncated_on_right_p
12545 && w
->cursor
.x
<= h_margin
)
12547 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12551 struct buffer
*saved_current_buffer
;
12555 /* Find point in a display of infinite width. */
12556 saved_current_buffer
= current_buffer
;
12557 current_buffer
= XBUFFER (w
->buffer
);
12559 if (w
== XWINDOW (selected_window
))
12562 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12564 /* Move iterator to pt starting at cursor_row->start in
12565 a line with infinite width. */
12566 init_to_row_start (&it
, w
, cursor_row
);
12567 it
.last_visible_x
= INFINITY
;
12568 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12569 current_buffer
= saved_current_buffer
;
12571 /* Position cursor in window. */
12572 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12573 hscroll
= max (0, (it
.current_x
12574 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12575 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12576 : (text_area_width
/ 2))))
12577 / FRAME_COLUMN_WIDTH (it
.f
);
12578 else if ((!row_r2l_p
12579 && w
->cursor
.x
>= text_area_width
- h_margin
)
12580 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12582 if (hscroll_relative_p
)
12583 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12586 wanted_x
= text_area_width
12587 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12590 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12594 if (hscroll_relative_p
)
12595 wanted_x
= text_area_width
* hscroll_step_rel
12598 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12601 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12603 hscroll
= max (hscroll
, w
->min_hscroll
);
12605 /* Don't prevent redisplay optimizations if hscroll
12606 hasn't changed, as it will unnecessarily slow down
12608 if (w
->hscroll
!= hscroll
)
12610 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12611 w
->hscroll
= hscroll
;
12620 /* Value is non-zero if hscroll of any leaf window has been changed. */
12621 return hscrolled_p
;
12625 /* Set hscroll so that cursor is visible and not inside horizontal
12626 scroll margins for all windows in the tree rooted at WINDOW. See
12627 also hscroll_window_tree above. Value is non-zero if any window's
12628 hscroll has been changed. If it has, desired matrices on the frame
12629 of WINDOW are cleared. */
12632 hscroll_windows (Lisp_Object window
)
12634 int hscrolled_p
= hscroll_window_tree (window
);
12636 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12637 return hscrolled_p
;
12642 /************************************************************************
12644 ************************************************************************/
12646 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12647 to a non-zero value. This is sometimes handy to have in a debugger
12652 /* First and last unchanged row for try_window_id. */
12654 static int debug_first_unchanged_at_end_vpos
;
12655 static int debug_last_unchanged_at_beg_vpos
;
12657 /* Delta vpos and y. */
12659 static int debug_dvpos
, debug_dy
;
12661 /* Delta in characters and bytes for try_window_id. */
12663 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12665 /* Values of window_end_pos and window_end_vpos at the end of
12668 static ptrdiff_t debug_end_vpos
;
12670 /* Append a string to W->desired_matrix->method. FMT is a printf
12671 format string. If trace_redisplay_p is non-zero also printf the
12672 resulting string to stderr. */
12674 static void debug_method_add (struct window
*, char const *, ...)
12675 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12678 debug_method_add (struct window
*w
, char const *fmt
, ...)
12680 char *method
= w
->desired_matrix
->method
;
12681 int len
= strlen (method
);
12682 int size
= sizeof w
->desired_matrix
->method
;
12683 int remaining
= size
- len
- 1;
12686 if (len
&& remaining
)
12689 --remaining
, ++len
;
12692 va_start (ap
, fmt
);
12693 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12696 if (trace_redisplay_p
)
12697 fprintf (stderr
, "%p (%s): %s\n",
12699 ((BUFFERP (w
->buffer
)
12700 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12701 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12706 #endif /* GLYPH_DEBUG */
12709 /* Value is non-zero if all changes in window W, which displays
12710 current_buffer, are in the text between START and END. START is a
12711 buffer position, END is given as a distance from Z. Used in
12712 redisplay_internal for display optimization. */
12715 text_outside_line_unchanged_p (struct window
*w
,
12716 ptrdiff_t start
, ptrdiff_t end
)
12718 int unchanged_p
= 1;
12720 /* If text or overlays have changed, see where. */
12721 if (window_outdated (w
))
12723 /* Gap in the line? */
12724 if (GPT
< start
|| Z
- GPT
< end
)
12727 /* Changes start in front of the line, or end after it? */
12729 && (BEG_UNCHANGED
< start
- 1
12730 || END_UNCHANGED
< end
))
12733 /* If selective display, can't optimize if changes start at the
12734 beginning of the line. */
12736 && INTEGERP (BVAR (current_buffer
, selective_display
))
12737 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12738 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12741 /* If there are overlays at the start or end of the line, these
12742 may have overlay strings with newlines in them. A change at
12743 START, for instance, may actually concern the display of such
12744 overlay strings as well, and they are displayed on different
12745 lines. So, quickly rule out this case. (For the future, it
12746 might be desirable to implement something more telling than
12747 just BEG/END_UNCHANGED.) */
12750 if (BEG
+ BEG_UNCHANGED
== start
12751 && overlay_touches_p (start
))
12753 if (END_UNCHANGED
== end
12754 && overlay_touches_p (Z
- end
))
12758 /* Under bidi reordering, adding or deleting a character in the
12759 beginning of a paragraph, before the first strong directional
12760 character, can change the base direction of the paragraph (unless
12761 the buffer specifies a fixed paragraph direction), which will
12762 require to redisplay the whole paragraph. It might be worthwhile
12763 to find the paragraph limits and widen the range of redisplayed
12764 lines to that, but for now just give up this optimization. */
12765 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12766 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12770 return unchanged_p
;
12774 /* Do a frame update, taking possible shortcuts into account. This is
12775 the main external entry point for redisplay.
12777 If the last redisplay displayed an echo area message and that message
12778 is no longer requested, we clear the echo area or bring back the
12779 mini-buffer if that is in use. */
12784 redisplay_internal ();
12789 overlay_arrow_string_or_property (Lisp_Object var
)
12793 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12796 return Voverlay_arrow_string
;
12799 /* Return 1 if there are any overlay-arrows in current_buffer. */
12801 overlay_arrow_in_current_buffer_p (void)
12805 for (vlist
= Voverlay_arrow_variable_list
;
12807 vlist
= XCDR (vlist
))
12809 Lisp_Object var
= XCAR (vlist
);
12812 if (!SYMBOLP (var
))
12814 val
= find_symbol_value (var
);
12816 && current_buffer
== XMARKER (val
)->buffer
)
12823 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12827 overlay_arrows_changed_p (void)
12831 for (vlist
= Voverlay_arrow_variable_list
;
12833 vlist
= XCDR (vlist
))
12835 Lisp_Object var
= XCAR (vlist
);
12836 Lisp_Object val
, pstr
;
12838 if (!SYMBOLP (var
))
12840 val
= find_symbol_value (var
);
12841 if (!MARKERP (val
))
12843 if (! EQ (COERCE_MARKER (val
),
12844 Fget (var
, Qlast_arrow_position
))
12845 || ! (pstr
= overlay_arrow_string_or_property (var
),
12846 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12852 /* Mark overlay arrows to be updated on next redisplay. */
12855 update_overlay_arrows (int up_to_date
)
12859 for (vlist
= Voverlay_arrow_variable_list
;
12861 vlist
= XCDR (vlist
))
12863 Lisp_Object var
= XCAR (vlist
);
12865 if (!SYMBOLP (var
))
12868 if (up_to_date
> 0)
12870 Lisp_Object val
= find_symbol_value (var
);
12871 Fput (var
, Qlast_arrow_position
,
12872 COERCE_MARKER (val
));
12873 Fput (var
, Qlast_arrow_string
,
12874 overlay_arrow_string_or_property (var
));
12876 else if (up_to_date
< 0
12877 || !NILP (Fget (var
, Qlast_arrow_position
)))
12879 Fput (var
, Qlast_arrow_position
, Qt
);
12880 Fput (var
, Qlast_arrow_string
, Qt
);
12886 /* Return overlay arrow string to display at row.
12887 Return integer (bitmap number) for arrow bitmap in left fringe.
12888 Return nil if no overlay arrow. */
12891 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12895 for (vlist
= Voverlay_arrow_variable_list
;
12897 vlist
= XCDR (vlist
))
12899 Lisp_Object var
= XCAR (vlist
);
12902 if (!SYMBOLP (var
))
12905 val
= find_symbol_value (var
);
12908 && current_buffer
== XMARKER (val
)->buffer
12909 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12911 if (FRAME_WINDOW_P (it
->f
)
12912 /* FIXME: if ROW->reversed_p is set, this should test
12913 the right fringe, not the left one. */
12914 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12916 #ifdef HAVE_WINDOW_SYSTEM
12917 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12920 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12921 return make_number (fringe_bitmap
);
12924 return make_number (-1); /* Use default arrow bitmap. */
12926 return overlay_arrow_string_or_property (var
);
12933 /* Return 1 if point moved out of or into a composition. Otherwise
12934 return 0. PREV_BUF and PREV_PT are the last point buffer and
12935 position. BUF and PT are the current point buffer and position. */
12938 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12939 struct buffer
*buf
, ptrdiff_t pt
)
12941 ptrdiff_t start
, end
;
12943 Lisp_Object buffer
;
12945 XSETBUFFER (buffer
, buf
);
12946 /* Check a composition at the last point if point moved within the
12948 if (prev_buf
== buf
)
12951 /* Point didn't move. */
12954 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12955 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12956 && COMPOSITION_VALID_P (start
, end
, prop
)
12957 && start
< prev_pt
&& end
> prev_pt
)
12958 /* The last point was within the composition. Return 1 iff
12959 point moved out of the composition. */
12960 return (pt
<= start
|| pt
>= end
);
12963 /* Check a composition at the current point. */
12964 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12965 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12966 && COMPOSITION_VALID_P (start
, end
, prop
)
12967 && start
< pt
&& end
> pt
);
12971 /* Reconsider the setting of B->clip_changed which is displayed
12975 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12977 if (b
->clip_changed
12978 && !NILP (w
->window_end_valid
)
12979 && w
->current_matrix
->buffer
== b
12980 && w
->current_matrix
->zv
== BUF_ZV (b
)
12981 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12982 b
->clip_changed
= 0;
12984 /* If display wasn't paused, and W is not a tool bar window, see if
12985 point has been moved into or out of a composition. In that case,
12986 we set b->clip_changed to 1 to force updating the screen. If
12987 b->clip_changed has already been set to 1, we can skip this
12989 if (!b
->clip_changed
12990 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12994 if (w
== XWINDOW (selected_window
))
12997 pt
= marker_position (w
->pointm
);
12999 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
13000 || pt
!= w
->last_point
)
13001 && check_point_in_composition (w
->current_matrix
->buffer
,
13003 XBUFFER (w
->buffer
), pt
))
13004 b
->clip_changed
= 1;
13009 #define STOP_POLLING \
13010 do { if (! polling_stopped_here) stop_polling (); \
13011 polling_stopped_here = 1; } while (0)
13013 #define RESUME_POLLING \
13014 do { if (polling_stopped_here) start_polling (); \
13015 polling_stopped_here = 0; } while (0)
13018 /* Perhaps in the future avoid recentering windows if it
13019 is not necessary; currently that causes some problems. */
13022 redisplay_internal (void)
13024 struct window
*w
= XWINDOW (selected_window
);
13028 int must_finish
= 0;
13029 struct text_pos tlbufpos
, tlendpos
;
13030 int number_of_visible_frames
;
13031 ptrdiff_t count
, count1
;
13033 int polling_stopped_here
= 0;
13034 Lisp_Object tail
, frame
;
13035 struct backtrace backtrace
;
13037 /* Non-zero means redisplay has to consider all windows on all
13038 frames. Zero means, only selected_window is considered. */
13039 int consider_all_windows_p
;
13041 /* Non-zero means redisplay has to redisplay the miniwindow. */
13042 int update_miniwindow_p
= 0;
13044 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13046 /* No redisplay if running in batch mode or frame is not yet fully
13047 initialized, or redisplay is explicitly turned off by setting
13048 Vinhibit_redisplay. */
13049 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13050 || !NILP (Vinhibit_redisplay
))
13053 /* Don't examine these until after testing Vinhibit_redisplay.
13054 When Emacs is shutting down, perhaps because its connection to
13055 X has dropped, we should not look at them at all. */
13056 fr
= XFRAME (w
->frame
);
13057 sf
= SELECTED_FRAME ();
13059 if (!fr
->glyphs_initialized_p
)
13062 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13063 if (popup_activated ())
13067 /* I don't think this happens but let's be paranoid. */
13068 if (redisplaying_p
)
13071 /* Record a function that clears redisplaying_p
13072 when we leave this function. */
13073 count
= SPECPDL_INDEX ();
13074 record_unwind_protect (unwind_redisplay
, selected_frame
);
13075 redisplaying_p
= 1;
13076 specbind (Qinhibit_free_realized_faces
, Qnil
);
13078 /* Record this function, so it appears on the profiler's backtraces. */
13079 backtrace
.next
= backtrace_list
;
13080 backtrace
.function
= Qredisplay_internal
;
13081 backtrace
.args
= &Qnil
;
13082 backtrace
.nargs
= 0;
13083 backtrace
.debug_on_exit
= 0;
13084 backtrace_list
= &backtrace
;
13086 FOR_EACH_FRAME (tail
, frame
)
13087 XFRAME (frame
)->already_hscrolled_p
= 0;
13090 /* Remember the currently selected window. */
13094 reconsider_clip_changes (w
, current_buffer
);
13095 last_escape_glyph_frame
= NULL
;
13096 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13097 last_glyphless_glyph_frame
= NULL
;
13098 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13100 /* If new fonts have been loaded that make a glyph matrix adjustment
13101 necessary, do it. */
13102 if (fonts_changed_p
)
13104 adjust_glyphs (NULL
);
13105 ++windows_or_buffers_changed
;
13106 fonts_changed_p
= 0;
13109 /* If face_change_count is non-zero, init_iterator will free all
13110 realized faces, which includes the faces referenced from current
13111 matrices. So, we can't reuse current matrices in this case. */
13112 if (face_change_count
)
13113 ++windows_or_buffers_changed
;
13115 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13116 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13118 /* Since frames on a single ASCII terminal share the same
13119 display area, displaying a different frame means redisplay
13120 the whole thing. */
13121 windows_or_buffers_changed
++;
13122 SET_FRAME_GARBAGED (sf
);
13124 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13126 FRAME_TTY (sf
)->previous_frame
= sf
;
13129 /* Set the visible flags for all frames. Do this before checking for
13130 resized or garbaged frames; they want to know if their frames are
13131 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13132 number_of_visible_frames
= 0;
13134 FOR_EACH_FRAME (tail
, frame
)
13136 struct frame
*f
= XFRAME (frame
);
13138 FRAME_SAMPLE_VISIBILITY (f
);
13139 if (FRAME_VISIBLE_P (f
))
13140 ++number_of_visible_frames
;
13141 clear_desired_matrices (f
);
13144 /* Notice any pending interrupt request to change frame size. */
13145 do_pending_window_change (1);
13147 /* do_pending_window_change could change the selected_window due to
13148 frame resizing which makes the selected window too small. */
13149 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13152 reconsider_clip_changes (w
, current_buffer
);
13155 /* Clear frames marked as garbaged. */
13156 clear_garbaged_frames ();
13158 /* Build menubar and tool-bar items. */
13159 if (NILP (Vmemory_full
))
13160 prepare_menu_bars ();
13162 if (windows_or_buffers_changed
)
13163 update_mode_lines
++;
13165 /* Detect case that we need to write or remove a star in the mode line. */
13166 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13168 w
->update_mode_line
= 1;
13169 if (buffer_shared_and_changed ())
13170 update_mode_lines
++;
13173 /* Avoid invocation of point motion hooks by `current_column' below. */
13174 count1
= SPECPDL_INDEX ();
13175 specbind (Qinhibit_point_motion_hooks
, Qt
);
13177 if (mode_line_update_needed (w
))
13178 w
->update_mode_line
= 1;
13180 unbind_to (count1
, Qnil
);
13182 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13184 consider_all_windows_p
= (update_mode_lines
13185 || buffer_shared_and_changed ()
13186 || cursor_type_changed
);
13188 /* If specs for an arrow have changed, do thorough redisplay
13189 to ensure we remove any arrow that should no longer exist. */
13190 if (overlay_arrows_changed_p ())
13191 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13193 /* Normally the message* functions will have already displayed and
13194 updated the echo area, but the frame may have been trashed, or
13195 the update may have been preempted, so display the echo area
13196 again here. Checking message_cleared_p captures the case that
13197 the echo area should be cleared. */
13198 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13199 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13200 || (message_cleared_p
13201 && minibuf_level
== 0
13202 /* If the mini-window is currently selected, this means the
13203 echo-area doesn't show through. */
13204 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13206 int window_height_changed_p
= echo_area_display (0);
13208 if (message_cleared_p
)
13209 update_miniwindow_p
= 1;
13213 /* If we don't display the current message, don't clear the
13214 message_cleared_p flag, because, if we did, we wouldn't clear
13215 the echo area in the next redisplay which doesn't preserve
13217 if (!display_last_displayed_message_p
)
13218 message_cleared_p
= 0;
13220 if (fonts_changed_p
)
13222 else if (window_height_changed_p
)
13224 consider_all_windows_p
= 1;
13225 ++update_mode_lines
;
13226 ++windows_or_buffers_changed
;
13228 /* If window configuration was changed, frames may have been
13229 marked garbaged. Clear them or we will experience
13230 surprises wrt scrolling. */
13231 clear_garbaged_frames ();
13234 else if (EQ (selected_window
, minibuf_window
)
13235 && (current_buffer
->clip_changed
|| window_outdated (w
))
13236 && resize_mini_window (w
, 0))
13238 /* Resized active mini-window to fit the size of what it is
13239 showing if its contents might have changed. */
13241 /* FIXME: this causes all frames to be updated, which seems unnecessary
13242 since only the current frame needs to be considered. This function
13243 needs to be rewritten with two variables, consider_all_windows and
13244 consider_all_frames. */
13245 consider_all_windows_p
= 1;
13246 ++windows_or_buffers_changed
;
13247 ++update_mode_lines
;
13249 /* If window configuration was changed, frames may have been
13250 marked garbaged. Clear them or we will experience
13251 surprises wrt scrolling. */
13252 clear_garbaged_frames ();
13256 /* If showing the region, and mark has changed, we must redisplay
13257 the whole window. The assignment to this_line_start_pos prevents
13258 the optimization directly below this if-statement. */
13259 if (((!NILP (Vtransient_mark_mode
)
13260 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13261 != !NILP (w
->region_showing
))
13262 || (!NILP (w
->region_showing
)
13263 && !EQ (w
->region_showing
,
13264 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13265 CHARPOS (this_line_start_pos
) = 0;
13267 /* Optimize the case that only the line containing the cursor in the
13268 selected window has changed. Variables starting with this_ are
13269 set in display_line and record information about the line
13270 containing the cursor. */
13271 tlbufpos
= this_line_start_pos
;
13272 tlendpos
= this_line_end_pos
;
13273 if (!consider_all_windows_p
13274 && CHARPOS (tlbufpos
) > 0
13275 && !w
->update_mode_line
13276 && !current_buffer
->clip_changed
13277 && !current_buffer
->prevent_redisplay_optimizations_p
13278 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13279 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13280 /* Make sure recorded data applies to current buffer, etc. */
13281 && this_line_buffer
== current_buffer
13282 && current_buffer
== XBUFFER (w
->buffer
)
13284 && !w
->optional_new_start
13285 /* Point must be on the line that we have info recorded about. */
13286 && PT
>= CHARPOS (tlbufpos
)
13287 && PT
<= Z
- CHARPOS (tlendpos
)
13288 /* All text outside that line, including its final newline,
13289 must be unchanged. */
13290 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13291 CHARPOS (tlendpos
)))
13293 if (CHARPOS (tlbufpos
) > BEGV
13294 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13295 && (CHARPOS (tlbufpos
) == ZV
13296 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13297 /* Former continuation line has disappeared by becoming empty. */
13299 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13301 /* We have to handle the case of continuation around a
13302 wide-column character (see the comment in indent.c around
13305 For instance, in the following case:
13307 -------- Insert --------
13308 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13309 J_I_ ==> J_I_ `^^' are cursors.
13313 As we have to redraw the line above, we cannot use this
13317 int line_height_before
= this_line_pixel_height
;
13319 /* Note that start_display will handle the case that the
13320 line starting at tlbufpos is a continuation line. */
13321 start_display (&it
, w
, tlbufpos
);
13323 /* Implementation note: It this still necessary? */
13324 if (it
.current_x
!= this_line_start_x
)
13327 TRACE ((stderr
, "trying display optimization 1\n"));
13328 w
->cursor
.vpos
= -1;
13329 overlay_arrow_seen
= 0;
13330 it
.vpos
= this_line_vpos
;
13331 it
.current_y
= this_line_y
;
13332 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13333 display_line (&it
);
13335 /* If line contains point, is not continued,
13336 and ends at same distance from eob as before, we win. */
13337 if (w
->cursor
.vpos
>= 0
13338 /* Line is not continued, otherwise this_line_start_pos
13339 would have been set to 0 in display_line. */
13340 && CHARPOS (this_line_start_pos
)
13341 /* Line ends as before. */
13342 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13343 /* Line has same height as before. Otherwise other lines
13344 would have to be shifted up or down. */
13345 && this_line_pixel_height
== line_height_before
)
13347 /* If this is not the window's last line, we must adjust
13348 the charstarts of the lines below. */
13349 if (it
.current_y
< it
.last_visible_y
)
13351 struct glyph_row
*row
13352 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13353 ptrdiff_t delta
, delta_bytes
;
13355 /* We used to distinguish between two cases here,
13356 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13357 when the line ends in a newline or the end of the
13358 buffer's accessible portion. But both cases did
13359 the same, so they were collapsed. */
13361 - CHARPOS (tlendpos
)
13362 - MATRIX_ROW_START_CHARPOS (row
));
13363 delta_bytes
= (Z_BYTE
13364 - BYTEPOS (tlendpos
)
13365 - MATRIX_ROW_START_BYTEPOS (row
));
13367 increment_matrix_positions (w
->current_matrix
,
13368 this_line_vpos
+ 1,
13369 w
->current_matrix
->nrows
,
13370 delta
, delta_bytes
);
13373 /* If this row displays text now but previously didn't,
13374 or vice versa, w->window_end_vpos may have to be
13376 if ((it
.glyph_row
- 1)->displays_text_p
)
13378 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13379 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13381 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13382 && this_line_vpos
> 0)
13383 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13384 wset_window_end_valid (w
, Qnil
);
13386 /* Update hint: No need to try to scroll in update_window. */
13387 w
->desired_matrix
->no_scrolling_p
= 1;
13390 *w
->desired_matrix
->method
= 0;
13391 debug_method_add (w
, "optimization 1");
13394 //debug optimization movement issue
13395 //w->desired_matrix->no_scrolling_p = 1;
13396 //*w->desired_matrix->method = 0;
13397 //debug_method_add (w, "optimization 1");
13400 #ifdef HAVE_WINDOW_SYSTEM
13401 update_window_fringes (w
, 0);
13408 else if (/* Cursor position hasn't changed. */
13409 PT
== w
->last_point
13410 /* Make sure the cursor was last displayed
13411 in this window. Otherwise we have to reposition it. */
13412 && 0 <= w
->cursor
.vpos
13413 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13417 do_pending_window_change (1);
13418 /* If selected_window changed, redisplay again. */
13419 if (WINDOWP (selected_window
)
13420 && (w
= XWINDOW (selected_window
)) != sw
)
13423 /* We used to always goto end_of_redisplay here, but this
13424 isn't enough if we have a blinking cursor. */
13425 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13426 goto end_of_redisplay
;
13430 /* If highlighting the region, or if the cursor is in the echo area,
13431 then we can't just move the cursor. */
13432 else if (! (!NILP (Vtransient_mark_mode
)
13433 && !NILP (BVAR (current_buffer
, mark_active
)))
13434 && (EQ (selected_window
,
13435 BVAR (current_buffer
, last_selected_window
))
13436 || highlight_nonselected_windows
)
13437 && NILP (w
->region_showing
)
13438 && NILP (Vshow_trailing_whitespace
)
13439 && !cursor_in_echo_area
)
13442 struct glyph_row
*row
;
13444 /* Skip from tlbufpos to PT and see where it is. Note that
13445 PT may be in invisible text. If so, we will end at the
13446 next visible position. */
13447 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13448 NULL
, DEFAULT_FACE_ID
);
13449 it
.current_x
= this_line_start_x
;
13450 it
.current_y
= this_line_y
;
13451 it
.vpos
= this_line_vpos
;
13453 /* The call to move_it_to stops in front of PT, but
13454 moves over before-strings. */
13455 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13457 if (it
.vpos
== this_line_vpos
13458 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13461 eassert (this_line_vpos
== it
.vpos
);
13462 eassert (this_line_y
== it
.current_y
);
13463 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13465 *w
->desired_matrix
->method
= 0;
13466 debug_method_add (w
, "optimization 3");
13475 /* Text changed drastically or point moved off of line. */
13476 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13479 CHARPOS (this_line_start_pos
) = 0;
13480 consider_all_windows_p
|= buffer_shared_and_changed ();
13481 ++clear_face_cache_count
;
13482 #ifdef HAVE_WINDOW_SYSTEM
13483 ++clear_image_cache_count
;
13486 /* Build desired matrices, and update the display. If
13487 consider_all_windows_p is non-zero, do it for all windows on all
13488 frames. Otherwise do it for selected_window, only. */
13490 if (consider_all_windows_p
)
13492 FOR_EACH_FRAME (tail
, frame
)
13493 XFRAME (frame
)->updated_p
= 0;
13495 FOR_EACH_FRAME (tail
, frame
)
13497 struct frame
*f
= XFRAME (frame
);
13499 /* We don't have to do anything for unselected terminal
13501 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13502 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13505 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13507 /* Mark all the scroll bars to be removed; we'll redeem
13508 the ones we want when we redisplay their windows. */
13509 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13510 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13512 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13513 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13515 /* The X error handler may have deleted that frame. */
13516 if (!FRAME_LIVE_P (f
))
13519 /* Any scroll bars which redisplay_windows should have
13520 nuked should now go away. */
13521 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13522 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13524 /* If fonts changed, display again. */
13525 /* ??? rms: I suspect it is a mistake to jump all the way
13526 back to retry here. It should just retry this frame. */
13527 if (fonts_changed_p
)
13530 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13532 /* See if we have to hscroll. */
13533 if (!f
->already_hscrolled_p
)
13535 f
->already_hscrolled_p
= 1;
13536 if (hscroll_windows (f
->root_window
))
13540 /* Prevent various kinds of signals during display
13541 update. stdio is not robust about handling
13542 signals, which can cause an apparent I/O
13544 if (interrupt_input
)
13545 unrequest_sigio ();
13548 /* Update the display. */
13549 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13550 pending
|= update_frame (f
, 0, 0);
13556 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13560 /* Do the mark_window_display_accurate after all windows have
13561 been redisplayed because this call resets flags in buffers
13562 which are needed for proper redisplay. */
13563 FOR_EACH_FRAME (tail
, frame
)
13565 struct frame
*f
= XFRAME (frame
);
13568 mark_window_display_accurate (f
->root_window
, 1);
13569 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13570 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13575 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13577 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13578 struct frame
*mini_frame
;
13580 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13581 /* Use list_of_error, not Qerror, so that
13582 we catch only errors and don't run the debugger. */
13583 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13585 redisplay_window_error
);
13586 if (update_miniwindow_p
)
13587 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13589 redisplay_window_error
);
13591 /* Compare desired and current matrices, perform output. */
13594 /* If fonts changed, display again. */
13595 if (fonts_changed_p
)
13598 /* Prevent various kinds of signals during display update.
13599 stdio is not robust about handling signals,
13600 which can cause an apparent I/O error. */
13601 if (interrupt_input
)
13602 unrequest_sigio ();
13605 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13607 if (hscroll_windows (selected_window
))
13610 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13611 pending
= update_frame (sf
, 0, 0);
13614 /* We may have called echo_area_display at the top of this
13615 function. If the echo area is on another frame, that may
13616 have put text on a frame other than the selected one, so the
13617 above call to update_frame would not have caught it. Catch
13619 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13620 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13622 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13624 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13625 pending
|= update_frame (mini_frame
, 0, 0);
13626 if (!pending
&& hscroll_windows (mini_window
))
13631 /* If display was paused because of pending input, make sure we do a
13632 thorough update the next time. */
13635 /* Prevent the optimization at the beginning of
13636 redisplay_internal that tries a single-line update of the
13637 line containing the cursor in the selected window. */
13638 CHARPOS (this_line_start_pos
) = 0;
13640 /* Let the overlay arrow be updated the next time. */
13641 update_overlay_arrows (0);
13643 /* If we pause after scrolling, some rows in the current
13644 matrices of some windows are not valid. */
13645 if (!WINDOW_FULL_WIDTH_P (w
)
13646 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13647 update_mode_lines
= 1;
13651 if (!consider_all_windows_p
)
13653 /* This has already been done above if
13654 consider_all_windows_p is set. */
13655 mark_window_display_accurate_1 (w
, 1);
13657 /* Say overlay arrows are up to date. */
13658 update_overlay_arrows (1);
13660 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13661 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13664 update_mode_lines
= 0;
13665 windows_or_buffers_changed
= 0;
13666 cursor_type_changed
= 0;
13669 /* Start SIGIO interrupts coming again. Having them off during the
13670 code above makes it less likely one will discard output, but not
13671 impossible, since there might be stuff in the system buffer here.
13672 But it is much hairier to try to do anything about that. */
13673 if (interrupt_input
)
13677 /* If a frame has become visible which was not before, redisplay
13678 again, so that we display it. Expose events for such a frame
13679 (which it gets when becoming visible) don't call the parts of
13680 redisplay constructing glyphs, so simply exposing a frame won't
13681 display anything in this case. So, we have to display these
13682 frames here explicitly. */
13687 FOR_EACH_FRAME (tail
, frame
)
13689 int this_is_visible
= 0;
13691 if (XFRAME (frame
)->visible
)
13692 this_is_visible
= 1;
13693 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13694 if (XFRAME (frame
)->visible
)
13695 this_is_visible
= 1;
13697 if (this_is_visible
)
13701 if (new_count
!= number_of_visible_frames
)
13702 windows_or_buffers_changed
++;
13705 /* Change frame size now if a change is pending. */
13706 do_pending_window_change (1);
13708 /* If we just did a pending size change, or have additional
13709 visible frames, or selected_window changed, redisplay again. */
13710 if ((windows_or_buffers_changed
&& !pending
)
13711 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13714 /* Clear the face and image caches.
13716 We used to do this only if consider_all_windows_p. But the cache
13717 needs to be cleared if a timer creates images in the current
13718 buffer (e.g. the test case in Bug#6230). */
13720 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13722 clear_face_cache (0);
13723 clear_face_cache_count
= 0;
13726 #ifdef HAVE_WINDOW_SYSTEM
13727 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13729 clear_image_caches (Qnil
);
13730 clear_image_cache_count
= 0;
13732 #endif /* HAVE_WINDOW_SYSTEM */
13735 backtrace_list
= backtrace
.next
;
13736 unbind_to (count
, Qnil
);
13741 /* Redisplay, but leave alone any recent echo area message unless
13742 another message has been requested in its place.
13744 This is useful in situations where you need to redisplay but no
13745 user action has occurred, making it inappropriate for the message
13746 area to be cleared. See tracking_off and
13747 wait_reading_process_output for examples of these situations.
13749 FROM_WHERE is an integer saying from where this function was
13750 called. This is useful for debugging. */
13753 redisplay_preserve_echo_area (int from_where
)
13755 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13757 if (!NILP (echo_area_buffer
[1]))
13759 /* We have a previously displayed message, but no current
13760 message. Redisplay the previous message. */
13761 display_last_displayed_message_p
= 1;
13762 redisplay_internal ();
13763 display_last_displayed_message_p
= 0;
13766 redisplay_internal ();
13768 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13769 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13770 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13774 /* Function registered with record_unwind_protect in redisplay_internal.
13775 Clear redisplaying_p. Also select the previously selected frame. */
13778 unwind_redisplay (Lisp_Object old_frame
)
13780 redisplaying_p
= 0;
13785 /* Mark the display of window W as accurate or inaccurate. If
13786 ACCURATE_P is non-zero mark display of W as accurate. If
13787 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13788 redisplay_internal is called. */
13791 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13793 if (BUFFERP (w
->buffer
))
13795 struct buffer
*b
= XBUFFER (w
->buffer
);
13797 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13798 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13800 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13804 b
->clip_changed
= 0;
13805 b
->prevent_redisplay_optimizations_p
= 0;
13807 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13808 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13809 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13810 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13812 w
->current_matrix
->buffer
= b
;
13813 w
->current_matrix
->begv
= BUF_BEGV (b
);
13814 w
->current_matrix
->zv
= BUF_ZV (b
);
13816 w
->last_cursor
= w
->cursor
;
13817 w
->last_cursor_off_p
= w
->cursor_off_p
;
13819 if (w
== XWINDOW (selected_window
))
13820 w
->last_point
= BUF_PT (b
);
13822 w
->last_point
= marker_position (w
->pointm
);
13828 wset_window_end_valid (w
, w
->buffer
);
13829 w
->update_mode_line
= 0;
13834 /* Mark the display of windows in the window tree rooted at WINDOW as
13835 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13836 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13837 be redisplayed the next time redisplay_internal is called. */
13840 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13844 for (; !NILP (window
); window
= w
->next
)
13846 w
= XWINDOW (window
);
13847 mark_window_display_accurate_1 (w
, accurate_p
);
13849 if (!NILP (w
->vchild
))
13850 mark_window_display_accurate (w
->vchild
, accurate_p
);
13851 if (!NILP (w
->hchild
))
13852 mark_window_display_accurate (w
->hchild
, accurate_p
);
13857 update_overlay_arrows (1);
13861 /* Force a thorough redisplay the next time by setting
13862 last_arrow_position and last_arrow_string to t, which is
13863 unequal to any useful value of Voverlay_arrow_... */
13864 update_overlay_arrows (-1);
13869 /* Return value in display table DP (Lisp_Char_Table *) for character
13870 C. Since a display table doesn't have any parent, we don't have to
13871 follow parent. Do not call this function directly but use the
13872 macro DISP_CHAR_VECTOR. */
13875 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13879 if (ASCII_CHAR_P (c
))
13882 if (SUB_CHAR_TABLE_P (val
))
13883 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13889 XSETCHAR_TABLE (table
, dp
);
13890 val
= char_table_ref (table
, c
);
13899 /***********************************************************************
13901 ***********************************************************************/
13903 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13906 redisplay_windows (Lisp_Object window
)
13908 while (!NILP (window
))
13910 struct window
*w
= XWINDOW (window
);
13912 if (!NILP (w
->hchild
))
13913 redisplay_windows (w
->hchild
);
13914 else if (!NILP (w
->vchild
))
13915 redisplay_windows (w
->vchild
);
13916 else if (!NILP (w
->buffer
))
13918 displayed_buffer
= XBUFFER (w
->buffer
);
13919 /* Use list_of_error, not Qerror, so that
13920 we catch only errors and don't run the debugger. */
13921 internal_condition_case_1 (redisplay_window_0
, window
,
13923 redisplay_window_error
);
13931 redisplay_window_error (Lisp_Object ignore
)
13933 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13938 redisplay_window_0 (Lisp_Object window
)
13940 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13941 redisplay_window (window
, 0);
13946 redisplay_window_1 (Lisp_Object window
)
13948 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13949 redisplay_window (window
, 1);
13954 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13955 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13956 which positions recorded in ROW differ from current buffer
13959 Return 0 if cursor is not on this row, 1 otherwise. */
13962 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13963 struct glyph_matrix
*matrix
,
13964 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13967 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13968 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13969 struct glyph
*cursor
= NULL
;
13970 /* The last known character position in row. */
13971 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13973 ptrdiff_t pt_old
= PT
- delta
;
13974 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13975 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13976 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13977 /* A glyph beyond the edge of TEXT_AREA which we should never
13979 struct glyph
*glyphs_end
= end
;
13980 /* Non-zero means we've found a match for cursor position, but that
13981 glyph has the avoid_cursor_p flag set. */
13982 int match_with_avoid_cursor
= 0;
13983 /* Non-zero means we've seen at least one glyph that came from a
13985 int string_seen
= 0;
13986 /* Largest and smallest buffer positions seen so far during scan of
13988 ptrdiff_t bpos_max
= pos_before
;
13989 ptrdiff_t bpos_min
= pos_after
;
13990 /* Last buffer position covered by an overlay string with an integer
13991 `cursor' property. */
13992 ptrdiff_t bpos_covered
= 0;
13993 /* Non-zero means the display string on which to display the cursor
13994 comes from a text property, not from an overlay. */
13995 int string_from_text_prop
= 0;
13997 /* Don't even try doing anything if called for a mode-line or
13998 header-line row, since the rest of the code isn't prepared to
13999 deal with such calamities. */
14000 eassert (!row
->mode_line_p
);
14001 if (row
->mode_line_p
)
14004 /* Skip over glyphs not having an object at the start and the end of
14005 the row. These are special glyphs like truncation marks on
14006 terminal frames. */
14007 if (row
->displays_text_p
)
14009 if (!row
->reversed_p
)
14012 && INTEGERP (glyph
->object
)
14013 && glyph
->charpos
< 0)
14015 x
+= glyph
->pixel_width
;
14019 && INTEGERP ((end
- 1)->object
)
14020 /* CHARPOS is zero for blanks and stretch glyphs
14021 inserted by extend_face_to_end_of_line. */
14022 && (end
- 1)->charpos
<= 0)
14024 glyph_before
= glyph
- 1;
14031 /* If the glyph row is reversed, we need to process it from back
14032 to front, so swap the edge pointers. */
14033 glyphs_end
= end
= glyph
- 1;
14034 glyph
+= row
->used
[TEXT_AREA
] - 1;
14036 while (glyph
> end
+ 1
14037 && INTEGERP (glyph
->object
)
14038 && glyph
->charpos
< 0)
14041 x
-= glyph
->pixel_width
;
14043 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14045 /* By default, in reversed rows we put the cursor on the
14046 rightmost (first in the reading order) glyph. */
14047 for (g
= end
+ 1; g
< glyph
; g
++)
14048 x
+= g
->pixel_width
;
14050 && INTEGERP ((end
+ 1)->object
)
14051 && (end
+ 1)->charpos
<= 0)
14053 glyph_before
= glyph
+ 1;
14057 else if (row
->reversed_p
)
14059 /* In R2L rows that don't display text, put the cursor on the
14060 rightmost glyph. Case in point: an empty last line that is
14061 part of an R2L paragraph. */
14063 /* Avoid placing the cursor on the last glyph of the row, where
14064 on terminal frames we hold the vertical border between
14065 adjacent windows. */
14066 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14067 && !WINDOW_RIGHTMOST_P (w
)
14068 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14070 x
= -1; /* will be computed below, at label compute_x */
14073 /* Step 1: Try to find the glyph whose character position
14074 corresponds to point. If that's not possible, find 2 glyphs
14075 whose character positions are the closest to point, one before
14076 point, the other after it. */
14077 if (!row
->reversed_p
)
14078 while (/* not marched to end of glyph row */
14080 /* glyph was not inserted by redisplay for internal purposes */
14081 && !INTEGERP (glyph
->object
))
14083 if (BUFFERP (glyph
->object
))
14085 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14087 if (glyph
->charpos
> bpos_max
)
14088 bpos_max
= glyph
->charpos
;
14089 if (glyph
->charpos
< bpos_min
)
14090 bpos_min
= glyph
->charpos
;
14091 if (!glyph
->avoid_cursor_p
)
14093 /* If we hit point, we've found the glyph on which to
14094 display the cursor. */
14097 match_with_avoid_cursor
= 0;
14100 /* See if we've found a better approximation to
14101 POS_BEFORE or to POS_AFTER. */
14102 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14104 pos_before
= glyph
->charpos
;
14105 glyph_before
= glyph
;
14107 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14109 pos_after
= glyph
->charpos
;
14110 glyph_after
= glyph
;
14113 else if (dpos
== 0)
14114 match_with_avoid_cursor
= 1;
14116 else if (STRINGP (glyph
->object
))
14118 Lisp_Object chprop
;
14119 ptrdiff_t glyph_pos
= glyph
->charpos
;
14121 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14123 if (!NILP (chprop
))
14125 /* If the string came from a `display' text property,
14126 look up the buffer position of that property and
14127 use that position to update bpos_max, as if we
14128 actually saw such a position in one of the row's
14129 glyphs. This helps with supporting integer values
14130 of `cursor' property on the display string in
14131 situations where most or all of the row's buffer
14132 text is completely covered by display properties,
14133 so that no glyph with valid buffer positions is
14134 ever seen in the row. */
14135 ptrdiff_t prop_pos
=
14136 string_buffer_position_lim (glyph
->object
, pos_before
,
14139 if (prop_pos
>= pos_before
)
14140 bpos_max
= prop_pos
- 1;
14142 if (INTEGERP (chprop
))
14144 bpos_covered
= bpos_max
+ XINT (chprop
);
14145 /* If the `cursor' property covers buffer positions up
14146 to and including point, we should display cursor on
14147 this glyph. Note that, if a `cursor' property on one
14148 of the string's characters has an integer value, we
14149 will break out of the loop below _before_ we get to
14150 the position match above. IOW, integer values of
14151 the `cursor' property override the "exact match for
14152 point" strategy of positioning the cursor. */
14153 /* Implementation note: bpos_max == pt_old when, e.g.,
14154 we are in an empty line, where bpos_max is set to
14155 MATRIX_ROW_START_CHARPOS, see above. */
14156 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14165 x
+= glyph
->pixel_width
;
14168 else if (glyph
> end
) /* row is reversed */
14169 while (!INTEGERP (glyph
->object
))
14171 if (BUFFERP (glyph
->object
))
14173 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14175 if (glyph
->charpos
> bpos_max
)
14176 bpos_max
= glyph
->charpos
;
14177 if (glyph
->charpos
< bpos_min
)
14178 bpos_min
= glyph
->charpos
;
14179 if (!glyph
->avoid_cursor_p
)
14183 match_with_avoid_cursor
= 0;
14186 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14188 pos_before
= glyph
->charpos
;
14189 glyph_before
= glyph
;
14191 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14193 pos_after
= glyph
->charpos
;
14194 glyph_after
= glyph
;
14197 else if (dpos
== 0)
14198 match_with_avoid_cursor
= 1;
14200 else if (STRINGP (glyph
->object
))
14202 Lisp_Object chprop
;
14203 ptrdiff_t glyph_pos
= glyph
->charpos
;
14205 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14207 if (!NILP (chprop
))
14209 ptrdiff_t prop_pos
=
14210 string_buffer_position_lim (glyph
->object
, pos_before
,
14213 if (prop_pos
>= pos_before
)
14214 bpos_max
= prop_pos
- 1;
14216 if (INTEGERP (chprop
))
14218 bpos_covered
= bpos_max
+ XINT (chprop
);
14219 /* If the `cursor' property covers buffer positions up
14220 to and including point, we should display cursor on
14222 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14231 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14233 x
--; /* can't use any pixel_width */
14236 x
-= glyph
->pixel_width
;
14239 /* Step 2: If we didn't find an exact match for point, we need to
14240 look for a proper place to put the cursor among glyphs between
14241 GLYPH_BEFORE and GLYPH_AFTER. */
14242 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14243 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14244 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14246 /* An empty line has a single glyph whose OBJECT is zero and
14247 whose CHARPOS is the position of a newline on that line.
14248 Note that on a TTY, there are more glyphs after that, which
14249 were produced by extend_face_to_end_of_line, but their
14250 CHARPOS is zero or negative. */
14252 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14253 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14255 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14257 ptrdiff_t ellipsis_pos
;
14259 /* Scan back over the ellipsis glyphs. */
14260 if (!row
->reversed_p
)
14262 ellipsis_pos
= (glyph
- 1)->charpos
;
14263 while (glyph
> row
->glyphs
[TEXT_AREA
]
14264 && (glyph
- 1)->charpos
== ellipsis_pos
)
14265 glyph
--, x
-= glyph
->pixel_width
;
14266 /* That loop always goes one position too far, including
14267 the glyph before the ellipsis. So scan forward over
14269 x
+= glyph
->pixel_width
;
14272 else /* row is reversed */
14274 ellipsis_pos
= (glyph
+ 1)->charpos
;
14275 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14276 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14277 glyph
++, x
+= glyph
->pixel_width
;
14278 x
-= glyph
->pixel_width
;
14282 else if (match_with_avoid_cursor
)
14284 cursor
= glyph_after
;
14287 else if (string_seen
)
14289 int incr
= row
->reversed_p
? -1 : +1;
14291 /* Need to find the glyph that came out of a string which is
14292 present at point. That glyph is somewhere between
14293 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14294 positioned between POS_BEFORE and POS_AFTER in the
14296 struct glyph
*start
, *stop
;
14297 ptrdiff_t pos
= pos_before
;
14301 /* If the row ends in a newline from a display string,
14302 reordering could have moved the glyphs belonging to the
14303 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14304 in this case we extend the search to the last glyph in
14305 the row that was not inserted by redisplay. */
14306 if (row
->ends_in_newline_from_string_p
)
14309 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14312 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14313 correspond to POS_BEFORE and POS_AFTER, respectively. We
14314 need START and STOP in the order that corresponds to the
14315 row's direction as given by its reversed_p flag. If the
14316 directionality of characters between POS_BEFORE and
14317 POS_AFTER is the opposite of the row's base direction,
14318 these characters will have been reordered for display,
14319 and we need to reverse START and STOP. */
14320 if (!row
->reversed_p
)
14322 start
= min (glyph_before
, glyph_after
);
14323 stop
= max (glyph_before
, glyph_after
);
14327 start
= max (glyph_before
, glyph_after
);
14328 stop
= min (glyph_before
, glyph_after
);
14330 for (glyph
= start
+ incr
;
14331 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14334 /* Any glyphs that come from the buffer are here because
14335 of bidi reordering. Skip them, and only pay
14336 attention to glyphs that came from some string. */
14337 if (STRINGP (glyph
->object
))
14341 /* If the display property covers the newline, we
14342 need to search for it one position farther. */
14343 ptrdiff_t lim
= pos_after
14344 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14346 string_from_text_prop
= 0;
14347 str
= glyph
->object
;
14348 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14349 if (tem
== 0 /* from overlay */
14352 /* If the string from which this glyph came is
14353 found in the buffer at point, or at position
14354 that is closer to point than pos_after, then
14355 we've found the glyph we've been looking for.
14356 If it comes from an overlay (tem == 0), and
14357 it has the `cursor' property on one of its
14358 glyphs, record that glyph as a candidate for
14359 displaying the cursor. (As in the
14360 unidirectional version, we will display the
14361 cursor on the last candidate we find.) */
14364 || (tem
- pt_old
> 0 && tem
< pos_after
))
14366 /* The glyphs from this string could have
14367 been reordered. Find the one with the
14368 smallest string position. Or there could
14369 be a character in the string with the
14370 `cursor' property, which means display
14371 cursor on that character's glyph. */
14372 ptrdiff_t strpos
= glyph
->charpos
;
14377 string_from_text_prop
= 1;
14380 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14381 && EQ (glyph
->object
, str
);
14385 ptrdiff_t gpos
= glyph
->charpos
;
14387 cprop
= Fget_char_property (make_number (gpos
),
14395 if (tem
&& glyph
->charpos
< strpos
)
14397 strpos
= glyph
->charpos
;
14403 || (tem
- pt_old
> 0 && tem
< pos_after
))
14407 pos
= tem
+ 1; /* don't find previous instances */
14409 /* This string is not what we want; skip all of the
14410 glyphs that came from it. */
14411 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14412 && EQ (glyph
->object
, str
))
14419 /* If we reached the end of the line, and END was from a string,
14420 the cursor is not on this line. */
14422 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14423 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14424 && STRINGP (end
->object
)
14425 && row
->continued_p
)
14428 /* A truncated row may not include PT among its character positions.
14429 Setting the cursor inside the scroll margin will trigger
14430 recalculation of hscroll in hscroll_window_tree. But if a
14431 display string covers point, defer to the string-handling
14432 code below to figure this out. */
14433 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14435 cursor
= glyph_before
;
14438 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14439 /* Zero-width characters produce no glyphs. */
14441 && (row
->reversed_p
14442 ? glyph_after
> glyphs_end
14443 : glyph_after
< glyphs_end
)))
14445 cursor
= glyph_after
;
14451 if (cursor
!= NULL
)
14453 else if (glyph
== glyphs_end
14454 && pos_before
== pos_after
14455 && STRINGP ((row
->reversed_p
14456 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14457 : row
->glyphs
[TEXT_AREA
])->object
))
14459 /* If all the glyphs of this row came from strings, put the
14460 cursor on the first glyph of the row. This avoids having the
14461 cursor outside of the text area in this very rare and hard
14465 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14466 : row
->glyphs
[TEXT_AREA
];
14472 /* Need to compute x that corresponds to GLYPH. */
14473 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14475 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14477 x
+= g
->pixel_width
;
14481 /* ROW could be part of a continued line, which, under bidi
14482 reordering, might have other rows whose start and end charpos
14483 occlude point. Only set w->cursor if we found a better
14484 approximation to the cursor position than we have from previously
14485 examined candidate rows belonging to the same continued line. */
14486 if (/* we already have a candidate row */
14487 w
->cursor
.vpos
>= 0
14488 /* that candidate is not the row we are processing */
14489 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14490 /* Make sure cursor.vpos specifies a row whose start and end
14491 charpos occlude point, and it is valid candidate for being a
14492 cursor-row. This is because some callers of this function
14493 leave cursor.vpos at the row where the cursor was displayed
14494 during the last redisplay cycle. */
14495 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14496 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14497 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14500 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14502 /* Don't consider glyphs that are outside TEXT_AREA. */
14503 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14505 /* Keep the candidate whose buffer position is the closest to
14506 point or has the `cursor' property. */
14507 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14508 w
->cursor
.hpos
>= 0
14509 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14510 && ((BUFFERP (g1
->object
)
14511 && (g1
->charpos
== pt_old
/* an exact match always wins */
14512 || (BUFFERP (glyph
->object
)
14513 && eabs (g1
->charpos
- pt_old
)
14514 < eabs (glyph
->charpos
- pt_old
))))
14515 /* previous candidate is a glyph from a string that has
14516 a non-nil `cursor' property */
14517 || (STRINGP (g1
->object
)
14518 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14519 Qcursor
, g1
->object
))
14520 /* previous candidate is from the same display
14521 string as this one, and the display string
14522 came from a text property */
14523 || (EQ (g1
->object
, glyph
->object
)
14524 && string_from_text_prop
)
14525 /* this candidate is from newline and its
14526 position is not an exact match */
14527 || (INTEGERP (glyph
->object
)
14528 && glyph
->charpos
!= pt_old
)))))
14530 /* If this candidate gives an exact match, use that. */
14531 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14532 /* If this candidate is a glyph created for the
14533 terminating newline of a line, and point is on that
14534 newline, it wins because it's an exact match. */
14535 || (!row
->continued_p
14536 && INTEGERP (glyph
->object
)
14537 && glyph
->charpos
== 0
14538 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14539 /* Otherwise, keep the candidate that comes from a row
14540 spanning less buffer positions. This may win when one or
14541 both candidate positions are on glyphs that came from
14542 display strings, for which we cannot compare buffer
14544 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14545 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14546 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14549 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14551 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14552 w
->cursor
.y
= row
->y
+ dy
;
14554 if (w
== XWINDOW (selected_window
))
14556 if (!row
->continued_p
14557 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14560 this_line_buffer
= XBUFFER (w
->buffer
);
14562 CHARPOS (this_line_start_pos
)
14563 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14564 BYTEPOS (this_line_start_pos
)
14565 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14567 CHARPOS (this_line_end_pos
)
14568 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14569 BYTEPOS (this_line_end_pos
)
14570 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14572 this_line_y
= w
->cursor
.y
;
14573 this_line_pixel_height
= row
->height
;
14574 this_line_vpos
= w
->cursor
.vpos
;
14575 this_line_start_x
= row
->x
;
14578 CHARPOS (this_line_start_pos
) = 0;
14585 /* Run window scroll functions, if any, for WINDOW with new window
14586 start STARTP. Sets the window start of WINDOW to that position.
14588 We assume that the window's buffer is really current. */
14590 static struct text_pos
14591 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14593 struct window
*w
= XWINDOW (window
);
14594 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14596 if (current_buffer
!= XBUFFER (w
->buffer
))
14599 if (!NILP (Vwindow_scroll_functions
))
14601 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14602 make_number (CHARPOS (startp
)));
14603 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14604 /* In case the hook functions switch buffers. */
14605 set_buffer_internal (XBUFFER (w
->buffer
));
14612 /* Make sure the line containing the cursor is fully visible.
14613 A value of 1 means there is nothing to be done.
14614 (Either the line is fully visible, or it cannot be made so,
14615 or we cannot tell.)
14617 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14618 is higher than window.
14620 A value of 0 means the caller should do scrolling
14621 as if point had gone off the screen. */
14624 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14626 struct glyph_matrix
*matrix
;
14627 struct glyph_row
*row
;
14630 if (!make_cursor_line_fully_visible_p
)
14633 /* It's not always possible to find the cursor, e.g, when a window
14634 is full of overlay strings. Don't do anything in that case. */
14635 if (w
->cursor
.vpos
< 0)
14638 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14639 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14641 /* If the cursor row is not partially visible, there's nothing to do. */
14642 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14645 /* If the row the cursor is in is taller than the window's height,
14646 it's not clear what to do, so do nothing. */
14647 window_height
= window_box_height (w
);
14648 if (row
->height
>= window_height
)
14650 if (!force_p
|| MINI_WINDOW_P (w
)
14651 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14658 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14659 non-zero means only WINDOW is redisplayed in redisplay_internal.
14660 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14661 in redisplay_window to bring a partially visible line into view in
14662 the case that only the cursor has moved.
14664 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14665 last screen line's vertical height extends past the end of the screen.
14669 1 if scrolling succeeded
14671 0 if scrolling didn't find point.
14673 -1 if new fonts have been loaded so that we must interrupt
14674 redisplay, adjust glyph matrices, and try again. */
14680 SCROLLING_NEED_LARGER_MATRICES
14683 /* If scroll-conservatively is more than this, never recenter.
14685 If you change this, don't forget to update the doc string of
14686 `scroll-conservatively' and the Emacs manual. */
14687 #define SCROLL_LIMIT 100
14690 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14691 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14692 int temp_scroll_step
, int last_line_misfit
)
14694 struct window
*w
= XWINDOW (window
);
14695 struct frame
*f
= XFRAME (w
->frame
);
14696 struct text_pos pos
, startp
;
14698 int this_scroll_margin
, scroll_max
, rc
, height
;
14699 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14700 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14701 Lisp_Object aggressive
;
14702 /* We will never try scrolling more than this number of lines. */
14703 int scroll_limit
= SCROLL_LIMIT
;
14706 debug_method_add (w
, "try_scrolling");
14709 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14711 /* Compute scroll margin height in pixels. We scroll when point is
14712 within this distance from the top or bottom of the window. */
14713 if (scroll_margin
> 0)
14714 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14715 * FRAME_LINE_HEIGHT (f
);
14717 this_scroll_margin
= 0;
14719 /* Force arg_scroll_conservatively to have a reasonable value, to
14720 avoid scrolling too far away with slow move_it_* functions. Note
14721 that the user can supply scroll-conservatively equal to
14722 `most-positive-fixnum', which can be larger than INT_MAX. */
14723 if (arg_scroll_conservatively
> scroll_limit
)
14725 arg_scroll_conservatively
= scroll_limit
+ 1;
14726 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14728 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14729 /* Compute how much we should try to scroll maximally to bring
14730 point into view. */
14731 scroll_max
= (max (scroll_step
,
14732 max (arg_scroll_conservatively
, temp_scroll_step
))
14733 * FRAME_LINE_HEIGHT (f
));
14734 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14735 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14736 /* We're trying to scroll because of aggressive scrolling but no
14737 scroll_step is set. Choose an arbitrary one. */
14738 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14744 /* Decide whether to scroll down. */
14745 if (PT
> CHARPOS (startp
))
14747 int scroll_margin_y
;
14749 /* Compute the pixel ypos of the scroll margin, then move IT to
14750 either that ypos or PT, whichever comes first. */
14751 start_display (&it
, w
, startp
);
14752 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14753 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14754 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14755 (MOVE_TO_POS
| MOVE_TO_Y
));
14757 if (PT
> CHARPOS (it
.current
.pos
))
14759 int y0
= line_bottom_y (&it
);
14760 /* Compute how many pixels below window bottom to stop searching
14761 for PT. This avoids costly search for PT that is far away if
14762 the user limited scrolling by a small number of lines, but
14763 always finds PT if scroll_conservatively is set to a large
14764 number, such as most-positive-fixnum. */
14765 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14766 int y_to_move
= it
.last_visible_y
+ slack
;
14768 /* Compute the distance from the scroll margin to PT or to
14769 the scroll limit, whichever comes first. This should
14770 include the height of the cursor line, to make that line
14772 move_it_to (&it
, PT
, -1, y_to_move
,
14773 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14774 dy
= line_bottom_y (&it
) - y0
;
14776 if (dy
> scroll_max
)
14777 return SCROLLING_FAILED
;
14786 /* Point is in or below the bottom scroll margin, so move the
14787 window start down. If scrolling conservatively, move it just
14788 enough down to make point visible. If scroll_step is set,
14789 move it down by scroll_step. */
14790 if (arg_scroll_conservatively
)
14792 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14793 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14794 else if (scroll_step
|| temp_scroll_step
)
14795 amount_to_scroll
= scroll_max
;
14798 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14799 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14800 if (NUMBERP (aggressive
))
14802 double float_amount
= XFLOATINT (aggressive
) * height
;
14803 int aggressive_scroll
= float_amount
;
14804 if (aggressive_scroll
== 0 && float_amount
> 0)
14805 aggressive_scroll
= 1;
14806 /* Don't let point enter the scroll margin near top of
14807 the window. This could happen if the value of
14808 scroll_up_aggressively is too large and there are
14809 non-zero margins, because scroll_up_aggressively
14810 means put point that fraction of window height
14811 _from_the_bottom_margin_. */
14812 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14813 aggressive_scroll
= height
- 2*this_scroll_margin
;
14814 amount_to_scroll
= dy
+ aggressive_scroll
;
14818 if (amount_to_scroll
<= 0)
14819 return SCROLLING_FAILED
;
14821 start_display (&it
, w
, startp
);
14822 if (arg_scroll_conservatively
<= scroll_limit
)
14823 move_it_vertically (&it
, amount_to_scroll
);
14826 /* Extra precision for users who set scroll-conservatively
14827 to a large number: make sure the amount we scroll
14828 the window start is never less than amount_to_scroll,
14829 which was computed as distance from window bottom to
14830 point. This matters when lines at window top and lines
14831 below window bottom have different height. */
14833 void *it1data
= NULL
;
14834 /* We use a temporary it1 because line_bottom_y can modify
14835 its argument, if it moves one line down; see there. */
14838 SAVE_IT (it1
, it
, it1data
);
14839 start_y
= line_bottom_y (&it1
);
14841 RESTORE_IT (&it
, &it
, it1data
);
14842 move_it_by_lines (&it
, 1);
14843 SAVE_IT (it1
, it
, it1data
);
14844 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14847 /* If STARTP is unchanged, move it down another screen line. */
14848 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14849 move_it_by_lines (&it
, 1);
14850 startp
= it
.current
.pos
;
14854 struct text_pos scroll_margin_pos
= startp
;
14856 /* See if point is inside the scroll margin at the top of the
14858 if (this_scroll_margin
)
14860 start_display (&it
, w
, startp
);
14861 move_it_vertically (&it
, this_scroll_margin
);
14862 scroll_margin_pos
= it
.current
.pos
;
14865 if (PT
< CHARPOS (scroll_margin_pos
))
14867 /* Point is in the scroll margin at the top of the window or
14868 above what is displayed in the window. */
14871 /* Compute the vertical distance from PT to the scroll
14872 margin position. Move as far as scroll_max allows, or
14873 one screenful, or 10 screen lines, whichever is largest.
14874 Give up if distance is greater than scroll_max or if we
14875 didn't reach the scroll margin position. */
14876 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14877 start_display (&it
, w
, pos
);
14879 y_to_move
= max (it
.last_visible_y
,
14880 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14881 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14883 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14884 dy
= it
.current_y
- y0
;
14885 if (dy
> scroll_max
14886 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
14887 return SCROLLING_FAILED
;
14889 /* Compute new window start. */
14890 start_display (&it
, w
, startp
);
14892 if (arg_scroll_conservatively
)
14893 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14894 max (scroll_step
, temp_scroll_step
));
14895 else if (scroll_step
|| temp_scroll_step
)
14896 amount_to_scroll
= scroll_max
;
14899 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14900 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14901 if (NUMBERP (aggressive
))
14903 double float_amount
= XFLOATINT (aggressive
) * height
;
14904 int aggressive_scroll
= float_amount
;
14905 if (aggressive_scroll
== 0 && float_amount
> 0)
14906 aggressive_scroll
= 1;
14907 /* Don't let point enter the scroll margin near
14908 bottom of the window, if the value of
14909 scroll_down_aggressively happens to be too
14911 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
14912 aggressive_scroll
= height
- 2*this_scroll_margin
;
14913 amount_to_scroll
= dy
+ aggressive_scroll
;
14917 if (amount_to_scroll
<= 0)
14918 return SCROLLING_FAILED
;
14920 move_it_vertically_backward (&it
, amount_to_scroll
);
14921 startp
= it
.current
.pos
;
14925 /* Run window scroll functions. */
14926 startp
= run_window_scroll_functions (window
, startp
);
14928 /* Display the window. Give up if new fonts are loaded, or if point
14930 if (!try_window (window
, startp
, 0))
14931 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14932 else if (w
->cursor
.vpos
< 0)
14934 clear_glyph_matrix (w
->desired_matrix
);
14935 rc
= SCROLLING_FAILED
;
14939 /* Maybe forget recorded base line for line number display. */
14940 if (!just_this_one_p
14941 || current_buffer
->clip_changed
14942 || BEG_UNCHANGED
< CHARPOS (startp
))
14943 wset_base_line_number (w
, Qnil
);
14945 /* If cursor ends up on a partially visible line,
14946 treat that as being off the bottom of the screen. */
14947 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14948 /* It's possible that the cursor is on the first line of the
14949 buffer, which is partially obscured due to a vscroll
14950 (Bug#7537). In that case, avoid looping forever . */
14951 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14953 clear_glyph_matrix (w
->desired_matrix
);
14954 ++extra_scroll_margin_lines
;
14957 rc
= SCROLLING_SUCCESS
;
14964 /* Compute a suitable window start for window W if display of W starts
14965 on a continuation line. Value is non-zero if a new window start
14968 The new window start will be computed, based on W's width, starting
14969 from the start of the continued line. It is the start of the
14970 screen line with the minimum distance from the old start W->start. */
14973 compute_window_start_on_continuation_line (struct window
*w
)
14975 struct text_pos pos
, start_pos
;
14976 int window_start_changed_p
= 0;
14978 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14980 /* If window start is on a continuation line... Window start may be
14981 < BEGV in case there's invisible text at the start of the
14982 buffer (M-x rmail, for example). */
14983 if (CHARPOS (start_pos
) > BEGV
14984 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14987 struct glyph_row
*row
;
14989 /* Handle the case that the window start is out of range. */
14990 if (CHARPOS (start_pos
) < BEGV
)
14991 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14992 else if (CHARPOS (start_pos
) > ZV
)
14993 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14995 /* Find the start of the continued line. This should be fast
14996 because scan_buffer is fast (newline cache). */
14997 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14998 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14999 row
, DEFAULT_FACE_ID
);
15000 reseat_at_previous_visible_line_start (&it
);
15002 /* If the line start is "too far" away from the window start,
15003 say it takes too much time to compute a new window start. */
15004 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15005 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15007 int min_distance
, distance
;
15009 /* Move forward by display lines to find the new window
15010 start. If window width was enlarged, the new start can
15011 be expected to be > the old start. If window width was
15012 decreased, the new window start will be < the old start.
15013 So, we're looking for the display line start with the
15014 minimum distance from the old window start. */
15015 pos
= it
.current
.pos
;
15016 min_distance
= INFINITY
;
15017 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15018 distance
< min_distance
)
15020 min_distance
= distance
;
15021 pos
= it
.current
.pos
;
15022 move_it_by_lines (&it
, 1);
15025 /* Set the window start there. */
15026 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15027 window_start_changed_p
= 1;
15031 return window_start_changed_p
;
15035 /* Try cursor movement in case text has not changed in window WINDOW,
15036 with window start STARTP. Value is
15038 CURSOR_MOVEMENT_SUCCESS if successful
15040 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15042 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15043 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15044 we want to scroll as if scroll-step were set to 1. See the code.
15046 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15047 which case we have to abort this redisplay, and adjust matrices
15052 CURSOR_MOVEMENT_SUCCESS
,
15053 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15054 CURSOR_MOVEMENT_MUST_SCROLL
,
15055 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15059 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15061 struct window
*w
= XWINDOW (window
);
15062 struct frame
*f
= XFRAME (w
->frame
);
15063 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15066 if (inhibit_try_cursor_movement
)
15070 /* Previously, there was a check for Lisp integer in the
15071 if-statement below. Now, this field is converted to
15072 ptrdiff_t, thus zero means invalid position in a buffer. */
15073 eassert (w
->last_point
> 0);
15075 /* Handle case where text has not changed, only point, and it has
15076 not moved off the frame. */
15077 if (/* Point may be in this window. */
15078 PT
>= CHARPOS (startp
)
15079 /* Selective display hasn't changed. */
15080 && !current_buffer
->clip_changed
15081 /* Function force-mode-line-update is used to force a thorough
15082 redisplay. It sets either windows_or_buffers_changed or
15083 update_mode_lines. So don't take a shortcut here for these
15085 && !update_mode_lines
15086 && !windows_or_buffers_changed
15087 && !cursor_type_changed
15088 /* Can't use this case if highlighting a region. When a
15089 region exists, cursor movement has to do more than just
15091 && markpos_of_region () < 0
15092 && NILP (w
->region_showing
)
15093 && NILP (Vshow_trailing_whitespace
)
15094 /* This code is not used for mini-buffer for the sake of the case
15095 of redisplaying to replace an echo area message; since in
15096 that case the mini-buffer contents per se are usually
15097 unchanged. This code is of no real use in the mini-buffer
15098 since the handling of this_line_start_pos, etc., in redisplay
15099 handles the same cases. */
15100 && !EQ (window
, minibuf_window
)
15101 /* When splitting windows or for new windows, it happens that
15102 redisplay is called with a nil window_end_vpos or one being
15103 larger than the window. This should really be fixed in
15104 window.c. I don't have this on my list, now, so we do
15105 approximately the same as the old redisplay code. --gerd. */
15106 && INTEGERP (w
->window_end_vpos
)
15107 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15108 && (FRAME_WINDOW_P (f
)
15109 || !overlay_arrow_in_current_buffer_p ()))
15111 int this_scroll_margin
, top_scroll_margin
;
15112 struct glyph_row
*row
= NULL
;
15115 debug_method_add (w
, "cursor movement");
15118 /* Scroll if point within this distance from the top or bottom
15119 of the window. This is a pixel value. */
15120 if (scroll_margin
> 0)
15122 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15123 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15126 this_scroll_margin
= 0;
15128 top_scroll_margin
= this_scroll_margin
;
15129 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15130 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15132 /* Start with the row the cursor was displayed during the last
15133 not paused redisplay. Give up if that row is not valid. */
15134 if (w
->last_cursor
.vpos
< 0
15135 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15136 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15139 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15140 if (row
->mode_line_p
)
15142 if (!row
->enabled_p
)
15143 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15146 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15148 int scroll_p
= 0, must_scroll
= 0;
15149 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15151 if (PT
> w
->last_point
)
15153 /* Point has moved forward. */
15154 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15155 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15157 eassert (row
->enabled_p
);
15161 /* If the end position of a row equals the start
15162 position of the next row, and PT is at that position,
15163 we would rather display cursor in the next line. */
15164 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15165 && MATRIX_ROW_END_CHARPOS (row
) == PT
15166 && row
< w
->current_matrix
->rows
15167 + w
->current_matrix
->nrows
- 1
15168 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15169 && !cursor_row_p (row
))
15172 /* If within the scroll margin, scroll. Note that
15173 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15174 the next line would be drawn, and that
15175 this_scroll_margin can be zero. */
15176 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15177 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15178 /* Line is completely visible last line in window
15179 and PT is to be set in the next line. */
15180 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15181 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15182 && !row
->ends_at_zv_p
15183 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15186 else if (PT
< w
->last_point
)
15188 /* Cursor has to be moved backward. Note that PT >=
15189 CHARPOS (startp) because of the outer if-statement. */
15190 while (!row
->mode_line_p
15191 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15192 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15193 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15194 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15195 row
> w
->current_matrix
->rows
15196 && (row
-1)->ends_in_newline_from_string_p
))))
15197 && (row
->y
> top_scroll_margin
15198 || CHARPOS (startp
) == BEGV
))
15200 eassert (row
->enabled_p
);
15204 /* Consider the following case: Window starts at BEGV,
15205 there is invisible, intangible text at BEGV, so that
15206 display starts at some point START > BEGV. It can
15207 happen that we are called with PT somewhere between
15208 BEGV and START. Try to handle that case. */
15209 if (row
< w
->current_matrix
->rows
15210 || row
->mode_line_p
)
15212 row
= w
->current_matrix
->rows
;
15213 if (row
->mode_line_p
)
15217 /* Due to newlines in overlay strings, we may have to
15218 skip forward over overlay strings. */
15219 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15220 && MATRIX_ROW_END_CHARPOS (row
) == PT
15221 && !cursor_row_p (row
))
15224 /* If within the scroll margin, scroll. */
15225 if (row
->y
< top_scroll_margin
15226 && CHARPOS (startp
) != BEGV
)
15231 /* Cursor did not move. So don't scroll even if cursor line
15232 is partially visible, as it was so before. */
15233 rc
= CURSOR_MOVEMENT_SUCCESS
;
15236 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15237 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15239 /* if PT is not in the glyph row, give up. */
15240 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15243 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15244 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15246 struct glyph_row
*row1
;
15248 /* If rows are bidi-reordered and point moved, back up
15249 until we find a row that does not belong to a
15250 continuation line. This is because we must consider
15251 all rows of a continued line as candidates for the
15252 new cursor positioning, since row start and end
15253 positions change non-linearly with vertical position
15255 /* FIXME: Revisit this when glyph ``spilling'' in
15256 continuation lines' rows is implemented for
15257 bidi-reordered rows. */
15258 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15259 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15262 /* If we hit the beginning of the displayed portion
15263 without finding the first row of a continued
15267 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15270 eassert (row
->enabled_p
);
15275 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15276 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15277 /* Make sure this isn't a header line by any chance, since
15278 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15279 && !row
->mode_line_p
15280 && make_cursor_line_fully_visible_p
)
15282 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15283 && !row
->ends_at_zv_p
15284 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15285 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15286 else if (row
->height
> window_box_height (w
))
15288 /* If we end up in a partially visible line, let's
15289 make it fully visible, except when it's taller
15290 than the window, in which case we can't do much
15293 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15297 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15298 if (!cursor_row_fully_visible_p (w
, 0, 1))
15299 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15301 rc
= CURSOR_MOVEMENT_SUCCESS
;
15305 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15306 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15307 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15309 /* With bidi-reordered rows, there could be more than
15310 one candidate row whose start and end positions
15311 occlude point. We need to let set_cursor_from_row
15312 find the best candidate. */
15313 /* FIXME: Revisit this when glyph ``spilling'' in
15314 continuation lines' rows is implemented for
15315 bidi-reordered rows. */
15320 int at_zv_p
= 0, exact_match_p
= 0;
15322 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15323 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15324 && cursor_row_p (row
))
15325 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15327 /* As soon as we've found the exact match for point,
15328 or the first suitable row whose ends_at_zv_p flag
15329 is set, we are done. */
15331 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15333 && w
->cursor
.hpos
>= 0
15334 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15337 struct glyph_row
*candidate
=
15338 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15340 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15341 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15344 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15345 || (INTEGERP (g
->object
)
15346 && (g
->charpos
== PT
15347 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15349 if (rv
&& (at_zv_p
|| exact_match_p
))
15351 rc
= CURSOR_MOVEMENT_SUCCESS
;
15354 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15358 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15359 || row
->continued_p
)
15360 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15361 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15362 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15363 /* If we didn't find any candidate rows, or exited the
15364 loop before all the candidates were examined, signal
15365 to the caller that this method failed. */
15366 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15368 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15369 && !row
->continued_p
))
15370 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15372 rc
= CURSOR_MOVEMENT_SUCCESS
;
15378 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15380 rc
= CURSOR_MOVEMENT_SUCCESS
;
15385 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15386 && MATRIX_ROW_START_CHARPOS (row
) == PT
15387 && cursor_row_p (row
));
15395 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15399 set_vertical_scroll_bar (struct window
*w
)
15401 ptrdiff_t start
, end
, whole
;
15403 /* Calculate the start and end positions for the current window.
15404 At some point, it would be nice to choose between scrollbars
15405 which reflect the whole buffer size, with special markers
15406 indicating narrowing, and scrollbars which reflect only the
15409 Note that mini-buffers sometimes aren't displaying any text. */
15410 if (!MINI_WINDOW_P (w
)
15411 || (w
== XWINDOW (minibuf_window
)
15412 && NILP (echo_area_buffer
[0])))
15414 struct buffer
*buf
= XBUFFER (w
->buffer
);
15415 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15416 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15417 /* I don't think this is guaranteed to be right. For the
15418 moment, we'll pretend it is. */
15419 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15423 if (whole
< (end
- start
))
15424 whole
= end
- start
;
15427 start
= end
= whole
= 0;
15429 /* Indicate what this scroll bar ought to be displaying now. */
15430 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15431 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15432 (w
, end
- start
, whole
, start
);
15436 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15437 selected_window is redisplayed.
15439 We can return without actually redisplaying the window if
15440 fonts_changed_p. In that case, redisplay_internal will
15444 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15446 struct window
*w
= XWINDOW (window
);
15447 struct frame
*f
= XFRAME (w
->frame
);
15448 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15449 struct buffer
*old
= current_buffer
;
15450 struct text_pos lpoint
, opoint
, startp
;
15451 int update_mode_line
;
15454 /* Record it now because it's overwritten. */
15455 int current_matrix_up_to_date_p
= 0;
15456 int used_current_matrix_p
= 0;
15457 /* This is less strict than current_matrix_up_to_date_p.
15458 It indicates that the buffer contents and narrowing are unchanged. */
15459 int buffer_unchanged_p
= 0;
15460 int temp_scroll_step
= 0;
15461 ptrdiff_t count
= SPECPDL_INDEX ();
15463 int centering_position
= -1;
15464 int last_line_misfit
= 0;
15465 ptrdiff_t beg_unchanged
, end_unchanged
;
15467 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15470 /* W must be a leaf window here. */
15471 eassert (!NILP (w
->buffer
));
15473 *w
->desired_matrix
->method
= 0;
15477 reconsider_clip_changes (w
, buffer
);
15479 /* Has the mode line to be updated? */
15480 update_mode_line
= (w
->update_mode_line
15481 || update_mode_lines
15482 || buffer
->clip_changed
15483 || buffer
->prevent_redisplay_optimizations_p
);
15485 if (MINI_WINDOW_P (w
))
15487 if (w
== XWINDOW (echo_area_window
)
15488 && !NILP (echo_area_buffer
[0]))
15490 if (update_mode_line
)
15491 /* We may have to update a tty frame's menu bar or a
15492 tool-bar. Example `M-x C-h C-h C-g'. */
15493 goto finish_menu_bars
;
15495 /* We've already displayed the echo area glyphs in this window. */
15496 goto finish_scroll_bars
;
15498 else if ((w
!= XWINDOW (minibuf_window
)
15499 || minibuf_level
== 0)
15500 /* When buffer is nonempty, redisplay window normally. */
15501 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15502 /* Quail displays non-mini buffers in minibuffer window.
15503 In that case, redisplay the window normally. */
15504 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15506 /* W is a mini-buffer window, but it's not active, so clear
15508 int yb
= window_text_bottom_y (w
);
15509 struct glyph_row
*row
;
15512 for (y
= 0, row
= w
->desired_matrix
->rows
;
15514 y
+= row
->height
, ++row
)
15515 blank_row (w
, row
, y
);
15516 goto finish_scroll_bars
;
15519 clear_glyph_matrix (w
->desired_matrix
);
15522 /* Otherwise set up data on this window; select its buffer and point
15524 /* Really select the buffer, for the sake of buffer-local
15526 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15528 current_matrix_up_to_date_p
15529 = (!NILP (w
->window_end_valid
)
15530 && !current_buffer
->clip_changed
15531 && !current_buffer
->prevent_redisplay_optimizations_p
15532 && !window_outdated (w
));
15534 /* Run the window-bottom-change-functions
15535 if it is possible that the text on the screen has changed
15536 (either due to modification of the text, or any other reason). */
15537 if (!current_matrix_up_to_date_p
15538 && !NILP (Vwindow_text_change_functions
))
15540 safe_run_hooks (Qwindow_text_change_functions
);
15544 beg_unchanged
= BEG_UNCHANGED
;
15545 end_unchanged
= END_UNCHANGED
;
15547 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15549 specbind (Qinhibit_point_motion_hooks
, Qt
);
15552 = (!NILP (w
->window_end_valid
)
15553 && !current_buffer
->clip_changed
15554 && !window_outdated (w
));
15556 /* When windows_or_buffers_changed is non-zero, we can't rely on
15557 the window end being valid, so set it to nil there. */
15558 if (windows_or_buffers_changed
)
15560 /* If window starts on a continuation line, maybe adjust the
15561 window start in case the window's width changed. */
15562 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15563 compute_window_start_on_continuation_line (w
);
15565 wset_window_end_valid (w
, Qnil
);
15568 /* Some sanity checks. */
15569 CHECK_WINDOW_END (w
);
15570 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15572 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15575 if (mode_line_update_needed (w
))
15576 update_mode_line
= 1;
15578 /* Point refers normally to the selected window. For any other
15579 window, set up appropriate value. */
15580 if (!EQ (window
, selected_window
))
15582 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15583 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15587 new_pt_byte
= BEGV_BYTE
;
15588 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15590 else if (new_pt
> (ZV
- 1))
15593 new_pt_byte
= ZV_BYTE
;
15594 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15597 /* We don't use SET_PT so that the point-motion hooks don't run. */
15598 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15601 /* If any of the character widths specified in the display table
15602 have changed, invalidate the width run cache. It's true that
15603 this may be a bit late to catch such changes, but the rest of
15604 redisplay goes (non-fatally) haywire when the display table is
15605 changed, so why should we worry about doing any better? */
15606 if (current_buffer
->width_run_cache
)
15608 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15610 if (! disptab_matches_widthtab
15611 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15613 invalidate_region_cache (current_buffer
,
15614 current_buffer
->width_run_cache
,
15616 recompute_width_table (current_buffer
, disptab
);
15620 /* If window-start is screwed up, choose a new one. */
15621 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15624 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15626 /* If someone specified a new starting point but did not insist,
15627 check whether it can be used. */
15628 if (w
->optional_new_start
15629 && CHARPOS (startp
) >= BEGV
15630 && CHARPOS (startp
) <= ZV
)
15632 w
->optional_new_start
= 0;
15633 start_display (&it
, w
, startp
);
15634 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15635 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15636 if (IT_CHARPOS (it
) == PT
)
15637 w
->force_start
= 1;
15638 /* IT may overshoot PT if text at PT is invisible. */
15639 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15640 w
->force_start
= 1;
15645 /* Handle case where place to start displaying has been specified,
15646 unless the specified location is outside the accessible range. */
15647 if (w
->force_start
|| w
->frozen_window_start_p
)
15649 /* We set this later on if we have to adjust point. */
15652 w
->force_start
= 0;
15654 wset_window_end_valid (w
, Qnil
);
15656 /* Forget any recorded base line for line number display. */
15657 if (!buffer_unchanged_p
)
15658 wset_base_line_number (w
, Qnil
);
15660 /* Redisplay the mode line. Select the buffer properly for that.
15661 Also, run the hook window-scroll-functions
15662 because we have scrolled. */
15663 /* Note, we do this after clearing force_start because
15664 if there's an error, it is better to forget about force_start
15665 than to get into an infinite loop calling the hook functions
15666 and having them get more errors. */
15667 if (!update_mode_line
15668 || ! NILP (Vwindow_scroll_functions
))
15670 update_mode_line
= 1;
15671 w
->update_mode_line
= 1;
15672 startp
= run_window_scroll_functions (window
, startp
);
15675 w
->last_modified
= 0;
15676 w
->last_overlay_modified
= 0;
15677 if (CHARPOS (startp
) < BEGV
)
15678 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15679 else if (CHARPOS (startp
) > ZV
)
15680 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15682 /* Redisplay, then check if cursor has been set during the
15683 redisplay. Give up if new fonts were loaded. */
15684 /* We used to issue a CHECK_MARGINS argument to try_window here,
15685 but this causes scrolling to fail when point begins inside
15686 the scroll margin (bug#148) -- cyd */
15687 if (!try_window (window
, startp
, 0))
15689 w
->force_start
= 1;
15690 clear_glyph_matrix (w
->desired_matrix
);
15691 goto need_larger_matrices
;
15694 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15696 /* If point does not appear, try to move point so it does
15697 appear. The desired matrix has been built above, so we
15698 can use it here. */
15699 new_vpos
= window_box_height (w
) / 2;
15702 if (!cursor_row_fully_visible_p (w
, 0, 0))
15704 /* Point does appear, but on a line partly visible at end of window.
15705 Move it back to a fully-visible line. */
15706 new_vpos
= window_box_height (w
);
15708 else if (w
->cursor
.vpos
>=0)
15710 /* Some people insist on not letting point enter the scroll
15711 margin, even though this part handles windows that didn't
15713 struct frame
*f
= XFRAME (w
->frame
);
15714 int margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15715 int pixel_margin
= margin
* FRAME_LINE_HEIGHT (f
);
15716 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15718 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15719 below, which finds the row to move point to, advances by
15720 the Y coordinate of the _next_ row, see the definition of
15721 MATRIX_ROW_BOTTOM_Y. */
15722 if (w
->cursor
.vpos
< margin
+ header_line
)
15724 = pixel_margin
+ (header_line
15725 ? CURRENT_HEADER_LINE_HEIGHT (w
)
15726 : 0) + FRAME_LINE_HEIGHT (f
);
15729 int window_height
= window_box_height (w
);
15732 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15733 if (w
->cursor
.y
>= window_height
- pixel_margin
)
15734 new_vpos
= window_height
- pixel_margin
;
15738 /* If we need to move point for either of the above reasons,
15739 now actually do it. */
15742 struct glyph_row
*row
;
15744 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15745 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15748 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15749 MATRIX_ROW_START_BYTEPOS (row
));
15751 if (w
!= XWINDOW (selected_window
))
15752 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15753 else if (current_buffer
== old
)
15754 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15756 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15758 /* If we are highlighting the region, then we just changed
15759 the region, so redisplay to show it. */
15760 if (0 <= markpos_of_region ())
15762 clear_glyph_matrix (w
->desired_matrix
);
15763 if (!try_window (window
, startp
, 0))
15764 goto need_larger_matrices
;
15769 debug_method_add (w
, "forced window start");
15774 /* Handle case where text has not changed, only point, and it has
15775 not moved off the frame, and we are not retrying after hscroll.
15776 (current_matrix_up_to_date_p is nonzero when retrying.) */
15777 if (current_matrix_up_to_date_p
15778 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15779 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15783 case CURSOR_MOVEMENT_SUCCESS
:
15784 used_current_matrix_p
= 1;
15787 case CURSOR_MOVEMENT_MUST_SCROLL
:
15788 goto try_to_scroll
;
15794 /* If current starting point was originally the beginning of a line
15795 but no longer is, find a new starting point. */
15796 else if (w
->start_at_line_beg
15797 && !(CHARPOS (startp
) <= BEGV
15798 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15801 debug_method_add (w
, "recenter 1");
15806 /* Try scrolling with try_window_id. Value is > 0 if update has
15807 been done, it is -1 if we know that the same window start will
15808 not work. It is 0 if unsuccessful for some other reason. */
15809 else if ((tem
= try_window_id (w
)) != 0)
15812 debug_method_add (w
, "try_window_id %d", tem
);
15815 if (fonts_changed_p
)
15816 goto need_larger_matrices
;
15820 /* Otherwise try_window_id has returned -1 which means that we
15821 don't want the alternative below this comment to execute. */
15823 else if (CHARPOS (startp
) >= BEGV
15824 && CHARPOS (startp
) <= ZV
15825 && PT
>= CHARPOS (startp
)
15826 && (CHARPOS (startp
) < ZV
15827 /* Avoid starting at end of buffer. */
15828 || CHARPOS (startp
) == BEGV
15829 || !window_outdated (w
)))
15831 int d1
, d2
, d3
, d4
, d5
, d6
;
15833 /* If first window line is a continuation line, and window start
15834 is inside the modified region, but the first change is before
15835 current window start, we must select a new window start.
15837 However, if this is the result of a down-mouse event (e.g. by
15838 extending the mouse-drag-overlay), we don't want to select a
15839 new window start, since that would change the position under
15840 the mouse, resulting in an unwanted mouse-movement rather
15841 than a simple mouse-click. */
15842 if (!w
->start_at_line_beg
15843 && NILP (do_mouse_tracking
)
15844 && CHARPOS (startp
) > BEGV
15845 && CHARPOS (startp
) > BEG
+ beg_unchanged
15846 && CHARPOS (startp
) <= Z
- end_unchanged
15847 /* Even if w->start_at_line_beg is nil, a new window may
15848 start at a line_beg, since that's how set_buffer_window
15849 sets it. So, we need to check the return value of
15850 compute_window_start_on_continuation_line. (See also
15852 && XMARKER (w
->start
)->buffer
== current_buffer
15853 && compute_window_start_on_continuation_line (w
)
15854 /* It doesn't make sense to force the window start like we
15855 do at label force_start if it is already known that point
15856 will not be visible in the resulting window, because
15857 doing so will move point from its correct position
15858 instead of scrolling the window to bring point into view.
15860 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15862 w
->force_start
= 1;
15863 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15868 debug_method_add (w
, "same window start");
15871 /* Try to redisplay starting at same place as before.
15872 If point has not moved off frame, accept the results. */
15873 if (!current_matrix_up_to_date_p
15874 /* Don't use try_window_reusing_current_matrix in this case
15875 because a window scroll function can have changed the
15877 || !NILP (Vwindow_scroll_functions
)
15878 || MINI_WINDOW_P (w
)
15879 || !(used_current_matrix_p
15880 = try_window_reusing_current_matrix (w
)))
15882 IF_DEBUG (debug_method_add (w
, "1"));
15883 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15884 /* -1 means we need to scroll.
15885 0 means we need new matrices, but fonts_changed_p
15886 is set in that case, so we will detect it below. */
15887 goto try_to_scroll
;
15890 if (fonts_changed_p
)
15891 goto need_larger_matrices
;
15893 if (w
->cursor
.vpos
>= 0)
15895 if (!just_this_one_p
15896 || current_buffer
->clip_changed
15897 || BEG_UNCHANGED
< CHARPOS (startp
))
15898 /* Forget any recorded base line for line number display. */
15899 wset_base_line_number (w
, Qnil
);
15901 if (!cursor_row_fully_visible_p (w
, 1, 0))
15903 clear_glyph_matrix (w
->desired_matrix
);
15904 last_line_misfit
= 1;
15906 /* Drop through and scroll. */
15911 clear_glyph_matrix (w
->desired_matrix
);
15916 w
->last_modified
= 0;
15917 w
->last_overlay_modified
= 0;
15919 /* Redisplay the mode line. Select the buffer properly for that. */
15920 if (!update_mode_line
)
15922 update_mode_line
= 1;
15923 w
->update_mode_line
= 1;
15926 /* Try to scroll by specified few lines. */
15927 if ((scroll_conservatively
15928 || emacs_scroll_step
15929 || temp_scroll_step
15930 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15931 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15932 && CHARPOS (startp
) >= BEGV
15933 && CHARPOS (startp
) <= ZV
)
15935 /* The function returns -1 if new fonts were loaded, 1 if
15936 successful, 0 if not successful. */
15937 int ss
= try_scrolling (window
, just_this_one_p
,
15938 scroll_conservatively
,
15940 temp_scroll_step
, last_line_misfit
);
15943 case SCROLLING_SUCCESS
:
15946 case SCROLLING_NEED_LARGER_MATRICES
:
15947 goto need_larger_matrices
;
15949 case SCROLLING_FAILED
:
15957 /* Finally, just choose a place to start which positions point
15958 according to user preferences. */
15963 debug_method_add (w
, "recenter");
15966 /* w->vscroll = 0; */
15968 /* Forget any previously recorded base line for line number display. */
15969 if (!buffer_unchanged_p
)
15970 wset_base_line_number (w
, Qnil
);
15972 /* Determine the window start relative to point. */
15973 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15974 it
.current_y
= it
.last_visible_y
;
15975 if (centering_position
< 0)
15979 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15981 ptrdiff_t margin_pos
= CHARPOS (startp
);
15982 Lisp_Object aggressive
;
15985 /* If there is a scroll margin at the top of the window, find
15986 its character position. */
15988 /* Cannot call start_display if startp is not in the
15989 accessible region of the buffer. This can happen when we
15990 have just switched to a different buffer and/or changed
15991 its restriction. In that case, startp is initialized to
15992 the character position 1 (BEGV) because we did not yet
15993 have chance to display the buffer even once. */
15994 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15997 void *it1data
= NULL
;
15999 SAVE_IT (it1
, it
, it1data
);
16000 start_display (&it1
, w
, startp
);
16001 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
16002 margin_pos
= IT_CHARPOS (it1
);
16003 RESTORE_IT (&it
, &it
, it1data
);
16005 scrolling_up
= PT
> margin_pos
;
16008 ? BVAR (current_buffer
, scroll_up_aggressively
)
16009 : BVAR (current_buffer
, scroll_down_aggressively
);
16011 if (!MINI_WINDOW_P (w
)
16012 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16016 /* Setting scroll-conservatively overrides
16017 scroll-*-aggressively. */
16018 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16020 double float_amount
= XFLOATINT (aggressive
);
16022 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16023 if (pt_offset
== 0 && float_amount
> 0)
16025 if (pt_offset
&& margin
> 0)
16028 /* Compute how much to move the window start backward from
16029 point so that point will be displayed where the user
16033 centering_position
= it
.last_visible_y
;
16035 centering_position
-= pt_offset
;
16036 centering_position
-=
16037 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
16038 + WINDOW_HEADER_LINE_HEIGHT (w
);
16039 /* Don't let point enter the scroll margin near top of
16041 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
16042 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
16045 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
16048 /* Set the window start half the height of the window backward
16050 centering_position
= window_box_height (w
) / 2;
16052 move_it_vertically_backward (&it
, centering_position
);
16054 eassert (IT_CHARPOS (it
) >= BEGV
);
16056 /* The function move_it_vertically_backward may move over more
16057 than the specified y-distance. If it->w is small, e.g. a
16058 mini-buffer window, we may end up in front of the window's
16059 display area. Start displaying at the start of the line
16060 containing PT in this case. */
16061 if (it
.current_y
<= 0)
16063 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16064 move_it_vertically_backward (&it
, 0);
16068 it
.current_x
= it
.hpos
= 0;
16070 /* Set the window start position here explicitly, to avoid an
16071 infinite loop in case the functions in window-scroll-functions
16073 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16075 /* Run scroll hooks. */
16076 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16078 /* Redisplay the window. */
16079 if (!current_matrix_up_to_date_p
16080 || windows_or_buffers_changed
16081 || cursor_type_changed
16082 /* Don't use try_window_reusing_current_matrix in this case
16083 because it can have changed the buffer. */
16084 || !NILP (Vwindow_scroll_functions
)
16085 || !just_this_one_p
16086 || MINI_WINDOW_P (w
)
16087 || !(used_current_matrix_p
16088 = try_window_reusing_current_matrix (w
)))
16089 try_window (window
, startp
, 0);
16091 /* If new fonts have been loaded (due to fontsets), give up. We
16092 have to start a new redisplay since we need to re-adjust glyph
16094 if (fonts_changed_p
)
16095 goto need_larger_matrices
;
16097 /* If cursor did not appear assume that the middle of the window is
16098 in the first line of the window. Do it again with the next line.
16099 (Imagine a window of height 100, displaying two lines of height
16100 60. Moving back 50 from it->last_visible_y will end in the first
16102 if (w
->cursor
.vpos
< 0)
16104 if (!NILP (w
->window_end_valid
)
16105 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16107 clear_glyph_matrix (w
->desired_matrix
);
16108 move_it_by_lines (&it
, 1);
16109 try_window (window
, it
.current
.pos
, 0);
16111 else if (PT
< IT_CHARPOS (it
))
16113 clear_glyph_matrix (w
->desired_matrix
);
16114 move_it_by_lines (&it
, -1);
16115 try_window (window
, it
.current
.pos
, 0);
16119 /* Not much we can do about it. */
16123 /* Consider the following case: Window starts at BEGV, there is
16124 invisible, intangible text at BEGV, so that display starts at
16125 some point START > BEGV. It can happen that we are called with
16126 PT somewhere between BEGV and START. Try to handle that case. */
16127 if (w
->cursor
.vpos
< 0)
16129 struct glyph_row
*row
= w
->current_matrix
->rows
;
16130 if (row
->mode_line_p
)
16132 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16135 if (!cursor_row_fully_visible_p (w
, 0, 0))
16137 /* If vscroll is enabled, disable it and try again. */
16141 clear_glyph_matrix (w
->desired_matrix
);
16145 /* Users who set scroll-conservatively to a large number want
16146 point just above/below the scroll margin. If we ended up
16147 with point's row partially visible, move the window start to
16148 make that row fully visible and out of the margin. */
16149 if (scroll_conservatively
> SCROLL_LIMIT
)
16153 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16155 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16157 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16158 clear_glyph_matrix (w
->desired_matrix
);
16159 if (1 == try_window (window
, it
.current
.pos
,
16160 TRY_WINDOW_CHECK_MARGINS
))
16164 /* If centering point failed to make the whole line visible,
16165 put point at the top instead. That has to make the whole line
16166 visible, if it can be done. */
16167 if (centering_position
== 0)
16170 clear_glyph_matrix (w
->desired_matrix
);
16171 centering_position
= 0;
16177 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16178 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16179 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16181 /* Display the mode line, if we must. */
16182 if ((update_mode_line
16183 /* If window not full width, must redo its mode line
16184 if (a) the window to its side is being redone and
16185 (b) we do a frame-based redisplay. This is a consequence
16186 of how inverted lines are drawn in frame-based redisplay. */
16187 || (!just_this_one_p
16188 && !FRAME_WINDOW_P (f
)
16189 && !WINDOW_FULL_WIDTH_P (w
))
16190 /* Line number to display. */
16191 || INTEGERP (w
->base_line_pos
)
16192 /* Column number is displayed and different from the one displayed. */
16193 || (!NILP (w
->column_number_displayed
)
16194 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16195 /* This means that the window has a mode line. */
16196 && (WINDOW_WANTS_MODELINE_P (w
)
16197 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16199 display_mode_lines (w
);
16201 /* If mode line height has changed, arrange for a thorough
16202 immediate redisplay using the correct mode line height. */
16203 if (WINDOW_WANTS_MODELINE_P (w
)
16204 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16206 fonts_changed_p
= 1;
16207 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16208 = DESIRED_MODE_LINE_HEIGHT (w
);
16211 /* If header line height has changed, arrange for a thorough
16212 immediate redisplay using the correct header line height. */
16213 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16214 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16216 fonts_changed_p
= 1;
16217 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16218 = DESIRED_HEADER_LINE_HEIGHT (w
);
16221 if (fonts_changed_p
)
16222 goto need_larger_matrices
;
16225 if (!line_number_displayed
16226 && !BUFFERP (w
->base_line_pos
))
16228 wset_base_line_pos (w
, Qnil
);
16229 wset_base_line_number (w
, Qnil
);
16234 /* When we reach a frame's selected window, redo the frame's menu bar. */
16235 if (update_mode_line
16236 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16238 int redisplay_menu_p
= 0;
16240 if (FRAME_WINDOW_P (f
))
16242 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16243 || defined (HAVE_NS) || defined (USE_GTK)
16244 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16246 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16250 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16252 if (redisplay_menu_p
)
16253 display_menu_bar (w
);
16255 #ifdef HAVE_WINDOW_SYSTEM
16256 if (FRAME_WINDOW_P (f
))
16258 #if defined (USE_GTK) || defined (HAVE_NS)
16259 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16260 redisplay_tool_bar (f
);
16262 if (WINDOWP (f
->tool_bar_window
)
16263 && (FRAME_TOOL_BAR_LINES (f
) > 0
16264 || !NILP (Vauto_resize_tool_bars
))
16265 && redisplay_tool_bar (f
))
16266 ignore_mouse_drag_p
= 1;
16272 #ifdef HAVE_WINDOW_SYSTEM
16273 if (FRAME_WINDOW_P (f
)
16274 && update_window_fringes (w
, (just_this_one_p
16275 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16276 || w
->pseudo_window_p
)))
16280 if (draw_window_fringes (w
, 1))
16281 x_draw_vertical_border (w
);
16285 #endif /* HAVE_WINDOW_SYSTEM */
16287 /* We go to this label, with fonts_changed_p set,
16288 if it is necessary to try again using larger glyph matrices.
16289 We have to redeem the scroll bar even in this case,
16290 because the loop in redisplay_internal expects that. */
16291 need_larger_matrices
:
16293 finish_scroll_bars
:
16295 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16297 /* Set the thumb's position and size. */
16298 set_vertical_scroll_bar (w
);
16300 /* Note that we actually used the scroll bar attached to this
16301 window, so it shouldn't be deleted at the end of redisplay. */
16302 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16303 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16306 /* Restore current_buffer and value of point in it. The window
16307 update may have changed the buffer, so first make sure `opoint'
16308 is still valid (Bug#6177). */
16309 if (CHARPOS (opoint
) < BEGV
)
16310 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16311 else if (CHARPOS (opoint
) > ZV
)
16312 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16314 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16316 set_buffer_internal_1 (old
);
16317 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16318 shorter. This can be caused by log truncation in *Messages*. */
16319 if (CHARPOS (lpoint
) <= ZV
)
16320 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16322 unbind_to (count
, Qnil
);
16326 /* Build the complete desired matrix of WINDOW with a window start
16327 buffer position POS.
16329 Value is 1 if successful. It is zero if fonts were loaded during
16330 redisplay which makes re-adjusting glyph matrices necessary, and -1
16331 if point would appear in the scroll margins.
16332 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16333 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16337 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16339 struct window
*w
= XWINDOW (window
);
16341 struct glyph_row
*last_text_row
= NULL
;
16342 struct frame
*f
= XFRAME (w
->frame
);
16344 /* Make POS the new window start. */
16345 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16347 /* Mark cursor position as unknown. No overlay arrow seen. */
16348 w
->cursor
.vpos
= -1;
16349 overlay_arrow_seen
= 0;
16351 /* Initialize iterator and info to start at POS. */
16352 start_display (&it
, w
, pos
);
16356 /* Display all lines of W. */
16357 while (it
.current_y
< it
.last_visible_y
)
16359 if (display_line (&it
))
16360 last_text_row
= it
.glyph_row
- 1;
16361 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16364 #ifdef HAVE_XWIDGETS_xxx
16365 //currently this is needed to detect xwidget movement reliably. or probably not.
16366 printf("try_window\n");
16370 /* Don't let the cursor end in the scroll margins. */
16371 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16372 && !MINI_WINDOW_P (w
))
16374 int this_scroll_margin
;
16376 if (scroll_margin
> 0)
16378 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16379 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16382 this_scroll_margin
= 0;
16384 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16385 && w
->cursor
.y
< this_scroll_margin
16386 && CHARPOS (pos
) > BEGV
16387 && IT_CHARPOS (it
) < ZV
)
16388 /* rms: considering make_cursor_line_fully_visible_p here
16389 seems to give wrong results. We don't want to recenter
16390 when the last line is partly visible, we want to allow
16391 that case to be handled in the usual way. */
16392 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16394 w
->cursor
.vpos
= -1;
16395 clear_glyph_matrix (w
->desired_matrix
);
16400 /* If bottom moved off end of frame, change mode line percentage. */
16401 if (XFASTINT (w
->window_end_pos
) <= 0
16402 && Z
!= IT_CHARPOS (it
))
16403 w
->update_mode_line
= 1;
16405 /* Set window_end_pos to the offset of the last character displayed
16406 on the window from the end of current_buffer. Set
16407 window_end_vpos to its row number. */
16410 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16411 w
->window_end_bytepos
16412 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16413 wset_window_end_pos
16414 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16415 wset_window_end_vpos
16416 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16418 (MATRIX_ROW (w
->desired_matrix
,
16419 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16423 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16424 wset_window_end_pos (w
, make_number (Z
- ZV
));
16425 wset_window_end_vpos (w
, make_number (0));
16428 /* But that is not valid info until redisplay finishes. */
16429 wset_window_end_valid (w
, Qnil
);
16435 /************************************************************************
16436 Window redisplay reusing current matrix when buffer has not changed
16437 ************************************************************************/
16439 /* Try redisplay of window W showing an unchanged buffer with a
16440 different window start than the last time it was displayed by
16441 reusing its current matrix. Value is non-zero if successful.
16442 W->start is the new window start. */
16445 try_window_reusing_current_matrix (struct window
*w
)
16447 struct frame
*f
= XFRAME (w
->frame
);
16448 struct glyph_row
*bottom_row
;
16451 struct text_pos start
, new_start
;
16452 int nrows_scrolled
, i
;
16453 struct glyph_row
*last_text_row
;
16454 struct glyph_row
*last_reused_text_row
;
16455 struct glyph_row
*start_row
;
16456 int start_vpos
, min_y
, max_y
;
16459 if (inhibit_try_window_reusing
)
16463 #ifdef HAVE_XWIDGETS_xxx
16464 //currently this is needed to detect xwidget movement reliably. or probably not.
16465 printf("try_window_reusing_current_matrix\n");
16470 if (/* This function doesn't handle terminal frames. */
16471 !FRAME_WINDOW_P (f
)
16472 /* Don't try to reuse the display if windows have been split
16474 || windows_or_buffers_changed
16475 || cursor_type_changed
)
16478 /* Can't do this if region may have changed. */
16479 if (0 <= markpos_of_region ()
16480 || !NILP (w
->region_showing
)
16481 || !NILP (Vshow_trailing_whitespace
))
16484 /* If top-line visibility has changed, give up. */
16485 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16486 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16489 /* Give up if old or new display is scrolled vertically. We could
16490 make this function handle this, but right now it doesn't. */
16491 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16492 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16495 /* The variable new_start now holds the new window start. The old
16496 start `start' can be determined from the current matrix. */
16497 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16498 start
= start_row
->minpos
;
16499 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16501 /* Clear the desired matrix for the display below. */
16502 clear_glyph_matrix (w
->desired_matrix
);
16504 if (CHARPOS (new_start
) <= CHARPOS (start
))
16506 /* Don't use this method if the display starts with an ellipsis
16507 displayed for invisible text. It's not easy to handle that case
16508 below, and it's certainly not worth the effort since this is
16509 not a frequent case. */
16510 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16513 IF_DEBUG (debug_method_add (w
, "twu1"));
16515 /* Display up to a row that can be reused. The variable
16516 last_text_row is set to the last row displayed that displays
16517 text. Note that it.vpos == 0 if or if not there is a
16518 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16519 start_display (&it
, w
, new_start
);
16520 w
->cursor
.vpos
= -1;
16521 last_text_row
= last_reused_text_row
= NULL
;
16523 while (it
.current_y
< it
.last_visible_y
16524 && !fonts_changed_p
)
16526 /* If we have reached into the characters in the START row,
16527 that means the line boundaries have changed. So we
16528 can't start copying with the row START. Maybe it will
16529 work to start copying with the following row. */
16530 while (IT_CHARPOS (it
) > CHARPOS (start
))
16532 /* Advance to the next row as the "start". */
16534 start
= start_row
->minpos
;
16535 /* If there are no more rows to try, or just one, give up. */
16536 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16537 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16538 || CHARPOS (start
) == ZV
)
16540 clear_glyph_matrix (w
->desired_matrix
);
16544 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16546 /* If we have reached alignment, we can copy the rest of the
16548 if (IT_CHARPOS (it
) == CHARPOS (start
)
16549 /* Don't accept "alignment" inside a display vector,
16550 since start_row could have started in the middle of
16551 that same display vector (thus their character
16552 positions match), and we have no way of telling if
16553 that is the case. */
16554 && it
.current
.dpvec_index
< 0)
16557 if (display_line (&it
))
16558 last_text_row
= it
.glyph_row
- 1;
16562 /* A value of current_y < last_visible_y means that we stopped
16563 at the previous window start, which in turn means that we
16564 have at least one reusable row. */
16565 if (it
.current_y
< it
.last_visible_y
)
16567 struct glyph_row
*row
;
16569 /* IT.vpos always starts from 0; it counts text lines. */
16570 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16572 /* Find PT if not already found in the lines displayed. */
16573 if (w
->cursor
.vpos
< 0)
16575 int dy
= it
.current_y
- start_row
->y
;
16577 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16578 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16580 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16581 dy
, nrows_scrolled
);
16584 clear_glyph_matrix (w
->desired_matrix
);
16589 /* Scroll the display. Do it before the current matrix is
16590 changed. The problem here is that update has not yet
16591 run, i.e. part of the current matrix is not up to date.
16592 scroll_run_hook will clear the cursor, and use the
16593 current matrix to get the height of the row the cursor is
16595 run
.current_y
= start_row
->y
;
16596 run
.desired_y
= it
.current_y
;
16597 run
.height
= it
.last_visible_y
- it
.current_y
;
16599 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16602 FRAME_RIF (f
)->update_window_begin_hook (w
);
16603 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16604 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16605 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16609 /* Shift current matrix down by nrows_scrolled lines. */
16610 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16611 rotate_matrix (w
->current_matrix
,
16613 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16616 /* Disable lines that must be updated. */
16617 for (i
= 0; i
< nrows_scrolled
; ++i
)
16618 (start_row
+ i
)->enabled_p
= 0;
16620 /* Re-compute Y positions. */
16621 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16622 max_y
= it
.last_visible_y
;
16623 for (row
= start_row
+ nrows_scrolled
;
16627 row
->y
= it
.current_y
;
16628 row
->visible_height
= row
->height
;
16630 if (row
->y
< min_y
)
16631 row
->visible_height
-= min_y
- row
->y
;
16632 if (row
->y
+ row
->height
> max_y
)
16633 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16634 if (row
->fringe_bitmap_periodic_p
)
16635 row
->redraw_fringe_bitmaps_p
= 1;
16637 it
.current_y
+= row
->height
;
16639 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16640 last_reused_text_row
= row
;
16641 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16645 /* Disable lines in the current matrix which are now
16646 below the window. */
16647 for (++row
; row
< bottom_row
; ++row
)
16648 row
->enabled_p
= row
->mode_line_p
= 0;
16651 /* Update window_end_pos etc.; last_reused_text_row is the last
16652 reused row from the current matrix containing text, if any.
16653 The value of last_text_row is the last displayed line
16654 containing text. */
16655 if (last_reused_text_row
)
16657 w
->window_end_bytepos
16658 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16659 wset_window_end_pos
16661 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16662 wset_window_end_vpos
16663 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16664 w
->current_matrix
)));
16666 else if (last_text_row
)
16668 w
->window_end_bytepos
16669 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16670 wset_window_end_pos
16671 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16672 wset_window_end_vpos
16673 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16674 w
->desired_matrix
)));
16678 /* This window must be completely empty. */
16679 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16680 wset_window_end_pos (w
, make_number (Z
- ZV
));
16681 wset_window_end_vpos (w
, make_number (0));
16683 wset_window_end_valid (w
, Qnil
);
16685 /* Update hint: don't try scrolling again in update_window. */
16686 w
->desired_matrix
->no_scrolling_p
= 1;
16689 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16693 else if (CHARPOS (new_start
) > CHARPOS (start
))
16695 struct glyph_row
*pt_row
, *row
;
16696 struct glyph_row
*first_reusable_row
;
16697 struct glyph_row
*first_row_to_display
;
16699 int yb
= window_text_bottom_y (w
);
16701 /* Find the row starting at new_start, if there is one. Don't
16702 reuse a partially visible line at the end. */
16703 first_reusable_row
= start_row
;
16704 while (first_reusable_row
->enabled_p
16705 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16706 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16707 < CHARPOS (new_start
)))
16708 ++first_reusable_row
;
16710 /* Give up if there is no row to reuse. */
16711 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16712 || !first_reusable_row
->enabled_p
16713 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16714 != CHARPOS (new_start
)))
16717 /* We can reuse fully visible rows beginning with
16718 first_reusable_row to the end of the window. Set
16719 first_row_to_display to the first row that cannot be reused.
16720 Set pt_row to the row containing point, if there is any. */
16722 for (first_row_to_display
= first_reusable_row
;
16723 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16724 ++first_row_to_display
)
16726 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16727 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16728 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16729 && first_row_to_display
->ends_at_zv_p
16730 && pt_row
== NULL
)))
16731 pt_row
= first_row_to_display
;
16734 /* Start displaying at the start of first_row_to_display. */
16735 eassert (first_row_to_display
->y
< yb
);
16736 init_to_row_start (&it
, w
, first_row_to_display
);
16738 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16740 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16742 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16743 + WINDOW_HEADER_LINE_HEIGHT (w
));
16745 /* Display lines beginning with first_row_to_display in the
16746 desired matrix. Set last_text_row to the last row displayed
16747 that displays text. */
16748 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16749 if (pt_row
== NULL
)
16750 w
->cursor
.vpos
= -1;
16751 last_text_row
= NULL
;
16752 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16753 if (display_line (&it
))
16754 last_text_row
= it
.glyph_row
- 1;
16756 /* If point is in a reused row, adjust y and vpos of the cursor
16760 w
->cursor
.vpos
-= nrows_scrolled
;
16761 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16764 /* Give up if point isn't in a row displayed or reused. (This
16765 also handles the case where w->cursor.vpos < nrows_scrolled
16766 after the calls to display_line, which can happen with scroll
16767 margins. See bug#1295.) */
16768 if (w
->cursor
.vpos
< 0)
16770 clear_glyph_matrix (w
->desired_matrix
);
16774 /* Scroll the display. */
16775 run
.current_y
= first_reusable_row
->y
;
16776 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16777 run
.height
= it
.last_visible_y
- run
.current_y
;
16778 dy
= run
.current_y
- run
.desired_y
;
16783 FRAME_RIF (f
)->update_window_begin_hook (w
);
16784 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16785 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16786 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16790 /* Adjust Y positions of reused rows. */
16791 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16792 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16793 max_y
= it
.last_visible_y
;
16794 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16797 row
->visible_height
= row
->height
;
16798 if (row
->y
< min_y
)
16799 row
->visible_height
-= min_y
- row
->y
;
16800 if (row
->y
+ row
->height
> max_y
)
16801 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16802 if (row
->fringe_bitmap_periodic_p
)
16803 row
->redraw_fringe_bitmaps_p
= 1;
16806 /* Scroll the current matrix. */
16807 eassert (nrows_scrolled
> 0);
16808 rotate_matrix (w
->current_matrix
,
16810 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16813 /* Disable rows not reused. */
16814 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16815 row
->enabled_p
= 0;
16817 /* Point may have moved to a different line, so we cannot assume that
16818 the previous cursor position is valid; locate the correct row. */
16821 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16823 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16824 && !row
->ends_at_zv_p
;
16828 w
->cursor
.y
= row
->y
;
16830 if (row
< bottom_row
)
16832 /* Can't simply scan the row for point with
16833 bidi-reordered glyph rows. Let set_cursor_from_row
16834 figure out where to put the cursor, and if it fails,
16836 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16838 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16841 clear_glyph_matrix (w
->desired_matrix
);
16847 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16848 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16851 && (!BUFFERP (glyph
->object
)
16852 || glyph
->charpos
< PT
);
16856 w
->cursor
.x
+= glyph
->pixel_width
;
16862 /* Adjust window end. A null value of last_text_row means that
16863 the window end is in reused rows which in turn means that
16864 only its vpos can have changed. */
16867 w
->window_end_bytepos
16868 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16869 wset_window_end_pos
16870 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16871 wset_window_end_vpos
16872 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16873 w
->desired_matrix
)));
16877 wset_window_end_vpos
16878 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16881 wset_window_end_valid (w
, Qnil
);
16882 w
->desired_matrix
->no_scrolling_p
= 1;
16885 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16895 /************************************************************************
16896 Window redisplay reusing current matrix when buffer has changed
16897 ************************************************************************/
16899 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16900 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16901 ptrdiff_t *, ptrdiff_t *);
16902 static struct glyph_row
*
16903 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16904 struct glyph_row
*);
16907 /* Return the last row in MATRIX displaying text. If row START is
16908 non-null, start searching with that row. IT gives the dimensions
16909 of the display. Value is null if matrix is empty; otherwise it is
16910 a pointer to the row found. */
16912 static struct glyph_row
*
16913 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16914 struct glyph_row
*start
)
16916 struct glyph_row
*row
, *row_found
;
16918 /* Set row_found to the last row in IT->w's current matrix
16919 displaying text. The loop looks funny but think of partially
16922 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16923 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16925 eassert (row
->enabled_p
);
16927 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16936 /* Return the last row in the current matrix of W that is not affected
16937 by changes at the start of current_buffer that occurred since W's
16938 current matrix was built. Value is null if no such row exists.
16940 BEG_UNCHANGED us the number of characters unchanged at the start of
16941 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16942 first changed character in current_buffer. Characters at positions <
16943 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16944 when the current matrix was built. */
16946 static struct glyph_row
*
16947 find_last_unchanged_at_beg_row (struct window
*w
)
16949 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16950 struct glyph_row
*row
;
16951 struct glyph_row
*row_found
= NULL
;
16952 int yb
= window_text_bottom_y (w
);
16954 /* Find the last row displaying unchanged text. */
16955 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16956 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16957 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16960 if (/* If row ends before first_changed_pos, it is unchanged,
16961 except in some case. */
16962 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16963 /* When row ends in ZV and we write at ZV it is not
16965 && !row
->ends_at_zv_p
16966 /* When first_changed_pos is the end of a continued line,
16967 row is not unchanged because it may be no longer
16969 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16970 && (row
->continued_p
16971 || row
->exact_window_width_line_p
))
16972 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16973 needs to be recomputed, so don't consider this row as
16974 unchanged. This happens when the last line was
16975 bidi-reordered and was killed immediately before this
16976 redisplay cycle. In that case, ROW->end stores the
16977 buffer position of the first visual-order character of
16978 the killed text, which is now beyond ZV. */
16979 && CHARPOS (row
->end
.pos
) <= ZV
)
16982 /* Stop if last visible row. */
16983 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16991 /* Find the first glyph row in the current matrix of W that is not
16992 affected by changes at the end of current_buffer since the
16993 time W's current matrix was built.
16995 Return in *DELTA the number of chars by which buffer positions in
16996 unchanged text at the end of current_buffer must be adjusted.
16998 Return in *DELTA_BYTES the corresponding number of bytes.
17000 Value is null if no such row exists, i.e. all rows are affected by
17003 static struct glyph_row
*
17004 find_first_unchanged_at_end_row (struct window
*w
,
17005 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17007 struct glyph_row
*row
;
17008 struct glyph_row
*row_found
= NULL
;
17010 *delta
= *delta_bytes
= 0;
17012 /* Display must not have been paused, otherwise the current matrix
17013 is not up to date. */
17014 eassert (!NILP (w
->window_end_valid
));
17016 /* A value of window_end_pos >= END_UNCHANGED means that the window
17017 end is in the range of changed text. If so, there is no
17018 unchanged row at the end of W's current matrix. */
17019 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
17022 /* Set row to the last row in W's current matrix displaying text. */
17023 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17025 /* If matrix is entirely empty, no unchanged row exists. */
17026 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17028 /* The value of row is the last glyph row in the matrix having a
17029 meaningful buffer position in it. The end position of row
17030 corresponds to window_end_pos. This allows us to translate
17031 buffer positions in the current matrix to current buffer
17032 positions for characters not in changed text. */
17034 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17035 ptrdiff_t Z_BYTE_old
=
17036 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17037 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17038 struct glyph_row
*first_text_row
17039 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17041 *delta
= Z
- Z_old
;
17042 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17044 /* Set last_unchanged_pos to the buffer position of the last
17045 character in the buffer that has not been changed. Z is the
17046 index + 1 of the last character in current_buffer, i.e. by
17047 subtracting END_UNCHANGED we get the index of the last
17048 unchanged character, and we have to add BEG to get its buffer
17050 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17051 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17053 /* Search backward from ROW for a row displaying a line that
17054 starts at a minimum position >= last_unchanged_pos_old. */
17055 for (; row
> first_text_row
; --row
)
17057 /* This used to abort, but it can happen.
17058 It is ok to just stop the search instead here. KFS. */
17059 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17062 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17067 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17073 /* Make sure that glyph rows in the current matrix of window W
17074 reference the same glyph memory as corresponding rows in the
17075 frame's frame matrix. This function is called after scrolling W's
17076 current matrix on a terminal frame in try_window_id and
17077 try_window_reusing_current_matrix. */
17080 sync_frame_with_window_matrix_rows (struct window
*w
)
17082 struct frame
*f
= XFRAME (w
->frame
);
17083 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17085 /* Preconditions: W must be a leaf window and full-width. Its frame
17086 must have a frame matrix. */
17087 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17088 eassert (WINDOW_FULL_WIDTH_P (w
));
17089 eassert (!FRAME_WINDOW_P (f
));
17091 /* If W is a full-width window, glyph pointers in W's current matrix
17092 have, by definition, to be the same as glyph pointers in the
17093 corresponding frame matrix. Note that frame matrices have no
17094 marginal areas (see build_frame_matrix). */
17095 window_row
= w
->current_matrix
->rows
;
17096 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17097 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17098 while (window_row
< window_row_end
)
17100 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17101 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17103 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17104 frame_row
->glyphs
[TEXT_AREA
] = start
;
17105 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17106 frame_row
->glyphs
[LAST_AREA
] = end
;
17108 /* Disable frame rows whose corresponding window rows have
17109 been disabled in try_window_id. */
17110 if (!window_row
->enabled_p
)
17111 frame_row
->enabled_p
= 0;
17113 ++window_row
, ++frame_row
;
17118 /* Find the glyph row in window W containing CHARPOS. Consider all
17119 rows between START and END (not inclusive). END null means search
17120 all rows to the end of the display area of W. Value is the row
17121 containing CHARPOS or null. */
17124 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17125 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17127 struct glyph_row
*row
= start
;
17128 struct glyph_row
*best_row
= NULL
;
17129 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17132 /* If we happen to start on a header-line, skip that. */
17133 if (row
->mode_line_p
)
17136 if ((end
&& row
>= end
) || !row
->enabled_p
)
17139 last_y
= window_text_bottom_y (w
) - dy
;
17143 /* Give up if we have gone too far. */
17144 if (end
&& row
>= end
)
17146 /* This formerly returned if they were equal.
17147 I think that both quantities are of a "last plus one" type;
17148 if so, when they are equal, the row is within the screen. -- rms. */
17149 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17152 /* If it is in this row, return this row. */
17153 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17154 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17155 /* The end position of a row equals the start
17156 position of the next row. If CHARPOS is there, we
17157 would rather display it in the next line, except
17158 when this line ends in ZV. */
17159 && !row
->ends_at_zv_p
17160 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17161 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17165 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17166 || (!best_row
&& !row
->continued_p
))
17168 /* In bidi-reordered rows, there could be several rows
17169 occluding point, all of them belonging to the same
17170 continued line. We need to find the row which fits
17171 CHARPOS the best. */
17172 for (g
= row
->glyphs
[TEXT_AREA
];
17173 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17176 if (!STRINGP (g
->object
))
17178 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17180 mindif
= eabs (g
->charpos
- charpos
);
17182 /* Exact match always wins. */
17189 else if (best_row
&& !row
->continued_p
)
17196 /* Try to redisplay window W by reusing its existing display. W's
17197 current matrix must be up to date when this function is called,
17198 i.e. window_end_valid must not be nil.
17202 1 if display has been updated
17203 0 if otherwise unsuccessful
17204 -1 if redisplay with same window start is known not to succeed
17206 The following steps are performed:
17208 1. Find the last row in the current matrix of W that is not
17209 affected by changes at the start of current_buffer. If no such row
17212 2. Find the first row in W's current matrix that is not affected by
17213 changes at the end of current_buffer. Maybe there is no such row.
17215 3. Display lines beginning with the row + 1 found in step 1 to the
17216 row found in step 2 or, if step 2 didn't find a row, to the end of
17219 4. If cursor is not known to appear on the window, give up.
17221 5. If display stopped at the row found in step 2, scroll the
17222 display and current matrix as needed.
17224 6. Maybe display some lines at the end of W, if we must. This can
17225 happen under various circumstances, like a partially visible line
17226 becoming fully visible, or because newly displayed lines are displayed
17227 in smaller font sizes.
17229 7. Update W's window end information. */
17232 try_window_id (struct window
*w
)
17234 struct frame
*f
= XFRAME (w
->frame
);
17235 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17236 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17237 struct glyph_row
*last_unchanged_at_beg_row
;
17238 struct glyph_row
*first_unchanged_at_end_row
;
17239 struct glyph_row
*row
;
17240 struct glyph_row
*bottom_row
;
17243 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17245 struct text_pos start_pos
;
17247 int first_unchanged_at_end_vpos
= 0;
17248 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17249 struct text_pos start
;
17250 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17253 if (inhibit_try_window_id
)
17257 #ifdef HAVE_XWIDGETS_xxx
17258 //maybe needed for proper xwidget movement
17259 printf("try_window_id\n");
17264 /* This is handy for debugging. */
17266 #define GIVE_UP(X) \
17268 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17272 #define GIVE_UP(X) return 0
17275 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17277 /* Don't use this for mini-windows because these can show
17278 messages and mini-buffers, and we don't handle that here. */
17279 if (MINI_WINDOW_P (w
))
17282 /* This flag is used to prevent redisplay optimizations. */
17283 if (windows_or_buffers_changed
|| cursor_type_changed
)
17286 /* Verify that narrowing has not changed.
17287 Also verify that we were not told to prevent redisplay optimizations.
17288 It would be nice to further
17289 reduce the number of cases where this prevents try_window_id. */
17290 if (current_buffer
->clip_changed
17291 || current_buffer
->prevent_redisplay_optimizations_p
)
17294 /* Window must either use window-based redisplay or be full width. */
17295 if (!FRAME_WINDOW_P (f
)
17296 && (!FRAME_LINE_INS_DEL_OK (f
)
17297 || !WINDOW_FULL_WIDTH_P (w
)))
17300 /* Give up if point is known NOT to appear in W. */
17301 if (PT
< CHARPOS (start
))
17304 /* Another way to prevent redisplay optimizations. */
17305 if (w
->last_modified
== 0)
17308 /* Verify that window is not hscrolled. */
17309 if (w
->hscroll
!= 0)
17312 /* Verify that display wasn't paused. */
17313 if (NILP (w
->window_end_valid
))
17316 /* Can't use this if highlighting a region because a cursor movement
17317 will do more than just set the cursor. */
17318 if (0 <= markpos_of_region ())
17321 /* Likewise if highlighting trailing whitespace. */
17322 if (!NILP (Vshow_trailing_whitespace
))
17325 /* Likewise if showing a region. */
17326 if (!NILP (w
->region_showing
))
17329 /* Can't use this if overlay arrow position and/or string have
17331 if (overlay_arrows_changed_p ())
17334 /* When word-wrap is on, adding a space to the first word of a
17335 wrapped line can change the wrap position, altering the line
17336 above it. It might be worthwhile to handle this more
17337 intelligently, but for now just redisplay from scratch. */
17338 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17341 /* Under bidi reordering, adding or deleting a character in the
17342 beginning of a paragraph, before the first strong directional
17343 character, can change the base direction of the paragraph (unless
17344 the buffer specifies a fixed paragraph direction), which will
17345 require to redisplay the whole paragraph. It might be worthwhile
17346 to find the paragraph limits and widen the range of redisplayed
17347 lines to that, but for now just give up this optimization and
17348 redisplay from scratch. */
17349 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17350 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17353 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17354 only if buffer has really changed. The reason is that the gap is
17355 initially at Z for freshly visited files. The code below would
17356 set end_unchanged to 0 in that case. */
17357 if (MODIFF
> SAVE_MODIFF
17358 /* This seems to happen sometimes after saving a buffer. */
17359 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17361 if (GPT
- BEG
< BEG_UNCHANGED
)
17362 BEG_UNCHANGED
= GPT
- BEG
;
17363 if (Z
- GPT
< END_UNCHANGED
)
17364 END_UNCHANGED
= Z
- GPT
;
17367 /* The position of the first and last character that has been changed. */
17368 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17369 last_changed_charpos
= Z
- END_UNCHANGED
;
17371 /* If window starts after a line end, and the last change is in
17372 front of that newline, then changes don't affect the display.
17373 This case happens with stealth-fontification. Note that although
17374 the display is unchanged, glyph positions in the matrix have to
17375 be adjusted, of course. */
17376 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17377 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17378 && ((last_changed_charpos
< CHARPOS (start
)
17379 && CHARPOS (start
) == BEGV
)
17380 || (last_changed_charpos
< CHARPOS (start
) - 1
17381 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17383 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17384 struct glyph_row
*r0
;
17386 /* Compute how many chars/bytes have been added to or removed
17387 from the buffer. */
17388 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17389 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17390 Z_delta
= Z
- Z_old
;
17391 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17393 /* Give up if PT is not in the window. Note that it already has
17394 been checked at the start of try_window_id that PT is not in
17395 front of the window start. */
17396 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17399 /* If window start is unchanged, we can reuse the whole matrix
17400 as is, after adjusting glyph positions. No need to compute
17401 the window end again, since its offset from Z hasn't changed. */
17402 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17403 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17404 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17405 /* PT must not be in a partially visible line. */
17406 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17407 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17409 /* Adjust positions in the glyph matrix. */
17410 if (Z_delta
|| Z_delta_bytes
)
17412 struct glyph_row
*r1
17413 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17414 increment_matrix_positions (w
->current_matrix
,
17415 MATRIX_ROW_VPOS (r0
, current_matrix
),
17416 MATRIX_ROW_VPOS (r1
, current_matrix
),
17417 Z_delta
, Z_delta_bytes
);
17420 /* Set the cursor. */
17421 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17423 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17430 /* Handle the case that changes are all below what is displayed in
17431 the window, and that PT is in the window. This shortcut cannot
17432 be taken if ZV is visible in the window, and text has been added
17433 there that is visible in the window. */
17434 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17435 /* ZV is not visible in the window, or there are no
17436 changes at ZV, actually. */
17437 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17438 || first_changed_charpos
== last_changed_charpos
))
17440 struct glyph_row
*r0
;
17442 /* Give up if PT is not in the window. Note that it already has
17443 been checked at the start of try_window_id that PT is not in
17444 front of the window start. */
17445 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17448 /* If window start is unchanged, we can reuse the whole matrix
17449 as is, without changing glyph positions since no text has
17450 been added/removed in front of the window end. */
17451 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17452 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17453 /* PT must not be in a partially visible line. */
17454 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17455 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17457 /* We have to compute the window end anew since text
17458 could have been added/removed after it. */
17459 wset_window_end_pos
17460 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17461 w
->window_end_bytepos
17462 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17464 /* Set the cursor. */
17465 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17467 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17474 /* Give up if window start is in the changed area.
17476 The condition used to read
17478 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17480 but why that was tested escapes me at the moment. */
17481 if (CHARPOS (start
) >= first_changed_charpos
17482 && CHARPOS (start
) <= last_changed_charpos
)
17485 /* Check that window start agrees with the start of the first glyph
17486 row in its current matrix. Check this after we know the window
17487 start is not in changed text, otherwise positions would not be
17489 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17490 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17493 /* Give up if the window ends in strings. Overlay strings
17494 at the end are difficult to handle, so don't try. */
17495 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17496 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17499 /* Compute the position at which we have to start displaying new
17500 lines. Some of the lines at the top of the window might be
17501 reusable because they are not displaying changed text. Find the
17502 last row in W's current matrix not affected by changes at the
17503 start of current_buffer. Value is null if changes start in the
17504 first line of window. */
17505 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17506 if (last_unchanged_at_beg_row
)
17508 /* Avoid starting to display in the middle of a character, a TAB
17509 for instance. This is easier than to set up the iterator
17510 exactly, and it's not a frequent case, so the additional
17511 effort wouldn't really pay off. */
17512 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17513 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17514 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17515 --last_unchanged_at_beg_row
;
17517 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17520 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17522 start_pos
= it
.current
.pos
;
17524 /* Start displaying new lines in the desired matrix at the same
17525 vpos we would use in the current matrix, i.e. below
17526 last_unchanged_at_beg_row. */
17527 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17529 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17530 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17532 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17536 /* There are no reusable lines at the start of the window.
17537 Start displaying in the first text line. */
17538 start_display (&it
, w
, start
);
17539 it
.vpos
= it
.first_vpos
;
17540 start_pos
= it
.current
.pos
;
17543 /* Find the first row that is not affected by changes at the end of
17544 the buffer. Value will be null if there is no unchanged row, in
17545 which case we must redisplay to the end of the window. delta
17546 will be set to the value by which buffer positions beginning with
17547 first_unchanged_at_end_row have to be adjusted due to text
17549 first_unchanged_at_end_row
17550 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17551 IF_DEBUG (debug_delta
= delta
);
17552 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17554 /* Set stop_pos to the buffer position up to which we will have to
17555 display new lines. If first_unchanged_at_end_row != NULL, this
17556 is the buffer position of the start of the line displayed in that
17557 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17558 that we don't stop at a buffer position. */
17560 if (first_unchanged_at_end_row
)
17562 eassert (last_unchanged_at_beg_row
== NULL
17563 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17565 /* If this is a continuation line, move forward to the next one
17566 that isn't. Changes in lines above affect this line.
17567 Caution: this may move first_unchanged_at_end_row to a row
17568 not displaying text. */
17569 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17570 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17571 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17572 < it
.last_visible_y
))
17573 ++first_unchanged_at_end_row
;
17575 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17576 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17577 >= it
.last_visible_y
))
17578 first_unchanged_at_end_row
= NULL
;
17581 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17583 first_unchanged_at_end_vpos
17584 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17585 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17588 else if (last_unchanged_at_beg_row
== NULL
)
17594 /* Either there is no unchanged row at the end, or the one we have
17595 now displays text. This is a necessary condition for the window
17596 end pos calculation at the end of this function. */
17597 eassert (first_unchanged_at_end_row
== NULL
17598 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17600 debug_last_unchanged_at_beg_vpos
17601 = (last_unchanged_at_beg_row
17602 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17604 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17606 #endif /* GLYPH_DEBUG */
17609 /* Display new lines. Set last_text_row to the last new line
17610 displayed which has text on it, i.e. might end up as being the
17611 line where the window_end_vpos is. */
17612 w
->cursor
.vpos
= -1;
17613 last_text_row
= NULL
;
17614 overlay_arrow_seen
= 0;
17615 while (it
.current_y
< it
.last_visible_y
17616 && !fonts_changed_p
17617 && (first_unchanged_at_end_row
== NULL
17618 || IT_CHARPOS (it
) < stop_pos
))
17620 if (display_line (&it
))
17621 last_text_row
= it
.glyph_row
- 1;
17624 if (fonts_changed_p
)
17628 /* Compute differences in buffer positions, y-positions etc. for
17629 lines reused at the bottom of the window. Compute what we can
17631 if (first_unchanged_at_end_row
17632 /* No lines reused because we displayed everything up to the
17633 bottom of the window. */
17634 && it
.current_y
< it
.last_visible_y
)
17637 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17639 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17640 run
.current_y
= first_unchanged_at_end_row
->y
;
17641 run
.desired_y
= run
.current_y
+ dy
;
17642 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17646 delta
= delta_bytes
= dvpos
= dy
17647 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17648 first_unchanged_at_end_row
= NULL
;
17650 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17653 /* Find the cursor if not already found. We have to decide whether
17654 PT will appear on this window (it sometimes doesn't, but this is
17655 not a very frequent case.) This decision has to be made before
17656 the current matrix is altered. A value of cursor.vpos < 0 means
17657 that PT is either in one of the lines beginning at
17658 first_unchanged_at_end_row or below the window. Don't care for
17659 lines that might be displayed later at the window end; as
17660 mentioned, this is not a frequent case. */
17661 if (w
->cursor
.vpos
< 0)
17663 /* Cursor in unchanged rows at the top? */
17664 if (PT
< CHARPOS (start_pos
)
17665 && last_unchanged_at_beg_row
)
17667 row
= row_containing_pos (w
, PT
,
17668 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17669 last_unchanged_at_beg_row
+ 1, 0);
17671 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17674 /* Start from first_unchanged_at_end_row looking for PT. */
17675 else if (first_unchanged_at_end_row
)
17677 row
= row_containing_pos (w
, PT
- delta
,
17678 first_unchanged_at_end_row
, NULL
, 0);
17680 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17681 delta_bytes
, dy
, dvpos
);
17684 /* Give up if cursor was not found. */
17685 if (w
->cursor
.vpos
< 0)
17687 clear_glyph_matrix (w
->desired_matrix
);
17692 /* Don't let the cursor end in the scroll margins. */
17694 int this_scroll_margin
, cursor_height
;
17696 this_scroll_margin
=
17697 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17698 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17699 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17701 if ((w
->cursor
.y
< this_scroll_margin
17702 && CHARPOS (start
) > BEGV
)
17703 /* Old redisplay didn't take scroll margin into account at the bottom,
17704 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17705 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17706 ? cursor_height
+ this_scroll_margin
17707 : 1)) > it
.last_visible_y
)
17709 w
->cursor
.vpos
= -1;
17710 clear_glyph_matrix (w
->desired_matrix
);
17715 /* Scroll the display. Do it before changing the current matrix so
17716 that xterm.c doesn't get confused about where the cursor glyph is
17718 if (dy
&& run
.height
)
17722 if (FRAME_WINDOW_P (f
))
17724 FRAME_RIF (f
)->update_window_begin_hook (w
);
17725 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17726 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17727 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17731 /* Terminal frame. In this case, dvpos gives the number of
17732 lines to scroll by; dvpos < 0 means scroll up. */
17734 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17735 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17736 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17737 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17738 + window_internal_height (w
));
17740 #if defined (HAVE_GPM) || defined (MSDOS)
17741 x_clear_window_mouse_face (w
);
17743 /* Perform the operation on the screen. */
17746 /* Scroll last_unchanged_at_beg_row to the end of the
17747 window down dvpos lines. */
17748 set_terminal_window (f
, end
);
17750 /* On dumb terminals delete dvpos lines at the end
17751 before inserting dvpos empty lines. */
17752 if (!FRAME_SCROLL_REGION_OK (f
))
17753 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17755 /* Insert dvpos empty lines in front of
17756 last_unchanged_at_beg_row. */
17757 ins_del_lines (f
, from
, dvpos
);
17759 else if (dvpos
< 0)
17761 /* Scroll up last_unchanged_at_beg_vpos to the end of
17762 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17763 set_terminal_window (f
, end
);
17765 /* Delete dvpos lines in front of
17766 last_unchanged_at_beg_vpos. ins_del_lines will set
17767 the cursor to the given vpos and emit |dvpos| delete
17769 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17771 /* On a dumb terminal insert dvpos empty lines at the
17773 if (!FRAME_SCROLL_REGION_OK (f
))
17774 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17777 set_terminal_window (f
, 0);
17783 /* Shift reused rows of the current matrix to the right position.
17784 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17786 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17787 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17790 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17791 bottom_vpos
, dvpos
);
17792 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17795 else if (dvpos
> 0)
17797 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17798 bottom_vpos
, dvpos
);
17799 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17800 first_unchanged_at_end_vpos
+ dvpos
);
17803 /* For frame-based redisplay, make sure that current frame and window
17804 matrix are in sync with respect to glyph memory. */
17805 if (!FRAME_WINDOW_P (f
))
17806 sync_frame_with_window_matrix_rows (w
);
17808 /* Adjust buffer positions in reused rows. */
17809 if (delta
|| delta_bytes
)
17810 increment_matrix_positions (current_matrix
,
17811 first_unchanged_at_end_vpos
+ dvpos
,
17812 bottom_vpos
, delta
, delta_bytes
);
17814 /* Adjust Y positions. */
17816 shift_glyph_matrix (w
, current_matrix
,
17817 first_unchanged_at_end_vpos
+ dvpos
,
17820 if (first_unchanged_at_end_row
)
17822 first_unchanged_at_end_row
+= dvpos
;
17823 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17824 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17825 first_unchanged_at_end_row
= NULL
;
17828 /* If scrolling up, there may be some lines to display at the end of
17830 last_text_row_at_end
= NULL
;
17833 /* Scrolling up can leave for example a partially visible line
17834 at the end of the window to be redisplayed. */
17835 /* Set last_row to the glyph row in the current matrix where the
17836 window end line is found. It has been moved up or down in
17837 the matrix by dvpos. */
17838 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17839 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17841 /* If last_row is the window end line, it should display text. */
17842 eassert (last_row
->displays_text_p
);
17844 /* If window end line was partially visible before, begin
17845 displaying at that line. Otherwise begin displaying with the
17846 line following it. */
17847 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17849 init_to_row_start (&it
, w
, last_row
);
17850 it
.vpos
= last_vpos
;
17851 it
.current_y
= last_row
->y
;
17855 init_to_row_end (&it
, w
, last_row
);
17856 it
.vpos
= 1 + last_vpos
;
17857 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17861 /* We may start in a continuation line. If so, we have to
17862 get the right continuation_lines_width and current_x. */
17863 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17864 it
.hpos
= it
.current_x
= 0;
17866 /* Display the rest of the lines at the window end. */
17867 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17868 while (it
.current_y
< it
.last_visible_y
17869 && !fonts_changed_p
)
17871 /* Is it always sure that the display agrees with lines in
17872 the current matrix? I don't think so, so we mark rows
17873 displayed invalid in the current matrix by setting their
17874 enabled_p flag to zero. */
17875 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17876 if (display_line (&it
))
17877 last_text_row_at_end
= it
.glyph_row
- 1;
17881 /* Update window_end_pos and window_end_vpos. */
17882 if (first_unchanged_at_end_row
17883 && !last_text_row_at_end
)
17885 /* Window end line if one of the preserved rows from the current
17886 matrix. Set row to the last row displaying text in current
17887 matrix starting at first_unchanged_at_end_row, after
17889 eassert (first_unchanged_at_end_row
->displays_text_p
);
17890 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17891 first_unchanged_at_end_row
);
17892 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17894 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17895 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17896 wset_window_end_vpos
17897 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17898 eassert (w
->window_end_bytepos
>= 0);
17899 IF_DEBUG (debug_method_add (w
, "A"));
17901 else if (last_text_row_at_end
)
17903 wset_window_end_pos
17904 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17905 w
->window_end_bytepos
17906 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17907 wset_window_end_vpos
17908 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17910 eassert (w
->window_end_bytepos
>= 0);
17911 IF_DEBUG (debug_method_add (w
, "B"));
17913 else if (last_text_row
)
17915 /* We have displayed either to the end of the window or at the
17916 end of the window, i.e. the last row with text is to be found
17917 in the desired matrix. */
17918 wset_window_end_pos
17919 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17920 w
->window_end_bytepos
17921 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17922 wset_window_end_vpos
17923 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17924 eassert (w
->window_end_bytepos
>= 0);
17926 else if (first_unchanged_at_end_row
== NULL
17927 && last_text_row
== NULL
17928 && last_text_row_at_end
== NULL
)
17930 /* Displayed to end of window, but no line containing text was
17931 displayed. Lines were deleted at the end of the window. */
17932 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17933 int vpos
= XFASTINT (w
->window_end_vpos
);
17934 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17935 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17938 row
== NULL
&& vpos
>= first_vpos
;
17939 --vpos
, --current_row
, --desired_row
)
17941 if (desired_row
->enabled_p
)
17943 if (desired_row
->displays_text_p
)
17946 else if (current_row
->displays_text_p
)
17950 eassert (row
!= NULL
);
17951 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17952 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17953 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17954 eassert (w
->window_end_bytepos
>= 0);
17955 IF_DEBUG (debug_method_add (w
, "C"));
17960 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17961 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17963 /* Record that display has not been completed. */
17964 wset_window_end_valid (w
, Qnil
);
17965 w
->desired_matrix
->no_scrolling_p
= 1;
17973 /***********************************************************************
17974 More debugging support
17975 ***********************************************************************/
17979 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17980 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17981 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17984 /* Dump the contents of glyph matrix MATRIX on stderr.
17986 GLYPHS 0 means don't show glyph contents.
17987 GLYPHS 1 means show glyphs in short form
17988 GLYPHS > 1 means show glyphs in long form. */
17991 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17994 for (i
= 0; i
< matrix
->nrows
; ++i
)
17995 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17999 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18000 the glyph row and area where the glyph comes from. */
18003 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18005 if (glyph
->type
== CHAR_GLYPH
)
18008 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18009 glyph
- row
->glyphs
[TEXT_AREA
],
18012 (BUFFERP (glyph
->object
)
18014 : (STRINGP (glyph
->object
)
18017 glyph
->pixel_width
,
18019 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18023 glyph
->left_box_line_p
,
18024 glyph
->right_box_line_p
);
18026 else if (glyph
->type
== STRETCH_GLYPH
)
18029 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18030 glyph
- row
->glyphs
[TEXT_AREA
],
18033 (BUFFERP (glyph
->object
)
18035 : (STRINGP (glyph
->object
)
18038 glyph
->pixel_width
,
18042 glyph
->left_box_line_p
,
18043 glyph
->right_box_line_p
);
18045 else if (glyph
->type
== IMAGE_GLYPH
)
18048 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18049 glyph
- row
->glyphs
[TEXT_AREA
],
18052 (BUFFERP (glyph
->object
)
18054 : (STRINGP (glyph
->object
)
18057 glyph
->pixel_width
,
18061 glyph
->left_box_line_p
,
18062 glyph
->right_box_line_p
);
18064 else if (glyph
->type
== COMPOSITE_GLYPH
)
18067 " %5td %4c %6"pI
"d %c %3d 0x%05x",
18068 glyph
- row
->glyphs
[TEXT_AREA
],
18071 (BUFFERP (glyph
->object
)
18073 : (STRINGP (glyph
->object
)
18076 glyph
->pixel_width
,
18078 if (glyph
->u
.cmp
.automatic
)
18081 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18082 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18084 glyph
->left_box_line_p
,
18085 glyph
->right_box_line_p
);
18087 #ifdef HAVE_XWIDGETS
18088 else if (glyph
->type
== XWIDGET_GLYPH
)
18091 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18092 glyph
- row
->glyphs
[TEXT_AREA
],
18095 (BUFFERP (glyph
->object
)
18097 : (STRINGP (glyph
->object
)
18100 glyph
->pixel_width
,
18104 glyph
->left_box_line_p
,
18105 glyph
->right_box_line_p
);
18107 // printf("dump xwidget glyph\n");
18113 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18114 GLYPHS 0 means don't show glyph contents.
18115 GLYPHS 1 means show glyphs in short form
18116 GLYPHS > 1 means show glyphs in long form. */
18119 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18123 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18124 fprintf (stderr
, "======================================================================\n");
18126 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18127 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18129 MATRIX_ROW_START_CHARPOS (row
),
18130 MATRIX_ROW_END_CHARPOS (row
),
18131 row
->used
[TEXT_AREA
],
18132 row
->contains_overlapping_glyphs_p
,
18134 row
->truncated_on_left_p
,
18135 row
->truncated_on_right_p
,
18137 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18138 row
->displays_text_p
,
18141 row
->ends_in_middle_of_char_p
,
18142 row
->starts_in_middle_of_char_p
,
18148 row
->visible_height
,
18151 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18152 row
->end
.overlay_string_index
,
18153 row
->continuation_lines_width
);
18154 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18155 CHARPOS (row
->start
.string_pos
),
18156 CHARPOS (row
->end
.string_pos
));
18157 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18158 row
->end
.dpvec_index
);
18165 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18167 struct glyph
*glyph
= row
->glyphs
[area
];
18168 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18170 /* Glyph for a line end in text. */
18171 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18174 if (glyph
< glyph_end
)
18175 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18177 for (; glyph
< glyph_end
; ++glyph
)
18178 dump_glyph (row
, glyph
, area
);
18181 else if (glyphs
== 1)
18185 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18187 char *s
= alloca (row
->used
[area
] + 1);
18190 for (i
= 0; i
< row
->used
[area
]; ++i
)
18192 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18193 if (glyph
->type
== CHAR_GLYPH
18194 && glyph
->u
.ch
< 0x80
18195 && glyph
->u
.ch
>= ' ')
18196 s
[i
] = glyph
->u
.ch
;
18202 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18208 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18209 Sdump_glyph_matrix
, 0, 1, "p",
18210 doc
: /* Dump the current matrix of the selected window to stderr.
18211 Shows contents of glyph row structures. With non-nil
18212 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18213 glyphs in short form, otherwise show glyphs in long form. */)
18214 (Lisp_Object glyphs
)
18216 struct window
*w
= XWINDOW (selected_window
);
18217 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18219 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18220 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18221 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18222 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18223 fprintf (stderr
, "=============================================\n");
18224 dump_glyph_matrix (w
->current_matrix
,
18225 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18230 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18231 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18234 struct frame
*f
= XFRAME (selected_frame
);
18235 dump_glyph_matrix (f
->current_matrix
, 1);
18240 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18241 doc
: /* Dump glyph row ROW to stderr.
18242 GLYPH 0 means don't dump glyphs.
18243 GLYPH 1 means dump glyphs in short form.
18244 GLYPH > 1 or omitted means dump glyphs in long form. */)
18245 (Lisp_Object row
, Lisp_Object glyphs
)
18247 struct glyph_matrix
*matrix
;
18250 CHECK_NUMBER (row
);
18251 matrix
= XWINDOW (selected_window
)->current_matrix
;
18253 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18254 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18256 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18261 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18262 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18263 GLYPH 0 means don't dump glyphs.
18264 GLYPH 1 means dump glyphs in short form.
18265 GLYPH > 1 or omitted means dump glyphs in long form. */)
18266 (Lisp_Object row
, Lisp_Object glyphs
)
18268 struct frame
*sf
= SELECTED_FRAME ();
18269 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18272 CHECK_NUMBER (row
);
18274 if (vpos
>= 0 && vpos
< m
->nrows
)
18275 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18276 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18281 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18282 doc
: /* Toggle tracing of redisplay.
18283 With ARG, turn tracing on if and only if ARG is positive. */)
18287 trace_redisplay_p
= !trace_redisplay_p
;
18290 arg
= Fprefix_numeric_value (arg
);
18291 trace_redisplay_p
= XINT (arg
) > 0;
18298 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18299 doc
: /* Like `format', but print result to stderr.
18300 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18301 (ptrdiff_t nargs
, Lisp_Object
*args
)
18303 Lisp_Object s
= Fformat (nargs
, args
);
18304 fprintf (stderr
, "%s", SDATA (s
));
18308 #endif /* GLYPH_DEBUG */
18312 /***********************************************************************
18313 Building Desired Matrix Rows
18314 ***********************************************************************/
18316 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18317 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18319 static struct glyph_row
*
18320 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18322 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18323 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18324 struct buffer
*old
= current_buffer
;
18325 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18326 int arrow_len
= SCHARS (overlay_arrow_string
);
18327 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18328 const unsigned char *p
;
18331 int n_glyphs_before
;
18333 set_buffer_temp (buffer
);
18334 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18335 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18336 SET_TEXT_POS (it
.position
, 0, 0);
18338 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18340 while (p
< arrow_end
)
18342 Lisp_Object face
, ilisp
;
18344 /* Get the next character. */
18346 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18349 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18350 if (! ASCII_CHAR_P (it
.c
))
18351 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18355 /* Get its face. */
18356 ilisp
= make_number (p
- arrow_string
);
18357 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18358 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18360 /* Compute its width, get its glyphs. */
18361 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18362 SET_TEXT_POS (it
.position
, -1, -1);
18363 PRODUCE_GLYPHS (&it
);
18365 /* If this character doesn't fit any more in the line, we have
18366 to remove some glyphs. */
18367 if (it
.current_x
> it
.last_visible_x
)
18369 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18374 set_buffer_temp (old
);
18375 return it
.glyph_row
;
18379 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18380 glyphs to insert is determined by produce_special_glyphs. */
18383 insert_left_trunc_glyphs (struct it
*it
)
18385 struct it truncate_it
;
18386 struct glyph
*from
, *end
, *to
, *toend
;
18388 eassert (!FRAME_WINDOW_P (it
->f
)
18389 || (!it
->glyph_row
->reversed_p
18390 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18391 || (it
->glyph_row
->reversed_p
18392 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18394 /* Get the truncation glyphs. */
18396 truncate_it
.current_x
= 0;
18397 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18398 truncate_it
.glyph_row
= &scratch_glyph_row
;
18399 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18400 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18401 truncate_it
.object
= make_number (0);
18402 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18404 /* Overwrite glyphs from IT with truncation glyphs. */
18405 if (!it
->glyph_row
->reversed_p
)
18407 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18409 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18410 end
= from
+ tused
;
18411 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18412 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18413 if (FRAME_WINDOW_P (it
->f
))
18415 /* On GUI frames, when variable-size fonts are displayed,
18416 the truncation glyphs may need more pixels than the row's
18417 glyphs they overwrite. We overwrite more glyphs to free
18418 enough screen real estate, and enlarge the stretch glyph
18419 on the right (see display_line), if there is one, to
18420 preserve the screen position of the truncation glyphs on
18423 struct glyph
*g
= to
;
18426 /* The first glyph could be partially visible, in which case
18427 it->glyph_row->x will be negative. But we want the left
18428 truncation glyphs to be aligned at the left margin of the
18429 window, so we override the x coordinate at which the row
18431 it
->glyph_row
->x
= 0;
18432 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18434 w
+= g
->pixel_width
;
18437 if (g
- to
- tused
> 0)
18439 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18440 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18442 used
= it
->glyph_row
->used
[TEXT_AREA
];
18443 if (it
->glyph_row
->truncated_on_right_p
18444 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18445 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18448 int extra
= w
- it
->truncation_pixel_width
;
18450 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18457 /* There may be padding glyphs left over. Overwrite them too. */
18458 if (!FRAME_WINDOW_P (it
->f
))
18460 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18462 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18469 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18473 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18475 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18476 that back to front. */
18477 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18478 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18479 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18480 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18481 if (FRAME_WINDOW_P (it
->f
))
18484 struct glyph
*g
= to
;
18486 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18488 w
+= g
->pixel_width
;
18491 if (to
- g
- tused
> 0)
18493 if (it
->glyph_row
->truncated_on_right_p
18494 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18495 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18497 int extra
= w
- it
->truncation_pixel_width
;
18499 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18503 while (from
>= end
&& to
>= toend
)
18505 if (!FRAME_WINDOW_P (it
->f
))
18507 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18510 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18511 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18512 while (from
>= end
&& to
>= toend
)
18518 /* Need to free some room before prepending additional
18520 int move_by
= from
- end
+ 1;
18521 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18522 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18524 for ( ; g
>= g0
; g
--)
18526 while (from
>= end
)
18528 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18533 /* Compute the hash code for ROW. */
18535 row_hash (struct glyph_row
*row
)
18538 unsigned hashval
= 0;
18540 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18541 for (k
= 0; k
< row
->used
[area
]; ++k
)
18542 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18543 + row
->glyphs
[area
][k
].u
.val
18544 + row
->glyphs
[area
][k
].face_id
18545 + row
->glyphs
[area
][k
].padding_p
18546 + (row
->glyphs
[area
][k
].type
<< 2));
18551 /* Compute the pixel height and width of IT->glyph_row.
18553 Most of the time, ascent and height of a display line will be equal
18554 to the max_ascent and max_height values of the display iterator
18555 structure. This is not the case if
18557 1. We hit ZV without displaying anything. In this case, max_ascent
18558 and max_height will be zero.
18560 2. We have some glyphs that don't contribute to the line height.
18561 (The glyph row flag contributes_to_line_height_p is for future
18562 pixmap extensions).
18564 The first case is easily covered by using default values because in
18565 these cases, the line height does not really matter, except that it
18566 must not be zero. */
18569 compute_line_metrics (struct it
*it
)
18571 struct glyph_row
*row
= it
->glyph_row
;
18573 if (FRAME_WINDOW_P (it
->f
))
18575 int i
, min_y
, max_y
;
18577 /* The line may consist of one space only, that was added to
18578 place the cursor on it. If so, the row's height hasn't been
18580 if (row
->height
== 0)
18582 if (it
->max_ascent
+ it
->max_descent
== 0)
18583 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18584 row
->ascent
= it
->max_ascent
;
18585 row
->height
= it
->max_ascent
+ it
->max_descent
;
18586 row
->phys_ascent
= it
->max_phys_ascent
;
18587 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18588 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18591 /* Compute the width of this line. */
18592 row
->pixel_width
= row
->x
;
18593 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18594 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18596 eassert (row
->pixel_width
>= 0);
18597 eassert (row
->ascent
>= 0 && row
->height
> 0);
18599 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18600 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18602 /* If first line's physical ascent is larger than its logical
18603 ascent, use the physical ascent, and make the row taller.
18604 This makes accented characters fully visible. */
18605 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18606 && row
->phys_ascent
> row
->ascent
)
18608 row
->height
+= row
->phys_ascent
- row
->ascent
;
18609 row
->ascent
= row
->phys_ascent
;
18612 /* Compute how much of the line is visible. */
18613 row
->visible_height
= row
->height
;
18615 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18616 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18618 if (row
->y
< min_y
)
18619 row
->visible_height
-= min_y
- row
->y
;
18620 if (row
->y
+ row
->height
> max_y
)
18621 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18625 row
->pixel_width
= row
->used
[TEXT_AREA
];
18626 if (row
->continued_p
)
18627 row
->pixel_width
-= it
->continuation_pixel_width
;
18628 else if (row
->truncated_on_right_p
)
18629 row
->pixel_width
-= it
->truncation_pixel_width
;
18630 row
->ascent
= row
->phys_ascent
= 0;
18631 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18632 row
->extra_line_spacing
= 0;
18635 /* Compute a hash code for this row. */
18636 row
->hash
= row_hash (row
);
18638 it
->max_ascent
= it
->max_descent
= 0;
18639 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18643 /* Append one space to the glyph row of iterator IT if doing a
18644 window-based redisplay. The space has the same face as
18645 IT->face_id. Value is non-zero if a space was added.
18647 This function is called to make sure that there is always one glyph
18648 at the end of a glyph row that the cursor can be set on under
18649 window-systems. (If there weren't such a glyph we would not know
18650 how wide and tall a box cursor should be displayed).
18652 At the same time this space let's a nicely handle clearing to the
18653 end of the line if the row ends in italic text. */
18656 append_space_for_newline (struct it
*it
, int default_face_p
)
18658 if (FRAME_WINDOW_P (it
->f
))
18660 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18662 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18663 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18665 /* Save some values that must not be changed.
18666 Must save IT->c and IT->len because otherwise
18667 ITERATOR_AT_END_P wouldn't work anymore after
18668 append_space_for_newline has been called. */
18669 enum display_element_type saved_what
= it
->what
;
18670 int saved_c
= it
->c
, saved_len
= it
->len
;
18671 int saved_char_to_display
= it
->char_to_display
;
18672 int saved_x
= it
->current_x
;
18673 int saved_face_id
= it
->face_id
;
18674 int saved_box_end
= it
->end_of_box_run_p
;
18675 struct text_pos saved_pos
;
18676 Lisp_Object saved_object
;
18679 saved_object
= it
->object
;
18680 saved_pos
= it
->position
;
18682 it
->what
= IT_CHARACTER
;
18683 memset (&it
->position
, 0, sizeof it
->position
);
18684 it
->object
= make_number (0);
18685 it
->c
= it
->char_to_display
= ' ';
18688 /* If the default face was remapped, be sure to use the
18689 remapped face for the appended newline. */
18690 if (default_face_p
)
18691 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18692 else if (it
->face_before_selective_p
)
18693 it
->face_id
= it
->saved_face_id
;
18694 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18695 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18696 /* In R2L rows, we will prepend a stretch glyph that will
18697 have the end_of_box_run_p flag set for it, so there's no
18698 need for the appended newline glyph to have that flag
18700 if (it
->glyph_row
->reversed_p
18701 /* But if the appended newline glyph goes all the way to
18702 the end of the row, there will be no stretch glyph,
18703 so leave the box flag set. */
18704 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18705 it
->end_of_box_run_p
= 0;
18707 PRODUCE_GLYPHS (it
);
18709 it
->override_ascent
= -1;
18710 it
->constrain_row_ascent_descent_p
= 0;
18711 it
->current_x
= saved_x
;
18712 it
->object
= saved_object
;
18713 it
->position
= saved_pos
;
18714 it
->what
= saved_what
;
18715 it
->face_id
= saved_face_id
;
18716 it
->len
= saved_len
;
18718 it
->char_to_display
= saved_char_to_display
;
18719 it
->end_of_box_run_p
= saved_box_end
;
18728 /* Extend the face of the last glyph in the text area of IT->glyph_row
18729 to the end of the display line. Called from display_line. If the
18730 glyph row is empty, add a space glyph to it so that we know the
18731 face to draw. Set the glyph row flag fill_line_p. If the glyph
18732 row is R2L, prepend a stretch glyph to cover the empty space to the
18733 left of the leftmost glyph. */
18736 extend_face_to_end_of_line (struct it
*it
)
18738 struct face
*face
, *default_face
;
18739 struct frame
*f
= it
->f
;
18741 /* If line is already filled, do nothing. Non window-system frames
18742 get a grace of one more ``pixel'' because their characters are
18743 1-``pixel'' wide, so they hit the equality too early. This grace
18744 is needed only for R2L rows that are not continued, to produce
18745 one extra blank where we could display the cursor. */
18746 if (it
->current_x
>= it
->last_visible_x
18747 + (!FRAME_WINDOW_P (f
)
18748 && it
->glyph_row
->reversed_p
18749 && !it
->glyph_row
->continued_p
))
18752 /* The default face, possibly remapped. */
18753 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18755 /* Face extension extends the background and box of IT->face_id
18756 to the end of the line. If the background equals the background
18757 of the frame, we don't have to do anything. */
18758 if (it
->face_before_selective_p
)
18759 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18761 face
= FACE_FROM_ID (f
, it
->face_id
);
18763 if (FRAME_WINDOW_P (f
)
18764 && it
->glyph_row
->displays_text_p
18765 && face
->box
== FACE_NO_BOX
18766 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18768 && !it
->glyph_row
->reversed_p
)
18771 /* Set the glyph row flag indicating that the face of the last glyph
18772 in the text area has to be drawn to the end of the text area. */
18773 it
->glyph_row
->fill_line_p
= 1;
18775 /* If current character of IT is not ASCII, make sure we have the
18776 ASCII face. This will be automatically undone the next time
18777 get_next_display_element returns a multibyte character. Note
18778 that the character will always be single byte in unibyte
18780 if (!ASCII_CHAR_P (it
->c
))
18782 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18785 if (FRAME_WINDOW_P (f
))
18787 /* If the row is empty, add a space with the current face of IT,
18788 so that we know which face to draw. */
18789 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18791 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18792 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18793 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18795 #ifdef HAVE_WINDOW_SYSTEM
18796 if (it
->glyph_row
->reversed_p
)
18798 /* Prepend a stretch glyph to the row, such that the
18799 rightmost glyph will be drawn flushed all the way to the
18800 right margin of the window. The stretch glyph that will
18801 occupy the empty space, if any, to the left of the
18803 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18804 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18805 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18807 int row_width
, stretch_ascent
, stretch_width
;
18808 struct text_pos saved_pos
;
18809 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
18811 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18812 row_width
+= g
->pixel_width
;
18813 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18814 if (stretch_width
> 0)
18817 (((it
->ascent
+ it
->descent
)
18818 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18819 saved_pos
= it
->position
;
18820 memset (&it
->position
, 0, sizeof it
->position
);
18821 saved_avoid_cursor
= it
->avoid_cursor_p
;
18822 it
->avoid_cursor_p
= 1;
18823 saved_face_id
= it
->face_id
;
18824 saved_box_start
= it
->start_of_box_run_p
;
18825 /* The last row's stretch glyph should get the default
18826 face, to avoid painting the rest of the window with
18827 the region face, if the region ends at ZV. */
18828 if (it
->glyph_row
->ends_at_zv_p
)
18829 it
->face_id
= default_face
->id
;
18831 it
->face_id
= face
->id
;
18832 it
->start_of_box_run_p
= 0;
18833 append_stretch_glyph (it
, make_number (0), stretch_width
,
18834 it
->ascent
+ it
->descent
, stretch_ascent
);
18835 it
->position
= saved_pos
;
18836 it
->avoid_cursor_p
= saved_avoid_cursor
;
18837 it
->face_id
= saved_face_id
;
18838 it
->start_of_box_run_p
= saved_box_start
;
18841 #endif /* HAVE_WINDOW_SYSTEM */
18845 /* Save some values that must not be changed. */
18846 int saved_x
= it
->current_x
;
18847 struct text_pos saved_pos
;
18848 Lisp_Object saved_object
;
18849 enum display_element_type saved_what
= it
->what
;
18850 int saved_face_id
= it
->face_id
;
18852 saved_object
= it
->object
;
18853 saved_pos
= it
->position
;
18855 it
->what
= IT_CHARACTER
;
18856 memset (&it
->position
, 0, sizeof it
->position
);
18857 it
->object
= make_number (0);
18858 it
->c
= it
->char_to_display
= ' ';
18860 /* The last row's blank glyphs should get the default face, to
18861 avoid painting the rest of the window with the region face,
18862 if the region ends at ZV. */
18863 if (it
->glyph_row
->ends_at_zv_p
)
18864 it
->face_id
= default_face
->id
;
18866 it
->face_id
= face
->id
;
18868 PRODUCE_GLYPHS (it
);
18870 while (it
->current_x
<= it
->last_visible_x
)
18871 PRODUCE_GLYPHS (it
);
18873 /* Don't count these blanks really. It would let us insert a left
18874 truncation glyph below and make us set the cursor on them, maybe. */
18875 it
->current_x
= saved_x
;
18876 it
->object
= saved_object
;
18877 it
->position
= saved_pos
;
18878 it
->what
= saved_what
;
18879 it
->face_id
= saved_face_id
;
18884 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18885 trailing whitespace. */
18888 trailing_whitespace_p (ptrdiff_t charpos
)
18890 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18893 while (bytepos
< ZV_BYTE
18894 && (c
= FETCH_CHAR (bytepos
),
18895 c
== ' ' || c
== '\t'))
18898 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18900 if (bytepos
!= PT_BYTE
)
18907 /* Highlight trailing whitespace, if any, in ROW. */
18910 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18912 int used
= row
->used
[TEXT_AREA
];
18916 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18917 struct glyph
*glyph
= start
+ used
- 1;
18919 if (row
->reversed_p
)
18921 /* Right-to-left rows need to be processed in the opposite
18922 direction, so swap the edge pointers. */
18924 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18927 /* Skip over glyphs inserted to display the cursor at the
18928 end of a line, for extending the face of the last glyph
18929 to the end of the line on terminals, and for truncation
18930 and continuation glyphs. */
18931 if (!row
->reversed_p
)
18933 while (glyph
>= start
18934 && glyph
->type
== CHAR_GLYPH
18935 && INTEGERP (glyph
->object
))
18940 while (glyph
<= start
18941 && glyph
->type
== CHAR_GLYPH
18942 && INTEGERP (glyph
->object
))
18946 /* If last glyph is a space or stretch, and it's trailing
18947 whitespace, set the face of all trailing whitespace glyphs in
18948 IT->glyph_row to `trailing-whitespace'. */
18949 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18950 && BUFFERP (glyph
->object
)
18951 && (glyph
->type
== STRETCH_GLYPH
18952 || (glyph
->type
== CHAR_GLYPH
18953 && glyph
->u
.ch
== ' '))
18954 && trailing_whitespace_p (glyph
->charpos
))
18956 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18960 if (!row
->reversed_p
)
18962 while (glyph
>= start
18963 && BUFFERP (glyph
->object
)
18964 && (glyph
->type
== STRETCH_GLYPH
18965 || (glyph
->type
== CHAR_GLYPH
18966 && glyph
->u
.ch
== ' ')))
18967 (glyph
--)->face_id
= face_id
;
18971 while (glyph
<= start
18972 && BUFFERP (glyph
->object
)
18973 && (glyph
->type
== STRETCH_GLYPH
18974 || (glyph
->type
== CHAR_GLYPH
18975 && glyph
->u
.ch
== ' ')))
18976 (glyph
++)->face_id
= face_id
;
18983 /* Value is non-zero if glyph row ROW should be
18984 used to hold the cursor. */
18987 cursor_row_p (struct glyph_row
*row
)
18991 if (PT
== CHARPOS (row
->end
.pos
)
18992 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18994 /* Suppose the row ends on a string.
18995 Unless the row is continued, that means it ends on a newline
18996 in the string. If it's anything other than a display string
18997 (e.g., a before-string from an overlay), we don't want the
18998 cursor there. (This heuristic seems to give the optimal
18999 behavior for the various types of multi-line strings.)
19000 One exception: if the string has `cursor' property on one of
19001 its characters, we _do_ want the cursor there. */
19002 if (CHARPOS (row
->end
.string_pos
) >= 0)
19004 if (row
->continued_p
)
19008 /* Check for `display' property. */
19009 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19010 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19011 struct glyph
*glyph
;
19014 for (glyph
= end
; glyph
>= beg
; --glyph
)
19015 if (STRINGP (glyph
->object
))
19018 = Fget_char_property (make_number (PT
),
19022 && display_prop_string_p (prop
, glyph
->object
));
19023 /* If there's a `cursor' property on one of the
19024 string's characters, this row is a cursor row,
19025 even though this is not a display string. */
19028 Lisp_Object s
= glyph
->object
;
19030 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19032 ptrdiff_t gpos
= glyph
->charpos
;
19034 if (!NILP (Fget_char_property (make_number (gpos
),
19046 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19048 /* If the row ends in middle of a real character,
19049 and the line is continued, we want the cursor here.
19050 That's because CHARPOS (ROW->end.pos) would equal
19051 PT if PT is before the character. */
19052 if (!row
->ends_in_ellipsis_p
)
19053 result
= row
->continued_p
;
19055 /* If the row ends in an ellipsis, then
19056 CHARPOS (ROW->end.pos) will equal point after the
19057 invisible text. We want that position to be displayed
19058 after the ellipsis. */
19061 /* If the row ends at ZV, display the cursor at the end of that
19062 row instead of at the start of the row below. */
19063 else if (row
->ends_at_zv_p
)
19074 /* Push the property PROP so that it will be rendered at the current
19075 position in IT. Return 1 if PROP was successfully pushed, 0
19076 otherwise. Called from handle_line_prefix to handle the
19077 `line-prefix' and `wrap-prefix' properties. */
19080 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19082 struct text_pos pos
=
19083 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19085 eassert (it
->method
== GET_FROM_BUFFER
19086 || it
->method
== GET_FROM_DISPLAY_VECTOR
19087 || it
->method
== GET_FROM_STRING
);
19089 /* We need to save the current buffer/string position, so it will be
19090 restored by pop_it, because iterate_out_of_display_property
19091 depends on that being set correctly, but some situations leave
19092 it->position not yet set when this function is called. */
19093 push_it (it
, &pos
);
19095 if (STRINGP (prop
))
19097 if (SCHARS (prop
) == 0)
19104 it
->string_from_prefix_prop_p
= 1;
19105 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19106 it
->current
.overlay_string_index
= -1;
19107 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19108 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19109 it
->method
= GET_FROM_STRING
;
19110 it
->stop_charpos
= 0;
19112 it
->base_level_stop
= 0;
19114 /* Force paragraph direction to be that of the parent
19116 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19117 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19119 it
->paragraph_embedding
= L2R
;
19121 /* Set up the bidi iterator for this display string. */
19124 it
->bidi_it
.string
.lstring
= it
->string
;
19125 it
->bidi_it
.string
.s
= NULL
;
19126 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19127 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19128 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19129 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19130 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19133 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19135 it
->method
= GET_FROM_STRETCH
;
19138 #ifdef HAVE_WINDOW_SYSTEM
19139 else if (IMAGEP (prop
))
19141 it
->what
= IT_IMAGE
;
19142 it
->image_id
= lookup_image (it
->f
, prop
);
19143 it
->method
= GET_FROM_IMAGE
;
19145 #endif /* HAVE_WINDOW_SYSTEM */
19148 pop_it (it
); /* bogus display property, give up */
19155 /* Return the character-property PROP at the current position in IT. */
19158 get_it_property (struct it
*it
, Lisp_Object prop
)
19160 Lisp_Object position
;
19162 if (STRINGP (it
->object
))
19163 position
= make_number (IT_STRING_CHARPOS (*it
));
19164 else if (BUFFERP (it
->object
))
19165 position
= make_number (IT_CHARPOS (*it
));
19169 return Fget_char_property (position
, prop
, it
->object
);
19172 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19175 handle_line_prefix (struct it
*it
)
19177 Lisp_Object prefix
;
19179 if (it
->continuation_lines_width
> 0)
19181 prefix
= get_it_property (it
, Qwrap_prefix
);
19183 prefix
= Vwrap_prefix
;
19187 prefix
= get_it_property (it
, Qline_prefix
);
19189 prefix
= Vline_prefix
;
19191 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19193 /* If the prefix is wider than the window, and we try to wrap
19194 it, it would acquire its own wrap prefix, and so on till the
19195 iterator stack overflows. So, don't wrap the prefix. */
19196 it
->line_wrap
= TRUNCATE
;
19197 it
->avoid_cursor_p
= 1;
19203 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19204 only for R2L lines from display_line and display_string, when they
19205 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19206 the line/string needs to be continued on the next glyph row. */
19208 unproduce_glyphs (struct it
*it
, int n
)
19210 struct glyph
*glyph
, *end
;
19212 eassert (it
->glyph_row
);
19213 eassert (it
->glyph_row
->reversed_p
);
19214 eassert (it
->area
== TEXT_AREA
);
19215 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19217 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19218 n
= it
->glyph_row
->used
[TEXT_AREA
];
19219 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19220 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19221 for ( ; glyph
< end
; glyph
++)
19222 glyph
[-n
] = *glyph
;
19225 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19226 and ROW->maxpos. */
19228 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19229 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19230 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19232 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19233 lines' rows is implemented for bidi-reordered rows. */
19235 /* ROW->minpos is the value of min_pos, the minimal buffer position
19236 we have in ROW, or ROW->start.pos if that is smaller. */
19237 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19238 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19240 /* We didn't find buffer positions smaller than ROW->start, or
19241 didn't find _any_ valid buffer positions in any of the glyphs,
19242 so we must trust the iterator's computed positions. */
19243 row
->minpos
= row
->start
.pos
;
19246 max_pos
= CHARPOS (it
->current
.pos
);
19247 max_bpos
= BYTEPOS (it
->current
.pos
);
19250 /* Here are the various use-cases for ending the row, and the
19251 corresponding values for ROW->maxpos:
19253 Line ends in a newline from buffer eol_pos + 1
19254 Line is continued from buffer max_pos + 1
19255 Line is truncated on right it->current.pos
19256 Line ends in a newline from string max_pos + 1(*)
19257 (*) + 1 only when line ends in a forward scan
19258 Line is continued from string max_pos
19259 Line is continued from display vector max_pos
19260 Line is entirely from a string min_pos == max_pos
19261 Line is entirely from a display vector min_pos == max_pos
19262 Line that ends at ZV ZV
19264 If you discover other use-cases, please add them here as
19266 if (row
->ends_at_zv_p
)
19267 row
->maxpos
= it
->current
.pos
;
19268 else if (row
->used
[TEXT_AREA
])
19270 int seen_this_string
= 0;
19271 struct glyph_row
*r1
= row
- 1;
19273 /* Did we see the same display string on the previous row? */
19274 if (STRINGP (it
->object
)
19275 /* this is not the first row */
19276 && row
> it
->w
->desired_matrix
->rows
19277 /* previous row is not the header line */
19278 && !r1
->mode_line_p
19279 /* previous row also ends in a newline from a string */
19280 && r1
->ends_in_newline_from_string_p
)
19282 struct glyph
*start
, *end
;
19284 /* Search for the last glyph of the previous row that came
19285 from buffer or string. Depending on whether the row is
19286 L2R or R2L, we need to process it front to back or the
19287 other way round. */
19288 if (!r1
->reversed_p
)
19290 start
= r1
->glyphs
[TEXT_AREA
];
19291 end
= start
+ r1
->used
[TEXT_AREA
];
19292 /* Glyphs inserted by redisplay have an integer (zero)
19293 as their object. */
19295 && INTEGERP ((end
- 1)->object
)
19296 && (end
- 1)->charpos
<= 0)
19300 if (EQ ((end
- 1)->object
, it
->object
))
19301 seen_this_string
= 1;
19304 /* If all the glyphs of the previous row were inserted
19305 by redisplay, it means the previous row was
19306 produced from a single newline, which is only
19307 possible if that newline came from the same string
19308 as the one which produced this ROW. */
19309 seen_this_string
= 1;
19313 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19314 start
= end
+ r1
->used
[TEXT_AREA
];
19316 && INTEGERP ((end
+ 1)->object
)
19317 && (end
+ 1)->charpos
<= 0)
19321 if (EQ ((end
+ 1)->object
, it
->object
))
19322 seen_this_string
= 1;
19325 seen_this_string
= 1;
19328 /* Take note of each display string that covers a newline only
19329 once, the first time we see it. This is for when a display
19330 string includes more than one newline in it. */
19331 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19333 /* If we were scanning the buffer forward when we displayed
19334 the string, we want to account for at least one buffer
19335 position that belongs to this row (position covered by
19336 the display string), so that cursor positioning will
19337 consider this row as a candidate when point is at the end
19338 of the visual line represented by this row. This is not
19339 required when scanning back, because max_pos will already
19340 have a much larger value. */
19341 if (CHARPOS (row
->end
.pos
) > max_pos
)
19342 INC_BOTH (max_pos
, max_bpos
);
19343 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19345 else if (CHARPOS (it
->eol_pos
) > 0)
19346 SET_TEXT_POS (row
->maxpos
,
19347 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19348 else if (row
->continued_p
)
19350 /* If max_pos is different from IT's current position, it
19351 means IT->method does not belong to the display element
19352 at max_pos. However, it also means that the display
19353 element at max_pos was displayed in its entirety on this
19354 line, which is equivalent to saying that the next line
19355 starts at the next buffer position. */
19356 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19357 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19360 INC_BOTH (max_pos
, max_bpos
);
19361 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19364 else if (row
->truncated_on_right_p
)
19365 /* display_line already called reseat_at_next_visible_line_start,
19366 which puts the iterator at the beginning of the next line, in
19367 the logical order. */
19368 row
->maxpos
= it
->current
.pos
;
19369 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19370 /* A line that is entirely from a string/image/stretch... */
19371 row
->maxpos
= row
->minpos
;
19376 row
->maxpos
= it
->current
.pos
;
19379 /* Construct the glyph row IT->glyph_row in the desired matrix of
19380 IT->w from text at the current position of IT. See dispextern.h
19381 for an overview of struct it. Value is non-zero if
19382 IT->glyph_row displays text, as opposed to a line displaying ZV
19386 display_line (struct it
*it
)
19388 struct glyph_row
*row
= it
->glyph_row
;
19389 Lisp_Object overlay_arrow_string
;
19391 void *wrap_data
= NULL
;
19392 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19393 int wrap_row_used
= -1;
19394 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19395 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19396 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19397 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19398 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19400 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19401 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19403 /* We always start displaying at hpos zero even if hscrolled. */
19404 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19406 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19407 >= it
->w
->desired_matrix
->nrows
)
19409 it
->w
->nrows_scale_factor
++;
19410 fonts_changed_p
= 1;
19414 /* Is IT->w showing the region? */
19415 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19417 /* Clear the result glyph row and enable it. */
19418 prepare_desired_row (row
);
19420 row
->y
= it
->current_y
;
19421 row
->start
= it
->start
;
19422 row
->continuation_lines_width
= it
->continuation_lines_width
;
19423 row
->displays_text_p
= 1;
19424 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19425 it
->starts_in_middle_of_char_p
= 0;
19427 /* Arrange the overlays nicely for our purposes. Usually, we call
19428 display_line on only one line at a time, in which case this
19429 can't really hurt too much, or we call it on lines which appear
19430 one after another in the buffer, in which case all calls to
19431 recenter_overlay_lists but the first will be pretty cheap. */
19432 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19434 /* Move over display elements that are not visible because we are
19435 hscrolled. This may stop at an x-position < IT->first_visible_x
19436 if the first glyph is partially visible or if we hit a line end. */
19437 if (it
->current_x
< it
->first_visible_x
)
19439 enum move_it_result move_result
;
19441 this_line_min_pos
= row
->start
.pos
;
19442 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19443 MOVE_TO_POS
| MOVE_TO_X
);
19444 /* If we are under a large hscroll, move_it_in_display_line_to
19445 could hit the end of the line without reaching
19446 it->first_visible_x. Pretend that we did reach it. This is
19447 especially important on a TTY, where we will call
19448 extend_face_to_end_of_line, which needs to know how many
19449 blank glyphs to produce. */
19450 if (it
->current_x
< it
->first_visible_x
19451 && (move_result
== MOVE_NEWLINE_OR_CR
19452 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19453 it
->current_x
= it
->first_visible_x
;
19455 /* Record the smallest positions seen while we moved over
19456 display elements that are not visible. This is needed by
19457 redisplay_internal for optimizing the case where the cursor
19458 stays inside the same line. The rest of this function only
19459 considers positions that are actually displayed, so
19460 RECORD_MAX_MIN_POS will not otherwise record positions that
19461 are hscrolled to the left of the left edge of the window. */
19462 min_pos
= CHARPOS (this_line_min_pos
);
19463 min_bpos
= BYTEPOS (this_line_min_pos
);
19467 /* We only do this when not calling `move_it_in_display_line_to'
19468 above, because move_it_in_display_line_to calls
19469 handle_line_prefix itself. */
19470 handle_line_prefix (it
);
19473 /* Get the initial row height. This is either the height of the
19474 text hscrolled, if there is any, or zero. */
19475 row
->ascent
= it
->max_ascent
;
19476 row
->height
= it
->max_ascent
+ it
->max_descent
;
19477 row
->phys_ascent
= it
->max_phys_ascent
;
19478 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19479 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19481 /* Utility macro to record max and min buffer positions seen until now. */
19482 #define RECORD_MAX_MIN_POS(IT) \
19485 int composition_p = !STRINGP ((IT)->string) \
19486 && ((IT)->what == IT_COMPOSITION); \
19487 ptrdiff_t current_pos = \
19488 composition_p ? (IT)->cmp_it.charpos \
19489 : IT_CHARPOS (*(IT)); \
19490 ptrdiff_t current_bpos = \
19491 composition_p ? CHAR_TO_BYTE (current_pos) \
19492 : IT_BYTEPOS (*(IT)); \
19493 if (current_pos < min_pos) \
19495 min_pos = current_pos; \
19496 min_bpos = current_bpos; \
19498 if (IT_CHARPOS (*it) > max_pos) \
19500 max_pos = IT_CHARPOS (*it); \
19501 max_bpos = IT_BYTEPOS (*it); \
19506 /* Loop generating characters. The loop is left with IT on the next
19507 character to display. */
19510 int n_glyphs_before
, hpos_before
, x_before
;
19512 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19514 /* Retrieve the next thing to display. Value is zero if end of
19516 if (!get_next_display_element (it
))
19518 /* Maybe add a space at the end of this line that is used to
19519 display the cursor there under X. Set the charpos of the
19520 first glyph of blank lines not corresponding to any text
19522 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19523 row
->exact_window_width_line_p
= 1;
19524 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19525 || row
->used
[TEXT_AREA
] == 0)
19527 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19528 row
->displays_text_p
= 0;
19530 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19531 && (!MINI_WINDOW_P (it
->w
)
19532 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19533 row
->indicate_empty_line_p
= 1;
19536 it
->continuation_lines_width
= 0;
19537 row
->ends_at_zv_p
= 1;
19538 /* A row that displays right-to-left text must always have
19539 its last face extended all the way to the end of line,
19540 even if this row ends in ZV, because we still write to
19541 the screen left to right. We also need to extend the
19542 last face if the default face is remapped to some
19543 different face, otherwise the functions that clear
19544 portions of the screen will clear with the default face's
19545 background color. */
19546 if (row
->reversed_p
19547 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19548 extend_face_to_end_of_line (it
);
19552 /* Now, get the metrics of what we want to display. This also
19553 generates glyphs in `row' (which is IT->glyph_row). */
19554 n_glyphs_before
= row
->used
[TEXT_AREA
];
19557 /* Remember the line height so far in case the next element doesn't
19558 fit on the line. */
19559 if (it
->line_wrap
!= TRUNCATE
)
19561 ascent
= it
->max_ascent
;
19562 descent
= it
->max_descent
;
19563 phys_ascent
= it
->max_phys_ascent
;
19564 phys_descent
= it
->max_phys_descent
;
19566 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19568 if (IT_DISPLAYING_WHITESPACE (it
))
19572 SAVE_IT (wrap_it
, *it
, wrap_data
);
19574 wrap_row_used
= row
->used
[TEXT_AREA
];
19575 wrap_row_ascent
= row
->ascent
;
19576 wrap_row_height
= row
->height
;
19577 wrap_row_phys_ascent
= row
->phys_ascent
;
19578 wrap_row_phys_height
= row
->phys_height
;
19579 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19580 wrap_row_min_pos
= min_pos
;
19581 wrap_row_min_bpos
= min_bpos
;
19582 wrap_row_max_pos
= max_pos
;
19583 wrap_row_max_bpos
= max_bpos
;
19589 PRODUCE_GLYPHS (it
);
19591 /* If this display element was in marginal areas, continue with
19593 if (it
->area
!= TEXT_AREA
)
19595 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19596 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19597 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19598 row
->phys_height
= max (row
->phys_height
,
19599 it
->max_phys_ascent
+ it
->max_phys_descent
);
19600 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19601 it
->max_extra_line_spacing
);
19602 set_iterator_to_next (it
, 1);
19606 /* Does the display element fit on the line? If we truncate
19607 lines, we should draw past the right edge of the window. If
19608 we don't truncate, we want to stop so that we can display the
19609 continuation glyph before the right margin. If lines are
19610 continued, there are two possible strategies for characters
19611 resulting in more than 1 glyph (e.g. tabs): Display as many
19612 glyphs as possible in this line and leave the rest for the
19613 continuation line, or display the whole element in the next
19614 line. Original redisplay did the former, so we do it also. */
19615 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19616 hpos_before
= it
->hpos
;
19619 if (/* Not a newline. */
19621 /* Glyphs produced fit entirely in the line. */
19622 && it
->current_x
< it
->last_visible_x
)
19624 it
->hpos
+= nglyphs
;
19625 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19626 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19627 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19628 row
->phys_height
= max (row
->phys_height
,
19629 it
->max_phys_ascent
+ it
->max_phys_descent
);
19630 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19631 it
->max_extra_line_spacing
);
19632 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19633 row
->x
= x
- it
->first_visible_x
;
19634 /* Record the maximum and minimum buffer positions seen so
19635 far in glyphs that will be displayed by this row. */
19637 RECORD_MAX_MIN_POS (it
);
19642 struct glyph
*glyph
;
19644 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19646 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19647 new_x
= x
+ glyph
->pixel_width
;
19649 if (/* Lines are continued. */
19650 it
->line_wrap
!= TRUNCATE
19651 && (/* Glyph doesn't fit on the line. */
19652 new_x
> it
->last_visible_x
19653 /* Or it fits exactly on a window system frame. */
19654 || (new_x
== it
->last_visible_x
19655 && FRAME_WINDOW_P (it
->f
)
19656 && (row
->reversed_p
19657 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19658 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19660 /* End of a continued line. */
19663 || (new_x
== it
->last_visible_x
19664 && FRAME_WINDOW_P (it
->f
)
19665 && (row
->reversed_p
19666 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19667 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19669 /* Current glyph is the only one on the line or
19670 fits exactly on the line. We must continue
19671 the line because we can't draw the cursor
19672 after the glyph. */
19673 row
->continued_p
= 1;
19674 it
->current_x
= new_x
;
19675 it
->continuation_lines_width
+= new_x
;
19677 if (i
== nglyphs
- 1)
19679 /* If line-wrap is on, check if a previous
19680 wrap point was found. */
19681 if (wrap_row_used
> 0
19682 /* Even if there is a previous wrap
19683 point, continue the line here as
19684 usual, if (i) the previous character
19685 was a space or tab AND (ii) the
19686 current character is not. */
19688 || IT_DISPLAYING_WHITESPACE (it
)))
19691 /* Record the maximum and minimum buffer
19692 positions seen so far in glyphs that will be
19693 displayed by this row. */
19695 RECORD_MAX_MIN_POS (it
);
19696 set_iterator_to_next (it
, 1);
19697 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19699 if (!get_next_display_element (it
))
19701 row
->exact_window_width_line_p
= 1;
19702 it
->continuation_lines_width
= 0;
19703 row
->continued_p
= 0;
19704 row
->ends_at_zv_p
= 1;
19706 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19708 row
->continued_p
= 0;
19709 row
->exact_window_width_line_p
= 1;
19713 else if (it
->bidi_p
)
19714 RECORD_MAX_MIN_POS (it
);
19716 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19717 && !FRAME_WINDOW_P (it
->f
))
19719 /* A padding glyph that doesn't fit on this line.
19720 This means the whole character doesn't fit
19722 if (row
->reversed_p
)
19723 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19724 - n_glyphs_before
);
19725 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19727 /* Fill the rest of the row with continuation
19728 glyphs like in 20.x. */
19729 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19730 < row
->glyphs
[1 + TEXT_AREA
])
19731 produce_special_glyphs (it
, IT_CONTINUATION
);
19733 row
->continued_p
= 1;
19734 it
->current_x
= x_before
;
19735 it
->continuation_lines_width
+= x_before
;
19737 /* Restore the height to what it was before the
19738 element not fitting on the line. */
19739 it
->max_ascent
= ascent
;
19740 it
->max_descent
= descent
;
19741 it
->max_phys_ascent
= phys_ascent
;
19742 it
->max_phys_descent
= phys_descent
;
19744 else if (wrap_row_used
> 0)
19747 if (row
->reversed_p
)
19748 unproduce_glyphs (it
,
19749 row
->used
[TEXT_AREA
] - wrap_row_used
);
19750 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19751 it
->continuation_lines_width
+= wrap_x
;
19752 row
->used
[TEXT_AREA
] = wrap_row_used
;
19753 row
->ascent
= wrap_row_ascent
;
19754 row
->height
= wrap_row_height
;
19755 row
->phys_ascent
= wrap_row_phys_ascent
;
19756 row
->phys_height
= wrap_row_phys_height
;
19757 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19758 min_pos
= wrap_row_min_pos
;
19759 min_bpos
= wrap_row_min_bpos
;
19760 max_pos
= wrap_row_max_pos
;
19761 max_bpos
= wrap_row_max_bpos
;
19762 row
->continued_p
= 1;
19763 row
->ends_at_zv_p
= 0;
19764 row
->exact_window_width_line_p
= 0;
19765 it
->continuation_lines_width
+= x
;
19767 /* Make sure that a non-default face is extended
19768 up to the right margin of the window. */
19769 extend_face_to_end_of_line (it
);
19771 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19773 /* A TAB that extends past the right edge of the
19774 window. This produces a single glyph on
19775 window system frames. We leave the glyph in
19776 this row and let it fill the row, but don't
19777 consume the TAB. */
19778 if ((row
->reversed_p
19779 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19780 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19781 produce_special_glyphs (it
, IT_CONTINUATION
);
19782 it
->continuation_lines_width
+= it
->last_visible_x
;
19783 row
->ends_in_middle_of_char_p
= 1;
19784 row
->continued_p
= 1;
19785 glyph
->pixel_width
= it
->last_visible_x
- x
;
19786 it
->starts_in_middle_of_char_p
= 1;
19790 /* Something other than a TAB that draws past
19791 the right edge of the window. Restore
19792 positions to values before the element. */
19793 if (row
->reversed_p
)
19794 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19795 - (n_glyphs_before
+ i
));
19796 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19798 /* Display continuation glyphs. */
19799 it
->current_x
= x_before
;
19800 it
->continuation_lines_width
+= x
;
19801 if (!FRAME_WINDOW_P (it
->f
)
19802 || (row
->reversed_p
19803 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19804 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19805 produce_special_glyphs (it
, IT_CONTINUATION
);
19806 row
->continued_p
= 1;
19808 extend_face_to_end_of_line (it
);
19810 if (nglyphs
> 1 && i
> 0)
19812 row
->ends_in_middle_of_char_p
= 1;
19813 it
->starts_in_middle_of_char_p
= 1;
19816 /* Restore the height to what it was before the
19817 element not fitting on the line. */
19818 it
->max_ascent
= ascent
;
19819 it
->max_descent
= descent
;
19820 it
->max_phys_ascent
= phys_ascent
;
19821 it
->max_phys_descent
= phys_descent
;
19826 else if (new_x
> it
->first_visible_x
)
19828 /* Increment number of glyphs actually displayed. */
19831 /* Record the maximum and minimum buffer positions
19832 seen so far in glyphs that will be displayed by
19835 RECORD_MAX_MIN_POS (it
);
19837 if (x
< it
->first_visible_x
)
19838 /* Glyph is partially visible, i.e. row starts at
19839 negative X position. */
19840 row
->x
= x
- it
->first_visible_x
;
19844 /* Glyph is completely off the left margin of the
19845 window. This should not happen because of the
19846 move_it_in_display_line at the start of this
19847 function, unless the text display area of the
19848 window is empty. */
19849 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19852 /* Even if this display element produced no glyphs at all,
19853 we want to record its position. */
19854 if (it
->bidi_p
&& nglyphs
== 0)
19855 RECORD_MAX_MIN_POS (it
);
19857 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19858 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19859 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19860 row
->phys_height
= max (row
->phys_height
,
19861 it
->max_phys_ascent
+ it
->max_phys_descent
);
19862 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19863 it
->max_extra_line_spacing
);
19865 /* End of this display line if row is continued. */
19866 if (row
->continued_p
|| row
->ends_at_zv_p
)
19871 /* Is this a line end? If yes, we're also done, after making
19872 sure that a non-default face is extended up to the right
19873 margin of the window. */
19874 if (ITERATOR_AT_END_OF_LINE_P (it
))
19876 int used_before
= row
->used
[TEXT_AREA
];
19878 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19880 /* Add a space at the end of the line that is used to
19881 display the cursor there. */
19882 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19883 append_space_for_newline (it
, 0);
19885 /* Extend the face to the end of the line. */
19886 extend_face_to_end_of_line (it
);
19888 /* Make sure we have the position. */
19889 if (used_before
== 0)
19890 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19892 /* Record the position of the newline, for use in
19894 it
->eol_pos
= it
->current
.pos
;
19896 /* Consume the line end. This skips over invisible lines. */
19897 set_iterator_to_next (it
, 1);
19898 it
->continuation_lines_width
= 0;
19902 /* Proceed with next display element. Note that this skips
19903 over lines invisible because of selective display. */
19904 set_iterator_to_next (it
, 1);
19906 /* If we truncate lines, we are done when the last displayed
19907 glyphs reach past the right margin of the window. */
19908 if (it
->line_wrap
== TRUNCATE
19909 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19910 ? (it
->current_x
>= it
->last_visible_x
)
19911 : (it
->current_x
> it
->last_visible_x
)))
19913 /* Maybe add truncation glyphs. */
19914 if (!FRAME_WINDOW_P (it
->f
)
19915 || (row
->reversed_p
19916 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19917 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19921 if (!row
->reversed_p
)
19923 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19924 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19929 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19930 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19932 /* Remove any padding glyphs at the front of ROW, to
19933 make room for the truncation glyphs we will be
19934 adding below. The loop below always inserts at
19935 least one truncation glyph, so also remove the
19936 last glyph added to ROW. */
19937 unproduce_glyphs (it
, i
+ 1);
19938 /* Adjust i for the loop below. */
19939 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19942 it
->current_x
= x_before
;
19943 if (!FRAME_WINDOW_P (it
->f
))
19945 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19947 row
->used
[TEXT_AREA
] = i
;
19948 produce_special_glyphs (it
, IT_TRUNCATION
);
19953 row
->used
[TEXT_AREA
] = i
;
19954 produce_special_glyphs (it
, IT_TRUNCATION
);
19957 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19959 /* Don't truncate if we can overflow newline into fringe. */
19960 if (!get_next_display_element (it
))
19962 it
->continuation_lines_width
= 0;
19963 row
->ends_at_zv_p
= 1;
19964 row
->exact_window_width_line_p
= 1;
19967 if (ITERATOR_AT_END_OF_LINE_P (it
))
19969 row
->exact_window_width_line_p
= 1;
19970 goto at_end_of_line
;
19972 it
->current_x
= x_before
;
19975 row
->truncated_on_right_p
= 1;
19976 it
->continuation_lines_width
= 0;
19977 reseat_at_next_visible_line_start (it
, 0);
19978 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19979 it
->hpos
= hpos_before
;
19985 bidi_unshelve_cache (wrap_data
, 1);
19987 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19988 at the left window margin. */
19989 if (it
->first_visible_x
19990 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19992 if (!FRAME_WINDOW_P (it
->f
)
19993 || (row
->reversed_p
19994 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19995 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19996 insert_left_trunc_glyphs (it
);
19997 row
->truncated_on_left_p
= 1;
20000 /* Remember the position at which this line ends.
20002 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20003 cannot be before the call to find_row_edges below, since that is
20004 where these positions are determined. */
20005 row
->end
= it
->current
;
20008 row
->minpos
= row
->start
.pos
;
20009 row
->maxpos
= row
->end
.pos
;
20013 /* ROW->minpos and ROW->maxpos must be the smallest and
20014 `1 + the largest' buffer positions in ROW. But if ROW was
20015 bidi-reordered, these two positions can be anywhere in the
20016 row, so we must determine them now. */
20017 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20020 /* If the start of this line is the overlay arrow-position, then
20021 mark this glyph row as the one containing the overlay arrow.
20022 This is clearly a mess with variable size fonts. It would be
20023 better to let it be displayed like cursors under X. */
20024 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
20025 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20026 !NILP (overlay_arrow_string
)))
20028 /* Overlay arrow in window redisplay is a fringe bitmap. */
20029 if (STRINGP (overlay_arrow_string
))
20031 struct glyph_row
*arrow_row
20032 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20033 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20034 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20035 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20036 struct glyph
*p2
, *end
;
20038 /* Copy the arrow glyphs. */
20039 while (glyph
< arrow_end
)
20042 /* Throw away padding glyphs. */
20044 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20045 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20051 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20056 eassert (INTEGERP (overlay_arrow_string
));
20057 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20059 overlay_arrow_seen
= 1;
20062 /* Highlight trailing whitespace. */
20063 if (!NILP (Vshow_trailing_whitespace
))
20064 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20066 /* Compute pixel dimensions of this line. */
20067 compute_line_metrics (it
);
20069 /* Implementation note: No changes in the glyphs of ROW or in their
20070 faces can be done past this point, because compute_line_metrics
20071 computes ROW's hash value and stores it within the glyph_row
20074 /* Record whether this row ends inside an ellipsis. */
20075 row
->ends_in_ellipsis_p
20076 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20077 && it
->ellipsis_p
);
20079 /* Save fringe bitmaps in this row. */
20080 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20081 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20082 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20083 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20085 it
->left_user_fringe_bitmap
= 0;
20086 it
->left_user_fringe_face_id
= 0;
20087 it
->right_user_fringe_bitmap
= 0;
20088 it
->right_user_fringe_face_id
= 0;
20090 /* Maybe set the cursor. */
20091 cvpos
= it
->w
->cursor
.vpos
;
20093 /* In bidi-reordered rows, keep checking for proper cursor
20094 position even if one has been found already, because buffer
20095 positions in such rows change non-linearly with ROW->VPOS,
20096 when a line is continued. One exception: when we are at ZV,
20097 display cursor on the first suitable glyph row, since all
20098 the empty rows after that also have their position set to ZV. */
20099 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20100 lines' rows is implemented for bidi-reordered rows. */
20102 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20103 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20104 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20105 && cursor_row_p (row
))
20106 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20108 /* Prepare for the next line. This line starts horizontally at (X
20109 HPOS) = (0 0). Vertical positions are incremented. As a
20110 convenience for the caller, IT->glyph_row is set to the next
20112 it
->current_x
= it
->hpos
= 0;
20113 it
->current_y
+= row
->height
;
20114 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20117 /* The next row should by default use the same value of the
20118 reversed_p flag as this one. set_iterator_to_next decides when
20119 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20120 the flag accordingly. */
20121 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20122 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20123 it
->start
= row
->end
;
20124 return row
->displays_text_p
;
20126 #undef RECORD_MAX_MIN_POS
20129 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20130 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20131 doc
: /* Return paragraph direction at point in BUFFER.
20132 Value is either `left-to-right' or `right-to-left'.
20133 If BUFFER is omitted or nil, it defaults to the current buffer.
20135 Paragraph direction determines how the text in the paragraph is displayed.
20136 In left-to-right paragraphs, text begins at the left margin of the window
20137 and the reading direction is generally left to right. In right-to-left
20138 paragraphs, text begins at the right margin and is read from right to left.
20140 See also `bidi-paragraph-direction'. */)
20141 (Lisp_Object buffer
)
20143 struct buffer
*buf
= current_buffer
;
20144 struct buffer
*old
= buf
;
20146 if (! NILP (buffer
))
20148 CHECK_BUFFER (buffer
);
20149 buf
= XBUFFER (buffer
);
20152 if (NILP (BVAR (buf
, bidi_display_reordering
))
20153 || NILP (BVAR (buf
, enable_multibyte_characters
))
20154 /* When we are loading loadup.el, the character property tables
20155 needed for bidi iteration are not yet available. */
20156 || !NILP (Vpurify_flag
))
20157 return Qleft_to_right
;
20158 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20159 return BVAR (buf
, bidi_paragraph_direction
);
20162 /* Determine the direction from buffer text. We could try to
20163 use current_matrix if it is up to date, but this seems fast
20164 enough as it is. */
20165 struct bidi_it itb
;
20166 ptrdiff_t pos
= BUF_PT (buf
);
20167 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20169 void *itb_data
= bidi_shelve_cache ();
20171 set_buffer_temp (buf
);
20172 /* bidi_paragraph_init finds the base direction of the paragraph
20173 by searching forward from paragraph start. We need the base
20174 direction of the current or _previous_ paragraph, so we need
20175 to make sure we are within that paragraph. To that end, find
20176 the previous non-empty line. */
20177 if (pos
>= ZV
&& pos
> BEGV
)
20180 bytepos
= CHAR_TO_BYTE (pos
);
20182 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20183 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20185 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20186 || c
== ' ' || c
== '\t' || c
== '\f')
20188 if (bytepos
<= BEGV_BYTE
)
20193 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20196 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20197 itb
.paragraph_dir
= NEUTRAL_DIR
;
20198 itb
.string
.s
= NULL
;
20199 itb
.string
.lstring
= Qnil
;
20200 itb
.string
.bufpos
= 0;
20201 itb
.string
.unibyte
= 0;
20202 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20203 bidi_unshelve_cache (itb_data
, 0);
20204 set_buffer_temp (old
);
20205 switch (itb
.paragraph_dir
)
20208 return Qleft_to_right
;
20211 return Qright_to_left
;
20221 /***********************************************************************
20223 ***********************************************************************/
20225 /* Redisplay the menu bar in the frame for window W.
20227 The menu bar of X frames that don't have X toolkit support is
20228 displayed in a special window W->frame->menu_bar_window.
20230 The menu bar of terminal frames is treated specially as far as
20231 glyph matrices are concerned. Menu bar lines are not part of
20232 windows, so the update is done directly on the frame matrix rows
20233 for the menu bar. */
20236 display_menu_bar (struct window
*w
)
20238 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20243 /* Don't do all this for graphical frames. */
20245 if (FRAME_W32_P (f
))
20248 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20254 if (FRAME_NS_P (f
))
20256 #endif /* HAVE_NS */
20258 #ifdef USE_X_TOOLKIT
20259 eassert (!FRAME_WINDOW_P (f
));
20260 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20261 it
.first_visible_x
= 0;
20262 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20263 #else /* not USE_X_TOOLKIT */
20264 if (FRAME_WINDOW_P (f
))
20266 /* Menu bar lines are displayed in the desired matrix of the
20267 dummy window menu_bar_window. */
20268 struct window
*menu_w
;
20269 eassert (WINDOWP (f
->menu_bar_window
));
20270 menu_w
= XWINDOW (f
->menu_bar_window
);
20271 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20273 it
.first_visible_x
= 0;
20274 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20278 /* This is a TTY frame, i.e. character hpos/vpos are used as
20280 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20282 it
.first_visible_x
= 0;
20283 it
.last_visible_x
= FRAME_COLS (f
);
20285 #endif /* not USE_X_TOOLKIT */
20287 /* FIXME: This should be controlled by a user option. See the
20288 comments in redisplay_tool_bar and display_mode_line about
20290 it
.paragraph_embedding
= L2R
;
20292 /* Clear all rows of the menu bar. */
20293 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20295 struct glyph_row
*row
= it
.glyph_row
+ i
;
20296 clear_glyph_row (row
);
20297 row
->enabled_p
= 1;
20298 row
->full_width_p
= 1;
20301 /* Display all items of the menu bar. */
20302 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20303 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20305 Lisp_Object string
;
20307 /* Stop at nil string. */
20308 string
= AREF (items
, i
+ 1);
20312 /* Remember where item was displayed. */
20313 ASET (items
, i
+ 3, make_number (it
.hpos
));
20315 /* Display the item, pad with one space. */
20316 if (it
.current_x
< it
.last_visible_x
)
20317 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20318 SCHARS (string
) + 1, 0, 0, -1);
20321 /* Fill out the line with spaces. */
20322 if (it
.current_x
< it
.last_visible_x
)
20323 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20325 /* Compute the total height of the lines. */
20326 compute_line_metrics (&it
);
20331 /***********************************************************************
20333 ***********************************************************************/
20335 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20336 FORCE is non-zero, redisplay mode lines unconditionally.
20337 Otherwise, redisplay only mode lines that are garbaged. Value is
20338 the number of windows whose mode lines were redisplayed. */
20341 redisplay_mode_lines (Lisp_Object window
, int force
)
20345 while (!NILP (window
))
20347 struct window
*w
= XWINDOW (window
);
20349 if (WINDOWP (w
->hchild
))
20350 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20351 else if (WINDOWP (w
->vchild
))
20352 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20354 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20355 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20357 struct text_pos lpoint
;
20358 struct buffer
*old
= current_buffer
;
20360 /* Set the window's buffer for the mode line display. */
20361 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20362 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20364 /* Point refers normally to the selected window. For any
20365 other window, set up appropriate value. */
20366 if (!EQ (window
, selected_window
))
20368 struct text_pos pt
;
20370 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20371 if (CHARPOS (pt
) < BEGV
)
20372 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20373 else if (CHARPOS (pt
) > (ZV
- 1))
20374 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20376 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20379 /* Display mode lines. */
20380 clear_glyph_matrix (w
->desired_matrix
);
20381 if (display_mode_lines (w
))
20384 w
->must_be_updated_p
= 1;
20387 /* Restore old settings. */
20388 set_buffer_internal_1 (old
);
20389 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20399 /* Display the mode and/or header line of window W. Value is the
20400 sum number of mode lines and header lines displayed. */
20403 display_mode_lines (struct window
*w
)
20405 Lisp_Object old_selected_window
= selected_window
;
20406 Lisp_Object old_selected_frame
= selected_frame
;
20407 Lisp_Object new_frame
= w
->frame
;
20408 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
20411 selected_frame
= new_frame
;
20412 /* FIXME: If we were to allow the mode-line's computation changing the buffer
20413 or window's point, then we'd need select_window_1 here as well. */
20414 XSETWINDOW (selected_window
, w
);
20415 XFRAME (new_frame
)->selected_window
= selected_window
;
20417 /* These will be set while the mode line specs are processed. */
20418 line_number_displayed
= 0;
20419 wset_column_number_displayed (w
, Qnil
);
20421 if (WINDOW_WANTS_MODELINE_P (w
))
20423 struct window
*sel_w
= XWINDOW (old_selected_window
);
20425 /* Select mode line face based on the real selected window. */
20426 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20427 BVAR (current_buffer
, mode_line_format
));
20431 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20433 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20434 BVAR (current_buffer
, header_line_format
));
20438 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
20439 selected_frame
= old_selected_frame
;
20440 selected_window
= old_selected_window
;
20445 /* Display mode or header line of window W. FACE_ID specifies which
20446 line to display; it is either MODE_LINE_FACE_ID or
20447 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20448 display. Value is the pixel height of the mode/header line
20452 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20456 ptrdiff_t count
= SPECPDL_INDEX ();
20458 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20459 /* Don't extend on a previously drawn mode-line.
20460 This may happen if called from pos_visible_p. */
20461 it
.glyph_row
->enabled_p
= 0;
20462 prepare_desired_row (it
.glyph_row
);
20464 it
.glyph_row
->mode_line_p
= 1;
20466 /* FIXME: This should be controlled by a user option. But
20467 supporting such an option is not trivial, since the mode line is
20468 made up of many separate strings. */
20469 it
.paragraph_embedding
= L2R
;
20471 record_unwind_protect (unwind_format_mode_line
,
20472 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20474 mode_line_target
= MODE_LINE_DISPLAY
;
20476 /* Temporarily make frame's keyboard the current kboard so that
20477 kboard-local variables in the mode_line_format will get the right
20479 push_kboard (FRAME_KBOARD (it
.f
));
20480 record_unwind_save_match_data ();
20481 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20484 unbind_to (count
, Qnil
);
20486 /* Fill up with spaces. */
20487 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20489 compute_line_metrics (&it
);
20490 it
.glyph_row
->full_width_p
= 1;
20491 it
.glyph_row
->continued_p
= 0;
20492 it
.glyph_row
->truncated_on_left_p
= 0;
20493 it
.glyph_row
->truncated_on_right_p
= 0;
20495 /* Make a 3D mode-line have a shadow at its right end. */
20496 face
= FACE_FROM_ID (it
.f
, face_id
);
20497 extend_face_to_end_of_line (&it
);
20498 if (face
->box
!= FACE_NO_BOX
)
20500 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20501 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20502 last
->right_box_line_p
= 1;
20505 return it
.glyph_row
->height
;
20508 /* Move element ELT in LIST to the front of LIST.
20509 Return the updated list. */
20512 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20514 register Lisp_Object tail
, prev
;
20515 register Lisp_Object tem
;
20519 while (CONSP (tail
))
20525 /* Splice out the link TAIL. */
20527 list
= XCDR (tail
);
20529 Fsetcdr (prev
, XCDR (tail
));
20531 /* Now make it the first. */
20532 Fsetcdr (tail
, list
);
20537 tail
= XCDR (tail
);
20541 /* Not found--return unchanged LIST. */
20545 /* Contribute ELT to the mode line for window IT->w. How it
20546 translates into text depends on its data type.
20548 IT describes the display environment in which we display, as usual.
20550 DEPTH is the depth in recursion. It is used to prevent
20551 infinite recursion here.
20553 FIELD_WIDTH is the number of characters the display of ELT should
20554 occupy in the mode line, and PRECISION is the maximum number of
20555 characters to display from ELT's representation. See
20556 display_string for details.
20558 Returns the hpos of the end of the text generated by ELT.
20560 PROPS is a property list to add to any string we encounter.
20562 If RISKY is nonzero, remove (disregard) any properties in any string
20563 we encounter, and ignore :eval and :propertize.
20565 The global variable `mode_line_target' determines whether the
20566 output is passed to `store_mode_line_noprop',
20567 `store_mode_line_string', or `display_string'. */
20570 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20571 Lisp_Object elt
, Lisp_Object props
, int risky
)
20573 int n
= 0, field
, prec
;
20578 elt
= build_string ("*too-deep*");
20582 switch (XTYPE (elt
))
20586 /* A string: output it and check for %-constructs within it. */
20588 ptrdiff_t offset
= 0;
20590 if (SCHARS (elt
) > 0
20591 && (!NILP (props
) || risky
))
20593 Lisp_Object oprops
, aelt
;
20594 oprops
= Ftext_properties_at (make_number (0), elt
);
20596 /* If the starting string's properties are not what
20597 we want, translate the string. Also, if the string
20598 is risky, do that anyway. */
20600 if (NILP (Fequal (props
, oprops
)) || risky
)
20602 /* If the starting string has properties,
20603 merge the specified ones onto the existing ones. */
20604 if (! NILP (oprops
) && !risky
)
20608 oprops
= Fcopy_sequence (oprops
);
20610 while (CONSP (tem
))
20612 oprops
= Fplist_put (oprops
, XCAR (tem
),
20613 XCAR (XCDR (tem
)));
20614 tem
= XCDR (XCDR (tem
));
20619 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20620 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20622 /* AELT is what we want. Move it to the front
20623 without consing. */
20625 mode_line_proptrans_alist
20626 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20632 /* If AELT has the wrong props, it is useless.
20633 so get rid of it. */
20635 mode_line_proptrans_alist
20636 = Fdelq (aelt
, mode_line_proptrans_alist
);
20638 elt
= Fcopy_sequence (elt
);
20639 Fset_text_properties (make_number (0), Flength (elt
),
20641 /* Add this item to mode_line_proptrans_alist. */
20642 mode_line_proptrans_alist
20643 = Fcons (Fcons (elt
, props
),
20644 mode_line_proptrans_alist
);
20645 /* Truncate mode_line_proptrans_alist
20646 to at most 50 elements. */
20647 tem
= Fnthcdr (make_number (50),
20648 mode_line_proptrans_alist
);
20650 XSETCDR (tem
, Qnil
);
20659 prec
= precision
- n
;
20660 switch (mode_line_target
)
20662 case MODE_LINE_NOPROP
:
20663 case MODE_LINE_TITLE
:
20664 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20666 case MODE_LINE_STRING
:
20667 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20669 case MODE_LINE_DISPLAY
:
20670 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20671 0, prec
, 0, STRING_MULTIBYTE (elt
));
20678 /* Handle the non-literal case. */
20680 while ((precision
<= 0 || n
< precision
)
20681 && SREF (elt
, offset
) != 0
20682 && (mode_line_target
!= MODE_LINE_DISPLAY
20683 || it
->current_x
< it
->last_visible_x
))
20685 ptrdiff_t last_offset
= offset
;
20687 /* Advance to end of string or next format specifier. */
20688 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20691 if (offset
- 1 != last_offset
)
20693 ptrdiff_t nchars
, nbytes
;
20695 /* Output to end of string or up to '%'. Field width
20696 is length of string. Don't output more than
20697 PRECISION allows us. */
20700 prec
= c_string_width (SDATA (elt
) + last_offset
,
20701 offset
- last_offset
, precision
- n
,
20704 switch (mode_line_target
)
20706 case MODE_LINE_NOPROP
:
20707 case MODE_LINE_TITLE
:
20708 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20710 case MODE_LINE_STRING
:
20712 ptrdiff_t bytepos
= last_offset
;
20713 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20714 ptrdiff_t endpos
= (precision
<= 0
20715 ? string_byte_to_char (elt
, offset
)
20716 : charpos
+ nchars
);
20718 n
+= store_mode_line_string (NULL
,
20719 Fsubstring (elt
, make_number (charpos
),
20720 make_number (endpos
)),
20724 case MODE_LINE_DISPLAY
:
20726 ptrdiff_t bytepos
= last_offset
;
20727 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20729 if (precision
<= 0)
20730 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20731 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20733 STRING_MULTIBYTE (elt
));
20738 else /* c == '%' */
20740 ptrdiff_t percent_position
= offset
;
20742 /* Get the specified minimum width. Zero means
20745 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20746 field
= field
* 10 + c
- '0';
20748 /* Don't pad beyond the total padding allowed. */
20749 if (field_width
- n
> 0 && field
> field_width
- n
)
20750 field
= field_width
- n
;
20752 /* Note that either PRECISION <= 0 or N < PRECISION. */
20753 prec
= precision
- n
;
20756 n
+= display_mode_element (it
, depth
, field
, prec
,
20757 Vglobal_mode_string
, props
,
20762 ptrdiff_t bytepos
, charpos
;
20764 Lisp_Object string
;
20766 bytepos
= percent_position
;
20767 charpos
= (STRING_MULTIBYTE (elt
)
20768 ? string_byte_to_char (elt
, bytepos
)
20770 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20771 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20773 switch (mode_line_target
)
20775 case MODE_LINE_NOPROP
:
20776 case MODE_LINE_TITLE
:
20777 n
+= store_mode_line_noprop (spec
, field
, prec
);
20779 case MODE_LINE_STRING
:
20781 Lisp_Object tem
= build_string (spec
);
20782 props
= Ftext_properties_at (make_number (charpos
), elt
);
20783 /* Should only keep face property in props */
20784 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20787 case MODE_LINE_DISPLAY
:
20789 int nglyphs_before
, nwritten
;
20791 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20792 nwritten
= display_string (spec
, string
, elt
,
20797 /* Assign to the glyphs written above the
20798 string where the `%x' came from, position
20802 struct glyph
*glyph
20803 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20807 for (i
= 0; i
< nwritten
; ++i
)
20809 glyph
[i
].object
= elt
;
20810 glyph
[i
].charpos
= charpos
;
20827 /* A symbol: process the value of the symbol recursively
20828 as if it appeared here directly. Avoid error if symbol void.
20829 Special case: if value of symbol is a string, output the string
20832 register Lisp_Object tem
;
20834 /* If the variable is not marked as risky to set
20835 then its contents are risky to use. */
20836 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20839 tem
= Fboundp (elt
);
20842 tem
= Fsymbol_value (elt
);
20843 /* If value is a string, output that string literally:
20844 don't check for % within it. */
20848 if (!EQ (tem
, elt
))
20850 /* Give up right away for nil or t. */
20860 register Lisp_Object car
, tem
;
20862 /* A cons cell: five distinct cases.
20863 If first element is :eval or :propertize, do something special.
20864 If first element is a string or a cons, process all the elements
20865 and effectively concatenate them.
20866 If first element is a negative number, truncate displaying cdr to
20867 at most that many characters. If positive, pad (with spaces)
20868 to at least that many characters.
20869 If first element is a symbol, process the cadr or caddr recursively
20870 according to whether the symbol's value is non-nil or nil. */
20872 if (EQ (car
, QCeval
))
20874 /* An element of the form (:eval FORM) means evaluate FORM
20875 and use the result as mode line elements. */
20880 if (CONSP (XCDR (elt
)))
20883 spec
= safe_eval (XCAR (XCDR (elt
)));
20884 n
+= display_mode_element (it
, depth
, field_width
- n
,
20885 precision
- n
, spec
, props
,
20889 else if (EQ (car
, QCpropertize
))
20891 /* An element of the form (:propertize ELT PROPS...)
20892 means display ELT but applying properties PROPS. */
20897 if (CONSP (XCDR (elt
)))
20898 n
+= display_mode_element (it
, depth
, field_width
- n
,
20899 precision
- n
, XCAR (XCDR (elt
)),
20900 XCDR (XCDR (elt
)), risky
);
20902 else if (SYMBOLP (car
))
20904 tem
= Fboundp (car
);
20908 /* elt is now the cdr, and we know it is a cons cell.
20909 Use its car if CAR has a non-nil value. */
20912 tem
= Fsymbol_value (car
);
20919 /* Symbol's value is nil (or symbol is unbound)
20920 Get the cddr of the original list
20921 and if possible find the caddr and use that. */
20925 else if (!CONSP (elt
))
20930 else if (INTEGERP (car
))
20932 register int lim
= XINT (car
);
20936 /* Negative int means reduce maximum width. */
20937 if (precision
<= 0)
20940 precision
= min (precision
, -lim
);
20944 /* Padding specified. Don't let it be more than
20945 current maximum. */
20947 lim
= min (precision
, lim
);
20949 /* If that's more padding than already wanted, queue it.
20950 But don't reduce padding already specified even if
20951 that is beyond the current truncation point. */
20952 field_width
= max (lim
, field_width
);
20956 else if (STRINGP (car
) || CONSP (car
))
20958 Lisp_Object halftail
= elt
;
20962 && (precision
<= 0 || n
< precision
))
20964 n
+= display_mode_element (it
, depth
,
20965 /* Do padding only after the last
20966 element in the list. */
20967 (! CONSP (XCDR (elt
))
20970 precision
- n
, XCAR (elt
),
20974 if ((len
& 1) == 0)
20975 halftail
= XCDR (halftail
);
20976 /* Check for cycle. */
20977 if (EQ (halftail
, elt
))
20986 elt
= build_string ("*invalid*");
20990 /* Pad to FIELD_WIDTH. */
20991 if (field_width
> 0 && n
< field_width
)
20993 switch (mode_line_target
)
20995 case MODE_LINE_NOPROP
:
20996 case MODE_LINE_TITLE
:
20997 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20999 case MODE_LINE_STRING
:
21000 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
21002 case MODE_LINE_DISPLAY
:
21003 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
21012 /* Store a mode-line string element in mode_line_string_list.
21014 If STRING is non-null, display that C string. Otherwise, the Lisp
21015 string LISP_STRING is displayed.
21017 FIELD_WIDTH is the minimum number of output glyphs to produce.
21018 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21019 with spaces. FIELD_WIDTH <= 0 means don't pad.
21021 PRECISION is the maximum number of characters to output from
21022 STRING. PRECISION <= 0 means don't truncate the string.
21024 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
21025 properties to the string.
21027 PROPS are the properties to add to the string.
21028 The mode_line_string_face face property is always added to the string.
21032 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
21033 int field_width
, int precision
, Lisp_Object props
)
21038 if (string
!= NULL
)
21040 len
= strlen (string
);
21041 if (precision
> 0 && len
> precision
)
21043 lisp_string
= make_string (string
, len
);
21045 props
= mode_line_string_face_prop
;
21046 else if (!NILP (mode_line_string_face
))
21048 Lisp_Object face
= Fplist_get (props
, Qface
);
21049 props
= Fcopy_sequence (props
);
21051 face
= mode_line_string_face
;
21053 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21054 props
= Fplist_put (props
, Qface
, face
);
21056 Fadd_text_properties (make_number (0), make_number (len
),
21057 props
, lisp_string
);
21061 len
= XFASTINT (Flength (lisp_string
));
21062 if (precision
> 0 && len
> precision
)
21065 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
21068 if (!NILP (mode_line_string_face
))
21072 props
= Ftext_properties_at (make_number (0), lisp_string
);
21073 face
= Fplist_get (props
, Qface
);
21075 face
= mode_line_string_face
;
21077 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
21078 props
= Fcons (Qface
, Fcons (face
, Qnil
));
21080 lisp_string
= Fcopy_sequence (lisp_string
);
21083 Fadd_text_properties (make_number (0), make_number (len
),
21084 props
, lisp_string
);
21089 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21093 if (field_width
> len
)
21095 field_width
-= len
;
21096 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
21098 Fadd_text_properties (make_number (0), make_number (field_width
),
21099 props
, lisp_string
);
21100 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21108 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
21110 doc
: /* Format a string out of a mode line format specification.
21111 First arg FORMAT specifies the mode line format (see `mode-line-format'
21112 for details) to use.
21114 By default, the format is evaluated for the currently selected window.
21116 Optional second arg FACE specifies the face property to put on all
21117 characters for which no face is specified. The value nil means the
21118 default face. The value t means whatever face the window's mode line
21119 currently uses (either `mode-line' or `mode-line-inactive',
21120 depending on whether the window is the selected window or not).
21121 An integer value means the value string has no text
21124 Optional third and fourth args WINDOW and BUFFER specify the window
21125 and buffer to use as the context for the formatting (defaults
21126 are the selected window and the WINDOW's buffer). */)
21127 (Lisp_Object format
, Lisp_Object face
,
21128 Lisp_Object window
, Lisp_Object buffer
)
21133 struct buffer
*old_buffer
= NULL
;
21135 int no_props
= INTEGERP (face
);
21136 ptrdiff_t count
= SPECPDL_INDEX ();
21138 int string_start
= 0;
21140 w
= decode_any_window (window
);
21141 XSETWINDOW (window
, w
);
21144 buffer
= w
->buffer
;
21145 CHECK_BUFFER (buffer
);
21147 /* Make formatting the modeline a non-op when noninteractive, otherwise
21148 there will be problems later caused by a partially initialized frame. */
21149 if (NILP (format
) || noninteractive
)
21150 return empty_unibyte_string
;
21155 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21156 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21157 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21158 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21159 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21160 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21161 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21164 old_buffer
= current_buffer
;
21166 /* Save things including mode_line_proptrans_alist,
21167 and set that to nil so that we don't alter the outer value. */
21168 record_unwind_protect (unwind_format_mode_line
,
21169 format_mode_line_unwind_data
21170 (XFRAME (WINDOW_FRAME (w
)),
21171 old_buffer
, selected_window
, 1));
21172 mode_line_proptrans_alist
= Qnil
;
21174 Fselect_window (window
, Qt
);
21175 set_buffer_internal_1 (XBUFFER (buffer
));
21177 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21181 mode_line_target
= MODE_LINE_NOPROP
;
21182 mode_line_string_face_prop
= Qnil
;
21183 mode_line_string_list
= Qnil
;
21184 string_start
= MODE_LINE_NOPROP_LEN (0);
21188 mode_line_target
= MODE_LINE_STRING
;
21189 mode_line_string_list
= Qnil
;
21190 mode_line_string_face
= face
;
21191 mode_line_string_face_prop
21192 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21195 push_kboard (FRAME_KBOARD (it
.f
));
21196 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21201 len
= MODE_LINE_NOPROP_LEN (string_start
);
21202 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21206 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21207 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21208 empty_unibyte_string
);
21211 unbind_to (count
, Qnil
);
21215 /* Write a null-terminated, right justified decimal representation of
21216 the positive integer D to BUF using a minimal field width WIDTH. */
21219 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21221 register char *p
= buf
;
21229 *p
++ = d
% 10 + '0';
21234 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21245 /* Write a null-terminated, right justified decimal and "human
21246 readable" representation of the nonnegative integer D to BUF using
21247 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21249 static const char power_letter
[] =
21263 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21265 /* We aim to represent the nonnegative integer D as
21266 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21267 ptrdiff_t quotient
= d
;
21269 /* -1 means: do not use TENTHS. */
21273 /* Length of QUOTIENT.TENTHS as a string. */
21279 if (1000 <= quotient
)
21281 /* Scale to the appropriate EXPONENT. */
21284 remainder
= quotient
% 1000;
21288 while (1000 <= quotient
);
21290 /* Round to nearest and decide whether to use TENTHS or not. */
21293 tenths
= remainder
/ 100;
21294 if (50 <= remainder
% 100)
21301 if (quotient
== 10)
21309 if (500 <= remainder
)
21311 if (quotient
< 999)
21322 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21323 if (tenths
== -1 && quotient
<= 99)
21330 p
= psuffix
= buf
+ max (width
, length
);
21332 /* Print EXPONENT. */
21333 *psuffix
++ = power_letter
[exponent
];
21336 /* Print TENTHS. */
21339 *--p
= '0' + tenths
;
21343 /* Print QUOTIENT. */
21346 int digit
= quotient
% 10;
21347 *--p
= '0' + digit
;
21349 while ((quotient
/= 10) != 0);
21351 /* Print leading spaces. */
21356 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21357 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21358 type of CODING_SYSTEM. Return updated pointer into BUF. */
21360 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21363 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21366 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21367 const unsigned char *eol_str
;
21369 /* The EOL conversion we are using. */
21370 Lisp_Object eoltype
;
21372 val
= CODING_SYSTEM_SPEC (coding_system
);
21375 if (!VECTORP (val
)) /* Not yet decided. */
21377 *buf
++ = multibyte
? '-' : ' ';
21379 eoltype
= eol_mnemonic_undecided
;
21380 /* Don't mention EOL conversion if it isn't decided. */
21385 Lisp_Object eolvalue
;
21387 attrs
= AREF (val
, 0);
21388 eolvalue
= AREF (val
, 2);
21391 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21396 /* The EOL conversion that is normal on this system. */
21398 if (NILP (eolvalue
)) /* Not yet decided. */
21399 eoltype
= eol_mnemonic_undecided
;
21400 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21401 eoltype
= eol_mnemonic_undecided
;
21402 else /* eolvalue is Qunix, Qdos, or Qmac. */
21403 eoltype
= (EQ (eolvalue
, Qunix
)
21404 ? eol_mnemonic_unix
21405 : (EQ (eolvalue
, Qdos
) == 1
21406 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21412 /* Mention the EOL conversion if it is not the usual one. */
21413 if (STRINGP (eoltype
))
21415 eol_str
= SDATA (eoltype
);
21416 eol_str_len
= SBYTES (eoltype
);
21418 else if (CHARACTERP (eoltype
))
21420 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21421 int c
= XFASTINT (eoltype
);
21422 eol_str_len
= CHAR_STRING (c
, tmp
);
21427 eol_str
= invalid_eol_type
;
21428 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21430 memcpy (buf
, eol_str
, eol_str_len
);
21431 buf
+= eol_str_len
;
21437 /* Return a string for the output of a mode line %-spec for window W,
21438 generated by character C. FIELD_WIDTH > 0 means pad the string
21439 returned with spaces to that value. Return a Lisp string in
21440 *STRING if the resulting string is taken from that Lisp string.
21442 Note we operate on the current buffer for most purposes,
21443 the exception being w->base_line_pos. */
21445 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21447 static const char *
21448 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21449 Lisp_Object
*string
)
21452 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21453 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21454 /* We are going to use f->decode_mode_spec_buffer as the buffer to
21455 produce strings from numerical values, so limit preposterously
21456 large values of FIELD_WIDTH to avoid overrunning the buffer's
21457 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
21458 bytes plus the terminating null. */
21459 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
21460 struct buffer
*b
= current_buffer
;
21468 if (!NILP (BVAR (b
, read_only
)))
21470 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21475 /* This differs from %* only for a modified read-only buffer. */
21476 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21478 if (!NILP (BVAR (b
, read_only
)))
21483 /* This differs from %* in ignoring read-only-ness. */
21484 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21496 if (command_loop_level
> 5)
21498 p
= decode_mode_spec_buf
;
21499 for (i
= 0; i
< command_loop_level
; i
++)
21502 return decode_mode_spec_buf
;
21510 if (command_loop_level
> 5)
21512 p
= decode_mode_spec_buf
;
21513 for (i
= 0; i
< command_loop_level
; i
++)
21516 return decode_mode_spec_buf
;
21523 /* Let lots_of_dashes be a string of infinite length. */
21524 if (mode_line_target
== MODE_LINE_NOPROP
21525 || mode_line_target
== MODE_LINE_STRING
)
21527 if (field_width
<= 0
21528 || field_width
> sizeof (lots_of_dashes
))
21530 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21531 decode_mode_spec_buf
[i
] = '-';
21532 decode_mode_spec_buf
[i
] = '\0';
21533 return decode_mode_spec_buf
;
21536 return lots_of_dashes
;
21540 obj
= BVAR (b
, name
);
21544 /* %c and %l are ignored in `frame-title-format'.
21545 (In redisplay_internal, the frame title is drawn _before_ the
21546 windows are updated, so the stuff which depends on actual
21547 window contents (such as %l) may fail to render properly, or
21548 even crash emacs.) */
21549 if (mode_line_target
== MODE_LINE_TITLE
)
21553 ptrdiff_t col
= current_column ();
21554 wset_column_number_displayed (w
, make_number (col
));
21555 pint2str (decode_mode_spec_buf
, width
, col
);
21556 return decode_mode_spec_buf
;
21560 #ifndef SYSTEM_MALLOC
21562 if (NILP (Vmemory_full
))
21565 return "!MEM FULL! ";
21572 /* %F displays the frame name. */
21573 if (!NILP (f
->title
))
21574 return SSDATA (f
->title
);
21575 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21576 return SSDATA (f
->name
);
21580 obj
= BVAR (b
, filename
);
21585 ptrdiff_t size
= ZV
- BEGV
;
21586 pint2str (decode_mode_spec_buf
, width
, size
);
21587 return decode_mode_spec_buf
;
21592 ptrdiff_t size
= ZV
- BEGV
;
21593 pint2hrstr (decode_mode_spec_buf
, width
, size
);
21594 return decode_mode_spec_buf
;
21599 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21600 ptrdiff_t topline
, nlines
, height
;
21603 /* %c and %l are ignored in `frame-title-format'. */
21604 if (mode_line_target
== MODE_LINE_TITLE
)
21607 startpos
= marker_position (w
->start
);
21608 startpos_byte
= marker_byte_position (w
->start
);
21609 height
= WINDOW_TOTAL_LINES (w
);
21611 /* If we decided that this buffer isn't suitable for line numbers,
21612 don't forget that too fast. */
21613 if (EQ (w
->base_line_pos
, w
->buffer
))
21615 /* But do forget it, if the window shows a different buffer now. */
21616 else if (BUFFERP (w
->base_line_pos
))
21617 wset_base_line_pos (w
, Qnil
);
21619 /* If the buffer is very big, don't waste time. */
21620 if (INTEGERP (Vline_number_display_limit
)
21621 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21623 wset_base_line_pos (w
, Qnil
);
21624 wset_base_line_number (w
, Qnil
);
21628 if (INTEGERP (w
->base_line_number
)
21629 && INTEGERP (w
->base_line_pos
)
21630 && XFASTINT (w
->base_line_pos
) <= startpos
)
21632 line
= XFASTINT (w
->base_line_number
);
21633 linepos
= XFASTINT (w
->base_line_pos
);
21634 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21639 linepos
= BUF_BEGV (b
);
21640 linepos_byte
= BUF_BEGV_BYTE (b
);
21643 /* Count lines from base line to window start position. */
21644 nlines
= display_count_lines (linepos_byte
,
21648 topline
= nlines
+ line
;
21650 /* Determine a new base line, if the old one is too close
21651 or too far away, or if we did not have one.
21652 "Too close" means it's plausible a scroll-down would
21653 go back past it. */
21654 if (startpos
== BUF_BEGV (b
))
21656 wset_base_line_number (w
, make_number (topline
));
21657 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21659 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21660 || linepos
== BUF_BEGV (b
))
21662 ptrdiff_t limit
= BUF_BEGV (b
);
21663 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21664 ptrdiff_t position
;
21665 ptrdiff_t distance
=
21666 (height
* 2 + 30) * line_number_display_limit_width
;
21668 if (startpos
- distance
> limit
)
21670 limit
= startpos
- distance
;
21671 limit_byte
= CHAR_TO_BYTE (limit
);
21674 nlines
= display_count_lines (startpos_byte
,
21676 - (height
* 2 + 30),
21678 /* If we couldn't find the lines we wanted within
21679 line_number_display_limit_width chars per line,
21680 give up on line numbers for this window. */
21681 if (position
== limit_byte
&& limit
== startpos
- distance
)
21683 wset_base_line_pos (w
, w
->buffer
);
21684 wset_base_line_number (w
, Qnil
);
21688 wset_base_line_number (w
, make_number (topline
- nlines
));
21689 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21692 /* Now count lines from the start pos to point. */
21693 nlines
= display_count_lines (startpos_byte
,
21694 PT_BYTE
, PT
, &junk
);
21696 /* Record that we did display the line number. */
21697 line_number_displayed
= 1;
21699 /* Make the string to show. */
21700 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
21701 return decode_mode_spec_buf
;
21704 char* p
= decode_mode_spec_buf
;
21705 int pad
= width
- 2;
21711 return decode_mode_spec_buf
;
21717 obj
= BVAR (b
, mode_name
);
21721 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21727 ptrdiff_t pos
= marker_position (w
->start
);
21728 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21730 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21732 if (pos
<= BUF_BEGV (b
))
21737 else if (pos
<= BUF_BEGV (b
))
21741 if (total
> 1000000)
21742 /* Do it differently for a large value, to avoid overflow. */
21743 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21745 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21746 /* We can't normally display a 3-digit number,
21747 so get us a 2-digit number that is close. */
21750 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21751 return decode_mode_spec_buf
;
21755 /* Display percentage of size above the bottom of the screen. */
21758 ptrdiff_t toppos
= marker_position (w
->start
);
21759 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21760 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21762 if (botpos
>= BUF_ZV (b
))
21764 if (toppos
<= BUF_BEGV (b
))
21771 if (total
> 1000000)
21772 /* Do it differently for a large value, to avoid overflow. */
21773 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21775 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21776 /* We can't normally display a 3-digit number,
21777 so get us a 2-digit number that is close. */
21780 if (toppos
<= BUF_BEGV (b
))
21781 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21783 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21784 return decode_mode_spec_buf
;
21789 /* status of process */
21790 obj
= Fget_buffer_process (Fcurrent_buffer ());
21792 return "no process";
21794 obj
= Fsymbol_name (Fprocess_status (obj
));
21800 ptrdiff_t count
= inhibit_garbage_collection ();
21801 Lisp_Object val
= call1 (intern ("file-remote-p"),
21802 BVAR (current_buffer
, directory
));
21803 unbind_to (count
, Qnil
);
21811 case 't': /* indicate TEXT or BINARY */
21815 /* coding-system (not including end-of-line format) */
21817 /* coding-system (including end-of-line type) */
21819 int eol_flag
= (c
== 'Z');
21820 char *p
= decode_mode_spec_buf
;
21822 if (! FRAME_WINDOW_P (f
))
21824 /* No need to mention EOL here--the terminal never needs
21825 to do EOL conversion. */
21826 p
= decode_mode_spec_coding (CODING_ID_NAME
21827 (FRAME_KEYBOARD_CODING (f
)->id
),
21829 p
= decode_mode_spec_coding (CODING_ID_NAME
21830 (FRAME_TERMINAL_CODING (f
)->id
),
21833 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21836 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21837 #ifdef subprocesses
21838 obj
= Fget_buffer_process (Fcurrent_buffer ());
21839 if (PROCESSP (obj
))
21841 p
= decode_mode_spec_coding
21842 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21843 p
= decode_mode_spec_coding
21844 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21846 #endif /* subprocesses */
21849 return decode_mode_spec_buf
;
21856 return SSDATA (obj
);
21863 /* Count up to COUNT lines starting from START_BYTE.
21864 But don't go beyond LIMIT_BYTE.
21865 Return the number of lines thus found (always nonnegative).
21867 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21870 display_count_lines (ptrdiff_t start_byte
,
21871 ptrdiff_t limit_byte
, ptrdiff_t count
,
21872 ptrdiff_t *byte_pos_ptr
)
21874 register unsigned char *cursor
;
21875 unsigned char *base
;
21877 register ptrdiff_t ceiling
;
21878 register unsigned char *ceiling_addr
;
21879 ptrdiff_t orig_count
= count
;
21881 /* If we are not in selective display mode,
21882 check only for newlines. */
21883 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21884 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21888 while (start_byte
< limit_byte
)
21890 ceiling
= BUFFER_CEILING_OF (start_byte
);
21891 ceiling
= min (limit_byte
- 1, ceiling
);
21892 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21893 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21896 if (selective_display
)
21897 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21900 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21903 if (cursor
!= ceiling_addr
)
21907 start_byte
+= cursor
- base
+ 1;
21908 *byte_pos_ptr
= start_byte
;
21912 if (++cursor
== ceiling_addr
)
21918 start_byte
+= cursor
- base
;
21923 while (start_byte
> limit_byte
)
21925 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21926 ceiling
= max (limit_byte
, ceiling
);
21927 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21928 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21931 if (selective_display
)
21932 while (--cursor
!= ceiling_addr
21933 && *cursor
!= '\n' && *cursor
!= 015)
21936 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21939 if (cursor
!= ceiling_addr
)
21943 start_byte
+= cursor
- base
+ 1;
21944 *byte_pos_ptr
= start_byte
;
21945 /* When scanning backwards, we should
21946 not count the newline posterior to which we stop. */
21947 return - orig_count
- 1;
21953 /* Here we add 1 to compensate for the last decrement
21954 of CURSOR, which took it past the valid range. */
21955 start_byte
+= cursor
- base
+ 1;
21959 *byte_pos_ptr
= limit_byte
;
21962 return - orig_count
+ count
;
21963 return orig_count
- count
;
21969 /***********************************************************************
21971 ***********************************************************************/
21973 /* Display a NUL-terminated string, starting with index START.
21975 If STRING is non-null, display that C string. Otherwise, the Lisp
21976 string LISP_STRING is displayed. There's a case that STRING is
21977 non-null and LISP_STRING is not nil. It means STRING is a string
21978 data of LISP_STRING. In that case, we display LISP_STRING while
21979 ignoring its text properties.
21981 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21982 FACE_STRING. Display STRING or LISP_STRING with the face at
21983 FACE_STRING_POS in FACE_STRING:
21985 Display the string in the environment given by IT, but use the
21986 standard display table, temporarily.
21988 FIELD_WIDTH is the minimum number of output glyphs to produce.
21989 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21990 with spaces. If STRING has more characters, more than FIELD_WIDTH
21991 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21993 PRECISION is the maximum number of characters to output from
21994 STRING. PRECISION < 0 means don't truncate the string.
21996 This is roughly equivalent to printf format specifiers:
21998 FIELD_WIDTH PRECISION PRINTF
21999 ----------------------------------------
22005 MULTIBYTE zero means do not display multibyte chars, > 0 means do
22006 display them, and < 0 means obey the current buffer's value of
22007 enable_multibyte_characters.
22009 Value is the number of columns displayed. */
22012 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
22013 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
22014 int field_width
, int precision
, int max_x
, int multibyte
)
22016 int hpos_at_start
= it
->hpos
;
22017 int saved_face_id
= it
->face_id
;
22018 struct glyph_row
*row
= it
->glyph_row
;
22019 ptrdiff_t it_charpos
;
22021 /* Initialize the iterator IT for iteration over STRING beginning
22022 with index START. */
22023 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
22024 precision
, field_width
, multibyte
);
22025 if (string
&& STRINGP (lisp_string
))
22026 /* LISP_STRING is the one returned by decode_mode_spec. We should
22027 ignore its text properties. */
22028 it
->stop_charpos
= it
->end_charpos
;
22030 /* If displaying STRING, set up the face of the iterator from
22031 FACE_STRING, if that's given. */
22032 if (STRINGP (face_string
))
22038 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
22039 0, it
->region_beg_charpos
,
22040 it
->region_end_charpos
,
22041 &endptr
, it
->base_face_id
, 0);
22042 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22043 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
22046 /* Set max_x to the maximum allowed X position. Don't let it go
22047 beyond the right edge of the window. */
22049 max_x
= it
->last_visible_x
;
22051 max_x
= min (max_x
, it
->last_visible_x
);
22053 /* Skip over display elements that are not visible. because IT->w is
22055 if (it
->current_x
< it
->first_visible_x
)
22056 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
22057 MOVE_TO_POS
| MOVE_TO_X
);
22059 row
->ascent
= it
->max_ascent
;
22060 row
->height
= it
->max_ascent
+ it
->max_descent
;
22061 row
->phys_ascent
= it
->max_phys_ascent
;
22062 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
22063 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
22065 if (STRINGP (it
->string
))
22066 it_charpos
= IT_STRING_CHARPOS (*it
);
22068 it_charpos
= IT_CHARPOS (*it
);
22070 /* This condition is for the case that we are called with current_x
22071 past last_visible_x. */
22072 while (it
->current_x
< max_x
)
22074 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
22076 /* Get the next display element. */
22077 if (!get_next_display_element (it
))
22080 /* Produce glyphs. */
22081 x_before
= it
->current_x
;
22082 n_glyphs_before
= row
->used
[TEXT_AREA
];
22083 PRODUCE_GLYPHS (it
);
22085 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
22088 while (i
< nglyphs
)
22090 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
22092 if (it
->line_wrap
!= TRUNCATE
22093 && x
+ glyph
->pixel_width
> max_x
)
22095 /* End of continued line or max_x reached. */
22096 if (CHAR_GLYPH_PADDING_P (*glyph
))
22098 /* A wide character is unbreakable. */
22099 if (row
->reversed_p
)
22100 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22101 - n_glyphs_before
);
22102 row
->used
[TEXT_AREA
] = n_glyphs_before
;
22103 it
->current_x
= x_before
;
22107 if (row
->reversed_p
)
22108 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22109 - (n_glyphs_before
+ i
));
22110 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
22115 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
22117 /* Glyph is at least partially visible. */
22119 if (x
< it
->first_visible_x
)
22120 row
->x
= x
- it
->first_visible_x
;
22124 /* Glyph is off the left margin of the display area.
22125 Should not happen. */
22129 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22130 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22131 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22132 row
->phys_height
= max (row
->phys_height
,
22133 it
->max_phys_ascent
+ it
->max_phys_descent
);
22134 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22135 it
->max_extra_line_spacing
);
22136 x
+= glyph
->pixel_width
;
22140 /* Stop if max_x reached. */
22144 /* Stop at line ends. */
22145 if (ITERATOR_AT_END_OF_LINE_P (it
))
22147 it
->continuation_lines_width
= 0;
22151 set_iterator_to_next (it
, 1);
22152 if (STRINGP (it
->string
))
22153 it_charpos
= IT_STRING_CHARPOS (*it
);
22155 it_charpos
= IT_CHARPOS (*it
);
22157 /* Stop if truncating at the right edge. */
22158 if (it
->line_wrap
== TRUNCATE
22159 && it
->current_x
>= it
->last_visible_x
)
22161 /* Add truncation mark, but don't do it if the line is
22162 truncated at a padding space. */
22163 if (it_charpos
< it
->string_nchars
)
22165 if (!FRAME_WINDOW_P (it
->f
))
22169 if (it
->current_x
> it
->last_visible_x
)
22171 if (!row
->reversed_p
)
22173 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22174 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22179 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22180 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22182 unproduce_glyphs (it
, ii
+ 1);
22183 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22185 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22187 row
->used
[TEXT_AREA
] = ii
;
22188 produce_special_glyphs (it
, IT_TRUNCATION
);
22191 produce_special_glyphs (it
, IT_TRUNCATION
);
22193 row
->truncated_on_right_p
= 1;
22199 /* Maybe insert a truncation at the left. */
22200 if (it
->first_visible_x
22203 if (!FRAME_WINDOW_P (it
->f
)
22204 || (row
->reversed_p
22205 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22206 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22207 insert_left_trunc_glyphs (it
);
22208 row
->truncated_on_left_p
= 1;
22211 it
->face_id
= saved_face_id
;
22213 /* Value is number of columns displayed. */
22214 return it
->hpos
- hpos_at_start
;
22219 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22220 appears as an element of LIST or as the car of an element of LIST.
22221 If PROPVAL is a list, compare each element against LIST in that
22222 way, and return 1/2 if any element of PROPVAL is found in LIST.
22223 Otherwise return 0. This function cannot quit.
22224 The return value is 2 if the text is invisible but with an ellipsis
22225 and 1 if it's invisible and without an ellipsis. */
22228 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22230 register Lisp_Object tail
, proptail
;
22232 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22234 register Lisp_Object tem
;
22236 if (EQ (propval
, tem
))
22238 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22239 return NILP (XCDR (tem
)) ? 1 : 2;
22242 if (CONSP (propval
))
22244 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22246 Lisp_Object propelt
;
22247 propelt
= XCAR (proptail
);
22248 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22250 register Lisp_Object tem
;
22252 if (EQ (propelt
, tem
))
22254 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22255 return NILP (XCDR (tem
)) ? 1 : 2;
22263 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22264 doc
: /* Non-nil if the property makes the text invisible.
22265 POS-OR-PROP can be a marker or number, in which case it is taken to be
22266 a position in the current buffer and the value of the `invisible' property
22267 is checked; or it can be some other value, which is then presumed to be the
22268 value of the `invisible' property of the text of interest.
22269 The non-nil value returned can be t for truly invisible text or something
22270 else if the text is replaced by an ellipsis. */)
22271 (Lisp_Object pos_or_prop
)
22274 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22275 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22277 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22278 return (invis
== 0 ? Qnil
22280 : make_number (invis
));
22283 /* Calculate a width or height in pixels from a specification using
22284 the following elements:
22287 NUM - a (fractional) multiple of the default font width/height
22288 (NUM) - specifies exactly NUM pixels
22289 UNIT - a fixed number of pixels, see below.
22290 ELEMENT - size of a display element in pixels, see below.
22291 (NUM . SPEC) - equals NUM * SPEC
22292 (+ SPEC SPEC ...) - add pixel values
22293 (- SPEC SPEC ...) - subtract pixel values
22294 (- SPEC) - negate pixel value
22297 INT or FLOAT - a number constant
22298 SYMBOL - use symbol's (buffer local) variable binding.
22301 in - pixels per inch *)
22302 mm - pixels per 1/1000 meter *)
22303 cm - pixels per 1/100 meter *)
22304 width - width of current font in pixels.
22305 height - height of current font in pixels.
22307 *) using the ratio(s) defined in display-pixels-per-inch.
22311 left-fringe - left fringe width in pixels
22312 right-fringe - right fringe width in pixels
22314 left-margin - left margin width in pixels
22315 right-margin - right margin width in pixels
22317 scroll-bar - scroll-bar area width in pixels
22321 Pixels corresponding to 5 inches:
22324 Total width of non-text areas on left side of window (if scroll-bar is on left):
22325 '(space :width (+ left-fringe left-margin scroll-bar))
22327 Align to first text column (in header line):
22328 '(space :align-to 0)
22330 Align to middle of text area minus half the width of variable `my-image'
22331 containing a loaded image:
22332 '(space :align-to (0.5 . (- text my-image)))
22334 Width of left margin minus width of 1 character in the default font:
22335 '(space :width (- left-margin 1))
22337 Width of left margin minus width of 2 characters in the current font:
22338 '(space :width (- left-margin (2 . width)))
22340 Center 1 character over left-margin (in header line):
22341 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22343 Different ways to express width of left fringe plus left margin minus one pixel:
22344 '(space :width (- (+ left-fringe left-margin) (1)))
22345 '(space :width (+ left-fringe left-margin (- (1))))
22346 '(space :width (+ left-fringe left-margin (-1)))
22350 #define NUMVAL(X) \
22351 ((INTEGERP (X) || FLOATP (X)) \
22356 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22357 struct font
*font
, int width_p
, int *align_to
)
22361 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22362 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22365 return OK_PIXELS (0);
22367 eassert (FRAME_LIVE_P (it
->f
));
22369 if (SYMBOLP (prop
))
22371 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22373 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22375 if (unit
[0] == 'i' && unit
[1] == 'n')
22377 else if (unit
[0] == 'm' && unit
[1] == 'm')
22379 else if (unit
[0] == 'c' && unit
[1] == 'm')
22386 #ifdef HAVE_WINDOW_SYSTEM
22387 if (FRAME_WINDOW_P (it
->f
)
22389 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22390 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22392 return OK_PIXELS (ppi
/ pixels
);
22395 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22396 || (CONSP (Vdisplay_pixels_per_inch
)
22398 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22399 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22401 return OK_PIXELS (ppi
/ pixels
);
22407 #ifdef HAVE_WINDOW_SYSTEM
22408 if (EQ (prop
, Qheight
))
22409 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22410 if (EQ (prop
, Qwidth
))
22411 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22413 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22414 return OK_PIXELS (1);
22417 if (EQ (prop
, Qtext
))
22418 return OK_PIXELS (width_p
22419 ? window_box_width (it
->w
, TEXT_AREA
)
22420 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22422 if (align_to
&& *align_to
< 0)
22425 if (EQ (prop
, Qleft
))
22426 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22427 if (EQ (prop
, Qright
))
22428 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22429 if (EQ (prop
, Qcenter
))
22430 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22431 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22432 if (EQ (prop
, Qleft_fringe
))
22433 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22434 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22435 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22436 if (EQ (prop
, Qright_fringe
))
22437 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22438 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22439 : window_box_right_offset (it
->w
, TEXT_AREA
));
22440 if (EQ (prop
, Qleft_margin
))
22441 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22442 if (EQ (prop
, Qright_margin
))
22443 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22444 if (EQ (prop
, Qscroll_bar
))
22445 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22447 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22448 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22449 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22454 if (EQ (prop
, Qleft_fringe
))
22455 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22456 if (EQ (prop
, Qright_fringe
))
22457 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22458 if (EQ (prop
, Qleft_margin
))
22459 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22460 if (EQ (prop
, Qright_margin
))
22461 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22462 if (EQ (prop
, Qscroll_bar
))
22463 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22466 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22467 if (EQ (prop
, Qunbound
))
22471 if (INTEGERP (prop
) || FLOATP (prop
))
22473 int base_unit
= (width_p
22474 ? FRAME_COLUMN_WIDTH (it
->f
)
22475 : FRAME_LINE_HEIGHT (it
->f
));
22476 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22481 Lisp_Object car
= XCAR (prop
);
22482 Lisp_Object cdr
= XCDR (prop
);
22486 #ifdef HAVE_WINDOW_SYSTEM
22487 if (FRAME_WINDOW_P (it
->f
)
22488 && valid_image_p (prop
))
22490 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22491 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22493 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22495 #ifdef HAVE_XWIDGETS
22496 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_p (prop
))
22498 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
22499 return OK_PIXELS (width_p
? 100 : 100);
22503 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22509 while (CONSP (cdr
))
22511 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22512 font
, width_p
, align_to
))
22515 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22520 if (EQ (car
, Qminus
))
22522 return OK_PIXELS (pixels
);
22525 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22526 if (EQ (car
, Qunbound
))
22530 if (INTEGERP (car
) || FLOATP (car
))
22533 pixels
= XFLOATINT (car
);
22535 return OK_PIXELS (pixels
);
22536 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22537 font
, width_p
, align_to
))
22538 return OK_PIXELS (pixels
* fact
);
22549 /***********************************************************************
22551 ***********************************************************************/
22553 #ifdef HAVE_WINDOW_SYSTEM
22558 dump_glyph_string (struct glyph_string
*s
)
22560 fprintf (stderr
, "glyph string\n");
22561 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22562 s
->x
, s
->y
, s
->width
, s
->height
);
22563 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22564 fprintf (stderr
, " hl = %d\n", s
->hl
);
22565 fprintf (stderr
, " left overhang = %d, right = %d\n",
22566 s
->left_overhang
, s
->right_overhang
);
22567 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22568 fprintf (stderr
, " extends to end of line = %d\n",
22569 s
->extends_to_end_of_line_p
);
22570 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22571 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22574 #endif /* GLYPH_DEBUG */
22576 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22577 of XChar2b structures for S; it can't be allocated in
22578 init_glyph_string because it must be allocated via `alloca'. W
22579 is the window on which S is drawn. ROW and AREA are the glyph row
22580 and area within the row from which S is constructed. START is the
22581 index of the first glyph structure covered by S. HL is a
22582 face-override for drawing S. */
22585 #define OPTIONAL_HDC(hdc) HDC hdc,
22586 #define DECLARE_HDC(hdc) HDC hdc;
22587 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22588 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22591 #ifndef OPTIONAL_HDC
22592 #define OPTIONAL_HDC(hdc)
22593 #define DECLARE_HDC(hdc)
22594 #define ALLOCATE_HDC(hdc, f)
22595 #define RELEASE_HDC(hdc, f)
22599 init_glyph_string (struct glyph_string
*s
,
22601 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22602 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22604 memset (s
, 0, sizeof *s
);
22606 s
->f
= XFRAME (w
->frame
);
22610 s
->display
= FRAME_X_DISPLAY (s
->f
);
22611 s
->window
= FRAME_X_WINDOW (s
->f
);
22612 s
->char2b
= char2b
;
22616 s
->first_glyph
= row
->glyphs
[area
] + start
;
22617 s
->height
= row
->height
;
22618 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22619 s
->ybase
= s
->y
+ row
->ascent
;
22623 /* Append the list of glyph strings with head H and tail T to the list
22624 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22627 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22628 struct glyph_string
*h
, struct glyph_string
*t
)
22642 /* Prepend the list of glyph strings with head H and tail T to the
22643 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22647 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22648 struct glyph_string
*h
, struct glyph_string
*t
)
22662 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22663 Set *HEAD and *TAIL to the resulting list. */
22666 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22667 struct glyph_string
*s
)
22669 s
->next
= s
->prev
= NULL
;
22670 append_glyph_string_lists (head
, tail
, s
, s
);
22674 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22675 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22676 make sure that X resources for the face returned are allocated.
22677 Value is a pointer to a realized face that is ready for display if
22678 DISPLAY_P is non-zero. */
22680 static struct face
*
22681 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22682 XChar2b
*char2b
, int display_p
)
22684 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22688 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22690 if (code
!= FONT_INVALID_CODE
)
22691 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22693 STORE_XCHAR2B (char2b
, 0, 0);
22696 /* Make sure X resources of the face are allocated. */
22697 #ifdef HAVE_X_WINDOWS
22701 eassert (face
!= NULL
);
22702 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22709 /* Get face and two-byte form of character glyph GLYPH on frame F.
22710 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22711 a pointer to a realized face that is ready for display. */
22713 static struct face
*
22714 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22715 XChar2b
*char2b
, int *two_byte_p
)
22719 eassert (glyph
->type
== CHAR_GLYPH
);
22720 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22729 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22730 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22732 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22734 if (code
!= FONT_INVALID_CODE
)
22735 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22737 STORE_XCHAR2B (char2b
, 0, 0);
22740 /* Make sure X resources of the face are allocated. */
22741 eassert (face
!= NULL
);
22742 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22747 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22748 Return 1 if FONT has a glyph for C, otherwise return 0. */
22751 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22755 if (CHAR_BYTE8_P (c
))
22756 code
= CHAR_TO_BYTE8 (c
);
22758 code
= font
->driver
->encode_char (font
, c
);
22760 if (code
== FONT_INVALID_CODE
)
22762 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22767 /* Fill glyph string S with composition components specified by S->cmp.
22769 BASE_FACE is the base face of the composition.
22770 S->cmp_from is the index of the first component for S.
22772 OVERLAPS non-zero means S should draw the foreground only, and use
22773 its physical height for clipping. See also draw_glyphs.
22775 Value is the index of a component not in S. */
22778 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22782 /* For all glyphs of this composition, starting at the offset
22783 S->cmp_from, until we reach the end of the definition or encounter a
22784 glyph that requires the different face, add it to S. */
22789 s
->for_overlaps
= overlaps
;
22792 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22794 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22796 /* TAB in a composition means display glyphs with padding space
22797 on the left or right. */
22800 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22803 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22810 s
->font
= s
->face
->font
;
22812 else if (s
->face
!= face
)
22820 if (s
->face
== NULL
)
22822 s
->face
= base_face
->ascii_face
;
22823 s
->font
= s
->face
->font
;
22826 /* All glyph strings for the same composition has the same width,
22827 i.e. the width set for the first component of the composition. */
22828 s
->width
= s
->first_glyph
->pixel_width
;
22830 /* If the specified font could not be loaded, use the frame's
22831 default font, but record the fact that we couldn't load it in
22832 the glyph string so that we can draw rectangles for the
22833 characters of the glyph string. */
22834 if (s
->font
== NULL
)
22836 s
->font_not_found_p
= 1;
22837 s
->font
= FRAME_FONT (s
->f
);
22840 /* Adjust base line for subscript/superscript text. */
22841 s
->ybase
+= s
->first_glyph
->voffset
;
22843 /* This glyph string must always be drawn with 16-bit functions. */
22850 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22851 int start
, int end
, int overlaps
)
22853 struct glyph
*glyph
, *last
;
22854 Lisp_Object lgstring
;
22857 s
->for_overlaps
= overlaps
;
22858 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22859 last
= s
->row
->glyphs
[s
->area
] + end
;
22860 s
->cmp_id
= glyph
->u
.cmp
.id
;
22861 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22862 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22863 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22864 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22865 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22867 while (glyph
< last
22868 && glyph
->u
.cmp
.automatic
22869 && glyph
->u
.cmp
.id
== s
->cmp_id
22870 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22871 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22873 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22875 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22876 unsigned code
= LGLYPH_CODE (lglyph
);
22878 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22880 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22881 return glyph
- s
->row
->glyphs
[s
->area
];
22885 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22886 See the comment of fill_glyph_string for arguments.
22887 Value is the index of the first glyph not in S. */
22891 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22892 int start
, int end
, int overlaps
)
22894 struct glyph
*glyph
, *last
;
22897 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22898 s
->for_overlaps
= overlaps
;
22899 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22900 last
= s
->row
->glyphs
[s
->area
] + end
;
22901 voffset
= glyph
->voffset
;
22902 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22903 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22905 s
->width
= glyph
->pixel_width
;
22907 while (glyph
< last
22908 && glyph
->type
== GLYPHLESS_GLYPH
22909 && glyph
->voffset
== voffset
22910 && glyph
->face_id
== face_id
)
22913 s
->width
+= glyph
->pixel_width
;
22916 s
->ybase
+= voffset
;
22917 return glyph
- s
->row
->glyphs
[s
->area
];
22921 /* Fill glyph string S from a sequence of character glyphs.
22923 FACE_ID is the face id of the string. START is the index of the
22924 first glyph to consider, END is the index of the last + 1.
22925 OVERLAPS non-zero means S should draw the foreground only, and use
22926 its physical height for clipping. See also draw_glyphs.
22928 Value is the index of the first glyph not in S. */
22931 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22932 int start
, int end
, int overlaps
)
22934 struct glyph
*glyph
, *last
;
22936 int glyph_not_available_p
;
22938 eassert (s
->f
== XFRAME (s
->w
->frame
));
22939 eassert (s
->nchars
== 0);
22940 eassert (start
>= 0 && end
> start
);
22942 s
->for_overlaps
= overlaps
;
22943 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22944 last
= s
->row
->glyphs
[s
->area
] + end
;
22945 voffset
= glyph
->voffset
;
22946 s
->padding_p
= glyph
->padding_p
;
22947 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22949 while (glyph
< last
22950 && glyph
->type
== CHAR_GLYPH
22951 && glyph
->voffset
== voffset
22952 /* Same face id implies same font, nowadays. */
22953 && glyph
->face_id
== face_id
22954 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22958 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22959 s
->char2b
+ s
->nchars
,
22961 s
->two_byte_p
= two_byte_p
;
22963 eassert (s
->nchars
<= end
- start
);
22964 s
->width
+= glyph
->pixel_width
;
22965 if (glyph
++->padding_p
!= s
->padding_p
)
22969 s
->font
= s
->face
->font
;
22971 /* If the specified font could not be loaded, use the frame's font,
22972 but record the fact that we couldn't load it in
22973 S->font_not_found_p so that we can draw rectangles for the
22974 characters of the glyph string. */
22975 if (s
->font
== NULL
|| glyph_not_available_p
)
22977 s
->font_not_found_p
= 1;
22978 s
->font
= FRAME_FONT (s
->f
);
22981 /* Adjust base line for subscript/superscript text. */
22982 s
->ybase
+= voffset
;
22984 eassert (s
->face
&& s
->face
->gc
);
22985 return glyph
- s
->row
->glyphs
[s
->area
];
22989 /* Fill glyph string S from image glyph S->first_glyph. */
22992 fill_image_glyph_string (struct glyph_string
*s
)
22994 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22995 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22997 s
->slice
= s
->first_glyph
->slice
.img
;
22998 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22999 s
->font
= s
->face
->font
;
23000 s
->width
= s
->first_glyph
->pixel_width
;
23002 /* Adjust base line for subscript/superscript text. */
23003 s
->ybase
+= s
->first_glyph
->voffset
;
23006 #ifdef HAVE_XWIDGETS
23008 fill_xwidget_glyph_string (struct glyph_string
*s
)
23010 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
23011 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
23012 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23013 s
->font
= s
->face
->font
;
23014 s
->width
= s
->first_glyph
->pixel_width
;
23015 s
->ybase
+= s
->first_glyph
->voffset
;
23016 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
23017 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
23020 /* Fill glyph string S from a sequence of stretch glyphs.
23022 START is the index of the first glyph to consider,
23023 END is the index of the last + 1.
23025 Value is the index of the first glyph not in S. */
23028 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
23030 struct glyph
*glyph
, *last
;
23031 int voffset
, face_id
;
23033 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
23035 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23036 last
= s
->row
->glyphs
[s
->area
] + end
;
23037 face_id
= glyph
->face_id
;
23038 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23039 s
->font
= s
->face
->font
;
23040 s
->width
= glyph
->pixel_width
;
23042 voffset
= glyph
->voffset
;
23046 && glyph
->type
== STRETCH_GLYPH
23047 && glyph
->voffset
== voffset
23048 && glyph
->face_id
== face_id
);
23050 s
->width
+= glyph
->pixel_width
;
23052 /* Adjust base line for subscript/superscript text. */
23053 s
->ybase
+= voffset
;
23055 /* The case that face->gc == 0 is handled when drawing the glyph
23056 string by calling PREPARE_FACE_FOR_DISPLAY. */
23058 return glyph
- s
->row
->glyphs
[s
->area
];
23061 static struct font_metrics
*
23062 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
23064 static struct font_metrics metrics
;
23065 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
23067 if (! font
|| code
== FONT_INVALID_CODE
)
23069 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
23074 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
23075 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
23076 assumed to be zero. */
23079 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
23081 *left
= *right
= 0;
23083 if (glyph
->type
== CHAR_GLYPH
)
23087 struct font_metrics
*pcm
;
23089 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
23090 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
23092 if (pcm
->rbearing
> pcm
->width
)
23093 *right
= pcm
->rbearing
- pcm
->width
;
23094 if (pcm
->lbearing
< 0)
23095 *left
= -pcm
->lbearing
;
23098 else if (glyph
->type
== COMPOSITE_GLYPH
)
23100 if (! glyph
->u
.cmp
.automatic
)
23102 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
23104 if (cmp
->rbearing
> cmp
->pixel_width
)
23105 *right
= cmp
->rbearing
- cmp
->pixel_width
;
23106 if (cmp
->lbearing
< 0)
23107 *left
= - cmp
->lbearing
;
23111 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
23112 struct font_metrics metrics
;
23114 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
23115 glyph
->slice
.cmp
.to
+ 1, &metrics
);
23116 if (metrics
.rbearing
> metrics
.width
)
23117 *right
= metrics
.rbearing
- metrics
.width
;
23118 if (metrics
.lbearing
< 0)
23119 *left
= - metrics
.lbearing
;
23125 /* Return the index of the first glyph preceding glyph string S that
23126 is overwritten by S because of S's left overhang. Value is -1
23127 if no glyphs are overwritten. */
23130 left_overwritten (struct glyph_string
*s
)
23134 if (s
->left_overhang
)
23137 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23138 int first
= s
->first_glyph
- glyphs
;
23140 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
23141 x
-= glyphs
[i
].pixel_width
;
23152 /* Return the index of the first glyph preceding glyph string S that
23153 is overwriting S because of its right overhang. Value is -1 if no
23154 glyph in front of S overwrites S. */
23157 left_overwriting (struct glyph_string
*s
)
23160 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23161 int first
= s
->first_glyph
- glyphs
;
23165 for (i
= first
- 1; i
>= 0; --i
)
23168 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23171 x
-= glyphs
[i
].pixel_width
;
23178 /* Return the index of the last glyph following glyph string S that is
23179 overwritten by S because of S's right overhang. Value is -1 if
23180 no such glyph is found. */
23183 right_overwritten (struct glyph_string
*s
)
23187 if (s
->right_overhang
)
23190 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23191 int first
= (s
->first_glyph
- glyphs
23192 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23193 int end
= s
->row
->used
[s
->area
];
23195 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23196 x
+= glyphs
[i
].pixel_width
;
23205 /* Return the index of the last glyph following glyph string S that
23206 overwrites S because of its left overhang. Value is negative
23207 if no such glyph is found. */
23210 right_overwriting (struct glyph_string
*s
)
23213 int end
= s
->row
->used
[s
->area
];
23214 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23215 int first
= (s
->first_glyph
- glyphs
23216 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23220 for (i
= first
; i
< end
; ++i
)
23223 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23226 x
+= glyphs
[i
].pixel_width
;
23233 /* Set background width of glyph string S. START is the index of the
23234 first glyph following S. LAST_X is the right-most x-position + 1
23235 in the drawing area. */
23238 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23240 /* If the face of this glyph string has to be drawn to the end of
23241 the drawing area, set S->extends_to_end_of_line_p. */
23243 if (start
== s
->row
->used
[s
->area
]
23244 && s
->area
== TEXT_AREA
23245 && ((s
->row
->fill_line_p
23246 && (s
->hl
== DRAW_NORMAL_TEXT
23247 || s
->hl
== DRAW_IMAGE_RAISED
23248 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23249 || s
->hl
== DRAW_MOUSE_FACE
))
23250 s
->extends_to_end_of_line_p
= 1;
23252 /* If S extends its face to the end of the line, set its
23253 background_width to the distance to the right edge of the drawing
23255 if (s
->extends_to_end_of_line_p
)
23256 s
->background_width
= last_x
- s
->x
+ 1;
23258 s
->background_width
= s
->width
;
23262 /* Compute overhangs and x-positions for glyph string S and its
23263 predecessors, or successors. X is the starting x-position for S.
23264 BACKWARD_P non-zero means process predecessors. */
23267 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23273 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23274 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23284 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23285 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23295 /* The following macros are only called from draw_glyphs below.
23296 They reference the following parameters of that function directly:
23297 `w', `row', `area', and `overlap_p'
23298 as well as the following local variables:
23299 `s', `f', and `hdc' (in W32) */
23302 /* On W32, silently add local `hdc' variable to argument list of
23303 init_glyph_string. */
23304 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23305 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23307 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23308 init_glyph_string (s, char2b, w, row, area, start, hl)
23311 /* Add a glyph string for a stretch glyph to the list of strings
23312 between HEAD and TAIL. START is the index of the stretch glyph in
23313 row area AREA of glyph row ROW. END is the index of the last glyph
23314 in that glyph row area. X is the current output position assigned
23315 to the new glyph string constructed. HL overrides that face of the
23316 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23317 is the right-most x-position of the drawing area. */
23319 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23320 and below -- keep them on one line. */
23321 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23324 s = alloca (sizeof *s); \
23325 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23326 START = fill_stretch_glyph_string (s, START, END); \
23327 append_glyph_string (&HEAD, &TAIL, s); \
23333 /* Add a glyph string for an image glyph to the list of strings
23334 between HEAD and TAIL. START is the index of the image glyph in
23335 row area AREA of glyph row ROW. END is the index of the last glyph
23336 in that glyph row area. X is the current output position assigned
23337 to the new glyph string constructed. HL overrides that face of the
23338 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23339 is the right-most x-position of the drawing area. */
23341 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23344 s = alloca (sizeof *s); \
23345 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23346 fill_image_glyph_string (s); \
23347 append_glyph_string (&HEAD, &TAIL, s); \
23353 #ifdef HAVE_XWIDGETS
23354 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23357 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
23358 s = (struct glyph_string *) alloca (sizeof *s); \
23359 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23360 fill_xwidget_glyph_string (s); \
23361 append_glyph_string (&HEAD, &TAIL, s); \
23369 /* Add a glyph string for a sequence of character glyphs to the list
23370 of strings between HEAD and TAIL. START is the index of the first
23371 glyph in row area AREA of glyph row ROW that is part of the new
23372 glyph string. END is the index of the last glyph in that glyph row
23373 area. X is the current output position assigned to the new glyph
23374 string constructed. HL overrides that face of the glyph; e.g. it
23375 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23376 right-most x-position of the drawing area. */
23378 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23384 face_id = (row)->glyphs[area][START].face_id; \
23386 s = alloca (sizeof *s); \
23387 char2b = alloca ((END - START) * sizeof *char2b); \
23388 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23389 append_glyph_string (&HEAD, &TAIL, s); \
23391 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23396 /* Add a glyph string for a composite sequence to the list of strings
23397 between HEAD and TAIL. START is the index of the first glyph in
23398 row area AREA of glyph row ROW that is part of the new glyph
23399 string. END is the index of the last glyph in that glyph row area.
23400 X is the current output position assigned to the new glyph string
23401 constructed. HL overrides that face of the glyph; e.g. it is
23402 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23403 x-position of the drawing area. */
23405 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23407 int face_id = (row)->glyphs[area][START].face_id; \
23408 struct face *base_face = FACE_FROM_ID (f, face_id); \
23409 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23410 struct composition *cmp = composition_table[cmp_id]; \
23412 struct glyph_string *first_s = NULL; \
23415 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23417 /* Make glyph_strings for each glyph sequence that is drawable by \
23418 the same face, and append them to HEAD/TAIL. */ \
23419 for (n = 0; n < cmp->glyph_len;) \
23421 s = alloca (sizeof *s); \
23422 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23423 append_glyph_string (&(HEAD), &(TAIL), s); \
23429 n = fill_composite_glyph_string (s, base_face, overlaps); \
23437 /* Add a glyph string for a glyph-string sequence to the list of strings
23438 between HEAD and TAIL. */
23440 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23444 Lisp_Object gstring; \
23446 face_id = (row)->glyphs[area][START].face_id; \
23447 gstring = (composition_gstring_from_id \
23448 ((row)->glyphs[area][START].u.cmp.id)); \
23449 s = alloca (sizeof *s); \
23450 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23451 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23452 append_glyph_string (&(HEAD), &(TAIL), s); \
23454 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23458 /* Add a glyph string for a sequence of glyphless character's glyphs
23459 to the list of strings between HEAD and TAIL. The meanings of
23460 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23462 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23467 face_id = (row)->glyphs[area][START].face_id; \
23469 s = alloca (sizeof *s); \
23470 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23471 append_glyph_string (&HEAD, &TAIL, s); \
23473 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23479 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23480 of AREA of glyph row ROW on window W between indices START and END.
23481 HL overrides the face for drawing glyph strings, e.g. it is
23482 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23483 x-positions of the drawing area.
23485 This is an ugly monster macro construct because we must use alloca
23486 to allocate glyph strings (because draw_glyphs can be called
23487 asynchronously). */
23489 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
23492 HEAD = TAIL = NULL; \
23493 while (START < END) \
23495 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23496 switch (first_glyph->type) \
23499 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23503 case COMPOSITE_GLYPH: \
23504 if (first_glyph->u.cmp.automatic) \
23505 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23508 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23512 case STRETCH_GLYPH: \
23513 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23517 case IMAGE_GLYPH: \
23518 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23522 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
23523 case XWIDGET_GLYPH: \
23524 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
23528 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
23529 case GLYPHLESS_GLYPH: \
23530 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23540 set_glyph_string_background_width (s, START, LAST_X); \
23547 #ifdef HAVE_XWIDGETS
23548 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23549 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
23550 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
23551 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
23553 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23554 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
23555 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
23559 /* Draw glyphs between START and END in AREA of ROW on window W,
23560 starting at x-position X. X is relative to AREA in W. HL is a
23561 face-override with the following meaning:
23563 DRAW_NORMAL_TEXT draw normally
23564 DRAW_CURSOR draw in cursor face
23565 DRAW_MOUSE_FACE draw in mouse face.
23566 DRAW_INVERSE_VIDEO draw in mode line face
23567 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23568 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23570 If OVERLAPS is non-zero, draw only the foreground of characters and
23571 clip to the physical height of ROW. Non-zero value also defines
23572 the overlapping part to be drawn:
23574 OVERLAPS_PRED overlap with preceding rows
23575 OVERLAPS_SUCC overlap with succeeding rows
23576 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23577 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23579 Value is the x-position reached, relative to AREA of W. */
23582 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23583 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23584 enum draw_glyphs_face hl
, int overlaps
)
23586 struct glyph_string
*head
, *tail
;
23587 struct glyph_string
*s
;
23588 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23589 int i
, j
, x_reached
, last_x
, area_left
= 0;
23590 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23593 ALLOCATE_HDC (hdc
, f
);
23595 /* Let's rather be paranoid than getting a SEGV. */
23596 end
= min (end
, row
->used
[area
]);
23597 start
= clip_to_bounds (0, start
, end
);
23599 /* Translate X to frame coordinates. Set last_x to the right
23600 end of the drawing area. */
23601 if (row
->full_width_p
)
23603 /* X is relative to the left edge of W, without scroll bars
23605 area_left
= WINDOW_LEFT_EDGE_X (w
);
23606 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23610 area_left
= window_box_left (w
, area
);
23611 last_x
= area_left
+ window_box_width (w
, area
);
23615 /* Build a doubly-linked list of glyph_string structures between
23616 head and tail from what we have to draw. Note that the macro
23617 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23618 the reason we use a separate variable `i'. */
23620 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23622 x_reached
= tail
->x
+ tail
->background_width
;
23626 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23627 the row, redraw some glyphs in front or following the glyph
23628 strings built above. */
23629 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23631 struct glyph_string
*h
, *t
;
23632 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23633 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23634 int check_mouse_face
= 0;
23637 /* If mouse highlighting is on, we may need to draw adjacent
23638 glyphs using mouse-face highlighting. */
23639 if (area
== TEXT_AREA
&& row
->mouse_face_p
23640 && hlinfo
->mouse_face_beg_row
>= 0
23641 && hlinfo
->mouse_face_end_row
>= 0)
23643 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23645 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23646 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23648 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23650 check_mouse_face
= 1;
23651 mouse_beg_col
= (row
== mouse_beg_row
)
23652 ? hlinfo
->mouse_face_beg_col
: 0;
23653 mouse_end_col
= (row
== mouse_end_row
)
23654 ? hlinfo
->mouse_face_end_col
23655 : row
->used
[TEXT_AREA
];
23659 /* Compute overhangs for all glyph strings. */
23660 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23661 for (s
= head
; s
; s
= s
->next
)
23662 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23664 /* Prepend glyph strings for glyphs in front of the first glyph
23665 string that are overwritten because of the first glyph
23666 string's left overhang. The background of all strings
23667 prepended must be drawn because the first glyph string
23669 i
= left_overwritten (head
);
23672 enum draw_glyphs_face overlap_hl
;
23674 /* If this row contains mouse highlighting, attempt to draw
23675 the overlapped glyphs with the correct highlight. This
23676 code fails if the overlap encompasses more than one glyph
23677 and mouse-highlight spans only some of these glyphs.
23678 However, making it work perfectly involves a lot more
23679 code, and I don't know if the pathological case occurs in
23680 practice, so we'll stick to this for now. --- cyd */
23681 if (check_mouse_face
23682 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23683 overlap_hl
= DRAW_MOUSE_FACE
;
23685 overlap_hl
= DRAW_NORMAL_TEXT
;
23688 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23689 overlap_hl
, dummy_x
, last_x
);
23691 compute_overhangs_and_x (t
, head
->x
, 1);
23692 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23696 /* Prepend glyph strings for glyphs in front of the first glyph
23697 string that overwrite that glyph string because of their
23698 right overhang. For these strings, only the foreground must
23699 be drawn, because it draws over the glyph string at `head'.
23700 The background must not be drawn because this would overwrite
23701 right overhangs of preceding glyphs for which no glyph
23703 i
= left_overwriting (head
);
23706 enum draw_glyphs_face overlap_hl
;
23708 if (check_mouse_face
23709 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23710 overlap_hl
= DRAW_MOUSE_FACE
;
23712 overlap_hl
= DRAW_NORMAL_TEXT
;
23715 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23716 overlap_hl
, dummy_x
, last_x
);
23717 for (s
= h
; s
; s
= s
->next
)
23718 s
->background_filled_p
= 1;
23719 compute_overhangs_and_x (t
, head
->x
, 1);
23720 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23723 /* Append glyphs strings for glyphs following the last glyph
23724 string tail that are overwritten by tail. The background of
23725 these strings has to be drawn because tail's foreground draws
23727 i
= right_overwritten (tail
);
23730 enum draw_glyphs_face overlap_hl
;
23732 if (check_mouse_face
23733 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23734 overlap_hl
= DRAW_MOUSE_FACE
;
23736 overlap_hl
= DRAW_NORMAL_TEXT
;
23738 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23739 overlap_hl
, x
, last_x
);
23740 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23741 we don't have `end = i;' here. */
23742 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23743 append_glyph_string_lists (&head
, &tail
, h
, t
);
23747 /* Append glyph strings for glyphs following the last glyph
23748 string tail that overwrite tail. The foreground of such
23749 glyphs has to be drawn because it writes into the background
23750 of tail. The background must not be drawn because it could
23751 paint over the foreground of following glyphs. */
23752 i
= right_overwriting (tail
);
23755 enum draw_glyphs_face overlap_hl
;
23756 if (check_mouse_face
23757 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23758 overlap_hl
= DRAW_MOUSE_FACE
;
23760 overlap_hl
= DRAW_NORMAL_TEXT
;
23763 i
++; /* We must include the Ith glyph. */
23764 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23765 overlap_hl
, x
, last_x
);
23766 for (s
= h
; s
; s
= s
->next
)
23767 s
->background_filled_p
= 1;
23768 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23769 append_glyph_string_lists (&head
, &tail
, h
, t
);
23771 if (clip_head
|| clip_tail
)
23772 for (s
= head
; s
; s
= s
->next
)
23774 s
->clip_head
= clip_head
;
23775 s
->clip_tail
= clip_tail
;
23779 /* Draw all strings. */
23780 for (s
= head
; s
; s
= s
->next
)
23781 FRAME_RIF (f
)->draw_glyph_string (s
);
23784 /* When focus a sole frame and move horizontally, this sets on_p to 0
23785 causing a failure to erase prev cursor position. */
23786 if (area
== TEXT_AREA
23787 && !row
->full_width_p
23788 /* When drawing overlapping rows, only the glyph strings'
23789 foreground is drawn, which doesn't erase a cursor
23793 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23794 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23795 : (tail
? tail
->x
+ tail
->background_width
: x
));
23799 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23800 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23804 /* Value is the x-position up to which drawn, relative to AREA of W.
23805 This doesn't include parts drawn because of overhangs. */
23806 if (row
->full_width_p
)
23807 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23809 x_reached
-= area_left
;
23811 RELEASE_HDC (hdc
, f
);
23816 /* Expand row matrix if too narrow. Don't expand if area
23819 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23821 if (!fonts_changed_p \
23822 && (it->glyph_row->glyphs[area] \
23823 < it->glyph_row->glyphs[area + 1])) \
23825 it->w->ncols_scale_factor++; \
23826 fonts_changed_p = 1; \
23830 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23831 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23834 append_glyph (struct it
*it
)
23836 struct glyph
*glyph
;
23837 enum glyph_row_area area
= it
->area
;
23839 eassert (it
->glyph_row
);
23840 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23842 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23843 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23845 /* If the glyph row is reversed, we need to prepend the glyph
23846 rather than append it. */
23847 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23851 /* Make room for the additional glyph. */
23852 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23854 glyph
= it
->glyph_row
->glyphs
[area
];
23856 glyph
->charpos
= CHARPOS (it
->position
);
23857 glyph
->object
= it
->object
;
23858 if (it
->pixel_width
> 0)
23860 glyph
->pixel_width
= it
->pixel_width
;
23861 glyph
->padding_p
= 0;
23865 /* Assure at least 1-pixel width. Otherwise, cursor can't
23866 be displayed correctly. */
23867 glyph
->pixel_width
= 1;
23868 glyph
->padding_p
= 1;
23870 glyph
->ascent
= it
->ascent
;
23871 glyph
->descent
= it
->descent
;
23872 glyph
->voffset
= it
->voffset
;
23873 glyph
->type
= CHAR_GLYPH
;
23874 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23875 glyph
->multibyte_p
= it
->multibyte_p
;
23876 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23878 /* In R2L rows, the left and the right box edges need to be
23879 drawn in reverse direction. */
23880 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23881 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23885 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23886 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23888 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23889 || it
->phys_descent
> it
->descent
);
23890 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23891 glyph
->face_id
= it
->face_id
;
23892 glyph
->u
.ch
= it
->char_to_display
;
23893 glyph
->slice
.img
= null_glyph_slice
;
23894 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23897 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23898 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23900 glyph
->bidi_type
= it
->bidi_it
.type
;
23904 glyph
->resolved_level
= 0;
23905 glyph
->bidi_type
= UNKNOWN_BT
;
23907 ++it
->glyph_row
->used
[area
];
23910 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23913 /* Store one glyph for the composition IT->cmp_it.id in
23914 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23918 append_composite_glyph (struct it
*it
)
23920 struct glyph
*glyph
;
23921 enum glyph_row_area area
= it
->area
;
23923 eassert (it
->glyph_row
);
23925 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23926 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23928 /* If the glyph row is reversed, we need to prepend the glyph
23929 rather than append it. */
23930 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23934 /* Make room for the new glyph. */
23935 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23937 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23939 glyph
->charpos
= it
->cmp_it
.charpos
;
23940 glyph
->object
= it
->object
;
23941 glyph
->pixel_width
= it
->pixel_width
;
23942 glyph
->ascent
= it
->ascent
;
23943 glyph
->descent
= it
->descent
;
23944 glyph
->voffset
= it
->voffset
;
23945 glyph
->type
= COMPOSITE_GLYPH
;
23946 if (it
->cmp_it
.ch
< 0)
23948 glyph
->u
.cmp
.automatic
= 0;
23949 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23950 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23954 glyph
->u
.cmp
.automatic
= 1;
23955 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23956 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23957 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23959 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23960 glyph
->multibyte_p
= it
->multibyte_p
;
23961 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23963 /* In R2L rows, the left and the right box edges need to be
23964 drawn in reverse direction. */
23965 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
23966 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
23970 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23971 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23973 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23974 || it
->phys_descent
> it
->descent
);
23975 glyph
->padding_p
= 0;
23976 glyph
->glyph_not_available_p
= 0;
23977 glyph
->face_id
= it
->face_id
;
23978 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23981 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23982 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23984 glyph
->bidi_type
= it
->bidi_it
.type
;
23986 ++it
->glyph_row
->used
[area
];
23989 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23993 /* Change IT->ascent and IT->height according to the setting of
23997 take_vertical_position_into_account (struct it
*it
)
24001 if (it
->voffset
< 0)
24002 /* Increase the ascent so that we can display the text higher
24004 it
->ascent
-= it
->voffset
;
24006 /* Increase the descent so that we can display the text lower
24008 it
->descent
+= it
->voffset
;
24013 /* Produce glyphs/get display metrics for the image IT is loaded with.
24014 See the description of struct display_iterator in dispextern.h for
24015 an overview of struct display_iterator. */
24018 produce_image_glyph (struct it
*it
)
24022 int glyph_ascent
, crop
;
24023 struct glyph_slice slice
;
24025 eassert (it
->what
== IT_IMAGE
);
24027 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24029 /* Make sure X resources of the face is loaded. */
24030 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24032 if (it
->image_id
< 0)
24034 /* Fringe bitmap. */
24035 it
->ascent
= it
->phys_ascent
= 0;
24036 it
->descent
= it
->phys_descent
= 0;
24037 it
->pixel_width
= 0;
24042 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24044 /* Make sure X resources of the image is loaded. */
24045 prepare_image_for_display (it
->f
, img
);
24047 slice
.x
= slice
.y
= 0;
24048 slice
.width
= img
->width
;
24049 slice
.height
= img
->height
;
24051 if (INTEGERP (it
->slice
.x
))
24052 slice
.x
= XINT (it
->slice
.x
);
24053 else if (FLOATP (it
->slice
.x
))
24054 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
24056 if (INTEGERP (it
->slice
.y
))
24057 slice
.y
= XINT (it
->slice
.y
);
24058 else if (FLOATP (it
->slice
.y
))
24059 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
24061 if (INTEGERP (it
->slice
.width
))
24062 slice
.width
= XINT (it
->slice
.width
);
24063 else if (FLOATP (it
->slice
.width
))
24064 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
24066 if (INTEGERP (it
->slice
.height
))
24067 slice
.height
= XINT (it
->slice
.height
);
24068 else if (FLOATP (it
->slice
.height
))
24069 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
24071 if (slice
.x
>= img
->width
)
24072 slice
.x
= img
->width
;
24073 if (slice
.y
>= img
->height
)
24074 slice
.y
= img
->height
;
24075 if (slice
.x
+ slice
.width
>= img
->width
)
24076 slice
.width
= img
->width
- slice
.x
;
24077 if (slice
.y
+ slice
.height
> img
->height
)
24078 slice
.height
= img
->height
- slice
.y
;
24080 if (slice
.width
== 0 || slice
.height
== 0)
24083 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
24085 it
->descent
= slice
.height
- glyph_ascent
;
24087 it
->descent
+= img
->vmargin
;
24088 if (slice
.y
+ slice
.height
== img
->height
)
24089 it
->descent
+= img
->vmargin
;
24090 it
->phys_descent
= it
->descent
;
24092 it
->pixel_width
= slice
.width
;
24094 it
->pixel_width
+= img
->hmargin
;
24095 if (slice
.x
+ slice
.width
== img
->width
)
24096 it
->pixel_width
+= img
->hmargin
;
24098 /* It's quite possible for images to have an ascent greater than
24099 their height, so don't get confused in that case. */
24100 if (it
->descent
< 0)
24105 if (face
->box
!= FACE_NO_BOX
)
24107 if (face
->box_line_width
> 0)
24110 it
->ascent
+= face
->box_line_width
;
24111 if (slice
.y
+ slice
.height
== img
->height
)
24112 it
->descent
+= face
->box_line_width
;
24115 if (it
->start_of_box_run_p
&& slice
.x
== 0)
24116 it
->pixel_width
+= eabs (face
->box_line_width
);
24117 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
24118 it
->pixel_width
+= eabs (face
->box_line_width
);
24121 take_vertical_position_into_account (it
);
24123 /* Automatically crop wide image glyphs at right edge so we can
24124 draw the cursor on same display row. */
24125 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24126 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24128 it
->pixel_width
-= crop
;
24129 slice
.width
-= crop
;
24134 struct glyph
*glyph
;
24135 enum glyph_row_area area
= it
->area
;
24137 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24138 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24140 glyph
->charpos
= CHARPOS (it
->position
);
24141 glyph
->object
= it
->object
;
24142 glyph
->pixel_width
= it
->pixel_width
;
24143 glyph
->ascent
= glyph_ascent
;
24144 glyph
->descent
= it
->descent
;
24145 glyph
->voffset
= it
->voffset
;
24146 glyph
->type
= IMAGE_GLYPH
;
24147 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24148 glyph
->multibyte_p
= it
->multibyte_p
;
24149 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24151 /* In R2L rows, the left and the right box edges need to be
24152 drawn in reverse direction. */
24153 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24154 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24158 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24159 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24161 glyph
->overlaps_vertically_p
= 0;
24162 glyph
->padding_p
= 0;
24163 glyph
->glyph_not_available_p
= 0;
24164 glyph
->face_id
= it
->face_id
;
24165 glyph
->u
.img_id
= img
->id
;
24166 glyph
->slice
.img
= slice
;
24167 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24170 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24171 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24173 glyph
->bidi_type
= it
->bidi_it
.type
;
24175 ++it
->glyph_row
->used
[area
];
24178 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24182 #ifdef HAVE_XWIDGETS
24184 produce_xwidget_glyph (struct it
*it
)
24186 struct xwidget
* xw
;
24188 int glyph_ascent
, crop
;
24189 printf("produce_xwidget_glyph:\n");
24190 eassert (it
->what
== IT_XWIDGET
);
24192 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24194 /* Make sure X resources of the face is loaded. */
24195 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24198 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
24199 it
->descent
= xw
->height
/2;
24200 it
->phys_descent
= it
->descent
;
24201 it
->pixel_width
= xw
->width
;
24202 /* It's quite possible for images to have an ascent greater than
24203 their height, so don't get confused in that case. */
24204 if (it
->descent
< 0)
24209 if (face
->box
!= FACE_NO_BOX
)
24211 if (face
->box_line_width
> 0)
24213 it
->ascent
+= face
->box_line_width
;
24214 it
->descent
+= face
->box_line_width
;
24217 if (it
->start_of_box_run_p
)
24218 it
->pixel_width
+= eabs (face
->box_line_width
);
24219 it
->pixel_width
+= eabs (face
->box_line_width
);
24222 take_vertical_position_into_account (it
);
24224 /* Automatically crop wide image glyphs at right edge so we can
24225 draw the cursor on same display row. */
24226 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24227 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24229 it
->pixel_width
-= crop
;
24234 struct glyph
*glyph
;
24235 enum glyph_row_area area
= it
->area
;
24237 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24238 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24240 glyph
->charpos
= CHARPOS (it
->position
);
24241 glyph
->object
= it
->object
;
24242 glyph
->pixel_width
= it
->pixel_width
;
24243 glyph
->ascent
= glyph_ascent
;
24244 glyph
->descent
= it
->descent
;
24245 glyph
->voffset
= it
->voffset
;
24246 glyph
->type
= XWIDGET_GLYPH
;
24248 glyph
->multibyte_p
= it
->multibyte_p
;
24249 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24250 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24251 glyph
->overlaps_vertically_p
= 0;
24252 glyph
->padding_p
= 0;
24253 glyph
->glyph_not_available_p
= 0;
24254 glyph
->face_id
= it
->face_id
;
24255 glyph
->u
.xwidget
= it
->xwidget
;
24256 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
24257 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24258 ++it
->glyph_row
->used
[area
];
24261 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24266 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
24267 of the glyph, WIDTH and HEIGHT are the width and height of the
24268 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
24271 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
24272 int width
, int height
, int ascent
)
24274 struct glyph
*glyph
;
24275 enum glyph_row_area area
= it
->area
;
24277 eassert (ascent
>= 0 && ascent
<= height
);
24279 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24280 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24282 /* If the glyph row is reversed, we need to prepend the glyph
24283 rather than append it. */
24284 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24288 /* Make room for the additional glyph. */
24289 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24291 glyph
= it
->glyph_row
->glyphs
[area
];
24293 glyph
->charpos
= CHARPOS (it
->position
);
24294 glyph
->object
= object
;
24295 glyph
->pixel_width
= width
;
24296 glyph
->ascent
= ascent
;
24297 glyph
->descent
= height
- ascent
;
24298 glyph
->voffset
= it
->voffset
;
24299 glyph
->type
= STRETCH_GLYPH
;
24300 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24301 glyph
->multibyte_p
= it
->multibyte_p
;
24302 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24304 /* In R2L rows, the left and the right box edges need to be
24305 drawn in reverse direction. */
24306 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24307 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24311 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24312 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24314 glyph
->overlaps_vertically_p
= 0;
24315 glyph
->padding_p
= 0;
24316 glyph
->glyph_not_available_p
= 0;
24317 glyph
->face_id
= it
->face_id
;
24318 glyph
->u
.stretch
.ascent
= ascent
;
24319 glyph
->u
.stretch
.height
= height
;
24320 glyph
->slice
.img
= null_glyph_slice
;
24321 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24324 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24325 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24327 glyph
->bidi_type
= it
->bidi_it
.type
;
24331 glyph
->resolved_level
= 0;
24332 glyph
->bidi_type
= UNKNOWN_BT
;
24334 ++it
->glyph_row
->used
[area
];
24337 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24340 #endif /* HAVE_WINDOW_SYSTEM */
24342 /* Produce a stretch glyph for iterator IT. IT->object is the value
24343 of the glyph property displayed. The value must be a list
24344 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24347 1. `:width WIDTH' specifies that the space should be WIDTH *
24348 canonical char width wide. WIDTH may be an integer or floating
24351 2. `:relative-width FACTOR' specifies that the width of the stretch
24352 should be computed from the width of the first character having the
24353 `glyph' property, and should be FACTOR times that width.
24355 3. `:align-to HPOS' specifies that the space should be wide enough
24356 to reach HPOS, a value in canonical character units.
24358 Exactly one of the above pairs must be present.
24360 4. `:height HEIGHT' specifies that the height of the stretch produced
24361 should be HEIGHT, measured in canonical character units.
24363 5. `:relative-height FACTOR' specifies that the height of the
24364 stretch should be FACTOR times the height of the characters having
24365 the glyph property.
24367 Either none or exactly one of 4 or 5 must be present.
24369 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24370 of the stretch should be used for the ascent of the stretch.
24371 ASCENT must be in the range 0 <= ASCENT <= 100. */
24374 produce_stretch_glyph (struct it
*it
)
24376 /* (space :width WIDTH :height HEIGHT ...) */
24377 Lisp_Object prop
, plist
;
24378 int width
= 0, height
= 0, align_to
= -1;
24379 int zero_width_ok_p
= 0;
24381 struct font
*font
= NULL
;
24383 #ifdef HAVE_WINDOW_SYSTEM
24385 int zero_height_ok_p
= 0;
24387 if (FRAME_WINDOW_P (it
->f
))
24389 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24390 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24391 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24395 /* List should start with `space'. */
24396 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24397 plist
= XCDR (it
->object
);
24399 /* Compute the width of the stretch. */
24400 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24401 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24403 /* Absolute width `:width WIDTH' specified and valid. */
24404 zero_width_ok_p
= 1;
24407 #ifdef HAVE_WINDOW_SYSTEM
24408 else if (FRAME_WINDOW_P (it
->f
)
24409 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24411 /* Relative width `:relative-width FACTOR' specified and valid.
24412 Compute the width of the characters having the `glyph'
24415 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24418 if (it
->multibyte_p
)
24419 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24422 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24423 if (! ASCII_CHAR_P (it2
.c
))
24424 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24427 it2
.glyph_row
= NULL
;
24428 it2
.what
= IT_CHARACTER
;
24429 x_produce_glyphs (&it2
);
24430 width
= NUMVAL (prop
) * it2
.pixel_width
;
24432 #endif /* HAVE_WINDOW_SYSTEM */
24433 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24434 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24436 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24437 align_to
= (align_to
< 0
24439 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24440 else if (align_to
< 0)
24441 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24442 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24443 zero_width_ok_p
= 1;
24446 /* Nothing specified -> width defaults to canonical char width. */
24447 width
= FRAME_COLUMN_WIDTH (it
->f
);
24449 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24452 #ifdef HAVE_WINDOW_SYSTEM
24453 /* Compute height. */
24454 if (FRAME_WINDOW_P (it
->f
))
24456 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24457 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24460 zero_height_ok_p
= 1;
24462 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24464 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24466 height
= FONT_HEIGHT (font
);
24468 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24471 /* Compute percentage of height used for ascent. If
24472 `:ascent ASCENT' is present and valid, use that. Otherwise,
24473 derive the ascent from the font in use. */
24474 if (prop
= Fplist_get (plist
, QCascent
),
24475 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24476 ascent
= height
* NUMVAL (prop
) / 100.0;
24477 else if (!NILP (prop
)
24478 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24479 ascent
= min (max (0, (int)tem
), height
);
24481 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24484 #endif /* HAVE_WINDOW_SYSTEM */
24487 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24488 && it
->current_x
+ width
> it
->last_visible_x
)
24490 width
= it
->last_visible_x
- it
->current_x
;
24491 #ifdef HAVE_WINDOW_SYSTEM
24492 /* Subtract one more pixel from the stretch width, but only on
24493 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24494 width
-= FRAME_WINDOW_P (it
->f
);
24498 if (width
> 0 && height
> 0 && it
->glyph_row
)
24500 Lisp_Object o_object
= it
->object
;
24501 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24504 if (!STRINGP (object
))
24505 object
= it
->w
->buffer
;
24506 #ifdef HAVE_WINDOW_SYSTEM
24507 if (FRAME_WINDOW_P (it
->f
))
24508 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24512 it
->object
= object
;
24513 it
->char_to_display
= ' ';
24514 it
->pixel_width
= it
->len
= 1;
24516 tty_append_glyph (it
);
24517 it
->object
= o_object
;
24521 it
->pixel_width
= width
;
24522 #ifdef HAVE_WINDOW_SYSTEM
24523 if (FRAME_WINDOW_P (it
->f
))
24525 it
->ascent
= it
->phys_ascent
= ascent
;
24526 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24527 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24528 take_vertical_position_into_account (it
);
24532 it
->nglyphs
= width
;
24535 /* Get information about special display element WHAT in an
24536 environment described by IT. WHAT is one of IT_TRUNCATION or
24537 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24538 non-null glyph_row member. This function ensures that fields like
24539 face_id, c, len of IT are left untouched. */
24542 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24549 temp_it
.object
= make_number (0);
24550 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24552 if (what
== IT_CONTINUATION
)
24554 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24555 if (it
->bidi_it
.paragraph_dir
== R2L
)
24556 SET_GLYPH_FROM_CHAR (glyph
, '/');
24558 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24560 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24562 /* FIXME: Should we mirror GC for R2L lines? */
24563 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24564 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24567 else if (what
== IT_TRUNCATION
)
24569 /* Truncation glyph. */
24570 SET_GLYPH_FROM_CHAR (glyph
, '$');
24572 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24574 /* FIXME: Should we mirror GC for R2L lines? */
24575 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24576 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24582 #ifdef HAVE_WINDOW_SYSTEM
24583 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24584 is turned off, we precede the truncation/continuation glyphs by a
24585 stretch glyph whose width is computed such that these special
24586 glyphs are aligned at the window margin, even when very different
24587 fonts are used in different glyph rows. */
24588 if (FRAME_WINDOW_P (temp_it
.f
)
24589 /* init_iterator calls this with it->glyph_row == NULL, and it
24590 wants only the pixel width of the truncation/continuation
24592 && temp_it
.glyph_row
24593 /* insert_left_trunc_glyphs calls us at the beginning of the
24594 row, and it has its own calculation of the stretch glyph
24596 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24597 && (temp_it
.glyph_row
->reversed_p
24598 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24599 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24601 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24603 if (stretch_width
> 0)
24605 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24606 struct font
*font
=
24607 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24608 int stretch_ascent
=
24609 (((temp_it
.ascent
+ temp_it
.descent
)
24610 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24612 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24613 temp_it
.ascent
+ temp_it
.descent
,
24620 temp_it
.what
= IT_CHARACTER
;
24622 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24623 temp_it
.face_id
= GLYPH_FACE (glyph
);
24624 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24626 PRODUCE_GLYPHS (&temp_it
);
24627 it
->pixel_width
= temp_it
.pixel_width
;
24628 it
->nglyphs
= temp_it
.pixel_width
;
24631 #ifdef HAVE_WINDOW_SYSTEM
24633 /* Calculate line-height and line-spacing properties.
24634 An integer value specifies explicit pixel value.
24635 A float value specifies relative value to current face height.
24636 A cons (float . face-name) specifies relative value to
24637 height of specified face font.
24639 Returns height in pixels, or nil. */
24643 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24644 int boff
, int override
)
24646 Lisp_Object face_name
= Qnil
;
24647 int ascent
, descent
, height
;
24649 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24654 face_name
= XCAR (val
);
24656 if (!NUMBERP (val
))
24657 val
= make_number (1);
24658 if (NILP (face_name
))
24660 height
= it
->ascent
+ it
->descent
;
24665 if (NILP (face_name
))
24667 font
= FRAME_FONT (it
->f
);
24668 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24670 else if (EQ (face_name
, Qt
))
24679 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24681 return make_number (-1);
24683 face
= FACE_FROM_ID (it
->f
, face_id
);
24686 return make_number (-1);
24687 boff
= font
->baseline_offset
;
24688 if (font
->vertical_centering
)
24689 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24692 ascent
= FONT_BASE (font
) + boff
;
24693 descent
= FONT_DESCENT (font
) - boff
;
24697 it
->override_ascent
= ascent
;
24698 it
->override_descent
= descent
;
24699 it
->override_boff
= boff
;
24702 height
= ascent
+ descent
;
24706 height
= (int)(XFLOAT_DATA (val
) * height
);
24707 else if (INTEGERP (val
))
24708 height
*= XINT (val
);
24710 return make_number (height
);
24714 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24715 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24716 and only if this is for a character for which no font was found.
24718 If the display method (it->glyphless_method) is
24719 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24720 length of the acronym or the hexadecimal string, UPPER_XOFF and
24721 UPPER_YOFF are pixel offsets for the upper part of the string,
24722 LOWER_XOFF and LOWER_YOFF are for the lower part.
24724 For the other display methods, LEN through LOWER_YOFF are zero. */
24727 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24728 short upper_xoff
, short upper_yoff
,
24729 short lower_xoff
, short lower_yoff
)
24731 struct glyph
*glyph
;
24732 enum glyph_row_area area
= it
->area
;
24734 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24735 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24737 /* If the glyph row is reversed, we need to prepend the glyph
24738 rather than append it. */
24739 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24743 /* Make room for the additional glyph. */
24744 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24746 glyph
= it
->glyph_row
->glyphs
[area
];
24748 glyph
->charpos
= CHARPOS (it
->position
);
24749 glyph
->object
= it
->object
;
24750 glyph
->pixel_width
= it
->pixel_width
;
24751 glyph
->ascent
= it
->ascent
;
24752 glyph
->descent
= it
->descent
;
24753 glyph
->voffset
= it
->voffset
;
24754 glyph
->type
= GLYPHLESS_GLYPH
;
24755 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24756 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24757 glyph
->u
.glyphless
.len
= len
;
24758 glyph
->u
.glyphless
.ch
= it
->c
;
24759 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24760 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24761 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24762 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24763 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24764 glyph
->multibyte_p
= it
->multibyte_p
;
24765 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24767 /* In R2L rows, the left and the right box edges need to be
24768 drawn in reverse direction. */
24769 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24770 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24774 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24775 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24777 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24778 || it
->phys_descent
> it
->descent
);
24779 glyph
->padding_p
= 0;
24780 glyph
->glyph_not_available_p
= 0;
24781 glyph
->face_id
= face_id
;
24782 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24785 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24786 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24788 glyph
->bidi_type
= it
->bidi_it
.type
;
24790 ++it
->glyph_row
->used
[area
];
24793 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24797 /* Produce a glyph for a glyphless character for iterator IT.
24798 IT->glyphless_method specifies which method to use for displaying
24799 the character. See the description of enum
24800 glyphless_display_method in dispextern.h for the detail.
24802 FOR_NO_FONT is nonzero if and only if this is for a character for
24803 which no font was found. ACRONYM, if non-nil, is an acronym string
24804 for the character. */
24807 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24812 int base_width
, base_height
, width
, height
;
24813 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24816 /* Get the metrics of the base font. We always refer to the current
24818 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24819 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24820 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24821 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24822 base_height
= it
->ascent
+ it
->descent
;
24823 base_width
= font
->average_width
;
24825 /* Get a face ID for the glyph by utilizing a cache (the same way as
24826 done for `escape-glyph' in get_next_display_element). */
24827 if (it
->f
== last_glyphless_glyph_frame
24828 && it
->face_id
== last_glyphless_glyph_face_id
)
24830 face_id
= last_glyphless_glyph_merged_face_id
;
24834 /* Merge the `glyphless-char' face into the current face. */
24835 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24836 last_glyphless_glyph_frame
= it
->f
;
24837 last_glyphless_glyph_face_id
= it
->face_id
;
24838 last_glyphless_glyph_merged_face_id
= face_id
;
24841 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24843 it
->pixel_width
= THIN_SPACE_WIDTH
;
24845 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24847 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24849 width
= CHAR_WIDTH (it
->c
);
24852 else if (width
> 4)
24854 it
->pixel_width
= base_width
* width
;
24856 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24862 unsigned int code
[6];
24864 int ascent
, descent
;
24865 struct font_metrics metrics_upper
, metrics_lower
;
24867 face
= FACE_FROM_ID (it
->f
, face_id
);
24868 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24869 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24871 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24873 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24874 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24875 if (CONSP (acronym
))
24876 acronym
= XCAR (acronym
);
24877 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24881 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24882 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24885 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24886 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24887 upper_len
= (len
+ 1) / 2;
24888 font
->driver
->text_extents (font
, code
, upper_len
,
24890 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24895 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24896 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24897 upper_xoff
= upper_yoff
= 2; /* the typical case */
24898 if (base_width
>= width
)
24900 /* Align the upper to the left, the lower to the right. */
24901 it
->pixel_width
= base_width
;
24902 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24906 /* Center the shorter one. */
24907 it
->pixel_width
= width
;
24908 if (metrics_upper
.width
>= metrics_lower
.width
)
24909 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24912 /* FIXME: This code doesn't look right. It formerly was
24913 missing the "lower_xoff = 0;", which couldn't have
24914 been right since it left lower_xoff uninitialized. */
24916 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24920 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24921 top, bottom, and between upper and lower strings. */
24922 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24923 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24924 /* Center vertically.
24925 H:base_height, D:base_descent
24926 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24928 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24929 descent = D - H/2 + h/2;
24930 lower_yoff = descent - 2 - ld;
24931 upper_yoff = lower_yoff - la - 1 - ud; */
24932 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24933 descent
= it
->descent
- (base_height
- height
) / 2;
24934 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24935 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24936 - metrics_upper
.descent
);
24937 /* Don't make the height shorter than the base height. */
24938 if (height
> base_height
)
24940 it
->ascent
= ascent
;
24941 it
->descent
= descent
;
24945 it
->phys_ascent
= it
->ascent
;
24946 it
->phys_descent
= it
->descent
;
24948 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24949 upper_xoff
, upper_yoff
,
24950 lower_xoff
, lower_yoff
);
24952 take_vertical_position_into_account (it
);
24957 Produce glyphs/get display metrics for the display element IT is
24958 loaded with. See the description of struct it in dispextern.h
24959 for an overview of struct it. */
24962 x_produce_glyphs (struct it
*it
)
24964 int extra_line_spacing
= it
->extra_line_spacing
;
24966 it
->glyph_not_available_p
= 0;
24968 if (it
->what
== IT_CHARACTER
)
24971 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24972 struct font
*font
= face
->font
;
24973 struct font_metrics
*pcm
= NULL
;
24974 int boff
; /* baseline offset */
24978 /* When no suitable font is found, display this character by
24979 the method specified in the first extra slot of
24980 Vglyphless_char_display. */
24981 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24983 eassert (it
->what
== IT_GLYPHLESS
);
24984 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24988 boff
= font
->baseline_offset
;
24989 if (font
->vertical_centering
)
24990 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24992 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24998 if (it
->override_ascent
>= 0)
25000 it
->ascent
= it
->override_ascent
;
25001 it
->descent
= it
->override_descent
;
25002 boff
= it
->override_boff
;
25006 it
->ascent
= FONT_BASE (font
) + boff
;
25007 it
->descent
= FONT_DESCENT (font
) - boff
;
25010 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25012 pcm
= get_per_char_metric (font
, &char2b
);
25013 if (pcm
->width
== 0
25014 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25020 it
->phys_ascent
= pcm
->ascent
+ boff
;
25021 it
->phys_descent
= pcm
->descent
- boff
;
25022 it
->pixel_width
= pcm
->width
;
25026 it
->glyph_not_available_p
= 1;
25027 it
->phys_ascent
= it
->ascent
;
25028 it
->phys_descent
= it
->descent
;
25029 it
->pixel_width
= font
->space_width
;
25032 if (it
->constrain_row_ascent_descent_p
)
25034 if (it
->descent
> it
->max_descent
)
25036 it
->ascent
+= it
->descent
- it
->max_descent
;
25037 it
->descent
= it
->max_descent
;
25039 if (it
->ascent
> it
->max_ascent
)
25041 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25042 it
->ascent
= it
->max_ascent
;
25044 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25045 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25046 extra_line_spacing
= 0;
25049 /* If this is a space inside a region of text with
25050 `space-width' property, change its width. */
25051 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25053 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25055 /* If face has a box, add the box thickness to the character
25056 height. If character has a box line to the left and/or
25057 right, add the box line width to the character's width. */
25058 if (face
->box
!= FACE_NO_BOX
)
25060 int thick
= face
->box_line_width
;
25064 it
->ascent
+= thick
;
25065 it
->descent
+= thick
;
25070 if (it
->start_of_box_run_p
)
25071 it
->pixel_width
+= thick
;
25072 if (it
->end_of_box_run_p
)
25073 it
->pixel_width
+= thick
;
25076 /* If face has an overline, add the height of the overline
25077 (1 pixel) and a 1 pixel margin to the character height. */
25078 if (face
->overline_p
)
25079 it
->ascent
+= overline_margin
;
25081 if (it
->constrain_row_ascent_descent_p
)
25083 if (it
->ascent
> it
->max_ascent
)
25084 it
->ascent
= it
->max_ascent
;
25085 if (it
->descent
> it
->max_descent
)
25086 it
->descent
= it
->max_descent
;
25089 take_vertical_position_into_account (it
);
25091 /* If we have to actually produce glyphs, do it. */
25096 /* Translate a space with a `space-width' property
25097 into a stretch glyph. */
25098 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25099 / FONT_HEIGHT (font
));
25100 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25101 it
->ascent
+ it
->descent
, ascent
);
25106 /* If characters with lbearing or rbearing are displayed
25107 in this line, record that fact in a flag of the
25108 glyph row. This is used to optimize X output code. */
25109 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25110 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25112 if (! stretched_p
&& it
->pixel_width
== 0)
25113 /* We assure that all visible glyphs have at least 1-pixel
25115 it
->pixel_width
= 1;
25117 else if (it
->char_to_display
== '\n')
25119 /* A newline has no width, but we need the height of the
25120 line. But if previous part of the line sets a height,
25121 don't increase that height */
25123 Lisp_Object height
;
25124 Lisp_Object total_height
= Qnil
;
25126 it
->override_ascent
= -1;
25127 it
->pixel_width
= 0;
25130 height
= get_it_property (it
, Qline_height
);
25131 /* Split (line-height total-height) list */
25133 && CONSP (XCDR (height
))
25134 && NILP (XCDR (XCDR (height
))))
25136 total_height
= XCAR (XCDR (height
));
25137 height
= XCAR (height
);
25139 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25141 if (it
->override_ascent
>= 0)
25143 it
->ascent
= it
->override_ascent
;
25144 it
->descent
= it
->override_descent
;
25145 boff
= it
->override_boff
;
25149 it
->ascent
= FONT_BASE (font
) + boff
;
25150 it
->descent
= FONT_DESCENT (font
) - boff
;
25153 if (EQ (height
, Qt
))
25155 if (it
->descent
> it
->max_descent
)
25157 it
->ascent
+= it
->descent
- it
->max_descent
;
25158 it
->descent
= it
->max_descent
;
25160 if (it
->ascent
> it
->max_ascent
)
25162 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25163 it
->ascent
= it
->max_ascent
;
25165 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25166 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25167 it
->constrain_row_ascent_descent_p
= 1;
25168 extra_line_spacing
= 0;
25172 Lisp_Object spacing
;
25174 it
->phys_ascent
= it
->ascent
;
25175 it
->phys_descent
= it
->descent
;
25177 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
25178 && face
->box
!= FACE_NO_BOX
25179 && face
->box_line_width
> 0)
25181 it
->ascent
+= face
->box_line_width
;
25182 it
->descent
+= face
->box_line_width
;
25185 && XINT (height
) > it
->ascent
+ it
->descent
)
25186 it
->ascent
= XINT (height
) - it
->descent
;
25188 if (!NILP (total_height
))
25189 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
25192 spacing
= get_it_property (it
, Qline_spacing
);
25193 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
25195 if (INTEGERP (spacing
))
25197 extra_line_spacing
= XINT (spacing
);
25198 if (!NILP (total_height
))
25199 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
25203 else /* i.e. (it->char_to_display == '\t') */
25205 if (font
->space_width
> 0)
25207 int tab_width
= it
->tab_width
* font
->space_width
;
25208 int x
= it
->current_x
+ it
->continuation_lines_width
;
25209 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
25211 /* If the distance from the current position to the next tab
25212 stop is less than a space character width, use the
25213 tab stop after that. */
25214 if (next_tab_x
- x
< font
->space_width
)
25215 next_tab_x
+= tab_width
;
25217 it
->pixel_width
= next_tab_x
- x
;
25219 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
25220 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
25224 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25225 it
->ascent
+ it
->descent
, it
->ascent
);
25230 it
->pixel_width
= 0;
25235 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
25237 /* A static composition.
25239 Note: A composition is represented as one glyph in the
25240 glyph matrix. There are no padding glyphs.
25242 Important note: pixel_width, ascent, and descent are the
25243 values of what is drawn by draw_glyphs (i.e. the values of
25244 the overall glyphs composed). */
25245 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25246 int boff
; /* baseline offset */
25247 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25248 int glyph_len
= cmp
->glyph_len
;
25249 struct font
*font
= face
->font
;
25253 /* If we have not yet calculated pixel size data of glyphs of
25254 the composition for the current face font, calculate them
25255 now. Theoretically, we have to check all fonts for the
25256 glyphs, but that requires much time and memory space. So,
25257 here we check only the font of the first glyph. This may
25258 lead to incorrect display, but it's very rare, and C-l
25259 (recenter-top-bottom) can correct the display anyway. */
25260 if (! cmp
->font
|| cmp
->font
!= font
)
25262 /* Ascent and descent of the font of the first character
25263 of this composition (adjusted by baseline offset).
25264 Ascent and descent of overall glyphs should not be less
25265 than these, respectively. */
25266 int font_ascent
, font_descent
, font_height
;
25267 /* Bounding box of the overall glyphs. */
25268 int leftmost
, rightmost
, lowest
, highest
;
25269 int lbearing
, rbearing
;
25270 int i
, width
, ascent
, descent
;
25271 int left_padded
= 0, right_padded
= 0;
25272 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
25274 struct font_metrics
*pcm
;
25275 int font_not_found_p
;
25278 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
25279 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
25281 if (glyph_len
< cmp
->glyph_len
)
25283 for (i
= 0; i
< glyph_len
; i
++)
25285 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
25287 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25292 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
25293 : IT_CHARPOS (*it
));
25294 /* If no suitable font is found, use the default font. */
25295 font_not_found_p
= font
== NULL
;
25296 if (font_not_found_p
)
25298 face
= face
->ascii_face
;
25301 boff
= font
->baseline_offset
;
25302 if (font
->vertical_centering
)
25303 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25304 font_ascent
= FONT_BASE (font
) + boff
;
25305 font_descent
= FONT_DESCENT (font
) - boff
;
25306 font_height
= FONT_HEIGHT (font
);
25311 if (! font_not_found_p
)
25313 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25315 pcm
= get_per_char_metric (font
, &char2b
);
25318 /* Initialize the bounding box. */
25321 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25322 ascent
= pcm
->ascent
;
25323 descent
= pcm
->descent
;
25324 lbearing
= pcm
->lbearing
;
25325 rbearing
= pcm
->rbearing
;
25329 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25330 ascent
= FONT_BASE (font
);
25331 descent
= FONT_DESCENT (font
);
25338 lowest
= - descent
+ boff
;
25339 highest
= ascent
+ boff
;
25341 if (! font_not_found_p
25342 && font
->default_ascent
25343 && CHAR_TABLE_P (Vuse_default_ascent
)
25344 && !NILP (Faref (Vuse_default_ascent
,
25345 make_number (it
->char_to_display
))))
25346 highest
= font
->default_ascent
+ boff
;
25348 /* Draw the first glyph at the normal position. It may be
25349 shifted to right later if some other glyphs are drawn
25351 cmp
->offsets
[i
* 2] = 0;
25352 cmp
->offsets
[i
* 2 + 1] = boff
;
25353 cmp
->lbearing
= lbearing
;
25354 cmp
->rbearing
= rbearing
;
25356 /* Set cmp->offsets for the remaining glyphs. */
25357 for (i
++; i
< glyph_len
; i
++)
25359 int left
, right
, btm
, top
;
25360 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25362 struct face
*this_face
;
25366 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25367 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25368 font
= this_face
->font
;
25374 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25376 pcm
= get_per_char_metric (font
, &char2b
);
25379 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25382 width
= pcm
->width
;
25383 ascent
= pcm
->ascent
;
25384 descent
= pcm
->descent
;
25385 lbearing
= pcm
->lbearing
;
25386 rbearing
= pcm
->rbearing
;
25387 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25389 /* Relative composition with or without
25390 alternate chars. */
25391 left
= (leftmost
+ rightmost
- width
) / 2;
25392 btm
= - descent
+ boff
;
25393 if (font
->relative_compose
25394 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25395 || NILP (Faref (Vignore_relative_composition
,
25396 make_number (ch
)))))
25399 if (- descent
>= font
->relative_compose
)
25400 /* One extra pixel between two glyphs. */
25402 else if (ascent
<= 0)
25403 /* One extra pixel between two glyphs. */
25404 btm
= lowest
- 1 - ascent
- descent
;
25409 /* A composition rule is specified by an integer
25410 value that encodes global and new reference
25411 points (GREF and NREF). GREF and NREF are
25412 specified by numbers as below:
25414 0---1---2 -- ascent
25418 9--10--11 -- center
25420 ---3---4---5--- baseline
25422 6---7---8 -- descent
25424 int rule
= COMPOSITION_RULE (cmp
, i
);
25425 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25427 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25428 grefx
= gref
% 3, nrefx
= nref
% 3;
25429 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25431 xoff
= font_height
* (xoff
- 128) / 256;
25433 yoff
= font_height
* (yoff
- 128) / 256;
25436 + grefx
* (rightmost
- leftmost
) / 2
25437 - nrefx
* width
/ 2
25440 btm
= ((grefy
== 0 ? highest
25442 : grefy
== 2 ? lowest
25443 : (highest
+ lowest
) / 2)
25444 - (nrefy
== 0 ? ascent
+ descent
25445 : nrefy
== 1 ? descent
- boff
25447 : (ascent
+ descent
) / 2)
25451 cmp
->offsets
[i
* 2] = left
;
25452 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25454 /* Update the bounding box of the overall glyphs. */
25457 right
= left
+ width
;
25458 if (left
< leftmost
)
25460 if (right
> rightmost
)
25463 top
= btm
+ descent
+ ascent
;
25469 if (cmp
->lbearing
> left
+ lbearing
)
25470 cmp
->lbearing
= left
+ lbearing
;
25471 if (cmp
->rbearing
< left
+ rbearing
)
25472 cmp
->rbearing
= left
+ rbearing
;
25476 /* If there are glyphs whose x-offsets are negative,
25477 shift all glyphs to the right and make all x-offsets
25481 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25482 cmp
->offsets
[i
* 2] -= leftmost
;
25483 rightmost
-= leftmost
;
25484 cmp
->lbearing
-= leftmost
;
25485 cmp
->rbearing
-= leftmost
;
25488 if (left_padded
&& cmp
->lbearing
< 0)
25490 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25491 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25492 rightmost
-= cmp
->lbearing
;
25493 cmp
->rbearing
-= cmp
->lbearing
;
25496 if (right_padded
&& rightmost
< cmp
->rbearing
)
25498 rightmost
= cmp
->rbearing
;
25501 cmp
->pixel_width
= rightmost
;
25502 cmp
->ascent
= highest
;
25503 cmp
->descent
= - lowest
;
25504 if (cmp
->ascent
< font_ascent
)
25505 cmp
->ascent
= font_ascent
;
25506 if (cmp
->descent
< font_descent
)
25507 cmp
->descent
= font_descent
;
25511 && (cmp
->lbearing
< 0
25512 || cmp
->rbearing
> cmp
->pixel_width
))
25513 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25515 it
->pixel_width
= cmp
->pixel_width
;
25516 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25517 it
->descent
= it
->phys_descent
= cmp
->descent
;
25518 if (face
->box
!= FACE_NO_BOX
)
25520 int thick
= face
->box_line_width
;
25524 it
->ascent
+= thick
;
25525 it
->descent
+= thick
;
25530 if (it
->start_of_box_run_p
)
25531 it
->pixel_width
+= thick
;
25532 if (it
->end_of_box_run_p
)
25533 it
->pixel_width
+= thick
;
25536 /* If face has an overline, add the height of the overline
25537 (1 pixel) and a 1 pixel margin to the character height. */
25538 if (face
->overline_p
)
25539 it
->ascent
+= overline_margin
;
25541 take_vertical_position_into_account (it
);
25542 if (it
->ascent
< 0)
25544 if (it
->descent
< 0)
25547 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25548 append_composite_glyph (it
);
25550 else if (it
->what
== IT_COMPOSITION
)
25552 /* A dynamic (automatic) composition. */
25553 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25554 Lisp_Object gstring
;
25555 struct font_metrics metrics
;
25559 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25561 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25564 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25565 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25566 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25567 it
->descent
= it
->phys_descent
= metrics
.descent
;
25568 if (face
->box
!= FACE_NO_BOX
)
25570 int thick
= face
->box_line_width
;
25574 it
->ascent
+= thick
;
25575 it
->descent
+= thick
;
25580 if (it
->start_of_box_run_p
)
25581 it
->pixel_width
+= thick
;
25582 if (it
->end_of_box_run_p
)
25583 it
->pixel_width
+= thick
;
25585 /* If face has an overline, add the height of the overline
25586 (1 pixel) and a 1 pixel margin to the character height. */
25587 if (face
->overline_p
)
25588 it
->ascent
+= overline_margin
;
25589 take_vertical_position_into_account (it
);
25590 if (it
->ascent
< 0)
25592 if (it
->descent
< 0)
25596 append_composite_glyph (it
);
25598 else if (it
->what
== IT_GLYPHLESS
)
25599 produce_glyphless_glyph (it
, 0, Qnil
);
25600 else if (it
->what
== IT_IMAGE
)
25601 produce_image_glyph (it
);
25602 else if (it
->what
== IT_STRETCH
)
25603 produce_stretch_glyph (it
);
25604 #ifdef HAVE_XWIDGETS
25605 else if (it
->what
== IT_XWIDGET
)
25606 produce_xwidget_glyph (it
);
25609 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25610 because this isn't true for images with `:ascent 100'. */
25611 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25612 if (it
->area
== TEXT_AREA
)
25613 it
->current_x
+= it
->pixel_width
;
25615 if (extra_line_spacing
> 0)
25617 it
->descent
+= extra_line_spacing
;
25618 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25619 it
->max_extra_line_spacing
= extra_line_spacing
;
25622 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25623 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25624 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25625 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25629 Output LEN glyphs starting at START at the nominal cursor position.
25630 Advance the nominal cursor over the text. The global variable
25631 updated_window contains the window being updated, updated_row is
25632 the glyph row being updated, and updated_area is the area of that
25633 row being updated. */
25636 x_write_glyphs (struct glyph
*start
, int len
)
25638 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25640 eassert (updated_window
&& updated_row
);
25641 /* When the window is hscrolled, cursor hpos can legitimately be out
25642 of bounds, but we draw the cursor at the corresponding window
25643 margin in that case. */
25644 if (!updated_row
->reversed_p
&& chpos
< 0)
25646 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25647 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25651 /* Write glyphs. */
25653 hpos
= start
- updated_row
->glyphs
[updated_area
];
25654 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25655 updated_row
, updated_area
,
25657 DRAW_NORMAL_TEXT
, 0);
25659 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25660 if (updated_area
== TEXT_AREA
25661 && updated_window
->phys_cursor_on_p
25662 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25664 && chpos
< hpos
+ len
)
25665 updated_window
->phys_cursor_on_p
= 0;
25669 /* Advance the output cursor. */
25670 output_cursor
.hpos
+= len
;
25671 output_cursor
.x
= x
;
25676 Insert LEN glyphs from START at the nominal cursor position. */
25679 x_insert_glyphs (struct glyph
*start
, int len
)
25683 int line_height
, shift_by_width
, shifted_region_width
;
25684 struct glyph_row
*row
;
25685 struct glyph
*glyph
;
25686 int frame_x
, frame_y
;
25689 eassert (updated_window
&& updated_row
);
25691 w
= updated_window
;
25692 f
= XFRAME (WINDOW_FRAME (w
));
25694 /* Get the height of the line we are in. */
25696 line_height
= row
->height
;
25698 /* Get the width of the glyphs to insert. */
25699 shift_by_width
= 0;
25700 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25701 shift_by_width
+= glyph
->pixel_width
;
25703 /* Get the width of the region to shift right. */
25704 shifted_region_width
= (window_box_width (w
, updated_area
)
25709 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25710 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25712 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25713 line_height
, shift_by_width
);
25715 /* Write the glyphs. */
25716 hpos
= start
- row
->glyphs
[updated_area
];
25717 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25719 DRAW_NORMAL_TEXT
, 0);
25721 /* Advance the output cursor. */
25722 output_cursor
.hpos
+= len
;
25723 output_cursor
.x
+= shift_by_width
;
25729 Erase the current text line from the nominal cursor position
25730 (inclusive) to pixel column TO_X (exclusive). The idea is that
25731 everything from TO_X onward is already erased.
25733 TO_X is a pixel position relative to updated_area of
25734 updated_window. TO_X == -1 means clear to the end of this area. */
25737 x_clear_end_of_line (int to_x
)
25740 struct window
*w
= updated_window
;
25741 int max_x
, min_y
, max_y
;
25742 int from_x
, from_y
, to_y
;
25744 eassert (updated_window
&& updated_row
);
25745 f
= XFRAME (w
->frame
);
25747 if (updated_row
->full_width_p
)
25748 max_x
= WINDOW_TOTAL_WIDTH (w
);
25750 max_x
= window_box_width (w
, updated_area
);
25751 max_y
= window_text_bottom_y (w
);
25753 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25754 of window. For TO_X > 0, truncate to end of drawing area. */
25760 to_x
= min (to_x
, max_x
);
25762 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25764 /* Notice if the cursor will be cleared by this operation. */
25765 if (!updated_row
->full_width_p
)
25766 notice_overwritten_cursor (w
, updated_area
,
25767 output_cursor
.x
, -1,
25769 MATRIX_ROW_BOTTOM_Y (updated_row
));
25771 from_x
= output_cursor
.x
;
25773 /* Translate to frame coordinates. */
25774 if (updated_row
->full_width_p
)
25776 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25777 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25781 int area_left
= window_box_left (w
, updated_area
);
25782 from_x
+= area_left
;
25786 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25787 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25788 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25790 /* Prevent inadvertently clearing to end of the X window. */
25791 if (to_x
> from_x
&& to_y
> from_y
)
25794 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25795 to_x
- from_x
, to_y
- from_y
);
25800 #endif /* HAVE_WINDOW_SYSTEM */
25804 /***********************************************************************
25806 ***********************************************************************/
25808 /* Value is the internal representation of the specified cursor type
25809 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25810 of the bar cursor. */
25812 static enum text_cursor_kinds
25813 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25815 enum text_cursor_kinds type
;
25820 if (EQ (arg
, Qbox
))
25821 return FILLED_BOX_CURSOR
;
25823 if (EQ (arg
, Qhollow
))
25824 return HOLLOW_BOX_CURSOR
;
25826 if (EQ (arg
, Qbar
))
25833 && EQ (XCAR (arg
), Qbar
)
25834 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25836 *width
= XINT (XCDR (arg
));
25840 if (EQ (arg
, Qhbar
))
25843 return HBAR_CURSOR
;
25847 && EQ (XCAR (arg
), Qhbar
)
25848 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25850 *width
= XINT (XCDR (arg
));
25851 return HBAR_CURSOR
;
25854 /* Treat anything unknown as "hollow box cursor".
25855 It was bad to signal an error; people have trouble fixing
25856 .Xdefaults with Emacs, when it has something bad in it. */
25857 type
= HOLLOW_BOX_CURSOR
;
25862 /* Set the default cursor types for specified frame. */
25864 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25869 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25870 FRAME_CURSOR_WIDTH (f
) = width
;
25872 /* By default, set up the blink-off state depending on the on-state. */
25874 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25877 FRAME_BLINK_OFF_CURSOR (f
)
25878 = get_specified_cursor_type (XCDR (tem
), &width
);
25879 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25882 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25886 #ifdef HAVE_WINDOW_SYSTEM
25888 /* Return the cursor we want to be displayed in window W. Return
25889 width of bar/hbar cursor through WIDTH arg. Return with
25890 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25891 (i.e. if the `system caret' should track this cursor).
25893 In a mini-buffer window, we want the cursor only to appear if we
25894 are reading input from this window. For the selected window, we
25895 want the cursor type given by the frame parameter or buffer local
25896 setting of cursor-type. If explicitly marked off, draw no cursor.
25897 In all other cases, we want a hollow box cursor. */
25899 static enum text_cursor_kinds
25900 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25901 int *active_cursor
)
25903 struct frame
*f
= XFRAME (w
->frame
);
25904 struct buffer
*b
= XBUFFER (w
->buffer
);
25905 int cursor_type
= DEFAULT_CURSOR
;
25906 Lisp_Object alt_cursor
;
25907 int non_selected
= 0;
25909 *active_cursor
= 1;
25912 if (cursor_in_echo_area
25913 && FRAME_HAS_MINIBUF_P (f
)
25914 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25916 if (w
== XWINDOW (echo_area_window
))
25918 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25920 *width
= FRAME_CURSOR_WIDTH (f
);
25921 return FRAME_DESIRED_CURSOR (f
);
25924 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25927 *active_cursor
= 0;
25931 /* Detect a nonselected window or nonselected frame. */
25932 else if (w
!= XWINDOW (f
->selected_window
)
25933 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25935 *active_cursor
= 0;
25937 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25943 /* Never display a cursor in a window in which cursor-type is nil. */
25944 if (NILP (BVAR (b
, cursor_type
)))
25947 /* Get the normal cursor type for this window. */
25948 if (EQ (BVAR (b
, cursor_type
), Qt
))
25950 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25951 *width
= FRAME_CURSOR_WIDTH (f
);
25954 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25956 /* Use cursor-in-non-selected-windows instead
25957 for non-selected window or frame. */
25960 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25961 if (!EQ (Qt
, alt_cursor
))
25962 return get_specified_cursor_type (alt_cursor
, width
);
25963 /* t means modify the normal cursor type. */
25964 if (cursor_type
== FILLED_BOX_CURSOR
)
25965 cursor_type
= HOLLOW_BOX_CURSOR
;
25966 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25968 return cursor_type
;
25971 /* Use normal cursor if not blinked off. */
25972 if (!w
->cursor_off_p
)
25975 #ifdef HAVE_XWIDGETS
25976 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
25977 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
25981 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25983 if (cursor_type
== FILLED_BOX_CURSOR
)
25985 /* Using a block cursor on large images can be very annoying.
25986 So use a hollow cursor for "large" images.
25987 If image is not transparent (no mask), also use hollow cursor. */
25988 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25989 if (img
!= NULL
&& IMAGEP (img
->spec
))
25991 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25992 where N = size of default frame font size.
25993 This should cover most of the "tiny" icons people may use. */
25995 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25996 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25997 cursor_type
= HOLLOW_BOX_CURSOR
;
26000 else if (cursor_type
!= NO_CURSOR
)
26002 /* Display current only supports BOX and HOLLOW cursors for images.
26003 So for now, unconditionally use a HOLLOW cursor when cursor is
26004 not a solid box cursor. */
26005 cursor_type
= HOLLOW_BOX_CURSOR
;
26008 return cursor_type
;
26011 /* Cursor is blinked off, so determine how to "toggle" it. */
26013 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26014 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26015 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26017 /* Then see if frame has specified a specific blink off cursor type. */
26018 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26020 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26021 return FRAME_BLINK_OFF_CURSOR (f
);
26025 /* Some people liked having a permanently visible blinking cursor,
26026 while others had very strong opinions against it. So it was
26027 decided to remove it. KFS 2003-09-03 */
26029 /* Finally perform built-in cursor blinking:
26030 filled box <-> hollow box
26031 wide [h]bar <-> narrow [h]bar
26032 narrow [h]bar <-> no cursor
26033 other type <-> no cursor */
26035 if (cursor_type
== FILLED_BOX_CURSOR
)
26036 return HOLLOW_BOX_CURSOR
;
26038 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26041 return cursor_type
;
26049 /* Notice when the text cursor of window W has been completely
26050 overwritten by a drawing operation that outputs glyphs in AREA
26051 starting at X0 and ending at X1 in the line starting at Y0 and
26052 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26053 the rest of the line after X0 has been written. Y coordinates
26054 are window-relative. */
26057 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26058 int x0
, int x1
, int y0
, int y1
)
26060 int cx0
, cx1
, cy0
, cy1
;
26061 struct glyph_row
*row
;
26063 if (!w
->phys_cursor_on_p
)
26065 if (area
!= TEXT_AREA
)
26068 if (w
->phys_cursor
.vpos
< 0
26069 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26070 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26071 !(row
->enabled_p
&& row
->displays_text_p
)))
26074 if (row
->cursor_in_fringe_p
)
26076 row
->cursor_in_fringe_p
= 0;
26077 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26078 w
->phys_cursor_on_p
= 0;
26082 cx0
= w
->phys_cursor
.x
;
26083 cx1
= cx0
+ w
->phys_cursor_width
;
26084 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26087 /* The cursor image will be completely removed from the
26088 screen if the output area intersects the cursor area in
26089 y-direction. When we draw in [y0 y1[, and some part of
26090 the cursor is at y < y0, that part must have been drawn
26091 before. When scrolling, the cursor is erased before
26092 actually scrolling, so we don't come here. When not
26093 scrolling, the rows above the old cursor row must have
26094 changed, and in this case these rows must have written
26095 over the cursor image.
26097 Likewise if part of the cursor is below y1, with the
26098 exception of the cursor being in the first blank row at
26099 the buffer and window end because update_text_area
26100 doesn't draw that row. (Except when it does, but
26101 that's handled in update_text_area.) */
26103 cy0
= w
->phys_cursor
.y
;
26104 cy1
= cy0
+ w
->phys_cursor_height
;
26105 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26108 w
->phys_cursor_on_p
= 0;
26111 #endif /* HAVE_WINDOW_SYSTEM */
26114 /************************************************************************
26116 ************************************************************************/
26118 #ifdef HAVE_WINDOW_SYSTEM
26121 Fix the display of area AREA of overlapping row ROW in window W
26122 with respect to the overlapping part OVERLAPS. */
26125 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26126 enum glyph_row_area area
, int overlaps
)
26133 for (i
= 0; i
< row
->used
[area
];)
26135 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26137 int start
= i
, start_x
= x
;
26141 x
+= row
->glyphs
[area
][i
].pixel_width
;
26144 while (i
< row
->used
[area
]
26145 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26147 draw_glyphs (w
, start_x
, row
, area
,
26149 DRAW_NORMAL_TEXT
, overlaps
);
26153 x
+= row
->glyphs
[area
][i
].pixel_width
;
26163 Draw the cursor glyph of window W in glyph row ROW. See the
26164 comment of draw_glyphs for the meaning of HL. */
26167 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
26168 enum draw_glyphs_face hl
)
26170 /* If cursor hpos is out of bounds, don't draw garbage. This can
26171 happen in mini-buffer windows when switching between echo area
26172 glyphs and mini-buffer. */
26173 if ((row
->reversed_p
26174 ? (w
->phys_cursor
.hpos
>= 0)
26175 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
26177 int on_p
= w
->phys_cursor_on_p
;
26179 int hpos
= w
->phys_cursor
.hpos
;
26181 /* When the window is hscrolled, cursor hpos can legitimately be
26182 out of bounds, but we draw the cursor at the corresponding
26183 window margin in that case. */
26184 if (!row
->reversed_p
&& hpos
< 0)
26186 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26187 hpos
= row
->used
[TEXT_AREA
] - 1;
26189 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
26191 w
->phys_cursor_on_p
= on_p
;
26193 if (hl
== DRAW_CURSOR
)
26194 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26195 /* When we erase the cursor, and ROW is overlapped by other
26196 rows, make sure that these overlapping parts of other rows
26198 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
26200 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26202 if (row
> w
->current_matrix
->rows
26203 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
26204 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
26205 OVERLAPS_ERASED_CURSOR
);
26207 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
26208 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
26209 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
26210 OVERLAPS_ERASED_CURSOR
);
26217 Erase the image of a cursor of window W from the screen. */
26220 erase_phys_cursor (struct window
*w
)
26222 struct frame
*f
= XFRAME (w
->frame
);
26223 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26224 int hpos
= w
->phys_cursor
.hpos
;
26225 int vpos
= w
->phys_cursor
.vpos
;
26226 int mouse_face_here_p
= 0;
26227 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
26228 struct glyph_row
*cursor_row
;
26229 struct glyph
*cursor_glyph
;
26230 enum draw_glyphs_face hl
;
26232 /* No cursor displayed or row invalidated => nothing to do on the
26234 if (w
->phys_cursor_type
== NO_CURSOR
)
26235 goto mark_cursor_off
;
26237 /* VPOS >= active_glyphs->nrows means that window has been resized.
26238 Don't bother to erase the cursor. */
26239 if (vpos
>= active_glyphs
->nrows
)
26240 goto mark_cursor_off
;
26242 /* If row containing cursor is marked invalid, there is nothing we
26244 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
26245 if (!cursor_row
->enabled_p
)
26246 goto mark_cursor_off
;
26248 /* If line spacing is > 0, old cursor may only be partially visible in
26249 window after split-window. So adjust visible height. */
26250 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26251 window_text_bottom_y (w
) - cursor_row
->y
);
26253 /* If row is completely invisible, don't attempt to delete a cursor which
26254 isn't there. This can happen if cursor is at top of a window, and
26255 we switch to a buffer with a header line in that window. */
26256 if (cursor_row
->visible_height
<= 0)
26257 goto mark_cursor_off
;
26259 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26260 if (cursor_row
->cursor_in_fringe_p
)
26262 cursor_row
->cursor_in_fringe_p
= 0;
26263 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26264 goto mark_cursor_off
;
26267 /* This can happen when the new row is shorter than the old one.
26268 In this case, either draw_glyphs or clear_end_of_line
26269 should have cleared the cursor. Note that we wouldn't be
26270 able to erase the cursor in this case because we don't have a
26271 cursor glyph at hand. */
26272 if ((cursor_row
->reversed_p
26273 ? (w
->phys_cursor
.hpos
< 0)
26274 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26275 goto mark_cursor_off
;
26277 /* When the window is hscrolled, cursor hpos can legitimately be out
26278 of bounds, but we draw the cursor at the corresponding window
26279 margin in that case. */
26280 if (!cursor_row
->reversed_p
&& hpos
< 0)
26282 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
26283 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
26285 /* If the cursor is in the mouse face area, redisplay that when
26286 we clear the cursor. */
26287 if (! NILP (hlinfo
->mouse_face_window
)
26288 && coords_in_mouse_face_p (w
, hpos
, vpos
)
26289 /* Don't redraw the cursor's spot in mouse face if it is at the
26290 end of a line (on a newline). The cursor appears there, but
26291 mouse highlighting does not. */
26292 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
26293 mouse_face_here_p
= 1;
26295 /* Maybe clear the display under the cursor. */
26296 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
26299 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
26302 cursor_glyph
= get_phys_cursor_glyph (w
);
26303 if (cursor_glyph
== NULL
)
26304 goto mark_cursor_off
;
26306 width
= cursor_glyph
->pixel_width
;
26307 left_x
= window_box_left_offset (w
, TEXT_AREA
);
26308 x
= w
->phys_cursor
.x
;
26310 width
-= left_x
- x
;
26311 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
26312 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
26313 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
26316 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
26319 /* Erase the cursor by redrawing the character underneath it. */
26320 if (mouse_face_here_p
)
26321 hl
= DRAW_MOUSE_FACE
;
26323 hl
= DRAW_NORMAL_TEXT
;
26324 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26327 w
->phys_cursor_on_p
= 0;
26328 w
->phys_cursor_type
= NO_CURSOR
;
26333 Display or clear cursor of window W. If ON is zero, clear the
26334 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26335 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26338 display_and_set_cursor (struct window
*w
, int on
,
26339 int hpos
, int vpos
, int x
, int y
)
26341 struct frame
*f
= XFRAME (w
->frame
);
26342 int new_cursor_type
;
26343 int new_cursor_width
;
26345 struct glyph_row
*glyph_row
;
26346 struct glyph
*glyph
;
26348 /* This is pointless on invisible frames, and dangerous on garbaged
26349 windows and frames; in the latter case, the frame or window may
26350 be in the midst of changing its size, and x and y may be off the
26352 if (! FRAME_VISIBLE_P (f
)
26353 || FRAME_GARBAGED_P (f
)
26354 || vpos
>= w
->current_matrix
->nrows
26355 || hpos
>= w
->current_matrix
->matrix_w
)
26358 /* If cursor is off and we want it off, return quickly. */
26359 if (!on
&& !w
->phys_cursor_on_p
)
26362 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26363 /* If cursor row is not enabled, we don't really know where to
26364 display the cursor. */
26365 if (!glyph_row
->enabled_p
)
26367 w
->phys_cursor_on_p
= 0;
26372 if (!glyph_row
->exact_window_width_line_p
26373 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26374 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26376 eassert (input_blocked_p ());
26378 /* Set new_cursor_type to the cursor we want to be displayed. */
26379 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26380 &new_cursor_width
, &active_cursor
);
26382 /* If cursor is currently being shown and we don't want it to be or
26383 it is in the wrong place, or the cursor type is not what we want,
26385 if (w
->phys_cursor_on_p
26387 || w
->phys_cursor
.x
!= x
26388 || w
->phys_cursor
.y
!= y
26389 || new_cursor_type
!= w
->phys_cursor_type
26390 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26391 && new_cursor_width
!= w
->phys_cursor_width
)))
26392 erase_phys_cursor (w
);
26394 /* Don't check phys_cursor_on_p here because that flag is only set
26395 to zero in some cases where we know that the cursor has been
26396 completely erased, to avoid the extra work of erasing the cursor
26397 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26398 still not be visible, or it has only been partly erased. */
26401 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26402 w
->phys_cursor_height
= glyph_row
->height
;
26404 /* Set phys_cursor_.* before x_draw_.* is called because some
26405 of them may need the information. */
26406 w
->phys_cursor
.x
= x
;
26407 w
->phys_cursor
.y
= glyph_row
->y
;
26408 w
->phys_cursor
.hpos
= hpos
;
26409 w
->phys_cursor
.vpos
= vpos
;
26412 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26413 new_cursor_type
, new_cursor_width
,
26414 on
, active_cursor
);
26418 /* Switch the display of W's cursor on or off, according to the value
26422 update_window_cursor (struct window
*w
, int on
)
26424 /* Don't update cursor in windows whose frame is in the process
26425 of being deleted. */
26426 if (w
->current_matrix
)
26428 int hpos
= w
->phys_cursor
.hpos
;
26429 int vpos
= w
->phys_cursor
.vpos
;
26430 struct glyph_row
*row
;
26432 if (vpos
>= w
->current_matrix
->nrows
26433 || hpos
>= w
->current_matrix
->matrix_w
)
26436 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26438 /* When the window is hscrolled, cursor hpos can legitimately be
26439 out of bounds, but we draw the cursor at the corresponding
26440 window margin in that case. */
26441 if (!row
->reversed_p
&& hpos
< 0)
26443 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26444 hpos
= row
->used
[TEXT_AREA
] - 1;
26447 display_and_set_cursor (w
, on
, hpos
, vpos
,
26448 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26454 /* Call update_window_cursor with parameter ON_P on all leaf windows
26455 in the window tree rooted at W. */
26458 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26462 if (!NILP (w
->hchild
))
26463 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26464 else if (!NILP (w
->vchild
))
26465 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26467 update_window_cursor (w
, on_p
);
26469 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26475 Display the cursor on window W, or clear it, according to ON_P.
26476 Don't change the cursor's position. */
26479 x_update_cursor (struct frame
*f
, int on_p
)
26481 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26486 Clear the cursor of window W to background color, and mark the
26487 cursor as not shown. This is used when the text where the cursor
26488 is about to be rewritten. */
26491 x_clear_cursor (struct window
*w
)
26493 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26494 update_window_cursor (w
, 0);
26497 #endif /* HAVE_WINDOW_SYSTEM */
26499 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26502 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26503 int start_hpos
, int end_hpos
,
26504 enum draw_glyphs_face draw
)
26506 #ifdef HAVE_WINDOW_SYSTEM
26507 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26509 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26513 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26514 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26518 /* Display the active region described by mouse_face_* according to DRAW. */
26521 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26523 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26524 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26526 if (/* If window is in the process of being destroyed, don't bother
26528 w
->current_matrix
!= NULL
26529 /* Don't update mouse highlight if hidden */
26530 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26531 /* Recognize when we are called to operate on rows that don't exist
26532 anymore. This can happen when a window is split. */
26533 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26535 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26536 struct glyph_row
*row
, *first
, *last
;
26538 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26539 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26541 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26543 int start_hpos
, end_hpos
, start_x
;
26545 /* For all but the first row, the highlight starts at column 0. */
26548 /* R2L rows have BEG and END in reversed order, but the
26549 screen drawing geometry is always left to right. So
26550 we need to mirror the beginning and end of the
26551 highlighted area in R2L rows. */
26552 if (!row
->reversed_p
)
26554 start_hpos
= hlinfo
->mouse_face_beg_col
;
26555 start_x
= hlinfo
->mouse_face_beg_x
;
26557 else if (row
== last
)
26559 start_hpos
= hlinfo
->mouse_face_end_col
;
26560 start_x
= hlinfo
->mouse_face_end_x
;
26568 else if (row
->reversed_p
&& row
== last
)
26570 start_hpos
= hlinfo
->mouse_face_end_col
;
26571 start_x
= hlinfo
->mouse_face_end_x
;
26581 if (!row
->reversed_p
)
26582 end_hpos
= hlinfo
->mouse_face_end_col
;
26583 else if (row
== first
)
26584 end_hpos
= hlinfo
->mouse_face_beg_col
;
26587 end_hpos
= row
->used
[TEXT_AREA
];
26588 if (draw
== DRAW_NORMAL_TEXT
)
26589 row
->fill_line_p
= 1; /* Clear to end of line */
26592 else if (row
->reversed_p
&& row
== first
)
26593 end_hpos
= hlinfo
->mouse_face_beg_col
;
26596 end_hpos
= row
->used
[TEXT_AREA
];
26597 if (draw
== DRAW_NORMAL_TEXT
)
26598 row
->fill_line_p
= 1; /* Clear to end of line */
26601 if (end_hpos
> start_hpos
)
26603 draw_row_with_mouse_face (w
, start_x
, row
,
26604 start_hpos
, end_hpos
, draw
);
26607 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26611 #ifdef HAVE_WINDOW_SYSTEM
26612 /* When we've written over the cursor, arrange for it to
26613 be displayed again. */
26614 if (FRAME_WINDOW_P (f
)
26615 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26617 int hpos
= w
->phys_cursor
.hpos
;
26619 /* When the window is hscrolled, cursor hpos can legitimately be
26620 out of bounds, but we draw the cursor at the corresponding
26621 window margin in that case. */
26622 if (!row
->reversed_p
&& hpos
< 0)
26624 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26625 hpos
= row
->used
[TEXT_AREA
] - 1;
26628 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26629 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26632 #endif /* HAVE_WINDOW_SYSTEM */
26635 #ifdef HAVE_WINDOW_SYSTEM
26636 /* Change the mouse cursor. */
26637 if (FRAME_WINDOW_P (f
))
26639 if (draw
== DRAW_NORMAL_TEXT
26640 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26641 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26642 else if (draw
== DRAW_MOUSE_FACE
)
26643 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26645 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26647 #endif /* HAVE_WINDOW_SYSTEM */
26651 Clear out the mouse-highlighted active region.
26652 Redraw it un-highlighted first. Value is non-zero if mouse
26653 face was actually drawn unhighlighted. */
26656 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26660 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26662 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26666 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26667 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26668 hlinfo
->mouse_face_window
= Qnil
;
26669 hlinfo
->mouse_face_overlay
= Qnil
;
26673 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26674 within the mouse face on that window. */
26676 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26678 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26680 /* Quickly resolve the easy cases. */
26681 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26682 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26684 if (vpos
< hlinfo
->mouse_face_beg_row
26685 || vpos
> hlinfo
->mouse_face_end_row
)
26687 if (vpos
> hlinfo
->mouse_face_beg_row
26688 && vpos
< hlinfo
->mouse_face_end_row
)
26691 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26693 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26695 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26698 else if ((vpos
== hlinfo
->mouse_face_beg_row
26699 && hpos
>= hlinfo
->mouse_face_beg_col
)
26700 || (vpos
== hlinfo
->mouse_face_end_row
26701 && hpos
< hlinfo
->mouse_face_end_col
))
26706 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26708 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26711 else if ((vpos
== hlinfo
->mouse_face_beg_row
26712 && hpos
<= hlinfo
->mouse_face_beg_col
)
26713 || (vpos
== hlinfo
->mouse_face_end_row
26714 && hpos
> hlinfo
->mouse_face_end_col
))
26722 Non-zero if physical cursor of window W is within mouse face. */
26725 cursor_in_mouse_face_p (struct window
*w
)
26727 int hpos
= w
->phys_cursor
.hpos
;
26728 int vpos
= w
->phys_cursor
.vpos
;
26729 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26731 /* When the window is hscrolled, cursor hpos can legitimately be out
26732 of bounds, but we draw the cursor at the corresponding window
26733 margin in that case. */
26734 if (!row
->reversed_p
&& hpos
< 0)
26736 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26737 hpos
= row
->used
[TEXT_AREA
] - 1;
26739 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26744 /* Find the glyph rows START_ROW and END_ROW of window W that display
26745 characters between buffer positions START_CHARPOS and END_CHARPOS
26746 (excluding END_CHARPOS). DISP_STRING is a display string that
26747 covers these buffer positions. This is similar to
26748 row_containing_pos, but is more accurate when bidi reordering makes
26749 buffer positions change non-linearly with glyph rows. */
26751 rows_from_pos_range (struct window
*w
,
26752 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26753 Lisp_Object disp_string
,
26754 struct glyph_row
**start
, struct glyph_row
**end
)
26756 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26757 int last_y
= window_text_bottom_y (w
);
26758 struct glyph_row
*row
;
26763 while (!first
->enabled_p
26764 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26767 /* Find the START row. */
26769 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26772 /* A row can potentially be the START row if the range of the
26773 characters it displays intersects the range
26774 [START_CHARPOS..END_CHARPOS). */
26775 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26776 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26777 /* See the commentary in row_containing_pos, for the
26778 explanation of the complicated way to check whether
26779 some position is beyond the end of the characters
26780 displayed by a row. */
26781 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26782 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26783 && !row
->ends_at_zv_p
26784 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26785 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26786 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26787 && !row
->ends_at_zv_p
26788 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26790 /* Found a candidate row. Now make sure at least one of the
26791 glyphs it displays has a charpos from the range
26792 [START_CHARPOS..END_CHARPOS).
26794 This is not obvious because bidi reordering could make
26795 buffer positions of a row be 1,2,3,102,101,100, and if we
26796 want to highlight characters in [50..60), we don't want
26797 this row, even though [50..60) does intersect [1..103),
26798 the range of character positions given by the row's start
26799 and end positions. */
26800 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26801 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26805 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26806 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26807 /* A glyph that comes from DISP_STRING is by
26808 definition to be highlighted. */
26809 || EQ (g
->object
, disp_string
))
26818 /* Find the END row. */
26820 /* If the last row is partially visible, start looking for END
26821 from that row, instead of starting from FIRST. */
26822 && !(row
->enabled_p
26823 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26825 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26827 struct glyph_row
*next
= row
+ 1;
26828 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26830 if (!next
->enabled_p
26831 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26832 /* The first row >= START whose range of displayed characters
26833 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26834 is the row END + 1. */
26835 || (start_charpos
< next_start
26836 && end_charpos
< next_start
)
26837 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26838 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26839 && !next
->ends_at_zv_p
26840 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26841 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26842 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26843 && !next
->ends_at_zv_p
26844 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26851 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26852 but none of the characters it displays are in the range, it is
26854 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26855 struct glyph
*s
= g
;
26856 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26860 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26861 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26862 /* If the buffer position of the first glyph in
26863 the row is equal to END_CHARPOS, it means
26864 the last character to be highlighted is the
26865 newline of ROW, and we must consider NEXT as
26867 || (((!next
->reversed_p
&& g
== s
)
26868 || (next
->reversed_p
&& g
== e
- 1))
26869 && (g
->charpos
== end_charpos
26870 /* Special case for when NEXT is an
26871 empty line at ZV. */
26872 || (g
->charpos
== -1
26873 && !row
->ends_at_zv_p
26874 && next_start
== end_charpos
)))))
26875 /* A glyph that comes from DISP_STRING is by
26876 definition to be highlighted. */
26877 || EQ (g
->object
, disp_string
))
26886 /* The first row that ends at ZV must be the last to be
26888 else if (next
->ends_at_zv_p
)
26897 /* This function sets the mouse_face_* elements of HLINFO, assuming
26898 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26899 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26900 for the overlay or run of text properties specifying the mouse
26901 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26902 before-string and after-string that must also be highlighted.
26903 DISP_STRING, if non-nil, is a display string that may cover some
26904 or all of the highlighted text. */
26907 mouse_face_from_buffer_pos (Lisp_Object window
,
26908 Mouse_HLInfo
*hlinfo
,
26909 ptrdiff_t mouse_charpos
,
26910 ptrdiff_t start_charpos
,
26911 ptrdiff_t end_charpos
,
26912 Lisp_Object before_string
,
26913 Lisp_Object after_string
,
26914 Lisp_Object disp_string
)
26916 struct window
*w
= XWINDOW (window
);
26917 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26918 struct glyph_row
*r1
, *r2
;
26919 struct glyph
*glyph
, *end
;
26920 ptrdiff_t ignore
, pos
;
26923 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26924 eassert (NILP (before_string
) || STRINGP (before_string
));
26925 eassert (NILP (after_string
) || STRINGP (after_string
));
26927 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26928 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26930 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26931 /* If the before-string or display-string contains newlines,
26932 rows_from_pos_range skips to its last row. Move back. */
26933 if (!NILP (before_string
) || !NILP (disp_string
))
26935 struct glyph_row
*prev
;
26936 while ((prev
= r1
- 1, prev
>= first
)
26937 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26938 && prev
->used
[TEXT_AREA
] > 0)
26940 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26941 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26942 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26944 || !(EQ (glyph
->object
, before_string
)
26945 || EQ (glyph
->object
, disp_string
)))
26952 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26953 hlinfo
->mouse_face_past_end
= 1;
26955 else if (!NILP (after_string
))
26957 /* If the after-string has newlines, advance to its last row. */
26958 struct glyph_row
*next
;
26959 struct glyph_row
*last
26960 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26962 for (next
= r2
+ 1;
26964 && next
->used
[TEXT_AREA
] > 0
26965 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26969 /* The rest of the display engine assumes that mouse_face_beg_row is
26970 either above mouse_face_end_row or identical to it. But with
26971 bidi-reordered continued lines, the row for START_CHARPOS could
26972 be below the row for END_CHARPOS. If so, swap the rows and store
26973 them in correct order. */
26976 struct glyph_row
*tem
= r2
;
26982 hlinfo
->mouse_face_beg_y
= r1
->y
;
26983 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26984 hlinfo
->mouse_face_end_y
= r2
->y
;
26985 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26987 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26988 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26989 could be anywhere in the row and in any order. The strategy
26990 below is to find the leftmost and the rightmost glyph that
26991 belongs to either of these 3 strings, or whose position is
26992 between START_CHARPOS and END_CHARPOS, and highlight all the
26993 glyphs between those two. This may cover more than just the text
26994 between START_CHARPOS and END_CHARPOS if the range of characters
26995 strides the bidi level boundary, e.g. if the beginning is in R2L
26996 text while the end is in L2R text or vice versa. */
26997 if (!r1
->reversed_p
)
26999 /* This row is in a left to right paragraph. Scan it left to
27001 glyph
= r1
->glyphs
[TEXT_AREA
];
27002 end
= glyph
+ r1
->used
[TEXT_AREA
];
27005 /* Skip truncation glyphs at the start of the glyph row. */
27006 if (r1
->displays_text_p
)
27008 && INTEGERP (glyph
->object
)
27009 && glyph
->charpos
< 0;
27011 x
+= glyph
->pixel_width
;
27013 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27014 or DISP_STRING, and the first glyph from buffer whose
27015 position is between START_CHARPOS and END_CHARPOS. */
27017 && !INTEGERP (glyph
->object
)
27018 && !EQ (glyph
->object
, disp_string
)
27019 && !(BUFFERP (glyph
->object
)
27020 && (glyph
->charpos
>= start_charpos
27021 && glyph
->charpos
< end_charpos
));
27024 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27025 are present at buffer positions between START_CHARPOS and
27026 END_CHARPOS, or if they come from an overlay. */
27027 if (EQ (glyph
->object
, before_string
))
27029 pos
= string_buffer_position (before_string
,
27031 /* If pos == 0, it means before_string came from an
27032 overlay, not from a buffer position. */
27033 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27036 else if (EQ (glyph
->object
, after_string
))
27038 pos
= string_buffer_position (after_string
, end_charpos
);
27039 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27042 x
+= glyph
->pixel_width
;
27044 hlinfo
->mouse_face_beg_x
= x
;
27045 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27049 /* This row is in a right to left paragraph. Scan it right to
27053 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27054 glyph
= end
+ r1
->used
[TEXT_AREA
];
27056 /* Skip truncation glyphs at the start of the glyph row. */
27057 if (r1
->displays_text_p
)
27059 && INTEGERP (glyph
->object
)
27060 && glyph
->charpos
< 0;
27064 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27065 or DISP_STRING, and the first glyph from buffer whose
27066 position is between START_CHARPOS and END_CHARPOS. */
27068 && !INTEGERP (glyph
->object
)
27069 && !EQ (glyph
->object
, disp_string
)
27070 && !(BUFFERP (glyph
->object
)
27071 && (glyph
->charpos
>= start_charpos
27072 && glyph
->charpos
< end_charpos
));
27075 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27076 are present at buffer positions between START_CHARPOS and
27077 END_CHARPOS, or if they come from an overlay. */
27078 if (EQ (glyph
->object
, before_string
))
27080 pos
= string_buffer_position (before_string
, start_charpos
);
27081 /* If pos == 0, it means before_string came from an
27082 overlay, not from a buffer position. */
27083 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27086 else if (EQ (glyph
->object
, after_string
))
27088 pos
= string_buffer_position (after_string
, end_charpos
);
27089 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27094 glyph
++; /* first glyph to the right of the highlighted area */
27095 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27096 x
+= g
->pixel_width
;
27097 hlinfo
->mouse_face_beg_x
= x
;
27098 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27101 /* If the highlight ends in a different row, compute GLYPH and END
27102 for the end row. Otherwise, reuse the values computed above for
27103 the row where the highlight begins. */
27106 if (!r2
->reversed_p
)
27108 glyph
= r2
->glyphs
[TEXT_AREA
];
27109 end
= glyph
+ r2
->used
[TEXT_AREA
];
27114 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27115 glyph
= end
+ r2
->used
[TEXT_AREA
];
27119 if (!r2
->reversed_p
)
27121 /* Skip truncation and continuation glyphs near the end of the
27122 row, and also blanks and stretch glyphs inserted by
27123 extend_face_to_end_of_line. */
27125 && INTEGERP ((end
- 1)->object
))
27127 /* Scan the rest of the glyph row from the end, looking for the
27128 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27129 DISP_STRING, or whose position is between START_CHARPOS
27133 && !INTEGERP (end
->object
)
27134 && !EQ (end
->object
, disp_string
)
27135 && !(BUFFERP (end
->object
)
27136 && (end
->charpos
>= start_charpos
27137 && end
->charpos
< end_charpos
));
27140 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27141 are present at buffer positions between START_CHARPOS and
27142 END_CHARPOS, or if they come from an overlay. */
27143 if (EQ (end
->object
, before_string
))
27145 pos
= string_buffer_position (before_string
, start_charpos
);
27146 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27149 else if (EQ (end
->object
, after_string
))
27151 pos
= string_buffer_position (after_string
, end_charpos
);
27152 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27156 /* Find the X coordinate of the last glyph to be highlighted. */
27157 for (; glyph
<= end
; ++glyph
)
27158 x
+= glyph
->pixel_width
;
27160 hlinfo
->mouse_face_end_x
= x
;
27161 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
27165 /* Skip truncation and continuation glyphs near the end of the
27166 row, and also blanks and stretch glyphs inserted by
27167 extend_face_to_end_of_line. */
27171 && INTEGERP (end
->object
))
27173 x
+= end
->pixel_width
;
27176 /* Scan the rest of the glyph row from the end, looking for the
27177 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27178 DISP_STRING, or whose position is between START_CHARPOS
27182 && !INTEGERP (end
->object
)
27183 && !EQ (end
->object
, disp_string
)
27184 && !(BUFFERP (end
->object
)
27185 && (end
->charpos
>= start_charpos
27186 && end
->charpos
< end_charpos
));
27189 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27190 are present at buffer positions between START_CHARPOS and
27191 END_CHARPOS, or if they come from an overlay. */
27192 if (EQ (end
->object
, before_string
))
27194 pos
= string_buffer_position (before_string
, start_charpos
);
27195 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27198 else if (EQ (end
->object
, after_string
))
27200 pos
= string_buffer_position (after_string
, end_charpos
);
27201 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27204 x
+= end
->pixel_width
;
27206 /* If we exited the above loop because we arrived at the last
27207 glyph of the row, and its buffer position is still not in
27208 range, it means the last character in range is the preceding
27209 newline. Bump the end column and x values to get past the
27212 && BUFFERP (end
->object
)
27213 && (end
->charpos
< start_charpos
27214 || end
->charpos
>= end_charpos
))
27216 x
+= end
->pixel_width
;
27219 hlinfo
->mouse_face_end_x
= x
;
27220 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
27223 hlinfo
->mouse_face_window
= window
;
27224 hlinfo
->mouse_face_face_id
27225 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
27227 !hlinfo
->mouse_face_hidden
, -1);
27228 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27231 /* The following function is not used anymore (replaced with
27232 mouse_face_from_string_pos), but I leave it here for the time
27233 being, in case someone would. */
27235 #if 0 /* not used */
27237 /* Find the position of the glyph for position POS in OBJECT in
27238 window W's current matrix, and return in *X, *Y the pixel
27239 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
27241 RIGHT_P non-zero means return the position of the right edge of the
27242 glyph, RIGHT_P zero means return the left edge position.
27244 If no glyph for POS exists in the matrix, return the position of
27245 the glyph with the next smaller position that is in the matrix, if
27246 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
27247 exists in the matrix, return the position of the glyph with the
27248 next larger position in OBJECT.
27250 Value is non-zero if a glyph was found. */
27253 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27254 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27256 int yb
= window_text_bottom_y (w
);
27257 struct glyph_row
*r
;
27258 struct glyph
*best_glyph
= NULL
;
27259 struct glyph_row
*best_row
= NULL
;
27262 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27263 r
->enabled_p
&& r
->y
< yb
;
27266 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27267 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27270 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27271 if (EQ (g
->object
, object
))
27273 if (g
->charpos
== pos
)
27280 else if (best_glyph
== NULL
27281 || ((eabs (g
->charpos
- pos
)
27282 < eabs (best_glyph
->charpos
- pos
))
27285 : g
->charpos
> pos
)))
27299 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
27303 *x
+= best_glyph
->pixel_width
;
27308 *vpos
= best_row
- w
->current_matrix
->rows
;
27311 return best_glyph
!= NULL
;
27313 #endif /* not used */
27315 /* Find the positions of the first and the last glyphs in window W's
27316 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27317 (assumed to be a string), and return in HLINFO's mouse_face_*
27318 members the pixel and column/row coordinates of those glyphs. */
27321 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27322 Lisp_Object object
,
27323 ptrdiff_t startpos
, ptrdiff_t endpos
)
27325 int yb
= window_text_bottom_y (w
);
27326 struct glyph_row
*r
;
27327 struct glyph
*g
, *e
;
27331 /* Find the glyph row with at least one position in the range
27332 [STARTPOS..ENDPOS], and the first glyph in that row whose
27333 position belongs to that range. */
27334 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27335 r
->enabled_p
&& r
->y
< yb
;
27338 if (!r
->reversed_p
)
27340 g
= r
->glyphs
[TEXT_AREA
];
27341 e
= g
+ r
->used
[TEXT_AREA
];
27342 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27343 if (EQ (g
->object
, object
)
27344 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27346 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27347 hlinfo
->mouse_face_beg_y
= r
->y
;
27348 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27349 hlinfo
->mouse_face_beg_x
= gx
;
27358 e
= r
->glyphs
[TEXT_AREA
];
27359 g
= e
+ r
->used
[TEXT_AREA
];
27360 for ( ; g
> e
; --g
)
27361 if (EQ ((g
-1)->object
, object
)
27362 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27364 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27365 hlinfo
->mouse_face_beg_y
= r
->y
;
27366 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27367 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27368 gx
+= g1
->pixel_width
;
27369 hlinfo
->mouse_face_beg_x
= gx
;
27381 /* Starting with the next row, look for the first row which does NOT
27382 include any glyphs whose positions are in the range. */
27383 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27385 g
= r
->glyphs
[TEXT_AREA
];
27386 e
= g
+ r
->used
[TEXT_AREA
];
27388 for ( ; g
< e
; ++g
)
27389 if (EQ (g
->object
, object
)
27390 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27399 /* The highlighted region ends on the previous row. */
27402 /* Set the end row and its vertical pixel coordinate. */
27403 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27404 hlinfo
->mouse_face_end_y
= r
->y
;
27406 /* Compute and set the end column and the end column's horizontal
27407 pixel coordinate. */
27408 if (!r
->reversed_p
)
27410 g
= r
->glyphs
[TEXT_AREA
];
27411 e
= g
+ r
->used
[TEXT_AREA
];
27412 for ( ; e
> g
; --e
)
27413 if (EQ ((e
-1)->object
, object
)
27414 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27416 hlinfo
->mouse_face_end_col
= e
- g
;
27418 for (gx
= r
->x
; g
< e
; ++g
)
27419 gx
+= g
->pixel_width
;
27420 hlinfo
->mouse_face_end_x
= gx
;
27424 e
= r
->glyphs
[TEXT_AREA
];
27425 g
= e
+ r
->used
[TEXT_AREA
];
27426 for (gx
= r
->x
; e
< g
; ++e
)
27428 if (EQ (e
->object
, object
)
27429 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27431 gx
+= e
->pixel_width
;
27433 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27434 hlinfo
->mouse_face_end_x
= gx
;
27438 #ifdef HAVE_WINDOW_SYSTEM
27440 /* See if position X, Y is within a hot-spot of an image. */
27443 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27445 if (!CONSP (hot_spot
))
27448 if (EQ (XCAR (hot_spot
), Qrect
))
27450 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27451 Lisp_Object rect
= XCDR (hot_spot
);
27455 if (!CONSP (XCAR (rect
)))
27457 if (!CONSP (XCDR (rect
)))
27459 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27461 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27463 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27465 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27469 else if (EQ (XCAR (hot_spot
), Qcircle
))
27471 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27472 Lisp_Object circ
= XCDR (hot_spot
);
27473 Lisp_Object lr
, lx0
, ly0
;
27475 && CONSP (XCAR (circ
))
27476 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27477 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27478 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27480 double r
= XFLOATINT (lr
);
27481 double dx
= XINT (lx0
) - x
;
27482 double dy
= XINT (ly0
) - y
;
27483 return (dx
* dx
+ dy
* dy
<= r
* r
);
27486 else if (EQ (XCAR (hot_spot
), Qpoly
))
27488 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27489 if (VECTORP (XCDR (hot_spot
)))
27491 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27492 Lisp_Object
*poly
= v
->contents
;
27493 ptrdiff_t n
= v
->header
.size
;
27496 Lisp_Object lx
, ly
;
27499 /* Need an even number of coordinates, and at least 3 edges. */
27500 if (n
< 6 || n
& 1)
27503 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27504 If count is odd, we are inside polygon. Pixels on edges
27505 may or may not be included depending on actual geometry of the
27507 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27508 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27510 x0
= XINT (lx
), y0
= XINT (ly
);
27511 for (i
= 0; i
< n
; i
+= 2)
27513 int x1
= x0
, y1
= y0
;
27514 if ((lx
= poly
[i
], !INTEGERP (lx
))
27515 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27517 x0
= XINT (lx
), y0
= XINT (ly
);
27519 /* Does this segment cross the X line? */
27527 if (y
> y0
&& y
> y1
)
27529 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27539 find_hot_spot (Lisp_Object map
, int x
, int y
)
27541 while (CONSP (map
))
27543 if (CONSP (XCAR (map
))
27544 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27552 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27554 doc
: /* Lookup in image map MAP coordinates X and Y.
27555 An image map is an alist where each element has the format (AREA ID PLIST).
27556 An AREA is specified as either a rectangle, a circle, or a polygon:
27557 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27558 pixel coordinates of the upper left and bottom right corners.
27559 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27560 and the radius of the circle; r may be a float or integer.
27561 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27562 vector describes one corner in the polygon.
27563 Returns the alist element for the first matching AREA in MAP. */)
27564 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27572 return find_hot_spot (map
,
27573 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27574 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27578 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27580 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27582 /* Do not change cursor shape while dragging mouse. */
27583 if (!NILP (do_mouse_tracking
))
27586 if (!NILP (pointer
))
27588 if (EQ (pointer
, Qarrow
))
27589 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27590 else if (EQ (pointer
, Qhand
))
27591 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27592 else if (EQ (pointer
, Qtext
))
27593 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27594 else if (EQ (pointer
, intern ("hdrag")))
27595 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27596 #ifdef HAVE_X_WINDOWS
27597 else if (EQ (pointer
, intern ("vdrag")))
27598 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27600 else if (EQ (pointer
, intern ("hourglass")))
27601 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27602 else if (EQ (pointer
, Qmodeline
))
27603 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27605 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27608 if (cursor
!= No_Cursor
)
27609 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27612 #endif /* HAVE_WINDOW_SYSTEM */
27614 /* Take proper action when mouse has moved to the mode or header line
27615 or marginal area AREA of window W, x-position X and y-position Y.
27616 X is relative to the start of the text display area of W, so the
27617 width of bitmap areas and scroll bars must be subtracted to get a
27618 position relative to the start of the mode line. */
27621 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27622 enum window_part area
)
27624 struct window
*w
= XWINDOW (window
);
27625 struct frame
*f
= XFRAME (w
->frame
);
27626 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27627 #ifdef HAVE_WINDOW_SYSTEM
27628 Display_Info
*dpyinfo
;
27630 Cursor cursor
= No_Cursor
;
27631 Lisp_Object pointer
= Qnil
;
27632 int dx
, dy
, width
, height
;
27634 Lisp_Object string
, object
= Qnil
;
27635 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27637 Lisp_Object mouse_face
;
27638 int original_x_pixel
= x
;
27639 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27640 struct glyph_row
*row
IF_LINT (= 0);
27642 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27647 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27648 returns them in row/column units! */
27649 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27650 &object
, &dx
, &dy
, &width
, &height
);
27652 row
= (area
== ON_MODE_LINE
27653 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27654 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27656 /* Find the glyph under the mouse pointer. */
27657 if (row
->mode_line_p
&& row
->enabled_p
)
27659 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27660 end
= glyph
+ row
->used
[TEXT_AREA
];
27662 for (x0
= original_x_pixel
;
27663 glyph
< end
&& x0
>= glyph
->pixel_width
;
27665 x0
-= glyph
->pixel_width
;
27673 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27674 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27675 returns them in row/column units! */
27676 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27677 &object
, &dx
, &dy
, &width
, &height
);
27682 #ifdef HAVE_WINDOW_SYSTEM
27683 if (IMAGEP (object
))
27685 Lisp_Object image_map
, hotspot
;
27686 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27688 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27690 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27694 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27695 If so, we could look for mouse-enter, mouse-leave
27696 properties in PLIST (and do something...). */
27697 hotspot
= XCDR (hotspot
);
27698 if (CONSP (hotspot
)
27699 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27701 pointer
= Fplist_get (plist
, Qpointer
);
27702 if (NILP (pointer
))
27704 help
= Fplist_get (plist
, Qhelp_echo
);
27707 help_echo_string
= help
;
27708 XSETWINDOW (help_echo_window
, w
);
27709 help_echo_object
= w
->buffer
;
27710 help_echo_pos
= charpos
;
27714 if (NILP (pointer
))
27715 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27717 #endif /* HAVE_WINDOW_SYSTEM */
27719 if (STRINGP (string
))
27720 pos
= make_number (charpos
);
27722 /* Set the help text and mouse pointer. If the mouse is on a part
27723 of the mode line without any text (e.g. past the right edge of
27724 the mode line text), use the default help text and pointer. */
27725 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27727 /* Arrange to display the help by setting the global variables
27728 help_echo_string, help_echo_object, and help_echo_pos. */
27731 if (STRINGP (string
))
27732 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27736 help_echo_string
= help
;
27737 XSETWINDOW (help_echo_window
, w
);
27738 help_echo_object
= string
;
27739 help_echo_pos
= charpos
;
27741 else if (area
== ON_MODE_LINE
)
27743 Lisp_Object default_help
27744 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27747 if (STRINGP (default_help
))
27749 help_echo_string
= default_help
;
27750 XSETWINDOW (help_echo_window
, w
);
27751 help_echo_object
= Qnil
;
27752 help_echo_pos
= -1;
27757 #ifdef HAVE_WINDOW_SYSTEM
27758 /* Change the mouse pointer according to what is under it. */
27759 if (FRAME_WINDOW_P (f
))
27761 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27762 if (STRINGP (string
))
27764 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27766 if (NILP (pointer
))
27767 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27769 /* Change the mouse pointer according to what is under X/Y. */
27771 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27774 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27775 if (!KEYMAPP (map
))
27776 map
= Fget_text_property (pos
, Qkeymap
, string
);
27777 if (!KEYMAPP (map
))
27778 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27782 /* Default mode-line pointer. */
27783 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27788 /* Change the mouse face according to what is under X/Y. */
27789 if (STRINGP (string
))
27791 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27792 if (!NILP (mouse_face
)
27793 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27798 struct glyph
* tmp_glyph
;
27802 int total_pixel_width
;
27803 ptrdiff_t begpos
, endpos
, ignore
;
27807 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27808 Qmouse_face
, string
, Qnil
);
27814 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27816 endpos
= SCHARS (string
);
27820 /* Calculate the glyph position GPOS of GLYPH in the
27821 displayed string, relative to the beginning of the
27822 highlighted part of the string.
27824 Note: GPOS is different from CHARPOS. CHARPOS is the
27825 position of GLYPH in the internal string object. A mode
27826 line string format has structures which are converted to
27827 a flattened string by the Emacs Lisp interpreter. The
27828 internal string is an element of those structures. The
27829 displayed string is the flattened string. */
27830 tmp_glyph
= row_start_glyph
;
27831 while (tmp_glyph
< glyph
27832 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27833 && begpos
<= tmp_glyph
->charpos
27834 && tmp_glyph
->charpos
< endpos
)))
27836 gpos
= glyph
- tmp_glyph
;
27838 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27839 the highlighted part of the displayed string to which
27840 GLYPH belongs. Note: GSEQ_LENGTH is different from
27841 SCHARS (STRING), because the latter returns the length of
27842 the internal string. */
27843 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27845 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27846 && begpos
<= tmp_glyph
->charpos
27847 && tmp_glyph
->charpos
< endpos
));
27850 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27852 /* Calculate the total pixel width of all the glyphs between
27853 the beginning of the highlighted area and GLYPH. */
27854 total_pixel_width
= 0;
27855 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27856 total_pixel_width
+= tmp_glyph
->pixel_width
;
27858 /* Pre calculation of re-rendering position. Note: X is in
27859 column units here, after the call to mode_line_string or
27860 marginal_area_string. */
27862 vpos
= (area
== ON_MODE_LINE
27863 ? (w
->current_matrix
)->nrows
- 1
27866 /* If GLYPH's position is included in the region that is
27867 already drawn in mouse face, we have nothing to do. */
27868 if ( EQ (window
, hlinfo
->mouse_face_window
)
27869 && (!row
->reversed_p
27870 ? (hlinfo
->mouse_face_beg_col
<= hpos
27871 && hpos
< hlinfo
->mouse_face_end_col
)
27872 /* In R2L rows we swap BEG and END, see below. */
27873 : (hlinfo
->mouse_face_end_col
<= hpos
27874 && hpos
< hlinfo
->mouse_face_beg_col
))
27875 && hlinfo
->mouse_face_beg_row
== vpos
)
27878 if (clear_mouse_face (hlinfo
))
27879 cursor
= No_Cursor
;
27881 if (!row
->reversed_p
)
27883 hlinfo
->mouse_face_beg_col
= hpos
;
27884 hlinfo
->mouse_face_beg_x
= original_x_pixel
27885 - (total_pixel_width
+ dx
);
27886 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27887 hlinfo
->mouse_face_end_x
= 0;
27891 /* In R2L rows, show_mouse_face expects BEG and END
27892 coordinates to be swapped. */
27893 hlinfo
->mouse_face_end_col
= hpos
;
27894 hlinfo
->mouse_face_end_x
= original_x_pixel
27895 - (total_pixel_width
+ dx
);
27896 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27897 hlinfo
->mouse_face_beg_x
= 0;
27900 hlinfo
->mouse_face_beg_row
= vpos
;
27901 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27902 hlinfo
->mouse_face_beg_y
= 0;
27903 hlinfo
->mouse_face_end_y
= 0;
27904 hlinfo
->mouse_face_past_end
= 0;
27905 hlinfo
->mouse_face_window
= window
;
27907 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27913 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27915 if (NILP (pointer
))
27918 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27919 clear_mouse_face (hlinfo
);
27921 #ifdef HAVE_WINDOW_SYSTEM
27922 if (FRAME_WINDOW_P (f
))
27923 define_frame_cursor1 (f
, cursor
, pointer
);
27929 Take proper action when the mouse has moved to position X, Y on
27930 frame F as regards highlighting characters that have mouse-face
27931 properties. Also de-highlighting chars where the mouse was before.
27932 X and Y can be negative or out of range. */
27935 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27937 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27938 enum window_part part
= ON_NOTHING
;
27939 Lisp_Object window
;
27941 Cursor cursor
= No_Cursor
;
27942 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27945 /* When a menu is active, don't highlight because this looks odd. */
27946 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27947 if (popup_activated ())
27951 if (NILP (Vmouse_highlight
)
27952 || !f
->glyphs_initialized_p
27953 || f
->pointer_invisible
)
27956 hlinfo
->mouse_face_mouse_x
= x
;
27957 hlinfo
->mouse_face_mouse_y
= y
;
27958 hlinfo
->mouse_face_mouse_frame
= f
;
27960 if (hlinfo
->mouse_face_defer
)
27963 /* Which window is that in? */
27964 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27966 /* If displaying active text in another window, clear that. */
27967 if (! EQ (window
, hlinfo
->mouse_face_window
)
27968 /* Also clear if we move out of text area in same window. */
27969 || (!NILP (hlinfo
->mouse_face_window
)
27972 && part
!= ON_MODE_LINE
27973 && part
!= ON_HEADER_LINE
))
27974 clear_mouse_face (hlinfo
);
27976 /* Not on a window -> return. */
27977 if (!WINDOWP (window
))
27980 /* Reset help_echo_string. It will get recomputed below. */
27981 help_echo_string
= Qnil
;
27983 /* Convert to window-relative pixel coordinates. */
27984 w
= XWINDOW (window
);
27985 frame_to_window_pixel_xy (w
, &x
, &y
);
27987 #ifdef HAVE_WINDOW_SYSTEM
27988 /* Handle tool-bar window differently since it doesn't display a
27990 if (EQ (window
, f
->tool_bar_window
))
27992 note_tool_bar_highlight (f
, x
, y
);
27997 /* Mouse is on the mode, header line or margin? */
27998 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27999 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28001 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28005 #ifdef HAVE_WINDOW_SYSTEM
28006 if (part
== ON_VERTICAL_BORDER
)
28008 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28009 help_echo_string
= build_string ("drag-mouse-1: resize");
28011 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28012 || part
== ON_SCROLL_BAR
)
28013 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28015 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28018 /* Are we in a window whose display is up to date?
28019 And verify the buffer's text has not changed. */
28020 b
= XBUFFER (w
->buffer
);
28021 if (part
== ON_TEXT
28022 && EQ (w
->window_end_valid
, w
->buffer
)
28023 && w
->last_modified
== BUF_MODIFF (b
)
28024 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
28026 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28028 struct glyph
*glyph
;
28029 Lisp_Object object
;
28030 Lisp_Object mouse_face
= Qnil
, position
;
28031 Lisp_Object
*overlay_vec
= NULL
;
28032 ptrdiff_t i
, noverlays
;
28033 struct buffer
*obuf
;
28034 ptrdiff_t obegv
, ozv
;
28037 /* Find the glyph under X/Y. */
28038 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28040 #ifdef HAVE_WINDOW_SYSTEM
28041 /* Look for :pointer property on image. */
28042 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28044 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28045 if (img
!= NULL
&& IMAGEP (img
->spec
))
28047 Lisp_Object image_map
, hotspot
;
28048 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28050 && (hotspot
= find_hot_spot (image_map
,
28051 glyph
->slice
.img
.x
+ dx
,
28052 glyph
->slice
.img
.y
+ dy
),
28054 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28058 /* Could check XCAR (hotspot) to see if we enter/leave
28060 If so, we could look for mouse-enter, mouse-leave
28061 properties in PLIST (and do something...). */
28062 hotspot
= XCDR (hotspot
);
28063 if (CONSP (hotspot
)
28064 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28066 pointer
= Fplist_get (plist
, Qpointer
);
28067 if (NILP (pointer
))
28069 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28070 if (!NILP (help_echo_string
))
28072 help_echo_window
= window
;
28073 help_echo_object
= glyph
->object
;
28074 help_echo_pos
= glyph
->charpos
;
28078 if (NILP (pointer
))
28079 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28082 #endif /* HAVE_WINDOW_SYSTEM */
28084 /* Clear mouse face if X/Y not over text. */
28086 || area
!= TEXT_AREA
28087 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
28088 /* Glyph's OBJECT is an integer for glyphs inserted by the
28089 display engine for its internal purposes, like truncation
28090 and continuation glyphs and blanks beyond the end of
28091 line's text on text terminals. If we are over such a
28092 glyph, we are not over any text. */
28093 || INTEGERP (glyph
->object
)
28094 /* R2L rows have a stretch glyph at their front, which
28095 stands for no text, whereas L2R rows have no glyphs at
28096 all beyond the end of text. Treat such stretch glyphs
28097 like we do with NULL glyphs in L2R rows. */
28098 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28099 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
28100 && glyph
->type
== STRETCH_GLYPH
28101 && glyph
->avoid_cursor_p
))
28103 if (clear_mouse_face (hlinfo
))
28104 cursor
= No_Cursor
;
28105 #ifdef HAVE_WINDOW_SYSTEM
28106 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28108 if (area
!= TEXT_AREA
)
28109 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28111 pointer
= Vvoid_text_area_pointer
;
28117 pos
= glyph
->charpos
;
28118 object
= glyph
->object
;
28119 if (!STRINGP (object
) && !BUFFERP (object
))
28122 /* If we get an out-of-range value, return now; avoid an error. */
28123 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28126 /* Make the window's buffer temporarily current for
28127 overlays_at and compute_char_face. */
28128 obuf
= current_buffer
;
28129 current_buffer
= b
;
28135 /* Is this char mouse-active or does it have help-echo? */
28136 position
= make_number (pos
);
28138 if (BUFFERP (object
))
28140 /* Put all the overlays we want in a vector in overlay_vec. */
28141 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
28142 /* Sort overlays into increasing priority order. */
28143 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
28148 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
28151 cursor
= No_Cursor
;
28153 /* Check mouse-face highlighting. */
28155 /* If there exists an overlay with mouse-face overlapping
28156 the one we are currently highlighting, we have to
28157 check if we enter the overlapping overlay, and then
28158 highlight only that. */
28159 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
28160 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
28162 /* Find the highest priority overlay with a mouse-face. */
28163 Lisp_Object overlay
= Qnil
;
28164 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
28166 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
28167 if (!NILP (mouse_face
))
28168 overlay
= overlay_vec
[i
];
28171 /* If we're highlighting the same overlay as before, there's
28172 no need to do that again. */
28173 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
28174 goto check_help_echo
;
28175 hlinfo
->mouse_face_overlay
= overlay
;
28177 /* Clear the display of the old active region, if any. */
28178 if (clear_mouse_face (hlinfo
))
28179 cursor
= No_Cursor
;
28181 /* If no overlay applies, get a text property. */
28182 if (NILP (overlay
))
28183 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
28185 /* Next, compute the bounds of the mouse highlighting and
28187 if (!NILP (mouse_face
) && STRINGP (object
))
28189 /* The mouse-highlighting comes from a display string
28190 with a mouse-face. */
28194 s
= Fprevious_single_property_change
28195 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
28196 e
= Fnext_single_property_change
28197 (position
, Qmouse_face
, object
, Qnil
);
28199 s
= make_number (0);
28201 e
= make_number (SCHARS (object
) - 1);
28202 mouse_face_from_string_pos (w
, hlinfo
, object
,
28203 XINT (s
), XINT (e
));
28204 hlinfo
->mouse_face_past_end
= 0;
28205 hlinfo
->mouse_face_window
= window
;
28206 hlinfo
->mouse_face_face_id
28207 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
28208 glyph
->face_id
, 1);
28209 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28210 cursor
= No_Cursor
;
28214 /* The mouse-highlighting, if any, comes from an overlay
28215 or text property in the buffer. */
28216 Lisp_Object buffer
IF_LINT (= Qnil
);
28217 Lisp_Object disp_string
IF_LINT (= Qnil
);
28219 if (STRINGP (object
))
28221 /* If we are on a display string with no mouse-face,
28222 check if the text under it has one. */
28223 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
28224 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28225 pos
= string_buffer_position (object
, start
);
28228 mouse_face
= get_char_property_and_overlay
28229 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
28230 buffer
= w
->buffer
;
28231 disp_string
= object
;
28237 disp_string
= Qnil
;
28240 if (!NILP (mouse_face
))
28242 Lisp_Object before
, after
;
28243 Lisp_Object before_string
, after_string
;
28244 /* To correctly find the limits of mouse highlight
28245 in a bidi-reordered buffer, we must not use the
28246 optimization of limiting the search in
28247 previous-single-property-change and
28248 next-single-property-change, because
28249 rows_from_pos_range needs the real start and end
28250 positions to DTRT in this case. That's because
28251 the first row visible in a window does not
28252 necessarily display the character whose position
28253 is the smallest. */
28255 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28256 ? Fmarker_position (w
->start
)
28259 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
28260 ? make_number (BUF_Z (XBUFFER (buffer
))
28261 - XFASTINT (w
->window_end_pos
))
28264 if (NILP (overlay
))
28266 /* Handle the text property case. */
28267 before
= Fprevious_single_property_change
28268 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
28269 after
= Fnext_single_property_change
28270 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
28271 before_string
= after_string
= Qnil
;
28275 /* Handle the overlay case. */
28276 before
= Foverlay_start (overlay
);
28277 after
= Foverlay_end (overlay
);
28278 before_string
= Foverlay_get (overlay
, Qbefore_string
);
28279 after_string
= Foverlay_get (overlay
, Qafter_string
);
28281 if (!STRINGP (before_string
)) before_string
= Qnil
;
28282 if (!STRINGP (after_string
)) after_string
= Qnil
;
28285 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
28288 : XFASTINT (before
),
28290 ? BUF_Z (XBUFFER (buffer
))
28291 : XFASTINT (after
),
28292 before_string
, after_string
,
28294 cursor
= No_Cursor
;
28301 /* Look for a `help-echo' property. */
28302 if (NILP (help_echo_string
)) {
28303 Lisp_Object help
, overlay
;
28305 /* Check overlays first. */
28306 help
= overlay
= Qnil
;
28307 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
28309 overlay
= overlay_vec
[i
];
28310 help
= Foverlay_get (overlay
, Qhelp_echo
);
28315 help_echo_string
= help
;
28316 help_echo_window
= window
;
28317 help_echo_object
= overlay
;
28318 help_echo_pos
= pos
;
28322 Lisp_Object obj
= glyph
->object
;
28323 ptrdiff_t charpos
= glyph
->charpos
;
28325 /* Try text properties. */
28328 && charpos
< SCHARS (obj
))
28330 help
= Fget_text_property (make_number (charpos
),
28334 /* If the string itself doesn't specify a help-echo,
28335 see if the buffer text ``under'' it does. */
28336 struct glyph_row
*r
28337 = MATRIX_ROW (w
->current_matrix
, vpos
);
28338 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28339 ptrdiff_t p
= string_buffer_position (obj
, start
);
28342 help
= Fget_char_property (make_number (p
),
28343 Qhelp_echo
, w
->buffer
);
28352 else if (BUFFERP (obj
)
28355 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28360 help_echo_string
= help
;
28361 help_echo_window
= window
;
28362 help_echo_object
= obj
;
28363 help_echo_pos
= charpos
;
28368 #ifdef HAVE_WINDOW_SYSTEM
28369 /* Look for a `pointer' property. */
28370 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28372 /* Check overlays first. */
28373 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28374 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28376 if (NILP (pointer
))
28378 Lisp_Object obj
= glyph
->object
;
28379 ptrdiff_t charpos
= glyph
->charpos
;
28381 /* Try text properties. */
28384 && charpos
< SCHARS (obj
))
28386 pointer
= Fget_text_property (make_number (charpos
),
28388 if (NILP (pointer
))
28390 /* If the string itself doesn't specify a pointer,
28391 see if the buffer text ``under'' it does. */
28392 struct glyph_row
*r
28393 = MATRIX_ROW (w
->current_matrix
, vpos
);
28394 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28395 ptrdiff_t p
= string_buffer_position (obj
, start
);
28397 pointer
= Fget_char_property (make_number (p
),
28398 Qpointer
, w
->buffer
);
28401 else if (BUFFERP (obj
)
28404 pointer
= Fget_text_property (make_number (charpos
),
28408 #endif /* HAVE_WINDOW_SYSTEM */
28412 current_buffer
= obuf
;
28417 #ifdef HAVE_WINDOW_SYSTEM
28418 if (FRAME_WINDOW_P (f
))
28419 define_frame_cursor1 (f
, cursor
, pointer
);
28421 /* This is here to prevent a compiler error, about "label at end of
28422 compound statement". */
28429 Clear any mouse-face on window W. This function is part of the
28430 redisplay interface, and is called from try_window_id and similar
28431 functions to ensure the mouse-highlight is off. */
28434 x_clear_window_mouse_face (struct window
*w
)
28436 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28437 Lisp_Object window
;
28440 XSETWINDOW (window
, w
);
28441 if (EQ (window
, hlinfo
->mouse_face_window
))
28442 clear_mouse_face (hlinfo
);
28448 Just discard the mouse face information for frame F, if any.
28449 This is used when the size of F is changed. */
28452 cancel_mouse_face (struct frame
*f
)
28454 Lisp_Object window
;
28455 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28457 window
= hlinfo
->mouse_face_window
;
28458 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28460 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28461 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28462 hlinfo
->mouse_face_window
= Qnil
;
28468 /***********************************************************************
28470 ***********************************************************************/
28472 #ifdef HAVE_WINDOW_SYSTEM
28474 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28475 which intersects rectangle R. R is in window-relative coordinates. */
28478 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28479 enum glyph_row_area area
)
28481 struct glyph
*first
= row
->glyphs
[area
];
28482 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28483 struct glyph
*last
;
28484 int first_x
, start_x
, x
;
28486 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28487 /* If row extends face to end of line write the whole line. */
28488 draw_glyphs (w
, 0, row
, area
,
28489 0, row
->used
[area
],
28490 DRAW_NORMAL_TEXT
, 0);
28493 /* Set START_X to the window-relative start position for drawing glyphs of
28494 AREA. The first glyph of the text area can be partially visible.
28495 The first glyphs of other areas cannot. */
28496 start_x
= window_box_left_offset (w
, area
);
28498 if (area
== TEXT_AREA
)
28501 /* Find the first glyph that must be redrawn. */
28503 && x
+ first
->pixel_width
< r
->x
)
28505 x
+= first
->pixel_width
;
28509 /* Find the last one. */
28513 && x
< r
->x
+ r
->width
)
28515 x
+= last
->pixel_width
;
28521 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28522 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28523 DRAW_NORMAL_TEXT
, 0);
28528 /* Redraw the parts of the glyph row ROW on window W intersecting
28529 rectangle R. R is in window-relative coordinates. Value is
28530 non-zero if mouse-face was overwritten. */
28533 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28535 eassert (row
->enabled_p
);
28537 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28538 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28539 0, row
->used
[TEXT_AREA
],
28540 DRAW_NORMAL_TEXT
, 0);
28543 if (row
->used
[LEFT_MARGIN_AREA
])
28544 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28545 if (row
->used
[TEXT_AREA
])
28546 expose_area (w
, row
, r
, TEXT_AREA
);
28547 if (row
->used
[RIGHT_MARGIN_AREA
])
28548 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28549 draw_row_fringe_bitmaps (w
, row
);
28552 return row
->mouse_face_p
;
28556 /* Redraw those parts of glyphs rows during expose event handling that
28557 overlap other rows. Redrawing of an exposed line writes over parts
28558 of lines overlapping that exposed line; this function fixes that.
28560 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28561 row in W's current matrix that is exposed and overlaps other rows.
28562 LAST_OVERLAPPING_ROW is the last such row. */
28565 expose_overlaps (struct window
*w
,
28566 struct glyph_row
*first_overlapping_row
,
28567 struct glyph_row
*last_overlapping_row
,
28570 struct glyph_row
*row
;
28572 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28573 if (row
->overlapping_p
)
28575 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28578 if (row
->used
[LEFT_MARGIN_AREA
])
28579 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28581 if (row
->used
[TEXT_AREA
])
28582 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28584 if (row
->used
[RIGHT_MARGIN_AREA
])
28585 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28591 /* Return non-zero if W's cursor intersects rectangle R. */
28594 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28596 XRectangle cr
, result
;
28597 struct glyph
*cursor_glyph
;
28598 struct glyph_row
*row
;
28600 if (w
->phys_cursor
.vpos
>= 0
28601 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28602 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28604 && row
->cursor_in_fringe_p
)
28606 /* Cursor is in the fringe. */
28607 cr
.x
= window_box_right_offset (w
,
28608 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28609 ? RIGHT_MARGIN_AREA
28612 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28613 cr
.height
= row
->height
;
28614 return x_intersect_rectangles (&cr
, r
, &result
);
28617 cursor_glyph
= get_phys_cursor_glyph (w
);
28620 /* r is relative to W's box, but w->phys_cursor.x is relative
28621 to left edge of W's TEXT area. Adjust it. */
28622 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28623 cr
.y
= w
->phys_cursor
.y
;
28624 cr
.width
= cursor_glyph
->pixel_width
;
28625 cr
.height
= w
->phys_cursor_height
;
28626 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28627 I assume the effect is the same -- and this is portable. */
28628 return x_intersect_rectangles (&cr
, r
, &result
);
28630 /* If we don't understand the format, pretend we're not in the hot-spot. */
28636 Draw a vertical window border to the right of window W if W doesn't
28637 have vertical scroll bars. */
28640 x_draw_vertical_border (struct window
*w
)
28642 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28644 /* We could do better, if we knew what type of scroll-bar the adjacent
28645 windows (on either side) have... But we don't :-(
28646 However, I think this works ok. ++KFS 2003-04-25 */
28648 /* Redraw borders between horizontally adjacent windows. Don't
28649 do it for frames with vertical scroll bars because either the
28650 right scroll bar of a window, or the left scroll bar of its
28651 neighbor will suffice as a border. */
28652 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28655 if (!WINDOW_RIGHTMOST_P (w
)
28656 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28658 int x0
, x1
, y0
, y1
;
28660 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28663 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28666 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28668 else if (!WINDOW_LEFTMOST_P (w
)
28669 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28671 int x0
, x1
, y0
, y1
;
28673 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28676 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28679 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28684 /* Redraw the part of window W intersection rectangle FR. Pixel
28685 coordinates in FR are frame-relative. Call this function with
28686 input blocked. Value is non-zero if the exposure overwrites
28690 expose_window (struct window
*w
, XRectangle
*fr
)
28692 struct frame
*f
= XFRAME (w
->frame
);
28694 int mouse_face_overwritten_p
= 0;
28696 /* If window is not yet fully initialized, do nothing. This can
28697 happen when toolkit scroll bars are used and a window is split.
28698 Reconfiguring the scroll bar will generate an expose for a newly
28700 if (w
->current_matrix
== NULL
)
28703 /* When we're currently updating the window, display and current
28704 matrix usually don't agree. Arrange for a thorough display
28706 if (w
== updated_window
)
28708 SET_FRAME_GARBAGED (f
);
28712 /* Frame-relative pixel rectangle of W. */
28713 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28714 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28715 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28716 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28718 if (x_intersect_rectangles (fr
, &wr
, &r
))
28720 int yb
= window_text_bottom_y (w
);
28721 struct glyph_row
*row
;
28722 int cursor_cleared_p
, phys_cursor_on_p
;
28723 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28725 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28726 r
.x
, r
.y
, r
.width
, r
.height
));
28728 /* Convert to window coordinates. */
28729 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28730 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28732 /* Turn off the cursor. */
28733 if (!w
->pseudo_window_p
28734 && phys_cursor_in_rect_p (w
, &r
))
28736 x_clear_cursor (w
);
28737 cursor_cleared_p
= 1;
28740 cursor_cleared_p
= 0;
28742 /* If the row containing the cursor extends face to end of line,
28743 then expose_area might overwrite the cursor outside the
28744 rectangle and thus notice_overwritten_cursor might clear
28745 w->phys_cursor_on_p. We remember the original value and
28746 check later if it is changed. */
28747 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28749 /* Update lines intersecting rectangle R. */
28750 first_overlapping_row
= last_overlapping_row
= NULL
;
28751 for (row
= w
->current_matrix
->rows
;
28756 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28758 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28759 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28760 || (r
.y
>= y0
&& r
.y
< y1
)
28761 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28763 /* A header line may be overlapping, but there is no need
28764 to fix overlapping areas for them. KFS 2005-02-12 */
28765 if (row
->overlapping_p
&& !row
->mode_line_p
)
28767 if (first_overlapping_row
== NULL
)
28768 first_overlapping_row
= row
;
28769 last_overlapping_row
= row
;
28773 if (expose_line (w
, row
, &r
))
28774 mouse_face_overwritten_p
= 1;
28777 else if (row
->overlapping_p
)
28779 /* We must redraw a row overlapping the exposed area. */
28781 ? y0
+ row
->phys_height
> r
.y
28782 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28784 if (first_overlapping_row
== NULL
)
28785 first_overlapping_row
= row
;
28786 last_overlapping_row
= row
;
28794 /* Display the mode line if there is one. */
28795 if (WINDOW_WANTS_MODELINE_P (w
)
28796 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28798 && row
->y
< r
.y
+ r
.height
)
28800 if (expose_line (w
, row
, &r
))
28801 mouse_face_overwritten_p
= 1;
28804 if (!w
->pseudo_window_p
)
28806 /* Fix the display of overlapping rows. */
28807 if (first_overlapping_row
)
28808 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28811 /* Draw border between windows. */
28812 x_draw_vertical_border (w
);
28814 /* Turn the cursor on again. */
28815 if (cursor_cleared_p
28816 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28817 update_window_cursor (w
, 1);
28821 return mouse_face_overwritten_p
;
28826 /* Redraw (parts) of all windows in the window tree rooted at W that
28827 intersect R. R contains frame pixel coordinates. Value is
28828 non-zero if the exposure overwrites mouse-face. */
28831 expose_window_tree (struct window
*w
, XRectangle
*r
)
28833 struct frame
*f
= XFRAME (w
->frame
);
28834 int mouse_face_overwritten_p
= 0;
28836 while (w
&& !FRAME_GARBAGED_P (f
))
28838 if (!NILP (w
->hchild
))
28839 mouse_face_overwritten_p
28840 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28841 else if (!NILP (w
->vchild
))
28842 mouse_face_overwritten_p
28843 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28845 mouse_face_overwritten_p
|= expose_window (w
, r
);
28847 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28850 return mouse_face_overwritten_p
;
28855 Redisplay an exposed area of frame F. X and Y are the upper-left
28856 corner of the exposed rectangle. W and H are width and height of
28857 the exposed area. All are pixel values. W or H zero means redraw
28858 the entire frame. */
28861 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28864 int mouse_face_overwritten_p
= 0;
28866 TRACE ((stderr
, "expose_frame "));
28868 /* No need to redraw if frame will be redrawn soon. */
28869 if (FRAME_GARBAGED_P (f
))
28871 TRACE ((stderr
, " garbaged\n"));
28875 /* If basic faces haven't been realized yet, there is no point in
28876 trying to redraw anything. This can happen when we get an expose
28877 event while Emacs is starting, e.g. by moving another window. */
28878 if (FRAME_FACE_CACHE (f
) == NULL
28879 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28881 TRACE ((stderr
, " no faces\n"));
28885 if (w
== 0 || h
== 0)
28888 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28889 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28899 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28900 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28902 if (WINDOWP (f
->tool_bar_window
))
28903 mouse_face_overwritten_p
28904 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28906 #ifdef HAVE_X_WINDOWS
28908 #ifndef USE_X_TOOLKIT
28909 if (WINDOWP (f
->menu_bar_window
))
28910 mouse_face_overwritten_p
28911 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28912 #endif /* not USE_X_TOOLKIT */
28916 /* Some window managers support a focus-follows-mouse style with
28917 delayed raising of frames. Imagine a partially obscured frame,
28918 and moving the mouse into partially obscured mouse-face on that
28919 frame. The visible part of the mouse-face will be highlighted,
28920 then the WM raises the obscured frame. With at least one WM, KDE
28921 2.1, Emacs is not getting any event for the raising of the frame
28922 (even tried with SubstructureRedirectMask), only Expose events.
28923 These expose events will draw text normally, i.e. not
28924 highlighted. Which means we must redo the highlight here.
28925 Subsume it under ``we love X''. --gerd 2001-08-15 */
28926 /* Included in Windows version because Windows most likely does not
28927 do the right thing if any third party tool offers
28928 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28929 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28931 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28932 if (f
== hlinfo
->mouse_face_mouse_frame
)
28934 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28935 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28936 clear_mouse_face (hlinfo
);
28937 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28944 Determine the intersection of two rectangles R1 and R2. Return
28945 the intersection in *RESULT. Value is non-zero if RESULT is not
28949 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28951 XRectangle
*left
, *right
;
28952 XRectangle
*upper
, *lower
;
28953 int intersection_p
= 0;
28955 /* Rearrange so that R1 is the left-most rectangle. */
28957 left
= r1
, right
= r2
;
28959 left
= r2
, right
= r1
;
28961 /* X0 of the intersection is right.x0, if this is inside R1,
28962 otherwise there is no intersection. */
28963 if (right
->x
<= left
->x
+ left
->width
)
28965 result
->x
= right
->x
;
28967 /* The right end of the intersection is the minimum of
28968 the right ends of left and right. */
28969 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28972 /* Same game for Y. */
28974 upper
= r1
, lower
= r2
;
28976 upper
= r2
, lower
= r1
;
28978 /* The upper end of the intersection is lower.y0, if this is inside
28979 of upper. Otherwise, there is no intersection. */
28980 if (lower
->y
<= upper
->y
+ upper
->height
)
28982 result
->y
= lower
->y
;
28984 /* The lower end of the intersection is the minimum of the lower
28985 ends of upper and lower. */
28986 result
->height
= (min (lower
->y
+ lower
->height
,
28987 upper
->y
+ upper
->height
)
28989 intersection_p
= 1;
28993 return intersection_p
;
28996 #endif /* HAVE_WINDOW_SYSTEM */
28999 /***********************************************************************
29001 ***********************************************************************/
29004 syms_of_xdisp (void)
29006 Vwith_echo_area_save_vector
= Qnil
;
29007 staticpro (&Vwith_echo_area_save_vector
);
29009 Vmessage_stack
= Qnil
;
29010 staticpro (&Vmessage_stack
);
29012 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29013 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29015 message_dolog_marker1
= Fmake_marker ();
29016 staticpro (&message_dolog_marker1
);
29017 message_dolog_marker2
= Fmake_marker ();
29018 staticpro (&message_dolog_marker2
);
29019 message_dolog_marker3
= Fmake_marker ();
29020 staticpro (&message_dolog_marker3
);
29023 defsubr (&Sdump_frame_glyph_matrix
);
29024 defsubr (&Sdump_glyph_matrix
);
29025 defsubr (&Sdump_glyph_row
);
29026 defsubr (&Sdump_tool_bar_row
);
29027 defsubr (&Strace_redisplay
);
29028 defsubr (&Strace_to_stderr
);
29030 #ifdef HAVE_WINDOW_SYSTEM
29031 defsubr (&Stool_bar_lines_needed
);
29032 defsubr (&Slookup_image_map
);
29034 defsubr (&Sformat_mode_line
);
29035 defsubr (&Sinvisible_p
);
29036 defsubr (&Scurrent_bidi_paragraph_direction
);
29038 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29039 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29040 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29041 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29042 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29043 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29044 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29045 DEFSYM (Qeval
, "eval");
29046 DEFSYM (QCdata
, ":data");
29047 DEFSYM (Qdisplay
, "display");
29048 DEFSYM (Qspace_width
, "space-width");
29049 DEFSYM (Qraise
, "raise");
29050 DEFSYM (Qslice
, "slice");
29051 DEFSYM (Qspace
, "space");
29052 DEFSYM (Qmargin
, "margin");
29053 DEFSYM (Qpointer
, "pointer");
29054 DEFSYM (Qleft_margin
, "left-margin");
29055 DEFSYM (Qright_margin
, "right-margin");
29056 DEFSYM (Qcenter
, "center");
29057 DEFSYM (Qline_height
, "line-height");
29058 DEFSYM (QCalign_to
, ":align-to");
29059 DEFSYM (QCrelative_width
, ":relative-width");
29060 DEFSYM (QCrelative_height
, ":relative-height");
29061 DEFSYM (QCeval
, ":eval");
29062 DEFSYM (QCpropertize
, ":propertize");
29063 DEFSYM (QCfile
, ":file");
29064 DEFSYM (Qfontified
, "fontified");
29065 DEFSYM (Qfontification_functions
, "fontification-functions");
29066 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29067 DEFSYM (Qescape_glyph
, "escape-glyph");
29068 DEFSYM (Qnobreak_space
, "nobreak-space");
29069 DEFSYM (Qimage
, "image");
29070 DEFSYM (Qtext
, "text");
29071 DEFSYM (Qboth
, "both");
29072 DEFSYM (Qboth_horiz
, "both-horiz");
29073 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29074 DEFSYM (QCmap
, ":map");
29075 DEFSYM (QCpointer
, ":pointer");
29076 DEFSYM (Qrect
, "rect");
29077 DEFSYM (Qcircle
, "circle");
29078 DEFSYM (Qpoly
, "poly");
29079 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29080 DEFSYM (Qgrow_only
, "grow-only");
29081 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
29082 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
29083 DEFSYM (Qposition
, "position");
29084 DEFSYM (Qbuffer_position
, "buffer-position");
29085 DEFSYM (Qobject
, "object");
29086 DEFSYM (Qbar
, "bar");
29087 DEFSYM (Qhbar
, "hbar");
29088 DEFSYM (Qbox
, "box");
29089 DEFSYM (Qhollow
, "hollow");
29090 DEFSYM (Qhand
, "hand");
29091 DEFSYM (Qarrow
, "arrow");
29092 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
29094 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
29095 Fcons (intern_c_string ("void-variable"), Qnil
)),
29097 staticpro (&list_of_error
);
29099 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
29100 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
29101 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
29102 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
29104 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
29105 staticpro (&echo_buffer
[0]);
29106 staticpro (&echo_buffer
[1]);
29108 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
29109 staticpro (&echo_area_buffer
[0]);
29110 staticpro (&echo_area_buffer
[1]);
29112 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
29113 staticpro (&Vmessages_buffer_name
);
29115 mode_line_proptrans_alist
= Qnil
;
29116 staticpro (&mode_line_proptrans_alist
);
29117 mode_line_string_list
= Qnil
;
29118 staticpro (&mode_line_string_list
);
29119 mode_line_string_face
= Qnil
;
29120 staticpro (&mode_line_string_face
);
29121 mode_line_string_face_prop
= Qnil
;
29122 staticpro (&mode_line_string_face_prop
);
29123 Vmode_line_unwind_vector
= Qnil
;
29124 staticpro (&Vmode_line_unwind_vector
);
29126 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
29128 help_echo_string
= Qnil
;
29129 staticpro (&help_echo_string
);
29130 help_echo_object
= Qnil
;
29131 staticpro (&help_echo_object
);
29132 help_echo_window
= Qnil
;
29133 staticpro (&help_echo_window
);
29134 previous_help_echo_string
= Qnil
;
29135 staticpro (&previous_help_echo_string
);
29136 help_echo_pos
= -1;
29138 DEFSYM (Qright_to_left
, "right-to-left");
29139 DEFSYM (Qleft_to_right
, "left-to-right");
29141 #ifdef HAVE_WINDOW_SYSTEM
29142 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
29143 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
29144 For example, if a block cursor is over a tab, it will be drawn as
29145 wide as that tab on the display. */);
29146 x_stretch_cursor_p
= 0;
29149 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
29150 doc
: /* Non-nil means highlight trailing whitespace.
29151 The face used for trailing whitespace is `trailing-whitespace'. */);
29152 Vshow_trailing_whitespace
= Qnil
;
29154 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
29155 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
29156 If the value is t, Emacs highlights non-ASCII chars which have the
29157 same appearance as an ASCII space or hyphen, using the `nobreak-space'
29158 or `escape-glyph' face respectively.
29160 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
29161 U+2011 (non-breaking hyphen) are affected.
29163 Any other non-nil value means to display these characters as a escape
29164 glyph followed by an ordinary space or hyphen.
29166 A value of nil means no special handling of these characters. */);
29167 Vnobreak_char_display
= Qt
;
29169 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
29170 doc
: /* The pointer shape to show in void text areas.
29171 A value of nil means to show the text pointer. Other options are `arrow',
29172 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
29173 Vvoid_text_area_pointer
= Qarrow
;
29175 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
29176 doc
: /* Non-nil means don't actually do any redisplay.
29177 This is used for internal purposes. */);
29178 Vinhibit_redisplay
= Qnil
;
29180 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
29181 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
29182 Vglobal_mode_string
= Qnil
;
29184 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
29185 doc
: /* Marker for where to display an arrow on top of the buffer text.
29186 This must be the beginning of a line in order to work.
29187 See also `overlay-arrow-string'. */);
29188 Voverlay_arrow_position
= Qnil
;
29190 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
29191 doc
: /* String to display as an arrow in non-window frames.
29192 See also `overlay-arrow-position'. */);
29193 Voverlay_arrow_string
= build_pure_c_string ("=>");
29195 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
29196 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
29197 The symbols on this list are examined during redisplay to determine
29198 where to display overlay arrows. */);
29199 Voverlay_arrow_variable_list
29200 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
29202 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
29203 doc
: /* The number of lines to try scrolling a window by when point moves out.
29204 If that fails to bring point back on frame, point is centered instead.
29205 If this is zero, point is always centered after it moves off frame.
29206 If you want scrolling to always be a line at a time, you should set
29207 `scroll-conservatively' to a large value rather than set this to 1. */);
29209 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
29210 doc
: /* Scroll up to this many lines, to bring point back on screen.
29211 If point moves off-screen, redisplay will scroll by up to
29212 `scroll-conservatively' lines in order to bring point just barely
29213 onto the screen again. If that cannot be done, then redisplay
29214 recenters point as usual.
29216 If the value is greater than 100, redisplay will never recenter point,
29217 but will always scroll just enough text to bring point into view, even
29218 if you move far away.
29220 A value of zero means always recenter point if it moves off screen. */);
29221 scroll_conservatively
= 0;
29223 DEFVAR_INT ("scroll-margin", scroll_margin
,
29224 doc
: /* Number of lines of margin at the top and bottom of a window.
29225 Recenter the window whenever point gets within this many lines
29226 of the top or bottom of the window. */);
29229 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
29230 doc
: /* Pixels per inch value for non-window system displays.
29231 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
29232 Vdisplay_pixels_per_inch
= make_float (72.0);
29235 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
29238 DEFVAR_LISP ("truncate-partial-width-windows",
29239 Vtruncate_partial_width_windows
,
29240 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
29241 For an integer value, truncate lines in each window narrower than the
29242 full frame width, provided the window width is less than that integer;
29243 otherwise, respect the value of `truncate-lines'.
29245 For any other non-nil value, truncate lines in all windows that do
29246 not span the full frame width.
29248 A value of nil means to respect the value of `truncate-lines'.
29250 If `word-wrap' is enabled, you might want to reduce this. */);
29251 Vtruncate_partial_width_windows
= make_number (50);
29253 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
29254 doc
: /* Maximum buffer size for which line number should be displayed.
29255 If the buffer is bigger than this, the line number does not appear
29256 in the mode line. A value of nil means no limit. */);
29257 Vline_number_display_limit
= Qnil
;
29259 DEFVAR_INT ("line-number-display-limit-width",
29260 line_number_display_limit_width
,
29261 doc
: /* Maximum line width (in characters) for line number display.
29262 If the average length of the lines near point is bigger than this, then the
29263 line number may be omitted from the mode line. */);
29264 line_number_display_limit_width
= 200;
29266 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
29267 doc
: /* Non-nil means highlight region even in nonselected windows. */);
29268 highlight_nonselected_windows
= 0;
29270 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
29271 doc
: /* Non-nil if more than one frame is visible on this display.
29272 Minibuffer-only frames don't count, but iconified frames do.
29273 This variable is not guaranteed to be accurate except while processing
29274 `frame-title-format' and `icon-title-format'. */);
29276 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
29277 doc
: /* Template for displaying the title bar of visible frames.
29278 \(Assuming the window manager supports this feature.)
29280 This variable has the same structure as `mode-line-format', except that
29281 the %c and %l constructs are ignored. It is used only on frames for
29282 which no explicit name has been set \(see `modify-frame-parameters'). */);
29284 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
29285 doc
: /* Template for displaying the title bar of an iconified frame.
29286 \(Assuming the window manager supports this feature.)
29287 This variable has the same structure as `mode-line-format' (which see),
29288 and is used only on frames for which no explicit name has been set
29289 \(see `modify-frame-parameters'). */);
29291 = Vframe_title_format
29292 = listn (CONSTYPE_PURE
, 3,
29293 intern_c_string ("multiple-frames"),
29294 build_pure_c_string ("%b"),
29295 listn (CONSTYPE_PURE
, 4,
29296 empty_unibyte_string
,
29297 intern_c_string ("invocation-name"),
29298 build_pure_c_string ("@"),
29299 intern_c_string ("system-name")));
29301 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
29302 doc
: /* Maximum number of lines to keep in the message log buffer.
29303 If nil, disable message logging. If t, log messages but don't truncate
29304 the buffer when it becomes large. */);
29305 Vmessage_log_max
= make_number (1000);
29307 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
29308 doc
: /* Functions called before redisplay, if window sizes have changed.
29309 The value should be a list of functions that take one argument.
29310 Just before redisplay, for each frame, if any of its windows have changed
29311 size since the last redisplay, or have been split or deleted,
29312 all the functions in the list are called, with the frame as argument. */);
29313 Vwindow_size_change_functions
= Qnil
;
29315 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29316 doc
: /* List of functions to call before redisplaying a window with scrolling.
29317 Each function is called with two arguments, the window and its new
29318 display-start position. Note that these functions are also called by
29319 `set-window-buffer'. Also note that the value of `window-end' is not
29320 valid when these functions are called.
29322 Warning: Do not use this feature to alter the way the window
29323 is scrolled. It is not designed for that, and such use probably won't
29325 Vwindow_scroll_functions
= Qnil
;
29327 DEFVAR_LISP ("window-text-change-functions",
29328 Vwindow_text_change_functions
,
29329 doc
: /* Functions to call in redisplay when text in the window might change. */);
29330 Vwindow_text_change_functions
= Qnil
;
29332 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29333 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29334 Each function is called with two arguments, the window and the end trigger value.
29335 See `set-window-redisplay-end-trigger'. */);
29336 Vredisplay_end_trigger_functions
= Qnil
;
29338 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29339 doc
: /* Non-nil means autoselect window with mouse pointer.
29340 If nil, do not autoselect windows.
29341 A positive number means delay autoselection by that many seconds: a
29342 window is autoselected only after the mouse has remained in that
29343 window for the duration of the delay.
29344 A negative number has a similar effect, but causes windows to be
29345 autoselected only after the mouse has stopped moving. \(Because of
29346 the way Emacs compares mouse events, you will occasionally wait twice
29347 that time before the window gets selected.\)
29348 Any other value means to autoselect window instantaneously when the
29349 mouse pointer enters it.
29351 Autoselection selects the minibuffer only if it is active, and never
29352 unselects the minibuffer if it is active.
29354 When customizing this variable make sure that the actual value of
29355 `focus-follows-mouse' matches the behavior of your window manager. */);
29356 Vmouse_autoselect_window
= Qnil
;
29358 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29359 doc
: /* Non-nil means automatically resize tool-bars.
29360 This dynamically changes the tool-bar's height to the minimum height
29361 that is needed to make all tool-bar items visible.
29362 If value is `grow-only', the tool-bar's height is only increased
29363 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29364 Vauto_resize_tool_bars
= Qt
;
29366 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29367 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29368 auto_raise_tool_bar_buttons_p
= 1;
29370 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29371 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29372 make_cursor_line_fully_visible_p
= 1;
29374 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29375 doc
: /* Border below tool-bar in pixels.
29376 If an integer, use it as the height of the border.
29377 If it is one of `internal-border-width' or `border-width', use the
29378 value of the corresponding frame parameter.
29379 Otherwise, no border is added below the tool-bar. */);
29380 Vtool_bar_border
= Qinternal_border_width
;
29382 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29383 doc
: /* Margin around tool-bar buttons in pixels.
29384 If an integer, use that for both horizontal and vertical margins.
29385 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29386 HORZ specifying the horizontal margin, and VERT specifying the
29387 vertical margin. */);
29388 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29390 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29391 doc
: /* Relief thickness of tool-bar buttons. */);
29392 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29394 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29395 doc
: /* Tool bar style to use.
29397 image - show images only
29398 text - show text only
29399 both - show both, text below image
29400 both-horiz - show text to the right of the image
29401 text-image-horiz - show text to the left of the image
29402 any other - use system default or image if no system default.
29404 This variable only affects the GTK+ toolkit version of Emacs. */);
29405 Vtool_bar_style
= Qnil
;
29407 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29408 doc
: /* Maximum number of characters a label can have to be shown.
29409 The tool bar style must also show labels for this to have any effect, see
29410 `tool-bar-style'. */);
29411 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29413 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29414 doc
: /* List of functions to call to fontify regions of text.
29415 Each function is called with one argument POS. Functions must
29416 fontify a region starting at POS in the current buffer, and give
29417 fontified regions the property `fontified'. */);
29418 Vfontification_functions
= Qnil
;
29419 Fmake_variable_buffer_local (Qfontification_functions
);
29421 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29422 unibyte_display_via_language_environment
,
29423 doc
: /* Non-nil means display unibyte text according to language environment.
29424 Specifically, this means that raw bytes in the range 160-255 decimal
29425 are displayed by converting them to the equivalent multibyte characters
29426 according to the current language environment. As a result, they are
29427 displayed according to the current fontset.
29429 Note that this variable affects only how these bytes are displayed,
29430 but does not change the fact they are interpreted as raw bytes. */);
29431 unibyte_display_via_language_environment
= 0;
29433 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29434 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29435 If a float, it specifies a fraction of the mini-window frame's height.
29436 If an integer, it specifies a number of lines. */);
29437 Vmax_mini_window_height
= make_float (0.25);
29439 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29440 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29441 A value of nil means don't automatically resize mini-windows.
29442 A value of t means resize them to fit the text displayed in them.
29443 A value of `grow-only', the default, means let mini-windows grow only;
29444 they return to their normal size when the minibuffer is closed, or the
29445 echo area becomes empty. */);
29446 Vresize_mini_windows
= Qgrow_only
;
29448 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29449 doc
: /* Alist specifying how to blink the cursor off.
29450 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29451 `cursor-type' frame-parameter or variable equals ON-STATE,
29452 comparing using `equal', Emacs uses OFF-STATE to specify
29453 how to blink it off. ON-STATE and OFF-STATE are values for
29454 the `cursor-type' frame parameter.
29456 If a frame's ON-STATE has no entry in this list,
29457 the frame's other specifications determine how to blink the cursor off. */);
29458 Vblink_cursor_alist
= Qnil
;
29460 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29461 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29462 If non-nil, windows are automatically scrolled horizontally to make
29463 point visible. */);
29464 automatic_hscrolling_p
= 1;
29465 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29467 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29468 doc
: /* How many columns away from the window edge point is allowed to get
29469 before automatic hscrolling will horizontally scroll the window. */);
29470 hscroll_margin
= 5;
29472 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29473 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29474 When point is less than `hscroll-margin' columns from the window
29475 edge, automatic hscrolling will scroll the window by the amount of columns
29476 determined by this variable. If its value is a positive integer, scroll that
29477 many columns. If it's a positive floating-point number, it specifies the
29478 fraction of the window's width to scroll. If it's nil or zero, point will be
29479 centered horizontally after the scroll. Any other value, including negative
29480 numbers, are treated as if the value were zero.
29482 Automatic hscrolling always moves point outside the scroll margin, so if
29483 point was more than scroll step columns inside the margin, the window will
29484 scroll more than the value given by the scroll step.
29486 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29487 and `scroll-right' overrides this variable's effect. */);
29488 Vhscroll_step
= make_number (0);
29490 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29491 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29492 Bind this around calls to `message' to let it take effect. */);
29493 message_truncate_lines
= 0;
29495 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29496 doc
: /* Normal hook run to update the menu bar definitions.
29497 Redisplay runs this hook before it redisplays the menu bar.
29498 This is used to update submenus such as Buffers,
29499 whose contents depend on various data. */);
29500 Vmenu_bar_update_hook
= Qnil
;
29502 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29503 doc
: /* Frame for which we are updating a menu.
29504 The enable predicate for a menu binding should check this variable. */);
29505 Vmenu_updating_frame
= Qnil
;
29507 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29508 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29509 inhibit_menubar_update
= 0;
29511 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29512 doc
: /* Prefix prepended to all continuation lines at display time.
29513 The value may be a string, an image, or a stretch-glyph; it is
29514 interpreted in the same way as the value of a `display' text property.
29516 This variable is overridden by any `wrap-prefix' text or overlay
29519 To add a prefix to non-continuation lines, use `line-prefix'. */);
29520 Vwrap_prefix
= Qnil
;
29521 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29522 Fmake_variable_buffer_local (Qwrap_prefix
);
29524 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29525 doc
: /* Prefix prepended to all non-continuation lines at display time.
29526 The value may be a string, an image, or a stretch-glyph; it is
29527 interpreted in the same way as the value of a `display' text property.
29529 This variable is overridden by any `line-prefix' text or overlay
29532 To add a prefix to continuation lines, use `wrap-prefix'. */);
29533 Vline_prefix
= Qnil
;
29534 DEFSYM (Qline_prefix
, "line-prefix");
29535 Fmake_variable_buffer_local (Qline_prefix
);
29537 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29538 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29539 inhibit_eval_during_redisplay
= 0;
29541 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29542 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29543 inhibit_free_realized_faces
= 0;
29546 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29547 doc
: /* Inhibit try_window_id display optimization. */);
29548 inhibit_try_window_id
= 0;
29550 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29551 doc
: /* Inhibit try_window_reusing display optimization. */);
29552 inhibit_try_window_reusing
= 0;
29554 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29555 doc
: /* Inhibit try_cursor_movement display optimization. */);
29556 inhibit_try_cursor_movement
= 0;
29557 #endif /* GLYPH_DEBUG */
29559 DEFVAR_INT ("overline-margin", overline_margin
,
29560 doc
: /* Space between overline and text, in pixels.
29561 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29562 margin to the character height. */);
29563 overline_margin
= 2;
29565 DEFVAR_INT ("underline-minimum-offset",
29566 underline_minimum_offset
,
29567 doc
: /* Minimum distance between baseline and underline.
29568 This can improve legibility of underlined text at small font sizes,
29569 particularly when using variable `x-use-underline-position-properties'
29570 with fonts that specify an UNDERLINE_POSITION relatively close to the
29571 baseline. The default value is 1. */);
29572 underline_minimum_offset
= 1;
29574 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29575 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29576 This feature only works when on a window system that can change
29577 cursor shapes. */);
29578 display_hourglass_p
= 1;
29580 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29581 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29582 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29584 hourglass_atimer
= NULL
;
29585 hourglass_shown_p
= 0;
29587 DEFSYM (Qglyphless_char
, "glyphless-char");
29588 DEFSYM (Qhex_code
, "hex-code");
29589 DEFSYM (Qempty_box
, "empty-box");
29590 DEFSYM (Qthin_space
, "thin-space");
29591 DEFSYM (Qzero_width
, "zero-width");
29593 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29594 /* Intern this now in case it isn't already done.
29595 Setting this variable twice is harmless.
29596 But don't staticpro it here--that is done in alloc.c. */
29597 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29598 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29600 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29601 doc
: /* Char-table defining glyphless characters.
29602 Each element, if non-nil, should be one of the following:
29603 an ASCII acronym string: display this string in a box
29604 `hex-code': display the hexadecimal code of a character in a box
29605 `empty-box': display as an empty box
29606 `thin-space': display as 1-pixel width space
29607 `zero-width': don't display
29608 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29609 display method for graphical terminals and text terminals respectively.
29610 GRAPHICAL and TEXT should each have one of the values listed above.
29612 The char-table has one extra slot to control the display of a character for
29613 which no font is found. This slot only takes effect on graphical terminals.
29614 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29615 `thin-space'. The default is `empty-box'. */);
29616 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29617 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29620 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29621 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29622 Vdebug_on_message
= Qnil
;
29626 /* Initialize this module when Emacs starts. */
29631 current_header_line_height
= current_mode_line_height
= -1;
29633 CHARPOS (this_line_start_pos
) = 0;
29635 if (!noninteractive
)
29637 struct window
*m
= XWINDOW (minibuf_window
);
29638 Lisp_Object frame
= m
->frame
;
29639 struct frame
*f
= XFRAME (frame
);
29640 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29641 struct window
*r
= XWINDOW (root
);
29644 echo_area_window
= minibuf_window
;
29646 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29648 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29649 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29650 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29651 wset_total_lines (m
, make_number (1));
29652 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29654 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29655 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29656 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29658 /* The default ellipsis glyphs `...'. */
29659 for (i
= 0; i
< 3; ++i
)
29660 default_invis_vector
[i
] = make_number ('.');
29664 /* Allocate the buffer for frame titles.
29665 Also used for `format-mode-line'. */
29667 mode_line_noprop_buf
= xmalloc (size
);
29668 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29669 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29670 mode_line_target
= MODE_LINE_DISPLAY
;
29673 help_echo_showing_p
= 0;
29676 /* Platform-independent portion of hourglass implementation. */
29678 /* Cancel a currently active hourglass timer, and start a new one. */
29680 start_hourglass (void)
29682 #if defined (HAVE_WINDOW_SYSTEM)
29685 cancel_hourglass ();
29687 if (INTEGERP (Vhourglass_delay
)
29688 && XINT (Vhourglass_delay
) > 0)
29689 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29690 TYPE_MAXIMUM (time_t)),
29692 else if (FLOATP (Vhourglass_delay
)
29693 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29694 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29696 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29700 extern void w32_note_current_window (void);
29701 w32_note_current_window ();
29703 #endif /* HAVE_NTGUI */
29705 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29706 show_hourglass
, NULL
);
29711 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29714 cancel_hourglass (void)
29716 #if defined (HAVE_WINDOW_SYSTEM)
29717 if (hourglass_atimer
)
29719 cancel_atimer (hourglass_atimer
);
29720 hourglass_atimer
= NULL
;
29723 if (hourglass_shown_p
)