1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
284 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT, or the underlying buffer
387 or string character, is a space or a TAB character. This is used
388 to determine where word wrapping can occur. */
390 #define IT_DISPLAYING_WHITESPACE(it) \
391 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
392 || ((STRINGP (it->string) \
393 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
394 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
396 && (it->s[IT_BYTEPOS (*it)] == ' ' \
397 || it->s[IT_BYTEPOS (*it)] == '\t')) \
398 || (IT_BYTEPOS (*it) < ZV_BYTE \
399 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
400 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
402 /* Name of the face used to highlight trailing whitespace. */
404 static Lisp_Object Qtrailing_whitespace
;
406 /* Name and number of the face used to highlight escape glyphs. */
408 static Lisp_Object Qescape_glyph
;
410 /* Name and number of the face used to highlight non-breaking spaces. */
412 static Lisp_Object Qnobreak_space
;
414 /* The symbol `image' which is the car of the lists used to represent
415 images in Lisp. Also a tool bar style. */
419 /* The image map types. */
421 static Lisp_Object QCpointer
;
422 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
424 /* Tool bar styles */
425 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
427 /* Non-zero means print newline to stdout before next mini-buffer
430 int noninteractive_need_newline
;
432 /* Non-zero means print newline to message log before next message. */
434 static int message_log_need_newline
;
436 /* Three markers that message_dolog uses.
437 It could allocate them itself, but that causes trouble
438 in handling memory-full errors. */
439 static Lisp_Object message_dolog_marker1
;
440 static Lisp_Object message_dolog_marker2
;
441 static Lisp_Object message_dolog_marker3
;
443 /* The buffer position of the first character appearing entirely or
444 partially on the line of the selected window which contains the
445 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
446 redisplay optimization in redisplay_internal. */
448 static struct text_pos this_line_start_pos
;
450 /* Number of characters past the end of the line above, including the
451 terminating newline. */
453 static struct text_pos this_line_end_pos
;
455 /* The vertical positions and the height of this line. */
457 static int this_line_vpos
;
458 static int this_line_y
;
459 static int this_line_pixel_height
;
461 /* X position at which this display line starts. Usually zero;
462 negative if first character is partially visible. */
464 static int this_line_start_x
;
466 /* The smallest character position seen by move_it_* functions as they
467 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
468 hscrolled lines, see display_line. */
470 static struct text_pos this_line_min_pos
;
472 /* Buffer that this_line_.* variables are referring to. */
474 static struct buffer
*this_line_buffer
;
477 /* Values of those variables at last redisplay are stored as
478 properties on `overlay-arrow-position' symbol. However, if
479 Voverlay_arrow_position is a marker, last-arrow-position is its
480 numerical position. */
482 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
484 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
485 properties on a symbol in overlay-arrow-variable-list. */
487 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
489 Lisp_Object Qmenu_bar_update_hook
;
491 /* Nonzero if an overlay arrow has been displayed in this window. */
493 static int overlay_arrow_seen
;
495 /* Number of windows showing the buffer of the selected window (or
496 another buffer with the same base buffer). keyboard.c refers to
501 /* Vector containing glyphs for an ellipsis `...'. */
503 static Lisp_Object default_invis_vector
[3];
505 /* This is the window where the echo area message was displayed. It
506 is always a mini-buffer window, but it may not be the same window
507 currently active as a mini-buffer. */
509 Lisp_Object echo_area_window
;
511 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
512 pushes the current message and the value of
513 message_enable_multibyte on the stack, the function restore_message
514 pops the stack and displays MESSAGE again. */
516 static Lisp_Object Vmessage_stack
;
518 /* Nonzero means multibyte characters were enabled when the echo area
519 message was specified. */
521 static int message_enable_multibyte
;
523 /* Nonzero if we should redraw the mode lines on the next redisplay. */
525 int update_mode_lines
;
527 /* Nonzero if window sizes or contents have changed since last
528 redisplay that finished. */
530 int windows_or_buffers_changed
;
532 /* Nonzero means a frame's cursor type has been changed. */
534 int cursor_type_changed
;
536 /* Nonzero after display_mode_line if %l was used and it displayed a
539 static int line_number_displayed
;
541 /* The name of the *Messages* buffer, a string. */
543 static Lisp_Object Vmessages_buffer_name
;
545 /* Current, index 0, and last displayed echo area message. Either
546 buffers from echo_buffers, or nil to indicate no message. */
548 Lisp_Object echo_area_buffer
[2];
550 /* The buffers referenced from echo_area_buffer. */
552 static Lisp_Object echo_buffer
[2];
554 /* A vector saved used in with_area_buffer to reduce consing. */
556 static Lisp_Object Vwith_echo_area_save_vector
;
558 /* Non-zero means display_echo_area should display the last echo area
559 message again. Set by redisplay_preserve_echo_area. */
561 static int display_last_displayed_message_p
;
563 /* Nonzero if echo area is being used by print; zero if being used by
566 static int message_buf_print
;
568 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
570 static Lisp_Object Qinhibit_menubar_update
;
571 static Lisp_Object Qmessage_truncate_lines
;
573 /* Set to 1 in clear_message to make redisplay_internal aware
574 of an emptied echo area. */
576 static int message_cleared_p
;
578 /* A scratch glyph row with contents used for generating truncation
579 glyphs. Also used in direct_output_for_insert. */
581 #define MAX_SCRATCH_GLYPHS 100
582 static struct glyph_row scratch_glyph_row
;
583 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
585 /* Ascent and height of the last line processed by move_it_to. */
587 static int last_max_ascent
, last_height
;
589 /* Non-zero if there's a help-echo in the echo area. */
591 int help_echo_showing_p
;
593 /* If >= 0, computed, exact values of mode-line and header-line height
594 to use in the macros CURRENT_MODE_LINE_HEIGHT and
595 CURRENT_HEADER_LINE_HEIGHT. */
597 int current_mode_line_height
, current_header_line_height
;
599 /* The maximum distance to look ahead for text properties. Values
600 that are too small let us call compute_char_face and similar
601 functions too often which is expensive. Values that are too large
602 let us call compute_char_face and alike too often because we
603 might not be interested in text properties that far away. */
605 #define TEXT_PROP_DISTANCE_LIMIT 100
607 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
608 iterator state and later restore it. This is needed because the
609 bidi iterator on bidi.c keeps a stacked cache of its states, which
610 is really a singleton. When we use scratch iterator objects to
611 move around the buffer, we can cause the bidi cache to be pushed or
612 popped, and therefore we need to restore the cache state when we
613 return to the original iterator. */
614 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
617 bidi_unshelve_cache (CACHE, 1); \
619 CACHE = bidi_shelve_cache (); \
622 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
624 if (pITORIG != pITCOPY) \
625 *(pITORIG) = *(pITCOPY); \
626 bidi_unshelve_cache (CACHE, 0); \
632 /* Non-zero means print traces of redisplay if compiled with
633 GLYPH_DEBUG defined. */
635 int trace_redisplay_p
;
637 #endif /* GLYPH_DEBUG */
639 #ifdef DEBUG_TRACE_MOVE
640 /* Non-zero means trace with TRACE_MOVE to stderr. */
643 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
645 #define TRACE_MOVE(x) (void) 0
648 static Lisp_Object Qauto_hscroll_mode
;
650 /* Buffer being redisplayed -- for redisplay_window_error. */
652 static struct buffer
*displayed_buffer
;
654 /* Value returned from text property handlers (see below). */
659 HANDLED_RECOMPUTE_PROPS
,
660 HANDLED_OVERLAY_STRING_CONSUMED
,
664 /* A description of text properties that redisplay is interested
669 /* The name of the property. */
672 /* A unique index for the property. */
675 /* A handler function called to set up iterator IT from the property
676 at IT's current position. Value is used to steer handle_stop. */
677 enum prop_handled (*handler
) (struct it
*it
);
680 static enum prop_handled
handle_face_prop (struct it
*);
681 static enum prop_handled
handle_invisible_prop (struct it
*);
682 static enum prop_handled
handle_display_prop (struct it
*);
683 static enum prop_handled
handle_composition_prop (struct it
*);
684 static enum prop_handled
handle_overlay_change (struct it
*);
685 static enum prop_handled
handle_fontified_prop (struct it
*);
687 /* Properties handled by iterators. */
689 static struct props it_props
[] =
691 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
692 /* Handle `face' before `display' because some sub-properties of
693 `display' need to know the face. */
694 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
695 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
696 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
697 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
701 /* Value is the position described by X. If X is a marker, value is
702 the marker_position of X. Otherwise, value is X. */
704 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
706 /* Enumeration returned by some move_it_.* functions internally. */
710 /* Not used. Undefined value. */
713 /* Move ended at the requested buffer position or ZV. */
714 MOVE_POS_MATCH_OR_ZV
,
716 /* Move ended at the requested X pixel position. */
719 /* Move within a line ended at the end of a line that must be
723 /* Move within a line ended at the end of a line that would
724 be displayed truncated. */
727 /* Move within a line ended at a line end. */
731 /* This counter is used to clear the face cache every once in a while
732 in redisplay_internal. It is incremented for each redisplay.
733 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
736 #define CLEAR_FACE_CACHE_COUNT 500
737 static int clear_face_cache_count
;
739 /* Similarly for the image cache. */
741 #ifdef HAVE_WINDOW_SYSTEM
742 #define CLEAR_IMAGE_CACHE_COUNT 101
743 static int clear_image_cache_count
;
745 /* Null glyph slice */
746 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
749 /* Non-zero while redisplay_internal is in progress. */
753 static Lisp_Object Qinhibit_free_realized_faces
;
754 static Lisp_Object Qmode_line_default_help_echo
;
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 /* Non-zero means an hourglass cursor is currently shown. */
771 int hourglass_shown_p
;
773 /* If non-null, an asynchronous timer that, when it expires, displays
774 an hourglass cursor on all frames. */
775 struct atimer
*hourglass_atimer
;
777 /* Name of the face used to display glyphless characters. */
778 Lisp_Object Qglyphless_char
;
780 /* Symbol for the purpose of Vglyphless_char_display. */
781 static Lisp_Object Qglyphless_char_display
;
783 /* Method symbols for Vglyphless_char_display. */
784 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
786 /* Default pixel width of `thin-space' display method. */
787 #define THIN_SPACE_WIDTH 1
789 /* Default number of seconds to wait before displaying an hourglass
791 #define DEFAULT_HOURGLASS_DELAY 1
794 /* Function prototypes. */
796 static void setup_for_ellipsis (struct it
*, int);
797 static void set_iterator_to_next (struct it
*, int);
798 static void mark_window_display_accurate_1 (struct window
*, int);
799 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
800 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
801 static int cursor_row_p (struct glyph_row
*);
802 static int redisplay_mode_lines (Lisp_Object
, int);
803 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
805 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
807 static void handle_line_prefix (struct it
*);
809 static void pint2str (char *, int, ptrdiff_t);
810 static void pint2hrstr (char *, int, ptrdiff_t);
811 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
813 static void reconsider_clip_changes (struct window
*, struct buffer
*);
814 static int text_outside_line_unchanged_p (struct window
*,
815 ptrdiff_t, ptrdiff_t);
816 static void store_mode_line_noprop_char (char);
817 static int store_mode_line_noprop (const char *, int, int);
818 static void handle_stop (struct it
*);
819 static void handle_stop_backwards (struct it
*, ptrdiff_t);
820 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
821 static void ensure_echo_area_buffers (void);
822 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
823 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
824 static int with_echo_area_buffer (struct window
*, int,
825 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
826 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
827 static void clear_garbaged_frames (void);
828 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
829 static void pop_message (void);
830 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
831 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
832 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
833 static int display_echo_area (struct window
*);
834 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
835 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
836 static Lisp_Object
unwind_redisplay (Lisp_Object
);
837 static int string_char_and_length (const unsigned char *, int *);
838 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
840 static int compute_window_start_on_continuation_line (struct window
*);
841 static Lisp_Object
safe_eval_handler (Lisp_Object
);
842 static void insert_left_trunc_glyphs (struct it
*);
843 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
845 static void extend_face_to_end_of_line (struct it
*);
846 static int append_space_for_newline (struct it
*, int);
847 static int cursor_row_fully_visible_p (struct window
*, int, int);
848 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
849 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
850 static int trailing_whitespace_p (ptrdiff_t);
851 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
852 static void push_it (struct it
*, struct text_pos
*);
853 static void iterate_out_of_display_property (struct it
*);
854 static void pop_it (struct it
*);
855 static void sync_frame_with_window_matrix_rows (struct window
*);
856 static void select_frame_for_redisplay (Lisp_Object
);
857 static void redisplay_internal (void);
858 static int echo_area_display (int);
859 static void redisplay_windows (Lisp_Object
);
860 static void redisplay_window (Lisp_Object
, int);
861 static Lisp_Object
redisplay_window_error (Lisp_Object
);
862 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
863 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
864 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
865 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
867 static int update_menu_bar (struct frame
*, int, int);
868 static int try_window_reusing_current_matrix (struct window
*);
869 static int try_window_id (struct window
*);
870 static int display_line (struct it
*);
871 static int display_mode_lines (struct window
*);
872 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
873 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
874 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
875 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
876 static void display_menu_bar (struct window
*);
877 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
879 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
880 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
881 static void compute_line_metrics (struct it
*);
882 static void run_redisplay_end_trigger_hook (struct it
*);
883 static int get_overlay_strings (struct it
*, ptrdiff_t);
884 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
885 static void next_overlay_string (struct it
*);
886 static void reseat (struct it
*, struct text_pos
, int);
887 static void reseat_1 (struct it
*, struct text_pos
, int);
888 static void back_to_previous_visible_line_start (struct it
*);
889 void reseat_at_previous_visible_line_start (struct it
*);
890 static void reseat_at_next_visible_line_start (struct it
*, int);
891 static int next_element_from_ellipsis (struct it
*);
892 static int next_element_from_display_vector (struct it
*);
893 static int next_element_from_string (struct it
*);
894 static int next_element_from_c_string (struct it
*);
895 static int next_element_from_buffer (struct it
*);
896 static int next_element_from_composition (struct it
*);
897 static int next_element_from_image (struct it
*);
898 static int next_element_from_stretch (struct it
*);
899 static void load_overlay_strings (struct it
*, ptrdiff_t);
900 static int init_from_display_pos (struct it
*, struct window
*,
901 struct display_pos
*);
902 static void reseat_to_string (struct it
*, const char *,
903 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
904 static int get_next_display_element (struct it
*);
905 static enum move_it_result
906 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
907 enum move_operation_enum
);
908 void move_it_vertically_backward (struct it
*, int);
909 static void init_to_row_start (struct it
*, struct window
*,
911 static int init_to_row_end (struct it
*, struct window
*,
913 static void back_to_previous_line_start (struct it
*);
914 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
915 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
916 Lisp_Object
, ptrdiff_t);
917 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
918 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
919 static ptrdiff_t number_of_chars (const char *, int);
920 static void compute_stop_pos (struct it
*);
921 static void compute_string_pos (struct text_pos
*, struct text_pos
,
923 static int face_before_or_after_it_pos (struct it
*, int);
924 static ptrdiff_t next_overlay_change (ptrdiff_t);
925 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
926 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
927 static int handle_single_display_spec (struct it
*, Lisp_Object
,
928 Lisp_Object
, Lisp_Object
,
929 struct text_pos
*, ptrdiff_t, int, int);
930 static int underlying_face_id (struct it
*);
931 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
934 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
935 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
937 #ifdef HAVE_WINDOW_SYSTEM
939 static void x_consider_frame_title (Lisp_Object
);
940 static int tool_bar_lines_needed (struct frame
*, int *);
941 static void update_tool_bar (struct frame
*, int);
942 static void build_desired_tool_bar_string (struct frame
*f
);
943 static int redisplay_tool_bar (struct frame
*);
944 static void display_tool_bar_line (struct it
*, int);
945 static void notice_overwritten_cursor (struct window
*,
948 static void append_stretch_glyph (struct it
*, Lisp_Object
,
952 #endif /* HAVE_WINDOW_SYSTEM */
954 static void produce_special_glyphs (struct it
*, enum display_element_type
);
955 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
956 static int coords_in_mouse_face_p (struct window
*, int, int);
960 /***********************************************************************
961 Window display dimensions
962 ***********************************************************************/
964 /* Return the bottom boundary y-position for text lines in window W.
965 This is the first y position at which a line cannot start.
966 It is relative to the top of the window.
968 This is the height of W minus the height of a mode line, if any. */
971 window_text_bottom_y (struct window
*w
)
973 int height
= WINDOW_TOTAL_HEIGHT (w
);
975 if (WINDOW_WANTS_MODELINE_P (w
))
976 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
980 /* Return the pixel width of display area AREA of window W. AREA < 0
981 means return the total width of W, not including fringes to
982 the left and right of the window. */
985 window_box_width (struct window
*w
, int area
)
987 int cols
= XFASTINT (w
->total_cols
);
990 if (!w
->pseudo_window_p
)
992 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
994 if (area
== TEXT_AREA
)
996 if (INTEGERP (w
->left_margin_cols
))
997 cols
-= XFASTINT (w
->left_margin_cols
);
998 if (INTEGERP (w
->right_margin_cols
))
999 cols
-= XFASTINT (w
->right_margin_cols
);
1000 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1002 else if (area
== LEFT_MARGIN_AREA
)
1004 cols
= (INTEGERP (w
->left_margin_cols
)
1005 ? XFASTINT (w
->left_margin_cols
) : 0);
1008 else if (area
== RIGHT_MARGIN_AREA
)
1010 cols
= (INTEGERP (w
->right_margin_cols
)
1011 ? XFASTINT (w
->right_margin_cols
) : 0);
1016 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1020 /* Return the pixel height of the display area of window W, not
1021 including mode lines of W, if any. */
1024 window_box_height (struct window
*w
)
1026 struct frame
*f
= XFRAME (w
->frame
);
1027 int height
= WINDOW_TOTAL_HEIGHT (w
);
1029 eassert (height
>= 0);
1031 /* Note: the code below that determines the mode-line/header-line
1032 height is essentially the same as that contained in the macro
1033 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1034 the appropriate glyph row has its `mode_line_p' flag set,
1035 and if it doesn't, uses estimate_mode_line_height instead. */
1037 if (WINDOW_WANTS_MODELINE_P (w
))
1039 struct glyph_row
*ml_row
1040 = (w
->current_matrix
&& w
->current_matrix
->rows
1041 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1043 if (ml_row
&& ml_row
->mode_line_p
)
1044 height
-= ml_row
->height
;
1046 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1049 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1051 struct glyph_row
*hl_row
1052 = (w
->current_matrix
&& w
->current_matrix
->rows
1053 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1055 if (hl_row
&& hl_row
->mode_line_p
)
1056 height
-= hl_row
->height
;
1058 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1061 /* With a very small font and a mode-line that's taller than
1062 default, we might end up with a negative height. */
1063 return max (0, height
);
1066 /* Return the window-relative coordinate of the left edge of display
1067 area AREA of window W. AREA < 0 means return the left edge of the
1068 whole window, to the right of the left fringe of W. */
1071 window_box_left_offset (struct window
*w
, int area
)
1075 if (w
->pseudo_window_p
)
1078 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1080 if (area
== TEXT_AREA
)
1081 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1082 + window_box_width (w
, LEFT_MARGIN_AREA
));
1083 else if (area
== RIGHT_MARGIN_AREA
)
1084 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1085 + window_box_width (w
, LEFT_MARGIN_AREA
)
1086 + window_box_width (w
, TEXT_AREA
)
1087 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1089 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1090 else if (area
== LEFT_MARGIN_AREA
1091 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1092 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1098 /* Return the window-relative coordinate of the right edge of display
1099 area AREA of window W. AREA < 0 means return the right edge of the
1100 whole window, to the left of the right fringe of W. */
1103 window_box_right_offset (struct window
*w
, int area
)
1105 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1108 /* Return the frame-relative coordinate of the left edge of display
1109 area AREA of window W. AREA < 0 means return the left edge of the
1110 whole window, to the right of the left fringe of W. */
1113 window_box_left (struct window
*w
, int area
)
1115 struct frame
*f
= XFRAME (w
->frame
);
1118 if (w
->pseudo_window_p
)
1119 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1121 x
= (WINDOW_LEFT_EDGE_X (w
)
1122 + window_box_left_offset (w
, area
));
1128 /* Return the frame-relative coordinate of the right edge of display
1129 area AREA of window W. AREA < 0 means return the right edge of the
1130 whole window, to the left of the right fringe of W. */
1133 window_box_right (struct window
*w
, int area
)
1135 return window_box_left (w
, area
) + window_box_width (w
, area
);
1138 /* Get the bounding box of the display area AREA of window W, without
1139 mode lines, in frame-relative coordinates. AREA < 0 means the
1140 whole window, not including the left and right fringes of
1141 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1142 coordinates of the upper-left corner of the box. Return in
1143 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1146 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1147 int *box_width
, int *box_height
)
1150 *box_width
= window_box_width (w
, area
);
1152 *box_height
= window_box_height (w
);
1154 *box_x
= window_box_left (w
, area
);
1157 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1158 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1159 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1164 /* Get the bounding box of the display area AREA of window W, without
1165 mode lines. AREA < 0 means the whole window, not including the
1166 left and right fringe of the window. Return in *TOP_LEFT_X
1167 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1168 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1169 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1173 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1174 int *bottom_right_x
, int *bottom_right_y
)
1176 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1178 *bottom_right_x
+= *top_left_x
;
1179 *bottom_right_y
+= *top_left_y
;
1184 /***********************************************************************
1186 ***********************************************************************/
1188 /* Return the bottom y-position of the line the iterator IT is in.
1189 This can modify IT's settings. */
1192 line_bottom_y (struct it
*it
)
1194 int line_height
= it
->max_ascent
+ it
->max_descent
;
1195 int line_top_y
= it
->current_y
;
1197 if (line_height
== 0)
1200 line_height
= last_height
;
1201 else if (IT_CHARPOS (*it
) < ZV
)
1203 move_it_by_lines (it
, 1);
1204 line_height
= (it
->max_ascent
|| it
->max_descent
1205 ? it
->max_ascent
+ it
->max_descent
1210 struct glyph_row
*row
= it
->glyph_row
;
1212 /* Use the default character height. */
1213 it
->glyph_row
= NULL
;
1214 it
->what
= IT_CHARACTER
;
1217 PRODUCE_GLYPHS (it
);
1218 line_height
= it
->ascent
+ it
->descent
;
1219 it
->glyph_row
= row
;
1223 return line_top_y
+ line_height
;
1226 /* Subroutine of pos_visible_p below. Extracts a display string, if
1227 any, from the display spec given as its argument. */
1229 string_from_display_spec (Lisp_Object spec
)
1233 while (CONSP (spec
))
1235 if (STRINGP (XCAR (spec
)))
1240 else if (VECTORP (spec
))
1244 for (i
= 0; i
< ASIZE (spec
); i
++)
1246 if (STRINGP (AREF (spec
, i
)))
1247 return AREF (spec
, i
);
1256 /* Limit insanely large values of W->hscroll on frame F to the largest
1257 value that will still prevent first_visible_x and last_visible_x of
1258 'struct it' from overflowing an int. */
1260 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1262 ptrdiff_t window_hscroll
= w
->hscroll
;
1263 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1264 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1266 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1267 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1269 return window_hscroll
;
1272 /* Return 1 if position CHARPOS is visible in window W.
1273 CHARPOS < 0 means return info about WINDOW_END position.
1274 If visible, set *X and *Y to pixel coordinates of top left corner.
1275 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1276 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1279 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1280 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1283 void *itdata
= bidi_shelve_cache ();
1284 struct text_pos top
;
1286 struct buffer
*old_buffer
= NULL
;
1288 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1291 if (XBUFFER (w
->buffer
) != current_buffer
)
1293 old_buffer
= current_buffer
;
1294 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1297 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1298 /* Scrolling a minibuffer window via scroll bar when the echo area
1299 shows long text sometimes resets the minibuffer contents behind
1301 if (CHARPOS (top
) > ZV
)
1302 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1304 /* Compute exact mode line heights. */
1305 if (WINDOW_WANTS_MODELINE_P (w
))
1306 current_mode_line_height
1307 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1308 BVAR (current_buffer
, mode_line_format
));
1310 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1311 current_header_line_height
1312 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1313 BVAR (current_buffer
, header_line_format
));
1315 start_display (&it
, w
, top
);
1316 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1317 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1320 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1321 && IT_CHARPOS (it
) >= charpos
)
1322 /* When scanning backwards under bidi iteration, move_it_to
1323 stops at or _before_ CHARPOS, because it stops at or to
1324 the _right_ of the character at CHARPOS. */
1325 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1326 && IT_CHARPOS (it
) <= charpos
)))
1328 /* We have reached CHARPOS, or passed it. How the call to
1329 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1330 or covered by a display property, move_it_to stops at the end
1331 of the invisible text, to the right of CHARPOS. (ii) If
1332 CHARPOS is in a display vector, move_it_to stops on its last
1334 int top_x
= it
.current_x
;
1335 int top_y
= it
.current_y
;
1336 /* Calling line_bottom_y may change it.method, it.position, etc. */
1337 enum it_method it_method
= it
.method
;
1338 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1339 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1341 if (top_y
< window_top_y
)
1342 visible_p
= bottom_y
> window_top_y
;
1343 else if (top_y
< it
.last_visible_y
)
1345 if (bottom_y
>= it
.last_visible_y
1346 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1347 && IT_CHARPOS (it
) < charpos
)
1349 /* When the last line of the window is scanned backwards
1350 under bidi iteration, we could be duped into thinking
1351 that we have passed CHARPOS, when in fact move_it_to
1352 simply stopped short of CHARPOS because it reached
1353 last_visible_y. To see if that's what happened, we call
1354 move_it_to again with a slightly larger vertical limit,
1355 and see if it actually moved vertically; if it did, we
1356 didn't really reach CHARPOS, which is beyond window end. */
1357 struct it save_it
= it
;
1358 /* Why 10? because we don't know how many canonical lines
1359 will the height of the next line(s) be. So we guess. */
1360 int ten_more_lines
=
1361 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1363 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1364 MOVE_TO_POS
| MOVE_TO_Y
);
1365 if (it
.current_y
> top_y
)
1372 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1374 /* We stopped on the last glyph of a display vector.
1375 Try and recompute. Hack alert! */
1376 if (charpos
< 2 || top
.charpos
>= charpos
)
1377 top_x
= it
.glyph_row
->x
;
1381 start_display (&it2
, w
, top
);
1382 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1383 get_next_display_element (&it2
);
1384 PRODUCE_GLYPHS (&it2
);
1385 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1386 || it2
.current_x
> it2
.last_visible_x
)
1387 top_x
= it
.glyph_row
->x
;
1390 top_x
= it2
.current_x
;
1391 top_y
= it2
.current_y
;
1395 else if (IT_CHARPOS (it
) != charpos
)
1397 Lisp_Object cpos
= make_number (charpos
);
1398 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1399 Lisp_Object string
= string_from_display_spec (spec
);
1400 int newline_in_string
= 0;
1402 if (STRINGP (string
))
1404 const char *s
= SSDATA (string
);
1405 const char *e
= s
+ SBYTES (string
);
1410 newline_in_string
= 1;
1415 /* The tricky code below is needed because there's a
1416 discrepancy between move_it_to and how we set cursor
1417 when the display line ends in a newline from a
1418 display string. move_it_to will stop _after_ such
1419 display strings, whereas set_cursor_from_row
1420 conspires with cursor_row_p to place the cursor on
1421 the first glyph produced from the display string. */
1423 /* We have overshoot PT because it is covered by a
1424 display property whose value is a string. If the
1425 string includes embedded newlines, we are also in the
1426 wrong display line. Backtrack to the correct line,
1427 where the display string begins. */
1428 if (newline_in_string
)
1430 Lisp_Object startpos
, endpos
;
1431 EMACS_INT start
, end
;
1435 /* Find the first and the last buffer positions
1436 covered by the display string. */
1438 Fnext_single_char_property_change (cpos
, Qdisplay
,
1441 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1443 start
= XFASTINT (startpos
);
1444 end
= XFASTINT (endpos
);
1445 /* Move to the last buffer position before the
1446 display property. */
1447 start_display (&it3
, w
, top
);
1448 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1449 /* Move forward one more line if the position before
1450 the display string is a newline or if it is the
1451 rightmost character on a line that is
1452 continued or word-wrapped. */
1453 if (it3
.method
== GET_FROM_BUFFER
1455 move_it_by_lines (&it3
, 1);
1456 else if (move_it_in_display_line_to (&it3
, -1,
1460 == MOVE_LINE_CONTINUED
)
1462 move_it_by_lines (&it3
, 1);
1463 /* When we are under word-wrap, the #$@%!
1464 move_it_by_lines moves 2 lines, so we need to
1466 if (it3
.line_wrap
== WORD_WRAP
)
1467 move_it_by_lines (&it3
, -1);
1470 /* Record the vertical coordinate of the display
1471 line where we wound up. */
1472 top_y
= it3
.current_y
;
1475 /* When characters are reordered for display,
1476 the character displayed to the left of the
1477 display string could be _after_ the display
1478 property in the logical order. Use the
1479 smallest vertical position of these two. */
1480 start_display (&it3
, w
, top
);
1481 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1482 if (it3
.current_y
< top_y
)
1483 top_y
= it3
.current_y
;
1485 /* Move from the top of the window to the beginning
1486 of the display line where the display string
1488 start_display (&it3
, w
, top
);
1489 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1490 /* If it3_moved stays zero after the 'while' loop
1491 below, that means we already were at a newline
1492 before the loop (e.g., the display string begins
1493 with a newline), so we don't need to (and cannot)
1494 inspect the glyphs of it3.glyph_row, because
1495 PRODUCE_GLYPHS will not produce anything for a
1496 newline, and thus it3.glyph_row stays at its
1497 stale content it got at top of the window. */
1499 /* Finally, advance the iterator until we hit the
1500 first display element whose character position is
1501 CHARPOS, or until the first newline from the
1502 display string, which signals the end of the
1504 while (get_next_display_element (&it3
))
1506 PRODUCE_GLYPHS (&it3
);
1507 if (IT_CHARPOS (it3
) == charpos
1508 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1511 set_iterator_to_next (&it3
, 0);
1513 top_x
= it3
.current_x
- it3
.pixel_width
;
1514 /* Normally, we would exit the above loop because we
1515 found the display element whose character
1516 position is CHARPOS. For the contingency that we
1517 didn't, and stopped at the first newline from the
1518 display string, move back over the glyphs
1519 produced from the string, until we find the
1520 rightmost glyph not from the string. */
1522 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1524 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1525 + it3
.glyph_row
->used
[TEXT_AREA
];
1527 while (EQ ((g
- 1)->object
, string
))
1530 top_x
-= g
->pixel_width
;
1532 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1533 + it3
.glyph_row
->used
[TEXT_AREA
]);
1539 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1540 *rtop
= max (0, window_top_y
- top_y
);
1541 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1542 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1543 - max (top_y
, window_top_y
)));
1549 /* We were asked to provide info about WINDOW_END. */
1551 void *it2data
= NULL
;
1553 SAVE_IT (it2
, it
, it2data
);
1554 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1555 move_it_by_lines (&it
, 1);
1556 if (charpos
< IT_CHARPOS (it
)
1557 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1560 RESTORE_IT (&it2
, &it2
, it2data
);
1561 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1563 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1564 *rtop
= max (0, -it2
.current_y
);
1565 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1566 - it
.last_visible_y
));
1567 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1569 - max (it2
.current_y
,
1570 WINDOW_HEADER_LINE_HEIGHT (w
))));
1574 bidi_unshelve_cache (it2data
, 1);
1576 bidi_unshelve_cache (itdata
, 0);
1579 set_buffer_internal_1 (old_buffer
);
1581 current_header_line_height
= current_mode_line_height
= -1;
1583 if (visible_p
&& w
->hscroll
> 0)
1585 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1586 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1589 /* Debugging code. */
1591 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1592 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1594 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1601 /* Return the next character from STR. Return in *LEN the length of
1602 the character. This is like STRING_CHAR_AND_LENGTH but never
1603 returns an invalid character. If we find one, we return a `?', but
1604 with the length of the invalid character. */
1607 string_char_and_length (const unsigned char *str
, int *len
)
1611 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1612 if (!CHAR_VALID_P (c
))
1613 /* We may not change the length here because other places in Emacs
1614 don't use this function, i.e. they silently accept invalid
1623 /* Given a position POS containing a valid character and byte position
1624 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1626 static struct text_pos
1627 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1629 eassert (STRINGP (string
) && nchars
>= 0);
1631 if (STRING_MULTIBYTE (string
))
1633 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1638 string_char_and_length (p
, &len
);
1641 BYTEPOS (pos
) += len
;
1645 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1651 /* Value is the text position, i.e. character and byte position,
1652 for character position CHARPOS in STRING. */
1654 static inline struct text_pos
1655 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1657 struct text_pos pos
;
1658 eassert (STRINGP (string
));
1659 eassert (charpos
>= 0);
1660 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1665 /* Value is a text position, i.e. character and byte position, for
1666 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1667 means recognize multibyte characters. */
1669 static struct text_pos
1670 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1672 struct text_pos pos
;
1674 eassert (s
!= NULL
);
1675 eassert (charpos
>= 0);
1681 SET_TEXT_POS (pos
, 0, 0);
1684 string_char_and_length ((const unsigned char *) s
, &len
);
1687 BYTEPOS (pos
) += len
;
1691 SET_TEXT_POS (pos
, charpos
, charpos
);
1697 /* Value is the number of characters in C string S. MULTIBYTE_P
1698 non-zero means recognize multibyte characters. */
1701 number_of_chars (const char *s
, int multibyte_p
)
1707 ptrdiff_t rest
= strlen (s
);
1709 const unsigned char *p
= (const unsigned char *) s
;
1711 for (nchars
= 0; rest
> 0; ++nchars
)
1713 string_char_and_length (p
, &len
);
1714 rest
-= len
, p
+= len
;
1718 nchars
= strlen (s
);
1724 /* Compute byte position NEWPOS->bytepos corresponding to
1725 NEWPOS->charpos. POS is a known position in string STRING.
1726 NEWPOS->charpos must be >= POS.charpos. */
1729 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1731 eassert (STRINGP (string
));
1732 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1734 if (STRING_MULTIBYTE (string
))
1735 *newpos
= string_pos_nchars_ahead (pos
, string
,
1736 CHARPOS (*newpos
) - CHARPOS (pos
));
1738 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1742 Return an estimation of the pixel height of mode or header lines on
1743 frame F. FACE_ID specifies what line's height to estimate. */
1746 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1748 #ifdef HAVE_WINDOW_SYSTEM
1749 if (FRAME_WINDOW_P (f
))
1751 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1753 /* This function is called so early when Emacs starts that the face
1754 cache and mode line face are not yet initialized. */
1755 if (FRAME_FACE_CACHE (f
))
1757 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1761 height
= FONT_HEIGHT (face
->font
);
1762 if (face
->box_line_width
> 0)
1763 height
+= 2 * face
->box_line_width
;
1774 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1775 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1776 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1777 not force the value into range. */
1780 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1781 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1784 #ifdef HAVE_WINDOW_SYSTEM
1785 if (FRAME_WINDOW_P (f
))
1787 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1788 even for negative values. */
1790 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1792 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1794 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1795 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1798 STORE_NATIVE_RECT (*bounds
,
1799 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1800 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1801 FRAME_COLUMN_WIDTH (f
) - 1,
1802 FRAME_LINE_HEIGHT (f
) - 1);
1808 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1809 pix_x
= FRAME_TOTAL_COLS (f
);
1813 else if (pix_y
> FRAME_LINES (f
))
1814 pix_y
= FRAME_LINES (f
);
1824 /* Find the glyph under window-relative coordinates X/Y in window W.
1825 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1826 strings. Return in *HPOS and *VPOS the row and column number of
1827 the glyph found. Return in *AREA the glyph area containing X.
1828 Value is a pointer to the glyph found or null if X/Y is not on
1829 text, or we can't tell because W's current matrix is not up to
1834 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1835 int *dx
, int *dy
, int *area
)
1837 struct glyph
*glyph
, *end
;
1838 struct glyph_row
*row
= NULL
;
1841 /* Find row containing Y. Give up if some row is not enabled. */
1842 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1844 row
= MATRIX_ROW (w
->current_matrix
, i
);
1845 if (!row
->enabled_p
)
1847 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1854 /* Give up if Y is not in the window. */
1855 if (i
== w
->current_matrix
->nrows
)
1858 /* Get the glyph area containing X. */
1859 if (w
->pseudo_window_p
)
1866 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1868 *area
= LEFT_MARGIN_AREA
;
1869 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1871 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1874 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1878 *area
= RIGHT_MARGIN_AREA
;
1879 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1883 /* Find glyph containing X. */
1884 glyph
= row
->glyphs
[*area
];
1885 end
= glyph
+ row
->used
[*area
];
1887 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1889 x
-= glyph
->pixel_width
;
1899 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1902 *hpos
= glyph
- row
->glyphs
[*area
];
1906 /* Convert frame-relative x/y to coordinates relative to window W.
1907 Takes pseudo-windows into account. */
1910 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1912 if (w
->pseudo_window_p
)
1914 /* A pseudo-window is always full-width, and starts at the
1915 left edge of the frame, plus a frame border. */
1916 struct frame
*f
= XFRAME (w
->frame
);
1917 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1918 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1922 *x
-= WINDOW_LEFT_EDGE_X (w
);
1923 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1927 #ifdef HAVE_WINDOW_SYSTEM
1930 Return in RECTS[] at most N clipping rectangles for glyph string S.
1931 Return the number of stored rectangles. */
1934 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1941 if (s
->row
->full_width_p
)
1943 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1944 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1945 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1947 /* Unless displaying a mode or menu bar line, which are always
1948 fully visible, clip to the visible part of the row. */
1949 if (s
->w
->pseudo_window_p
)
1950 r
.height
= s
->row
->visible_height
;
1952 r
.height
= s
->height
;
1956 /* This is a text line that may be partially visible. */
1957 r
.x
= window_box_left (s
->w
, s
->area
);
1958 r
.width
= window_box_width (s
->w
, s
->area
);
1959 r
.height
= s
->row
->visible_height
;
1963 if (r
.x
< s
->clip_head
->x
)
1965 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1966 r
.width
-= s
->clip_head
->x
- r
.x
;
1969 r
.x
= s
->clip_head
->x
;
1972 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1974 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1975 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1980 /* If S draws overlapping rows, it's sufficient to use the top and
1981 bottom of the window for clipping because this glyph string
1982 intentionally draws over other lines. */
1983 if (s
->for_overlaps
)
1985 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1986 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1988 /* Alas, the above simple strategy does not work for the
1989 environments with anti-aliased text: if the same text is
1990 drawn onto the same place multiple times, it gets thicker.
1991 If the overlap we are processing is for the erased cursor, we
1992 take the intersection with the rectangle of the cursor. */
1993 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1995 XRectangle rc
, r_save
= r
;
1997 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1998 rc
.y
= s
->w
->phys_cursor
.y
;
1999 rc
.width
= s
->w
->phys_cursor_width
;
2000 rc
.height
= s
->w
->phys_cursor_height
;
2002 x_intersect_rectangles (&r_save
, &rc
, &r
);
2007 /* Don't use S->y for clipping because it doesn't take partially
2008 visible lines into account. For example, it can be negative for
2009 partially visible lines at the top of a window. */
2010 if (!s
->row
->full_width_p
2011 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2012 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2014 r
.y
= max (0, s
->row
->y
);
2017 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2019 /* If drawing the cursor, don't let glyph draw outside its
2020 advertised boundaries. Cleartype does this under some circumstances. */
2021 if (s
->hl
== DRAW_CURSOR
)
2023 struct glyph
*glyph
= s
->first_glyph
;
2028 r
.width
-= s
->x
- r
.x
;
2031 r
.width
= min (r
.width
, glyph
->pixel_width
);
2033 /* If r.y is below window bottom, ensure that we still see a cursor. */
2034 height
= min (glyph
->ascent
+ glyph
->descent
,
2035 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2036 max_y
= window_text_bottom_y (s
->w
) - height
;
2037 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2038 if (s
->ybase
- glyph
->ascent
> max_y
)
2045 /* Don't draw cursor glyph taller than our actual glyph. */
2046 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2047 if (height
< r
.height
)
2049 max_y
= r
.y
+ r
.height
;
2050 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2051 r
.height
= min (max_y
- r
.y
, height
);
2058 XRectangle r_save
= r
;
2060 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2064 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2065 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2067 #ifdef CONVERT_FROM_XRECT
2068 CONVERT_FROM_XRECT (r
, *rects
);
2076 /* If we are processing overlapping and allowed to return
2077 multiple clipping rectangles, we exclude the row of the glyph
2078 string from the clipping rectangle. This is to avoid drawing
2079 the same text on the environment with anti-aliasing. */
2080 #ifdef CONVERT_FROM_XRECT
2083 XRectangle
*rs
= rects
;
2085 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2087 if (s
->for_overlaps
& OVERLAPS_PRED
)
2090 if (r
.y
+ r
.height
> row_y
)
2093 rs
[i
].height
= row_y
- r
.y
;
2099 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2102 if (r
.y
< row_y
+ s
->row
->visible_height
)
2104 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2106 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2107 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2116 #ifdef CONVERT_FROM_XRECT
2117 for (i
= 0; i
< n
; i
++)
2118 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2125 Return in *NR the clipping rectangle for glyph string S. */
2128 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2130 get_glyph_string_clip_rects (s
, nr
, 1);
2135 Return the position and height of the phys cursor in window W.
2136 Set w->phys_cursor_width to width of phys cursor.
2140 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2141 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2143 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2144 int x
, y
, wd
, h
, h0
, y0
;
2146 /* Compute the width of the rectangle to draw. If on a stretch
2147 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2148 rectangle as wide as the glyph, but use a canonical character
2150 wd
= glyph
->pixel_width
- 1;
2151 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2155 x
= w
->phys_cursor
.x
;
2162 if (glyph
->type
== STRETCH_GLYPH
2163 && !x_stretch_cursor_p
)
2164 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2165 w
->phys_cursor_width
= wd
;
2167 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2169 /* If y is below window bottom, ensure that we still see a cursor. */
2170 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2172 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2173 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2175 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2178 h
= max (h
- (y0
- y
) + 1, h0
);
2183 y0
= window_text_bottom_y (w
) - h0
;
2191 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2192 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2197 * Remember which glyph the mouse is over.
2201 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2205 struct glyph_row
*r
, *gr
, *end_row
;
2206 enum window_part part
;
2207 enum glyph_row_area area
;
2208 int x
, y
, width
, height
;
2210 /* Try to determine frame pixel position and size of the glyph under
2211 frame pixel coordinates X/Y on frame F. */
2213 if (!f
->glyphs_initialized_p
2214 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2217 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2218 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2222 w
= XWINDOW (window
);
2223 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2224 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2226 x
= window_relative_x_coord (w
, part
, gx
);
2227 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2229 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2230 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2232 if (w
->pseudo_window_p
)
2235 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2241 case ON_LEFT_MARGIN
:
2242 area
= LEFT_MARGIN_AREA
;
2245 case ON_RIGHT_MARGIN
:
2246 area
= RIGHT_MARGIN_AREA
;
2249 case ON_HEADER_LINE
:
2251 gr
= (part
== ON_HEADER_LINE
2252 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2253 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2256 goto text_glyph_row_found
;
2263 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2264 if (r
->y
+ r
->height
> y
)
2270 text_glyph_row_found
:
2273 struct glyph
*g
= gr
->glyphs
[area
];
2274 struct glyph
*end
= g
+ gr
->used
[area
];
2276 height
= gr
->height
;
2277 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2278 if (gx
+ g
->pixel_width
> x
)
2283 if (g
->type
== IMAGE_GLYPH
)
2285 /* Don't remember when mouse is over image, as
2286 image may have hot-spots. */
2287 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2290 width
= g
->pixel_width
;
2294 /* Use nominal char spacing at end of line. */
2296 gx
+= (x
/ width
) * width
;
2299 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2300 gx
+= window_box_left_offset (w
, area
);
2304 /* Use nominal line height at end of window. */
2305 gx
= (x
/ width
) * width
;
2307 gy
+= (y
/ height
) * height
;
2311 case ON_LEFT_FRINGE
:
2312 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2313 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2314 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2315 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2318 case ON_RIGHT_FRINGE
:
2319 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2320 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2321 : window_box_right_offset (w
, TEXT_AREA
));
2322 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2326 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2328 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2329 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2330 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2332 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2336 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2337 if (r
->y
+ r
->height
> y
)
2344 height
= gr
->height
;
2347 /* Use nominal line height at end of window. */
2349 gy
+= (y
/ height
) * height
;
2356 /* If there is no glyph under the mouse, then we divide the screen
2357 into a grid of the smallest glyph in the frame, and use that
2360 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2361 round down even for negative values. */
2367 gx
= (gx
/ width
) * width
;
2368 gy
= (gy
/ height
) * height
;
2373 gx
+= WINDOW_LEFT_EDGE_X (w
);
2374 gy
+= WINDOW_TOP_EDGE_Y (w
);
2377 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2379 /* Visible feedback for debugging. */
2382 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2383 f
->output_data
.x
->normal_gc
,
2384 gx
, gy
, width
, height
);
2390 #endif /* HAVE_WINDOW_SYSTEM */
2393 /***********************************************************************
2394 Lisp form evaluation
2395 ***********************************************************************/
2397 /* Error handler for safe_eval and safe_call. */
2400 safe_eval_handler (Lisp_Object arg
)
2402 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2407 /* Evaluate SEXPR and return the result, or nil if something went
2408 wrong. Prevent redisplay during the evaluation. */
2410 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2411 Return the result, or nil if something went wrong. Prevent
2412 redisplay during the evaluation. */
2415 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2419 if (inhibit_eval_during_redisplay
)
2423 ptrdiff_t count
= SPECPDL_INDEX ();
2424 struct gcpro gcpro1
;
2427 gcpro1
.nvars
= nargs
;
2428 specbind (Qinhibit_redisplay
, Qt
);
2429 /* Use Qt to ensure debugger does not run,
2430 so there is no possibility of wanting to redisplay. */
2431 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2434 val
= unbind_to (count
, val
);
2441 /* Call function FN with one argument ARG.
2442 Return the result, or nil if something went wrong. */
2445 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2447 Lisp_Object args
[2];
2450 return safe_call (2, args
);
2453 static Lisp_Object Qeval
;
2456 safe_eval (Lisp_Object sexpr
)
2458 return safe_call1 (Qeval
, sexpr
);
2461 /* Call function FN with one argument ARG.
2462 Return the result, or nil if something went wrong. */
2465 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2467 Lisp_Object args
[3];
2471 return safe_call (3, args
);
2476 /***********************************************************************
2478 ***********************************************************************/
2482 /* Define CHECK_IT to perform sanity checks on iterators.
2483 This is for debugging. It is too slow to do unconditionally. */
2486 check_it (struct it
*it
)
2488 if (it
->method
== GET_FROM_STRING
)
2490 eassert (STRINGP (it
->string
));
2491 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2495 eassert (IT_STRING_CHARPOS (*it
) < 0);
2496 if (it
->method
== GET_FROM_BUFFER
)
2498 /* Check that character and byte positions agree. */
2499 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2504 eassert (it
->current
.dpvec_index
>= 0);
2506 eassert (it
->current
.dpvec_index
< 0);
2509 #define CHECK_IT(IT) check_it ((IT))
2513 #define CHECK_IT(IT) (void) 0
2518 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2520 /* Check that the window end of window W is what we expect it
2521 to be---the last row in the current matrix displaying text. */
2524 check_window_end (struct window
*w
)
2526 if (!MINI_WINDOW_P (w
)
2527 && !NILP (w
->window_end_valid
))
2529 struct glyph_row
*row
;
2530 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2531 XFASTINT (w
->window_end_vpos
)),
2533 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2534 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2538 #define CHECK_WINDOW_END(W) check_window_end ((W))
2542 #define CHECK_WINDOW_END(W) (void) 0
2544 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2548 /***********************************************************************
2549 Iterator initialization
2550 ***********************************************************************/
2552 /* Initialize IT for displaying current_buffer in window W, starting
2553 at character position CHARPOS. CHARPOS < 0 means that no buffer
2554 position is specified which is useful when the iterator is assigned
2555 a position later. BYTEPOS is the byte position corresponding to
2556 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2558 If ROW is not null, calls to produce_glyphs with IT as parameter
2559 will produce glyphs in that row.
2561 BASE_FACE_ID is the id of a base face to use. It must be one of
2562 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2563 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2564 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2566 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2567 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2568 will be initialized to use the corresponding mode line glyph row of
2569 the desired matrix of W. */
2572 init_iterator (struct it
*it
, struct window
*w
,
2573 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2574 struct glyph_row
*row
, enum face_id base_face_id
)
2576 int highlight_region_p
;
2577 enum face_id remapped_base_face_id
= base_face_id
;
2579 /* Some precondition checks. */
2580 eassert (w
!= NULL
&& it
!= NULL
);
2581 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2584 /* If face attributes have been changed since the last redisplay,
2585 free realized faces now because they depend on face definitions
2586 that might have changed. Don't free faces while there might be
2587 desired matrices pending which reference these faces. */
2588 if (face_change_count
&& !inhibit_free_realized_faces
)
2590 face_change_count
= 0;
2591 free_all_realized_faces (Qnil
);
2594 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2595 if (! NILP (Vface_remapping_alist
))
2596 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2598 /* Use one of the mode line rows of W's desired matrix if
2602 if (base_face_id
== MODE_LINE_FACE_ID
2603 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2604 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2605 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2606 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2610 memset (it
, 0, sizeof *it
);
2611 it
->current
.overlay_string_index
= -1;
2612 it
->current
.dpvec_index
= -1;
2613 it
->base_face_id
= remapped_base_face_id
;
2615 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2616 it
->paragraph_embedding
= L2R
;
2617 it
->bidi_it
.string
.lstring
= Qnil
;
2618 it
->bidi_it
.string
.s
= NULL
;
2619 it
->bidi_it
.string
.bufpos
= 0;
2621 /* The window in which we iterate over current_buffer: */
2622 XSETWINDOW (it
->window
, w
);
2624 it
->f
= XFRAME (w
->frame
);
2628 /* Extra space between lines (on window systems only). */
2629 if (base_face_id
== DEFAULT_FACE_ID
2630 && FRAME_WINDOW_P (it
->f
))
2632 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2633 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2634 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2635 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2636 * FRAME_LINE_HEIGHT (it
->f
));
2637 else if (it
->f
->extra_line_spacing
> 0)
2638 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2639 it
->max_extra_line_spacing
= 0;
2642 /* If realized faces have been removed, e.g. because of face
2643 attribute changes of named faces, recompute them. When running
2644 in batch mode, the face cache of the initial frame is null. If
2645 we happen to get called, make a dummy face cache. */
2646 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2647 init_frame_faces (it
->f
);
2648 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2649 recompute_basic_faces (it
->f
);
2651 /* Current value of the `slice', `space-width', and 'height' properties. */
2652 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2653 it
->space_width
= Qnil
;
2654 it
->font_height
= Qnil
;
2655 it
->override_ascent
= -1;
2657 /* Are control characters displayed as `^C'? */
2658 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2660 /* -1 means everything between a CR and the following line end
2661 is invisible. >0 means lines indented more than this value are
2663 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2664 ? clip_to_bounds (-1, XINT (BVAR (current_buffer
,
2665 selective_display
)),
2667 : (!NILP (BVAR (current_buffer
, selective_display
))
2669 it
->selective_display_ellipsis_p
2670 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2672 /* Display table to use. */
2673 it
->dp
= window_display_table (w
);
2675 /* Are multibyte characters enabled in current_buffer? */
2676 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2678 /* Non-zero if we should highlight the region. */
2680 = (!NILP (Vtransient_mark_mode
)
2681 && !NILP (BVAR (current_buffer
, mark_active
))
2682 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2684 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2685 start and end of a visible region in window IT->w. Set both to
2686 -1 to indicate no region. */
2687 if (highlight_region_p
2688 /* Maybe highlight only in selected window. */
2689 && (/* Either show region everywhere. */
2690 highlight_nonselected_windows
2691 /* Or show region in the selected window. */
2692 || w
== XWINDOW (selected_window
)
2693 /* Or show the region if we are in the mini-buffer and W is
2694 the window the mini-buffer refers to. */
2695 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2696 && WINDOWP (minibuf_selected_window
)
2697 && w
== XWINDOW (minibuf_selected_window
))))
2699 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2700 it
->region_beg_charpos
= min (PT
, markpos
);
2701 it
->region_end_charpos
= max (PT
, markpos
);
2704 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2706 /* Get the position at which the redisplay_end_trigger hook should
2707 be run, if it is to be run at all. */
2708 if (MARKERP (w
->redisplay_end_trigger
)
2709 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2710 it
->redisplay_end_trigger_charpos
2711 = marker_position (w
->redisplay_end_trigger
);
2712 else if (INTEGERP (w
->redisplay_end_trigger
))
2713 it
->redisplay_end_trigger_charpos
=
2714 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2716 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2718 /* Are lines in the display truncated? */
2719 if (base_face_id
!= DEFAULT_FACE_ID
2721 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2722 && ((!NILP (Vtruncate_partial_width_windows
)
2723 && !INTEGERP (Vtruncate_partial_width_windows
))
2724 || (INTEGERP (Vtruncate_partial_width_windows
)
2725 && (WINDOW_TOTAL_COLS (it
->w
)
2726 < XINT (Vtruncate_partial_width_windows
))))))
2727 it
->line_wrap
= TRUNCATE
;
2728 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2729 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2730 ? WINDOW_WRAP
: WORD_WRAP
;
2732 it
->line_wrap
= TRUNCATE
;
2734 /* Get dimensions of truncation and continuation glyphs. These are
2735 displayed as fringe bitmaps under X, but we need them for such
2736 frames when the fringes are turned off. */
2737 if (it
->line_wrap
== TRUNCATE
)
2739 /* We will need the truncation glyph. */
2740 eassert (it
->glyph_row
== NULL
);
2741 produce_special_glyphs (it
, IT_TRUNCATION
);
2742 it
->truncation_pixel_width
= it
->pixel_width
;
2746 /* We will need the continuation glyph. */
2747 eassert (it
->glyph_row
== NULL
);
2748 produce_special_glyphs (it
, IT_CONTINUATION
);
2749 it
->continuation_pixel_width
= it
->pixel_width
;
2752 /* Reset these values to zero because the produce_special_glyphs
2753 above has changed them. */
2754 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2755 it
->phys_ascent
= it
->phys_descent
= 0;
2757 /* Set this after getting the dimensions of truncation and
2758 continuation glyphs, so that we don't produce glyphs when calling
2759 produce_special_glyphs, above. */
2760 it
->glyph_row
= row
;
2761 it
->area
= TEXT_AREA
;
2763 /* Forget any previous info about this row being reversed. */
2765 it
->glyph_row
->reversed_p
= 0;
2767 /* Get the dimensions of the display area. The display area
2768 consists of the visible window area plus a horizontally scrolled
2769 part to the left of the window. All x-values are relative to the
2770 start of this total display area. */
2771 if (base_face_id
!= DEFAULT_FACE_ID
)
2773 /* Mode lines, menu bar in terminal frames. */
2774 it
->first_visible_x
= 0;
2775 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2779 it
->first_visible_x
=
2780 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2781 it
->last_visible_x
= (it
->first_visible_x
2782 + window_box_width (w
, TEXT_AREA
));
2784 /* If we truncate lines, leave room for the truncation glyph(s) at
2785 the right margin. Otherwise, leave room for the continuation
2786 glyph(s). Done only if the window has no fringes. Since we
2787 don't know at this point whether there will be any R2L lines in
2788 the window, we reserve space for truncation/continuation glyphs
2789 even if only one of the fringes is absent. */
2790 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2791 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2793 if (it
->line_wrap
== TRUNCATE
)
2794 it
->last_visible_x
-= it
->truncation_pixel_width
;
2796 it
->last_visible_x
-= it
->continuation_pixel_width
;
2799 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2800 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2803 /* Leave room for a border glyph. */
2804 if (!FRAME_WINDOW_P (it
->f
)
2805 && !WINDOW_RIGHTMOST_P (it
->w
))
2806 it
->last_visible_x
-= 1;
2808 it
->last_visible_y
= window_text_bottom_y (w
);
2810 /* For mode lines and alike, arrange for the first glyph having a
2811 left box line if the face specifies a box. */
2812 if (base_face_id
!= DEFAULT_FACE_ID
)
2816 it
->face_id
= remapped_base_face_id
;
2818 /* If we have a boxed mode line, make the first character appear
2819 with a left box line. */
2820 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2821 if (face
->box
!= FACE_NO_BOX
)
2822 it
->start_of_box_run_p
= 1;
2825 /* If a buffer position was specified, set the iterator there,
2826 getting overlays and face properties from that position. */
2827 if (charpos
>= BUF_BEG (current_buffer
))
2829 it
->end_charpos
= ZV
;
2830 IT_CHARPOS (*it
) = charpos
;
2832 /* We will rely on `reseat' to set this up properly, via
2833 handle_face_prop. */
2834 it
->face_id
= it
->base_face_id
;
2836 /* Compute byte position if not specified. */
2837 if (bytepos
< charpos
)
2838 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2840 IT_BYTEPOS (*it
) = bytepos
;
2842 it
->start
= it
->current
;
2843 /* Do we need to reorder bidirectional text? Not if this is a
2844 unibyte buffer: by definition, none of the single-byte
2845 characters are strong R2L, so no reordering is needed. And
2846 bidi.c doesn't support unibyte buffers anyway. Also, don't
2847 reorder while we are loading loadup.el, since the tables of
2848 character properties needed for reordering are not yet
2852 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2855 /* If we are to reorder bidirectional text, init the bidi
2859 /* Note the paragraph direction that this buffer wants to
2861 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2863 it
->paragraph_embedding
= L2R
;
2864 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2866 it
->paragraph_embedding
= R2L
;
2868 it
->paragraph_embedding
= NEUTRAL_DIR
;
2869 bidi_unshelve_cache (NULL
, 0);
2870 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2874 /* Compute faces etc. */
2875 reseat (it
, it
->current
.pos
, 1);
2882 /* Initialize IT for the display of window W with window start POS. */
2885 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2887 struct glyph_row
*row
;
2888 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2890 row
= w
->desired_matrix
->rows
+ first_vpos
;
2891 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2892 it
->first_vpos
= first_vpos
;
2894 /* Don't reseat to previous visible line start if current start
2895 position is in a string or image. */
2896 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2898 int start_at_line_beg_p
;
2899 int first_y
= it
->current_y
;
2901 /* If window start is not at a line start, skip forward to POS to
2902 get the correct continuation lines width. */
2903 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2904 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2905 if (!start_at_line_beg_p
)
2909 reseat_at_previous_visible_line_start (it
);
2910 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2912 new_x
= it
->current_x
+ it
->pixel_width
;
2914 /* If lines are continued, this line may end in the middle
2915 of a multi-glyph character (e.g. a control character
2916 displayed as \003, or in the middle of an overlay
2917 string). In this case move_it_to above will not have
2918 taken us to the start of the continuation line but to the
2919 end of the continued line. */
2920 if (it
->current_x
> 0
2921 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2922 && (/* And glyph doesn't fit on the line. */
2923 new_x
> it
->last_visible_x
2924 /* Or it fits exactly and we're on a window
2926 || (new_x
== it
->last_visible_x
2927 && FRAME_WINDOW_P (it
->f
)
2928 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2929 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2930 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2932 if ((it
->current
.dpvec_index
>= 0
2933 || it
->current
.overlay_string_index
>= 0)
2934 /* If we are on a newline from a display vector or
2935 overlay string, then we are already at the end of
2936 a screen line; no need to go to the next line in
2937 that case, as this line is not really continued.
2938 (If we do go to the next line, C-e will not DTRT.) */
2941 set_iterator_to_next (it
, 1);
2942 move_it_in_display_line_to (it
, -1, -1, 0);
2945 it
->continuation_lines_width
+= it
->current_x
;
2947 /* If the character at POS is displayed via a display
2948 vector, move_it_to above stops at the final glyph of
2949 IT->dpvec. To make the caller redisplay that character
2950 again (a.k.a. start at POS), we need to reset the
2951 dpvec_index to the beginning of IT->dpvec. */
2952 else if (it
->current
.dpvec_index
>= 0)
2953 it
->current
.dpvec_index
= 0;
2955 /* We're starting a new display line, not affected by the
2956 height of the continued line, so clear the appropriate
2957 fields in the iterator structure. */
2958 it
->max_ascent
= it
->max_descent
= 0;
2959 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2961 it
->current_y
= first_y
;
2963 it
->current_x
= it
->hpos
= 0;
2969 /* Return 1 if POS is a position in ellipses displayed for invisible
2970 text. W is the window we display, for text property lookup. */
2973 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2975 Lisp_Object prop
, window
;
2977 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2979 /* If POS specifies a position in a display vector, this might
2980 be for an ellipsis displayed for invisible text. We won't
2981 get the iterator set up for delivering that ellipsis unless
2982 we make sure that it gets aware of the invisible text. */
2983 if (pos
->dpvec_index
>= 0
2984 && pos
->overlay_string_index
< 0
2985 && CHARPOS (pos
->string_pos
) < 0
2987 && (XSETWINDOW (window
, w
),
2988 prop
= Fget_char_property (make_number (charpos
),
2989 Qinvisible
, window
),
2990 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2992 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2994 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3001 /* Initialize IT for stepping through current_buffer in window W,
3002 starting at position POS that includes overlay string and display
3003 vector/ control character translation position information. Value
3004 is zero if there are overlay strings with newlines at POS. */
3007 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3009 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3010 int i
, overlay_strings_with_newlines
= 0;
3012 /* If POS specifies a position in a display vector, this might
3013 be for an ellipsis displayed for invisible text. We won't
3014 get the iterator set up for delivering that ellipsis unless
3015 we make sure that it gets aware of the invisible text. */
3016 if (in_ellipses_for_invisible_text_p (pos
, w
))
3022 /* Keep in mind: the call to reseat in init_iterator skips invisible
3023 text, so we might end up at a position different from POS. This
3024 is only a problem when POS is a row start after a newline and an
3025 overlay starts there with an after-string, and the overlay has an
3026 invisible property. Since we don't skip invisible text in
3027 display_line and elsewhere immediately after consuming the
3028 newline before the row start, such a POS will not be in a string,
3029 but the call to init_iterator below will move us to the
3031 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3033 /* This only scans the current chunk -- it should scan all chunks.
3034 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3035 to 16 in 22.1 to make this a lesser problem. */
3036 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3038 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3039 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3041 while (s
< e
&& *s
!= '\n')
3046 overlay_strings_with_newlines
= 1;
3051 /* If position is within an overlay string, set up IT to the right
3053 if (pos
->overlay_string_index
>= 0)
3057 /* If the first overlay string happens to have a `display'
3058 property for an image, the iterator will be set up for that
3059 image, and we have to undo that setup first before we can
3060 correct the overlay string index. */
3061 if (it
->method
== GET_FROM_IMAGE
)
3064 /* We already have the first chunk of overlay strings in
3065 IT->overlay_strings. Load more until the one for
3066 pos->overlay_string_index is in IT->overlay_strings. */
3067 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3069 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3070 it
->current
.overlay_string_index
= 0;
3073 load_overlay_strings (it
, 0);
3074 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3078 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3079 relative_index
= (it
->current
.overlay_string_index
3080 % OVERLAY_STRING_CHUNK_SIZE
);
3081 it
->string
= it
->overlay_strings
[relative_index
];
3082 eassert (STRINGP (it
->string
));
3083 it
->current
.string_pos
= pos
->string_pos
;
3084 it
->method
= GET_FROM_STRING
;
3087 if (CHARPOS (pos
->string_pos
) >= 0)
3089 /* Recorded position is not in an overlay string, but in another
3090 string. This can only be a string from a `display' property.
3091 IT should already be filled with that string. */
3092 it
->current
.string_pos
= pos
->string_pos
;
3093 eassert (STRINGP (it
->string
));
3096 /* Restore position in display vector translations, control
3097 character translations or ellipses. */
3098 if (pos
->dpvec_index
>= 0)
3100 if (it
->dpvec
== NULL
)
3101 get_next_display_element (it
);
3102 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3103 it
->current
.dpvec_index
= pos
->dpvec_index
;
3107 return !overlay_strings_with_newlines
;
3111 /* Initialize IT for stepping through current_buffer in window W
3112 starting at ROW->start. */
3115 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3117 init_from_display_pos (it
, w
, &row
->start
);
3118 it
->start
= row
->start
;
3119 it
->continuation_lines_width
= row
->continuation_lines_width
;
3124 /* Initialize IT for stepping through current_buffer in window W
3125 starting in the line following ROW, i.e. starting at ROW->end.
3126 Value is zero if there are overlay strings with newlines at ROW's
3130 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3134 if (init_from_display_pos (it
, w
, &row
->end
))
3136 if (row
->continued_p
)
3137 it
->continuation_lines_width
3138 = row
->continuation_lines_width
+ row
->pixel_width
;
3149 /***********************************************************************
3151 ***********************************************************************/
3153 /* Called when IT reaches IT->stop_charpos. Handle text property and
3154 overlay changes. Set IT->stop_charpos to the next position where
3158 handle_stop (struct it
*it
)
3160 enum prop_handled handled
;
3161 int handle_overlay_change_p
;
3165 it
->current
.dpvec_index
= -1;
3166 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3167 it
->ignore_overlay_strings_at_pos_p
= 0;
3170 /* Use face of preceding text for ellipsis (if invisible) */
3171 if (it
->selective_display_ellipsis_p
)
3172 it
->saved_face_id
= it
->face_id
;
3176 handled
= HANDLED_NORMALLY
;
3178 /* Call text property handlers. */
3179 for (p
= it_props
; p
->handler
; ++p
)
3181 handled
= p
->handler (it
);
3183 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3185 else if (handled
== HANDLED_RETURN
)
3187 /* We still want to show before and after strings from
3188 overlays even if the actual buffer text is replaced. */
3189 if (!handle_overlay_change_p
3191 /* Don't call get_overlay_strings_1 if we already
3192 have overlay strings loaded, because doing so
3193 will load them again and push the iterator state
3194 onto the stack one more time, which is not
3195 expected by the rest of the code that processes
3197 || (it
->current
.overlay_string_index
< 0
3198 ? !get_overlay_strings_1 (it
, 0, 0)
3202 setup_for_ellipsis (it
, 0);
3203 /* When handling a display spec, we might load an
3204 empty string. In that case, discard it here. We
3205 used to discard it in handle_single_display_spec,
3206 but that causes get_overlay_strings_1, above, to
3207 ignore overlay strings that we must check. */
3208 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3212 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3216 it
->ignore_overlay_strings_at_pos_p
= 1;
3217 it
->string_from_display_prop_p
= 0;
3218 it
->from_disp_prop_p
= 0;
3219 handle_overlay_change_p
= 0;
3221 handled
= HANDLED_RECOMPUTE_PROPS
;
3224 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3225 handle_overlay_change_p
= 0;
3228 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3230 /* Don't check for overlay strings below when set to deliver
3231 characters from a display vector. */
3232 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3233 handle_overlay_change_p
= 0;
3235 /* Handle overlay changes.
3236 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3237 if it finds overlays. */
3238 if (handle_overlay_change_p
)
3239 handled
= handle_overlay_change (it
);
3244 setup_for_ellipsis (it
, 0);
3248 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3250 /* Determine where to stop next. */
3251 if (handled
== HANDLED_NORMALLY
)
3252 compute_stop_pos (it
);
3256 /* Compute IT->stop_charpos from text property and overlay change
3257 information for IT's current position. */
3260 compute_stop_pos (struct it
*it
)
3262 register INTERVAL iv
, next_iv
;
3263 Lisp_Object object
, limit
, position
;
3264 ptrdiff_t charpos
, bytepos
;
3266 if (STRINGP (it
->string
))
3268 /* Strings are usually short, so don't limit the search for
3270 it
->stop_charpos
= it
->end_charpos
;
3271 object
= it
->string
;
3273 charpos
= IT_STRING_CHARPOS (*it
);
3274 bytepos
= IT_STRING_BYTEPOS (*it
);
3280 /* If end_charpos is out of range for some reason, such as a
3281 misbehaving display function, rationalize it (Bug#5984). */
3282 if (it
->end_charpos
> ZV
)
3283 it
->end_charpos
= ZV
;
3284 it
->stop_charpos
= it
->end_charpos
;
3286 /* If next overlay change is in front of the current stop pos
3287 (which is IT->end_charpos), stop there. Note: value of
3288 next_overlay_change is point-max if no overlay change
3290 charpos
= IT_CHARPOS (*it
);
3291 bytepos
= IT_BYTEPOS (*it
);
3292 pos
= next_overlay_change (charpos
);
3293 if (pos
< it
->stop_charpos
)
3294 it
->stop_charpos
= pos
;
3296 /* If showing the region, we have to stop at the region
3297 start or end because the face might change there. */
3298 if (it
->region_beg_charpos
> 0)
3300 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3301 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3302 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3303 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3306 /* Set up variables for computing the stop position from text
3307 property changes. */
3308 XSETBUFFER (object
, current_buffer
);
3309 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3312 /* Get the interval containing IT's position. Value is a null
3313 interval if there isn't such an interval. */
3314 position
= make_number (charpos
);
3315 iv
= validate_interval_range (object
, &position
, &position
, 0);
3316 if (!NULL_INTERVAL_P (iv
))
3318 Lisp_Object values_here
[LAST_PROP_IDX
];
3321 /* Get properties here. */
3322 for (p
= it_props
; p
->handler
; ++p
)
3323 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3325 /* Look for an interval following iv that has different
3327 for (next_iv
= next_interval (iv
);
3328 (!NULL_INTERVAL_P (next_iv
)
3330 || XFASTINT (limit
) > next_iv
->position
));
3331 next_iv
= next_interval (next_iv
))
3333 for (p
= it_props
; p
->handler
; ++p
)
3335 Lisp_Object new_value
;
3337 new_value
= textget (next_iv
->plist
, *p
->name
);
3338 if (!EQ (values_here
[p
->idx
], new_value
))
3346 if (!NULL_INTERVAL_P (next_iv
))
3348 if (INTEGERP (limit
)
3349 && next_iv
->position
>= XFASTINT (limit
))
3350 /* No text property change up to limit. */
3351 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3353 /* Text properties change in next_iv. */
3354 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3358 if (it
->cmp_it
.id
< 0)
3360 ptrdiff_t stoppos
= it
->end_charpos
;
3362 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3364 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3365 stoppos
, it
->string
);
3368 eassert (STRINGP (it
->string
)
3369 || (it
->stop_charpos
>= BEGV
3370 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3374 /* Return the position of the next overlay change after POS in
3375 current_buffer. Value is point-max if no overlay change
3376 follows. This is like `next-overlay-change' but doesn't use
3380 next_overlay_change (ptrdiff_t pos
)
3382 ptrdiff_t i
, noverlays
;
3384 Lisp_Object
*overlays
;
3386 /* Get all overlays at the given position. */
3387 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3389 /* If any of these overlays ends before endpos,
3390 use its ending point instead. */
3391 for (i
= 0; i
< noverlays
; ++i
)
3396 oend
= OVERLAY_END (overlays
[i
]);
3397 oendpos
= OVERLAY_POSITION (oend
);
3398 endpos
= min (endpos
, oendpos
);
3404 /* How many characters forward to search for a display property or
3405 display string. Searching too far forward makes the bidi display
3406 sluggish, especially in small windows. */
3407 #define MAX_DISP_SCAN 250
3409 /* Return the character position of a display string at or after
3410 position specified by POSITION. If no display string exists at or
3411 after POSITION, return ZV. A display string is either an overlay
3412 with `display' property whose value is a string, or a `display'
3413 text property whose value is a string. STRING is data about the
3414 string to iterate; if STRING->lstring is nil, we are iterating a
3415 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3416 on a GUI frame. DISP_PROP is set to zero if we searched
3417 MAX_DISP_SCAN characters forward without finding any display
3418 strings, non-zero otherwise. It is set to 2 if the display string
3419 uses any kind of `(space ...)' spec that will produce a stretch of
3420 white space in the text area. */
3422 compute_display_string_pos (struct text_pos
*position
,
3423 struct bidi_string_data
*string
,
3424 int frame_window_p
, int *disp_prop
)
3426 /* OBJECT = nil means current buffer. */
3427 Lisp_Object object
=
3428 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3429 Lisp_Object pos
, spec
, limpos
;
3430 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3431 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3432 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3433 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3435 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3436 struct text_pos tpos
;
3442 /* We don't support display properties whose values are strings
3443 that have display string properties. */
3444 || string
->from_disp_str
3445 /* C strings cannot have display properties. */
3446 || (string
->s
&& !STRINGP (object
)))
3452 /* If the character at CHARPOS is where the display string begins,
3454 pos
= make_number (charpos
);
3455 if (STRINGP (object
))
3456 bufpos
= string
->bufpos
;
3460 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3462 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3465 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3473 /* Look forward for the first character with a `display' property
3474 that will replace the underlying text when displayed. */
3475 limpos
= make_number (lim
);
3477 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3478 CHARPOS (tpos
) = XFASTINT (pos
);
3479 if (CHARPOS (tpos
) >= lim
)
3484 if (STRINGP (object
))
3485 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3487 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3488 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3489 if (!STRINGP (object
))
3490 bufpos
= CHARPOS (tpos
);
3491 } while (NILP (spec
)
3492 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3493 bufpos
, frame_window_p
)));
3497 return CHARPOS (tpos
);
3500 /* Return the character position of the end of the display string that
3501 started at CHARPOS. If there's no display string at CHARPOS,
3502 return -1. A display string is either an overlay with `display'
3503 property whose value is a string or a `display' text property whose
3504 value is a string. */
3506 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3508 /* OBJECT = nil means current buffer. */
3509 Lisp_Object object
=
3510 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3511 Lisp_Object pos
= make_number (charpos
);
3513 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3515 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3518 /* It could happen that the display property or overlay was removed
3519 since we found it in compute_display_string_pos above. One way
3520 this can happen is if JIT font-lock was called (through
3521 handle_fontified_prop), and jit-lock-functions remove text
3522 properties or overlays from the portion of buffer that includes
3523 CHARPOS. Muse mode is known to do that, for example. In this
3524 case, we return -1 to the caller, to signal that no display
3525 string is actually present at CHARPOS. See bidi_fetch_char for
3526 how this is handled.
3528 An alternative would be to never look for display properties past
3529 it->stop_charpos. But neither compute_display_string_pos nor
3530 bidi_fetch_char that calls it know or care where the next
3532 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3535 /* Look forward for the first character where the `display' property
3537 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3539 return XFASTINT (pos
);
3544 /***********************************************************************
3546 ***********************************************************************/
3548 /* Handle changes in the `fontified' property of the current buffer by
3549 calling hook functions from Qfontification_functions to fontify
3552 static enum prop_handled
3553 handle_fontified_prop (struct it
*it
)
3555 Lisp_Object prop
, pos
;
3556 enum prop_handled handled
= HANDLED_NORMALLY
;
3558 if (!NILP (Vmemory_full
))
3561 /* Get the value of the `fontified' property at IT's current buffer
3562 position. (The `fontified' property doesn't have a special
3563 meaning in strings.) If the value is nil, call functions from
3564 Qfontification_functions. */
3565 if (!STRINGP (it
->string
)
3567 && !NILP (Vfontification_functions
)
3568 && !NILP (Vrun_hooks
)
3569 && (pos
= make_number (IT_CHARPOS (*it
)),
3570 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3571 /* Ignore the special cased nil value always present at EOB since
3572 no amount of fontifying will be able to change it. */
3573 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3575 ptrdiff_t count
= SPECPDL_INDEX ();
3577 struct buffer
*obuf
= current_buffer
;
3578 int begv
= BEGV
, zv
= ZV
;
3579 int old_clip_changed
= current_buffer
->clip_changed
;
3581 val
= Vfontification_functions
;
3582 specbind (Qfontification_functions
, Qnil
);
3584 eassert (it
->end_charpos
== ZV
);
3586 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3587 safe_call1 (val
, pos
);
3590 Lisp_Object fns
, fn
;
3591 struct gcpro gcpro1
, gcpro2
;
3596 for (; CONSP (val
); val
= XCDR (val
))
3602 /* A value of t indicates this hook has a local
3603 binding; it means to run the global binding too.
3604 In a global value, t should not occur. If it
3605 does, we must ignore it to avoid an endless
3607 for (fns
= Fdefault_value (Qfontification_functions
);
3613 safe_call1 (fn
, pos
);
3617 safe_call1 (fn
, pos
);
3623 unbind_to (count
, Qnil
);
3625 /* Fontification functions routinely call `save-restriction'.
3626 Normally, this tags clip_changed, which can confuse redisplay
3627 (see discussion in Bug#6671). Since we don't perform any
3628 special handling of fontification changes in the case where
3629 `save-restriction' isn't called, there's no point doing so in
3630 this case either. So, if the buffer's restrictions are
3631 actually left unchanged, reset clip_changed. */
3632 if (obuf
== current_buffer
)
3634 if (begv
== BEGV
&& zv
== ZV
)
3635 current_buffer
->clip_changed
= old_clip_changed
;
3637 /* There isn't much we can reasonably do to protect against
3638 misbehaving fontification, but here's a fig leaf. */
3639 else if (!NILP (BVAR (obuf
, name
)))
3640 set_buffer_internal_1 (obuf
);
3642 /* The fontification code may have added/removed text.
3643 It could do even a lot worse, but let's at least protect against
3644 the most obvious case where only the text past `pos' gets changed',
3645 as is/was done in grep.el where some escapes sequences are turned
3646 into face properties (bug#7876). */
3647 it
->end_charpos
= ZV
;
3649 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3650 something. This avoids an endless loop if they failed to
3651 fontify the text for which reason ever. */
3652 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3653 handled
= HANDLED_RECOMPUTE_PROPS
;
3661 /***********************************************************************
3663 ***********************************************************************/
3665 /* Set up iterator IT from face properties at its current position.
3666 Called from handle_stop. */
3668 static enum prop_handled
3669 handle_face_prop (struct it
*it
)
3672 ptrdiff_t next_stop
;
3674 if (!STRINGP (it
->string
))
3677 = face_at_buffer_position (it
->w
,
3679 it
->region_beg_charpos
,
3680 it
->region_end_charpos
,
3683 + TEXT_PROP_DISTANCE_LIMIT
),
3684 0, it
->base_face_id
);
3686 /* Is this a start of a run of characters with box face?
3687 Caveat: this can be called for a freshly initialized
3688 iterator; face_id is -1 in this case. We know that the new
3689 face will not change until limit, i.e. if the new face has a
3690 box, all characters up to limit will have one. But, as
3691 usual, we don't know whether limit is really the end. */
3692 if (new_face_id
!= it
->face_id
)
3694 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3696 /* If new face has a box but old face has not, this is
3697 the start of a run of characters with box, i.e. it has
3698 a shadow on the left side. The value of face_id of the
3699 iterator will be -1 if this is the initial call that gets
3700 the face. In this case, we have to look in front of IT's
3701 position and see whether there is a face != new_face_id. */
3702 it
->start_of_box_run_p
3703 = (new_face
->box
!= FACE_NO_BOX
3704 && (it
->face_id
>= 0
3705 || IT_CHARPOS (*it
) == BEG
3706 || new_face_id
!= face_before_it_pos (it
)));
3707 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3715 Lisp_Object from_overlay
3716 = (it
->current
.overlay_string_index
>= 0
3717 ? it
->string_overlays
[it
->current
.overlay_string_index
3718 % OVERLAY_STRING_CHUNK_SIZE
]
3721 /* See if we got to this string directly or indirectly from
3722 an overlay property. That includes the before-string or
3723 after-string of an overlay, strings in display properties
3724 provided by an overlay, their text properties, etc.
3726 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3727 if (! NILP (from_overlay
))
3728 for (i
= it
->sp
- 1; i
>= 0; i
--)
3730 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3732 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3733 % OVERLAY_STRING_CHUNK_SIZE
];
3734 else if (! NILP (it
->stack
[i
].from_overlay
))
3735 from_overlay
= it
->stack
[i
].from_overlay
;
3737 if (!NILP (from_overlay
))
3741 if (! NILP (from_overlay
))
3743 bufpos
= IT_CHARPOS (*it
);
3744 /* For a string from an overlay, the base face depends
3745 only on text properties and ignores overlays. */
3747 = face_for_overlay_string (it
->w
,
3749 it
->region_beg_charpos
,
3750 it
->region_end_charpos
,
3753 + TEXT_PROP_DISTANCE_LIMIT
),
3761 /* For strings from a `display' property, use the face at
3762 IT's current buffer position as the base face to merge
3763 with, so that overlay strings appear in the same face as
3764 surrounding text, unless they specify their own
3766 base_face_id
= it
->string_from_prefix_prop_p
3768 : underlying_face_id (it
);
3771 new_face_id
= face_at_string_position (it
->w
,
3773 IT_STRING_CHARPOS (*it
),
3775 it
->region_beg_charpos
,
3776 it
->region_end_charpos
,
3780 /* Is this a start of a run of characters with box? Caveat:
3781 this can be called for a freshly allocated iterator; face_id
3782 is -1 is this case. We know that the new face will not
3783 change until the next check pos, i.e. if the new face has a
3784 box, all characters up to that position will have a
3785 box. But, as usual, we don't know whether that position
3786 is really the end. */
3787 if (new_face_id
!= it
->face_id
)
3789 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3790 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3792 /* If new face has a box but old face hasn't, this is the
3793 start of a run of characters with box, i.e. it has a
3794 shadow on the left side. */
3795 it
->start_of_box_run_p
3796 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3797 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3801 it
->face_id
= new_face_id
;
3802 return HANDLED_NORMALLY
;
3806 /* Return the ID of the face ``underlying'' IT's current position,
3807 which is in a string. If the iterator is associated with a
3808 buffer, return the face at IT's current buffer position.
3809 Otherwise, use the iterator's base_face_id. */
3812 underlying_face_id (struct it
*it
)
3814 int face_id
= it
->base_face_id
, i
;
3816 eassert (STRINGP (it
->string
));
3818 for (i
= it
->sp
- 1; i
>= 0; --i
)
3819 if (NILP (it
->stack
[i
].string
))
3820 face_id
= it
->stack
[i
].face_id
;
3826 /* Compute the face one character before or after the current position
3827 of IT, in the visual order. BEFORE_P non-zero means get the face
3828 in front (to the left in L2R paragraphs, to the right in R2L
3829 paragraphs) of IT's screen position. Value is the ID of the face. */
3832 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3835 ptrdiff_t next_check_charpos
;
3837 void *it_copy_data
= NULL
;
3839 eassert (it
->s
== NULL
);
3841 if (STRINGP (it
->string
))
3843 ptrdiff_t bufpos
, charpos
;
3846 /* No face change past the end of the string (for the case
3847 we are padding with spaces). No face change before the
3849 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3850 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3855 /* Set charpos to the position before or after IT's current
3856 position, in the logical order, which in the non-bidi
3857 case is the same as the visual order. */
3859 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3860 else if (it
->what
== IT_COMPOSITION
)
3861 /* For composition, we must check the character after the
3863 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3865 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3871 /* With bidi iteration, the character before the current
3872 in the visual order cannot be found by simple
3873 iteration, because "reverse" reordering is not
3874 supported. Instead, we need to use the move_it_*
3875 family of functions. */
3876 /* Ignore face changes before the first visible
3877 character on this display line. */
3878 if (it
->current_x
<= it
->first_visible_x
)
3880 SAVE_IT (it_copy
, *it
, it_copy_data
);
3881 /* Implementation note: Since move_it_in_display_line
3882 works in the iterator geometry, and thinks the first
3883 character is always the leftmost, even in R2L lines,
3884 we don't need to distinguish between the R2L and L2R
3886 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3887 it_copy
.current_x
- 1, MOVE_TO_X
);
3888 charpos
= IT_STRING_CHARPOS (it_copy
);
3889 RESTORE_IT (it
, it
, it_copy_data
);
3893 /* Set charpos to the string position of the character
3894 that comes after IT's current position in the visual
3896 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3900 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3902 charpos
= it_copy
.bidi_it
.charpos
;
3905 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3907 if (it
->current
.overlay_string_index
>= 0)
3908 bufpos
= IT_CHARPOS (*it
);
3912 base_face_id
= underlying_face_id (it
);
3914 /* Get the face for ASCII, or unibyte. */
3915 face_id
= face_at_string_position (it
->w
,
3919 it
->region_beg_charpos
,
3920 it
->region_end_charpos
,
3921 &next_check_charpos
,
3924 /* Correct the face for charsets different from ASCII. Do it
3925 for the multibyte case only. The face returned above is
3926 suitable for unibyte text if IT->string is unibyte. */
3927 if (STRING_MULTIBYTE (it
->string
))
3929 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3930 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3932 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3934 c
= string_char_and_length (p
, &len
);
3935 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3940 struct text_pos pos
;
3942 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3943 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3946 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3947 pos
= it
->current
.pos
;
3952 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3955 if (it
->what
== IT_COMPOSITION
)
3957 /* For composition, we must check the position after
3959 pos
.charpos
+= it
->cmp_it
.nchars
;
3960 pos
.bytepos
+= it
->len
;
3963 INC_TEXT_POS (pos
, it
->multibyte_p
);
3970 /* With bidi iteration, the character before the current
3971 in the visual order cannot be found by simple
3972 iteration, because "reverse" reordering is not
3973 supported. Instead, we need to use the move_it_*
3974 family of functions. */
3975 /* Ignore face changes before the first visible
3976 character on this display line. */
3977 if (it
->current_x
<= it
->first_visible_x
)
3979 SAVE_IT (it_copy
, *it
, it_copy_data
);
3980 /* Implementation note: Since move_it_in_display_line
3981 works in the iterator geometry, and thinks the first
3982 character is always the leftmost, even in R2L lines,
3983 we don't need to distinguish between the R2L and L2R
3985 move_it_in_display_line (&it_copy
, ZV
,
3986 it_copy
.current_x
- 1, MOVE_TO_X
);
3987 pos
= it_copy
.current
.pos
;
3988 RESTORE_IT (it
, it
, it_copy_data
);
3992 /* Set charpos to the buffer position of the character
3993 that comes after IT's current position in the visual
3995 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3999 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4002 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4005 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4007 /* Determine face for CHARSET_ASCII, or unibyte. */
4008 face_id
= face_at_buffer_position (it
->w
,
4010 it
->region_beg_charpos
,
4011 it
->region_end_charpos
,
4012 &next_check_charpos
,
4015 /* Correct the face for charsets different from ASCII. Do it
4016 for the multibyte case only. The face returned above is
4017 suitable for unibyte text if current_buffer is unibyte. */
4018 if (it
->multibyte_p
)
4020 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4021 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4022 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4031 /***********************************************************************
4033 ***********************************************************************/
4035 /* Set up iterator IT from invisible properties at its current
4036 position. Called from handle_stop. */
4038 static enum prop_handled
4039 handle_invisible_prop (struct it
*it
)
4041 enum prop_handled handled
= HANDLED_NORMALLY
;
4043 if (STRINGP (it
->string
))
4045 Lisp_Object prop
, end_charpos
, limit
, charpos
;
4047 /* Get the value of the invisible text property at the
4048 current position. Value will be nil if there is no such
4050 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4051 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4054 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4058 handled
= HANDLED_RECOMPUTE_PROPS
;
4060 /* Get the position at which the next change of the
4061 invisible text property can be found in IT->string.
4062 Value will be nil if the property value is the same for
4063 all the rest of IT->string. */
4064 XSETINT (limit
, SCHARS (it
->string
));
4065 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4068 /* Text at current position is invisible. The next
4069 change in the property is at position end_charpos.
4070 Move IT's current position to that position. */
4071 if (INTEGERP (end_charpos
)
4072 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
4074 struct text_pos old
;
4077 old
= it
->current
.string_pos
;
4078 oldpos
= CHARPOS (old
);
4081 if (it
->bidi_it
.first_elt
4082 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4083 bidi_paragraph_init (it
->paragraph_embedding
,
4085 /* Bidi-iterate out of the invisible text. */
4088 bidi_move_to_visually_next (&it
->bidi_it
);
4090 while (oldpos
<= it
->bidi_it
.charpos
4091 && it
->bidi_it
.charpos
< endpos
);
4093 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4094 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4095 if (IT_CHARPOS (*it
) >= endpos
)
4096 it
->prev_stop
= endpos
;
4100 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4101 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4106 /* The rest of the string is invisible. If this is an
4107 overlay string, proceed with the next overlay string
4108 or whatever comes and return a character from there. */
4109 if (it
->current
.overlay_string_index
>= 0)
4111 next_overlay_string (it
);
4112 /* Don't check for overlay strings when we just
4113 finished processing them. */
4114 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4118 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4119 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4127 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4128 Lisp_Object pos
, prop
, overlay
;
4130 /* First of all, is there invisible text at this position? */
4131 tem
= start_charpos
= IT_CHARPOS (*it
);
4132 pos
= make_number (tem
);
4133 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4135 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4137 /* If we are on invisible text, skip over it. */
4138 if (invis_p
&& start_charpos
< it
->end_charpos
)
4140 /* Record whether we have to display an ellipsis for the
4142 int display_ellipsis_p
= invis_p
== 2;
4144 handled
= HANDLED_RECOMPUTE_PROPS
;
4146 /* Loop skipping over invisible text. The loop is left at
4147 ZV or with IT on the first char being visible again. */
4150 /* Try to skip some invisible text. Return value is the
4151 position reached which can be equal to where we start
4152 if there is nothing invisible there. This skips both
4153 over invisible text properties and overlays with
4154 invisible property. */
4155 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4157 /* If we skipped nothing at all we weren't at invisible
4158 text in the first place. If everything to the end of
4159 the buffer was skipped, end the loop. */
4160 if (newpos
== tem
|| newpos
>= ZV
)
4164 /* We skipped some characters but not necessarily
4165 all there are. Check if we ended up on visible
4166 text. Fget_char_property returns the property of
4167 the char before the given position, i.e. if we
4168 get invis_p = 0, this means that the char at
4169 newpos is visible. */
4170 pos
= make_number (newpos
);
4171 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4172 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4175 /* If we ended up on invisible text, proceed to
4176 skip starting with next_stop. */
4180 /* If there are adjacent invisible texts, don't lose the
4181 second one's ellipsis. */
4183 display_ellipsis_p
= 1;
4187 /* The position newpos is now either ZV or on visible text. */
4190 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4192 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4194 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4196 /* If the invisible text ends on a newline or on a
4197 character after a newline, we can avoid the costly,
4198 character by character, bidi iteration to NEWPOS, and
4199 instead simply reseat the iterator there. That's
4200 because all bidi reordering information is tossed at
4201 the newline. This is a big win for modes that hide
4202 complete lines, like Outline, Org, etc. */
4203 if (on_newline
|| after_newline
)
4205 struct text_pos tpos
;
4206 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4208 SET_TEXT_POS (tpos
, newpos
, bpos
);
4209 reseat_1 (it
, tpos
, 0);
4210 /* If we reseat on a newline/ZV, we need to prep the
4211 bidi iterator for advancing to the next character
4212 after the newline/EOB, keeping the current paragraph
4213 direction (so that PRODUCE_GLYPHS does TRT wrt
4214 prepending/appending glyphs to a glyph row). */
4217 it
->bidi_it
.first_elt
= 0;
4218 it
->bidi_it
.paragraph_dir
= pdir
;
4219 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4220 it
->bidi_it
.nchars
= 1;
4221 it
->bidi_it
.ch_len
= 1;
4224 else /* Must use the slow method. */
4226 /* With bidi iteration, the region of invisible text
4227 could start and/or end in the middle of a
4228 non-base embedding level. Therefore, we need to
4229 skip invisible text using the bidi iterator,
4230 starting at IT's current position, until we find
4231 ourselves outside of the invisible text.
4232 Skipping invisible text _after_ bidi iteration
4233 avoids affecting the visual order of the
4234 displayed text when invisible properties are
4235 added or removed. */
4236 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4238 /* If we were `reseat'ed to a new paragraph,
4239 determine the paragraph base direction. We
4240 need to do it now because
4241 next_element_from_buffer may not have a
4242 chance to do it, if we are going to skip any
4243 text at the beginning, which resets the
4245 bidi_paragraph_init (it
->paragraph_embedding
,
4250 bidi_move_to_visually_next (&it
->bidi_it
);
4252 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4253 && it
->bidi_it
.charpos
< newpos
);
4254 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4255 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4256 /* If we overstepped NEWPOS, record its position in
4257 the iterator, so that we skip invisible text if
4258 later the bidi iteration lands us in the
4259 invisible region again. */
4260 if (IT_CHARPOS (*it
) >= newpos
)
4261 it
->prev_stop
= newpos
;
4266 IT_CHARPOS (*it
) = newpos
;
4267 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4270 /* If there are before-strings at the start of invisible
4271 text, and the text is invisible because of a text
4272 property, arrange to show before-strings because 20.x did
4273 it that way. (If the text is invisible because of an
4274 overlay property instead of a text property, this is
4275 already handled in the overlay code.) */
4277 && get_overlay_strings (it
, it
->stop_charpos
))
4279 handled
= HANDLED_RECOMPUTE_PROPS
;
4280 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4282 else if (display_ellipsis_p
)
4284 /* Make sure that the glyphs of the ellipsis will get
4285 correct `charpos' values. If we would not update
4286 it->position here, the glyphs would belong to the
4287 last visible character _before_ the invisible
4288 text, which confuses `set_cursor_from_row'.
4290 We use the last invisible position instead of the
4291 first because this way the cursor is always drawn on
4292 the first "." of the ellipsis, whenever PT is inside
4293 the invisible text. Otherwise the cursor would be
4294 placed _after_ the ellipsis when the point is after the
4295 first invisible character. */
4296 if (!STRINGP (it
->object
))
4298 it
->position
.charpos
= newpos
- 1;
4299 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4302 /* Let the ellipsis display before
4303 considering any properties of the following char.
4304 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4305 handled
= HANDLED_RETURN
;
4314 /* Make iterator IT return `...' next.
4315 Replaces LEN characters from buffer. */
4318 setup_for_ellipsis (struct it
*it
, int len
)
4320 /* Use the display table definition for `...'. Invalid glyphs
4321 will be handled by the method returning elements from dpvec. */
4322 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4324 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4325 it
->dpvec
= v
->contents
;
4326 it
->dpend
= v
->contents
+ v
->header
.size
;
4330 /* Default `...'. */
4331 it
->dpvec
= default_invis_vector
;
4332 it
->dpend
= default_invis_vector
+ 3;
4335 it
->dpvec_char_len
= len
;
4336 it
->current
.dpvec_index
= 0;
4337 it
->dpvec_face_id
= -1;
4339 /* Remember the current face id in case glyphs specify faces.
4340 IT's face is restored in set_iterator_to_next.
4341 saved_face_id was set to preceding char's face in handle_stop. */
4342 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4343 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4345 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4351 /***********************************************************************
4353 ***********************************************************************/
4355 /* Set up iterator IT from `display' property at its current position.
4356 Called from handle_stop.
4357 We return HANDLED_RETURN if some part of the display property
4358 overrides the display of the buffer text itself.
4359 Otherwise we return HANDLED_NORMALLY. */
4361 static enum prop_handled
4362 handle_display_prop (struct it
*it
)
4364 Lisp_Object propval
, object
, overlay
;
4365 struct text_pos
*position
;
4367 /* Nonzero if some property replaces the display of the text itself. */
4368 int display_replaced_p
= 0;
4370 if (STRINGP (it
->string
))
4372 object
= it
->string
;
4373 position
= &it
->current
.string_pos
;
4374 bufpos
= CHARPOS (it
->current
.pos
);
4378 XSETWINDOW (object
, it
->w
);
4379 position
= &it
->current
.pos
;
4380 bufpos
= CHARPOS (*position
);
4383 /* Reset those iterator values set from display property values. */
4384 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4385 it
->space_width
= Qnil
;
4386 it
->font_height
= Qnil
;
4389 /* We don't support recursive `display' properties, i.e. string
4390 values that have a string `display' property, that have a string
4391 `display' property etc. */
4392 if (!it
->string_from_display_prop_p
)
4393 it
->area
= TEXT_AREA
;
4395 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4396 Qdisplay
, object
, &overlay
);
4398 return HANDLED_NORMALLY
;
4399 /* Now OVERLAY is the overlay that gave us this property, or nil
4400 if it was a text property. */
4402 if (!STRINGP (it
->string
))
4403 object
= it
->w
->buffer
;
4405 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4407 FRAME_WINDOW_P (it
->f
));
4409 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4412 /* Subroutine of handle_display_prop. Returns non-zero if the display
4413 specification in SPEC is a replacing specification, i.e. it would
4414 replace the text covered by `display' property with something else,
4415 such as an image or a display string. If SPEC includes any kind or
4416 `(space ...) specification, the value is 2; this is used by
4417 compute_display_string_pos, which see.
4419 See handle_single_display_spec for documentation of arguments.
4420 frame_window_p is non-zero if the window being redisplayed is on a
4421 GUI frame; this argument is used only if IT is NULL, see below.
4423 IT can be NULL, if this is called by the bidi reordering code
4424 through compute_display_string_pos, which see. In that case, this
4425 function only examines SPEC, but does not otherwise "handle" it, in
4426 the sense that it doesn't set up members of IT from the display
4429 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4430 Lisp_Object overlay
, struct text_pos
*position
,
4431 ptrdiff_t bufpos
, int frame_window_p
)
4433 int replacing_p
= 0;
4437 /* Simple specifications. */
4438 && !EQ (XCAR (spec
), Qimage
)
4439 && !EQ (XCAR (spec
), Qspace
)
4440 && !EQ (XCAR (spec
), Qwhen
)
4441 && !EQ (XCAR (spec
), Qslice
)
4442 && !EQ (XCAR (spec
), Qspace_width
)
4443 && !EQ (XCAR (spec
), Qheight
)
4444 && !EQ (XCAR (spec
), Qraise
)
4445 /* Marginal area specifications. */
4446 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4447 && !EQ (XCAR (spec
), Qleft_fringe
)
4448 && !EQ (XCAR (spec
), Qright_fringe
)
4449 && !NILP (XCAR (spec
)))
4451 for (; CONSP (spec
); spec
= XCDR (spec
))
4453 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4454 overlay
, position
, bufpos
,
4455 replacing_p
, frame_window_p
)))
4458 /* If some text in a string is replaced, `position' no
4459 longer points to the position of `object'. */
4460 if (!it
|| STRINGP (object
))
4465 else if (VECTORP (spec
))
4468 for (i
= 0; i
< ASIZE (spec
); ++i
)
4469 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4470 overlay
, position
, bufpos
,
4471 replacing_p
, frame_window_p
)))
4474 /* If some text in a string is replaced, `position' no
4475 longer points to the position of `object'. */
4476 if (!it
|| STRINGP (object
))
4482 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4483 position
, bufpos
, 0,
4491 /* Value is the position of the end of the `display' property starting
4492 at START_POS in OBJECT. */
4494 static struct text_pos
4495 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4498 struct text_pos end_pos
;
4500 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4501 Qdisplay
, object
, Qnil
);
4502 CHARPOS (end_pos
) = XFASTINT (end
);
4503 if (STRINGP (object
))
4504 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4506 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4512 /* Set up IT from a single `display' property specification SPEC. OBJECT
4513 is the object in which the `display' property was found. *POSITION
4514 is the position in OBJECT at which the `display' property was found.
4515 BUFPOS is the buffer position of OBJECT (different from POSITION if
4516 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4517 previously saw a display specification which already replaced text
4518 display with something else, for example an image; we ignore such
4519 properties after the first one has been processed.
4521 OVERLAY is the overlay this `display' property came from,
4522 or nil if it was a text property.
4524 If SPEC is a `space' or `image' specification, and in some other
4525 cases too, set *POSITION to the position where the `display'
4528 If IT is NULL, only examine the property specification in SPEC, but
4529 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4530 is intended to be displayed in a window on a GUI frame.
4532 Value is non-zero if something was found which replaces the display
4533 of buffer or string text. */
4536 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4537 Lisp_Object overlay
, struct text_pos
*position
,
4538 ptrdiff_t bufpos
, int display_replaced_p
,
4542 Lisp_Object location
, value
;
4543 struct text_pos start_pos
= *position
;
4546 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4547 If the result is non-nil, use VALUE instead of SPEC. */
4549 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4558 if (!NILP (form
) && !EQ (form
, Qt
))
4560 ptrdiff_t count
= SPECPDL_INDEX ();
4561 struct gcpro gcpro1
;
4563 /* Bind `object' to the object having the `display' property, a
4564 buffer or string. Bind `position' to the position in the
4565 object where the property was found, and `buffer-position'
4566 to the current position in the buffer. */
4569 XSETBUFFER (object
, current_buffer
);
4570 specbind (Qobject
, object
);
4571 specbind (Qposition
, make_number (CHARPOS (*position
)));
4572 specbind (Qbuffer_position
, make_number (bufpos
));
4574 form
= safe_eval (form
);
4576 unbind_to (count
, Qnil
);
4582 /* Handle `(height HEIGHT)' specifications. */
4584 && EQ (XCAR (spec
), Qheight
)
4585 && CONSP (XCDR (spec
)))
4589 if (!FRAME_WINDOW_P (it
->f
))
4592 it
->font_height
= XCAR (XCDR (spec
));
4593 if (!NILP (it
->font_height
))
4595 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4596 int new_height
= -1;
4598 if (CONSP (it
->font_height
)
4599 && (EQ (XCAR (it
->font_height
), Qplus
)
4600 || EQ (XCAR (it
->font_height
), Qminus
))
4601 && CONSP (XCDR (it
->font_height
))
4602 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4604 /* `(+ N)' or `(- N)' where N is an integer. */
4605 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4606 if (EQ (XCAR (it
->font_height
), Qplus
))
4608 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4610 else if (FUNCTIONP (it
->font_height
))
4612 /* Call function with current height as argument.
4613 Value is the new height. */
4615 height
= safe_call1 (it
->font_height
,
4616 face
->lface
[LFACE_HEIGHT_INDEX
]);
4617 if (NUMBERP (height
))
4618 new_height
= XFLOATINT (height
);
4620 else if (NUMBERP (it
->font_height
))
4622 /* Value is a multiple of the canonical char height. */
4625 f
= FACE_FROM_ID (it
->f
,
4626 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4627 new_height
= (XFLOATINT (it
->font_height
)
4628 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4632 /* Evaluate IT->font_height with `height' bound to the
4633 current specified height to get the new height. */
4634 ptrdiff_t count
= SPECPDL_INDEX ();
4636 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4637 value
= safe_eval (it
->font_height
);
4638 unbind_to (count
, Qnil
);
4640 if (NUMBERP (value
))
4641 new_height
= XFLOATINT (value
);
4645 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4652 /* Handle `(space-width WIDTH)'. */
4654 && EQ (XCAR (spec
), Qspace_width
)
4655 && CONSP (XCDR (spec
)))
4659 if (!FRAME_WINDOW_P (it
->f
))
4662 value
= XCAR (XCDR (spec
));
4663 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4664 it
->space_width
= value
;
4670 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4672 && EQ (XCAR (spec
), Qslice
))
4678 if (!FRAME_WINDOW_P (it
->f
))
4681 if (tem
= XCDR (spec
), CONSP (tem
))
4683 it
->slice
.x
= XCAR (tem
);
4684 if (tem
= XCDR (tem
), CONSP (tem
))
4686 it
->slice
.y
= XCAR (tem
);
4687 if (tem
= XCDR (tem
), CONSP (tem
))
4689 it
->slice
.width
= XCAR (tem
);
4690 if (tem
= XCDR (tem
), CONSP (tem
))
4691 it
->slice
.height
= XCAR (tem
);
4700 /* Handle `(raise FACTOR)'. */
4702 && EQ (XCAR (spec
), Qraise
)
4703 && CONSP (XCDR (spec
)))
4707 if (!FRAME_WINDOW_P (it
->f
))
4710 #ifdef HAVE_WINDOW_SYSTEM
4711 value
= XCAR (XCDR (spec
));
4712 if (NUMBERP (value
))
4714 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4715 it
->voffset
= - (XFLOATINT (value
)
4716 * (FONT_HEIGHT (face
->font
)));
4718 #endif /* HAVE_WINDOW_SYSTEM */
4724 /* Don't handle the other kinds of display specifications
4725 inside a string that we got from a `display' property. */
4726 if (it
&& it
->string_from_display_prop_p
)
4729 /* Characters having this form of property are not displayed, so
4730 we have to find the end of the property. */
4733 start_pos
= *position
;
4734 *position
= display_prop_end (it
, object
, start_pos
);
4738 /* Stop the scan at that end position--we assume that all
4739 text properties change there. */
4741 it
->stop_charpos
= position
->charpos
;
4743 /* Handle `(left-fringe BITMAP [FACE])'
4744 and `(right-fringe BITMAP [FACE])'. */
4746 && (EQ (XCAR (spec
), Qleft_fringe
)
4747 || EQ (XCAR (spec
), Qright_fringe
))
4748 && CONSP (XCDR (spec
)))
4754 if (!FRAME_WINDOW_P (it
->f
))
4755 /* If we return here, POSITION has been advanced
4756 across the text with this property. */
4758 /* Synchronize the bidi iterator with POSITION. This is
4759 needed because we are not going to push the iterator
4760 on behalf of this display property, so there will be
4761 no pop_it call to do this synchronization for us. */
4764 it
->position
= *position
;
4765 iterate_out_of_display_property (it
);
4766 *position
= it
->position
;
4771 else if (!frame_window_p
)
4774 #ifdef HAVE_WINDOW_SYSTEM
4775 value
= XCAR (XCDR (spec
));
4776 if (!SYMBOLP (value
)
4777 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4778 /* If we return here, POSITION has been advanced
4779 across the text with this property. */
4781 if (it
&& it
->bidi_p
)
4783 it
->position
= *position
;
4784 iterate_out_of_display_property (it
);
4785 *position
= it
->position
;
4792 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4794 if (CONSP (XCDR (XCDR (spec
))))
4796 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4797 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4803 /* Save current settings of IT so that we can restore them
4804 when we are finished with the glyph property value. */
4805 push_it (it
, position
);
4807 it
->area
= TEXT_AREA
;
4808 it
->what
= IT_IMAGE
;
4809 it
->image_id
= -1; /* no image */
4810 it
->position
= start_pos
;
4811 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4812 it
->method
= GET_FROM_IMAGE
;
4813 it
->from_overlay
= Qnil
;
4814 it
->face_id
= face_id
;
4815 it
->from_disp_prop_p
= 1;
4817 /* Say that we haven't consumed the characters with
4818 `display' property yet. The call to pop_it in
4819 set_iterator_to_next will clean this up. */
4820 *position
= start_pos
;
4822 if (EQ (XCAR (spec
), Qleft_fringe
))
4824 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4825 it
->left_user_fringe_face_id
= face_id
;
4829 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4830 it
->right_user_fringe_face_id
= face_id
;
4833 #endif /* HAVE_WINDOW_SYSTEM */
4837 /* Prepare to handle `((margin left-margin) ...)',
4838 `((margin right-margin) ...)' and `((margin nil) ...)'
4839 prefixes for display specifications. */
4840 location
= Qunbound
;
4841 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4845 value
= XCDR (spec
);
4847 value
= XCAR (value
);
4850 if (EQ (XCAR (tem
), Qmargin
)
4851 && (tem
= XCDR (tem
),
4852 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4854 || EQ (tem
, Qleft_margin
)
4855 || EQ (tem
, Qright_margin
))))
4859 if (EQ (location
, Qunbound
))
4865 /* After this point, VALUE is the property after any
4866 margin prefix has been stripped. It must be a string,
4867 an image specification, or `(space ...)'.
4869 LOCATION specifies where to display: `left-margin',
4870 `right-margin' or nil. */
4872 valid_p
= (STRINGP (value
)
4873 #ifdef HAVE_WINDOW_SYSTEM
4874 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4875 && valid_image_p (value
))
4876 #endif /* not HAVE_WINDOW_SYSTEM */
4877 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4879 if (valid_p
&& !display_replaced_p
)
4885 /* Callers need to know whether the display spec is any kind
4886 of `(space ...)' spec that is about to affect text-area
4888 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4893 /* Save current settings of IT so that we can restore them
4894 when we are finished with the glyph property value. */
4895 push_it (it
, position
);
4896 it
->from_overlay
= overlay
;
4897 it
->from_disp_prop_p
= 1;
4899 if (NILP (location
))
4900 it
->area
= TEXT_AREA
;
4901 else if (EQ (location
, Qleft_margin
))
4902 it
->area
= LEFT_MARGIN_AREA
;
4904 it
->area
= RIGHT_MARGIN_AREA
;
4906 if (STRINGP (value
))
4909 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4910 it
->current
.overlay_string_index
= -1;
4911 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4912 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4913 it
->method
= GET_FROM_STRING
;
4914 it
->stop_charpos
= 0;
4916 it
->base_level_stop
= 0;
4917 it
->string_from_display_prop_p
= 1;
4918 /* Say that we haven't consumed the characters with
4919 `display' property yet. The call to pop_it in
4920 set_iterator_to_next will clean this up. */
4921 if (BUFFERP (object
))
4922 *position
= start_pos
;
4924 /* Force paragraph direction to be that of the parent
4925 object. If the parent object's paragraph direction is
4926 not yet determined, default to L2R. */
4927 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4928 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4930 it
->paragraph_embedding
= L2R
;
4932 /* Set up the bidi iterator for this display string. */
4935 it
->bidi_it
.string
.lstring
= it
->string
;
4936 it
->bidi_it
.string
.s
= NULL
;
4937 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4938 it
->bidi_it
.string
.bufpos
= bufpos
;
4939 it
->bidi_it
.string
.from_disp_str
= 1;
4940 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4941 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4944 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4946 it
->method
= GET_FROM_STRETCH
;
4948 *position
= it
->position
= start_pos
;
4949 retval
= 1 + (it
->area
== TEXT_AREA
);
4951 #ifdef HAVE_WINDOW_SYSTEM
4954 it
->what
= IT_IMAGE
;
4955 it
->image_id
= lookup_image (it
->f
, value
);
4956 it
->position
= start_pos
;
4957 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4958 it
->method
= GET_FROM_IMAGE
;
4960 /* Say that we haven't consumed the characters with
4961 `display' property yet. The call to pop_it in
4962 set_iterator_to_next will clean this up. */
4963 *position
= start_pos
;
4965 #endif /* HAVE_WINDOW_SYSTEM */
4970 /* Invalid property or property not supported. Restore
4971 POSITION to what it was before. */
4972 *position
= start_pos
;
4976 /* Check if PROP is a display property value whose text should be
4977 treated as intangible. OVERLAY is the overlay from which PROP
4978 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4979 specify the buffer position covered by PROP. */
4982 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4983 ptrdiff_t charpos
, ptrdiff_t bytepos
)
4985 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4986 struct text_pos position
;
4988 SET_TEXT_POS (position
, charpos
, bytepos
);
4989 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4990 &position
, charpos
, frame_window_p
);
4994 /* Return 1 if PROP is a display sub-property value containing STRING.
4996 Implementation note: this and the following function are really
4997 special cases of handle_display_spec and
4998 handle_single_display_spec, and should ideally use the same code.
4999 Until they do, these two pairs must be consistent and must be
5000 modified in sync. */
5003 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5005 if (EQ (string
, prop
))
5008 /* Skip over `when FORM'. */
5009 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5014 /* Actually, the condition following `when' should be eval'ed,
5015 like handle_single_display_spec does, and we should return
5016 zero if it evaluates to nil. However, this function is
5017 called only when the buffer was already displayed and some
5018 glyph in the glyph matrix was found to come from a display
5019 string. Therefore, the condition was already evaluated, and
5020 the result was non-nil, otherwise the display string wouldn't
5021 have been displayed and we would have never been called for
5022 this property. Thus, we can skip the evaluation and assume
5023 its result is non-nil. */
5028 /* Skip over `margin LOCATION'. */
5029 if (EQ (XCAR (prop
), Qmargin
))
5040 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5044 /* Return 1 if STRING appears in the `display' property PROP. */
5047 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5050 && !EQ (XCAR (prop
), Qwhen
)
5051 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5053 /* A list of sub-properties. */
5054 while (CONSP (prop
))
5056 if (single_display_spec_string_p (XCAR (prop
), string
))
5061 else if (VECTORP (prop
))
5063 /* A vector of sub-properties. */
5065 for (i
= 0; i
< ASIZE (prop
); ++i
)
5066 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5070 return single_display_spec_string_p (prop
, string
);
5075 /* Look for STRING in overlays and text properties in the current
5076 buffer, between character positions FROM and TO (excluding TO).
5077 BACK_P non-zero means look back (in this case, TO is supposed to be
5079 Value is the first character position where STRING was found, or
5080 zero if it wasn't found before hitting TO.
5082 This function may only use code that doesn't eval because it is
5083 called asynchronously from note_mouse_highlight. */
5086 string_buffer_position_lim (Lisp_Object string
,
5087 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5089 Lisp_Object limit
, prop
, pos
;
5092 pos
= make_number (max (from
, BEGV
));
5094 if (!back_p
) /* looking forward */
5096 limit
= make_number (min (to
, ZV
));
5097 while (!found
&& !EQ (pos
, limit
))
5099 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5100 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5103 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5107 else /* looking back */
5109 limit
= make_number (max (to
, BEGV
));
5110 while (!found
&& !EQ (pos
, limit
))
5112 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5113 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5116 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5121 return found
? XINT (pos
) : 0;
5124 /* Determine which buffer position in current buffer STRING comes from.
5125 AROUND_CHARPOS is an approximate position where it could come from.
5126 Value is the buffer position or 0 if it couldn't be determined.
5128 This function is necessary because we don't record buffer positions
5129 in glyphs generated from strings (to keep struct glyph small).
5130 This function may only use code that doesn't eval because it is
5131 called asynchronously from note_mouse_highlight. */
5134 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5136 const int MAX_DISTANCE
= 1000;
5137 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5138 around_charpos
+ MAX_DISTANCE
,
5142 found
= string_buffer_position_lim (string
, around_charpos
,
5143 around_charpos
- MAX_DISTANCE
, 1);
5149 /***********************************************************************
5150 `composition' property
5151 ***********************************************************************/
5153 /* Set up iterator IT from `composition' property at its current
5154 position. Called from handle_stop. */
5156 static enum prop_handled
5157 handle_composition_prop (struct it
*it
)
5159 Lisp_Object prop
, string
;
5160 ptrdiff_t pos
, pos_byte
, start
, end
;
5162 if (STRINGP (it
->string
))
5166 pos
= IT_STRING_CHARPOS (*it
);
5167 pos_byte
= IT_STRING_BYTEPOS (*it
);
5168 string
= it
->string
;
5169 s
= SDATA (string
) + pos_byte
;
5170 it
->c
= STRING_CHAR (s
);
5174 pos
= IT_CHARPOS (*it
);
5175 pos_byte
= IT_BYTEPOS (*it
);
5177 it
->c
= FETCH_CHAR (pos_byte
);
5180 /* If there's a valid composition and point is not inside of the
5181 composition (in the case that the composition is from the current
5182 buffer), draw a glyph composed from the composition components. */
5183 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5184 && COMPOSITION_VALID_P (start
, end
, prop
)
5185 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5188 /* As we can't handle this situation (perhaps font-lock added
5189 a new composition), we just return here hoping that next
5190 redisplay will detect this composition much earlier. */
5191 return HANDLED_NORMALLY
;
5194 if (STRINGP (it
->string
))
5195 pos_byte
= string_char_to_byte (it
->string
, start
);
5197 pos_byte
= CHAR_TO_BYTE (start
);
5199 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5202 if (it
->cmp_it
.id
>= 0)
5205 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5206 it
->cmp_it
.nglyphs
= -1;
5210 return HANDLED_NORMALLY
;
5215 /***********************************************************************
5217 ***********************************************************************/
5219 /* The following structure is used to record overlay strings for
5220 later sorting in load_overlay_strings. */
5222 struct overlay_entry
5224 Lisp_Object overlay
;
5231 /* Set up iterator IT from overlay strings at its current position.
5232 Called from handle_stop. */
5234 static enum prop_handled
5235 handle_overlay_change (struct it
*it
)
5237 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5238 return HANDLED_RECOMPUTE_PROPS
;
5240 return HANDLED_NORMALLY
;
5244 /* Set up the next overlay string for delivery by IT, if there is an
5245 overlay string to deliver. Called by set_iterator_to_next when the
5246 end of the current overlay string is reached. If there are more
5247 overlay strings to display, IT->string and
5248 IT->current.overlay_string_index are set appropriately here.
5249 Otherwise IT->string is set to nil. */
5252 next_overlay_string (struct it
*it
)
5254 ++it
->current
.overlay_string_index
;
5255 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5257 /* No more overlay strings. Restore IT's settings to what
5258 they were before overlay strings were processed, and
5259 continue to deliver from current_buffer. */
5261 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5264 || (NILP (it
->string
)
5265 && it
->method
== GET_FROM_BUFFER
5266 && it
->stop_charpos
>= BEGV
5267 && it
->stop_charpos
<= it
->end_charpos
));
5268 it
->current
.overlay_string_index
= -1;
5269 it
->n_overlay_strings
= 0;
5270 it
->overlay_strings_charpos
= -1;
5271 /* If there's an empty display string on the stack, pop the
5272 stack, to resync the bidi iterator with IT's position. Such
5273 empty strings are pushed onto the stack in
5274 get_overlay_strings_1. */
5275 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5278 /* If we're at the end of the buffer, record that we have
5279 processed the overlay strings there already, so that
5280 next_element_from_buffer doesn't try it again. */
5281 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5282 it
->overlay_strings_at_end_processed_p
= 1;
5286 /* There are more overlay strings to process. If
5287 IT->current.overlay_string_index has advanced to a position
5288 where we must load IT->overlay_strings with more strings, do
5289 it. We must load at the IT->overlay_strings_charpos where
5290 IT->n_overlay_strings was originally computed; when invisible
5291 text is present, this might not be IT_CHARPOS (Bug#7016). */
5292 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5294 if (it
->current
.overlay_string_index
&& i
== 0)
5295 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5297 /* Initialize IT to deliver display elements from the overlay
5299 it
->string
= it
->overlay_strings
[i
];
5300 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5301 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5302 it
->method
= GET_FROM_STRING
;
5303 it
->stop_charpos
= 0;
5304 if (it
->cmp_it
.stop_pos
>= 0)
5305 it
->cmp_it
.stop_pos
= 0;
5307 it
->base_level_stop
= 0;
5309 /* Set up the bidi iterator for this overlay string. */
5312 it
->bidi_it
.string
.lstring
= it
->string
;
5313 it
->bidi_it
.string
.s
= NULL
;
5314 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5315 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5316 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5317 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5318 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5326 /* Compare two overlay_entry structures E1 and E2. Used as a
5327 comparison function for qsort in load_overlay_strings. Overlay
5328 strings for the same position are sorted so that
5330 1. All after-strings come in front of before-strings, except
5331 when they come from the same overlay.
5333 2. Within after-strings, strings are sorted so that overlay strings
5334 from overlays with higher priorities come first.
5336 2. Within before-strings, strings are sorted so that overlay
5337 strings from overlays with higher priorities come last.
5339 Value is analogous to strcmp. */
5343 compare_overlay_entries (const void *e1
, const void *e2
)
5345 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5346 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5349 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5351 /* Let after-strings appear in front of before-strings if
5352 they come from different overlays. */
5353 if (EQ (entry1
->overlay
, entry2
->overlay
))
5354 result
= entry1
->after_string_p
? 1 : -1;
5356 result
= entry1
->after_string_p
? -1 : 1;
5358 else if (entry1
->priority
!= entry2
->priority
)
5360 if (entry1
->after_string_p
)
5361 /* After-strings sorted in order of decreasing priority. */
5362 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5364 /* Before-strings sorted in order of increasing priority. */
5365 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5374 /* Load the vector IT->overlay_strings with overlay strings from IT's
5375 current buffer position, or from CHARPOS if that is > 0. Set
5376 IT->n_overlays to the total number of overlay strings found.
5378 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5379 a time. On entry into load_overlay_strings,
5380 IT->current.overlay_string_index gives the number of overlay
5381 strings that have already been loaded by previous calls to this
5384 IT->add_overlay_start contains an additional overlay start
5385 position to consider for taking overlay strings from, if non-zero.
5386 This position comes into play when the overlay has an `invisible'
5387 property, and both before and after-strings. When we've skipped to
5388 the end of the overlay, because of its `invisible' property, we
5389 nevertheless want its before-string to appear.
5390 IT->add_overlay_start will contain the overlay start position
5393 Overlay strings are sorted so that after-string strings come in
5394 front of before-string strings. Within before and after-strings,
5395 strings are sorted by overlay priority. See also function
5396 compare_overlay_entries. */
5399 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5401 Lisp_Object overlay
, window
, str
, invisible
;
5402 struct Lisp_Overlay
*ov
;
5403 ptrdiff_t start
, end
;
5404 ptrdiff_t size
= 20;
5405 ptrdiff_t n
= 0, i
, j
;
5407 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5411 charpos
= IT_CHARPOS (*it
);
5413 /* Append the overlay string STRING of overlay OVERLAY to vector
5414 `entries' which has size `size' and currently contains `n'
5415 elements. AFTER_P non-zero means STRING is an after-string of
5417 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5420 Lisp_Object priority; \
5424 struct overlay_entry *old = entries; \
5425 SAFE_NALLOCA (entries, 2, size); \
5426 memcpy (entries, old, size * sizeof *entries); \
5430 entries[n].string = (STRING); \
5431 entries[n].overlay = (OVERLAY); \
5432 priority = Foverlay_get ((OVERLAY), Qpriority); \
5433 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5434 entries[n].after_string_p = (AFTER_P); \
5439 /* Process overlay before the overlay center. */
5440 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5442 XSETMISC (overlay
, ov
);
5443 eassert (OVERLAYP (overlay
));
5444 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5445 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5450 /* Skip this overlay if it doesn't start or end at IT's current
5452 if (end
!= charpos
&& start
!= charpos
)
5455 /* Skip this overlay if it doesn't apply to IT->w. */
5456 window
= Foverlay_get (overlay
, Qwindow
);
5457 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5460 /* If the text ``under'' the overlay is invisible, both before-
5461 and after-strings from this overlay are visible; start and
5462 end position are indistinguishable. */
5463 invisible
= Foverlay_get (overlay
, Qinvisible
);
5464 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5466 /* If overlay has a non-empty before-string, record it. */
5467 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5468 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5470 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5472 /* If overlay has a non-empty after-string, record it. */
5473 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5474 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5476 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5479 /* Process overlays after the overlay center. */
5480 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5482 XSETMISC (overlay
, ov
);
5483 eassert (OVERLAYP (overlay
));
5484 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5485 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5487 if (start
> charpos
)
5490 /* Skip this overlay if it doesn't start or end at IT's current
5492 if (end
!= charpos
&& start
!= charpos
)
5495 /* Skip this overlay if it doesn't apply to IT->w. */
5496 window
= Foverlay_get (overlay
, Qwindow
);
5497 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5500 /* If the text ``under'' the overlay is invisible, it has a zero
5501 dimension, and both before- and after-strings apply. */
5502 invisible
= Foverlay_get (overlay
, Qinvisible
);
5503 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5505 /* If overlay has a non-empty before-string, record it. */
5506 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5507 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5509 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5511 /* If overlay has a non-empty after-string, record it. */
5512 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5513 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5515 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5518 #undef RECORD_OVERLAY_STRING
5522 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5524 /* Record number of overlay strings, and where we computed it. */
5525 it
->n_overlay_strings
= n
;
5526 it
->overlay_strings_charpos
= charpos
;
5528 /* IT->current.overlay_string_index is the number of overlay strings
5529 that have already been consumed by IT. Copy some of the
5530 remaining overlay strings to IT->overlay_strings. */
5532 j
= it
->current
.overlay_string_index
;
5533 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5535 it
->overlay_strings
[i
] = entries
[j
].string
;
5536 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5544 /* Get the first chunk of overlay strings at IT's current buffer
5545 position, or at CHARPOS if that is > 0. Value is non-zero if at
5546 least one overlay string was found. */
5549 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5551 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5552 process. This fills IT->overlay_strings with strings, and sets
5553 IT->n_overlay_strings to the total number of strings to process.
5554 IT->pos.overlay_string_index has to be set temporarily to zero
5555 because load_overlay_strings needs this; it must be set to -1
5556 when no overlay strings are found because a zero value would
5557 indicate a position in the first overlay string. */
5558 it
->current
.overlay_string_index
= 0;
5559 load_overlay_strings (it
, charpos
);
5561 /* If we found overlay strings, set up IT to deliver display
5562 elements from the first one. Otherwise set up IT to deliver
5563 from current_buffer. */
5564 if (it
->n_overlay_strings
)
5566 /* Make sure we know settings in current_buffer, so that we can
5567 restore meaningful values when we're done with the overlay
5570 compute_stop_pos (it
);
5571 eassert (it
->face_id
>= 0);
5573 /* Save IT's settings. They are restored after all overlay
5574 strings have been processed. */
5575 eassert (!compute_stop_p
|| it
->sp
== 0);
5577 /* When called from handle_stop, there might be an empty display
5578 string loaded. In that case, don't bother saving it. But
5579 don't use this optimization with the bidi iterator, since we
5580 need the corresponding pop_it call to resync the bidi
5581 iterator's position with IT's position, after we are done
5582 with the overlay strings. (The corresponding call to pop_it
5583 in case of an empty display string is in
5584 next_overlay_string.) */
5586 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5589 /* Set up IT to deliver display elements from the first overlay
5591 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5592 it
->string
= it
->overlay_strings
[0];
5593 it
->from_overlay
= Qnil
;
5594 it
->stop_charpos
= 0;
5595 eassert (STRINGP (it
->string
));
5596 it
->end_charpos
= SCHARS (it
->string
);
5598 it
->base_level_stop
= 0;
5599 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5600 it
->method
= GET_FROM_STRING
;
5601 it
->from_disp_prop_p
= 0;
5603 /* Force paragraph direction to be that of the parent
5605 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5606 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5608 it
->paragraph_embedding
= L2R
;
5610 /* Set up the bidi iterator for this overlay string. */
5613 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5615 it
->bidi_it
.string
.lstring
= it
->string
;
5616 it
->bidi_it
.string
.s
= NULL
;
5617 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5618 it
->bidi_it
.string
.bufpos
= pos
;
5619 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5620 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5621 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5626 it
->current
.overlay_string_index
= -1;
5631 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5634 it
->method
= GET_FROM_BUFFER
;
5636 (void) get_overlay_strings_1 (it
, charpos
, 1);
5640 /* Value is non-zero if we found at least one overlay string. */
5641 return STRINGP (it
->string
);
5646 /***********************************************************************
5647 Saving and restoring state
5648 ***********************************************************************/
5650 /* Save current settings of IT on IT->stack. Called, for example,
5651 before setting up IT for an overlay string, to be able to restore
5652 IT's settings to what they were after the overlay string has been
5653 processed. If POSITION is non-NULL, it is the position to save on
5654 the stack instead of IT->position. */
5657 push_it (struct it
*it
, struct text_pos
*position
)
5659 struct iterator_stack_entry
*p
;
5661 eassert (it
->sp
< IT_STACK_SIZE
);
5662 p
= it
->stack
+ it
->sp
;
5664 p
->stop_charpos
= it
->stop_charpos
;
5665 p
->prev_stop
= it
->prev_stop
;
5666 p
->base_level_stop
= it
->base_level_stop
;
5667 p
->cmp_it
= it
->cmp_it
;
5668 eassert (it
->face_id
>= 0);
5669 p
->face_id
= it
->face_id
;
5670 p
->string
= it
->string
;
5671 p
->method
= it
->method
;
5672 p
->from_overlay
= it
->from_overlay
;
5675 case GET_FROM_IMAGE
:
5676 p
->u
.image
.object
= it
->object
;
5677 p
->u
.image
.image_id
= it
->image_id
;
5678 p
->u
.image
.slice
= it
->slice
;
5680 case GET_FROM_STRETCH
:
5681 p
->u
.stretch
.object
= it
->object
;
5684 p
->position
= position
? *position
: it
->position
;
5685 p
->current
= it
->current
;
5686 p
->end_charpos
= it
->end_charpos
;
5687 p
->string_nchars
= it
->string_nchars
;
5689 p
->multibyte_p
= it
->multibyte_p
;
5690 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5691 p
->space_width
= it
->space_width
;
5692 p
->font_height
= it
->font_height
;
5693 p
->voffset
= it
->voffset
;
5694 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5695 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5696 p
->display_ellipsis_p
= 0;
5697 p
->line_wrap
= it
->line_wrap
;
5698 p
->bidi_p
= it
->bidi_p
;
5699 p
->paragraph_embedding
= it
->paragraph_embedding
;
5700 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5703 /* Save the state of the bidi iterator as well. */
5705 bidi_push_it (&it
->bidi_it
);
5709 iterate_out_of_display_property (struct it
*it
)
5711 int buffer_p
= !STRINGP (it
->string
);
5712 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5713 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5715 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5717 /* Maybe initialize paragraph direction. If we are at the beginning
5718 of a new paragraph, next_element_from_buffer may not have a
5719 chance to do that. */
5720 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5721 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5722 /* prev_stop can be zero, so check against BEGV as well. */
5723 while (it
->bidi_it
.charpos
>= bob
5724 && it
->prev_stop
<= it
->bidi_it
.charpos
5725 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5726 && it
->bidi_it
.charpos
< eob
)
5727 bidi_move_to_visually_next (&it
->bidi_it
);
5728 /* Record the stop_pos we just crossed, for when we cross it
5730 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5731 it
->prev_stop
= CHARPOS (it
->position
);
5732 /* If we ended up not where pop_it put us, resync IT's
5733 positional members with the bidi iterator. */
5734 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5735 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5737 it
->current
.pos
= it
->position
;
5739 it
->current
.string_pos
= it
->position
;
5742 /* Restore IT's settings from IT->stack. Called, for example, when no
5743 more overlay strings must be processed, and we return to delivering
5744 display elements from a buffer, or when the end of a string from a
5745 `display' property is reached and we return to delivering display
5746 elements from an overlay string, or from a buffer. */
5749 pop_it (struct it
*it
)
5751 struct iterator_stack_entry
*p
;
5752 int from_display_prop
= it
->from_disp_prop_p
;
5754 eassert (it
->sp
> 0);
5756 p
= it
->stack
+ it
->sp
;
5757 it
->stop_charpos
= p
->stop_charpos
;
5758 it
->prev_stop
= p
->prev_stop
;
5759 it
->base_level_stop
= p
->base_level_stop
;
5760 it
->cmp_it
= p
->cmp_it
;
5761 it
->face_id
= p
->face_id
;
5762 it
->current
= p
->current
;
5763 it
->position
= p
->position
;
5764 it
->string
= p
->string
;
5765 it
->from_overlay
= p
->from_overlay
;
5766 if (NILP (it
->string
))
5767 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5768 it
->method
= p
->method
;
5771 case GET_FROM_IMAGE
:
5772 it
->image_id
= p
->u
.image
.image_id
;
5773 it
->object
= p
->u
.image
.object
;
5774 it
->slice
= p
->u
.image
.slice
;
5776 case GET_FROM_STRETCH
:
5777 it
->object
= p
->u
.stretch
.object
;
5779 case GET_FROM_BUFFER
:
5780 it
->object
= it
->w
->buffer
;
5782 case GET_FROM_STRING
:
5783 it
->object
= it
->string
;
5785 case GET_FROM_DISPLAY_VECTOR
:
5787 it
->method
= GET_FROM_C_STRING
;
5788 else if (STRINGP (it
->string
))
5789 it
->method
= GET_FROM_STRING
;
5792 it
->method
= GET_FROM_BUFFER
;
5793 it
->object
= it
->w
->buffer
;
5796 it
->end_charpos
= p
->end_charpos
;
5797 it
->string_nchars
= p
->string_nchars
;
5799 it
->multibyte_p
= p
->multibyte_p
;
5800 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5801 it
->space_width
= p
->space_width
;
5802 it
->font_height
= p
->font_height
;
5803 it
->voffset
= p
->voffset
;
5804 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5805 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5806 it
->line_wrap
= p
->line_wrap
;
5807 it
->bidi_p
= p
->bidi_p
;
5808 it
->paragraph_embedding
= p
->paragraph_embedding
;
5809 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5812 bidi_pop_it (&it
->bidi_it
);
5813 /* Bidi-iterate until we get out of the portion of text, if any,
5814 covered by a `display' text property or by an overlay with
5815 `display' property. (We cannot just jump there, because the
5816 internal coherency of the bidi iterator state can not be
5817 preserved across such jumps.) We also must determine the
5818 paragraph base direction if the overlay we just processed is
5819 at the beginning of a new paragraph. */
5820 if (from_display_prop
5821 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5822 iterate_out_of_display_property (it
);
5824 eassert ((BUFFERP (it
->object
)
5825 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5826 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5827 || (STRINGP (it
->object
)
5828 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5829 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5830 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5836 /***********************************************************************
5838 ***********************************************************************/
5840 /* Set IT's current position to the previous line start. */
5843 back_to_previous_line_start (struct it
*it
)
5845 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5846 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5850 /* Move IT to the next line start.
5852 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5853 we skipped over part of the text (as opposed to moving the iterator
5854 continuously over the text). Otherwise, don't change the value
5857 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5858 iterator on the newline, if it was found.
5860 Newlines may come from buffer text, overlay strings, or strings
5861 displayed via the `display' property. That's the reason we can't
5862 simply use find_next_newline_no_quit.
5864 Note that this function may not skip over invisible text that is so
5865 because of text properties and immediately follows a newline. If
5866 it would, function reseat_at_next_visible_line_start, when called
5867 from set_iterator_to_next, would effectively make invisible
5868 characters following a newline part of the wrong glyph row, which
5869 leads to wrong cursor motion. */
5872 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5873 struct bidi_it
*bidi_it_prev
)
5875 ptrdiff_t old_selective
;
5876 int newline_found_p
, n
;
5877 const int MAX_NEWLINE_DISTANCE
= 500;
5879 /* If already on a newline, just consume it to avoid unintended
5880 skipping over invisible text below. */
5881 if (it
->what
== IT_CHARACTER
5883 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5885 if (it
->bidi_p
&& bidi_it_prev
)
5886 *bidi_it_prev
= it
->bidi_it
;
5887 set_iterator_to_next (it
, 0);
5892 /* Don't handle selective display in the following. It's (a)
5893 unnecessary because it's done by the caller, and (b) leads to an
5894 infinite recursion because next_element_from_ellipsis indirectly
5895 calls this function. */
5896 old_selective
= it
->selective
;
5899 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5900 from buffer text. */
5901 for (n
= newline_found_p
= 0;
5902 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5903 n
+= STRINGP (it
->string
) ? 0 : 1)
5905 if (!get_next_display_element (it
))
5907 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5908 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5909 *bidi_it_prev
= it
->bidi_it
;
5910 set_iterator_to_next (it
, 0);
5913 /* If we didn't find a newline near enough, see if we can use a
5915 if (!newline_found_p
)
5917 ptrdiff_t start
= IT_CHARPOS (*it
);
5918 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5921 eassert (!STRINGP (it
->string
));
5923 /* If there isn't any `display' property in sight, and no
5924 overlays, we can just use the position of the newline in
5926 if (it
->stop_charpos
>= limit
5927 || ((pos
= Fnext_single_property_change (make_number (start
),
5929 make_number (limit
)),
5931 && next_overlay_change (start
) == ZV
))
5935 IT_CHARPOS (*it
) = limit
;
5936 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5940 struct bidi_it bprev
;
5942 /* Help bidi.c avoid expensive searches for display
5943 properties and overlays, by telling it that there are
5944 none up to `limit'. */
5945 if (it
->bidi_it
.disp_pos
< limit
)
5947 it
->bidi_it
.disp_pos
= limit
;
5948 it
->bidi_it
.disp_prop
= 0;
5951 bprev
= it
->bidi_it
;
5952 bidi_move_to_visually_next (&it
->bidi_it
);
5953 } while (it
->bidi_it
.charpos
!= limit
);
5954 IT_CHARPOS (*it
) = limit
;
5955 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5957 *bidi_it_prev
= bprev
;
5959 *skipped_p
= newline_found_p
= 1;
5963 while (get_next_display_element (it
)
5964 && !newline_found_p
)
5966 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5967 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5968 *bidi_it_prev
= it
->bidi_it
;
5969 set_iterator_to_next (it
, 0);
5974 it
->selective
= old_selective
;
5975 return newline_found_p
;
5979 /* Set IT's current position to the previous visible line start. Skip
5980 invisible text that is so either due to text properties or due to
5981 selective display. Caution: this does not change IT->current_x and
5985 back_to_previous_visible_line_start (struct it
*it
)
5987 while (IT_CHARPOS (*it
) > BEGV
)
5989 back_to_previous_line_start (it
);
5991 if (IT_CHARPOS (*it
) <= BEGV
)
5994 /* If selective > 0, then lines indented more than its value are
5996 if (it
->selective
> 0
5997 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6001 /* Check the newline before point for invisibility. */
6004 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6005 Qinvisible
, it
->window
);
6006 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6010 if (IT_CHARPOS (*it
) <= BEGV
)
6015 void *it2data
= NULL
;
6018 Lisp_Object val
, overlay
;
6020 SAVE_IT (it2
, *it
, it2data
);
6022 /* If newline is part of a composition, continue from start of composition */
6023 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6024 && beg
< IT_CHARPOS (*it
))
6027 /* If newline is replaced by a display property, find start of overlay
6028 or interval and continue search from that point. */
6029 pos
= --IT_CHARPOS (it2
);
6032 bidi_unshelve_cache (NULL
, 0);
6033 it2
.string_from_display_prop_p
= 0;
6034 it2
.from_disp_prop_p
= 0;
6035 if (handle_display_prop (&it2
) == HANDLED_RETURN
6036 && !NILP (val
= get_char_property_and_overlay
6037 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6038 && (OVERLAYP (overlay
)
6039 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6040 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6042 RESTORE_IT (it
, it
, it2data
);
6046 /* Newline is not replaced by anything -- so we are done. */
6047 RESTORE_IT (it
, it
, it2data
);
6053 IT_CHARPOS (*it
) = beg
;
6054 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6058 it
->continuation_lines_width
= 0;
6060 eassert (IT_CHARPOS (*it
) >= BEGV
);
6061 eassert (IT_CHARPOS (*it
) == BEGV
6062 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6067 /* Reseat iterator IT at the previous visible line start. Skip
6068 invisible text that is so either due to text properties or due to
6069 selective display. At the end, update IT's overlay information,
6070 face information etc. */
6073 reseat_at_previous_visible_line_start (struct it
*it
)
6075 back_to_previous_visible_line_start (it
);
6076 reseat (it
, it
->current
.pos
, 1);
6081 /* Reseat iterator IT on the next visible line start in the current
6082 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6083 preceding the line start. Skip over invisible text that is so
6084 because of selective display. Compute faces, overlays etc at the
6085 new position. Note that this function does not skip over text that
6086 is invisible because of text properties. */
6089 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6091 int newline_found_p
, skipped_p
= 0;
6092 struct bidi_it bidi_it_prev
;
6094 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6096 /* Skip over lines that are invisible because they are indented
6097 more than the value of IT->selective. */
6098 if (it
->selective
> 0)
6099 while (IT_CHARPOS (*it
) < ZV
6100 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6103 eassert (IT_BYTEPOS (*it
) == BEGV
6104 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6106 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6109 /* Position on the newline if that's what's requested. */
6110 if (on_newline_p
&& newline_found_p
)
6112 if (STRINGP (it
->string
))
6114 if (IT_STRING_CHARPOS (*it
) > 0)
6118 --IT_STRING_CHARPOS (*it
);
6119 --IT_STRING_BYTEPOS (*it
);
6123 /* We need to restore the bidi iterator to the state
6124 it had on the newline, and resync the IT's
6125 position with that. */
6126 it
->bidi_it
= bidi_it_prev
;
6127 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6128 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6132 else if (IT_CHARPOS (*it
) > BEGV
)
6141 /* We need to restore the bidi iterator to the state it
6142 had on the newline and resync IT with that. */
6143 it
->bidi_it
= bidi_it_prev
;
6144 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6145 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6147 reseat (it
, it
->current
.pos
, 0);
6151 reseat (it
, it
->current
.pos
, 0);
6158 /***********************************************************************
6159 Changing an iterator's position
6160 ***********************************************************************/
6162 /* Change IT's current position to POS in current_buffer. If FORCE_P
6163 is non-zero, always check for text properties at the new position.
6164 Otherwise, text properties are only looked up if POS >=
6165 IT->check_charpos of a property. */
6168 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6170 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6172 reseat_1 (it
, pos
, 0);
6174 /* Determine where to check text properties. Avoid doing it
6175 where possible because text property lookup is very expensive. */
6177 || CHARPOS (pos
) > it
->stop_charpos
6178 || CHARPOS (pos
) < original_pos
)
6182 /* For bidi iteration, we need to prime prev_stop and
6183 base_level_stop with our best estimations. */
6184 /* Implementation note: Of course, POS is not necessarily a
6185 stop position, so assigning prev_pos to it is a lie; we
6186 should have called compute_stop_backwards. However, if
6187 the current buffer does not include any R2L characters,
6188 that call would be a waste of cycles, because the
6189 iterator will never move back, and thus never cross this
6190 "fake" stop position. So we delay that backward search
6191 until the time we really need it, in next_element_from_buffer. */
6192 if (CHARPOS (pos
) != it
->prev_stop
)
6193 it
->prev_stop
= CHARPOS (pos
);
6194 if (CHARPOS (pos
) < it
->base_level_stop
)
6195 it
->base_level_stop
= 0; /* meaning it's unknown */
6201 it
->prev_stop
= it
->base_level_stop
= 0;
6210 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6211 IT->stop_pos to POS, also. */
6214 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6216 /* Don't call this function when scanning a C string. */
6217 eassert (it
->s
== NULL
);
6219 /* POS must be a reasonable value. */
6220 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6222 it
->current
.pos
= it
->position
= pos
;
6223 it
->end_charpos
= ZV
;
6225 it
->current
.dpvec_index
= -1;
6226 it
->current
.overlay_string_index
= -1;
6227 IT_STRING_CHARPOS (*it
) = -1;
6228 IT_STRING_BYTEPOS (*it
) = -1;
6230 it
->method
= GET_FROM_BUFFER
;
6231 it
->object
= it
->w
->buffer
;
6232 it
->area
= TEXT_AREA
;
6233 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6235 it
->string_from_display_prop_p
= 0;
6236 it
->string_from_prefix_prop_p
= 0;
6238 it
->from_disp_prop_p
= 0;
6239 it
->face_before_selective_p
= 0;
6242 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6244 bidi_unshelve_cache (NULL
, 0);
6245 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6246 it
->bidi_it
.string
.s
= NULL
;
6247 it
->bidi_it
.string
.lstring
= Qnil
;
6248 it
->bidi_it
.string
.bufpos
= 0;
6249 it
->bidi_it
.string
.unibyte
= 0;
6254 it
->stop_charpos
= CHARPOS (pos
);
6255 it
->base_level_stop
= CHARPOS (pos
);
6260 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6261 If S is non-null, it is a C string to iterate over. Otherwise,
6262 STRING gives a Lisp string to iterate over.
6264 If PRECISION > 0, don't return more then PRECISION number of
6265 characters from the string.
6267 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6268 characters have been returned. FIELD_WIDTH < 0 means an infinite
6271 MULTIBYTE = 0 means disable processing of multibyte characters,
6272 MULTIBYTE > 0 means enable it,
6273 MULTIBYTE < 0 means use IT->multibyte_p.
6275 IT must be initialized via a prior call to init_iterator before
6276 calling this function. */
6279 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6280 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6283 /* No region in strings. */
6284 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6286 /* No text property checks performed by default, but see below. */
6287 it
->stop_charpos
= -1;
6289 /* Set iterator position and end position. */
6290 memset (&it
->current
, 0, sizeof it
->current
);
6291 it
->current
.overlay_string_index
= -1;
6292 it
->current
.dpvec_index
= -1;
6293 eassert (charpos
>= 0);
6295 /* If STRING is specified, use its multibyteness, otherwise use the
6296 setting of MULTIBYTE, if specified. */
6298 it
->multibyte_p
= multibyte
> 0;
6300 /* Bidirectional reordering of strings is controlled by the default
6301 value of bidi-display-reordering. Don't try to reorder while
6302 loading loadup.el, as the necessary character property tables are
6303 not yet available. */
6306 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6310 eassert (STRINGP (string
));
6311 it
->string
= string
;
6313 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6314 it
->method
= GET_FROM_STRING
;
6315 it
->current
.string_pos
= string_pos (charpos
, string
);
6319 it
->bidi_it
.string
.lstring
= string
;
6320 it
->bidi_it
.string
.s
= NULL
;
6321 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6322 it
->bidi_it
.string
.bufpos
= 0;
6323 it
->bidi_it
.string
.from_disp_str
= 0;
6324 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6325 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6326 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6331 it
->s
= (const unsigned char *) s
;
6334 /* Note that we use IT->current.pos, not it->current.string_pos,
6335 for displaying C strings. */
6336 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6337 if (it
->multibyte_p
)
6339 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6340 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6344 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6345 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6350 it
->bidi_it
.string
.lstring
= Qnil
;
6351 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6352 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6353 it
->bidi_it
.string
.bufpos
= 0;
6354 it
->bidi_it
.string
.from_disp_str
= 0;
6355 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6356 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6359 it
->method
= GET_FROM_C_STRING
;
6362 /* PRECISION > 0 means don't return more than PRECISION characters
6364 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6366 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6368 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6371 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6372 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6373 FIELD_WIDTH < 0 means infinite field width. This is useful for
6374 padding with `-' at the end of a mode line. */
6375 if (field_width
< 0)
6376 field_width
= INFINITY
;
6377 /* Implementation note: We deliberately don't enlarge
6378 it->bidi_it.string.schars here to fit it->end_charpos, because
6379 the bidi iterator cannot produce characters out of thin air. */
6380 if (field_width
> it
->end_charpos
- charpos
)
6381 it
->end_charpos
= charpos
+ field_width
;
6383 /* Use the standard display table for displaying strings. */
6384 if (DISP_TABLE_P (Vstandard_display_table
))
6385 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6387 it
->stop_charpos
= charpos
;
6388 it
->prev_stop
= charpos
;
6389 it
->base_level_stop
= 0;
6392 it
->bidi_it
.first_elt
= 1;
6393 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6394 it
->bidi_it
.disp_pos
= -1;
6396 if (s
== NULL
&& it
->multibyte_p
)
6398 ptrdiff_t endpos
= SCHARS (it
->string
);
6399 if (endpos
> it
->end_charpos
)
6400 endpos
= it
->end_charpos
;
6401 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6409 /***********************************************************************
6411 ***********************************************************************/
6413 /* Map enum it_method value to corresponding next_element_from_* function. */
6415 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6417 next_element_from_buffer
,
6418 next_element_from_display_vector
,
6419 next_element_from_string
,
6420 next_element_from_c_string
,
6421 next_element_from_image
,
6422 next_element_from_stretch
6425 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6428 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6429 (possibly with the following characters). */
6431 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6432 ((IT)->cmp_it.id >= 0 \
6433 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6434 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6435 END_CHARPOS, (IT)->w, \
6436 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6440 /* Lookup the char-table Vglyphless_char_display for character C (-1
6441 if we want information for no-font case), and return the display
6442 method symbol. By side-effect, update it->what and
6443 it->glyphless_method. This function is called from
6444 get_next_display_element for each character element, and from
6445 x_produce_glyphs when no suitable font was found. */
6448 lookup_glyphless_char_display (int c
, struct it
*it
)
6450 Lisp_Object glyphless_method
= Qnil
;
6452 if (CHAR_TABLE_P (Vglyphless_char_display
)
6453 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6457 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6458 if (CONSP (glyphless_method
))
6459 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6460 ? XCAR (glyphless_method
)
6461 : XCDR (glyphless_method
);
6464 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6468 if (NILP (glyphless_method
))
6471 /* The default is to display the character by a proper font. */
6473 /* The default for the no-font case is to display an empty box. */
6474 glyphless_method
= Qempty_box
;
6476 if (EQ (glyphless_method
, Qzero_width
))
6479 return glyphless_method
;
6480 /* This method can't be used for the no-font case. */
6481 glyphless_method
= Qempty_box
;
6483 if (EQ (glyphless_method
, Qthin_space
))
6484 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6485 else if (EQ (glyphless_method
, Qempty_box
))
6486 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6487 else if (EQ (glyphless_method
, Qhex_code
))
6488 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6489 else if (STRINGP (glyphless_method
))
6490 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6493 /* Invalid value. We use the default method. */
6494 glyphless_method
= Qnil
;
6497 it
->what
= IT_GLYPHLESS
;
6498 return glyphless_method
;
6501 /* Load IT's display element fields with information about the next
6502 display element from the current position of IT. Value is zero if
6503 end of buffer (or C string) is reached. */
6505 static struct frame
*last_escape_glyph_frame
= NULL
;
6506 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6507 static int last_escape_glyph_merged_face_id
= 0;
6509 struct frame
*last_glyphless_glyph_frame
= NULL
;
6510 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6511 int last_glyphless_glyph_merged_face_id
= 0;
6514 get_next_display_element (struct it
*it
)
6516 /* Non-zero means that we found a display element. Zero means that
6517 we hit the end of what we iterate over. Performance note: the
6518 function pointer `method' used here turns out to be faster than
6519 using a sequence of if-statements. */
6523 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6525 if (it
->what
== IT_CHARACTER
)
6527 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6528 and only if (a) the resolved directionality of that character
6530 /* FIXME: Do we need an exception for characters from display
6532 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6533 it
->c
= bidi_mirror_char (it
->c
);
6534 /* Map via display table or translate control characters.
6535 IT->c, IT->len etc. have been set to the next character by
6536 the function call above. If we have a display table, and it
6537 contains an entry for IT->c, translate it. Don't do this if
6538 IT->c itself comes from a display table, otherwise we could
6539 end up in an infinite recursion. (An alternative could be to
6540 count the recursion depth of this function and signal an
6541 error when a certain maximum depth is reached.) Is it worth
6543 if (success_p
&& it
->dpvec
== NULL
)
6546 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6547 int nonascii_space_p
= 0;
6548 int nonascii_hyphen_p
= 0;
6549 int c
= it
->c
; /* This is the character to display. */
6551 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6553 eassert (SINGLE_BYTE_CHAR_P (c
));
6554 if (unibyte_display_via_language_environment
)
6556 c
= DECODE_CHAR (unibyte
, c
);
6558 c
= BYTE8_TO_CHAR (it
->c
);
6561 c
= BYTE8_TO_CHAR (it
->c
);
6565 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6568 struct Lisp_Vector
*v
= XVECTOR (dv
);
6570 /* Return the first character from the display table
6571 entry, if not empty. If empty, don't display the
6572 current character. */
6575 it
->dpvec_char_len
= it
->len
;
6576 it
->dpvec
= v
->contents
;
6577 it
->dpend
= v
->contents
+ v
->header
.size
;
6578 it
->current
.dpvec_index
= 0;
6579 it
->dpvec_face_id
= -1;
6580 it
->saved_face_id
= it
->face_id
;
6581 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6586 set_iterator_to_next (it
, 0);
6591 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6593 if (it
->what
== IT_GLYPHLESS
)
6595 /* Don't display this character. */
6596 set_iterator_to_next (it
, 0);
6600 /* If `nobreak-char-display' is non-nil, we display
6601 non-ASCII spaces and hyphens specially. */
6602 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6605 nonascii_space_p
= 1;
6606 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6607 nonascii_hyphen_p
= 1;
6610 /* Translate control characters into `\003' or `^C' form.
6611 Control characters coming from a display table entry are
6612 currently not translated because we use IT->dpvec to hold
6613 the translation. This could easily be changed but I
6614 don't believe that it is worth doing.
6616 The characters handled by `nobreak-char-display' must be
6619 Non-printable characters and raw-byte characters are also
6620 translated to octal form. */
6621 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6622 ? (it
->area
!= TEXT_AREA
6623 /* In mode line, treat \n, \t like other crl chars. */
6626 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6627 || (c
!= '\n' && c
!= '\t'))
6629 || nonascii_hyphen_p
6631 || ! CHAR_PRINTABLE_P (c
))))
6633 /* C is a control character, non-ASCII space/hyphen,
6634 raw-byte, or a non-printable character which must be
6635 displayed either as '\003' or as `^C' where the '\\'
6636 and '^' can be defined in the display table. Fill
6637 IT->ctl_chars with glyphs for what we have to
6638 display. Then, set IT->dpvec to these glyphs. */
6645 /* Handle control characters with ^. */
6647 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6651 g
= '^'; /* default glyph for Control */
6652 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6654 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6656 g
= GLYPH_CODE_CHAR (gc
);
6657 lface_id
= GLYPH_CODE_FACE (gc
);
6661 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6663 else if (it
->f
== last_escape_glyph_frame
6664 && it
->face_id
== last_escape_glyph_face_id
)
6666 face_id
= last_escape_glyph_merged_face_id
;
6670 /* Merge the escape-glyph face into the current face. */
6671 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6673 last_escape_glyph_frame
= it
->f
;
6674 last_escape_glyph_face_id
= it
->face_id
;
6675 last_escape_glyph_merged_face_id
= face_id
;
6678 XSETINT (it
->ctl_chars
[0], g
);
6679 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6681 goto display_control
;
6684 /* Handle non-ascii space in the mode where it only gets
6687 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6689 /* Merge `nobreak-space' into the current face. */
6690 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6692 XSETINT (it
->ctl_chars
[0], ' ');
6694 goto display_control
;
6697 /* Handle sequences that start with the "escape glyph". */
6699 /* the default escape glyph is \. */
6700 escape_glyph
= '\\';
6703 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6705 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6706 lface_id
= GLYPH_CODE_FACE (gc
);
6710 /* The display table specified a face.
6711 Merge it into face_id and also into escape_glyph. */
6712 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6715 else if (it
->f
== last_escape_glyph_frame
6716 && it
->face_id
== last_escape_glyph_face_id
)
6718 face_id
= last_escape_glyph_merged_face_id
;
6722 /* Merge the escape-glyph face into the current face. */
6723 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6725 last_escape_glyph_frame
= it
->f
;
6726 last_escape_glyph_face_id
= it
->face_id
;
6727 last_escape_glyph_merged_face_id
= face_id
;
6730 /* Draw non-ASCII hyphen with just highlighting: */
6732 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6734 XSETINT (it
->ctl_chars
[0], '-');
6736 goto display_control
;
6739 /* Draw non-ASCII space/hyphen with escape glyph: */
6741 if (nonascii_space_p
|| nonascii_hyphen_p
)
6743 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6744 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6746 goto display_control
;
6753 if (CHAR_BYTE8_P (c
))
6754 /* Display \200 instead of \17777600. */
6755 c
= CHAR_TO_BYTE8 (c
);
6756 len
= sprintf (str
, "%03o", c
);
6758 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6759 for (i
= 0; i
< len
; i
++)
6760 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6765 /* Set up IT->dpvec and return first character from it. */
6766 it
->dpvec_char_len
= it
->len
;
6767 it
->dpvec
= it
->ctl_chars
;
6768 it
->dpend
= it
->dpvec
+ ctl_len
;
6769 it
->current
.dpvec_index
= 0;
6770 it
->dpvec_face_id
= face_id
;
6771 it
->saved_face_id
= it
->face_id
;
6772 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6776 it
->char_to_display
= c
;
6780 it
->char_to_display
= it
->c
;
6784 /* Adjust face id for a multibyte character. There are no multibyte
6785 character in unibyte text. */
6786 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6789 && FRAME_WINDOW_P (it
->f
))
6791 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6793 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6795 /* Automatic composition with glyph-string. */
6796 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6798 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6802 ptrdiff_t pos
= (it
->s
? -1
6803 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6804 : IT_CHARPOS (*it
));
6807 if (it
->what
== IT_CHARACTER
)
6808 c
= it
->char_to_display
;
6811 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6815 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6816 /* TAB in a composition means display glyphs with
6817 padding space on the left or right. */
6818 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6821 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6826 /* Is this character the last one of a run of characters with
6827 box? If yes, set IT->end_of_box_run_p to 1. */
6831 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6833 int face_id
= underlying_face_id (it
);
6834 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6838 if (face
->box
== FACE_NO_BOX
)
6840 /* If the box comes from face properties in a
6841 display string, check faces in that string. */
6842 int string_face_id
= face_after_it_pos (it
);
6843 it
->end_of_box_run_p
6844 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6847 /* Otherwise, the box comes from the underlying face.
6848 If this is the last string character displayed, check
6849 the next buffer location. */
6850 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6851 && (it
->current
.overlay_string_index
6852 == it
->n_overlay_strings
- 1))
6856 struct text_pos pos
= it
->current
.pos
;
6857 INC_TEXT_POS (pos
, it
->multibyte_p
);
6859 next_face_id
= face_at_buffer_position
6860 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6861 it
->region_end_charpos
, &ignore
,
6862 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6864 it
->end_of_box_run_p
6865 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6872 int face_id
= face_after_it_pos (it
);
6873 it
->end_of_box_run_p
6874 = (face_id
!= it
->face_id
6875 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6878 /* If we reached the end of the object we've been iterating (e.g., a
6879 display string or an overlay string), and there's something on
6880 IT->stack, proceed with what's on the stack. It doesn't make
6881 sense to return zero if there's unprocessed stuff on the stack,
6882 because otherwise that stuff will never be displayed. */
6883 if (!success_p
&& it
->sp
> 0)
6885 set_iterator_to_next (it
, 0);
6886 success_p
= get_next_display_element (it
);
6889 /* Value is 0 if end of buffer or string reached. */
6894 /* Move IT to the next display element.
6896 RESEAT_P non-zero means if called on a newline in buffer text,
6897 skip to the next visible line start.
6899 Functions get_next_display_element and set_iterator_to_next are
6900 separate because I find this arrangement easier to handle than a
6901 get_next_display_element function that also increments IT's
6902 position. The way it is we can first look at an iterator's current
6903 display element, decide whether it fits on a line, and if it does,
6904 increment the iterator position. The other way around we probably
6905 would either need a flag indicating whether the iterator has to be
6906 incremented the next time, or we would have to implement a
6907 decrement position function which would not be easy to write. */
6910 set_iterator_to_next (struct it
*it
, int reseat_p
)
6912 /* Reset flags indicating start and end of a sequence of characters
6913 with box. Reset them at the start of this function because
6914 moving the iterator to a new position might set them. */
6915 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6919 case GET_FROM_BUFFER
:
6920 /* The current display element of IT is a character from
6921 current_buffer. Advance in the buffer, and maybe skip over
6922 invisible lines that are so because of selective display. */
6923 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6924 reseat_at_next_visible_line_start (it
, 0);
6925 else if (it
->cmp_it
.id
>= 0)
6927 /* We are currently getting glyphs from a composition. */
6932 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6933 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6934 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6936 it
->cmp_it
.from
= it
->cmp_it
.to
;
6941 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6943 it
->end_charpos
, Qnil
);
6946 else if (! it
->cmp_it
.reversed_p
)
6948 /* Composition created while scanning forward. */
6949 /* Update IT's char/byte positions to point to the first
6950 character of the next grapheme cluster, or to the
6951 character visually after the current composition. */
6952 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6953 bidi_move_to_visually_next (&it
->bidi_it
);
6954 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6955 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6957 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6959 /* Proceed to the next grapheme cluster. */
6960 it
->cmp_it
.from
= it
->cmp_it
.to
;
6964 /* No more grapheme clusters in this composition.
6965 Find the next stop position. */
6966 ptrdiff_t stop
= it
->end_charpos
;
6967 if (it
->bidi_it
.scan_dir
< 0)
6968 /* Now we are scanning backward and don't know
6971 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6972 IT_BYTEPOS (*it
), stop
, Qnil
);
6977 /* Composition created while scanning backward. */
6978 /* Update IT's char/byte positions to point to the last
6979 character of the previous grapheme cluster, or the
6980 character visually after the current composition. */
6981 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6982 bidi_move_to_visually_next (&it
->bidi_it
);
6983 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6984 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6985 if (it
->cmp_it
.from
> 0)
6987 /* Proceed to the previous grapheme cluster. */
6988 it
->cmp_it
.to
= it
->cmp_it
.from
;
6992 /* No more grapheme clusters in this composition.
6993 Find the next stop position. */
6994 ptrdiff_t stop
= it
->end_charpos
;
6995 if (it
->bidi_it
.scan_dir
< 0)
6996 /* Now we are scanning backward and don't know
6999 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7000 IT_BYTEPOS (*it
), stop
, Qnil
);
7006 eassert (it
->len
!= 0);
7010 IT_BYTEPOS (*it
) += it
->len
;
7011 IT_CHARPOS (*it
) += 1;
7015 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7016 /* If this is a new paragraph, determine its base
7017 direction (a.k.a. its base embedding level). */
7018 if (it
->bidi_it
.new_paragraph
)
7019 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7020 bidi_move_to_visually_next (&it
->bidi_it
);
7021 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7022 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7023 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7025 /* As the scan direction was changed, we must
7026 re-compute the stop position for composition. */
7027 ptrdiff_t stop
= it
->end_charpos
;
7028 if (it
->bidi_it
.scan_dir
< 0)
7030 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7031 IT_BYTEPOS (*it
), stop
, Qnil
);
7034 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7038 case GET_FROM_C_STRING
:
7039 /* Current display element of IT is from a C string. */
7041 /* If the string position is beyond string's end, it means
7042 next_element_from_c_string is padding the string with
7043 blanks, in which case we bypass the bidi iterator,
7044 because it cannot deal with such virtual characters. */
7045 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7047 IT_BYTEPOS (*it
) += it
->len
;
7048 IT_CHARPOS (*it
) += 1;
7052 bidi_move_to_visually_next (&it
->bidi_it
);
7053 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7054 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7058 case GET_FROM_DISPLAY_VECTOR
:
7059 /* Current display element of IT is from a display table entry.
7060 Advance in the display table definition. Reset it to null if
7061 end reached, and continue with characters from buffers/
7063 ++it
->current
.dpvec_index
;
7065 /* Restore face of the iterator to what they were before the
7066 display vector entry (these entries may contain faces). */
7067 it
->face_id
= it
->saved_face_id
;
7069 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7071 int recheck_faces
= it
->ellipsis_p
;
7074 it
->method
= GET_FROM_C_STRING
;
7075 else if (STRINGP (it
->string
))
7076 it
->method
= GET_FROM_STRING
;
7079 it
->method
= GET_FROM_BUFFER
;
7080 it
->object
= it
->w
->buffer
;
7084 it
->current
.dpvec_index
= -1;
7086 /* Skip over characters which were displayed via IT->dpvec. */
7087 if (it
->dpvec_char_len
< 0)
7088 reseat_at_next_visible_line_start (it
, 1);
7089 else if (it
->dpvec_char_len
> 0)
7091 if (it
->method
== GET_FROM_STRING
7092 && it
->n_overlay_strings
> 0)
7093 it
->ignore_overlay_strings_at_pos_p
= 1;
7094 it
->len
= it
->dpvec_char_len
;
7095 set_iterator_to_next (it
, reseat_p
);
7098 /* Maybe recheck faces after display vector */
7100 it
->stop_charpos
= IT_CHARPOS (*it
);
7104 case GET_FROM_STRING
:
7105 /* Current display element is a character from a Lisp string. */
7106 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7107 /* Don't advance past string end. These conditions are true
7108 when set_iterator_to_next is called at the end of
7109 get_next_display_element, in which case the Lisp string is
7110 already exhausted, and all we want is pop the iterator
7112 if (it
->current
.overlay_string_index
>= 0)
7114 /* This is an overlay string, so there's no padding with
7115 spaces, and the number of characters in the string is
7116 where the string ends. */
7117 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7118 goto consider_string_end
;
7122 /* Not an overlay string. There could be padding, so test
7123 against it->end_charpos . */
7124 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7125 goto consider_string_end
;
7127 if (it
->cmp_it
.id
>= 0)
7133 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7134 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7135 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7136 it
->cmp_it
.from
= it
->cmp_it
.to
;
7140 composition_compute_stop_pos (&it
->cmp_it
,
7141 IT_STRING_CHARPOS (*it
),
7142 IT_STRING_BYTEPOS (*it
),
7143 it
->end_charpos
, it
->string
);
7146 else if (! it
->cmp_it
.reversed_p
)
7148 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7149 bidi_move_to_visually_next (&it
->bidi_it
);
7150 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7151 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7153 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7154 it
->cmp_it
.from
= it
->cmp_it
.to
;
7157 ptrdiff_t stop
= it
->end_charpos
;
7158 if (it
->bidi_it
.scan_dir
< 0)
7160 composition_compute_stop_pos (&it
->cmp_it
,
7161 IT_STRING_CHARPOS (*it
),
7162 IT_STRING_BYTEPOS (*it
), stop
,
7168 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7169 bidi_move_to_visually_next (&it
->bidi_it
);
7170 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7171 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7172 if (it
->cmp_it
.from
> 0)
7173 it
->cmp_it
.to
= it
->cmp_it
.from
;
7176 ptrdiff_t stop
= it
->end_charpos
;
7177 if (it
->bidi_it
.scan_dir
< 0)
7179 composition_compute_stop_pos (&it
->cmp_it
,
7180 IT_STRING_CHARPOS (*it
),
7181 IT_STRING_BYTEPOS (*it
), stop
,
7189 /* If the string position is beyond string's end, it
7190 means next_element_from_string is padding the string
7191 with blanks, in which case we bypass the bidi
7192 iterator, because it cannot deal with such virtual
7194 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7196 IT_STRING_BYTEPOS (*it
) += it
->len
;
7197 IT_STRING_CHARPOS (*it
) += 1;
7201 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7203 bidi_move_to_visually_next (&it
->bidi_it
);
7204 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7205 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7206 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7208 ptrdiff_t stop
= it
->end_charpos
;
7210 if (it
->bidi_it
.scan_dir
< 0)
7212 composition_compute_stop_pos (&it
->cmp_it
,
7213 IT_STRING_CHARPOS (*it
),
7214 IT_STRING_BYTEPOS (*it
), stop
,
7220 consider_string_end
:
7222 if (it
->current
.overlay_string_index
>= 0)
7224 /* IT->string is an overlay string. Advance to the
7225 next, if there is one. */
7226 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7229 next_overlay_string (it
);
7231 setup_for_ellipsis (it
, 0);
7236 /* IT->string is not an overlay string. If we reached
7237 its end, and there is something on IT->stack, proceed
7238 with what is on the stack. This can be either another
7239 string, this time an overlay string, or a buffer. */
7240 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7244 if (it
->method
== GET_FROM_STRING
)
7245 goto consider_string_end
;
7250 case GET_FROM_IMAGE
:
7251 case GET_FROM_STRETCH
:
7252 /* The position etc with which we have to proceed are on
7253 the stack. The position may be at the end of a string,
7254 if the `display' property takes up the whole string. */
7255 eassert (it
->sp
> 0);
7257 if (it
->method
== GET_FROM_STRING
)
7258 goto consider_string_end
;
7262 /* There are no other methods defined, so this should be a bug. */
7266 eassert (it
->method
!= GET_FROM_STRING
7267 || (STRINGP (it
->string
)
7268 && IT_STRING_CHARPOS (*it
) >= 0));
7271 /* Load IT's display element fields with information about the next
7272 display element which comes from a display table entry or from the
7273 result of translating a control character to one of the forms `^C'
7276 IT->dpvec holds the glyphs to return as characters.
7277 IT->saved_face_id holds the face id before the display vector--it
7278 is restored into IT->face_id in set_iterator_to_next. */
7281 next_element_from_display_vector (struct it
*it
)
7286 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7288 it
->face_id
= it
->saved_face_id
;
7290 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7291 That seemed totally bogus - so I changed it... */
7292 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7294 if (GLYPH_CODE_P (gc
))
7296 it
->c
= GLYPH_CODE_CHAR (gc
);
7297 it
->len
= CHAR_BYTES (it
->c
);
7299 /* The entry may contain a face id to use. Such a face id is
7300 the id of a Lisp face, not a realized face. A face id of
7301 zero means no face is specified. */
7302 if (it
->dpvec_face_id
>= 0)
7303 it
->face_id
= it
->dpvec_face_id
;
7306 int lface_id
= GLYPH_CODE_FACE (gc
);
7308 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7313 /* Display table entry is invalid. Return a space. */
7314 it
->c
= ' ', it
->len
= 1;
7316 /* Don't change position and object of the iterator here. They are
7317 still the values of the character that had this display table
7318 entry or was translated, and that's what we want. */
7319 it
->what
= IT_CHARACTER
;
7323 /* Get the first element of string/buffer in the visual order, after
7324 being reseated to a new position in a string or a buffer. */
7326 get_visually_first_element (struct it
*it
)
7328 int string_p
= STRINGP (it
->string
) || it
->s
;
7329 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7330 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7332 if (STRINGP (it
->string
))
7334 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7335 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7339 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7340 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7343 if (it
->bidi_it
.charpos
== eob
)
7345 /* Nothing to do, but reset the FIRST_ELT flag, like
7346 bidi_paragraph_init does, because we are not going to
7348 it
->bidi_it
.first_elt
= 0;
7350 else if (it
->bidi_it
.charpos
== bob
7352 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7353 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7355 /* If we are at the beginning of a line/string, we can produce
7356 the next element right away. */
7357 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7358 bidi_move_to_visually_next (&it
->bidi_it
);
7362 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7364 /* We need to prime the bidi iterator starting at the line's or
7365 string's beginning, before we will be able to produce the
7368 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7371 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7373 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7375 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7378 /* Now return to buffer/string position where we were asked
7379 to get the next display element, and produce that. */
7380 bidi_move_to_visually_next (&it
->bidi_it
);
7382 while (it
->bidi_it
.bytepos
!= orig_bytepos
7383 && it
->bidi_it
.charpos
< eob
);
7386 /* Adjust IT's position information to where we ended up. */
7387 if (STRINGP (it
->string
))
7389 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7390 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7394 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7395 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7398 if (STRINGP (it
->string
) || !it
->s
)
7400 ptrdiff_t stop
, charpos
, bytepos
;
7402 if (STRINGP (it
->string
))
7405 stop
= SCHARS (it
->string
);
7406 if (stop
> it
->end_charpos
)
7407 stop
= it
->end_charpos
;
7408 charpos
= IT_STRING_CHARPOS (*it
);
7409 bytepos
= IT_STRING_BYTEPOS (*it
);
7413 stop
= it
->end_charpos
;
7414 charpos
= IT_CHARPOS (*it
);
7415 bytepos
= IT_BYTEPOS (*it
);
7417 if (it
->bidi_it
.scan_dir
< 0)
7419 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7424 /* Load IT with the next display element from Lisp string IT->string.
7425 IT->current.string_pos is the current position within the string.
7426 If IT->current.overlay_string_index >= 0, the Lisp string is an
7430 next_element_from_string (struct it
*it
)
7432 struct text_pos position
;
7434 eassert (STRINGP (it
->string
));
7435 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7436 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7437 position
= it
->current
.string_pos
;
7439 /* With bidi reordering, the character to display might not be the
7440 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7441 that we were reseat()ed to a new string, whose paragraph
7442 direction is not known. */
7443 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7445 get_visually_first_element (it
);
7446 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7449 /* Time to check for invisible text? */
7450 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7452 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7455 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7456 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7458 /* With bidi non-linear iteration, we could find
7459 ourselves far beyond the last computed stop_charpos,
7460 with several other stop positions in between that we
7461 missed. Scan them all now, in buffer's logical
7462 order, until we find and handle the last stop_charpos
7463 that precedes our current position. */
7464 handle_stop_backwards (it
, it
->stop_charpos
);
7465 return GET_NEXT_DISPLAY_ELEMENT (it
);
7471 /* Take note of the stop position we just moved
7472 across, for when we will move back across it. */
7473 it
->prev_stop
= it
->stop_charpos
;
7474 /* If we are at base paragraph embedding level, take
7475 note of the last stop position seen at this
7477 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7478 it
->base_level_stop
= it
->stop_charpos
;
7482 /* Since a handler may have changed IT->method, we must
7484 return GET_NEXT_DISPLAY_ELEMENT (it
);
7488 /* If we are before prev_stop, we may have overstepped
7489 on our way backwards a stop_pos, and if so, we need
7490 to handle that stop_pos. */
7491 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7492 /* We can sometimes back up for reasons that have nothing
7493 to do with bidi reordering. E.g., compositions. The
7494 code below is only needed when we are above the base
7495 embedding level, so test for that explicitly. */
7496 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7498 /* If we lost track of base_level_stop, we have no better
7499 place for handle_stop_backwards to start from than string
7500 beginning. This happens, e.g., when we were reseated to
7501 the previous screenful of text by vertical-motion. */
7502 if (it
->base_level_stop
<= 0
7503 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7504 it
->base_level_stop
= 0;
7505 handle_stop_backwards (it
, it
->base_level_stop
);
7506 return GET_NEXT_DISPLAY_ELEMENT (it
);
7510 if (it
->current
.overlay_string_index
>= 0)
7512 /* Get the next character from an overlay string. In overlay
7513 strings, there is no field width or padding with spaces to
7515 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7520 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7521 IT_STRING_BYTEPOS (*it
),
7522 it
->bidi_it
.scan_dir
< 0
7524 : SCHARS (it
->string
))
7525 && next_element_from_composition (it
))
7529 else if (STRING_MULTIBYTE (it
->string
))
7531 const unsigned char *s
= (SDATA (it
->string
)
7532 + IT_STRING_BYTEPOS (*it
));
7533 it
->c
= string_char_and_length (s
, &it
->len
);
7537 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7543 /* Get the next character from a Lisp string that is not an
7544 overlay string. Such strings come from the mode line, for
7545 example. We may have to pad with spaces, or truncate the
7546 string. See also next_element_from_c_string. */
7547 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7552 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7554 /* Pad with spaces. */
7555 it
->c
= ' ', it
->len
= 1;
7556 CHARPOS (position
) = BYTEPOS (position
) = -1;
7558 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7559 IT_STRING_BYTEPOS (*it
),
7560 it
->bidi_it
.scan_dir
< 0
7562 : it
->string_nchars
)
7563 && next_element_from_composition (it
))
7567 else if (STRING_MULTIBYTE (it
->string
))
7569 const unsigned char *s
= (SDATA (it
->string
)
7570 + IT_STRING_BYTEPOS (*it
));
7571 it
->c
= string_char_and_length (s
, &it
->len
);
7575 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7580 /* Record what we have and where it came from. */
7581 it
->what
= IT_CHARACTER
;
7582 it
->object
= it
->string
;
7583 it
->position
= position
;
7588 /* Load IT with next display element from C string IT->s.
7589 IT->string_nchars is the maximum number of characters to return
7590 from the string. IT->end_charpos may be greater than
7591 IT->string_nchars when this function is called, in which case we
7592 may have to return padding spaces. Value is zero if end of string
7593 reached, including padding spaces. */
7596 next_element_from_c_string (struct it
*it
)
7601 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7602 it
->what
= IT_CHARACTER
;
7603 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7606 /* With bidi reordering, the character to display might not be the
7607 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7608 we were reseated to a new string, whose paragraph direction is
7610 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7611 get_visually_first_element (it
);
7613 /* IT's position can be greater than IT->string_nchars in case a
7614 field width or precision has been specified when the iterator was
7616 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7618 /* End of the game. */
7622 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7624 /* Pad with spaces. */
7625 it
->c
= ' ', it
->len
= 1;
7626 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7628 else if (it
->multibyte_p
)
7629 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7631 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7637 /* Set up IT to return characters from an ellipsis, if appropriate.
7638 The definition of the ellipsis glyphs may come from a display table
7639 entry. This function fills IT with the first glyph from the
7640 ellipsis if an ellipsis is to be displayed. */
7643 next_element_from_ellipsis (struct it
*it
)
7645 if (it
->selective_display_ellipsis_p
)
7646 setup_for_ellipsis (it
, it
->len
);
7649 /* The face at the current position may be different from the
7650 face we find after the invisible text. Remember what it
7651 was in IT->saved_face_id, and signal that it's there by
7652 setting face_before_selective_p. */
7653 it
->saved_face_id
= it
->face_id
;
7654 it
->method
= GET_FROM_BUFFER
;
7655 it
->object
= it
->w
->buffer
;
7656 reseat_at_next_visible_line_start (it
, 1);
7657 it
->face_before_selective_p
= 1;
7660 return GET_NEXT_DISPLAY_ELEMENT (it
);
7664 /* Deliver an image display element. The iterator IT is already
7665 filled with image information (done in handle_display_prop). Value
7670 next_element_from_image (struct it
*it
)
7672 it
->what
= IT_IMAGE
;
7673 it
->ignore_overlay_strings_at_pos_p
= 0;
7678 /* Fill iterator IT with next display element from a stretch glyph
7679 property. IT->object is the value of the text property. Value is
7683 next_element_from_stretch (struct it
*it
)
7685 it
->what
= IT_STRETCH
;
7689 /* Scan backwards from IT's current position until we find a stop
7690 position, or until BEGV. This is called when we find ourself
7691 before both the last known prev_stop and base_level_stop while
7692 reordering bidirectional text. */
7695 compute_stop_pos_backwards (struct it
*it
)
7697 const int SCAN_BACK_LIMIT
= 1000;
7698 struct text_pos pos
;
7699 struct display_pos save_current
= it
->current
;
7700 struct text_pos save_position
= it
->position
;
7701 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7702 ptrdiff_t where_we_are
= charpos
;
7703 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7704 ptrdiff_t save_end_pos
= it
->end_charpos
;
7706 eassert (NILP (it
->string
) && !it
->s
);
7707 eassert (it
->bidi_p
);
7711 it
->end_charpos
= min (charpos
+ 1, ZV
);
7712 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7713 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7714 reseat_1 (it
, pos
, 0);
7715 compute_stop_pos (it
);
7716 /* We must advance forward, right? */
7717 if (it
->stop_charpos
<= charpos
)
7720 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7722 if (it
->stop_charpos
<= where_we_are
)
7723 it
->prev_stop
= it
->stop_charpos
;
7725 it
->prev_stop
= BEGV
;
7727 it
->current
= save_current
;
7728 it
->position
= save_position
;
7729 it
->stop_charpos
= save_stop_pos
;
7730 it
->end_charpos
= save_end_pos
;
7733 /* Scan forward from CHARPOS in the current buffer/string, until we
7734 find a stop position > current IT's position. Then handle the stop
7735 position before that. This is called when we bump into a stop
7736 position while reordering bidirectional text. CHARPOS should be
7737 the last previously processed stop_pos (or BEGV/0, if none were
7738 processed yet) whose position is less that IT's current
7742 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7744 int bufp
= !STRINGP (it
->string
);
7745 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7746 struct display_pos save_current
= it
->current
;
7747 struct text_pos save_position
= it
->position
;
7748 struct text_pos pos1
;
7749 ptrdiff_t next_stop
;
7751 /* Scan in strict logical order. */
7752 eassert (it
->bidi_p
);
7756 it
->prev_stop
= charpos
;
7759 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7760 reseat_1 (it
, pos1
, 0);
7763 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7764 compute_stop_pos (it
);
7765 /* We must advance forward, right? */
7766 if (it
->stop_charpos
<= it
->prev_stop
)
7768 charpos
= it
->stop_charpos
;
7770 while (charpos
<= where_we_are
);
7773 it
->current
= save_current
;
7774 it
->position
= save_position
;
7775 next_stop
= it
->stop_charpos
;
7776 it
->stop_charpos
= it
->prev_stop
;
7778 it
->stop_charpos
= next_stop
;
7781 /* Load IT with the next display element from current_buffer. Value
7782 is zero if end of buffer reached. IT->stop_charpos is the next
7783 position at which to stop and check for text properties or buffer
7787 next_element_from_buffer (struct it
*it
)
7791 eassert (IT_CHARPOS (*it
) >= BEGV
);
7792 eassert (NILP (it
->string
) && !it
->s
);
7793 eassert (!it
->bidi_p
7794 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7795 && it
->bidi_it
.string
.s
== NULL
));
7797 /* With bidi reordering, the character to display might not be the
7798 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7799 we were reseat()ed to a new buffer position, which is potentially
7800 a different paragraph. */
7801 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7803 get_visually_first_element (it
);
7804 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7807 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7809 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7811 int overlay_strings_follow_p
;
7813 /* End of the game, except when overlay strings follow that
7814 haven't been returned yet. */
7815 if (it
->overlay_strings_at_end_processed_p
)
7816 overlay_strings_follow_p
= 0;
7819 it
->overlay_strings_at_end_processed_p
= 1;
7820 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7823 if (overlay_strings_follow_p
)
7824 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7828 it
->position
= it
->current
.pos
;
7832 else if (!(!it
->bidi_p
7833 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7834 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7836 /* With bidi non-linear iteration, we could find ourselves
7837 far beyond the last computed stop_charpos, with several
7838 other stop positions in between that we missed. Scan
7839 them all now, in buffer's logical order, until we find
7840 and handle the last stop_charpos that precedes our
7841 current position. */
7842 handle_stop_backwards (it
, it
->stop_charpos
);
7843 return GET_NEXT_DISPLAY_ELEMENT (it
);
7849 /* Take note of the stop position we just moved across,
7850 for when we will move back across it. */
7851 it
->prev_stop
= it
->stop_charpos
;
7852 /* If we are at base paragraph embedding level, take
7853 note of the last stop position seen at this
7855 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7856 it
->base_level_stop
= it
->stop_charpos
;
7859 return GET_NEXT_DISPLAY_ELEMENT (it
);
7863 /* If we are before prev_stop, we may have overstepped on
7864 our way backwards a stop_pos, and if so, we need to
7865 handle that stop_pos. */
7866 && IT_CHARPOS (*it
) < it
->prev_stop
7867 /* We can sometimes back up for reasons that have nothing
7868 to do with bidi reordering. E.g., compositions. The
7869 code below is only needed when we are above the base
7870 embedding level, so test for that explicitly. */
7871 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7873 if (it
->base_level_stop
<= 0
7874 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7876 /* If we lost track of base_level_stop, we need to find
7877 prev_stop by looking backwards. This happens, e.g., when
7878 we were reseated to the previous screenful of text by
7880 it
->base_level_stop
= BEGV
;
7881 compute_stop_pos_backwards (it
);
7882 handle_stop_backwards (it
, it
->prev_stop
);
7885 handle_stop_backwards (it
, it
->base_level_stop
);
7886 return GET_NEXT_DISPLAY_ELEMENT (it
);
7890 /* No face changes, overlays etc. in sight, so just return a
7891 character from current_buffer. */
7895 /* Maybe run the redisplay end trigger hook. Performance note:
7896 This doesn't seem to cost measurable time. */
7897 if (it
->redisplay_end_trigger_charpos
7899 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7900 run_redisplay_end_trigger_hook (it
);
7902 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7903 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7905 && next_element_from_composition (it
))
7910 /* Get the next character, maybe multibyte. */
7911 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7912 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7913 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7915 it
->c
= *p
, it
->len
= 1;
7917 /* Record what we have and where it came from. */
7918 it
->what
= IT_CHARACTER
;
7919 it
->object
= it
->w
->buffer
;
7920 it
->position
= it
->current
.pos
;
7922 /* Normally we return the character found above, except when we
7923 really want to return an ellipsis for selective display. */
7928 /* A value of selective > 0 means hide lines indented more
7929 than that number of columns. */
7930 if (it
->selective
> 0
7931 && IT_CHARPOS (*it
) + 1 < ZV
7932 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7933 IT_BYTEPOS (*it
) + 1,
7936 success_p
= next_element_from_ellipsis (it
);
7937 it
->dpvec_char_len
= -1;
7940 else if (it
->c
== '\r' && it
->selective
== -1)
7942 /* A value of selective == -1 means that everything from the
7943 CR to the end of the line is invisible, with maybe an
7944 ellipsis displayed for it. */
7945 success_p
= next_element_from_ellipsis (it
);
7946 it
->dpvec_char_len
= -1;
7951 /* Value is zero if end of buffer reached. */
7952 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7957 /* Run the redisplay end trigger hook for IT. */
7960 run_redisplay_end_trigger_hook (struct it
*it
)
7962 Lisp_Object args
[3];
7964 /* IT->glyph_row should be non-null, i.e. we should be actually
7965 displaying something, or otherwise we should not run the hook. */
7966 eassert (it
->glyph_row
);
7968 /* Set up hook arguments. */
7969 args
[0] = Qredisplay_end_trigger_functions
;
7970 args
[1] = it
->window
;
7971 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7972 it
->redisplay_end_trigger_charpos
= 0;
7974 /* Since we are *trying* to run these functions, don't try to run
7975 them again, even if they get an error. */
7976 it
->w
->redisplay_end_trigger
= Qnil
;
7977 Frun_hook_with_args (3, args
);
7979 /* Notice if it changed the face of the character we are on. */
7980 handle_face_prop (it
);
7984 /* Deliver a composition display element. Unlike the other
7985 next_element_from_XXX, this function is not registered in the array
7986 get_next_element[]. It is called from next_element_from_buffer and
7987 next_element_from_string when necessary. */
7990 next_element_from_composition (struct it
*it
)
7992 it
->what
= IT_COMPOSITION
;
7993 it
->len
= it
->cmp_it
.nbytes
;
7994 if (STRINGP (it
->string
))
7998 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7999 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8002 it
->position
= it
->current
.string_pos
;
8003 it
->object
= it
->string
;
8004 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8005 IT_STRING_BYTEPOS (*it
), it
->string
);
8011 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8012 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8015 if (it
->bidi_it
.new_paragraph
)
8016 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8017 /* Resync the bidi iterator with IT's new position.
8018 FIXME: this doesn't support bidirectional text. */
8019 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8020 bidi_move_to_visually_next (&it
->bidi_it
);
8024 it
->position
= it
->current
.pos
;
8025 it
->object
= it
->w
->buffer
;
8026 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8027 IT_BYTEPOS (*it
), Qnil
);
8034 /***********************************************************************
8035 Moving an iterator without producing glyphs
8036 ***********************************************************************/
8038 /* Check if iterator is at a position corresponding to a valid buffer
8039 position after some move_it_ call. */
8041 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8042 ((it)->method == GET_FROM_STRING \
8043 ? IT_STRING_CHARPOS (*it) == 0 \
8047 /* Move iterator IT to a specified buffer or X position within one
8048 line on the display without producing glyphs.
8050 OP should be a bit mask including some or all of these bits:
8051 MOVE_TO_X: Stop upon reaching x-position TO_X.
8052 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8053 Regardless of OP's value, stop upon reaching the end of the display line.
8055 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8056 This means, in particular, that TO_X includes window's horizontal
8059 The return value has several possible values that
8060 say what condition caused the scan to stop:
8062 MOVE_POS_MATCH_OR_ZV
8063 - when TO_POS or ZV was reached.
8066 -when TO_X was reached before TO_POS or ZV were reached.
8069 - when we reached the end of the display area and the line must
8073 - when we reached the end of the display area and the line is
8077 - when we stopped at a line end, i.e. a newline or a CR and selective
8080 static enum move_it_result
8081 move_it_in_display_line_to (struct it
*it
,
8082 ptrdiff_t to_charpos
, int to_x
,
8083 enum move_operation_enum op
)
8085 enum move_it_result result
= MOVE_UNDEFINED
;
8086 struct glyph_row
*saved_glyph_row
;
8087 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8088 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8089 void *ppos_data
= NULL
;
8091 enum it_method prev_method
= it
->method
;
8092 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8093 int saw_smaller_pos
= prev_pos
< to_charpos
;
8095 /* Don't produce glyphs in produce_glyphs. */
8096 saved_glyph_row
= it
->glyph_row
;
8097 it
->glyph_row
= NULL
;
8099 /* Use wrap_it to save a copy of IT wherever a word wrap could
8100 occur. Use atpos_it to save a copy of IT at the desired buffer
8101 position, if found, so that we can scan ahead and check if the
8102 word later overshoots the window edge. Use atx_it similarly, for
8108 /* Use ppos_it under bidi reordering to save a copy of IT for the
8109 position > CHARPOS that is the closest to CHARPOS. We restore
8110 that position in IT when we have scanned the entire display line
8111 without finding a match for CHARPOS and all the character
8112 positions are greater than CHARPOS. */
8115 SAVE_IT (ppos_it
, *it
, ppos_data
);
8116 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8117 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8118 SAVE_IT (ppos_it
, *it
, ppos_data
);
8121 #define BUFFER_POS_REACHED_P() \
8122 ((op & MOVE_TO_POS) != 0 \
8123 && BUFFERP (it->object) \
8124 && (IT_CHARPOS (*it) == to_charpos \
8126 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8127 && IT_CHARPOS (*it) > to_charpos) \
8128 || (it->what == IT_COMPOSITION \
8129 && ((IT_CHARPOS (*it) > to_charpos \
8130 && to_charpos >= it->cmp_it.charpos) \
8131 || (IT_CHARPOS (*it) < to_charpos \
8132 && to_charpos <= it->cmp_it.charpos)))) \
8133 && (it->method == GET_FROM_BUFFER \
8134 || (it->method == GET_FROM_DISPLAY_VECTOR \
8135 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8137 /* If there's a line-/wrap-prefix, handle it. */
8138 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8139 && it
->current_y
< it
->last_visible_y
)
8140 handle_line_prefix (it
);
8142 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8143 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8147 int x
, i
, ascent
= 0, descent
= 0;
8149 /* Utility macro to reset an iterator with x, ascent, and descent. */
8150 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8151 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8152 (IT)->max_descent = descent)
8154 /* Stop if we move beyond TO_CHARPOS (after an image or a
8155 display string or stretch glyph). */
8156 if ((op
& MOVE_TO_POS
) != 0
8157 && BUFFERP (it
->object
)
8158 && it
->method
== GET_FROM_BUFFER
8160 /* When the iterator is at base embedding level, we
8161 are guaranteed that characters are delivered for
8162 display in strictly increasing order of their
8163 buffer positions. */
8164 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8165 && IT_CHARPOS (*it
) > to_charpos
)
8167 && (prev_method
== GET_FROM_IMAGE
8168 || prev_method
== GET_FROM_STRETCH
8169 || prev_method
== GET_FROM_STRING
)
8170 /* Passed TO_CHARPOS from left to right. */
8171 && ((prev_pos
< to_charpos
8172 && IT_CHARPOS (*it
) > to_charpos
)
8173 /* Passed TO_CHARPOS from right to left. */
8174 || (prev_pos
> to_charpos
8175 && IT_CHARPOS (*it
) < to_charpos
)))))
8177 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8179 result
= MOVE_POS_MATCH_OR_ZV
;
8182 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8183 /* If wrap_it is valid, the current position might be in a
8184 word that is wrapped. So, save the iterator in
8185 atpos_it and continue to see if wrapping happens. */
8186 SAVE_IT (atpos_it
, *it
, atpos_data
);
8189 /* Stop when ZV reached.
8190 We used to stop here when TO_CHARPOS reached as well, but that is
8191 too soon if this glyph does not fit on this line. So we handle it
8192 explicitly below. */
8193 if (!get_next_display_element (it
))
8195 result
= MOVE_POS_MATCH_OR_ZV
;
8199 if (it
->line_wrap
== TRUNCATE
)
8201 if (BUFFER_POS_REACHED_P ())
8203 result
= MOVE_POS_MATCH_OR_ZV
;
8209 if (it
->line_wrap
== WORD_WRAP
)
8211 if (IT_DISPLAYING_WHITESPACE (it
))
8215 /* We have reached a glyph that follows one or more
8216 whitespace characters. If the position is
8217 already found, we are done. */
8218 if (atpos_it
.sp
>= 0)
8220 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8221 result
= MOVE_POS_MATCH_OR_ZV
;
8226 RESTORE_IT (it
, &atx_it
, atx_data
);
8227 result
= MOVE_X_REACHED
;
8230 /* Otherwise, we can wrap here. */
8231 SAVE_IT (wrap_it
, *it
, wrap_data
);
8237 /* Remember the line height for the current line, in case
8238 the next element doesn't fit on the line. */
8239 ascent
= it
->max_ascent
;
8240 descent
= it
->max_descent
;
8242 /* The call to produce_glyphs will get the metrics of the
8243 display element IT is loaded with. Record the x-position
8244 before this display element, in case it doesn't fit on the
8248 PRODUCE_GLYPHS (it
);
8250 if (it
->area
!= TEXT_AREA
)
8252 prev_method
= it
->method
;
8253 if (it
->method
== GET_FROM_BUFFER
)
8254 prev_pos
= IT_CHARPOS (*it
);
8255 set_iterator_to_next (it
, 1);
8256 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8257 SET_TEXT_POS (this_line_min_pos
,
8258 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8260 && (op
& MOVE_TO_POS
)
8261 && IT_CHARPOS (*it
) > to_charpos
8262 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8263 SAVE_IT (ppos_it
, *it
, ppos_data
);
8267 /* The number of glyphs we get back in IT->nglyphs will normally
8268 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8269 character on a terminal frame, or (iii) a line end. For the
8270 second case, IT->nglyphs - 1 padding glyphs will be present.
8271 (On X frames, there is only one glyph produced for a
8272 composite character.)
8274 The behavior implemented below means, for continuation lines,
8275 that as many spaces of a TAB as fit on the current line are
8276 displayed there. For terminal frames, as many glyphs of a
8277 multi-glyph character are displayed in the current line, too.
8278 This is what the old redisplay code did, and we keep it that
8279 way. Under X, the whole shape of a complex character must
8280 fit on the line or it will be completely displayed in the
8283 Note that both for tabs and padding glyphs, all glyphs have
8287 /* More than one glyph or glyph doesn't fit on line. All
8288 glyphs have the same width. */
8289 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8291 int x_before_this_char
= x
;
8292 int hpos_before_this_char
= it
->hpos
;
8294 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8296 new_x
= x
+ single_glyph_width
;
8298 /* We want to leave anything reaching TO_X to the caller. */
8299 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8301 if (BUFFER_POS_REACHED_P ())
8303 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8304 goto buffer_pos_reached
;
8305 if (atpos_it
.sp
< 0)
8307 SAVE_IT (atpos_it
, *it
, atpos_data
);
8308 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8313 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8316 result
= MOVE_X_REACHED
;
8321 SAVE_IT (atx_it
, *it
, atx_data
);
8322 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8327 if (/* Lines are continued. */
8328 it
->line_wrap
!= TRUNCATE
8329 && (/* And glyph doesn't fit on the line. */
8330 new_x
> it
->last_visible_x
8331 /* Or it fits exactly and we're on a window
8333 || (new_x
== it
->last_visible_x
8334 && FRAME_WINDOW_P (it
->f
)
8335 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8336 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8337 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8339 if (/* IT->hpos == 0 means the very first glyph
8340 doesn't fit on the line, e.g. a wide image. */
8342 || (new_x
== it
->last_visible_x
8343 && FRAME_WINDOW_P (it
->f
)))
8346 it
->current_x
= new_x
;
8348 /* The character's last glyph just barely fits
8350 if (i
== it
->nglyphs
- 1)
8352 /* If this is the destination position,
8353 return a position *before* it in this row,
8354 now that we know it fits in this row. */
8355 if (BUFFER_POS_REACHED_P ())
8357 if (it
->line_wrap
!= WORD_WRAP
8360 it
->hpos
= hpos_before_this_char
;
8361 it
->current_x
= x_before_this_char
;
8362 result
= MOVE_POS_MATCH_OR_ZV
;
8365 if (it
->line_wrap
== WORD_WRAP
8368 SAVE_IT (atpos_it
, *it
, atpos_data
);
8369 atpos_it
.current_x
= x_before_this_char
;
8370 atpos_it
.hpos
= hpos_before_this_char
;
8374 prev_method
= it
->method
;
8375 if (it
->method
== GET_FROM_BUFFER
)
8376 prev_pos
= IT_CHARPOS (*it
);
8377 set_iterator_to_next (it
, 1);
8378 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8379 SET_TEXT_POS (this_line_min_pos
,
8380 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8381 /* On graphical terminals, newlines may
8382 "overflow" into the fringe if
8383 overflow-newline-into-fringe is non-nil.
8384 On text terminals, newlines may overflow
8385 into the last glyph on the display
8387 if (!FRAME_WINDOW_P (it
->f
)
8388 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8390 if (!get_next_display_element (it
))
8392 result
= MOVE_POS_MATCH_OR_ZV
;
8395 if (BUFFER_POS_REACHED_P ())
8397 if (ITERATOR_AT_END_OF_LINE_P (it
))
8398 result
= MOVE_POS_MATCH_OR_ZV
;
8400 result
= MOVE_LINE_CONTINUED
;
8403 if (ITERATOR_AT_END_OF_LINE_P (it
))
8405 result
= MOVE_NEWLINE_OR_CR
;
8412 IT_RESET_X_ASCENT_DESCENT (it
);
8414 if (wrap_it
.sp
>= 0)
8416 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8421 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8423 result
= MOVE_LINE_CONTINUED
;
8427 if (BUFFER_POS_REACHED_P ())
8429 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8430 goto buffer_pos_reached
;
8431 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8433 SAVE_IT (atpos_it
, *it
, atpos_data
);
8434 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8438 if (new_x
> it
->first_visible_x
)
8440 /* Glyph is visible. Increment number of glyphs that
8441 would be displayed. */
8446 if (result
!= MOVE_UNDEFINED
)
8449 else if (BUFFER_POS_REACHED_P ())
8452 IT_RESET_X_ASCENT_DESCENT (it
);
8453 result
= MOVE_POS_MATCH_OR_ZV
;
8456 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8458 /* Stop when TO_X specified and reached. This check is
8459 necessary here because of lines consisting of a line end,
8460 only. The line end will not produce any glyphs and we
8461 would never get MOVE_X_REACHED. */
8462 eassert (it
->nglyphs
== 0);
8463 result
= MOVE_X_REACHED
;
8467 /* Is this a line end? If yes, we're done. */
8468 if (ITERATOR_AT_END_OF_LINE_P (it
))
8470 /* If we are past TO_CHARPOS, but never saw any character
8471 positions smaller than TO_CHARPOS, return
8472 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8474 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8476 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8478 if (IT_CHARPOS (ppos_it
) < ZV
)
8480 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8481 result
= MOVE_POS_MATCH_OR_ZV
;
8484 goto buffer_pos_reached
;
8486 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8487 && IT_CHARPOS (*it
) > to_charpos
)
8488 goto buffer_pos_reached
;
8490 result
= MOVE_NEWLINE_OR_CR
;
8493 result
= MOVE_NEWLINE_OR_CR
;
8497 prev_method
= it
->method
;
8498 if (it
->method
== GET_FROM_BUFFER
)
8499 prev_pos
= IT_CHARPOS (*it
);
8500 /* The current display element has been consumed. Advance
8502 set_iterator_to_next (it
, 1);
8503 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8504 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8505 if (IT_CHARPOS (*it
) < to_charpos
)
8506 saw_smaller_pos
= 1;
8508 && (op
& MOVE_TO_POS
)
8509 && IT_CHARPOS (*it
) >= to_charpos
8510 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8511 SAVE_IT (ppos_it
, *it
, ppos_data
);
8513 /* Stop if lines are truncated and IT's current x-position is
8514 past the right edge of the window now. */
8515 if (it
->line_wrap
== TRUNCATE
8516 && it
->current_x
>= it
->last_visible_x
)
8518 if (!FRAME_WINDOW_P (it
->f
)
8519 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8520 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8521 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
8522 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8526 if ((at_eob_p
= !get_next_display_element (it
))
8527 || BUFFER_POS_REACHED_P ()
8528 /* If we are past TO_CHARPOS, but never saw any
8529 character positions smaller than TO_CHARPOS,
8530 return MOVE_POS_MATCH_OR_ZV, like the
8531 unidirectional display did. */
8532 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8534 && IT_CHARPOS (*it
) > to_charpos
))
8537 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8538 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8539 result
= MOVE_POS_MATCH_OR_ZV
;
8542 if (ITERATOR_AT_END_OF_LINE_P (it
))
8544 result
= MOVE_NEWLINE_OR_CR
;
8548 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8550 && IT_CHARPOS (*it
) > to_charpos
)
8552 if (IT_CHARPOS (ppos_it
) < ZV
)
8553 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8554 result
= MOVE_POS_MATCH_OR_ZV
;
8557 result
= MOVE_LINE_TRUNCATED
;
8560 #undef IT_RESET_X_ASCENT_DESCENT
8563 #undef BUFFER_POS_REACHED_P
8565 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8566 restore the saved iterator. */
8567 if (atpos_it
.sp
>= 0)
8568 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8569 else if (atx_it
.sp
>= 0)
8570 RESTORE_IT (it
, &atx_it
, atx_data
);
8575 bidi_unshelve_cache (atpos_data
, 1);
8577 bidi_unshelve_cache (atx_data
, 1);
8579 bidi_unshelve_cache (wrap_data
, 1);
8581 bidi_unshelve_cache (ppos_data
, 1);
8583 /* Restore the iterator settings altered at the beginning of this
8585 it
->glyph_row
= saved_glyph_row
;
8589 /* For external use. */
8591 move_it_in_display_line (struct it
*it
,
8592 ptrdiff_t to_charpos
, int to_x
,
8593 enum move_operation_enum op
)
8595 if (it
->line_wrap
== WORD_WRAP
8596 && (op
& MOVE_TO_X
))
8599 void *save_data
= NULL
;
8602 SAVE_IT (save_it
, *it
, save_data
);
8603 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8604 /* When word-wrap is on, TO_X may lie past the end
8605 of a wrapped line. Then it->current is the
8606 character on the next line, so backtrack to the
8607 space before the wrap point. */
8608 if (skip
== MOVE_LINE_CONTINUED
)
8610 int prev_x
= max (it
->current_x
- 1, 0);
8611 RESTORE_IT (it
, &save_it
, save_data
);
8612 move_it_in_display_line_to
8613 (it
, -1, prev_x
, MOVE_TO_X
);
8616 bidi_unshelve_cache (save_data
, 1);
8619 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8623 /* Move IT forward until it satisfies one or more of the criteria in
8624 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8626 OP is a bit-mask that specifies where to stop, and in particular,
8627 which of those four position arguments makes a difference. See the
8628 description of enum move_operation_enum.
8630 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8631 screen line, this function will set IT to the next position that is
8632 displayed to the right of TO_CHARPOS on the screen. */
8635 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8637 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8638 int line_height
, line_start_x
= 0, reached
= 0;
8639 void *backup_data
= NULL
;
8643 if (op
& MOVE_TO_VPOS
)
8645 /* If no TO_CHARPOS and no TO_X specified, stop at the
8646 start of the line TO_VPOS. */
8647 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8649 if (it
->vpos
== to_vpos
)
8655 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8659 /* TO_VPOS >= 0 means stop at TO_X in the line at
8660 TO_VPOS, or at TO_POS, whichever comes first. */
8661 if (it
->vpos
== to_vpos
)
8667 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8669 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8674 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8676 /* We have reached TO_X but not in the line we want. */
8677 skip
= move_it_in_display_line_to (it
, to_charpos
,
8679 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8687 else if (op
& MOVE_TO_Y
)
8689 struct it it_backup
;
8691 if (it
->line_wrap
== WORD_WRAP
)
8692 SAVE_IT (it_backup
, *it
, backup_data
);
8694 /* TO_Y specified means stop at TO_X in the line containing
8695 TO_Y---or at TO_CHARPOS if this is reached first. The
8696 problem is that we can't really tell whether the line
8697 contains TO_Y before we have completely scanned it, and
8698 this may skip past TO_X. What we do is to first scan to
8701 If TO_X is not specified, use a TO_X of zero. The reason
8702 is to make the outcome of this function more predictable.
8703 If we didn't use TO_X == 0, we would stop at the end of
8704 the line which is probably not what a caller would expect
8706 skip
= move_it_in_display_line_to
8707 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8708 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8710 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8711 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8713 else if (skip
== MOVE_X_REACHED
)
8715 /* If TO_X was reached, we want to know whether TO_Y is
8716 in the line. We know this is the case if the already
8717 scanned glyphs make the line tall enough. Otherwise,
8718 we must check by scanning the rest of the line. */
8719 line_height
= it
->max_ascent
+ it
->max_descent
;
8720 if (to_y
>= it
->current_y
8721 && to_y
< it
->current_y
+ line_height
)
8726 SAVE_IT (it_backup
, *it
, backup_data
);
8727 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8728 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8730 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8731 line_height
= it
->max_ascent
+ it
->max_descent
;
8732 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8734 if (to_y
>= it
->current_y
8735 && to_y
< it
->current_y
+ line_height
)
8737 /* If TO_Y is in this line and TO_X was reached
8738 above, we scanned too far. We have to restore
8739 IT's settings to the ones before skipping. But
8740 keep the more accurate values of max_ascent and
8741 max_descent we've found while skipping the rest
8742 of the line, for the sake of callers, such as
8743 pos_visible_p, that need to know the line
8745 int max_ascent
= it
->max_ascent
;
8746 int max_descent
= it
->max_descent
;
8748 RESTORE_IT (it
, &it_backup
, backup_data
);
8749 it
->max_ascent
= max_ascent
;
8750 it
->max_descent
= max_descent
;
8756 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8762 /* Check whether TO_Y is in this line. */
8763 line_height
= it
->max_ascent
+ it
->max_descent
;
8764 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8766 if (to_y
>= it
->current_y
8767 && to_y
< it
->current_y
+ line_height
)
8769 /* When word-wrap is on, TO_X may lie past the end
8770 of a wrapped line. Then it->current is the
8771 character on the next line, so backtrack to the
8772 space before the wrap point. */
8773 if (skip
== MOVE_LINE_CONTINUED
8774 && it
->line_wrap
== WORD_WRAP
)
8776 int prev_x
= max (it
->current_x
- 1, 0);
8777 RESTORE_IT (it
, &it_backup
, backup_data
);
8778 skip
= move_it_in_display_line_to
8779 (it
, -1, prev_x
, MOVE_TO_X
);
8788 else if (BUFFERP (it
->object
)
8789 && (it
->method
== GET_FROM_BUFFER
8790 || it
->method
== GET_FROM_STRETCH
)
8791 && IT_CHARPOS (*it
) >= to_charpos
8792 /* Under bidi iteration, a call to set_iterator_to_next
8793 can scan far beyond to_charpos if the initial
8794 portion of the next line needs to be reordered. In
8795 that case, give move_it_in_display_line_to another
8798 && it
->bidi_it
.scan_dir
== -1))
8799 skip
= MOVE_POS_MATCH_OR_ZV
;
8801 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8805 case MOVE_POS_MATCH_OR_ZV
:
8809 case MOVE_NEWLINE_OR_CR
:
8810 set_iterator_to_next (it
, 1);
8811 it
->continuation_lines_width
= 0;
8814 case MOVE_LINE_TRUNCATED
:
8815 it
->continuation_lines_width
= 0;
8816 reseat_at_next_visible_line_start (it
, 0);
8817 if ((op
& MOVE_TO_POS
) != 0
8818 && IT_CHARPOS (*it
) > to_charpos
)
8825 case MOVE_LINE_CONTINUED
:
8826 /* For continued lines ending in a tab, some of the glyphs
8827 associated with the tab are displayed on the current
8828 line. Since it->current_x does not include these glyphs,
8829 we use it->last_visible_x instead. */
8832 it
->continuation_lines_width
+= it
->last_visible_x
;
8833 /* When moving by vpos, ensure that the iterator really
8834 advances to the next line (bug#847, bug#969). Fixme:
8835 do we need to do this in other circumstances? */
8836 if (it
->current_x
!= it
->last_visible_x
8837 && (op
& MOVE_TO_VPOS
)
8838 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8840 line_start_x
= it
->current_x
+ it
->pixel_width
8841 - it
->last_visible_x
;
8842 set_iterator_to_next (it
, 0);
8846 it
->continuation_lines_width
+= it
->current_x
;
8853 /* Reset/increment for the next run. */
8854 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8855 it
->current_x
= line_start_x
;
8858 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8860 last_height
= it
->max_ascent
+ it
->max_descent
;
8861 last_max_ascent
= it
->max_ascent
;
8862 it
->max_ascent
= it
->max_descent
= 0;
8867 /* On text terminals, we may stop at the end of a line in the middle
8868 of a multi-character glyph. If the glyph itself is continued,
8869 i.e. it is actually displayed on the next line, don't treat this
8870 stopping point as valid; move to the next line instead (unless
8871 that brings us offscreen). */
8872 if (!FRAME_WINDOW_P (it
->f
)
8874 && IT_CHARPOS (*it
) == to_charpos
8875 && it
->what
== IT_CHARACTER
8877 && it
->line_wrap
== WINDOW_WRAP
8878 && it
->current_x
== it
->last_visible_x
- 1
8881 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8883 it
->continuation_lines_width
+= it
->current_x
;
8884 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8885 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8887 last_height
= it
->max_ascent
+ it
->max_descent
;
8888 last_max_ascent
= it
->max_ascent
;
8892 bidi_unshelve_cache (backup_data
, 1);
8894 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8898 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8900 If DY > 0, move IT backward at least that many pixels. DY = 0
8901 means move IT backward to the preceding line start or BEGV. This
8902 function may move over more than DY pixels if IT->current_y - DY
8903 ends up in the middle of a line; in this case IT->current_y will be
8904 set to the top of the line moved to. */
8907 move_it_vertically_backward (struct it
*it
, int dy
)
8911 void *it2data
= NULL
, *it3data
= NULL
;
8912 ptrdiff_t start_pos
;
8917 start_pos
= IT_CHARPOS (*it
);
8919 /* Estimate how many newlines we must move back. */
8920 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8922 /* Set the iterator's position that many lines back. */
8923 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8924 back_to_previous_visible_line_start (it
);
8926 /* Reseat the iterator here. When moving backward, we don't want
8927 reseat to skip forward over invisible text, set up the iterator
8928 to deliver from overlay strings at the new position etc. So,
8929 use reseat_1 here. */
8930 reseat_1 (it
, it
->current
.pos
, 1);
8932 /* We are now surely at a line start. */
8933 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8934 reordering is in effect. */
8935 it
->continuation_lines_width
= 0;
8937 /* Move forward and see what y-distance we moved. First move to the
8938 start of the next line so that we get its height. We need this
8939 height to be able to tell whether we reached the specified
8941 SAVE_IT (it2
, *it
, it2data
);
8942 it2
.max_ascent
= it2
.max_descent
= 0;
8945 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8946 MOVE_TO_POS
| MOVE_TO_VPOS
);
8948 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8949 /* If we are in a display string which starts at START_POS,
8950 and that display string includes a newline, and we are
8951 right after that newline (i.e. at the beginning of a
8952 display line), exit the loop, because otherwise we will
8953 infloop, since move_it_to will see that it is already at
8954 START_POS and will not move. */
8955 || (it2
.method
== GET_FROM_STRING
8956 && IT_CHARPOS (it2
) == start_pos
8957 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8958 eassert (IT_CHARPOS (*it
) >= BEGV
);
8959 SAVE_IT (it3
, it2
, it3data
);
8961 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8962 eassert (IT_CHARPOS (*it
) >= BEGV
);
8963 /* H is the actual vertical distance from the position in *IT
8964 and the starting position. */
8965 h
= it2
.current_y
- it
->current_y
;
8966 /* NLINES is the distance in number of lines. */
8967 nlines
= it2
.vpos
- it
->vpos
;
8969 /* Correct IT's y and vpos position
8970 so that they are relative to the starting point. */
8976 /* DY == 0 means move to the start of the screen line. The
8977 value of nlines is > 0 if continuation lines were involved,
8978 or if the original IT position was at start of a line. */
8979 RESTORE_IT (it
, it
, it2data
);
8981 move_it_by_lines (it
, nlines
);
8982 /* The above code moves us to some position NLINES down,
8983 usually to its first glyph (leftmost in an L2R line), but
8984 that's not necessarily the start of the line, under bidi
8985 reordering. We want to get to the character position
8986 that is immediately after the newline of the previous
8989 && !it
->continuation_lines_width
8990 && !STRINGP (it
->string
)
8991 && IT_CHARPOS (*it
) > BEGV
8992 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8995 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8997 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8999 bidi_unshelve_cache (it3data
, 1);
9003 /* The y-position we try to reach, relative to *IT.
9004 Note that H has been subtracted in front of the if-statement. */
9005 int target_y
= it
->current_y
+ h
- dy
;
9006 int y0
= it3
.current_y
;
9010 RESTORE_IT (&it3
, &it3
, it3data
);
9011 y1
= line_bottom_y (&it3
);
9012 line_height
= y1
- y0
;
9013 RESTORE_IT (it
, it
, it2data
);
9014 /* If we did not reach target_y, try to move further backward if
9015 we can. If we moved too far backward, try to move forward. */
9016 if (target_y
< it
->current_y
9017 /* This is heuristic. In a window that's 3 lines high, with
9018 a line height of 13 pixels each, recentering with point
9019 on the bottom line will try to move -39/2 = 19 pixels
9020 backward. Try to avoid moving into the first line. */
9021 && (it
->current_y
- target_y
9022 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9023 && IT_CHARPOS (*it
) > BEGV
)
9025 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9026 target_y
- it
->current_y
));
9027 dy
= it
->current_y
- target_y
;
9028 goto move_further_back
;
9030 else if (target_y
>= it
->current_y
+ line_height
9031 && IT_CHARPOS (*it
) < ZV
)
9033 /* Should move forward by at least one line, maybe more.
9035 Note: Calling move_it_by_lines can be expensive on
9036 terminal frames, where compute_motion is used (via
9037 vmotion) to do the job, when there are very long lines
9038 and truncate-lines is nil. That's the reason for
9039 treating terminal frames specially here. */
9041 if (!FRAME_WINDOW_P (it
->f
))
9042 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9047 move_it_by_lines (it
, 1);
9049 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9056 /* Move IT by a specified amount of pixel lines DY. DY negative means
9057 move backwards. DY = 0 means move to start of screen line. At the
9058 end, IT will be on the start of a screen line. */
9061 move_it_vertically (struct it
*it
, int dy
)
9064 move_it_vertically_backward (it
, -dy
);
9067 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9068 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9069 MOVE_TO_POS
| MOVE_TO_Y
);
9070 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9072 /* If buffer ends in ZV without a newline, move to the start of
9073 the line to satisfy the post-condition. */
9074 if (IT_CHARPOS (*it
) == ZV
9076 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9077 move_it_by_lines (it
, 0);
9082 /* Move iterator IT past the end of the text line it is in. */
9085 move_it_past_eol (struct it
*it
)
9087 enum move_it_result rc
;
9089 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9090 if (rc
== MOVE_NEWLINE_OR_CR
)
9091 set_iterator_to_next (it
, 0);
9095 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9096 negative means move up. DVPOS == 0 means move to the start of the
9099 Optimization idea: If we would know that IT->f doesn't use
9100 a face with proportional font, we could be faster for
9101 truncate-lines nil. */
9104 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9107 /* The commented-out optimization uses vmotion on terminals. This
9108 gives bad results, because elements like it->what, on which
9109 callers such as pos_visible_p rely, aren't updated. */
9110 /* struct position pos;
9111 if (!FRAME_WINDOW_P (it->f))
9113 struct text_pos textpos;
9115 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9116 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9117 reseat (it, textpos, 1);
9118 it->vpos += pos.vpos;
9119 it->current_y += pos.vpos;
9125 /* DVPOS == 0 means move to the start of the screen line. */
9126 move_it_vertically_backward (it
, 0);
9127 /* Let next call to line_bottom_y calculate real line height */
9132 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9133 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9135 /* Only move to the next buffer position if we ended up in a
9136 string from display property, not in an overlay string
9137 (before-string or after-string). That is because the
9138 latter don't conceal the underlying buffer position, so
9139 we can ask to move the iterator to the exact position we
9140 are interested in. Note that, even if we are already at
9141 IT_CHARPOS (*it), the call below is not a no-op, as it
9142 will detect that we are at the end of the string, pop the
9143 iterator, and compute it->current_x and it->hpos
9145 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9146 -1, -1, -1, MOVE_TO_POS
);
9152 void *it2data
= NULL
;
9153 ptrdiff_t start_charpos
, i
;
9155 /* Start at the beginning of the screen line containing IT's
9156 position. This may actually move vertically backwards,
9157 in case of overlays, so adjust dvpos accordingly. */
9159 move_it_vertically_backward (it
, 0);
9162 /* Go back -DVPOS visible lines and reseat the iterator there. */
9163 start_charpos
= IT_CHARPOS (*it
);
9164 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9165 back_to_previous_visible_line_start (it
);
9166 reseat (it
, it
->current
.pos
, 1);
9168 /* Move further back if we end up in a string or an image. */
9169 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9171 /* First try to move to start of display line. */
9173 move_it_vertically_backward (it
, 0);
9175 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9177 /* If start of line is still in string or image,
9178 move further back. */
9179 back_to_previous_visible_line_start (it
);
9180 reseat (it
, it
->current
.pos
, 1);
9184 it
->current_x
= it
->hpos
= 0;
9186 /* Above call may have moved too far if continuation lines
9187 are involved. Scan forward and see if it did. */
9188 SAVE_IT (it2
, *it
, it2data
);
9189 it2
.vpos
= it2
.current_y
= 0;
9190 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9191 it
->vpos
-= it2
.vpos
;
9192 it
->current_y
-= it2
.current_y
;
9193 it
->current_x
= it
->hpos
= 0;
9195 /* If we moved too far back, move IT some lines forward. */
9196 if (it2
.vpos
> -dvpos
)
9198 int delta
= it2
.vpos
+ dvpos
;
9200 RESTORE_IT (&it2
, &it2
, it2data
);
9201 SAVE_IT (it2
, *it
, it2data
);
9202 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9203 /* Move back again if we got too far ahead. */
9204 if (IT_CHARPOS (*it
) >= start_charpos
)
9205 RESTORE_IT (it
, &it2
, it2data
);
9207 bidi_unshelve_cache (it2data
, 1);
9210 RESTORE_IT (it
, it
, it2data
);
9214 /* Return 1 if IT points into the middle of a display vector. */
9217 in_display_vector_p (struct it
*it
)
9219 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9220 && it
->current
.dpvec_index
> 0
9221 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9225 /***********************************************************************
9227 ***********************************************************************/
9230 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9234 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9236 Lisp_Object args
[3];
9237 Lisp_Object msg
, fmt
;
9240 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9243 /* Do nothing if called asynchronously. Inserting text into
9244 a buffer may call after-change-functions and alike and
9245 that would means running Lisp asynchronously. */
9246 if (handling_signal
)
9250 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9252 args
[0] = fmt
= build_string (format
);
9255 msg
= Fformat (3, args
);
9257 len
= SBYTES (msg
) + 1;
9258 SAFE_ALLOCA (buffer
, char *, len
);
9259 memcpy (buffer
, SDATA (msg
), len
);
9261 message_dolog (buffer
, len
- 1, 1, 0);
9268 /* Output a newline in the *Messages* buffer if "needs" one. */
9271 message_log_maybe_newline (void)
9273 if (message_log_need_newline
)
9274 message_dolog ("", 0, 1, 0);
9278 /* Add a string M of length NBYTES to the message log, optionally
9279 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9280 nonzero, means interpret the contents of M as multibyte. This
9281 function calls low-level routines in order to bypass text property
9282 hooks, etc. which might not be safe to run.
9284 This may GC (insert may run before/after change hooks),
9285 so the buffer M must NOT point to a Lisp string. */
9288 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9290 const unsigned char *msg
= (const unsigned char *) m
;
9292 if (!NILP (Vmemory_full
))
9295 if (!NILP (Vmessage_log_max
))
9297 struct buffer
*oldbuf
;
9298 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9299 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9300 ptrdiff_t point_at_end
= 0;
9301 ptrdiff_t zv_at_end
= 0;
9302 Lisp_Object old_deactivate_mark
, tem
;
9303 struct gcpro gcpro1
;
9305 old_deactivate_mark
= Vdeactivate_mark
;
9306 oldbuf
= current_buffer
;
9307 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9308 BVAR (current_buffer
, undo_list
) = Qt
;
9310 oldpoint
= message_dolog_marker1
;
9311 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9312 oldbegv
= message_dolog_marker2
;
9313 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9314 oldzv
= message_dolog_marker3
;
9315 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9316 GCPRO1 (old_deactivate_mark
);
9324 BEGV_BYTE
= BEG_BYTE
;
9327 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9329 /* Insert the string--maybe converting multibyte to single byte
9330 or vice versa, so that all the text fits the buffer. */
9332 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9338 /* Convert a multibyte string to single-byte
9339 for the *Message* buffer. */
9340 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9342 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9343 work
[0] = (ASCII_CHAR_P (c
)
9345 : multibyte_char_to_unibyte (c
));
9346 insert_1_both (work
, 1, 1, 1, 0, 0);
9349 else if (! multibyte
9350 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9354 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9355 /* Convert a single-byte string to multibyte
9356 for the *Message* buffer. */
9357 for (i
= 0; i
< nbytes
; i
++)
9360 MAKE_CHAR_MULTIBYTE (c
);
9361 char_bytes
= CHAR_STRING (c
, str
);
9362 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9366 insert_1 (m
, nbytes
, 1, 0, 0);
9370 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9372 insert_1 ("\n", 1, 1, 0, 0);
9374 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9376 this_bol_byte
= PT_BYTE
;
9378 /* See if this line duplicates the previous one.
9379 If so, combine duplicates. */
9382 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9384 prev_bol_byte
= PT_BYTE
;
9386 dups
= message_log_check_duplicate (prev_bol_byte
,
9390 del_range_both (prev_bol
, prev_bol_byte
,
9391 this_bol
, this_bol_byte
, 0);
9394 char dupstr
[sizeof " [ times]"
9395 + INT_STRLEN_BOUND (printmax_t
)];
9397 /* If you change this format, don't forget to also
9398 change message_log_check_duplicate. */
9399 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9400 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9401 insert_1 (dupstr
, duplen
, 1, 0, 1);
9406 /* If we have more than the desired maximum number of lines
9407 in the *Messages* buffer now, delete the oldest ones.
9408 This is safe because we don't have undo in this buffer. */
9410 if (NATNUMP (Vmessage_log_max
))
9412 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9413 -XFASTINT (Vmessage_log_max
) - 1, 0);
9414 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9417 BEGV
= XMARKER (oldbegv
)->charpos
;
9418 BEGV_BYTE
= marker_byte_position (oldbegv
);
9427 ZV
= XMARKER (oldzv
)->charpos
;
9428 ZV_BYTE
= marker_byte_position (oldzv
);
9432 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9434 /* We can't do Fgoto_char (oldpoint) because it will run some
9436 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9437 XMARKER (oldpoint
)->bytepos
);
9440 unchain_marker (XMARKER (oldpoint
));
9441 unchain_marker (XMARKER (oldbegv
));
9442 unchain_marker (XMARKER (oldzv
));
9444 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9445 set_buffer_internal (oldbuf
);
9447 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9448 message_log_need_newline
= !nlflag
;
9449 Vdeactivate_mark
= old_deactivate_mark
;
9454 /* We are at the end of the buffer after just having inserted a newline.
9455 (Note: We depend on the fact we won't be crossing the gap.)
9456 Check to see if the most recent message looks a lot like the previous one.
9457 Return 0 if different, 1 if the new one should just replace it, or a
9458 value N > 1 if we should also append " [N times]". */
9461 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9464 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9466 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9467 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9469 for (i
= 0; i
< len
; i
++)
9471 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9479 if (*p1
++ == ' ' && *p1
++ == '[')
9482 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9483 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9490 /* Display an echo area message M with a specified length of NBYTES
9491 bytes. The string may include null characters. If M is 0, clear
9492 out any existing message, and let the mini-buffer text show
9495 This may GC, so the buffer M must NOT point to a Lisp string. */
9498 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9500 /* First flush out any partial line written with print. */
9501 message_log_maybe_newline ();
9503 message_dolog (m
, nbytes
, 1, multibyte
);
9504 message2_nolog (m
, nbytes
, multibyte
);
9508 /* The non-logging counterpart of message2. */
9511 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9513 struct frame
*sf
= SELECTED_FRAME ();
9514 message_enable_multibyte
= multibyte
;
9516 if (FRAME_INITIAL_P (sf
))
9518 if (noninteractive_need_newline
)
9519 putc ('\n', stderr
);
9520 noninteractive_need_newline
= 0;
9522 fwrite (m
, nbytes
, 1, stderr
);
9523 if (cursor_in_echo_area
== 0)
9524 fprintf (stderr
, "\n");
9527 /* A null message buffer means that the frame hasn't really been
9528 initialized yet. Error messages get reported properly by
9529 cmd_error, so this must be just an informative message; toss it. */
9530 else if (INTERACTIVE
9531 && sf
->glyphs_initialized_p
9532 && FRAME_MESSAGE_BUF (sf
))
9534 Lisp_Object mini_window
;
9537 /* Get the frame containing the mini-buffer
9538 that the selected frame is using. */
9539 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9540 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9542 FRAME_SAMPLE_VISIBILITY (f
);
9543 if (FRAME_VISIBLE_P (sf
)
9544 && ! FRAME_VISIBLE_P (f
))
9545 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9549 set_message (m
, Qnil
, nbytes
, multibyte
);
9550 if (minibuffer_auto_raise
)
9551 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9554 clear_message (1, 1);
9556 do_pending_window_change (0);
9557 echo_area_display (1);
9558 do_pending_window_change (0);
9559 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9560 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9565 /* Display an echo area message M with a specified length of NBYTES
9566 bytes. The string may include null characters. If M is not a
9567 string, clear out any existing message, and let the mini-buffer
9570 This function cancels echoing. */
9573 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9575 struct gcpro gcpro1
;
9578 clear_message (1,1);
9581 /* First flush out any partial line written with print. */
9582 message_log_maybe_newline ();
9588 SAFE_ALLOCA (buffer
, char *, nbytes
);
9589 memcpy (buffer
, SDATA (m
), nbytes
);
9590 message_dolog (buffer
, nbytes
, 1, multibyte
);
9593 message3_nolog (m
, nbytes
, multibyte
);
9599 /* The non-logging version of message3.
9600 This does not cancel echoing, because it is used for echoing.
9601 Perhaps we need to make a separate function for echoing
9602 and make this cancel echoing. */
9605 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9607 struct frame
*sf
= SELECTED_FRAME ();
9608 message_enable_multibyte
= multibyte
;
9610 if (FRAME_INITIAL_P (sf
))
9612 if (noninteractive_need_newline
)
9613 putc ('\n', stderr
);
9614 noninteractive_need_newline
= 0;
9616 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9617 if (cursor_in_echo_area
== 0)
9618 fprintf (stderr
, "\n");
9621 /* A null message buffer means that the frame hasn't really been
9622 initialized yet. Error messages get reported properly by
9623 cmd_error, so this must be just an informative message; toss it. */
9624 else if (INTERACTIVE
9625 && sf
->glyphs_initialized_p
9626 && FRAME_MESSAGE_BUF (sf
))
9628 Lisp_Object mini_window
;
9632 /* Get the frame containing the mini-buffer
9633 that the selected frame is using. */
9634 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9635 frame
= XWINDOW (mini_window
)->frame
;
9638 FRAME_SAMPLE_VISIBILITY (f
);
9639 if (FRAME_VISIBLE_P (sf
)
9640 && !FRAME_VISIBLE_P (f
))
9641 Fmake_frame_visible (frame
);
9643 if (STRINGP (m
) && SCHARS (m
) > 0)
9645 set_message (NULL
, m
, nbytes
, multibyte
);
9646 if (minibuffer_auto_raise
)
9647 Fraise_frame (frame
);
9648 /* Assume we are not echoing.
9649 (If we are, echo_now will override this.) */
9650 echo_message_buffer
= Qnil
;
9653 clear_message (1, 1);
9655 do_pending_window_change (0);
9656 echo_area_display (1);
9657 do_pending_window_change (0);
9658 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9659 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9664 /* Display a null-terminated echo area message M. If M is 0, clear
9665 out any existing message, and let the mini-buffer text show through.
9667 The buffer M must continue to exist until after the echo area gets
9668 cleared or some other message gets displayed there. Do not pass
9669 text that is stored in a Lisp string. Do not pass text in a buffer
9670 that was alloca'd. */
9673 message1 (const char *m
)
9675 message2 (m
, (m
? strlen (m
) : 0), 0);
9679 /* The non-logging counterpart of message1. */
9682 message1_nolog (const char *m
)
9684 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9687 /* Display a message M which contains a single %s
9688 which gets replaced with STRING. */
9691 message_with_string (const char *m
, Lisp_Object string
, int log
)
9693 CHECK_STRING (string
);
9699 if (noninteractive_need_newline
)
9700 putc ('\n', stderr
);
9701 noninteractive_need_newline
= 0;
9702 fprintf (stderr
, m
, SDATA (string
));
9703 if (!cursor_in_echo_area
)
9704 fprintf (stderr
, "\n");
9708 else if (INTERACTIVE
)
9710 /* The frame whose minibuffer we're going to display the message on.
9711 It may be larger than the selected frame, so we need
9712 to use its buffer, not the selected frame's buffer. */
9713 Lisp_Object mini_window
;
9714 struct frame
*f
, *sf
= SELECTED_FRAME ();
9716 /* Get the frame containing the minibuffer
9717 that the selected frame is using. */
9718 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9719 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9721 /* A null message buffer means that the frame hasn't really been
9722 initialized yet. Error messages get reported properly by
9723 cmd_error, so this must be just an informative message; toss it. */
9724 if (FRAME_MESSAGE_BUF (f
))
9726 Lisp_Object args
[2], msg
;
9727 struct gcpro gcpro1
, gcpro2
;
9729 args
[0] = build_string (m
);
9730 args
[1] = msg
= string
;
9731 GCPRO2 (args
[0], msg
);
9734 msg
= Fformat (2, args
);
9737 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9739 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9743 /* Print should start at the beginning of the message
9744 buffer next time. */
9745 message_buf_print
= 0;
9751 /* Dump an informative message to the minibuf. If M is 0, clear out
9752 any existing message, and let the mini-buffer text show through. */
9755 vmessage (const char *m
, va_list ap
)
9761 if (noninteractive_need_newline
)
9762 putc ('\n', stderr
);
9763 noninteractive_need_newline
= 0;
9764 vfprintf (stderr
, m
, ap
);
9765 if (cursor_in_echo_area
== 0)
9766 fprintf (stderr
, "\n");
9770 else if (INTERACTIVE
)
9772 /* The frame whose mini-buffer we're going to display the message
9773 on. It may be larger than the selected frame, so we need to
9774 use its buffer, not the selected frame's buffer. */
9775 Lisp_Object mini_window
;
9776 struct frame
*f
, *sf
= SELECTED_FRAME ();
9778 /* Get the frame containing the mini-buffer
9779 that the selected frame is using. */
9780 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9781 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9783 /* A null message buffer means that the frame hasn't really been
9784 initialized yet. Error messages get reported properly by
9785 cmd_error, so this must be just an informative message; toss
9787 if (FRAME_MESSAGE_BUF (f
))
9793 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9794 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9796 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9801 /* Print should start at the beginning of the message
9802 buffer next time. */
9803 message_buf_print
= 0;
9809 message (const char *m
, ...)
9819 /* The non-logging version of message. */
9822 message_nolog (const char *m
, ...)
9824 Lisp_Object old_log_max
;
9827 old_log_max
= Vmessage_log_max
;
9828 Vmessage_log_max
= Qnil
;
9830 Vmessage_log_max
= old_log_max
;
9836 /* Display the current message in the current mini-buffer. This is
9837 only called from error handlers in process.c, and is not time
9841 update_echo_area (void)
9843 if (!NILP (echo_area_buffer
[0]))
9846 string
= Fcurrent_message ();
9847 message3 (string
, SBYTES (string
),
9848 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9853 /* Make sure echo area buffers in `echo_buffers' are live.
9854 If they aren't, make new ones. */
9857 ensure_echo_area_buffers (void)
9861 for (i
= 0; i
< 2; ++i
)
9862 if (!BUFFERP (echo_buffer
[i
])
9863 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9866 Lisp_Object old_buffer
;
9869 old_buffer
= echo_buffer
[i
];
9870 echo_buffer
[i
] = Fget_buffer_create
9871 (make_formatted_string (name
, " *Echo Area %d*", i
));
9872 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9873 /* to force word wrap in echo area -
9874 it was decided to postpone this*/
9875 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9877 for (j
= 0; j
< 2; ++j
)
9878 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9879 echo_area_buffer
[j
] = echo_buffer
[i
];
9884 /* Call FN with args A1..A4 with either the current or last displayed
9885 echo_area_buffer as current buffer.
9887 WHICH zero means use the current message buffer
9888 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9889 from echo_buffer[] and clear it.
9891 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9892 suitable buffer from echo_buffer[] and clear it.
9894 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9895 that the current message becomes the last displayed one, make
9896 choose a suitable buffer for echo_area_buffer[0], and clear it.
9898 Value is what FN returns. */
9901 with_echo_area_buffer (struct window
*w
, int which
,
9902 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9903 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9906 int this_one
, the_other
, clear_buffer_p
, rc
;
9907 ptrdiff_t count
= SPECPDL_INDEX ();
9909 /* If buffers aren't live, make new ones. */
9910 ensure_echo_area_buffers ();
9915 this_one
= 0, the_other
= 1;
9917 this_one
= 1, the_other
= 0;
9920 this_one
= 0, the_other
= 1;
9923 /* We need a fresh one in case the current echo buffer equals
9924 the one containing the last displayed echo area message. */
9925 if (!NILP (echo_area_buffer
[this_one
])
9926 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9927 echo_area_buffer
[this_one
] = Qnil
;
9930 /* Choose a suitable buffer from echo_buffer[] is we don't
9932 if (NILP (echo_area_buffer
[this_one
]))
9934 echo_area_buffer
[this_one
]
9935 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9936 ? echo_buffer
[the_other
]
9937 : echo_buffer
[this_one
]);
9941 buffer
= echo_area_buffer
[this_one
];
9943 /* Don't get confused by reusing the buffer used for echoing
9944 for a different purpose. */
9945 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9948 record_unwind_protect (unwind_with_echo_area_buffer
,
9949 with_echo_area_buffer_unwind_data (w
));
9951 /* Make the echo area buffer current. Note that for display
9952 purposes, it is not necessary that the displayed window's buffer
9953 == current_buffer, except for text property lookup. So, let's
9954 only set that buffer temporarily here without doing a full
9955 Fset_window_buffer. We must also change w->pointm, though,
9956 because otherwise an assertions in unshow_buffer fails, and Emacs
9958 set_buffer_internal_1 (XBUFFER (buffer
));
9962 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9965 BVAR (current_buffer
, undo_list
) = Qt
;
9966 BVAR (current_buffer
, read_only
) = Qnil
;
9967 specbind (Qinhibit_read_only
, Qt
);
9968 specbind (Qinhibit_modification_hooks
, Qt
);
9970 if (clear_buffer_p
&& Z
> BEG
)
9973 eassert (BEGV
>= BEG
);
9974 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9976 rc
= fn (a1
, a2
, a3
, a4
);
9978 eassert (BEGV
>= BEG
);
9979 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9981 unbind_to (count
, Qnil
);
9986 /* Save state that should be preserved around the call to the function
9987 FN called in with_echo_area_buffer. */
9990 with_echo_area_buffer_unwind_data (struct window
*w
)
9993 Lisp_Object vector
, tmp
;
9995 /* Reduce consing by keeping one vector in
9996 Vwith_echo_area_save_vector. */
9997 vector
= Vwith_echo_area_save_vector
;
9998 Vwith_echo_area_save_vector
= Qnil
;
10001 vector
= Fmake_vector (make_number (7), Qnil
);
10003 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10004 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10005 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10009 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10010 ASET (vector
, i
, w
->buffer
); ++i
;
10011 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10012 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10017 for (; i
< end
; ++i
)
10018 ASET (vector
, i
, Qnil
);
10021 eassert (i
== ASIZE (vector
));
10026 /* Restore global state from VECTOR which was created by
10027 with_echo_area_buffer_unwind_data. */
10030 unwind_with_echo_area_buffer (Lisp_Object vector
)
10032 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10033 Vdeactivate_mark
= AREF (vector
, 1);
10034 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10036 if (WINDOWP (AREF (vector
, 3)))
10039 Lisp_Object buffer
, charpos
, bytepos
;
10041 w
= XWINDOW (AREF (vector
, 3));
10042 buffer
= AREF (vector
, 4);
10043 charpos
= AREF (vector
, 5);
10044 bytepos
= AREF (vector
, 6);
10046 w
->buffer
= buffer
;
10047 set_marker_both (w
->pointm
, buffer
,
10048 XFASTINT (charpos
), XFASTINT (bytepos
));
10051 Vwith_echo_area_save_vector
= vector
;
10056 /* Set up the echo area for use by print functions. MULTIBYTE_P
10057 non-zero means we will print multibyte. */
10060 setup_echo_area_for_printing (int multibyte_p
)
10062 /* If we can't find an echo area any more, exit. */
10063 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10064 Fkill_emacs (Qnil
);
10066 ensure_echo_area_buffers ();
10068 if (!message_buf_print
)
10070 /* A message has been output since the last time we printed.
10071 Choose a fresh echo area buffer. */
10072 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10073 echo_area_buffer
[0] = echo_buffer
[1];
10075 echo_area_buffer
[0] = echo_buffer
[0];
10077 /* Switch to that buffer and clear it. */
10078 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10079 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10083 ptrdiff_t count
= SPECPDL_INDEX ();
10084 specbind (Qinhibit_read_only
, Qt
);
10085 /* Note that undo recording is always disabled. */
10086 del_range (BEG
, Z
);
10087 unbind_to (count
, Qnil
);
10089 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10091 /* Set up the buffer for the multibyteness we need. */
10093 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10094 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10096 /* Raise the frame containing the echo area. */
10097 if (minibuffer_auto_raise
)
10099 struct frame
*sf
= SELECTED_FRAME ();
10100 Lisp_Object mini_window
;
10101 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10102 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10105 message_log_maybe_newline ();
10106 message_buf_print
= 1;
10110 if (NILP (echo_area_buffer
[0]))
10112 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10113 echo_area_buffer
[0] = echo_buffer
[1];
10115 echo_area_buffer
[0] = echo_buffer
[0];
10118 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10120 /* Someone switched buffers between print requests. */
10121 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10122 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10128 /* Display an echo area message in window W. Value is non-zero if W's
10129 height is changed. If display_last_displayed_message_p is
10130 non-zero, display the message that was last displayed, otherwise
10131 display the current message. */
10134 display_echo_area (struct window
*w
)
10136 int i
, no_message_p
, window_height_changed_p
;
10138 /* Temporarily disable garbage collections while displaying the echo
10139 area. This is done because a GC can print a message itself.
10140 That message would modify the echo area buffer's contents while a
10141 redisplay of the buffer is going on, and seriously confuse
10143 ptrdiff_t count
= inhibit_garbage_collection ();
10145 /* If there is no message, we must call display_echo_area_1
10146 nevertheless because it resizes the window. But we will have to
10147 reset the echo_area_buffer in question to nil at the end because
10148 with_echo_area_buffer will sets it to an empty buffer. */
10149 i
= display_last_displayed_message_p
? 1 : 0;
10150 no_message_p
= NILP (echo_area_buffer
[i
]);
10152 window_height_changed_p
10153 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10154 display_echo_area_1
,
10155 (intptr_t) w
, Qnil
, 0, 0);
10158 echo_area_buffer
[i
] = Qnil
;
10160 unbind_to (count
, Qnil
);
10161 return window_height_changed_p
;
10165 /* Helper for display_echo_area. Display the current buffer which
10166 contains the current echo area message in window W, a mini-window,
10167 a pointer to which is passed in A1. A2..A4 are currently not used.
10168 Change the height of W so that all of the message is displayed.
10169 Value is non-zero if height of W was changed. */
10172 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10175 struct window
*w
= (struct window
*) i1
;
10176 Lisp_Object window
;
10177 struct text_pos start
;
10178 int window_height_changed_p
= 0;
10180 /* Do this before displaying, so that we have a large enough glyph
10181 matrix for the display. If we can't get enough space for the
10182 whole text, display the last N lines. That works by setting w->start. */
10183 window_height_changed_p
= resize_mini_window (w
, 0);
10185 /* Use the starting position chosen by resize_mini_window. */
10186 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10189 clear_glyph_matrix (w
->desired_matrix
);
10190 XSETWINDOW (window
, w
);
10191 try_window (window
, start
, 0);
10193 return window_height_changed_p
;
10197 /* Resize the echo area window to exactly the size needed for the
10198 currently displayed message, if there is one. If a mini-buffer
10199 is active, don't shrink it. */
10202 resize_echo_area_exactly (void)
10204 if (BUFFERP (echo_area_buffer
[0])
10205 && WINDOWP (echo_area_window
))
10207 struct window
*w
= XWINDOW (echo_area_window
);
10209 Lisp_Object resize_exactly
;
10211 if (minibuf_level
== 0)
10212 resize_exactly
= Qt
;
10214 resize_exactly
= Qnil
;
10216 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10217 (intptr_t) w
, resize_exactly
,
10221 ++windows_or_buffers_changed
;
10222 ++update_mode_lines
;
10223 redisplay_internal ();
10229 /* Callback function for with_echo_area_buffer, when used from
10230 resize_echo_area_exactly. A1 contains a pointer to the window to
10231 resize, EXACTLY non-nil means resize the mini-window exactly to the
10232 size of the text displayed. A3 and A4 are not used. Value is what
10233 resize_mini_window returns. */
10236 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10239 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10243 /* Resize mini-window W to fit the size of its contents. EXACT_P
10244 means size the window exactly to the size needed. Otherwise, it's
10245 only enlarged until W's buffer is empty.
10247 Set W->start to the right place to begin display. If the whole
10248 contents fit, start at the beginning. Otherwise, start so as
10249 to make the end of the contents appear. This is particularly
10250 important for y-or-n-p, but seems desirable generally.
10252 Value is non-zero if the window height has been changed. */
10255 resize_mini_window (struct window
*w
, int exact_p
)
10257 struct frame
*f
= XFRAME (w
->frame
);
10258 int window_height_changed_p
= 0;
10260 eassert (MINI_WINDOW_P (w
));
10262 /* By default, start display at the beginning. */
10263 set_marker_both (w
->start
, w
->buffer
,
10264 BUF_BEGV (XBUFFER (w
->buffer
)),
10265 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10267 /* Don't resize windows while redisplaying a window; it would
10268 confuse redisplay functions when the size of the window they are
10269 displaying changes from under them. Such a resizing can happen,
10270 for instance, when which-func prints a long message while
10271 we are running fontification-functions. We're running these
10272 functions with safe_call which binds inhibit-redisplay to t. */
10273 if (!NILP (Vinhibit_redisplay
))
10276 /* Nil means don't try to resize. */
10277 if (NILP (Vresize_mini_windows
)
10278 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10281 if (!FRAME_MINIBUF_ONLY_P (f
))
10284 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10285 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10287 EMACS_INT max_height
;
10288 int unit
= FRAME_LINE_HEIGHT (f
);
10289 struct text_pos start
;
10290 struct buffer
*old_current_buffer
= NULL
;
10292 if (current_buffer
!= XBUFFER (w
->buffer
))
10294 old_current_buffer
= current_buffer
;
10295 set_buffer_internal (XBUFFER (w
->buffer
));
10298 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10300 /* Compute the max. number of lines specified by the user. */
10301 if (FLOATP (Vmax_mini_window_height
))
10302 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10303 else if (INTEGERP (Vmax_mini_window_height
))
10304 max_height
= XINT (Vmax_mini_window_height
);
10306 max_height
= total_height
/ 4;
10308 /* Correct that max. height if it's bogus. */
10309 max_height
= max (1, max_height
);
10310 max_height
= min (total_height
, max_height
);
10312 /* Find out the height of the text in the window. */
10313 if (it
.line_wrap
== TRUNCATE
)
10318 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10319 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10320 height
= it
.current_y
+ last_height
;
10322 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10323 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10324 height
= (height
+ unit
- 1) / unit
;
10327 /* Compute a suitable window start. */
10328 if (height
> max_height
)
10330 height
= max_height
;
10331 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10332 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10333 start
= it
.current
.pos
;
10336 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10337 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10339 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10341 /* Let it grow only, until we display an empty message, in which
10342 case the window shrinks again. */
10343 if (height
> WINDOW_TOTAL_LINES (w
))
10345 int old_height
= WINDOW_TOTAL_LINES (w
);
10346 freeze_window_starts (f
, 1);
10347 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10348 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10350 else if (height
< WINDOW_TOTAL_LINES (w
)
10351 && (exact_p
|| BEGV
== ZV
))
10353 int old_height
= WINDOW_TOTAL_LINES (w
);
10354 freeze_window_starts (f
, 0);
10355 shrink_mini_window (w
);
10356 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10361 /* Always resize to exact size needed. */
10362 if (height
> WINDOW_TOTAL_LINES (w
))
10364 int old_height
= WINDOW_TOTAL_LINES (w
);
10365 freeze_window_starts (f
, 1);
10366 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10367 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10369 else if (height
< WINDOW_TOTAL_LINES (w
))
10371 int old_height
= WINDOW_TOTAL_LINES (w
);
10372 freeze_window_starts (f
, 0);
10373 shrink_mini_window (w
);
10377 freeze_window_starts (f
, 1);
10378 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10381 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10385 if (old_current_buffer
)
10386 set_buffer_internal (old_current_buffer
);
10389 return window_height_changed_p
;
10393 /* Value is the current message, a string, or nil if there is no
10394 current message. */
10397 current_message (void)
10401 if (!BUFFERP (echo_area_buffer
[0]))
10405 with_echo_area_buffer (0, 0, current_message_1
,
10406 (intptr_t) &msg
, Qnil
, 0, 0);
10408 echo_area_buffer
[0] = Qnil
;
10416 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10419 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10422 *msg
= make_buffer_string (BEG
, Z
, 1);
10429 /* Push the current message on Vmessage_stack for later restoration
10430 by restore_message. Value is non-zero if the current message isn't
10431 empty. This is a relatively infrequent operation, so it's not
10432 worth optimizing. */
10435 push_message (void)
10438 msg
= current_message ();
10439 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10440 return STRINGP (msg
);
10444 /* Restore message display from the top of Vmessage_stack. */
10447 restore_message (void)
10451 eassert (CONSP (Vmessage_stack
));
10452 msg
= XCAR (Vmessage_stack
);
10454 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10456 message3_nolog (msg
, 0, 0);
10460 /* Handler for record_unwind_protect calling pop_message. */
10463 pop_message_unwind (Lisp_Object dummy
)
10469 /* Pop the top-most entry off Vmessage_stack. */
10474 eassert (CONSP (Vmessage_stack
));
10475 Vmessage_stack
= XCDR (Vmessage_stack
);
10479 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10480 exits. If the stack is not empty, we have a missing pop_message
10484 check_message_stack (void)
10486 if (!NILP (Vmessage_stack
))
10491 /* Truncate to NCHARS what will be displayed in the echo area the next
10492 time we display it---but don't redisplay it now. */
10495 truncate_echo_area (ptrdiff_t nchars
)
10498 echo_area_buffer
[0] = Qnil
;
10499 /* A null message buffer means that the frame hasn't really been
10500 initialized yet. Error messages get reported properly by
10501 cmd_error, so this must be just an informative message; toss it. */
10502 else if (!noninteractive
10504 && !NILP (echo_area_buffer
[0]))
10506 struct frame
*sf
= SELECTED_FRAME ();
10507 if (FRAME_MESSAGE_BUF (sf
))
10508 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10513 /* Helper function for truncate_echo_area. Truncate the current
10514 message to at most NCHARS characters. */
10517 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10519 if (BEG
+ nchars
< Z
)
10520 del_range (BEG
+ nchars
, Z
);
10522 echo_area_buffer
[0] = Qnil
;
10527 /* Set the current message to a substring of S or STRING.
10529 If STRING is a Lisp string, set the message to the first NBYTES
10530 bytes from STRING. NBYTES zero means use the whole string. If
10531 STRING is multibyte, the message will be displayed multibyte.
10533 If S is not null, set the message to the first LEN bytes of S. LEN
10534 zero means use the whole string. MULTIBYTE_P non-zero means S is
10535 multibyte. Display the message multibyte in that case.
10537 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10538 to t before calling set_message_1 (which calls insert).
10542 set_message (const char *s
, Lisp_Object string
,
10543 ptrdiff_t nbytes
, int multibyte_p
)
10545 message_enable_multibyte
10546 = ((s
&& multibyte_p
)
10547 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10549 with_echo_area_buffer (0, -1, set_message_1
,
10550 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10551 message_buf_print
= 0;
10552 help_echo_showing_p
= 0;
10556 /* Helper function for set_message. Arguments have the same meaning
10557 as there, with A1 corresponding to S and A2 corresponding to STRING
10558 This function is called with the echo area buffer being
10562 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10565 const char *s
= (const char *) i1
;
10566 const unsigned char *msg
= (const unsigned char *) s
;
10567 Lisp_Object string
= a2
;
10569 /* Change multibyteness of the echo buffer appropriately. */
10570 if (message_enable_multibyte
10571 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10572 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10574 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10575 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10576 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10578 /* Insert new message at BEG. */
10579 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10581 if (STRINGP (string
))
10586 nbytes
= SBYTES (string
);
10587 nchars
= string_byte_to_char (string
, nbytes
);
10589 /* This function takes care of single/multibyte conversion. We
10590 just have to ensure that the echo area buffer has the right
10591 setting of enable_multibyte_characters. */
10592 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10597 nbytes
= strlen (s
);
10599 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10601 /* Convert from multi-byte to single-byte. */
10606 /* Convert a multibyte string to single-byte. */
10607 for (i
= 0; i
< nbytes
; i
+= n
)
10609 c
= string_char_and_length (msg
+ i
, &n
);
10610 work
[0] = (ASCII_CHAR_P (c
)
10612 : multibyte_char_to_unibyte (c
));
10613 insert_1_both (work
, 1, 1, 1, 0, 0);
10616 else if (!multibyte_p
10617 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10619 /* Convert from single-byte to multi-byte. */
10622 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10624 /* Convert a single-byte string to multibyte. */
10625 for (i
= 0; i
< nbytes
; i
++)
10628 MAKE_CHAR_MULTIBYTE (c
);
10629 n
= CHAR_STRING (c
, str
);
10630 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10634 insert_1 (s
, nbytes
, 1, 0, 0);
10641 /* Clear messages. CURRENT_P non-zero means clear the current
10642 message. LAST_DISPLAYED_P non-zero means clear the message
10646 clear_message (int current_p
, int last_displayed_p
)
10650 echo_area_buffer
[0] = Qnil
;
10651 message_cleared_p
= 1;
10654 if (last_displayed_p
)
10655 echo_area_buffer
[1] = Qnil
;
10657 message_buf_print
= 0;
10660 /* Clear garbaged frames.
10662 This function is used where the old redisplay called
10663 redraw_garbaged_frames which in turn called redraw_frame which in
10664 turn called clear_frame. The call to clear_frame was a source of
10665 flickering. I believe a clear_frame is not necessary. It should
10666 suffice in the new redisplay to invalidate all current matrices,
10667 and ensure a complete redisplay of all windows. */
10670 clear_garbaged_frames (void)
10672 if (frame_garbaged
)
10674 Lisp_Object tail
, frame
;
10675 int changed_count
= 0;
10677 FOR_EACH_FRAME (tail
, frame
)
10679 struct frame
*f
= XFRAME (frame
);
10681 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10685 Fredraw_frame (frame
);
10686 f
->force_flush_display_p
= 1;
10688 clear_current_matrices (f
);
10695 frame_garbaged
= 0;
10697 ++windows_or_buffers_changed
;
10702 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10703 is non-zero update selected_frame. Value is non-zero if the
10704 mini-windows height has been changed. */
10707 echo_area_display (int update_frame_p
)
10709 Lisp_Object mini_window
;
10712 int window_height_changed_p
= 0;
10713 struct frame
*sf
= SELECTED_FRAME ();
10715 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10716 w
= XWINDOW (mini_window
);
10717 f
= XFRAME (WINDOW_FRAME (w
));
10719 /* Don't display if frame is invisible or not yet initialized. */
10720 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10723 #ifdef HAVE_WINDOW_SYSTEM
10724 /* When Emacs starts, selected_frame may be the initial terminal
10725 frame. If we let this through, a message would be displayed on
10727 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10729 #endif /* HAVE_WINDOW_SYSTEM */
10731 /* Redraw garbaged frames. */
10732 if (frame_garbaged
)
10733 clear_garbaged_frames ();
10735 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10737 echo_area_window
= mini_window
;
10738 window_height_changed_p
= display_echo_area (w
);
10739 w
->must_be_updated_p
= 1;
10741 /* Update the display, unless called from redisplay_internal.
10742 Also don't update the screen during redisplay itself. The
10743 update will happen at the end of redisplay, and an update
10744 here could cause confusion. */
10745 if (update_frame_p
&& !redisplaying_p
)
10749 /* If the display update has been interrupted by pending
10750 input, update mode lines in the frame. Due to the
10751 pending input, it might have been that redisplay hasn't
10752 been called, so that mode lines above the echo area are
10753 garbaged. This looks odd, so we prevent it here. */
10754 if (!display_completed
)
10755 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10757 if (window_height_changed_p
10758 /* Don't do this if Emacs is shutting down. Redisplay
10759 needs to run hooks. */
10760 && !NILP (Vrun_hooks
))
10762 /* Must update other windows. Likewise as in other
10763 cases, don't let this update be interrupted by
10765 ptrdiff_t count
= SPECPDL_INDEX ();
10766 specbind (Qredisplay_dont_pause
, Qt
);
10767 windows_or_buffers_changed
= 1;
10768 redisplay_internal ();
10769 unbind_to (count
, Qnil
);
10771 else if (FRAME_WINDOW_P (f
) && n
== 0)
10773 /* Window configuration is the same as before.
10774 Can do with a display update of the echo area,
10775 unless we displayed some mode lines. */
10776 update_single_window (w
, 1);
10777 FRAME_RIF (f
)->flush_display (f
);
10780 update_frame (f
, 1, 1);
10782 /* If cursor is in the echo area, make sure that the next
10783 redisplay displays the minibuffer, so that the cursor will
10784 be replaced with what the minibuffer wants. */
10785 if (cursor_in_echo_area
)
10786 ++windows_or_buffers_changed
;
10789 else if (!EQ (mini_window
, selected_window
))
10790 windows_or_buffers_changed
++;
10792 /* Last displayed message is now the current message. */
10793 echo_area_buffer
[1] = echo_area_buffer
[0];
10794 /* Inform read_char that we're not echoing. */
10795 echo_message_buffer
= Qnil
;
10797 /* Prevent redisplay optimization in redisplay_internal by resetting
10798 this_line_start_pos. This is done because the mini-buffer now
10799 displays the message instead of its buffer text. */
10800 if (EQ (mini_window
, selected_window
))
10801 CHARPOS (this_line_start_pos
) = 0;
10803 return window_height_changed_p
;
10808 /***********************************************************************
10809 Mode Lines and Frame Titles
10810 ***********************************************************************/
10812 /* A buffer for constructing non-propertized mode-line strings and
10813 frame titles in it; allocated from the heap in init_xdisp and
10814 resized as needed in store_mode_line_noprop_char. */
10816 static char *mode_line_noprop_buf
;
10818 /* The buffer's end, and a current output position in it. */
10820 static char *mode_line_noprop_buf_end
;
10821 static char *mode_line_noprop_ptr
;
10823 #define MODE_LINE_NOPROP_LEN(start) \
10824 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10827 MODE_LINE_DISPLAY
= 0,
10831 } mode_line_target
;
10833 /* Alist that caches the results of :propertize.
10834 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10835 static Lisp_Object mode_line_proptrans_alist
;
10837 /* List of strings making up the mode-line. */
10838 static Lisp_Object mode_line_string_list
;
10840 /* Base face property when building propertized mode line string. */
10841 static Lisp_Object mode_line_string_face
;
10842 static Lisp_Object mode_line_string_face_prop
;
10845 /* Unwind data for mode line strings */
10847 static Lisp_Object Vmode_line_unwind_vector
;
10850 format_mode_line_unwind_data (struct frame
*target_frame
,
10851 struct buffer
*obuf
,
10853 int save_proptrans
)
10855 Lisp_Object vector
, tmp
;
10857 /* Reduce consing by keeping one vector in
10858 Vwith_echo_area_save_vector. */
10859 vector
= Vmode_line_unwind_vector
;
10860 Vmode_line_unwind_vector
= Qnil
;
10863 vector
= Fmake_vector (make_number (10), Qnil
);
10865 ASET (vector
, 0, make_number (mode_line_target
));
10866 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10867 ASET (vector
, 2, mode_line_string_list
);
10868 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10869 ASET (vector
, 4, mode_line_string_face
);
10870 ASET (vector
, 5, mode_line_string_face_prop
);
10873 XSETBUFFER (tmp
, obuf
);
10876 ASET (vector
, 6, tmp
);
10877 ASET (vector
, 7, owin
);
10880 /* Similarly to `with-selected-window', if the operation selects
10881 a window on another frame, we must restore that frame's
10882 selected window, and (for a tty) the top-frame. */
10883 ASET (vector
, 8, target_frame
->selected_window
);
10884 if (FRAME_TERMCAP_P (target_frame
))
10885 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10892 unwind_format_mode_line (Lisp_Object vector
)
10894 Lisp_Object old_window
= AREF (vector
, 7);
10895 Lisp_Object target_frame_window
= AREF (vector
, 8);
10896 Lisp_Object old_top_frame
= AREF (vector
, 9);
10898 mode_line_target
= XINT (AREF (vector
, 0));
10899 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10900 mode_line_string_list
= AREF (vector
, 2);
10901 if (! EQ (AREF (vector
, 3), Qt
))
10902 mode_line_proptrans_alist
= AREF (vector
, 3);
10903 mode_line_string_face
= AREF (vector
, 4);
10904 mode_line_string_face_prop
= AREF (vector
, 5);
10906 /* Select window before buffer, since it may change the buffer. */
10907 if (!NILP (old_window
))
10909 /* If the operation that we are unwinding had selected a window
10910 on a different frame, reset its frame-selected-window. For a
10911 text terminal, reset its top-frame if necessary. */
10912 if (!NILP (target_frame_window
))
10915 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10917 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10918 Fselect_window (target_frame_window
, Qt
);
10920 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10921 Fselect_frame (old_top_frame
, Qt
);
10924 Fselect_window (old_window
, Qt
);
10927 if (!NILP (AREF (vector
, 6)))
10929 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10930 ASET (vector
, 6, Qnil
);
10933 Vmode_line_unwind_vector
= vector
;
10938 /* Store a single character C for the frame title in mode_line_noprop_buf.
10939 Re-allocate mode_line_noprop_buf if necessary. */
10942 store_mode_line_noprop_char (char c
)
10944 /* If output position has reached the end of the allocated buffer,
10945 increase the buffer's size. */
10946 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10948 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10949 ptrdiff_t size
= len
;
10950 mode_line_noprop_buf
=
10951 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10952 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10953 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10956 *mode_line_noprop_ptr
++ = c
;
10960 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10961 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10962 characters that yield more columns than PRECISION; PRECISION <= 0
10963 means copy the whole string. Pad with spaces until FIELD_WIDTH
10964 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10965 pad. Called from display_mode_element when it is used to build a
10969 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10971 const unsigned char *str
= (const unsigned char *) string
;
10973 ptrdiff_t dummy
, nbytes
;
10975 /* Copy at most PRECISION chars from STR. */
10976 nbytes
= strlen (string
);
10977 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10979 store_mode_line_noprop_char (*str
++);
10981 /* Fill up with spaces until FIELD_WIDTH reached. */
10982 while (field_width
> 0
10983 && n
< field_width
)
10985 store_mode_line_noprop_char (' ');
10992 /***********************************************************************
10994 ***********************************************************************/
10996 #ifdef HAVE_WINDOW_SYSTEM
10998 /* Set the title of FRAME, if it has changed. The title format is
10999 Vicon_title_format if FRAME is iconified, otherwise it is
11000 frame_title_format. */
11003 x_consider_frame_title (Lisp_Object frame
)
11005 struct frame
*f
= XFRAME (frame
);
11007 if (FRAME_WINDOW_P (f
)
11008 || FRAME_MINIBUF_ONLY_P (f
)
11009 || f
->explicit_name
)
11011 /* Do we have more than one visible frame on this X display? */
11014 ptrdiff_t title_start
;
11018 ptrdiff_t count
= SPECPDL_INDEX ();
11020 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11022 Lisp_Object other_frame
= XCAR (tail
);
11023 struct frame
*tf
= XFRAME (other_frame
);
11026 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11027 && !FRAME_MINIBUF_ONLY_P (tf
)
11028 && !EQ (other_frame
, tip_frame
)
11029 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11033 /* Set global variable indicating that multiple frames exist. */
11034 multiple_frames
= CONSP (tail
);
11036 /* Switch to the buffer of selected window of the frame. Set up
11037 mode_line_target so that display_mode_element will output into
11038 mode_line_noprop_buf; then display the title. */
11039 record_unwind_protect (unwind_format_mode_line
,
11040 format_mode_line_unwind_data
11041 (f
, current_buffer
, selected_window
, 0));
11043 Fselect_window (f
->selected_window
, Qt
);
11044 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11045 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11047 mode_line_target
= MODE_LINE_TITLE
;
11048 title_start
= MODE_LINE_NOPROP_LEN (0);
11049 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11050 NULL
, DEFAULT_FACE_ID
);
11051 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11052 len
= MODE_LINE_NOPROP_LEN (title_start
);
11053 title
= mode_line_noprop_buf
+ title_start
;
11054 unbind_to (count
, Qnil
);
11056 /* Set the title only if it's changed. This avoids consing in
11057 the common case where it hasn't. (If it turns out that we've
11058 already wasted too much time by walking through the list with
11059 display_mode_element, then we might need to optimize at a
11060 higher level than this.) */
11061 if (! STRINGP (f
->name
)
11062 || SBYTES (f
->name
) != len
11063 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11064 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11068 #endif /* not HAVE_WINDOW_SYSTEM */
11071 /***********************************************************************
11073 ***********************************************************************/
11076 /* Prepare for redisplay by updating menu-bar item lists when
11077 appropriate. This can call eval. */
11080 prepare_menu_bars (void)
11083 struct gcpro gcpro1
, gcpro2
;
11085 Lisp_Object tooltip_frame
;
11087 #ifdef HAVE_WINDOW_SYSTEM
11088 tooltip_frame
= tip_frame
;
11090 tooltip_frame
= Qnil
;
11093 /* Update all frame titles based on their buffer names, etc. We do
11094 this before the menu bars so that the buffer-menu will show the
11095 up-to-date frame titles. */
11096 #ifdef HAVE_WINDOW_SYSTEM
11097 if (windows_or_buffers_changed
|| update_mode_lines
)
11099 Lisp_Object tail
, frame
;
11101 FOR_EACH_FRAME (tail
, frame
)
11103 f
= XFRAME (frame
);
11104 if (!EQ (frame
, tooltip_frame
)
11105 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11106 x_consider_frame_title (frame
);
11109 #endif /* HAVE_WINDOW_SYSTEM */
11111 /* Update the menu bar item lists, if appropriate. This has to be
11112 done before any actual redisplay or generation of display lines. */
11113 all_windows
= (update_mode_lines
11114 || buffer_shared
> 1
11115 || windows_or_buffers_changed
);
11118 Lisp_Object tail
, frame
;
11119 ptrdiff_t count
= SPECPDL_INDEX ();
11120 /* 1 means that update_menu_bar has run its hooks
11121 so any further calls to update_menu_bar shouldn't do so again. */
11122 int menu_bar_hooks_run
= 0;
11124 record_unwind_save_match_data ();
11126 FOR_EACH_FRAME (tail
, frame
)
11128 f
= XFRAME (frame
);
11130 /* Ignore tooltip frame. */
11131 if (EQ (frame
, tooltip_frame
))
11134 /* If a window on this frame changed size, report that to
11135 the user and clear the size-change flag. */
11136 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11138 Lisp_Object functions
;
11140 /* Clear flag first in case we get an error below. */
11141 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11142 functions
= Vwindow_size_change_functions
;
11143 GCPRO2 (tail
, functions
);
11145 while (CONSP (functions
))
11147 if (!EQ (XCAR (functions
), Qt
))
11148 call1 (XCAR (functions
), frame
);
11149 functions
= XCDR (functions
);
11155 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11156 #ifdef HAVE_WINDOW_SYSTEM
11157 update_tool_bar (f
, 0);
11160 if (windows_or_buffers_changed
11162 ns_set_doc_edited (f
, Fbuffer_modified_p
11163 (XWINDOW (f
->selected_window
)->buffer
));
11168 unbind_to (count
, Qnil
);
11172 struct frame
*sf
= SELECTED_FRAME ();
11173 update_menu_bar (sf
, 1, 0);
11174 #ifdef HAVE_WINDOW_SYSTEM
11175 update_tool_bar (sf
, 1);
11181 /* Update the menu bar item list for frame F. This has to be done
11182 before we start to fill in any display lines, because it can call
11185 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11187 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11188 already ran the menu bar hooks for this redisplay, so there
11189 is no need to run them again. The return value is the
11190 updated value of this flag, to pass to the next call. */
11193 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11195 Lisp_Object window
;
11196 register struct window
*w
;
11198 /* If called recursively during a menu update, do nothing. This can
11199 happen when, for instance, an activate-menubar-hook causes a
11201 if (inhibit_menubar_update
)
11204 window
= FRAME_SELECTED_WINDOW (f
);
11205 w
= XWINDOW (window
);
11207 if (FRAME_WINDOW_P (f
)
11209 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11210 || defined (HAVE_NS) || defined (USE_GTK)
11211 FRAME_EXTERNAL_MENU_BAR (f
)
11213 FRAME_MENU_BAR_LINES (f
) > 0
11215 : FRAME_MENU_BAR_LINES (f
) > 0)
11217 /* If the user has switched buffers or windows, we need to
11218 recompute to reflect the new bindings. But we'll
11219 recompute when update_mode_lines is set too; that means
11220 that people can use force-mode-line-update to request
11221 that the menu bar be recomputed. The adverse effect on
11222 the rest of the redisplay algorithm is about the same as
11223 windows_or_buffers_changed anyway. */
11224 if (windows_or_buffers_changed
11225 /* This used to test w->update_mode_line, but we believe
11226 there is no need to recompute the menu in that case. */
11227 || update_mode_lines
11228 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11229 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11230 != w
->last_had_star
)
11231 || ((!NILP (Vtransient_mark_mode
)
11232 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11233 != !NILP (w
->region_showing
)))
11235 struct buffer
*prev
= current_buffer
;
11236 ptrdiff_t count
= SPECPDL_INDEX ();
11238 specbind (Qinhibit_menubar_update
, Qt
);
11240 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11241 if (save_match_data
)
11242 record_unwind_save_match_data ();
11243 if (NILP (Voverriding_local_map_menu_flag
))
11245 specbind (Qoverriding_terminal_local_map
, Qnil
);
11246 specbind (Qoverriding_local_map
, Qnil
);
11251 /* Run the Lucid hook. */
11252 safe_run_hooks (Qactivate_menubar_hook
);
11254 /* If it has changed current-menubar from previous value,
11255 really recompute the menu-bar from the value. */
11256 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11257 call0 (Qrecompute_lucid_menubar
);
11259 safe_run_hooks (Qmenu_bar_update_hook
);
11264 XSETFRAME (Vmenu_updating_frame
, f
);
11265 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11267 /* Redisplay the menu bar in case we changed it. */
11268 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11269 || defined (HAVE_NS) || defined (USE_GTK)
11270 if (FRAME_WINDOW_P (f
))
11272 #if defined (HAVE_NS)
11273 /* All frames on Mac OS share the same menubar. So only
11274 the selected frame should be allowed to set it. */
11275 if (f
== SELECTED_FRAME ())
11277 set_frame_menubar (f
, 0, 0);
11280 /* On a terminal screen, the menu bar is an ordinary screen
11281 line, and this makes it get updated. */
11282 w
->update_mode_line
= 1;
11283 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11284 /* In the non-toolkit version, the menu bar is an ordinary screen
11285 line, and this makes it get updated. */
11286 w
->update_mode_line
= 1;
11287 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11289 unbind_to (count
, Qnil
);
11290 set_buffer_internal_1 (prev
);
11299 /***********************************************************************
11301 ***********************************************************************/
11303 #ifdef HAVE_WINDOW_SYSTEM
11306 Nominal cursor position -- where to draw output.
11307 HPOS and VPOS are window relative glyph matrix coordinates.
11308 X and Y are window relative pixel coordinates. */
11310 struct cursor_pos output_cursor
;
11314 Set the global variable output_cursor to CURSOR. All cursor
11315 positions are relative to updated_window. */
11318 set_output_cursor (struct cursor_pos
*cursor
)
11320 output_cursor
.hpos
= cursor
->hpos
;
11321 output_cursor
.vpos
= cursor
->vpos
;
11322 output_cursor
.x
= cursor
->x
;
11323 output_cursor
.y
= cursor
->y
;
11328 Set a nominal cursor position.
11330 HPOS and VPOS are column/row positions in a window glyph matrix. X
11331 and Y are window text area relative pixel positions.
11333 If this is done during an update, updated_window will contain the
11334 window that is being updated and the position is the future output
11335 cursor position for that window. If updated_window is null, use
11336 selected_window and display the cursor at the given position. */
11339 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11343 /* If updated_window is not set, work on selected_window. */
11344 if (updated_window
)
11345 w
= updated_window
;
11347 w
= XWINDOW (selected_window
);
11349 /* Set the output cursor. */
11350 output_cursor
.hpos
= hpos
;
11351 output_cursor
.vpos
= vpos
;
11352 output_cursor
.x
= x
;
11353 output_cursor
.y
= y
;
11355 /* If not called as part of an update, really display the cursor.
11356 This will also set the cursor position of W. */
11357 if (updated_window
== NULL
)
11360 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11361 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11362 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11367 #endif /* HAVE_WINDOW_SYSTEM */
11370 /***********************************************************************
11372 ***********************************************************************/
11374 #ifdef HAVE_WINDOW_SYSTEM
11376 /* Where the mouse was last time we reported a mouse event. */
11378 FRAME_PTR last_mouse_frame
;
11380 /* Tool-bar item index of the item on which a mouse button was pressed
11383 int last_tool_bar_item
;
11387 update_tool_bar_unwind (Lisp_Object frame
)
11389 selected_frame
= frame
;
11393 /* Update the tool-bar item list for frame F. This has to be done
11394 before we start to fill in any display lines. Called from
11395 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11396 and restore it here. */
11399 update_tool_bar (struct frame
*f
, int save_match_data
)
11401 #if defined (USE_GTK) || defined (HAVE_NS)
11402 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11404 int do_update
= WINDOWP (f
->tool_bar_window
)
11405 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11410 Lisp_Object window
;
11413 window
= FRAME_SELECTED_WINDOW (f
);
11414 w
= XWINDOW (window
);
11416 /* If the user has switched buffers or windows, we need to
11417 recompute to reflect the new bindings. But we'll
11418 recompute when update_mode_lines is set too; that means
11419 that people can use force-mode-line-update to request
11420 that the menu bar be recomputed. The adverse effect on
11421 the rest of the redisplay algorithm is about the same as
11422 windows_or_buffers_changed anyway. */
11423 if (windows_or_buffers_changed
11424 || w
->update_mode_line
11425 || update_mode_lines
11426 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11427 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11428 != w
->last_had_star
)
11429 || ((!NILP (Vtransient_mark_mode
)
11430 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11431 != !NILP (w
->region_showing
)))
11433 struct buffer
*prev
= current_buffer
;
11434 ptrdiff_t count
= SPECPDL_INDEX ();
11435 Lisp_Object frame
, new_tool_bar
;
11436 int new_n_tool_bar
;
11437 struct gcpro gcpro1
;
11439 /* Set current_buffer to the buffer of the selected
11440 window of the frame, so that we get the right local
11442 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11444 /* Save match data, if we must. */
11445 if (save_match_data
)
11446 record_unwind_save_match_data ();
11448 /* Make sure that we don't accidentally use bogus keymaps. */
11449 if (NILP (Voverriding_local_map_menu_flag
))
11451 specbind (Qoverriding_terminal_local_map
, Qnil
);
11452 specbind (Qoverriding_local_map
, Qnil
);
11455 GCPRO1 (new_tool_bar
);
11457 /* We must temporarily set the selected frame to this frame
11458 before calling tool_bar_items, because the calculation of
11459 the tool-bar keymap uses the selected frame (see
11460 `tool-bar-make-keymap' in tool-bar.el). */
11461 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11462 XSETFRAME (frame
, f
);
11463 selected_frame
= frame
;
11465 /* Build desired tool-bar items from keymaps. */
11466 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11469 /* Redisplay the tool-bar if we changed it. */
11470 if (new_n_tool_bar
!= f
->n_tool_bar_items
11471 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11473 /* Redisplay that happens asynchronously due to an expose event
11474 may access f->tool_bar_items. Make sure we update both
11475 variables within BLOCK_INPUT so no such event interrupts. */
11477 f
->tool_bar_items
= new_tool_bar
;
11478 f
->n_tool_bar_items
= new_n_tool_bar
;
11479 w
->update_mode_line
= 1;
11485 unbind_to (count
, Qnil
);
11486 set_buffer_internal_1 (prev
);
11492 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11493 F's desired tool-bar contents. F->tool_bar_items must have
11494 been set up previously by calling prepare_menu_bars. */
11497 build_desired_tool_bar_string (struct frame
*f
)
11499 int i
, size
, size_needed
;
11500 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11501 Lisp_Object image
, plist
, props
;
11503 image
= plist
= props
= Qnil
;
11504 GCPRO3 (image
, plist
, props
);
11506 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11507 Otherwise, make a new string. */
11509 /* The size of the string we might be able to reuse. */
11510 size
= (STRINGP (f
->desired_tool_bar_string
)
11511 ? SCHARS (f
->desired_tool_bar_string
)
11514 /* We need one space in the string for each image. */
11515 size_needed
= f
->n_tool_bar_items
;
11517 /* Reuse f->desired_tool_bar_string, if possible. */
11518 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11519 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11520 make_number (' '));
11523 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11524 Fremove_text_properties (make_number (0), make_number (size
),
11525 props
, f
->desired_tool_bar_string
);
11528 /* Put a `display' property on the string for the images to display,
11529 put a `menu_item' property on tool-bar items with a value that
11530 is the index of the item in F's tool-bar item vector. */
11531 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11533 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11535 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11536 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11537 int hmargin
, vmargin
, relief
, idx
, end
;
11539 /* If image is a vector, choose the image according to the
11541 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11542 if (VECTORP (image
))
11546 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11547 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11550 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11551 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11553 eassert (ASIZE (image
) >= idx
);
11554 image
= AREF (image
, idx
);
11559 /* Ignore invalid image specifications. */
11560 if (!valid_image_p (image
))
11563 /* Display the tool-bar button pressed, or depressed. */
11564 plist
= Fcopy_sequence (XCDR (image
));
11566 /* Compute margin and relief to draw. */
11567 relief
= (tool_bar_button_relief
>= 0
11568 ? tool_bar_button_relief
11569 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11570 hmargin
= vmargin
= relief
;
11572 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11573 INT_MAX
- max (hmargin
, vmargin
)))
11575 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11576 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11578 else if (CONSP (Vtool_bar_button_margin
))
11580 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11581 INT_MAX
- hmargin
))
11582 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11584 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11585 INT_MAX
- vmargin
))
11586 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11589 if (auto_raise_tool_bar_buttons_p
)
11591 /* Add a `:relief' property to the image spec if the item is
11595 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11602 /* If image is selected, display it pressed, i.e. with a
11603 negative relief. If it's not selected, display it with a
11605 plist
= Fplist_put (plist
, QCrelief
,
11607 ? make_number (-relief
)
11608 : make_number (relief
)));
11613 /* Put a margin around the image. */
11614 if (hmargin
|| vmargin
)
11616 if (hmargin
== vmargin
)
11617 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11619 plist
= Fplist_put (plist
, QCmargin
,
11620 Fcons (make_number (hmargin
),
11621 make_number (vmargin
)));
11624 /* If button is not enabled, and we don't have special images
11625 for the disabled state, make the image appear disabled by
11626 applying an appropriate algorithm to it. */
11627 if (!enabled_p
&& idx
< 0)
11628 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11630 /* Put a `display' text property on the string for the image to
11631 display. Put a `menu-item' property on the string that gives
11632 the start of this item's properties in the tool-bar items
11634 image
= Fcons (Qimage
, plist
);
11635 props
= list4 (Qdisplay
, image
,
11636 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11638 /* Let the last image hide all remaining spaces in the tool bar
11639 string. The string can be longer than needed when we reuse a
11640 previous string. */
11641 if (i
+ 1 == f
->n_tool_bar_items
)
11642 end
= SCHARS (f
->desired_tool_bar_string
);
11645 Fadd_text_properties (make_number (i
), make_number (end
),
11646 props
, f
->desired_tool_bar_string
);
11654 /* Display one line of the tool-bar of frame IT->f.
11656 HEIGHT specifies the desired height of the tool-bar line.
11657 If the actual height of the glyph row is less than HEIGHT, the
11658 row's height is increased to HEIGHT, and the icons are centered
11659 vertically in the new height.
11661 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11662 count a final empty row in case the tool-bar width exactly matches
11667 display_tool_bar_line (struct it
*it
, int height
)
11669 struct glyph_row
*row
= it
->glyph_row
;
11670 int max_x
= it
->last_visible_x
;
11671 struct glyph
*last
;
11673 prepare_desired_row (row
);
11674 row
->y
= it
->current_y
;
11676 /* Note that this isn't made use of if the face hasn't a box,
11677 so there's no need to check the face here. */
11678 it
->start_of_box_run_p
= 1;
11680 while (it
->current_x
< max_x
)
11682 int x
, n_glyphs_before
, i
, nglyphs
;
11683 struct it it_before
;
11685 /* Get the next display element. */
11686 if (!get_next_display_element (it
))
11688 /* Don't count empty row if we are counting needed tool-bar lines. */
11689 if (height
< 0 && !it
->hpos
)
11694 /* Produce glyphs. */
11695 n_glyphs_before
= row
->used
[TEXT_AREA
];
11698 PRODUCE_GLYPHS (it
);
11700 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11702 x
= it_before
.current_x
;
11703 while (i
< nglyphs
)
11705 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11707 if (x
+ glyph
->pixel_width
> max_x
)
11709 /* Glyph doesn't fit on line. Backtrack. */
11710 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11712 /* If this is the only glyph on this line, it will never fit on the
11713 tool-bar, so skip it. But ensure there is at least one glyph,
11714 so we don't accidentally disable the tool-bar. */
11715 if (n_glyphs_before
== 0
11716 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11722 x
+= glyph
->pixel_width
;
11726 /* Stop at line end. */
11727 if (ITERATOR_AT_END_OF_LINE_P (it
))
11730 set_iterator_to_next (it
, 1);
11735 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11737 /* Use default face for the border below the tool bar.
11739 FIXME: When auto-resize-tool-bars is grow-only, there is
11740 no additional border below the possibly empty tool-bar lines.
11741 So to make the extra empty lines look "normal", we have to
11742 use the tool-bar face for the border too. */
11743 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11744 it
->face_id
= DEFAULT_FACE_ID
;
11746 extend_face_to_end_of_line (it
);
11747 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11748 last
->right_box_line_p
= 1;
11749 if (last
== row
->glyphs
[TEXT_AREA
])
11750 last
->left_box_line_p
= 1;
11752 /* Make line the desired height and center it vertically. */
11753 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11755 /* Don't add more than one line height. */
11756 height
%= FRAME_LINE_HEIGHT (it
->f
);
11757 it
->max_ascent
+= height
/ 2;
11758 it
->max_descent
+= (height
+ 1) / 2;
11761 compute_line_metrics (it
);
11763 /* If line is empty, make it occupy the rest of the tool-bar. */
11764 if (!row
->displays_text_p
)
11766 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11767 row
->visible_height
= row
->height
;
11768 row
->ascent
= row
->phys_ascent
= 0;
11769 row
->extra_line_spacing
= 0;
11772 row
->full_width_p
= 1;
11773 row
->continued_p
= 0;
11774 row
->truncated_on_left_p
= 0;
11775 row
->truncated_on_right_p
= 0;
11777 it
->current_x
= it
->hpos
= 0;
11778 it
->current_y
+= row
->height
;
11784 /* Max tool-bar height. */
11786 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11787 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11789 /* Value is the number of screen lines needed to make all tool-bar
11790 items of frame F visible. The number of actual rows needed is
11791 returned in *N_ROWS if non-NULL. */
11794 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11796 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11798 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11799 the desired matrix, so use (unused) mode-line row as temporary row to
11800 avoid destroying the first tool-bar row. */
11801 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11803 /* Initialize an iterator for iteration over
11804 F->desired_tool_bar_string in the tool-bar window of frame F. */
11805 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11806 it
.first_visible_x
= 0;
11807 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11808 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11809 it
.paragraph_embedding
= L2R
;
11811 while (!ITERATOR_AT_END_P (&it
))
11813 clear_glyph_row (temp_row
);
11814 it
.glyph_row
= temp_row
;
11815 display_tool_bar_line (&it
, -1);
11817 clear_glyph_row (temp_row
);
11819 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11821 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11823 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11827 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11829 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11830 (Lisp_Object frame
)
11837 frame
= selected_frame
;
11839 CHECK_FRAME (frame
);
11840 f
= XFRAME (frame
);
11842 if (WINDOWP (f
->tool_bar_window
)
11843 && (w
= XWINDOW (f
->tool_bar_window
),
11844 WINDOW_TOTAL_LINES (w
) > 0))
11846 update_tool_bar (f
, 1);
11847 if (f
->n_tool_bar_items
)
11849 build_desired_tool_bar_string (f
);
11850 nlines
= tool_bar_lines_needed (f
, NULL
);
11854 return make_number (nlines
);
11858 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11859 height should be changed. */
11862 redisplay_tool_bar (struct frame
*f
)
11866 struct glyph_row
*row
;
11868 #if defined (USE_GTK) || defined (HAVE_NS)
11869 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11870 update_frame_tool_bar (f
);
11874 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11875 do anything. This means you must start with tool-bar-lines
11876 non-zero to get the auto-sizing effect. Or in other words, you
11877 can turn off tool-bars by specifying tool-bar-lines zero. */
11878 if (!WINDOWP (f
->tool_bar_window
)
11879 || (w
= XWINDOW (f
->tool_bar_window
),
11880 WINDOW_TOTAL_LINES (w
) == 0))
11883 /* Set up an iterator for the tool-bar window. */
11884 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11885 it
.first_visible_x
= 0;
11886 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11887 row
= it
.glyph_row
;
11889 /* Build a string that represents the contents of the tool-bar. */
11890 build_desired_tool_bar_string (f
);
11891 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11892 /* FIXME: This should be controlled by a user option. But it
11893 doesn't make sense to have an R2L tool bar if the menu bar cannot
11894 be drawn also R2L, and making the menu bar R2L is tricky due
11895 toolkit-specific code that implements it. If an R2L tool bar is
11896 ever supported, display_tool_bar_line should also be augmented to
11897 call unproduce_glyphs like display_line and display_string
11899 it
.paragraph_embedding
= L2R
;
11901 if (f
->n_tool_bar_rows
== 0)
11905 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11906 nlines
!= WINDOW_TOTAL_LINES (w
)))
11909 int old_height
= WINDOW_TOTAL_LINES (w
);
11911 XSETFRAME (frame
, f
);
11912 Fmodify_frame_parameters (frame
,
11913 Fcons (Fcons (Qtool_bar_lines
,
11914 make_number (nlines
)),
11916 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11918 clear_glyph_matrix (w
->desired_matrix
);
11919 fonts_changed_p
= 1;
11925 /* Display as many lines as needed to display all tool-bar items. */
11927 if (f
->n_tool_bar_rows
> 0)
11929 int border
, rows
, height
, extra
;
11931 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11932 border
= XINT (Vtool_bar_border
);
11933 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11934 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11935 else if (EQ (Vtool_bar_border
, Qborder_width
))
11936 border
= f
->border_width
;
11942 rows
= f
->n_tool_bar_rows
;
11943 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11944 extra
= it
.last_visible_y
- border
- height
* rows
;
11946 while (it
.current_y
< it
.last_visible_y
)
11949 if (extra
> 0 && rows
-- > 0)
11951 h
= (extra
+ rows
- 1) / rows
;
11954 display_tool_bar_line (&it
, height
+ h
);
11959 while (it
.current_y
< it
.last_visible_y
)
11960 display_tool_bar_line (&it
, 0);
11963 /* It doesn't make much sense to try scrolling in the tool-bar
11964 window, so don't do it. */
11965 w
->desired_matrix
->no_scrolling_p
= 1;
11966 w
->must_be_updated_p
= 1;
11968 if (!NILP (Vauto_resize_tool_bars
))
11970 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11971 int change_height_p
= 0;
11973 /* If we couldn't display everything, change the tool-bar's
11974 height if there is room for more. */
11975 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11976 && it
.current_y
< max_tool_bar_height
)
11977 change_height_p
= 1;
11979 row
= it
.glyph_row
- 1;
11981 /* If there are blank lines at the end, except for a partially
11982 visible blank line at the end that is smaller than
11983 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11984 if (!row
->displays_text_p
11985 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11986 change_height_p
= 1;
11988 /* If row displays tool-bar items, but is partially visible,
11989 change the tool-bar's height. */
11990 if (row
->displays_text_p
11991 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11992 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11993 change_height_p
= 1;
11995 /* Resize windows as needed by changing the `tool-bar-lines'
11996 frame parameter. */
11997 if (change_height_p
)
12000 int old_height
= WINDOW_TOTAL_LINES (w
);
12002 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12004 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12005 && !f
->minimize_tool_bar_window_p
)
12006 ? (nlines
> old_height
)
12007 : (nlines
!= old_height
));
12008 f
->minimize_tool_bar_window_p
= 0;
12010 if (change_height_p
)
12012 XSETFRAME (frame
, f
);
12013 Fmodify_frame_parameters (frame
,
12014 Fcons (Fcons (Qtool_bar_lines
,
12015 make_number (nlines
)),
12017 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12019 clear_glyph_matrix (w
->desired_matrix
);
12020 f
->n_tool_bar_rows
= nrows
;
12021 fonts_changed_p
= 1;
12028 f
->minimize_tool_bar_window_p
= 0;
12033 /* Get information about the tool-bar item which is displayed in GLYPH
12034 on frame F. Return in *PROP_IDX the index where tool-bar item
12035 properties start in F->tool_bar_items. Value is zero if
12036 GLYPH doesn't display a tool-bar item. */
12039 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12045 /* This function can be called asynchronously, which means we must
12046 exclude any possibility that Fget_text_property signals an
12048 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12049 charpos
= max (0, charpos
);
12051 /* Get the text property `menu-item' at pos. The value of that
12052 property is the start index of this item's properties in
12053 F->tool_bar_items. */
12054 prop
= Fget_text_property (make_number (charpos
),
12055 Qmenu_item
, f
->current_tool_bar_string
);
12056 if (INTEGERP (prop
))
12058 *prop_idx
= XINT (prop
);
12068 /* Get information about the tool-bar item at position X/Y on frame F.
12069 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12070 the current matrix of the tool-bar window of F, or NULL if not
12071 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12072 item in F->tool_bar_items. Value is
12074 -1 if X/Y is not on a tool-bar item
12075 0 if X/Y is on the same item that was highlighted before.
12079 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12080 int *hpos
, int *vpos
, int *prop_idx
)
12082 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12083 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12086 /* Find the glyph under X/Y. */
12087 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12088 if (*glyph
== NULL
)
12091 /* Get the start of this tool-bar item's properties in
12092 f->tool_bar_items. */
12093 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12096 /* Is mouse on the highlighted item? */
12097 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12098 && *vpos
>= hlinfo
->mouse_face_beg_row
12099 && *vpos
<= hlinfo
->mouse_face_end_row
12100 && (*vpos
> hlinfo
->mouse_face_beg_row
12101 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12102 && (*vpos
< hlinfo
->mouse_face_end_row
12103 || *hpos
< hlinfo
->mouse_face_end_col
12104 || hlinfo
->mouse_face_past_end
))
12112 Handle mouse button event on the tool-bar of frame F, at
12113 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12114 0 for button release. MODIFIERS is event modifiers for button
12118 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12121 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12122 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12123 int hpos
, vpos
, prop_idx
;
12124 struct glyph
*glyph
;
12125 Lisp_Object enabled_p
;
12127 /* If not on the highlighted tool-bar item, return. */
12128 frame_to_window_pixel_xy (w
, &x
, &y
);
12129 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12132 /* If item is disabled, do nothing. */
12133 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12134 if (NILP (enabled_p
))
12139 /* Show item in pressed state. */
12140 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12141 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12142 last_tool_bar_item
= prop_idx
;
12146 Lisp_Object key
, frame
;
12147 struct input_event event
;
12148 EVENT_INIT (event
);
12150 /* Show item in released state. */
12151 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12152 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12154 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12156 XSETFRAME (frame
, f
);
12157 event
.kind
= TOOL_BAR_EVENT
;
12158 event
.frame_or_window
= frame
;
12160 kbd_buffer_store_event (&event
);
12162 event
.kind
= TOOL_BAR_EVENT
;
12163 event
.frame_or_window
= frame
;
12165 event
.modifiers
= modifiers
;
12166 kbd_buffer_store_event (&event
);
12167 last_tool_bar_item
= -1;
12172 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12173 tool-bar window-relative coordinates X/Y. Called from
12174 note_mouse_highlight. */
12177 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12179 Lisp_Object window
= f
->tool_bar_window
;
12180 struct window
*w
= XWINDOW (window
);
12181 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12182 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12184 struct glyph
*glyph
;
12185 struct glyph_row
*row
;
12187 Lisp_Object enabled_p
;
12189 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12190 int mouse_down_p
, rc
;
12192 /* Function note_mouse_highlight is called with negative X/Y
12193 values when mouse moves outside of the frame. */
12194 if (x
<= 0 || y
<= 0)
12196 clear_mouse_face (hlinfo
);
12200 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12203 /* Not on tool-bar item. */
12204 clear_mouse_face (hlinfo
);
12208 /* On same tool-bar item as before. */
12209 goto set_help_echo
;
12211 clear_mouse_face (hlinfo
);
12213 /* Mouse is down, but on different tool-bar item? */
12214 mouse_down_p
= (dpyinfo
->grabbed
12215 && f
== last_mouse_frame
12216 && FRAME_LIVE_P (f
));
12218 && last_tool_bar_item
!= prop_idx
)
12221 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12222 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12224 /* If tool-bar item is not enabled, don't highlight it. */
12225 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12226 if (!NILP (enabled_p
))
12228 /* Compute the x-position of the glyph. In front and past the
12229 image is a space. We include this in the highlighted area. */
12230 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12231 for (i
= x
= 0; i
< hpos
; ++i
)
12232 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12234 /* Record this as the current active region. */
12235 hlinfo
->mouse_face_beg_col
= hpos
;
12236 hlinfo
->mouse_face_beg_row
= vpos
;
12237 hlinfo
->mouse_face_beg_x
= x
;
12238 hlinfo
->mouse_face_beg_y
= row
->y
;
12239 hlinfo
->mouse_face_past_end
= 0;
12241 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12242 hlinfo
->mouse_face_end_row
= vpos
;
12243 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12244 hlinfo
->mouse_face_end_y
= row
->y
;
12245 hlinfo
->mouse_face_window
= window
;
12246 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12248 /* Display it as active. */
12249 show_mouse_face (hlinfo
, draw
);
12250 hlinfo
->mouse_face_image_state
= draw
;
12255 /* Set help_echo_string to a help string to display for this tool-bar item.
12256 XTread_socket does the rest. */
12257 help_echo_object
= help_echo_window
= Qnil
;
12258 help_echo_pos
= -1;
12259 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12260 if (NILP (help_echo_string
))
12261 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12264 #endif /* HAVE_WINDOW_SYSTEM */
12268 /************************************************************************
12269 Horizontal scrolling
12270 ************************************************************************/
12272 static int hscroll_window_tree (Lisp_Object
);
12273 static int hscroll_windows (Lisp_Object
);
12275 /* For all leaf windows in the window tree rooted at WINDOW, set their
12276 hscroll value so that PT is (i) visible in the window, and (ii) so
12277 that it is not within a certain margin at the window's left and
12278 right border. Value is non-zero if any window's hscroll has been
12282 hscroll_window_tree (Lisp_Object window
)
12284 int hscrolled_p
= 0;
12285 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12286 int hscroll_step_abs
= 0;
12287 double hscroll_step_rel
= 0;
12289 if (hscroll_relative_p
)
12291 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12292 if (hscroll_step_rel
< 0)
12294 hscroll_relative_p
= 0;
12295 hscroll_step_abs
= 0;
12298 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12300 hscroll_step_abs
= XINT (Vhscroll_step
);
12301 if (hscroll_step_abs
< 0)
12302 hscroll_step_abs
= 0;
12305 hscroll_step_abs
= 0;
12307 while (WINDOWP (window
))
12309 struct window
*w
= XWINDOW (window
);
12311 if (WINDOWP (w
->hchild
))
12312 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12313 else if (WINDOWP (w
->vchild
))
12314 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12315 else if (w
->cursor
.vpos
>= 0)
12318 int text_area_width
;
12319 struct glyph_row
*current_cursor_row
12320 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12321 struct glyph_row
*desired_cursor_row
12322 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12323 struct glyph_row
*cursor_row
12324 = (desired_cursor_row
->enabled_p
12325 ? desired_cursor_row
12326 : current_cursor_row
);
12327 int row_r2l_p
= cursor_row
->reversed_p
;
12329 text_area_width
= window_box_width (w
, TEXT_AREA
);
12331 /* Scroll when cursor is inside this scroll margin. */
12332 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12334 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12335 /* For left-to-right rows, hscroll when cursor is either
12336 (i) inside the right hscroll margin, or (ii) if it is
12337 inside the left margin and the window is already
12341 && w
->cursor
.x
<= h_margin
)
12342 || (cursor_row
->enabled_p
12343 && cursor_row
->truncated_on_right_p
12344 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12345 /* For right-to-left rows, the logic is similar,
12346 except that rules for scrolling to left and right
12347 are reversed. E.g., if cursor.x <= h_margin, we
12348 need to hscroll "to the right" unconditionally,
12349 and that will scroll the screen to the left so as
12350 to reveal the next portion of the row. */
12352 && ((cursor_row
->enabled_p
12353 /* FIXME: It is confusing to set the
12354 truncated_on_right_p flag when R2L rows
12355 are actually truncated on the left. */
12356 && cursor_row
->truncated_on_right_p
12357 && w
->cursor
.x
<= h_margin
)
12359 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12363 struct buffer
*saved_current_buffer
;
12367 /* Find point in a display of infinite width. */
12368 saved_current_buffer
= current_buffer
;
12369 current_buffer
= XBUFFER (w
->buffer
);
12371 if (w
== XWINDOW (selected_window
))
12375 pt
= marker_position (w
->pointm
);
12376 pt
= max (BEGV
, pt
);
12380 /* Move iterator to pt starting at cursor_row->start in
12381 a line with infinite width. */
12382 init_to_row_start (&it
, w
, cursor_row
);
12383 it
.last_visible_x
= INFINITY
;
12384 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12385 current_buffer
= saved_current_buffer
;
12387 /* Position cursor in window. */
12388 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12389 hscroll
= max (0, (it
.current_x
12390 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12391 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12392 : (text_area_width
/ 2))))
12393 / FRAME_COLUMN_WIDTH (it
.f
);
12394 else if ((!row_r2l_p
12395 && w
->cursor
.x
>= text_area_width
- h_margin
)
12396 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12398 if (hscroll_relative_p
)
12399 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12402 wanted_x
= text_area_width
12403 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12406 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12410 if (hscroll_relative_p
)
12411 wanted_x
= text_area_width
* hscroll_step_rel
12414 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12417 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12419 hscroll
= max (hscroll
, w
->min_hscroll
);
12421 /* Don't prevent redisplay optimizations if hscroll
12422 hasn't changed, as it will unnecessarily slow down
12424 if (w
->hscroll
!= hscroll
)
12426 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12427 w
->hscroll
= hscroll
;
12436 /* Value is non-zero if hscroll of any leaf window has been changed. */
12437 return hscrolled_p
;
12441 /* Set hscroll so that cursor is visible and not inside horizontal
12442 scroll margins for all windows in the tree rooted at WINDOW. See
12443 also hscroll_window_tree above. Value is non-zero if any window's
12444 hscroll has been changed. If it has, desired matrices on the frame
12445 of WINDOW are cleared. */
12448 hscroll_windows (Lisp_Object window
)
12450 int hscrolled_p
= hscroll_window_tree (window
);
12452 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12453 return hscrolled_p
;
12458 /************************************************************************
12460 ************************************************************************/
12462 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12463 to a non-zero value. This is sometimes handy to have in a debugger
12468 /* First and last unchanged row for try_window_id. */
12470 static int debug_first_unchanged_at_end_vpos
;
12471 static int debug_last_unchanged_at_beg_vpos
;
12473 /* Delta vpos and y. */
12475 static int debug_dvpos
, debug_dy
;
12477 /* Delta in characters and bytes for try_window_id. */
12479 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12481 /* Values of window_end_pos and window_end_vpos at the end of
12484 static ptrdiff_t debug_end_vpos
;
12486 /* Append a string to W->desired_matrix->method. FMT is a printf
12487 format string. If trace_redisplay_p is non-zero also printf the
12488 resulting string to stderr. */
12490 static void debug_method_add (struct window
*, char const *, ...)
12491 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12494 debug_method_add (struct window
*w
, char const *fmt
, ...)
12496 char *method
= w
->desired_matrix
->method
;
12497 int len
= strlen (method
);
12498 int size
= sizeof w
->desired_matrix
->method
;
12499 int remaining
= size
- len
- 1;
12502 if (len
&& remaining
)
12505 --remaining
, ++len
;
12508 va_start (ap
, fmt
);
12509 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12512 if (trace_redisplay_p
)
12513 fprintf (stderr
, "%p (%s): %s\n",
12515 ((BUFFERP (w
->buffer
)
12516 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12517 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12522 #endif /* GLYPH_DEBUG */
12525 /* Value is non-zero if all changes in window W, which displays
12526 current_buffer, are in the text between START and END. START is a
12527 buffer position, END is given as a distance from Z. Used in
12528 redisplay_internal for display optimization. */
12531 text_outside_line_unchanged_p (struct window
*w
,
12532 ptrdiff_t start
, ptrdiff_t end
)
12534 int unchanged_p
= 1;
12536 /* If text or overlays have changed, see where. */
12537 if (w
->last_modified
< MODIFF
12538 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12540 /* Gap in the line? */
12541 if (GPT
< start
|| Z
- GPT
< end
)
12544 /* Changes start in front of the line, or end after it? */
12546 && (BEG_UNCHANGED
< start
- 1
12547 || END_UNCHANGED
< end
))
12550 /* If selective display, can't optimize if changes start at the
12551 beginning of the line. */
12553 && INTEGERP (BVAR (current_buffer
, selective_display
))
12554 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12555 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12558 /* If there are overlays at the start or end of the line, these
12559 may have overlay strings with newlines in them. A change at
12560 START, for instance, may actually concern the display of such
12561 overlay strings as well, and they are displayed on different
12562 lines. So, quickly rule out this case. (For the future, it
12563 might be desirable to implement something more telling than
12564 just BEG/END_UNCHANGED.) */
12567 if (BEG
+ BEG_UNCHANGED
== start
12568 && overlay_touches_p (start
))
12570 if (END_UNCHANGED
== end
12571 && overlay_touches_p (Z
- end
))
12575 /* Under bidi reordering, adding or deleting a character in the
12576 beginning of a paragraph, before the first strong directional
12577 character, can change the base direction of the paragraph (unless
12578 the buffer specifies a fixed paragraph direction), which will
12579 require to redisplay the whole paragraph. It might be worthwhile
12580 to find the paragraph limits and widen the range of redisplayed
12581 lines to that, but for now just give up this optimization. */
12582 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12583 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12587 return unchanged_p
;
12591 /* Do a frame update, taking possible shortcuts into account. This is
12592 the main external entry point for redisplay.
12594 If the last redisplay displayed an echo area message and that message
12595 is no longer requested, we clear the echo area or bring back the
12596 mini-buffer if that is in use. */
12601 redisplay_internal ();
12606 overlay_arrow_string_or_property (Lisp_Object var
)
12610 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12613 return Voverlay_arrow_string
;
12616 /* Return 1 if there are any overlay-arrows in current_buffer. */
12618 overlay_arrow_in_current_buffer_p (void)
12622 for (vlist
= Voverlay_arrow_variable_list
;
12624 vlist
= XCDR (vlist
))
12626 Lisp_Object var
= XCAR (vlist
);
12629 if (!SYMBOLP (var
))
12631 val
= find_symbol_value (var
);
12633 && current_buffer
== XMARKER (val
)->buffer
)
12640 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12644 overlay_arrows_changed_p (void)
12648 for (vlist
= Voverlay_arrow_variable_list
;
12650 vlist
= XCDR (vlist
))
12652 Lisp_Object var
= XCAR (vlist
);
12653 Lisp_Object val
, pstr
;
12655 if (!SYMBOLP (var
))
12657 val
= find_symbol_value (var
);
12658 if (!MARKERP (val
))
12660 if (! EQ (COERCE_MARKER (val
),
12661 Fget (var
, Qlast_arrow_position
))
12662 || ! (pstr
= overlay_arrow_string_or_property (var
),
12663 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12669 /* Mark overlay arrows to be updated on next redisplay. */
12672 update_overlay_arrows (int up_to_date
)
12676 for (vlist
= Voverlay_arrow_variable_list
;
12678 vlist
= XCDR (vlist
))
12680 Lisp_Object var
= XCAR (vlist
);
12682 if (!SYMBOLP (var
))
12685 if (up_to_date
> 0)
12687 Lisp_Object val
= find_symbol_value (var
);
12688 Fput (var
, Qlast_arrow_position
,
12689 COERCE_MARKER (val
));
12690 Fput (var
, Qlast_arrow_string
,
12691 overlay_arrow_string_or_property (var
));
12693 else if (up_to_date
< 0
12694 || !NILP (Fget (var
, Qlast_arrow_position
)))
12696 Fput (var
, Qlast_arrow_position
, Qt
);
12697 Fput (var
, Qlast_arrow_string
, Qt
);
12703 /* Return overlay arrow string to display at row.
12704 Return integer (bitmap number) for arrow bitmap in left fringe.
12705 Return nil if no overlay arrow. */
12708 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12712 for (vlist
= Voverlay_arrow_variable_list
;
12714 vlist
= XCDR (vlist
))
12716 Lisp_Object var
= XCAR (vlist
);
12719 if (!SYMBOLP (var
))
12722 val
= find_symbol_value (var
);
12725 && current_buffer
== XMARKER (val
)->buffer
12726 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12728 if (FRAME_WINDOW_P (it
->f
)
12729 /* FIXME: if ROW->reversed_p is set, this should test
12730 the right fringe, not the left one. */
12731 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12733 #ifdef HAVE_WINDOW_SYSTEM
12734 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12737 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12738 return make_number (fringe_bitmap
);
12741 return make_number (-1); /* Use default arrow bitmap */
12743 return overlay_arrow_string_or_property (var
);
12750 /* Return 1 if point moved out of or into a composition. Otherwise
12751 return 0. PREV_BUF and PREV_PT are the last point buffer and
12752 position. BUF and PT are the current point buffer and position. */
12755 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12756 struct buffer
*buf
, ptrdiff_t pt
)
12758 ptrdiff_t start
, end
;
12760 Lisp_Object buffer
;
12762 XSETBUFFER (buffer
, buf
);
12763 /* Check a composition at the last point if point moved within the
12765 if (prev_buf
== buf
)
12768 /* Point didn't move. */
12771 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12772 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12773 && COMPOSITION_VALID_P (start
, end
, prop
)
12774 && start
< prev_pt
&& end
> prev_pt
)
12775 /* The last point was within the composition. Return 1 iff
12776 point moved out of the composition. */
12777 return (pt
<= start
|| pt
>= end
);
12780 /* Check a composition at the current point. */
12781 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12782 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12783 && COMPOSITION_VALID_P (start
, end
, prop
)
12784 && start
< pt
&& end
> pt
);
12788 /* Reconsider the setting of B->clip_changed which is displayed
12792 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12794 if (b
->clip_changed
12795 && !NILP (w
->window_end_valid
)
12796 && w
->current_matrix
->buffer
== b
12797 && w
->current_matrix
->zv
== BUF_ZV (b
)
12798 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12799 b
->clip_changed
= 0;
12801 /* If display wasn't paused, and W is not a tool bar window, see if
12802 point has been moved into or out of a composition. In that case,
12803 we set b->clip_changed to 1 to force updating the screen. If
12804 b->clip_changed has already been set to 1, we can skip this
12806 if (!b
->clip_changed
12807 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12811 if (w
== XWINDOW (selected_window
))
12814 pt
= marker_position (w
->pointm
);
12816 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12817 || pt
!= w
->last_point
)
12818 && check_point_in_composition (w
->current_matrix
->buffer
,
12820 XBUFFER (w
->buffer
), pt
))
12821 b
->clip_changed
= 1;
12826 /* Select FRAME to forward the values of frame-local variables into C
12827 variables so that the redisplay routines can access those values
12831 select_frame_for_redisplay (Lisp_Object frame
)
12833 Lisp_Object tail
, tem
;
12834 Lisp_Object old
= selected_frame
;
12835 struct Lisp_Symbol
*sym
;
12837 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12839 selected_frame
= frame
;
12842 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12843 if (CONSP (XCAR (tail
))
12844 && (tem
= XCAR (XCAR (tail
)),
12846 && (sym
= indirect_variable (XSYMBOL (tem
)),
12847 sym
->redirect
== SYMBOL_LOCALIZED
)
12848 && sym
->val
.blv
->frame_local
)
12849 /* Use find_symbol_value rather than Fsymbol_value
12850 to avoid an error if it is void. */
12851 find_symbol_value (tem
);
12852 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12856 #define STOP_POLLING \
12857 do { if (! polling_stopped_here) stop_polling (); \
12858 polling_stopped_here = 1; } while (0)
12860 #define RESUME_POLLING \
12861 do { if (polling_stopped_here) start_polling (); \
12862 polling_stopped_here = 0; } while (0)
12865 /* Perhaps in the future avoid recentering windows if it
12866 is not necessary; currently that causes some problems. */
12869 redisplay_internal (void)
12871 struct window
*w
= XWINDOW (selected_window
);
12875 int must_finish
= 0;
12876 struct text_pos tlbufpos
, tlendpos
;
12877 int number_of_visible_frames
;
12878 ptrdiff_t count
, count1
;
12880 int polling_stopped_here
= 0;
12881 Lisp_Object old_frame
= selected_frame
;
12883 /* Non-zero means redisplay has to consider all windows on all
12884 frames. Zero means, only selected_window is considered. */
12885 int consider_all_windows_p
;
12887 /* Non-zero means redisplay has to redisplay the miniwindow */
12888 int update_miniwindow_p
= 0;
12890 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12892 /* No redisplay if running in batch mode or frame is not yet fully
12893 initialized, or redisplay is explicitly turned off by setting
12894 Vinhibit_redisplay. */
12895 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12896 || !NILP (Vinhibit_redisplay
))
12899 /* Don't examine these until after testing Vinhibit_redisplay.
12900 When Emacs is shutting down, perhaps because its connection to
12901 X has dropped, we should not look at them at all. */
12902 fr
= XFRAME (w
->frame
);
12903 sf
= SELECTED_FRAME ();
12905 if (!fr
->glyphs_initialized_p
)
12908 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12909 if (popup_activated ())
12913 /* I don't think this happens but let's be paranoid. */
12914 if (redisplaying_p
)
12917 /* Record a function that resets redisplaying_p to its old value
12918 when we leave this function. */
12919 count
= SPECPDL_INDEX ();
12920 record_unwind_protect (unwind_redisplay
,
12921 Fcons (make_number (redisplaying_p
), selected_frame
));
12923 specbind (Qinhibit_free_realized_faces
, Qnil
);
12926 Lisp_Object tail
, frame
;
12928 FOR_EACH_FRAME (tail
, frame
)
12930 struct frame
*f
= XFRAME (frame
);
12931 f
->already_hscrolled_p
= 0;
12936 /* Remember the currently selected window. */
12939 if (!EQ (old_frame
, selected_frame
)
12940 && FRAME_LIVE_P (XFRAME (old_frame
)))
12941 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12942 selected_frame and selected_window to be temporarily out-of-sync so
12943 when we come back here via `goto retry', we need to resync because we
12944 may need to run Elisp code (via prepare_menu_bars). */
12945 select_frame_for_redisplay (old_frame
);
12948 reconsider_clip_changes (w
, current_buffer
);
12949 last_escape_glyph_frame
= NULL
;
12950 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12951 last_glyphless_glyph_frame
= NULL
;
12952 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12954 /* If new fonts have been loaded that make a glyph matrix adjustment
12955 necessary, do it. */
12956 if (fonts_changed_p
)
12958 adjust_glyphs (NULL
);
12959 ++windows_or_buffers_changed
;
12960 fonts_changed_p
= 0;
12963 /* If face_change_count is non-zero, init_iterator will free all
12964 realized faces, which includes the faces referenced from current
12965 matrices. So, we can't reuse current matrices in this case. */
12966 if (face_change_count
)
12967 ++windows_or_buffers_changed
;
12969 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12970 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12972 /* Since frames on a single ASCII terminal share the same
12973 display area, displaying a different frame means redisplay
12974 the whole thing. */
12975 windows_or_buffers_changed
++;
12976 SET_FRAME_GARBAGED (sf
);
12978 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12980 FRAME_TTY (sf
)->previous_frame
= sf
;
12983 /* Set the visible flags for all frames. Do this before checking
12984 for resized or garbaged frames; they want to know if their frames
12985 are visible. See the comment in frame.h for
12986 FRAME_SAMPLE_VISIBILITY. */
12988 Lisp_Object tail
, frame
;
12990 number_of_visible_frames
= 0;
12992 FOR_EACH_FRAME (tail
, frame
)
12994 struct frame
*f
= XFRAME (frame
);
12996 FRAME_SAMPLE_VISIBILITY (f
);
12997 if (FRAME_VISIBLE_P (f
))
12998 ++number_of_visible_frames
;
12999 clear_desired_matrices (f
);
13003 /* Notice any pending interrupt request to change frame size. */
13004 do_pending_window_change (1);
13006 /* do_pending_window_change could change the selected_window due to
13007 frame resizing which makes the selected window too small. */
13008 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13011 reconsider_clip_changes (w
, current_buffer
);
13014 /* Clear frames marked as garbaged. */
13015 if (frame_garbaged
)
13016 clear_garbaged_frames ();
13018 /* Build menubar and tool-bar items. */
13019 if (NILP (Vmemory_full
))
13020 prepare_menu_bars ();
13022 if (windows_or_buffers_changed
)
13023 update_mode_lines
++;
13025 /* Detect case that we need to write or remove a star in the mode line. */
13026 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13028 w
->update_mode_line
= 1;
13029 if (buffer_shared
> 1)
13030 update_mode_lines
++;
13033 /* Avoid invocation of point motion hooks by `current_column' below. */
13034 count1
= SPECPDL_INDEX ();
13035 specbind (Qinhibit_point_motion_hooks
, Qt
);
13037 /* If %c is in the mode line, update it if needed. */
13038 if (!NILP (w
->column_number_displayed
)
13039 /* This alternative quickly identifies a common case
13040 where no change is needed. */
13041 && !(PT
== w
->last_point
13042 && w
->last_modified
>= MODIFF
13043 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13044 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13045 w
->update_mode_line
= 1;
13047 unbind_to (count1
, Qnil
);
13049 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13051 /* The variable buffer_shared is set in redisplay_window and
13052 indicates that we redisplay a buffer in different windows. See
13054 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13055 || cursor_type_changed
);
13057 /* If specs for an arrow have changed, do thorough redisplay
13058 to ensure we remove any arrow that should no longer exist. */
13059 if (overlay_arrows_changed_p ())
13060 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13062 /* Normally the message* functions will have already displayed and
13063 updated the echo area, but the frame may have been trashed, or
13064 the update may have been preempted, so display the echo area
13065 again here. Checking message_cleared_p captures the case that
13066 the echo area should be cleared. */
13067 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13068 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13069 || (message_cleared_p
13070 && minibuf_level
== 0
13071 /* If the mini-window is currently selected, this means the
13072 echo-area doesn't show through. */
13073 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13075 int window_height_changed_p
= echo_area_display (0);
13077 if (message_cleared_p
)
13078 update_miniwindow_p
= 1;
13082 /* If we don't display the current message, don't clear the
13083 message_cleared_p flag, because, if we did, we wouldn't clear
13084 the echo area in the next redisplay which doesn't preserve
13086 if (!display_last_displayed_message_p
)
13087 message_cleared_p
= 0;
13089 if (fonts_changed_p
)
13091 else if (window_height_changed_p
)
13093 consider_all_windows_p
= 1;
13094 ++update_mode_lines
;
13095 ++windows_or_buffers_changed
;
13097 /* If window configuration was changed, frames may have been
13098 marked garbaged. Clear them or we will experience
13099 surprises wrt scrolling. */
13100 if (frame_garbaged
)
13101 clear_garbaged_frames ();
13104 else if (EQ (selected_window
, minibuf_window
)
13105 && (current_buffer
->clip_changed
13106 || w
->last_modified
< MODIFF
13107 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13108 && resize_mini_window (w
, 0))
13110 /* Resized active mini-window to fit the size of what it is
13111 showing if its contents might have changed. */
13113 /* FIXME: this causes all frames to be updated, which seems unnecessary
13114 since only the current frame needs to be considered. This function needs
13115 to be rewritten with two variables, consider_all_windows and
13116 consider_all_frames. */
13117 consider_all_windows_p
= 1;
13118 ++windows_or_buffers_changed
;
13119 ++update_mode_lines
;
13121 /* If window configuration was changed, frames may have been
13122 marked garbaged. Clear them or we will experience
13123 surprises wrt scrolling. */
13124 if (frame_garbaged
)
13125 clear_garbaged_frames ();
13129 /* If showing the region, and mark has changed, we must redisplay
13130 the whole window. The assignment to this_line_start_pos prevents
13131 the optimization directly below this if-statement. */
13132 if (((!NILP (Vtransient_mark_mode
)
13133 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13134 != !NILP (w
->region_showing
))
13135 || (!NILP (w
->region_showing
)
13136 && !EQ (w
->region_showing
,
13137 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13138 CHARPOS (this_line_start_pos
) = 0;
13140 /* Optimize the case that only the line containing the cursor in the
13141 selected window has changed. Variables starting with this_ are
13142 set in display_line and record information about the line
13143 containing the cursor. */
13144 tlbufpos
= this_line_start_pos
;
13145 tlendpos
= this_line_end_pos
;
13146 if (!consider_all_windows_p
13147 && CHARPOS (tlbufpos
) > 0
13148 && !w
->update_mode_line
13149 && !current_buffer
->clip_changed
13150 && !current_buffer
->prevent_redisplay_optimizations_p
13151 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13152 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13153 /* Make sure recorded data applies to current buffer, etc. */
13154 && this_line_buffer
== current_buffer
13155 && current_buffer
== XBUFFER (w
->buffer
)
13157 && !w
->optional_new_start
13158 /* Point must be on the line that we have info recorded about. */
13159 && PT
>= CHARPOS (tlbufpos
)
13160 && PT
<= Z
- CHARPOS (tlendpos
)
13161 /* All text outside that line, including its final newline,
13162 must be unchanged. */
13163 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13164 CHARPOS (tlendpos
)))
13166 if (CHARPOS (tlbufpos
) > BEGV
13167 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13168 && (CHARPOS (tlbufpos
) == ZV
13169 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13170 /* Former continuation line has disappeared by becoming empty. */
13172 else if (w
->last_modified
< MODIFF
13173 || w
->last_overlay_modified
< OVERLAY_MODIFF
13174 || MINI_WINDOW_P (w
))
13176 /* We have to handle the case of continuation around a
13177 wide-column character (see the comment in indent.c around
13180 For instance, in the following case:
13182 -------- Insert --------
13183 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13184 J_I_ ==> J_I_ `^^' are cursors.
13188 As we have to redraw the line above, we cannot use this
13192 int line_height_before
= this_line_pixel_height
;
13194 /* Note that start_display will handle the case that the
13195 line starting at tlbufpos is a continuation line. */
13196 start_display (&it
, w
, tlbufpos
);
13198 /* Implementation note: It this still necessary? */
13199 if (it
.current_x
!= this_line_start_x
)
13202 TRACE ((stderr
, "trying display optimization 1\n"));
13203 w
->cursor
.vpos
= -1;
13204 overlay_arrow_seen
= 0;
13205 it
.vpos
= this_line_vpos
;
13206 it
.current_y
= this_line_y
;
13207 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13208 display_line (&it
);
13210 /* If line contains point, is not continued,
13211 and ends at same distance from eob as before, we win. */
13212 if (w
->cursor
.vpos
>= 0
13213 /* Line is not continued, otherwise this_line_start_pos
13214 would have been set to 0 in display_line. */
13215 && CHARPOS (this_line_start_pos
)
13216 /* Line ends as before. */
13217 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13218 /* Line has same height as before. Otherwise other lines
13219 would have to be shifted up or down. */
13220 && this_line_pixel_height
== line_height_before
)
13222 /* If this is not the window's last line, we must adjust
13223 the charstarts of the lines below. */
13224 if (it
.current_y
< it
.last_visible_y
)
13226 struct glyph_row
*row
13227 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13228 ptrdiff_t delta
, delta_bytes
;
13230 /* We used to distinguish between two cases here,
13231 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13232 when the line ends in a newline or the end of the
13233 buffer's accessible portion. But both cases did
13234 the same, so they were collapsed. */
13236 - CHARPOS (tlendpos
)
13237 - MATRIX_ROW_START_CHARPOS (row
));
13238 delta_bytes
= (Z_BYTE
13239 - BYTEPOS (tlendpos
)
13240 - MATRIX_ROW_START_BYTEPOS (row
));
13242 increment_matrix_positions (w
->current_matrix
,
13243 this_line_vpos
+ 1,
13244 w
->current_matrix
->nrows
,
13245 delta
, delta_bytes
);
13248 /* If this row displays text now but previously didn't,
13249 or vice versa, w->window_end_vpos may have to be
13251 if ((it
.glyph_row
- 1)->displays_text_p
)
13253 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13254 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13256 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13257 && this_line_vpos
> 0)
13258 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13259 w
->window_end_valid
= Qnil
;
13261 /* Update hint: No need to try to scroll in update_window. */
13262 w
->desired_matrix
->no_scrolling_p
= 1;
13265 *w
->desired_matrix
->method
= 0;
13266 debug_method_add (w
, "optimization 1");
13268 #ifdef HAVE_WINDOW_SYSTEM
13269 update_window_fringes (w
, 0);
13276 else if (/* Cursor position hasn't changed. */
13277 PT
== w
->last_point
13278 /* Make sure the cursor was last displayed
13279 in this window. Otherwise we have to reposition it. */
13280 && 0 <= w
->cursor
.vpos
13281 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13285 do_pending_window_change (1);
13286 /* If selected_window changed, redisplay again. */
13287 if (WINDOWP (selected_window
)
13288 && (w
= XWINDOW (selected_window
)) != sw
)
13291 /* We used to always goto end_of_redisplay here, but this
13292 isn't enough if we have a blinking cursor. */
13293 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13294 goto end_of_redisplay
;
13298 /* If highlighting the region, or if the cursor is in the echo area,
13299 then we can't just move the cursor. */
13300 else if (! (!NILP (Vtransient_mark_mode
)
13301 && !NILP (BVAR (current_buffer
, mark_active
)))
13302 && (EQ (selected_window
,
13303 BVAR (current_buffer
, last_selected_window
))
13304 || highlight_nonselected_windows
)
13305 && NILP (w
->region_showing
)
13306 && NILP (Vshow_trailing_whitespace
)
13307 && !cursor_in_echo_area
)
13310 struct glyph_row
*row
;
13312 /* Skip from tlbufpos to PT and see where it is. Note that
13313 PT may be in invisible text. If so, we will end at the
13314 next visible position. */
13315 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13316 NULL
, DEFAULT_FACE_ID
);
13317 it
.current_x
= this_line_start_x
;
13318 it
.current_y
= this_line_y
;
13319 it
.vpos
= this_line_vpos
;
13321 /* The call to move_it_to stops in front of PT, but
13322 moves over before-strings. */
13323 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13325 if (it
.vpos
== this_line_vpos
13326 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13329 eassert (this_line_vpos
== it
.vpos
);
13330 eassert (this_line_y
== it
.current_y
);
13331 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13333 *w
->desired_matrix
->method
= 0;
13334 debug_method_add (w
, "optimization 3");
13343 /* Text changed drastically or point moved off of line. */
13344 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13347 CHARPOS (this_line_start_pos
) = 0;
13348 consider_all_windows_p
|= buffer_shared
> 1;
13349 ++clear_face_cache_count
;
13350 #ifdef HAVE_WINDOW_SYSTEM
13351 ++clear_image_cache_count
;
13354 /* Build desired matrices, and update the display. If
13355 consider_all_windows_p is non-zero, do it for all windows on all
13356 frames. Otherwise do it for selected_window, only. */
13358 if (consider_all_windows_p
)
13360 Lisp_Object tail
, frame
;
13362 FOR_EACH_FRAME (tail
, frame
)
13363 XFRAME (frame
)->updated_p
= 0;
13365 /* Recompute # windows showing selected buffer. This will be
13366 incremented each time such a window is displayed. */
13369 FOR_EACH_FRAME (tail
, frame
)
13371 struct frame
*f
= XFRAME (frame
);
13373 /* We don't have to do anything for unselected terminal
13375 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13376 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13379 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13381 if (! EQ (frame
, selected_frame
))
13382 /* Select the frame, for the sake of frame-local
13384 select_frame_for_redisplay (frame
);
13386 /* Mark all the scroll bars to be removed; we'll redeem
13387 the ones we want when we redisplay their windows. */
13388 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13389 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13391 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13392 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13394 /* The X error handler may have deleted that frame. */
13395 if (!FRAME_LIVE_P (f
))
13398 /* Any scroll bars which redisplay_windows should have
13399 nuked should now go away. */
13400 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13401 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13403 /* If fonts changed, display again. */
13404 /* ??? rms: I suspect it is a mistake to jump all the way
13405 back to retry here. It should just retry this frame. */
13406 if (fonts_changed_p
)
13409 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13411 /* See if we have to hscroll. */
13412 if (!f
->already_hscrolled_p
)
13414 f
->already_hscrolled_p
= 1;
13415 if (hscroll_windows (f
->root_window
))
13419 /* Prevent various kinds of signals during display
13420 update. stdio is not robust about handling
13421 signals, which can cause an apparent I/O
13423 if (interrupt_input
)
13424 unrequest_sigio ();
13427 /* Update the display. */
13428 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13429 pending
|= update_frame (f
, 0, 0);
13435 if (!EQ (old_frame
, selected_frame
)
13436 && FRAME_LIVE_P (XFRAME (old_frame
)))
13437 /* We played a bit fast-and-loose above and allowed selected_frame
13438 and selected_window to be temporarily out-of-sync but let's make
13439 sure this stays contained. */
13440 select_frame_for_redisplay (old_frame
);
13441 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13445 /* Do the mark_window_display_accurate after all windows have
13446 been redisplayed because this call resets flags in buffers
13447 which are needed for proper redisplay. */
13448 FOR_EACH_FRAME (tail
, frame
)
13450 struct frame
*f
= XFRAME (frame
);
13453 mark_window_display_accurate (f
->root_window
, 1);
13454 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13455 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13460 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13462 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13463 struct frame
*mini_frame
;
13465 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13466 /* Use list_of_error, not Qerror, so that
13467 we catch only errors and don't run the debugger. */
13468 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13470 redisplay_window_error
);
13471 if (update_miniwindow_p
)
13472 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13474 redisplay_window_error
);
13476 /* Compare desired and current matrices, perform output. */
13479 /* If fonts changed, display again. */
13480 if (fonts_changed_p
)
13483 /* Prevent various kinds of signals during display update.
13484 stdio is not robust about handling signals,
13485 which can cause an apparent I/O error. */
13486 if (interrupt_input
)
13487 unrequest_sigio ();
13490 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13492 if (hscroll_windows (selected_window
))
13495 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13496 pending
= update_frame (sf
, 0, 0);
13499 /* We may have called echo_area_display at the top of this
13500 function. If the echo area is on another frame, that may
13501 have put text on a frame other than the selected one, so the
13502 above call to update_frame would not have caught it. Catch
13504 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13505 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13507 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13509 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13510 pending
|= update_frame (mini_frame
, 0, 0);
13511 if (!pending
&& hscroll_windows (mini_window
))
13516 /* If display was paused because of pending input, make sure we do a
13517 thorough update the next time. */
13520 /* Prevent the optimization at the beginning of
13521 redisplay_internal that tries a single-line update of the
13522 line containing the cursor in the selected window. */
13523 CHARPOS (this_line_start_pos
) = 0;
13525 /* Let the overlay arrow be updated the next time. */
13526 update_overlay_arrows (0);
13528 /* If we pause after scrolling, some rows in the current
13529 matrices of some windows are not valid. */
13530 if (!WINDOW_FULL_WIDTH_P (w
)
13531 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13532 update_mode_lines
= 1;
13536 if (!consider_all_windows_p
)
13538 /* This has already been done above if
13539 consider_all_windows_p is set. */
13540 mark_window_display_accurate_1 (w
, 1);
13542 /* Say overlay arrows are up to date. */
13543 update_overlay_arrows (1);
13545 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13546 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13549 update_mode_lines
= 0;
13550 windows_or_buffers_changed
= 0;
13551 cursor_type_changed
= 0;
13554 /* Start SIGIO interrupts coming again. Having them off during the
13555 code above makes it less likely one will discard output, but not
13556 impossible, since there might be stuff in the system buffer here.
13557 But it is much hairier to try to do anything about that. */
13558 if (interrupt_input
)
13562 /* If a frame has become visible which was not before, redisplay
13563 again, so that we display it. Expose events for such a frame
13564 (which it gets when becoming visible) don't call the parts of
13565 redisplay constructing glyphs, so simply exposing a frame won't
13566 display anything in this case. So, we have to display these
13567 frames here explicitly. */
13570 Lisp_Object tail
, frame
;
13573 FOR_EACH_FRAME (tail
, frame
)
13575 int this_is_visible
= 0;
13577 if (XFRAME (frame
)->visible
)
13578 this_is_visible
= 1;
13579 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13580 if (XFRAME (frame
)->visible
)
13581 this_is_visible
= 1;
13583 if (this_is_visible
)
13587 if (new_count
!= number_of_visible_frames
)
13588 windows_or_buffers_changed
++;
13591 /* Change frame size now if a change is pending. */
13592 do_pending_window_change (1);
13594 /* If we just did a pending size change, or have additional
13595 visible frames, or selected_window changed, redisplay again. */
13596 if ((windows_or_buffers_changed
&& !pending
)
13597 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13600 /* Clear the face and image caches.
13602 We used to do this only if consider_all_windows_p. But the cache
13603 needs to be cleared if a timer creates images in the current
13604 buffer (e.g. the test case in Bug#6230). */
13606 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13608 clear_face_cache (0);
13609 clear_face_cache_count
= 0;
13612 #ifdef HAVE_WINDOW_SYSTEM
13613 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13615 clear_image_caches (Qnil
);
13616 clear_image_cache_count
= 0;
13618 #endif /* HAVE_WINDOW_SYSTEM */
13621 unbind_to (count
, Qnil
);
13626 /* Redisplay, but leave alone any recent echo area message unless
13627 another message has been requested in its place.
13629 This is useful in situations where you need to redisplay but no
13630 user action has occurred, making it inappropriate for the message
13631 area to be cleared. See tracking_off and
13632 wait_reading_process_output for examples of these situations.
13634 FROM_WHERE is an integer saying from where this function was
13635 called. This is useful for debugging. */
13638 redisplay_preserve_echo_area (int from_where
)
13640 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13642 if (!NILP (echo_area_buffer
[1]))
13644 /* We have a previously displayed message, but no current
13645 message. Redisplay the previous message. */
13646 display_last_displayed_message_p
= 1;
13647 redisplay_internal ();
13648 display_last_displayed_message_p
= 0;
13651 redisplay_internal ();
13653 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13654 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13655 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13659 /* Function registered with record_unwind_protect in
13660 redisplay_internal. Reset redisplaying_p to the value it had
13661 before redisplay_internal was called, and clear
13662 prevent_freeing_realized_faces_p. It also selects the previously
13663 selected frame, unless it has been deleted (by an X connection
13664 failure during redisplay, for example). */
13667 unwind_redisplay (Lisp_Object val
)
13669 Lisp_Object old_redisplaying_p
, old_frame
;
13671 old_redisplaying_p
= XCAR (val
);
13672 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13673 old_frame
= XCDR (val
);
13674 if (! EQ (old_frame
, selected_frame
)
13675 && FRAME_LIVE_P (XFRAME (old_frame
)))
13676 select_frame_for_redisplay (old_frame
);
13681 /* Mark the display of window W as accurate or inaccurate. If
13682 ACCURATE_P is non-zero mark display of W as accurate. If
13683 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13684 redisplay_internal is called. */
13687 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13689 if (BUFFERP (w
->buffer
))
13691 struct buffer
*b
= XBUFFER (w
->buffer
);
13693 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13694 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13696 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13700 b
->clip_changed
= 0;
13701 b
->prevent_redisplay_optimizations_p
= 0;
13703 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13704 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13705 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13706 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13708 w
->current_matrix
->buffer
= b
;
13709 w
->current_matrix
->begv
= BUF_BEGV (b
);
13710 w
->current_matrix
->zv
= BUF_ZV (b
);
13712 w
->last_cursor
= w
->cursor
;
13713 w
->last_cursor_off_p
= w
->cursor_off_p
;
13715 if (w
== XWINDOW (selected_window
))
13716 w
->last_point
= BUF_PT (b
);
13718 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13724 w
->window_end_valid
= w
->buffer
;
13725 w
->update_mode_line
= 0;
13730 /* Mark the display of windows in the window tree rooted at WINDOW as
13731 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13732 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13733 be redisplayed the next time redisplay_internal is called. */
13736 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13740 for (; !NILP (window
); window
= w
->next
)
13742 w
= XWINDOW (window
);
13743 mark_window_display_accurate_1 (w
, accurate_p
);
13745 if (!NILP (w
->vchild
))
13746 mark_window_display_accurate (w
->vchild
, accurate_p
);
13747 if (!NILP (w
->hchild
))
13748 mark_window_display_accurate (w
->hchild
, accurate_p
);
13753 update_overlay_arrows (1);
13757 /* Force a thorough redisplay the next time by setting
13758 last_arrow_position and last_arrow_string to t, which is
13759 unequal to any useful value of Voverlay_arrow_... */
13760 update_overlay_arrows (-1);
13765 /* Return value in display table DP (Lisp_Char_Table *) for character
13766 C. Since a display table doesn't have any parent, we don't have to
13767 follow parent. Do not call this function directly but use the
13768 macro DISP_CHAR_VECTOR. */
13771 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13775 if (ASCII_CHAR_P (c
))
13778 if (SUB_CHAR_TABLE_P (val
))
13779 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13785 XSETCHAR_TABLE (table
, dp
);
13786 val
= char_table_ref (table
, c
);
13795 /***********************************************************************
13797 ***********************************************************************/
13799 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13802 redisplay_windows (Lisp_Object window
)
13804 while (!NILP (window
))
13806 struct window
*w
= XWINDOW (window
);
13808 if (!NILP (w
->hchild
))
13809 redisplay_windows (w
->hchild
);
13810 else if (!NILP (w
->vchild
))
13811 redisplay_windows (w
->vchild
);
13812 else if (!NILP (w
->buffer
))
13814 displayed_buffer
= XBUFFER (w
->buffer
);
13815 /* Use list_of_error, not Qerror, so that
13816 we catch only errors and don't run the debugger. */
13817 internal_condition_case_1 (redisplay_window_0
, window
,
13819 redisplay_window_error
);
13827 redisplay_window_error (Lisp_Object ignore
)
13829 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13834 redisplay_window_0 (Lisp_Object window
)
13836 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13837 redisplay_window (window
, 0);
13842 redisplay_window_1 (Lisp_Object window
)
13844 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13845 redisplay_window (window
, 1);
13850 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13851 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13852 which positions recorded in ROW differ from current buffer
13855 Return 0 if cursor is not on this row, 1 otherwise. */
13858 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13859 struct glyph_matrix
*matrix
,
13860 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13863 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13864 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13865 struct glyph
*cursor
= NULL
;
13866 /* The last known character position in row. */
13867 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13869 ptrdiff_t pt_old
= PT
- delta
;
13870 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13871 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13872 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13873 /* A glyph beyond the edge of TEXT_AREA which we should never
13875 struct glyph
*glyphs_end
= end
;
13876 /* Non-zero means we've found a match for cursor position, but that
13877 glyph has the avoid_cursor_p flag set. */
13878 int match_with_avoid_cursor
= 0;
13879 /* Non-zero means we've seen at least one glyph that came from a
13881 int string_seen
= 0;
13882 /* Largest and smallest buffer positions seen so far during scan of
13884 ptrdiff_t bpos_max
= pos_before
;
13885 ptrdiff_t bpos_min
= pos_after
;
13886 /* Last buffer position covered by an overlay string with an integer
13887 `cursor' property. */
13888 ptrdiff_t bpos_covered
= 0;
13889 /* Non-zero means the display string on which to display the cursor
13890 comes from a text property, not from an overlay. */
13891 int string_from_text_prop
= 0;
13893 /* Don't even try doing anything if called for a mode-line or
13894 header-line row, since the rest of the code isn't prepared to
13895 deal with such calamities. */
13896 eassert (!row
->mode_line_p
);
13897 if (row
->mode_line_p
)
13900 /* Skip over glyphs not having an object at the start and the end of
13901 the row. These are special glyphs like truncation marks on
13902 terminal frames. */
13903 if (row
->displays_text_p
)
13905 if (!row
->reversed_p
)
13908 && INTEGERP (glyph
->object
)
13909 && glyph
->charpos
< 0)
13911 x
+= glyph
->pixel_width
;
13915 && INTEGERP ((end
- 1)->object
)
13916 /* CHARPOS is zero for blanks and stretch glyphs
13917 inserted by extend_face_to_end_of_line. */
13918 && (end
- 1)->charpos
<= 0)
13920 glyph_before
= glyph
- 1;
13927 /* If the glyph row is reversed, we need to process it from back
13928 to front, so swap the edge pointers. */
13929 glyphs_end
= end
= glyph
- 1;
13930 glyph
+= row
->used
[TEXT_AREA
] - 1;
13932 while (glyph
> end
+ 1
13933 && INTEGERP (glyph
->object
)
13934 && glyph
->charpos
< 0)
13937 x
-= glyph
->pixel_width
;
13939 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13941 /* By default, in reversed rows we put the cursor on the
13942 rightmost (first in the reading order) glyph. */
13943 for (g
= end
+ 1; g
< glyph
; g
++)
13944 x
+= g
->pixel_width
;
13946 && INTEGERP ((end
+ 1)->object
)
13947 && (end
+ 1)->charpos
<= 0)
13949 glyph_before
= glyph
+ 1;
13953 else if (row
->reversed_p
)
13955 /* In R2L rows that don't display text, put the cursor on the
13956 rightmost glyph. Case in point: an empty last line that is
13957 part of an R2L paragraph. */
13959 /* Avoid placing the cursor on the last glyph of the row, where
13960 on terminal frames we hold the vertical border between
13961 adjacent windows. */
13962 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13963 && !WINDOW_RIGHTMOST_P (w
)
13964 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13966 x
= -1; /* will be computed below, at label compute_x */
13969 /* Step 1: Try to find the glyph whose character position
13970 corresponds to point. If that's not possible, find 2 glyphs
13971 whose character positions are the closest to point, one before
13972 point, the other after it. */
13973 if (!row
->reversed_p
)
13974 while (/* not marched to end of glyph row */
13976 /* glyph was not inserted by redisplay for internal purposes */
13977 && !INTEGERP (glyph
->object
))
13979 if (BUFFERP (glyph
->object
))
13981 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13983 if (glyph
->charpos
> bpos_max
)
13984 bpos_max
= glyph
->charpos
;
13985 if (glyph
->charpos
< bpos_min
)
13986 bpos_min
= glyph
->charpos
;
13987 if (!glyph
->avoid_cursor_p
)
13989 /* If we hit point, we've found the glyph on which to
13990 display the cursor. */
13993 match_with_avoid_cursor
= 0;
13996 /* See if we've found a better approximation to
13997 POS_BEFORE or to POS_AFTER. */
13998 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14000 pos_before
= glyph
->charpos
;
14001 glyph_before
= glyph
;
14003 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14005 pos_after
= glyph
->charpos
;
14006 glyph_after
= glyph
;
14009 else if (dpos
== 0)
14010 match_with_avoid_cursor
= 1;
14012 else if (STRINGP (glyph
->object
))
14014 Lisp_Object chprop
;
14015 ptrdiff_t glyph_pos
= glyph
->charpos
;
14017 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14019 if (!NILP (chprop
))
14021 /* If the string came from a `display' text property,
14022 look up the buffer position of that property and
14023 use that position to update bpos_max, as if we
14024 actually saw such a position in one of the row's
14025 glyphs. This helps with supporting integer values
14026 of `cursor' property on the display string in
14027 situations where most or all of the row's buffer
14028 text is completely covered by display properties,
14029 so that no glyph with valid buffer positions is
14030 ever seen in the row. */
14031 ptrdiff_t prop_pos
=
14032 string_buffer_position_lim (glyph
->object
, pos_before
,
14035 if (prop_pos
>= pos_before
)
14036 bpos_max
= prop_pos
- 1;
14038 if (INTEGERP (chprop
))
14040 bpos_covered
= bpos_max
+ XINT (chprop
);
14041 /* If the `cursor' property covers buffer positions up
14042 to and including point, we should display cursor on
14043 this glyph. Note that, if a `cursor' property on one
14044 of the string's characters has an integer value, we
14045 will break out of the loop below _before_ we get to
14046 the position match above. IOW, integer values of
14047 the `cursor' property override the "exact match for
14048 point" strategy of positioning the cursor. */
14049 /* Implementation note: bpos_max == pt_old when, e.g.,
14050 we are in an empty line, where bpos_max is set to
14051 MATRIX_ROW_START_CHARPOS, see above. */
14052 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14061 x
+= glyph
->pixel_width
;
14064 else if (glyph
> end
) /* row is reversed */
14065 while (!INTEGERP (glyph
->object
))
14067 if (BUFFERP (glyph
->object
))
14069 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14071 if (glyph
->charpos
> bpos_max
)
14072 bpos_max
= glyph
->charpos
;
14073 if (glyph
->charpos
< bpos_min
)
14074 bpos_min
= glyph
->charpos
;
14075 if (!glyph
->avoid_cursor_p
)
14079 match_with_avoid_cursor
= 0;
14082 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14084 pos_before
= glyph
->charpos
;
14085 glyph_before
= glyph
;
14087 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14089 pos_after
= glyph
->charpos
;
14090 glyph_after
= glyph
;
14093 else if (dpos
== 0)
14094 match_with_avoid_cursor
= 1;
14096 else if (STRINGP (glyph
->object
))
14098 Lisp_Object chprop
;
14099 ptrdiff_t glyph_pos
= glyph
->charpos
;
14101 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14103 if (!NILP (chprop
))
14105 ptrdiff_t prop_pos
=
14106 string_buffer_position_lim (glyph
->object
, pos_before
,
14109 if (prop_pos
>= pos_before
)
14110 bpos_max
= prop_pos
- 1;
14112 if (INTEGERP (chprop
))
14114 bpos_covered
= bpos_max
+ XINT (chprop
);
14115 /* If the `cursor' property covers buffer positions up
14116 to and including point, we should display cursor on
14118 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14127 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14129 x
--; /* can't use any pixel_width */
14132 x
-= glyph
->pixel_width
;
14135 /* Step 2: If we didn't find an exact match for point, we need to
14136 look for a proper place to put the cursor among glyphs between
14137 GLYPH_BEFORE and GLYPH_AFTER. */
14138 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14139 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14140 && bpos_covered
< pt_old
)
14142 /* An empty line has a single glyph whose OBJECT is zero and
14143 whose CHARPOS is the position of a newline on that line.
14144 Note that on a TTY, there are more glyphs after that, which
14145 were produced by extend_face_to_end_of_line, but their
14146 CHARPOS is zero or negative. */
14148 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14149 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14151 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14153 ptrdiff_t ellipsis_pos
;
14155 /* Scan back over the ellipsis glyphs. */
14156 if (!row
->reversed_p
)
14158 ellipsis_pos
= (glyph
- 1)->charpos
;
14159 while (glyph
> row
->glyphs
[TEXT_AREA
]
14160 && (glyph
- 1)->charpos
== ellipsis_pos
)
14161 glyph
--, x
-= glyph
->pixel_width
;
14162 /* That loop always goes one position too far, including
14163 the glyph before the ellipsis. So scan forward over
14165 x
+= glyph
->pixel_width
;
14168 else /* row is reversed */
14170 ellipsis_pos
= (glyph
+ 1)->charpos
;
14171 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14172 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14173 glyph
++, x
+= glyph
->pixel_width
;
14174 x
-= glyph
->pixel_width
;
14178 else if (match_with_avoid_cursor
)
14180 cursor
= glyph_after
;
14183 else if (string_seen
)
14185 int incr
= row
->reversed_p
? -1 : +1;
14187 /* Need to find the glyph that came out of a string which is
14188 present at point. That glyph is somewhere between
14189 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14190 positioned between POS_BEFORE and POS_AFTER in the
14192 struct glyph
*start
, *stop
;
14193 ptrdiff_t pos
= pos_before
;
14197 /* If the row ends in a newline from a display string,
14198 reordering could have moved the glyphs belonging to the
14199 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14200 in this case we extend the search to the last glyph in
14201 the row that was not inserted by redisplay. */
14202 if (row
->ends_in_newline_from_string_p
)
14205 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14208 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14209 correspond to POS_BEFORE and POS_AFTER, respectively. We
14210 need START and STOP in the order that corresponds to the
14211 row's direction as given by its reversed_p flag. If the
14212 directionality of characters between POS_BEFORE and
14213 POS_AFTER is the opposite of the row's base direction,
14214 these characters will have been reordered for display,
14215 and we need to reverse START and STOP. */
14216 if (!row
->reversed_p
)
14218 start
= min (glyph_before
, glyph_after
);
14219 stop
= max (glyph_before
, glyph_after
);
14223 start
= max (glyph_before
, glyph_after
);
14224 stop
= min (glyph_before
, glyph_after
);
14226 for (glyph
= start
+ incr
;
14227 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14230 /* Any glyphs that come from the buffer are here because
14231 of bidi reordering. Skip them, and only pay
14232 attention to glyphs that came from some string. */
14233 if (STRINGP (glyph
->object
))
14237 /* If the display property covers the newline, we
14238 need to search for it one position farther. */
14239 ptrdiff_t lim
= pos_after
14240 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14242 string_from_text_prop
= 0;
14243 str
= glyph
->object
;
14244 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14245 if (tem
== 0 /* from overlay */
14248 /* If the string from which this glyph came is
14249 found in the buffer at point, or at position
14250 that is closer to point than pos_after, then
14251 we've found the glyph we've been looking for.
14252 If it comes from an overlay (tem == 0), and
14253 it has the `cursor' property on one of its
14254 glyphs, record that glyph as a candidate for
14255 displaying the cursor. (As in the
14256 unidirectional version, we will display the
14257 cursor on the last candidate we find.) */
14260 || (tem
- pt_old
> 0 && tem
< pos_after
))
14262 /* The glyphs from this string could have
14263 been reordered. Find the one with the
14264 smallest string position. Or there could
14265 be a character in the string with the
14266 `cursor' property, which means display
14267 cursor on that character's glyph. */
14268 ptrdiff_t strpos
= glyph
->charpos
;
14273 string_from_text_prop
= 1;
14276 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14277 && EQ (glyph
->object
, str
);
14281 ptrdiff_t gpos
= glyph
->charpos
;
14283 cprop
= Fget_char_property (make_number (gpos
),
14291 if (tem
&& glyph
->charpos
< strpos
)
14293 strpos
= glyph
->charpos
;
14299 || (tem
- pt_old
> 0 && tem
< pos_after
))
14303 pos
= tem
+ 1; /* don't find previous instances */
14305 /* This string is not what we want; skip all of the
14306 glyphs that came from it. */
14307 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14308 && EQ (glyph
->object
, str
))
14315 /* If we reached the end of the line, and END was from a string,
14316 the cursor is not on this line. */
14318 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14319 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14320 && STRINGP (end
->object
)
14321 && row
->continued_p
)
14324 /* A truncated row may not include PT among its character positions.
14325 Setting the cursor inside the scroll margin will trigger
14326 recalculation of hscroll in hscroll_window_tree. But if a
14327 display string covers point, defer to the string-handling
14328 code below to figure this out. */
14329 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14331 cursor
= glyph_before
;
14334 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14335 /* Zero-width characters produce no glyphs. */
14337 && (row
->reversed_p
14338 ? glyph_after
> glyphs_end
14339 : glyph_after
< glyphs_end
)))
14341 cursor
= glyph_after
;
14347 if (cursor
!= NULL
)
14349 else if (glyph
== glyphs_end
14350 && pos_before
== pos_after
14351 && STRINGP ((row
->reversed_p
14352 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14353 : row
->glyphs
[TEXT_AREA
])->object
))
14355 /* If all the glyphs of this row came from strings, put the
14356 cursor on the first glyph of the row. This avoids having the
14357 cursor outside of the text area in this very rare and hard
14361 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14362 : row
->glyphs
[TEXT_AREA
];
14368 /* Need to compute x that corresponds to GLYPH. */
14369 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14371 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14373 x
+= g
->pixel_width
;
14377 /* ROW could be part of a continued line, which, under bidi
14378 reordering, might have other rows whose start and end charpos
14379 occlude point. Only set w->cursor if we found a better
14380 approximation to the cursor position than we have from previously
14381 examined candidate rows belonging to the same continued line. */
14382 if (/* we already have a candidate row */
14383 w
->cursor
.vpos
>= 0
14384 /* that candidate is not the row we are processing */
14385 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14386 /* Make sure cursor.vpos specifies a row whose start and end
14387 charpos occlude point, and it is valid candidate for being a
14388 cursor-row. This is because some callers of this function
14389 leave cursor.vpos at the row where the cursor was displayed
14390 during the last redisplay cycle. */
14391 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14392 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14393 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14396 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14398 /* Don't consider glyphs that are outside TEXT_AREA. */
14399 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14401 /* Keep the candidate whose buffer position is the closest to
14402 point or has the `cursor' property. */
14403 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14404 w
->cursor
.hpos
>= 0
14405 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14406 && ((BUFFERP (g1
->object
)
14407 && (g1
->charpos
== pt_old
/* an exact match always wins */
14408 || (BUFFERP (glyph
->object
)
14409 && eabs (g1
->charpos
- pt_old
)
14410 < eabs (glyph
->charpos
- pt_old
))))
14411 /* previous candidate is a glyph from a string that has
14412 a non-nil `cursor' property */
14413 || (STRINGP (g1
->object
)
14414 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14415 Qcursor
, g1
->object
))
14416 /* previous candidate is from the same display
14417 string as this one, and the display string
14418 came from a text property */
14419 || (EQ (g1
->object
, glyph
->object
)
14420 && string_from_text_prop
)
14421 /* this candidate is from newline and its
14422 position is not an exact match */
14423 || (INTEGERP (glyph
->object
)
14424 && glyph
->charpos
!= pt_old
)))))
14426 /* If this candidate gives an exact match, use that. */
14427 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14428 /* If this candidate is a glyph created for the
14429 terminating newline of a line, and point is on that
14430 newline, it wins because it's an exact match. */
14431 || (!row
->continued_p
14432 && INTEGERP (glyph
->object
)
14433 && glyph
->charpos
== 0
14434 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14435 /* Otherwise, keep the candidate that comes from a row
14436 spanning less buffer positions. This may win when one or
14437 both candidate positions are on glyphs that came from
14438 display strings, for which we cannot compare buffer
14440 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14441 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14442 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14445 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14447 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14448 w
->cursor
.y
= row
->y
+ dy
;
14450 if (w
== XWINDOW (selected_window
))
14452 if (!row
->continued_p
14453 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14456 this_line_buffer
= XBUFFER (w
->buffer
);
14458 CHARPOS (this_line_start_pos
)
14459 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14460 BYTEPOS (this_line_start_pos
)
14461 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14463 CHARPOS (this_line_end_pos
)
14464 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14465 BYTEPOS (this_line_end_pos
)
14466 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14468 this_line_y
= w
->cursor
.y
;
14469 this_line_pixel_height
= row
->height
;
14470 this_line_vpos
= w
->cursor
.vpos
;
14471 this_line_start_x
= row
->x
;
14474 CHARPOS (this_line_start_pos
) = 0;
14481 /* Run window scroll functions, if any, for WINDOW with new window
14482 start STARTP. Sets the window start of WINDOW to that position.
14484 We assume that the window's buffer is really current. */
14486 static inline struct text_pos
14487 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14489 struct window
*w
= XWINDOW (window
);
14490 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14492 if (current_buffer
!= XBUFFER (w
->buffer
))
14495 if (!NILP (Vwindow_scroll_functions
))
14497 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14498 make_number (CHARPOS (startp
)));
14499 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14500 /* In case the hook functions switch buffers. */
14501 if (current_buffer
!= XBUFFER (w
->buffer
))
14502 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14509 /* Make sure the line containing the cursor is fully visible.
14510 A value of 1 means there is nothing to be done.
14511 (Either the line is fully visible, or it cannot be made so,
14512 or we cannot tell.)
14514 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14515 is higher than window.
14517 A value of 0 means the caller should do scrolling
14518 as if point had gone off the screen. */
14521 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14523 struct glyph_matrix
*matrix
;
14524 struct glyph_row
*row
;
14527 if (!make_cursor_line_fully_visible_p
)
14530 /* It's not always possible to find the cursor, e.g, when a window
14531 is full of overlay strings. Don't do anything in that case. */
14532 if (w
->cursor
.vpos
< 0)
14535 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14536 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14538 /* If the cursor row is not partially visible, there's nothing to do. */
14539 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14542 /* If the row the cursor is in is taller than the window's height,
14543 it's not clear what to do, so do nothing. */
14544 window_height
= window_box_height (w
);
14545 if (row
->height
>= window_height
)
14547 if (!force_p
|| MINI_WINDOW_P (w
)
14548 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14555 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14556 non-zero means only WINDOW is redisplayed in redisplay_internal.
14557 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14558 in redisplay_window to bring a partially visible line into view in
14559 the case that only the cursor has moved.
14561 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14562 last screen line's vertical height extends past the end of the screen.
14566 1 if scrolling succeeded
14568 0 if scrolling didn't find point.
14570 -1 if new fonts have been loaded so that we must interrupt
14571 redisplay, adjust glyph matrices, and try again. */
14577 SCROLLING_NEED_LARGER_MATRICES
14580 /* If scroll-conservatively is more than this, never recenter.
14582 If you change this, don't forget to update the doc string of
14583 `scroll-conservatively' and the Emacs manual. */
14584 #define SCROLL_LIMIT 100
14587 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14588 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14589 int temp_scroll_step
, int last_line_misfit
)
14591 struct window
*w
= XWINDOW (window
);
14592 struct frame
*f
= XFRAME (w
->frame
);
14593 struct text_pos pos
, startp
;
14595 int this_scroll_margin
, scroll_max
, rc
, height
;
14596 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14597 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14598 Lisp_Object aggressive
;
14599 /* We will never try scrolling more than this number of lines. */
14600 int scroll_limit
= SCROLL_LIMIT
;
14603 debug_method_add (w
, "try_scrolling");
14606 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14608 /* Compute scroll margin height in pixels. We scroll when point is
14609 within this distance from the top or bottom of the window. */
14610 if (scroll_margin
> 0)
14611 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14612 * FRAME_LINE_HEIGHT (f
);
14614 this_scroll_margin
= 0;
14616 /* Force arg_scroll_conservatively to have a reasonable value, to
14617 avoid scrolling too far away with slow move_it_* functions. Note
14618 that the user can supply scroll-conservatively equal to
14619 `most-positive-fixnum', which can be larger than INT_MAX. */
14620 if (arg_scroll_conservatively
> scroll_limit
)
14622 arg_scroll_conservatively
= scroll_limit
+ 1;
14623 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14625 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14626 /* Compute how much we should try to scroll maximally to bring
14627 point into view. */
14628 scroll_max
= (max (scroll_step
,
14629 max (arg_scroll_conservatively
, temp_scroll_step
))
14630 * FRAME_LINE_HEIGHT (f
));
14631 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14632 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14633 /* We're trying to scroll because of aggressive scrolling but no
14634 scroll_step is set. Choose an arbitrary one. */
14635 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14641 /* Decide whether to scroll down. */
14642 if (PT
> CHARPOS (startp
))
14644 int scroll_margin_y
;
14646 /* Compute the pixel ypos of the scroll margin, then move IT to
14647 either that ypos or PT, whichever comes first. */
14648 start_display (&it
, w
, startp
);
14649 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14650 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14651 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14652 (MOVE_TO_POS
| MOVE_TO_Y
));
14654 if (PT
> CHARPOS (it
.current
.pos
))
14656 int y0
= line_bottom_y (&it
);
14657 /* Compute how many pixels below window bottom to stop searching
14658 for PT. This avoids costly search for PT that is far away if
14659 the user limited scrolling by a small number of lines, but
14660 always finds PT if scroll_conservatively is set to a large
14661 number, such as most-positive-fixnum. */
14662 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14663 int y_to_move
= it
.last_visible_y
+ slack
;
14665 /* Compute the distance from the scroll margin to PT or to
14666 the scroll limit, whichever comes first. This should
14667 include the height of the cursor line, to make that line
14669 move_it_to (&it
, PT
, -1, y_to_move
,
14670 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14671 dy
= line_bottom_y (&it
) - y0
;
14673 if (dy
> scroll_max
)
14674 return SCROLLING_FAILED
;
14683 /* Point is in or below the bottom scroll margin, so move the
14684 window start down. If scrolling conservatively, move it just
14685 enough down to make point visible. If scroll_step is set,
14686 move it down by scroll_step. */
14687 if (arg_scroll_conservatively
)
14689 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14690 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14691 else if (scroll_step
|| temp_scroll_step
)
14692 amount_to_scroll
= scroll_max
;
14695 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14696 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14697 if (NUMBERP (aggressive
))
14699 double float_amount
= XFLOATINT (aggressive
) * height
;
14700 amount_to_scroll
= float_amount
;
14701 if (amount_to_scroll
== 0 && float_amount
> 0)
14702 amount_to_scroll
= 1;
14703 /* Don't let point enter the scroll margin near top of
14705 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14706 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14710 if (amount_to_scroll
<= 0)
14711 return SCROLLING_FAILED
;
14713 start_display (&it
, w
, startp
);
14714 if (arg_scroll_conservatively
<= scroll_limit
)
14715 move_it_vertically (&it
, amount_to_scroll
);
14718 /* Extra precision for users who set scroll-conservatively
14719 to a large number: make sure the amount we scroll
14720 the window start is never less than amount_to_scroll,
14721 which was computed as distance from window bottom to
14722 point. This matters when lines at window top and lines
14723 below window bottom have different height. */
14725 void *it1data
= NULL
;
14726 /* We use a temporary it1 because line_bottom_y can modify
14727 its argument, if it moves one line down; see there. */
14730 SAVE_IT (it1
, it
, it1data
);
14731 start_y
= line_bottom_y (&it1
);
14733 RESTORE_IT (&it
, &it
, it1data
);
14734 move_it_by_lines (&it
, 1);
14735 SAVE_IT (it1
, it
, it1data
);
14736 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14739 /* If STARTP is unchanged, move it down another screen line. */
14740 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14741 move_it_by_lines (&it
, 1);
14742 startp
= it
.current
.pos
;
14746 struct text_pos scroll_margin_pos
= startp
;
14748 /* See if point is inside the scroll margin at the top of the
14750 if (this_scroll_margin
)
14752 start_display (&it
, w
, startp
);
14753 move_it_vertically (&it
, this_scroll_margin
);
14754 scroll_margin_pos
= it
.current
.pos
;
14757 if (PT
< CHARPOS (scroll_margin_pos
))
14759 /* Point is in the scroll margin at the top of the window or
14760 above what is displayed in the window. */
14763 /* Compute the vertical distance from PT to the scroll
14764 margin position. Move as far as scroll_max allows, or
14765 one screenful, or 10 screen lines, whichever is largest.
14766 Give up if distance is greater than scroll_max. */
14767 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14768 start_display (&it
, w
, pos
);
14770 y_to_move
= max (it
.last_visible_y
,
14771 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14772 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14774 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14775 dy
= it
.current_y
- y0
;
14776 if (dy
> scroll_max
)
14777 return SCROLLING_FAILED
;
14779 /* Compute new window start. */
14780 start_display (&it
, w
, startp
);
14782 if (arg_scroll_conservatively
)
14783 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14784 max (scroll_step
, temp_scroll_step
));
14785 else if (scroll_step
|| temp_scroll_step
)
14786 amount_to_scroll
= scroll_max
;
14789 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14790 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14791 if (NUMBERP (aggressive
))
14793 double float_amount
= XFLOATINT (aggressive
) * height
;
14794 amount_to_scroll
= float_amount
;
14795 if (amount_to_scroll
== 0 && float_amount
> 0)
14796 amount_to_scroll
= 1;
14797 amount_to_scroll
-=
14798 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14799 /* Don't let point enter the scroll margin near
14800 bottom of the window. */
14801 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14802 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14806 if (amount_to_scroll
<= 0)
14807 return SCROLLING_FAILED
;
14809 move_it_vertically_backward (&it
, amount_to_scroll
);
14810 startp
= it
.current
.pos
;
14814 /* Run window scroll functions. */
14815 startp
= run_window_scroll_functions (window
, startp
);
14817 /* Display the window. Give up if new fonts are loaded, or if point
14819 if (!try_window (window
, startp
, 0))
14820 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14821 else if (w
->cursor
.vpos
< 0)
14823 clear_glyph_matrix (w
->desired_matrix
);
14824 rc
= SCROLLING_FAILED
;
14828 /* Maybe forget recorded base line for line number display. */
14829 if (!just_this_one_p
14830 || current_buffer
->clip_changed
14831 || BEG_UNCHANGED
< CHARPOS (startp
))
14832 w
->base_line_number
= Qnil
;
14834 /* If cursor ends up on a partially visible line,
14835 treat that as being off the bottom of the screen. */
14836 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14837 /* It's possible that the cursor is on the first line of the
14838 buffer, which is partially obscured due to a vscroll
14839 (Bug#7537). In that case, avoid looping forever . */
14840 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14842 clear_glyph_matrix (w
->desired_matrix
);
14843 ++extra_scroll_margin_lines
;
14846 rc
= SCROLLING_SUCCESS
;
14853 /* Compute a suitable window start for window W if display of W starts
14854 on a continuation line. Value is non-zero if a new window start
14857 The new window start will be computed, based on W's width, starting
14858 from the start of the continued line. It is the start of the
14859 screen line with the minimum distance from the old start W->start. */
14862 compute_window_start_on_continuation_line (struct window
*w
)
14864 struct text_pos pos
, start_pos
;
14865 int window_start_changed_p
= 0;
14867 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14869 /* If window start is on a continuation line... Window start may be
14870 < BEGV in case there's invisible text at the start of the
14871 buffer (M-x rmail, for example). */
14872 if (CHARPOS (start_pos
) > BEGV
14873 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14876 struct glyph_row
*row
;
14878 /* Handle the case that the window start is out of range. */
14879 if (CHARPOS (start_pos
) < BEGV
)
14880 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14881 else if (CHARPOS (start_pos
) > ZV
)
14882 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14884 /* Find the start of the continued line. This should be fast
14885 because scan_buffer is fast (newline cache). */
14886 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14887 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14888 row
, DEFAULT_FACE_ID
);
14889 reseat_at_previous_visible_line_start (&it
);
14891 /* If the line start is "too far" away from the window start,
14892 say it takes too much time to compute a new window start. */
14893 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14894 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14896 int min_distance
, distance
;
14898 /* Move forward by display lines to find the new window
14899 start. If window width was enlarged, the new start can
14900 be expected to be > the old start. If window width was
14901 decreased, the new window start will be < the old start.
14902 So, we're looking for the display line start with the
14903 minimum distance from the old window start. */
14904 pos
= it
.current
.pos
;
14905 min_distance
= INFINITY
;
14906 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14907 distance
< min_distance
)
14909 min_distance
= distance
;
14910 pos
= it
.current
.pos
;
14911 move_it_by_lines (&it
, 1);
14914 /* Set the window start there. */
14915 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14916 window_start_changed_p
= 1;
14920 return window_start_changed_p
;
14924 /* Try cursor movement in case text has not changed in window WINDOW,
14925 with window start STARTP. Value is
14927 CURSOR_MOVEMENT_SUCCESS if successful
14929 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14931 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14932 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14933 we want to scroll as if scroll-step were set to 1. See the code.
14935 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14936 which case we have to abort this redisplay, and adjust matrices
14941 CURSOR_MOVEMENT_SUCCESS
,
14942 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14943 CURSOR_MOVEMENT_MUST_SCROLL
,
14944 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14948 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14950 struct window
*w
= XWINDOW (window
);
14951 struct frame
*f
= XFRAME (w
->frame
);
14952 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14955 if (inhibit_try_cursor_movement
)
14959 /* Previously, there was a check for Lisp integer in the
14960 if-statement below. Now, this field is converted to
14961 ptrdiff_t, thus zero means invalid position in a buffer. */
14962 eassert (w
->last_point
> 0);
14964 /* Handle case where text has not changed, only point, and it has
14965 not moved off the frame. */
14966 if (/* Point may be in this window. */
14967 PT
>= CHARPOS (startp
)
14968 /* Selective display hasn't changed. */
14969 && !current_buffer
->clip_changed
14970 /* Function force-mode-line-update is used to force a thorough
14971 redisplay. It sets either windows_or_buffers_changed or
14972 update_mode_lines. So don't take a shortcut here for these
14974 && !update_mode_lines
14975 && !windows_or_buffers_changed
14976 && !cursor_type_changed
14977 /* Can't use this case if highlighting a region. When a
14978 region exists, cursor movement has to do more than just
14980 && !(!NILP (Vtransient_mark_mode
)
14981 && !NILP (BVAR (current_buffer
, mark_active
)))
14982 && NILP (w
->region_showing
)
14983 && NILP (Vshow_trailing_whitespace
)
14984 /* This code is not used for mini-buffer for the sake of the case
14985 of redisplaying to replace an echo area message; since in
14986 that case the mini-buffer contents per se are usually
14987 unchanged. This code is of no real use in the mini-buffer
14988 since the handling of this_line_start_pos, etc., in redisplay
14989 handles the same cases. */
14990 && !EQ (window
, minibuf_window
)
14991 /* When splitting windows or for new windows, it happens that
14992 redisplay is called with a nil window_end_vpos or one being
14993 larger than the window. This should really be fixed in
14994 window.c. I don't have this on my list, now, so we do
14995 approximately the same as the old redisplay code. --gerd. */
14996 && INTEGERP (w
->window_end_vpos
)
14997 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14998 && (FRAME_WINDOW_P (f
)
14999 || !overlay_arrow_in_current_buffer_p ()))
15001 int this_scroll_margin
, top_scroll_margin
;
15002 struct glyph_row
*row
= NULL
;
15005 debug_method_add (w
, "cursor movement");
15008 /* Scroll if point within this distance from the top or bottom
15009 of the window. This is a pixel value. */
15010 if (scroll_margin
> 0)
15012 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15013 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15016 this_scroll_margin
= 0;
15018 top_scroll_margin
= this_scroll_margin
;
15019 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15020 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15022 /* Start with the row the cursor was displayed during the last
15023 not paused redisplay. Give up if that row is not valid. */
15024 if (w
->last_cursor
.vpos
< 0
15025 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15026 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15029 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15030 if (row
->mode_line_p
)
15032 if (!row
->enabled_p
)
15033 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15036 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15038 int scroll_p
= 0, must_scroll
= 0;
15039 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15041 if (PT
> w
->last_point
)
15043 /* Point has moved forward. */
15044 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15045 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15047 eassert (row
->enabled_p
);
15051 /* If the end position of a row equals the start
15052 position of the next row, and PT is at that position,
15053 we would rather display cursor in the next line. */
15054 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15055 && MATRIX_ROW_END_CHARPOS (row
) == PT
15056 && row
< w
->current_matrix
->rows
15057 + w
->current_matrix
->nrows
- 1
15058 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15059 && !cursor_row_p (row
))
15062 /* If within the scroll margin, scroll. Note that
15063 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15064 the next line would be drawn, and that
15065 this_scroll_margin can be zero. */
15066 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15067 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15068 /* Line is completely visible last line in window
15069 and PT is to be set in the next line. */
15070 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15071 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15072 && !row
->ends_at_zv_p
15073 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15076 else if (PT
< w
->last_point
)
15078 /* Cursor has to be moved backward. Note that PT >=
15079 CHARPOS (startp) because of the outer if-statement. */
15080 while (!row
->mode_line_p
15081 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15082 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15083 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15084 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15085 row
> w
->current_matrix
->rows
15086 && (row
-1)->ends_in_newline_from_string_p
))))
15087 && (row
->y
> top_scroll_margin
15088 || CHARPOS (startp
) == BEGV
))
15090 eassert (row
->enabled_p
);
15094 /* Consider the following case: Window starts at BEGV,
15095 there is invisible, intangible text at BEGV, so that
15096 display starts at some point START > BEGV. It can
15097 happen that we are called with PT somewhere between
15098 BEGV and START. Try to handle that case. */
15099 if (row
< w
->current_matrix
->rows
15100 || row
->mode_line_p
)
15102 row
= w
->current_matrix
->rows
;
15103 if (row
->mode_line_p
)
15107 /* Due to newlines in overlay strings, we may have to
15108 skip forward over overlay strings. */
15109 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15110 && MATRIX_ROW_END_CHARPOS (row
) == PT
15111 && !cursor_row_p (row
))
15114 /* If within the scroll margin, scroll. */
15115 if (row
->y
< top_scroll_margin
15116 && CHARPOS (startp
) != BEGV
)
15121 /* Cursor did not move. So don't scroll even if cursor line
15122 is partially visible, as it was so before. */
15123 rc
= CURSOR_MOVEMENT_SUCCESS
;
15126 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15127 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15129 /* if PT is not in the glyph row, give up. */
15130 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15133 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15134 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15136 struct glyph_row
*row1
;
15138 /* If rows are bidi-reordered and point moved, back up
15139 until we find a row that does not belong to a
15140 continuation line. This is because we must consider
15141 all rows of a continued line as candidates for the
15142 new cursor positioning, since row start and end
15143 positions change non-linearly with vertical position
15145 /* FIXME: Revisit this when glyph ``spilling'' in
15146 continuation lines' rows is implemented for
15147 bidi-reordered rows. */
15148 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15149 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15152 /* If we hit the beginning of the displayed portion
15153 without finding the first row of a continued
15157 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15160 eassert (row
->enabled_p
);
15165 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15166 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15167 /* Make sure this isn't a header line by any chance, since
15168 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15169 && !row
->mode_line_p
15170 && make_cursor_line_fully_visible_p
)
15172 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15173 && !row
->ends_at_zv_p
15174 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15175 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15176 else if (row
->height
> window_box_height (w
))
15178 /* If we end up in a partially visible line, let's
15179 make it fully visible, except when it's taller
15180 than the window, in which case we can't do much
15183 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15187 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15188 if (!cursor_row_fully_visible_p (w
, 0, 1))
15189 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15191 rc
= CURSOR_MOVEMENT_SUCCESS
;
15195 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15196 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15197 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15199 /* With bidi-reordered rows, there could be more than
15200 one candidate row whose start and end positions
15201 occlude point. We need to let set_cursor_from_row
15202 find the best candidate. */
15203 /* FIXME: Revisit this when glyph ``spilling'' in
15204 continuation lines' rows is implemented for
15205 bidi-reordered rows. */
15210 int at_zv_p
= 0, exact_match_p
= 0;
15212 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15213 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15214 && cursor_row_p (row
))
15215 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15217 /* As soon as we've found the exact match for point,
15218 or the first suitable row whose ends_at_zv_p flag
15219 is set, we are done. */
15221 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15223 && w
->cursor
.hpos
>= 0
15224 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15227 struct glyph_row
*candidate
=
15228 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15230 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15231 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15234 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15235 || (INTEGERP (g
->object
)
15236 && (g
->charpos
== PT
15237 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15239 if (rv
&& (at_zv_p
|| exact_match_p
))
15241 rc
= CURSOR_MOVEMENT_SUCCESS
;
15244 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15248 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15249 || row
->continued_p
)
15250 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15251 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15252 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15253 /* If we didn't find any candidate rows, or exited the
15254 loop before all the candidates were examined, signal
15255 to the caller that this method failed. */
15256 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15258 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15259 && !row
->continued_p
))
15260 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15262 rc
= CURSOR_MOVEMENT_SUCCESS
;
15268 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15270 rc
= CURSOR_MOVEMENT_SUCCESS
;
15275 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15276 && MATRIX_ROW_START_CHARPOS (row
) == PT
15277 && cursor_row_p (row
));
15285 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15289 set_vertical_scroll_bar (struct window
*w
)
15291 ptrdiff_t start
, end
, whole
;
15293 /* Calculate the start and end positions for the current window.
15294 At some point, it would be nice to choose between scrollbars
15295 which reflect the whole buffer size, with special markers
15296 indicating narrowing, and scrollbars which reflect only the
15299 Note that mini-buffers sometimes aren't displaying any text. */
15300 if (!MINI_WINDOW_P (w
)
15301 || (w
== XWINDOW (minibuf_window
)
15302 && NILP (echo_area_buffer
[0])))
15304 struct buffer
*buf
= XBUFFER (w
->buffer
);
15305 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15306 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15307 /* I don't think this is guaranteed to be right. For the
15308 moment, we'll pretend it is. */
15309 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15313 if (whole
< (end
- start
))
15314 whole
= end
- start
;
15317 start
= end
= whole
= 0;
15319 /* Indicate what this scroll bar ought to be displaying now. */
15320 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15321 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15322 (w
, end
- start
, whole
, start
);
15326 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15327 selected_window is redisplayed.
15329 We can return without actually redisplaying the window if
15330 fonts_changed_p is nonzero. In that case, redisplay_internal will
15334 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15336 struct window
*w
= XWINDOW (window
);
15337 struct frame
*f
= XFRAME (w
->frame
);
15338 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15339 struct buffer
*old
= current_buffer
;
15340 struct text_pos lpoint
, opoint
, startp
;
15341 int update_mode_line
;
15344 /* Record it now because it's overwritten. */
15345 int current_matrix_up_to_date_p
= 0;
15346 int used_current_matrix_p
= 0;
15347 /* This is less strict than current_matrix_up_to_date_p.
15348 It indicates that the buffer contents and narrowing are unchanged. */
15349 int buffer_unchanged_p
= 0;
15350 int temp_scroll_step
= 0;
15351 ptrdiff_t count
= SPECPDL_INDEX ();
15353 int centering_position
= -1;
15354 int last_line_misfit
= 0;
15355 ptrdiff_t beg_unchanged
, end_unchanged
;
15357 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15360 /* W must be a leaf window here. */
15361 eassert (!NILP (w
->buffer
));
15363 *w
->desired_matrix
->method
= 0;
15367 reconsider_clip_changes (w
, buffer
);
15369 /* Has the mode line to be updated? */
15370 update_mode_line
= (w
->update_mode_line
15371 || update_mode_lines
15372 || buffer
->clip_changed
15373 || buffer
->prevent_redisplay_optimizations_p
);
15375 if (MINI_WINDOW_P (w
))
15377 if (w
== XWINDOW (echo_area_window
)
15378 && !NILP (echo_area_buffer
[0]))
15380 if (update_mode_line
)
15381 /* We may have to update a tty frame's menu bar or a
15382 tool-bar. Example `M-x C-h C-h C-g'. */
15383 goto finish_menu_bars
;
15385 /* We've already displayed the echo area glyphs in this window. */
15386 goto finish_scroll_bars
;
15388 else if ((w
!= XWINDOW (minibuf_window
)
15389 || minibuf_level
== 0)
15390 /* When buffer is nonempty, redisplay window normally. */
15391 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15392 /* Quail displays non-mini buffers in minibuffer window.
15393 In that case, redisplay the window normally. */
15394 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15396 /* W is a mini-buffer window, but it's not active, so clear
15398 int yb
= window_text_bottom_y (w
);
15399 struct glyph_row
*row
;
15402 for (y
= 0, row
= w
->desired_matrix
->rows
;
15404 y
+= row
->height
, ++row
)
15405 blank_row (w
, row
, y
);
15406 goto finish_scroll_bars
;
15409 clear_glyph_matrix (w
->desired_matrix
);
15412 /* Otherwise set up data on this window; select its buffer and point
15414 /* Really select the buffer, for the sake of buffer-local
15416 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15418 current_matrix_up_to_date_p
15419 = (!NILP (w
->window_end_valid
)
15420 && !current_buffer
->clip_changed
15421 && !current_buffer
->prevent_redisplay_optimizations_p
15422 && w
->last_modified
>= MODIFF
15423 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15425 /* Run the window-bottom-change-functions
15426 if it is possible that the text on the screen has changed
15427 (either due to modification of the text, or any other reason). */
15428 if (!current_matrix_up_to_date_p
15429 && !NILP (Vwindow_text_change_functions
))
15431 safe_run_hooks (Qwindow_text_change_functions
);
15435 beg_unchanged
= BEG_UNCHANGED
;
15436 end_unchanged
= END_UNCHANGED
;
15438 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15440 specbind (Qinhibit_point_motion_hooks
, Qt
);
15443 = (!NILP (w
->window_end_valid
)
15444 && !current_buffer
->clip_changed
15445 && w
->last_modified
>= MODIFF
15446 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15448 /* When windows_or_buffers_changed is non-zero, we can't rely on
15449 the window end being valid, so set it to nil there. */
15450 if (windows_or_buffers_changed
)
15452 /* If window starts on a continuation line, maybe adjust the
15453 window start in case the window's width changed. */
15454 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15455 compute_window_start_on_continuation_line (w
);
15457 w
->window_end_valid
= Qnil
;
15460 /* Some sanity checks. */
15461 CHECK_WINDOW_END (w
);
15462 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15464 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15467 /* If %c is in mode line, update it if needed. */
15468 if (!NILP (w
->column_number_displayed
)
15469 /* This alternative quickly identifies a common case
15470 where no change is needed. */
15471 && !(PT
== w
->last_point
15472 && w
->last_modified
>= MODIFF
15473 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15474 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15475 update_mode_line
= 1;
15477 /* Count number of windows showing the selected buffer. An indirect
15478 buffer counts as its base buffer. */
15479 if (!just_this_one_p
)
15481 struct buffer
*current_base
, *window_base
;
15482 current_base
= current_buffer
;
15483 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15484 if (current_base
->base_buffer
)
15485 current_base
= current_base
->base_buffer
;
15486 if (window_base
->base_buffer
)
15487 window_base
= window_base
->base_buffer
;
15488 if (current_base
== window_base
)
15492 /* Point refers normally to the selected window. For any other
15493 window, set up appropriate value. */
15494 if (!EQ (window
, selected_window
))
15496 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15497 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15501 new_pt_byte
= BEGV_BYTE
;
15502 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15504 else if (new_pt
> (ZV
- 1))
15507 new_pt_byte
= ZV_BYTE
;
15508 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15511 /* We don't use SET_PT so that the point-motion hooks don't run. */
15512 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15515 /* If any of the character widths specified in the display table
15516 have changed, invalidate the width run cache. It's true that
15517 this may be a bit late to catch such changes, but the rest of
15518 redisplay goes (non-fatally) haywire when the display table is
15519 changed, so why should we worry about doing any better? */
15520 if (current_buffer
->width_run_cache
)
15522 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15524 if (! disptab_matches_widthtab (disptab
,
15525 XVECTOR (BVAR (current_buffer
, width_table
))))
15527 invalidate_region_cache (current_buffer
,
15528 current_buffer
->width_run_cache
,
15530 recompute_width_table (current_buffer
, disptab
);
15534 /* If window-start is screwed up, choose a new one. */
15535 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15538 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15540 /* If someone specified a new starting point but did not insist,
15541 check whether it can be used. */
15542 if (w
->optional_new_start
15543 && CHARPOS (startp
) >= BEGV
15544 && CHARPOS (startp
) <= ZV
)
15546 w
->optional_new_start
= 0;
15547 start_display (&it
, w
, startp
);
15548 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15549 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15550 if (IT_CHARPOS (it
) == PT
)
15551 w
->force_start
= 1;
15552 /* IT may overshoot PT if text at PT is invisible. */
15553 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15554 w
->force_start
= 1;
15559 /* Handle case where place to start displaying has been specified,
15560 unless the specified location is outside the accessible range. */
15561 if (w
->force_start
|| w
->frozen_window_start_p
)
15563 /* We set this later on if we have to adjust point. */
15566 w
->force_start
= 0;
15568 w
->window_end_valid
= Qnil
;
15570 /* Forget any recorded base line for line number display. */
15571 if (!buffer_unchanged_p
)
15572 w
->base_line_number
= Qnil
;
15574 /* Redisplay the mode line. Select the buffer properly for that.
15575 Also, run the hook window-scroll-functions
15576 because we have scrolled. */
15577 /* Note, we do this after clearing force_start because
15578 if there's an error, it is better to forget about force_start
15579 than to get into an infinite loop calling the hook functions
15580 and having them get more errors. */
15581 if (!update_mode_line
15582 || ! NILP (Vwindow_scroll_functions
))
15584 update_mode_line
= 1;
15585 w
->update_mode_line
= 1;
15586 startp
= run_window_scroll_functions (window
, startp
);
15589 w
->last_modified
= 0;
15590 w
->last_overlay_modified
= 0;
15591 if (CHARPOS (startp
) < BEGV
)
15592 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15593 else if (CHARPOS (startp
) > ZV
)
15594 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15596 /* Redisplay, then check if cursor has been set during the
15597 redisplay. Give up if new fonts were loaded. */
15598 /* We used to issue a CHECK_MARGINS argument to try_window here,
15599 but this causes scrolling to fail when point begins inside
15600 the scroll margin (bug#148) -- cyd */
15601 if (!try_window (window
, startp
, 0))
15603 w
->force_start
= 1;
15604 clear_glyph_matrix (w
->desired_matrix
);
15605 goto need_larger_matrices
;
15608 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15610 /* If point does not appear, try to move point so it does
15611 appear. The desired matrix has been built above, so we
15612 can use it here. */
15613 new_vpos
= window_box_height (w
) / 2;
15616 if (!cursor_row_fully_visible_p (w
, 0, 0))
15618 /* Point does appear, but on a line partly visible at end of window.
15619 Move it back to a fully-visible line. */
15620 new_vpos
= window_box_height (w
);
15623 /* If we need to move point for either of the above reasons,
15624 now actually do it. */
15627 struct glyph_row
*row
;
15629 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15630 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15633 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15634 MATRIX_ROW_START_BYTEPOS (row
));
15636 if (w
!= XWINDOW (selected_window
))
15637 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15638 else if (current_buffer
== old
)
15639 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15641 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15643 /* If we are highlighting the region, then we just changed
15644 the region, so redisplay to show it. */
15645 if (!NILP (Vtransient_mark_mode
)
15646 && !NILP (BVAR (current_buffer
, mark_active
)))
15648 clear_glyph_matrix (w
->desired_matrix
);
15649 if (!try_window (window
, startp
, 0))
15650 goto need_larger_matrices
;
15655 debug_method_add (w
, "forced window start");
15660 /* Handle case where text has not changed, only point, and it has
15661 not moved off the frame, and we are not retrying after hscroll.
15662 (current_matrix_up_to_date_p is nonzero when retrying.) */
15663 if (current_matrix_up_to_date_p
15664 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15665 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15669 case CURSOR_MOVEMENT_SUCCESS
:
15670 used_current_matrix_p
= 1;
15673 case CURSOR_MOVEMENT_MUST_SCROLL
:
15674 goto try_to_scroll
;
15680 /* If current starting point was originally the beginning of a line
15681 but no longer is, find a new starting point. */
15682 else if (w
->start_at_line_beg
15683 && !(CHARPOS (startp
) <= BEGV
15684 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15687 debug_method_add (w
, "recenter 1");
15692 /* Try scrolling with try_window_id. Value is > 0 if update has
15693 been done, it is -1 if we know that the same window start will
15694 not work. It is 0 if unsuccessful for some other reason. */
15695 else if ((tem
= try_window_id (w
)) != 0)
15698 debug_method_add (w
, "try_window_id %d", tem
);
15701 if (fonts_changed_p
)
15702 goto need_larger_matrices
;
15706 /* Otherwise try_window_id has returned -1 which means that we
15707 don't want the alternative below this comment to execute. */
15709 else if (CHARPOS (startp
) >= BEGV
15710 && CHARPOS (startp
) <= ZV
15711 && PT
>= CHARPOS (startp
)
15712 && (CHARPOS (startp
) < ZV
15713 /* Avoid starting at end of buffer. */
15714 || CHARPOS (startp
) == BEGV
15715 || (w
->last_modified
>= MODIFF
15716 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15718 int d1
, d2
, d3
, d4
, d5
, d6
;
15720 /* If first window line is a continuation line, and window start
15721 is inside the modified region, but the first change is before
15722 current window start, we must select a new window start.
15724 However, if this is the result of a down-mouse event (e.g. by
15725 extending the mouse-drag-overlay), we don't want to select a
15726 new window start, since that would change the position under
15727 the mouse, resulting in an unwanted mouse-movement rather
15728 than a simple mouse-click. */
15729 if (!w
->start_at_line_beg
15730 && NILP (do_mouse_tracking
)
15731 && CHARPOS (startp
) > BEGV
15732 && CHARPOS (startp
) > BEG
+ beg_unchanged
15733 && CHARPOS (startp
) <= Z
- end_unchanged
15734 /* Even if w->start_at_line_beg is nil, a new window may
15735 start at a line_beg, since that's how set_buffer_window
15736 sets it. So, we need to check the return value of
15737 compute_window_start_on_continuation_line. (See also
15739 && XMARKER (w
->start
)->buffer
== current_buffer
15740 && compute_window_start_on_continuation_line (w
)
15741 /* It doesn't make sense to force the window start like we
15742 do at label force_start if it is already known that point
15743 will not be visible in the resulting window, because
15744 doing so will move point from its correct position
15745 instead of scrolling the window to bring point into view.
15747 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15749 w
->force_start
= 1;
15750 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15755 debug_method_add (w
, "same window start");
15758 /* Try to redisplay starting at same place as before.
15759 If point has not moved off frame, accept the results. */
15760 if (!current_matrix_up_to_date_p
15761 /* Don't use try_window_reusing_current_matrix in this case
15762 because a window scroll function can have changed the
15764 || !NILP (Vwindow_scroll_functions
)
15765 || MINI_WINDOW_P (w
)
15766 || !(used_current_matrix_p
15767 = try_window_reusing_current_matrix (w
)))
15769 IF_DEBUG (debug_method_add (w
, "1"));
15770 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15771 /* -1 means we need to scroll.
15772 0 means we need new matrices, but fonts_changed_p
15773 is set in that case, so we will detect it below. */
15774 goto try_to_scroll
;
15777 if (fonts_changed_p
)
15778 goto need_larger_matrices
;
15780 if (w
->cursor
.vpos
>= 0)
15782 if (!just_this_one_p
15783 || current_buffer
->clip_changed
15784 || BEG_UNCHANGED
< CHARPOS (startp
))
15785 /* Forget any recorded base line for line number display. */
15786 w
->base_line_number
= Qnil
;
15788 if (!cursor_row_fully_visible_p (w
, 1, 0))
15790 clear_glyph_matrix (w
->desired_matrix
);
15791 last_line_misfit
= 1;
15793 /* Drop through and scroll. */
15798 clear_glyph_matrix (w
->desired_matrix
);
15803 w
->last_modified
= 0;
15804 w
->last_overlay_modified
= 0;
15806 /* Redisplay the mode line. Select the buffer properly for that. */
15807 if (!update_mode_line
)
15809 update_mode_line
= 1;
15810 w
->update_mode_line
= 1;
15813 /* Try to scroll by specified few lines. */
15814 if ((scroll_conservatively
15815 || emacs_scroll_step
15816 || temp_scroll_step
15817 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15818 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15819 && CHARPOS (startp
) >= BEGV
15820 && CHARPOS (startp
) <= ZV
)
15822 /* The function returns -1 if new fonts were loaded, 1 if
15823 successful, 0 if not successful. */
15824 int ss
= try_scrolling (window
, just_this_one_p
,
15825 scroll_conservatively
,
15827 temp_scroll_step
, last_line_misfit
);
15830 case SCROLLING_SUCCESS
:
15833 case SCROLLING_NEED_LARGER_MATRICES
:
15834 goto need_larger_matrices
;
15836 case SCROLLING_FAILED
:
15844 /* Finally, just choose a place to start which positions point
15845 according to user preferences. */
15850 debug_method_add (w
, "recenter");
15853 /* w->vscroll = 0; */
15855 /* Forget any previously recorded base line for line number display. */
15856 if (!buffer_unchanged_p
)
15857 w
->base_line_number
= Qnil
;
15859 /* Determine the window start relative to point. */
15860 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15861 it
.current_y
= it
.last_visible_y
;
15862 if (centering_position
< 0)
15866 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15868 ptrdiff_t margin_pos
= CHARPOS (startp
);
15869 Lisp_Object aggressive
;
15872 /* If there is a scroll margin at the top of the window, find
15873 its character position. */
15875 /* Cannot call start_display if startp is not in the
15876 accessible region of the buffer. This can happen when we
15877 have just switched to a different buffer and/or changed
15878 its restriction. In that case, startp is initialized to
15879 the character position 1 (BEGV) because we did not yet
15880 have chance to display the buffer even once. */
15881 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15884 void *it1data
= NULL
;
15886 SAVE_IT (it1
, it
, it1data
);
15887 start_display (&it1
, w
, startp
);
15888 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15889 margin_pos
= IT_CHARPOS (it1
);
15890 RESTORE_IT (&it
, &it
, it1data
);
15892 scrolling_up
= PT
> margin_pos
;
15895 ? BVAR (current_buffer
, scroll_up_aggressively
)
15896 : BVAR (current_buffer
, scroll_down_aggressively
);
15898 if (!MINI_WINDOW_P (w
)
15899 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15903 /* Setting scroll-conservatively overrides
15904 scroll-*-aggressively. */
15905 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15907 double float_amount
= XFLOATINT (aggressive
);
15909 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15910 if (pt_offset
== 0 && float_amount
> 0)
15912 if (pt_offset
&& margin
> 0)
15915 /* Compute how much to move the window start backward from
15916 point so that point will be displayed where the user
15920 centering_position
= it
.last_visible_y
;
15922 centering_position
-= pt_offset
;
15923 centering_position
-=
15924 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15925 + WINDOW_HEADER_LINE_HEIGHT (w
);
15926 /* Don't let point enter the scroll margin near top of
15928 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15929 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15932 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15935 /* Set the window start half the height of the window backward
15937 centering_position
= window_box_height (w
) / 2;
15939 move_it_vertically_backward (&it
, centering_position
);
15941 eassert (IT_CHARPOS (it
) >= BEGV
);
15943 /* The function move_it_vertically_backward may move over more
15944 than the specified y-distance. If it->w is small, e.g. a
15945 mini-buffer window, we may end up in front of the window's
15946 display area. Start displaying at the start of the line
15947 containing PT in this case. */
15948 if (it
.current_y
<= 0)
15950 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15951 move_it_vertically_backward (&it
, 0);
15955 it
.current_x
= it
.hpos
= 0;
15957 /* Set the window start position here explicitly, to avoid an
15958 infinite loop in case the functions in window-scroll-functions
15960 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15962 /* Run scroll hooks. */
15963 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15965 /* Redisplay the window. */
15966 if (!current_matrix_up_to_date_p
15967 || windows_or_buffers_changed
15968 || cursor_type_changed
15969 /* Don't use try_window_reusing_current_matrix in this case
15970 because it can have changed the buffer. */
15971 || !NILP (Vwindow_scroll_functions
)
15972 || !just_this_one_p
15973 || MINI_WINDOW_P (w
)
15974 || !(used_current_matrix_p
15975 = try_window_reusing_current_matrix (w
)))
15976 try_window (window
, startp
, 0);
15978 /* If new fonts have been loaded (due to fontsets), give up. We
15979 have to start a new redisplay since we need to re-adjust glyph
15981 if (fonts_changed_p
)
15982 goto need_larger_matrices
;
15984 /* If cursor did not appear assume that the middle of the window is
15985 in the first line of the window. Do it again with the next line.
15986 (Imagine a window of height 100, displaying two lines of height
15987 60. Moving back 50 from it->last_visible_y will end in the first
15989 if (w
->cursor
.vpos
< 0)
15991 if (!NILP (w
->window_end_valid
)
15992 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15994 clear_glyph_matrix (w
->desired_matrix
);
15995 move_it_by_lines (&it
, 1);
15996 try_window (window
, it
.current
.pos
, 0);
15998 else if (PT
< IT_CHARPOS (it
))
16000 clear_glyph_matrix (w
->desired_matrix
);
16001 move_it_by_lines (&it
, -1);
16002 try_window (window
, it
.current
.pos
, 0);
16006 /* Not much we can do about it. */
16010 /* Consider the following case: Window starts at BEGV, there is
16011 invisible, intangible text at BEGV, so that display starts at
16012 some point START > BEGV. It can happen that we are called with
16013 PT somewhere between BEGV and START. Try to handle that case. */
16014 if (w
->cursor
.vpos
< 0)
16016 struct glyph_row
*row
= w
->current_matrix
->rows
;
16017 if (row
->mode_line_p
)
16019 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16022 if (!cursor_row_fully_visible_p (w
, 0, 0))
16024 /* If vscroll is enabled, disable it and try again. */
16028 clear_glyph_matrix (w
->desired_matrix
);
16032 /* Users who set scroll-conservatively to a large number want
16033 point just above/below the scroll margin. If we ended up
16034 with point's row partially visible, move the window start to
16035 make that row fully visible and out of the margin. */
16036 if (scroll_conservatively
> SCROLL_LIMIT
)
16040 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16042 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16044 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16045 clear_glyph_matrix (w
->desired_matrix
);
16046 if (1 == try_window (window
, it
.current
.pos
,
16047 TRY_WINDOW_CHECK_MARGINS
))
16051 /* If centering point failed to make the whole line visible,
16052 put point at the top instead. That has to make the whole line
16053 visible, if it can be done. */
16054 if (centering_position
== 0)
16057 clear_glyph_matrix (w
->desired_matrix
);
16058 centering_position
= 0;
16064 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16065 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16066 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16068 /* Display the mode line, if we must. */
16069 if ((update_mode_line
16070 /* If window not full width, must redo its mode line
16071 if (a) the window to its side is being redone and
16072 (b) we do a frame-based redisplay. This is a consequence
16073 of how inverted lines are drawn in frame-based redisplay. */
16074 || (!just_this_one_p
16075 && !FRAME_WINDOW_P (f
)
16076 && !WINDOW_FULL_WIDTH_P (w
))
16077 /* Line number to display. */
16078 || INTEGERP (w
->base_line_pos
)
16079 /* Column number is displayed and different from the one displayed. */
16080 || (!NILP (w
->column_number_displayed
)
16081 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16082 /* This means that the window has a mode line. */
16083 && (WINDOW_WANTS_MODELINE_P (w
)
16084 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16086 display_mode_lines (w
);
16088 /* If mode line height has changed, arrange for a thorough
16089 immediate redisplay using the correct mode line height. */
16090 if (WINDOW_WANTS_MODELINE_P (w
)
16091 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16093 fonts_changed_p
= 1;
16094 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16095 = DESIRED_MODE_LINE_HEIGHT (w
);
16098 /* If header line height has changed, arrange for a thorough
16099 immediate redisplay using the correct header line height. */
16100 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16101 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16103 fonts_changed_p
= 1;
16104 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16105 = DESIRED_HEADER_LINE_HEIGHT (w
);
16108 if (fonts_changed_p
)
16109 goto need_larger_matrices
;
16112 if (!line_number_displayed
16113 && !BUFFERP (w
->base_line_pos
))
16115 w
->base_line_pos
= Qnil
;
16116 w
->base_line_number
= Qnil
;
16121 /* When we reach a frame's selected window, redo the frame's menu bar. */
16122 if (update_mode_line
16123 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16125 int redisplay_menu_p
= 0;
16127 if (FRAME_WINDOW_P (f
))
16129 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16130 || defined (HAVE_NS) || defined (USE_GTK)
16131 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16133 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16137 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16139 if (redisplay_menu_p
)
16140 display_menu_bar (w
);
16142 #ifdef HAVE_WINDOW_SYSTEM
16143 if (FRAME_WINDOW_P (f
))
16145 #if defined (USE_GTK) || defined (HAVE_NS)
16146 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16147 redisplay_tool_bar (f
);
16149 if (WINDOWP (f
->tool_bar_window
)
16150 && (FRAME_TOOL_BAR_LINES (f
) > 0
16151 || !NILP (Vauto_resize_tool_bars
))
16152 && redisplay_tool_bar (f
))
16153 ignore_mouse_drag_p
= 1;
16159 #ifdef HAVE_WINDOW_SYSTEM
16160 if (FRAME_WINDOW_P (f
)
16161 && update_window_fringes (w
, (just_this_one_p
16162 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16163 || w
->pseudo_window_p
)))
16167 if (draw_window_fringes (w
, 1))
16168 x_draw_vertical_border (w
);
16172 #endif /* HAVE_WINDOW_SYSTEM */
16174 /* We go to this label, with fonts_changed_p nonzero,
16175 if it is necessary to try again using larger glyph matrices.
16176 We have to redeem the scroll bar even in this case,
16177 because the loop in redisplay_internal expects that. */
16178 need_larger_matrices
:
16180 finish_scroll_bars
:
16182 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16184 /* Set the thumb's position and size. */
16185 set_vertical_scroll_bar (w
);
16187 /* Note that we actually used the scroll bar attached to this
16188 window, so it shouldn't be deleted at the end of redisplay. */
16189 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16190 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16193 /* Restore current_buffer and value of point in it. The window
16194 update may have changed the buffer, so first make sure `opoint'
16195 is still valid (Bug#6177). */
16196 if (CHARPOS (opoint
) < BEGV
)
16197 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16198 else if (CHARPOS (opoint
) > ZV
)
16199 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16201 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16203 set_buffer_internal_1 (old
);
16204 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16205 shorter. This can be caused by log truncation in *Messages*. */
16206 if (CHARPOS (lpoint
) <= ZV
)
16207 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16209 unbind_to (count
, Qnil
);
16213 /* Build the complete desired matrix of WINDOW with a window start
16214 buffer position POS.
16216 Value is 1 if successful. It is zero if fonts were loaded during
16217 redisplay which makes re-adjusting glyph matrices necessary, and -1
16218 if point would appear in the scroll margins.
16219 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16220 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16224 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16226 struct window
*w
= XWINDOW (window
);
16228 struct glyph_row
*last_text_row
= NULL
;
16229 struct frame
*f
= XFRAME (w
->frame
);
16231 /* Make POS the new window start. */
16232 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16234 /* Mark cursor position as unknown. No overlay arrow seen. */
16235 w
->cursor
.vpos
= -1;
16236 overlay_arrow_seen
= 0;
16238 /* Initialize iterator and info to start at POS. */
16239 start_display (&it
, w
, pos
);
16241 /* Display all lines of W. */
16242 while (it
.current_y
< it
.last_visible_y
)
16244 if (display_line (&it
))
16245 last_text_row
= it
.glyph_row
- 1;
16246 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16250 /* Don't let the cursor end in the scroll margins. */
16251 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16252 && !MINI_WINDOW_P (w
))
16254 int this_scroll_margin
;
16256 if (scroll_margin
> 0)
16258 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16259 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16262 this_scroll_margin
= 0;
16264 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16265 && w
->cursor
.y
< this_scroll_margin
16266 && CHARPOS (pos
) > BEGV
16267 && IT_CHARPOS (it
) < ZV
)
16268 /* rms: considering make_cursor_line_fully_visible_p here
16269 seems to give wrong results. We don't want to recenter
16270 when the last line is partly visible, we want to allow
16271 that case to be handled in the usual way. */
16272 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16274 w
->cursor
.vpos
= -1;
16275 clear_glyph_matrix (w
->desired_matrix
);
16280 /* If bottom moved off end of frame, change mode line percentage. */
16281 if (XFASTINT (w
->window_end_pos
) <= 0
16282 && Z
!= IT_CHARPOS (it
))
16283 w
->update_mode_line
= 1;
16285 /* Set window_end_pos to the offset of the last character displayed
16286 on the window from the end of current_buffer. Set
16287 window_end_vpos to its row number. */
16290 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16291 w
->window_end_bytepos
16292 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16294 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16296 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16297 eassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16298 ->displays_text_p
);
16302 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16303 w
->window_end_pos
= make_number (Z
- ZV
);
16304 w
->window_end_vpos
= make_number (0);
16307 /* But that is not valid info until redisplay finishes. */
16308 w
->window_end_valid
= Qnil
;
16314 /************************************************************************
16315 Window redisplay reusing current matrix when buffer has not changed
16316 ************************************************************************/
16318 /* Try redisplay of window W showing an unchanged buffer with a
16319 different window start than the last time it was displayed by
16320 reusing its current matrix. Value is non-zero if successful.
16321 W->start is the new window start. */
16324 try_window_reusing_current_matrix (struct window
*w
)
16326 struct frame
*f
= XFRAME (w
->frame
);
16327 struct glyph_row
*bottom_row
;
16330 struct text_pos start
, new_start
;
16331 int nrows_scrolled
, i
;
16332 struct glyph_row
*last_text_row
;
16333 struct glyph_row
*last_reused_text_row
;
16334 struct glyph_row
*start_row
;
16335 int start_vpos
, min_y
, max_y
;
16338 if (inhibit_try_window_reusing
)
16342 if (/* This function doesn't handle terminal frames. */
16343 !FRAME_WINDOW_P (f
)
16344 /* Don't try to reuse the display if windows have been split
16346 || windows_or_buffers_changed
16347 || cursor_type_changed
)
16350 /* Can't do this if region may have changed. */
16351 if ((!NILP (Vtransient_mark_mode
)
16352 && !NILP (BVAR (current_buffer
, mark_active
)))
16353 || !NILP (w
->region_showing
)
16354 || !NILP (Vshow_trailing_whitespace
))
16357 /* If top-line visibility has changed, give up. */
16358 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16359 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16362 /* Give up if old or new display is scrolled vertically. We could
16363 make this function handle this, but right now it doesn't. */
16364 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16365 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16368 /* The variable new_start now holds the new window start. The old
16369 start `start' can be determined from the current matrix. */
16370 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16371 start
= start_row
->minpos
;
16372 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16374 /* Clear the desired matrix for the display below. */
16375 clear_glyph_matrix (w
->desired_matrix
);
16377 if (CHARPOS (new_start
) <= CHARPOS (start
))
16379 /* Don't use this method if the display starts with an ellipsis
16380 displayed for invisible text. It's not easy to handle that case
16381 below, and it's certainly not worth the effort since this is
16382 not a frequent case. */
16383 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16386 IF_DEBUG (debug_method_add (w
, "twu1"));
16388 /* Display up to a row that can be reused. The variable
16389 last_text_row is set to the last row displayed that displays
16390 text. Note that it.vpos == 0 if or if not there is a
16391 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16392 start_display (&it
, w
, new_start
);
16393 w
->cursor
.vpos
= -1;
16394 last_text_row
= last_reused_text_row
= NULL
;
16396 while (it
.current_y
< it
.last_visible_y
16397 && !fonts_changed_p
)
16399 /* If we have reached into the characters in the START row,
16400 that means the line boundaries have changed. So we
16401 can't start copying with the row START. Maybe it will
16402 work to start copying with the following row. */
16403 while (IT_CHARPOS (it
) > CHARPOS (start
))
16405 /* Advance to the next row as the "start". */
16407 start
= start_row
->minpos
;
16408 /* If there are no more rows to try, or just one, give up. */
16409 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16410 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16411 || CHARPOS (start
) == ZV
)
16413 clear_glyph_matrix (w
->desired_matrix
);
16417 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16419 /* If we have reached alignment, we can copy the rest of the
16421 if (IT_CHARPOS (it
) == CHARPOS (start
)
16422 /* Don't accept "alignment" inside a display vector,
16423 since start_row could have started in the middle of
16424 that same display vector (thus their character
16425 positions match), and we have no way of telling if
16426 that is the case. */
16427 && it
.current
.dpvec_index
< 0)
16430 if (display_line (&it
))
16431 last_text_row
= it
.glyph_row
- 1;
16435 /* A value of current_y < last_visible_y means that we stopped
16436 at the previous window start, which in turn means that we
16437 have at least one reusable row. */
16438 if (it
.current_y
< it
.last_visible_y
)
16440 struct glyph_row
*row
;
16442 /* IT.vpos always starts from 0; it counts text lines. */
16443 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16445 /* Find PT if not already found in the lines displayed. */
16446 if (w
->cursor
.vpos
< 0)
16448 int dy
= it
.current_y
- start_row
->y
;
16450 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16451 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16453 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16454 dy
, nrows_scrolled
);
16457 clear_glyph_matrix (w
->desired_matrix
);
16462 /* Scroll the display. Do it before the current matrix is
16463 changed. The problem here is that update has not yet
16464 run, i.e. part of the current matrix is not up to date.
16465 scroll_run_hook will clear the cursor, and use the
16466 current matrix to get the height of the row the cursor is
16468 run
.current_y
= start_row
->y
;
16469 run
.desired_y
= it
.current_y
;
16470 run
.height
= it
.last_visible_y
- it
.current_y
;
16472 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16475 FRAME_RIF (f
)->update_window_begin_hook (w
);
16476 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16477 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16478 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16482 /* Shift current matrix down by nrows_scrolled lines. */
16483 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16484 rotate_matrix (w
->current_matrix
,
16486 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16489 /* Disable lines that must be updated. */
16490 for (i
= 0; i
< nrows_scrolled
; ++i
)
16491 (start_row
+ i
)->enabled_p
= 0;
16493 /* Re-compute Y positions. */
16494 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16495 max_y
= it
.last_visible_y
;
16496 for (row
= start_row
+ nrows_scrolled
;
16500 row
->y
= it
.current_y
;
16501 row
->visible_height
= row
->height
;
16503 if (row
->y
< min_y
)
16504 row
->visible_height
-= min_y
- row
->y
;
16505 if (row
->y
+ row
->height
> max_y
)
16506 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16507 if (row
->fringe_bitmap_periodic_p
)
16508 row
->redraw_fringe_bitmaps_p
= 1;
16510 it
.current_y
+= row
->height
;
16512 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16513 last_reused_text_row
= row
;
16514 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16518 /* Disable lines in the current matrix which are now
16519 below the window. */
16520 for (++row
; row
< bottom_row
; ++row
)
16521 row
->enabled_p
= row
->mode_line_p
= 0;
16524 /* Update window_end_pos etc.; last_reused_text_row is the last
16525 reused row from the current matrix containing text, if any.
16526 The value of last_text_row is the last displayed line
16527 containing text. */
16528 if (last_reused_text_row
)
16530 w
->window_end_bytepos
16531 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16533 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16535 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16536 w
->current_matrix
));
16538 else if (last_text_row
)
16540 w
->window_end_bytepos
16541 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16543 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16545 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16549 /* This window must be completely empty. */
16550 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16551 w
->window_end_pos
= make_number (Z
- ZV
);
16552 w
->window_end_vpos
= make_number (0);
16554 w
->window_end_valid
= Qnil
;
16556 /* Update hint: don't try scrolling again in update_window. */
16557 w
->desired_matrix
->no_scrolling_p
= 1;
16560 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16564 else if (CHARPOS (new_start
) > CHARPOS (start
))
16566 struct glyph_row
*pt_row
, *row
;
16567 struct glyph_row
*first_reusable_row
;
16568 struct glyph_row
*first_row_to_display
;
16570 int yb
= window_text_bottom_y (w
);
16572 /* Find the row starting at new_start, if there is one. Don't
16573 reuse a partially visible line at the end. */
16574 first_reusable_row
= start_row
;
16575 while (first_reusable_row
->enabled_p
16576 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16577 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16578 < CHARPOS (new_start
)))
16579 ++first_reusable_row
;
16581 /* Give up if there is no row to reuse. */
16582 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16583 || !first_reusable_row
->enabled_p
16584 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16585 != CHARPOS (new_start
)))
16588 /* We can reuse fully visible rows beginning with
16589 first_reusable_row to the end of the window. Set
16590 first_row_to_display to the first row that cannot be reused.
16591 Set pt_row to the row containing point, if there is any. */
16593 for (first_row_to_display
= first_reusable_row
;
16594 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16595 ++first_row_to_display
)
16597 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16598 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16599 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16600 && first_row_to_display
->ends_at_zv_p
16601 && pt_row
== NULL
)))
16602 pt_row
= first_row_to_display
;
16605 /* Start displaying at the start of first_row_to_display. */
16606 eassert (first_row_to_display
->y
< yb
);
16607 init_to_row_start (&it
, w
, first_row_to_display
);
16609 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16611 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16613 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16614 + WINDOW_HEADER_LINE_HEIGHT (w
));
16616 /* Display lines beginning with first_row_to_display in the
16617 desired matrix. Set last_text_row to the last row displayed
16618 that displays text. */
16619 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16620 if (pt_row
== NULL
)
16621 w
->cursor
.vpos
= -1;
16622 last_text_row
= NULL
;
16623 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16624 if (display_line (&it
))
16625 last_text_row
= it
.glyph_row
- 1;
16627 /* If point is in a reused row, adjust y and vpos of the cursor
16631 w
->cursor
.vpos
-= nrows_scrolled
;
16632 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16635 /* Give up if point isn't in a row displayed or reused. (This
16636 also handles the case where w->cursor.vpos < nrows_scrolled
16637 after the calls to display_line, which can happen with scroll
16638 margins. See bug#1295.) */
16639 if (w
->cursor
.vpos
< 0)
16641 clear_glyph_matrix (w
->desired_matrix
);
16645 /* Scroll the display. */
16646 run
.current_y
= first_reusable_row
->y
;
16647 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16648 run
.height
= it
.last_visible_y
- run
.current_y
;
16649 dy
= run
.current_y
- run
.desired_y
;
16654 FRAME_RIF (f
)->update_window_begin_hook (w
);
16655 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16656 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16657 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16661 /* Adjust Y positions of reused rows. */
16662 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16663 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16664 max_y
= it
.last_visible_y
;
16665 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16668 row
->visible_height
= row
->height
;
16669 if (row
->y
< min_y
)
16670 row
->visible_height
-= min_y
- row
->y
;
16671 if (row
->y
+ row
->height
> max_y
)
16672 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16673 if (row
->fringe_bitmap_periodic_p
)
16674 row
->redraw_fringe_bitmaps_p
= 1;
16677 /* Scroll the current matrix. */
16678 eassert (nrows_scrolled
> 0);
16679 rotate_matrix (w
->current_matrix
,
16681 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16684 /* Disable rows not reused. */
16685 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16686 row
->enabled_p
= 0;
16688 /* Point may have moved to a different line, so we cannot assume that
16689 the previous cursor position is valid; locate the correct row. */
16692 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16694 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16695 && !row
->ends_at_zv_p
;
16699 w
->cursor
.y
= row
->y
;
16701 if (row
< bottom_row
)
16703 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16704 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16706 /* Can't use this optimization with bidi-reordered glyph
16707 rows, unless cursor is already at point. */
16708 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16710 if (!(w
->cursor
.hpos
>= 0
16711 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16712 && BUFFERP (glyph
->object
)
16713 && glyph
->charpos
== PT
))
16718 && (!BUFFERP (glyph
->object
)
16719 || glyph
->charpos
< PT
);
16723 w
->cursor
.x
+= glyph
->pixel_width
;
16728 /* Adjust window end. A null value of last_text_row means that
16729 the window end is in reused rows which in turn means that
16730 only its vpos can have changed. */
16733 w
->window_end_bytepos
16734 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16736 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16738 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16743 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16746 w
->window_end_valid
= Qnil
;
16747 w
->desired_matrix
->no_scrolling_p
= 1;
16750 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16760 /************************************************************************
16761 Window redisplay reusing current matrix when buffer has changed
16762 ************************************************************************/
16764 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16765 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16766 ptrdiff_t *, ptrdiff_t *);
16767 static struct glyph_row
*
16768 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16769 struct glyph_row
*);
16772 /* Return the last row in MATRIX displaying text. If row START is
16773 non-null, start searching with that row. IT gives the dimensions
16774 of the display. Value is null if matrix is empty; otherwise it is
16775 a pointer to the row found. */
16777 static struct glyph_row
*
16778 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16779 struct glyph_row
*start
)
16781 struct glyph_row
*row
, *row_found
;
16783 /* Set row_found to the last row in IT->w's current matrix
16784 displaying text. The loop looks funny but think of partially
16787 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16788 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16790 eassert (row
->enabled_p
);
16792 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16801 /* Return the last row in the current matrix of W that is not affected
16802 by changes at the start of current_buffer that occurred since W's
16803 current matrix was built. Value is null if no such row exists.
16805 BEG_UNCHANGED us the number of characters unchanged at the start of
16806 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16807 first changed character in current_buffer. Characters at positions <
16808 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16809 when the current matrix was built. */
16811 static struct glyph_row
*
16812 find_last_unchanged_at_beg_row (struct window
*w
)
16814 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16815 struct glyph_row
*row
;
16816 struct glyph_row
*row_found
= NULL
;
16817 int yb
= window_text_bottom_y (w
);
16819 /* Find the last row displaying unchanged text. */
16820 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16821 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16822 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16825 if (/* If row ends before first_changed_pos, it is unchanged,
16826 except in some case. */
16827 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16828 /* When row ends in ZV and we write at ZV it is not
16830 && !row
->ends_at_zv_p
16831 /* When first_changed_pos is the end of a continued line,
16832 row is not unchanged because it may be no longer
16834 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16835 && (row
->continued_p
16836 || row
->exact_window_width_line_p
))
16837 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16838 needs to be recomputed, so don't consider this row as
16839 unchanged. This happens when the last line was
16840 bidi-reordered and was killed immediately before this
16841 redisplay cycle. In that case, ROW->end stores the
16842 buffer position of the first visual-order character of
16843 the killed text, which is now beyond ZV. */
16844 && CHARPOS (row
->end
.pos
) <= ZV
)
16847 /* Stop if last visible row. */
16848 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16856 /* Find the first glyph row in the current matrix of W that is not
16857 affected by changes at the end of current_buffer since the
16858 time W's current matrix was built.
16860 Return in *DELTA the number of chars by which buffer positions in
16861 unchanged text at the end of current_buffer must be adjusted.
16863 Return in *DELTA_BYTES the corresponding number of bytes.
16865 Value is null if no such row exists, i.e. all rows are affected by
16868 static struct glyph_row
*
16869 find_first_unchanged_at_end_row (struct window
*w
,
16870 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16872 struct glyph_row
*row
;
16873 struct glyph_row
*row_found
= NULL
;
16875 *delta
= *delta_bytes
= 0;
16877 /* Display must not have been paused, otherwise the current matrix
16878 is not up to date. */
16879 eassert (!NILP (w
->window_end_valid
));
16881 /* A value of window_end_pos >= END_UNCHANGED means that the window
16882 end is in the range of changed text. If so, there is no
16883 unchanged row at the end of W's current matrix. */
16884 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16887 /* Set row to the last row in W's current matrix displaying text. */
16888 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16890 /* If matrix is entirely empty, no unchanged row exists. */
16891 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16893 /* The value of row is the last glyph row in the matrix having a
16894 meaningful buffer position in it. The end position of row
16895 corresponds to window_end_pos. This allows us to translate
16896 buffer positions in the current matrix to current buffer
16897 positions for characters not in changed text. */
16899 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16900 ptrdiff_t Z_BYTE_old
=
16901 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16902 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16903 struct glyph_row
*first_text_row
16904 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16906 *delta
= Z
- Z_old
;
16907 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16909 /* Set last_unchanged_pos to the buffer position of the last
16910 character in the buffer that has not been changed. Z is the
16911 index + 1 of the last character in current_buffer, i.e. by
16912 subtracting END_UNCHANGED we get the index of the last
16913 unchanged character, and we have to add BEG to get its buffer
16915 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16916 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16918 /* Search backward from ROW for a row displaying a line that
16919 starts at a minimum position >= last_unchanged_pos_old. */
16920 for (; row
> first_text_row
; --row
)
16922 /* This used to abort, but it can happen.
16923 It is ok to just stop the search instead here. KFS. */
16924 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16927 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16932 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16938 /* Make sure that glyph rows in the current matrix of window W
16939 reference the same glyph memory as corresponding rows in the
16940 frame's frame matrix. This function is called after scrolling W's
16941 current matrix on a terminal frame in try_window_id and
16942 try_window_reusing_current_matrix. */
16945 sync_frame_with_window_matrix_rows (struct window
*w
)
16947 struct frame
*f
= XFRAME (w
->frame
);
16948 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16950 /* Preconditions: W must be a leaf window and full-width. Its frame
16951 must have a frame matrix. */
16952 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16953 eassert (WINDOW_FULL_WIDTH_P (w
));
16954 eassert (!FRAME_WINDOW_P (f
));
16956 /* If W is a full-width window, glyph pointers in W's current matrix
16957 have, by definition, to be the same as glyph pointers in the
16958 corresponding frame matrix. Note that frame matrices have no
16959 marginal areas (see build_frame_matrix). */
16960 window_row
= w
->current_matrix
->rows
;
16961 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16962 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16963 while (window_row
< window_row_end
)
16965 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16966 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16968 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16969 frame_row
->glyphs
[TEXT_AREA
] = start
;
16970 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16971 frame_row
->glyphs
[LAST_AREA
] = end
;
16973 /* Disable frame rows whose corresponding window rows have
16974 been disabled in try_window_id. */
16975 if (!window_row
->enabled_p
)
16976 frame_row
->enabled_p
= 0;
16978 ++window_row
, ++frame_row
;
16983 /* Find the glyph row in window W containing CHARPOS. Consider all
16984 rows between START and END (not inclusive). END null means search
16985 all rows to the end of the display area of W. Value is the row
16986 containing CHARPOS or null. */
16989 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16990 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16992 struct glyph_row
*row
= start
;
16993 struct glyph_row
*best_row
= NULL
;
16994 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16997 /* If we happen to start on a header-line, skip that. */
16998 if (row
->mode_line_p
)
17001 if ((end
&& row
>= end
) || !row
->enabled_p
)
17004 last_y
= window_text_bottom_y (w
) - dy
;
17008 /* Give up if we have gone too far. */
17009 if (end
&& row
>= end
)
17011 /* This formerly returned if they were equal.
17012 I think that both quantities are of a "last plus one" type;
17013 if so, when they are equal, the row is within the screen. -- rms. */
17014 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17017 /* If it is in this row, return this row. */
17018 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17019 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17020 /* The end position of a row equals the start
17021 position of the next row. If CHARPOS is there, we
17022 would rather display it in the next line, except
17023 when this line ends in ZV. */
17024 && !row
->ends_at_zv_p
17025 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17026 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17030 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17031 || (!best_row
&& !row
->continued_p
))
17033 /* In bidi-reordered rows, there could be several rows
17034 occluding point, all of them belonging to the same
17035 continued line. We need to find the row which fits
17036 CHARPOS the best. */
17037 for (g
= row
->glyphs
[TEXT_AREA
];
17038 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17041 if (!STRINGP (g
->object
))
17043 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17045 mindif
= eabs (g
->charpos
- charpos
);
17047 /* Exact match always wins. */
17054 else if (best_row
&& !row
->continued_p
)
17061 /* Try to redisplay window W by reusing its existing display. W's
17062 current matrix must be up to date when this function is called,
17063 i.e. window_end_valid must not be nil.
17067 1 if display has been updated
17068 0 if otherwise unsuccessful
17069 -1 if redisplay with same window start is known not to succeed
17071 The following steps are performed:
17073 1. Find the last row in the current matrix of W that is not
17074 affected by changes at the start of current_buffer. If no such row
17077 2. Find the first row in W's current matrix that is not affected by
17078 changes at the end of current_buffer. Maybe there is no such row.
17080 3. Display lines beginning with the row + 1 found in step 1 to the
17081 row found in step 2 or, if step 2 didn't find a row, to the end of
17084 4. If cursor is not known to appear on the window, give up.
17086 5. If display stopped at the row found in step 2, scroll the
17087 display and current matrix as needed.
17089 6. Maybe display some lines at the end of W, if we must. This can
17090 happen under various circumstances, like a partially visible line
17091 becoming fully visible, or because newly displayed lines are displayed
17092 in smaller font sizes.
17094 7. Update W's window end information. */
17097 try_window_id (struct window
*w
)
17099 struct frame
*f
= XFRAME (w
->frame
);
17100 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17101 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17102 struct glyph_row
*last_unchanged_at_beg_row
;
17103 struct glyph_row
*first_unchanged_at_end_row
;
17104 struct glyph_row
*row
;
17105 struct glyph_row
*bottom_row
;
17108 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17110 struct text_pos start_pos
;
17112 int first_unchanged_at_end_vpos
= 0;
17113 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17114 struct text_pos start
;
17115 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17118 if (inhibit_try_window_id
)
17122 /* This is handy for debugging. */
17124 #define GIVE_UP(X) \
17126 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17130 #define GIVE_UP(X) return 0
17133 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17135 /* Don't use this for mini-windows because these can show
17136 messages and mini-buffers, and we don't handle that here. */
17137 if (MINI_WINDOW_P (w
))
17140 /* This flag is used to prevent redisplay optimizations. */
17141 if (windows_or_buffers_changed
|| cursor_type_changed
)
17144 /* Verify that narrowing has not changed.
17145 Also verify that we were not told to prevent redisplay optimizations.
17146 It would be nice to further
17147 reduce the number of cases where this prevents try_window_id. */
17148 if (current_buffer
->clip_changed
17149 || current_buffer
->prevent_redisplay_optimizations_p
)
17152 /* Window must either use window-based redisplay or be full width. */
17153 if (!FRAME_WINDOW_P (f
)
17154 && (!FRAME_LINE_INS_DEL_OK (f
)
17155 || !WINDOW_FULL_WIDTH_P (w
)))
17158 /* Give up if point is known NOT to appear in W. */
17159 if (PT
< CHARPOS (start
))
17162 /* Another way to prevent redisplay optimizations. */
17163 if (w
->last_modified
== 0)
17166 /* Verify that window is not hscrolled. */
17167 if (w
->hscroll
!= 0)
17170 /* Verify that display wasn't paused. */
17171 if (NILP (w
->window_end_valid
))
17174 /* Can't use this if highlighting a region because a cursor movement
17175 will do more than just set the cursor. */
17176 if (!NILP (Vtransient_mark_mode
)
17177 && !NILP (BVAR (current_buffer
, mark_active
)))
17180 /* Likewise if highlighting trailing whitespace. */
17181 if (!NILP (Vshow_trailing_whitespace
))
17184 /* Likewise if showing a region. */
17185 if (!NILP (w
->region_showing
))
17188 /* Can't use this if overlay arrow position and/or string have
17190 if (overlay_arrows_changed_p ())
17193 /* When word-wrap is on, adding a space to the first word of a
17194 wrapped line can change the wrap position, altering the line
17195 above it. It might be worthwhile to handle this more
17196 intelligently, but for now just redisplay from scratch. */
17197 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17200 /* Under bidi reordering, adding or deleting a character in the
17201 beginning of a paragraph, before the first strong directional
17202 character, can change the base direction of the paragraph (unless
17203 the buffer specifies a fixed paragraph direction), which will
17204 require to redisplay the whole paragraph. It might be worthwhile
17205 to find the paragraph limits and widen the range of redisplayed
17206 lines to that, but for now just give up this optimization and
17207 redisplay from scratch. */
17208 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17209 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17212 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17213 only if buffer has really changed. The reason is that the gap is
17214 initially at Z for freshly visited files. The code below would
17215 set end_unchanged to 0 in that case. */
17216 if (MODIFF
> SAVE_MODIFF
17217 /* This seems to happen sometimes after saving a buffer. */
17218 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17220 if (GPT
- BEG
< BEG_UNCHANGED
)
17221 BEG_UNCHANGED
= GPT
- BEG
;
17222 if (Z
- GPT
< END_UNCHANGED
)
17223 END_UNCHANGED
= Z
- GPT
;
17226 /* The position of the first and last character that has been changed. */
17227 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17228 last_changed_charpos
= Z
- END_UNCHANGED
;
17230 /* If window starts after a line end, and the last change is in
17231 front of that newline, then changes don't affect the display.
17232 This case happens with stealth-fontification. Note that although
17233 the display is unchanged, glyph positions in the matrix have to
17234 be adjusted, of course. */
17235 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17236 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17237 && ((last_changed_charpos
< CHARPOS (start
)
17238 && CHARPOS (start
) == BEGV
)
17239 || (last_changed_charpos
< CHARPOS (start
) - 1
17240 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17242 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17243 struct glyph_row
*r0
;
17245 /* Compute how many chars/bytes have been added to or removed
17246 from the buffer. */
17247 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17248 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17249 Z_delta
= Z
- Z_old
;
17250 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17252 /* Give up if PT is not in the window. Note that it already has
17253 been checked at the start of try_window_id that PT is not in
17254 front of the window start. */
17255 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17258 /* If window start is unchanged, we can reuse the whole matrix
17259 as is, after adjusting glyph positions. No need to compute
17260 the window end again, since its offset from Z hasn't changed. */
17261 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17262 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17263 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17264 /* PT must not be in a partially visible line. */
17265 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17266 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17268 /* Adjust positions in the glyph matrix. */
17269 if (Z_delta
|| Z_delta_bytes
)
17271 struct glyph_row
*r1
17272 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17273 increment_matrix_positions (w
->current_matrix
,
17274 MATRIX_ROW_VPOS (r0
, current_matrix
),
17275 MATRIX_ROW_VPOS (r1
, current_matrix
),
17276 Z_delta
, Z_delta_bytes
);
17279 /* Set the cursor. */
17280 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17282 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17289 /* Handle the case that changes are all below what is displayed in
17290 the window, and that PT is in the window. This shortcut cannot
17291 be taken if ZV is visible in the window, and text has been added
17292 there that is visible in the window. */
17293 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17294 /* ZV is not visible in the window, or there are no
17295 changes at ZV, actually. */
17296 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17297 || first_changed_charpos
== last_changed_charpos
))
17299 struct glyph_row
*r0
;
17301 /* Give up if PT is not in the window. Note that it already has
17302 been checked at the start of try_window_id that PT is not in
17303 front of the window start. */
17304 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17307 /* If window start is unchanged, we can reuse the whole matrix
17308 as is, without changing glyph positions since no text has
17309 been added/removed in front of the window end. */
17310 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17311 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17312 /* PT must not be in a partially visible line. */
17313 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17314 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17316 /* We have to compute the window end anew since text
17317 could have been added/removed after it. */
17319 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17320 w
->window_end_bytepos
17321 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17323 /* Set the cursor. */
17324 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17326 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17333 /* Give up if window start is in the changed area.
17335 The condition used to read
17337 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17339 but why that was tested escapes me at the moment. */
17340 if (CHARPOS (start
) >= first_changed_charpos
17341 && CHARPOS (start
) <= last_changed_charpos
)
17344 /* Check that window start agrees with the start of the first glyph
17345 row in its current matrix. Check this after we know the window
17346 start is not in changed text, otherwise positions would not be
17348 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17349 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17352 /* Give up if the window ends in strings. Overlay strings
17353 at the end are difficult to handle, so don't try. */
17354 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17355 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17358 /* Compute the position at which we have to start displaying new
17359 lines. Some of the lines at the top of the window might be
17360 reusable because they are not displaying changed text. Find the
17361 last row in W's current matrix not affected by changes at the
17362 start of current_buffer. Value is null if changes start in the
17363 first line of window. */
17364 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17365 if (last_unchanged_at_beg_row
)
17367 /* Avoid starting to display in the middle of a character, a TAB
17368 for instance. This is easier than to set up the iterator
17369 exactly, and it's not a frequent case, so the additional
17370 effort wouldn't really pay off. */
17371 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17372 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17373 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17374 --last_unchanged_at_beg_row
;
17376 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17379 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17381 start_pos
= it
.current
.pos
;
17383 /* Start displaying new lines in the desired matrix at the same
17384 vpos we would use in the current matrix, i.e. below
17385 last_unchanged_at_beg_row. */
17386 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17388 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17389 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17391 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17395 /* There are no reusable lines at the start of the window.
17396 Start displaying in the first text line. */
17397 start_display (&it
, w
, start
);
17398 it
.vpos
= it
.first_vpos
;
17399 start_pos
= it
.current
.pos
;
17402 /* Find the first row that is not affected by changes at the end of
17403 the buffer. Value will be null if there is no unchanged row, in
17404 which case we must redisplay to the end of the window. delta
17405 will be set to the value by which buffer positions beginning with
17406 first_unchanged_at_end_row have to be adjusted due to text
17408 first_unchanged_at_end_row
17409 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17410 IF_DEBUG (debug_delta
= delta
);
17411 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17413 /* Set stop_pos to the buffer position up to which we will have to
17414 display new lines. If first_unchanged_at_end_row != NULL, this
17415 is the buffer position of the start of the line displayed in that
17416 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17417 that we don't stop at a buffer position. */
17419 if (first_unchanged_at_end_row
)
17421 eassert (last_unchanged_at_beg_row
== NULL
17422 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17424 /* If this is a continuation line, move forward to the next one
17425 that isn't. Changes in lines above affect this line.
17426 Caution: this may move first_unchanged_at_end_row to a row
17427 not displaying text. */
17428 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17429 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17430 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17431 < it
.last_visible_y
))
17432 ++first_unchanged_at_end_row
;
17434 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17435 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17436 >= it
.last_visible_y
))
17437 first_unchanged_at_end_row
= NULL
;
17440 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17442 first_unchanged_at_end_vpos
17443 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17444 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17447 else if (last_unchanged_at_beg_row
== NULL
)
17453 /* Either there is no unchanged row at the end, or the one we have
17454 now displays text. This is a necessary condition for the window
17455 end pos calculation at the end of this function. */
17456 eassert (first_unchanged_at_end_row
== NULL
17457 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17459 debug_last_unchanged_at_beg_vpos
17460 = (last_unchanged_at_beg_row
17461 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17463 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17465 #endif /* GLYPH_DEBUG */
17468 /* Display new lines. Set last_text_row to the last new line
17469 displayed which has text on it, i.e. might end up as being the
17470 line where the window_end_vpos is. */
17471 w
->cursor
.vpos
= -1;
17472 last_text_row
= NULL
;
17473 overlay_arrow_seen
= 0;
17474 while (it
.current_y
< it
.last_visible_y
17475 && !fonts_changed_p
17476 && (first_unchanged_at_end_row
== NULL
17477 || IT_CHARPOS (it
) < stop_pos
))
17479 if (display_line (&it
))
17480 last_text_row
= it
.glyph_row
- 1;
17483 if (fonts_changed_p
)
17487 /* Compute differences in buffer positions, y-positions etc. for
17488 lines reused at the bottom of the window. Compute what we can
17490 if (first_unchanged_at_end_row
17491 /* No lines reused because we displayed everything up to the
17492 bottom of the window. */
17493 && it
.current_y
< it
.last_visible_y
)
17496 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17498 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17499 run
.current_y
= first_unchanged_at_end_row
->y
;
17500 run
.desired_y
= run
.current_y
+ dy
;
17501 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17505 delta
= delta_bytes
= dvpos
= dy
17506 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17507 first_unchanged_at_end_row
= NULL
;
17509 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17512 /* Find the cursor if not already found. We have to decide whether
17513 PT will appear on this window (it sometimes doesn't, but this is
17514 not a very frequent case.) This decision has to be made before
17515 the current matrix is altered. A value of cursor.vpos < 0 means
17516 that PT is either in one of the lines beginning at
17517 first_unchanged_at_end_row or below the window. Don't care for
17518 lines that might be displayed later at the window end; as
17519 mentioned, this is not a frequent case. */
17520 if (w
->cursor
.vpos
< 0)
17522 /* Cursor in unchanged rows at the top? */
17523 if (PT
< CHARPOS (start_pos
)
17524 && last_unchanged_at_beg_row
)
17526 row
= row_containing_pos (w
, PT
,
17527 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17528 last_unchanged_at_beg_row
+ 1, 0);
17530 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17533 /* Start from first_unchanged_at_end_row looking for PT. */
17534 else if (first_unchanged_at_end_row
)
17536 row
= row_containing_pos (w
, PT
- delta
,
17537 first_unchanged_at_end_row
, NULL
, 0);
17539 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17540 delta_bytes
, dy
, dvpos
);
17543 /* Give up if cursor was not found. */
17544 if (w
->cursor
.vpos
< 0)
17546 clear_glyph_matrix (w
->desired_matrix
);
17551 /* Don't let the cursor end in the scroll margins. */
17553 int this_scroll_margin
, cursor_height
;
17555 this_scroll_margin
=
17556 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17557 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17558 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17560 if ((w
->cursor
.y
< this_scroll_margin
17561 && CHARPOS (start
) > BEGV
)
17562 /* Old redisplay didn't take scroll margin into account at the bottom,
17563 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17564 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17565 ? cursor_height
+ this_scroll_margin
17566 : 1)) > it
.last_visible_y
)
17568 w
->cursor
.vpos
= -1;
17569 clear_glyph_matrix (w
->desired_matrix
);
17574 /* Scroll the display. Do it before changing the current matrix so
17575 that xterm.c doesn't get confused about where the cursor glyph is
17577 if (dy
&& run
.height
)
17581 if (FRAME_WINDOW_P (f
))
17583 FRAME_RIF (f
)->update_window_begin_hook (w
);
17584 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17585 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17586 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17590 /* Terminal frame. In this case, dvpos gives the number of
17591 lines to scroll by; dvpos < 0 means scroll up. */
17593 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17594 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17595 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17596 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17597 + window_internal_height (w
));
17599 #if defined (HAVE_GPM) || defined (MSDOS)
17600 x_clear_window_mouse_face (w
);
17602 /* Perform the operation on the screen. */
17605 /* Scroll last_unchanged_at_beg_row to the end of the
17606 window down dvpos lines. */
17607 set_terminal_window (f
, end
);
17609 /* On dumb terminals delete dvpos lines at the end
17610 before inserting dvpos empty lines. */
17611 if (!FRAME_SCROLL_REGION_OK (f
))
17612 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17614 /* Insert dvpos empty lines in front of
17615 last_unchanged_at_beg_row. */
17616 ins_del_lines (f
, from
, dvpos
);
17618 else if (dvpos
< 0)
17620 /* Scroll up last_unchanged_at_beg_vpos to the end of
17621 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17622 set_terminal_window (f
, end
);
17624 /* Delete dvpos lines in front of
17625 last_unchanged_at_beg_vpos. ins_del_lines will set
17626 the cursor to the given vpos and emit |dvpos| delete
17628 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17630 /* On a dumb terminal insert dvpos empty lines at the
17632 if (!FRAME_SCROLL_REGION_OK (f
))
17633 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17636 set_terminal_window (f
, 0);
17642 /* Shift reused rows of the current matrix to the right position.
17643 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17645 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17646 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17649 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17650 bottom_vpos
, dvpos
);
17651 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17654 else if (dvpos
> 0)
17656 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17657 bottom_vpos
, dvpos
);
17658 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17659 first_unchanged_at_end_vpos
+ dvpos
, 0);
17662 /* For frame-based redisplay, make sure that current frame and window
17663 matrix are in sync with respect to glyph memory. */
17664 if (!FRAME_WINDOW_P (f
))
17665 sync_frame_with_window_matrix_rows (w
);
17667 /* Adjust buffer positions in reused rows. */
17668 if (delta
|| delta_bytes
)
17669 increment_matrix_positions (current_matrix
,
17670 first_unchanged_at_end_vpos
+ dvpos
,
17671 bottom_vpos
, delta
, delta_bytes
);
17673 /* Adjust Y positions. */
17675 shift_glyph_matrix (w
, current_matrix
,
17676 first_unchanged_at_end_vpos
+ dvpos
,
17679 if (first_unchanged_at_end_row
)
17681 first_unchanged_at_end_row
+= dvpos
;
17682 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17683 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17684 first_unchanged_at_end_row
= NULL
;
17687 /* If scrolling up, there may be some lines to display at the end of
17689 last_text_row_at_end
= NULL
;
17692 /* Scrolling up can leave for example a partially visible line
17693 at the end of the window to be redisplayed. */
17694 /* Set last_row to the glyph row in the current matrix where the
17695 window end line is found. It has been moved up or down in
17696 the matrix by dvpos. */
17697 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17698 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17700 /* If last_row is the window end line, it should display text. */
17701 eassert (last_row
->displays_text_p
);
17703 /* If window end line was partially visible before, begin
17704 displaying at that line. Otherwise begin displaying with the
17705 line following it. */
17706 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17708 init_to_row_start (&it
, w
, last_row
);
17709 it
.vpos
= last_vpos
;
17710 it
.current_y
= last_row
->y
;
17714 init_to_row_end (&it
, w
, last_row
);
17715 it
.vpos
= 1 + last_vpos
;
17716 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17720 /* We may start in a continuation line. If so, we have to
17721 get the right continuation_lines_width and current_x. */
17722 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17723 it
.hpos
= it
.current_x
= 0;
17725 /* Display the rest of the lines at the window end. */
17726 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17727 while (it
.current_y
< it
.last_visible_y
17728 && !fonts_changed_p
)
17730 /* Is it always sure that the display agrees with lines in
17731 the current matrix? I don't think so, so we mark rows
17732 displayed invalid in the current matrix by setting their
17733 enabled_p flag to zero. */
17734 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17735 if (display_line (&it
))
17736 last_text_row_at_end
= it
.glyph_row
- 1;
17740 /* Update window_end_pos and window_end_vpos. */
17741 if (first_unchanged_at_end_row
17742 && !last_text_row_at_end
)
17744 /* Window end line if one of the preserved rows from the current
17745 matrix. Set row to the last row displaying text in current
17746 matrix starting at first_unchanged_at_end_row, after
17748 eassert (first_unchanged_at_end_row
->displays_text_p
);
17749 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17750 first_unchanged_at_end_row
);
17751 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17753 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17754 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17756 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17757 eassert (w
->window_end_bytepos
>= 0);
17758 IF_DEBUG (debug_method_add (w
, "A"));
17760 else if (last_text_row_at_end
)
17763 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17764 w
->window_end_bytepos
17765 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17767 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17768 eassert (w
->window_end_bytepos
>= 0);
17769 IF_DEBUG (debug_method_add (w
, "B"));
17771 else if (last_text_row
)
17773 /* We have displayed either to the end of the window or at the
17774 end of the window, i.e. the last row with text is to be found
17775 in the desired matrix. */
17777 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17778 w
->window_end_bytepos
17779 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17781 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17782 eassert (w
->window_end_bytepos
>= 0);
17784 else if (first_unchanged_at_end_row
== NULL
17785 && last_text_row
== NULL
17786 && last_text_row_at_end
== NULL
)
17788 /* Displayed to end of window, but no line containing text was
17789 displayed. Lines were deleted at the end of the window. */
17790 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17791 int vpos
= XFASTINT (w
->window_end_vpos
);
17792 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17793 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17796 row
== NULL
&& vpos
>= first_vpos
;
17797 --vpos
, --current_row
, --desired_row
)
17799 if (desired_row
->enabled_p
)
17801 if (desired_row
->displays_text_p
)
17804 else if (current_row
->displays_text_p
)
17808 eassert (row
!= NULL
);
17809 w
->window_end_vpos
= make_number (vpos
+ 1);
17810 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17811 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17812 eassert (w
->window_end_bytepos
>= 0);
17813 IF_DEBUG (debug_method_add (w
, "C"));
17818 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17819 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17821 /* Record that display has not been completed. */
17822 w
->window_end_valid
= Qnil
;
17823 w
->desired_matrix
->no_scrolling_p
= 1;
17831 /***********************************************************************
17832 More debugging support
17833 ***********************************************************************/
17837 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17838 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17839 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17842 /* Dump the contents of glyph matrix MATRIX on stderr.
17844 GLYPHS 0 means don't show glyph contents.
17845 GLYPHS 1 means show glyphs in short form
17846 GLYPHS > 1 means show glyphs in long form. */
17849 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17852 for (i
= 0; i
< matrix
->nrows
; ++i
)
17853 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17857 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17858 the glyph row and area where the glyph comes from. */
17861 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17863 if (glyph
->type
== CHAR_GLYPH
)
17866 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17867 glyph
- row
->glyphs
[TEXT_AREA
],
17870 (BUFFERP (glyph
->object
)
17872 : (STRINGP (glyph
->object
)
17875 glyph
->pixel_width
,
17877 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17881 glyph
->left_box_line_p
,
17882 glyph
->right_box_line_p
);
17884 else if (glyph
->type
== STRETCH_GLYPH
)
17887 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17888 glyph
- row
->glyphs
[TEXT_AREA
],
17891 (BUFFERP (glyph
->object
)
17893 : (STRINGP (glyph
->object
)
17896 glyph
->pixel_width
,
17900 glyph
->left_box_line_p
,
17901 glyph
->right_box_line_p
);
17903 else if (glyph
->type
== IMAGE_GLYPH
)
17906 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17907 glyph
- row
->glyphs
[TEXT_AREA
],
17910 (BUFFERP (glyph
->object
)
17912 : (STRINGP (glyph
->object
)
17915 glyph
->pixel_width
,
17919 glyph
->left_box_line_p
,
17920 glyph
->right_box_line_p
);
17922 else if (glyph
->type
== COMPOSITE_GLYPH
)
17925 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17926 glyph
- row
->glyphs
[TEXT_AREA
],
17929 (BUFFERP (glyph
->object
)
17931 : (STRINGP (glyph
->object
)
17934 glyph
->pixel_width
,
17936 if (glyph
->u
.cmp
.automatic
)
17939 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17940 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17942 glyph
->left_box_line_p
,
17943 glyph
->right_box_line_p
);
17948 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17949 GLYPHS 0 means don't show glyph contents.
17950 GLYPHS 1 means show glyphs in short form
17951 GLYPHS > 1 means show glyphs in long form. */
17954 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17958 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17959 fprintf (stderr
, "======================================================================\n");
17961 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17962 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17964 MATRIX_ROW_START_CHARPOS (row
),
17965 MATRIX_ROW_END_CHARPOS (row
),
17966 row
->used
[TEXT_AREA
],
17967 row
->contains_overlapping_glyphs_p
,
17969 row
->truncated_on_left_p
,
17970 row
->truncated_on_right_p
,
17972 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17973 row
->displays_text_p
,
17976 row
->ends_in_middle_of_char_p
,
17977 row
->starts_in_middle_of_char_p
,
17983 row
->visible_height
,
17986 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17987 row
->end
.overlay_string_index
,
17988 row
->continuation_lines_width
);
17989 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17990 CHARPOS (row
->start
.string_pos
),
17991 CHARPOS (row
->end
.string_pos
));
17992 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17993 row
->end
.dpvec_index
);
18000 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18002 struct glyph
*glyph
= row
->glyphs
[area
];
18003 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18005 /* Glyph for a line end in text. */
18006 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18009 if (glyph
< glyph_end
)
18010 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18012 for (; glyph
< glyph_end
; ++glyph
)
18013 dump_glyph (row
, glyph
, area
);
18016 else if (glyphs
== 1)
18020 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18022 char *s
= alloca (row
->used
[area
] + 1);
18025 for (i
= 0; i
< row
->used
[area
]; ++i
)
18027 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18028 if (glyph
->type
== CHAR_GLYPH
18029 && glyph
->u
.ch
< 0x80
18030 && glyph
->u
.ch
>= ' ')
18031 s
[i
] = glyph
->u
.ch
;
18037 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18043 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18044 Sdump_glyph_matrix
, 0, 1, "p",
18045 doc
: /* Dump the current matrix of the selected window to stderr.
18046 Shows contents of glyph row structures. With non-nil
18047 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18048 glyphs in short form, otherwise show glyphs in long form. */)
18049 (Lisp_Object glyphs
)
18051 struct window
*w
= XWINDOW (selected_window
);
18052 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18054 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18055 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18056 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18057 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18058 fprintf (stderr
, "=============================================\n");
18059 dump_glyph_matrix (w
->current_matrix
,
18060 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18065 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18066 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18069 struct frame
*f
= XFRAME (selected_frame
);
18070 dump_glyph_matrix (f
->current_matrix
, 1);
18075 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18076 doc
: /* Dump glyph row ROW to stderr.
18077 GLYPH 0 means don't dump glyphs.
18078 GLYPH 1 means dump glyphs in short form.
18079 GLYPH > 1 or omitted means dump glyphs in long form. */)
18080 (Lisp_Object row
, Lisp_Object glyphs
)
18082 struct glyph_matrix
*matrix
;
18085 CHECK_NUMBER (row
);
18086 matrix
= XWINDOW (selected_window
)->current_matrix
;
18088 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18089 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18091 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18096 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18097 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18098 GLYPH 0 means don't dump glyphs.
18099 GLYPH 1 means dump glyphs in short form.
18100 GLYPH > 1 or omitted means dump glyphs in long form. */)
18101 (Lisp_Object row
, Lisp_Object glyphs
)
18103 struct frame
*sf
= SELECTED_FRAME ();
18104 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18107 CHECK_NUMBER (row
);
18109 if (vpos
>= 0 && vpos
< m
->nrows
)
18110 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18111 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18116 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18117 doc
: /* Toggle tracing of redisplay.
18118 With ARG, turn tracing on if and only if ARG is positive. */)
18122 trace_redisplay_p
= !trace_redisplay_p
;
18125 arg
= Fprefix_numeric_value (arg
);
18126 trace_redisplay_p
= XINT (arg
) > 0;
18133 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18134 doc
: /* Like `format', but print result to stderr.
18135 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18136 (ptrdiff_t nargs
, Lisp_Object
*args
)
18138 Lisp_Object s
= Fformat (nargs
, args
);
18139 fprintf (stderr
, "%s", SDATA (s
));
18143 #endif /* GLYPH_DEBUG */
18147 /***********************************************************************
18148 Building Desired Matrix Rows
18149 ***********************************************************************/
18151 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18152 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18154 static struct glyph_row
*
18155 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18157 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18158 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18159 struct buffer
*old
= current_buffer
;
18160 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18161 int arrow_len
= SCHARS (overlay_arrow_string
);
18162 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18163 const unsigned char *p
;
18166 int n_glyphs_before
;
18168 set_buffer_temp (buffer
);
18169 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18170 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18171 SET_TEXT_POS (it
.position
, 0, 0);
18173 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18175 while (p
< arrow_end
)
18177 Lisp_Object face
, ilisp
;
18179 /* Get the next character. */
18181 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18184 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18185 if (! ASCII_CHAR_P (it
.c
))
18186 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18190 /* Get its face. */
18191 ilisp
= make_number (p
- arrow_string
);
18192 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18193 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18195 /* Compute its width, get its glyphs. */
18196 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18197 SET_TEXT_POS (it
.position
, -1, -1);
18198 PRODUCE_GLYPHS (&it
);
18200 /* If this character doesn't fit any more in the line, we have
18201 to remove some glyphs. */
18202 if (it
.current_x
> it
.last_visible_x
)
18204 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18209 set_buffer_temp (old
);
18210 return it
.glyph_row
;
18214 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18215 glyphs to insert is determined by produce_special_glyphs. */
18218 insert_left_trunc_glyphs (struct it
*it
)
18220 struct it truncate_it
;
18221 struct glyph
*from
, *end
, *to
, *toend
;
18223 eassert (!FRAME_WINDOW_P (it
->f
)
18224 || (!it
->glyph_row
->reversed_p
18225 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18226 || (it
->glyph_row
->reversed_p
18227 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18229 /* Get the truncation glyphs. */
18231 truncate_it
.current_x
= 0;
18232 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18233 truncate_it
.glyph_row
= &scratch_glyph_row
;
18234 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18235 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18236 truncate_it
.object
= make_number (0);
18237 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18239 /* Overwrite glyphs from IT with truncation glyphs. */
18240 if (!it
->glyph_row
->reversed_p
)
18242 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18244 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18245 end
= from
+ tused
;
18246 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18247 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18248 if (FRAME_WINDOW_P (it
->f
))
18250 /* On GUI frames, when variable-size fonts are displayed,
18251 the truncation glyphs may need more pixels than the row's
18252 glyphs they overwrite. We overwrite more glyphs to free
18253 enough screen real estate, and enlarge the stretch glyph
18254 on the right (see display_line), if there is one, to
18255 preserve the screen position of the truncation glyphs on
18258 struct glyph
*g
= to
;
18261 /* The first glyph could be partially visible, in which case
18262 it->glyph_row->x will be negative. But we want the left
18263 truncation glyphs to be aligned at the left margin of the
18264 window, so we override the x coordinate at which the row
18266 it
->glyph_row
->x
= 0;
18267 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18269 w
+= g
->pixel_width
;
18272 if (g
- to
- tused
> 0)
18274 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18275 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18277 used
= it
->glyph_row
->used
[TEXT_AREA
];
18278 if (it
->glyph_row
->truncated_on_right_p
18279 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18280 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18283 int extra
= w
- it
->truncation_pixel_width
;
18285 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18292 /* There may be padding glyphs left over. Overwrite them too. */
18293 if (!FRAME_WINDOW_P (it
->f
))
18295 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18297 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18304 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18308 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18310 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18311 that back to front. */
18312 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18313 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18314 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18315 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18316 if (FRAME_WINDOW_P (it
->f
))
18319 struct glyph
*g
= to
;
18321 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18323 w
+= g
->pixel_width
;
18326 if (to
- g
- tused
> 0)
18328 if (it
->glyph_row
->truncated_on_right_p
18329 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18330 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18332 int extra
= w
- it
->truncation_pixel_width
;
18334 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18338 while (from
>= end
&& to
>= toend
)
18340 if (!FRAME_WINDOW_P (it
->f
))
18342 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18345 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18346 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18347 while (from
>= end
&& to
>= toend
)
18353 /* Need to free some room before prepending additional
18355 int move_by
= from
- end
+ 1;
18356 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18357 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18359 for ( ; g
>= g0
; g
--)
18361 while (from
>= end
)
18363 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18368 /* Compute the hash code for ROW. */
18370 row_hash (struct glyph_row
*row
)
18373 unsigned hashval
= 0;
18375 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18376 for (k
= 0; k
< row
->used
[area
]; ++k
)
18377 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18378 + row
->glyphs
[area
][k
].u
.val
18379 + row
->glyphs
[area
][k
].face_id
18380 + row
->glyphs
[area
][k
].padding_p
18381 + (row
->glyphs
[area
][k
].type
<< 2));
18386 /* Compute the pixel height and width of IT->glyph_row.
18388 Most of the time, ascent and height of a display line will be equal
18389 to the max_ascent and max_height values of the display iterator
18390 structure. This is not the case if
18392 1. We hit ZV without displaying anything. In this case, max_ascent
18393 and max_height will be zero.
18395 2. We have some glyphs that don't contribute to the line height.
18396 (The glyph row flag contributes_to_line_height_p is for future
18397 pixmap extensions).
18399 The first case is easily covered by using default values because in
18400 these cases, the line height does not really matter, except that it
18401 must not be zero. */
18404 compute_line_metrics (struct it
*it
)
18406 struct glyph_row
*row
= it
->glyph_row
;
18408 if (FRAME_WINDOW_P (it
->f
))
18410 int i
, min_y
, max_y
;
18412 /* The line may consist of one space only, that was added to
18413 place the cursor on it. If so, the row's height hasn't been
18415 if (row
->height
== 0)
18417 if (it
->max_ascent
+ it
->max_descent
== 0)
18418 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18419 row
->ascent
= it
->max_ascent
;
18420 row
->height
= it
->max_ascent
+ it
->max_descent
;
18421 row
->phys_ascent
= it
->max_phys_ascent
;
18422 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18423 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18426 /* Compute the width of this line. */
18427 row
->pixel_width
= row
->x
;
18428 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18429 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18431 eassert (row
->pixel_width
>= 0);
18432 eassert (row
->ascent
>= 0 && row
->height
> 0);
18434 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18435 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18437 /* If first line's physical ascent is larger than its logical
18438 ascent, use the physical ascent, and make the row taller.
18439 This makes accented characters fully visible. */
18440 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18441 && row
->phys_ascent
> row
->ascent
)
18443 row
->height
+= row
->phys_ascent
- row
->ascent
;
18444 row
->ascent
= row
->phys_ascent
;
18447 /* Compute how much of the line is visible. */
18448 row
->visible_height
= row
->height
;
18450 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18451 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18453 if (row
->y
< min_y
)
18454 row
->visible_height
-= min_y
- row
->y
;
18455 if (row
->y
+ row
->height
> max_y
)
18456 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18460 row
->pixel_width
= row
->used
[TEXT_AREA
];
18461 if (row
->continued_p
)
18462 row
->pixel_width
-= it
->continuation_pixel_width
;
18463 else if (row
->truncated_on_right_p
)
18464 row
->pixel_width
-= it
->truncation_pixel_width
;
18465 row
->ascent
= row
->phys_ascent
= 0;
18466 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18467 row
->extra_line_spacing
= 0;
18470 /* Compute a hash code for this row. */
18471 row
->hash
= row_hash (row
);
18473 it
->max_ascent
= it
->max_descent
= 0;
18474 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18478 /* Append one space to the glyph row of iterator IT if doing a
18479 window-based redisplay. The space has the same face as
18480 IT->face_id. Value is non-zero if a space was added.
18482 This function is called to make sure that there is always one glyph
18483 at the end of a glyph row that the cursor can be set on under
18484 window-systems. (If there weren't such a glyph we would not know
18485 how wide and tall a box cursor should be displayed).
18487 At the same time this space let's a nicely handle clearing to the
18488 end of the line if the row ends in italic text. */
18491 append_space_for_newline (struct it
*it
, int default_face_p
)
18493 if (FRAME_WINDOW_P (it
->f
))
18495 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18497 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18498 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18500 /* Save some values that must not be changed.
18501 Must save IT->c and IT->len because otherwise
18502 ITERATOR_AT_END_P wouldn't work anymore after
18503 append_space_for_newline has been called. */
18504 enum display_element_type saved_what
= it
->what
;
18505 int saved_c
= it
->c
, saved_len
= it
->len
;
18506 int saved_char_to_display
= it
->char_to_display
;
18507 int saved_x
= it
->current_x
;
18508 int saved_face_id
= it
->face_id
;
18509 struct text_pos saved_pos
;
18510 Lisp_Object saved_object
;
18513 saved_object
= it
->object
;
18514 saved_pos
= it
->position
;
18516 it
->what
= IT_CHARACTER
;
18517 memset (&it
->position
, 0, sizeof it
->position
);
18518 it
->object
= make_number (0);
18519 it
->c
= it
->char_to_display
= ' ';
18522 /* If the default face was remapped, be sure to use the
18523 remapped face for the appended newline. */
18524 if (default_face_p
)
18525 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18526 else if (it
->face_before_selective_p
)
18527 it
->face_id
= it
->saved_face_id
;
18528 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18529 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18531 PRODUCE_GLYPHS (it
);
18533 it
->override_ascent
= -1;
18534 it
->constrain_row_ascent_descent_p
= 0;
18535 it
->current_x
= saved_x
;
18536 it
->object
= saved_object
;
18537 it
->position
= saved_pos
;
18538 it
->what
= saved_what
;
18539 it
->face_id
= saved_face_id
;
18540 it
->len
= saved_len
;
18542 it
->char_to_display
= saved_char_to_display
;
18551 /* Extend the face of the last glyph in the text area of IT->glyph_row
18552 to the end of the display line. Called from display_line. If the
18553 glyph row is empty, add a space glyph to it so that we know the
18554 face to draw. Set the glyph row flag fill_line_p. If the glyph
18555 row is R2L, prepend a stretch glyph to cover the empty space to the
18556 left of the leftmost glyph. */
18559 extend_face_to_end_of_line (struct it
*it
)
18561 struct face
*face
, *default_face
;
18562 struct frame
*f
= it
->f
;
18564 /* If line is already filled, do nothing. Non window-system frames
18565 get a grace of one more ``pixel'' because their characters are
18566 1-``pixel'' wide, so they hit the equality too early. This grace
18567 is needed only for R2L rows that are not continued, to produce
18568 one extra blank where we could display the cursor. */
18569 if (it
->current_x
>= it
->last_visible_x
18570 + (!FRAME_WINDOW_P (f
)
18571 && it
->glyph_row
->reversed_p
18572 && !it
->glyph_row
->continued_p
))
18575 /* The default face, possibly remapped. */
18576 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18578 /* Face extension extends the background and box of IT->face_id
18579 to the end of the line. If the background equals the background
18580 of the frame, we don't have to do anything. */
18581 if (it
->face_before_selective_p
)
18582 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18584 face
= FACE_FROM_ID (f
, it
->face_id
);
18586 if (FRAME_WINDOW_P (f
)
18587 && it
->glyph_row
->displays_text_p
18588 && face
->box
== FACE_NO_BOX
18589 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18591 && !it
->glyph_row
->reversed_p
)
18594 /* Set the glyph row flag indicating that the face of the last glyph
18595 in the text area has to be drawn to the end of the text area. */
18596 it
->glyph_row
->fill_line_p
= 1;
18598 /* If current character of IT is not ASCII, make sure we have the
18599 ASCII face. This will be automatically undone the next time
18600 get_next_display_element returns a multibyte character. Note
18601 that the character will always be single byte in unibyte
18603 if (!ASCII_CHAR_P (it
->c
))
18605 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18608 if (FRAME_WINDOW_P (f
))
18610 /* If the row is empty, add a space with the current face of IT,
18611 so that we know which face to draw. */
18612 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18614 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18615 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18616 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18618 #ifdef HAVE_WINDOW_SYSTEM
18619 if (it
->glyph_row
->reversed_p
)
18621 /* Prepend a stretch glyph to the row, such that the
18622 rightmost glyph will be drawn flushed all the way to the
18623 right margin of the window. The stretch glyph that will
18624 occupy the empty space, if any, to the left of the
18626 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18627 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18628 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18630 int row_width
, stretch_ascent
, stretch_width
;
18631 struct text_pos saved_pos
;
18632 int saved_face_id
, saved_avoid_cursor
;
18634 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18635 row_width
+= g
->pixel_width
;
18636 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18637 if (stretch_width
> 0)
18640 (((it
->ascent
+ it
->descent
)
18641 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18642 saved_pos
= it
->position
;
18643 memset (&it
->position
, 0, sizeof it
->position
);
18644 saved_avoid_cursor
= it
->avoid_cursor_p
;
18645 it
->avoid_cursor_p
= 1;
18646 saved_face_id
= it
->face_id
;
18647 /* The last row's stretch glyph should get the default
18648 face, to avoid painting the rest of the window with
18649 the region face, if the region ends at ZV. */
18650 if (it
->glyph_row
->ends_at_zv_p
)
18651 it
->face_id
= default_face
->id
;
18653 it
->face_id
= face
->id
;
18654 append_stretch_glyph (it
, make_number (0), stretch_width
,
18655 it
->ascent
+ it
->descent
, stretch_ascent
);
18656 it
->position
= saved_pos
;
18657 it
->avoid_cursor_p
= saved_avoid_cursor
;
18658 it
->face_id
= saved_face_id
;
18661 #endif /* HAVE_WINDOW_SYSTEM */
18665 /* Save some values that must not be changed. */
18666 int saved_x
= it
->current_x
;
18667 struct text_pos saved_pos
;
18668 Lisp_Object saved_object
;
18669 enum display_element_type saved_what
= it
->what
;
18670 int saved_face_id
= it
->face_id
;
18672 saved_object
= it
->object
;
18673 saved_pos
= it
->position
;
18675 it
->what
= IT_CHARACTER
;
18676 memset (&it
->position
, 0, sizeof it
->position
);
18677 it
->object
= make_number (0);
18678 it
->c
= it
->char_to_display
= ' ';
18680 /* The last row's blank glyphs should get the default face, to
18681 avoid painting the rest of the window with the region face,
18682 if the region ends at ZV. */
18683 if (it
->glyph_row
->ends_at_zv_p
)
18684 it
->face_id
= default_face
->id
;
18686 it
->face_id
= face
->id
;
18688 PRODUCE_GLYPHS (it
);
18690 while (it
->current_x
<= it
->last_visible_x
)
18691 PRODUCE_GLYPHS (it
);
18693 /* Don't count these blanks really. It would let us insert a left
18694 truncation glyph below and make us set the cursor on them, maybe. */
18695 it
->current_x
= saved_x
;
18696 it
->object
= saved_object
;
18697 it
->position
= saved_pos
;
18698 it
->what
= saved_what
;
18699 it
->face_id
= saved_face_id
;
18704 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18705 trailing whitespace. */
18708 trailing_whitespace_p (ptrdiff_t charpos
)
18710 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18713 while (bytepos
< ZV_BYTE
18714 && (c
= FETCH_CHAR (bytepos
),
18715 c
== ' ' || c
== '\t'))
18718 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18720 if (bytepos
!= PT_BYTE
)
18727 /* Highlight trailing whitespace, if any, in ROW. */
18730 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18732 int used
= row
->used
[TEXT_AREA
];
18736 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18737 struct glyph
*glyph
= start
+ used
- 1;
18739 if (row
->reversed_p
)
18741 /* Right-to-left rows need to be processed in the opposite
18742 direction, so swap the edge pointers. */
18744 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18747 /* Skip over glyphs inserted to display the cursor at the
18748 end of a line, for extending the face of the last glyph
18749 to the end of the line on terminals, and for truncation
18750 and continuation glyphs. */
18751 if (!row
->reversed_p
)
18753 while (glyph
>= start
18754 && glyph
->type
== CHAR_GLYPH
18755 && INTEGERP (glyph
->object
))
18760 while (glyph
<= start
18761 && glyph
->type
== CHAR_GLYPH
18762 && INTEGERP (glyph
->object
))
18766 /* If last glyph is a space or stretch, and it's trailing
18767 whitespace, set the face of all trailing whitespace glyphs in
18768 IT->glyph_row to `trailing-whitespace'. */
18769 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18770 && BUFFERP (glyph
->object
)
18771 && (glyph
->type
== STRETCH_GLYPH
18772 || (glyph
->type
== CHAR_GLYPH
18773 && glyph
->u
.ch
== ' '))
18774 && trailing_whitespace_p (glyph
->charpos
))
18776 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18780 if (!row
->reversed_p
)
18782 while (glyph
>= start
18783 && BUFFERP (glyph
->object
)
18784 && (glyph
->type
== STRETCH_GLYPH
18785 || (glyph
->type
== CHAR_GLYPH
18786 && glyph
->u
.ch
== ' ')))
18787 (glyph
--)->face_id
= face_id
;
18791 while (glyph
<= start
18792 && BUFFERP (glyph
->object
)
18793 && (glyph
->type
== STRETCH_GLYPH
18794 || (glyph
->type
== CHAR_GLYPH
18795 && glyph
->u
.ch
== ' ')))
18796 (glyph
++)->face_id
= face_id
;
18803 /* Value is non-zero if glyph row ROW should be
18804 used to hold the cursor. */
18807 cursor_row_p (struct glyph_row
*row
)
18811 if (PT
== CHARPOS (row
->end
.pos
)
18812 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18814 /* Suppose the row ends on a string.
18815 Unless the row is continued, that means it ends on a newline
18816 in the string. If it's anything other than a display string
18817 (e.g., a before-string from an overlay), we don't want the
18818 cursor there. (This heuristic seems to give the optimal
18819 behavior for the various types of multi-line strings.)
18820 One exception: if the string has `cursor' property on one of
18821 its characters, we _do_ want the cursor there. */
18822 if (CHARPOS (row
->end
.string_pos
) >= 0)
18824 if (row
->continued_p
)
18828 /* Check for `display' property. */
18829 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18830 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18831 struct glyph
*glyph
;
18834 for (glyph
= end
; glyph
>= beg
; --glyph
)
18835 if (STRINGP (glyph
->object
))
18838 = Fget_char_property (make_number (PT
),
18842 && display_prop_string_p (prop
, glyph
->object
));
18843 /* If there's a `cursor' property on one of the
18844 string's characters, this row is a cursor row,
18845 even though this is not a display string. */
18848 Lisp_Object s
= glyph
->object
;
18850 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18852 ptrdiff_t gpos
= glyph
->charpos
;
18854 if (!NILP (Fget_char_property (make_number (gpos
),
18866 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18868 /* If the row ends in middle of a real character,
18869 and the line is continued, we want the cursor here.
18870 That's because CHARPOS (ROW->end.pos) would equal
18871 PT if PT is before the character. */
18872 if (!row
->ends_in_ellipsis_p
)
18873 result
= row
->continued_p
;
18875 /* If the row ends in an ellipsis, then
18876 CHARPOS (ROW->end.pos) will equal point after the
18877 invisible text. We want that position to be displayed
18878 after the ellipsis. */
18881 /* If the row ends at ZV, display the cursor at the end of that
18882 row instead of at the start of the row below. */
18883 else if (row
->ends_at_zv_p
)
18894 /* Push the property PROP so that it will be rendered at the current
18895 position in IT. Return 1 if PROP was successfully pushed, 0
18896 otherwise. Called from handle_line_prefix to handle the
18897 `line-prefix' and `wrap-prefix' properties. */
18900 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18902 struct text_pos pos
=
18903 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18905 eassert (it
->method
== GET_FROM_BUFFER
18906 || it
->method
== GET_FROM_DISPLAY_VECTOR
18907 || it
->method
== GET_FROM_STRING
);
18909 /* We need to save the current buffer/string position, so it will be
18910 restored by pop_it, because iterate_out_of_display_property
18911 depends on that being set correctly, but some situations leave
18912 it->position not yet set when this function is called. */
18913 push_it (it
, &pos
);
18915 if (STRINGP (prop
))
18917 if (SCHARS (prop
) == 0)
18924 it
->string_from_prefix_prop_p
= 1;
18925 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18926 it
->current
.overlay_string_index
= -1;
18927 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18928 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18929 it
->method
= GET_FROM_STRING
;
18930 it
->stop_charpos
= 0;
18932 it
->base_level_stop
= 0;
18934 /* Force paragraph direction to be that of the parent
18936 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18937 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18939 it
->paragraph_embedding
= L2R
;
18941 /* Set up the bidi iterator for this display string. */
18944 it
->bidi_it
.string
.lstring
= it
->string
;
18945 it
->bidi_it
.string
.s
= NULL
;
18946 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18947 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18948 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18949 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18950 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18953 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18955 it
->method
= GET_FROM_STRETCH
;
18958 #ifdef HAVE_WINDOW_SYSTEM
18959 else if (IMAGEP (prop
))
18961 it
->what
= IT_IMAGE
;
18962 it
->image_id
= lookup_image (it
->f
, prop
);
18963 it
->method
= GET_FROM_IMAGE
;
18965 #endif /* HAVE_WINDOW_SYSTEM */
18968 pop_it (it
); /* bogus display property, give up */
18975 /* Return the character-property PROP at the current position in IT. */
18978 get_it_property (struct it
*it
, Lisp_Object prop
)
18980 Lisp_Object position
;
18982 if (STRINGP (it
->object
))
18983 position
= make_number (IT_STRING_CHARPOS (*it
));
18984 else if (BUFFERP (it
->object
))
18985 position
= make_number (IT_CHARPOS (*it
));
18989 return Fget_char_property (position
, prop
, it
->object
);
18992 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18995 handle_line_prefix (struct it
*it
)
18997 Lisp_Object prefix
;
18999 if (it
->continuation_lines_width
> 0)
19001 prefix
= get_it_property (it
, Qwrap_prefix
);
19003 prefix
= Vwrap_prefix
;
19007 prefix
= get_it_property (it
, Qline_prefix
);
19009 prefix
= Vline_prefix
;
19011 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19013 /* If the prefix is wider than the window, and we try to wrap
19014 it, it would acquire its own wrap prefix, and so on till the
19015 iterator stack overflows. So, don't wrap the prefix. */
19016 it
->line_wrap
= TRUNCATE
;
19017 it
->avoid_cursor_p
= 1;
19023 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19024 only for R2L lines from display_line and display_string, when they
19025 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19026 the line/string needs to be continued on the next glyph row. */
19028 unproduce_glyphs (struct it
*it
, int n
)
19030 struct glyph
*glyph
, *end
;
19032 eassert (it
->glyph_row
);
19033 eassert (it
->glyph_row
->reversed_p
);
19034 eassert (it
->area
== TEXT_AREA
);
19035 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19037 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19038 n
= it
->glyph_row
->used
[TEXT_AREA
];
19039 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19040 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19041 for ( ; glyph
< end
; glyph
++)
19042 glyph
[-n
] = *glyph
;
19045 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19046 and ROW->maxpos. */
19048 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19049 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19050 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19052 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19053 lines' rows is implemented for bidi-reordered rows. */
19055 /* ROW->minpos is the value of min_pos, the minimal buffer position
19056 we have in ROW, or ROW->start.pos if that is smaller. */
19057 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19058 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19060 /* We didn't find buffer positions smaller than ROW->start, or
19061 didn't find _any_ valid buffer positions in any of the glyphs,
19062 so we must trust the iterator's computed positions. */
19063 row
->minpos
= row
->start
.pos
;
19066 max_pos
= CHARPOS (it
->current
.pos
);
19067 max_bpos
= BYTEPOS (it
->current
.pos
);
19070 /* Here are the various use-cases for ending the row, and the
19071 corresponding values for ROW->maxpos:
19073 Line ends in a newline from buffer eol_pos + 1
19074 Line is continued from buffer max_pos + 1
19075 Line is truncated on right it->current.pos
19076 Line ends in a newline from string max_pos + 1(*)
19077 (*) + 1 only when line ends in a forward scan
19078 Line is continued from string max_pos
19079 Line is continued from display vector max_pos
19080 Line is entirely from a string min_pos == max_pos
19081 Line is entirely from a display vector min_pos == max_pos
19082 Line that ends at ZV ZV
19084 If you discover other use-cases, please add them here as
19086 if (row
->ends_at_zv_p
)
19087 row
->maxpos
= it
->current
.pos
;
19088 else if (row
->used
[TEXT_AREA
])
19090 int seen_this_string
= 0;
19091 struct glyph_row
*r1
= row
- 1;
19093 /* Did we see the same display string on the previous row? */
19094 if (STRINGP (it
->object
)
19095 /* this is not the first row */
19096 && row
> it
->w
->desired_matrix
->rows
19097 /* previous row is not the header line */
19098 && !r1
->mode_line_p
19099 /* previous row also ends in a newline from a string */
19100 && r1
->ends_in_newline_from_string_p
)
19102 struct glyph
*start
, *end
;
19104 /* Search for the last glyph of the previous row that came
19105 from buffer or string. Depending on whether the row is
19106 L2R or R2L, we need to process it front to back or the
19107 other way round. */
19108 if (!r1
->reversed_p
)
19110 start
= r1
->glyphs
[TEXT_AREA
];
19111 end
= start
+ r1
->used
[TEXT_AREA
];
19112 /* Glyphs inserted by redisplay have an integer (zero)
19113 as their object. */
19115 && INTEGERP ((end
- 1)->object
)
19116 && (end
- 1)->charpos
<= 0)
19120 if (EQ ((end
- 1)->object
, it
->object
))
19121 seen_this_string
= 1;
19124 /* If all the glyphs of the previous row were inserted
19125 by redisplay, it means the previous row was
19126 produced from a single newline, which is only
19127 possible if that newline came from the same string
19128 as the one which produced this ROW. */
19129 seen_this_string
= 1;
19133 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19134 start
= end
+ r1
->used
[TEXT_AREA
];
19136 && INTEGERP ((end
+ 1)->object
)
19137 && (end
+ 1)->charpos
<= 0)
19141 if (EQ ((end
+ 1)->object
, it
->object
))
19142 seen_this_string
= 1;
19145 seen_this_string
= 1;
19148 /* Take note of each display string that covers a newline only
19149 once, the first time we see it. This is for when a display
19150 string includes more than one newline in it. */
19151 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19153 /* If we were scanning the buffer forward when we displayed
19154 the string, we want to account for at least one buffer
19155 position that belongs to this row (position covered by
19156 the display string), so that cursor positioning will
19157 consider this row as a candidate when point is at the end
19158 of the visual line represented by this row. This is not
19159 required when scanning back, because max_pos will already
19160 have a much larger value. */
19161 if (CHARPOS (row
->end
.pos
) > max_pos
)
19162 INC_BOTH (max_pos
, max_bpos
);
19163 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19165 else if (CHARPOS (it
->eol_pos
) > 0)
19166 SET_TEXT_POS (row
->maxpos
,
19167 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19168 else if (row
->continued_p
)
19170 /* If max_pos is different from IT's current position, it
19171 means IT->method does not belong to the display element
19172 at max_pos. However, it also means that the display
19173 element at max_pos was displayed in its entirety on this
19174 line, which is equivalent to saying that the next line
19175 starts at the next buffer position. */
19176 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19177 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19180 INC_BOTH (max_pos
, max_bpos
);
19181 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19184 else if (row
->truncated_on_right_p
)
19185 /* display_line already called reseat_at_next_visible_line_start,
19186 which puts the iterator at the beginning of the next line, in
19187 the logical order. */
19188 row
->maxpos
= it
->current
.pos
;
19189 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19190 /* A line that is entirely from a string/image/stretch... */
19191 row
->maxpos
= row
->minpos
;
19196 row
->maxpos
= it
->current
.pos
;
19199 /* Construct the glyph row IT->glyph_row in the desired matrix of
19200 IT->w from text at the current position of IT. See dispextern.h
19201 for an overview of struct it. Value is non-zero if
19202 IT->glyph_row displays text, as opposed to a line displaying ZV
19206 display_line (struct it
*it
)
19208 struct glyph_row
*row
= it
->glyph_row
;
19209 Lisp_Object overlay_arrow_string
;
19211 void *wrap_data
= NULL
;
19212 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19213 int wrap_row_used
= -1;
19214 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19215 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19216 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19217 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19218 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19220 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19221 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19223 /* We always start displaying at hpos zero even if hscrolled. */
19224 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19226 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19227 >= it
->w
->desired_matrix
->nrows
)
19229 it
->w
->nrows_scale_factor
++;
19230 fonts_changed_p
= 1;
19234 /* Is IT->w showing the region? */
19235 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
19237 /* Clear the result glyph row and enable it. */
19238 prepare_desired_row (row
);
19240 row
->y
= it
->current_y
;
19241 row
->start
= it
->start
;
19242 row
->continuation_lines_width
= it
->continuation_lines_width
;
19243 row
->displays_text_p
= 1;
19244 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19245 it
->starts_in_middle_of_char_p
= 0;
19247 /* Arrange the overlays nicely for our purposes. Usually, we call
19248 display_line on only one line at a time, in which case this
19249 can't really hurt too much, or we call it on lines which appear
19250 one after another in the buffer, in which case all calls to
19251 recenter_overlay_lists but the first will be pretty cheap. */
19252 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19254 /* Move over display elements that are not visible because we are
19255 hscrolled. This may stop at an x-position < IT->first_visible_x
19256 if the first glyph is partially visible or if we hit a line end. */
19257 if (it
->current_x
< it
->first_visible_x
)
19259 enum move_it_result move_result
;
19261 this_line_min_pos
= row
->start
.pos
;
19262 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19263 MOVE_TO_POS
| MOVE_TO_X
);
19264 /* If we are under a large hscroll, move_it_in_display_line_to
19265 could hit the end of the line without reaching
19266 it->first_visible_x. Pretend that we did reach it. This is
19267 especially important on a TTY, where we will call
19268 extend_face_to_end_of_line, which needs to know how many
19269 blank glyphs to produce. */
19270 if (it
->current_x
< it
->first_visible_x
19271 && (move_result
== MOVE_NEWLINE_OR_CR
19272 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19273 it
->current_x
= it
->first_visible_x
;
19275 /* Record the smallest positions seen while we moved over
19276 display elements that are not visible. This is needed by
19277 redisplay_internal for optimizing the case where the cursor
19278 stays inside the same line. The rest of this function only
19279 considers positions that are actually displayed, so
19280 RECORD_MAX_MIN_POS will not otherwise record positions that
19281 are hscrolled to the left of the left edge of the window. */
19282 min_pos
= CHARPOS (this_line_min_pos
);
19283 min_bpos
= BYTEPOS (this_line_min_pos
);
19287 /* We only do this when not calling `move_it_in_display_line_to'
19288 above, because move_it_in_display_line_to calls
19289 handle_line_prefix itself. */
19290 handle_line_prefix (it
);
19293 /* Get the initial row height. This is either the height of the
19294 text hscrolled, if there is any, or zero. */
19295 row
->ascent
= it
->max_ascent
;
19296 row
->height
= it
->max_ascent
+ it
->max_descent
;
19297 row
->phys_ascent
= it
->max_phys_ascent
;
19298 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19299 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19301 /* Utility macro to record max and min buffer positions seen until now. */
19302 #define RECORD_MAX_MIN_POS(IT) \
19305 int composition_p = !STRINGP ((IT)->string) \
19306 && ((IT)->what == IT_COMPOSITION); \
19307 ptrdiff_t current_pos = \
19308 composition_p ? (IT)->cmp_it.charpos \
19309 : IT_CHARPOS (*(IT)); \
19310 ptrdiff_t current_bpos = \
19311 composition_p ? CHAR_TO_BYTE (current_pos) \
19312 : IT_BYTEPOS (*(IT)); \
19313 if (current_pos < min_pos) \
19315 min_pos = current_pos; \
19316 min_bpos = current_bpos; \
19318 if (IT_CHARPOS (*it) > max_pos) \
19320 max_pos = IT_CHARPOS (*it); \
19321 max_bpos = IT_BYTEPOS (*it); \
19326 /* Loop generating characters. The loop is left with IT on the next
19327 character to display. */
19330 int n_glyphs_before
, hpos_before
, x_before
;
19332 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19334 /* Retrieve the next thing to display. Value is zero if end of
19336 if (!get_next_display_element (it
))
19338 /* Maybe add a space at the end of this line that is used to
19339 display the cursor there under X. Set the charpos of the
19340 first glyph of blank lines not corresponding to any text
19342 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19343 row
->exact_window_width_line_p
= 1;
19344 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19345 || row
->used
[TEXT_AREA
] == 0)
19347 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19348 row
->displays_text_p
= 0;
19350 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19351 && (!MINI_WINDOW_P (it
->w
)
19352 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19353 row
->indicate_empty_line_p
= 1;
19356 it
->continuation_lines_width
= 0;
19357 row
->ends_at_zv_p
= 1;
19358 /* A row that displays right-to-left text must always have
19359 its last face extended all the way to the end of line,
19360 even if this row ends in ZV, because we still write to
19361 the screen left to right. We also need to extend the
19362 last face if the default face is remapped to some
19363 different face, otherwise the functions that clear
19364 portions of the screen will clear with the default face's
19365 background color. */
19366 if (row
->reversed_p
19367 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19368 extend_face_to_end_of_line (it
);
19372 /* Now, get the metrics of what we want to display. This also
19373 generates glyphs in `row' (which is IT->glyph_row). */
19374 n_glyphs_before
= row
->used
[TEXT_AREA
];
19377 /* Remember the line height so far in case the next element doesn't
19378 fit on the line. */
19379 if (it
->line_wrap
!= TRUNCATE
)
19381 ascent
= it
->max_ascent
;
19382 descent
= it
->max_descent
;
19383 phys_ascent
= it
->max_phys_ascent
;
19384 phys_descent
= it
->max_phys_descent
;
19386 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19388 if (IT_DISPLAYING_WHITESPACE (it
))
19392 SAVE_IT (wrap_it
, *it
, wrap_data
);
19394 wrap_row_used
= row
->used
[TEXT_AREA
];
19395 wrap_row_ascent
= row
->ascent
;
19396 wrap_row_height
= row
->height
;
19397 wrap_row_phys_ascent
= row
->phys_ascent
;
19398 wrap_row_phys_height
= row
->phys_height
;
19399 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19400 wrap_row_min_pos
= min_pos
;
19401 wrap_row_min_bpos
= min_bpos
;
19402 wrap_row_max_pos
= max_pos
;
19403 wrap_row_max_bpos
= max_bpos
;
19409 PRODUCE_GLYPHS (it
);
19411 /* If this display element was in marginal areas, continue with
19413 if (it
->area
!= TEXT_AREA
)
19415 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19416 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19417 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19418 row
->phys_height
= max (row
->phys_height
,
19419 it
->max_phys_ascent
+ it
->max_phys_descent
);
19420 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19421 it
->max_extra_line_spacing
);
19422 set_iterator_to_next (it
, 1);
19426 /* Does the display element fit on the line? If we truncate
19427 lines, we should draw past the right edge of the window. If
19428 we don't truncate, we want to stop so that we can display the
19429 continuation glyph before the right margin. If lines are
19430 continued, there are two possible strategies for characters
19431 resulting in more than 1 glyph (e.g. tabs): Display as many
19432 glyphs as possible in this line and leave the rest for the
19433 continuation line, or display the whole element in the next
19434 line. Original redisplay did the former, so we do it also. */
19435 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19436 hpos_before
= it
->hpos
;
19439 if (/* Not a newline. */
19441 /* Glyphs produced fit entirely in the line. */
19442 && it
->current_x
< it
->last_visible_x
)
19444 it
->hpos
+= nglyphs
;
19445 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19446 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19447 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19448 row
->phys_height
= max (row
->phys_height
,
19449 it
->max_phys_ascent
+ it
->max_phys_descent
);
19450 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19451 it
->max_extra_line_spacing
);
19452 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19453 row
->x
= x
- it
->first_visible_x
;
19454 /* Record the maximum and minimum buffer positions seen so
19455 far in glyphs that will be displayed by this row. */
19457 RECORD_MAX_MIN_POS (it
);
19462 struct glyph
*glyph
;
19464 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19466 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19467 new_x
= x
+ glyph
->pixel_width
;
19469 if (/* Lines are continued. */
19470 it
->line_wrap
!= TRUNCATE
19471 && (/* Glyph doesn't fit on the line. */
19472 new_x
> it
->last_visible_x
19473 /* Or it fits exactly on a window system frame. */
19474 || (new_x
== it
->last_visible_x
19475 && FRAME_WINDOW_P (it
->f
)
19476 && (row
->reversed_p
19477 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19478 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19480 /* End of a continued line. */
19483 || (new_x
== it
->last_visible_x
19484 && FRAME_WINDOW_P (it
->f
)
19485 && (row
->reversed_p
19486 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19487 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19489 /* Current glyph is the only one on the line or
19490 fits exactly on the line. We must continue
19491 the line because we can't draw the cursor
19492 after the glyph. */
19493 row
->continued_p
= 1;
19494 it
->current_x
= new_x
;
19495 it
->continuation_lines_width
+= new_x
;
19497 if (i
== nglyphs
- 1)
19499 /* If line-wrap is on, check if a previous
19500 wrap point was found. */
19501 if (wrap_row_used
> 0
19502 /* Even if there is a previous wrap
19503 point, continue the line here as
19504 usual, if (i) the previous character
19505 was a space or tab AND (ii) the
19506 current character is not. */
19508 || IT_DISPLAYING_WHITESPACE (it
)))
19511 /* Record the maximum and minimum buffer
19512 positions seen so far in glyphs that will be
19513 displayed by this row. */
19515 RECORD_MAX_MIN_POS (it
);
19516 set_iterator_to_next (it
, 1);
19517 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19519 if (!get_next_display_element (it
))
19521 row
->exact_window_width_line_p
= 1;
19522 it
->continuation_lines_width
= 0;
19523 row
->continued_p
= 0;
19524 row
->ends_at_zv_p
= 1;
19526 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19528 row
->continued_p
= 0;
19529 row
->exact_window_width_line_p
= 1;
19533 else if (it
->bidi_p
)
19534 RECORD_MAX_MIN_POS (it
);
19536 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19537 && !FRAME_WINDOW_P (it
->f
))
19539 /* A padding glyph that doesn't fit on this line.
19540 This means the whole character doesn't fit
19542 if (row
->reversed_p
)
19543 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19544 - n_glyphs_before
);
19545 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19547 /* Fill the rest of the row with continuation
19548 glyphs like in 20.x. */
19549 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19550 < row
->glyphs
[1 + TEXT_AREA
])
19551 produce_special_glyphs (it
, IT_CONTINUATION
);
19553 row
->continued_p
= 1;
19554 it
->current_x
= x_before
;
19555 it
->continuation_lines_width
+= x_before
;
19557 /* Restore the height to what it was before the
19558 element not fitting on the line. */
19559 it
->max_ascent
= ascent
;
19560 it
->max_descent
= descent
;
19561 it
->max_phys_ascent
= phys_ascent
;
19562 it
->max_phys_descent
= phys_descent
;
19564 else if (wrap_row_used
> 0)
19567 if (row
->reversed_p
)
19568 unproduce_glyphs (it
,
19569 row
->used
[TEXT_AREA
] - wrap_row_used
);
19570 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19571 it
->continuation_lines_width
+= wrap_x
;
19572 row
->used
[TEXT_AREA
] = wrap_row_used
;
19573 row
->ascent
= wrap_row_ascent
;
19574 row
->height
= wrap_row_height
;
19575 row
->phys_ascent
= wrap_row_phys_ascent
;
19576 row
->phys_height
= wrap_row_phys_height
;
19577 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19578 min_pos
= wrap_row_min_pos
;
19579 min_bpos
= wrap_row_min_bpos
;
19580 max_pos
= wrap_row_max_pos
;
19581 max_bpos
= wrap_row_max_bpos
;
19582 row
->continued_p
= 1;
19583 row
->ends_at_zv_p
= 0;
19584 row
->exact_window_width_line_p
= 0;
19585 it
->continuation_lines_width
+= x
;
19587 /* Make sure that a non-default face is extended
19588 up to the right margin of the window. */
19589 extend_face_to_end_of_line (it
);
19591 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19593 /* A TAB that extends past the right edge of the
19594 window. This produces a single glyph on
19595 window system frames. We leave the glyph in
19596 this row and let it fill the row, but don't
19597 consume the TAB. */
19598 if ((row
->reversed_p
19599 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19600 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19601 produce_special_glyphs (it
, IT_CONTINUATION
);
19602 it
->continuation_lines_width
+= it
->last_visible_x
;
19603 row
->ends_in_middle_of_char_p
= 1;
19604 row
->continued_p
= 1;
19605 glyph
->pixel_width
= it
->last_visible_x
- x
;
19606 it
->starts_in_middle_of_char_p
= 1;
19610 /* Something other than a TAB that draws past
19611 the right edge of the window. Restore
19612 positions to values before the element. */
19613 if (row
->reversed_p
)
19614 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19615 - (n_glyphs_before
+ i
));
19616 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19618 /* Display continuation glyphs. */
19619 it
->current_x
= x_before
;
19620 it
->continuation_lines_width
+= x
;
19621 if (!FRAME_WINDOW_P (it
->f
)
19622 || (row
->reversed_p
19623 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19624 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19625 produce_special_glyphs (it
, IT_CONTINUATION
);
19626 row
->continued_p
= 1;
19628 extend_face_to_end_of_line (it
);
19630 if (nglyphs
> 1 && i
> 0)
19632 row
->ends_in_middle_of_char_p
= 1;
19633 it
->starts_in_middle_of_char_p
= 1;
19636 /* Restore the height to what it was before the
19637 element not fitting on the line. */
19638 it
->max_ascent
= ascent
;
19639 it
->max_descent
= descent
;
19640 it
->max_phys_ascent
= phys_ascent
;
19641 it
->max_phys_descent
= phys_descent
;
19646 else if (new_x
> it
->first_visible_x
)
19648 /* Increment number of glyphs actually displayed. */
19651 /* Record the maximum and minimum buffer positions
19652 seen so far in glyphs that will be displayed by
19655 RECORD_MAX_MIN_POS (it
);
19657 if (x
< it
->first_visible_x
)
19658 /* Glyph is partially visible, i.e. row starts at
19659 negative X position. */
19660 row
->x
= x
- it
->first_visible_x
;
19664 /* Glyph is completely off the left margin of the
19665 window. This should not happen because of the
19666 move_it_in_display_line at the start of this
19667 function, unless the text display area of the
19668 window is empty. */
19669 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19672 /* Even if this display element produced no glyphs at all,
19673 we want to record its position. */
19674 if (it
->bidi_p
&& nglyphs
== 0)
19675 RECORD_MAX_MIN_POS (it
);
19677 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19678 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19679 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19680 row
->phys_height
= max (row
->phys_height
,
19681 it
->max_phys_ascent
+ it
->max_phys_descent
);
19682 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19683 it
->max_extra_line_spacing
);
19685 /* End of this display line if row is continued. */
19686 if (row
->continued_p
|| row
->ends_at_zv_p
)
19691 /* Is this a line end? If yes, we're also done, after making
19692 sure that a non-default face is extended up to the right
19693 margin of the window. */
19694 if (ITERATOR_AT_END_OF_LINE_P (it
))
19696 int used_before
= row
->used
[TEXT_AREA
];
19698 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19700 /* Add a space at the end of the line that is used to
19701 display the cursor there. */
19702 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19703 append_space_for_newline (it
, 0);
19705 /* Extend the face to the end of the line. */
19706 extend_face_to_end_of_line (it
);
19708 /* Make sure we have the position. */
19709 if (used_before
== 0)
19710 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19712 /* Record the position of the newline, for use in
19714 it
->eol_pos
= it
->current
.pos
;
19716 /* Consume the line end. This skips over invisible lines. */
19717 set_iterator_to_next (it
, 1);
19718 it
->continuation_lines_width
= 0;
19722 /* Proceed with next display element. Note that this skips
19723 over lines invisible because of selective display. */
19724 set_iterator_to_next (it
, 1);
19726 /* If we truncate lines, we are done when the last displayed
19727 glyphs reach past the right margin of the window. */
19728 if (it
->line_wrap
== TRUNCATE
19729 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19730 ? (it
->current_x
>= it
->last_visible_x
)
19731 : (it
->current_x
> it
->last_visible_x
)))
19733 /* Maybe add truncation glyphs. */
19734 if (!FRAME_WINDOW_P (it
->f
)
19735 || (row
->reversed_p
19736 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19737 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19741 if (!row
->reversed_p
)
19743 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19744 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19749 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19750 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19752 /* Remove any padding glyphs at the front of ROW, to
19753 make room for the truncation glyphs we will be
19754 adding below. The loop below always inserts at
19755 least one truncation glyph, so also remove the
19756 last glyph added to ROW. */
19757 unproduce_glyphs (it
, i
+ 1);
19758 /* Adjust i for the loop below. */
19759 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19762 it
->current_x
= x_before
;
19763 if (!FRAME_WINDOW_P (it
->f
))
19765 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19767 row
->used
[TEXT_AREA
] = i
;
19768 produce_special_glyphs (it
, IT_TRUNCATION
);
19773 row
->used
[TEXT_AREA
] = i
;
19774 produce_special_glyphs (it
, IT_TRUNCATION
);
19777 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19779 /* Don't truncate if we can overflow newline into fringe. */
19780 if (!get_next_display_element (it
))
19782 it
->continuation_lines_width
= 0;
19783 row
->ends_at_zv_p
= 1;
19784 row
->exact_window_width_line_p
= 1;
19787 if (ITERATOR_AT_END_OF_LINE_P (it
))
19789 row
->exact_window_width_line_p
= 1;
19790 goto at_end_of_line
;
19792 it
->current_x
= x_before
;
19795 row
->truncated_on_right_p
= 1;
19796 it
->continuation_lines_width
= 0;
19797 reseat_at_next_visible_line_start (it
, 0);
19798 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19799 it
->hpos
= hpos_before
;
19805 bidi_unshelve_cache (wrap_data
, 1);
19807 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19808 at the left window margin. */
19809 if (it
->first_visible_x
19810 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19812 if (!FRAME_WINDOW_P (it
->f
)
19813 || (row
->reversed_p
19814 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19815 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19816 insert_left_trunc_glyphs (it
);
19817 row
->truncated_on_left_p
= 1;
19820 /* Remember the position at which this line ends.
19822 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19823 cannot be before the call to find_row_edges below, since that is
19824 where these positions are determined. */
19825 row
->end
= it
->current
;
19828 row
->minpos
= row
->start
.pos
;
19829 row
->maxpos
= row
->end
.pos
;
19833 /* ROW->minpos and ROW->maxpos must be the smallest and
19834 `1 + the largest' buffer positions in ROW. But if ROW was
19835 bidi-reordered, these two positions can be anywhere in the
19836 row, so we must determine them now. */
19837 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19840 /* If the start of this line is the overlay arrow-position, then
19841 mark this glyph row as the one containing the overlay arrow.
19842 This is clearly a mess with variable size fonts. It would be
19843 better to let it be displayed like cursors under X. */
19844 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19845 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19846 !NILP (overlay_arrow_string
)))
19848 /* Overlay arrow in window redisplay is a fringe bitmap. */
19849 if (STRINGP (overlay_arrow_string
))
19851 struct glyph_row
*arrow_row
19852 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19853 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19854 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19855 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19856 struct glyph
*p2
, *end
;
19858 /* Copy the arrow glyphs. */
19859 while (glyph
< arrow_end
)
19862 /* Throw away padding glyphs. */
19864 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19865 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19871 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19876 eassert (INTEGERP (overlay_arrow_string
));
19877 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19879 overlay_arrow_seen
= 1;
19882 /* Highlight trailing whitespace. */
19883 if (!NILP (Vshow_trailing_whitespace
))
19884 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19886 /* Compute pixel dimensions of this line. */
19887 compute_line_metrics (it
);
19889 /* Implementation note: No changes in the glyphs of ROW or in their
19890 faces can be done past this point, because compute_line_metrics
19891 computes ROW's hash value and stores it within the glyph_row
19894 /* Record whether this row ends inside an ellipsis. */
19895 row
->ends_in_ellipsis_p
19896 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19897 && it
->ellipsis_p
);
19899 /* Save fringe bitmaps in this row. */
19900 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19901 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19902 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19903 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19905 it
->left_user_fringe_bitmap
= 0;
19906 it
->left_user_fringe_face_id
= 0;
19907 it
->right_user_fringe_bitmap
= 0;
19908 it
->right_user_fringe_face_id
= 0;
19910 /* Maybe set the cursor. */
19911 cvpos
= it
->w
->cursor
.vpos
;
19913 /* In bidi-reordered rows, keep checking for proper cursor
19914 position even if one has been found already, because buffer
19915 positions in such rows change non-linearly with ROW->VPOS,
19916 when a line is continued. One exception: when we are at ZV,
19917 display cursor on the first suitable glyph row, since all
19918 the empty rows after that also have their position set to ZV. */
19919 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19920 lines' rows is implemented for bidi-reordered rows. */
19922 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19923 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19924 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19925 && cursor_row_p (row
))
19926 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19928 /* Prepare for the next line. This line starts horizontally at (X
19929 HPOS) = (0 0). Vertical positions are incremented. As a
19930 convenience for the caller, IT->glyph_row is set to the next
19932 it
->current_x
= it
->hpos
= 0;
19933 it
->current_y
+= row
->height
;
19934 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19937 /* The next row should by default use the same value of the
19938 reversed_p flag as this one. set_iterator_to_next decides when
19939 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19940 the flag accordingly. */
19941 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19942 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19943 it
->start
= row
->end
;
19944 return row
->displays_text_p
;
19946 #undef RECORD_MAX_MIN_POS
19949 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19950 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19951 doc
: /* Return paragraph direction at point in BUFFER.
19952 Value is either `left-to-right' or `right-to-left'.
19953 If BUFFER is omitted or nil, it defaults to the current buffer.
19955 Paragraph direction determines how the text in the paragraph is displayed.
19956 In left-to-right paragraphs, text begins at the left margin of the window
19957 and the reading direction is generally left to right. In right-to-left
19958 paragraphs, text begins at the right margin and is read from right to left.
19960 See also `bidi-paragraph-direction'. */)
19961 (Lisp_Object buffer
)
19963 struct buffer
*buf
= current_buffer
;
19964 struct buffer
*old
= buf
;
19966 if (! NILP (buffer
))
19968 CHECK_BUFFER (buffer
);
19969 buf
= XBUFFER (buffer
);
19972 if (NILP (BVAR (buf
, bidi_display_reordering
))
19973 || NILP (BVAR (buf
, enable_multibyte_characters
))
19974 /* When we are loading loadup.el, the character property tables
19975 needed for bidi iteration are not yet available. */
19976 || !NILP (Vpurify_flag
))
19977 return Qleft_to_right
;
19978 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19979 return BVAR (buf
, bidi_paragraph_direction
);
19982 /* Determine the direction from buffer text. We could try to
19983 use current_matrix if it is up to date, but this seems fast
19984 enough as it is. */
19985 struct bidi_it itb
;
19986 ptrdiff_t pos
= BUF_PT (buf
);
19987 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19989 void *itb_data
= bidi_shelve_cache ();
19991 set_buffer_temp (buf
);
19992 /* bidi_paragraph_init finds the base direction of the paragraph
19993 by searching forward from paragraph start. We need the base
19994 direction of the current or _previous_ paragraph, so we need
19995 to make sure we are within that paragraph. To that end, find
19996 the previous non-empty line. */
19997 if (pos
>= ZV
&& pos
> BEGV
)
20000 bytepos
= CHAR_TO_BYTE (pos
);
20002 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20003 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20005 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20006 || c
== ' ' || c
== '\t' || c
== '\f')
20008 if (bytepos
<= BEGV_BYTE
)
20013 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20016 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20017 itb
.paragraph_dir
= NEUTRAL_DIR
;
20018 itb
.string
.s
= NULL
;
20019 itb
.string
.lstring
= Qnil
;
20020 itb
.string
.bufpos
= 0;
20021 itb
.string
.unibyte
= 0;
20022 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20023 bidi_unshelve_cache (itb_data
, 0);
20024 set_buffer_temp (old
);
20025 switch (itb
.paragraph_dir
)
20028 return Qleft_to_right
;
20031 return Qright_to_left
;
20041 /***********************************************************************
20043 ***********************************************************************/
20045 /* Redisplay the menu bar in the frame for window W.
20047 The menu bar of X frames that don't have X toolkit support is
20048 displayed in a special window W->frame->menu_bar_window.
20050 The menu bar of terminal frames is treated specially as far as
20051 glyph matrices are concerned. Menu bar lines are not part of
20052 windows, so the update is done directly on the frame matrix rows
20053 for the menu bar. */
20056 display_menu_bar (struct window
*w
)
20058 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20063 /* Don't do all this for graphical frames. */
20065 if (FRAME_W32_P (f
))
20068 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20074 if (FRAME_NS_P (f
))
20076 #endif /* HAVE_NS */
20078 #ifdef USE_X_TOOLKIT
20079 eassert (!FRAME_WINDOW_P (f
));
20080 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20081 it
.first_visible_x
= 0;
20082 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20083 #else /* not USE_X_TOOLKIT */
20084 if (FRAME_WINDOW_P (f
))
20086 /* Menu bar lines are displayed in the desired matrix of the
20087 dummy window menu_bar_window. */
20088 struct window
*menu_w
;
20089 eassert (WINDOWP (f
->menu_bar_window
));
20090 menu_w
= XWINDOW (f
->menu_bar_window
);
20091 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20093 it
.first_visible_x
= 0;
20094 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20098 /* This is a TTY frame, i.e. character hpos/vpos are used as
20100 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20102 it
.first_visible_x
= 0;
20103 it
.last_visible_x
= FRAME_COLS (f
);
20105 #endif /* not USE_X_TOOLKIT */
20107 /* FIXME: This should be controlled by a user option. See the
20108 comments in redisplay_tool_bar and display_mode_line about
20110 it
.paragraph_embedding
= L2R
;
20112 if (! mode_line_inverse_video
)
20113 /* Force the menu-bar to be displayed in the default face. */
20114 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20116 /* Clear all rows of the menu bar. */
20117 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20119 struct glyph_row
*row
= it
.glyph_row
+ i
;
20120 clear_glyph_row (row
);
20121 row
->enabled_p
= 1;
20122 row
->full_width_p
= 1;
20125 /* Display all items of the menu bar. */
20126 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20127 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20129 Lisp_Object string
;
20131 /* Stop at nil string. */
20132 string
= AREF (items
, i
+ 1);
20136 /* Remember where item was displayed. */
20137 ASET (items
, i
+ 3, make_number (it
.hpos
));
20139 /* Display the item, pad with one space. */
20140 if (it
.current_x
< it
.last_visible_x
)
20141 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20142 SCHARS (string
) + 1, 0, 0, -1);
20145 /* Fill out the line with spaces. */
20146 if (it
.current_x
< it
.last_visible_x
)
20147 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20149 /* Compute the total height of the lines. */
20150 compute_line_metrics (&it
);
20155 /***********************************************************************
20157 ***********************************************************************/
20159 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20160 FORCE is non-zero, redisplay mode lines unconditionally.
20161 Otherwise, redisplay only mode lines that are garbaged. Value is
20162 the number of windows whose mode lines were redisplayed. */
20165 redisplay_mode_lines (Lisp_Object window
, int force
)
20169 while (!NILP (window
))
20171 struct window
*w
= XWINDOW (window
);
20173 if (WINDOWP (w
->hchild
))
20174 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20175 else if (WINDOWP (w
->vchild
))
20176 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20178 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20179 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20181 struct text_pos lpoint
;
20182 struct buffer
*old
= current_buffer
;
20184 /* Set the window's buffer for the mode line display. */
20185 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20186 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20188 /* Point refers normally to the selected window. For any
20189 other window, set up appropriate value. */
20190 if (!EQ (window
, selected_window
))
20192 struct text_pos pt
;
20194 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20195 if (CHARPOS (pt
) < BEGV
)
20196 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20197 else if (CHARPOS (pt
) > (ZV
- 1))
20198 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20200 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20203 /* Display mode lines. */
20204 clear_glyph_matrix (w
->desired_matrix
);
20205 if (display_mode_lines (w
))
20208 w
->must_be_updated_p
= 1;
20211 /* Restore old settings. */
20212 set_buffer_internal_1 (old
);
20213 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20223 /* Display the mode and/or header line of window W. Value is the
20224 sum number of mode lines and header lines displayed. */
20227 display_mode_lines (struct window
*w
)
20229 Lisp_Object old_selected_window
, old_selected_frame
;
20232 old_selected_frame
= selected_frame
;
20233 selected_frame
= w
->frame
;
20234 old_selected_window
= selected_window
;
20235 XSETWINDOW (selected_window
, w
);
20237 /* These will be set while the mode line specs are processed. */
20238 line_number_displayed
= 0;
20239 w
->column_number_displayed
= Qnil
;
20241 if (WINDOW_WANTS_MODELINE_P (w
))
20243 struct window
*sel_w
= XWINDOW (old_selected_window
);
20245 /* Select mode line face based on the real selected window. */
20246 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20247 BVAR (current_buffer
, mode_line_format
));
20251 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20253 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20254 BVAR (current_buffer
, header_line_format
));
20258 selected_frame
= old_selected_frame
;
20259 selected_window
= old_selected_window
;
20264 /* Display mode or header line of window W. FACE_ID specifies which
20265 line to display; it is either MODE_LINE_FACE_ID or
20266 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20267 display. Value is the pixel height of the mode/header line
20271 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20275 ptrdiff_t count
= SPECPDL_INDEX ();
20277 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20278 /* Don't extend on a previously drawn mode-line.
20279 This may happen if called from pos_visible_p. */
20280 it
.glyph_row
->enabled_p
= 0;
20281 prepare_desired_row (it
.glyph_row
);
20283 it
.glyph_row
->mode_line_p
= 1;
20285 if (! mode_line_inverse_video
)
20286 /* Force the mode-line to be displayed in the default face. */
20287 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20289 /* FIXME: This should be controlled by a user option. But
20290 supporting such an option is not trivial, since the mode line is
20291 made up of many separate strings. */
20292 it
.paragraph_embedding
= L2R
;
20294 record_unwind_protect (unwind_format_mode_line
,
20295 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20297 mode_line_target
= MODE_LINE_DISPLAY
;
20299 /* Temporarily make frame's keyboard the current kboard so that
20300 kboard-local variables in the mode_line_format will get the right
20302 push_kboard (FRAME_KBOARD (it
.f
));
20303 record_unwind_save_match_data ();
20304 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20307 unbind_to (count
, Qnil
);
20309 /* Fill up with spaces. */
20310 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20312 compute_line_metrics (&it
);
20313 it
.glyph_row
->full_width_p
= 1;
20314 it
.glyph_row
->continued_p
= 0;
20315 it
.glyph_row
->truncated_on_left_p
= 0;
20316 it
.glyph_row
->truncated_on_right_p
= 0;
20318 /* Make a 3D mode-line have a shadow at its right end. */
20319 face
= FACE_FROM_ID (it
.f
, face_id
);
20320 extend_face_to_end_of_line (&it
);
20321 if (face
->box
!= FACE_NO_BOX
)
20323 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20324 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20325 last
->right_box_line_p
= 1;
20328 return it
.glyph_row
->height
;
20331 /* Move element ELT in LIST to the front of LIST.
20332 Return the updated list. */
20335 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20337 register Lisp_Object tail
, prev
;
20338 register Lisp_Object tem
;
20342 while (CONSP (tail
))
20348 /* Splice out the link TAIL. */
20350 list
= XCDR (tail
);
20352 Fsetcdr (prev
, XCDR (tail
));
20354 /* Now make it the first. */
20355 Fsetcdr (tail
, list
);
20360 tail
= XCDR (tail
);
20364 /* Not found--return unchanged LIST. */
20368 /* Contribute ELT to the mode line for window IT->w. How it
20369 translates into text depends on its data type.
20371 IT describes the display environment in which we display, as usual.
20373 DEPTH is the depth in recursion. It is used to prevent
20374 infinite recursion here.
20376 FIELD_WIDTH is the number of characters the display of ELT should
20377 occupy in the mode line, and PRECISION is the maximum number of
20378 characters to display from ELT's representation. See
20379 display_string for details.
20381 Returns the hpos of the end of the text generated by ELT.
20383 PROPS is a property list to add to any string we encounter.
20385 If RISKY is nonzero, remove (disregard) any properties in any string
20386 we encounter, and ignore :eval and :propertize.
20388 The global variable `mode_line_target' determines whether the
20389 output is passed to `store_mode_line_noprop',
20390 `store_mode_line_string', or `display_string'. */
20393 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20394 Lisp_Object elt
, Lisp_Object props
, int risky
)
20396 int n
= 0, field
, prec
;
20401 elt
= build_string ("*too-deep*");
20405 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20409 /* A string: output it and check for %-constructs within it. */
20411 ptrdiff_t offset
= 0;
20413 if (SCHARS (elt
) > 0
20414 && (!NILP (props
) || risky
))
20416 Lisp_Object oprops
, aelt
;
20417 oprops
= Ftext_properties_at (make_number (0), elt
);
20419 /* If the starting string's properties are not what
20420 we want, translate the string. Also, if the string
20421 is risky, do that anyway. */
20423 if (NILP (Fequal (props
, oprops
)) || risky
)
20425 /* If the starting string has properties,
20426 merge the specified ones onto the existing ones. */
20427 if (! NILP (oprops
) && !risky
)
20431 oprops
= Fcopy_sequence (oprops
);
20433 while (CONSP (tem
))
20435 oprops
= Fplist_put (oprops
, XCAR (tem
),
20436 XCAR (XCDR (tem
)));
20437 tem
= XCDR (XCDR (tem
));
20442 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20443 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20445 /* AELT is what we want. Move it to the front
20446 without consing. */
20448 mode_line_proptrans_alist
20449 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20455 /* If AELT has the wrong props, it is useless.
20456 so get rid of it. */
20458 mode_line_proptrans_alist
20459 = Fdelq (aelt
, mode_line_proptrans_alist
);
20461 elt
= Fcopy_sequence (elt
);
20462 Fset_text_properties (make_number (0), Flength (elt
),
20464 /* Add this item to mode_line_proptrans_alist. */
20465 mode_line_proptrans_alist
20466 = Fcons (Fcons (elt
, props
),
20467 mode_line_proptrans_alist
);
20468 /* Truncate mode_line_proptrans_alist
20469 to at most 50 elements. */
20470 tem
= Fnthcdr (make_number (50),
20471 mode_line_proptrans_alist
);
20473 XSETCDR (tem
, Qnil
);
20482 prec
= precision
- n
;
20483 switch (mode_line_target
)
20485 case MODE_LINE_NOPROP
:
20486 case MODE_LINE_TITLE
:
20487 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20489 case MODE_LINE_STRING
:
20490 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20492 case MODE_LINE_DISPLAY
:
20493 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20494 0, prec
, 0, STRING_MULTIBYTE (elt
));
20501 /* Handle the non-literal case. */
20503 while ((precision
<= 0 || n
< precision
)
20504 && SREF (elt
, offset
) != 0
20505 && (mode_line_target
!= MODE_LINE_DISPLAY
20506 || it
->current_x
< it
->last_visible_x
))
20508 ptrdiff_t last_offset
= offset
;
20510 /* Advance to end of string or next format specifier. */
20511 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20514 if (offset
- 1 != last_offset
)
20516 ptrdiff_t nchars
, nbytes
;
20518 /* Output to end of string or up to '%'. Field width
20519 is length of string. Don't output more than
20520 PRECISION allows us. */
20523 prec
= c_string_width (SDATA (elt
) + last_offset
,
20524 offset
- last_offset
, precision
- n
,
20527 switch (mode_line_target
)
20529 case MODE_LINE_NOPROP
:
20530 case MODE_LINE_TITLE
:
20531 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20533 case MODE_LINE_STRING
:
20535 ptrdiff_t bytepos
= last_offset
;
20536 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20537 ptrdiff_t endpos
= (precision
<= 0
20538 ? string_byte_to_char (elt
, offset
)
20539 : charpos
+ nchars
);
20541 n
+= store_mode_line_string (NULL
,
20542 Fsubstring (elt
, make_number (charpos
),
20543 make_number (endpos
)),
20547 case MODE_LINE_DISPLAY
:
20549 ptrdiff_t bytepos
= last_offset
;
20550 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20552 if (precision
<= 0)
20553 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20554 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20556 STRING_MULTIBYTE (elt
));
20561 else /* c == '%' */
20563 ptrdiff_t percent_position
= offset
;
20565 /* Get the specified minimum width. Zero means
20568 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20569 field
= field
* 10 + c
- '0';
20571 /* Don't pad beyond the total padding allowed. */
20572 if (field_width
- n
> 0 && field
> field_width
- n
)
20573 field
= field_width
- n
;
20575 /* Note that either PRECISION <= 0 or N < PRECISION. */
20576 prec
= precision
- n
;
20579 n
+= display_mode_element (it
, depth
, field
, prec
,
20580 Vglobal_mode_string
, props
,
20585 ptrdiff_t bytepos
, charpos
;
20587 Lisp_Object string
;
20589 bytepos
= percent_position
;
20590 charpos
= (STRING_MULTIBYTE (elt
)
20591 ? string_byte_to_char (elt
, bytepos
)
20593 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20594 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20596 switch (mode_line_target
)
20598 case MODE_LINE_NOPROP
:
20599 case MODE_LINE_TITLE
:
20600 n
+= store_mode_line_noprop (spec
, field
, prec
);
20602 case MODE_LINE_STRING
:
20604 Lisp_Object tem
= build_string (spec
);
20605 props
= Ftext_properties_at (make_number (charpos
), elt
);
20606 /* Should only keep face property in props */
20607 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20610 case MODE_LINE_DISPLAY
:
20612 int nglyphs_before
, nwritten
;
20614 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20615 nwritten
= display_string (spec
, string
, elt
,
20620 /* Assign to the glyphs written above the
20621 string where the `%x' came from, position
20625 struct glyph
*glyph
20626 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20630 for (i
= 0; i
< nwritten
; ++i
)
20632 glyph
[i
].object
= elt
;
20633 glyph
[i
].charpos
= charpos
;
20650 /* A symbol: process the value of the symbol recursively
20651 as if it appeared here directly. Avoid error if symbol void.
20652 Special case: if value of symbol is a string, output the string
20655 register Lisp_Object tem
;
20657 /* If the variable is not marked as risky to set
20658 then its contents are risky to use. */
20659 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20662 tem
= Fboundp (elt
);
20665 tem
= Fsymbol_value (elt
);
20666 /* If value is a string, output that string literally:
20667 don't check for % within it. */
20671 if (!EQ (tem
, elt
))
20673 /* Give up right away for nil or t. */
20683 register Lisp_Object car
, tem
;
20685 /* A cons cell: five distinct cases.
20686 If first element is :eval or :propertize, do something special.
20687 If first element is a string or a cons, process all the elements
20688 and effectively concatenate them.
20689 If first element is a negative number, truncate displaying cdr to
20690 at most that many characters. If positive, pad (with spaces)
20691 to at least that many characters.
20692 If first element is a symbol, process the cadr or caddr recursively
20693 according to whether the symbol's value is non-nil or nil. */
20695 if (EQ (car
, QCeval
))
20697 /* An element of the form (:eval FORM) means evaluate FORM
20698 and use the result as mode line elements. */
20703 if (CONSP (XCDR (elt
)))
20706 spec
= safe_eval (XCAR (XCDR (elt
)));
20707 n
+= display_mode_element (it
, depth
, field_width
- n
,
20708 precision
- n
, spec
, props
,
20712 else if (EQ (car
, QCpropertize
))
20714 /* An element of the form (:propertize ELT PROPS...)
20715 means display ELT but applying properties PROPS. */
20720 if (CONSP (XCDR (elt
)))
20721 n
+= display_mode_element (it
, depth
, field_width
- n
,
20722 precision
- n
, XCAR (XCDR (elt
)),
20723 XCDR (XCDR (elt
)), risky
);
20725 else if (SYMBOLP (car
))
20727 tem
= Fboundp (car
);
20731 /* elt is now the cdr, and we know it is a cons cell.
20732 Use its car if CAR has a non-nil value. */
20735 tem
= Fsymbol_value (car
);
20742 /* Symbol's value is nil (or symbol is unbound)
20743 Get the cddr of the original list
20744 and if possible find the caddr and use that. */
20748 else if (!CONSP (elt
))
20753 else if (INTEGERP (car
))
20755 register int lim
= XINT (car
);
20759 /* Negative int means reduce maximum width. */
20760 if (precision
<= 0)
20763 precision
= min (precision
, -lim
);
20767 /* Padding specified. Don't let it be more than
20768 current maximum. */
20770 lim
= min (precision
, lim
);
20772 /* If that's more padding than already wanted, queue it.
20773 But don't reduce padding already specified even if
20774 that is beyond the current truncation point. */
20775 field_width
= max (lim
, field_width
);
20779 else if (STRINGP (car
) || CONSP (car
))
20781 Lisp_Object halftail
= elt
;
20785 && (precision
<= 0 || n
< precision
))
20787 n
+= display_mode_element (it
, depth
,
20788 /* Do padding only after the last
20789 element in the list. */
20790 (! CONSP (XCDR (elt
))
20793 precision
- n
, XCAR (elt
),
20797 if ((len
& 1) == 0)
20798 halftail
= XCDR (halftail
);
20799 /* Check for cycle. */
20800 if (EQ (halftail
, elt
))
20809 elt
= build_string ("*invalid*");
20813 /* Pad to FIELD_WIDTH. */
20814 if (field_width
> 0 && n
< field_width
)
20816 switch (mode_line_target
)
20818 case MODE_LINE_NOPROP
:
20819 case MODE_LINE_TITLE
:
20820 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20822 case MODE_LINE_STRING
:
20823 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20825 case MODE_LINE_DISPLAY
:
20826 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20835 /* Store a mode-line string element in mode_line_string_list.
20837 If STRING is non-null, display that C string. Otherwise, the Lisp
20838 string LISP_STRING is displayed.
20840 FIELD_WIDTH is the minimum number of output glyphs to produce.
20841 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20842 with spaces. FIELD_WIDTH <= 0 means don't pad.
20844 PRECISION is the maximum number of characters to output from
20845 STRING. PRECISION <= 0 means don't truncate the string.
20847 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20848 properties to the string.
20850 PROPS are the properties to add to the string.
20851 The mode_line_string_face face property is always added to the string.
20855 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20856 int field_width
, int precision
, Lisp_Object props
)
20861 if (string
!= NULL
)
20863 len
= strlen (string
);
20864 if (precision
> 0 && len
> precision
)
20866 lisp_string
= make_string (string
, len
);
20868 props
= mode_line_string_face_prop
;
20869 else if (!NILP (mode_line_string_face
))
20871 Lisp_Object face
= Fplist_get (props
, Qface
);
20872 props
= Fcopy_sequence (props
);
20874 face
= mode_line_string_face
;
20876 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20877 props
= Fplist_put (props
, Qface
, face
);
20879 Fadd_text_properties (make_number (0), make_number (len
),
20880 props
, lisp_string
);
20884 len
= XFASTINT (Flength (lisp_string
));
20885 if (precision
> 0 && len
> precision
)
20888 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20891 if (!NILP (mode_line_string_face
))
20895 props
= Ftext_properties_at (make_number (0), lisp_string
);
20896 face
= Fplist_get (props
, Qface
);
20898 face
= mode_line_string_face
;
20900 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20901 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20903 lisp_string
= Fcopy_sequence (lisp_string
);
20906 Fadd_text_properties (make_number (0), make_number (len
),
20907 props
, lisp_string
);
20912 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20916 if (field_width
> len
)
20918 field_width
-= len
;
20919 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20921 Fadd_text_properties (make_number (0), make_number (field_width
),
20922 props
, lisp_string
);
20923 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20931 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20933 doc
: /* Format a string out of a mode line format specification.
20934 First arg FORMAT specifies the mode line format (see `mode-line-format'
20935 for details) to use.
20937 By default, the format is evaluated for the currently selected window.
20939 Optional second arg FACE specifies the face property to put on all
20940 characters for which no face is specified. The value nil means the
20941 default face. The value t means whatever face the window's mode line
20942 currently uses (either `mode-line' or `mode-line-inactive',
20943 depending on whether the window is the selected window or not).
20944 An integer value means the value string has no text
20947 Optional third and fourth args WINDOW and BUFFER specify the window
20948 and buffer to use as the context for the formatting (defaults
20949 are the selected window and the WINDOW's buffer). */)
20950 (Lisp_Object format
, Lisp_Object face
,
20951 Lisp_Object window
, Lisp_Object buffer
)
20956 struct buffer
*old_buffer
= NULL
;
20958 int no_props
= INTEGERP (face
);
20959 ptrdiff_t count
= SPECPDL_INDEX ();
20961 int string_start
= 0;
20964 window
= selected_window
;
20965 CHECK_WINDOW (window
);
20966 w
= XWINDOW (window
);
20969 buffer
= w
->buffer
;
20970 CHECK_BUFFER (buffer
);
20972 /* Make formatting the modeline a non-op when noninteractive, otherwise
20973 there will be problems later caused by a partially initialized frame. */
20974 if (NILP (format
) || noninteractive
)
20975 return empty_unibyte_string
;
20980 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20981 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20982 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20983 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20984 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20985 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20986 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20989 if (XBUFFER (buffer
) != current_buffer
)
20990 old_buffer
= current_buffer
;
20992 /* Save things including mode_line_proptrans_alist,
20993 and set that to nil so that we don't alter the outer value. */
20994 record_unwind_protect (unwind_format_mode_line
,
20995 format_mode_line_unwind_data
20996 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
20997 old_buffer
, selected_window
, 1));
20998 mode_line_proptrans_alist
= Qnil
;
21000 Fselect_window (window
, Qt
);
21002 set_buffer_internal_1 (XBUFFER (buffer
));
21004 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21008 mode_line_target
= MODE_LINE_NOPROP
;
21009 mode_line_string_face_prop
= Qnil
;
21010 mode_line_string_list
= Qnil
;
21011 string_start
= MODE_LINE_NOPROP_LEN (0);
21015 mode_line_target
= MODE_LINE_STRING
;
21016 mode_line_string_list
= Qnil
;
21017 mode_line_string_face
= face
;
21018 mode_line_string_face_prop
21019 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21022 push_kboard (FRAME_KBOARD (it
.f
));
21023 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21028 len
= MODE_LINE_NOPROP_LEN (string_start
);
21029 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21033 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21034 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21035 empty_unibyte_string
);
21038 unbind_to (count
, Qnil
);
21042 /* Write a null-terminated, right justified decimal representation of
21043 the positive integer D to BUF using a minimal field width WIDTH. */
21046 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21048 register char *p
= buf
;
21056 *p
++ = d
% 10 + '0';
21061 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21072 /* Write a null-terminated, right justified decimal and "human
21073 readable" representation of the nonnegative integer D to BUF using
21074 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21076 static const char power_letter
[] =
21090 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21092 /* We aim to represent the nonnegative integer D as
21093 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21094 ptrdiff_t quotient
= d
;
21096 /* -1 means: do not use TENTHS. */
21100 /* Length of QUOTIENT.TENTHS as a string. */
21106 if (1000 <= quotient
)
21108 /* Scale to the appropriate EXPONENT. */
21111 remainder
= quotient
% 1000;
21115 while (1000 <= quotient
);
21117 /* Round to nearest and decide whether to use TENTHS or not. */
21120 tenths
= remainder
/ 100;
21121 if (50 <= remainder
% 100)
21128 if (quotient
== 10)
21136 if (500 <= remainder
)
21138 if (quotient
< 999)
21149 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21150 if (tenths
== -1 && quotient
<= 99)
21157 p
= psuffix
= buf
+ max (width
, length
);
21159 /* Print EXPONENT. */
21160 *psuffix
++ = power_letter
[exponent
];
21163 /* Print TENTHS. */
21166 *--p
= '0' + tenths
;
21170 /* Print QUOTIENT. */
21173 int digit
= quotient
% 10;
21174 *--p
= '0' + digit
;
21176 while ((quotient
/= 10) != 0);
21178 /* Print leading spaces. */
21183 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21184 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21185 type of CODING_SYSTEM. Return updated pointer into BUF. */
21187 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21190 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21193 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21194 const unsigned char *eol_str
;
21196 /* The EOL conversion we are using. */
21197 Lisp_Object eoltype
;
21199 val
= CODING_SYSTEM_SPEC (coding_system
);
21202 if (!VECTORP (val
)) /* Not yet decided. */
21204 *buf
++ = multibyte
? '-' : ' ';
21206 eoltype
= eol_mnemonic_undecided
;
21207 /* Don't mention EOL conversion if it isn't decided. */
21212 Lisp_Object eolvalue
;
21214 attrs
= AREF (val
, 0);
21215 eolvalue
= AREF (val
, 2);
21218 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21223 /* The EOL conversion that is normal on this system. */
21225 if (NILP (eolvalue
)) /* Not yet decided. */
21226 eoltype
= eol_mnemonic_undecided
;
21227 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21228 eoltype
= eol_mnemonic_undecided
;
21229 else /* eolvalue is Qunix, Qdos, or Qmac. */
21230 eoltype
= (EQ (eolvalue
, Qunix
)
21231 ? eol_mnemonic_unix
21232 : (EQ (eolvalue
, Qdos
) == 1
21233 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21239 /* Mention the EOL conversion if it is not the usual one. */
21240 if (STRINGP (eoltype
))
21242 eol_str
= SDATA (eoltype
);
21243 eol_str_len
= SBYTES (eoltype
);
21245 else if (CHARACTERP (eoltype
))
21247 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21248 int c
= XFASTINT (eoltype
);
21249 eol_str_len
= CHAR_STRING (c
, tmp
);
21254 eol_str
= invalid_eol_type
;
21255 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21257 memcpy (buf
, eol_str
, eol_str_len
);
21258 buf
+= eol_str_len
;
21264 /* Return a string for the output of a mode line %-spec for window W,
21265 generated by character C. FIELD_WIDTH > 0 means pad the string
21266 returned with spaces to that value. Return a Lisp string in
21267 *STRING if the resulting string is taken from that Lisp string.
21269 Note we operate on the current buffer for most purposes,
21270 the exception being w->base_line_pos. */
21272 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21274 static const char *
21275 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21276 Lisp_Object
*string
)
21279 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21280 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21281 struct buffer
*b
= current_buffer
;
21289 if (!NILP (BVAR (b
, read_only
)))
21291 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21296 /* This differs from %* only for a modified read-only buffer. */
21297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21299 if (!NILP (BVAR (b
, read_only
)))
21304 /* This differs from %* in ignoring read-only-ness. */
21305 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21317 if (command_loop_level
> 5)
21319 p
= decode_mode_spec_buf
;
21320 for (i
= 0; i
< command_loop_level
; i
++)
21323 return decode_mode_spec_buf
;
21331 if (command_loop_level
> 5)
21333 p
= decode_mode_spec_buf
;
21334 for (i
= 0; i
< command_loop_level
; i
++)
21337 return decode_mode_spec_buf
;
21344 /* Let lots_of_dashes be a string of infinite length. */
21345 if (mode_line_target
== MODE_LINE_NOPROP
||
21346 mode_line_target
== MODE_LINE_STRING
)
21348 if (field_width
<= 0
21349 || field_width
> sizeof (lots_of_dashes
))
21351 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21352 decode_mode_spec_buf
[i
] = '-';
21353 decode_mode_spec_buf
[i
] = '\0';
21354 return decode_mode_spec_buf
;
21357 return lots_of_dashes
;
21361 obj
= BVAR (b
, name
);
21365 /* %c and %l are ignored in `frame-title-format'.
21366 (In redisplay_internal, the frame title is drawn _before_ the
21367 windows are updated, so the stuff which depends on actual
21368 window contents (such as %l) may fail to render properly, or
21369 even crash emacs.) */
21370 if (mode_line_target
== MODE_LINE_TITLE
)
21374 ptrdiff_t col
= current_column ();
21375 w
->column_number_displayed
= make_number (col
);
21376 pint2str (decode_mode_spec_buf
, field_width
, col
);
21377 return decode_mode_spec_buf
;
21381 #ifndef SYSTEM_MALLOC
21383 if (NILP (Vmemory_full
))
21386 return "!MEM FULL! ";
21393 /* %F displays the frame name. */
21394 if (!NILP (f
->title
))
21395 return SSDATA (f
->title
);
21396 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21397 return SSDATA (f
->name
);
21401 obj
= BVAR (b
, filename
);
21406 ptrdiff_t size
= ZV
- BEGV
;
21407 pint2str (decode_mode_spec_buf
, field_width
, size
);
21408 return decode_mode_spec_buf
;
21413 ptrdiff_t size
= ZV
- BEGV
;
21414 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21415 return decode_mode_spec_buf
;
21420 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21421 ptrdiff_t topline
, nlines
, height
;
21424 /* %c and %l are ignored in `frame-title-format'. */
21425 if (mode_line_target
== MODE_LINE_TITLE
)
21428 startpos
= XMARKER (w
->start
)->charpos
;
21429 startpos_byte
= marker_byte_position (w
->start
);
21430 height
= WINDOW_TOTAL_LINES (w
);
21432 /* If we decided that this buffer isn't suitable for line numbers,
21433 don't forget that too fast. */
21434 if (EQ (w
->base_line_pos
, w
->buffer
))
21436 /* But do forget it, if the window shows a different buffer now. */
21437 else if (BUFFERP (w
->base_line_pos
))
21438 w
->base_line_pos
= Qnil
;
21440 /* If the buffer is very big, don't waste time. */
21441 if (INTEGERP (Vline_number_display_limit
)
21442 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21444 w
->base_line_pos
= Qnil
;
21445 w
->base_line_number
= Qnil
;
21449 if (INTEGERP (w
->base_line_number
)
21450 && INTEGERP (w
->base_line_pos
)
21451 && XFASTINT (w
->base_line_pos
) <= startpos
)
21453 line
= XFASTINT (w
->base_line_number
);
21454 linepos
= XFASTINT (w
->base_line_pos
);
21455 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21460 linepos
= BUF_BEGV (b
);
21461 linepos_byte
= BUF_BEGV_BYTE (b
);
21464 /* Count lines from base line to window start position. */
21465 nlines
= display_count_lines (linepos_byte
,
21469 topline
= nlines
+ line
;
21471 /* Determine a new base line, if the old one is too close
21472 or too far away, or if we did not have one.
21473 "Too close" means it's plausible a scroll-down would
21474 go back past it. */
21475 if (startpos
== BUF_BEGV (b
))
21477 w
->base_line_number
= make_number (topline
);
21478 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21480 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21481 || linepos
== BUF_BEGV (b
))
21483 ptrdiff_t limit
= BUF_BEGV (b
);
21484 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21485 ptrdiff_t position
;
21486 ptrdiff_t distance
=
21487 (height
* 2 + 30) * line_number_display_limit_width
;
21489 if (startpos
- distance
> limit
)
21491 limit
= startpos
- distance
;
21492 limit_byte
= CHAR_TO_BYTE (limit
);
21495 nlines
= display_count_lines (startpos_byte
,
21497 - (height
* 2 + 30),
21499 /* If we couldn't find the lines we wanted within
21500 line_number_display_limit_width chars per line,
21501 give up on line numbers for this window. */
21502 if (position
== limit_byte
&& limit
== startpos
- distance
)
21504 w
->base_line_pos
= w
->buffer
;
21505 w
->base_line_number
= Qnil
;
21509 w
->base_line_number
= make_number (topline
- nlines
);
21510 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21513 /* Now count lines from the start pos to point. */
21514 nlines
= display_count_lines (startpos_byte
,
21515 PT_BYTE
, PT
, &junk
);
21517 /* Record that we did display the line number. */
21518 line_number_displayed
= 1;
21520 /* Make the string to show. */
21521 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21522 return decode_mode_spec_buf
;
21525 char* p
= decode_mode_spec_buf
;
21526 int pad
= field_width
- 2;
21532 return decode_mode_spec_buf
;
21538 obj
= BVAR (b
, mode_name
);
21542 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21548 ptrdiff_t pos
= marker_position (w
->start
);
21549 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21551 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21553 if (pos
<= BUF_BEGV (b
))
21558 else if (pos
<= BUF_BEGV (b
))
21562 if (total
> 1000000)
21563 /* Do it differently for a large value, to avoid overflow. */
21564 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21566 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21567 /* We can't normally display a 3-digit number,
21568 so get us a 2-digit number that is close. */
21571 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21572 return decode_mode_spec_buf
;
21576 /* Display percentage of size above the bottom of the screen. */
21579 ptrdiff_t toppos
= marker_position (w
->start
);
21580 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21581 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21583 if (botpos
>= BUF_ZV (b
))
21585 if (toppos
<= BUF_BEGV (b
))
21592 if (total
> 1000000)
21593 /* Do it differently for a large value, to avoid overflow. */
21594 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21596 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21597 /* We can't normally display a 3-digit number,
21598 so get us a 2-digit number that is close. */
21601 if (toppos
<= BUF_BEGV (b
))
21602 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21604 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21605 return decode_mode_spec_buf
;
21610 /* status of process */
21611 obj
= Fget_buffer_process (Fcurrent_buffer ());
21613 return "no process";
21615 obj
= Fsymbol_name (Fprocess_status (obj
));
21621 ptrdiff_t count
= inhibit_garbage_collection ();
21622 Lisp_Object val
= call1 (intern ("file-remote-p"),
21623 BVAR (current_buffer
, directory
));
21624 unbind_to (count
, Qnil
);
21632 case 't': /* indicate TEXT or BINARY */
21636 /* coding-system (not including end-of-line format) */
21638 /* coding-system (including end-of-line type) */
21640 int eol_flag
= (c
== 'Z');
21641 char *p
= decode_mode_spec_buf
;
21643 if (! FRAME_WINDOW_P (f
))
21645 /* No need to mention EOL here--the terminal never needs
21646 to do EOL conversion. */
21647 p
= decode_mode_spec_coding (CODING_ID_NAME
21648 (FRAME_KEYBOARD_CODING (f
)->id
),
21650 p
= decode_mode_spec_coding (CODING_ID_NAME
21651 (FRAME_TERMINAL_CODING (f
)->id
),
21654 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21657 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21658 #ifdef subprocesses
21659 obj
= Fget_buffer_process (Fcurrent_buffer ());
21660 if (PROCESSP (obj
))
21662 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21664 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21667 #endif /* subprocesses */
21670 return decode_mode_spec_buf
;
21677 return SSDATA (obj
);
21684 /* Count up to COUNT lines starting from START_BYTE.
21685 But don't go beyond LIMIT_BYTE.
21686 Return the number of lines thus found (always nonnegative).
21688 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21691 display_count_lines (ptrdiff_t start_byte
,
21692 ptrdiff_t limit_byte
, ptrdiff_t count
,
21693 ptrdiff_t *byte_pos_ptr
)
21695 register unsigned char *cursor
;
21696 unsigned char *base
;
21698 register ptrdiff_t ceiling
;
21699 register unsigned char *ceiling_addr
;
21700 ptrdiff_t orig_count
= count
;
21702 /* If we are not in selective display mode,
21703 check only for newlines. */
21704 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21705 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21709 while (start_byte
< limit_byte
)
21711 ceiling
= BUFFER_CEILING_OF (start_byte
);
21712 ceiling
= min (limit_byte
- 1, ceiling
);
21713 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21714 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21717 if (selective_display
)
21718 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21721 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21724 if (cursor
!= ceiling_addr
)
21728 start_byte
+= cursor
- base
+ 1;
21729 *byte_pos_ptr
= start_byte
;
21733 if (++cursor
== ceiling_addr
)
21739 start_byte
+= cursor
- base
;
21744 while (start_byte
> limit_byte
)
21746 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21747 ceiling
= max (limit_byte
, ceiling
);
21748 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21749 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21752 if (selective_display
)
21753 while (--cursor
!= ceiling_addr
21754 && *cursor
!= '\n' && *cursor
!= 015)
21757 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21760 if (cursor
!= ceiling_addr
)
21764 start_byte
+= cursor
- base
+ 1;
21765 *byte_pos_ptr
= start_byte
;
21766 /* When scanning backwards, we should
21767 not count the newline posterior to which we stop. */
21768 return - orig_count
- 1;
21774 /* Here we add 1 to compensate for the last decrement
21775 of CURSOR, which took it past the valid range. */
21776 start_byte
+= cursor
- base
+ 1;
21780 *byte_pos_ptr
= limit_byte
;
21783 return - orig_count
+ count
;
21784 return orig_count
- count
;
21790 /***********************************************************************
21792 ***********************************************************************/
21794 /* Display a NUL-terminated string, starting with index START.
21796 If STRING is non-null, display that C string. Otherwise, the Lisp
21797 string LISP_STRING is displayed. There's a case that STRING is
21798 non-null and LISP_STRING is not nil. It means STRING is a string
21799 data of LISP_STRING. In that case, we display LISP_STRING while
21800 ignoring its text properties.
21802 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21803 FACE_STRING. Display STRING or LISP_STRING with the face at
21804 FACE_STRING_POS in FACE_STRING:
21806 Display the string in the environment given by IT, but use the
21807 standard display table, temporarily.
21809 FIELD_WIDTH is the minimum number of output glyphs to produce.
21810 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21811 with spaces. If STRING has more characters, more than FIELD_WIDTH
21812 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21814 PRECISION is the maximum number of characters to output from
21815 STRING. PRECISION < 0 means don't truncate the string.
21817 This is roughly equivalent to printf format specifiers:
21819 FIELD_WIDTH PRECISION PRINTF
21820 ----------------------------------------
21826 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21827 display them, and < 0 means obey the current buffer's value of
21828 enable_multibyte_characters.
21830 Value is the number of columns displayed. */
21833 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21834 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21835 int field_width
, int precision
, int max_x
, int multibyte
)
21837 int hpos_at_start
= it
->hpos
;
21838 int saved_face_id
= it
->face_id
;
21839 struct glyph_row
*row
= it
->glyph_row
;
21840 ptrdiff_t it_charpos
;
21842 /* Initialize the iterator IT for iteration over STRING beginning
21843 with index START. */
21844 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21845 precision
, field_width
, multibyte
);
21846 if (string
&& STRINGP (lisp_string
))
21847 /* LISP_STRING is the one returned by decode_mode_spec. We should
21848 ignore its text properties. */
21849 it
->stop_charpos
= it
->end_charpos
;
21851 /* If displaying STRING, set up the face of the iterator from
21852 FACE_STRING, if that's given. */
21853 if (STRINGP (face_string
))
21859 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21860 0, it
->region_beg_charpos
,
21861 it
->region_end_charpos
,
21862 &endptr
, it
->base_face_id
, 0);
21863 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21864 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21867 /* Set max_x to the maximum allowed X position. Don't let it go
21868 beyond the right edge of the window. */
21870 max_x
= it
->last_visible_x
;
21872 max_x
= min (max_x
, it
->last_visible_x
);
21874 /* Skip over display elements that are not visible. because IT->w is
21876 if (it
->current_x
< it
->first_visible_x
)
21877 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21878 MOVE_TO_POS
| MOVE_TO_X
);
21880 row
->ascent
= it
->max_ascent
;
21881 row
->height
= it
->max_ascent
+ it
->max_descent
;
21882 row
->phys_ascent
= it
->max_phys_ascent
;
21883 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21884 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21886 if (STRINGP (it
->string
))
21887 it_charpos
= IT_STRING_CHARPOS (*it
);
21889 it_charpos
= IT_CHARPOS (*it
);
21891 /* This condition is for the case that we are called with current_x
21892 past last_visible_x. */
21893 while (it
->current_x
< max_x
)
21895 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21897 /* Get the next display element. */
21898 if (!get_next_display_element (it
))
21901 /* Produce glyphs. */
21902 x_before
= it
->current_x
;
21903 n_glyphs_before
= row
->used
[TEXT_AREA
];
21904 PRODUCE_GLYPHS (it
);
21906 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21909 while (i
< nglyphs
)
21911 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21913 if (it
->line_wrap
!= TRUNCATE
21914 && x
+ glyph
->pixel_width
> max_x
)
21916 /* End of continued line or max_x reached. */
21917 if (CHAR_GLYPH_PADDING_P (*glyph
))
21919 /* A wide character is unbreakable. */
21920 if (row
->reversed_p
)
21921 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21922 - n_glyphs_before
);
21923 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21924 it
->current_x
= x_before
;
21928 if (row
->reversed_p
)
21929 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21930 - (n_glyphs_before
+ i
));
21931 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21936 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21938 /* Glyph is at least partially visible. */
21940 if (x
< it
->first_visible_x
)
21941 row
->x
= x
- it
->first_visible_x
;
21945 /* Glyph is off the left margin of the display area.
21946 Should not happen. */
21950 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21951 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21952 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21953 row
->phys_height
= max (row
->phys_height
,
21954 it
->max_phys_ascent
+ it
->max_phys_descent
);
21955 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21956 it
->max_extra_line_spacing
);
21957 x
+= glyph
->pixel_width
;
21961 /* Stop if max_x reached. */
21965 /* Stop at line ends. */
21966 if (ITERATOR_AT_END_OF_LINE_P (it
))
21968 it
->continuation_lines_width
= 0;
21972 set_iterator_to_next (it
, 1);
21973 if (STRINGP (it
->string
))
21974 it_charpos
= IT_STRING_CHARPOS (*it
);
21976 it_charpos
= IT_CHARPOS (*it
);
21978 /* Stop if truncating at the right edge. */
21979 if (it
->line_wrap
== TRUNCATE
21980 && it
->current_x
>= it
->last_visible_x
)
21982 /* Add truncation mark, but don't do it if the line is
21983 truncated at a padding space. */
21984 if (it_charpos
< it
->string_nchars
)
21986 if (!FRAME_WINDOW_P (it
->f
))
21990 if (it
->current_x
> it
->last_visible_x
)
21992 if (!row
->reversed_p
)
21994 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21995 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22000 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22001 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22003 unproduce_glyphs (it
, ii
+ 1);
22004 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22006 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22008 row
->used
[TEXT_AREA
] = ii
;
22009 produce_special_glyphs (it
, IT_TRUNCATION
);
22012 produce_special_glyphs (it
, IT_TRUNCATION
);
22014 row
->truncated_on_right_p
= 1;
22020 /* Maybe insert a truncation at the left. */
22021 if (it
->first_visible_x
22024 if (!FRAME_WINDOW_P (it
->f
)
22025 || (row
->reversed_p
22026 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22027 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22028 insert_left_trunc_glyphs (it
);
22029 row
->truncated_on_left_p
= 1;
22032 it
->face_id
= saved_face_id
;
22034 /* Value is number of columns displayed. */
22035 return it
->hpos
- hpos_at_start
;
22040 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22041 appears as an element of LIST or as the car of an element of LIST.
22042 If PROPVAL is a list, compare each element against LIST in that
22043 way, and return 1/2 if any element of PROPVAL is found in LIST.
22044 Otherwise return 0. This function cannot quit.
22045 The return value is 2 if the text is invisible but with an ellipsis
22046 and 1 if it's invisible and without an ellipsis. */
22049 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22051 register Lisp_Object tail
, proptail
;
22053 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22055 register Lisp_Object tem
;
22057 if (EQ (propval
, tem
))
22059 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22060 return NILP (XCDR (tem
)) ? 1 : 2;
22063 if (CONSP (propval
))
22065 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22067 Lisp_Object propelt
;
22068 propelt
= XCAR (proptail
);
22069 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22071 register Lisp_Object tem
;
22073 if (EQ (propelt
, tem
))
22075 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22076 return NILP (XCDR (tem
)) ? 1 : 2;
22084 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22085 doc
: /* Non-nil if the property makes the text invisible.
22086 POS-OR-PROP can be a marker or number, in which case it is taken to be
22087 a position in the current buffer and the value of the `invisible' property
22088 is checked; or it can be some other value, which is then presumed to be the
22089 value of the `invisible' property of the text of interest.
22090 The non-nil value returned can be t for truly invisible text or something
22091 else if the text is replaced by an ellipsis. */)
22092 (Lisp_Object pos_or_prop
)
22095 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22096 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22098 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22099 return (invis
== 0 ? Qnil
22101 : make_number (invis
));
22104 /* Calculate a width or height in pixels from a specification using
22105 the following elements:
22108 NUM - a (fractional) multiple of the default font width/height
22109 (NUM) - specifies exactly NUM pixels
22110 UNIT - a fixed number of pixels, see below.
22111 ELEMENT - size of a display element in pixels, see below.
22112 (NUM . SPEC) - equals NUM * SPEC
22113 (+ SPEC SPEC ...) - add pixel values
22114 (- SPEC SPEC ...) - subtract pixel values
22115 (- SPEC) - negate pixel value
22118 INT or FLOAT - a number constant
22119 SYMBOL - use symbol's (buffer local) variable binding.
22122 in - pixels per inch *)
22123 mm - pixels per 1/1000 meter *)
22124 cm - pixels per 1/100 meter *)
22125 width - width of current font in pixels.
22126 height - height of current font in pixels.
22128 *) using the ratio(s) defined in display-pixels-per-inch.
22132 left-fringe - left fringe width in pixels
22133 right-fringe - right fringe width in pixels
22135 left-margin - left margin width in pixels
22136 right-margin - right margin width in pixels
22138 scroll-bar - scroll-bar area width in pixels
22142 Pixels corresponding to 5 inches:
22145 Total width of non-text areas on left side of window (if scroll-bar is on left):
22146 '(space :width (+ left-fringe left-margin scroll-bar))
22148 Align to first text column (in header line):
22149 '(space :align-to 0)
22151 Align to middle of text area minus half the width of variable `my-image'
22152 containing a loaded image:
22153 '(space :align-to (0.5 . (- text my-image)))
22155 Width of left margin minus width of 1 character in the default font:
22156 '(space :width (- left-margin 1))
22158 Width of left margin minus width of 2 characters in the current font:
22159 '(space :width (- left-margin (2 . width)))
22161 Center 1 character over left-margin (in header line):
22162 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22164 Different ways to express width of left fringe plus left margin minus one pixel:
22165 '(space :width (- (+ left-fringe left-margin) (1)))
22166 '(space :width (+ left-fringe left-margin (- (1))))
22167 '(space :width (+ left-fringe left-margin (-1)))
22171 #define NUMVAL(X) \
22172 ((INTEGERP (X) || FLOATP (X)) \
22177 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22178 struct font
*font
, int width_p
, int *align_to
)
22182 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22183 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22186 return OK_PIXELS (0);
22188 eassert (FRAME_LIVE_P (it
->f
));
22190 if (SYMBOLP (prop
))
22192 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22194 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22196 if (unit
[0] == 'i' && unit
[1] == 'n')
22198 else if (unit
[0] == 'm' && unit
[1] == 'm')
22200 else if (unit
[0] == 'c' && unit
[1] == 'm')
22207 #ifdef HAVE_WINDOW_SYSTEM
22208 if (FRAME_WINDOW_P (it
->f
)
22210 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22211 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22213 return OK_PIXELS (ppi
/ pixels
);
22216 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22217 || (CONSP (Vdisplay_pixels_per_inch
)
22219 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22220 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22222 return OK_PIXELS (ppi
/ pixels
);
22228 #ifdef HAVE_WINDOW_SYSTEM
22229 if (EQ (prop
, Qheight
))
22230 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22231 if (EQ (prop
, Qwidth
))
22232 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22234 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22235 return OK_PIXELS (1);
22238 if (EQ (prop
, Qtext
))
22239 return OK_PIXELS (width_p
22240 ? window_box_width (it
->w
, TEXT_AREA
)
22241 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22243 if (align_to
&& *align_to
< 0)
22246 if (EQ (prop
, Qleft
))
22247 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22248 if (EQ (prop
, Qright
))
22249 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22250 if (EQ (prop
, Qcenter
))
22251 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22252 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22253 if (EQ (prop
, Qleft_fringe
))
22254 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22255 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22256 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22257 if (EQ (prop
, Qright_fringe
))
22258 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22259 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22260 : window_box_right_offset (it
->w
, TEXT_AREA
));
22261 if (EQ (prop
, Qleft_margin
))
22262 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22263 if (EQ (prop
, Qright_margin
))
22264 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22265 if (EQ (prop
, Qscroll_bar
))
22266 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22268 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22269 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22270 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22275 if (EQ (prop
, Qleft_fringe
))
22276 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22277 if (EQ (prop
, Qright_fringe
))
22278 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22279 if (EQ (prop
, Qleft_margin
))
22280 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22281 if (EQ (prop
, Qright_margin
))
22282 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22283 if (EQ (prop
, Qscroll_bar
))
22284 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22287 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22288 if (EQ (prop
, Qunbound
))
22292 if (INTEGERP (prop
) || FLOATP (prop
))
22294 int base_unit
= (width_p
22295 ? FRAME_COLUMN_WIDTH (it
->f
)
22296 : FRAME_LINE_HEIGHT (it
->f
));
22297 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22302 Lisp_Object car
= XCAR (prop
);
22303 Lisp_Object cdr
= XCDR (prop
);
22307 #ifdef HAVE_WINDOW_SYSTEM
22308 if (FRAME_WINDOW_P (it
->f
)
22309 && valid_image_p (prop
))
22311 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22312 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22314 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22317 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22323 while (CONSP (cdr
))
22325 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22326 font
, width_p
, align_to
))
22329 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22334 if (EQ (car
, Qminus
))
22336 return OK_PIXELS (pixels
);
22339 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22340 if (EQ (car
, Qunbound
))
22344 if (INTEGERP (car
) || FLOATP (car
))
22347 pixels
= XFLOATINT (car
);
22349 return OK_PIXELS (pixels
);
22350 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22351 font
, width_p
, align_to
))
22352 return OK_PIXELS (pixels
* fact
);
22363 /***********************************************************************
22365 ***********************************************************************/
22367 #ifdef HAVE_WINDOW_SYSTEM
22372 dump_glyph_string (struct glyph_string
*s
)
22374 fprintf (stderr
, "glyph string\n");
22375 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22376 s
->x
, s
->y
, s
->width
, s
->height
);
22377 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22378 fprintf (stderr
, " hl = %d\n", s
->hl
);
22379 fprintf (stderr
, " left overhang = %d, right = %d\n",
22380 s
->left_overhang
, s
->right_overhang
);
22381 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22382 fprintf (stderr
, " extends to end of line = %d\n",
22383 s
->extends_to_end_of_line_p
);
22384 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22385 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22388 #endif /* GLYPH_DEBUG */
22390 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22391 of XChar2b structures for S; it can't be allocated in
22392 init_glyph_string because it must be allocated via `alloca'. W
22393 is the window on which S is drawn. ROW and AREA are the glyph row
22394 and area within the row from which S is constructed. START is the
22395 index of the first glyph structure covered by S. HL is a
22396 face-override for drawing S. */
22399 #define OPTIONAL_HDC(hdc) HDC hdc,
22400 #define DECLARE_HDC(hdc) HDC hdc;
22401 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22402 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22405 #ifndef OPTIONAL_HDC
22406 #define OPTIONAL_HDC(hdc)
22407 #define DECLARE_HDC(hdc)
22408 #define ALLOCATE_HDC(hdc, f)
22409 #define RELEASE_HDC(hdc, f)
22413 init_glyph_string (struct glyph_string
*s
,
22415 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22416 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22418 memset (s
, 0, sizeof *s
);
22420 s
->f
= XFRAME (w
->frame
);
22424 s
->display
= FRAME_X_DISPLAY (s
->f
);
22425 s
->window
= FRAME_X_WINDOW (s
->f
);
22426 s
->char2b
= char2b
;
22430 s
->first_glyph
= row
->glyphs
[area
] + start
;
22431 s
->height
= row
->height
;
22432 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22433 s
->ybase
= s
->y
+ row
->ascent
;
22437 /* Append the list of glyph strings with head H and tail T to the list
22438 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22441 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22442 struct glyph_string
*h
, struct glyph_string
*t
)
22456 /* Prepend the list of glyph strings with head H and tail T to the
22457 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22461 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22462 struct glyph_string
*h
, struct glyph_string
*t
)
22476 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22477 Set *HEAD and *TAIL to the resulting list. */
22480 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22481 struct glyph_string
*s
)
22483 s
->next
= s
->prev
= NULL
;
22484 append_glyph_string_lists (head
, tail
, s
, s
);
22488 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22489 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22490 make sure that X resources for the face returned are allocated.
22491 Value is a pointer to a realized face that is ready for display if
22492 DISPLAY_P is non-zero. */
22494 static inline struct face
*
22495 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22496 XChar2b
*char2b
, int display_p
)
22498 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22502 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22504 if (code
!= FONT_INVALID_CODE
)
22505 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22507 STORE_XCHAR2B (char2b
, 0, 0);
22510 /* Make sure X resources of the face are allocated. */
22511 #ifdef HAVE_X_WINDOWS
22515 eassert (face
!= NULL
);
22516 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22523 /* Get face and two-byte form of character glyph GLYPH on frame F.
22524 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22525 a pointer to a realized face that is ready for display. */
22527 static inline struct face
*
22528 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22529 XChar2b
*char2b
, int *two_byte_p
)
22533 eassert (glyph
->type
== CHAR_GLYPH
);
22534 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22543 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22544 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22546 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22548 if (code
!= FONT_INVALID_CODE
)
22549 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22551 STORE_XCHAR2B (char2b
, 0, 0);
22554 /* Make sure X resources of the face are allocated. */
22555 eassert (face
!= NULL
);
22556 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22561 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22562 Return 1 if FONT has a glyph for C, otherwise return 0. */
22565 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22569 if (CHAR_BYTE8_P (c
))
22570 code
= CHAR_TO_BYTE8 (c
);
22572 code
= font
->driver
->encode_char (font
, c
);
22574 if (code
== FONT_INVALID_CODE
)
22576 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22581 /* Fill glyph string S with composition components specified by S->cmp.
22583 BASE_FACE is the base face of the composition.
22584 S->cmp_from is the index of the first component for S.
22586 OVERLAPS non-zero means S should draw the foreground only, and use
22587 its physical height for clipping. See also draw_glyphs.
22589 Value is the index of a component not in S. */
22592 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22596 /* For all glyphs of this composition, starting at the offset
22597 S->cmp_from, until we reach the end of the definition or encounter a
22598 glyph that requires the different face, add it to S. */
22603 s
->for_overlaps
= overlaps
;
22606 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22608 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22610 /* TAB in a composition means display glyphs with padding space
22611 on the left or right. */
22614 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22617 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22624 s
->font
= s
->face
->font
;
22626 else if (s
->face
!= face
)
22634 if (s
->face
== NULL
)
22636 s
->face
= base_face
->ascii_face
;
22637 s
->font
= s
->face
->font
;
22640 /* All glyph strings for the same composition has the same width,
22641 i.e. the width set for the first component of the composition. */
22642 s
->width
= s
->first_glyph
->pixel_width
;
22644 /* If the specified font could not be loaded, use the frame's
22645 default font, but record the fact that we couldn't load it in
22646 the glyph string so that we can draw rectangles for the
22647 characters of the glyph string. */
22648 if (s
->font
== NULL
)
22650 s
->font_not_found_p
= 1;
22651 s
->font
= FRAME_FONT (s
->f
);
22654 /* Adjust base line for subscript/superscript text. */
22655 s
->ybase
+= s
->first_glyph
->voffset
;
22657 /* This glyph string must always be drawn with 16-bit functions. */
22664 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22665 int start
, int end
, int overlaps
)
22667 struct glyph
*glyph
, *last
;
22668 Lisp_Object lgstring
;
22671 s
->for_overlaps
= overlaps
;
22672 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22673 last
= s
->row
->glyphs
[s
->area
] + end
;
22674 s
->cmp_id
= glyph
->u
.cmp
.id
;
22675 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22676 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22677 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22678 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22679 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22681 while (glyph
< last
22682 && glyph
->u
.cmp
.automatic
22683 && glyph
->u
.cmp
.id
== s
->cmp_id
22684 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22685 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22687 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22689 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22690 unsigned code
= LGLYPH_CODE (lglyph
);
22692 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22694 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22695 return glyph
- s
->row
->glyphs
[s
->area
];
22699 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22700 See the comment of fill_glyph_string for arguments.
22701 Value is the index of the first glyph not in S. */
22705 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22706 int start
, int end
, int overlaps
)
22708 struct glyph
*glyph
, *last
;
22711 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22712 s
->for_overlaps
= overlaps
;
22713 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22714 last
= s
->row
->glyphs
[s
->area
] + end
;
22715 voffset
= glyph
->voffset
;
22716 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22717 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22719 s
->width
= glyph
->pixel_width
;
22721 while (glyph
< last
22722 && glyph
->type
== GLYPHLESS_GLYPH
22723 && glyph
->voffset
== voffset
22724 && glyph
->face_id
== face_id
)
22727 s
->width
+= glyph
->pixel_width
;
22730 s
->ybase
+= voffset
;
22731 return glyph
- s
->row
->glyphs
[s
->area
];
22735 /* Fill glyph string S from a sequence of character glyphs.
22737 FACE_ID is the face id of the string. START is the index of the
22738 first glyph to consider, END is the index of the last + 1.
22739 OVERLAPS non-zero means S should draw the foreground only, and use
22740 its physical height for clipping. See also draw_glyphs.
22742 Value is the index of the first glyph not in S. */
22745 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22746 int start
, int end
, int overlaps
)
22748 struct glyph
*glyph
, *last
;
22750 int glyph_not_available_p
;
22752 eassert (s
->f
== XFRAME (s
->w
->frame
));
22753 eassert (s
->nchars
== 0);
22754 eassert (start
>= 0 && end
> start
);
22756 s
->for_overlaps
= overlaps
;
22757 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22758 last
= s
->row
->glyphs
[s
->area
] + end
;
22759 voffset
= glyph
->voffset
;
22760 s
->padding_p
= glyph
->padding_p
;
22761 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22763 while (glyph
< last
22764 && glyph
->type
== CHAR_GLYPH
22765 && glyph
->voffset
== voffset
22766 /* Same face id implies same font, nowadays. */
22767 && glyph
->face_id
== face_id
22768 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22772 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22773 s
->char2b
+ s
->nchars
,
22775 s
->two_byte_p
= two_byte_p
;
22777 eassert (s
->nchars
<= end
- start
);
22778 s
->width
+= glyph
->pixel_width
;
22779 if (glyph
++->padding_p
!= s
->padding_p
)
22783 s
->font
= s
->face
->font
;
22785 /* If the specified font could not be loaded, use the frame's font,
22786 but record the fact that we couldn't load it in
22787 S->font_not_found_p so that we can draw rectangles for the
22788 characters of the glyph string. */
22789 if (s
->font
== NULL
|| glyph_not_available_p
)
22791 s
->font_not_found_p
= 1;
22792 s
->font
= FRAME_FONT (s
->f
);
22795 /* Adjust base line for subscript/superscript text. */
22796 s
->ybase
+= voffset
;
22798 eassert (s
->face
&& s
->face
->gc
);
22799 return glyph
- s
->row
->glyphs
[s
->area
];
22803 /* Fill glyph string S from image glyph S->first_glyph. */
22806 fill_image_glyph_string (struct glyph_string
*s
)
22808 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22809 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22811 s
->slice
= s
->first_glyph
->slice
.img
;
22812 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22813 s
->font
= s
->face
->font
;
22814 s
->width
= s
->first_glyph
->pixel_width
;
22816 /* Adjust base line for subscript/superscript text. */
22817 s
->ybase
+= s
->first_glyph
->voffset
;
22821 /* Fill glyph string S from a sequence of stretch glyphs.
22823 START is the index of the first glyph to consider,
22824 END is the index of the last + 1.
22826 Value is the index of the first glyph not in S. */
22829 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22831 struct glyph
*glyph
, *last
;
22832 int voffset
, face_id
;
22834 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22836 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22837 last
= s
->row
->glyphs
[s
->area
] + end
;
22838 face_id
= glyph
->face_id
;
22839 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22840 s
->font
= s
->face
->font
;
22841 s
->width
= glyph
->pixel_width
;
22843 voffset
= glyph
->voffset
;
22847 && glyph
->type
== STRETCH_GLYPH
22848 && glyph
->voffset
== voffset
22849 && glyph
->face_id
== face_id
);
22851 s
->width
+= glyph
->pixel_width
;
22853 /* Adjust base line for subscript/superscript text. */
22854 s
->ybase
+= voffset
;
22856 /* The case that face->gc == 0 is handled when drawing the glyph
22857 string by calling PREPARE_FACE_FOR_DISPLAY. */
22859 return glyph
- s
->row
->glyphs
[s
->area
];
22862 static struct font_metrics
*
22863 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22865 static struct font_metrics metrics
;
22866 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22868 if (! font
|| code
== FONT_INVALID_CODE
)
22870 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22875 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22876 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22877 assumed to be zero. */
22880 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22882 *left
= *right
= 0;
22884 if (glyph
->type
== CHAR_GLYPH
)
22888 struct font_metrics
*pcm
;
22890 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22891 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22893 if (pcm
->rbearing
> pcm
->width
)
22894 *right
= pcm
->rbearing
- pcm
->width
;
22895 if (pcm
->lbearing
< 0)
22896 *left
= -pcm
->lbearing
;
22899 else if (glyph
->type
== COMPOSITE_GLYPH
)
22901 if (! glyph
->u
.cmp
.automatic
)
22903 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22905 if (cmp
->rbearing
> cmp
->pixel_width
)
22906 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22907 if (cmp
->lbearing
< 0)
22908 *left
= - cmp
->lbearing
;
22912 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22913 struct font_metrics metrics
;
22915 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22916 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22917 if (metrics
.rbearing
> metrics
.width
)
22918 *right
= metrics
.rbearing
- metrics
.width
;
22919 if (metrics
.lbearing
< 0)
22920 *left
= - metrics
.lbearing
;
22926 /* Return the index of the first glyph preceding glyph string S that
22927 is overwritten by S because of S's left overhang. Value is -1
22928 if no glyphs are overwritten. */
22931 left_overwritten (struct glyph_string
*s
)
22935 if (s
->left_overhang
)
22938 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22939 int first
= s
->first_glyph
- glyphs
;
22941 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22942 x
-= glyphs
[i
].pixel_width
;
22953 /* Return the index of the first glyph preceding glyph string S that
22954 is overwriting S because of its right overhang. Value is -1 if no
22955 glyph in front of S overwrites S. */
22958 left_overwriting (struct glyph_string
*s
)
22961 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22962 int first
= s
->first_glyph
- glyphs
;
22966 for (i
= first
- 1; i
>= 0; --i
)
22969 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22972 x
-= glyphs
[i
].pixel_width
;
22979 /* Return the index of the last glyph following glyph string S that is
22980 overwritten by S because of S's right overhang. Value is -1 if
22981 no such glyph is found. */
22984 right_overwritten (struct glyph_string
*s
)
22988 if (s
->right_overhang
)
22991 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22992 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22993 int end
= s
->row
->used
[s
->area
];
22995 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22996 x
+= glyphs
[i
].pixel_width
;
23005 /* Return the index of the last glyph following glyph string S that
23006 overwrites S because of its left overhang. Value is negative
23007 if no such glyph is found. */
23010 right_overwriting (struct glyph_string
*s
)
23013 int end
= s
->row
->used
[s
->area
];
23014 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23015 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
23019 for (i
= first
; i
< end
; ++i
)
23022 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23025 x
+= glyphs
[i
].pixel_width
;
23032 /* Set background width of glyph string S. START is the index of the
23033 first glyph following S. LAST_X is the right-most x-position + 1
23034 in the drawing area. */
23037 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23039 /* If the face of this glyph string has to be drawn to the end of
23040 the drawing area, set S->extends_to_end_of_line_p. */
23042 if (start
== s
->row
->used
[s
->area
]
23043 && s
->area
== TEXT_AREA
23044 && ((s
->row
->fill_line_p
23045 && (s
->hl
== DRAW_NORMAL_TEXT
23046 || s
->hl
== DRAW_IMAGE_RAISED
23047 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23048 || s
->hl
== DRAW_MOUSE_FACE
))
23049 s
->extends_to_end_of_line_p
= 1;
23051 /* If S extends its face to the end of the line, set its
23052 background_width to the distance to the right edge of the drawing
23054 if (s
->extends_to_end_of_line_p
)
23055 s
->background_width
= last_x
- s
->x
+ 1;
23057 s
->background_width
= s
->width
;
23061 /* Compute overhangs and x-positions for glyph string S and its
23062 predecessors, or successors. X is the starting x-position for S.
23063 BACKWARD_P non-zero means process predecessors. */
23066 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23072 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23073 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23083 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23084 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23094 /* The following macros are only called from draw_glyphs below.
23095 They reference the following parameters of that function directly:
23096 `w', `row', `area', and `overlap_p'
23097 as well as the following local variables:
23098 `s', `f', and `hdc' (in W32) */
23101 /* On W32, silently add local `hdc' variable to argument list of
23102 init_glyph_string. */
23103 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23104 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23106 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23107 init_glyph_string (s, char2b, w, row, area, start, hl)
23110 /* Add a glyph string for a stretch glyph to the list of strings
23111 between HEAD and TAIL. START is the index of the stretch glyph in
23112 row area AREA of glyph row ROW. END is the index of the last glyph
23113 in that glyph row area. X is the current output position assigned
23114 to the new glyph string constructed. HL overrides that face of the
23115 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23116 is the right-most x-position of the drawing area. */
23118 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23119 and below -- keep them on one line. */
23120 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23123 s = alloca (sizeof *s); \
23124 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23125 START = fill_stretch_glyph_string (s, START, END); \
23126 append_glyph_string (&HEAD, &TAIL, s); \
23132 /* Add a glyph string for an image glyph to the list of strings
23133 between HEAD and TAIL. START is the index of the image glyph in
23134 row area AREA of glyph row ROW. END is the index of the last glyph
23135 in that glyph row area. X is the current output position assigned
23136 to the new glyph string constructed. HL overrides that face of the
23137 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23138 is the right-most x-position of the drawing area. */
23140 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23143 s = alloca (sizeof *s); \
23144 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23145 fill_image_glyph_string (s); \
23146 append_glyph_string (&HEAD, &TAIL, s); \
23153 /* Add a glyph string for a sequence of character glyphs to the list
23154 of strings between HEAD and TAIL. START is the index of the first
23155 glyph in row area AREA of glyph row ROW that is part of the new
23156 glyph string. END is the index of the last glyph in that glyph row
23157 area. X is the current output position assigned to the new glyph
23158 string constructed. HL overrides that face of the glyph; e.g. it
23159 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23160 right-most x-position of the drawing area. */
23162 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23168 face_id = (row)->glyphs[area][START].face_id; \
23170 s = alloca (sizeof *s); \
23171 char2b = alloca ((END - START) * sizeof *char2b); \
23172 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23173 append_glyph_string (&HEAD, &TAIL, s); \
23175 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23180 /* Add a glyph string for a composite sequence to the list of strings
23181 between HEAD and TAIL. START is the index of the first glyph in
23182 row area AREA of glyph row ROW that is part of the new glyph
23183 string. END is the index of the last glyph in that glyph row area.
23184 X is the current output position assigned to the new glyph string
23185 constructed. HL overrides that face of the glyph; e.g. it is
23186 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23187 x-position of the drawing area. */
23189 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23191 int face_id = (row)->glyphs[area][START].face_id; \
23192 struct face *base_face = FACE_FROM_ID (f, face_id); \
23193 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23194 struct composition *cmp = composition_table[cmp_id]; \
23196 struct glyph_string *first_s = NULL; \
23199 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23201 /* Make glyph_strings for each glyph sequence that is drawable by \
23202 the same face, and append them to HEAD/TAIL. */ \
23203 for (n = 0; n < cmp->glyph_len;) \
23205 s = alloca (sizeof *s); \
23206 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23207 append_glyph_string (&(HEAD), &(TAIL), s); \
23213 n = fill_composite_glyph_string (s, base_face, overlaps); \
23221 /* Add a glyph string for a glyph-string sequence to the list of strings
23222 between HEAD and TAIL. */
23224 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23228 Lisp_Object gstring; \
23230 face_id = (row)->glyphs[area][START].face_id; \
23231 gstring = (composition_gstring_from_id \
23232 ((row)->glyphs[area][START].u.cmp.id)); \
23233 s = alloca (sizeof *s); \
23234 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23235 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23236 append_glyph_string (&(HEAD), &(TAIL), s); \
23238 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23242 /* Add a glyph string for a sequence of glyphless character's glyphs
23243 to the list of strings between HEAD and TAIL. The meanings of
23244 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23246 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23251 face_id = (row)->glyphs[area][START].face_id; \
23253 s = alloca (sizeof *s); \
23254 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23255 append_glyph_string (&HEAD, &TAIL, s); \
23257 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23263 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23264 of AREA of glyph row ROW on window W between indices START and END.
23265 HL overrides the face for drawing glyph strings, e.g. it is
23266 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23267 x-positions of the drawing area.
23269 This is an ugly monster macro construct because we must use alloca
23270 to allocate glyph strings (because draw_glyphs can be called
23271 asynchronously). */
23273 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23276 HEAD = TAIL = NULL; \
23277 while (START < END) \
23279 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23280 switch (first_glyph->type) \
23283 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23287 case COMPOSITE_GLYPH: \
23288 if (first_glyph->u.cmp.automatic) \
23289 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23292 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23296 case STRETCH_GLYPH: \
23297 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23301 case IMAGE_GLYPH: \
23302 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23306 case GLYPHLESS_GLYPH: \
23307 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23317 set_glyph_string_background_width (s, START, LAST_X); \
23324 /* Draw glyphs between START and END in AREA of ROW on window W,
23325 starting at x-position X. X is relative to AREA in W. HL is a
23326 face-override with the following meaning:
23328 DRAW_NORMAL_TEXT draw normally
23329 DRAW_CURSOR draw in cursor face
23330 DRAW_MOUSE_FACE draw in mouse face.
23331 DRAW_INVERSE_VIDEO draw in mode line face
23332 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23333 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23335 If OVERLAPS is non-zero, draw only the foreground of characters and
23336 clip to the physical height of ROW. Non-zero value also defines
23337 the overlapping part to be drawn:
23339 OVERLAPS_PRED overlap with preceding rows
23340 OVERLAPS_SUCC overlap with succeeding rows
23341 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23342 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23344 Value is the x-position reached, relative to AREA of W. */
23347 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23348 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23349 enum draw_glyphs_face hl
, int overlaps
)
23351 struct glyph_string
*head
, *tail
;
23352 struct glyph_string
*s
;
23353 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23354 int i
, j
, x_reached
, last_x
, area_left
= 0;
23355 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23358 ALLOCATE_HDC (hdc
, f
);
23360 /* Let's rather be paranoid than getting a SEGV. */
23361 end
= min (end
, row
->used
[area
]);
23362 start
= max (0, start
);
23363 start
= min (end
, start
);
23365 /* Translate X to frame coordinates. Set last_x to the right
23366 end of the drawing area. */
23367 if (row
->full_width_p
)
23369 /* X is relative to the left edge of W, without scroll bars
23371 area_left
= WINDOW_LEFT_EDGE_X (w
);
23372 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23376 area_left
= window_box_left (w
, area
);
23377 last_x
= area_left
+ window_box_width (w
, area
);
23381 /* Build a doubly-linked list of glyph_string structures between
23382 head and tail from what we have to draw. Note that the macro
23383 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23384 the reason we use a separate variable `i'. */
23386 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23388 x_reached
= tail
->x
+ tail
->background_width
;
23392 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23393 the row, redraw some glyphs in front or following the glyph
23394 strings built above. */
23395 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23397 struct glyph_string
*h
, *t
;
23398 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23399 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23400 int check_mouse_face
= 0;
23403 /* If mouse highlighting is on, we may need to draw adjacent
23404 glyphs using mouse-face highlighting. */
23405 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23407 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23409 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23410 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23412 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23414 check_mouse_face
= 1;
23415 mouse_beg_col
= (row
== mouse_beg_row
)
23416 ? hlinfo
->mouse_face_beg_col
: 0;
23417 mouse_end_col
= (row
== mouse_end_row
)
23418 ? hlinfo
->mouse_face_end_col
23419 : row
->used
[TEXT_AREA
];
23423 /* Compute overhangs for all glyph strings. */
23424 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23425 for (s
= head
; s
; s
= s
->next
)
23426 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23428 /* Prepend glyph strings for glyphs in front of the first glyph
23429 string that are overwritten because of the first glyph
23430 string's left overhang. The background of all strings
23431 prepended must be drawn because the first glyph string
23433 i
= left_overwritten (head
);
23436 enum draw_glyphs_face overlap_hl
;
23438 /* If this row contains mouse highlighting, attempt to draw
23439 the overlapped glyphs with the correct highlight. This
23440 code fails if the overlap encompasses more than one glyph
23441 and mouse-highlight spans only some of these glyphs.
23442 However, making it work perfectly involves a lot more
23443 code, and I don't know if the pathological case occurs in
23444 practice, so we'll stick to this for now. --- cyd */
23445 if (check_mouse_face
23446 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23447 overlap_hl
= DRAW_MOUSE_FACE
;
23449 overlap_hl
= DRAW_NORMAL_TEXT
;
23452 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23453 overlap_hl
, dummy_x
, last_x
);
23455 compute_overhangs_and_x (t
, head
->x
, 1);
23456 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23460 /* Prepend glyph strings for glyphs in front of the first glyph
23461 string that overwrite that glyph string because of their
23462 right overhang. For these strings, only the foreground must
23463 be drawn, because it draws over the glyph string at `head'.
23464 The background must not be drawn because this would overwrite
23465 right overhangs of preceding glyphs for which no glyph
23467 i
= left_overwriting (head
);
23470 enum draw_glyphs_face overlap_hl
;
23472 if (check_mouse_face
23473 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23474 overlap_hl
= DRAW_MOUSE_FACE
;
23476 overlap_hl
= DRAW_NORMAL_TEXT
;
23479 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23480 overlap_hl
, dummy_x
, last_x
);
23481 for (s
= h
; s
; s
= s
->next
)
23482 s
->background_filled_p
= 1;
23483 compute_overhangs_and_x (t
, head
->x
, 1);
23484 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23487 /* Append glyphs strings for glyphs following the last glyph
23488 string tail that are overwritten by tail. The background of
23489 these strings has to be drawn because tail's foreground draws
23491 i
= right_overwritten (tail
);
23494 enum draw_glyphs_face overlap_hl
;
23496 if (check_mouse_face
23497 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23498 overlap_hl
= DRAW_MOUSE_FACE
;
23500 overlap_hl
= DRAW_NORMAL_TEXT
;
23502 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23503 overlap_hl
, x
, last_x
);
23504 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23505 we don't have `end = i;' here. */
23506 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23507 append_glyph_string_lists (&head
, &tail
, h
, t
);
23511 /* Append glyph strings for glyphs following the last glyph
23512 string tail that overwrite tail. The foreground of such
23513 glyphs has to be drawn because it writes into the background
23514 of tail. The background must not be drawn because it could
23515 paint over the foreground of following glyphs. */
23516 i
= right_overwriting (tail
);
23519 enum draw_glyphs_face overlap_hl
;
23520 if (check_mouse_face
23521 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23522 overlap_hl
= DRAW_MOUSE_FACE
;
23524 overlap_hl
= DRAW_NORMAL_TEXT
;
23527 i
++; /* We must include the Ith glyph. */
23528 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23529 overlap_hl
, x
, last_x
);
23530 for (s
= h
; s
; s
= s
->next
)
23531 s
->background_filled_p
= 1;
23532 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23533 append_glyph_string_lists (&head
, &tail
, h
, t
);
23535 if (clip_head
|| clip_tail
)
23536 for (s
= head
; s
; s
= s
->next
)
23538 s
->clip_head
= clip_head
;
23539 s
->clip_tail
= clip_tail
;
23543 /* Draw all strings. */
23544 for (s
= head
; s
; s
= s
->next
)
23545 FRAME_RIF (f
)->draw_glyph_string (s
);
23548 /* When focus a sole frame and move horizontally, this sets on_p to 0
23549 causing a failure to erase prev cursor position. */
23550 if (area
== TEXT_AREA
23551 && !row
->full_width_p
23552 /* When drawing overlapping rows, only the glyph strings'
23553 foreground is drawn, which doesn't erase a cursor
23557 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23558 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23559 : (tail
? tail
->x
+ tail
->background_width
: x
));
23563 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23564 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23568 /* Value is the x-position up to which drawn, relative to AREA of W.
23569 This doesn't include parts drawn because of overhangs. */
23570 if (row
->full_width_p
)
23571 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23573 x_reached
-= area_left
;
23575 RELEASE_HDC (hdc
, f
);
23580 /* Expand row matrix if too narrow. Don't expand if area
23583 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23585 if (!fonts_changed_p \
23586 && (it->glyph_row->glyphs[area] \
23587 < it->glyph_row->glyphs[area + 1])) \
23589 it->w->ncols_scale_factor++; \
23590 fonts_changed_p = 1; \
23594 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23595 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23598 append_glyph (struct it
*it
)
23600 struct glyph
*glyph
;
23601 enum glyph_row_area area
= it
->area
;
23603 eassert (it
->glyph_row
);
23604 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23606 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23607 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23609 /* If the glyph row is reversed, we need to prepend the glyph
23610 rather than append it. */
23611 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23615 /* Make room for the additional glyph. */
23616 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23618 glyph
= it
->glyph_row
->glyphs
[area
];
23620 glyph
->charpos
= CHARPOS (it
->position
);
23621 glyph
->object
= it
->object
;
23622 if (it
->pixel_width
> 0)
23624 glyph
->pixel_width
= it
->pixel_width
;
23625 glyph
->padding_p
= 0;
23629 /* Assure at least 1-pixel width. Otherwise, cursor can't
23630 be displayed correctly. */
23631 glyph
->pixel_width
= 1;
23632 glyph
->padding_p
= 1;
23634 glyph
->ascent
= it
->ascent
;
23635 glyph
->descent
= it
->descent
;
23636 glyph
->voffset
= it
->voffset
;
23637 glyph
->type
= CHAR_GLYPH
;
23638 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23639 glyph
->multibyte_p
= it
->multibyte_p
;
23640 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23641 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23642 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23643 || it
->phys_descent
> it
->descent
);
23644 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23645 glyph
->face_id
= it
->face_id
;
23646 glyph
->u
.ch
= it
->char_to_display
;
23647 glyph
->slice
.img
= null_glyph_slice
;
23648 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23651 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23652 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23654 glyph
->bidi_type
= it
->bidi_it
.type
;
23658 glyph
->resolved_level
= 0;
23659 glyph
->bidi_type
= UNKNOWN_BT
;
23661 ++it
->glyph_row
->used
[area
];
23664 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23667 /* Store one glyph for the composition IT->cmp_it.id in
23668 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23672 append_composite_glyph (struct it
*it
)
23674 struct glyph
*glyph
;
23675 enum glyph_row_area area
= it
->area
;
23677 eassert (it
->glyph_row
);
23679 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23680 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23682 /* If the glyph row is reversed, we need to prepend the glyph
23683 rather than append it. */
23684 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23688 /* Make room for the new glyph. */
23689 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23691 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23693 glyph
->charpos
= it
->cmp_it
.charpos
;
23694 glyph
->object
= it
->object
;
23695 glyph
->pixel_width
= it
->pixel_width
;
23696 glyph
->ascent
= it
->ascent
;
23697 glyph
->descent
= it
->descent
;
23698 glyph
->voffset
= it
->voffset
;
23699 glyph
->type
= COMPOSITE_GLYPH
;
23700 if (it
->cmp_it
.ch
< 0)
23702 glyph
->u
.cmp
.automatic
= 0;
23703 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23704 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23708 glyph
->u
.cmp
.automatic
= 1;
23709 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23710 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23711 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23713 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23714 glyph
->multibyte_p
= it
->multibyte_p
;
23715 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23716 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23717 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23718 || it
->phys_descent
> it
->descent
);
23719 glyph
->padding_p
= 0;
23720 glyph
->glyph_not_available_p
= 0;
23721 glyph
->face_id
= it
->face_id
;
23722 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23725 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23726 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23728 glyph
->bidi_type
= it
->bidi_it
.type
;
23730 ++it
->glyph_row
->used
[area
];
23733 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23737 /* Change IT->ascent and IT->height according to the setting of
23741 take_vertical_position_into_account (struct it
*it
)
23745 if (it
->voffset
< 0)
23746 /* Increase the ascent so that we can display the text higher
23748 it
->ascent
-= it
->voffset
;
23750 /* Increase the descent so that we can display the text lower
23752 it
->descent
+= it
->voffset
;
23757 /* Produce glyphs/get display metrics for the image IT is loaded with.
23758 See the description of struct display_iterator in dispextern.h for
23759 an overview of struct display_iterator. */
23762 produce_image_glyph (struct it
*it
)
23766 int glyph_ascent
, crop
;
23767 struct glyph_slice slice
;
23769 eassert (it
->what
== IT_IMAGE
);
23771 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23773 /* Make sure X resources of the face is loaded. */
23774 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23776 if (it
->image_id
< 0)
23778 /* Fringe bitmap. */
23779 it
->ascent
= it
->phys_ascent
= 0;
23780 it
->descent
= it
->phys_descent
= 0;
23781 it
->pixel_width
= 0;
23786 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23788 /* Make sure X resources of the image is loaded. */
23789 prepare_image_for_display (it
->f
, img
);
23791 slice
.x
= slice
.y
= 0;
23792 slice
.width
= img
->width
;
23793 slice
.height
= img
->height
;
23795 if (INTEGERP (it
->slice
.x
))
23796 slice
.x
= XINT (it
->slice
.x
);
23797 else if (FLOATP (it
->slice
.x
))
23798 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23800 if (INTEGERP (it
->slice
.y
))
23801 slice
.y
= XINT (it
->slice
.y
);
23802 else if (FLOATP (it
->slice
.y
))
23803 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23805 if (INTEGERP (it
->slice
.width
))
23806 slice
.width
= XINT (it
->slice
.width
);
23807 else if (FLOATP (it
->slice
.width
))
23808 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23810 if (INTEGERP (it
->slice
.height
))
23811 slice
.height
= XINT (it
->slice
.height
);
23812 else if (FLOATP (it
->slice
.height
))
23813 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23815 if (slice
.x
>= img
->width
)
23816 slice
.x
= img
->width
;
23817 if (slice
.y
>= img
->height
)
23818 slice
.y
= img
->height
;
23819 if (slice
.x
+ slice
.width
>= img
->width
)
23820 slice
.width
= img
->width
- slice
.x
;
23821 if (slice
.y
+ slice
.height
> img
->height
)
23822 slice
.height
= img
->height
- slice
.y
;
23824 if (slice
.width
== 0 || slice
.height
== 0)
23827 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23829 it
->descent
= slice
.height
- glyph_ascent
;
23831 it
->descent
+= img
->vmargin
;
23832 if (slice
.y
+ slice
.height
== img
->height
)
23833 it
->descent
+= img
->vmargin
;
23834 it
->phys_descent
= it
->descent
;
23836 it
->pixel_width
= slice
.width
;
23838 it
->pixel_width
+= img
->hmargin
;
23839 if (slice
.x
+ slice
.width
== img
->width
)
23840 it
->pixel_width
+= img
->hmargin
;
23842 /* It's quite possible for images to have an ascent greater than
23843 their height, so don't get confused in that case. */
23844 if (it
->descent
< 0)
23849 if (face
->box
!= FACE_NO_BOX
)
23851 if (face
->box_line_width
> 0)
23854 it
->ascent
+= face
->box_line_width
;
23855 if (slice
.y
+ slice
.height
== img
->height
)
23856 it
->descent
+= face
->box_line_width
;
23859 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23860 it
->pixel_width
+= eabs (face
->box_line_width
);
23861 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23862 it
->pixel_width
+= eabs (face
->box_line_width
);
23865 take_vertical_position_into_account (it
);
23867 /* Automatically crop wide image glyphs at right edge so we can
23868 draw the cursor on same display row. */
23869 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23870 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23872 it
->pixel_width
-= crop
;
23873 slice
.width
-= crop
;
23878 struct glyph
*glyph
;
23879 enum glyph_row_area area
= it
->area
;
23881 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23882 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23884 glyph
->charpos
= CHARPOS (it
->position
);
23885 glyph
->object
= it
->object
;
23886 glyph
->pixel_width
= it
->pixel_width
;
23887 glyph
->ascent
= glyph_ascent
;
23888 glyph
->descent
= it
->descent
;
23889 glyph
->voffset
= it
->voffset
;
23890 glyph
->type
= IMAGE_GLYPH
;
23891 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23892 glyph
->multibyte_p
= it
->multibyte_p
;
23893 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23894 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23895 glyph
->overlaps_vertically_p
= 0;
23896 glyph
->padding_p
= 0;
23897 glyph
->glyph_not_available_p
= 0;
23898 glyph
->face_id
= it
->face_id
;
23899 glyph
->u
.img_id
= img
->id
;
23900 glyph
->slice
.img
= slice
;
23901 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23904 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23905 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23907 glyph
->bidi_type
= it
->bidi_it
.type
;
23909 ++it
->glyph_row
->used
[area
];
23912 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23917 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23918 of the glyph, WIDTH and HEIGHT are the width and height of the
23919 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23922 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23923 int width
, int height
, int ascent
)
23925 struct glyph
*glyph
;
23926 enum glyph_row_area area
= it
->area
;
23928 eassert (ascent
>= 0 && ascent
<= height
);
23930 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23931 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23933 /* If the glyph row is reversed, we need to prepend the glyph
23934 rather than append it. */
23935 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23939 /* Make room for the additional glyph. */
23940 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23942 glyph
= it
->glyph_row
->glyphs
[area
];
23944 glyph
->charpos
= CHARPOS (it
->position
);
23945 glyph
->object
= object
;
23946 glyph
->pixel_width
= width
;
23947 glyph
->ascent
= ascent
;
23948 glyph
->descent
= height
- ascent
;
23949 glyph
->voffset
= it
->voffset
;
23950 glyph
->type
= STRETCH_GLYPH
;
23951 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23952 glyph
->multibyte_p
= it
->multibyte_p
;
23953 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23954 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23955 glyph
->overlaps_vertically_p
= 0;
23956 glyph
->padding_p
= 0;
23957 glyph
->glyph_not_available_p
= 0;
23958 glyph
->face_id
= it
->face_id
;
23959 glyph
->u
.stretch
.ascent
= ascent
;
23960 glyph
->u
.stretch
.height
= height
;
23961 glyph
->slice
.img
= null_glyph_slice
;
23962 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23965 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23966 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23968 glyph
->bidi_type
= it
->bidi_it
.type
;
23972 glyph
->resolved_level
= 0;
23973 glyph
->bidi_type
= UNKNOWN_BT
;
23975 ++it
->glyph_row
->used
[area
];
23978 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23981 #endif /* HAVE_WINDOW_SYSTEM */
23983 /* Produce a stretch glyph for iterator IT. IT->object is the value
23984 of the glyph property displayed. The value must be a list
23985 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23988 1. `:width WIDTH' specifies that the space should be WIDTH *
23989 canonical char width wide. WIDTH may be an integer or floating
23992 2. `:relative-width FACTOR' specifies that the width of the stretch
23993 should be computed from the width of the first character having the
23994 `glyph' property, and should be FACTOR times that width.
23996 3. `:align-to HPOS' specifies that the space should be wide enough
23997 to reach HPOS, a value in canonical character units.
23999 Exactly one of the above pairs must be present.
24001 4. `:height HEIGHT' specifies that the height of the stretch produced
24002 should be HEIGHT, measured in canonical character units.
24004 5. `:relative-height FACTOR' specifies that the height of the
24005 stretch should be FACTOR times the height of the characters having
24006 the glyph property.
24008 Either none or exactly one of 4 or 5 must be present.
24010 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24011 of the stretch should be used for the ascent of the stretch.
24012 ASCENT must be in the range 0 <= ASCENT <= 100. */
24015 produce_stretch_glyph (struct it
*it
)
24017 /* (space :width WIDTH :height HEIGHT ...) */
24018 Lisp_Object prop
, plist
;
24019 int width
= 0, height
= 0, align_to
= -1;
24020 int zero_width_ok_p
= 0;
24023 struct face
*face
= NULL
;
24024 struct font
*font
= NULL
;
24026 #ifdef HAVE_WINDOW_SYSTEM
24027 int zero_height_ok_p
= 0;
24029 if (FRAME_WINDOW_P (it
->f
))
24031 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24032 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24033 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24037 /* List should start with `space'. */
24038 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24039 plist
= XCDR (it
->object
);
24041 /* Compute the width of the stretch. */
24042 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24043 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24045 /* Absolute width `:width WIDTH' specified and valid. */
24046 zero_width_ok_p
= 1;
24049 #ifdef HAVE_WINDOW_SYSTEM
24050 else if (FRAME_WINDOW_P (it
->f
)
24051 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24053 /* Relative width `:relative-width FACTOR' specified and valid.
24054 Compute the width of the characters having the `glyph'
24057 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24060 if (it
->multibyte_p
)
24061 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24064 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24065 if (! ASCII_CHAR_P (it2
.c
))
24066 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24069 it2
.glyph_row
= NULL
;
24070 it2
.what
= IT_CHARACTER
;
24071 x_produce_glyphs (&it2
);
24072 width
= NUMVAL (prop
) * it2
.pixel_width
;
24074 #endif /* HAVE_WINDOW_SYSTEM */
24075 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24076 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24078 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24079 align_to
= (align_to
< 0
24081 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24082 else if (align_to
< 0)
24083 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24084 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24085 zero_width_ok_p
= 1;
24088 /* Nothing specified -> width defaults to canonical char width. */
24089 width
= FRAME_COLUMN_WIDTH (it
->f
);
24091 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24094 #ifdef HAVE_WINDOW_SYSTEM
24095 /* Compute height. */
24096 if (FRAME_WINDOW_P (it
->f
))
24098 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24099 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24102 zero_height_ok_p
= 1;
24104 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24106 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24108 height
= FONT_HEIGHT (font
);
24110 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24113 /* Compute percentage of height used for ascent. If
24114 `:ascent ASCENT' is present and valid, use that. Otherwise,
24115 derive the ascent from the font in use. */
24116 if (prop
= Fplist_get (plist
, QCascent
),
24117 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24118 ascent
= height
* NUMVAL (prop
) / 100.0;
24119 else if (!NILP (prop
)
24120 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24121 ascent
= min (max (0, (int)tem
), height
);
24123 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24126 #endif /* HAVE_WINDOW_SYSTEM */
24129 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24130 && it
->current_x
+ width
> it
->last_visible_x
)
24132 width
= it
->last_visible_x
- it
->current_x
;
24133 #ifdef HAVE_WINDOW_SYSTEM
24134 /* Subtract one more pixel from the stretch width, but only on
24135 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24136 width
-= FRAME_WINDOW_P (it
->f
);
24140 if (width
> 0 && height
> 0 && it
->glyph_row
)
24142 Lisp_Object o_object
= it
->object
;
24143 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24146 if (!STRINGP (object
))
24147 object
= it
->w
->buffer
;
24148 #ifdef HAVE_WINDOW_SYSTEM
24149 if (FRAME_WINDOW_P (it
->f
))
24150 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24154 it
->object
= object
;
24155 it
->char_to_display
= ' ';
24156 it
->pixel_width
= it
->len
= 1;
24158 tty_append_glyph (it
);
24159 it
->object
= o_object
;
24163 it
->pixel_width
= width
;
24164 #ifdef HAVE_WINDOW_SYSTEM
24165 if (FRAME_WINDOW_P (it
->f
))
24167 it
->ascent
= it
->phys_ascent
= ascent
;
24168 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24169 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24170 take_vertical_position_into_account (it
);
24174 it
->nglyphs
= width
;
24177 /* Get information about special display element WHAT in an
24178 environment described by IT. WHAT is one of IT_TRUNCATION or
24179 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24180 non-null glyph_row member. This function ensures that fields like
24181 face_id, c, len of IT are left untouched. */
24184 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24191 temp_it
.object
= make_number (0);
24192 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24194 if (what
== IT_CONTINUATION
)
24196 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24197 if (it
->bidi_it
.paragraph_dir
== R2L
)
24198 SET_GLYPH_FROM_CHAR (glyph
, '/');
24200 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24202 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24204 /* FIXME: Should we mirror GC for R2L lines? */
24205 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24206 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24209 else if (what
== IT_TRUNCATION
)
24211 /* Truncation glyph. */
24212 SET_GLYPH_FROM_CHAR (glyph
, '$');
24214 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24216 /* FIXME: Should we mirror GC for R2L lines? */
24217 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24218 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24224 #ifdef HAVE_WINDOW_SYSTEM
24225 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24226 is turned off, we precede the truncation/continuation glyphs by a
24227 stretch glyph whose width is computed such that these special
24228 glyphs are aligned at the window margin, even when very different
24229 fonts are used in different glyph rows. */
24230 if (FRAME_WINDOW_P (temp_it
.f
)
24231 /* init_iterator calls this with it->glyph_row == NULL, and it
24232 wants only the pixel width of the truncation/continuation
24234 && temp_it
.glyph_row
24235 /* insert_left_trunc_glyphs calls us at the beginning of the
24236 row, and it has its own calculation of the stretch glyph
24238 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24239 && (temp_it
.glyph_row
->reversed_p
24240 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24241 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24243 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24245 if (stretch_width
> 0)
24247 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24248 struct font
*font
=
24249 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24250 int stretch_ascent
=
24251 (((temp_it
.ascent
+ temp_it
.descent
)
24252 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24254 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24255 temp_it
.ascent
+ temp_it
.descent
,
24262 temp_it
.what
= IT_CHARACTER
;
24264 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24265 temp_it
.face_id
= GLYPH_FACE (glyph
);
24266 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24268 PRODUCE_GLYPHS (&temp_it
);
24269 it
->pixel_width
= temp_it
.pixel_width
;
24270 it
->nglyphs
= temp_it
.pixel_width
;
24273 #ifdef HAVE_WINDOW_SYSTEM
24275 /* Calculate line-height and line-spacing properties.
24276 An integer value specifies explicit pixel value.
24277 A float value specifies relative value to current face height.
24278 A cons (float . face-name) specifies relative value to
24279 height of specified face font.
24281 Returns height in pixels, or nil. */
24285 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24286 int boff
, int override
)
24288 Lisp_Object face_name
= Qnil
;
24289 int ascent
, descent
, height
;
24291 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24296 face_name
= XCAR (val
);
24298 if (!NUMBERP (val
))
24299 val
= make_number (1);
24300 if (NILP (face_name
))
24302 height
= it
->ascent
+ it
->descent
;
24307 if (NILP (face_name
))
24309 font
= FRAME_FONT (it
->f
);
24310 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24312 else if (EQ (face_name
, Qt
))
24321 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24323 return make_number (-1);
24325 face
= FACE_FROM_ID (it
->f
, face_id
);
24328 return make_number (-1);
24329 boff
= font
->baseline_offset
;
24330 if (font
->vertical_centering
)
24331 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24334 ascent
= FONT_BASE (font
) + boff
;
24335 descent
= FONT_DESCENT (font
) - boff
;
24339 it
->override_ascent
= ascent
;
24340 it
->override_descent
= descent
;
24341 it
->override_boff
= boff
;
24344 height
= ascent
+ descent
;
24348 height
= (int)(XFLOAT_DATA (val
) * height
);
24349 else if (INTEGERP (val
))
24350 height
*= XINT (val
);
24352 return make_number (height
);
24356 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24357 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24358 and only if this is for a character for which no font was found.
24360 If the display method (it->glyphless_method) is
24361 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24362 length of the acronym or the hexadecimal string, UPPER_XOFF and
24363 UPPER_YOFF are pixel offsets for the upper part of the string,
24364 LOWER_XOFF and LOWER_YOFF are for the lower part.
24366 For the other display methods, LEN through LOWER_YOFF are zero. */
24369 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24370 short upper_xoff
, short upper_yoff
,
24371 short lower_xoff
, short lower_yoff
)
24373 struct glyph
*glyph
;
24374 enum glyph_row_area area
= it
->area
;
24376 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24377 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24379 /* If the glyph row is reversed, we need to prepend the glyph
24380 rather than append it. */
24381 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24385 /* Make room for the additional glyph. */
24386 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24388 glyph
= it
->glyph_row
->glyphs
[area
];
24390 glyph
->charpos
= CHARPOS (it
->position
);
24391 glyph
->object
= it
->object
;
24392 glyph
->pixel_width
= it
->pixel_width
;
24393 glyph
->ascent
= it
->ascent
;
24394 glyph
->descent
= it
->descent
;
24395 glyph
->voffset
= it
->voffset
;
24396 glyph
->type
= GLYPHLESS_GLYPH
;
24397 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24398 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24399 glyph
->u
.glyphless
.len
= len
;
24400 glyph
->u
.glyphless
.ch
= it
->c
;
24401 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24402 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24403 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24404 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24405 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24406 glyph
->multibyte_p
= it
->multibyte_p
;
24407 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24408 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24409 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24410 || it
->phys_descent
> it
->descent
);
24411 glyph
->padding_p
= 0;
24412 glyph
->glyph_not_available_p
= 0;
24413 glyph
->face_id
= face_id
;
24414 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24417 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24418 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24420 glyph
->bidi_type
= it
->bidi_it
.type
;
24422 ++it
->glyph_row
->used
[area
];
24425 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24429 /* Produce a glyph for a glyphless character for iterator IT.
24430 IT->glyphless_method specifies which method to use for displaying
24431 the character. See the description of enum
24432 glyphless_display_method in dispextern.h for the detail.
24434 FOR_NO_FONT is nonzero if and only if this is for a character for
24435 which no font was found. ACRONYM, if non-nil, is an acronym string
24436 for the character. */
24439 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24444 int base_width
, base_height
, width
, height
;
24445 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24448 /* Get the metrics of the base font. We always refer to the current
24450 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24451 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24452 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24453 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24454 base_height
= it
->ascent
+ it
->descent
;
24455 base_width
= font
->average_width
;
24457 /* Get a face ID for the glyph by utilizing a cache (the same way as
24458 done for `escape-glyph' in get_next_display_element). */
24459 if (it
->f
== last_glyphless_glyph_frame
24460 && it
->face_id
== last_glyphless_glyph_face_id
)
24462 face_id
= last_glyphless_glyph_merged_face_id
;
24466 /* Merge the `glyphless-char' face into the current face. */
24467 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24468 last_glyphless_glyph_frame
= it
->f
;
24469 last_glyphless_glyph_face_id
= it
->face_id
;
24470 last_glyphless_glyph_merged_face_id
= face_id
;
24473 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24475 it
->pixel_width
= THIN_SPACE_WIDTH
;
24477 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24479 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24481 width
= CHAR_WIDTH (it
->c
);
24484 else if (width
> 4)
24486 it
->pixel_width
= base_width
* width
;
24488 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24494 unsigned int code
[6];
24496 int ascent
, descent
;
24497 struct font_metrics metrics_upper
, metrics_lower
;
24499 face
= FACE_FROM_ID (it
->f
, face_id
);
24500 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24501 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24503 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24505 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24506 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24507 if (CONSP (acronym
))
24508 acronym
= XCAR (acronym
);
24509 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24513 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24514 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24517 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24518 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24519 upper_len
= (len
+ 1) / 2;
24520 font
->driver
->text_extents (font
, code
, upper_len
,
24522 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24527 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24528 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24529 upper_xoff
= upper_yoff
= 2; /* the typical case */
24530 if (base_width
>= width
)
24532 /* Align the upper to the left, the lower to the right. */
24533 it
->pixel_width
= base_width
;
24534 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24538 /* Center the shorter one. */
24539 it
->pixel_width
= width
;
24540 if (metrics_upper
.width
>= metrics_lower
.width
)
24541 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24544 /* FIXME: This code doesn't look right. It formerly was
24545 missing the "lower_xoff = 0;", which couldn't have
24546 been right since it left lower_xoff uninitialized. */
24548 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24552 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24553 top, bottom, and between upper and lower strings. */
24554 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24555 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24556 /* Center vertically.
24557 H:base_height, D:base_descent
24558 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24560 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24561 descent = D - H/2 + h/2;
24562 lower_yoff = descent - 2 - ld;
24563 upper_yoff = lower_yoff - la - 1 - ud; */
24564 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24565 descent
= it
->descent
- (base_height
- height
) / 2;
24566 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24567 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24568 - metrics_upper
.descent
);
24569 /* Don't make the height shorter than the base height. */
24570 if (height
> base_height
)
24572 it
->ascent
= ascent
;
24573 it
->descent
= descent
;
24577 it
->phys_ascent
= it
->ascent
;
24578 it
->phys_descent
= it
->descent
;
24580 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24581 upper_xoff
, upper_yoff
,
24582 lower_xoff
, lower_yoff
);
24584 take_vertical_position_into_account (it
);
24589 Produce glyphs/get display metrics for the display element IT is
24590 loaded with. See the description of struct it in dispextern.h
24591 for an overview of struct it. */
24594 x_produce_glyphs (struct it
*it
)
24596 int extra_line_spacing
= it
->extra_line_spacing
;
24598 it
->glyph_not_available_p
= 0;
24600 if (it
->what
== IT_CHARACTER
)
24603 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24604 struct font
*font
= face
->font
;
24605 struct font_metrics
*pcm
= NULL
;
24606 int boff
; /* baseline offset */
24610 /* When no suitable font is found, display this character by
24611 the method specified in the first extra slot of
24612 Vglyphless_char_display. */
24613 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24615 eassert (it
->what
== IT_GLYPHLESS
);
24616 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24620 boff
= font
->baseline_offset
;
24621 if (font
->vertical_centering
)
24622 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24624 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24630 if (it
->override_ascent
>= 0)
24632 it
->ascent
= it
->override_ascent
;
24633 it
->descent
= it
->override_descent
;
24634 boff
= it
->override_boff
;
24638 it
->ascent
= FONT_BASE (font
) + boff
;
24639 it
->descent
= FONT_DESCENT (font
) - boff
;
24642 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24644 pcm
= get_per_char_metric (font
, &char2b
);
24645 if (pcm
->width
== 0
24646 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24652 it
->phys_ascent
= pcm
->ascent
+ boff
;
24653 it
->phys_descent
= pcm
->descent
- boff
;
24654 it
->pixel_width
= pcm
->width
;
24658 it
->glyph_not_available_p
= 1;
24659 it
->phys_ascent
= it
->ascent
;
24660 it
->phys_descent
= it
->descent
;
24661 it
->pixel_width
= font
->space_width
;
24664 if (it
->constrain_row_ascent_descent_p
)
24666 if (it
->descent
> it
->max_descent
)
24668 it
->ascent
+= it
->descent
- it
->max_descent
;
24669 it
->descent
= it
->max_descent
;
24671 if (it
->ascent
> it
->max_ascent
)
24673 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24674 it
->ascent
= it
->max_ascent
;
24676 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24677 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24678 extra_line_spacing
= 0;
24681 /* If this is a space inside a region of text with
24682 `space-width' property, change its width. */
24683 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24685 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24687 /* If face has a box, add the box thickness to the character
24688 height. If character has a box line to the left and/or
24689 right, add the box line width to the character's width. */
24690 if (face
->box
!= FACE_NO_BOX
)
24692 int thick
= face
->box_line_width
;
24696 it
->ascent
+= thick
;
24697 it
->descent
+= thick
;
24702 if (it
->start_of_box_run_p
)
24703 it
->pixel_width
+= thick
;
24704 if (it
->end_of_box_run_p
)
24705 it
->pixel_width
+= thick
;
24708 /* If face has an overline, add the height of the overline
24709 (1 pixel) and a 1 pixel margin to the character height. */
24710 if (face
->overline_p
)
24711 it
->ascent
+= overline_margin
;
24713 if (it
->constrain_row_ascent_descent_p
)
24715 if (it
->ascent
> it
->max_ascent
)
24716 it
->ascent
= it
->max_ascent
;
24717 if (it
->descent
> it
->max_descent
)
24718 it
->descent
= it
->max_descent
;
24721 take_vertical_position_into_account (it
);
24723 /* If we have to actually produce glyphs, do it. */
24728 /* Translate a space with a `space-width' property
24729 into a stretch glyph. */
24730 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24731 / FONT_HEIGHT (font
));
24732 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24733 it
->ascent
+ it
->descent
, ascent
);
24738 /* If characters with lbearing or rbearing are displayed
24739 in this line, record that fact in a flag of the
24740 glyph row. This is used to optimize X output code. */
24741 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24742 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24744 if (! stretched_p
&& it
->pixel_width
== 0)
24745 /* We assure that all visible glyphs have at least 1-pixel
24747 it
->pixel_width
= 1;
24749 else if (it
->char_to_display
== '\n')
24751 /* A newline has no width, but we need the height of the
24752 line. But if previous part of the line sets a height,
24753 don't increase that height */
24755 Lisp_Object height
;
24756 Lisp_Object total_height
= Qnil
;
24758 it
->override_ascent
= -1;
24759 it
->pixel_width
= 0;
24762 height
= get_it_property (it
, Qline_height
);
24763 /* Split (line-height total-height) list */
24765 && CONSP (XCDR (height
))
24766 && NILP (XCDR (XCDR (height
))))
24768 total_height
= XCAR (XCDR (height
));
24769 height
= XCAR (height
);
24771 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24773 if (it
->override_ascent
>= 0)
24775 it
->ascent
= it
->override_ascent
;
24776 it
->descent
= it
->override_descent
;
24777 boff
= it
->override_boff
;
24781 it
->ascent
= FONT_BASE (font
) + boff
;
24782 it
->descent
= FONT_DESCENT (font
) - boff
;
24785 if (EQ (height
, Qt
))
24787 if (it
->descent
> it
->max_descent
)
24789 it
->ascent
+= it
->descent
- it
->max_descent
;
24790 it
->descent
= it
->max_descent
;
24792 if (it
->ascent
> it
->max_ascent
)
24794 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24795 it
->ascent
= it
->max_ascent
;
24797 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24798 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24799 it
->constrain_row_ascent_descent_p
= 1;
24800 extra_line_spacing
= 0;
24804 Lisp_Object spacing
;
24806 it
->phys_ascent
= it
->ascent
;
24807 it
->phys_descent
= it
->descent
;
24809 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24810 && face
->box
!= FACE_NO_BOX
24811 && face
->box_line_width
> 0)
24813 it
->ascent
+= face
->box_line_width
;
24814 it
->descent
+= face
->box_line_width
;
24817 && XINT (height
) > it
->ascent
+ it
->descent
)
24818 it
->ascent
= XINT (height
) - it
->descent
;
24820 if (!NILP (total_height
))
24821 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24824 spacing
= get_it_property (it
, Qline_spacing
);
24825 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24827 if (INTEGERP (spacing
))
24829 extra_line_spacing
= XINT (spacing
);
24830 if (!NILP (total_height
))
24831 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24835 else /* i.e. (it->char_to_display == '\t') */
24837 if (font
->space_width
> 0)
24839 int tab_width
= it
->tab_width
* font
->space_width
;
24840 int x
= it
->current_x
+ it
->continuation_lines_width
;
24841 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24843 /* If the distance from the current position to the next tab
24844 stop is less than a space character width, use the
24845 tab stop after that. */
24846 if (next_tab_x
- x
< font
->space_width
)
24847 next_tab_x
+= tab_width
;
24849 it
->pixel_width
= next_tab_x
- x
;
24851 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24852 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24856 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24857 it
->ascent
+ it
->descent
, it
->ascent
);
24862 it
->pixel_width
= 0;
24867 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24869 /* A static composition.
24871 Note: A composition is represented as one glyph in the
24872 glyph matrix. There are no padding glyphs.
24874 Important note: pixel_width, ascent, and descent are the
24875 values of what is drawn by draw_glyphs (i.e. the values of
24876 the overall glyphs composed). */
24877 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24878 int boff
; /* baseline offset */
24879 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24880 int glyph_len
= cmp
->glyph_len
;
24881 struct font
*font
= face
->font
;
24885 /* If we have not yet calculated pixel size data of glyphs of
24886 the composition for the current face font, calculate them
24887 now. Theoretically, we have to check all fonts for the
24888 glyphs, but that requires much time and memory space. So,
24889 here we check only the font of the first glyph. This may
24890 lead to incorrect display, but it's very rare, and C-l
24891 (recenter-top-bottom) can correct the display anyway. */
24892 if (! cmp
->font
|| cmp
->font
!= font
)
24894 /* Ascent and descent of the font of the first character
24895 of this composition (adjusted by baseline offset).
24896 Ascent and descent of overall glyphs should not be less
24897 than these, respectively. */
24898 int font_ascent
, font_descent
, font_height
;
24899 /* Bounding box of the overall glyphs. */
24900 int leftmost
, rightmost
, lowest
, highest
;
24901 int lbearing
, rbearing
;
24902 int i
, width
, ascent
, descent
;
24903 int left_padded
= 0, right_padded
= 0;
24904 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24906 struct font_metrics
*pcm
;
24907 int font_not_found_p
;
24910 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24911 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24913 if (glyph_len
< cmp
->glyph_len
)
24915 for (i
= 0; i
< glyph_len
; i
++)
24917 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24919 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24924 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24925 : IT_CHARPOS (*it
));
24926 /* If no suitable font is found, use the default font. */
24927 font_not_found_p
= font
== NULL
;
24928 if (font_not_found_p
)
24930 face
= face
->ascii_face
;
24933 boff
= font
->baseline_offset
;
24934 if (font
->vertical_centering
)
24935 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24936 font_ascent
= FONT_BASE (font
) + boff
;
24937 font_descent
= FONT_DESCENT (font
) - boff
;
24938 font_height
= FONT_HEIGHT (font
);
24940 cmp
->font
= (void *) font
;
24943 if (! font_not_found_p
)
24945 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24947 pcm
= get_per_char_metric (font
, &char2b
);
24950 /* Initialize the bounding box. */
24953 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24954 ascent
= pcm
->ascent
;
24955 descent
= pcm
->descent
;
24956 lbearing
= pcm
->lbearing
;
24957 rbearing
= pcm
->rbearing
;
24961 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24962 ascent
= FONT_BASE (font
);
24963 descent
= FONT_DESCENT (font
);
24970 lowest
= - descent
+ boff
;
24971 highest
= ascent
+ boff
;
24973 if (! font_not_found_p
24974 && font
->default_ascent
24975 && CHAR_TABLE_P (Vuse_default_ascent
)
24976 && !NILP (Faref (Vuse_default_ascent
,
24977 make_number (it
->char_to_display
))))
24978 highest
= font
->default_ascent
+ boff
;
24980 /* Draw the first glyph at the normal position. It may be
24981 shifted to right later if some other glyphs are drawn
24983 cmp
->offsets
[i
* 2] = 0;
24984 cmp
->offsets
[i
* 2 + 1] = boff
;
24985 cmp
->lbearing
= lbearing
;
24986 cmp
->rbearing
= rbearing
;
24988 /* Set cmp->offsets for the remaining glyphs. */
24989 for (i
++; i
< glyph_len
; i
++)
24991 int left
, right
, btm
, top
;
24992 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24994 struct face
*this_face
;
24998 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24999 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25000 font
= this_face
->font
;
25006 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25008 pcm
= get_per_char_metric (font
, &char2b
);
25011 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25014 width
= pcm
->width
;
25015 ascent
= pcm
->ascent
;
25016 descent
= pcm
->descent
;
25017 lbearing
= pcm
->lbearing
;
25018 rbearing
= pcm
->rbearing
;
25019 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25021 /* Relative composition with or without
25022 alternate chars. */
25023 left
= (leftmost
+ rightmost
- width
) / 2;
25024 btm
= - descent
+ boff
;
25025 if (font
->relative_compose
25026 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25027 || NILP (Faref (Vignore_relative_composition
,
25028 make_number (ch
)))))
25031 if (- descent
>= font
->relative_compose
)
25032 /* One extra pixel between two glyphs. */
25034 else if (ascent
<= 0)
25035 /* One extra pixel between two glyphs. */
25036 btm
= lowest
- 1 - ascent
- descent
;
25041 /* A composition rule is specified by an integer
25042 value that encodes global and new reference
25043 points (GREF and NREF). GREF and NREF are
25044 specified by numbers as below:
25046 0---1---2 -- ascent
25050 9--10--11 -- center
25052 ---3---4---5--- baseline
25054 6---7---8 -- descent
25056 int rule
= COMPOSITION_RULE (cmp
, i
);
25057 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25059 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25060 grefx
= gref
% 3, nrefx
= nref
% 3;
25061 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25063 xoff
= font_height
* (xoff
- 128) / 256;
25065 yoff
= font_height
* (yoff
- 128) / 256;
25068 + grefx
* (rightmost
- leftmost
) / 2
25069 - nrefx
* width
/ 2
25072 btm
= ((grefy
== 0 ? highest
25074 : grefy
== 2 ? lowest
25075 : (highest
+ lowest
) / 2)
25076 - (nrefy
== 0 ? ascent
+ descent
25077 : nrefy
== 1 ? descent
- boff
25079 : (ascent
+ descent
) / 2)
25083 cmp
->offsets
[i
* 2] = left
;
25084 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25086 /* Update the bounding box of the overall glyphs. */
25089 right
= left
+ width
;
25090 if (left
< leftmost
)
25092 if (right
> rightmost
)
25095 top
= btm
+ descent
+ ascent
;
25101 if (cmp
->lbearing
> left
+ lbearing
)
25102 cmp
->lbearing
= left
+ lbearing
;
25103 if (cmp
->rbearing
< left
+ rbearing
)
25104 cmp
->rbearing
= left
+ rbearing
;
25108 /* If there are glyphs whose x-offsets are negative,
25109 shift all glyphs to the right and make all x-offsets
25113 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25114 cmp
->offsets
[i
* 2] -= leftmost
;
25115 rightmost
-= leftmost
;
25116 cmp
->lbearing
-= leftmost
;
25117 cmp
->rbearing
-= leftmost
;
25120 if (left_padded
&& cmp
->lbearing
< 0)
25122 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25123 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25124 rightmost
-= cmp
->lbearing
;
25125 cmp
->rbearing
-= cmp
->lbearing
;
25128 if (right_padded
&& rightmost
< cmp
->rbearing
)
25130 rightmost
= cmp
->rbearing
;
25133 cmp
->pixel_width
= rightmost
;
25134 cmp
->ascent
= highest
;
25135 cmp
->descent
= - lowest
;
25136 if (cmp
->ascent
< font_ascent
)
25137 cmp
->ascent
= font_ascent
;
25138 if (cmp
->descent
< font_descent
)
25139 cmp
->descent
= font_descent
;
25143 && (cmp
->lbearing
< 0
25144 || cmp
->rbearing
> cmp
->pixel_width
))
25145 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25147 it
->pixel_width
= cmp
->pixel_width
;
25148 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25149 it
->descent
= it
->phys_descent
= cmp
->descent
;
25150 if (face
->box
!= FACE_NO_BOX
)
25152 int thick
= face
->box_line_width
;
25156 it
->ascent
+= thick
;
25157 it
->descent
+= thick
;
25162 if (it
->start_of_box_run_p
)
25163 it
->pixel_width
+= thick
;
25164 if (it
->end_of_box_run_p
)
25165 it
->pixel_width
+= thick
;
25168 /* If face has an overline, add the height of the overline
25169 (1 pixel) and a 1 pixel margin to the character height. */
25170 if (face
->overline_p
)
25171 it
->ascent
+= overline_margin
;
25173 take_vertical_position_into_account (it
);
25174 if (it
->ascent
< 0)
25176 if (it
->descent
< 0)
25179 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25180 append_composite_glyph (it
);
25182 else if (it
->what
== IT_COMPOSITION
)
25184 /* A dynamic (automatic) composition. */
25185 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25186 Lisp_Object gstring
;
25187 struct font_metrics metrics
;
25191 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25193 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25196 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25197 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25198 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25199 it
->descent
= it
->phys_descent
= metrics
.descent
;
25200 if (face
->box
!= FACE_NO_BOX
)
25202 int thick
= face
->box_line_width
;
25206 it
->ascent
+= thick
;
25207 it
->descent
+= thick
;
25212 if (it
->start_of_box_run_p
)
25213 it
->pixel_width
+= thick
;
25214 if (it
->end_of_box_run_p
)
25215 it
->pixel_width
+= thick
;
25217 /* If face has an overline, add the height of the overline
25218 (1 pixel) and a 1 pixel margin to the character height. */
25219 if (face
->overline_p
)
25220 it
->ascent
+= overline_margin
;
25221 take_vertical_position_into_account (it
);
25222 if (it
->ascent
< 0)
25224 if (it
->descent
< 0)
25228 append_composite_glyph (it
);
25230 else if (it
->what
== IT_GLYPHLESS
)
25231 produce_glyphless_glyph (it
, 0, Qnil
);
25232 else if (it
->what
== IT_IMAGE
)
25233 produce_image_glyph (it
);
25234 else if (it
->what
== IT_STRETCH
)
25235 produce_stretch_glyph (it
);
25238 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25239 because this isn't true for images with `:ascent 100'. */
25240 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25241 if (it
->area
== TEXT_AREA
)
25242 it
->current_x
+= it
->pixel_width
;
25244 if (extra_line_spacing
> 0)
25246 it
->descent
+= extra_line_spacing
;
25247 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25248 it
->max_extra_line_spacing
= extra_line_spacing
;
25251 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25252 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25253 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25254 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25258 Output LEN glyphs starting at START at the nominal cursor position.
25259 Advance the nominal cursor over the text. The global variable
25260 updated_window contains the window being updated, updated_row is
25261 the glyph row being updated, and updated_area is the area of that
25262 row being updated. */
25265 x_write_glyphs (struct glyph
*start
, int len
)
25267 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25269 eassert (updated_window
&& updated_row
);
25270 /* When the window is hscrolled, cursor hpos can legitimately be out
25271 of bounds, but we draw the cursor at the corresponding window
25272 margin in that case. */
25273 if (!updated_row
->reversed_p
&& chpos
< 0)
25275 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25276 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25280 /* Write glyphs. */
25282 hpos
= start
- updated_row
->glyphs
[updated_area
];
25283 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25284 updated_row
, updated_area
,
25286 DRAW_NORMAL_TEXT
, 0);
25288 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25289 if (updated_area
== TEXT_AREA
25290 && updated_window
->phys_cursor_on_p
25291 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25293 && chpos
< hpos
+ len
)
25294 updated_window
->phys_cursor_on_p
= 0;
25298 /* Advance the output cursor. */
25299 output_cursor
.hpos
+= len
;
25300 output_cursor
.x
= x
;
25305 Insert LEN glyphs from START at the nominal cursor position. */
25308 x_insert_glyphs (struct glyph
*start
, int len
)
25312 int line_height
, shift_by_width
, shifted_region_width
;
25313 struct glyph_row
*row
;
25314 struct glyph
*glyph
;
25315 int frame_x
, frame_y
;
25318 eassert (updated_window
&& updated_row
);
25320 w
= updated_window
;
25321 f
= XFRAME (WINDOW_FRAME (w
));
25323 /* Get the height of the line we are in. */
25325 line_height
= row
->height
;
25327 /* Get the width of the glyphs to insert. */
25328 shift_by_width
= 0;
25329 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25330 shift_by_width
+= glyph
->pixel_width
;
25332 /* Get the width of the region to shift right. */
25333 shifted_region_width
= (window_box_width (w
, updated_area
)
25338 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25339 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25341 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25342 line_height
, shift_by_width
);
25344 /* Write the glyphs. */
25345 hpos
= start
- row
->glyphs
[updated_area
];
25346 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25348 DRAW_NORMAL_TEXT
, 0);
25350 /* Advance the output cursor. */
25351 output_cursor
.hpos
+= len
;
25352 output_cursor
.x
+= shift_by_width
;
25358 Erase the current text line from the nominal cursor position
25359 (inclusive) to pixel column TO_X (exclusive). The idea is that
25360 everything from TO_X onward is already erased.
25362 TO_X is a pixel position relative to updated_area of
25363 updated_window. TO_X == -1 means clear to the end of this area. */
25366 x_clear_end_of_line (int to_x
)
25369 struct window
*w
= updated_window
;
25370 int max_x
, min_y
, max_y
;
25371 int from_x
, from_y
, to_y
;
25373 eassert (updated_window
&& updated_row
);
25374 f
= XFRAME (w
->frame
);
25376 if (updated_row
->full_width_p
)
25377 max_x
= WINDOW_TOTAL_WIDTH (w
);
25379 max_x
= window_box_width (w
, updated_area
);
25380 max_y
= window_text_bottom_y (w
);
25382 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25383 of window. For TO_X > 0, truncate to end of drawing area. */
25389 to_x
= min (to_x
, max_x
);
25391 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25393 /* Notice if the cursor will be cleared by this operation. */
25394 if (!updated_row
->full_width_p
)
25395 notice_overwritten_cursor (w
, updated_area
,
25396 output_cursor
.x
, -1,
25398 MATRIX_ROW_BOTTOM_Y (updated_row
));
25400 from_x
= output_cursor
.x
;
25402 /* Translate to frame coordinates. */
25403 if (updated_row
->full_width_p
)
25405 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25406 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25410 int area_left
= window_box_left (w
, updated_area
);
25411 from_x
+= area_left
;
25415 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25416 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25417 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25419 /* Prevent inadvertently clearing to end of the X window. */
25420 if (to_x
> from_x
&& to_y
> from_y
)
25423 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25424 to_x
- from_x
, to_y
- from_y
);
25429 #endif /* HAVE_WINDOW_SYSTEM */
25433 /***********************************************************************
25435 ***********************************************************************/
25437 /* Value is the internal representation of the specified cursor type
25438 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25439 of the bar cursor. */
25441 static enum text_cursor_kinds
25442 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25444 enum text_cursor_kinds type
;
25449 if (EQ (arg
, Qbox
))
25450 return FILLED_BOX_CURSOR
;
25452 if (EQ (arg
, Qhollow
))
25453 return HOLLOW_BOX_CURSOR
;
25455 if (EQ (arg
, Qbar
))
25462 && EQ (XCAR (arg
), Qbar
)
25463 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25465 *width
= XINT (XCDR (arg
));
25469 if (EQ (arg
, Qhbar
))
25472 return HBAR_CURSOR
;
25476 && EQ (XCAR (arg
), Qhbar
)
25477 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25479 *width
= XINT (XCDR (arg
));
25480 return HBAR_CURSOR
;
25483 /* Treat anything unknown as "hollow box cursor".
25484 It was bad to signal an error; people have trouble fixing
25485 .Xdefaults with Emacs, when it has something bad in it. */
25486 type
= HOLLOW_BOX_CURSOR
;
25491 /* Set the default cursor types for specified frame. */
25493 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25498 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25499 FRAME_CURSOR_WIDTH (f
) = width
;
25501 /* By default, set up the blink-off state depending on the on-state. */
25503 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25506 FRAME_BLINK_OFF_CURSOR (f
)
25507 = get_specified_cursor_type (XCDR (tem
), &width
);
25508 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25511 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25515 #ifdef HAVE_WINDOW_SYSTEM
25517 /* Return the cursor we want to be displayed in window W. Return
25518 width of bar/hbar cursor through WIDTH arg. Return with
25519 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25520 (i.e. if the `system caret' should track this cursor).
25522 In a mini-buffer window, we want the cursor only to appear if we
25523 are reading input from this window. For the selected window, we
25524 want the cursor type given by the frame parameter or buffer local
25525 setting of cursor-type. If explicitly marked off, draw no cursor.
25526 In all other cases, we want a hollow box cursor. */
25528 static enum text_cursor_kinds
25529 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25530 int *active_cursor
)
25532 struct frame
*f
= XFRAME (w
->frame
);
25533 struct buffer
*b
= XBUFFER (w
->buffer
);
25534 int cursor_type
= DEFAULT_CURSOR
;
25535 Lisp_Object alt_cursor
;
25536 int non_selected
= 0;
25538 *active_cursor
= 1;
25541 if (cursor_in_echo_area
25542 && FRAME_HAS_MINIBUF_P (f
)
25543 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25545 if (w
== XWINDOW (echo_area_window
))
25547 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25549 *width
= FRAME_CURSOR_WIDTH (f
);
25550 return FRAME_DESIRED_CURSOR (f
);
25553 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25556 *active_cursor
= 0;
25560 /* Detect a nonselected window or nonselected frame. */
25561 else if (w
!= XWINDOW (f
->selected_window
)
25562 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25564 *active_cursor
= 0;
25566 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25572 /* Never display a cursor in a window in which cursor-type is nil. */
25573 if (NILP (BVAR (b
, cursor_type
)))
25576 /* Get the normal cursor type for this window. */
25577 if (EQ (BVAR (b
, cursor_type
), Qt
))
25579 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25580 *width
= FRAME_CURSOR_WIDTH (f
);
25583 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25585 /* Use cursor-in-non-selected-windows instead
25586 for non-selected window or frame. */
25589 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25590 if (!EQ (Qt
, alt_cursor
))
25591 return get_specified_cursor_type (alt_cursor
, width
);
25592 /* t means modify the normal cursor type. */
25593 if (cursor_type
== FILLED_BOX_CURSOR
)
25594 cursor_type
= HOLLOW_BOX_CURSOR
;
25595 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25597 return cursor_type
;
25600 /* Use normal cursor if not blinked off. */
25601 if (!w
->cursor_off_p
)
25603 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25605 if (cursor_type
== FILLED_BOX_CURSOR
)
25607 /* Using a block cursor on large images can be very annoying.
25608 So use a hollow cursor for "large" images.
25609 If image is not transparent (no mask), also use hollow cursor. */
25610 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25611 if (img
!= NULL
&& IMAGEP (img
->spec
))
25613 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25614 where N = size of default frame font size.
25615 This should cover most of the "tiny" icons people may use. */
25617 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25618 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25619 cursor_type
= HOLLOW_BOX_CURSOR
;
25622 else if (cursor_type
!= NO_CURSOR
)
25624 /* Display current only supports BOX and HOLLOW cursors for images.
25625 So for now, unconditionally use a HOLLOW cursor when cursor is
25626 not a solid box cursor. */
25627 cursor_type
= HOLLOW_BOX_CURSOR
;
25630 return cursor_type
;
25633 /* Cursor is blinked off, so determine how to "toggle" it. */
25635 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25636 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25637 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25639 /* Then see if frame has specified a specific blink off cursor type. */
25640 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25642 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25643 return FRAME_BLINK_OFF_CURSOR (f
);
25647 /* Some people liked having a permanently visible blinking cursor,
25648 while others had very strong opinions against it. So it was
25649 decided to remove it. KFS 2003-09-03 */
25651 /* Finally perform built-in cursor blinking:
25652 filled box <-> hollow box
25653 wide [h]bar <-> narrow [h]bar
25654 narrow [h]bar <-> no cursor
25655 other type <-> no cursor */
25657 if (cursor_type
== FILLED_BOX_CURSOR
)
25658 return HOLLOW_BOX_CURSOR
;
25660 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25663 return cursor_type
;
25671 /* Notice when the text cursor of window W has been completely
25672 overwritten by a drawing operation that outputs glyphs in AREA
25673 starting at X0 and ending at X1 in the line starting at Y0 and
25674 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25675 the rest of the line after X0 has been written. Y coordinates
25676 are window-relative. */
25679 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25680 int x0
, int x1
, int y0
, int y1
)
25682 int cx0
, cx1
, cy0
, cy1
;
25683 struct glyph_row
*row
;
25685 if (!w
->phys_cursor_on_p
)
25687 if (area
!= TEXT_AREA
)
25690 if (w
->phys_cursor
.vpos
< 0
25691 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25692 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25693 !(row
->enabled_p
&& row
->displays_text_p
)))
25696 if (row
->cursor_in_fringe_p
)
25698 row
->cursor_in_fringe_p
= 0;
25699 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25700 w
->phys_cursor_on_p
= 0;
25704 cx0
= w
->phys_cursor
.x
;
25705 cx1
= cx0
+ w
->phys_cursor_width
;
25706 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25709 /* The cursor image will be completely removed from the
25710 screen if the output area intersects the cursor area in
25711 y-direction. When we draw in [y0 y1[, and some part of
25712 the cursor is at y < y0, that part must have been drawn
25713 before. When scrolling, the cursor is erased before
25714 actually scrolling, so we don't come here. When not
25715 scrolling, the rows above the old cursor row must have
25716 changed, and in this case these rows must have written
25717 over the cursor image.
25719 Likewise if part of the cursor is below y1, with the
25720 exception of the cursor being in the first blank row at
25721 the buffer and window end because update_text_area
25722 doesn't draw that row. (Except when it does, but
25723 that's handled in update_text_area.) */
25725 cy0
= w
->phys_cursor
.y
;
25726 cy1
= cy0
+ w
->phys_cursor_height
;
25727 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25730 w
->phys_cursor_on_p
= 0;
25733 #endif /* HAVE_WINDOW_SYSTEM */
25736 /************************************************************************
25738 ************************************************************************/
25740 #ifdef HAVE_WINDOW_SYSTEM
25743 Fix the display of area AREA of overlapping row ROW in window W
25744 with respect to the overlapping part OVERLAPS. */
25747 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25748 enum glyph_row_area area
, int overlaps
)
25755 for (i
= 0; i
< row
->used
[area
];)
25757 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25759 int start
= i
, start_x
= x
;
25763 x
+= row
->glyphs
[area
][i
].pixel_width
;
25766 while (i
< row
->used
[area
]
25767 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25769 draw_glyphs (w
, start_x
, row
, area
,
25771 DRAW_NORMAL_TEXT
, overlaps
);
25775 x
+= row
->glyphs
[area
][i
].pixel_width
;
25785 Draw the cursor glyph of window W in glyph row ROW. See the
25786 comment of draw_glyphs for the meaning of HL. */
25789 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25790 enum draw_glyphs_face hl
)
25792 /* If cursor hpos is out of bounds, don't draw garbage. This can
25793 happen in mini-buffer windows when switching between echo area
25794 glyphs and mini-buffer. */
25795 if ((row
->reversed_p
25796 ? (w
->phys_cursor
.hpos
>= 0)
25797 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25799 int on_p
= w
->phys_cursor_on_p
;
25801 int hpos
= w
->phys_cursor
.hpos
;
25803 /* When the window is hscrolled, cursor hpos can legitimately be
25804 out of bounds, but we draw the cursor at the corresponding
25805 window margin in that case. */
25806 if (!row
->reversed_p
&& hpos
< 0)
25808 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25809 hpos
= row
->used
[TEXT_AREA
] - 1;
25811 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25813 w
->phys_cursor_on_p
= on_p
;
25815 if (hl
== DRAW_CURSOR
)
25816 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25817 /* When we erase the cursor, and ROW is overlapped by other
25818 rows, make sure that these overlapping parts of other rows
25820 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25822 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25824 if (row
> w
->current_matrix
->rows
25825 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25826 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25827 OVERLAPS_ERASED_CURSOR
);
25829 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25830 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25831 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25832 OVERLAPS_ERASED_CURSOR
);
25839 Erase the image of a cursor of window W from the screen. */
25842 erase_phys_cursor (struct window
*w
)
25844 struct frame
*f
= XFRAME (w
->frame
);
25845 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25846 int hpos
= w
->phys_cursor
.hpos
;
25847 int vpos
= w
->phys_cursor
.vpos
;
25848 int mouse_face_here_p
= 0;
25849 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25850 struct glyph_row
*cursor_row
;
25851 struct glyph
*cursor_glyph
;
25852 enum draw_glyphs_face hl
;
25854 /* No cursor displayed or row invalidated => nothing to do on the
25856 if (w
->phys_cursor_type
== NO_CURSOR
)
25857 goto mark_cursor_off
;
25859 /* VPOS >= active_glyphs->nrows means that window has been resized.
25860 Don't bother to erase the cursor. */
25861 if (vpos
>= active_glyphs
->nrows
)
25862 goto mark_cursor_off
;
25864 /* If row containing cursor is marked invalid, there is nothing we
25866 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25867 if (!cursor_row
->enabled_p
)
25868 goto mark_cursor_off
;
25870 /* If line spacing is > 0, old cursor may only be partially visible in
25871 window after split-window. So adjust visible height. */
25872 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25873 window_text_bottom_y (w
) - cursor_row
->y
);
25875 /* If row is completely invisible, don't attempt to delete a cursor which
25876 isn't there. This can happen if cursor is at top of a window, and
25877 we switch to a buffer with a header line in that window. */
25878 if (cursor_row
->visible_height
<= 0)
25879 goto mark_cursor_off
;
25881 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25882 if (cursor_row
->cursor_in_fringe_p
)
25884 cursor_row
->cursor_in_fringe_p
= 0;
25885 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25886 goto mark_cursor_off
;
25889 /* This can happen when the new row is shorter than the old one.
25890 In this case, either draw_glyphs or clear_end_of_line
25891 should have cleared the cursor. Note that we wouldn't be
25892 able to erase the cursor in this case because we don't have a
25893 cursor glyph at hand. */
25894 if ((cursor_row
->reversed_p
25895 ? (w
->phys_cursor
.hpos
< 0)
25896 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25897 goto mark_cursor_off
;
25899 /* When the window is hscrolled, cursor hpos can legitimately be out
25900 of bounds, but we draw the cursor at the corresponding window
25901 margin in that case. */
25902 if (!cursor_row
->reversed_p
&& hpos
< 0)
25904 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25905 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25907 /* If the cursor is in the mouse face area, redisplay that when
25908 we clear the cursor. */
25909 if (! NILP (hlinfo
->mouse_face_window
)
25910 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25911 /* Don't redraw the cursor's spot in mouse face if it is at the
25912 end of a line (on a newline). The cursor appears there, but
25913 mouse highlighting does not. */
25914 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25915 mouse_face_here_p
= 1;
25917 /* Maybe clear the display under the cursor. */
25918 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25921 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25924 cursor_glyph
= get_phys_cursor_glyph (w
);
25925 if (cursor_glyph
== NULL
)
25926 goto mark_cursor_off
;
25928 width
= cursor_glyph
->pixel_width
;
25929 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25930 x
= w
->phys_cursor
.x
;
25932 width
-= left_x
- x
;
25933 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25934 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25935 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25938 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25941 /* Erase the cursor by redrawing the character underneath it. */
25942 if (mouse_face_here_p
)
25943 hl
= DRAW_MOUSE_FACE
;
25945 hl
= DRAW_NORMAL_TEXT
;
25946 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25949 w
->phys_cursor_on_p
= 0;
25950 w
->phys_cursor_type
= NO_CURSOR
;
25955 Display or clear cursor of window W. If ON is zero, clear the
25956 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25957 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25960 display_and_set_cursor (struct window
*w
, int on
,
25961 int hpos
, int vpos
, int x
, int y
)
25963 struct frame
*f
= XFRAME (w
->frame
);
25964 int new_cursor_type
;
25965 int new_cursor_width
;
25967 struct glyph_row
*glyph_row
;
25968 struct glyph
*glyph
;
25970 /* This is pointless on invisible frames, and dangerous on garbaged
25971 windows and frames; in the latter case, the frame or window may
25972 be in the midst of changing its size, and x and y may be off the
25974 if (! FRAME_VISIBLE_P (f
)
25975 || FRAME_GARBAGED_P (f
)
25976 || vpos
>= w
->current_matrix
->nrows
25977 || hpos
>= w
->current_matrix
->matrix_w
)
25980 /* If cursor is off and we want it off, return quickly. */
25981 if (!on
&& !w
->phys_cursor_on_p
)
25984 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25985 /* If cursor row is not enabled, we don't really know where to
25986 display the cursor. */
25987 if (!glyph_row
->enabled_p
)
25989 w
->phys_cursor_on_p
= 0;
25994 if (!glyph_row
->exact_window_width_line_p
25995 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25996 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25998 eassert (interrupt_input_blocked
);
26000 /* Set new_cursor_type to the cursor we want to be displayed. */
26001 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26002 &new_cursor_width
, &active_cursor
);
26004 /* If cursor is currently being shown and we don't want it to be or
26005 it is in the wrong place, or the cursor type is not what we want,
26007 if (w
->phys_cursor_on_p
26009 || w
->phys_cursor
.x
!= x
26010 || w
->phys_cursor
.y
!= y
26011 || new_cursor_type
!= w
->phys_cursor_type
26012 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26013 && new_cursor_width
!= w
->phys_cursor_width
)))
26014 erase_phys_cursor (w
);
26016 /* Don't check phys_cursor_on_p here because that flag is only set
26017 to zero in some cases where we know that the cursor has been
26018 completely erased, to avoid the extra work of erasing the cursor
26019 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26020 still not be visible, or it has only been partly erased. */
26023 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26024 w
->phys_cursor_height
= glyph_row
->height
;
26026 /* Set phys_cursor_.* before x_draw_.* is called because some
26027 of them may need the information. */
26028 w
->phys_cursor
.x
= x
;
26029 w
->phys_cursor
.y
= glyph_row
->y
;
26030 w
->phys_cursor
.hpos
= hpos
;
26031 w
->phys_cursor
.vpos
= vpos
;
26034 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26035 new_cursor_type
, new_cursor_width
,
26036 on
, active_cursor
);
26040 /* Switch the display of W's cursor on or off, according to the value
26044 update_window_cursor (struct window
*w
, int on
)
26046 /* Don't update cursor in windows whose frame is in the process
26047 of being deleted. */
26048 if (w
->current_matrix
)
26050 int hpos
= w
->phys_cursor
.hpos
;
26051 int vpos
= w
->phys_cursor
.vpos
;
26052 struct glyph_row
*row
;
26054 if (vpos
>= w
->current_matrix
->nrows
26055 || hpos
>= w
->current_matrix
->matrix_w
)
26058 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26060 /* When the window is hscrolled, cursor hpos can legitimately be
26061 out of bounds, but we draw the cursor at the corresponding
26062 window margin in that case. */
26063 if (!row
->reversed_p
&& hpos
< 0)
26065 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26066 hpos
= row
->used
[TEXT_AREA
] - 1;
26069 display_and_set_cursor (w
, on
, hpos
, vpos
,
26070 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26076 /* Call update_window_cursor with parameter ON_P on all leaf windows
26077 in the window tree rooted at W. */
26080 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26084 if (!NILP (w
->hchild
))
26085 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26086 else if (!NILP (w
->vchild
))
26087 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26089 update_window_cursor (w
, on_p
);
26091 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26097 Display the cursor on window W, or clear it, according to ON_P.
26098 Don't change the cursor's position. */
26101 x_update_cursor (struct frame
*f
, int on_p
)
26103 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26108 Clear the cursor of window W to background color, and mark the
26109 cursor as not shown. This is used when the text where the cursor
26110 is about to be rewritten. */
26113 x_clear_cursor (struct window
*w
)
26115 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26116 update_window_cursor (w
, 0);
26119 #endif /* HAVE_WINDOW_SYSTEM */
26121 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26124 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26125 int start_hpos
, int end_hpos
,
26126 enum draw_glyphs_face draw
)
26128 #ifdef HAVE_WINDOW_SYSTEM
26129 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26131 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26135 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26136 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26140 /* Display the active region described by mouse_face_* according to DRAW. */
26143 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26145 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26146 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26148 if (/* If window is in the process of being destroyed, don't bother
26150 w
->current_matrix
!= NULL
26151 /* Don't update mouse highlight if hidden */
26152 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26153 /* Recognize when we are called to operate on rows that don't exist
26154 anymore. This can happen when a window is split. */
26155 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26157 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26158 struct glyph_row
*row
, *first
, *last
;
26160 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26161 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26163 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26165 int start_hpos
, end_hpos
, start_x
;
26167 /* For all but the first row, the highlight starts at column 0. */
26170 /* R2L rows have BEG and END in reversed order, but the
26171 screen drawing geometry is always left to right. So
26172 we need to mirror the beginning and end of the
26173 highlighted area in R2L rows. */
26174 if (!row
->reversed_p
)
26176 start_hpos
= hlinfo
->mouse_face_beg_col
;
26177 start_x
= hlinfo
->mouse_face_beg_x
;
26179 else if (row
== last
)
26181 start_hpos
= hlinfo
->mouse_face_end_col
;
26182 start_x
= hlinfo
->mouse_face_end_x
;
26190 else if (row
->reversed_p
&& row
== last
)
26192 start_hpos
= hlinfo
->mouse_face_end_col
;
26193 start_x
= hlinfo
->mouse_face_end_x
;
26203 if (!row
->reversed_p
)
26204 end_hpos
= hlinfo
->mouse_face_end_col
;
26205 else if (row
== first
)
26206 end_hpos
= hlinfo
->mouse_face_beg_col
;
26209 end_hpos
= row
->used
[TEXT_AREA
];
26210 if (draw
== DRAW_NORMAL_TEXT
)
26211 row
->fill_line_p
= 1; /* Clear to end of line */
26214 else if (row
->reversed_p
&& row
== first
)
26215 end_hpos
= hlinfo
->mouse_face_beg_col
;
26218 end_hpos
= row
->used
[TEXT_AREA
];
26219 if (draw
== DRAW_NORMAL_TEXT
)
26220 row
->fill_line_p
= 1; /* Clear to end of line */
26223 if (end_hpos
> start_hpos
)
26225 draw_row_with_mouse_face (w
, start_x
, row
,
26226 start_hpos
, end_hpos
, draw
);
26229 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26233 #ifdef HAVE_WINDOW_SYSTEM
26234 /* When we've written over the cursor, arrange for it to
26235 be displayed again. */
26236 if (FRAME_WINDOW_P (f
)
26237 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26239 int hpos
= w
->phys_cursor
.hpos
;
26241 /* When the window is hscrolled, cursor hpos can legitimately be
26242 out of bounds, but we draw the cursor at the corresponding
26243 window margin in that case. */
26244 if (!row
->reversed_p
&& hpos
< 0)
26246 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26247 hpos
= row
->used
[TEXT_AREA
] - 1;
26250 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26251 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26254 #endif /* HAVE_WINDOW_SYSTEM */
26257 #ifdef HAVE_WINDOW_SYSTEM
26258 /* Change the mouse cursor. */
26259 if (FRAME_WINDOW_P (f
))
26261 if (draw
== DRAW_NORMAL_TEXT
26262 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26263 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26264 else if (draw
== DRAW_MOUSE_FACE
)
26265 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26267 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26269 #endif /* HAVE_WINDOW_SYSTEM */
26273 Clear out the mouse-highlighted active region.
26274 Redraw it un-highlighted first. Value is non-zero if mouse
26275 face was actually drawn unhighlighted. */
26278 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26282 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26284 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26288 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26289 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26290 hlinfo
->mouse_face_window
= Qnil
;
26291 hlinfo
->mouse_face_overlay
= Qnil
;
26295 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26296 within the mouse face on that window. */
26298 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26300 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26302 /* Quickly resolve the easy cases. */
26303 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26304 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26306 if (vpos
< hlinfo
->mouse_face_beg_row
26307 || vpos
> hlinfo
->mouse_face_end_row
)
26309 if (vpos
> hlinfo
->mouse_face_beg_row
26310 && vpos
< hlinfo
->mouse_face_end_row
)
26313 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26315 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26317 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26320 else if ((vpos
== hlinfo
->mouse_face_beg_row
26321 && hpos
>= hlinfo
->mouse_face_beg_col
)
26322 || (vpos
== hlinfo
->mouse_face_end_row
26323 && hpos
< hlinfo
->mouse_face_end_col
))
26328 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26330 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26333 else if ((vpos
== hlinfo
->mouse_face_beg_row
26334 && hpos
<= hlinfo
->mouse_face_beg_col
)
26335 || (vpos
== hlinfo
->mouse_face_end_row
26336 && hpos
> hlinfo
->mouse_face_end_col
))
26344 Non-zero if physical cursor of window W is within mouse face. */
26347 cursor_in_mouse_face_p (struct window
*w
)
26349 int hpos
= w
->phys_cursor
.hpos
;
26350 int vpos
= w
->phys_cursor
.vpos
;
26351 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26353 /* When the window is hscrolled, cursor hpos can legitimately be out
26354 of bounds, but we draw the cursor at the corresponding window
26355 margin in that case. */
26356 if (!row
->reversed_p
&& hpos
< 0)
26358 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26359 hpos
= row
->used
[TEXT_AREA
] - 1;
26361 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26366 /* Find the glyph rows START_ROW and END_ROW of window W that display
26367 characters between buffer positions START_CHARPOS and END_CHARPOS
26368 (excluding END_CHARPOS). DISP_STRING is a display string that
26369 covers these buffer positions. This is similar to
26370 row_containing_pos, but is more accurate when bidi reordering makes
26371 buffer positions change non-linearly with glyph rows. */
26373 rows_from_pos_range (struct window
*w
,
26374 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26375 Lisp_Object disp_string
,
26376 struct glyph_row
**start
, struct glyph_row
**end
)
26378 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26379 int last_y
= window_text_bottom_y (w
);
26380 struct glyph_row
*row
;
26385 while (!first
->enabled_p
26386 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26389 /* Find the START row. */
26391 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26394 /* A row can potentially be the START row if the range of the
26395 characters it displays intersects the range
26396 [START_CHARPOS..END_CHARPOS). */
26397 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26398 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26399 /* See the commentary in row_containing_pos, for the
26400 explanation of the complicated way to check whether
26401 some position is beyond the end of the characters
26402 displayed by a row. */
26403 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26404 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26405 && !row
->ends_at_zv_p
26406 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26407 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26408 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26409 && !row
->ends_at_zv_p
26410 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26412 /* Found a candidate row. Now make sure at least one of the
26413 glyphs it displays has a charpos from the range
26414 [START_CHARPOS..END_CHARPOS).
26416 This is not obvious because bidi reordering could make
26417 buffer positions of a row be 1,2,3,102,101,100, and if we
26418 want to highlight characters in [50..60), we don't want
26419 this row, even though [50..60) does intersect [1..103),
26420 the range of character positions given by the row's start
26421 and end positions. */
26422 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26423 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26427 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26428 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26429 /* A glyph that comes from DISP_STRING is by
26430 definition to be highlighted. */
26431 || EQ (g
->object
, disp_string
))
26440 /* Find the END row. */
26442 /* If the last row is partially visible, start looking for END
26443 from that row, instead of starting from FIRST. */
26444 && !(row
->enabled_p
26445 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26447 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26449 struct glyph_row
*next
= row
+ 1;
26450 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26452 if (!next
->enabled_p
26453 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26454 /* The first row >= START whose range of displayed characters
26455 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26456 is the row END + 1. */
26457 || (start_charpos
< next_start
26458 && end_charpos
< next_start
)
26459 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26460 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26461 && !next
->ends_at_zv_p
26462 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26463 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26464 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26465 && !next
->ends_at_zv_p
26466 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26473 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26474 but none of the characters it displays are in the range, it is
26476 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26477 struct glyph
*s
= g
;
26478 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26482 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26483 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26484 /* If the buffer position of the first glyph in
26485 the row is equal to END_CHARPOS, it means
26486 the last character to be highlighted is the
26487 newline of ROW, and we must consider NEXT as
26489 || (((!next
->reversed_p
&& g
== s
)
26490 || (next
->reversed_p
&& g
== e
- 1))
26491 && (g
->charpos
== end_charpos
26492 /* Special case for when NEXT is an
26493 empty line at ZV. */
26494 || (g
->charpos
== -1
26495 && !row
->ends_at_zv_p
26496 && next_start
== end_charpos
)))))
26497 /* A glyph that comes from DISP_STRING is by
26498 definition to be highlighted. */
26499 || EQ (g
->object
, disp_string
))
26508 /* The first row that ends at ZV must be the last to be
26510 else if (next
->ends_at_zv_p
)
26519 /* This function sets the mouse_face_* elements of HLINFO, assuming
26520 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26521 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26522 for the overlay or run of text properties specifying the mouse
26523 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26524 before-string and after-string that must also be highlighted.
26525 DISP_STRING, if non-nil, is a display string that may cover some
26526 or all of the highlighted text. */
26529 mouse_face_from_buffer_pos (Lisp_Object window
,
26530 Mouse_HLInfo
*hlinfo
,
26531 ptrdiff_t mouse_charpos
,
26532 ptrdiff_t start_charpos
,
26533 ptrdiff_t end_charpos
,
26534 Lisp_Object before_string
,
26535 Lisp_Object after_string
,
26536 Lisp_Object disp_string
)
26538 struct window
*w
= XWINDOW (window
);
26539 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26540 struct glyph_row
*r1
, *r2
;
26541 struct glyph
*glyph
, *end
;
26542 ptrdiff_t ignore
, pos
;
26545 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26546 eassert (NILP (before_string
) || STRINGP (before_string
));
26547 eassert (NILP (after_string
) || STRINGP (after_string
));
26549 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26550 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26552 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26553 /* If the before-string or display-string contains newlines,
26554 rows_from_pos_range skips to its last row. Move back. */
26555 if (!NILP (before_string
) || !NILP (disp_string
))
26557 struct glyph_row
*prev
;
26558 while ((prev
= r1
- 1, prev
>= first
)
26559 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26560 && prev
->used
[TEXT_AREA
] > 0)
26562 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26563 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26564 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26566 || !(EQ (glyph
->object
, before_string
)
26567 || EQ (glyph
->object
, disp_string
)))
26574 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26575 hlinfo
->mouse_face_past_end
= 1;
26577 else if (!NILP (after_string
))
26579 /* If the after-string has newlines, advance to its last row. */
26580 struct glyph_row
*next
;
26581 struct glyph_row
*last
26582 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26584 for (next
= r2
+ 1;
26586 && next
->used
[TEXT_AREA
] > 0
26587 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26591 /* The rest of the display engine assumes that mouse_face_beg_row is
26592 either above mouse_face_end_row or identical to it. But with
26593 bidi-reordered continued lines, the row for START_CHARPOS could
26594 be below the row for END_CHARPOS. If so, swap the rows and store
26595 them in correct order. */
26598 struct glyph_row
*tem
= r2
;
26604 hlinfo
->mouse_face_beg_y
= r1
->y
;
26605 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26606 hlinfo
->mouse_face_end_y
= r2
->y
;
26607 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26609 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26610 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26611 could be anywhere in the row and in any order. The strategy
26612 below is to find the leftmost and the rightmost glyph that
26613 belongs to either of these 3 strings, or whose position is
26614 between START_CHARPOS and END_CHARPOS, and highlight all the
26615 glyphs between those two. This may cover more than just the text
26616 between START_CHARPOS and END_CHARPOS if the range of characters
26617 strides the bidi level boundary, e.g. if the beginning is in R2L
26618 text while the end is in L2R text or vice versa. */
26619 if (!r1
->reversed_p
)
26621 /* This row is in a left to right paragraph. Scan it left to
26623 glyph
= r1
->glyphs
[TEXT_AREA
];
26624 end
= glyph
+ r1
->used
[TEXT_AREA
];
26627 /* Skip truncation glyphs at the start of the glyph row. */
26628 if (r1
->displays_text_p
)
26630 && INTEGERP (glyph
->object
)
26631 && glyph
->charpos
< 0;
26633 x
+= glyph
->pixel_width
;
26635 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26636 or DISP_STRING, and the first glyph from buffer whose
26637 position is between START_CHARPOS and END_CHARPOS. */
26639 && !INTEGERP (glyph
->object
)
26640 && !EQ (glyph
->object
, disp_string
)
26641 && !(BUFFERP (glyph
->object
)
26642 && (glyph
->charpos
>= start_charpos
26643 && glyph
->charpos
< end_charpos
));
26646 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26647 are present at buffer positions between START_CHARPOS and
26648 END_CHARPOS, or if they come from an overlay. */
26649 if (EQ (glyph
->object
, before_string
))
26651 pos
= string_buffer_position (before_string
,
26653 /* If pos == 0, it means before_string came from an
26654 overlay, not from a buffer position. */
26655 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26658 else if (EQ (glyph
->object
, after_string
))
26660 pos
= string_buffer_position (after_string
, end_charpos
);
26661 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26664 x
+= glyph
->pixel_width
;
26666 hlinfo
->mouse_face_beg_x
= x
;
26667 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26671 /* This row is in a right to left paragraph. Scan it right to
26675 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26676 glyph
= end
+ r1
->used
[TEXT_AREA
];
26678 /* Skip truncation glyphs at the start of the glyph row. */
26679 if (r1
->displays_text_p
)
26681 && INTEGERP (glyph
->object
)
26682 && glyph
->charpos
< 0;
26686 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26687 or DISP_STRING, and the first glyph from buffer whose
26688 position is between START_CHARPOS and END_CHARPOS. */
26690 && !INTEGERP (glyph
->object
)
26691 && !EQ (glyph
->object
, disp_string
)
26692 && !(BUFFERP (glyph
->object
)
26693 && (glyph
->charpos
>= start_charpos
26694 && glyph
->charpos
< end_charpos
));
26697 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26698 are present at buffer positions between START_CHARPOS and
26699 END_CHARPOS, or if they come from an overlay. */
26700 if (EQ (glyph
->object
, before_string
))
26702 pos
= string_buffer_position (before_string
, start_charpos
);
26703 /* If pos == 0, it means before_string came from an
26704 overlay, not from a buffer position. */
26705 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26708 else if (EQ (glyph
->object
, after_string
))
26710 pos
= string_buffer_position (after_string
, end_charpos
);
26711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26716 glyph
++; /* first glyph to the right of the highlighted area */
26717 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26718 x
+= g
->pixel_width
;
26719 hlinfo
->mouse_face_beg_x
= x
;
26720 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26723 /* If the highlight ends in a different row, compute GLYPH and END
26724 for the end row. Otherwise, reuse the values computed above for
26725 the row where the highlight begins. */
26728 if (!r2
->reversed_p
)
26730 glyph
= r2
->glyphs
[TEXT_AREA
];
26731 end
= glyph
+ r2
->used
[TEXT_AREA
];
26736 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26737 glyph
= end
+ r2
->used
[TEXT_AREA
];
26741 if (!r2
->reversed_p
)
26743 /* Skip truncation and continuation glyphs near the end of the
26744 row, and also blanks and stretch glyphs inserted by
26745 extend_face_to_end_of_line. */
26747 && INTEGERP ((end
- 1)->object
))
26749 /* Scan the rest of the glyph row from the end, looking for the
26750 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26751 DISP_STRING, or whose position is between START_CHARPOS
26755 && !INTEGERP (end
->object
)
26756 && !EQ (end
->object
, disp_string
)
26757 && !(BUFFERP (end
->object
)
26758 && (end
->charpos
>= start_charpos
26759 && end
->charpos
< end_charpos
));
26762 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26763 are present at buffer positions between START_CHARPOS and
26764 END_CHARPOS, or if they come from an overlay. */
26765 if (EQ (end
->object
, before_string
))
26767 pos
= string_buffer_position (before_string
, start_charpos
);
26768 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26771 else if (EQ (end
->object
, after_string
))
26773 pos
= string_buffer_position (after_string
, end_charpos
);
26774 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26778 /* Find the X coordinate of the last glyph to be highlighted. */
26779 for (; glyph
<= end
; ++glyph
)
26780 x
+= glyph
->pixel_width
;
26782 hlinfo
->mouse_face_end_x
= x
;
26783 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26787 /* Skip truncation and continuation glyphs near the end of the
26788 row, and also blanks and stretch glyphs inserted by
26789 extend_face_to_end_of_line. */
26793 && INTEGERP (end
->object
))
26795 x
+= end
->pixel_width
;
26798 /* Scan the rest of the glyph row from the end, looking for the
26799 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26800 DISP_STRING, or whose position is between START_CHARPOS
26804 && !INTEGERP (end
->object
)
26805 && !EQ (end
->object
, disp_string
)
26806 && !(BUFFERP (end
->object
)
26807 && (end
->charpos
>= start_charpos
26808 && end
->charpos
< end_charpos
));
26811 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26812 are present at buffer positions between START_CHARPOS and
26813 END_CHARPOS, or if they come from an overlay. */
26814 if (EQ (end
->object
, before_string
))
26816 pos
= string_buffer_position (before_string
, start_charpos
);
26817 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26820 else if (EQ (end
->object
, after_string
))
26822 pos
= string_buffer_position (after_string
, end_charpos
);
26823 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26826 x
+= end
->pixel_width
;
26828 /* If we exited the above loop because we arrived at the last
26829 glyph of the row, and its buffer position is still not in
26830 range, it means the last character in range is the preceding
26831 newline. Bump the end column and x values to get past the
26834 && BUFFERP (end
->object
)
26835 && (end
->charpos
< start_charpos
26836 || end
->charpos
>= end_charpos
))
26838 x
+= end
->pixel_width
;
26841 hlinfo
->mouse_face_end_x
= x
;
26842 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26845 hlinfo
->mouse_face_window
= window
;
26846 hlinfo
->mouse_face_face_id
26847 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26849 !hlinfo
->mouse_face_hidden
, -1);
26850 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26853 /* The following function is not used anymore (replaced with
26854 mouse_face_from_string_pos), but I leave it here for the time
26855 being, in case someone would. */
26857 #if 0 /* not used */
26859 /* Find the position of the glyph for position POS in OBJECT in
26860 window W's current matrix, and return in *X, *Y the pixel
26861 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26863 RIGHT_P non-zero means return the position of the right edge of the
26864 glyph, RIGHT_P zero means return the left edge position.
26866 If no glyph for POS exists in the matrix, return the position of
26867 the glyph with the next smaller position that is in the matrix, if
26868 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26869 exists in the matrix, return the position of the glyph with the
26870 next larger position in OBJECT.
26872 Value is non-zero if a glyph was found. */
26875 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26876 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26878 int yb
= window_text_bottom_y (w
);
26879 struct glyph_row
*r
;
26880 struct glyph
*best_glyph
= NULL
;
26881 struct glyph_row
*best_row
= NULL
;
26884 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26885 r
->enabled_p
&& r
->y
< yb
;
26888 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26889 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26892 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26893 if (EQ (g
->object
, object
))
26895 if (g
->charpos
== pos
)
26902 else if (best_glyph
== NULL
26903 || ((eabs (g
->charpos
- pos
)
26904 < eabs (best_glyph
->charpos
- pos
))
26907 : g
->charpos
> pos
)))
26921 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26925 *x
+= best_glyph
->pixel_width
;
26930 *vpos
= best_row
- w
->current_matrix
->rows
;
26933 return best_glyph
!= NULL
;
26935 #endif /* not used */
26937 /* Find the positions of the first and the last glyphs in window W's
26938 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26939 (assumed to be a string), and return in HLINFO's mouse_face_*
26940 members the pixel and column/row coordinates of those glyphs. */
26943 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26944 Lisp_Object object
,
26945 ptrdiff_t startpos
, ptrdiff_t endpos
)
26947 int yb
= window_text_bottom_y (w
);
26948 struct glyph_row
*r
;
26949 struct glyph
*g
, *e
;
26953 /* Find the glyph row with at least one position in the range
26954 [STARTPOS..ENDPOS], and the first glyph in that row whose
26955 position belongs to that range. */
26956 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26957 r
->enabled_p
&& r
->y
< yb
;
26960 if (!r
->reversed_p
)
26962 g
= r
->glyphs
[TEXT_AREA
];
26963 e
= g
+ r
->used
[TEXT_AREA
];
26964 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26965 if (EQ (g
->object
, object
)
26966 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26968 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26969 hlinfo
->mouse_face_beg_y
= r
->y
;
26970 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26971 hlinfo
->mouse_face_beg_x
= gx
;
26980 e
= r
->glyphs
[TEXT_AREA
];
26981 g
= e
+ r
->used
[TEXT_AREA
];
26982 for ( ; g
> e
; --g
)
26983 if (EQ ((g
-1)->object
, object
)
26984 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26986 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26987 hlinfo
->mouse_face_beg_y
= r
->y
;
26988 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26989 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26990 gx
+= g1
->pixel_width
;
26991 hlinfo
->mouse_face_beg_x
= gx
;
27003 /* Starting with the next row, look for the first row which does NOT
27004 include any glyphs whose positions are in the range. */
27005 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27007 g
= r
->glyphs
[TEXT_AREA
];
27008 e
= g
+ r
->used
[TEXT_AREA
];
27010 for ( ; g
< e
; ++g
)
27011 if (EQ (g
->object
, object
)
27012 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27021 /* The highlighted region ends on the previous row. */
27024 /* Set the end row and its vertical pixel coordinate. */
27025 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27026 hlinfo
->mouse_face_end_y
= r
->y
;
27028 /* Compute and set the end column and the end column's horizontal
27029 pixel coordinate. */
27030 if (!r
->reversed_p
)
27032 g
= r
->glyphs
[TEXT_AREA
];
27033 e
= g
+ r
->used
[TEXT_AREA
];
27034 for ( ; e
> g
; --e
)
27035 if (EQ ((e
-1)->object
, object
)
27036 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27038 hlinfo
->mouse_face_end_col
= e
- g
;
27040 for (gx
= r
->x
; g
< e
; ++g
)
27041 gx
+= g
->pixel_width
;
27042 hlinfo
->mouse_face_end_x
= gx
;
27046 e
= r
->glyphs
[TEXT_AREA
];
27047 g
= e
+ r
->used
[TEXT_AREA
];
27048 for (gx
= r
->x
; e
< g
; ++e
)
27050 if (EQ (e
->object
, object
)
27051 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27053 gx
+= e
->pixel_width
;
27055 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27056 hlinfo
->mouse_face_end_x
= gx
;
27060 #ifdef HAVE_WINDOW_SYSTEM
27062 /* See if position X, Y is within a hot-spot of an image. */
27065 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27067 if (!CONSP (hot_spot
))
27070 if (EQ (XCAR (hot_spot
), Qrect
))
27072 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27073 Lisp_Object rect
= XCDR (hot_spot
);
27077 if (!CONSP (XCAR (rect
)))
27079 if (!CONSP (XCDR (rect
)))
27081 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27083 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27085 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27087 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27091 else if (EQ (XCAR (hot_spot
), Qcircle
))
27093 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27094 Lisp_Object circ
= XCDR (hot_spot
);
27095 Lisp_Object lr
, lx0
, ly0
;
27097 && CONSP (XCAR (circ
))
27098 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27099 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27100 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27102 double r
= XFLOATINT (lr
);
27103 double dx
= XINT (lx0
) - x
;
27104 double dy
= XINT (ly0
) - y
;
27105 return (dx
* dx
+ dy
* dy
<= r
* r
);
27108 else if (EQ (XCAR (hot_spot
), Qpoly
))
27110 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27111 if (VECTORP (XCDR (hot_spot
)))
27113 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27114 Lisp_Object
*poly
= v
->contents
;
27115 ptrdiff_t n
= v
->header
.size
;
27118 Lisp_Object lx
, ly
;
27121 /* Need an even number of coordinates, and at least 3 edges. */
27122 if (n
< 6 || n
& 1)
27125 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27126 If count is odd, we are inside polygon. Pixels on edges
27127 may or may not be included depending on actual geometry of the
27129 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27130 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27132 x0
= XINT (lx
), y0
= XINT (ly
);
27133 for (i
= 0; i
< n
; i
+= 2)
27135 int x1
= x0
, y1
= y0
;
27136 if ((lx
= poly
[i
], !INTEGERP (lx
))
27137 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27139 x0
= XINT (lx
), y0
= XINT (ly
);
27141 /* Does this segment cross the X line? */
27149 if (y
> y0
&& y
> y1
)
27151 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27161 find_hot_spot (Lisp_Object map
, int x
, int y
)
27163 while (CONSP (map
))
27165 if (CONSP (XCAR (map
))
27166 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27174 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27176 doc
: /* Lookup in image map MAP coordinates X and Y.
27177 An image map is an alist where each element has the format (AREA ID PLIST).
27178 An AREA is specified as either a rectangle, a circle, or a polygon:
27179 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27180 pixel coordinates of the upper left and bottom right corners.
27181 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27182 and the radius of the circle; r may be a float or integer.
27183 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27184 vector describes one corner in the polygon.
27185 Returns the alist element for the first matching AREA in MAP. */)
27186 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27194 return find_hot_spot (map
,
27195 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27196 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27200 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27202 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27204 /* Do not change cursor shape while dragging mouse. */
27205 if (!NILP (do_mouse_tracking
))
27208 if (!NILP (pointer
))
27210 if (EQ (pointer
, Qarrow
))
27211 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27212 else if (EQ (pointer
, Qhand
))
27213 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27214 else if (EQ (pointer
, Qtext
))
27215 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27216 else if (EQ (pointer
, intern ("hdrag")))
27217 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27218 #ifdef HAVE_X_WINDOWS
27219 else if (EQ (pointer
, intern ("vdrag")))
27220 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27222 else if (EQ (pointer
, intern ("hourglass")))
27223 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27224 else if (EQ (pointer
, Qmodeline
))
27225 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27227 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27230 if (cursor
!= No_Cursor
)
27231 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27234 #endif /* HAVE_WINDOW_SYSTEM */
27236 /* Take proper action when mouse has moved to the mode or header line
27237 or marginal area AREA of window W, x-position X and y-position Y.
27238 X is relative to the start of the text display area of W, so the
27239 width of bitmap areas and scroll bars must be subtracted to get a
27240 position relative to the start of the mode line. */
27243 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27244 enum window_part area
)
27246 struct window
*w
= XWINDOW (window
);
27247 struct frame
*f
= XFRAME (w
->frame
);
27248 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27249 #ifdef HAVE_WINDOW_SYSTEM
27250 Display_Info
*dpyinfo
;
27252 Cursor cursor
= No_Cursor
;
27253 Lisp_Object pointer
= Qnil
;
27254 int dx
, dy
, width
, height
;
27256 Lisp_Object string
, object
= Qnil
;
27257 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27259 Lisp_Object mouse_face
;
27260 int original_x_pixel
= x
;
27261 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27262 struct glyph_row
*row
IF_LINT (= 0);
27264 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27269 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27270 returns them in row/column units! */
27271 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27272 &object
, &dx
, &dy
, &width
, &height
);
27274 row
= (area
== ON_MODE_LINE
27275 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27276 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27278 /* Find the glyph under the mouse pointer. */
27279 if (row
->mode_line_p
&& row
->enabled_p
)
27281 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27282 end
= glyph
+ row
->used
[TEXT_AREA
];
27284 for (x0
= original_x_pixel
;
27285 glyph
< end
&& x0
>= glyph
->pixel_width
;
27287 x0
-= glyph
->pixel_width
;
27295 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27296 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27297 returns them in row/column units! */
27298 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27299 &object
, &dx
, &dy
, &width
, &height
);
27304 #ifdef HAVE_WINDOW_SYSTEM
27305 if (IMAGEP (object
))
27307 Lisp_Object image_map
, hotspot
;
27308 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27310 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27312 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27316 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27317 If so, we could look for mouse-enter, mouse-leave
27318 properties in PLIST (and do something...). */
27319 hotspot
= XCDR (hotspot
);
27320 if (CONSP (hotspot
)
27321 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27323 pointer
= Fplist_get (plist
, Qpointer
);
27324 if (NILP (pointer
))
27326 help
= Fplist_get (plist
, Qhelp_echo
);
27329 help_echo_string
= help
;
27330 XSETWINDOW (help_echo_window
, w
);
27331 help_echo_object
= w
->buffer
;
27332 help_echo_pos
= charpos
;
27336 if (NILP (pointer
))
27337 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27339 #endif /* HAVE_WINDOW_SYSTEM */
27341 if (STRINGP (string
))
27342 pos
= make_number (charpos
);
27344 /* Set the help text and mouse pointer. If the mouse is on a part
27345 of the mode line without any text (e.g. past the right edge of
27346 the mode line text), use the default help text and pointer. */
27347 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27349 /* Arrange to display the help by setting the global variables
27350 help_echo_string, help_echo_object, and help_echo_pos. */
27353 if (STRINGP (string
))
27354 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27358 help_echo_string
= help
;
27359 XSETWINDOW (help_echo_window
, w
);
27360 help_echo_object
= string
;
27361 help_echo_pos
= charpos
;
27363 else if (area
== ON_MODE_LINE
)
27365 Lisp_Object default_help
27366 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27369 if (STRINGP (default_help
))
27371 help_echo_string
= default_help
;
27372 XSETWINDOW (help_echo_window
, w
);
27373 help_echo_object
= Qnil
;
27374 help_echo_pos
= -1;
27379 #ifdef HAVE_WINDOW_SYSTEM
27380 /* Change the mouse pointer according to what is under it. */
27381 if (FRAME_WINDOW_P (f
))
27383 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27384 if (STRINGP (string
))
27386 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27388 if (NILP (pointer
))
27389 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27391 /* Change the mouse pointer according to what is under X/Y. */
27393 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27396 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27397 if (!KEYMAPP (map
))
27398 map
= Fget_text_property (pos
, Qkeymap
, string
);
27399 if (!KEYMAPP (map
))
27400 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27404 /* Default mode-line pointer. */
27405 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27410 /* Change the mouse face according to what is under X/Y. */
27411 if (STRINGP (string
))
27413 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27414 if (!NILP (mouse_face
)
27415 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27420 struct glyph
* tmp_glyph
;
27424 int total_pixel_width
;
27425 ptrdiff_t begpos
, endpos
, ignore
;
27429 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27430 Qmouse_face
, string
, Qnil
);
27436 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27438 endpos
= SCHARS (string
);
27442 /* Calculate the glyph position GPOS of GLYPH in the
27443 displayed string, relative to the beginning of the
27444 highlighted part of the string.
27446 Note: GPOS is different from CHARPOS. CHARPOS is the
27447 position of GLYPH in the internal string object. A mode
27448 line string format has structures which are converted to
27449 a flattened string by the Emacs Lisp interpreter. The
27450 internal string is an element of those structures. The
27451 displayed string is the flattened string. */
27452 tmp_glyph
= row_start_glyph
;
27453 while (tmp_glyph
< glyph
27454 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27455 && begpos
<= tmp_glyph
->charpos
27456 && tmp_glyph
->charpos
< endpos
)))
27458 gpos
= glyph
- tmp_glyph
;
27460 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27461 the highlighted part of the displayed string to which
27462 GLYPH belongs. Note: GSEQ_LENGTH is different from
27463 SCHARS (STRING), because the latter returns the length of
27464 the internal string. */
27465 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27467 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27468 && begpos
<= tmp_glyph
->charpos
27469 && tmp_glyph
->charpos
< endpos
));
27472 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27474 /* Calculate the total pixel width of all the glyphs between
27475 the beginning of the highlighted area and GLYPH. */
27476 total_pixel_width
= 0;
27477 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27478 total_pixel_width
+= tmp_glyph
->pixel_width
;
27480 /* Pre calculation of re-rendering position. Note: X is in
27481 column units here, after the call to mode_line_string or
27482 marginal_area_string. */
27484 vpos
= (area
== ON_MODE_LINE
27485 ? (w
->current_matrix
)->nrows
- 1
27488 /* If GLYPH's position is included in the region that is
27489 already drawn in mouse face, we have nothing to do. */
27490 if ( EQ (window
, hlinfo
->mouse_face_window
)
27491 && (!row
->reversed_p
27492 ? (hlinfo
->mouse_face_beg_col
<= hpos
27493 && hpos
< hlinfo
->mouse_face_end_col
)
27494 /* In R2L rows we swap BEG and END, see below. */
27495 : (hlinfo
->mouse_face_end_col
<= hpos
27496 && hpos
< hlinfo
->mouse_face_beg_col
))
27497 && hlinfo
->mouse_face_beg_row
== vpos
)
27500 if (clear_mouse_face (hlinfo
))
27501 cursor
= No_Cursor
;
27503 if (!row
->reversed_p
)
27505 hlinfo
->mouse_face_beg_col
= hpos
;
27506 hlinfo
->mouse_face_beg_x
= original_x_pixel
27507 - (total_pixel_width
+ dx
);
27508 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27509 hlinfo
->mouse_face_end_x
= 0;
27513 /* In R2L rows, show_mouse_face expects BEG and END
27514 coordinates to be swapped. */
27515 hlinfo
->mouse_face_end_col
= hpos
;
27516 hlinfo
->mouse_face_end_x
= original_x_pixel
27517 - (total_pixel_width
+ dx
);
27518 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27519 hlinfo
->mouse_face_beg_x
= 0;
27522 hlinfo
->mouse_face_beg_row
= vpos
;
27523 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27524 hlinfo
->mouse_face_beg_y
= 0;
27525 hlinfo
->mouse_face_end_y
= 0;
27526 hlinfo
->mouse_face_past_end
= 0;
27527 hlinfo
->mouse_face_window
= window
;
27529 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27535 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27537 if (NILP (pointer
))
27540 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27541 clear_mouse_face (hlinfo
);
27543 #ifdef HAVE_WINDOW_SYSTEM
27544 if (FRAME_WINDOW_P (f
))
27545 define_frame_cursor1 (f
, cursor
, pointer
);
27551 Take proper action when the mouse has moved to position X, Y on
27552 frame F as regards highlighting characters that have mouse-face
27553 properties. Also de-highlighting chars where the mouse was before.
27554 X and Y can be negative or out of range. */
27557 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27559 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27560 enum window_part part
= ON_NOTHING
;
27561 Lisp_Object window
;
27563 Cursor cursor
= No_Cursor
;
27564 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27567 /* When a menu is active, don't highlight because this looks odd. */
27568 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27569 if (popup_activated ())
27573 if (NILP (Vmouse_highlight
)
27574 || !f
->glyphs_initialized_p
27575 || f
->pointer_invisible
)
27578 hlinfo
->mouse_face_mouse_x
= x
;
27579 hlinfo
->mouse_face_mouse_y
= y
;
27580 hlinfo
->mouse_face_mouse_frame
= f
;
27582 if (hlinfo
->mouse_face_defer
)
27585 if (gc_in_progress
)
27587 hlinfo
->mouse_face_deferred_gc
= 1;
27591 /* Which window is that in? */
27592 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27594 /* If displaying active text in another window, clear that. */
27595 if (! EQ (window
, hlinfo
->mouse_face_window
)
27596 /* Also clear if we move out of text area in same window. */
27597 || (!NILP (hlinfo
->mouse_face_window
)
27600 && part
!= ON_MODE_LINE
27601 && part
!= ON_HEADER_LINE
))
27602 clear_mouse_face (hlinfo
);
27604 /* Not on a window -> return. */
27605 if (!WINDOWP (window
))
27608 /* Reset help_echo_string. It will get recomputed below. */
27609 help_echo_string
= Qnil
;
27611 /* Convert to window-relative pixel coordinates. */
27612 w
= XWINDOW (window
);
27613 frame_to_window_pixel_xy (w
, &x
, &y
);
27615 #ifdef HAVE_WINDOW_SYSTEM
27616 /* Handle tool-bar window differently since it doesn't display a
27618 if (EQ (window
, f
->tool_bar_window
))
27620 note_tool_bar_highlight (f
, x
, y
);
27625 /* Mouse is on the mode, header line or margin? */
27626 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27627 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27629 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27633 #ifdef HAVE_WINDOW_SYSTEM
27634 if (part
== ON_VERTICAL_BORDER
)
27636 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27637 help_echo_string
= build_string ("drag-mouse-1: resize");
27639 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27640 || part
== ON_SCROLL_BAR
)
27641 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27643 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27646 /* Are we in a window whose display is up to date?
27647 And verify the buffer's text has not changed. */
27648 b
= XBUFFER (w
->buffer
);
27649 if (part
== ON_TEXT
27650 && EQ (w
->window_end_valid
, w
->buffer
)
27651 && w
->last_modified
== BUF_MODIFF (b
)
27652 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27654 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27656 struct glyph
*glyph
;
27657 Lisp_Object object
;
27658 Lisp_Object mouse_face
= Qnil
, position
;
27659 Lisp_Object
*overlay_vec
= NULL
;
27660 ptrdiff_t i
, noverlays
;
27661 struct buffer
*obuf
;
27662 ptrdiff_t obegv
, ozv
;
27665 /* Find the glyph under X/Y. */
27666 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27668 #ifdef HAVE_WINDOW_SYSTEM
27669 /* Look for :pointer property on image. */
27670 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27672 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27673 if (img
!= NULL
&& IMAGEP (img
->spec
))
27675 Lisp_Object image_map
, hotspot
;
27676 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27678 && (hotspot
= find_hot_spot (image_map
,
27679 glyph
->slice
.img
.x
+ dx
,
27680 glyph
->slice
.img
.y
+ dy
),
27682 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27686 /* Could check XCAR (hotspot) to see if we enter/leave
27688 If so, we could look for mouse-enter, mouse-leave
27689 properties in PLIST (and do something...). */
27690 hotspot
= XCDR (hotspot
);
27691 if (CONSP (hotspot
)
27692 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27694 pointer
= Fplist_get (plist
, Qpointer
);
27695 if (NILP (pointer
))
27697 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27698 if (!NILP (help_echo_string
))
27700 help_echo_window
= window
;
27701 help_echo_object
= glyph
->object
;
27702 help_echo_pos
= glyph
->charpos
;
27706 if (NILP (pointer
))
27707 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27710 #endif /* HAVE_WINDOW_SYSTEM */
27712 /* Clear mouse face if X/Y not over text. */
27714 || area
!= TEXT_AREA
27715 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27716 /* Glyph's OBJECT is an integer for glyphs inserted by the
27717 display engine for its internal purposes, like truncation
27718 and continuation glyphs and blanks beyond the end of
27719 line's text on text terminals. If we are over such a
27720 glyph, we are not over any text. */
27721 || INTEGERP (glyph
->object
)
27722 /* R2L rows have a stretch glyph at their front, which
27723 stands for no text, whereas L2R rows have no glyphs at
27724 all beyond the end of text. Treat such stretch glyphs
27725 like we do with NULL glyphs in L2R rows. */
27726 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27727 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27728 && glyph
->type
== STRETCH_GLYPH
27729 && glyph
->avoid_cursor_p
))
27731 if (clear_mouse_face (hlinfo
))
27732 cursor
= No_Cursor
;
27733 #ifdef HAVE_WINDOW_SYSTEM
27734 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27736 if (area
!= TEXT_AREA
)
27737 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27739 pointer
= Vvoid_text_area_pointer
;
27745 pos
= glyph
->charpos
;
27746 object
= glyph
->object
;
27747 if (!STRINGP (object
) && !BUFFERP (object
))
27750 /* If we get an out-of-range value, return now; avoid an error. */
27751 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27754 /* Make the window's buffer temporarily current for
27755 overlays_at and compute_char_face. */
27756 obuf
= current_buffer
;
27757 current_buffer
= b
;
27763 /* Is this char mouse-active or does it have help-echo? */
27764 position
= make_number (pos
);
27766 if (BUFFERP (object
))
27768 /* Put all the overlays we want in a vector in overlay_vec. */
27769 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27770 /* Sort overlays into increasing priority order. */
27771 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27776 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27779 cursor
= No_Cursor
;
27781 /* Check mouse-face highlighting. */
27783 /* If there exists an overlay with mouse-face overlapping
27784 the one we are currently highlighting, we have to
27785 check if we enter the overlapping overlay, and then
27786 highlight only that. */
27787 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27788 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27790 /* Find the highest priority overlay with a mouse-face. */
27791 Lisp_Object overlay
= Qnil
;
27792 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27794 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27795 if (!NILP (mouse_face
))
27796 overlay
= overlay_vec
[i
];
27799 /* If we're highlighting the same overlay as before, there's
27800 no need to do that again. */
27801 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27802 goto check_help_echo
;
27803 hlinfo
->mouse_face_overlay
= overlay
;
27805 /* Clear the display of the old active region, if any. */
27806 if (clear_mouse_face (hlinfo
))
27807 cursor
= No_Cursor
;
27809 /* If no overlay applies, get a text property. */
27810 if (NILP (overlay
))
27811 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27813 /* Next, compute the bounds of the mouse highlighting and
27815 if (!NILP (mouse_face
) && STRINGP (object
))
27817 /* The mouse-highlighting comes from a display string
27818 with a mouse-face. */
27822 s
= Fprevious_single_property_change
27823 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27824 e
= Fnext_single_property_change
27825 (position
, Qmouse_face
, object
, Qnil
);
27827 s
= make_number (0);
27829 e
= make_number (SCHARS (object
) - 1);
27830 mouse_face_from_string_pos (w
, hlinfo
, object
,
27831 XINT (s
), XINT (e
));
27832 hlinfo
->mouse_face_past_end
= 0;
27833 hlinfo
->mouse_face_window
= window
;
27834 hlinfo
->mouse_face_face_id
27835 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27836 glyph
->face_id
, 1);
27837 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27838 cursor
= No_Cursor
;
27842 /* The mouse-highlighting, if any, comes from an overlay
27843 or text property in the buffer. */
27844 Lisp_Object buffer
IF_LINT (= Qnil
);
27845 Lisp_Object disp_string
IF_LINT (= Qnil
);
27847 if (STRINGP (object
))
27849 /* If we are on a display string with no mouse-face,
27850 check if the text under it has one. */
27851 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27852 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27853 pos
= string_buffer_position (object
, start
);
27856 mouse_face
= get_char_property_and_overlay
27857 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27858 buffer
= w
->buffer
;
27859 disp_string
= object
;
27865 disp_string
= Qnil
;
27868 if (!NILP (mouse_face
))
27870 Lisp_Object before
, after
;
27871 Lisp_Object before_string
, after_string
;
27872 /* To correctly find the limits of mouse highlight
27873 in a bidi-reordered buffer, we must not use the
27874 optimization of limiting the search in
27875 previous-single-property-change and
27876 next-single-property-change, because
27877 rows_from_pos_range needs the real start and end
27878 positions to DTRT in this case. That's because
27879 the first row visible in a window does not
27880 necessarily display the character whose position
27881 is the smallest. */
27883 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27884 ? Fmarker_position (w
->start
)
27887 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27888 ? make_number (BUF_Z (XBUFFER (buffer
))
27889 - XFASTINT (w
->window_end_pos
))
27892 if (NILP (overlay
))
27894 /* Handle the text property case. */
27895 before
= Fprevious_single_property_change
27896 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27897 after
= Fnext_single_property_change
27898 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27899 before_string
= after_string
= Qnil
;
27903 /* Handle the overlay case. */
27904 before
= Foverlay_start (overlay
);
27905 after
= Foverlay_end (overlay
);
27906 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27907 after_string
= Foverlay_get (overlay
, Qafter_string
);
27909 if (!STRINGP (before_string
)) before_string
= Qnil
;
27910 if (!STRINGP (after_string
)) after_string
= Qnil
;
27913 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27916 : XFASTINT (before
),
27918 ? BUF_Z (XBUFFER (buffer
))
27919 : XFASTINT (after
),
27920 before_string
, after_string
,
27922 cursor
= No_Cursor
;
27929 /* Look for a `help-echo' property. */
27930 if (NILP (help_echo_string
)) {
27931 Lisp_Object help
, overlay
;
27933 /* Check overlays first. */
27934 help
= overlay
= Qnil
;
27935 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27937 overlay
= overlay_vec
[i
];
27938 help
= Foverlay_get (overlay
, Qhelp_echo
);
27943 help_echo_string
= help
;
27944 help_echo_window
= window
;
27945 help_echo_object
= overlay
;
27946 help_echo_pos
= pos
;
27950 Lisp_Object obj
= glyph
->object
;
27951 ptrdiff_t charpos
= glyph
->charpos
;
27953 /* Try text properties. */
27956 && charpos
< SCHARS (obj
))
27958 help
= Fget_text_property (make_number (charpos
),
27962 /* If the string itself doesn't specify a help-echo,
27963 see if the buffer text ``under'' it does. */
27964 struct glyph_row
*r
27965 = MATRIX_ROW (w
->current_matrix
, vpos
);
27966 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27967 ptrdiff_t p
= string_buffer_position (obj
, start
);
27970 help
= Fget_char_property (make_number (p
),
27971 Qhelp_echo
, w
->buffer
);
27980 else if (BUFFERP (obj
)
27983 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27988 help_echo_string
= help
;
27989 help_echo_window
= window
;
27990 help_echo_object
= obj
;
27991 help_echo_pos
= charpos
;
27996 #ifdef HAVE_WINDOW_SYSTEM
27997 /* Look for a `pointer' property. */
27998 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28000 /* Check overlays first. */
28001 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28002 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28004 if (NILP (pointer
))
28006 Lisp_Object obj
= glyph
->object
;
28007 ptrdiff_t charpos
= glyph
->charpos
;
28009 /* Try text properties. */
28012 && charpos
< SCHARS (obj
))
28014 pointer
= Fget_text_property (make_number (charpos
),
28016 if (NILP (pointer
))
28018 /* If the string itself doesn't specify a pointer,
28019 see if the buffer text ``under'' it does. */
28020 struct glyph_row
*r
28021 = MATRIX_ROW (w
->current_matrix
, vpos
);
28022 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28023 ptrdiff_t p
= string_buffer_position (obj
, start
);
28025 pointer
= Fget_char_property (make_number (p
),
28026 Qpointer
, w
->buffer
);
28029 else if (BUFFERP (obj
)
28032 pointer
= Fget_text_property (make_number (charpos
),
28036 #endif /* HAVE_WINDOW_SYSTEM */
28040 current_buffer
= obuf
;
28045 #ifdef HAVE_WINDOW_SYSTEM
28046 if (FRAME_WINDOW_P (f
))
28047 define_frame_cursor1 (f
, cursor
, pointer
);
28049 /* This is here to prevent a compiler error, about "label at end of
28050 compound statement". */
28057 Clear any mouse-face on window W. This function is part of the
28058 redisplay interface, and is called from try_window_id and similar
28059 functions to ensure the mouse-highlight is off. */
28062 x_clear_window_mouse_face (struct window
*w
)
28064 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28065 Lisp_Object window
;
28068 XSETWINDOW (window
, w
);
28069 if (EQ (window
, hlinfo
->mouse_face_window
))
28070 clear_mouse_face (hlinfo
);
28076 Just discard the mouse face information for frame F, if any.
28077 This is used when the size of F is changed. */
28080 cancel_mouse_face (struct frame
*f
)
28082 Lisp_Object window
;
28083 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28085 window
= hlinfo
->mouse_face_window
;
28086 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28088 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28089 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28090 hlinfo
->mouse_face_window
= Qnil
;
28096 /***********************************************************************
28098 ***********************************************************************/
28100 #ifdef HAVE_WINDOW_SYSTEM
28102 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28103 which intersects rectangle R. R is in window-relative coordinates. */
28106 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28107 enum glyph_row_area area
)
28109 struct glyph
*first
= row
->glyphs
[area
];
28110 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28111 struct glyph
*last
;
28112 int first_x
, start_x
, x
;
28114 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28115 /* If row extends face to end of line write the whole line. */
28116 draw_glyphs (w
, 0, row
, area
,
28117 0, row
->used
[area
],
28118 DRAW_NORMAL_TEXT
, 0);
28121 /* Set START_X to the window-relative start position for drawing glyphs of
28122 AREA. The first glyph of the text area can be partially visible.
28123 The first glyphs of other areas cannot. */
28124 start_x
= window_box_left_offset (w
, area
);
28126 if (area
== TEXT_AREA
)
28129 /* Find the first glyph that must be redrawn. */
28131 && x
+ first
->pixel_width
< r
->x
)
28133 x
+= first
->pixel_width
;
28137 /* Find the last one. */
28141 && x
< r
->x
+ r
->width
)
28143 x
+= last
->pixel_width
;
28149 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28150 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28151 DRAW_NORMAL_TEXT
, 0);
28156 /* Redraw the parts of the glyph row ROW on window W intersecting
28157 rectangle R. R is in window-relative coordinates. Value is
28158 non-zero if mouse-face was overwritten. */
28161 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28163 eassert (row
->enabled_p
);
28165 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28166 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28167 0, row
->used
[TEXT_AREA
],
28168 DRAW_NORMAL_TEXT
, 0);
28171 if (row
->used
[LEFT_MARGIN_AREA
])
28172 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28173 if (row
->used
[TEXT_AREA
])
28174 expose_area (w
, row
, r
, TEXT_AREA
);
28175 if (row
->used
[RIGHT_MARGIN_AREA
])
28176 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28177 draw_row_fringe_bitmaps (w
, row
);
28180 return row
->mouse_face_p
;
28184 /* Redraw those parts of glyphs rows during expose event handling that
28185 overlap other rows. Redrawing of an exposed line writes over parts
28186 of lines overlapping that exposed line; this function fixes that.
28188 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28189 row in W's current matrix that is exposed and overlaps other rows.
28190 LAST_OVERLAPPING_ROW is the last such row. */
28193 expose_overlaps (struct window
*w
,
28194 struct glyph_row
*first_overlapping_row
,
28195 struct glyph_row
*last_overlapping_row
,
28198 struct glyph_row
*row
;
28200 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28201 if (row
->overlapping_p
)
28203 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28206 if (row
->used
[LEFT_MARGIN_AREA
])
28207 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28209 if (row
->used
[TEXT_AREA
])
28210 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28212 if (row
->used
[RIGHT_MARGIN_AREA
])
28213 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28219 /* Return non-zero if W's cursor intersects rectangle R. */
28222 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28224 XRectangle cr
, result
;
28225 struct glyph
*cursor_glyph
;
28226 struct glyph_row
*row
;
28228 if (w
->phys_cursor
.vpos
>= 0
28229 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28230 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28232 && row
->cursor_in_fringe_p
)
28234 /* Cursor is in the fringe. */
28235 cr
.x
= window_box_right_offset (w
,
28236 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28237 ? RIGHT_MARGIN_AREA
28240 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28241 cr
.height
= row
->height
;
28242 return x_intersect_rectangles (&cr
, r
, &result
);
28245 cursor_glyph
= get_phys_cursor_glyph (w
);
28248 /* r is relative to W's box, but w->phys_cursor.x is relative
28249 to left edge of W's TEXT area. Adjust it. */
28250 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28251 cr
.y
= w
->phys_cursor
.y
;
28252 cr
.width
= cursor_glyph
->pixel_width
;
28253 cr
.height
= w
->phys_cursor_height
;
28254 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28255 I assume the effect is the same -- and this is portable. */
28256 return x_intersect_rectangles (&cr
, r
, &result
);
28258 /* If we don't understand the format, pretend we're not in the hot-spot. */
28264 Draw a vertical window border to the right of window W if W doesn't
28265 have vertical scroll bars. */
28268 x_draw_vertical_border (struct window
*w
)
28270 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28272 /* We could do better, if we knew what type of scroll-bar the adjacent
28273 windows (on either side) have... But we don't :-(
28274 However, I think this works ok. ++KFS 2003-04-25 */
28276 /* Redraw borders between horizontally adjacent windows. Don't
28277 do it for frames with vertical scroll bars because either the
28278 right scroll bar of a window, or the left scroll bar of its
28279 neighbor will suffice as a border. */
28280 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28283 if (!WINDOW_RIGHTMOST_P (w
)
28284 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28286 int x0
, x1
, y0
, y1
;
28288 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28291 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28294 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28296 else if (!WINDOW_LEFTMOST_P (w
)
28297 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28299 int x0
, x1
, y0
, y1
;
28301 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28304 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28307 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28312 /* Redraw the part of window W intersection rectangle FR. Pixel
28313 coordinates in FR are frame-relative. Call this function with
28314 input blocked. Value is non-zero if the exposure overwrites
28318 expose_window (struct window
*w
, XRectangle
*fr
)
28320 struct frame
*f
= XFRAME (w
->frame
);
28322 int mouse_face_overwritten_p
= 0;
28324 /* If window is not yet fully initialized, do nothing. This can
28325 happen when toolkit scroll bars are used and a window is split.
28326 Reconfiguring the scroll bar will generate an expose for a newly
28328 if (w
->current_matrix
== NULL
)
28331 /* When we're currently updating the window, display and current
28332 matrix usually don't agree. Arrange for a thorough display
28334 if (w
== updated_window
)
28336 SET_FRAME_GARBAGED (f
);
28340 /* Frame-relative pixel rectangle of W. */
28341 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28342 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28343 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28344 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28346 if (x_intersect_rectangles (fr
, &wr
, &r
))
28348 int yb
= window_text_bottom_y (w
);
28349 struct glyph_row
*row
;
28350 int cursor_cleared_p
, phys_cursor_on_p
;
28351 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28353 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28354 r
.x
, r
.y
, r
.width
, r
.height
));
28356 /* Convert to window coordinates. */
28357 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28358 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28360 /* Turn off the cursor. */
28361 if (!w
->pseudo_window_p
28362 && phys_cursor_in_rect_p (w
, &r
))
28364 x_clear_cursor (w
);
28365 cursor_cleared_p
= 1;
28368 cursor_cleared_p
= 0;
28370 /* If the row containing the cursor extends face to end of line,
28371 then expose_area might overwrite the cursor outside the
28372 rectangle and thus notice_overwritten_cursor might clear
28373 w->phys_cursor_on_p. We remember the original value and
28374 check later if it is changed. */
28375 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28377 /* Update lines intersecting rectangle R. */
28378 first_overlapping_row
= last_overlapping_row
= NULL
;
28379 for (row
= w
->current_matrix
->rows
;
28384 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28386 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28387 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28388 || (r
.y
>= y0
&& r
.y
< y1
)
28389 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28391 /* A header line may be overlapping, but there is no need
28392 to fix overlapping areas for them. KFS 2005-02-12 */
28393 if (row
->overlapping_p
&& !row
->mode_line_p
)
28395 if (first_overlapping_row
== NULL
)
28396 first_overlapping_row
= row
;
28397 last_overlapping_row
= row
;
28401 if (expose_line (w
, row
, &r
))
28402 mouse_face_overwritten_p
= 1;
28405 else if (row
->overlapping_p
)
28407 /* We must redraw a row overlapping the exposed area. */
28409 ? y0
+ row
->phys_height
> r
.y
28410 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28412 if (first_overlapping_row
== NULL
)
28413 first_overlapping_row
= row
;
28414 last_overlapping_row
= row
;
28422 /* Display the mode line if there is one. */
28423 if (WINDOW_WANTS_MODELINE_P (w
)
28424 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28426 && row
->y
< r
.y
+ r
.height
)
28428 if (expose_line (w
, row
, &r
))
28429 mouse_face_overwritten_p
= 1;
28432 if (!w
->pseudo_window_p
)
28434 /* Fix the display of overlapping rows. */
28435 if (first_overlapping_row
)
28436 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28439 /* Draw border between windows. */
28440 x_draw_vertical_border (w
);
28442 /* Turn the cursor on again. */
28443 if (cursor_cleared_p
28444 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28445 update_window_cursor (w
, 1);
28449 return mouse_face_overwritten_p
;
28454 /* Redraw (parts) of all windows in the window tree rooted at W that
28455 intersect R. R contains frame pixel coordinates. Value is
28456 non-zero if the exposure overwrites mouse-face. */
28459 expose_window_tree (struct window
*w
, XRectangle
*r
)
28461 struct frame
*f
= XFRAME (w
->frame
);
28462 int mouse_face_overwritten_p
= 0;
28464 while (w
&& !FRAME_GARBAGED_P (f
))
28466 if (!NILP (w
->hchild
))
28467 mouse_face_overwritten_p
28468 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28469 else if (!NILP (w
->vchild
))
28470 mouse_face_overwritten_p
28471 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28473 mouse_face_overwritten_p
|= expose_window (w
, r
);
28475 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28478 return mouse_face_overwritten_p
;
28483 Redisplay an exposed area of frame F. X and Y are the upper-left
28484 corner of the exposed rectangle. W and H are width and height of
28485 the exposed area. All are pixel values. W or H zero means redraw
28486 the entire frame. */
28489 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28492 int mouse_face_overwritten_p
= 0;
28494 TRACE ((stderr
, "expose_frame "));
28496 /* No need to redraw if frame will be redrawn soon. */
28497 if (FRAME_GARBAGED_P (f
))
28499 TRACE ((stderr
, " garbaged\n"));
28503 /* If basic faces haven't been realized yet, there is no point in
28504 trying to redraw anything. This can happen when we get an expose
28505 event while Emacs is starting, e.g. by moving another window. */
28506 if (FRAME_FACE_CACHE (f
) == NULL
28507 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28509 TRACE ((stderr
, " no faces\n"));
28513 if (w
== 0 || h
== 0)
28516 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28517 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28527 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28528 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28530 if (WINDOWP (f
->tool_bar_window
))
28531 mouse_face_overwritten_p
28532 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28534 #ifdef HAVE_X_WINDOWS
28536 #ifndef USE_X_TOOLKIT
28537 if (WINDOWP (f
->menu_bar_window
))
28538 mouse_face_overwritten_p
28539 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28540 #endif /* not USE_X_TOOLKIT */
28544 /* Some window managers support a focus-follows-mouse style with
28545 delayed raising of frames. Imagine a partially obscured frame,
28546 and moving the mouse into partially obscured mouse-face on that
28547 frame. The visible part of the mouse-face will be highlighted,
28548 then the WM raises the obscured frame. With at least one WM, KDE
28549 2.1, Emacs is not getting any event for the raising of the frame
28550 (even tried with SubstructureRedirectMask), only Expose events.
28551 These expose events will draw text normally, i.e. not
28552 highlighted. Which means we must redo the highlight here.
28553 Subsume it under ``we love X''. --gerd 2001-08-15 */
28554 /* Included in Windows version because Windows most likely does not
28555 do the right thing if any third party tool offers
28556 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28557 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28559 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28560 if (f
== hlinfo
->mouse_face_mouse_frame
)
28562 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28563 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28564 clear_mouse_face (hlinfo
);
28565 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28572 Determine the intersection of two rectangles R1 and R2. Return
28573 the intersection in *RESULT. Value is non-zero if RESULT is not
28577 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28579 XRectangle
*left
, *right
;
28580 XRectangle
*upper
, *lower
;
28581 int intersection_p
= 0;
28583 /* Rearrange so that R1 is the left-most rectangle. */
28585 left
= r1
, right
= r2
;
28587 left
= r2
, right
= r1
;
28589 /* X0 of the intersection is right.x0, if this is inside R1,
28590 otherwise there is no intersection. */
28591 if (right
->x
<= left
->x
+ left
->width
)
28593 result
->x
= right
->x
;
28595 /* The right end of the intersection is the minimum of
28596 the right ends of left and right. */
28597 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28600 /* Same game for Y. */
28602 upper
= r1
, lower
= r2
;
28604 upper
= r2
, lower
= r1
;
28606 /* The upper end of the intersection is lower.y0, if this is inside
28607 of upper. Otherwise, there is no intersection. */
28608 if (lower
->y
<= upper
->y
+ upper
->height
)
28610 result
->y
= lower
->y
;
28612 /* The lower end of the intersection is the minimum of the lower
28613 ends of upper and lower. */
28614 result
->height
= (min (lower
->y
+ lower
->height
,
28615 upper
->y
+ upper
->height
)
28617 intersection_p
= 1;
28621 return intersection_p
;
28624 #endif /* HAVE_WINDOW_SYSTEM */
28627 /***********************************************************************
28629 ***********************************************************************/
28632 syms_of_xdisp (void)
28634 Vwith_echo_area_save_vector
= Qnil
;
28635 staticpro (&Vwith_echo_area_save_vector
);
28637 Vmessage_stack
= Qnil
;
28638 staticpro (&Vmessage_stack
);
28640 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28642 message_dolog_marker1
= Fmake_marker ();
28643 staticpro (&message_dolog_marker1
);
28644 message_dolog_marker2
= Fmake_marker ();
28645 staticpro (&message_dolog_marker2
);
28646 message_dolog_marker3
= Fmake_marker ();
28647 staticpro (&message_dolog_marker3
);
28650 defsubr (&Sdump_frame_glyph_matrix
);
28651 defsubr (&Sdump_glyph_matrix
);
28652 defsubr (&Sdump_glyph_row
);
28653 defsubr (&Sdump_tool_bar_row
);
28654 defsubr (&Strace_redisplay
);
28655 defsubr (&Strace_to_stderr
);
28657 #ifdef HAVE_WINDOW_SYSTEM
28658 defsubr (&Stool_bar_lines_needed
);
28659 defsubr (&Slookup_image_map
);
28661 defsubr (&Sformat_mode_line
);
28662 defsubr (&Sinvisible_p
);
28663 defsubr (&Scurrent_bidi_paragraph_direction
);
28665 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28666 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28667 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28668 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28669 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28670 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28671 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28672 DEFSYM (Qeval
, "eval");
28673 DEFSYM (QCdata
, ":data");
28674 DEFSYM (Qdisplay
, "display");
28675 DEFSYM (Qspace_width
, "space-width");
28676 DEFSYM (Qraise
, "raise");
28677 DEFSYM (Qslice
, "slice");
28678 DEFSYM (Qspace
, "space");
28679 DEFSYM (Qmargin
, "margin");
28680 DEFSYM (Qpointer
, "pointer");
28681 DEFSYM (Qleft_margin
, "left-margin");
28682 DEFSYM (Qright_margin
, "right-margin");
28683 DEFSYM (Qcenter
, "center");
28684 DEFSYM (Qline_height
, "line-height");
28685 DEFSYM (QCalign_to
, ":align-to");
28686 DEFSYM (QCrelative_width
, ":relative-width");
28687 DEFSYM (QCrelative_height
, ":relative-height");
28688 DEFSYM (QCeval
, ":eval");
28689 DEFSYM (QCpropertize
, ":propertize");
28690 DEFSYM (QCfile
, ":file");
28691 DEFSYM (Qfontified
, "fontified");
28692 DEFSYM (Qfontification_functions
, "fontification-functions");
28693 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28694 DEFSYM (Qescape_glyph
, "escape-glyph");
28695 DEFSYM (Qnobreak_space
, "nobreak-space");
28696 DEFSYM (Qimage
, "image");
28697 DEFSYM (Qtext
, "text");
28698 DEFSYM (Qboth
, "both");
28699 DEFSYM (Qboth_horiz
, "both-horiz");
28700 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28701 DEFSYM (QCmap
, ":map");
28702 DEFSYM (QCpointer
, ":pointer");
28703 DEFSYM (Qrect
, "rect");
28704 DEFSYM (Qcircle
, "circle");
28705 DEFSYM (Qpoly
, "poly");
28706 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28707 DEFSYM (Qgrow_only
, "grow-only");
28708 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28709 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28710 DEFSYM (Qposition
, "position");
28711 DEFSYM (Qbuffer_position
, "buffer-position");
28712 DEFSYM (Qobject
, "object");
28713 DEFSYM (Qbar
, "bar");
28714 DEFSYM (Qhbar
, "hbar");
28715 DEFSYM (Qbox
, "box");
28716 DEFSYM (Qhollow
, "hollow");
28717 DEFSYM (Qhand
, "hand");
28718 DEFSYM (Qarrow
, "arrow");
28719 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28721 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28722 Fcons (intern_c_string ("void-variable"), Qnil
)),
28724 staticpro (&list_of_error
);
28726 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28727 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28728 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28729 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28731 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28732 staticpro (&echo_buffer
[0]);
28733 staticpro (&echo_buffer
[1]);
28735 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28736 staticpro (&echo_area_buffer
[0]);
28737 staticpro (&echo_area_buffer
[1]);
28739 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28740 staticpro (&Vmessages_buffer_name
);
28742 mode_line_proptrans_alist
= Qnil
;
28743 staticpro (&mode_line_proptrans_alist
);
28744 mode_line_string_list
= Qnil
;
28745 staticpro (&mode_line_string_list
);
28746 mode_line_string_face
= Qnil
;
28747 staticpro (&mode_line_string_face
);
28748 mode_line_string_face_prop
= Qnil
;
28749 staticpro (&mode_line_string_face_prop
);
28750 Vmode_line_unwind_vector
= Qnil
;
28751 staticpro (&Vmode_line_unwind_vector
);
28753 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28755 help_echo_string
= Qnil
;
28756 staticpro (&help_echo_string
);
28757 help_echo_object
= Qnil
;
28758 staticpro (&help_echo_object
);
28759 help_echo_window
= Qnil
;
28760 staticpro (&help_echo_window
);
28761 previous_help_echo_string
= Qnil
;
28762 staticpro (&previous_help_echo_string
);
28763 help_echo_pos
= -1;
28765 DEFSYM (Qright_to_left
, "right-to-left");
28766 DEFSYM (Qleft_to_right
, "left-to-right");
28768 #ifdef HAVE_WINDOW_SYSTEM
28769 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28770 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28771 For example, if a block cursor is over a tab, it will be drawn as
28772 wide as that tab on the display. */);
28773 x_stretch_cursor_p
= 0;
28776 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28777 doc
: /* Non-nil means highlight trailing whitespace.
28778 The face used for trailing whitespace is `trailing-whitespace'. */);
28779 Vshow_trailing_whitespace
= Qnil
;
28781 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28782 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28783 If the value is t, Emacs highlights non-ASCII chars which have the
28784 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28785 or `escape-glyph' face respectively.
28787 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28788 U+2011 (non-breaking hyphen) are affected.
28790 Any other non-nil value means to display these characters as a escape
28791 glyph followed by an ordinary space or hyphen.
28793 A value of nil means no special handling of these characters. */);
28794 Vnobreak_char_display
= Qt
;
28796 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28797 doc
: /* The pointer shape to show in void text areas.
28798 A value of nil means to show the text pointer. Other options are `arrow',
28799 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28800 Vvoid_text_area_pointer
= Qarrow
;
28802 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28803 doc
: /* Non-nil means don't actually do any redisplay.
28804 This is used for internal purposes. */);
28805 Vinhibit_redisplay
= Qnil
;
28807 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28808 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28809 Vglobal_mode_string
= Qnil
;
28811 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28812 doc
: /* Marker for where to display an arrow on top of the buffer text.
28813 This must be the beginning of a line in order to work.
28814 See also `overlay-arrow-string'. */);
28815 Voverlay_arrow_position
= Qnil
;
28817 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28818 doc
: /* String to display as an arrow in non-window frames.
28819 See also `overlay-arrow-position'. */);
28820 Voverlay_arrow_string
= build_pure_c_string ("=>");
28822 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28823 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28824 The symbols on this list are examined during redisplay to determine
28825 where to display overlay arrows. */);
28826 Voverlay_arrow_variable_list
28827 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28829 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28830 doc
: /* The number of lines to try scrolling a window by when point moves out.
28831 If that fails to bring point back on frame, point is centered instead.
28832 If this is zero, point is always centered after it moves off frame.
28833 If you want scrolling to always be a line at a time, you should set
28834 `scroll-conservatively' to a large value rather than set this to 1. */);
28836 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28837 doc
: /* Scroll up to this many lines, to bring point back on screen.
28838 If point moves off-screen, redisplay will scroll by up to
28839 `scroll-conservatively' lines in order to bring point just barely
28840 onto the screen again. If that cannot be done, then redisplay
28841 recenters point as usual.
28843 If the value is greater than 100, redisplay will never recenter point,
28844 but will always scroll just enough text to bring point into view, even
28845 if you move far away.
28847 A value of zero means always recenter point if it moves off screen. */);
28848 scroll_conservatively
= 0;
28850 DEFVAR_INT ("scroll-margin", scroll_margin
,
28851 doc
: /* Number of lines of margin at the top and bottom of a window.
28852 Recenter the window whenever point gets within this many lines
28853 of the top or bottom of the window. */);
28856 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28857 doc
: /* Pixels per inch value for non-window system displays.
28858 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28859 Vdisplay_pixels_per_inch
= make_float (72.0);
28862 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28865 DEFVAR_LISP ("truncate-partial-width-windows",
28866 Vtruncate_partial_width_windows
,
28867 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28868 For an integer value, truncate lines in each window narrower than the
28869 full frame width, provided the window width is less than that integer;
28870 otherwise, respect the value of `truncate-lines'.
28872 For any other non-nil value, truncate lines in all windows that do
28873 not span the full frame width.
28875 A value of nil means to respect the value of `truncate-lines'.
28877 If `word-wrap' is enabled, you might want to reduce this. */);
28878 Vtruncate_partial_width_windows
= make_number (50);
28880 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28881 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28882 Any other value means to use the appropriate face, `mode-line',
28883 `header-line', or `menu' respectively. */);
28884 mode_line_inverse_video
= 1;
28886 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28887 doc
: /* Maximum buffer size for which line number should be displayed.
28888 If the buffer is bigger than this, the line number does not appear
28889 in the mode line. A value of nil means no limit. */);
28890 Vline_number_display_limit
= Qnil
;
28892 DEFVAR_INT ("line-number-display-limit-width",
28893 line_number_display_limit_width
,
28894 doc
: /* Maximum line width (in characters) for line number display.
28895 If the average length of the lines near point is bigger than this, then the
28896 line number may be omitted from the mode line. */);
28897 line_number_display_limit_width
= 200;
28899 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28900 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28901 highlight_nonselected_windows
= 0;
28903 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28904 doc
: /* Non-nil if more than one frame is visible on this display.
28905 Minibuffer-only frames don't count, but iconified frames do.
28906 This variable is not guaranteed to be accurate except while processing
28907 `frame-title-format' and `icon-title-format'. */);
28909 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28910 doc
: /* Template for displaying the title bar of visible frames.
28911 \(Assuming the window manager supports this feature.)
28913 This variable has the same structure as `mode-line-format', except that
28914 the %c and %l constructs are ignored. It is used only on frames for
28915 which no explicit name has been set \(see `modify-frame-parameters'). */);
28917 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28918 doc
: /* Template for displaying the title bar of an iconified frame.
28919 \(Assuming the window manager supports this feature.)
28920 This variable has the same structure as `mode-line-format' (which see),
28921 and is used only on frames for which no explicit name has been set
28922 \(see `modify-frame-parameters'). */);
28924 = Vframe_title_format
28925 = pure_cons (intern_c_string ("multiple-frames"),
28926 pure_cons (build_pure_c_string ("%b"),
28927 pure_cons (pure_cons (empty_unibyte_string
,
28928 pure_cons (intern_c_string ("invocation-name"),
28929 pure_cons (build_pure_c_string ("@"),
28930 pure_cons (intern_c_string ("system-name"),
28934 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28935 doc
: /* Maximum number of lines to keep in the message log buffer.
28936 If nil, disable message logging. If t, log messages but don't truncate
28937 the buffer when it becomes large. */);
28938 Vmessage_log_max
= make_number (100);
28940 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28941 doc
: /* Functions called before redisplay, if window sizes have changed.
28942 The value should be a list of functions that take one argument.
28943 Just before redisplay, for each frame, if any of its windows have changed
28944 size since the last redisplay, or have been split or deleted,
28945 all the functions in the list are called, with the frame as argument. */);
28946 Vwindow_size_change_functions
= Qnil
;
28948 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28949 doc
: /* List of functions to call before redisplaying a window with scrolling.
28950 Each function is called with two arguments, the window and its new
28951 display-start position. Note that these functions are also called by
28952 `set-window-buffer'. Also note that the value of `window-end' is not
28953 valid when these functions are called.
28955 Warning: Do not use this feature to alter the way the window
28956 is scrolled. It is not designed for that, and such use probably won't
28958 Vwindow_scroll_functions
= Qnil
;
28960 DEFVAR_LISP ("window-text-change-functions",
28961 Vwindow_text_change_functions
,
28962 doc
: /* Functions to call in redisplay when text in the window might change. */);
28963 Vwindow_text_change_functions
= Qnil
;
28965 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28966 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28967 Each function is called with two arguments, the window and the end trigger value.
28968 See `set-window-redisplay-end-trigger'. */);
28969 Vredisplay_end_trigger_functions
= Qnil
;
28971 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28972 doc
: /* Non-nil means autoselect window with mouse pointer.
28973 If nil, do not autoselect windows.
28974 A positive number means delay autoselection by that many seconds: a
28975 window is autoselected only after the mouse has remained in that
28976 window for the duration of the delay.
28977 A negative number has a similar effect, but causes windows to be
28978 autoselected only after the mouse has stopped moving. \(Because of
28979 the way Emacs compares mouse events, you will occasionally wait twice
28980 that time before the window gets selected.\)
28981 Any other value means to autoselect window instantaneously when the
28982 mouse pointer enters it.
28984 Autoselection selects the minibuffer only if it is active, and never
28985 unselects the minibuffer if it is active.
28987 When customizing this variable make sure that the actual value of
28988 `focus-follows-mouse' matches the behavior of your window manager. */);
28989 Vmouse_autoselect_window
= Qnil
;
28991 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28992 doc
: /* Non-nil means automatically resize tool-bars.
28993 This dynamically changes the tool-bar's height to the minimum height
28994 that is needed to make all tool-bar items visible.
28995 If value is `grow-only', the tool-bar's height is only increased
28996 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28997 Vauto_resize_tool_bars
= Qt
;
28999 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29000 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29001 auto_raise_tool_bar_buttons_p
= 1;
29003 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29004 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29005 make_cursor_line_fully_visible_p
= 1;
29007 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29008 doc
: /* Border below tool-bar in pixels.
29009 If an integer, use it as the height of the border.
29010 If it is one of `internal-border-width' or `border-width', use the
29011 value of the corresponding frame parameter.
29012 Otherwise, no border is added below the tool-bar. */);
29013 Vtool_bar_border
= Qinternal_border_width
;
29015 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29016 doc
: /* Margin around tool-bar buttons in pixels.
29017 If an integer, use that for both horizontal and vertical margins.
29018 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29019 HORZ specifying the horizontal margin, and VERT specifying the
29020 vertical margin. */);
29021 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29023 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29024 doc
: /* Relief thickness of tool-bar buttons. */);
29025 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29027 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29028 doc
: /* Tool bar style to use.
29030 image - show images only
29031 text - show text only
29032 both - show both, text below image
29033 both-horiz - show text to the right of the image
29034 text-image-horiz - show text to the left of the image
29035 any other - use system default or image if no system default.
29037 This variable only affects the GTK+ toolkit version of Emacs. */);
29038 Vtool_bar_style
= Qnil
;
29040 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29041 doc
: /* Maximum number of characters a label can have to be shown.
29042 The tool bar style must also show labels for this to have any effect, see
29043 `tool-bar-style'. */);
29044 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29046 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29047 doc
: /* List of functions to call to fontify regions of text.
29048 Each function is called with one argument POS. Functions must
29049 fontify a region starting at POS in the current buffer, and give
29050 fontified regions the property `fontified'. */);
29051 Vfontification_functions
= Qnil
;
29052 Fmake_variable_buffer_local (Qfontification_functions
);
29054 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29055 unibyte_display_via_language_environment
,
29056 doc
: /* Non-nil means display unibyte text according to language environment.
29057 Specifically, this means that raw bytes in the range 160-255 decimal
29058 are displayed by converting them to the equivalent multibyte characters
29059 according to the current language environment. As a result, they are
29060 displayed according to the current fontset.
29062 Note that this variable affects only how these bytes are displayed,
29063 but does not change the fact they are interpreted as raw bytes. */);
29064 unibyte_display_via_language_environment
= 0;
29066 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29067 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29068 If a float, it specifies a fraction of the mini-window frame's height.
29069 If an integer, it specifies a number of lines. */);
29070 Vmax_mini_window_height
= make_float (0.25);
29072 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29073 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29074 A value of nil means don't automatically resize mini-windows.
29075 A value of t means resize them to fit the text displayed in them.
29076 A value of `grow-only', the default, means let mini-windows grow only;
29077 they return to their normal size when the minibuffer is closed, or the
29078 echo area becomes empty. */);
29079 Vresize_mini_windows
= Qgrow_only
;
29081 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29082 doc
: /* Alist specifying how to blink the cursor off.
29083 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29084 `cursor-type' frame-parameter or variable equals ON-STATE,
29085 comparing using `equal', Emacs uses OFF-STATE to specify
29086 how to blink it off. ON-STATE and OFF-STATE are values for
29087 the `cursor-type' frame parameter.
29089 If a frame's ON-STATE has no entry in this list,
29090 the frame's other specifications determine how to blink the cursor off. */);
29091 Vblink_cursor_alist
= Qnil
;
29093 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29094 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29095 If non-nil, windows are automatically scrolled horizontally to make
29096 point visible. */);
29097 automatic_hscrolling_p
= 1;
29098 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29100 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29101 doc
: /* How many columns away from the window edge point is allowed to get
29102 before automatic hscrolling will horizontally scroll the window. */);
29103 hscroll_margin
= 5;
29105 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29106 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29107 When point is less than `hscroll-margin' columns from the window
29108 edge, automatic hscrolling will scroll the window by the amount of columns
29109 determined by this variable. If its value is a positive integer, scroll that
29110 many columns. If it's a positive floating-point number, it specifies the
29111 fraction of the window's width to scroll. If it's nil or zero, point will be
29112 centered horizontally after the scroll. Any other value, including negative
29113 numbers, are treated as if the value were zero.
29115 Automatic hscrolling always moves point outside the scroll margin, so if
29116 point was more than scroll step columns inside the margin, the window will
29117 scroll more than the value given by the scroll step.
29119 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29120 and `scroll-right' overrides this variable's effect. */);
29121 Vhscroll_step
= make_number (0);
29123 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29124 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29125 Bind this around calls to `message' to let it take effect. */);
29126 message_truncate_lines
= 0;
29128 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29129 doc
: /* Normal hook run to update the menu bar definitions.
29130 Redisplay runs this hook before it redisplays the menu bar.
29131 This is used to update submenus such as Buffers,
29132 whose contents depend on various data. */);
29133 Vmenu_bar_update_hook
= Qnil
;
29135 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29136 doc
: /* Frame for which we are updating a menu.
29137 The enable predicate for a menu binding should check this variable. */);
29138 Vmenu_updating_frame
= Qnil
;
29140 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29141 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29142 inhibit_menubar_update
= 0;
29144 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29145 doc
: /* Prefix prepended to all continuation lines at display time.
29146 The value may be a string, an image, or a stretch-glyph; it is
29147 interpreted in the same way as the value of a `display' text property.
29149 This variable is overridden by any `wrap-prefix' text or overlay
29152 To add a prefix to non-continuation lines, use `line-prefix'. */);
29153 Vwrap_prefix
= Qnil
;
29154 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29155 Fmake_variable_buffer_local (Qwrap_prefix
);
29157 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29158 doc
: /* Prefix prepended to all non-continuation lines at display time.
29159 The value may be a string, an image, or a stretch-glyph; it is
29160 interpreted in the same way as the value of a `display' text property.
29162 This variable is overridden by any `line-prefix' text or overlay
29165 To add a prefix to continuation lines, use `wrap-prefix'. */);
29166 Vline_prefix
= Qnil
;
29167 DEFSYM (Qline_prefix
, "line-prefix");
29168 Fmake_variable_buffer_local (Qline_prefix
);
29170 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29171 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29172 inhibit_eval_during_redisplay
= 0;
29174 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29175 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29176 inhibit_free_realized_faces
= 0;
29179 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29180 doc
: /* Inhibit try_window_id display optimization. */);
29181 inhibit_try_window_id
= 0;
29183 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29184 doc
: /* Inhibit try_window_reusing display optimization. */);
29185 inhibit_try_window_reusing
= 0;
29187 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29188 doc
: /* Inhibit try_cursor_movement display optimization. */);
29189 inhibit_try_cursor_movement
= 0;
29190 #endif /* GLYPH_DEBUG */
29192 DEFVAR_INT ("overline-margin", overline_margin
,
29193 doc
: /* Space between overline and text, in pixels.
29194 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29195 margin to the character height. */);
29196 overline_margin
= 2;
29198 DEFVAR_INT ("underline-minimum-offset",
29199 underline_minimum_offset
,
29200 doc
: /* Minimum distance between baseline and underline.
29201 This can improve legibility of underlined text at small font sizes,
29202 particularly when using variable `x-use-underline-position-properties'
29203 with fonts that specify an UNDERLINE_POSITION relatively close to the
29204 baseline. The default value is 1. */);
29205 underline_minimum_offset
= 1;
29207 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29208 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29209 This feature only works when on a window system that can change
29210 cursor shapes. */);
29211 display_hourglass_p
= 1;
29213 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29214 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29215 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29217 hourglass_atimer
= NULL
;
29218 hourglass_shown_p
= 0;
29220 DEFSYM (Qglyphless_char
, "glyphless-char");
29221 DEFSYM (Qhex_code
, "hex-code");
29222 DEFSYM (Qempty_box
, "empty-box");
29223 DEFSYM (Qthin_space
, "thin-space");
29224 DEFSYM (Qzero_width
, "zero-width");
29226 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29227 /* Intern this now in case it isn't already done.
29228 Setting this variable twice is harmless.
29229 But don't staticpro it here--that is done in alloc.c. */
29230 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29231 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29233 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29234 doc
: /* Char-table defining glyphless characters.
29235 Each element, if non-nil, should be one of the following:
29236 an ASCII acronym string: display this string in a box
29237 `hex-code': display the hexadecimal code of a character in a box
29238 `empty-box': display as an empty box
29239 `thin-space': display as 1-pixel width space
29240 `zero-width': don't display
29241 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29242 display method for graphical terminals and text terminals respectively.
29243 GRAPHICAL and TEXT should each have one of the values listed above.
29245 The char-table has one extra slot to control the display of a character for
29246 which no font is found. This slot only takes effect on graphical terminals.
29247 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29248 `thin-space'. The default is `empty-box'. */);
29249 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29250 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29255 /* Initialize this module when Emacs starts. */
29260 current_header_line_height
= current_mode_line_height
= -1;
29262 CHARPOS (this_line_start_pos
) = 0;
29264 if (!noninteractive
)
29266 struct window
*m
= XWINDOW (minibuf_window
);
29267 Lisp_Object frame
= m
->frame
;
29268 struct frame
*f
= XFRAME (frame
);
29269 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29270 struct window
*r
= XWINDOW (root
);
29273 echo_area_window
= minibuf_window
;
29275 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
29276 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
29277 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
29278 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
29279 XSETFASTINT (m
->total_lines
, 1);
29280 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
29282 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29283 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29284 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29286 /* The default ellipsis glyphs `...'. */
29287 for (i
= 0; i
< 3; ++i
)
29288 default_invis_vector
[i
] = make_number ('.');
29292 /* Allocate the buffer for frame titles.
29293 Also used for `format-mode-line'. */
29295 mode_line_noprop_buf
= xmalloc (size
);
29296 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29297 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29298 mode_line_target
= MODE_LINE_DISPLAY
;
29301 help_echo_showing_p
= 0;
29304 /* Since w32 does not support atimers, it defines its own implementation of
29305 the following three functions in w32fns.c. */
29308 /* Platform-independent portion of hourglass implementation. */
29310 /* Cancel a currently active hourglass timer, and start a new one. */
29312 start_hourglass (void)
29314 #if defined (HAVE_WINDOW_SYSTEM)
29317 cancel_hourglass ();
29319 if (INTEGERP (Vhourglass_delay
)
29320 && XINT (Vhourglass_delay
) > 0)
29321 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29322 TYPE_MAXIMUM (time_t)),
29324 else if (FLOATP (Vhourglass_delay
)
29325 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29326 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29328 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29330 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29331 show_hourglass
, NULL
);
29336 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29339 cancel_hourglass (void)
29341 #if defined (HAVE_WINDOW_SYSTEM)
29342 if (hourglass_atimer
)
29344 cancel_atimer (hourglass_atimer
);
29345 hourglass_atimer
= NULL
;
29348 if (hourglass_shown_p
)
29352 #endif /* ! WINDOWSNT */