1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 ptrdiff_t help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, ptrdiff_t);
799 static void pint2hrstr (char *, int, ptrdiff_t);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 ptrdiff_t, ptrdiff_t);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, ptrdiff_t);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
815 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
818 static void pop_message (void);
819 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
820 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
821 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
824 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (ptrdiff_t);
840 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, ptrdiff_t);
872 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, ptrdiff_t);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, ptrdiff_t);
905 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
906 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
907 static ptrdiff_t number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static ptrdiff_t next_overlay_change (ptrdiff_t);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, ptrdiff_t, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 prfoduced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 ptrdiff_t rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectagle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 ptrdiff_t count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? clip_to_bounds (-1, XINT (BVAR (current_buffer
,
2591 selective_display
)),
2593 : (!NILP (BVAR (current_buffer
, selective_display
))
2595 it
->selective_display_ellipsis_p
2596 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2598 /* Display table to use. */
2599 it
->dp
= window_display_table (w
);
2601 /* Are multibyte characters enabled in current_buffer? */
2602 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2604 /* Non-zero if we should highlight the region. */
2606 = (!NILP (Vtransient_mark_mode
)
2607 && !NILP (BVAR (current_buffer
, mark_active
))
2608 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2610 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2611 start and end of a visible region in window IT->w. Set both to
2612 -1 to indicate no region. */
2613 if (highlight_region_p
2614 /* Maybe highlight only in selected window. */
2615 && (/* Either show region everywhere. */
2616 highlight_nonselected_windows
2617 /* Or show region in the selected window. */
2618 || w
== XWINDOW (selected_window
)
2619 /* Or show the region if we are in the mini-buffer and W is
2620 the window the mini-buffer refers to. */
2621 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2622 && WINDOWP (minibuf_selected_window
)
2623 && w
== XWINDOW (minibuf_selected_window
))))
2625 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2626 it
->region_beg_charpos
= min (PT
, markpos
);
2627 it
->region_end_charpos
= max (PT
, markpos
);
2630 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2632 /* Get the position at which the redisplay_end_trigger hook should
2633 be run, if it is to be run at all. */
2634 if (MARKERP (w
->redisplay_end_trigger
)
2635 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2636 it
->redisplay_end_trigger_charpos
2637 = marker_position (w
->redisplay_end_trigger
);
2638 else if (INTEGERP (w
->redisplay_end_trigger
))
2639 it
->redisplay_end_trigger_charpos
=
2640 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2642 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2644 /* Are lines in the display truncated? */
2645 if (base_face_id
!= DEFAULT_FACE_ID
2646 || XINT (it
->w
->hscroll
)
2647 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2648 && ((!NILP (Vtruncate_partial_width_windows
)
2649 && !INTEGERP (Vtruncate_partial_width_windows
))
2650 || (INTEGERP (Vtruncate_partial_width_windows
)
2651 && (WINDOW_TOTAL_COLS (it
->w
)
2652 < XINT (Vtruncate_partial_width_windows
))))))
2653 it
->line_wrap
= TRUNCATE
;
2654 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2655 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2656 ? WINDOW_WRAP
: WORD_WRAP
;
2658 it
->line_wrap
= TRUNCATE
;
2660 /* Get dimensions of truncation and continuation glyphs. These are
2661 displayed as fringe bitmaps under X, so we don't need them for such
2663 if (!FRAME_WINDOW_P (it
->f
))
2665 if (it
->line_wrap
== TRUNCATE
)
2667 /* We will need the truncation glyph. */
2668 xassert (it
->glyph_row
== NULL
);
2669 produce_special_glyphs (it
, IT_TRUNCATION
);
2670 it
->truncation_pixel_width
= it
->pixel_width
;
2674 /* We will need the continuation glyph. */
2675 xassert (it
->glyph_row
== NULL
);
2676 produce_special_glyphs (it
, IT_CONTINUATION
);
2677 it
->continuation_pixel_width
= it
->pixel_width
;
2680 /* Reset these values to zero because the produce_special_glyphs
2681 above has changed them. */
2682 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2683 it
->phys_ascent
= it
->phys_descent
= 0;
2686 /* Set this after getting the dimensions of truncation and
2687 continuation glyphs, so that we don't produce glyphs when calling
2688 produce_special_glyphs, above. */
2689 it
->glyph_row
= row
;
2690 it
->area
= TEXT_AREA
;
2692 /* Forget any previous info about this row being reversed. */
2694 it
->glyph_row
->reversed_p
= 0;
2696 /* Get the dimensions of the display area. The display area
2697 consists of the visible window area plus a horizontally scrolled
2698 part to the left of the window. All x-values are relative to the
2699 start of this total display area. */
2700 if (base_face_id
!= DEFAULT_FACE_ID
)
2702 /* Mode lines, menu bar in terminal frames. */
2703 it
->first_visible_x
= 0;
2704 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2709 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2710 it
->last_visible_x
= (it
->first_visible_x
2711 + window_box_width (w
, TEXT_AREA
));
2713 /* If we truncate lines, leave room for the truncator glyph(s) at
2714 the right margin. Otherwise, leave room for the continuation
2715 glyph(s). Truncation and continuation glyphs are not inserted
2716 for window-based redisplay. */
2717 if (!FRAME_WINDOW_P (it
->f
))
2719 if (it
->line_wrap
== TRUNCATE
)
2720 it
->last_visible_x
-= it
->truncation_pixel_width
;
2722 it
->last_visible_x
-= it
->continuation_pixel_width
;
2725 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2726 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2729 /* Leave room for a border glyph. */
2730 if (!FRAME_WINDOW_P (it
->f
)
2731 && !WINDOW_RIGHTMOST_P (it
->w
))
2732 it
->last_visible_x
-= 1;
2734 it
->last_visible_y
= window_text_bottom_y (w
);
2736 /* For mode lines and alike, arrange for the first glyph having a
2737 left box line if the face specifies a box. */
2738 if (base_face_id
!= DEFAULT_FACE_ID
)
2742 it
->face_id
= remapped_base_face_id
;
2744 /* If we have a boxed mode line, make the first character appear
2745 with a left box line. */
2746 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2747 if (face
->box
!= FACE_NO_BOX
)
2748 it
->start_of_box_run_p
= 1;
2751 /* If a buffer position was specified, set the iterator there,
2752 getting overlays and face properties from that position. */
2753 if (charpos
>= BUF_BEG (current_buffer
))
2755 it
->end_charpos
= ZV
;
2757 IT_CHARPOS (*it
) = charpos
;
2759 /* Compute byte position if not specified. */
2760 if (bytepos
< charpos
)
2761 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2763 IT_BYTEPOS (*it
) = bytepos
;
2765 it
->start
= it
->current
;
2766 /* Do we need to reorder bidirectional text? Not if this is a
2767 unibyte buffer: by definition, none of the single-byte
2768 characters are strong R2L, so no reordering is needed. And
2769 bidi.c doesn't support unibyte buffers anyway. */
2771 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2774 /* If we are to reorder bidirectional text, init the bidi
2778 /* Note the paragraph direction that this buffer wants to
2780 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2782 it
->paragraph_embedding
= L2R
;
2783 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2785 it
->paragraph_embedding
= R2L
;
2787 it
->paragraph_embedding
= NEUTRAL_DIR
;
2788 bidi_unshelve_cache (NULL
, 0);
2789 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2793 /* Compute faces etc. */
2794 reseat (it
, it
->current
.pos
, 1);
2801 /* Initialize IT for the display of window W with window start POS. */
2804 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2806 struct glyph_row
*row
;
2807 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2809 row
= w
->desired_matrix
->rows
+ first_vpos
;
2810 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2811 it
->first_vpos
= first_vpos
;
2813 /* Don't reseat to previous visible line start if current start
2814 position is in a string or image. */
2815 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2817 int start_at_line_beg_p
;
2818 int first_y
= it
->current_y
;
2820 /* If window start is not at a line start, skip forward to POS to
2821 get the correct continuation lines width. */
2822 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2823 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2824 if (!start_at_line_beg_p
)
2828 reseat_at_previous_visible_line_start (it
);
2829 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2831 new_x
= it
->current_x
+ it
->pixel_width
;
2833 /* If lines are continued, this line may end in the middle
2834 of a multi-glyph character (e.g. a control character
2835 displayed as \003, or in the middle of an overlay
2836 string). In this case move_it_to above will not have
2837 taken us to the start of the continuation line but to the
2838 end of the continued line. */
2839 if (it
->current_x
> 0
2840 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2841 && (/* And glyph doesn't fit on the line. */
2842 new_x
> it
->last_visible_x
2843 /* Or it fits exactly and we're on a window
2845 || (new_x
== it
->last_visible_x
2846 && FRAME_WINDOW_P (it
->f
))))
2848 if (it
->current
.dpvec_index
>= 0
2849 || it
->current
.overlay_string_index
>= 0)
2851 set_iterator_to_next (it
, 1);
2852 move_it_in_display_line_to (it
, -1, -1, 0);
2855 it
->continuation_lines_width
+= it
->current_x
;
2858 /* We're starting a new display line, not affected by the
2859 height of the continued line, so clear the appropriate
2860 fields in the iterator structure. */
2861 it
->max_ascent
= it
->max_descent
= 0;
2862 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2864 it
->current_y
= first_y
;
2866 it
->current_x
= it
->hpos
= 0;
2872 /* Return 1 if POS is a position in ellipses displayed for invisible
2873 text. W is the window we display, for text property lookup. */
2876 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2878 Lisp_Object prop
, window
;
2880 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2882 /* If POS specifies a position in a display vector, this might
2883 be for an ellipsis displayed for invisible text. We won't
2884 get the iterator set up for delivering that ellipsis unless
2885 we make sure that it gets aware of the invisible text. */
2886 if (pos
->dpvec_index
>= 0
2887 && pos
->overlay_string_index
< 0
2888 && CHARPOS (pos
->string_pos
) < 0
2890 && (XSETWINDOW (window
, w
),
2891 prop
= Fget_char_property (make_number (charpos
),
2892 Qinvisible
, window
),
2893 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2895 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2897 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2904 /* Initialize IT for stepping through current_buffer in window W,
2905 starting at position POS that includes overlay string and display
2906 vector/ control character translation position information. Value
2907 is zero if there are overlay strings with newlines at POS. */
2910 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2912 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2913 int i
, overlay_strings_with_newlines
= 0;
2915 /* If POS specifies a position in a display vector, this might
2916 be for an ellipsis displayed for invisible text. We won't
2917 get the iterator set up for delivering that ellipsis unless
2918 we make sure that it gets aware of the invisible text. */
2919 if (in_ellipses_for_invisible_text_p (pos
, w
))
2925 /* Keep in mind: the call to reseat in init_iterator skips invisible
2926 text, so we might end up at a position different from POS. This
2927 is only a problem when POS is a row start after a newline and an
2928 overlay starts there with an after-string, and the overlay has an
2929 invisible property. Since we don't skip invisible text in
2930 display_line and elsewhere immediately after consuming the
2931 newline before the row start, such a POS will not be in a string,
2932 but the call to init_iterator below will move us to the
2934 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2936 /* This only scans the current chunk -- it should scan all chunks.
2937 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2938 to 16 in 22.1 to make this a lesser problem. */
2939 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2941 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2942 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2944 while (s
< e
&& *s
!= '\n')
2949 overlay_strings_with_newlines
= 1;
2954 /* If position is within an overlay string, set up IT to the right
2956 if (pos
->overlay_string_index
>= 0)
2960 /* If the first overlay string happens to have a `display'
2961 property for an image, the iterator will be set up for that
2962 image, and we have to undo that setup first before we can
2963 correct the overlay string index. */
2964 if (it
->method
== GET_FROM_IMAGE
)
2967 /* We already have the first chunk of overlay strings in
2968 IT->overlay_strings. Load more until the one for
2969 pos->overlay_string_index is in IT->overlay_strings. */
2970 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2972 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2973 it
->current
.overlay_string_index
= 0;
2976 load_overlay_strings (it
, 0);
2977 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2981 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2982 relative_index
= (it
->current
.overlay_string_index
2983 % OVERLAY_STRING_CHUNK_SIZE
);
2984 it
->string
= it
->overlay_strings
[relative_index
];
2985 xassert (STRINGP (it
->string
));
2986 it
->current
.string_pos
= pos
->string_pos
;
2987 it
->method
= GET_FROM_STRING
;
2990 if (CHARPOS (pos
->string_pos
) >= 0)
2992 /* Recorded position is not in an overlay string, but in another
2993 string. This can only be a string from a `display' property.
2994 IT should already be filled with that string. */
2995 it
->current
.string_pos
= pos
->string_pos
;
2996 xassert (STRINGP (it
->string
));
2999 /* Restore position in display vector translations, control
3000 character translations or ellipses. */
3001 if (pos
->dpvec_index
>= 0)
3003 if (it
->dpvec
== NULL
)
3004 get_next_display_element (it
);
3005 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3006 it
->current
.dpvec_index
= pos
->dpvec_index
;
3010 return !overlay_strings_with_newlines
;
3014 /* Initialize IT for stepping through current_buffer in window W
3015 starting at ROW->start. */
3018 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3020 init_from_display_pos (it
, w
, &row
->start
);
3021 it
->start
= row
->start
;
3022 it
->continuation_lines_width
= row
->continuation_lines_width
;
3027 /* Initialize IT for stepping through current_buffer in window W
3028 starting in the line following ROW, i.e. starting at ROW->end.
3029 Value is zero if there are overlay strings with newlines at ROW's
3033 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3037 if (init_from_display_pos (it
, w
, &row
->end
))
3039 if (row
->continued_p
)
3040 it
->continuation_lines_width
3041 = row
->continuation_lines_width
+ row
->pixel_width
;
3052 /***********************************************************************
3054 ***********************************************************************/
3056 /* Called when IT reaches IT->stop_charpos. Handle text property and
3057 overlay changes. Set IT->stop_charpos to the next position where
3061 handle_stop (struct it
*it
)
3063 enum prop_handled handled
;
3064 int handle_overlay_change_p
;
3068 it
->current
.dpvec_index
= -1;
3069 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3070 it
->ignore_overlay_strings_at_pos_p
= 0;
3073 /* Use face of preceding text for ellipsis (if invisible) */
3074 if (it
->selective_display_ellipsis_p
)
3075 it
->saved_face_id
= it
->face_id
;
3079 handled
= HANDLED_NORMALLY
;
3081 /* Call text property handlers. */
3082 for (p
= it_props
; p
->handler
; ++p
)
3084 handled
= p
->handler (it
);
3086 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3088 else if (handled
== HANDLED_RETURN
)
3090 /* We still want to show before and after strings from
3091 overlays even if the actual buffer text is replaced. */
3092 if (!handle_overlay_change_p
3094 || !get_overlay_strings_1 (it
, 0, 0))
3097 setup_for_ellipsis (it
, 0);
3098 /* When handling a display spec, we might load an
3099 empty string. In that case, discard it here. We
3100 used to discard it in handle_single_display_spec,
3101 but that causes get_overlay_strings_1, above, to
3102 ignore overlay strings that we must check. */
3103 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3107 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3111 it
->ignore_overlay_strings_at_pos_p
= 1;
3112 it
->string_from_display_prop_p
= 0;
3113 it
->from_disp_prop_p
= 0;
3114 handle_overlay_change_p
= 0;
3116 handled
= HANDLED_RECOMPUTE_PROPS
;
3119 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3120 handle_overlay_change_p
= 0;
3123 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3125 /* Don't check for overlay strings below when set to deliver
3126 characters from a display vector. */
3127 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3128 handle_overlay_change_p
= 0;
3130 /* Handle overlay changes.
3131 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3132 if it finds overlays. */
3133 if (handle_overlay_change_p
)
3134 handled
= handle_overlay_change (it
);
3139 setup_for_ellipsis (it
, 0);
3143 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3145 /* Determine where to stop next. */
3146 if (handled
== HANDLED_NORMALLY
)
3147 compute_stop_pos (it
);
3151 /* Compute IT->stop_charpos from text property and overlay change
3152 information for IT's current position. */
3155 compute_stop_pos (struct it
*it
)
3157 register INTERVAL iv
, next_iv
;
3158 Lisp_Object object
, limit
, position
;
3159 ptrdiff_t charpos
, bytepos
;
3161 /* If nowhere else, stop at the end. */
3162 it
->stop_charpos
= it
->end_charpos
;
3164 if (STRINGP (it
->string
))
3166 /* Strings are usually short, so don't limit the search for
3168 object
= it
->string
;
3170 charpos
= IT_STRING_CHARPOS (*it
);
3171 bytepos
= IT_STRING_BYTEPOS (*it
);
3177 /* If next overlay change is in front of the current stop pos
3178 (which is IT->end_charpos), stop there. Note: value of
3179 next_overlay_change is point-max if no overlay change
3181 charpos
= IT_CHARPOS (*it
);
3182 bytepos
= IT_BYTEPOS (*it
);
3183 pos
= next_overlay_change (charpos
);
3184 if (pos
< it
->stop_charpos
)
3185 it
->stop_charpos
= pos
;
3187 /* If showing the region, we have to stop at the region
3188 start or end because the face might change there. */
3189 if (it
->region_beg_charpos
> 0)
3191 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3192 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3193 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3194 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3197 /* Set up variables for computing the stop position from text
3198 property changes. */
3199 XSETBUFFER (object
, current_buffer
);
3200 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3203 /* Get the interval containing IT's position. Value is a null
3204 interval if there isn't such an interval. */
3205 position
= make_number (charpos
);
3206 iv
= validate_interval_range (object
, &position
, &position
, 0);
3207 if (!NULL_INTERVAL_P (iv
))
3209 Lisp_Object values_here
[LAST_PROP_IDX
];
3212 /* Get properties here. */
3213 for (p
= it_props
; p
->handler
; ++p
)
3214 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3216 /* Look for an interval following iv that has different
3218 for (next_iv
= next_interval (iv
);
3219 (!NULL_INTERVAL_P (next_iv
)
3221 || XFASTINT (limit
) > next_iv
->position
));
3222 next_iv
= next_interval (next_iv
))
3224 for (p
= it_props
; p
->handler
; ++p
)
3226 Lisp_Object new_value
;
3228 new_value
= textget (next_iv
->plist
, *p
->name
);
3229 if (!EQ (values_here
[p
->idx
], new_value
))
3237 if (!NULL_INTERVAL_P (next_iv
))
3239 if (INTEGERP (limit
)
3240 && next_iv
->position
>= XFASTINT (limit
))
3241 /* No text property change up to limit. */
3242 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3244 /* Text properties change in next_iv. */
3245 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3249 if (it
->cmp_it
.id
< 0)
3251 ptrdiff_t stoppos
= it
->end_charpos
;
3253 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3255 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3256 stoppos
, it
->string
);
3259 xassert (STRINGP (it
->string
)
3260 || (it
->stop_charpos
>= BEGV
3261 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3265 /* Return the position of the next overlay change after POS in
3266 current_buffer. Value is point-max if no overlay change
3267 follows. This is like `next-overlay-change' but doesn't use
3271 next_overlay_change (ptrdiff_t pos
)
3273 ptrdiff_t i
, noverlays
;
3275 Lisp_Object
*overlays
;
3277 /* Get all overlays at the given position. */
3278 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3280 /* If any of these overlays ends before endpos,
3281 use its ending point instead. */
3282 for (i
= 0; i
< noverlays
; ++i
)
3287 oend
= OVERLAY_END (overlays
[i
]);
3288 oendpos
= OVERLAY_POSITION (oend
);
3289 endpos
= min (endpos
, oendpos
);
3295 /* How many characters forward to search for a display property or
3296 display string. Searching too far forward makes the bidi display
3297 sluggish, especially in small windows. */
3298 #define MAX_DISP_SCAN 250
3300 /* Return the character position of a display string at or after
3301 position specified by POSITION. If no display string exists at or
3302 after POSITION, return ZV. A display string is either an overlay
3303 with `display' property whose value is a string, or a `display'
3304 text property whose value is a string. STRING is data about the
3305 string to iterate; if STRING->lstring is nil, we are iterating a
3306 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3307 on a GUI frame. DISP_PROP is set to zero if we searched
3308 MAX_DISP_SCAN characters forward without finding any display
3309 strings, non-zero otherwise. It is set to 2 if the display string
3310 uses any kind of `(space ...)' spec that will produce a stretch of
3311 white space in the text area. */
3313 compute_display_string_pos (struct text_pos
*position
,
3314 struct bidi_string_data
*string
,
3315 int frame_window_p
, int *disp_prop
)
3317 /* OBJECT = nil means current buffer. */
3318 Lisp_Object object
=
3319 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3320 Lisp_Object pos
, spec
, limpos
;
3321 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3322 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3323 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3324 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3326 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3327 struct text_pos tpos
;
3333 /* We don't support display properties whose values are strings
3334 that have display string properties. */
3335 || string
->from_disp_str
3336 /* C strings cannot have display properties. */
3337 || (string
->s
&& !STRINGP (object
)))
3343 /* If the character at CHARPOS is where the display string begins,
3345 pos
= make_number (charpos
);
3346 if (STRINGP (object
))
3347 bufpos
= string
->bufpos
;
3351 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3353 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3356 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3364 /* Look forward for the first character with a `display' property
3365 that will replace the underlying text when displayed. */
3366 limpos
= make_number (lim
);
3368 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3369 CHARPOS (tpos
) = XFASTINT (pos
);
3370 if (CHARPOS (tpos
) >= lim
)
3375 if (STRINGP (object
))
3376 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3378 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3379 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3380 if (!STRINGP (object
))
3381 bufpos
= CHARPOS (tpos
);
3382 } while (NILP (spec
)
3383 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3384 bufpos
, frame_window_p
)));
3388 return CHARPOS (tpos
);
3391 /* Return the character position of the end of the display string that
3392 started at CHARPOS. If there's no display string at CHARPOS,
3393 return -1. A display string is either an overlay with `display'
3394 property whose value is a string or a `display' text property whose
3395 value is a string. */
3397 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3399 /* OBJECT = nil means current buffer. */
3400 Lisp_Object object
=
3401 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3402 Lisp_Object pos
= make_number (charpos
);
3404 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3406 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3409 /* It could happen that the display property or overlay was removed
3410 since we found it in compute_display_string_pos above. One way
3411 this can happen is if JIT font-lock was called (through
3412 handle_fontified_prop), and jit-lock-functions remove text
3413 properties or overlays from the portion of buffer that includes
3414 CHARPOS. Muse mode is known to do that, for example. In this
3415 case, we return -1 to the caller, to signal that no display
3416 string is actually present at CHARPOS. See bidi_fetch_char for
3417 how this is handled.
3419 An alternative would be to never look for display properties past
3420 it->stop_charpos. But neither compute_display_string_pos nor
3421 bidi_fetch_char that calls it know or care where the next
3423 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3426 /* Look forward for the first character where the `display' property
3428 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3430 return XFASTINT (pos
);
3435 /***********************************************************************
3437 ***********************************************************************/
3439 /* Handle changes in the `fontified' property of the current buffer by
3440 calling hook functions from Qfontification_functions to fontify
3443 static enum prop_handled
3444 handle_fontified_prop (struct it
*it
)
3446 Lisp_Object prop
, pos
;
3447 enum prop_handled handled
= HANDLED_NORMALLY
;
3449 if (!NILP (Vmemory_full
))
3452 /* Get the value of the `fontified' property at IT's current buffer
3453 position. (The `fontified' property doesn't have a special
3454 meaning in strings.) If the value is nil, call functions from
3455 Qfontification_functions. */
3456 if (!STRINGP (it
->string
)
3458 && !NILP (Vfontification_functions
)
3459 && !NILP (Vrun_hooks
)
3460 && (pos
= make_number (IT_CHARPOS (*it
)),
3461 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3462 /* Ignore the special cased nil value always present at EOB since
3463 no amount of fontifying will be able to change it. */
3464 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3466 ptrdiff_t count
= SPECPDL_INDEX ();
3468 struct buffer
*obuf
= current_buffer
;
3469 int begv
= BEGV
, zv
= ZV
;
3470 int old_clip_changed
= current_buffer
->clip_changed
;
3472 val
= Vfontification_functions
;
3473 specbind (Qfontification_functions
, Qnil
);
3475 xassert (it
->end_charpos
== ZV
);
3477 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3478 safe_call1 (val
, pos
);
3481 Lisp_Object fns
, fn
;
3482 struct gcpro gcpro1
, gcpro2
;
3487 for (; CONSP (val
); val
= XCDR (val
))
3493 /* A value of t indicates this hook has a local
3494 binding; it means to run the global binding too.
3495 In a global value, t should not occur. If it
3496 does, we must ignore it to avoid an endless
3498 for (fns
= Fdefault_value (Qfontification_functions
);
3504 safe_call1 (fn
, pos
);
3508 safe_call1 (fn
, pos
);
3514 unbind_to (count
, Qnil
);
3516 /* Fontification functions routinely call `save-restriction'.
3517 Normally, this tags clip_changed, which can confuse redisplay
3518 (see discussion in Bug#6671). Since we don't perform any
3519 special handling of fontification changes in the case where
3520 `save-restriction' isn't called, there's no point doing so in
3521 this case either. So, if the buffer's restrictions are
3522 actually left unchanged, reset clip_changed. */
3523 if (obuf
== current_buffer
)
3525 if (begv
== BEGV
&& zv
== ZV
)
3526 current_buffer
->clip_changed
= old_clip_changed
;
3528 /* There isn't much we can reasonably do to protect against
3529 misbehaving fontification, but here's a fig leaf. */
3530 else if (!NILP (BVAR (obuf
, name
)))
3531 set_buffer_internal_1 (obuf
);
3533 /* The fontification code may have added/removed text.
3534 It could do even a lot worse, but let's at least protect against
3535 the most obvious case where only the text past `pos' gets changed',
3536 as is/was done in grep.el where some escapes sequences are turned
3537 into face properties (bug#7876). */
3538 it
->end_charpos
= ZV
;
3540 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3541 something. This avoids an endless loop if they failed to
3542 fontify the text for which reason ever. */
3543 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3544 handled
= HANDLED_RECOMPUTE_PROPS
;
3552 /***********************************************************************
3554 ***********************************************************************/
3556 /* Set up iterator IT from face properties at its current position.
3557 Called from handle_stop. */
3559 static enum prop_handled
3560 handle_face_prop (struct it
*it
)
3563 ptrdiff_t next_stop
;
3565 if (!STRINGP (it
->string
))
3568 = face_at_buffer_position (it
->w
,
3570 it
->region_beg_charpos
,
3571 it
->region_end_charpos
,
3574 + TEXT_PROP_DISTANCE_LIMIT
),
3575 0, it
->base_face_id
);
3577 /* Is this a start of a run of characters with box face?
3578 Caveat: this can be called for a freshly initialized
3579 iterator; face_id is -1 in this case. We know that the new
3580 face will not change until limit, i.e. if the new face has a
3581 box, all characters up to limit will have one. But, as
3582 usual, we don't know whether limit is really the end. */
3583 if (new_face_id
!= it
->face_id
)
3585 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3587 /* If new face has a box but old face has not, this is
3588 the start of a run of characters with box, i.e. it has
3589 a shadow on the left side. The value of face_id of the
3590 iterator will be -1 if this is the initial call that gets
3591 the face. In this case, we have to look in front of IT's
3592 position and see whether there is a face != new_face_id. */
3593 it
->start_of_box_run_p
3594 = (new_face
->box
!= FACE_NO_BOX
3595 && (it
->face_id
>= 0
3596 || IT_CHARPOS (*it
) == BEG
3597 || new_face_id
!= face_before_it_pos (it
)));
3598 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3606 Lisp_Object from_overlay
3607 = (it
->current
.overlay_string_index
>= 0
3608 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3611 /* See if we got to this string directly or indirectly from
3612 an overlay property. That includes the before-string or
3613 after-string of an overlay, strings in display properties
3614 provided by an overlay, their text properties, etc.
3616 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3617 if (! NILP (from_overlay
))
3618 for (i
= it
->sp
- 1; i
>= 0; i
--)
3620 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3622 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3623 else if (! NILP (it
->stack
[i
].from_overlay
))
3624 from_overlay
= it
->stack
[i
].from_overlay
;
3626 if (!NILP (from_overlay
))
3630 if (! NILP (from_overlay
))
3632 bufpos
= IT_CHARPOS (*it
);
3633 /* For a string from an overlay, the base face depends
3634 only on text properties and ignores overlays. */
3636 = face_for_overlay_string (it
->w
,
3638 it
->region_beg_charpos
,
3639 it
->region_end_charpos
,
3642 + TEXT_PROP_DISTANCE_LIMIT
),
3650 /* For strings from a `display' property, use the face at
3651 IT's current buffer position as the base face to merge
3652 with, so that overlay strings appear in the same face as
3653 surrounding text, unless they specify their own
3655 base_face_id
= underlying_face_id (it
);
3658 new_face_id
= face_at_string_position (it
->w
,
3660 IT_STRING_CHARPOS (*it
),
3662 it
->region_beg_charpos
,
3663 it
->region_end_charpos
,
3667 /* Is this a start of a run of characters with box? Caveat:
3668 this can be called for a freshly allocated iterator; face_id
3669 is -1 is this case. We know that the new face will not
3670 change until the next check pos, i.e. if the new face has a
3671 box, all characters up to that position will have a
3672 box. But, as usual, we don't know whether that position
3673 is really the end. */
3674 if (new_face_id
!= it
->face_id
)
3676 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3677 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3679 /* If new face has a box but old face hasn't, this is the
3680 start of a run of characters with box, i.e. it has a
3681 shadow on the left side. */
3682 it
->start_of_box_run_p
3683 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3684 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3688 it
->face_id
= new_face_id
;
3689 return HANDLED_NORMALLY
;
3693 /* Return the ID of the face ``underlying'' IT's current position,
3694 which is in a string. If the iterator is associated with a
3695 buffer, return the face at IT's current buffer position.
3696 Otherwise, use the iterator's base_face_id. */
3699 underlying_face_id (struct it
*it
)
3701 int face_id
= it
->base_face_id
, i
;
3703 xassert (STRINGP (it
->string
));
3705 for (i
= it
->sp
- 1; i
>= 0; --i
)
3706 if (NILP (it
->stack
[i
].string
))
3707 face_id
= it
->stack
[i
].face_id
;
3713 /* Compute the face one character before or after the current position
3714 of IT, in the visual order. BEFORE_P non-zero means get the face
3715 in front (to the left in L2R paragraphs, to the right in R2L
3716 paragraphs) of IT's screen position. Value is the ID of the face. */
3719 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3722 ptrdiff_t next_check_charpos
;
3724 void *it_copy_data
= NULL
;
3726 xassert (it
->s
== NULL
);
3728 if (STRINGP (it
->string
))
3730 ptrdiff_t bufpos
, charpos
;
3733 /* No face change past the end of the string (for the case
3734 we are padding with spaces). No face change before the
3736 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3737 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3742 /* Set charpos to the position before or after IT's current
3743 position, in the logical order, which in the non-bidi
3744 case is the same as the visual order. */
3746 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3747 else if (it
->what
== IT_COMPOSITION
)
3748 /* For composition, we must check the character after the
3750 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3752 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3758 /* With bidi iteration, the character before the current
3759 in the visual order cannot be found by simple
3760 iteration, because "reverse" reordering is not
3761 supported. Instead, we need to use the move_it_*
3762 family of functions. */
3763 /* Ignore face changes before the first visible
3764 character on this display line. */
3765 if (it
->current_x
<= it
->first_visible_x
)
3767 SAVE_IT (it_copy
, *it
, it_copy_data
);
3768 /* Implementation note: Since move_it_in_display_line
3769 works in the iterator geometry, and thinks the first
3770 character is always the leftmost, even in R2L lines,
3771 we don't need to distinguish between the R2L and L2R
3773 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3774 it_copy
.current_x
- 1, MOVE_TO_X
);
3775 charpos
= IT_STRING_CHARPOS (it_copy
);
3776 RESTORE_IT (it
, it
, it_copy_data
);
3780 /* Set charpos to the string position of the character
3781 that comes after IT's current position in the visual
3783 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3787 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3789 charpos
= it_copy
.bidi_it
.charpos
;
3792 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3794 if (it
->current
.overlay_string_index
>= 0)
3795 bufpos
= IT_CHARPOS (*it
);
3799 base_face_id
= underlying_face_id (it
);
3801 /* Get the face for ASCII, or unibyte. */
3802 face_id
= face_at_string_position (it
->w
,
3806 it
->region_beg_charpos
,
3807 it
->region_end_charpos
,
3808 &next_check_charpos
,
3811 /* Correct the face for charsets different from ASCII. Do it
3812 for the multibyte case only. The face returned above is
3813 suitable for unibyte text if IT->string is unibyte. */
3814 if (STRING_MULTIBYTE (it
->string
))
3816 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3817 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3819 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3821 c
= string_char_and_length (p
, &len
);
3822 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3827 struct text_pos pos
;
3829 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3830 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3833 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3834 pos
= it
->current
.pos
;
3839 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3842 if (it
->what
== IT_COMPOSITION
)
3844 /* For composition, we must check the position after
3846 pos
.charpos
+= it
->cmp_it
.nchars
;
3847 pos
.bytepos
+= it
->len
;
3850 INC_TEXT_POS (pos
, it
->multibyte_p
);
3857 /* With bidi iteration, the character before the current
3858 in the visual order cannot be found by simple
3859 iteration, because "reverse" reordering is not
3860 supported. Instead, we need to use the move_it_*
3861 family of functions. */
3862 /* Ignore face changes before the first visible
3863 character on this display line. */
3864 if (it
->current_x
<= it
->first_visible_x
)
3866 SAVE_IT (it_copy
, *it
, it_copy_data
);
3867 /* Implementation note: Since move_it_in_display_line
3868 works in the iterator geometry, and thinks the first
3869 character is always the leftmost, even in R2L lines,
3870 we don't need to distinguish between the R2L and L2R
3872 move_it_in_display_line (&it_copy
, ZV
,
3873 it_copy
.current_x
- 1, MOVE_TO_X
);
3874 pos
= it_copy
.current
.pos
;
3875 RESTORE_IT (it
, it
, it_copy_data
);
3879 /* Set charpos to the buffer position of the character
3880 that comes after IT's current position in the visual
3882 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3886 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3889 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3892 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3894 /* Determine face for CHARSET_ASCII, or unibyte. */
3895 face_id
= face_at_buffer_position (it
->w
,
3897 it
->region_beg_charpos
,
3898 it
->region_end_charpos
,
3899 &next_check_charpos
,
3902 /* Correct the face for charsets different from ASCII. Do it
3903 for the multibyte case only. The face returned above is
3904 suitable for unibyte text if current_buffer is unibyte. */
3905 if (it
->multibyte_p
)
3907 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3908 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3909 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3918 /***********************************************************************
3920 ***********************************************************************/
3922 /* Set up iterator IT from invisible properties at its current
3923 position. Called from handle_stop. */
3925 static enum prop_handled
3926 handle_invisible_prop (struct it
*it
)
3928 enum prop_handled handled
= HANDLED_NORMALLY
;
3930 if (STRINGP (it
->string
))
3932 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3934 /* Get the value of the invisible text property at the
3935 current position. Value will be nil if there is no such
3937 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3938 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3941 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3945 handled
= HANDLED_RECOMPUTE_PROPS
;
3947 /* Get the position at which the next change of the
3948 invisible text property can be found in IT->string.
3949 Value will be nil if the property value is the same for
3950 all the rest of IT->string. */
3951 XSETINT (limit
, SCHARS (it
->string
));
3952 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3955 /* Text at current position is invisible. The next
3956 change in the property is at position end_charpos.
3957 Move IT's current position to that position. */
3958 if (INTEGERP (end_charpos
)
3959 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3961 struct text_pos old
;
3964 old
= it
->current
.string_pos
;
3965 oldpos
= CHARPOS (old
);
3968 if (it
->bidi_it
.first_elt
3969 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3970 bidi_paragraph_init (it
->paragraph_embedding
,
3972 /* Bidi-iterate out of the invisible text. */
3975 bidi_move_to_visually_next (&it
->bidi_it
);
3977 while (oldpos
<= it
->bidi_it
.charpos
3978 && it
->bidi_it
.charpos
< endpos
);
3980 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3981 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3982 if (IT_CHARPOS (*it
) >= endpos
)
3983 it
->prev_stop
= endpos
;
3987 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3988 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3993 /* The rest of the string is invisible. If this is an
3994 overlay string, proceed with the next overlay string
3995 or whatever comes and return a character from there. */
3996 if (it
->current
.overlay_string_index
>= 0)
3998 next_overlay_string (it
);
3999 /* Don't check for overlay strings when we just
4000 finished processing them. */
4001 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4005 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4006 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4014 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4015 Lisp_Object pos
, prop
, overlay
;
4017 /* First of all, is there invisible text at this position? */
4018 tem
= start_charpos
= IT_CHARPOS (*it
);
4019 pos
= make_number (tem
);
4020 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4022 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4024 /* If we are on invisible text, skip over it. */
4025 if (invis_p
&& start_charpos
< it
->end_charpos
)
4027 /* Record whether we have to display an ellipsis for the
4029 int display_ellipsis_p
= invis_p
== 2;
4031 handled
= HANDLED_RECOMPUTE_PROPS
;
4033 /* Loop skipping over invisible text. The loop is left at
4034 ZV or with IT on the first char being visible again. */
4037 /* Try to skip some invisible text. Return value is the
4038 position reached which can be equal to where we start
4039 if there is nothing invisible there. This skips both
4040 over invisible text properties and overlays with
4041 invisible property. */
4042 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4044 /* If we skipped nothing at all we weren't at invisible
4045 text in the first place. If everything to the end of
4046 the buffer was skipped, end the loop. */
4047 if (newpos
== tem
|| newpos
>= ZV
)
4051 /* We skipped some characters but not necessarily
4052 all there are. Check if we ended up on visible
4053 text. Fget_char_property returns the property of
4054 the char before the given position, i.e. if we
4055 get invis_p = 0, this means that the char at
4056 newpos is visible. */
4057 pos
= make_number (newpos
);
4058 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4059 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4062 /* If we ended up on invisible text, proceed to
4063 skip starting with next_stop. */
4067 /* If there are adjacent invisible texts, don't lose the
4068 second one's ellipsis. */
4070 display_ellipsis_p
= 1;
4074 /* The position newpos is now either ZV or on visible text. */
4075 if (it
->bidi_p
&& newpos
< ZV
)
4077 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4079 if (FETCH_BYTE (bpos
) == '\n'
4080 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4082 /* If the invisible text ends on a newline or the
4083 character after a newline, we can avoid the
4084 costly, character by character, bidi iteration to
4085 newpos, and instead simply reseat the iterator
4086 there. That's because all bidi reordering
4087 information is tossed at the newline. This is a
4088 big win for modes that hide complete lines, like
4089 Outline, Org, etc. (Implementation note: the
4090 call to reseat_1 is necessary, because it signals
4091 to the bidi iterator that it needs to reinit its
4092 internal information when the next element for
4093 display is requested. */
4094 struct text_pos tpos
;
4096 SET_TEXT_POS (tpos
, newpos
, bpos
);
4097 reseat_1 (it
, tpos
, 0);
4099 else /* Must use the slow method. */
4101 /* With bidi iteration, the region of invisible text
4102 could start and/or end in the middle of a
4103 non-base embedding level. Therefore, we need to
4104 skip invisible text using the bidi iterator,
4105 starting at IT's current position, until we find
4106 ourselves outside the invisible text. Skipping
4107 invisible text _after_ bidi iteration avoids
4108 affecting the visual order of the displayed text
4109 when invisible properties are added or
4111 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4113 /* If we were `reseat'ed to a new paragraph,
4114 determine the paragraph base direction. We
4115 need to do it now because
4116 next_element_from_buffer may not have a
4117 chance to do it, if we are going to skip any
4118 text at the beginning, which resets the
4120 bidi_paragraph_init (it
->paragraph_embedding
,
4125 bidi_move_to_visually_next (&it
->bidi_it
);
4127 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4128 && it
->bidi_it
.charpos
< newpos
);
4129 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4130 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4131 /* If we overstepped NEWPOS, record its position in
4132 the iterator, so that we skip invisible text if
4133 later the bidi iteration lands us in the
4134 invisible region again. */
4135 if (IT_CHARPOS (*it
) >= newpos
)
4136 it
->prev_stop
= newpos
;
4141 IT_CHARPOS (*it
) = newpos
;
4142 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4145 /* If there are before-strings at the start of invisible
4146 text, and the text is invisible because of a text
4147 property, arrange to show before-strings because 20.x did
4148 it that way. (If the text is invisible because of an
4149 overlay property instead of a text property, this is
4150 already handled in the overlay code.) */
4152 && get_overlay_strings (it
, it
->stop_charpos
))
4154 handled
= HANDLED_RECOMPUTE_PROPS
;
4155 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4157 else if (display_ellipsis_p
)
4159 /* Make sure that the glyphs of the ellipsis will get
4160 correct `charpos' values. If we would not update
4161 it->position here, the glyphs would belong to the
4162 last visible character _before_ the invisible
4163 text, which confuses `set_cursor_from_row'.
4165 We use the last invisible position instead of the
4166 first because this way the cursor is always drawn on
4167 the first "." of the ellipsis, whenever PT is inside
4168 the invisible text. Otherwise the cursor would be
4169 placed _after_ the ellipsis when the point is after the
4170 first invisible character. */
4171 if (!STRINGP (it
->object
))
4173 it
->position
.charpos
= newpos
- 1;
4174 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4177 /* Let the ellipsis display before
4178 considering any properties of the following char.
4179 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4180 handled
= HANDLED_RETURN
;
4189 /* Make iterator IT return `...' next.
4190 Replaces LEN characters from buffer. */
4193 setup_for_ellipsis (struct it
*it
, int len
)
4195 /* Use the display table definition for `...'. Invalid glyphs
4196 will be handled by the method returning elements from dpvec. */
4197 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4199 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4200 it
->dpvec
= v
->contents
;
4201 it
->dpend
= v
->contents
+ v
->header
.size
;
4205 /* Default `...'. */
4206 it
->dpvec
= default_invis_vector
;
4207 it
->dpend
= default_invis_vector
+ 3;
4210 it
->dpvec_char_len
= len
;
4211 it
->current
.dpvec_index
= 0;
4212 it
->dpvec_face_id
= -1;
4214 /* Remember the current face id in case glyphs specify faces.
4215 IT's face is restored in set_iterator_to_next.
4216 saved_face_id was set to preceding char's face in handle_stop. */
4217 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4218 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4220 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4226 /***********************************************************************
4228 ***********************************************************************/
4230 /* Set up iterator IT from `display' property at its current position.
4231 Called from handle_stop.
4232 We return HANDLED_RETURN if some part of the display property
4233 overrides the display of the buffer text itself.
4234 Otherwise we return HANDLED_NORMALLY. */
4236 static enum prop_handled
4237 handle_display_prop (struct it
*it
)
4239 Lisp_Object propval
, object
, overlay
;
4240 struct text_pos
*position
;
4242 /* Nonzero if some property replaces the display of the text itself. */
4243 int display_replaced_p
= 0;
4245 if (STRINGP (it
->string
))
4247 object
= it
->string
;
4248 position
= &it
->current
.string_pos
;
4249 bufpos
= CHARPOS (it
->current
.pos
);
4253 XSETWINDOW (object
, it
->w
);
4254 position
= &it
->current
.pos
;
4255 bufpos
= CHARPOS (*position
);
4258 /* Reset those iterator values set from display property values. */
4259 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4260 it
->space_width
= Qnil
;
4261 it
->font_height
= Qnil
;
4264 /* We don't support recursive `display' properties, i.e. string
4265 values that have a string `display' property, that have a string
4266 `display' property etc. */
4267 if (!it
->string_from_display_prop_p
)
4268 it
->area
= TEXT_AREA
;
4270 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4271 Qdisplay
, object
, &overlay
);
4273 return HANDLED_NORMALLY
;
4274 /* Now OVERLAY is the overlay that gave us this property, or nil
4275 if it was a text property. */
4277 if (!STRINGP (it
->string
))
4278 object
= it
->w
->buffer
;
4280 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4282 FRAME_WINDOW_P (it
->f
));
4284 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4287 /* Subroutine of handle_display_prop. Returns non-zero if the display
4288 specification in SPEC is a replacing specification, i.e. it would
4289 replace the text covered by `display' property with something else,
4290 such as an image or a display string. If SPEC includes any kind or
4291 `(space ...) specification, the value is 2; this is used by
4292 compute_display_string_pos, which see.
4294 See handle_single_display_spec for documentation of arguments.
4295 frame_window_p is non-zero if the window being redisplayed is on a
4296 GUI frame; this argument is used only if IT is NULL, see below.
4298 IT can be NULL, if this is called by the bidi reordering code
4299 through compute_display_string_pos, which see. In that case, this
4300 function only examines SPEC, but does not otherwise "handle" it, in
4301 the sense that it doesn't set up members of IT from the display
4304 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4305 Lisp_Object overlay
, struct text_pos
*position
,
4306 ptrdiff_t bufpos
, int frame_window_p
)
4308 int replacing_p
= 0;
4312 /* Simple specerties. */
4313 && !EQ (XCAR (spec
), Qimage
)
4314 && !EQ (XCAR (spec
), Qspace
)
4315 && !EQ (XCAR (spec
), Qwhen
)
4316 && !EQ (XCAR (spec
), Qslice
)
4317 && !EQ (XCAR (spec
), Qspace_width
)
4318 && !EQ (XCAR (spec
), Qheight
)
4319 && !EQ (XCAR (spec
), Qraise
)
4320 /* Marginal area specifications. */
4321 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4322 && !EQ (XCAR (spec
), Qleft_fringe
)
4323 && !EQ (XCAR (spec
), Qright_fringe
)
4324 && !NILP (XCAR (spec
)))
4326 for (; CONSP (spec
); spec
= XCDR (spec
))
4328 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4329 overlay
, position
, bufpos
,
4330 replacing_p
, frame_window_p
)))
4333 /* If some text in a string is replaced, `position' no
4334 longer points to the position of `object'. */
4335 if (!it
|| STRINGP (object
))
4340 else if (VECTORP (spec
))
4343 for (i
= 0; i
< ASIZE (spec
); ++i
)
4344 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4345 overlay
, position
, bufpos
,
4346 replacing_p
, frame_window_p
)))
4349 /* If some text in a string is replaced, `position' no
4350 longer points to the position of `object'. */
4351 if (!it
|| STRINGP (object
))
4357 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4358 position
, bufpos
, 0,
4366 /* Value is the position of the end of the `display' property starting
4367 at START_POS in OBJECT. */
4369 static struct text_pos
4370 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4373 struct text_pos end_pos
;
4375 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4376 Qdisplay
, object
, Qnil
);
4377 CHARPOS (end_pos
) = XFASTINT (end
);
4378 if (STRINGP (object
))
4379 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4381 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4387 /* Set up IT from a single `display' property specification SPEC. OBJECT
4388 is the object in which the `display' property was found. *POSITION
4389 is the position in OBJECT at which the `display' property was found.
4390 BUFPOS is the buffer position of OBJECT (different from POSITION if
4391 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4392 previously saw a display specification which already replaced text
4393 display with something else, for example an image; we ignore such
4394 properties after the first one has been processed.
4396 OVERLAY is the overlay this `display' property came from,
4397 or nil if it was a text property.
4399 If SPEC is a `space' or `image' specification, and in some other
4400 cases too, set *POSITION to the position where the `display'
4403 If IT is NULL, only examine the property specification in SPEC, but
4404 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4405 is intended to be displayed in a window on a GUI frame.
4407 Value is non-zero if something was found which replaces the display
4408 of buffer or string text. */
4411 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4412 Lisp_Object overlay
, struct text_pos
*position
,
4413 ptrdiff_t bufpos
, int display_replaced_p
,
4417 Lisp_Object location
, value
;
4418 struct text_pos start_pos
= *position
;
4421 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4422 If the result is non-nil, use VALUE instead of SPEC. */
4424 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4433 if (!NILP (form
) && !EQ (form
, Qt
))
4435 ptrdiff_t count
= SPECPDL_INDEX ();
4436 struct gcpro gcpro1
;
4438 /* Bind `object' to the object having the `display' property, a
4439 buffer or string. Bind `position' to the position in the
4440 object where the property was found, and `buffer-position'
4441 to the current position in the buffer. */
4444 XSETBUFFER (object
, current_buffer
);
4445 specbind (Qobject
, object
);
4446 specbind (Qposition
, make_number (CHARPOS (*position
)));
4447 specbind (Qbuffer_position
, make_number (bufpos
));
4449 form
= safe_eval (form
);
4451 unbind_to (count
, Qnil
);
4457 /* Handle `(height HEIGHT)' specifications. */
4459 && EQ (XCAR (spec
), Qheight
)
4460 && CONSP (XCDR (spec
)))
4464 if (!FRAME_WINDOW_P (it
->f
))
4467 it
->font_height
= XCAR (XCDR (spec
));
4468 if (!NILP (it
->font_height
))
4470 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4471 int new_height
= -1;
4473 if (CONSP (it
->font_height
)
4474 && (EQ (XCAR (it
->font_height
), Qplus
)
4475 || EQ (XCAR (it
->font_height
), Qminus
))
4476 && CONSP (XCDR (it
->font_height
))
4477 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4479 /* `(+ N)' or `(- N)' where N is an integer. */
4480 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4481 if (EQ (XCAR (it
->font_height
), Qplus
))
4483 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4485 else if (FUNCTIONP (it
->font_height
))
4487 /* Call function with current height as argument.
4488 Value is the new height. */
4490 height
= safe_call1 (it
->font_height
,
4491 face
->lface
[LFACE_HEIGHT_INDEX
]);
4492 if (NUMBERP (height
))
4493 new_height
= XFLOATINT (height
);
4495 else if (NUMBERP (it
->font_height
))
4497 /* Value is a multiple of the canonical char height. */
4500 f
= FACE_FROM_ID (it
->f
,
4501 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4502 new_height
= (XFLOATINT (it
->font_height
)
4503 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4507 /* Evaluate IT->font_height with `height' bound to the
4508 current specified height to get the new height. */
4509 ptrdiff_t count
= SPECPDL_INDEX ();
4511 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4512 value
= safe_eval (it
->font_height
);
4513 unbind_to (count
, Qnil
);
4515 if (NUMBERP (value
))
4516 new_height
= XFLOATINT (value
);
4520 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4527 /* Handle `(space-width WIDTH)'. */
4529 && EQ (XCAR (spec
), Qspace_width
)
4530 && CONSP (XCDR (spec
)))
4534 if (!FRAME_WINDOW_P (it
->f
))
4537 value
= XCAR (XCDR (spec
));
4538 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4539 it
->space_width
= value
;
4545 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4547 && EQ (XCAR (spec
), Qslice
))
4553 if (!FRAME_WINDOW_P (it
->f
))
4556 if (tem
= XCDR (spec
), CONSP (tem
))
4558 it
->slice
.x
= XCAR (tem
);
4559 if (tem
= XCDR (tem
), CONSP (tem
))
4561 it
->slice
.y
= XCAR (tem
);
4562 if (tem
= XCDR (tem
), CONSP (tem
))
4564 it
->slice
.width
= XCAR (tem
);
4565 if (tem
= XCDR (tem
), CONSP (tem
))
4566 it
->slice
.height
= XCAR (tem
);
4575 /* Handle `(raise FACTOR)'. */
4577 && EQ (XCAR (spec
), Qraise
)
4578 && CONSP (XCDR (spec
)))
4582 if (!FRAME_WINDOW_P (it
->f
))
4585 #ifdef HAVE_WINDOW_SYSTEM
4586 value
= XCAR (XCDR (spec
));
4587 if (NUMBERP (value
))
4589 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4590 it
->voffset
= - (XFLOATINT (value
)
4591 * (FONT_HEIGHT (face
->font
)));
4593 #endif /* HAVE_WINDOW_SYSTEM */
4599 /* Don't handle the other kinds of display specifications
4600 inside a string that we got from a `display' property. */
4601 if (it
&& it
->string_from_display_prop_p
)
4604 /* Characters having this form of property are not displayed, so
4605 we have to find the end of the property. */
4608 start_pos
= *position
;
4609 *position
= display_prop_end (it
, object
, start_pos
);
4613 /* Stop the scan at that end position--we assume that all
4614 text properties change there. */
4616 it
->stop_charpos
= position
->charpos
;
4618 /* Handle `(left-fringe BITMAP [FACE])'
4619 and `(right-fringe BITMAP [FACE])'. */
4621 && (EQ (XCAR (spec
), Qleft_fringe
)
4622 || EQ (XCAR (spec
), Qright_fringe
))
4623 && CONSP (XCDR (spec
)))
4629 if (!FRAME_WINDOW_P (it
->f
))
4630 /* If we return here, POSITION has been advanced
4631 across the text with this property. */
4634 else if (!frame_window_p
)
4637 #ifdef HAVE_WINDOW_SYSTEM
4638 value
= XCAR (XCDR (spec
));
4639 if (!SYMBOLP (value
)
4640 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4641 /* If we return here, POSITION has been advanced
4642 across the text with this property. */
4647 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4649 if (CONSP (XCDR (XCDR (spec
))))
4651 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4652 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4658 /* Save current settings of IT so that we can restore them
4659 when we are finished with the glyph property value. */
4660 push_it (it
, position
);
4662 it
->area
= TEXT_AREA
;
4663 it
->what
= IT_IMAGE
;
4664 it
->image_id
= -1; /* no image */
4665 it
->position
= start_pos
;
4666 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4667 it
->method
= GET_FROM_IMAGE
;
4668 it
->from_overlay
= Qnil
;
4669 it
->face_id
= face_id
;
4670 it
->from_disp_prop_p
= 1;
4672 /* Say that we haven't consumed the characters with
4673 `display' property yet. The call to pop_it in
4674 set_iterator_to_next will clean this up. */
4675 *position
= start_pos
;
4677 if (EQ (XCAR (spec
), Qleft_fringe
))
4679 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4680 it
->left_user_fringe_face_id
= face_id
;
4684 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4685 it
->right_user_fringe_face_id
= face_id
;
4688 #endif /* HAVE_WINDOW_SYSTEM */
4692 /* Prepare to handle `((margin left-margin) ...)',
4693 `((margin right-margin) ...)' and `((margin nil) ...)'
4694 prefixes for display specifications. */
4695 location
= Qunbound
;
4696 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4700 value
= XCDR (spec
);
4702 value
= XCAR (value
);
4705 if (EQ (XCAR (tem
), Qmargin
)
4706 && (tem
= XCDR (tem
),
4707 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4709 || EQ (tem
, Qleft_margin
)
4710 || EQ (tem
, Qright_margin
))))
4714 if (EQ (location
, Qunbound
))
4720 /* After this point, VALUE is the property after any
4721 margin prefix has been stripped. It must be a string,
4722 an image specification, or `(space ...)'.
4724 LOCATION specifies where to display: `left-margin',
4725 `right-margin' or nil. */
4727 valid_p
= (STRINGP (value
)
4728 #ifdef HAVE_WINDOW_SYSTEM
4729 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4730 && valid_image_p (value
))
4731 #endif /* not HAVE_WINDOW_SYSTEM */
4732 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4734 if (valid_p
&& !display_replaced_p
)
4740 /* Callers need to know whether the display spec is any kind
4741 of `(space ...)' spec that is about to affect text-area
4743 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4748 /* Save current settings of IT so that we can restore them
4749 when we are finished with the glyph property value. */
4750 push_it (it
, position
);
4751 it
->from_overlay
= overlay
;
4752 it
->from_disp_prop_p
= 1;
4754 if (NILP (location
))
4755 it
->area
= TEXT_AREA
;
4756 else if (EQ (location
, Qleft_margin
))
4757 it
->area
= LEFT_MARGIN_AREA
;
4759 it
->area
= RIGHT_MARGIN_AREA
;
4761 if (STRINGP (value
))
4764 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4765 it
->current
.overlay_string_index
= -1;
4766 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4767 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4768 it
->method
= GET_FROM_STRING
;
4769 it
->stop_charpos
= 0;
4771 it
->base_level_stop
= 0;
4772 it
->string_from_display_prop_p
= 1;
4773 /* Say that we haven't consumed the characters with
4774 `display' property yet. The call to pop_it in
4775 set_iterator_to_next will clean this up. */
4776 if (BUFFERP (object
))
4777 *position
= start_pos
;
4779 /* Force paragraph direction to be that of the parent
4780 object. If the parent object's paragraph direction is
4781 not yet determined, default to L2R. */
4782 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4783 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4785 it
->paragraph_embedding
= L2R
;
4787 /* Set up the bidi iterator for this display string. */
4790 it
->bidi_it
.string
.lstring
= it
->string
;
4791 it
->bidi_it
.string
.s
= NULL
;
4792 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4793 it
->bidi_it
.string
.bufpos
= bufpos
;
4794 it
->bidi_it
.string
.from_disp_str
= 1;
4795 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4796 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4799 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4801 it
->method
= GET_FROM_STRETCH
;
4803 *position
= it
->position
= start_pos
;
4804 retval
= 1 + (it
->area
== TEXT_AREA
);
4806 #ifdef HAVE_WINDOW_SYSTEM
4809 it
->what
= IT_IMAGE
;
4810 it
->image_id
= lookup_image (it
->f
, value
);
4811 it
->position
= start_pos
;
4812 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4813 it
->method
= GET_FROM_IMAGE
;
4815 /* Say that we haven't consumed the characters with
4816 `display' property yet. The call to pop_it in
4817 set_iterator_to_next will clean this up. */
4818 *position
= start_pos
;
4820 #endif /* HAVE_WINDOW_SYSTEM */
4825 /* Invalid property or property not supported. Restore
4826 POSITION to what it was before. */
4827 *position
= start_pos
;
4831 /* Check if PROP is a display property value whose text should be
4832 treated as intangible. OVERLAY is the overlay from which PROP
4833 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4834 specify the buffer position covered by PROP. */
4837 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4838 ptrdiff_t charpos
, ptrdiff_t bytepos
)
4840 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4841 struct text_pos position
;
4843 SET_TEXT_POS (position
, charpos
, bytepos
);
4844 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4845 &position
, charpos
, frame_window_p
);
4849 /* Return 1 if PROP is a display sub-property value containing STRING.
4851 Implementation note: this and the following function are really
4852 special cases of handle_display_spec and
4853 handle_single_display_spec, and should ideally use the same code.
4854 Until they do, these two pairs must be consistent and must be
4855 modified in sync. */
4858 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4860 if (EQ (string
, prop
))
4863 /* Skip over `when FORM'. */
4864 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4869 /* Actually, the condition following `when' should be eval'ed,
4870 like handle_single_display_spec does, and we should return
4871 zero if it evaluates to nil. However, this function is
4872 called only when the buffer was already displayed and some
4873 glyph in the glyph matrix was found to come from a display
4874 string. Therefore, the condition was already evaluated, and
4875 the result was non-nil, otherwise the display string wouldn't
4876 have been displayed and we would have never been called for
4877 this property. Thus, we can skip the evaluation and assume
4878 its result is non-nil. */
4883 /* Skip over `margin LOCATION'. */
4884 if (EQ (XCAR (prop
), Qmargin
))
4895 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4899 /* Return 1 if STRING appears in the `display' property PROP. */
4902 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4905 && !EQ (XCAR (prop
), Qwhen
)
4906 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4908 /* A list of sub-properties. */
4909 while (CONSP (prop
))
4911 if (single_display_spec_string_p (XCAR (prop
), string
))
4916 else if (VECTORP (prop
))
4918 /* A vector of sub-properties. */
4920 for (i
= 0; i
< ASIZE (prop
); ++i
)
4921 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4925 return single_display_spec_string_p (prop
, string
);
4930 /* Look for STRING in overlays and text properties in the current
4931 buffer, between character positions FROM and TO (excluding TO).
4932 BACK_P non-zero means look back (in this case, TO is supposed to be
4934 Value is the first character position where STRING was found, or
4935 zero if it wasn't found before hitting TO.
4937 This function may only use code that doesn't eval because it is
4938 called asynchronously from note_mouse_highlight. */
4941 string_buffer_position_lim (Lisp_Object string
,
4942 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
4944 Lisp_Object limit
, prop
, pos
;
4947 pos
= make_number (from
);
4949 if (!back_p
) /* looking forward */
4951 limit
= make_number (min (to
, ZV
));
4952 while (!found
&& !EQ (pos
, limit
))
4954 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4955 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4958 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4962 else /* looking back */
4964 limit
= make_number (max (to
, BEGV
));
4965 while (!found
&& !EQ (pos
, limit
))
4967 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4968 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4971 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4976 return found
? XINT (pos
) : 0;
4979 /* Determine which buffer position in current buffer STRING comes from.
4980 AROUND_CHARPOS is an approximate position where it could come from.
4981 Value is the buffer position or 0 if it couldn't be determined.
4983 This function is necessary because we don't record buffer positions
4984 in glyphs generated from strings (to keep struct glyph small).
4985 This function may only use code that doesn't eval because it is
4986 called asynchronously from note_mouse_highlight. */
4989 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
4991 const int MAX_DISTANCE
= 1000;
4992 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
4993 around_charpos
+ MAX_DISTANCE
,
4997 found
= string_buffer_position_lim (string
, around_charpos
,
4998 around_charpos
- MAX_DISTANCE
, 1);
5004 /***********************************************************************
5005 `composition' property
5006 ***********************************************************************/
5008 /* Set up iterator IT from `composition' property at its current
5009 position. Called from handle_stop. */
5011 static enum prop_handled
5012 handle_composition_prop (struct it
*it
)
5014 Lisp_Object prop
, string
;
5015 ptrdiff_t pos
, pos_byte
, start
, end
;
5017 if (STRINGP (it
->string
))
5021 pos
= IT_STRING_CHARPOS (*it
);
5022 pos_byte
= IT_STRING_BYTEPOS (*it
);
5023 string
= it
->string
;
5024 s
= SDATA (string
) + pos_byte
;
5025 it
->c
= STRING_CHAR (s
);
5029 pos
= IT_CHARPOS (*it
);
5030 pos_byte
= IT_BYTEPOS (*it
);
5032 it
->c
= FETCH_CHAR (pos_byte
);
5035 /* If there's a valid composition and point is not inside of the
5036 composition (in the case that the composition is from the current
5037 buffer), draw a glyph composed from the composition components. */
5038 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5039 && COMPOSITION_VALID_P (start
, end
, prop
)
5040 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5043 /* As we can't handle this situation (perhaps font-lock added
5044 a new composition), we just return here hoping that next
5045 redisplay will detect this composition much earlier. */
5046 return HANDLED_NORMALLY
;
5049 if (STRINGP (it
->string
))
5050 pos_byte
= string_char_to_byte (it
->string
, start
);
5052 pos_byte
= CHAR_TO_BYTE (start
);
5054 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5057 if (it
->cmp_it
.id
>= 0)
5060 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5061 it
->cmp_it
.nglyphs
= -1;
5065 return HANDLED_NORMALLY
;
5070 /***********************************************************************
5072 ***********************************************************************/
5074 /* The following structure is used to record overlay strings for
5075 later sorting in load_overlay_strings. */
5077 struct overlay_entry
5079 Lisp_Object overlay
;
5086 /* Set up iterator IT from overlay strings at its current position.
5087 Called from handle_stop. */
5089 static enum prop_handled
5090 handle_overlay_change (struct it
*it
)
5092 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5093 return HANDLED_RECOMPUTE_PROPS
;
5095 return HANDLED_NORMALLY
;
5099 /* Set up the next overlay string for delivery by IT, if there is an
5100 overlay string to deliver. Called by set_iterator_to_next when the
5101 end of the current overlay string is reached. If there are more
5102 overlay strings to display, IT->string and
5103 IT->current.overlay_string_index are set appropriately here.
5104 Otherwise IT->string is set to nil. */
5107 next_overlay_string (struct it
*it
)
5109 ++it
->current
.overlay_string_index
;
5110 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5112 /* No more overlay strings. Restore IT's settings to what
5113 they were before overlay strings were processed, and
5114 continue to deliver from current_buffer. */
5116 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5119 || (NILP (it
->string
)
5120 && it
->method
== GET_FROM_BUFFER
5121 && it
->stop_charpos
>= BEGV
5122 && it
->stop_charpos
<= it
->end_charpos
));
5123 it
->current
.overlay_string_index
= -1;
5124 it
->n_overlay_strings
= 0;
5125 it
->overlay_strings_charpos
= -1;
5127 /* If we're at the end of the buffer, record that we have
5128 processed the overlay strings there already, so that
5129 next_element_from_buffer doesn't try it again. */
5130 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5131 it
->overlay_strings_at_end_processed_p
= 1;
5135 /* There are more overlay strings to process. If
5136 IT->current.overlay_string_index has advanced to a position
5137 where we must load IT->overlay_strings with more strings, do
5138 it. We must load at the IT->overlay_strings_charpos where
5139 IT->n_overlay_strings was originally computed; when invisible
5140 text is present, this might not be IT_CHARPOS (Bug#7016). */
5141 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5143 if (it
->current
.overlay_string_index
&& i
== 0)
5144 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5146 /* Initialize IT to deliver display elements from the overlay
5148 it
->string
= it
->overlay_strings
[i
];
5149 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5150 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5151 it
->method
= GET_FROM_STRING
;
5152 it
->stop_charpos
= 0;
5153 if (it
->cmp_it
.stop_pos
>= 0)
5154 it
->cmp_it
.stop_pos
= 0;
5156 it
->base_level_stop
= 0;
5158 /* Set up the bidi iterator for this overlay string. */
5161 it
->bidi_it
.string
.lstring
= it
->string
;
5162 it
->bidi_it
.string
.s
= NULL
;
5163 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5164 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5165 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5166 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5167 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5175 /* Compare two overlay_entry structures E1 and E2. Used as a
5176 comparison function for qsort in load_overlay_strings. Overlay
5177 strings for the same position are sorted so that
5179 1. All after-strings come in front of before-strings, except
5180 when they come from the same overlay.
5182 2. Within after-strings, strings are sorted so that overlay strings
5183 from overlays with higher priorities come first.
5185 2. Within before-strings, strings are sorted so that overlay
5186 strings from overlays with higher priorities come last.
5188 Value is analogous to strcmp. */
5192 compare_overlay_entries (const void *e1
, const void *e2
)
5194 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5195 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5198 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5200 /* Let after-strings appear in front of before-strings if
5201 they come from different overlays. */
5202 if (EQ (entry1
->overlay
, entry2
->overlay
))
5203 result
= entry1
->after_string_p
? 1 : -1;
5205 result
= entry1
->after_string_p
? -1 : 1;
5207 else if (entry1
->priority
!= entry2
->priority
)
5209 if (entry1
->after_string_p
)
5210 /* After-strings sorted in order of decreasing priority. */
5211 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5213 /* Before-strings sorted in order of increasing priority. */
5214 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5223 /* Load the vector IT->overlay_strings with overlay strings from IT's
5224 current buffer position, or from CHARPOS if that is > 0. Set
5225 IT->n_overlays to the total number of overlay strings found.
5227 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5228 a time. On entry into load_overlay_strings,
5229 IT->current.overlay_string_index gives the number of overlay
5230 strings that have already been loaded by previous calls to this
5233 IT->add_overlay_start contains an additional overlay start
5234 position to consider for taking overlay strings from, if non-zero.
5235 This position comes into play when the overlay has an `invisible'
5236 property, and both before and after-strings. When we've skipped to
5237 the end of the overlay, because of its `invisible' property, we
5238 nevertheless want its before-string to appear.
5239 IT->add_overlay_start will contain the overlay start position
5242 Overlay strings are sorted so that after-string strings come in
5243 front of before-string strings. Within before and after-strings,
5244 strings are sorted by overlay priority. See also function
5245 compare_overlay_entries. */
5248 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5250 Lisp_Object overlay
, window
, str
, invisible
;
5251 struct Lisp_Overlay
*ov
;
5252 ptrdiff_t start
, end
;
5253 ptrdiff_t size
= 20;
5254 ptrdiff_t n
= 0, i
, j
;
5256 struct overlay_entry
*entries
5257 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5261 charpos
= IT_CHARPOS (*it
);
5263 /* Append the overlay string STRING of overlay OVERLAY to vector
5264 `entries' which has size `size' and currently contains `n'
5265 elements. AFTER_P non-zero means STRING is an after-string of
5267 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5270 Lisp_Object priority; \
5274 struct overlay_entry *old = entries; \
5275 SAFE_NALLOCA (entries, 2, size); \
5276 memcpy (entries, old, size * sizeof *entries); \
5280 entries[n].string = (STRING); \
5281 entries[n].overlay = (OVERLAY); \
5282 priority = Foverlay_get ((OVERLAY), Qpriority); \
5283 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5284 entries[n].after_string_p = (AFTER_P); \
5289 /* Process overlay before the overlay center. */
5290 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5292 XSETMISC (overlay
, ov
);
5293 xassert (OVERLAYP (overlay
));
5294 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5295 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5300 /* Skip this overlay if it doesn't start or end at IT's current
5302 if (end
!= charpos
&& start
!= charpos
)
5305 /* Skip this overlay if it doesn't apply to IT->w. */
5306 window
= Foverlay_get (overlay
, Qwindow
);
5307 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5310 /* If the text ``under'' the overlay is invisible, both before-
5311 and after-strings from this overlay are visible; start and
5312 end position are indistinguishable. */
5313 invisible
= Foverlay_get (overlay
, Qinvisible
);
5314 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5316 /* If overlay has a non-empty before-string, record it. */
5317 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5318 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5320 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5322 /* If overlay has a non-empty after-string, record it. */
5323 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5324 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5326 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5329 /* Process overlays after the overlay center. */
5330 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5332 XSETMISC (overlay
, ov
);
5333 xassert (OVERLAYP (overlay
));
5334 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5335 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5337 if (start
> charpos
)
5340 /* Skip this overlay if it doesn't start or end at IT's current
5342 if (end
!= charpos
&& start
!= charpos
)
5345 /* Skip this overlay if it doesn't apply to IT->w. */
5346 window
= Foverlay_get (overlay
, Qwindow
);
5347 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5350 /* If the text ``under'' the overlay is invisible, it has a zero
5351 dimension, and both before- and after-strings apply. */
5352 invisible
= Foverlay_get (overlay
, Qinvisible
);
5353 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5355 /* If overlay has a non-empty before-string, record it. */
5356 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5357 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5359 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5361 /* If overlay has a non-empty after-string, record it. */
5362 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5363 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5365 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5368 #undef RECORD_OVERLAY_STRING
5372 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5374 /* Record number of overlay strings, and where we computed it. */
5375 it
->n_overlay_strings
= n
;
5376 it
->overlay_strings_charpos
= charpos
;
5378 /* IT->current.overlay_string_index is the number of overlay strings
5379 that have already been consumed by IT. Copy some of the
5380 remaining overlay strings to IT->overlay_strings. */
5382 j
= it
->current
.overlay_string_index
;
5383 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5385 it
->overlay_strings
[i
] = entries
[j
].string
;
5386 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5394 /* Get the first chunk of overlay strings at IT's current buffer
5395 position, or at CHARPOS if that is > 0. Value is non-zero if at
5396 least one overlay string was found. */
5399 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5401 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5402 process. This fills IT->overlay_strings with strings, and sets
5403 IT->n_overlay_strings to the total number of strings to process.
5404 IT->pos.overlay_string_index has to be set temporarily to zero
5405 because load_overlay_strings needs this; it must be set to -1
5406 when no overlay strings are found because a zero value would
5407 indicate a position in the first overlay string. */
5408 it
->current
.overlay_string_index
= 0;
5409 load_overlay_strings (it
, charpos
);
5411 /* If we found overlay strings, set up IT to deliver display
5412 elements from the first one. Otherwise set up IT to deliver
5413 from current_buffer. */
5414 if (it
->n_overlay_strings
)
5416 /* Make sure we know settings in current_buffer, so that we can
5417 restore meaningful values when we're done with the overlay
5420 compute_stop_pos (it
);
5421 xassert (it
->face_id
>= 0);
5423 /* Save IT's settings. They are restored after all overlay
5424 strings have been processed. */
5425 xassert (!compute_stop_p
|| it
->sp
== 0);
5427 /* When called from handle_stop, there might be an empty display
5428 string loaded. In that case, don't bother saving it. */
5429 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5432 /* Set up IT to deliver display elements from the first overlay
5434 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5435 it
->string
= it
->overlay_strings
[0];
5436 it
->from_overlay
= Qnil
;
5437 it
->stop_charpos
= 0;
5438 xassert (STRINGP (it
->string
));
5439 it
->end_charpos
= SCHARS (it
->string
);
5441 it
->base_level_stop
= 0;
5442 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5443 it
->method
= GET_FROM_STRING
;
5444 it
->from_disp_prop_p
= 0;
5446 /* Force paragraph direction to be that of the parent
5448 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5449 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5451 it
->paragraph_embedding
= L2R
;
5453 /* Set up the bidi iterator for this overlay string. */
5456 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5458 it
->bidi_it
.string
.lstring
= it
->string
;
5459 it
->bidi_it
.string
.s
= NULL
;
5460 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5461 it
->bidi_it
.string
.bufpos
= pos
;
5462 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5463 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5464 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5469 it
->current
.overlay_string_index
= -1;
5474 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5477 it
->method
= GET_FROM_BUFFER
;
5479 (void) get_overlay_strings_1 (it
, charpos
, 1);
5483 /* Value is non-zero if we found at least one overlay string. */
5484 return STRINGP (it
->string
);
5489 /***********************************************************************
5490 Saving and restoring state
5491 ***********************************************************************/
5493 /* Save current settings of IT on IT->stack. Called, for example,
5494 before setting up IT for an overlay string, to be able to restore
5495 IT's settings to what they were after the overlay string has been
5496 processed. If POSITION is non-NULL, it is the position to save on
5497 the stack instead of IT->position. */
5500 push_it (struct it
*it
, struct text_pos
*position
)
5502 struct iterator_stack_entry
*p
;
5504 xassert (it
->sp
< IT_STACK_SIZE
);
5505 p
= it
->stack
+ it
->sp
;
5507 p
->stop_charpos
= it
->stop_charpos
;
5508 p
->prev_stop
= it
->prev_stop
;
5509 p
->base_level_stop
= it
->base_level_stop
;
5510 p
->cmp_it
= it
->cmp_it
;
5511 xassert (it
->face_id
>= 0);
5512 p
->face_id
= it
->face_id
;
5513 p
->string
= it
->string
;
5514 p
->method
= it
->method
;
5515 p
->from_overlay
= it
->from_overlay
;
5518 case GET_FROM_IMAGE
:
5519 p
->u
.image
.object
= it
->object
;
5520 p
->u
.image
.image_id
= it
->image_id
;
5521 p
->u
.image
.slice
= it
->slice
;
5523 case GET_FROM_STRETCH
:
5524 p
->u
.stretch
.object
= it
->object
;
5527 p
->position
= position
? *position
: it
->position
;
5528 p
->current
= it
->current
;
5529 p
->end_charpos
= it
->end_charpos
;
5530 p
->string_nchars
= it
->string_nchars
;
5532 p
->multibyte_p
= it
->multibyte_p
;
5533 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5534 p
->space_width
= it
->space_width
;
5535 p
->font_height
= it
->font_height
;
5536 p
->voffset
= it
->voffset
;
5537 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5538 p
->display_ellipsis_p
= 0;
5539 p
->line_wrap
= it
->line_wrap
;
5540 p
->bidi_p
= it
->bidi_p
;
5541 p
->paragraph_embedding
= it
->paragraph_embedding
;
5542 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5545 /* Save the state of the bidi iterator as well. */
5547 bidi_push_it (&it
->bidi_it
);
5551 iterate_out_of_display_property (struct it
*it
)
5553 int buffer_p
= BUFFERP (it
->object
);
5554 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5555 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5557 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5559 /* Maybe initialize paragraph direction. If we are at the beginning
5560 of a new paragraph, next_element_from_buffer may not have a
5561 chance to do that. */
5562 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5563 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5564 /* prev_stop can be zero, so check against BEGV as well. */
5565 while (it
->bidi_it
.charpos
>= bob
5566 && it
->prev_stop
<= it
->bidi_it
.charpos
5567 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5568 && it
->bidi_it
.charpos
< eob
)
5569 bidi_move_to_visually_next (&it
->bidi_it
);
5570 /* Record the stop_pos we just crossed, for when we cross it
5572 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5573 it
->prev_stop
= CHARPOS (it
->position
);
5574 /* If we ended up not where pop_it put us, resync IT's
5575 positional members with the bidi iterator. */
5576 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5577 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5579 it
->current
.pos
= it
->position
;
5581 it
->current
.string_pos
= it
->position
;
5584 /* Restore IT's settings from IT->stack. Called, for example, when no
5585 more overlay strings must be processed, and we return to delivering
5586 display elements from a buffer, or when the end of a string from a
5587 `display' property is reached and we return to delivering display
5588 elements from an overlay string, or from a buffer. */
5591 pop_it (struct it
*it
)
5593 struct iterator_stack_entry
*p
;
5594 int from_display_prop
= it
->from_disp_prop_p
;
5596 xassert (it
->sp
> 0);
5598 p
= it
->stack
+ it
->sp
;
5599 it
->stop_charpos
= p
->stop_charpos
;
5600 it
->prev_stop
= p
->prev_stop
;
5601 it
->base_level_stop
= p
->base_level_stop
;
5602 it
->cmp_it
= p
->cmp_it
;
5603 it
->face_id
= p
->face_id
;
5604 it
->current
= p
->current
;
5605 it
->position
= p
->position
;
5606 it
->string
= p
->string
;
5607 it
->from_overlay
= p
->from_overlay
;
5608 if (NILP (it
->string
))
5609 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5610 it
->method
= p
->method
;
5613 case GET_FROM_IMAGE
:
5614 it
->image_id
= p
->u
.image
.image_id
;
5615 it
->object
= p
->u
.image
.object
;
5616 it
->slice
= p
->u
.image
.slice
;
5618 case GET_FROM_STRETCH
:
5619 it
->object
= p
->u
.stretch
.object
;
5621 case GET_FROM_BUFFER
:
5622 it
->object
= it
->w
->buffer
;
5624 case GET_FROM_STRING
:
5625 it
->object
= it
->string
;
5627 case GET_FROM_DISPLAY_VECTOR
:
5629 it
->method
= GET_FROM_C_STRING
;
5630 else if (STRINGP (it
->string
))
5631 it
->method
= GET_FROM_STRING
;
5634 it
->method
= GET_FROM_BUFFER
;
5635 it
->object
= it
->w
->buffer
;
5638 it
->end_charpos
= p
->end_charpos
;
5639 it
->string_nchars
= p
->string_nchars
;
5641 it
->multibyte_p
= p
->multibyte_p
;
5642 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5643 it
->space_width
= p
->space_width
;
5644 it
->font_height
= p
->font_height
;
5645 it
->voffset
= p
->voffset
;
5646 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5647 it
->line_wrap
= p
->line_wrap
;
5648 it
->bidi_p
= p
->bidi_p
;
5649 it
->paragraph_embedding
= p
->paragraph_embedding
;
5650 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5653 bidi_pop_it (&it
->bidi_it
);
5654 /* Bidi-iterate until we get out of the portion of text, if any,
5655 covered by a `display' text property or by an overlay with
5656 `display' property. (We cannot just jump there, because the
5657 internal coherency of the bidi iterator state can not be
5658 preserved across such jumps.) We also must determine the
5659 paragraph base direction if the overlay we just processed is
5660 at the beginning of a new paragraph. */
5661 if (from_display_prop
5662 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5663 iterate_out_of_display_property (it
);
5665 xassert ((BUFFERP (it
->object
)
5666 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5667 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5668 || (STRINGP (it
->object
)
5669 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5670 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5671 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5677 /***********************************************************************
5679 ***********************************************************************/
5681 /* Set IT's current position to the previous line start. */
5684 back_to_previous_line_start (struct it
*it
)
5686 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5687 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5691 /* Move IT to the next line start.
5693 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5694 we skipped over part of the text (as opposed to moving the iterator
5695 continuously over the text). Otherwise, don't change the value
5698 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5699 iterator on the newline, if it was found.
5701 Newlines may come from buffer text, overlay strings, or strings
5702 displayed via the `display' property. That's the reason we can't
5703 simply use find_next_newline_no_quit.
5705 Note that this function may not skip over invisible text that is so
5706 because of text properties and immediately follows a newline. If
5707 it would, function reseat_at_next_visible_line_start, when called
5708 from set_iterator_to_next, would effectively make invisible
5709 characters following a newline part of the wrong glyph row, which
5710 leads to wrong cursor motion. */
5713 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5714 struct bidi_it
*bidi_it_prev
)
5716 ptrdiff_t old_selective
;
5717 int newline_found_p
, n
;
5718 const int MAX_NEWLINE_DISTANCE
= 500;
5720 /* If already on a newline, just consume it to avoid unintended
5721 skipping over invisible text below. */
5722 if (it
->what
== IT_CHARACTER
5724 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5726 if (it
->bidi_p
&& bidi_it_prev
)
5727 *bidi_it_prev
= it
->bidi_it
;
5728 set_iterator_to_next (it
, 0);
5733 /* Don't handle selective display in the following. It's (a)
5734 unnecessary because it's done by the caller, and (b) leads to an
5735 infinite recursion because next_element_from_ellipsis indirectly
5736 calls this function. */
5737 old_selective
= it
->selective
;
5740 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5741 from buffer text. */
5742 for (n
= newline_found_p
= 0;
5743 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5744 n
+= STRINGP (it
->string
) ? 0 : 1)
5746 if (!get_next_display_element (it
))
5748 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5749 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5750 *bidi_it_prev
= it
->bidi_it
;
5751 set_iterator_to_next (it
, 0);
5754 /* If we didn't find a newline near enough, see if we can use a
5756 if (!newline_found_p
)
5758 ptrdiff_t start
= IT_CHARPOS (*it
);
5759 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5762 xassert (!STRINGP (it
->string
));
5764 /* If there isn't any `display' property in sight, and no
5765 overlays, we can just use the position of the newline in
5767 if (it
->stop_charpos
>= limit
5768 || ((pos
= Fnext_single_property_change (make_number (start
),
5770 make_number (limit
)),
5772 && next_overlay_change (start
) == ZV
))
5776 IT_CHARPOS (*it
) = limit
;
5777 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5781 struct bidi_it bprev
;
5783 /* Help bidi.c avoid expensive searches for display
5784 properties and overlays, by telling it that there are
5785 none up to `limit'. */
5786 if (it
->bidi_it
.disp_pos
< limit
)
5788 it
->bidi_it
.disp_pos
= limit
;
5789 it
->bidi_it
.disp_prop
= 0;
5792 bprev
= it
->bidi_it
;
5793 bidi_move_to_visually_next (&it
->bidi_it
);
5794 } while (it
->bidi_it
.charpos
!= limit
);
5795 IT_CHARPOS (*it
) = limit
;
5796 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5798 *bidi_it_prev
= bprev
;
5800 *skipped_p
= newline_found_p
= 1;
5804 while (get_next_display_element (it
)
5805 && !newline_found_p
)
5807 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5808 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5809 *bidi_it_prev
= it
->bidi_it
;
5810 set_iterator_to_next (it
, 0);
5815 it
->selective
= old_selective
;
5816 return newline_found_p
;
5820 /* Set IT's current position to the previous visible line start. Skip
5821 invisible text that is so either due to text properties or due to
5822 selective display. Caution: this does not change IT->current_x and
5826 back_to_previous_visible_line_start (struct it
*it
)
5828 while (IT_CHARPOS (*it
) > BEGV
)
5830 back_to_previous_line_start (it
);
5832 if (IT_CHARPOS (*it
) <= BEGV
)
5835 /* If selective > 0, then lines indented more than its value are
5837 if (it
->selective
> 0
5838 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5842 /* Check the newline before point for invisibility. */
5845 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5846 Qinvisible
, it
->window
);
5847 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5851 if (IT_CHARPOS (*it
) <= BEGV
)
5856 void *it2data
= NULL
;
5859 Lisp_Object val
, overlay
;
5861 SAVE_IT (it2
, *it
, it2data
);
5863 /* If newline is part of a composition, continue from start of composition */
5864 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5865 && beg
< IT_CHARPOS (*it
))
5868 /* If newline is replaced by a display property, find start of overlay
5869 or interval and continue search from that point. */
5870 pos
= --IT_CHARPOS (it2
);
5873 bidi_unshelve_cache (NULL
, 0);
5874 it2
.string_from_display_prop_p
= 0;
5875 it2
.from_disp_prop_p
= 0;
5876 if (handle_display_prop (&it2
) == HANDLED_RETURN
5877 && !NILP (val
= get_char_property_and_overlay
5878 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5879 && (OVERLAYP (overlay
)
5880 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5881 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5883 RESTORE_IT (it
, it
, it2data
);
5887 /* Newline is not replaced by anything -- so we are done. */
5888 RESTORE_IT (it
, it
, it2data
);
5894 IT_CHARPOS (*it
) = beg
;
5895 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5899 it
->continuation_lines_width
= 0;
5901 xassert (IT_CHARPOS (*it
) >= BEGV
);
5902 xassert (IT_CHARPOS (*it
) == BEGV
5903 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5908 /* Reseat iterator IT at the previous visible line start. Skip
5909 invisible text that is so either due to text properties or due to
5910 selective display. At the end, update IT's overlay information,
5911 face information etc. */
5914 reseat_at_previous_visible_line_start (struct it
*it
)
5916 back_to_previous_visible_line_start (it
);
5917 reseat (it
, it
->current
.pos
, 1);
5922 /* Reseat iterator IT on the next visible line start in the current
5923 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5924 preceding the line start. Skip over invisible text that is so
5925 because of selective display. Compute faces, overlays etc at the
5926 new position. Note that this function does not skip over text that
5927 is invisible because of text properties. */
5930 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5932 int newline_found_p
, skipped_p
= 0;
5933 struct bidi_it bidi_it_prev
;
5935 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5937 /* Skip over lines that are invisible because they are indented
5938 more than the value of IT->selective. */
5939 if (it
->selective
> 0)
5940 while (IT_CHARPOS (*it
) < ZV
5941 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5944 xassert (IT_BYTEPOS (*it
) == BEGV
5945 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5947 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5950 /* Position on the newline if that's what's requested. */
5951 if (on_newline_p
&& newline_found_p
)
5953 if (STRINGP (it
->string
))
5955 if (IT_STRING_CHARPOS (*it
) > 0)
5959 --IT_STRING_CHARPOS (*it
);
5960 --IT_STRING_BYTEPOS (*it
);
5964 /* We need to restore the bidi iterator to the state
5965 it had on the newline, and resync the IT's
5966 position with that. */
5967 it
->bidi_it
= bidi_it_prev
;
5968 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5969 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5973 else if (IT_CHARPOS (*it
) > BEGV
)
5982 /* We need to restore the bidi iterator to the state it
5983 had on the newline and resync IT with that. */
5984 it
->bidi_it
= bidi_it_prev
;
5985 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5986 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5988 reseat (it
, it
->current
.pos
, 0);
5992 reseat (it
, it
->current
.pos
, 0);
5999 /***********************************************************************
6000 Changing an iterator's position
6001 ***********************************************************************/
6003 /* Change IT's current position to POS in current_buffer. If FORCE_P
6004 is non-zero, always check for text properties at the new position.
6005 Otherwise, text properties are only looked up if POS >=
6006 IT->check_charpos of a property. */
6009 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6011 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6013 reseat_1 (it
, pos
, 0);
6015 /* Determine where to check text properties. Avoid doing it
6016 where possible because text property lookup is very expensive. */
6018 || CHARPOS (pos
) > it
->stop_charpos
6019 || CHARPOS (pos
) < original_pos
)
6023 /* For bidi iteration, we need to prime prev_stop and
6024 base_level_stop with our best estimations. */
6025 /* Implementation note: Of course, POS is not necessarily a
6026 stop position, so assigning prev_pos to it is a lie; we
6027 should have called compute_stop_backwards. However, if
6028 the current buffer does not include any R2L characters,
6029 that call would be a waste of cycles, because the
6030 iterator will never move back, and thus never cross this
6031 "fake" stop position. So we delay that backward search
6032 until the time we really need it, in next_element_from_buffer. */
6033 if (CHARPOS (pos
) != it
->prev_stop
)
6034 it
->prev_stop
= CHARPOS (pos
);
6035 if (CHARPOS (pos
) < it
->base_level_stop
)
6036 it
->base_level_stop
= 0; /* meaning it's unknown */
6042 it
->prev_stop
= it
->base_level_stop
= 0;
6051 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6052 IT->stop_pos to POS, also. */
6055 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6057 /* Don't call this function when scanning a C string. */
6058 xassert (it
->s
== NULL
);
6060 /* POS must be a reasonable value. */
6061 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6063 it
->current
.pos
= it
->position
= pos
;
6064 it
->end_charpos
= ZV
;
6066 it
->current
.dpvec_index
= -1;
6067 it
->current
.overlay_string_index
= -1;
6068 IT_STRING_CHARPOS (*it
) = -1;
6069 IT_STRING_BYTEPOS (*it
) = -1;
6071 it
->method
= GET_FROM_BUFFER
;
6072 it
->object
= it
->w
->buffer
;
6073 it
->area
= TEXT_AREA
;
6074 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6076 it
->string_from_display_prop_p
= 0;
6077 it
->from_disp_prop_p
= 0;
6078 it
->face_before_selective_p
= 0;
6081 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6083 bidi_unshelve_cache (NULL
, 0);
6084 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6085 it
->bidi_it
.string
.s
= NULL
;
6086 it
->bidi_it
.string
.lstring
= Qnil
;
6087 it
->bidi_it
.string
.bufpos
= 0;
6088 it
->bidi_it
.string
.unibyte
= 0;
6093 it
->stop_charpos
= CHARPOS (pos
);
6094 it
->base_level_stop
= CHARPOS (pos
);
6099 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6100 If S is non-null, it is a C string to iterate over. Otherwise,
6101 STRING gives a Lisp string to iterate over.
6103 If PRECISION > 0, don't return more then PRECISION number of
6104 characters from the string.
6106 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6107 characters have been returned. FIELD_WIDTH < 0 means an infinite
6110 MULTIBYTE = 0 means disable processing of multibyte characters,
6111 MULTIBYTE > 0 means enable it,
6112 MULTIBYTE < 0 means use IT->multibyte_p.
6114 IT must be initialized via a prior call to init_iterator before
6115 calling this function. */
6118 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6119 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6122 /* No region in strings. */
6123 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6125 /* No text property checks performed by default, but see below. */
6126 it
->stop_charpos
= -1;
6128 /* Set iterator position and end position. */
6129 memset (&it
->current
, 0, sizeof it
->current
);
6130 it
->current
.overlay_string_index
= -1;
6131 it
->current
.dpvec_index
= -1;
6132 xassert (charpos
>= 0);
6134 /* If STRING is specified, use its multibyteness, otherwise use the
6135 setting of MULTIBYTE, if specified. */
6137 it
->multibyte_p
= multibyte
> 0;
6139 /* Bidirectional reordering of strings is controlled by the default
6140 value of bidi-display-reordering. */
6141 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6145 xassert (STRINGP (string
));
6146 it
->string
= string
;
6148 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6149 it
->method
= GET_FROM_STRING
;
6150 it
->current
.string_pos
= string_pos (charpos
, string
);
6154 it
->bidi_it
.string
.lstring
= string
;
6155 it
->bidi_it
.string
.s
= NULL
;
6156 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6157 it
->bidi_it
.string
.bufpos
= 0;
6158 it
->bidi_it
.string
.from_disp_str
= 0;
6159 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6160 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6161 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6166 it
->s
= (const unsigned char *) s
;
6169 /* Note that we use IT->current.pos, not it->current.string_pos,
6170 for displaying C strings. */
6171 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6172 if (it
->multibyte_p
)
6174 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6175 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6179 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6180 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6185 it
->bidi_it
.string
.lstring
= Qnil
;
6186 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6187 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6188 it
->bidi_it
.string
.bufpos
= 0;
6189 it
->bidi_it
.string
.from_disp_str
= 0;
6190 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6191 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6194 it
->method
= GET_FROM_C_STRING
;
6197 /* PRECISION > 0 means don't return more than PRECISION characters
6199 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6201 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6203 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6206 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6207 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6208 FIELD_WIDTH < 0 means infinite field width. This is useful for
6209 padding with `-' at the end of a mode line. */
6210 if (field_width
< 0)
6211 field_width
= INFINITY
;
6212 /* Implementation note: We deliberately don't enlarge
6213 it->bidi_it.string.schars here to fit it->end_charpos, because
6214 the bidi iterator cannot produce characters out of thin air. */
6215 if (field_width
> it
->end_charpos
- charpos
)
6216 it
->end_charpos
= charpos
+ field_width
;
6218 /* Use the standard display table for displaying strings. */
6219 if (DISP_TABLE_P (Vstandard_display_table
))
6220 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6222 it
->stop_charpos
= charpos
;
6223 it
->prev_stop
= charpos
;
6224 it
->base_level_stop
= 0;
6227 it
->bidi_it
.first_elt
= 1;
6228 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6229 it
->bidi_it
.disp_pos
= -1;
6231 if (s
== NULL
&& it
->multibyte_p
)
6233 ptrdiff_t endpos
= SCHARS (it
->string
);
6234 if (endpos
> it
->end_charpos
)
6235 endpos
= it
->end_charpos
;
6236 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6244 /***********************************************************************
6246 ***********************************************************************/
6248 /* Map enum it_method value to corresponding next_element_from_* function. */
6250 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6252 next_element_from_buffer
,
6253 next_element_from_display_vector
,
6254 next_element_from_string
,
6255 next_element_from_c_string
,
6256 next_element_from_image
,
6257 next_element_from_stretch
6260 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6263 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6264 (possibly with the following characters). */
6266 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6267 ((IT)->cmp_it.id >= 0 \
6268 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6269 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6270 END_CHARPOS, (IT)->w, \
6271 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6275 /* Lookup the char-table Vglyphless_char_display for character C (-1
6276 if we want information for no-font case), and return the display
6277 method symbol. By side-effect, update it->what and
6278 it->glyphless_method. This function is called from
6279 get_next_display_element for each character element, and from
6280 x_produce_glyphs when no suitable font was found. */
6283 lookup_glyphless_char_display (int c
, struct it
*it
)
6285 Lisp_Object glyphless_method
= Qnil
;
6287 if (CHAR_TABLE_P (Vglyphless_char_display
)
6288 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6292 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6293 if (CONSP (glyphless_method
))
6294 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6295 ? XCAR (glyphless_method
)
6296 : XCDR (glyphless_method
);
6299 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6303 if (NILP (glyphless_method
))
6306 /* The default is to display the character by a proper font. */
6308 /* The default for the no-font case is to display an empty box. */
6309 glyphless_method
= Qempty_box
;
6311 if (EQ (glyphless_method
, Qzero_width
))
6314 return glyphless_method
;
6315 /* This method can't be used for the no-font case. */
6316 glyphless_method
= Qempty_box
;
6318 if (EQ (glyphless_method
, Qthin_space
))
6319 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6320 else if (EQ (glyphless_method
, Qempty_box
))
6321 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6322 else if (EQ (glyphless_method
, Qhex_code
))
6323 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6324 else if (STRINGP (glyphless_method
))
6325 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6328 /* Invalid value. We use the default method. */
6329 glyphless_method
= Qnil
;
6332 it
->what
= IT_GLYPHLESS
;
6333 return glyphless_method
;
6336 /* Load IT's display element fields with information about the next
6337 display element from the current position of IT. Value is zero if
6338 end of buffer (or C string) is reached. */
6340 static struct frame
*last_escape_glyph_frame
= NULL
;
6341 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6342 static int last_escape_glyph_merged_face_id
= 0;
6344 struct frame
*last_glyphless_glyph_frame
= NULL
;
6345 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6346 int last_glyphless_glyph_merged_face_id
= 0;
6349 get_next_display_element (struct it
*it
)
6351 /* Non-zero means that we found a display element. Zero means that
6352 we hit the end of what we iterate over. Performance note: the
6353 function pointer `method' used here turns out to be faster than
6354 using a sequence of if-statements. */
6358 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6360 if (it
->what
== IT_CHARACTER
)
6362 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6363 and only if (a) the resolved directionality of that character
6365 /* FIXME: Do we need an exception for characters from display
6367 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6368 it
->c
= bidi_mirror_char (it
->c
);
6369 /* Map via display table or translate control characters.
6370 IT->c, IT->len etc. have been set to the next character by
6371 the function call above. If we have a display table, and it
6372 contains an entry for IT->c, translate it. Don't do this if
6373 IT->c itself comes from a display table, otherwise we could
6374 end up in an infinite recursion. (An alternative could be to
6375 count the recursion depth of this function and signal an
6376 error when a certain maximum depth is reached.) Is it worth
6378 if (success_p
&& it
->dpvec
== NULL
)
6381 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6382 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6383 nbsp_or_shy
= char_is_other
;
6384 int c
= it
->c
; /* This is the character to display. */
6386 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6388 xassert (SINGLE_BYTE_CHAR_P (c
));
6389 if (unibyte_display_via_language_environment
)
6391 c
= DECODE_CHAR (unibyte
, c
);
6393 c
= BYTE8_TO_CHAR (it
->c
);
6396 c
= BYTE8_TO_CHAR (it
->c
);
6400 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6403 struct Lisp_Vector
*v
= XVECTOR (dv
);
6405 /* Return the first character from the display table
6406 entry, if not empty. If empty, don't display the
6407 current character. */
6410 it
->dpvec_char_len
= it
->len
;
6411 it
->dpvec
= v
->contents
;
6412 it
->dpend
= v
->contents
+ v
->header
.size
;
6413 it
->current
.dpvec_index
= 0;
6414 it
->dpvec_face_id
= -1;
6415 it
->saved_face_id
= it
->face_id
;
6416 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6421 set_iterator_to_next (it
, 0);
6426 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6428 if (it
->what
== IT_GLYPHLESS
)
6430 /* Don't display this character. */
6431 set_iterator_to_next (it
, 0);
6435 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6436 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6437 : c
== 0xAD ? char_is_soft_hyphen
6440 /* Translate control characters into `\003' or `^C' form.
6441 Control characters coming from a display table entry are
6442 currently not translated because we use IT->dpvec to hold
6443 the translation. This could easily be changed but I
6444 don't believe that it is worth doing.
6446 NBSP and SOFT-HYPEN are property translated too.
6448 Non-printable characters and raw-byte characters are also
6449 translated to octal form. */
6450 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6451 ? (it
->area
!= TEXT_AREA
6452 /* In mode line, treat \n, \t like other crl chars. */
6455 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6456 || (c
!= '\n' && c
!= '\t'))
6459 || ! CHAR_PRINTABLE_P (c
))))
6461 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6462 or a non-printable character which must be displayed
6463 either as '\003' or as `^C' where the '\\' and '^'
6464 can be defined in the display table. Fill
6465 IT->ctl_chars with glyphs for what we have to
6466 display. Then, set IT->dpvec to these glyphs. */
6473 /* Handle control characters with ^. */
6475 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6479 g
= '^'; /* default glyph for Control */
6480 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6482 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6484 g
= GLYPH_CODE_CHAR (gc
);
6485 lface_id
= GLYPH_CODE_FACE (gc
);
6489 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6491 else if (it
->f
== last_escape_glyph_frame
6492 && it
->face_id
== last_escape_glyph_face_id
)
6494 face_id
= last_escape_glyph_merged_face_id
;
6498 /* Merge the escape-glyph face into the current face. */
6499 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6501 last_escape_glyph_frame
= it
->f
;
6502 last_escape_glyph_face_id
= it
->face_id
;
6503 last_escape_glyph_merged_face_id
= face_id
;
6506 XSETINT (it
->ctl_chars
[0], g
);
6507 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6509 goto display_control
;
6512 /* Handle non-break space in the mode where it only gets
6515 if (EQ (Vnobreak_char_display
, Qt
)
6516 && nbsp_or_shy
== char_is_nbsp
)
6518 /* Merge the no-break-space face into the current face. */
6519 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6523 XSETINT (it
->ctl_chars
[0], ' ');
6525 goto display_control
;
6528 /* Handle sequences that start with the "escape glyph". */
6530 /* the default escape glyph is \. */
6531 escape_glyph
= '\\';
6534 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6536 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6537 lface_id
= GLYPH_CODE_FACE (gc
);
6541 /* The display table specified a face.
6542 Merge it into face_id and also into escape_glyph. */
6543 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6546 else if (it
->f
== last_escape_glyph_frame
6547 && it
->face_id
== last_escape_glyph_face_id
)
6549 face_id
= last_escape_glyph_merged_face_id
;
6553 /* Merge the escape-glyph face into the current face. */
6554 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6556 last_escape_glyph_frame
= it
->f
;
6557 last_escape_glyph_face_id
= it
->face_id
;
6558 last_escape_glyph_merged_face_id
= face_id
;
6561 /* Handle soft hyphens in the mode where they only get
6564 if (EQ (Vnobreak_char_display
, Qt
)
6565 && nbsp_or_shy
== char_is_soft_hyphen
)
6567 XSETINT (it
->ctl_chars
[0], '-');
6569 goto display_control
;
6572 /* Handle non-break space and soft hyphen
6573 with the escape glyph. */
6577 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6578 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6579 XSETINT (it
->ctl_chars
[1], c
);
6581 goto display_control
;
6588 if (CHAR_BYTE8_P (c
))
6589 /* Display \200 instead of \17777600. */
6590 c
= CHAR_TO_BYTE8 (c
);
6591 len
= sprintf (str
, "%03o", c
);
6593 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6594 for (i
= 0; i
< len
; i
++)
6595 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6600 /* Set up IT->dpvec and return first character from it. */
6601 it
->dpvec_char_len
= it
->len
;
6602 it
->dpvec
= it
->ctl_chars
;
6603 it
->dpend
= it
->dpvec
+ ctl_len
;
6604 it
->current
.dpvec_index
= 0;
6605 it
->dpvec_face_id
= face_id
;
6606 it
->saved_face_id
= it
->face_id
;
6607 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6611 it
->char_to_display
= c
;
6615 it
->char_to_display
= it
->c
;
6619 /* Adjust face id for a multibyte character. There are no multibyte
6620 character in unibyte text. */
6621 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6624 && FRAME_WINDOW_P (it
->f
))
6626 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6628 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6630 /* Automatic composition with glyph-string. */
6631 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6633 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6637 ptrdiff_t pos
= (it
->s
? -1
6638 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6639 : IT_CHARPOS (*it
));
6642 if (it
->what
== IT_CHARACTER
)
6643 c
= it
->char_to_display
;
6646 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6650 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6651 /* TAB in a composition means display glyphs with
6652 padding space on the left or right. */
6653 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6656 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6661 /* Is this character the last one of a run of characters with
6662 box? If yes, set IT->end_of_box_run_p to 1. */
6666 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6668 int face_id
= underlying_face_id (it
);
6669 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6673 if (face
->box
== FACE_NO_BOX
)
6675 /* If the box comes from face properties in a
6676 display string, check faces in that string. */
6677 int string_face_id
= face_after_it_pos (it
);
6678 it
->end_of_box_run_p
6679 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6682 /* Otherwise, the box comes from the underlying face.
6683 If this is the last string character displayed, check
6684 the next buffer location. */
6685 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6686 && (it
->current
.overlay_string_index
6687 == it
->n_overlay_strings
- 1))
6691 struct text_pos pos
= it
->current
.pos
;
6692 INC_TEXT_POS (pos
, it
->multibyte_p
);
6694 next_face_id
= face_at_buffer_position
6695 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6696 it
->region_end_charpos
, &ignore
,
6697 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6699 it
->end_of_box_run_p
6700 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6707 int face_id
= face_after_it_pos (it
);
6708 it
->end_of_box_run_p
6709 = (face_id
!= it
->face_id
6710 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6714 /* Value is 0 if end of buffer or string reached. */
6719 /* Move IT to the next display element.
6721 RESEAT_P non-zero means if called on a newline in buffer text,
6722 skip to the next visible line start.
6724 Functions get_next_display_element and set_iterator_to_next are
6725 separate because I find this arrangement easier to handle than a
6726 get_next_display_element function that also increments IT's
6727 position. The way it is we can first look at an iterator's current
6728 display element, decide whether it fits on a line, and if it does,
6729 increment the iterator position. The other way around we probably
6730 would either need a flag indicating whether the iterator has to be
6731 incremented the next time, or we would have to implement a
6732 decrement position function which would not be easy to write. */
6735 set_iterator_to_next (struct it
*it
, int reseat_p
)
6737 /* Reset flags indicating start and end of a sequence of characters
6738 with box. Reset them at the start of this function because
6739 moving the iterator to a new position might set them. */
6740 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6744 case GET_FROM_BUFFER
:
6745 /* The current display element of IT is a character from
6746 current_buffer. Advance in the buffer, and maybe skip over
6747 invisible lines that are so because of selective display. */
6748 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6749 reseat_at_next_visible_line_start (it
, 0);
6750 else if (it
->cmp_it
.id
>= 0)
6752 /* We are currently getting glyphs from a composition. */
6757 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6758 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6759 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6761 it
->cmp_it
.from
= it
->cmp_it
.to
;
6766 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6768 it
->end_charpos
, Qnil
);
6771 else if (! it
->cmp_it
.reversed_p
)
6773 /* Composition created while scanning forward. */
6774 /* Update IT's char/byte positions to point to the first
6775 character of the next grapheme cluster, or to the
6776 character visually after the current composition. */
6777 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6778 bidi_move_to_visually_next (&it
->bidi_it
);
6779 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6780 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6782 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6784 /* Proceed to the next grapheme cluster. */
6785 it
->cmp_it
.from
= it
->cmp_it
.to
;
6789 /* No more grapheme clusters in this composition.
6790 Find the next stop position. */
6791 ptrdiff_t stop
= it
->end_charpos
;
6792 if (it
->bidi_it
.scan_dir
< 0)
6793 /* Now we are scanning backward and don't know
6796 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6797 IT_BYTEPOS (*it
), stop
, Qnil
);
6802 /* Composition created while scanning backward. */
6803 /* Update IT's char/byte positions to point to the last
6804 character of the previous grapheme cluster, or the
6805 character visually after the current composition. */
6806 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6807 bidi_move_to_visually_next (&it
->bidi_it
);
6808 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6809 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6810 if (it
->cmp_it
.from
> 0)
6812 /* Proceed to the previous grapheme cluster. */
6813 it
->cmp_it
.to
= it
->cmp_it
.from
;
6817 /* No more grapheme clusters in this composition.
6818 Find the next stop position. */
6819 ptrdiff_t stop
= it
->end_charpos
;
6820 if (it
->bidi_it
.scan_dir
< 0)
6821 /* Now we are scanning backward and don't know
6824 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6825 IT_BYTEPOS (*it
), stop
, Qnil
);
6831 xassert (it
->len
!= 0);
6835 IT_BYTEPOS (*it
) += it
->len
;
6836 IT_CHARPOS (*it
) += 1;
6840 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6841 /* If this is a new paragraph, determine its base
6842 direction (a.k.a. its base embedding level). */
6843 if (it
->bidi_it
.new_paragraph
)
6844 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6845 bidi_move_to_visually_next (&it
->bidi_it
);
6846 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6847 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6848 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6850 /* As the scan direction was changed, we must
6851 re-compute the stop position for composition. */
6852 ptrdiff_t stop
= it
->end_charpos
;
6853 if (it
->bidi_it
.scan_dir
< 0)
6855 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6856 IT_BYTEPOS (*it
), stop
, Qnil
);
6859 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6863 case GET_FROM_C_STRING
:
6864 /* Current display element of IT is from a C string. */
6866 /* If the string position is beyond string's end, it means
6867 next_element_from_c_string is padding the string with
6868 blanks, in which case we bypass the bidi iterator,
6869 because it cannot deal with such virtual characters. */
6870 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6872 IT_BYTEPOS (*it
) += it
->len
;
6873 IT_CHARPOS (*it
) += 1;
6877 bidi_move_to_visually_next (&it
->bidi_it
);
6878 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6879 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6883 case GET_FROM_DISPLAY_VECTOR
:
6884 /* Current display element of IT is from a display table entry.
6885 Advance in the display table definition. Reset it to null if
6886 end reached, and continue with characters from buffers/
6888 ++it
->current
.dpvec_index
;
6890 /* Restore face of the iterator to what they were before the
6891 display vector entry (these entries may contain faces). */
6892 it
->face_id
= it
->saved_face_id
;
6894 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6896 int recheck_faces
= it
->ellipsis_p
;
6899 it
->method
= GET_FROM_C_STRING
;
6900 else if (STRINGP (it
->string
))
6901 it
->method
= GET_FROM_STRING
;
6904 it
->method
= GET_FROM_BUFFER
;
6905 it
->object
= it
->w
->buffer
;
6909 it
->current
.dpvec_index
= -1;
6911 /* Skip over characters which were displayed via IT->dpvec. */
6912 if (it
->dpvec_char_len
< 0)
6913 reseat_at_next_visible_line_start (it
, 1);
6914 else if (it
->dpvec_char_len
> 0)
6916 if (it
->method
== GET_FROM_STRING
6917 && it
->n_overlay_strings
> 0)
6918 it
->ignore_overlay_strings_at_pos_p
= 1;
6919 it
->len
= it
->dpvec_char_len
;
6920 set_iterator_to_next (it
, reseat_p
);
6923 /* Maybe recheck faces after display vector */
6925 it
->stop_charpos
= IT_CHARPOS (*it
);
6929 case GET_FROM_STRING
:
6930 /* Current display element is a character from a Lisp string. */
6931 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6932 if (it
->cmp_it
.id
>= 0)
6938 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6939 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6940 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6941 it
->cmp_it
.from
= it
->cmp_it
.to
;
6945 composition_compute_stop_pos (&it
->cmp_it
,
6946 IT_STRING_CHARPOS (*it
),
6947 IT_STRING_BYTEPOS (*it
),
6948 it
->end_charpos
, it
->string
);
6951 else if (! it
->cmp_it
.reversed_p
)
6953 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6954 bidi_move_to_visually_next (&it
->bidi_it
);
6955 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6956 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6958 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6959 it
->cmp_it
.from
= it
->cmp_it
.to
;
6962 ptrdiff_t stop
= it
->end_charpos
;
6963 if (it
->bidi_it
.scan_dir
< 0)
6965 composition_compute_stop_pos (&it
->cmp_it
,
6966 IT_STRING_CHARPOS (*it
),
6967 IT_STRING_BYTEPOS (*it
), stop
,
6973 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6974 bidi_move_to_visually_next (&it
->bidi_it
);
6975 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6976 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6977 if (it
->cmp_it
.from
> 0)
6978 it
->cmp_it
.to
= it
->cmp_it
.from
;
6981 ptrdiff_t stop
= it
->end_charpos
;
6982 if (it
->bidi_it
.scan_dir
< 0)
6984 composition_compute_stop_pos (&it
->cmp_it
,
6985 IT_STRING_CHARPOS (*it
),
6986 IT_STRING_BYTEPOS (*it
), stop
,
6994 /* If the string position is beyond string's end, it
6995 means next_element_from_string is padding the string
6996 with blanks, in which case we bypass the bidi
6997 iterator, because it cannot deal with such virtual
6999 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7001 IT_STRING_BYTEPOS (*it
) += it
->len
;
7002 IT_STRING_CHARPOS (*it
) += 1;
7006 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7008 bidi_move_to_visually_next (&it
->bidi_it
);
7009 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7010 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7011 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7013 ptrdiff_t stop
= it
->end_charpos
;
7015 if (it
->bidi_it
.scan_dir
< 0)
7017 composition_compute_stop_pos (&it
->cmp_it
,
7018 IT_STRING_CHARPOS (*it
),
7019 IT_STRING_BYTEPOS (*it
), stop
,
7025 consider_string_end
:
7027 if (it
->current
.overlay_string_index
>= 0)
7029 /* IT->string is an overlay string. Advance to the
7030 next, if there is one. */
7031 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7034 next_overlay_string (it
);
7036 setup_for_ellipsis (it
, 0);
7041 /* IT->string is not an overlay string. If we reached
7042 its end, and there is something on IT->stack, proceed
7043 with what is on the stack. This can be either another
7044 string, this time an overlay string, or a buffer. */
7045 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7049 if (it
->method
== GET_FROM_STRING
)
7050 goto consider_string_end
;
7055 case GET_FROM_IMAGE
:
7056 case GET_FROM_STRETCH
:
7057 /* The position etc with which we have to proceed are on
7058 the stack. The position may be at the end of a string,
7059 if the `display' property takes up the whole string. */
7060 xassert (it
->sp
> 0);
7062 if (it
->method
== GET_FROM_STRING
)
7063 goto consider_string_end
;
7067 /* There are no other methods defined, so this should be a bug. */
7071 xassert (it
->method
!= GET_FROM_STRING
7072 || (STRINGP (it
->string
)
7073 && IT_STRING_CHARPOS (*it
) >= 0));
7076 /* Load IT's display element fields with information about the next
7077 display element which comes from a display table entry or from the
7078 result of translating a control character to one of the forms `^C'
7081 IT->dpvec holds the glyphs to return as characters.
7082 IT->saved_face_id holds the face id before the display vector--it
7083 is restored into IT->face_id in set_iterator_to_next. */
7086 next_element_from_display_vector (struct it
*it
)
7091 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7093 it
->face_id
= it
->saved_face_id
;
7095 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7096 That seemed totally bogus - so I changed it... */
7097 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7099 if (GLYPH_CODE_P (gc
))
7101 it
->c
= GLYPH_CODE_CHAR (gc
);
7102 it
->len
= CHAR_BYTES (it
->c
);
7104 /* The entry may contain a face id to use. Such a face id is
7105 the id of a Lisp face, not a realized face. A face id of
7106 zero means no face is specified. */
7107 if (it
->dpvec_face_id
>= 0)
7108 it
->face_id
= it
->dpvec_face_id
;
7111 int lface_id
= GLYPH_CODE_FACE (gc
);
7113 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7118 /* Display table entry is invalid. Return a space. */
7119 it
->c
= ' ', it
->len
= 1;
7121 /* Don't change position and object of the iterator here. They are
7122 still the values of the character that had this display table
7123 entry or was translated, and that's what we want. */
7124 it
->what
= IT_CHARACTER
;
7128 /* Get the first element of string/buffer in the visual order, after
7129 being reseated to a new position in a string or a buffer. */
7131 get_visually_first_element (struct it
*it
)
7133 int string_p
= STRINGP (it
->string
) || it
->s
;
7134 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7135 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7137 if (STRINGP (it
->string
))
7139 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7140 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7144 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7145 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7148 if (it
->bidi_it
.charpos
== eob
)
7150 /* Nothing to do, but reset the FIRST_ELT flag, like
7151 bidi_paragraph_init does, because we are not going to
7153 it
->bidi_it
.first_elt
= 0;
7155 else if (it
->bidi_it
.charpos
== bob
7157 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7158 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7160 /* If we are at the beginning of a line/string, we can produce
7161 the next element right away. */
7162 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7163 bidi_move_to_visually_next (&it
->bidi_it
);
7167 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7169 /* We need to prime the bidi iterator starting at the line's or
7170 string's beginning, before we will be able to produce the
7173 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7176 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7178 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7180 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7183 /* Now return to buffer/string position where we were asked
7184 to get the next display element, and produce that. */
7185 bidi_move_to_visually_next (&it
->bidi_it
);
7187 while (it
->bidi_it
.bytepos
!= orig_bytepos
7188 && it
->bidi_it
.charpos
< eob
);
7191 /* Adjust IT's position information to where we ended up. */
7192 if (STRINGP (it
->string
))
7194 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7195 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7199 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7200 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7203 if (STRINGP (it
->string
) || !it
->s
)
7205 ptrdiff_t stop
, charpos
, bytepos
;
7207 if (STRINGP (it
->string
))
7210 stop
= SCHARS (it
->string
);
7211 if (stop
> it
->end_charpos
)
7212 stop
= it
->end_charpos
;
7213 charpos
= IT_STRING_CHARPOS (*it
);
7214 bytepos
= IT_STRING_BYTEPOS (*it
);
7218 stop
= it
->end_charpos
;
7219 charpos
= IT_CHARPOS (*it
);
7220 bytepos
= IT_BYTEPOS (*it
);
7222 if (it
->bidi_it
.scan_dir
< 0)
7224 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7229 /* Load IT with the next display element from Lisp string IT->string.
7230 IT->current.string_pos is the current position within the string.
7231 If IT->current.overlay_string_index >= 0, the Lisp string is an
7235 next_element_from_string (struct it
*it
)
7237 struct text_pos position
;
7239 xassert (STRINGP (it
->string
));
7240 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7241 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7242 position
= it
->current
.string_pos
;
7244 /* With bidi reordering, the character to display might not be the
7245 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7246 that we were reseat()ed to a new string, whose paragraph
7247 direction is not known. */
7248 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7250 get_visually_first_element (it
);
7251 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7254 /* Time to check for invisible text? */
7255 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7257 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7260 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7261 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7263 /* With bidi non-linear iteration, we could find
7264 ourselves far beyond the last computed stop_charpos,
7265 with several other stop positions in between that we
7266 missed. Scan them all now, in buffer's logical
7267 order, until we find and handle the last stop_charpos
7268 that precedes our current position. */
7269 handle_stop_backwards (it
, it
->stop_charpos
);
7270 return GET_NEXT_DISPLAY_ELEMENT (it
);
7276 /* Take note of the stop position we just moved
7277 across, for when we will move back across it. */
7278 it
->prev_stop
= it
->stop_charpos
;
7279 /* If we are at base paragraph embedding level, take
7280 note of the last stop position seen at this
7282 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7283 it
->base_level_stop
= it
->stop_charpos
;
7287 /* Since a handler may have changed IT->method, we must
7289 return GET_NEXT_DISPLAY_ELEMENT (it
);
7293 /* If we are before prev_stop, we may have overstepped
7294 on our way backwards a stop_pos, and if so, we need
7295 to handle that stop_pos. */
7296 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7297 /* We can sometimes back up for reasons that have nothing
7298 to do with bidi reordering. E.g., compositions. The
7299 code below is only needed when we are above the base
7300 embedding level, so test for that explicitly. */
7301 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7303 /* If we lost track of base_level_stop, we have no better
7304 place for handle_stop_backwards to start from than string
7305 beginning. This happens, e.g., when we were reseated to
7306 the previous screenful of text by vertical-motion. */
7307 if (it
->base_level_stop
<= 0
7308 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7309 it
->base_level_stop
= 0;
7310 handle_stop_backwards (it
, it
->base_level_stop
);
7311 return GET_NEXT_DISPLAY_ELEMENT (it
);
7315 if (it
->current
.overlay_string_index
>= 0)
7317 /* Get the next character from an overlay string. In overlay
7318 strings, There is no field width or padding with spaces to
7320 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7325 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7326 IT_STRING_BYTEPOS (*it
),
7327 it
->bidi_it
.scan_dir
< 0
7329 : SCHARS (it
->string
))
7330 && next_element_from_composition (it
))
7334 else if (STRING_MULTIBYTE (it
->string
))
7336 const unsigned char *s
= (SDATA (it
->string
)
7337 + IT_STRING_BYTEPOS (*it
));
7338 it
->c
= string_char_and_length (s
, &it
->len
);
7342 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7348 /* Get the next character from a Lisp string that is not an
7349 overlay string. Such strings come from the mode line, for
7350 example. We may have to pad with spaces, or truncate the
7351 string. See also next_element_from_c_string. */
7352 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7357 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7359 /* Pad with spaces. */
7360 it
->c
= ' ', it
->len
= 1;
7361 CHARPOS (position
) = BYTEPOS (position
) = -1;
7363 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7364 IT_STRING_BYTEPOS (*it
),
7365 it
->bidi_it
.scan_dir
< 0
7367 : it
->string_nchars
)
7368 && next_element_from_composition (it
))
7372 else if (STRING_MULTIBYTE (it
->string
))
7374 const unsigned char *s
= (SDATA (it
->string
)
7375 + IT_STRING_BYTEPOS (*it
));
7376 it
->c
= string_char_and_length (s
, &it
->len
);
7380 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7385 /* Record what we have and where it came from. */
7386 it
->what
= IT_CHARACTER
;
7387 it
->object
= it
->string
;
7388 it
->position
= position
;
7393 /* Load IT with next display element from C string IT->s.
7394 IT->string_nchars is the maximum number of characters to return
7395 from the string. IT->end_charpos may be greater than
7396 IT->string_nchars when this function is called, in which case we
7397 may have to return padding spaces. Value is zero if end of string
7398 reached, including padding spaces. */
7401 next_element_from_c_string (struct it
*it
)
7406 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7407 it
->what
= IT_CHARACTER
;
7408 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7411 /* With bidi reordering, the character to display might not be the
7412 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7413 we were reseated to a new string, whose paragraph direction is
7415 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7416 get_visually_first_element (it
);
7418 /* IT's position can be greater than IT->string_nchars in case a
7419 field width or precision has been specified when the iterator was
7421 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7423 /* End of the game. */
7427 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7429 /* Pad with spaces. */
7430 it
->c
= ' ', it
->len
= 1;
7431 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7433 else if (it
->multibyte_p
)
7434 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7436 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7442 /* Set up IT to return characters from an ellipsis, if appropriate.
7443 The definition of the ellipsis glyphs may come from a display table
7444 entry. This function fills IT with the first glyph from the
7445 ellipsis if an ellipsis is to be displayed. */
7448 next_element_from_ellipsis (struct it
*it
)
7450 if (it
->selective_display_ellipsis_p
)
7451 setup_for_ellipsis (it
, it
->len
);
7454 /* The face at the current position may be different from the
7455 face we find after the invisible text. Remember what it
7456 was in IT->saved_face_id, and signal that it's there by
7457 setting face_before_selective_p. */
7458 it
->saved_face_id
= it
->face_id
;
7459 it
->method
= GET_FROM_BUFFER
;
7460 it
->object
= it
->w
->buffer
;
7461 reseat_at_next_visible_line_start (it
, 1);
7462 it
->face_before_selective_p
= 1;
7465 return GET_NEXT_DISPLAY_ELEMENT (it
);
7469 /* Deliver an image display element. The iterator IT is already
7470 filled with image information (done in handle_display_prop). Value
7475 next_element_from_image (struct it
*it
)
7477 it
->what
= IT_IMAGE
;
7478 it
->ignore_overlay_strings_at_pos_p
= 0;
7483 /* Fill iterator IT with next display element from a stretch glyph
7484 property. IT->object is the value of the text property. Value is
7488 next_element_from_stretch (struct it
*it
)
7490 it
->what
= IT_STRETCH
;
7494 /* Scan backwards from IT's current position until we find a stop
7495 position, or until BEGV. This is called when we find ourself
7496 before both the last known prev_stop and base_level_stop while
7497 reordering bidirectional text. */
7500 compute_stop_pos_backwards (struct it
*it
)
7502 const int SCAN_BACK_LIMIT
= 1000;
7503 struct text_pos pos
;
7504 struct display_pos save_current
= it
->current
;
7505 struct text_pos save_position
= it
->position
;
7506 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7507 ptrdiff_t where_we_are
= charpos
;
7508 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7509 ptrdiff_t save_end_pos
= it
->end_charpos
;
7511 xassert (NILP (it
->string
) && !it
->s
);
7512 xassert (it
->bidi_p
);
7516 it
->end_charpos
= min (charpos
+ 1, ZV
);
7517 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7518 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7519 reseat_1 (it
, pos
, 0);
7520 compute_stop_pos (it
);
7521 /* We must advance forward, right? */
7522 if (it
->stop_charpos
<= charpos
)
7525 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7527 if (it
->stop_charpos
<= where_we_are
)
7528 it
->prev_stop
= it
->stop_charpos
;
7530 it
->prev_stop
= BEGV
;
7532 it
->current
= save_current
;
7533 it
->position
= save_position
;
7534 it
->stop_charpos
= save_stop_pos
;
7535 it
->end_charpos
= save_end_pos
;
7538 /* Scan forward from CHARPOS in the current buffer/string, until we
7539 find a stop position > current IT's position. Then handle the stop
7540 position before that. This is called when we bump into a stop
7541 position while reordering bidirectional text. CHARPOS should be
7542 the last previously processed stop_pos (or BEGV/0, if none were
7543 processed yet) whose position is less that IT's current
7547 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7549 int bufp
= !STRINGP (it
->string
);
7550 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7551 struct display_pos save_current
= it
->current
;
7552 struct text_pos save_position
= it
->position
;
7553 struct text_pos pos1
;
7554 ptrdiff_t next_stop
;
7556 /* Scan in strict logical order. */
7557 xassert (it
->bidi_p
);
7561 it
->prev_stop
= charpos
;
7564 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7565 reseat_1 (it
, pos1
, 0);
7568 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7569 compute_stop_pos (it
);
7570 /* We must advance forward, right? */
7571 if (it
->stop_charpos
<= it
->prev_stop
)
7573 charpos
= it
->stop_charpos
;
7575 while (charpos
<= where_we_are
);
7578 it
->current
= save_current
;
7579 it
->position
= save_position
;
7580 next_stop
= it
->stop_charpos
;
7581 it
->stop_charpos
= it
->prev_stop
;
7583 it
->stop_charpos
= next_stop
;
7586 /* Load IT with the next display element from current_buffer. Value
7587 is zero if end of buffer reached. IT->stop_charpos is the next
7588 position at which to stop and check for text properties or buffer
7592 next_element_from_buffer (struct it
*it
)
7596 xassert (IT_CHARPOS (*it
) >= BEGV
);
7597 xassert (NILP (it
->string
) && !it
->s
);
7598 xassert (!it
->bidi_p
7599 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7600 && it
->bidi_it
.string
.s
== NULL
));
7602 /* With bidi reordering, the character to display might not be the
7603 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7604 we were reseat()ed to a new buffer position, which is potentially
7605 a different paragraph. */
7606 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7608 get_visually_first_element (it
);
7609 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7612 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7614 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7616 int overlay_strings_follow_p
;
7618 /* End of the game, except when overlay strings follow that
7619 haven't been returned yet. */
7620 if (it
->overlay_strings_at_end_processed_p
)
7621 overlay_strings_follow_p
= 0;
7624 it
->overlay_strings_at_end_processed_p
= 1;
7625 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7628 if (overlay_strings_follow_p
)
7629 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7633 it
->position
= it
->current
.pos
;
7637 else if (!(!it
->bidi_p
7638 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7639 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7641 /* With bidi non-linear iteration, we could find ourselves
7642 far beyond the last computed stop_charpos, with several
7643 other stop positions in between that we missed. Scan
7644 them all now, in buffer's logical order, until we find
7645 and handle the last stop_charpos that precedes our
7646 current position. */
7647 handle_stop_backwards (it
, it
->stop_charpos
);
7648 return GET_NEXT_DISPLAY_ELEMENT (it
);
7654 /* Take note of the stop position we just moved across,
7655 for when we will move back across it. */
7656 it
->prev_stop
= it
->stop_charpos
;
7657 /* If we are at base paragraph embedding level, take
7658 note of the last stop position seen at this
7660 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7661 it
->base_level_stop
= it
->stop_charpos
;
7664 return GET_NEXT_DISPLAY_ELEMENT (it
);
7668 /* If we are before prev_stop, we may have overstepped on
7669 our way backwards a stop_pos, and if so, we need to
7670 handle that stop_pos. */
7671 && IT_CHARPOS (*it
) < it
->prev_stop
7672 /* We can sometimes back up for reasons that have nothing
7673 to do with bidi reordering. E.g., compositions. The
7674 code below is only needed when we are above the base
7675 embedding level, so test for that explicitly. */
7676 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7678 if (it
->base_level_stop
<= 0
7679 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7681 /* If we lost track of base_level_stop, we need to find
7682 prev_stop by looking backwards. This happens, e.g., when
7683 we were reseated to the previous screenful of text by
7685 it
->base_level_stop
= BEGV
;
7686 compute_stop_pos_backwards (it
);
7687 handle_stop_backwards (it
, it
->prev_stop
);
7690 handle_stop_backwards (it
, it
->base_level_stop
);
7691 return GET_NEXT_DISPLAY_ELEMENT (it
);
7695 /* No face changes, overlays etc. in sight, so just return a
7696 character from current_buffer. */
7700 /* Maybe run the redisplay end trigger hook. Performance note:
7701 This doesn't seem to cost measurable time. */
7702 if (it
->redisplay_end_trigger_charpos
7704 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7705 run_redisplay_end_trigger_hook (it
);
7707 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7708 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7710 && next_element_from_composition (it
))
7715 /* Get the next character, maybe multibyte. */
7716 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7717 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7718 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7720 it
->c
= *p
, it
->len
= 1;
7722 /* Record what we have and where it came from. */
7723 it
->what
= IT_CHARACTER
;
7724 it
->object
= it
->w
->buffer
;
7725 it
->position
= it
->current
.pos
;
7727 /* Normally we return the character found above, except when we
7728 really want to return an ellipsis for selective display. */
7733 /* A value of selective > 0 means hide lines indented more
7734 than that number of columns. */
7735 if (it
->selective
> 0
7736 && IT_CHARPOS (*it
) + 1 < ZV
7737 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7738 IT_BYTEPOS (*it
) + 1,
7741 success_p
= next_element_from_ellipsis (it
);
7742 it
->dpvec_char_len
= -1;
7745 else if (it
->c
== '\r' && it
->selective
== -1)
7747 /* A value of selective == -1 means that everything from the
7748 CR to the end of the line is invisible, with maybe an
7749 ellipsis displayed for it. */
7750 success_p
= next_element_from_ellipsis (it
);
7751 it
->dpvec_char_len
= -1;
7756 /* Value is zero if end of buffer reached. */
7757 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7762 /* Run the redisplay end trigger hook for IT. */
7765 run_redisplay_end_trigger_hook (struct it
*it
)
7767 Lisp_Object args
[3];
7769 /* IT->glyph_row should be non-null, i.e. we should be actually
7770 displaying something, or otherwise we should not run the hook. */
7771 xassert (it
->glyph_row
);
7773 /* Set up hook arguments. */
7774 args
[0] = Qredisplay_end_trigger_functions
;
7775 args
[1] = it
->window
;
7776 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7777 it
->redisplay_end_trigger_charpos
= 0;
7779 /* Since we are *trying* to run these functions, don't try to run
7780 them again, even if they get an error. */
7781 it
->w
->redisplay_end_trigger
= Qnil
;
7782 Frun_hook_with_args (3, args
);
7784 /* Notice if it changed the face of the character we are on. */
7785 handle_face_prop (it
);
7789 /* Deliver a composition display element. Unlike the other
7790 next_element_from_XXX, this function is not registered in the array
7791 get_next_element[]. It is called from next_element_from_buffer and
7792 next_element_from_string when necessary. */
7795 next_element_from_composition (struct it
*it
)
7797 it
->what
= IT_COMPOSITION
;
7798 it
->len
= it
->cmp_it
.nbytes
;
7799 if (STRINGP (it
->string
))
7803 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7804 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7807 it
->position
= it
->current
.string_pos
;
7808 it
->object
= it
->string
;
7809 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7810 IT_STRING_BYTEPOS (*it
), it
->string
);
7816 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7817 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7820 if (it
->bidi_it
.new_paragraph
)
7821 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7822 /* Resync the bidi iterator with IT's new position.
7823 FIXME: this doesn't support bidirectional text. */
7824 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7825 bidi_move_to_visually_next (&it
->bidi_it
);
7829 it
->position
= it
->current
.pos
;
7830 it
->object
= it
->w
->buffer
;
7831 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7832 IT_BYTEPOS (*it
), Qnil
);
7839 /***********************************************************************
7840 Moving an iterator without producing glyphs
7841 ***********************************************************************/
7843 /* Check if iterator is at a position corresponding to a valid buffer
7844 position after some move_it_ call. */
7846 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7847 ((it)->method == GET_FROM_STRING \
7848 ? IT_STRING_CHARPOS (*it) == 0 \
7852 /* Move iterator IT to a specified buffer or X position within one
7853 line on the display without producing glyphs.
7855 OP should be a bit mask including some or all of these bits:
7856 MOVE_TO_X: Stop upon reaching x-position TO_X.
7857 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7858 Regardless of OP's value, stop upon reaching the end of the display line.
7860 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7861 This means, in particular, that TO_X includes window's horizontal
7864 The return value has several possible values that
7865 say what condition caused the scan to stop:
7867 MOVE_POS_MATCH_OR_ZV
7868 - when TO_POS or ZV was reached.
7871 -when TO_X was reached before TO_POS or ZV were reached.
7874 - when we reached the end of the display area and the line must
7878 - when we reached the end of the display area and the line is
7882 - when we stopped at a line end, i.e. a newline or a CR and selective
7885 static enum move_it_result
7886 move_it_in_display_line_to (struct it
*it
,
7887 ptrdiff_t to_charpos
, int to_x
,
7888 enum move_operation_enum op
)
7890 enum move_it_result result
= MOVE_UNDEFINED
;
7891 struct glyph_row
*saved_glyph_row
;
7892 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7893 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7894 void *ppos_data
= NULL
;
7896 enum it_method prev_method
= it
->method
;
7897 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
7898 int saw_smaller_pos
= prev_pos
< to_charpos
;
7900 /* Don't produce glyphs in produce_glyphs. */
7901 saved_glyph_row
= it
->glyph_row
;
7902 it
->glyph_row
= NULL
;
7904 /* Use wrap_it to save a copy of IT wherever a word wrap could
7905 occur. Use atpos_it to save a copy of IT at the desired buffer
7906 position, if found, so that we can scan ahead and check if the
7907 word later overshoots the window edge. Use atx_it similarly, for
7913 /* Use ppos_it under bidi reordering to save a copy of IT for the
7914 position > CHARPOS that is the closest to CHARPOS. We restore
7915 that position in IT when we have scanned the entire display line
7916 without finding a match for CHARPOS and all the character
7917 positions are greater than CHARPOS. */
7920 SAVE_IT (ppos_it
, *it
, ppos_data
);
7921 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7922 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7923 SAVE_IT (ppos_it
, *it
, ppos_data
);
7926 #define BUFFER_POS_REACHED_P() \
7927 ((op & MOVE_TO_POS) != 0 \
7928 && BUFFERP (it->object) \
7929 && (IT_CHARPOS (*it) == to_charpos \
7931 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7932 && IT_CHARPOS (*it) > to_charpos) \
7933 || (it->what == IT_COMPOSITION \
7934 && ((IT_CHARPOS (*it) > to_charpos \
7935 && to_charpos >= it->cmp_it.charpos) \
7936 || (IT_CHARPOS (*it) < to_charpos \
7937 && to_charpos <= it->cmp_it.charpos)))) \
7938 && (it->method == GET_FROM_BUFFER \
7939 || (it->method == GET_FROM_DISPLAY_VECTOR \
7940 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7942 /* If there's a line-/wrap-prefix, handle it. */
7943 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7944 && it
->current_y
< it
->last_visible_y
)
7945 handle_line_prefix (it
);
7947 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7948 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7952 int x
, i
, ascent
= 0, descent
= 0;
7954 /* Utility macro to reset an iterator with x, ascent, and descent. */
7955 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7956 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7957 (IT)->max_descent = descent)
7959 /* Stop if we move beyond TO_CHARPOS (after an image or a
7960 display string or stretch glyph). */
7961 if ((op
& MOVE_TO_POS
) != 0
7962 && BUFFERP (it
->object
)
7963 && it
->method
== GET_FROM_BUFFER
7965 /* When the iterator is at base embedding level, we
7966 are guaranteed that characters are delivered for
7967 display in strictly increasing order of their
7968 buffer positions. */
7969 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7970 && IT_CHARPOS (*it
) > to_charpos
)
7972 && (prev_method
== GET_FROM_IMAGE
7973 || prev_method
== GET_FROM_STRETCH
7974 || prev_method
== GET_FROM_STRING
)
7975 /* Passed TO_CHARPOS from left to right. */
7976 && ((prev_pos
< to_charpos
7977 && IT_CHARPOS (*it
) > to_charpos
)
7978 /* Passed TO_CHARPOS from right to left. */
7979 || (prev_pos
> to_charpos
7980 && IT_CHARPOS (*it
) < to_charpos
)))))
7982 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7984 result
= MOVE_POS_MATCH_OR_ZV
;
7987 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7988 /* If wrap_it is valid, the current position might be in a
7989 word that is wrapped. So, save the iterator in
7990 atpos_it and continue to see if wrapping happens. */
7991 SAVE_IT (atpos_it
, *it
, atpos_data
);
7994 /* Stop when ZV reached.
7995 We used to stop here when TO_CHARPOS reached as well, but that is
7996 too soon if this glyph does not fit on this line. So we handle it
7997 explicitly below. */
7998 if (!get_next_display_element (it
))
8000 result
= MOVE_POS_MATCH_OR_ZV
;
8004 if (it
->line_wrap
== TRUNCATE
)
8006 if (BUFFER_POS_REACHED_P ())
8008 result
= MOVE_POS_MATCH_OR_ZV
;
8014 if (it
->line_wrap
== WORD_WRAP
)
8016 if (IT_DISPLAYING_WHITESPACE (it
))
8020 /* We have reached a glyph that follows one or more
8021 whitespace characters. If the position is
8022 already found, we are done. */
8023 if (atpos_it
.sp
>= 0)
8025 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8026 result
= MOVE_POS_MATCH_OR_ZV
;
8031 RESTORE_IT (it
, &atx_it
, atx_data
);
8032 result
= MOVE_X_REACHED
;
8035 /* Otherwise, we can wrap here. */
8036 SAVE_IT (wrap_it
, *it
, wrap_data
);
8042 /* Remember the line height for the current line, in case
8043 the next element doesn't fit on the line. */
8044 ascent
= it
->max_ascent
;
8045 descent
= it
->max_descent
;
8047 /* The call to produce_glyphs will get the metrics of the
8048 display element IT is loaded with. Record the x-position
8049 before this display element, in case it doesn't fit on the
8053 PRODUCE_GLYPHS (it
);
8055 if (it
->area
!= TEXT_AREA
)
8057 prev_method
= it
->method
;
8058 if (it
->method
== GET_FROM_BUFFER
)
8059 prev_pos
= IT_CHARPOS (*it
);
8060 set_iterator_to_next (it
, 1);
8061 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8062 SET_TEXT_POS (this_line_min_pos
,
8063 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8065 && (op
& MOVE_TO_POS
)
8066 && IT_CHARPOS (*it
) > to_charpos
8067 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8068 SAVE_IT (ppos_it
, *it
, ppos_data
);
8072 /* The number of glyphs we get back in IT->nglyphs will normally
8073 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8074 character on a terminal frame, or (iii) a line end. For the
8075 second case, IT->nglyphs - 1 padding glyphs will be present.
8076 (On X frames, there is only one glyph produced for a
8077 composite character.)
8079 The behavior implemented below means, for continuation lines,
8080 that as many spaces of a TAB as fit on the current line are
8081 displayed there. For terminal frames, as many glyphs of a
8082 multi-glyph character are displayed in the current line, too.
8083 This is what the old redisplay code did, and we keep it that
8084 way. Under X, the whole shape of a complex character must
8085 fit on the line or it will be completely displayed in the
8088 Note that both for tabs and padding glyphs, all glyphs have
8092 /* More than one glyph or glyph doesn't fit on line. All
8093 glyphs have the same width. */
8094 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8096 int x_before_this_char
= x
;
8097 int hpos_before_this_char
= it
->hpos
;
8099 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8101 new_x
= x
+ single_glyph_width
;
8103 /* We want to leave anything reaching TO_X to the caller. */
8104 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8106 if (BUFFER_POS_REACHED_P ())
8108 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8109 goto buffer_pos_reached
;
8110 if (atpos_it
.sp
< 0)
8112 SAVE_IT (atpos_it
, *it
, atpos_data
);
8113 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8118 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8121 result
= MOVE_X_REACHED
;
8126 SAVE_IT (atx_it
, *it
, atx_data
);
8127 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8132 if (/* Lines are continued. */
8133 it
->line_wrap
!= TRUNCATE
8134 && (/* And glyph doesn't fit on the line. */
8135 new_x
> it
->last_visible_x
8136 /* Or it fits exactly and we're on a window
8138 || (new_x
== it
->last_visible_x
8139 && FRAME_WINDOW_P (it
->f
))))
8141 if (/* IT->hpos == 0 means the very first glyph
8142 doesn't fit on the line, e.g. a wide image. */
8144 || (new_x
== it
->last_visible_x
8145 && FRAME_WINDOW_P (it
->f
)))
8148 it
->current_x
= new_x
;
8150 /* The character's last glyph just barely fits
8152 if (i
== it
->nglyphs
- 1)
8154 /* If this is the destination position,
8155 return a position *before* it in this row,
8156 now that we know it fits in this row. */
8157 if (BUFFER_POS_REACHED_P ())
8159 if (it
->line_wrap
!= WORD_WRAP
8162 it
->hpos
= hpos_before_this_char
;
8163 it
->current_x
= x_before_this_char
;
8164 result
= MOVE_POS_MATCH_OR_ZV
;
8167 if (it
->line_wrap
== WORD_WRAP
8170 SAVE_IT (atpos_it
, *it
, atpos_data
);
8171 atpos_it
.current_x
= x_before_this_char
;
8172 atpos_it
.hpos
= hpos_before_this_char
;
8176 prev_method
= it
->method
;
8177 if (it
->method
== GET_FROM_BUFFER
)
8178 prev_pos
= IT_CHARPOS (*it
);
8179 set_iterator_to_next (it
, 1);
8180 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8181 SET_TEXT_POS (this_line_min_pos
,
8182 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8183 /* On graphical terminals, newlines may
8184 "overflow" into the fringe if
8185 overflow-newline-into-fringe is non-nil.
8186 On text-only terminals, newlines may
8187 overflow into the last glyph on the
8189 if (!FRAME_WINDOW_P (it
->f
)
8190 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8192 if (!get_next_display_element (it
))
8194 result
= MOVE_POS_MATCH_OR_ZV
;
8197 if (BUFFER_POS_REACHED_P ())
8199 if (ITERATOR_AT_END_OF_LINE_P (it
))
8200 result
= MOVE_POS_MATCH_OR_ZV
;
8202 result
= MOVE_LINE_CONTINUED
;
8205 if (ITERATOR_AT_END_OF_LINE_P (it
))
8207 result
= MOVE_NEWLINE_OR_CR
;
8214 IT_RESET_X_ASCENT_DESCENT (it
);
8216 if (wrap_it
.sp
>= 0)
8218 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8223 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8225 result
= MOVE_LINE_CONTINUED
;
8229 if (BUFFER_POS_REACHED_P ())
8231 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8232 goto buffer_pos_reached
;
8233 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8235 SAVE_IT (atpos_it
, *it
, atpos_data
);
8236 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8240 if (new_x
> it
->first_visible_x
)
8242 /* Glyph is visible. Increment number of glyphs that
8243 would be displayed. */
8248 if (result
!= MOVE_UNDEFINED
)
8251 else if (BUFFER_POS_REACHED_P ())
8254 IT_RESET_X_ASCENT_DESCENT (it
);
8255 result
= MOVE_POS_MATCH_OR_ZV
;
8258 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8260 /* Stop when TO_X specified and reached. This check is
8261 necessary here because of lines consisting of a line end,
8262 only. The line end will not produce any glyphs and we
8263 would never get MOVE_X_REACHED. */
8264 xassert (it
->nglyphs
== 0);
8265 result
= MOVE_X_REACHED
;
8269 /* Is this a line end? If yes, we're done. */
8270 if (ITERATOR_AT_END_OF_LINE_P (it
))
8272 /* If we are past TO_CHARPOS, but never saw any character
8273 positions smaller than TO_CHARPOS, return
8274 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8276 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8278 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8280 if (IT_CHARPOS (ppos_it
) < ZV
)
8282 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8283 result
= MOVE_POS_MATCH_OR_ZV
;
8286 goto buffer_pos_reached
;
8288 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8289 && IT_CHARPOS (*it
) > to_charpos
)
8290 goto buffer_pos_reached
;
8292 result
= MOVE_NEWLINE_OR_CR
;
8295 result
= MOVE_NEWLINE_OR_CR
;
8299 prev_method
= it
->method
;
8300 if (it
->method
== GET_FROM_BUFFER
)
8301 prev_pos
= IT_CHARPOS (*it
);
8302 /* The current display element has been consumed. Advance
8304 set_iterator_to_next (it
, 1);
8305 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8306 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8307 if (IT_CHARPOS (*it
) < to_charpos
)
8308 saw_smaller_pos
= 1;
8310 && (op
& MOVE_TO_POS
)
8311 && IT_CHARPOS (*it
) >= to_charpos
8312 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8313 SAVE_IT (ppos_it
, *it
, ppos_data
);
8315 /* Stop if lines are truncated and IT's current x-position is
8316 past the right edge of the window now. */
8317 if (it
->line_wrap
== TRUNCATE
8318 && it
->current_x
>= it
->last_visible_x
)
8320 if (!FRAME_WINDOW_P (it
->f
)
8321 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8325 if ((at_eob_p
= !get_next_display_element (it
))
8326 || BUFFER_POS_REACHED_P ()
8327 /* If we are past TO_CHARPOS, but never saw any
8328 character positions smaller than TO_CHARPOS,
8329 return MOVE_POS_MATCH_OR_ZV, like the
8330 unidirectional display did. */
8331 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8333 && IT_CHARPOS (*it
) > to_charpos
))
8336 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8337 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8338 result
= MOVE_POS_MATCH_OR_ZV
;
8341 if (ITERATOR_AT_END_OF_LINE_P (it
))
8343 result
= MOVE_NEWLINE_OR_CR
;
8347 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8349 && IT_CHARPOS (*it
) > to_charpos
)
8351 if (IT_CHARPOS (ppos_it
) < ZV
)
8352 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8353 result
= MOVE_POS_MATCH_OR_ZV
;
8356 result
= MOVE_LINE_TRUNCATED
;
8359 #undef IT_RESET_X_ASCENT_DESCENT
8362 #undef BUFFER_POS_REACHED_P
8364 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8365 restore the saved iterator. */
8366 if (atpos_it
.sp
>= 0)
8367 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8368 else if (atx_it
.sp
>= 0)
8369 RESTORE_IT (it
, &atx_it
, atx_data
);
8374 bidi_unshelve_cache (atpos_data
, 1);
8376 bidi_unshelve_cache (atx_data
, 1);
8378 bidi_unshelve_cache (wrap_data
, 1);
8380 bidi_unshelve_cache (ppos_data
, 1);
8382 /* Restore the iterator settings altered at the beginning of this
8384 it
->glyph_row
= saved_glyph_row
;
8388 /* For external use. */
8390 move_it_in_display_line (struct it
*it
,
8391 ptrdiff_t to_charpos
, int to_x
,
8392 enum move_operation_enum op
)
8394 if (it
->line_wrap
== WORD_WRAP
8395 && (op
& MOVE_TO_X
))
8398 void *save_data
= NULL
;
8401 SAVE_IT (save_it
, *it
, save_data
);
8402 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8403 /* When word-wrap is on, TO_X may lie past the end
8404 of a wrapped line. Then it->current is the
8405 character on the next line, so backtrack to the
8406 space before the wrap point. */
8407 if (skip
== MOVE_LINE_CONTINUED
)
8409 int prev_x
= max (it
->current_x
- 1, 0);
8410 RESTORE_IT (it
, &save_it
, save_data
);
8411 move_it_in_display_line_to
8412 (it
, -1, prev_x
, MOVE_TO_X
);
8415 bidi_unshelve_cache (save_data
, 1);
8418 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8422 /* Move IT forward until it satisfies one or more of the criteria in
8423 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8425 OP is a bit-mask that specifies where to stop, and in particular,
8426 which of those four position arguments makes a difference. See the
8427 description of enum move_operation_enum.
8429 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8430 screen line, this function will set IT to the next position that is
8431 displayed to the right of TO_CHARPOS on the screen. */
8434 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8436 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8437 int line_height
, line_start_x
= 0, reached
= 0;
8438 void *backup_data
= NULL
;
8442 if (op
& MOVE_TO_VPOS
)
8444 /* If no TO_CHARPOS and no TO_X specified, stop at the
8445 start of the line TO_VPOS. */
8446 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8448 if (it
->vpos
== to_vpos
)
8454 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8458 /* TO_VPOS >= 0 means stop at TO_X in the line at
8459 TO_VPOS, or at TO_POS, whichever comes first. */
8460 if (it
->vpos
== to_vpos
)
8466 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8468 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8473 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8475 /* We have reached TO_X but not in the line we want. */
8476 skip
= move_it_in_display_line_to (it
, to_charpos
,
8478 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8486 else if (op
& MOVE_TO_Y
)
8488 struct it it_backup
;
8490 if (it
->line_wrap
== WORD_WRAP
)
8491 SAVE_IT (it_backup
, *it
, backup_data
);
8493 /* TO_Y specified means stop at TO_X in the line containing
8494 TO_Y---or at TO_CHARPOS if this is reached first. The
8495 problem is that we can't really tell whether the line
8496 contains TO_Y before we have completely scanned it, and
8497 this may skip past TO_X. What we do is to first scan to
8500 If TO_X is not specified, use a TO_X of zero. The reason
8501 is to make the outcome of this function more predictable.
8502 If we didn't use TO_X == 0, we would stop at the end of
8503 the line which is probably not what a caller would expect
8505 skip
= move_it_in_display_line_to
8506 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8507 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8509 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8510 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8512 else if (skip
== MOVE_X_REACHED
)
8514 /* If TO_X was reached, we want to know whether TO_Y is
8515 in the line. We know this is the case if the already
8516 scanned glyphs make the line tall enough. Otherwise,
8517 we must check by scanning the rest of the line. */
8518 line_height
= it
->max_ascent
+ it
->max_descent
;
8519 if (to_y
>= it
->current_y
8520 && to_y
< it
->current_y
+ line_height
)
8525 SAVE_IT (it_backup
, *it
, backup_data
);
8526 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8527 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8529 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8530 line_height
= it
->max_ascent
+ it
->max_descent
;
8531 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8533 if (to_y
>= it
->current_y
8534 && to_y
< it
->current_y
+ line_height
)
8536 /* If TO_Y is in this line and TO_X was reached
8537 above, we scanned too far. We have to restore
8538 IT's settings to the ones before skipping. */
8539 RESTORE_IT (it
, &it_backup
, backup_data
);
8545 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8551 /* Check whether TO_Y is in this line. */
8552 line_height
= it
->max_ascent
+ it
->max_descent
;
8553 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8555 if (to_y
>= it
->current_y
8556 && to_y
< it
->current_y
+ line_height
)
8558 /* When word-wrap is on, TO_X may lie past the end
8559 of a wrapped line. Then it->current is the
8560 character on the next line, so backtrack to the
8561 space before the wrap point. */
8562 if (skip
== MOVE_LINE_CONTINUED
8563 && it
->line_wrap
== WORD_WRAP
)
8565 int prev_x
= max (it
->current_x
- 1, 0);
8566 RESTORE_IT (it
, &it_backup
, backup_data
);
8567 skip
= move_it_in_display_line_to
8568 (it
, -1, prev_x
, MOVE_TO_X
);
8577 else if (BUFFERP (it
->object
)
8578 && (it
->method
== GET_FROM_BUFFER
8579 || it
->method
== GET_FROM_STRETCH
)
8580 && IT_CHARPOS (*it
) >= to_charpos
8581 /* Under bidi iteration, a call to set_iterator_to_next
8582 can scan far beyond to_charpos if the initial
8583 portion of the next line needs to be reordered. In
8584 that case, give move_it_in_display_line_to another
8587 && it
->bidi_it
.scan_dir
== -1))
8588 skip
= MOVE_POS_MATCH_OR_ZV
;
8590 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8594 case MOVE_POS_MATCH_OR_ZV
:
8598 case MOVE_NEWLINE_OR_CR
:
8599 set_iterator_to_next (it
, 1);
8600 it
->continuation_lines_width
= 0;
8603 case MOVE_LINE_TRUNCATED
:
8604 it
->continuation_lines_width
= 0;
8605 reseat_at_next_visible_line_start (it
, 0);
8606 if ((op
& MOVE_TO_POS
) != 0
8607 && IT_CHARPOS (*it
) > to_charpos
)
8614 case MOVE_LINE_CONTINUED
:
8615 /* For continued lines ending in a tab, some of the glyphs
8616 associated with the tab are displayed on the current
8617 line. Since it->current_x does not include these glyphs,
8618 we use it->last_visible_x instead. */
8621 it
->continuation_lines_width
+= it
->last_visible_x
;
8622 /* When moving by vpos, ensure that the iterator really
8623 advances to the next line (bug#847, bug#969). Fixme:
8624 do we need to do this in other circumstances? */
8625 if (it
->current_x
!= it
->last_visible_x
8626 && (op
& MOVE_TO_VPOS
)
8627 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8629 line_start_x
= it
->current_x
+ it
->pixel_width
8630 - it
->last_visible_x
;
8631 set_iterator_to_next (it
, 0);
8635 it
->continuation_lines_width
+= it
->current_x
;
8642 /* Reset/increment for the next run. */
8643 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8644 it
->current_x
= line_start_x
;
8647 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8649 last_height
= it
->max_ascent
+ it
->max_descent
;
8650 last_max_ascent
= it
->max_ascent
;
8651 it
->max_ascent
= it
->max_descent
= 0;
8656 /* On text terminals, we may stop at the end of a line in the middle
8657 of a multi-character glyph. If the glyph itself is continued,
8658 i.e. it is actually displayed on the next line, don't treat this
8659 stopping point as valid; move to the next line instead (unless
8660 that brings us offscreen). */
8661 if (!FRAME_WINDOW_P (it
->f
)
8663 && IT_CHARPOS (*it
) == to_charpos
8664 && it
->what
== IT_CHARACTER
8666 && it
->line_wrap
== WINDOW_WRAP
8667 && it
->current_x
== it
->last_visible_x
- 1
8670 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8672 it
->continuation_lines_width
+= it
->current_x
;
8673 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8674 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8676 last_height
= it
->max_ascent
+ it
->max_descent
;
8677 last_max_ascent
= it
->max_ascent
;
8681 bidi_unshelve_cache (backup_data
, 1);
8683 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8687 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8689 If DY > 0, move IT backward at least that many pixels. DY = 0
8690 means move IT backward to the preceding line start or BEGV. This
8691 function may move over more than DY pixels if IT->current_y - DY
8692 ends up in the middle of a line; in this case IT->current_y will be
8693 set to the top of the line moved to. */
8696 move_it_vertically_backward (struct it
*it
, int dy
)
8700 void *it2data
= NULL
, *it3data
= NULL
;
8701 ptrdiff_t start_pos
;
8706 start_pos
= IT_CHARPOS (*it
);
8708 /* Estimate how many newlines we must move back. */
8709 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8711 /* Set the iterator's position that many lines back. */
8712 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8713 back_to_previous_visible_line_start (it
);
8715 /* Reseat the iterator here. When moving backward, we don't want
8716 reseat to skip forward over invisible text, set up the iterator
8717 to deliver from overlay strings at the new position etc. So,
8718 use reseat_1 here. */
8719 reseat_1 (it
, it
->current
.pos
, 1);
8721 /* We are now surely at a line start. */
8722 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8723 reordering is in effect. */
8724 it
->continuation_lines_width
= 0;
8726 /* Move forward and see what y-distance we moved. First move to the
8727 start of the next line so that we get its height. We need this
8728 height to be able to tell whether we reached the specified
8730 SAVE_IT (it2
, *it
, it2data
);
8731 it2
.max_ascent
= it2
.max_descent
= 0;
8734 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8735 MOVE_TO_POS
| MOVE_TO_VPOS
);
8737 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8738 /* If we are in a display string which starts at START_POS,
8739 and that display string includes a newline, and we are
8740 right after that newline (i.e. at the beginning of a
8741 display line), exit the loop, because otherwise we will
8742 infloop, since move_it_to will see that it is already at
8743 START_POS and will not move. */
8744 || (it2
.method
== GET_FROM_STRING
8745 && IT_CHARPOS (it2
) == start_pos
8746 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8747 xassert (IT_CHARPOS (*it
) >= BEGV
);
8748 SAVE_IT (it3
, it2
, it3data
);
8750 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8751 xassert (IT_CHARPOS (*it
) >= BEGV
);
8752 /* H is the actual vertical distance from the position in *IT
8753 and the starting position. */
8754 h
= it2
.current_y
- it
->current_y
;
8755 /* NLINES is the distance in number of lines. */
8756 nlines
= it2
.vpos
- it
->vpos
;
8758 /* Correct IT's y and vpos position
8759 so that they are relative to the starting point. */
8765 /* DY == 0 means move to the start of the screen line. The
8766 value of nlines is > 0 if continuation lines were involved,
8767 or if the original IT position was at start of a line. */
8768 RESTORE_IT (it
, it
, it2data
);
8770 move_it_by_lines (it
, nlines
);
8771 /* The above code moves us to some position NLINES down,
8772 usually to its first glyph (leftmost in an L2R line), but
8773 that's not necessarily the start of the line, under bidi
8774 reordering. We want to get to the character position
8775 that is immediately after the newline of the previous
8777 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8778 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8781 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8783 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8785 bidi_unshelve_cache (it3data
, 1);
8789 /* The y-position we try to reach, relative to *IT.
8790 Note that H has been subtracted in front of the if-statement. */
8791 int target_y
= it
->current_y
+ h
- dy
;
8792 int y0
= it3
.current_y
;
8796 RESTORE_IT (&it3
, &it3
, it3data
);
8797 y1
= line_bottom_y (&it3
);
8798 line_height
= y1
- y0
;
8799 RESTORE_IT (it
, it
, it2data
);
8800 /* If we did not reach target_y, try to move further backward if
8801 we can. If we moved too far backward, try to move forward. */
8802 if (target_y
< it
->current_y
8803 /* This is heuristic. In a window that's 3 lines high, with
8804 a line height of 13 pixels each, recentering with point
8805 on the bottom line will try to move -39/2 = 19 pixels
8806 backward. Try to avoid moving into the first line. */
8807 && (it
->current_y
- target_y
8808 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8809 && IT_CHARPOS (*it
) > BEGV
)
8811 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8812 target_y
- it
->current_y
));
8813 dy
= it
->current_y
- target_y
;
8814 goto move_further_back
;
8816 else if (target_y
>= it
->current_y
+ line_height
8817 && IT_CHARPOS (*it
) < ZV
)
8819 /* Should move forward by at least one line, maybe more.
8821 Note: Calling move_it_by_lines can be expensive on
8822 terminal frames, where compute_motion is used (via
8823 vmotion) to do the job, when there are very long lines
8824 and truncate-lines is nil. That's the reason for
8825 treating terminal frames specially here. */
8827 if (!FRAME_WINDOW_P (it
->f
))
8828 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8833 move_it_by_lines (it
, 1);
8835 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8842 /* Move IT by a specified amount of pixel lines DY. DY negative means
8843 move backwards. DY = 0 means move to start of screen line. At the
8844 end, IT will be on the start of a screen line. */
8847 move_it_vertically (struct it
*it
, int dy
)
8850 move_it_vertically_backward (it
, -dy
);
8853 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8854 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8855 MOVE_TO_POS
| MOVE_TO_Y
);
8856 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8858 /* If buffer ends in ZV without a newline, move to the start of
8859 the line to satisfy the post-condition. */
8860 if (IT_CHARPOS (*it
) == ZV
8862 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8863 move_it_by_lines (it
, 0);
8868 /* Move iterator IT past the end of the text line it is in. */
8871 move_it_past_eol (struct it
*it
)
8873 enum move_it_result rc
;
8875 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8876 if (rc
== MOVE_NEWLINE_OR_CR
)
8877 set_iterator_to_next (it
, 0);
8881 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8882 negative means move up. DVPOS == 0 means move to the start of the
8885 Optimization idea: If we would know that IT->f doesn't use
8886 a face with proportional font, we could be faster for
8887 truncate-lines nil. */
8890 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
8893 /* The commented-out optimization uses vmotion on terminals. This
8894 gives bad results, because elements like it->what, on which
8895 callers such as pos_visible_p rely, aren't updated. */
8896 /* struct position pos;
8897 if (!FRAME_WINDOW_P (it->f))
8899 struct text_pos textpos;
8901 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8902 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8903 reseat (it, textpos, 1);
8904 it->vpos += pos.vpos;
8905 it->current_y += pos.vpos;
8911 /* DVPOS == 0 means move to the start of the screen line. */
8912 move_it_vertically_backward (it
, 0);
8913 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8914 /* Let next call to line_bottom_y calculate real line height */
8919 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8920 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8921 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8926 void *it2data
= NULL
;
8927 ptrdiff_t start_charpos
, i
;
8929 /* Start at the beginning of the screen line containing IT's
8930 position. This may actually move vertically backwards,
8931 in case of overlays, so adjust dvpos accordingly. */
8933 move_it_vertically_backward (it
, 0);
8936 /* Go back -DVPOS visible lines and reseat the iterator there. */
8937 start_charpos
= IT_CHARPOS (*it
);
8938 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8939 back_to_previous_visible_line_start (it
);
8940 reseat (it
, it
->current
.pos
, 1);
8942 /* Move further back if we end up in a string or an image. */
8943 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8945 /* First try to move to start of display line. */
8947 move_it_vertically_backward (it
, 0);
8949 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8951 /* If start of line is still in string or image,
8952 move further back. */
8953 back_to_previous_visible_line_start (it
);
8954 reseat (it
, it
->current
.pos
, 1);
8958 it
->current_x
= it
->hpos
= 0;
8960 /* Above call may have moved too far if continuation lines
8961 are involved. Scan forward and see if it did. */
8962 SAVE_IT (it2
, *it
, it2data
);
8963 it2
.vpos
= it2
.current_y
= 0;
8964 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8965 it
->vpos
-= it2
.vpos
;
8966 it
->current_y
-= it2
.current_y
;
8967 it
->current_x
= it
->hpos
= 0;
8969 /* If we moved too far back, move IT some lines forward. */
8970 if (it2
.vpos
> -dvpos
)
8972 int delta
= it2
.vpos
+ dvpos
;
8974 RESTORE_IT (&it2
, &it2
, it2data
);
8975 SAVE_IT (it2
, *it
, it2data
);
8976 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8977 /* Move back again if we got too far ahead. */
8978 if (IT_CHARPOS (*it
) >= start_charpos
)
8979 RESTORE_IT (it
, &it2
, it2data
);
8981 bidi_unshelve_cache (it2data
, 1);
8984 RESTORE_IT (it
, it
, it2data
);
8988 /* Return 1 if IT points into the middle of a display vector. */
8991 in_display_vector_p (struct it
*it
)
8993 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8994 && it
->current
.dpvec_index
> 0
8995 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8999 /***********************************************************************
9001 ***********************************************************************/
9004 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9008 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9010 Lisp_Object args
[3];
9011 Lisp_Object msg
, fmt
;
9014 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9017 /* Do nothing if called asynchronously. Inserting text into
9018 a buffer may call after-change-functions and alike and
9019 that would means running Lisp asynchronously. */
9020 if (handling_signal
)
9024 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9026 args
[0] = fmt
= build_string (format
);
9029 msg
= Fformat (3, args
);
9031 len
= SBYTES (msg
) + 1;
9032 SAFE_ALLOCA (buffer
, char *, len
);
9033 memcpy (buffer
, SDATA (msg
), len
);
9035 message_dolog (buffer
, len
- 1, 1, 0);
9042 /* Output a newline in the *Messages* buffer if "needs" one. */
9045 message_log_maybe_newline (void)
9047 if (message_log_need_newline
)
9048 message_dolog ("", 0, 1, 0);
9052 /* Add a string M of length NBYTES to the message log, optionally
9053 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9054 nonzero, means interpret the contents of M as multibyte. This
9055 function calls low-level routines in order to bypass text property
9056 hooks, etc. which might not be safe to run.
9058 This may GC (insert may run before/after change hooks),
9059 so the buffer M must NOT point to a Lisp string. */
9062 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9064 const unsigned char *msg
= (const unsigned char *) m
;
9066 if (!NILP (Vmemory_full
))
9069 if (!NILP (Vmessage_log_max
))
9071 struct buffer
*oldbuf
;
9072 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9073 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9074 ptrdiff_t point_at_end
= 0;
9075 ptrdiff_t zv_at_end
= 0;
9076 Lisp_Object old_deactivate_mark
, tem
;
9077 struct gcpro gcpro1
;
9079 old_deactivate_mark
= Vdeactivate_mark
;
9080 oldbuf
= current_buffer
;
9081 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9082 BVAR (current_buffer
, undo_list
) = Qt
;
9084 oldpoint
= message_dolog_marker1
;
9085 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9086 oldbegv
= message_dolog_marker2
;
9087 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9088 oldzv
= message_dolog_marker3
;
9089 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9090 GCPRO1 (old_deactivate_mark
);
9098 BEGV_BYTE
= BEG_BYTE
;
9101 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9103 /* Insert the string--maybe converting multibyte to single byte
9104 or vice versa, so that all the text fits the buffer. */
9106 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9112 /* Convert a multibyte string to single-byte
9113 for the *Message* buffer. */
9114 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9116 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9117 work
[0] = (ASCII_CHAR_P (c
)
9119 : multibyte_char_to_unibyte (c
));
9120 insert_1_both (work
, 1, 1, 1, 0, 0);
9123 else if (! multibyte
9124 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9128 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9129 /* Convert a single-byte string to multibyte
9130 for the *Message* buffer. */
9131 for (i
= 0; i
< nbytes
; i
++)
9134 MAKE_CHAR_MULTIBYTE (c
);
9135 char_bytes
= CHAR_STRING (c
, str
);
9136 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9140 insert_1 (m
, nbytes
, 1, 0, 0);
9144 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9146 insert_1 ("\n", 1, 1, 0, 0);
9148 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9150 this_bol_byte
= PT_BYTE
;
9152 /* See if this line duplicates the previous one.
9153 If so, combine duplicates. */
9156 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9158 prev_bol_byte
= PT_BYTE
;
9160 dups
= message_log_check_duplicate (prev_bol_byte
,
9164 del_range_both (prev_bol
, prev_bol_byte
,
9165 this_bol
, this_bol_byte
, 0);
9168 char dupstr
[sizeof " [ times]"
9169 + INT_STRLEN_BOUND (printmax_t
)];
9172 /* If you change this format, don't forget to also
9173 change message_log_check_duplicate. */
9174 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9175 duplen
= strlen (dupstr
);
9176 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9177 insert_1 (dupstr
, duplen
, 1, 0, 1);
9182 /* If we have more than the desired maximum number of lines
9183 in the *Messages* buffer now, delete the oldest ones.
9184 This is safe because we don't have undo in this buffer. */
9186 if (NATNUMP (Vmessage_log_max
))
9188 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9189 -XFASTINT (Vmessage_log_max
) - 1, 0);
9190 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9193 BEGV
= XMARKER (oldbegv
)->charpos
;
9194 BEGV_BYTE
= marker_byte_position (oldbegv
);
9203 ZV
= XMARKER (oldzv
)->charpos
;
9204 ZV_BYTE
= marker_byte_position (oldzv
);
9208 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9210 /* We can't do Fgoto_char (oldpoint) because it will run some
9212 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9213 XMARKER (oldpoint
)->bytepos
);
9216 unchain_marker (XMARKER (oldpoint
));
9217 unchain_marker (XMARKER (oldbegv
));
9218 unchain_marker (XMARKER (oldzv
));
9220 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9221 set_buffer_internal (oldbuf
);
9223 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9224 message_log_need_newline
= !nlflag
;
9225 Vdeactivate_mark
= old_deactivate_mark
;
9230 /* We are at the end of the buffer after just having inserted a newline.
9231 (Note: We depend on the fact we won't be crossing the gap.)
9232 Check to see if the most recent message looks a lot like the previous one.
9233 Return 0 if different, 1 if the new one should just replace it, or a
9234 value N > 1 if we should also append " [N times]". */
9237 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9240 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9242 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9243 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9245 for (i
= 0; i
< len
; i
++)
9247 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9255 if (*p1
++ == ' ' && *p1
++ == '[')
9258 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9259 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9266 /* Display an echo area message M with a specified length of NBYTES
9267 bytes. The string may include null characters. If M is 0, clear
9268 out any existing message, and let the mini-buffer text show
9271 This may GC, so the buffer M must NOT point to a Lisp string. */
9274 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9276 /* First flush out any partial line written with print. */
9277 message_log_maybe_newline ();
9279 message_dolog (m
, nbytes
, 1, multibyte
);
9280 message2_nolog (m
, nbytes
, multibyte
);
9284 /* The non-logging counterpart of message2. */
9287 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9289 struct frame
*sf
= SELECTED_FRAME ();
9290 message_enable_multibyte
= multibyte
;
9292 if (FRAME_INITIAL_P (sf
))
9294 if (noninteractive_need_newline
)
9295 putc ('\n', stderr
);
9296 noninteractive_need_newline
= 0;
9298 fwrite (m
, nbytes
, 1, stderr
);
9299 if (cursor_in_echo_area
== 0)
9300 fprintf (stderr
, "\n");
9303 /* A null message buffer means that the frame hasn't really been
9304 initialized yet. Error messages get reported properly by
9305 cmd_error, so this must be just an informative message; toss it. */
9306 else if (INTERACTIVE
9307 && sf
->glyphs_initialized_p
9308 && FRAME_MESSAGE_BUF (sf
))
9310 Lisp_Object mini_window
;
9313 /* Get the frame containing the mini-buffer
9314 that the selected frame is using. */
9315 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9316 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9318 FRAME_SAMPLE_VISIBILITY (f
);
9319 if (FRAME_VISIBLE_P (sf
)
9320 && ! FRAME_VISIBLE_P (f
))
9321 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9325 set_message (m
, Qnil
, nbytes
, multibyte
);
9326 if (minibuffer_auto_raise
)
9327 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9330 clear_message (1, 1);
9332 do_pending_window_change (0);
9333 echo_area_display (1);
9334 do_pending_window_change (0);
9335 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9336 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9341 /* Display an echo area message M with a specified length of NBYTES
9342 bytes. The string may include null characters. If M is not a
9343 string, clear out any existing message, and let the mini-buffer
9346 This function cancels echoing. */
9349 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9351 struct gcpro gcpro1
;
9354 clear_message (1,1);
9357 /* First flush out any partial line written with print. */
9358 message_log_maybe_newline ();
9364 SAFE_ALLOCA (buffer
, char *, nbytes
);
9365 memcpy (buffer
, SDATA (m
), nbytes
);
9366 message_dolog (buffer
, nbytes
, 1, multibyte
);
9369 message3_nolog (m
, nbytes
, multibyte
);
9375 /* The non-logging version of message3.
9376 This does not cancel echoing, because it is used for echoing.
9377 Perhaps we need to make a separate function for echoing
9378 and make this cancel echoing. */
9381 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9383 struct frame
*sf
= SELECTED_FRAME ();
9384 message_enable_multibyte
= multibyte
;
9386 if (FRAME_INITIAL_P (sf
))
9388 if (noninteractive_need_newline
)
9389 putc ('\n', stderr
);
9390 noninteractive_need_newline
= 0;
9392 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9393 if (cursor_in_echo_area
== 0)
9394 fprintf (stderr
, "\n");
9397 /* A null message buffer means that the frame hasn't really been
9398 initialized yet. Error messages get reported properly by
9399 cmd_error, so this must be just an informative message; toss it. */
9400 else if (INTERACTIVE
9401 && sf
->glyphs_initialized_p
9402 && FRAME_MESSAGE_BUF (sf
))
9404 Lisp_Object mini_window
;
9408 /* Get the frame containing the mini-buffer
9409 that the selected frame is using. */
9410 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9411 frame
= XWINDOW (mini_window
)->frame
;
9414 FRAME_SAMPLE_VISIBILITY (f
);
9415 if (FRAME_VISIBLE_P (sf
)
9416 && !FRAME_VISIBLE_P (f
))
9417 Fmake_frame_visible (frame
);
9419 if (STRINGP (m
) && SCHARS (m
) > 0)
9421 set_message (NULL
, m
, nbytes
, multibyte
);
9422 if (minibuffer_auto_raise
)
9423 Fraise_frame (frame
);
9424 /* Assume we are not echoing.
9425 (If we are, echo_now will override this.) */
9426 echo_message_buffer
= Qnil
;
9429 clear_message (1, 1);
9431 do_pending_window_change (0);
9432 echo_area_display (1);
9433 do_pending_window_change (0);
9434 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9435 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9440 /* Display a null-terminated echo area message M. If M is 0, clear
9441 out any existing message, and let the mini-buffer text show through.
9443 The buffer M must continue to exist until after the echo area gets
9444 cleared or some other message gets displayed there. Do not pass
9445 text that is stored in a Lisp string. Do not pass text in a buffer
9446 that was alloca'd. */
9449 message1 (const char *m
)
9451 message2 (m
, (m
? strlen (m
) : 0), 0);
9455 /* The non-logging counterpart of message1. */
9458 message1_nolog (const char *m
)
9460 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9463 /* Display a message M which contains a single %s
9464 which gets replaced with STRING. */
9467 message_with_string (const char *m
, Lisp_Object string
, int log
)
9469 CHECK_STRING (string
);
9475 if (noninteractive_need_newline
)
9476 putc ('\n', stderr
);
9477 noninteractive_need_newline
= 0;
9478 fprintf (stderr
, m
, SDATA (string
));
9479 if (!cursor_in_echo_area
)
9480 fprintf (stderr
, "\n");
9484 else if (INTERACTIVE
)
9486 /* The frame whose minibuffer we're going to display the message on.
9487 It may be larger than the selected frame, so we need
9488 to use its buffer, not the selected frame's buffer. */
9489 Lisp_Object mini_window
;
9490 struct frame
*f
, *sf
= SELECTED_FRAME ();
9492 /* Get the frame containing the minibuffer
9493 that the selected frame is using. */
9494 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9495 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9497 /* A null message buffer means that the frame hasn't really been
9498 initialized yet. Error messages get reported properly by
9499 cmd_error, so this must be just an informative message; toss it. */
9500 if (FRAME_MESSAGE_BUF (f
))
9502 Lisp_Object args
[2], msg
;
9503 struct gcpro gcpro1
, gcpro2
;
9505 args
[0] = build_string (m
);
9506 args
[1] = msg
= string
;
9507 GCPRO2 (args
[0], msg
);
9510 msg
= Fformat (2, args
);
9513 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9515 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9519 /* Print should start at the beginning of the message
9520 buffer next time. */
9521 message_buf_print
= 0;
9527 /* Dump an informative message to the minibuf. If M is 0, clear out
9528 any existing message, and let the mini-buffer text show through. */
9531 vmessage (const char *m
, va_list ap
)
9537 if (noninteractive_need_newline
)
9538 putc ('\n', stderr
);
9539 noninteractive_need_newline
= 0;
9540 vfprintf (stderr
, m
, ap
);
9541 if (cursor_in_echo_area
== 0)
9542 fprintf (stderr
, "\n");
9546 else if (INTERACTIVE
)
9548 /* The frame whose mini-buffer we're going to display the message
9549 on. It may be larger than the selected frame, so we need to
9550 use its buffer, not the selected frame's buffer. */
9551 Lisp_Object mini_window
;
9552 struct frame
*f
, *sf
= SELECTED_FRAME ();
9554 /* Get the frame containing the mini-buffer
9555 that the selected frame is using. */
9556 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9557 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9559 /* A null message buffer means that the frame hasn't really been
9560 initialized yet. Error messages get reported properly by
9561 cmd_error, so this must be just an informative message; toss
9563 if (FRAME_MESSAGE_BUF (f
))
9569 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9570 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9572 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9577 /* Print should start at the beginning of the message
9578 buffer next time. */
9579 message_buf_print
= 0;
9585 message (const char *m
, ...)
9595 /* The non-logging version of message. */
9598 message_nolog (const char *m
, ...)
9600 Lisp_Object old_log_max
;
9603 old_log_max
= Vmessage_log_max
;
9604 Vmessage_log_max
= Qnil
;
9606 Vmessage_log_max
= old_log_max
;
9612 /* Display the current message in the current mini-buffer. This is
9613 only called from error handlers in process.c, and is not time
9617 update_echo_area (void)
9619 if (!NILP (echo_area_buffer
[0]))
9622 string
= Fcurrent_message ();
9623 message3 (string
, SBYTES (string
),
9624 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9629 /* Make sure echo area buffers in `echo_buffers' are live.
9630 If they aren't, make new ones. */
9633 ensure_echo_area_buffers (void)
9637 for (i
= 0; i
< 2; ++i
)
9638 if (!BUFFERP (echo_buffer
[i
])
9639 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9642 Lisp_Object old_buffer
;
9645 old_buffer
= echo_buffer
[i
];
9646 sprintf (name
, " *Echo Area %d*", i
);
9647 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9648 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9649 /* to force word wrap in echo area -
9650 it was decided to postpone this*/
9651 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9653 for (j
= 0; j
< 2; ++j
)
9654 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9655 echo_area_buffer
[j
] = echo_buffer
[i
];
9660 /* Call FN with args A1..A4 with either the current or last displayed
9661 echo_area_buffer as current buffer.
9663 WHICH zero means use the current message buffer
9664 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9665 from echo_buffer[] and clear it.
9667 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9668 suitable buffer from echo_buffer[] and clear it.
9670 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9671 that the current message becomes the last displayed one, make
9672 choose a suitable buffer for echo_area_buffer[0], and clear it.
9674 Value is what FN returns. */
9677 with_echo_area_buffer (struct window
*w
, int which
,
9678 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9679 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9682 int this_one
, the_other
, clear_buffer_p
, rc
;
9683 ptrdiff_t count
= SPECPDL_INDEX ();
9685 /* If buffers aren't live, make new ones. */
9686 ensure_echo_area_buffers ();
9691 this_one
= 0, the_other
= 1;
9693 this_one
= 1, the_other
= 0;
9696 this_one
= 0, the_other
= 1;
9699 /* We need a fresh one in case the current echo buffer equals
9700 the one containing the last displayed echo area message. */
9701 if (!NILP (echo_area_buffer
[this_one
])
9702 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9703 echo_area_buffer
[this_one
] = Qnil
;
9706 /* Choose a suitable buffer from echo_buffer[] is we don't
9708 if (NILP (echo_area_buffer
[this_one
]))
9710 echo_area_buffer
[this_one
]
9711 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9712 ? echo_buffer
[the_other
]
9713 : echo_buffer
[this_one
]);
9717 buffer
= echo_area_buffer
[this_one
];
9719 /* Don't get confused by reusing the buffer used for echoing
9720 for a different purpose. */
9721 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9724 record_unwind_protect (unwind_with_echo_area_buffer
,
9725 with_echo_area_buffer_unwind_data (w
));
9727 /* Make the echo area buffer current. Note that for display
9728 purposes, it is not necessary that the displayed window's buffer
9729 == current_buffer, except for text property lookup. So, let's
9730 only set that buffer temporarily here without doing a full
9731 Fset_window_buffer. We must also change w->pointm, though,
9732 because otherwise an assertions in unshow_buffer fails, and Emacs
9734 set_buffer_internal_1 (XBUFFER (buffer
));
9738 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9741 BVAR (current_buffer
, undo_list
) = Qt
;
9742 BVAR (current_buffer
, read_only
) = Qnil
;
9743 specbind (Qinhibit_read_only
, Qt
);
9744 specbind (Qinhibit_modification_hooks
, Qt
);
9746 if (clear_buffer_p
&& Z
> BEG
)
9749 xassert (BEGV
>= BEG
);
9750 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9752 rc
= fn (a1
, a2
, a3
, a4
);
9754 xassert (BEGV
>= BEG
);
9755 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9757 unbind_to (count
, Qnil
);
9762 /* Save state that should be preserved around the call to the function
9763 FN called in with_echo_area_buffer. */
9766 with_echo_area_buffer_unwind_data (struct window
*w
)
9769 Lisp_Object vector
, tmp
;
9771 /* Reduce consing by keeping one vector in
9772 Vwith_echo_area_save_vector. */
9773 vector
= Vwith_echo_area_save_vector
;
9774 Vwith_echo_area_save_vector
= Qnil
;
9777 vector
= Fmake_vector (make_number (7), Qnil
);
9779 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9780 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9781 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9785 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9786 ASET (vector
, i
, w
->buffer
); ++i
;
9787 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9788 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9793 for (; i
< end
; ++i
)
9794 ASET (vector
, i
, Qnil
);
9797 xassert (i
== ASIZE (vector
));
9802 /* Restore global state from VECTOR which was created by
9803 with_echo_area_buffer_unwind_data. */
9806 unwind_with_echo_area_buffer (Lisp_Object vector
)
9808 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9809 Vdeactivate_mark
= AREF (vector
, 1);
9810 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9812 if (WINDOWP (AREF (vector
, 3)))
9815 Lisp_Object buffer
, charpos
, bytepos
;
9817 w
= XWINDOW (AREF (vector
, 3));
9818 buffer
= AREF (vector
, 4);
9819 charpos
= AREF (vector
, 5);
9820 bytepos
= AREF (vector
, 6);
9823 set_marker_both (w
->pointm
, buffer
,
9824 XFASTINT (charpos
), XFASTINT (bytepos
));
9827 Vwith_echo_area_save_vector
= vector
;
9832 /* Set up the echo area for use by print functions. MULTIBYTE_P
9833 non-zero means we will print multibyte. */
9836 setup_echo_area_for_printing (int multibyte_p
)
9838 /* If we can't find an echo area any more, exit. */
9839 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9842 ensure_echo_area_buffers ();
9844 if (!message_buf_print
)
9846 /* A message has been output since the last time we printed.
9847 Choose a fresh echo area buffer. */
9848 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9849 echo_area_buffer
[0] = echo_buffer
[1];
9851 echo_area_buffer
[0] = echo_buffer
[0];
9853 /* Switch to that buffer and clear it. */
9854 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9855 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9859 ptrdiff_t count
= SPECPDL_INDEX ();
9860 specbind (Qinhibit_read_only
, Qt
);
9861 /* Note that undo recording is always disabled. */
9863 unbind_to (count
, Qnil
);
9865 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9867 /* Set up the buffer for the multibyteness we need. */
9869 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9870 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9872 /* Raise the frame containing the echo area. */
9873 if (minibuffer_auto_raise
)
9875 struct frame
*sf
= SELECTED_FRAME ();
9876 Lisp_Object mini_window
;
9877 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9878 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9881 message_log_maybe_newline ();
9882 message_buf_print
= 1;
9886 if (NILP (echo_area_buffer
[0]))
9888 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9889 echo_area_buffer
[0] = echo_buffer
[1];
9891 echo_area_buffer
[0] = echo_buffer
[0];
9894 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9896 /* Someone switched buffers between print requests. */
9897 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9898 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9904 /* Display an echo area message in window W. Value is non-zero if W's
9905 height is changed. If display_last_displayed_message_p is
9906 non-zero, display the message that was last displayed, otherwise
9907 display the current message. */
9910 display_echo_area (struct window
*w
)
9912 int i
, no_message_p
, window_height_changed_p
;
9914 /* Temporarily disable garbage collections while displaying the echo
9915 area. This is done because a GC can print a message itself.
9916 That message would modify the echo area buffer's contents while a
9917 redisplay of the buffer is going on, and seriously confuse
9919 ptrdiff_t count
= inhibit_garbage_collection ();
9921 /* If there is no message, we must call display_echo_area_1
9922 nevertheless because it resizes the window. But we will have to
9923 reset the echo_area_buffer in question to nil at the end because
9924 with_echo_area_buffer will sets it to an empty buffer. */
9925 i
= display_last_displayed_message_p
? 1 : 0;
9926 no_message_p
= NILP (echo_area_buffer
[i
]);
9928 window_height_changed_p
9929 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9930 display_echo_area_1
,
9931 (intptr_t) w
, Qnil
, 0, 0);
9934 echo_area_buffer
[i
] = Qnil
;
9936 unbind_to (count
, Qnil
);
9937 return window_height_changed_p
;
9941 /* Helper for display_echo_area. Display the current buffer which
9942 contains the current echo area message in window W, a mini-window,
9943 a pointer to which is passed in A1. A2..A4 are currently not used.
9944 Change the height of W so that all of the message is displayed.
9945 Value is non-zero if height of W was changed. */
9948 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9951 struct window
*w
= (struct window
*) i1
;
9953 struct text_pos start
;
9954 int window_height_changed_p
= 0;
9956 /* Do this before displaying, so that we have a large enough glyph
9957 matrix for the display. If we can't get enough space for the
9958 whole text, display the last N lines. That works by setting w->start. */
9959 window_height_changed_p
= resize_mini_window (w
, 0);
9961 /* Use the starting position chosen by resize_mini_window. */
9962 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9965 clear_glyph_matrix (w
->desired_matrix
);
9966 XSETWINDOW (window
, w
);
9967 try_window (window
, start
, 0);
9969 return window_height_changed_p
;
9973 /* Resize the echo area window to exactly the size needed for the
9974 currently displayed message, if there is one. If a mini-buffer
9975 is active, don't shrink it. */
9978 resize_echo_area_exactly (void)
9980 if (BUFFERP (echo_area_buffer
[0])
9981 && WINDOWP (echo_area_window
))
9983 struct window
*w
= XWINDOW (echo_area_window
);
9985 Lisp_Object resize_exactly
;
9987 if (minibuf_level
== 0)
9988 resize_exactly
= Qt
;
9990 resize_exactly
= Qnil
;
9992 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9993 (intptr_t) w
, resize_exactly
,
9997 ++windows_or_buffers_changed
;
9998 ++update_mode_lines
;
9999 redisplay_internal ();
10005 /* Callback function for with_echo_area_buffer, when used from
10006 resize_echo_area_exactly. A1 contains a pointer to the window to
10007 resize, EXACTLY non-nil means resize the mini-window exactly to the
10008 size of the text displayed. A3 and A4 are not used. Value is what
10009 resize_mini_window returns. */
10012 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10015 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10019 /* Resize mini-window W to fit the size of its contents. EXACT_P
10020 means size the window exactly to the size needed. Otherwise, it's
10021 only enlarged until W's buffer is empty.
10023 Set W->start to the right place to begin display. If the whole
10024 contents fit, start at the beginning. Otherwise, start so as
10025 to make the end of the contents appear. This is particularly
10026 important for y-or-n-p, but seems desirable generally.
10028 Value is non-zero if the window height has been changed. */
10031 resize_mini_window (struct window
*w
, int exact_p
)
10033 struct frame
*f
= XFRAME (w
->frame
);
10034 int window_height_changed_p
= 0;
10036 xassert (MINI_WINDOW_P (w
));
10038 /* By default, start display at the beginning. */
10039 set_marker_both (w
->start
, w
->buffer
,
10040 BUF_BEGV (XBUFFER (w
->buffer
)),
10041 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10043 /* Don't resize windows while redisplaying a window; it would
10044 confuse redisplay functions when the size of the window they are
10045 displaying changes from under them. Such a resizing can happen,
10046 for instance, when which-func prints a long message while
10047 we are running fontification-functions. We're running these
10048 functions with safe_call which binds inhibit-redisplay to t. */
10049 if (!NILP (Vinhibit_redisplay
))
10052 /* Nil means don't try to resize. */
10053 if (NILP (Vresize_mini_windows
)
10054 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10057 if (!FRAME_MINIBUF_ONLY_P (f
))
10060 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10061 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10063 EMACS_INT max_height
;
10064 int unit
= FRAME_LINE_HEIGHT (f
);
10065 struct text_pos start
;
10066 struct buffer
*old_current_buffer
= NULL
;
10068 if (current_buffer
!= XBUFFER (w
->buffer
))
10070 old_current_buffer
= current_buffer
;
10071 set_buffer_internal (XBUFFER (w
->buffer
));
10074 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10076 /* Compute the max. number of lines specified by the user. */
10077 if (FLOATP (Vmax_mini_window_height
))
10078 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10079 else if (INTEGERP (Vmax_mini_window_height
))
10080 max_height
= XINT (Vmax_mini_window_height
);
10082 max_height
= total_height
/ 4;
10084 /* Correct that max. height if it's bogus. */
10085 max_height
= max (1, max_height
);
10086 max_height
= min (total_height
, max_height
);
10088 /* Find out the height of the text in the window. */
10089 if (it
.line_wrap
== TRUNCATE
)
10094 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10095 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10096 height
= it
.current_y
+ last_height
;
10098 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10099 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10100 height
= (height
+ unit
- 1) / unit
;
10103 /* Compute a suitable window start. */
10104 if (height
> max_height
)
10106 height
= max_height
;
10107 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10108 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10109 start
= it
.current
.pos
;
10112 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10113 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10115 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10117 /* Let it grow only, until we display an empty message, in which
10118 case the window shrinks again. */
10119 if (height
> WINDOW_TOTAL_LINES (w
))
10121 int old_height
= WINDOW_TOTAL_LINES (w
);
10122 freeze_window_starts (f
, 1);
10123 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10124 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10126 else if (height
< WINDOW_TOTAL_LINES (w
)
10127 && (exact_p
|| BEGV
== ZV
))
10129 int old_height
= WINDOW_TOTAL_LINES (w
);
10130 freeze_window_starts (f
, 0);
10131 shrink_mini_window (w
);
10132 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10137 /* Always resize to exact size needed. */
10138 if (height
> WINDOW_TOTAL_LINES (w
))
10140 int old_height
= WINDOW_TOTAL_LINES (w
);
10141 freeze_window_starts (f
, 1);
10142 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10143 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10145 else if (height
< WINDOW_TOTAL_LINES (w
))
10147 int old_height
= WINDOW_TOTAL_LINES (w
);
10148 freeze_window_starts (f
, 0);
10149 shrink_mini_window (w
);
10153 freeze_window_starts (f
, 1);
10154 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10157 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10161 if (old_current_buffer
)
10162 set_buffer_internal (old_current_buffer
);
10165 return window_height_changed_p
;
10169 /* Value is the current message, a string, or nil if there is no
10170 current message. */
10173 current_message (void)
10177 if (!BUFFERP (echo_area_buffer
[0]))
10181 with_echo_area_buffer (0, 0, current_message_1
,
10182 (intptr_t) &msg
, Qnil
, 0, 0);
10184 echo_area_buffer
[0] = Qnil
;
10192 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10195 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10198 *msg
= make_buffer_string (BEG
, Z
, 1);
10205 /* Push the current message on Vmessage_stack for later restauration
10206 by restore_message. Value is non-zero if the current message isn't
10207 empty. This is a relatively infrequent operation, so it's not
10208 worth optimizing. */
10211 push_message (void)
10214 msg
= current_message ();
10215 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10216 return STRINGP (msg
);
10220 /* Restore message display from the top of Vmessage_stack. */
10223 restore_message (void)
10227 xassert (CONSP (Vmessage_stack
));
10228 msg
= XCAR (Vmessage_stack
);
10230 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10232 message3_nolog (msg
, 0, 0);
10236 /* Handler for record_unwind_protect calling pop_message. */
10239 pop_message_unwind (Lisp_Object dummy
)
10245 /* Pop the top-most entry off Vmessage_stack. */
10250 xassert (CONSP (Vmessage_stack
));
10251 Vmessage_stack
= XCDR (Vmessage_stack
);
10255 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10256 exits. If the stack is not empty, we have a missing pop_message
10260 check_message_stack (void)
10262 if (!NILP (Vmessage_stack
))
10267 /* Truncate to NCHARS what will be displayed in the echo area the next
10268 time we display it---but don't redisplay it now. */
10271 truncate_echo_area (ptrdiff_t nchars
)
10274 echo_area_buffer
[0] = Qnil
;
10275 /* A null message buffer means that the frame hasn't really been
10276 initialized yet. Error messages get reported properly by
10277 cmd_error, so this must be just an informative message; toss it. */
10278 else if (!noninteractive
10280 && !NILP (echo_area_buffer
[0]))
10282 struct frame
*sf
= SELECTED_FRAME ();
10283 if (FRAME_MESSAGE_BUF (sf
))
10284 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10289 /* Helper function for truncate_echo_area. Truncate the current
10290 message to at most NCHARS characters. */
10293 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10295 if (BEG
+ nchars
< Z
)
10296 del_range (BEG
+ nchars
, Z
);
10298 echo_area_buffer
[0] = Qnil
;
10303 /* Set the current message to a substring of S or STRING.
10305 If STRING is a Lisp string, set the message to the first NBYTES
10306 bytes from STRING. NBYTES zero means use the whole string. If
10307 STRING is multibyte, the message will be displayed multibyte.
10309 If S is not null, set the message to the first LEN bytes of S. LEN
10310 zero means use the whole string. MULTIBYTE_P non-zero means S is
10311 multibyte. Display the message multibyte in that case.
10313 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10314 to t before calling set_message_1 (which calls insert).
10318 set_message (const char *s
, Lisp_Object string
,
10319 ptrdiff_t nbytes
, int multibyte_p
)
10321 message_enable_multibyte
10322 = ((s
&& multibyte_p
)
10323 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10325 with_echo_area_buffer (0, -1, set_message_1
,
10326 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10327 message_buf_print
= 0;
10328 help_echo_showing_p
= 0;
10332 /* Helper function for set_message. Arguments have the same meaning
10333 as there, with A1 corresponding to S and A2 corresponding to STRING
10334 This function is called with the echo area buffer being
10338 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10341 const char *s
= (const char *) i1
;
10342 const unsigned char *msg
= (const unsigned char *) s
;
10343 Lisp_Object string
= a2
;
10345 /* Change multibyteness of the echo buffer appropriately. */
10346 if (message_enable_multibyte
10347 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10348 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10350 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10351 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10352 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10354 /* Insert new message at BEG. */
10355 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10357 if (STRINGP (string
))
10362 nbytes
= SBYTES (string
);
10363 nchars
= string_byte_to_char (string
, nbytes
);
10365 /* This function takes care of single/multibyte conversion. We
10366 just have to ensure that the echo area buffer has the right
10367 setting of enable_multibyte_characters. */
10368 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10373 nbytes
= strlen (s
);
10375 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10377 /* Convert from multi-byte to single-byte. */
10382 /* Convert a multibyte string to single-byte. */
10383 for (i
= 0; i
< nbytes
; i
+= n
)
10385 c
= string_char_and_length (msg
+ i
, &n
);
10386 work
[0] = (ASCII_CHAR_P (c
)
10388 : multibyte_char_to_unibyte (c
));
10389 insert_1_both (work
, 1, 1, 1, 0, 0);
10392 else if (!multibyte_p
10393 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10395 /* Convert from single-byte to multi-byte. */
10398 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10400 /* Convert a single-byte string to multibyte. */
10401 for (i
= 0; i
< nbytes
; i
++)
10404 MAKE_CHAR_MULTIBYTE (c
);
10405 n
= CHAR_STRING (c
, str
);
10406 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10410 insert_1 (s
, nbytes
, 1, 0, 0);
10417 /* Clear messages. CURRENT_P non-zero means clear the current
10418 message. LAST_DISPLAYED_P non-zero means clear the message
10422 clear_message (int current_p
, int last_displayed_p
)
10426 echo_area_buffer
[0] = Qnil
;
10427 message_cleared_p
= 1;
10430 if (last_displayed_p
)
10431 echo_area_buffer
[1] = Qnil
;
10433 message_buf_print
= 0;
10436 /* Clear garbaged frames.
10438 This function is used where the old redisplay called
10439 redraw_garbaged_frames which in turn called redraw_frame which in
10440 turn called clear_frame. The call to clear_frame was a source of
10441 flickering. I believe a clear_frame is not necessary. It should
10442 suffice in the new redisplay to invalidate all current matrices,
10443 and ensure a complete redisplay of all windows. */
10446 clear_garbaged_frames (void)
10448 if (frame_garbaged
)
10450 Lisp_Object tail
, frame
;
10451 int changed_count
= 0;
10453 FOR_EACH_FRAME (tail
, frame
)
10455 struct frame
*f
= XFRAME (frame
);
10457 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10461 Fredraw_frame (frame
);
10462 f
->force_flush_display_p
= 1;
10464 clear_current_matrices (f
);
10471 frame_garbaged
= 0;
10473 ++windows_or_buffers_changed
;
10478 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10479 is non-zero update selected_frame. Value is non-zero if the
10480 mini-windows height has been changed. */
10483 echo_area_display (int update_frame_p
)
10485 Lisp_Object mini_window
;
10488 int window_height_changed_p
= 0;
10489 struct frame
*sf
= SELECTED_FRAME ();
10491 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10492 w
= XWINDOW (mini_window
);
10493 f
= XFRAME (WINDOW_FRAME (w
));
10495 /* Don't display if frame is invisible or not yet initialized. */
10496 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10499 #ifdef HAVE_WINDOW_SYSTEM
10500 /* When Emacs starts, selected_frame may be the initial terminal
10501 frame. If we let this through, a message would be displayed on
10503 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10505 #endif /* HAVE_WINDOW_SYSTEM */
10507 /* Redraw garbaged frames. */
10508 if (frame_garbaged
)
10509 clear_garbaged_frames ();
10511 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10513 echo_area_window
= mini_window
;
10514 window_height_changed_p
= display_echo_area (w
);
10515 w
->must_be_updated_p
= 1;
10517 /* Update the display, unless called from redisplay_internal.
10518 Also don't update the screen during redisplay itself. The
10519 update will happen at the end of redisplay, and an update
10520 here could cause confusion. */
10521 if (update_frame_p
&& !redisplaying_p
)
10525 /* If the display update has been interrupted by pending
10526 input, update mode lines in the frame. Due to the
10527 pending input, it might have been that redisplay hasn't
10528 been called, so that mode lines above the echo area are
10529 garbaged. This looks odd, so we prevent it here. */
10530 if (!display_completed
)
10531 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10533 if (window_height_changed_p
10534 /* Don't do this if Emacs is shutting down. Redisplay
10535 needs to run hooks. */
10536 && !NILP (Vrun_hooks
))
10538 /* Must update other windows. Likewise as in other
10539 cases, don't let this update be interrupted by
10541 ptrdiff_t count
= SPECPDL_INDEX ();
10542 specbind (Qredisplay_dont_pause
, Qt
);
10543 windows_or_buffers_changed
= 1;
10544 redisplay_internal ();
10545 unbind_to (count
, Qnil
);
10547 else if (FRAME_WINDOW_P (f
) && n
== 0)
10549 /* Window configuration is the same as before.
10550 Can do with a display update of the echo area,
10551 unless we displayed some mode lines. */
10552 update_single_window (w
, 1);
10553 FRAME_RIF (f
)->flush_display (f
);
10556 update_frame (f
, 1, 1);
10558 /* If cursor is in the echo area, make sure that the next
10559 redisplay displays the minibuffer, so that the cursor will
10560 be replaced with what the minibuffer wants. */
10561 if (cursor_in_echo_area
)
10562 ++windows_or_buffers_changed
;
10565 else if (!EQ (mini_window
, selected_window
))
10566 windows_or_buffers_changed
++;
10568 /* Last displayed message is now the current message. */
10569 echo_area_buffer
[1] = echo_area_buffer
[0];
10570 /* Inform read_char that we're not echoing. */
10571 echo_message_buffer
= Qnil
;
10573 /* Prevent redisplay optimization in redisplay_internal by resetting
10574 this_line_start_pos. This is done because the mini-buffer now
10575 displays the message instead of its buffer text. */
10576 if (EQ (mini_window
, selected_window
))
10577 CHARPOS (this_line_start_pos
) = 0;
10579 return window_height_changed_p
;
10584 /***********************************************************************
10585 Mode Lines and Frame Titles
10586 ***********************************************************************/
10588 /* A buffer for constructing non-propertized mode-line strings and
10589 frame titles in it; allocated from the heap in init_xdisp and
10590 resized as needed in store_mode_line_noprop_char. */
10592 static char *mode_line_noprop_buf
;
10594 /* The buffer's end, and a current output position in it. */
10596 static char *mode_line_noprop_buf_end
;
10597 static char *mode_line_noprop_ptr
;
10599 #define MODE_LINE_NOPROP_LEN(start) \
10600 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10603 MODE_LINE_DISPLAY
= 0,
10607 } mode_line_target
;
10609 /* Alist that caches the results of :propertize.
10610 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10611 static Lisp_Object mode_line_proptrans_alist
;
10613 /* List of strings making up the mode-line. */
10614 static Lisp_Object mode_line_string_list
;
10616 /* Base face property when building propertized mode line string. */
10617 static Lisp_Object mode_line_string_face
;
10618 static Lisp_Object mode_line_string_face_prop
;
10621 /* Unwind data for mode line strings */
10623 static Lisp_Object Vmode_line_unwind_vector
;
10626 format_mode_line_unwind_data (struct buffer
*obuf
,
10628 int save_proptrans
)
10630 Lisp_Object vector
, tmp
;
10632 /* Reduce consing by keeping one vector in
10633 Vwith_echo_area_save_vector. */
10634 vector
= Vmode_line_unwind_vector
;
10635 Vmode_line_unwind_vector
= Qnil
;
10638 vector
= Fmake_vector (make_number (8), Qnil
);
10640 ASET (vector
, 0, make_number (mode_line_target
));
10641 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10642 ASET (vector
, 2, mode_line_string_list
);
10643 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10644 ASET (vector
, 4, mode_line_string_face
);
10645 ASET (vector
, 5, mode_line_string_face_prop
);
10648 XSETBUFFER (tmp
, obuf
);
10651 ASET (vector
, 6, tmp
);
10652 ASET (vector
, 7, owin
);
10658 unwind_format_mode_line (Lisp_Object vector
)
10660 mode_line_target
= XINT (AREF (vector
, 0));
10661 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10662 mode_line_string_list
= AREF (vector
, 2);
10663 if (! EQ (AREF (vector
, 3), Qt
))
10664 mode_line_proptrans_alist
= AREF (vector
, 3);
10665 mode_line_string_face
= AREF (vector
, 4);
10666 mode_line_string_face_prop
= AREF (vector
, 5);
10668 if (!NILP (AREF (vector
, 7)))
10669 /* Select window before buffer, since it may change the buffer. */
10670 Fselect_window (AREF (vector
, 7), Qt
);
10672 if (!NILP (AREF (vector
, 6)))
10674 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10675 ASET (vector
, 6, Qnil
);
10678 Vmode_line_unwind_vector
= vector
;
10683 /* Store a single character C for the frame title in mode_line_noprop_buf.
10684 Re-allocate mode_line_noprop_buf if necessary. */
10687 store_mode_line_noprop_char (char c
)
10689 /* If output position has reached the end of the allocated buffer,
10690 increase the buffer's size. */
10691 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10693 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10694 ptrdiff_t size
= len
;
10695 mode_line_noprop_buf
=
10696 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10697 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10698 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10701 *mode_line_noprop_ptr
++ = c
;
10705 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10706 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10707 characters that yield more columns than PRECISION; PRECISION <= 0
10708 means copy the whole string. Pad with spaces until FIELD_WIDTH
10709 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10710 pad. Called from display_mode_element when it is used to build a
10714 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10716 const unsigned char *str
= (const unsigned char *) string
;
10718 ptrdiff_t dummy
, nbytes
;
10720 /* Copy at most PRECISION chars from STR. */
10721 nbytes
= strlen (string
);
10722 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10724 store_mode_line_noprop_char (*str
++);
10726 /* Fill up with spaces until FIELD_WIDTH reached. */
10727 while (field_width
> 0
10728 && n
< field_width
)
10730 store_mode_line_noprop_char (' ');
10737 /***********************************************************************
10739 ***********************************************************************/
10741 #ifdef HAVE_WINDOW_SYSTEM
10743 /* Set the title of FRAME, if it has changed. The title format is
10744 Vicon_title_format if FRAME is iconified, otherwise it is
10745 frame_title_format. */
10748 x_consider_frame_title (Lisp_Object frame
)
10750 struct frame
*f
= XFRAME (frame
);
10752 if (FRAME_WINDOW_P (f
)
10753 || FRAME_MINIBUF_ONLY_P (f
)
10754 || f
->explicit_name
)
10756 /* Do we have more than one visible frame on this X display? */
10759 ptrdiff_t title_start
;
10763 ptrdiff_t count
= SPECPDL_INDEX ();
10765 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10767 Lisp_Object other_frame
= XCAR (tail
);
10768 struct frame
*tf
= XFRAME (other_frame
);
10771 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10772 && !FRAME_MINIBUF_ONLY_P (tf
)
10773 && !EQ (other_frame
, tip_frame
)
10774 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10778 /* Set global variable indicating that multiple frames exist. */
10779 multiple_frames
= CONSP (tail
);
10781 /* Switch to the buffer of selected window of the frame. Set up
10782 mode_line_target so that display_mode_element will output into
10783 mode_line_noprop_buf; then display the title. */
10784 record_unwind_protect (unwind_format_mode_line
,
10785 format_mode_line_unwind_data
10786 (current_buffer
, selected_window
, 0));
10788 Fselect_window (f
->selected_window
, Qt
);
10789 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10790 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10792 mode_line_target
= MODE_LINE_TITLE
;
10793 title_start
= MODE_LINE_NOPROP_LEN (0);
10794 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10795 NULL
, DEFAULT_FACE_ID
);
10796 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10797 len
= MODE_LINE_NOPROP_LEN (title_start
);
10798 title
= mode_line_noprop_buf
+ title_start
;
10799 unbind_to (count
, Qnil
);
10801 /* Set the title only if it's changed. This avoids consing in
10802 the common case where it hasn't. (If it turns out that we've
10803 already wasted too much time by walking through the list with
10804 display_mode_element, then we might need to optimize at a
10805 higher level than this.) */
10806 if (! STRINGP (f
->name
)
10807 || SBYTES (f
->name
) != len
10808 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10809 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10813 #endif /* not HAVE_WINDOW_SYSTEM */
10818 /***********************************************************************
10820 ***********************************************************************/
10823 /* Prepare for redisplay by updating menu-bar item lists when
10824 appropriate. This can call eval. */
10827 prepare_menu_bars (void)
10830 struct gcpro gcpro1
, gcpro2
;
10832 Lisp_Object tooltip_frame
;
10834 #ifdef HAVE_WINDOW_SYSTEM
10835 tooltip_frame
= tip_frame
;
10837 tooltip_frame
= Qnil
;
10840 /* Update all frame titles based on their buffer names, etc. We do
10841 this before the menu bars so that the buffer-menu will show the
10842 up-to-date frame titles. */
10843 #ifdef HAVE_WINDOW_SYSTEM
10844 if (windows_or_buffers_changed
|| update_mode_lines
)
10846 Lisp_Object tail
, frame
;
10848 FOR_EACH_FRAME (tail
, frame
)
10850 f
= XFRAME (frame
);
10851 if (!EQ (frame
, tooltip_frame
)
10852 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10853 x_consider_frame_title (frame
);
10856 #endif /* HAVE_WINDOW_SYSTEM */
10858 /* Update the menu bar item lists, if appropriate. This has to be
10859 done before any actual redisplay or generation of display lines. */
10860 all_windows
= (update_mode_lines
10861 || buffer_shared
> 1
10862 || windows_or_buffers_changed
);
10865 Lisp_Object tail
, frame
;
10866 ptrdiff_t count
= SPECPDL_INDEX ();
10867 /* 1 means that update_menu_bar has run its hooks
10868 so any further calls to update_menu_bar shouldn't do so again. */
10869 int menu_bar_hooks_run
= 0;
10871 record_unwind_save_match_data ();
10873 FOR_EACH_FRAME (tail
, frame
)
10875 f
= XFRAME (frame
);
10877 /* Ignore tooltip frame. */
10878 if (EQ (frame
, tooltip_frame
))
10881 /* If a window on this frame changed size, report that to
10882 the user and clear the size-change flag. */
10883 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10885 Lisp_Object functions
;
10887 /* Clear flag first in case we get an error below. */
10888 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10889 functions
= Vwindow_size_change_functions
;
10890 GCPRO2 (tail
, functions
);
10892 while (CONSP (functions
))
10894 if (!EQ (XCAR (functions
), Qt
))
10895 call1 (XCAR (functions
), frame
);
10896 functions
= XCDR (functions
);
10902 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10903 #ifdef HAVE_WINDOW_SYSTEM
10904 update_tool_bar (f
, 0);
10907 if (windows_or_buffers_changed
10909 ns_set_doc_edited (f
, Fbuffer_modified_p
10910 (XWINDOW (f
->selected_window
)->buffer
));
10915 unbind_to (count
, Qnil
);
10919 struct frame
*sf
= SELECTED_FRAME ();
10920 update_menu_bar (sf
, 1, 0);
10921 #ifdef HAVE_WINDOW_SYSTEM
10922 update_tool_bar (sf
, 1);
10928 /* Update the menu bar item list for frame F. This has to be done
10929 before we start to fill in any display lines, because it can call
10932 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10934 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10935 already ran the menu bar hooks for this redisplay, so there
10936 is no need to run them again. The return value is the
10937 updated value of this flag, to pass to the next call. */
10940 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10942 Lisp_Object window
;
10943 register struct window
*w
;
10945 /* If called recursively during a menu update, do nothing. This can
10946 happen when, for instance, an activate-menubar-hook causes a
10948 if (inhibit_menubar_update
)
10951 window
= FRAME_SELECTED_WINDOW (f
);
10952 w
= XWINDOW (window
);
10954 if (FRAME_WINDOW_P (f
)
10956 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10957 || defined (HAVE_NS) || defined (USE_GTK)
10958 FRAME_EXTERNAL_MENU_BAR (f
)
10960 FRAME_MENU_BAR_LINES (f
) > 0
10962 : FRAME_MENU_BAR_LINES (f
) > 0)
10964 /* If the user has switched buffers or windows, we need to
10965 recompute to reflect the new bindings. But we'll
10966 recompute when update_mode_lines is set too; that means
10967 that people can use force-mode-line-update to request
10968 that the menu bar be recomputed. The adverse effect on
10969 the rest of the redisplay algorithm is about the same as
10970 windows_or_buffers_changed anyway. */
10971 if (windows_or_buffers_changed
10972 /* This used to test w->update_mode_line, but we believe
10973 there is no need to recompute the menu in that case. */
10974 || update_mode_lines
10975 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10976 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10977 != !NILP (w
->last_had_star
))
10978 || ((!NILP (Vtransient_mark_mode
)
10979 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10980 != !NILP (w
->region_showing
)))
10982 struct buffer
*prev
= current_buffer
;
10983 ptrdiff_t count
= SPECPDL_INDEX ();
10985 specbind (Qinhibit_menubar_update
, Qt
);
10987 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10988 if (save_match_data
)
10989 record_unwind_save_match_data ();
10990 if (NILP (Voverriding_local_map_menu_flag
))
10992 specbind (Qoverriding_terminal_local_map
, Qnil
);
10993 specbind (Qoverriding_local_map
, Qnil
);
10998 /* Run the Lucid hook. */
10999 safe_run_hooks (Qactivate_menubar_hook
);
11001 /* If it has changed current-menubar from previous value,
11002 really recompute the menu-bar from the value. */
11003 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11004 call0 (Qrecompute_lucid_menubar
);
11006 safe_run_hooks (Qmenu_bar_update_hook
);
11011 XSETFRAME (Vmenu_updating_frame
, f
);
11012 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11014 /* Redisplay the menu bar in case we changed it. */
11015 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11016 || defined (HAVE_NS) || defined (USE_GTK)
11017 if (FRAME_WINDOW_P (f
))
11019 #if defined (HAVE_NS)
11020 /* All frames on Mac OS share the same menubar. So only
11021 the selected frame should be allowed to set it. */
11022 if (f
== SELECTED_FRAME ())
11024 set_frame_menubar (f
, 0, 0);
11027 /* On a terminal screen, the menu bar is an ordinary screen
11028 line, and this makes it get updated. */
11029 w
->update_mode_line
= Qt
;
11030 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11031 /* In the non-toolkit version, the menu bar is an ordinary screen
11032 line, and this makes it get updated. */
11033 w
->update_mode_line
= Qt
;
11034 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11036 unbind_to (count
, Qnil
);
11037 set_buffer_internal_1 (prev
);
11046 /***********************************************************************
11048 ***********************************************************************/
11050 #ifdef HAVE_WINDOW_SYSTEM
11053 Nominal cursor position -- where to draw output.
11054 HPOS and VPOS are window relative glyph matrix coordinates.
11055 X and Y are window relative pixel coordinates. */
11057 struct cursor_pos output_cursor
;
11061 Set the global variable output_cursor to CURSOR. All cursor
11062 positions are relative to updated_window. */
11065 set_output_cursor (struct cursor_pos
*cursor
)
11067 output_cursor
.hpos
= cursor
->hpos
;
11068 output_cursor
.vpos
= cursor
->vpos
;
11069 output_cursor
.x
= cursor
->x
;
11070 output_cursor
.y
= cursor
->y
;
11075 Set a nominal cursor position.
11077 HPOS and VPOS are column/row positions in a window glyph matrix. X
11078 and Y are window text area relative pixel positions.
11080 If this is done during an update, updated_window will contain the
11081 window that is being updated and the position is the future output
11082 cursor position for that window. If updated_window is null, use
11083 selected_window and display the cursor at the given position. */
11086 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11090 /* If updated_window is not set, work on selected_window. */
11091 if (updated_window
)
11092 w
= updated_window
;
11094 w
= XWINDOW (selected_window
);
11096 /* Set the output cursor. */
11097 output_cursor
.hpos
= hpos
;
11098 output_cursor
.vpos
= vpos
;
11099 output_cursor
.x
= x
;
11100 output_cursor
.y
= y
;
11102 /* If not called as part of an update, really display the cursor.
11103 This will also set the cursor position of W. */
11104 if (updated_window
== NULL
)
11107 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11108 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11109 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11114 #endif /* HAVE_WINDOW_SYSTEM */
11117 /***********************************************************************
11119 ***********************************************************************/
11121 #ifdef HAVE_WINDOW_SYSTEM
11123 /* Where the mouse was last time we reported a mouse event. */
11125 FRAME_PTR last_mouse_frame
;
11127 /* Tool-bar item index of the item on which a mouse button was pressed
11130 int last_tool_bar_item
;
11134 update_tool_bar_unwind (Lisp_Object frame
)
11136 selected_frame
= frame
;
11140 /* Update the tool-bar item list for frame F. This has to be done
11141 before we start to fill in any display lines. Called from
11142 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11143 and restore it here. */
11146 update_tool_bar (struct frame
*f
, int save_match_data
)
11148 #if defined (USE_GTK) || defined (HAVE_NS)
11149 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11151 int do_update
= WINDOWP (f
->tool_bar_window
)
11152 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11157 Lisp_Object window
;
11160 window
= FRAME_SELECTED_WINDOW (f
);
11161 w
= XWINDOW (window
);
11163 /* If the user has switched buffers or windows, we need to
11164 recompute to reflect the new bindings. But we'll
11165 recompute when update_mode_lines is set too; that means
11166 that people can use force-mode-line-update to request
11167 that the menu bar be recomputed. The adverse effect on
11168 the rest of the redisplay algorithm is about the same as
11169 windows_or_buffers_changed anyway. */
11170 if (windows_or_buffers_changed
11171 || !NILP (w
->update_mode_line
)
11172 || update_mode_lines
11173 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11174 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11175 != !NILP (w
->last_had_star
))
11176 || ((!NILP (Vtransient_mark_mode
)
11177 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11178 != !NILP (w
->region_showing
)))
11180 struct buffer
*prev
= current_buffer
;
11181 ptrdiff_t count
= SPECPDL_INDEX ();
11182 Lisp_Object frame
, new_tool_bar
;
11183 int new_n_tool_bar
;
11184 struct gcpro gcpro1
;
11186 /* Set current_buffer to the buffer of the selected
11187 window of the frame, so that we get the right local
11189 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11191 /* Save match data, if we must. */
11192 if (save_match_data
)
11193 record_unwind_save_match_data ();
11195 /* Make sure that we don't accidentally use bogus keymaps. */
11196 if (NILP (Voverriding_local_map_menu_flag
))
11198 specbind (Qoverriding_terminal_local_map
, Qnil
);
11199 specbind (Qoverriding_local_map
, Qnil
);
11202 GCPRO1 (new_tool_bar
);
11204 /* We must temporarily set the selected frame to this frame
11205 before calling tool_bar_items, because the calculation of
11206 the tool-bar keymap uses the selected frame (see
11207 `tool-bar-make-keymap' in tool-bar.el). */
11208 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11209 XSETFRAME (frame
, f
);
11210 selected_frame
= frame
;
11212 /* Build desired tool-bar items from keymaps. */
11213 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11216 /* Redisplay the tool-bar if we changed it. */
11217 if (new_n_tool_bar
!= f
->n_tool_bar_items
11218 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11220 /* Redisplay that happens asynchronously due to an expose event
11221 may access f->tool_bar_items. Make sure we update both
11222 variables within BLOCK_INPUT so no such event interrupts. */
11224 f
->tool_bar_items
= new_tool_bar
;
11225 f
->n_tool_bar_items
= new_n_tool_bar
;
11226 w
->update_mode_line
= Qt
;
11232 unbind_to (count
, Qnil
);
11233 set_buffer_internal_1 (prev
);
11239 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11240 F's desired tool-bar contents. F->tool_bar_items must have
11241 been set up previously by calling prepare_menu_bars. */
11244 build_desired_tool_bar_string (struct frame
*f
)
11246 int i
, size
, size_needed
;
11247 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11248 Lisp_Object image
, plist
, props
;
11250 image
= plist
= props
= Qnil
;
11251 GCPRO3 (image
, plist
, props
);
11253 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11254 Otherwise, make a new string. */
11256 /* The size of the string we might be able to reuse. */
11257 size
= (STRINGP (f
->desired_tool_bar_string
)
11258 ? SCHARS (f
->desired_tool_bar_string
)
11261 /* We need one space in the string for each image. */
11262 size_needed
= f
->n_tool_bar_items
;
11264 /* Reuse f->desired_tool_bar_string, if possible. */
11265 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11266 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11267 make_number (' '));
11270 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11271 Fremove_text_properties (make_number (0), make_number (size
),
11272 props
, f
->desired_tool_bar_string
);
11275 /* Put a `display' property on the string for the images to display,
11276 put a `menu_item' property on tool-bar items with a value that
11277 is the index of the item in F's tool-bar item vector. */
11278 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11280 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11282 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11283 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11284 int hmargin
, vmargin
, relief
, idx
, end
;
11286 /* If image is a vector, choose the image according to the
11288 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11289 if (VECTORP (image
))
11293 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11294 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11297 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11298 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11300 xassert (ASIZE (image
) >= idx
);
11301 image
= AREF (image
, idx
);
11306 /* Ignore invalid image specifications. */
11307 if (!valid_image_p (image
))
11310 /* Display the tool-bar button pressed, or depressed. */
11311 plist
= Fcopy_sequence (XCDR (image
));
11313 /* Compute margin and relief to draw. */
11314 relief
= (tool_bar_button_relief
>= 0
11315 ? tool_bar_button_relief
11316 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11317 hmargin
= vmargin
= relief
;
11319 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11320 INT_MAX
- max (hmargin
, vmargin
)))
11322 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11323 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11325 else if (CONSP (Vtool_bar_button_margin
))
11327 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11328 INT_MAX
- hmargin
))
11329 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11331 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11332 INT_MAX
- vmargin
))
11333 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11336 if (auto_raise_tool_bar_buttons_p
)
11338 /* Add a `:relief' property to the image spec if the item is
11342 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11349 /* If image is selected, display it pressed, i.e. with a
11350 negative relief. If it's not selected, display it with a
11352 plist
= Fplist_put (plist
, QCrelief
,
11354 ? make_number (-relief
)
11355 : make_number (relief
)));
11360 /* Put a margin around the image. */
11361 if (hmargin
|| vmargin
)
11363 if (hmargin
== vmargin
)
11364 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11366 plist
= Fplist_put (plist
, QCmargin
,
11367 Fcons (make_number (hmargin
),
11368 make_number (vmargin
)));
11371 /* If button is not enabled, and we don't have special images
11372 for the disabled state, make the image appear disabled by
11373 applying an appropriate algorithm to it. */
11374 if (!enabled_p
&& idx
< 0)
11375 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11377 /* Put a `display' text property on the string for the image to
11378 display. Put a `menu-item' property on the string that gives
11379 the start of this item's properties in the tool-bar items
11381 image
= Fcons (Qimage
, plist
);
11382 props
= list4 (Qdisplay
, image
,
11383 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11385 /* Let the last image hide all remaining spaces in the tool bar
11386 string. The string can be longer than needed when we reuse a
11387 previous string. */
11388 if (i
+ 1 == f
->n_tool_bar_items
)
11389 end
= SCHARS (f
->desired_tool_bar_string
);
11392 Fadd_text_properties (make_number (i
), make_number (end
),
11393 props
, f
->desired_tool_bar_string
);
11401 /* Display one line of the tool-bar of frame IT->f.
11403 HEIGHT specifies the desired height of the tool-bar line.
11404 If the actual height of the glyph row is less than HEIGHT, the
11405 row's height is increased to HEIGHT, and the icons are centered
11406 vertically in the new height.
11408 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11409 count a final empty row in case the tool-bar width exactly matches
11414 display_tool_bar_line (struct it
*it
, int height
)
11416 struct glyph_row
*row
= it
->glyph_row
;
11417 int max_x
= it
->last_visible_x
;
11418 struct glyph
*last
;
11420 prepare_desired_row (row
);
11421 row
->y
= it
->current_y
;
11423 /* Note that this isn't made use of if the face hasn't a box,
11424 so there's no need to check the face here. */
11425 it
->start_of_box_run_p
= 1;
11427 while (it
->current_x
< max_x
)
11429 int x
, n_glyphs_before
, i
, nglyphs
;
11430 struct it it_before
;
11432 /* Get the next display element. */
11433 if (!get_next_display_element (it
))
11435 /* Don't count empty row if we are counting needed tool-bar lines. */
11436 if (height
< 0 && !it
->hpos
)
11441 /* Produce glyphs. */
11442 n_glyphs_before
= row
->used
[TEXT_AREA
];
11445 PRODUCE_GLYPHS (it
);
11447 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11449 x
= it_before
.current_x
;
11450 while (i
< nglyphs
)
11452 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11454 if (x
+ glyph
->pixel_width
> max_x
)
11456 /* Glyph doesn't fit on line. Backtrack. */
11457 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11459 /* If this is the only glyph on this line, it will never fit on the
11460 tool-bar, so skip it. But ensure there is at least one glyph,
11461 so we don't accidentally disable the tool-bar. */
11462 if (n_glyphs_before
== 0
11463 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11469 x
+= glyph
->pixel_width
;
11473 /* Stop at line end. */
11474 if (ITERATOR_AT_END_OF_LINE_P (it
))
11477 set_iterator_to_next (it
, 1);
11482 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11484 /* Use default face for the border below the tool bar.
11486 FIXME: When auto-resize-tool-bars is grow-only, there is
11487 no additional border below the possibly empty tool-bar lines.
11488 So to make the extra empty lines look "normal", we have to
11489 use the tool-bar face for the border too. */
11490 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11491 it
->face_id
= DEFAULT_FACE_ID
;
11493 extend_face_to_end_of_line (it
);
11494 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11495 last
->right_box_line_p
= 1;
11496 if (last
== row
->glyphs
[TEXT_AREA
])
11497 last
->left_box_line_p
= 1;
11499 /* Make line the desired height and center it vertically. */
11500 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11502 /* Don't add more than one line height. */
11503 height
%= FRAME_LINE_HEIGHT (it
->f
);
11504 it
->max_ascent
+= height
/ 2;
11505 it
->max_descent
+= (height
+ 1) / 2;
11508 compute_line_metrics (it
);
11510 /* If line is empty, make it occupy the rest of the tool-bar. */
11511 if (!row
->displays_text_p
)
11513 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11514 row
->visible_height
= row
->height
;
11515 row
->ascent
= row
->phys_ascent
= 0;
11516 row
->extra_line_spacing
= 0;
11519 row
->full_width_p
= 1;
11520 row
->continued_p
= 0;
11521 row
->truncated_on_left_p
= 0;
11522 row
->truncated_on_right_p
= 0;
11524 it
->current_x
= it
->hpos
= 0;
11525 it
->current_y
+= row
->height
;
11531 /* Max tool-bar height. */
11533 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11534 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11536 /* Value is the number of screen lines needed to make all tool-bar
11537 items of frame F visible. The number of actual rows needed is
11538 returned in *N_ROWS if non-NULL. */
11541 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11543 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11545 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11546 the desired matrix, so use (unused) mode-line row as temporary row to
11547 avoid destroying the first tool-bar row. */
11548 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11550 /* Initialize an iterator for iteration over
11551 F->desired_tool_bar_string in the tool-bar window of frame F. */
11552 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11553 it
.first_visible_x
= 0;
11554 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11555 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11556 it
.paragraph_embedding
= L2R
;
11558 while (!ITERATOR_AT_END_P (&it
))
11560 clear_glyph_row (temp_row
);
11561 it
.glyph_row
= temp_row
;
11562 display_tool_bar_line (&it
, -1);
11564 clear_glyph_row (temp_row
);
11566 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11568 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11570 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11574 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11576 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11577 (Lisp_Object frame
)
11584 frame
= selected_frame
;
11586 CHECK_FRAME (frame
);
11587 f
= XFRAME (frame
);
11589 if (WINDOWP (f
->tool_bar_window
)
11590 && (w
= XWINDOW (f
->tool_bar_window
),
11591 WINDOW_TOTAL_LINES (w
) > 0))
11593 update_tool_bar (f
, 1);
11594 if (f
->n_tool_bar_items
)
11596 build_desired_tool_bar_string (f
);
11597 nlines
= tool_bar_lines_needed (f
, NULL
);
11601 return make_number (nlines
);
11605 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11606 height should be changed. */
11609 redisplay_tool_bar (struct frame
*f
)
11613 struct glyph_row
*row
;
11615 #if defined (USE_GTK) || defined (HAVE_NS)
11616 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11617 update_frame_tool_bar (f
);
11621 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11622 do anything. This means you must start with tool-bar-lines
11623 non-zero to get the auto-sizing effect. Or in other words, you
11624 can turn off tool-bars by specifying tool-bar-lines zero. */
11625 if (!WINDOWP (f
->tool_bar_window
)
11626 || (w
= XWINDOW (f
->tool_bar_window
),
11627 WINDOW_TOTAL_LINES (w
) == 0))
11630 /* Set up an iterator for the tool-bar window. */
11631 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11632 it
.first_visible_x
= 0;
11633 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11634 row
= it
.glyph_row
;
11636 /* Build a string that represents the contents of the tool-bar. */
11637 build_desired_tool_bar_string (f
);
11638 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11639 /* FIXME: This should be controlled by a user option. But it
11640 doesn't make sense to have an R2L tool bar if the menu bar cannot
11641 be drawn also R2L, and making the menu bar R2L is tricky due
11642 toolkit-specific code that implements it. If an R2L tool bar is
11643 ever supported, display_tool_bar_line should also be augmented to
11644 call unproduce_glyphs like display_line and display_string
11646 it
.paragraph_embedding
= L2R
;
11648 if (f
->n_tool_bar_rows
== 0)
11652 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11653 nlines
!= WINDOW_TOTAL_LINES (w
)))
11656 int old_height
= WINDOW_TOTAL_LINES (w
);
11658 XSETFRAME (frame
, f
);
11659 Fmodify_frame_parameters (frame
,
11660 Fcons (Fcons (Qtool_bar_lines
,
11661 make_number (nlines
)),
11663 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11665 clear_glyph_matrix (w
->desired_matrix
);
11666 fonts_changed_p
= 1;
11672 /* Display as many lines as needed to display all tool-bar items. */
11674 if (f
->n_tool_bar_rows
> 0)
11676 int border
, rows
, height
, extra
;
11678 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11679 border
= XINT (Vtool_bar_border
);
11680 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11681 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11682 else if (EQ (Vtool_bar_border
, Qborder_width
))
11683 border
= f
->border_width
;
11689 rows
= f
->n_tool_bar_rows
;
11690 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11691 extra
= it
.last_visible_y
- border
- height
* rows
;
11693 while (it
.current_y
< it
.last_visible_y
)
11696 if (extra
> 0 && rows
-- > 0)
11698 h
= (extra
+ rows
- 1) / rows
;
11701 display_tool_bar_line (&it
, height
+ h
);
11706 while (it
.current_y
< it
.last_visible_y
)
11707 display_tool_bar_line (&it
, 0);
11710 /* It doesn't make much sense to try scrolling in the tool-bar
11711 window, so don't do it. */
11712 w
->desired_matrix
->no_scrolling_p
= 1;
11713 w
->must_be_updated_p
= 1;
11715 if (!NILP (Vauto_resize_tool_bars
))
11717 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11718 int change_height_p
= 0;
11720 /* If we couldn't display everything, change the tool-bar's
11721 height if there is room for more. */
11722 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11723 && it
.current_y
< max_tool_bar_height
)
11724 change_height_p
= 1;
11726 row
= it
.glyph_row
- 1;
11728 /* If there are blank lines at the end, except for a partially
11729 visible blank line at the end that is smaller than
11730 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11731 if (!row
->displays_text_p
11732 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11733 change_height_p
= 1;
11735 /* If row displays tool-bar items, but is partially visible,
11736 change the tool-bar's height. */
11737 if (row
->displays_text_p
11738 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11739 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11740 change_height_p
= 1;
11742 /* Resize windows as needed by changing the `tool-bar-lines'
11743 frame parameter. */
11744 if (change_height_p
)
11747 int old_height
= WINDOW_TOTAL_LINES (w
);
11749 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11751 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11752 && !f
->minimize_tool_bar_window_p
)
11753 ? (nlines
> old_height
)
11754 : (nlines
!= old_height
));
11755 f
->minimize_tool_bar_window_p
= 0;
11757 if (change_height_p
)
11759 XSETFRAME (frame
, f
);
11760 Fmodify_frame_parameters (frame
,
11761 Fcons (Fcons (Qtool_bar_lines
,
11762 make_number (nlines
)),
11764 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11766 clear_glyph_matrix (w
->desired_matrix
);
11767 f
->n_tool_bar_rows
= nrows
;
11768 fonts_changed_p
= 1;
11775 f
->minimize_tool_bar_window_p
= 0;
11780 /* Get information about the tool-bar item which is displayed in GLYPH
11781 on frame F. Return in *PROP_IDX the index where tool-bar item
11782 properties start in F->tool_bar_items. Value is zero if
11783 GLYPH doesn't display a tool-bar item. */
11786 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11792 /* This function can be called asynchronously, which means we must
11793 exclude any possibility that Fget_text_property signals an
11795 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11796 charpos
= max (0, charpos
);
11798 /* Get the text property `menu-item' at pos. The value of that
11799 property is the start index of this item's properties in
11800 F->tool_bar_items. */
11801 prop
= Fget_text_property (make_number (charpos
),
11802 Qmenu_item
, f
->current_tool_bar_string
);
11803 if (INTEGERP (prop
))
11805 *prop_idx
= XINT (prop
);
11815 /* Get information about the tool-bar item at position X/Y on frame F.
11816 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11817 the current matrix of the tool-bar window of F, or NULL if not
11818 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11819 item in F->tool_bar_items. Value is
11821 -1 if X/Y is not on a tool-bar item
11822 0 if X/Y is on the same item that was highlighted before.
11826 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11827 int *hpos
, int *vpos
, int *prop_idx
)
11829 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11830 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11833 /* Find the glyph under X/Y. */
11834 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11835 if (*glyph
== NULL
)
11838 /* Get the start of this tool-bar item's properties in
11839 f->tool_bar_items. */
11840 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11843 /* Is mouse on the highlighted item? */
11844 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11845 && *vpos
>= hlinfo
->mouse_face_beg_row
11846 && *vpos
<= hlinfo
->mouse_face_end_row
11847 && (*vpos
> hlinfo
->mouse_face_beg_row
11848 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11849 && (*vpos
< hlinfo
->mouse_face_end_row
11850 || *hpos
< hlinfo
->mouse_face_end_col
11851 || hlinfo
->mouse_face_past_end
))
11859 Handle mouse button event on the tool-bar of frame F, at
11860 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11861 0 for button release. MODIFIERS is event modifiers for button
11865 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11868 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11869 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11870 int hpos
, vpos
, prop_idx
;
11871 struct glyph
*glyph
;
11872 Lisp_Object enabled_p
;
11874 /* If not on the highlighted tool-bar item, return. */
11875 frame_to_window_pixel_xy (w
, &x
, &y
);
11876 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11879 /* If item is disabled, do nothing. */
11880 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11881 if (NILP (enabled_p
))
11886 /* Show item in pressed state. */
11887 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11888 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11889 last_tool_bar_item
= prop_idx
;
11893 Lisp_Object key
, frame
;
11894 struct input_event event
;
11895 EVENT_INIT (event
);
11897 /* Show item in released state. */
11898 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11899 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11901 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11903 XSETFRAME (frame
, f
);
11904 event
.kind
= TOOL_BAR_EVENT
;
11905 event
.frame_or_window
= frame
;
11907 kbd_buffer_store_event (&event
);
11909 event
.kind
= TOOL_BAR_EVENT
;
11910 event
.frame_or_window
= frame
;
11912 event
.modifiers
= modifiers
;
11913 kbd_buffer_store_event (&event
);
11914 last_tool_bar_item
= -1;
11919 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11920 tool-bar window-relative coordinates X/Y. Called from
11921 note_mouse_highlight. */
11924 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11926 Lisp_Object window
= f
->tool_bar_window
;
11927 struct window
*w
= XWINDOW (window
);
11928 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11929 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11931 struct glyph
*glyph
;
11932 struct glyph_row
*row
;
11934 Lisp_Object enabled_p
;
11936 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11937 int mouse_down_p
, rc
;
11939 /* Function note_mouse_highlight is called with negative X/Y
11940 values when mouse moves outside of the frame. */
11941 if (x
<= 0 || y
<= 0)
11943 clear_mouse_face (hlinfo
);
11947 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11950 /* Not on tool-bar item. */
11951 clear_mouse_face (hlinfo
);
11955 /* On same tool-bar item as before. */
11956 goto set_help_echo
;
11958 clear_mouse_face (hlinfo
);
11960 /* Mouse is down, but on different tool-bar item? */
11961 mouse_down_p
= (dpyinfo
->grabbed
11962 && f
== last_mouse_frame
11963 && FRAME_LIVE_P (f
));
11965 && last_tool_bar_item
!= prop_idx
)
11968 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11969 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11971 /* If tool-bar item is not enabled, don't highlight it. */
11972 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11973 if (!NILP (enabled_p
))
11975 /* Compute the x-position of the glyph. In front and past the
11976 image is a space. We include this in the highlighted area. */
11977 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11978 for (i
= x
= 0; i
< hpos
; ++i
)
11979 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11981 /* Record this as the current active region. */
11982 hlinfo
->mouse_face_beg_col
= hpos
;
11983 hlinfo
->mouse_face_beg_row
= vpos
;
11984 hlinfo
->mouse_face_beg_x
= x
;
11985 hlinfo
->mouse_face_beg_y
= row
->y
;
11986 hlinfo
->mouse_face_past_end
= 0;
11988 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11989 hlinfo
->mouse_face_end_row
= vpos
;
11990 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11991 hlinfo
->mouse_face_end_y
= row
->y
;
11992 hlinfo
->mouse_face_window
= window
;
11993 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11995 /* Display it as active. */
11996 show_mouse_face (hlinfo
, draw
);
11997 hlinfo
->mouse_face_image_state
= draw
;
12002 /* Set help_echo_string to a help string to display for this tool-bar item.
12003 XTread_socket does the rest. */
12004 help_echo_object
= help_echo_window
= Qnil
;
12005 help_echo_pos
= -1;
12006 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12007 if (NILP (help_echo_string
))
12008 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12011 #endif /* HAVE_WINDOW_SYSTEM */
12015 /************************************************************************
12016 Horizontal scrolling
12017 ************************************************************************/
12019 static int hscroll_window_tree (Lisp_Object
);
12020 static int hscroll_windows (Lisp_Object
);
12022 /* For all leaf windows in the window tree rooted at WINDOW, set their
12023 hscroll value so that PT is (i) visible in the window, and (ii) so
12024 that it is not within a certain margin at the window's left and
12025 right border. Value is non-zero if any window's hscroll has been
12029 hscroll_window_tree (Lisp_Object window
)
12031 int hscrolled_p
= 0;
12032 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12033 int hscroll_step_abs
= 0;
12034 double hscroll_step_rel
= 0;
12036 if (hscroll_relative_p
)
12038 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12039 if (hscroll_step_rel
< 0)
12041 hscroll_relative_p
= 0;
12042 hscroll_step_abs
= 0;
12045 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12047 hscroll_step_abs
= XINT (Vhscroll_step
);
12048 if (hscroll_step_abs
< 0)
12049 hscroll_step_abs
= 0;
12052 hscroll_step_abs
= 0;
12054 while (WINDOWP (window
))
12056 struct window
*w
= XWINDOW (window
);
12058 if (WINDOWP (w
->hchild
))
12059 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12060 else if (WINDOWP (w
->vchild
))
12061 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12062 else if (w
->cursor
.vpos
>= 0)
12065 int text_area_width
;
12066 struct glyph_row
*current_cursor_row
12067 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12068 struct glyph_row
*desired_cursor_row
12069 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12070 struct glyph_row
*cursor_row
12071 = (desired_cursor_row
->enabled_p
12072 ? desired_cursor_row
12073 : current_cursor_row
);
12074 int row_r2l_p
= cursor_row
->reversed_p
;
12076 text_area_width
= window_box_width (w
, TEXT_AREA
);
12078 /* Scroll when cursor is inside this scroll margin. */
12079 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12081 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12082 /* For left-to-right rows, hscroll when cursor is either
12083 (i) inside the right hscroll margin, or (ii) if it is
12084 inside the left margin and the window is already
12087 && ((XFASTINT (w
->hscroll
)
12088 && w
->cursor
.x
<= h_margin
)
12089 || (cursor_row
->enabled_p
12090 && cursor_row
->truncated_on_right_p
12091 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12092 /* For right-to-left rows, the logic is similar,
12093 except that rules for scrolling to left and right
12094 are reversed. E.g., if cursor.x <= h_margin, we
12095 need to hscroll "to the right" unconditionally,
12096 and that will scroll the screen to the left so as
12097 to reveal the next portion of the row. */
12099 && ((cursor_row
->enabled_p
12100 /* FIXME: It is confusing to set the
12101 truncated_on_right_p flag when R2L rows
12102 are actually truncated on the left. */
12103 && cursor_row
->truncated_on_right_p
12104 && w
->cursor
.x
<= h_margin
)
12105 || (XFASTINT (w
->hscroll
)
12106 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12110 struct buffer
*saved_current_buffer
;
12114 /* Find point in a display of infinite width. */
12115 saved_current_buffer
= current_buffer
;
12116 current_buffer
= XBUFFER (w
->buffer
);
12118 if (w
== XWINDOW (selected_window
))
12122 pt
= marker_position (w
->pointm
);
12123 pt
= max (BEGV
, pt
);
12127 /* Move iterator to pt starting at cursor_row->start in
12128 a line with infinite width. */
12129 init_to_row_start (&it
, w
, cursor_row
);
12130 it
.last_visible_x
= INFINITY
;
12131 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12132 current_buffer
= saved_current_buffer
;
12134 /* Position cursor in window. */
12135 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12136 hscroll
= max (0, (it
.current_x
12137 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12138 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12139 : (text_area_width
/ 2))))
12140 / FRAME_COLUMN_WIDTH (it
.f
);
12141 else if ((!row_r2l_p
12142 && w
->cursor
.x
>= text_area_width
- h_margin
)
12143 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12145 if (hscroll_relative_p
)
12146 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12149 wanted_x
= text_area_width
12150 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12153 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12157 if (hscroll_relative_p
)
12158 wanted_x
= text_area_width
* hscroll_step_rel
12161 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12164 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12166 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12168 /* Don't prevent redisplay optimizations if hscroll
12169 hasn't changed, as it will unnecessarily slow down
12171 if (XFASTINT (w
->hscroll
) != hscroll
)
12173 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12174 w
->hscroll
= make_number (hscroll
);
12183 /* Value is non-zero if hscroll of any leaf window has been changed. */
12184 return hscrolled_p
;
12188 /* Set hscroll so that cursor is visible and not inside horizontal
12189 scroll margins for all windows in the tree rooted at WINDOW. See
12190 also hscroll_window_tree above. Value is non-zero if any window's
12191 hscroll has been changed. If it has, desired matrices on the frame
12192 of WINDOW are cleared. */
12195 hscroll_windows (Lisp_Object window
)
12197 int hscrolled_p
= hscroll_window_tree (window
);
12199 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12200 return hscrolled_p
;
12205 /************************************************************************
12207 ************************************************************************/
12209 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12210 to a non-zero value. This is sometimes handy to have in a debugger
12215 /* First and last unchanged row for try_window_id. */
12217 static int debug_first_unchanged_at_end_vpos
;
12218 static int debug_last_unchanged_at_beg_vpos
;
12220 /* Delta vpos and y. */
12222 static int debug_dvpos
, debug_dy
;
12224 /* Delta in characters and bytes for try_window_id. */
12226 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12228 /* Values of window_end_pos and window_end_vpos at the end of
12231 static ptrdiff_t debug_end_vpos
;
12233 /* Append a string to W->desired_matrix->method. FMT is a printf
12234 format string. If trace_redisplay_p is non-zero also printf the
12235 resulting string to stderr. */
12237 static void debug_method_add (struct window
*, char const *, ...)
12238 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12241 debug_method_add (struct window
*w
, char const *fmt
, ...)
12244 char *method
= w
->desired_matrix
->method
;
12245 int len
= strlen (method
);
12246 int size
= sizeof w
->desired_matrix
->method
;
12247 int remaining
= size
- len
- 1;
12250 va_start (ap
, fmt
);
12251 vsprintf (buffer
, fmt
, ap
);
12253 if (len
&& remaining
)
12256 --remaining
, ++len
;
12259 strncpy (method
+ len
, buffer
, remaining
);
12261 if (trace_redisplay_p
)
12262 fprintf (stderr
, "%p (%s): %s\n",
12264 ((BUFFERP (w
->buffer
)
12265 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12266 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12271 #endif /* GLYPH_DEBUG */
12274 /* Value is non-zero if all changes in window W, which displays
12275 current_buffer, are in the text between START and END. START is a
12276 buffer position, END is given as a distance from Z. Used in
12277 redisplay_internal for display optimization. */
12280 text_outside_line_unchanged_p (struct window
*w
,
12281 ptrdiff_t start
, ptrdiff_t end
)
12283 int unchanged_p
= 1;
12285 /* If text or overlays have changed, see where. */
12286 if (XFASTINT (w
->last_modified
) < MODIFF
12287 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12289 /* Gap in the line? */
12290 if (GPT
< start
|| Z
- GPT
< end
)
12293 /* Changes start in front of the line, or end after it? */
12295 && (BEG_UNCHANGED
< start
- 1
12296 || END_UNCHANGED
< end
))
12299 /* If selective display, can't optimize if changes start at the
12300 beginning of the line. */
12302 && INTEGERP (BVAR (current_buffer
, selective_display
))
12303 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12304 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12307 /* If there are overlays at the start or end of the line, these
12308 may have overlay strings with newlines in them. A change at
12309 START, for instance, may actually concern the display of such
12310 overlay strings as well, and they are displayed on different
12311 lines. So, quickly rule out this case. (For the future, it
12312 might be desirable to implement something more telling than
12313 just BEG/END_UNCHANGED.) */
12316 if (BEG
+ BEG_UNCHANGED
== start
12317 && overlay_touches_p (start
))
12319 if (END_UNCHANGED
== end
12320 && overlay_touches_p (Z
- end
))
12324 /* Under bidi reordering, adding or deleting a character in the
12325 beginning of a paragraph, before the first strong directional
12326 character, can change the base direction of the paragraph (unless
12327 the buffer specifies a fixed paragraph direction), which will
12328 require to redisplay the whole paragraph. It might be worthwhile
12329 to find the paragraph limits and widen the range of redisplayed
12330 lines to that, but for now just give up this optimization. */
12331 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12332 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12336 return unchanged_p
;
12340 /* Do a frame update, taking possible shortcuts into account. This is
12341 the main external entry point for redisplay.
12343 If the last redisplay displayed an echo area message and that message
12344 is no longer requested, we clear the echo area or bring back the
12345 mini-buffer if that is in use. */
12350 redisplay_internal ();
12355 overlay_arrow_string_or_property (Lisp_Object var
)
12359 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12362 return Voverlay_arrow_string
;
12365 /* Return 1 if there are any overlay-arrows in current_buffer. */
12367 overlay_arrow_in_current_buffer_p (void)
12371 for (vlist
= Voverlay_arrow_variable_list
;
12373 vlist
= XCDR (vlist
))
12375 Lisp_Object var
= XCAR (vlist
);
12378 if (!SYMBOLP (var
))
12380 val
= find_symbol_value (var
);
12382 && current_buffer
== XMARKER (val
)->buffer
)
12389 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12393 overlay_arrows_changed_p (void)
12397 for (vlist
= Voverlay_arrow_variable_list
;
12399 vlist
= XCDR (vlist
))
12401 Lisp_Object var
= XCAR (vlist
);
12402 Lisp_Object val
, pstr
;
12404 if (!SYMBOLP (var
))
12406 val
= find_symbol_value (var
);
12407 if (!MARKERP (val
))
12409 if (! EQ (COERCE_MARKER (val
),
12410 Fget (var
, Qlast_arrow_position
))
12411 || ! (pstr
= overlay_arrow_string_or_property (var
),
12412 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12418 /* Mark overlay arrows to be updated on next redisplay. */
12421 update_overlay_arrows (int up_to_date
)
12425 for (vlist
= Voverlay_arrow_variable_list
;
12427 vlist
= XCDR (vlist
))
12429 Lisp_Object var
= XCAR (vlist
);
12431 if (!SYMBOLP (var
))
12434 if (up_to_date
> 0)
12436 Lisp_Object val
= find_symbol_value (var
);
12437 Fput (var
, Qlast_arrow_position
,
12438 COERCE_MARKER (val
));
12439 Fput (var
, Qlast_arrow_string
,
12440 overlay_arrow_string_or_property (var
));
12442 else if (up_to_date
< 0
12443 || !NILP (Fget (var
, Qlast_arrow_position
)))
12445 Fput (var
, Qlast_arrow_position
, Qt
);
12446 Fput (var
, Qlast_arrow_string
, Qt
);
12452 /* Return overlay arrow string to display at row.
12453 Return integer (bitmap number) for arrow bitmap in left fringe.
12454 Return nil if no overlay arrow. */
12457 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12461 for (vlist
= Voverlay_arrow_variable_list
;
12463 vlist
= XCDR (vlist
))
12465 Lisp_Object var
= XCAR (vlist
);
12468 if (!SYMBOLP (var
))
12471 val
= find_symbol_value (var
);
12474 && current_buffer
== XMARKER (val
)->buffer
12475 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12477 if (FRAME_WINDOW_P (it
->f
)
12478 /* FIXME: if ROW->reversed_p is set, this should test
12479 the right fringe, not the left one. */
12480 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12482 #ifdef HAVE_WINDOW_SYSTEM
12483 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12486 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12487 return make_number (fringe_bitmap
);
12490 return make_number (-1); /* Use default arrow bitmap */
12492 return overlay_arrow_string_or_property (var
);
12499 /* Return 1 if point moved out of or into a composition. Otherwise
12500 return 0. PREV_BUF and PREV_PT are the last point buffer and
12501 position. BUF and PT are the current point buffer and position. */
12504 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12505 struct buffer
*buf
, ptrdiff_t pt
)
12507 ptrdiff_t start
, end
;
12509 Lisp_Object buffer
;
12511 XSETBUFFER (buffer
, buf
);
12512 /* Check a composition at the last point if point moved within the
12514 if (prev_buf
== buf
)
12517 /* Point didn't move. */
12520 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12521 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12522 && COMPOSITION_VALID_P (start
, end
, prop
)
12523 && start
< prev_pt
&& end
> prev_pt
)
12524 /* The last point was within the composition. Return 1 iff
12525 point moved out of the composition. */
12526 return (pt
<= start
|| pt
>= end
);
12529 /* Check a composition at the current point. */
12530 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12531 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12532 && COMPOSITION_VALID_P (start
, end
, prop
)
12533 && start
< pt
&& end
> pt
);
12537 /* Reconsider the setting of B->clip_changed which is displayed
12541 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12543 if (b
->clip_changed
12544 && !NILP (w
->window_end_valid
)
12545 && w
->current_matrix
->buffer
== b
12546 && w
->current_matrix
->zv
== BUF_ZV (b
)
12547 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12548 b
->clip_changed
= 0;
12550 /* If display wasn't paused, and W is not a tool bar window, see if
12551 point has been moved into or out of a composition. In that case,
12552 we set b->clip_changed to 1 to force updating the screen. If
12553 b->clip_changed has already been set to 1, we can skip this
12555 if (!b
->clip_changed
12556 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12560 if (w
== XWINDOW (selected_window
))
12563 pt
= marker_position (w
->pointm
);
12565 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12566 || pt
!= XINT (w
->last_point
))
12567 && check_point_in_composition (w
->current_matrix
->buffer
,
12568 XINT (w
->last_point
),
12569 XBUFFER (w
->buffer
), pt
))
12570 b
->clip_changed
= 1;
12575 /* Select FRAME to forward the values of frame-local variables into C
12576 variables so that the redisplay routines can access those values
12580 select_frame_for_redisplay (Lisp_Object frame
)
12582 Lisp_Object tail
, tem
;
12583 Lisp_Object old
= selected_frame
;
12584 struct Lisp_Symbol
*sym
;
12586 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12588 selected_frame
= frame
;
12591 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12592 if (CONSP (XCAR (tail
))
12593 && (tem
= XCAR (XCAR (tail
)),
12595 && (sym
= indirect_variable (XSYMBOL (tem
)),
12596 sym
->redirect
== SYMBOL_LOCALIZED
)
12597 && sym
->val
.blv
->frame_local
)
12598 /* Use find_symbol_value rather than Fsymbol_value
12599 to avoid an error if it is void. */
12600 find_symbol_value (tem
);
12601 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12605 #define STOP_POLLING \
12606 do { if (! polling_stopped_here) stop_polling (); \
12607 polling_stopped_here = 1; } while (0)
12609 #define RESUME_POLLING \
12610 do { if (polling_stopped_here) start_polling (); \
12611 polling_stopped_here = 0; } while (0)
12614 /* Perhaps in the future avoid recentering windows if it
12615 is not necessary; currently that causes some problems. */
12618 redisplay_internal (void)
12620 struct window
*w
= XWINDOW (selected_window
);
12624 int must_finish
= 0;
12625 struct text_pos tlbufpos
, tlendpos
;
12626 int number_of_visible_frames
;
12627 ptrdiff_t count
, count1
;
12629 int polling_stopped_here
= 0;
12630 Lisp_Object old_frame
= selected_frame
;
12632 /* Non-zero means redisplay has to consider all windows on all
12633 frames. Zero means, only selected_window is considered. */
12634 int consider_all_windows_p
;
12636 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12638 /* No redisplay if running in batch mode or frame is not yet fully
12639 initialized, or redisplay is explicitly turned off by setting
12640 Vinhibit_redisplay. */
12641 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12642 || !NILP (Vinhibit_redisplay
))
12645 /* Don't examine these until after testing Vinhibit_redisplay.
12646 When Emacs is shutting down, perhaps because its connection to
12647 X has dropped, we should not look at them at all. */
12648 fr
= XFRAME (w
->frame
);
12649 sf
= SELECTED_FRAME ();
12651 if (!fr
->glyphs_initialized_p
)
12654 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12655 if (popup_activated ())
12659 /* I don't think this happens but let's be paranoid. */
12660 if (redisplaying_p
)
12663 /* Record a function that resets redisplaying_p to its old value
12664 when we leave this function. */
12665 count
= SPECPDL_INDEX ();
12666 record_unwind_protect (unwind_redisplay
,
12667 Fcons (make_number (redisplaying_p
), selected_frame
));
12669 specbind (Qinhibit_free_realized_faces
, Qnil
);
12672 Lisp_Object tail
, frame
;
12674 FOR_EACH_FRAME (tail
, frame
)
12676 struct frame
*f
= XFRAME (frame
);
12677 f
->already_hscrolled_p
= 0;
12682 /* Remember the currently selected window. */
12685 if (!EQ (old_frame
, selected_frame
)
12686 && FRAME_LIVE_P (XFRAME (old_frame
)))
12687 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12688 selected_frame and selected_window to be temporarily out-of-sync so
12689 when we come back here via `goto retry', we need to resync because we
12690 may need to run Elisp code (via prepare_menu_bars). */
12691 select_frame_for_redisplay (old_frame
);
12694 reconsider_clip_changes (w
, current_buffer
);
12695 last_escape_glyph_frame
= NULL
;
12696 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12697 last_glyphless_glyph_frame
= NULL
;
12698 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12700 /* If new fonts have been loaded that make a glyph matrix adjustment
12701 necessary, do it. */
12702 if (fonts_changed_p
)
12704 adjust_glyphs (NULL
);
12705 ++windows_or_buffers_changed
;
12706 fonts_changed_p
= 0;
12709 /* If face_change_count is non-zero, init_iterator will free all
12710 realized faces, which includes the faces referenced from current
12711 matrices. So, we can't reuse current matrices in this case. */
12712 if (face_change_count
)
12713 ++windows_or_buffers_changed
;
12715 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12716 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12718 /* Since frames on a single ASCII terminal share the same
12719 display area, displaying a different frame means redisplay
12720 the whole thing. */
12721 windows_or_buffers_changed
++;
12722 SET_FRAME_GARBAGED (sf
);
12724 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12726 FRAME_TTY (sf
)->previous_frame
= sf
;
12729 /* Set the visible flags for all frames. Do this before checking
12730 for resized or garbaged frames; they want to know if their frames
12731 are visible. See the comment in frame.h for
12732 FRAME_SAMPLE_VISIBILITY. */
12734 Lisp_Object tail
, frame
;
12736 number_of_visible_frames
= 0;
12738 FOR_EACH_FRAME (tail
, frame
)
12740 struct frame
*f
= XFRAME (frame
);
12742 FRAME_SAMPLE_VISIBILITY (f
);
12743 if (FRAME_VISIBLE_P (f
))
12744 ++number_of_visible_frames
;
12745 clear_desired_matrices (f
);
12749 /* Notice any pending interrupt request to change frame size. */
12750 do_pending_window_change (1);
12752 /* do_pending_window_change could change the selected_window due to
12753 frame resizing which makes the selected window too small. */
12754 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12757 reconsider_clip_changes (w
, current_buffer
);
12760 /* Clear frames marked as garbaged. */
12761 if (frame_garbaged
)
12762 clear_garbaged_frames ();
12764 /* Build menubar and tool-bar items. */
12765 if (NILP (Vmemory_full
))
12766 prepare_menu_bars ();
12768 if (windows_or_buffers_changed
)
12769 update_mode_lines
++;
12771 /* Detect case that we need to write or remove a star in the mode line. */
12772 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12774 w
->update_mode_line
= Qt
;
12775 if (buffer_shared
> 1)
12776 update_mode_lines
++;
12779 /* Avoid invocation of point motion hooks by `current_column' below. */
12780 count1
= SPECPDL_INDEX ();
12781 specbind (Qinhibit_point_motion_hooks
, Qt
);
12783 /* If %c is in the mode line, update it if needed. */
12784 if (!NILP (w
->column_number_displayed
)
12785 /* This alternative quickly identifies a common case
12786 where no change is needed. */
12787 && !(PT
== XFASTINT (w
->last_point
)
12788 && XFASTINT (w
->last_modified
) >= MODIFF
12789 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12790 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12791 w
->update_mode_line
= Qt
;
12793 unbind_to (count1
, Qnil
);
12795 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12797 /* The variable buffer_shared is set in redisplay_window and
12798 indicates that we redisplay a buffer in different windows. See
12800 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12801 || cursor_type_changed
);
12803 /* If specs for an arrow have changed, do thorough redisplay
12804 to ensure we remove any arrow that should no longer exist. */
12805 if (overlay_arrows_changed_p ())
12806 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12808 /* Normally the message* functions will have already displayed and
12809 updated the echo area, but the frame may have been trashed, or
12810 the update may have been preempted, so display the echo area
12811 again here. Checking message_cleared_p captures the case that
12812 the echo area should be cleared. */
12813 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12814 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12815 || (message_cleared_p
12816 && minibuf_level
== 0
12817 /* If the mini-window is currently selected, this means the
12818 echo-area doesn't show through. */
12819 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12821 int window_height_changed_p
= echo_area_display (0);
12824 /* If we don't display the current message, don't clear the
12825 message_cleared_p flag, because, if we did, we wouldn't clear
12826 the echo area in the next redisplay which doesn't preserve
12828 if (!display_last_displayed_message_p
)
12829 message_cleared_p
= 0;
12831 if (fonts_changed_p
)
12833 else if (window_height_changed_p
)
12835 consider_all_windows_p
= 1;
12836 ++update_mode_lines
;
12837 ++windows_or_buffers_changed
;
12839 /* If window configuration was changed, frames may have been
12840 marked garbaged. Clear them or we will experience
12841 surprises wrt scrolling. */
12842 if (frame_garbaged
)
12843 clear_garbaged_frames ();
12846 else if (EQ (selected_window
, minibuf_window
)
12847 && (current_buffer
->clip_changed
12848 || XFASTINT (w
->last_modified
) < MODIFF
12849 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12850 && resize_mini_window (w
, 0))
12852 /* Resized active mini-window to fit the size of what it is
12853 showing if its contents might have changed. */
12855 /* FIXME: this causes all frames to be updated, which seems unnecessary
12856 since only the current frame needs to be considered. This function needs
12857 to be rewritten with two variables, consider_all_windows and
12858 consider_all_frames. */
12859 consider_all_windows_p
= 1;
12860 ++windows_or_buffers_changed
;
12861 ++update_mode_lines
;
12863 /* If window configuration was changed, frames may have been
12864 marked garbaged. Clear them or we will experience
12865 surprises wrt scrolling. */
12866 if (frame_garbaged
)
12867 clear_garbaged_frames ();
12871 /* If showing the region, and mark has changed, we must redisplay
12872 the whole window. The assignment to this_line_start_pos prevents
12873 the optimization directly below this if-statement. */
12874 if (((!NILP (Vtransient_mark_mode
)
12875 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12876 != !NILP (w
->region_showing
))
12877 || (!NILP (w
->region_showing
)
12878 && !EQ (w
->region_showing
,
12879 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12880 CHARPOS (this_line_start_pos
) = 0;
12882 /* Optimize the case that only the line containing the cursor in the
12883 selected window has changed. Variables starting with this_ are
12884 set in display_line and record information about the line
12885 containing the cursor. */
12886 tlbufpos
= this_line_start_pos
;
12887 tlendpos
= this_line_end_pos
;
12888 if (!consider_all_windows_p
12889 && CHARPOS (tlbufpos
) > 0
12890 && NILP (w
->update_mode_line
)
12891 && !current_buffer
->clip_changed
12892 && !current_buffer
->prevent_redisplay_optimizations_p
12893 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12894 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12895 /* Make sure recorded data applies to current buffer, etc. */
12896 && this_line_buffer
== current_buffer
12897 && current_buffer
== XBUFFER (w
->buffer
)
12898 && NILP (w
->force_start
)
12899 && NILP (w
->optional_new_start
)
12900 /* Point must be on the line that we have info recorded about. */
12901 && PT
>= CHARPOS (tlbufpos
)
12902 && PT
<= Z
- CHARPOS (tlendpos
)
12903 /* All text outside that line, including its final newline,
12904 must be unchanged. */
12905 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12906 CHARPOS (tlendpos
)))
12908 if (CHARPOS (tlbufpos
) > BEGV
12909 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12910 && (CHARPOS (tlbufpos
) == ZV
12911 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12912 /* Former continuation line has disappeared by becoming empty. */
12914 else if (XFASTINT (w
->last_modified
) < MODIFF
12915 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12916 || MINI_WINDOW_P (w
))
12918 /* We have to handle the case of continuation around a
12919 wide-column character (see the comment in indent.c around
12922 For instance, in the following case:
12924 -------- Insert --------
12925 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12926 J_I_ ==> J_I_ `^^' are cursors.
12930 As we have to redraw the line above, we cannot use this
12934 int line_height_before
= this_line_pixel_height
;
12936 /* Note that start_display will handle the case that the
12937 line starting at tlbufpos is a continuation line. */
12938 start_display (&it
, w
, tlbufpos
);
12940 /* Implementation note: It this still necessary? */
12941 if (it
.current_x
!= this_line_start_x
)
12944 TRACE ((stderr
, "trying display optimization 1\n"));
12945 w
->cursor
.vpos
= -1;
12946 overlay_arrow_seen
= 0;
12947 it
.vpos
= this_line_vpos
;
12948 it
.current_y
= this_line_y
;
12949 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12950 display_line (&it
);
12952 /* If line contains point, is not continued,
12953 and ends at same distance from eob as before, we win. */
12954 if (w
->cursor
.vpos
>= 0
12955 /* Line is not continued, otherwise this_line_start_pos
12956 would have been set to 0 in display_line. */
12957 && CHARPOS (this_line_start_pos
)
12958 /* Line ends as before. */
12959 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12960 /* Line has same height as before. Otherwise other lines
12961 would have to be shifted up or down. */
12962 && this_line_pixel_height
== line_height_before
)
12964 /* If this is not the window's last line, we must adjust
12965 the charstarts of the lines below. */
12966 if (it
.current_y
< it
.last_visible_y
)
12968 struct glyph_row
*row
12969 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12970 ptrdiff_t delta
, delta_bytes
;
12972 /* We used to distinguish between two cases here,
12973 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12974 when the line ends in a newline or the end of the
12975 buffer's accessible portion. But both cases did
12976 the same, so they were collapsed. */
12978 - CHARPOS (tlendpos
)
12979 - MATRIX_ROW_START_CHARPOS (row
));
12980 delta_bytes
= (Z_BYTE
12981 - BYTEPOS (tlendpos
)
12982 - MATRIX_ROW_START_BYTEPOS (row
));
12984 increment_matrix_positions (w
->current_matrix
,
12985 this_line_vpos
+ 1,
12986 w
->current_matrix
->nrows
,
12987 delta
, delta_bytes
);
12990 /* If this row displays text now but previously didn't,
12991 or vice versa, w->window_end_vpos may have to be
12993 if ((it
.glyph_row
- 1)->displays_text_p
)
12995 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12996 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12998 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12999 && this_line_vpos
> 0)
13000 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13001 w
->window_end_valid
= Qnil
;
13003 /* Update hint: No need to try to scroll in update_window. */
13004 w
->desired_matrix
->no_scrolling_p
= 1;
13007 *w
->desired_matrix
->method
= 0;
13008 debug_method_add (w
, "optimization 1");
13010 #ifdef HAVE_WINDOW_SYSTEM
13011 update_window_fringes (w
, 0);
13018 else if (/* Cursor position hasn't changed. */
13019 PT
== XFASTINT (w
->last_point
)
13020 /* Make sure the cursor was last displayed
13021 in this window. Otherwise we have to reposition it. */
13022 && 0 <= w
->cursor
.vpos
13023 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13027 do_pending_window_change (1);
13028 /* If selected_window changed, redisplay again. */
13029 if (WINDOWP (selected_window
)
13030 && (w
= XWINDOW (selected_window
)) != sw
)
13033 /* We used to always goto end_of_redisplay here, but this
13034 isn't enough if we have a blinking cursor. */
13035 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13036 goto end_of_redisplay
;
13040 /* If highlighting the region, or if the cursor is in the echo area,
13041 then we can't just move the cursor. */
13042 else if (! (!NILP (Vtransient_mark_mode
)
13043 && !NILP (BVAR (current_buffer
, mark_active
)))
13044 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13045 || highlight_nonselected_windows
)
13046 && NILP (w
->region_showing
)
13047 && NILP (Vshow_trailing_whitespace
)
13048 && !cursor_in_echo_area
)
13051 struct glyph_row
*row
;
13053 /* Skip from tlbufpos to PT and see where it is. Note that
13054 PT may be in invisible text. If so, we will end at the
13055 next visible position. */
13056 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13057 NULL
, DEFAULT_FACE_ID
);
13058 it
.current_x
= this_line_start_x
;
13059 it
.current_y
= this_line_y
;
13060 it
.vpos
= this_line_vpos
;
13062 /* The call to move_it_to stops in front of PT, but
13063 moves over before-strings. */
13064 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13066 if (it
.vpos
== this_line_vpos
13067 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13070 xassert (this_line_vpos
== it
.vpos
);
13071 xassert (this_line_y
== it
.current_y
);
13072 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13074 *w
->desired_matrix
->method
= 0;
13075 debug_method_add (w
, "optimization 3");
13084 /* Text changed drastically or point moved off of line. */
13085 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13088 CHARPOS (this_line_start_pos
) = 0;
13089 consider_all_windows_p
|= buffer_shared
> 1;
13090 ++clear_face_cache_count
;
13091 #ifdef HAVE_WINDOW_SYSTEM
13092 ++clear_image_cache_count
;
13095 /* Build desired matrices, and update the display. If
13096 consider_all_windows_p is non-zero, do it for all windows on all
13097 frames. Otherwise do it for selected_window, only. */
13099 if (consider_all_windows_p
)
13101 Lisp_Object tail
, frame
;
13103 FOR_EACH_FRAME (tail
, frame
)
13104 XFRAME (frame
)->updated_p
= 0;
13106 /* Recompute # windows showing selected buffer. This will be
13107 incremented each time such a window is displayed. */
13110 FOR_EACH_FRAME (tail
, frame
)
13112 struct frame
*f
= XFRAME (frame
);
13114 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13116 if (! EQ (frame
, selected_frame
))
13117 /* Select the frame, for the sake of frame-local
13119 select_frame_for_redisplay (frame
);
13121 /* Mark all the scroll bars to be removed; we'll redeem
13122 the ones we want when we redisplay their windows. */
13123 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13124 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13126 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13127 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13129 /* The X error handler may have deleted that frame. */
13130 if (!FRAME_LIVE_P (f
))
13133 /* Any scroll bars which redisplay_windows should have
13134 nuked should now go away. */
13135 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13136 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13138 /* If fonts changed, display again. */
13139 /* ??? rms: I suspect it is a mistake to jump all the way
13140 back to retry here. It should just retry this frame. */
13141 if (fonts_changed_p
)
13144 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13146 /* See if we have to hscroll. */
13147 if (!f
->already_hscrolled_p
)
13149 f
->already_hscrolled_p
= 1;
13150 if (hscroll_windows (f
->root_window
))
13154 /* Prevent various kinds of signals during display
13155 update. stdio is not robust about handling
13156 signals, which can cause an apparent I/O
13158 if (interrupt_input
)
13159 unrequest_sigio ();
13162 /* Update the display. */
13163 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13164 pending
|= update_frame (f
, 0, 0);
13170 if (!EQ (old_frame
, selected_frame
)
13171 && FRAME_LIVE_P (XFRAME (old_frame
)))
13172 /* We played a bit fast-and-loose above and allowed selected_frame
13173 and selected_window to be temporarily out-of-sync but let's make
13174 sure this stays contained. */
13175 select_frame_for_redisplay (old_frame
);
13176 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13180 /* Do the mark_window_display_accurate after all windows have
13181 been redisplayed because this call resets flags in buffers
13182 which are needed for proper redisplay. */
13183 FOR_EACH_FRAME (tail
, frame
)
13185 struct frame
*f
= XFRAME (frame
);
13188 mark_window_display_accurate (f
->root_window
, 1);
13189 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13190 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13195 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13197 Lisp_Object mini_window
;
13198 struct frame
*mini_frame
;
13200 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13201 /* Use list_of_error, not Qerror, so that
13202 we catch only errors and don't run the debugger. */
13203 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13205 redisplay_window_error
);
13207 /* Compare desired and current matrices, perform output. */
13210 /* If fonts changed, display again. */
13211 if (fonts_changed_p
)
13214 /* Prevent various kinds of signals during display update.
13215 stdio is not robust about handling signals,
13216 which can cause an apparent I/O error. */
13217 if (interrupt_input
)
13218 unrequest_sigio ();
13221 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13223 if (hscroll_windows (selected_window
))
13226 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13227 pending
= update_frame (sf
, 0, 0);
13230 /* We may have called echo_area_display at the top of this
13231 function. If the echo area is on another frame, that may
13232 have put text on a frame other than the selected one, so the
13233 above call to update_frame would not have caught it. Catch
13235 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13236 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13238 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13240 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13241 pending
|= update_frame (mini_frame
, 0, 0);
13242 if (!pending
&& hscroll_windows (mini_window
))
13247 /* If display was paused because of pending input, make sure we do a
13248 thorough update the next time. */
13251 /* Prevent the optimization at the beginning of
13252 redisplay_internal that tries a single-line update of the
13253 line containing the cursor in the selected window. */
13254 CHARPOS (this_line_start_pos
) = 0;
13256 /* Let the overlay arrow be updated the next time. */
13257 update_overlay_arrows (0);
13259 /* If we pause after scrolling, some rows in the current
13260 matrices of some windows are not valid. */
13261 if (!WINDOW_FULL_WIDTH_P (w
)
13262 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13263 update_mode_lines
= 1;
13267 if (!consider_all_windows_p
)
13269 /* This has already been done above if
13270 consider_all_windows_p is set. */
13271 mark_window_display_accurate_1 (w
, 1);
13273 /* Say overlay arrows are up to date. */
13274 update_overlay_arrows (1);
13276 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13277 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13280 update_mode_lines
= 0;
13281 windows_or_buffers_changed
= 0;
13282 cursor_type_changed
= 0;
13285 /* Start SIGIO interrupts coming again. Having them off during the
13286 code above makes it less likely one will discard output, but not
13287 impossible, since there might be stuff in the system buffer here.
13288 But it is much hairier to try to do anything about that. */
13289 if (interrupt_input
)
13293 /* If a frame has become visible which was not before, redisplay
13294 again, so that we display it. Expose events for such a frame
13295 (which it gets when becoming visible) don't call the parts of
13296 redisplay constructing glyphs, so simply exposing a frame won't
13297 display anything in this case. So, we have to display these
13298 frames here explicitly. */
13301 Lisp_Object tail
, frame
;
13304 FOR_EACH_FRAME (tail
, frame
)
13306 int this_is_visible
= 0;
13308 if (XFRAME (frame
)->visible
)
13309 this_is_visible
= 1;
13310 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13311 if (XFRAME (frame
)->visible
)
13312 this_is_visible
= 1;
13314 if (this_is_visible
)
13318 if (new_count
!= number_of_visible_frames
)
13319 windows_or_buffers_changed
++;
13322 /* Change frame size now if a change is pending. */
13323 do_pending_window_change (1);
13325 /* If we just did a pending size change, or have additional
13326 visible frames, or selected_window changed, redisplay again. */
13327 if ((windows_or_buffers_changed
&& !pending
)
13328 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13331 /* Clear the face and image caches.
13333 We used to do this only if consider_all_windows_p. But the cache
13334 needs to be cleared if a timer creates images in the current
13335 buffer (e.g. the test case in Bug#6230). */
13337 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13339 clear_face_cache (0);
13340 clear_face_cache_count
= 0;
13343 #ifdef HAVE_WINDOW_SYSTEM
13344 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13346 clear_image_caches (Qnil
);
13347 clear_image_cache_count
= 0;
13349 #endif /* HAVE_WINDOW_SYSTEM */
13352 unbind_to (count
, Qnil
);
13357 /* Redisplay, but leave alone any recent echo area message unless
13358 another message has been requested in its place.
13360 This is useful in situations where you need to redisplay but no
13361 user action has occurred, making it inappropriate for the message
13362 area to be cleared. See tracking_off and
13363 wait_reading_process_output for examples of these situations.
13365 FROM_WHERE is an integer saying from where this function was
13366 called. This is useful for debugging. */
13369 redisplay_preserve_echo_area (int from_where
)
13371 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13373 if (!NILP (echo_area_buffer
[1]))
13375 /* We have a previously displayed message, but no current
13376 message. Redisplay the previous message. */
13377 display_last_displayed_message_p
= 1;
13378 redisplay_internal ();
13379 display_last_displayed_message_p
= 0;
13382 redisplay_internal ();
13384 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13385 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13386 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13390 /* Function registered with record_unwind_protect in
13391 redisplay_internal. Reset redisplaying_p to the value it had
13392 before redisplay_internal was called, and clear
13393 prevent_freeing_realized_faces_p. It also selects the previously
13394 selected frame, unless it has been deleted (by an X connection
13395 failure during redisplay, for example). */
13398 unwind_redisplay (Lisp_Object val
)
13400 Lisp_Object old_redisplaying_p
, old_frame
;
13402 old_redisplaying_p
= XCAR (val
);
13403 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13404 old_frame
= XCDR (val
);
13405 if (! EQ (old_frame
, selected_frame
)
13406 && FRAME_LIVE_P (XFRAME (old_frame
)))
13407 select_frame_for_redisplay (old_frame
);
13412 /* Mark the display of window W as accurate or inaccurate. If
13413 ACCURATE_P is non-zero mark display of W as accurate. If
13414 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13415 redisplay_internal is called. */
13418 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13420 if (BUFFERP (w
->buffer
))
13422 struct buffer
*b
= XBUFFER (w
->buffer
);
13425 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13426 w
->last_overlay_modified
13427 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13429 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13433 b
->clip_changed
= 0;
13434 b
->prevent_redisplay_optimizations_p
= 0;
13436 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13437 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13438 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13439 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13441 w
->current_matrix
->buffer
= b
;
13442 w
->current_matrix
->begv
= BUF_BEGV (b
);
13443 w
->current_matrix
->zv
= BUF_ZV (b
);
13445 w
->last_cursor
= w
->cursor
;
13446 w
->last_cursor_off_p
= w
->cursor_off_p
;
13448 if (w
== XWINDOW (selected_window
))
13449 w
->last_point
= make_number (BUF_PT (b
));
13451 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13457 w
->window_end_valid
= w
->buffer
;
13458 w
->update_mode_line
= Qnil
;
13463 /* Mark the display of windows in the window tree rooted at WINDOW as
13464 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13465 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13466 be redisplayed the next time redisplay_internal is called. */
13469 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13473 for (; !NILP (window
); window
= w
->next
)
13475 w
= XWINDOW (window
);
13476 mark_window_display_accurate_1 (w
, accurate_p
);
13478 if (!NILP (w
->vchild
))
13479 mark_window_display_accurate (w
->vchild
, accurate_p
);
13480 if (!NILP (w
->hchild
))
13481 mark_window_display_accurate (w
->hchild
, accurate_p
);
13486 update_overlay_arrows (1);
13490 /* Force a thorough redisplay the next time by setting
13491 last_arrow_position and last_arrow_string to t, which is
13492 unequal to any useful value of Voverlay_arrow_... */
13493 update_overlay_arrows (-1);
13498 /* Return value in display table DP (Lisp_Char_Table *) for character
13499 C. Since a display table doesn't have any parent, we don't have to
13500 follow parent. Do not call this function directly but use the
13501 macro DISP_CHAR_VECTOR. */
13504 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13508 if (ASCII_CHAR_P (c
))
13511 if (SUB_CHAR_TABLE_P (val
))
13512 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13518 XSETCHAR_TABLE (table
, dp
);
13519 val
= char_table_ref (table
, c
);
13528 /***********************************************************************
13530 ***********************************************************************/
13532 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13535 redisplay_windows (Lisp_Object window
)
13537 while (!NILP (window
))
13539 struct window
*w
= XWINDOW (window
);
13541 if (!NILP (w
->hchild
))
13542 redisplay_windows (w
->hchild
);
13543 else if (!NILP (w
->vchild
))
13544 redisplay_windows (w
->vchild
);
13545 else if (!NILP (w
->buffer
))
13547 displayed_buffer
= XBUFFER (w
->buffer
);
13548 /* Use list_of_error, not Qerror, so that
13549 we catch only errors and don't run the debugger. */
13550 internal_condition_case_1 (redisplay_window_0
, window
,
13552 redisplay_window_error
);
13560 redisplay_window_error (Lisp_Object ignore
)
13562 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13567 redisplay_window_0 (Lisp_Object window
)
13569 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13570 redisplay_window (window
, 0);
13575 redisplay_window_1 (Lisp_Object window
)
13577 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13578 redisplay_window (window
, 1);
13583 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13584 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13585 which positions recorded in ROW differ from current buffer
13588 Return 0 if cursor is not on this row, 1 otherwise. */
13591 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13592 struct glyph_matrix
*matrix
,
13593 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13596 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13597 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13598 struct glyph
*cursor
= NULL
;
13599 /* The last known character position in row. */
13600 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13602 ptrdiff_t pt_old
= PT
- delta
;
13603 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13604 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13605 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13606 /* A glyph beyond the edge of TEXT_AREA which we should never
13608 struct glyph
*glyphs_end
= end
;
13609 /* Non-zero means we've found a match for cursor position, but that
13610 glyph has the avoid_cursor_p flag set. */
13611 int match_with_avoid_cursor
= 0;
13612 /* Non-zero means we've seen at least one glyph that came from a
13614 int string_seen
= 0;
13615 /* Largest and smalles buffer positions seen so far during scan of
13617 ptrdiff_t bpos_max
= pos_before
;
13618 ptrdiff_t bpos_min
= pos_after
;
13619 /* Last buffer position covered by an overlay string with an integer
13620 `cursor' property. */
13621 ptrdiff_t bpos_covered
= 0;
13622 /* Non-zero means the display string on which to display the cursor
13623 comes from a text property, not from an overlay. */
13624 int string_from_text_prop
= 0;
13626 /* Skip over glyphs not having an object at the start and the end of
13627 the row. These are special glyphs like truncation marks on
13628 terminal frames. */
13629 if (row
->displays_text_p
)
13631 if (!row
->reversed_p
)
13634 && INTEGERP (glyph
->object
)
13635 && glyph
->charpos
< 0)
13637 x
+= glyph
->pixel_width
;
13641 && INTEGERP ((end
- 1)->object
)
13642 /* CHARPOS is zero for blanks and stretch glyphs
13643 inserted by extend_face_to_end_of_line. */
13644 && (end
- 1)->charpos
<= 0)
13646 glyph_before
= glyph
- 1;
13653 /* If the glyph row is reversed, we need to process it from back
13654 to front, so swap the edge pointers. */
13655 glyphs_end
= end
= glyph
- 1;
13656 glyph
+= row
->used
[TEXT_AREA
] - 1;
13658 while (glyph
> end
+ 1
13659 && INTEGERP (glyph
->object
)
13660 && glyph
->charpos
< 0)
13663 x
-= glyph
->pixel_width
;
13665 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13667 /* By default, in reversed rows we put the cursor on the
13668 rightmost (first in the reading order) glyph. */
13669 for (g
= end
+ 1; g
< glyph
; g
++)
13670 x
+= g
->pixel_width
;
13672 && INTEGERP ((end
+ 1)->object
)
13673 && (end
+ 1)->charpos
<= 0)
13675 glyph_before
= glyph
+ 1;
13679 else if (row
->reversed_p
)
13681 /* In R2L rows that don't display text, put the cursor on the
13682 rightmost glyph. Case in point: an empty last line that is
13683 part of an R2L paragraph. */
13685 /* Avoid placing the cursor on the last glyph of the row, where
13686 on terminal frames we hold the vertical border between
13687 adjacent windows. */
13688 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13689 && !WINDOW_RIGHTMOST_P (w
)
13690 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13692 x
= -1; /* will be computed below, at label compute_x */
13695 /* Step 1: Try to find the glyph whose character position
13696 corresponds to point. If that's not possible, find 2 glyphs
13697 whose character positions are the closest to point, one before
13698 point, the other after it. */
13699 if (!row
->reversed_p
)
13700 while (/* not marched to end of glyph row */
13702 /* glyph was not inserted by redisplay for internal purposes */
13703 && !INTEGERP (glyph
->object
))
13705 if (BUFFERP (glyph
->object
))
13707 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13709 if (glyph
->charpos
> bpos_max
)
13710 bpos_max
= glyph
->charpos
;
13711 if (glyph
->charpos
< bpos_min
)
13712 bpos_min
= glyph
->charpos
;
13713 if (!glyph
->avoid_cursor_p
)
13715 /* If we hit point, we've found the glyph on which to
13716 display the cursor. */
13719 match_with_avoid_cursor
= 0;
13722 /* See if we've found a better approximation to
13723 POS_BEFORE or to POS_AFTER. Note that we want the
13724 first (leftmost) glyph of all those that are the
13725 closest from below, and the last (rightmost) of all
13726 those from above. */
13727 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13729 pos_before
= glyph
->charpos
;
13730 glyph_before
= glyph
;
13732 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13734 pos_after
= glyph
->charpos
;
13735 glyph_after
= glyph
;
13738 else if (dpos
== 0)
13739 match_with_avoid_cursor
= 1;
13741 else if (STRINGP (glyph
->object
))
13743 Lisp_Object chprop
;
13744 ptrdiff_t glyph_pos
= glyph
->charpos
;
13746 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13748 if (INTEGERP (chprop
))
13750 bpos_covered
= bpos_max
+ XINT (chprop
);
13751 /* If the `cursor' property covers buffer positions up
13752 to and including point, we should display cursor on
13753 this glyph. Note that overlays and text properties
13754 with string values stop bidi reordering, so every
13755 buffer position to the left of the string is always
13756 smaller than any position to the right of the
13757 string. Therefore, if a `cursor' property on one
13758 of the string's characters has an integer value, we
13759 will break out of the loop below _before_ we get to
13760 the position match above. IOW, integer values of
13761 the `cursor' property override the "exact match for
13762 point" strategy of positioning the cursor. */
13763 /* Implementation note: bpos_max == pt_old when, e.g.,
13764 we are in an empty line, where bpos_max is set to
13765 MATRIX_ROW_START_CHARPOS, see above. */
13766 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13775 x
+= glyph
->pixel_width
;
13778 else if (glyph
> end
) /* row is reversed */
13779 while (!INTEGERP (glyph
->object
))
13781 if (BUFFERP (glyph
->object
))
13783 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13785 if (glyph
->charpos
> bpos_max
)
13786 bpos_max
= glyph
->charpos
;
13787 if (glyph
->charpos
< bpos_min
)
13788 bpos_min
= glyph
->charpos
;
13789 if (!glyph
->avoid_cursor_p
)
13793 match_with_avoid_cursor
= 0;
13796 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13798 pos_before
= glyph
->charpos
;
13799 glyph_before
= glyph
;
13801 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13803 pos_after
= glyph
->charpos
;
13804 glyph_after
= glyph
;
13807 else if (dpos
== 0)
13808 match_with_avoid_cursor
= 1;
13810 else if (STRINGP (glyph
->object
))
13812 Lisp_Object chprop
;
13813 ptrdiff_t glyph_pos
= glyph
->charpos
;
13815 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13817 if (INTEGERP (chprop
))
13819 bpos_covered
= bpos_max
+ XINT (chprop
);
13820 /* If the `cursor' property covers buffer positions up
13821 to and including point, we should display cursor on
13823 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13832 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13834 x
--; /* can't use any pixel_width */
13837 x
-= glyph
->pixel_width
;
13840 /* Step 2: If we didn't find an exact match for point, we need to
13841 look for a proper place to put the cursor among glyphs between
13842 GLYPH_BEFORE and GLYPH_AFTER. */
13843 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13844 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13845 && bpos_covered
< pt_old
)
13847 /* An empty line has a single glyph whose OBJECT is zero and
13848 whose CHARPOS is the position of a newline on that line.
13849 Note that on a TTY, there are more glyphs after that, which
13850 were produced by extend_face_to_end_of_line, but their
13851 CHARPOS is zero or negative. */
13853 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13854 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13856 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13858 ptrdiff_t ellipsis_pos
;
13860 /* Scan back over the ellipsis glyphs. */
13861 if (!row
->reversed_p
)
13863 ellipsis_pos
= (glyph
- 1)->charpos
;
13864 while (glyph
> row
->glyphs
[TEXT_AREA
]
13865 && (glyph
- 1)->charpos
== ellipsis_pos
)
13866 glyph
--, x
-= glyph
->pixel_width
;
13867 /* That loop always goes one position too far, including
13868 the glyph before the ellipsis. So scan forward over
13870 x
+= glyph
->pixel_width
;
13873 else /* row is reversed */
13875 ellipsis_pos
= (glyph
+ 1)->charpos
;
13876 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13877 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13878 glyph
++, x
+= glyph
->pixel_width
;
13879 x
-= glyph
->pixel_width
;
13883 else if (match_with_avoid_cursor
)
13885 cursor
= glyph_after
;
13888 else if (string_seen
)
13890 int incr
= row
->reversed_p
? -1 : +1;
13892 /* Need to find the glyph that came out of a string which is
13893 present at point. That glyph is somewhere between
13894 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13895 positioned between POS_BEFORE and POS_AFTER in the
13897 struct glyph
*start
, *stop
;
13898 ptrdiff_t pos
= pos_before
;
13902 /* If the row ends in a newline from a display string,
13903 reordering could have moved the glyphs belonging to the
13904 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13905 in this case we extend the search to the last glyph in
13906 the row that was not inserted by redisplay. */
13907 if (row
->ends_in_newline_from_string_p
)
13910 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13913 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13914 correspond to POS_BEFORE and POS_AFTER, respectively. We
13915 need START and STOP in the order that corresponds to the
13916 row's direction as given by its reversed_p flag. If the
13917 directionality of characters between POS_BEFORE and
13918 POS_AFTER is the opposite of the row's base direction,
13919 these characters will have been reordered for display,
13920 and we need to reverse START and STOP. */
13921 if (!row
->reversed_p
)
13923 start
= min (glyph_before
, glyph_after
);
13924 stop
= max (glyph_before
, glyph_after
);
13928 start
= max (glyph_before
, glyph_after
);
13929 stop
= min (glyph_before
, glyph_after
);
13931 for (glyph
= start
+ incr
;
13932 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13935 /* Any glyphs that come from the buffer are here because
13936 of bidi reordering. Skip them, and only pay
13937 attention to glyphs that came from some string. */
13938 if (STRINGP (glyph
->object
))
13942 /* If the display property covers the newline, we
13943 need to search for it one position farther. */
13944 ptrdiff_t lim
= pos_after
13945 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13947 string_from_text_prop
= 0;
13948 str
= glyph
->object
;
13949 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13950 if (tem
== 0 /* from overlay */
13953 /* If the string from which this glyph came is
13954 found in the buffer at point, then we've
13955 found the glyph we've been looking for. If
13956 it comes from an overlay (tem == 0), and it
13957 has the `cursor' property on one of its
13958 glyphs, record that glyph as a candidate for
13959 displaying the cursor. (As in the
13960 unidirectional version, we will display the
13961 cursor on the last candidate we find.) */
13962 if (tem
== 0 || tem
== pt_old
)
13964 /* The glyphs from this string could have
13965 been reordered. Find the one with the
13966 smallest string position. Or there could
13967 be a character in the string with the
13968 `cursor' property, which means display
13969 cursor on that character's glyph. */
13970 ptrdiff_t strpos
= glyph
->charpos
;
13975 string_from_text_prop
= 1;
13978 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13979 && EQ (glyph
->object
, str
);
13983 ptrdiff_t gpos
= glyph
->charpos
;
13985 cprop
= Fget_char_property (make_number (gpos
),
13993 if (tem
&& glyph
->charpos
< strpos
)
13995 strpos
= glyph
->charpos
;
14004 pos
= tem
+ 1; /* don't find previous instances */
14006 /* This string is not what we want; skip all of the
14007 glyphs that came from it. */
14008 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14009 && EQ (glyph
->object
, str
))
14016 /* If we reached the end of the line, and END was from a string,
14017 the cursor is not on this line. */
14019 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14020 && STRINGP (end
->object
)
14021 && row
->continued_p
)
14024 /* A truncated row may not include PT among its character positions.
14025 Setting the cursor inside the scroll margin will trigger
14026 recalculation of hscroll in hscroll_window_tree. But if a
14027 display string covers point, defer to the string-handling
14028 code below to figure this out. */
14029 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14031 cursor
= glyph_before
;
14034 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14035 /* Zero-width characters produce no glyphs. */
14037 && (row
->reversed_p
14038 ? glyph_after
> glyphs_end
14039 : glyph_after
< glyphs_end
)))
14041 cursor
= glyph_after
;
14047 if (cursor
!= NULL
)
14053 /* Need to compute x that corresponds to GLYPH. */
14054 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14056 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14058 x
+= g
->pixel_width
;
14062 /* ROW could be part of a continued line, which, under bidi
14063 reordering, might have other rows whose start and end charpos
14064 occlude point. Only set w->cursor if we found a better
14065 approximation to the cursor position than we have from previously
14066 examined candidate rows belonging to the same continued line. */
14067 if (/* we already have a candidate row */
14068 w
->cursor
.vpos
>= 0
14069 /* that candidate is not the row we are processing */
14070 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14071 /* Make sure cursor.vpos specifies a row whose start and end
14072 charpos occlude point, and it is valid candidate for being a
14073 cursor-row. This is because some callers of this function
14074 leave cursor.vpos at the row where the cursor was displayed
14075 during the last redisplay cycle. */
14076 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14077 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14078 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14081 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14083 /* Don't consider glyphs that are outside TEXT_AREA. */
14084 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14086 /* Keep the candidate whose buffer position is the closest to
14087 point or has the `cursor' property. */
14088 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14089 w
->cursor
.hpos
>= 0
14090 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14091 && ((BUFFERP (g1
->object
)
14092 && (g1
->charpos
== pt_old
/* an exact match always wins */
14093 || (BUFFERP (glyph
->object
)
14094 && eabs (g1
->charpos
- pt_old
)
14095 < eabs (glyph
->charpos
- pt_old
))))
14096 /* previous candidate is a glyph from a string that has
14097 a non-nil `cursor' property */
14098 || (STRINGP (g1
->object
)
14099 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14100 Qcursor
, g1
->object
))
14101 /* pevious candidate is from the same display
14102 string as this one, and the display string
14103 came from a text property */
14104 || (EQ (g1
->object
, glyph
->object
)
14105 && string_from_text_prop
)
14106 /* this candidate is from newline and its
14107 position is not an exact match */
14108 || (INTEGERP (glyph
->object
)
14109 && glyph
->charpos
!= pt_old
)))))
14111 /* If this candidate gives an exact match, use that. */
14112 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14113 /* If this candidate is a glyph created for the
14114 terminating newline of a line, and point is on that
14115 newline, it wins because it's an exact match. */
14116 || (!row
->continued_p
14117 && INTEGERP (glyph
->object
)
14118 && glyph
->charpos
== 0
14119 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14120 /* Otherwise, keep the candidate that comes from a row
14121 spanning less buffer positions. This may win when one or
14122 both candidate positions are on glyphs that came from
14123 display strings, for which we cannot compare buffer
14125 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14126 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14127 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14130 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14132 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14133 w
->cursor
.y
= row
->y
+ dy
;
14135 if (w
== XWINDOW (selected_window
))
14137 if (!row
->continued_p
14138 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14141 this_line_buffer
= XBUFFER (w
->buffer
);
14143 CHARPOS (this_line_start_pos
)
14144 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14145 BYTEPOS (this_line_start_pos
)
14146 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14148 CHARPOS (this_line_end_pos
)
14149 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14150 BYTEPOS (this_line_end_pos
)
14151 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14153 this_line_y
= w
->cursor
.y
;
14154 this_line_pixel_height
= row
->height
;
14155 this_line_vpos
= w
->cursor
.vpos
;
14156 this_line_start_x
= row
->x
;
14159 CHARPOS (this_line_start_pos
) = 0;
14166 /* Run window scroll functions, if any, for WINDOW with new window
14167 start STARTP. Sets the window start of WINDOW to that position.
14169 We assume that the window's buffer is really current. */
14171 static inline struct text_pos
14172 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14174 struct window
*w
= XWINDOW (window
);
14175 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14177 if (current_buffer
!= XBUFFER (w
->buffer
))
14180 if (!NILP (Vwindow_scroll_functions
))
14182 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14183 make_number (CHARPOS (startp
)));
14184 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14185 /* In case the hook functions switch buffers. */
14186 if (current_buffer
!= XBUFFER (w
->buffer
))
14187 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14194 /* Make sure the line containing the cursor is fully visible.
14195 A value of 1 means there is nothing to be done.
14196 (Either the line is fully visible, or it cannot be made so,
14197 or we cannot tell.)
14199 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14200 is higher than window.
14202 A value of 0 means the caller should do scrolling
14203 as if point had gone off the screen. */
14206 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14208 struct glyph_matrix
*matrix
;
14209 struct glyph_row
*row
;
14212 if (!make_cursor_line_fully_visible_p
)
14215 /* It's not always possible to find the cursor, e.g, when a window
14216 is full of overlay strings. Don't do anything in that case. */
14217 if (w
->cursor
.vpos
< 0)
14220 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14221 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14223 /* If the cursor row is not partially visible, there's nothing to do. */
14224 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14227 /* If the row the cursor is in is taller than the window's height,
14228 it's not clear what to do, so do nothing. */
14229 window_height
= window_box_height (w
);
14230 if (row
->height
>= window_height
)
14232 if (!force_p
|| MINI_WINDOW_P (w
)
14233 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14240 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14241 non-zero means only WINDOW is redisplayed in redisplay_internal.
14242 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14243 in redisplay_window to bring a partially visible line into view in
14244 the case that only the cursor has moved.
14246 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14247 last screen line's vertical height extends past the end of the screen.
14251 1 if scrolling succeeded
14253 0 if scrolling didn't find point.
14255 -1 if new fonts have been loaded so that we must interrupt
14256 redisplay, adjust glyph matrices, and try again. */
14262 SCROLLING_NEED_LARGER_MATRICES
14265 /* If scroll-conservatively is more than this, never recenter.
14267 If you change this, don't forget to update the doc string of
14268 `scroll-conservatively' and the Emacs manual. */
14269 #define SCROLL_LIMIT 100
14272 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14273 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14274 int temp_scroll_step
, int last_line_misfit
)
14276 struct window
*w
= XWINDOW (window
);
14277 struct frame
*f
= XFRAME (w
->frame
);
14278 struct text_pos pos
, startp
;
14280 int this_scroll_margin
, scroll_max
, rc
, height
;
14281 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14282 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14283 Lisp_Object aggressive
;
14284 /* We will never try scrolling more than this number of lines. */
14285 int scroll_limit
= SCROLL_LIMIT
;
14288 debug_method_add (w
, "try_scrolling");
14291 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14293 /* Compute scroll margin height in pixels. We scroll when point is
14294 within this distance from the top or bottom of the window. */
14295 if (scroll_margin
> 0)
14296 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14297 * FRAME_LINE_HEIGHT (f
);
14299 this_scroll_margin
= 0;
14301 /* Force arg_scroll_conservatively to have a reasonable value, to
14302 avoid scrolling too far away with slow move_it_* functions. Note
14303 that the user can supply scroll-conservatively equal to
14304 `most-positive-fixnum', which can be larger than INT_MAX. */
14305 if (arg_scroll_conservatively
> scroll_limit
)
14307 arg_scroll_conservatively
= scroll_limit
+ 1;
14308 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14310 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14311 /* Compute how much we should try to scroll maximally to bring
14312 point into view. */
14313 scroll_max
= (max (scroll_step
,
14314 max (arg_scroll_conservatively
, temp_scroll_step
))
14315 * FRAME_LINE_HEIGHT (f
));
14316 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14317 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14318 /* We're trying to scroll because of aggressive scrolling but no
14319 scroll_step is set. Choose an arbitrary one. */
14320 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14326 /* Decide whether to scroll down. */
14327 if (PT
> CHARPOS (startp
))
14329 int scroll_margin_y
;
14331 /* Compute the pixel ypos of the scroll margin, then move it to
14332 either that ypos or PT, whichever comes first. */
14333 start_display (&it
, w
, startp
);
14334 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14335 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14336 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14337 (MOVE_TO_POS
| MOVE_TO_Y
));
14339 if (PT
> CHARPOS (it
.current
.pos
))
14341 int y0
= line_bottom_y (&it
);
14342 /* Compute how many pixels below window bottom to stop searching
14343 for PT. This avoids costly search for PT that is far away if
14344 the user limited scrolling by a small number of lines, but
14345 always finds PT if scroll_conservatively is set to a large
14346 number, such as most-positive-fixnum. */
14347 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14348 int y_to_move
= it
.last_visible_y
+ slack
;
14350 /* Compute the distance from the scroll margin to PT or to
14351 the scroll limit, whichever comes first. This should
14352 include the height of the cursor line, to make that line
14354 move_it_to (&it
, PT
, -1, y_to_move
,
14355 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14356 dy
= line_bottom_y (&it
) - y0
;
14358 if (dy
> scroll_max
)
14359 return SCROLLING_FAILED
;
14367 /* Point is in or below the bottom scroll margin, so move the
14368 window start down. If scrolling conservatively, move it just
14369 enough down to make point visible. If scroll_step is set,
14370 move it down by scroll_step. */
14371 if (arg_scroll_conservatively
)
14373 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14374 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14375 else if (scroll_step
|| temp_scroll_step
)
14376 amount_to_scroll
= scroll_max
;
14379 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14380 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14381 if (NUMBERP (aggressive
))
14383 double float_amount
= XFLOATINT (aggressive
) * height
;
14384 amount_to_scroll
= float_amount
;
14385 if (amount_to_scroll
== 0 && float_amount
> 0)
14386 amount_to_scroll
= 1;
14387 /* Don't let point enter the scroll margin near top of
14389 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14390 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14394 if (amount_to_scroll
<= 0)
14395 return SCROLLING_FAILED
;
14397 start_display (&it
, w
, startp
);
14398 if (arg_scroll_conservatively
<= scroll_limit
)
14399 move_it_vertically (&it
, amount_to_scroll
);
14402 /* Extra precision for users who set scroll-conservatively
14403 to a large number: make sure the amount we scroll
14404 the window start is never less than amount_to_scroll,
14405 which was computed as distance from window bottom to
14406 point. This matters when lines at window top and lines
14407 below window bottom have different height. */
14409 void *it1data
= NULL
;
14410 /* We use a temporary it1 because line_bottom_y can modify
14411 its argument, if it moves one line down; see there. */
14414 SAVE_IT (it1
, it
, it1data
);
14415 start_y
= line_bottom_y (&it1
);
14417 RESTORE_IT (&it
, &it
, it1data
);
14418 move_it_by_lines (&it
, 1);
14419 SAVE_IT (it1
, it
, it1data
);
14420 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14423 /* If STARTP is unchanged, move it down another screen line. */
14424 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14425 move_it_by_lines (&it
, 1);
14426 startp
= it
.current
.pos
;
14430 struct text_pos scroll_margin_pos
= startp
;
14432 /* See if point is inside the scroll margin at the top of the
14434 if (this_scroll_margin
)
14436 start_display (&it
, w
, startp
);
14437 move_it_vertically (&it
, this_scroll_margin
);
14438 scroll_margin_pos
= it
.current
.pos
;
14441 if (PT
< CHARPOS (scroll_margin_pos
))
14443 /* Point is in the scroll margin at the top of the window or
14444 above what is displayed in the window. */
14447 /* Compute the vertical distance from PT to the scroll
14448 margin position. Move as far as scroll_max allows, or
14449 one screenful, or 10 screen lines, whichever is largest.
14450 Give up if distance is greater than scroll_max. */
14451 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14452 start_display (&it
, w
, pos
);
14454 y_to_move
= max (it
.last_visible_y
,
14455 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14456 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14458 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14459 dy
= it
.current_y
- y0
;
14460 if (dy
> scroll_max
)
14461 return SCROLLING_FAILED
;
14463 /* Compute new window start. */
14464 start_display (&it
, w
, startp
);
14466 if (arg_scroll_conservatively
)
14467 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14468 max (scroll_step
, temp_scroll_step
));
14469 else if (scroll_step
|| temp_scroll_step
)
14470 amount_to_scroll
= scroll_max
;
14473 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14474 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14475 if (NUMBERP (aggressive
))
14477 double float_amount
= XFLOATINT (aggressive
) * height
;
14478 amount_to_scroll
= float_amount
;
14479 if (amount_to_scroll
== 0 && float_amount
> 0)
14480 amount_to_scroll
= 1;
14481 amount_to_scroll
-=
14482 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14483 /* Don't let point enter the scroll margin near
14484 bottom of the window. */
14485 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14486 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14490 if (amount_to_scroll
<= 0)
14491 return SCROLLING_FAILED
;
14493 move_it_vertically_backward (&it
, amount_to_scroll
);
14494 startp
= it
.current
.pos
;
14498 /* Run window scroll functions. */
14499 startp
= run_window_scroll_functions (window
, startp
);
14501 /* Display the window. Give up if new fonts are loaded, or if point
14503 if (!try_window (window
, startp
, 0))
14504 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14505 else if (w
->cursor
.vpos
< 0)
14507 clear_glyph_matrix (w
->desired_matrix
);
14508 rc
= SCROLLING_FAILED
;
14512 /* Maybe forget recorded base line for line number display. */
14513 if (!just_this_one_p
14514 || current_buffer
->clip_changed
14515 || BEG_UNCHANGED
< CHARPOS (startp
))
14516 w
->base_line_number
= Qnil
;
14518 /* If cursor ends up on a partially visible line,
14519 treat that as being off the bottom of the screen. */
14520 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14521 /* It's possible that the cursor is on the first line of the
14522 buffer, which is partially obscured due to a vscroll
14523 (Bug#7537). In that case, avoid looping forever . */
14524 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14526 clear_glyph_matrix (w
->desired_matrix
);
14527 ++extra_scroll_margin_lines
;
14530 rc
= SCROLLING_SUCCESS
;
14537 /* Compute a suitable window start for window W if display of W starts
14538 on a continuation line. Value is non-zero if a new window start
14541 The new window start will be computed, based on W's width, starting
14542 from the start of the continued line. It is the start of the
14543 screen line with the minimum distance from the old start W->start. */
14546 compute_window_start_on_continuation_line (struct window
*w
)
14548 struct text_pos pos
, start_pos
;
14549 int window_start_changed_p
= 0;
14551 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14553 /* If window start is on a continuation line... Window start may be
14554 < BEGV in case there's invisible text at the start of the
14555 buffer (M-x rmail, for example). */
14556 if (CHARPOS (start_pos
) > BEGV
14557 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14560 struct glyph_row
*row
;
14562 /* Handle the case that the window start is out of range. */
14563 if (CHARPOS (start_pos
) < BEGV
)
14564 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14565 else if (CHARPOS (start_pos
) > ZV
)
14566 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14568 /* Find the start of the continued line. This should be fast
14569 because scan_buffer is fast (newline cache). */
14570 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14571 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14572 row
, DEFAULT_FACE_ID
);
14573 reseat_at_previous_visible_line_start (&it
);
14575 /* If the line start is "too far" away from the window start,
14576 say it takes too much time to compute a new window start. */
14577 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14578 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14580 int min_distance
, distance
;
14582 /* Move forward by display lines to find the new window
14583 start. If window width was enlarged, the new start can
14584 be expected to be > the old start. If window width was
14585 decreased, the new window start will be < the old start.
14586 So, we're looking for the display line start with the
14587 minimum distance from the old window start. */
14588 pos
= it
.current
.pos
;
14589 min_distance
= INFINITY
;
14590 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14591 distance
< min_distance
)
14593 min_distance
= distance
;
14594 pos
= it
.current
.pos
;
14595 move_it_by_lines (&it
, 1);
14598 /* Set the window start there. */
14599 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14600 window_start_changed_p
= 1;
14604 return window_start_changed_p
;
14608 /* Try cursor movement in case text has not changed in window WINDOW,
14609 with window start STARTP. Value is
14611 CURSOR_MOVEMENT_SUCCESS if successful
14613 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14615 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14616 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14617 we want to scroll as if scroll-step were set to 1. See the code.
14619 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14620 which case we have to abort this redisplay, and adjust matrices
14625 CURSOR_MOVEMENT_SUCCESS
,
14626 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14627 CURSOR_MOVEMENT_MUST_SCROLL
,
14628 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14632 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14634 struct window
*w
= XWINDOW (window
);
14635 struct frame
*f
= XFRAME (w
->frame
);
14636 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14639 if (inhibit_try_cursor_movement
)
14643 /* Handle case where text has not changed, only point, and it has
14644 not moved off the frame. */
14645 if (/* Point may be in this window. */
14646 PT
>= CHARPOS (startp
)
14647 /* Selective display hasn't changed. */
14648 && !current_buffer
->clip_changed
14649 /* Function force-mode-line-update is used to force a thorough
14650 redisplay. It sets either windows_or_buffers_changed or
14651 update_mode_lines. So don't take a shortcut here for these
14653 && !update_mode_lines
14654 && !windows_or_buffers_changed
14655 && !cursor_type_changed
14656 /* Can't use this case if highlighting a region. When a
14657 region exists, cursor movement has to do more than just
14659 && !(!NILP (Vtransient_mark_mode
)
14660 && !NILP (BVAR (current_buffer
, mark_active
)))
14661 && NILP (w
->region_showing
)
14662 && NILP (Vshow_trailing_whitespace
)
14663 /* Right after splitting windows, last_point may be nil. */
14664 && INTEGERP (w
->last_point
)
14665 /* This code is not used for mini-buffer for the sake of the case
14666 of redisplaying to replace an echo area message; since in
14667 that case the mini-buffer contents per se are usually
14668 unchanged. This code is of no real use in the mini-buffer
14669 since the handling of this_line_start_pos, etc., in redisplay
14670 handles the same cases. */
14671 && !EQ (window
, minibuf_window
)
14672 /* When splitting windows or for new windows, it happens that
14673 redisplay is called with a nil window_end_vpos or one being
14674 larger than the window. This should really be fixed in
14675 window.c. I don't have this on my list, now, so we do
14676 approximately the same as the old redisplay code. --gerd. */
14677 && INTEGERP (w
->window_end_vpos
)
14678 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14679 && (FRAME_WINDOW_P (f
)
14680 || !overlay_arrow_in_current_buffer_p ()))
14682 int this_scroll_margin
, top_scroll_margin
;
14683 struct glyph_row
*row
= NULL
;
14686 debug_method_add (w
, "cursor movement");
14689 /* Scroll if point within this distance from the top or bottom
14690 of the window. This is a pixel value. */
14691 if (scroll_margin
> 0)
14693 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14694 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14697 this_scroll_margin
= 0;
14699 top_scroll_margin
= this_scroll_margin
;
14700 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14701 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14703 /* Start with the row the cursor was displayed during the last
14704 not paused redisplay. Give up if that row is not valid. */
14705 if (w
->last_cursor
.vpos
< 0
14706 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14707 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14710 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14711 if (row
->mode_line_p
)
14713 if (!row
->enabled_p
)
14714 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14717 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14719 int scroll_p
= 0, must_scroll
= 0;
14720 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14722 if (PT
> XFASTINT (w
->last_point
))
14724 /* Point has moved forward. */
14725 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14726 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14728 xassert (row
->enabled_p
);
14732 /* If the end position of a row equals the start
14733 position of the next row, and PT is at that position,
14734 we would rather display cursor in the next line. */
14735 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14736 && MATRIX_ROW_END_CHARPOS (row
) == PT
14737 && row
< w
->current_matrix
->rows
14738 + w
->current_matrix
->nrows
- 1
14739 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14740 && !cursor_row_p (row
))
14743 /* If within the scroll margin, scroll. Note that
14744 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14745 the next line would be drawn, and that
14746 this_scroll_margin can be zero. */
14747 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14748 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14749 /* Line is completely visible last line in window
14750 and PT is to be set in the next line. */
14751 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14752 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14753 && !row
->ends_at_zv_p
14754 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14757 else if (PT
< XFASTINT (w
->last_point
))
14759 /* Cursor has to be moved backward. Note that PT >=
14760 CHARPOS (startp) because of the outer if-statement. */
14761 while (!row
->mode_line_p
14762 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14763 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14764 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14765 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14766 row
> w
->current_matrix
->rows
14767 && (row
-1)->ends_in_newline_from_string_p
))))
14768 && (row
->y
> top_scroll_margin
14769 || CHARPOS (startp
) == BEGV
))
14771 xassert (row
->enabled_p
);
14775 /* Consider the following case: Window starts at BEGV,
14776 there is invisible, intangible text at BEGV, so that
14777 display starts at some point START > BEGV. It can
14778 happen that we are called with PT somewhere between
14779 BEGV and START. Try to handle that case. */
14780 if (row
< w
->current_matrix
->rows
14781 || row
->mode_line_p
)
14783 row
= w
->current_matrix
->rows
;
14784 if (row
->mode_line_p
)
14788 /* Due to newlines in overlay strings, we may have to
14789 skip forward over overlay strings. */
14790 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14791 && MATRIX_ROW_END_CHARPOS (row
) == PT
14792 && !cursor_row_p (row
))
14795 /* If within the scroll margin, scroll. */
14796 if (row
->y
< top_scroll_margin
14797 && CHARPOS (startp
) != BEGV
)
14802 /* Cursor did not move. So don't scroll even if cursor line
14803 is partially visible, as it was so before. */
14804 rc
= CURSOR_MOVEMENT_SUCCESS
;
14807 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14808 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14810 /* if PT is not in the glyph row, give up. */
14811 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14814 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14815 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14817 /* If rows are bidi-reordered and point moved, back up
14818 until we find a row that does not belong to a
14819 continuation line. This is because we must consider
14820 all rows of a continued line as candidates for the
14821 new cursor positioning, since row start and end
14822 positions change non-linearly with vertical position
14824 /* FIXME: Revisit this when glyph ``spilling'' in
14825 continuation lines' rows is implemented for
14826 bidi-reordered rows. */
14827 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14829 xassert (row
->enabled_p
);
14831 /* If we hit the beginning of the displayed portion
14832 without finding the first row of a continued
14834 if (row
<= w
->current_matrix
->rows
)
14836 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14844 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14845 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14846 && make_cursor_line_fully_visible_p
)
14848 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14849 && !row
->ends_at_zv_p
14850 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14851 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14852 else if (row
->height
> window_box_height (w
))
14854 /* If we end up in a partially visible line, let's
14855 make it fully visible, except when it's taller
14856 than the window, in which case we can't do much
14859 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14863 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14864 if (!cursor_row_fully_visible_p (w
, 0, 1))
14865 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14867 rc
= CURSOR_MOVEMENT_SUCCESS
;
14871 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14872 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14873 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14875 /* With bidi-reordered rows, there could be more than
14876 one candidate row whose start and end positions
14877 occlude point. We need to let set_cursor_from_row
14878 find the best candidate. */
14879 /* FIXME: Revisit this when glyph ``spilling'' in
14880 continuation lines' rows is implemented for
14881 bidi-reordered rows. */
14886 int at_zv_p
= 0, exact_match_p
= 0;
14888 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14889 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14890 && cursor_row_p (row
))
14891 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14893 /* As soon as we've found the exact match for point,
14894 or the first suitable row whose ends_at_zv_p flag
14895 is set, we are done. */
14897 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14899 && w
->cursor
.hpos
>= 0
14900 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14903 struct glyph_row
*candidate
=
14904 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14906 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14907 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14910 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14911 || (INTEGERP (g
->object
)
14912 && (g
->charpos
== PT
14913 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14915 if (rv
&& (at_zv_p
|| exact_match_p
))
14917 rc
= CURSOR_MOVEMENT_SUCCESS
;
14920 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14924 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14925 || row
->continued_p
)
14926 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14927 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14928 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14929 /* If we didn't find any candidate rows, or exited the
14930 loop before all the candidates were examined, signal
14931 to the caller that this method failed. */
14932 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14934 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14935 && !row
->continued_p
))
14936 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14938 rc
= CURSOR_MOVEMENT_SUCCESS
;
14944 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14946 rc
= CURSOR_MOVEMENT_SUCCESS
;
14951 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14952 && MATRIX_ROW_START_CHARPOS (row
) == PT
14953 && cursor_row_p (row
));
14961 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14965 set_vertical_scroll_bar (struct window
*w
)
14967 ptrdiff_t start
, end
, whole
;
14969 /* Calculate the start and end positions for the current window.
14970 At some point, it would be nice to choose between scrollbars
14971 which reflect the whole buffer size, with special markers
14972 indicating narrowing, and scrollbars which reflect only the
14975 Note that mini-buffers sometimes aren't displaying any text. */
14976 if (!MINI_WINDOW_P (w
)
14977 || (w
== XWINDOW (minibuf_window
)
14978 && NILP (echo_area_buffer
[0])))
14980 struct buffer
*buf
= XBUFFER (w
->buffer
);
14981 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14982 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14983 /* I don't think this is guaranteed to be right. For the
14984 moment, we'll pretend it is. */
14985 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14989 if (whole
< (end
- start
))
14990 whole
= end
- start
;
14993 start
= end
= whole
= 0;
14995 /* Indicate what this scroll bar ought to be displaying now. */
14996 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14997 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14998 (w
, end
- start
, whole
, start
);
15002 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15003 selected_window is redisplayed.
15005 We can return without actually redisplaying the window if
15006 fonts_changed_p is nonzero. In that case, redisplay_internal will
15010 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15012 struct window
*w
= XWINDOW (window
);
15013 struct frame
*f
= XFRAME (w
->frame
);
15014 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15015 struct buffer
*old
= current_buffer
;
15016 struct text_pos lpoint
, opoint
, startp
;
15017 int update_mode_line
;
15020 /* Record it now because it's overwritten. */
15021 int current_matrix_up_to_date_p
= 0;
15022 int used_current_matrix_p
= 0;
15023 /* This is less strict than current_matrix_up_to_date_p.
15024 It indictes that the buffer contents and narrowing are unchanged. */
15025 int buffer_unchanged_p
= 0;
15026 int temp_scroll_step
= 0;
15027 ptrdiff_t count
= SPECPDL_INDEX ();
15029 int centering_position
= -1;
15030 int last_line_misfit
= 0;
15031 ptrdiff_t beg_unchanged
, end_unchanged
;
15033 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15036 /* W must be a leaf window here. */
15037 xassert (!NILP (w
->buffer
));
15039 *w
->desired_matrix
->method
= 0;
15043 reconsider_clip_changes (w
, buffer
);
15045 /* Has the mode line to be updated? */
15046 update_mode_line
= (!NILP (w
->update_mode_line
)
15047 || update_mode_lines
15048 || buffer
->clip_changed
15049 || buffer
->prevent_redisplay_optimizations_p
);
15051 if (MINI_WINDOW_P (w
))
15053 if (w
== XWINDOW (echo_area_window
)
15054 && !NILP (echo_area_buffer
[0]))
15056 if (update_mode_line
)
15057 /* We may have to update a tty frame's menu bar or a
15058 tool-bar. Example `M-x C-h C-h C-g'. */
15059 goto finish_menu_bars
;
15061 /* We've already displayed the echo area glyphs in this window. */
15062 goto finish_scroll_bars
;
15064 else if ((w
!= XWINDOW (minibuf_window
)
15065 || minibuf_level
== 0)
15066 /* When buffer is nonempty, redisplay window normally. */
15067 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15068 /* Quail displays non-mini buffers in minibuffer window.
15069 In that case, redisplay the window normally. */
15070 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15072 /* W is a mini-buffer window, but it's not active, so clear
15074 int yb
= window_text_bottom_y (w
);
15075 struct glyph_row
*row
;
15078 for (y
= 0, row
= w
->desired_matrix
->rows
;
15080 y
+= row
->height
, ++row
)
15081 blank_row (w
, row
, y
);
15082 goto finish_scroll_bars
;
15085 clear_glyph_matrix (w
->desired_matrix
);
15088 /* Otherwise set up data on this window; select its buffer and point
15090 /* Really select the buffer, for the sake of buffer-local
15092 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15094 current_matrix_up_to_date_p
15095 = (!NILP (w
->window_end_valid
)
15096 && !current_buffer
->clip_changed
15097 && !current_buffer
->prevent_redisplay_optimizations_p
15098 && XFASTINT (w
->last_modified
) >= MODIFF
15099 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15101 /* Run the window-bottom-change-functions
15102 if it is possible that the text on the screen has changed
15103 (either due to modification of the text, or any other reason). */
15104 if (!current_matrix_up_to_date_p
15105 && !NILP (Vwindow_text_change_functions
))
15107 safe_run_hooks (Qwindow_text_change_functions
);
15111 beg_unchanged
= BEG_UNCHANGED
;
15112 end_unchanged
= END_UNCHANGED
;
15114 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15116 specbind (Qinhibit_point_motion_hooks
, Qt
);
15119 = (!NILP (w
->window_end_valid
)
15120 && !current_buffer
->clip_changed
15121 && XFASTINT (w
->last_modified
) >= MODIFF
15122 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15124 /* When windows_or_buffers_changed is non-zero, we can't rely on
15125 the window end being valid, so set it to nil there. */
15126 if (windows_or_buffers_changed
)
15128 /* If window starts on a continuation line, maybe adjust the
15129 window start in case the window's width changed. */
15130 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15131 compute_window_start_on_continuation_line (w
);
15133 w
->window_end_valid
= Qnil
;
15136 /* Some sanity checks. */
15137 CHECK_WINDOW_END (w
);
15138 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15140 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15143 /* If %c is in mode line, update it if needed. */
15144 if (!NILP (w
->column_number_displayed
)
15145 /* This alternative quickly identifies a common case
15146 where no change is needed. */
15147 && !(PT
== XFASTINT (w
->last_point
)
15148 && XFASTINT (w
->last_modified
) >= MODIFF
15149 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15150 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15151 update_mode_line
= 1;
15153 /* Count number of windows showing the selected buffer. An indirect
15154 buffer counts as its base buffer. */
15155 if (!just_this_one_p
)
15157 struct buffer
*current_base
, *window_base
;
15158 current_base
= current_buffer
;
15159 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15160 if (current_base
->base_buffer
)
15161 current_base
= current_base
->base_buffer
;
15162 if (window_base
->base_buffer
)
15163 window_base
= window_base
->base_buffer
;
15164 if (current_base
== window_base
)
15168 /* Point refers normally to the selected window. For any other
15169 window, set up appropriate value. */
15170 if (!EQ (window
, selected_window
))
15172 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15173 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15177 new_pt_byte
= BEGV_BYTE
;
15178 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15180 else if (new_pt
> (ZV
- 1))
15183 new_pt_byte
= ZV_BYTE
;
15184 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15187 /* We don't use SET_PT so that the point-motion hooks don't run. */
15188 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15191 /* If any of the character widths specified in the display table
15192 have changed, invalidate the width run cache. It's true that
15193 this may be a bit late to catch such changes, but the rest of
15194 redisplay goes (non-fatally) haywire when the display table is
15195 changed, so why should we worry about doing any better? */
15196 if (current_buffer
->width_run_cache
)
15198 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15200 if (! disptab_matches_widthtab (disptab
,
15201 XVECTOR (BVAR (current_buffer
, width_table
))))
15203 invalidate_region_cache (current_buffer
,
15204 current_buffer
->width_run_cache
,
15206 recompute_width_table (current_buffer
, disptab
);
15210 /* If window-start is screwed up, choose a new one. */
15211 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15214 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15216 /* If someone specified a new starting point but did not insist,
15217 check whether it can be used. */
15218 if (!NILP (w
->optional_new_start
)
15219 && CHARPOS (startp
) >= BEGV
15220 && CHARPOS (startp
) <= ZV
)
15222 w
->optional_new_start
= Qnil
;
15223 start_display (&it
, w
, startp
);
15224 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15225 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15226 if (IT_CHARPOS (it
) == PT
)
15227 w
->force_start
= Qt
;
15228 /* IT may overshoot PT if text at PT is invisible. */
15229 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15230 w
->force_start
= Qt
;
15235 /* Handle case where place to start displaying has been specified,
15236 unless the specified location is outside the accessible range. */
15237 if (!NILP (w
->force_start
)
15238 || w
->frozen_window_start_p
)
15240 /* We set this later on if we have to adjust point. */
15243 w
->force_start
= Qnil
;
15245 w
->window_end_valid
= Qnil
;
15247 /* Forget any recorded base line for line number display. */
15248 if (!buffer_unchanged_p
)
15249 w
->base_line_number
= Qnil
;
15251 /* Redisplay the mode line. Select the buffer properly for that.
15252 Also, run the hook window-scroll-functions
15253 because we have scrolled. */
15254 /* Note, we do this after clearing force_start because
15255 if there's an error, it is better to forget about force_start
15256 than to get into an infinite loop calling the hook functions
15257 and having them get more errors. */
15258 if (!update_mode_line
15259 || ! NILP (Vwindow_scroll_functions
))
15261 update_mode_line
= 1;
15262 w
->update_mode_line
= Qt
;
15263 startp
= run_window_scroll_functions (window
, startp
);
15266 w
->last_modified
= make_number (0);
15267 w
->last_overlay_modified
= make_number (0);
15268 if (CHARPOS (startp
) < BEGV
)
15269 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15270 else if (CHARPOS (startp
) > ZV
)
15271 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15273 /* Redisplay, then check if cursor has been set during the
15274 redisplay. Give up if new fonts were loaded. */
15275 /* We used to issue a CHECK_MARGINS argument to try_window here,
15276 but this causes scrolling to fail when point begins inside
15277 the scroll margin (bug#148) -- cyd */
15278 if (!try_window (window
, startp
, 0))
15280 w
->force_start
= Qt
;
15281 clear_glyph_matrix (w
->desired_matrix
);
15282 goto need_larger_matrices
;
15285 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15287 /* If point does not appear, try to move point so it does
15288 appear. The desired matrix has been built above, so we
15289 can use it here. */
15290 new_vpos
= window_box_height (w
) / 2;
15293 if (!cursor_row_fully_visible_p (w
, 0, 0))
15295 /* Point does appear, but on a line partly visible at end of window.
15296 Move it back to a fully-visible line. */
15297 new_vpos
= window_box_height (w
);
15300 /* If we need to move point for either of the above reasons,
15301 now actually do it. */
15304 struct glyph_row
*row
;
15306 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15307 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15310 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15311 MATRIX_ROW_START_BYTEPOS (row
));
15313 if (w
!= XWINDOW (selected_window
))
15314 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15315 else if (current_buffer
== old
)
15316 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15318 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15320 /* If we are highlighting the region, then we just changed
15321 the region, so redisplay to show it. */
15322 if (!NILP (Vtransient_mark_mode
)
15323 && !NILP (BVAR (current_buffer
, mark_active
)))
15325 clear_glyph_matrix (w
->desired_matrix
);
15326 if (!try_window (window
, startp
, 0))
15327 goto need_larger_matrices
;
15332 debug_method_add (w
, "forced window start");
15337 /* Handle case where text has not changed, only point, and it has
15338 not moved off the frame, and we are not retrying after hscroll.
15339 (current_matrix_up_to_date_p is nonzero when retrying.) */
15340 if (current_matrix_up_to_date_p
15341 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15342 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15346 case CURSOR_MOVEMENT_SUCCESS
:
15347 used_current_matrix_p
= 1;
15350 case CURSOR_MOVEMENT_MUST_SCROLL
:
15351 goto try_to_scroll
;
15357 /* If current starting point was originally the beginning of a line
15358 but no longer is, find a new starting point. */
15359 else if (!NILP (w
->start_at_line_beg
)
15360 && !(CHARPOS (startp
) <= BEGV
15361 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15364 debug_method_add (w
, "recenter 1");
15369 /* Try scrolling with try_window_id. Value is > 0 if update has
15370 been done, it is -1 if we know that the same window start will
15371 not work. It is 0 if unsuccessful for some other reason. */
15372 else if ((tem
= try_window_id (w
)) != 0)
15375 debug_method_add (w
, "try_window_id %d", tem
);
15378 if (fonts_changed_p
)
15379 goto need_larger_matrices
;
15383 /* Otherwise try_window_id has returned -1 which means that we
15384 don't want the alternative below this comment to execute. */
15386 else if (CHARPOS (startp
) >= BEGV
15387 && CHARPOS (startp
) <= ZV
15388 && PT
>= CHARPOS (startp
)
15389 && (CHARPOS (startp
) < ZV
15390 /* Avoid starting at end of buffer. */
15391 || CHARPOS (startp
) == BEGV
15392 || (XFASTINT (w
->last_modified
) >= MODIFF
15393 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15395 int d1
, d2
, d3
, d4
, d5
, d6
;
15397 /* If first window line is a continuation line, and window start
15398 is inside the modified region, but the first change is before
15399 current window start, we must select a new window start.
15401 However, if this is the result of a down-mouse event (e.g. by
15402 extending the mouse-drag-overlay), we don't want to select a
15403 new window start, since that would change the position under
15404 the mouse, resulting in an unwanted mouse-movement rather
15405 than a simple mouse-click. */
15406 if (NILP (w
->start_at_line_beg
)
15407 && NILP (do_mouse_tracking
)
15408 && CHARPOS (startp
) > BEGV
15409 && CHARPOS (startp
) > BEG
+ beg_unchanged
15410 && CHARPOS (startp
) <= Z
- end_unchanged
15411 /* Even if w->start_at_line_beg is nil, a new window may
15412 start at a line_beg, since that's how set_buffer_window
15413 sets it. So, we need to check the return value of
15414 compute_window_start_on_continuation_line. (See also
15416 && XMARKER (w
->start
)->buffer
== current_buffer
15417 && compute_window_start_on_continuation_line (w
)
15418 /* It doesn't make sense to force the window start like we
15419 do at label force_start if it is already known that point
15420 will not be visible in the resulting window, because
15421 doing so will move point from its correct position
15422 instead of scrolling the window to bring point into view.
15424 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15426 w
->force_start
= Qt
;
15427 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15432 debug_method_add (w
, "same window start");
15435 /* Try to redisplay starting at same place as before.
15436 If point has not moved off frame, accept the results. */
15437 if (!current_matrix_up_to_date_p
15438 /* Don't use try_window_reusing_current_matrix in this case
15439 because a window scroll function can have changed the
15441 || !NILP (Vwindow_scroll_functions
)
15442 || MINI_WINDOW_P (w
)
15443 || !(used_current_matrix_p
15444 = try_window_reusing_current_matrix (w
)))
15446 IF_DEBUG (debug_method_add (w
, "1"));
15447 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15448 /* -1 means we need to scroll.
15449 0 means we need new matrices, but fonts_changed_p
15450 is set in that case, so we will detect it below. */
15451 goto try_to_scroll
;
15454 if (fonts_changed_p
)
15455 goto need_larger_matrices
;
15457 if (w
->cursor
.vpos
>= 0)
15459 if (!just_this_one_p
15460 || current_buffer
->clip_changed
15461 || BEG_UNCHANGED
< CHARPOS (startp
))
15462 /* Forget any recorded base line for line number display. */
15463 w
->base_line_number
= Qnil
;
15465 if (!cursor_row_fully_visible_p (w
, 1, 0))
15467 clear_glyph_matrix (w
->desired_matrix
);
15468 last_line_misfit
= 1;
15470 /* Drop through and scroll. */
15475 clear_glyph_matrix (w
->desired_matrix
);
15480 w
->last_modified
= make_number (0);
15481 w
->last_overlay_modified
= make_number (0);
15483 /* Redisplay the mode line. Select the buffer properly for that. */
15484 if (!update_mode_line
)
15486 update_mode_line
= 1;
15487 w
->update_mode_line
= Qt
;
15490 /* Try to scroll by specified few lines. */
15491 if ((scroll_conservatively
15492 || emacs_scroll_step
15493 || temp_scroll_step
15494 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15495 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15496 && CHARPOS (startp
) >= BEGV
15497 && CHARPOS (startp
) <= ZV
)
15499 /* The function returns -1 if new fonts were loaded, 1 if
15500 successful, 0 if not successful. */
15501 int ss
= try_scrolling (window
, just_this_one_p
,
15502 scroll_conservatively
,
15504 temp_scroll_step
, last_line_misfit
);
15507 case SCROLLING_SUCCESS
:
15510 case SCROLLING_NEED_LARGER_MATRICES
:
15511 goto need_larger_matrices
;
15513 case SCROLLING_FAILED
:
15521 /* Finally, just choose a place to start which positions point
15522 according to user preferences. */
15527 debug_method_add (w
, "recenter");
15530 /* w->vscroll = 0; */
15532 /* Forget any previously recorded base line for line number display. */
15533 if (!buffer_unchanged_p
)
15534 w
->base_line_number
= Qnil
;
15536 /* Determine the window start relative to point. */
15537 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15538 it
.current_y
= it
.last_visible_y
;
15539 if (centering_position
< 0)
15543 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15545 ptrdiff_t margin_pos
= CHARPOS (startp
);
15547 Lisp_Object aggressive
;
15549 /* If there is a scroll margin at the top of the window, find
15550 its character position. */
15552 /* Cannot call start_display if startp is not in the
15553 accessible region of the buffer. This can happen when we
15554 have just switched to a different buffer and/or changed
15555 its restriction. In that case, startp is initialized to
15556 the character position 1 (BEG) because we did not yet
15557 have chance to display the buffer even once. */
15558 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15561 void *it1data
= NULL
;
15563 SAVE_IT (it1
, it
, it1data
);
15564 start_display (&it1
, w
, startp
);
15565 move_it_vertically (&it1
, margin
);
15566 margin_pos
= IT_CHARPOS (it1
);
15567 RESTORE_IT (&it
, &it
, it1data
);
15569 scrolling_up
= PT
> margin_pos
;
15572 ? BVAR (current_buffer
, scroll_up_aggressively
)
15573 : BVAR (current_buffer
, scroll_down_aggressively
);
15575 if (!MINI_WINDOW_P (w
)
15576 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15580 /* Setting scroll-conservatively overrides
15581 scroll-*-aggressively. */
15582 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15584 double float_amount
= XFLOATINT (aggressive
);
15586 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15587 if (pt_offset
== 0 && float_amount
> 0)
15592 /* Compute how much to move the window start backward from
15593 point so that point will be displayed where the user
15597 centering_position
= it
.last_visible_y
;
15599 centering_position
-= pt_offset
;
15600 centering_position
-=
15601 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15602 + WINDOW_HEADER_LINE_HEIGHT (w
);
15603 /* Don't let point enter the scroll margin near top of
15605 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15606 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15609 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15612 /* Set the window start half the height of the window backward
15614 centering_position
= window_box_height (w
) / 2;
15616 move_it_vertically_backward (&it
, centering_position
);
15618 xassert (IT_CHARPOS (it
) >= BEGV
);
15620 /* The function move_it_vertically_backward may move over more
15621 than the specified y-distance. If it->w is small, e.g. a
15622 mini-buffer window, we may end up in front of the window's
15623 display area. Start displaying at the start of the line
15624 containing PT in this case. */
15625 if (it
.current_y
<= 0)
15627 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15628 move_it_vertically_backward (&it
, 0);
15632 it
.current_x
= it
.hpos
= 0;
15634 /* Set the window start position here explicitly, to avoid an
15635 infinite loop in case the functions in window-scroll-functions
15637 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15639 /* Run scroll hooks. */
15640 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15642 /* Redisplay the window. */
15643 if (!current_matrix_up_to_date_p
15644 || windows_or_buffers_changed
15645 || cursor_type_changed
15646 /* Don't use try_window_reusing_current_matrix in this case
15647 because it can have changed the buffer. */
15648 || !NILP (Vwindow_scroll_functions
)
15649 || !just_this_one_p
15650 || MINI_WINDOW_P (w
)
15651 || !(used_current_matrix_p
15652 = try_window_reusing_current_matrix (w
)))
15653 try_window (window
, startp
, 0);
15655 /* If new fonts have been loaded (due to fontsets), give up. We
15656 have to start a new redisplay since we need to re-adjust glyph
15658 if (fonts_changed_p
)
15659 goto need_larger_matrices
;
15661 /* If cursor did not appear assume that the middle of the window is
15662 in the first line of the window. Do it again with the next line.
15663 (Imagine a window of height 100, displaying two lines of height
15664 60. Moving back 50 from it->last_visible_y will end in the first
15666 if (w
->cursor
.vpos
< 0)
15668 if (!NILP (w
->window_end_valid
)
15669 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15671 clear_glyph_matrix (w
->desired_matrix
);
15672 move_it_by_lines (&it
, 1);
15673 try_window (window
, it
.current
.pos
, 0);
15675 else if (PT
< IT_CHARPOS (it
))
15677 clear_glyph_matrix (w
->desired_matrix
);
15678 move_it_by_lines (&it
, -1);
15679 try_window (window
, it
.current
.pos
, 0);
15683 /* Not much we can do about it. */
15687 /* Consider the following case: Window starts at BEGV, there is
15688 invisible, intangible text at BEGV, so that display starts at
15689 some point START > BEGV. It can happen that we are called with
15690 PT somewhere between BEGV and START. Try to handle that case. */
15691 if (w
->cursor
.vpos
< 0)
15693 struct glyph_row
*row
= w
->current_matrix
->rows
;
15694 if (row
->mode_line_p
)
15696 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15699 if (!cursor_row_fully_visible_p (w
, 0, 0))
15701 /* If vscroll is enabled, disable it and try again. */
15705 clear_glyph_matrix (w
->desired_matrix
);
15709 /* If centering point failed to make the whole line visible,
15710 put point at the top instead. That has to make the whole line
15711 visible, if it can be done. */
15712 if (centering_position
== 0)
15715 clear_glyph_matrix (w
->desired_matrix
);
15716 centering_position
= 0;
15722 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15723 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15724 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15727 /* Display the mode line, if we must. */
15728 if ((update_mode_line
15729 /* If window not full width, must redo its mode line
15730 if (a) the window to its side is being redone and
15731 (b) we do a frame-based redisplay. This is a consequence
15732 of how inverted lines are drawn in frame-based redisplay. */
15733 || (!just_this_one_p
15734 && !FRAME_WINDOW_P (f
)
15735 && !WINDOW_FULL_WIDTH_P (w
))
15736 /* Line number to display. */
15737 || INTEGERP (w
->base_line_pos
)
15738 /* Column number is displayed and different from the one displayed. */
15739 || (!NILP (w
->column_number_displayed
)
15740 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15741 /* This means that the window has a mode line. */
15742 && (WINDOW_WANTS_MODELINE_P (w
)
15743 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15745 display_mode_lines (w
);
15747 /* If mode line height has changed, arrange for a thorough
15748 immediate redisplay using the correct mode line height. */
15749 if (WINDOW_WANTS_MODELINE_P (w
)
15750 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15752 fonts_changed_p
= 1;
15753 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15754 = DESIRED_MODE_LINE_HEIGHT (w
);
15757 /* If header line height has changed, arrange for a thorough
15758 immediate redisplay using the correct header line height. */
15759 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15760 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15762 fonts_changed_p
= 1;
15763 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15764 = DESIRED_HEADER_LINE_HEIGHT (w
);
15767 if (fonts_changed_p
)
15768 goto need_larger_matrices
;
15771 if (!line_number_displayed
15772 && !BUFFERP (w
->base_line_pos
))
15774 w
->base_line_pos
= Qnil
;
15775 w
->base_line_number
= Qnil
;
15780 /* When we reach a frame's selected window, redo the frame's menu bar. */
15781 if (update_mode_line
15782 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15784 int redisplay_menu_p
= 0;
15786 if (FRAME_WINDOW_P (f
))
15788 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15789 || defined (HAVE_NS) || defined (USE_GTK)
15790 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15792 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15796 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15798 if (redisplay_menu_p
)
15799 display_menu_bar (w
);
15801 #ifdef HAVE_WINDOW_SYSTEM
15802 if (FRAME_WINDOW_P (f
))
15804 #if defined (USE_GTK) || defined (HAVE_NS)
15805 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15806 redisplay_tool_bar (f
);
15808 if (WINDOWP (f
->tool_bar_window
)
15809 && (FRAME_TOOL_BAR_LINES (f
) > 0
15810 || !NILP (Vauto_resize_tool_bars
))
15811 && redisplay_tool_bar (f
))
15812 ignore_mouse_drag_p
= 1;
15818 #ifdef HAVE_WINDOW_SYSTEM
15819 if (FRAME_WINDOW_P (f
)
15820 && update_window_fringes (w
, (just_this_one_p
15821 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15822 || w
->pseudo_window_p
)))
15826 if (draw_window_fringes (w
, 1))
15827 x_draw_vertical_border (w
);
15831 #endif /* HAVE_WINDOW_SYSTEM */
15833 /* We go to this label, with fonts_changed_p nonzero,
15834 if it is necessary to try again using larger glyph matrices.
15835 We have to redeem the scroll bar even in this case,
15836 because the loop in redisplay_internal expects that. */
15837 need_larger_matrices
:
15839 finish_scroll_bars
:
15841 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15843 /* Set the thumb's position and size. */
15844 set_vertical_scroll_bar (w
);
15846 /* Note that we actually used the scroll bar attached to this
15847 window, so it shouldn't be deleted at the end of redisplay. */
15848 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15849 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15852 /* Restore current_buffer and value of point in it. The window
15853 update may have changed the buffer, so first make sure `opoint'
15854 is still valid (Bug#6177). */
15855 if (CHARPOS (opoint
) < BEGV
)
15856 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15857 else if (CHARPOS (opoint
) > ZV
)
15858 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15860 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15862 set_buffer_internal_1 (old
);
15863 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15864 shorter. This can be caused by log truncation in *Messages*. */
15865 if (CHARPOS (lpoint
) <= ZV
)
15866 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15868 unbind_to (count
, Qnil
);
15872 /* Build the complete desired matrix of WINDOW with a window start
15873 buffer position POS.
15875 Value is 1 if successful. It is zero if fonts were loaded during
15876 redisplay which makes re-adjusting glyph matrices necessary, and -1
15877 if point would appear in the scroll margins.
15878 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15879 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15883 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15885 struct window
*w
= XWINDOW (window
);
15887 struct glyph_row
*last_text_row
= NULL
;
15888 struct frame
*f
= XFRAME (w
->frame
);
15890 /* Make POS the new window start. */
15891 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15893 /* Mark cursor position as unknown. No overlay arrow seen. */
15894 w
->cursor
.vpos
= -1;
15895 overlay_arrow_seen
= 0;
15897 /* Initialize iterator and info to start at POS. */
15898 start_display (&it
, w
, pos
);
15900 /* Display all lines of W. */
15901 while (it
.current_y
< it
.last_visible_y
)
15903 if (display_line (&it
))
15904 last_text_row
= it
.glyph_row
- 1;
15905 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15909 /* Don't let the cursor end in the scroll margins. */
15910 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15911 && !MINI_WINDOW_P (w
))
15913 int this_scroll_margin
;
15915 if (scroll_margin
> 0)
15917 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15918 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15921 this_scroll_margin
= 0;
15923 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15924 && w
->cursor
.y
< this_scroll_margin
15925 && CHARPOS (pos
) > BEGV
15926 && IT_CHARPOS (it
) < ZV
)
15927 /* rms: considering make_cursor_line_fully_visible_p here
15928 seems to give wrong results. We don't want to recenter
15929 when the last line is partly visible, we want to allow
15930 that case to be handled in the usual way. */
15931 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15933 w
->cursor
.vpos
= -1;
15934 clear_glyph_matrix (w
->desired_matrix
);
15939 /* If bottom moved off end of frame, change mode line percentage. */
15940 if (XFASTINT (w
->window_end_pos
) <= 0
15941 && Z
!= IT_CHARPOS (it
))
15942 w
->update_mode_line
= Qt
;
15944 /* Set window_end_pos to the offset of the last character displayed
15945 on the window from the end of current_buffer. Set
15946 window_end_vpos to its row number. */
15949 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15950 w
->window_end_bytepos
15951 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15953 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15955 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15956 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15957 ->displays_text_p
);
15961 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15962 w
->window_end_pos
= make_number (Z
- ZV
);
15963 w
->window_end_vpos
= make_number (0);
15966 /* But that is not valid info until redisplay finishes. */
15967 w
->window_end_valid
= Qnil
;
15973 /************************************************************************
15974 Window redisplay reusing current matrix when buffer has not changed
15975 ************************************************************************/
15977 /* Try redisplay of window W showing an unchanged buffer with a
15978 different window start than the last time it was displayed by
15979 reusing its current matrix. Value is non-zero if successful.
15980 W->start is the new window start. */
15983 try_window_reusing_current_matrix (struct window
*w
)
15985 struct frame
*f
= XFRAME (w
->frame
);
15986 struct glyph_row
*bottom_row
;
15989 struct text_pos start
, new_start
;
15990 int nrows_scrolled
, i
;
15991 struct glyph_row
*last_text_row
;
15992 struct glyph_row
*last_reused_text_row
;
15993 struct glyph_row
*start_row
;
15994 int start_vpos
, min_y
, max_y
;
15997 if (inhibit_try_window_reusing
)
16001 if (/* This function doesn't handle terminal frames. */
16002 !FRAME_WINDOW_P (f
)
16003 /* Don't try to reuse the display if windows have been split
16005 || windows_or_buffers_changed
16006 || cursor_type_changed
)
16009 /* Can't do this if region may have changed. */
16010 if ((!NILP (Vtransient_mark_mode
)
16011 && !NILP (BVAR (current_buffer
, mark_active
)))
16012 || !NILP (w
->region_showing
)
16013 || !NILP (Vshow_trailing_whitespace
))
16016 /* If top-line visibility has changed, give up. */
16017 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16018 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16021 /* Give up if old or new display is scrolled vertically. We could
16022 make this function handle this, but right now it doesn't. */
16023 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16024 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16027 /* The variable new_start now holds the new window start. The old
16028 start `start' can be determined from the current matrix. */
16029 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16030 start
= start_row
->minpos
;
16031 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16033 /* Clear the desired matrix for the display below. */
16034 clear_glyph_matrix (w
->desired_matrix
);
16036 if (CHARPOS (new_start
) <= CHARPOS (start
))
16038 /* Don't use this method if the display starts with an ellipsis
16039 displayed for invisible text. It's not easy to handle that case
16040 below, and it's certainly not worth the effort since this is
16041 not a frequent case. */
16042 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16045 IF_DEBUG (debug_method_add (w
, "twu1"));
16047 /* Display up to a row that can be reused. The variable
16048 last_text_row is set to the last row displayed that displays
16049 text. Note that it.vpos == 0 if or if not there is a
16050 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16051 start_display (&it
, w
, new_start
);
16052 w
->cursor
.vpos
= -1;
16053 last_text_row
= last_reused_text_row
= NULL
;
16055 while (it
.current_y
< it
.last_visible_y
16056 && !fonts_changed_p
)
16058 /* If we have reached into the characters in the START row,
16059 that means the line boundaries have changed. So we
16060 can't start copying with the row START. Maybe it will
16061 work to start copying with the following row. */
16062 while (IT_CHARPOS (it
) > CHARPOS (start
))
16064 /* Advance to the next row as the "start". */
16066 start
= start_row
->minpos
;
16067 /* If there are no more rows to try, or just one, give up. */
16068 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16069 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16070 || CHARPOS (start
) == ZV
)
16072 clear_glyph_matrix (w
->desired_matrix
);
16076 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16078 /* If we have reached alignment,
16079 we can copy the rest of the rows. */
16080 if (IT_CHARPOS (it
) == CHARPOS (start
))
16083 if (display_line (&it
))
16084 last_text_row
= it
.glyph_row
- 1;
16087 /* A value of current_y < last_visible_y means that we stopped
16088 at the previous window start, which in turn means that we
16089 have at least one reusable row. */
16090 if (it
.current_y
< it
.last_visible_y
)
16092 struct glyph_row
*row
;
16094 /* IT.vpos always starts from 0; it counts text lines. */
16095 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16097 /* Find PT if not already found in the lines displayed. */
16098 if (w
->cursor
.vpos
< 0)
16100 int dy
= it
.current_y
- start_row
->y
;
16102 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16103 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16105 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16106 dy
, nrows_scrolled
);
16109 clear_glyph_matrix (w
->desired_matrix
);
16114 /* Scroll the display. Do it before the current matrix is
16115 changed. The problem here is that update has not yet
16116 run, i.e. part of the current matrix is not up to date.
16117 scroll_run_hook will clear the cursor, and use the
16118 current matrix to get the height of the row the cursor is
16120 run
.current_y
= start_row
->y
;
16121 run
.desired_y
= it
.current_y
;
16122 run
.height
= it
.last_visible_y
- it
.current_y
;
16124 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16127 FRAME_RIF (f
)->update_window_begin_hook (w
);
16128 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16129 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16130 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16134 /* Shift current matrix down by nrows_scrolled lines. */
16135 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16136 rotate_matrix (w
->current_matrix
,
16138 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16141 /* Disable lines that must be updated. */
16142 for (i
= 0; i
< nrows_scrolled
; ++i
)
16143 (start_row
+ i
)->enabled_p
= 0;
16145 /* Re-compute Y positions. */
16146 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16147 max_y
= it
.last_visible_y
;
16148 for (row
= start_row
+ nrows_scrolled
;
16152 row
->y
= it
.current_y
;
16153 row
->visible_height
= row
->height
;
16155 if (row
->y
< min_y
)
16156 row
->visible_height
-= min_y
- row
->y
;
16157 if (row
->y
+ row
->height
> max_y
)
16158 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16159 if (row
->fringe_bitmap_periodic_p
)
16160 row
->redraw_fringe_bitmaps_p
= 1;
16162 it
.current_y
+= row
->height
;
16164 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16165 last_reused_text_row
= row
;
16166 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16170 /* Disable lines in the current matrix which are now
16171 below the window. */
16172 for (++row
; row
< bottom_row
; ++row
)
16173 row
->enabled_p
= row
->mode_line_p
= 0;
16176 /* Update window_end_pos etc.; last_reused_text_row is the last
16177 reused row from the current matrix containing text, if any.
16178 The value of last_text_row is the last displayed line
16179 containing text. */
16180 if (last_reused_text_row
)
16182 w
->window_end_bytepos
16183 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16185 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16187 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16188 w
->current_matrix
));
16190 else if (last_text_row
)
16192 w
->window_end_bytepos
16193 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16195 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16197 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16201 /* This window must be completely empty. */
16202 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16203 w
->window_end_pos
= make_number (Z
- ZV
);
16204 w
->window_end_vpos
= make_number (0);
16206 w
->window_end_valid
= Qnil
;
16208 /* Update hint: don't try scrolling again in update_window. */
16209 w
->desired_matrix
->no_scrolling_p
= 1;
16212 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16216 else if (CHARPOS (new_start
) > CHARPOS (start
))
16218 struct glyph_row
*pt_row
, *row
;
16219 struct glyph_row
*first_reusable_row
;
16220 struct glyph_row
*first_row_to_display
;
16222 int yb
= window_text_bottom_y (w
);
16224 /* Find the row starting at new_start, if there is one. Don't
16225 reuse a partially visible line at the end. */
16226 first_reusable_row
= start_row
;
16227 while (first_reusable_row
->enabled_p
16228 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16229 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16230 < CHARPOS (new_start
)))
16231 ++first_reusable_row
;
16233 /* Give up if there is no row to reuse. */
16234 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16235 || !first_reusable_row
->enabled_p
16236 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16237 != CHARPOS (new_start
)))
16240 /* We can reuse fully visible rows beginning with
16241 first_reusable_row to the end of the window. Set
16242 first_row_to_display to the first row that cannot be reused.
16243 Set pt_row to the row containing point, if there is any. */
16245 for (first_row_to_display
= first_reusable_row
;
16246 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16247 ++first_row_to_display
)
16249 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16250 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16251 pt_row
= first_row_to_display
;
16254 /* Start displaying at the start of first_row_to_display. */
16255 xassert (first_row_to_display
->y
< yb
);
16256 init_to_row_start (&it
, w
, first_row_to_display
);
16258 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16260 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16262 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16263 + WINDOW_HEADER_LINE_HEIGHT (w
));
16265 /* Display lines beginning with first_row_to_display in the
16266 desired matrix. Set last_text_row to the last row displayed
16267 that displays text. */
16268 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16269 if (pt_row
== NULL
)
16270 w
->cursor
.vpos
= -1;
16271 last_text_row
= NULL
;
16272 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16273 if (display_line (&it
))
16274 last_text_row
= it
.glyph_row
- 1;
16276 /* If point is in a reused row, adjust y and vpos of the cursor
16280 w
->cursor
.vpos
-= nrows_scrolled
;
16281 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16284 /* Give up if point isn't in a row displayed or reused. (This
16285 also handles the case where w->cursor.vpos < nrows_scrolled
16286 after the calls to display_line, which can happen with scroll
16287 margins. See bug#1295.) */
16288 if (w
->cursor
.vpos
< 0)
16290 clear_glyph_matrix (w
->desired_matrix
);
16294 /* Scroll the display. */
16295 run
.current_y
= first_reusable_row
->y
;
16296 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16297 run
.height
= it
.last_visible_y
- run
.current_y
;
16298 dy
= run
.current_y
- run
.desired_y
;
16303 FRAME_RIF (f
)->update_window_begin_hook (w
);
16304 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16305 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16306 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16310 /* Adjust Y positions of reused rows. */
16311 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16312 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16313 max_y
= it
.last_visible_y
;
16314 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16317 row
->visible_height
= row
->height
;
16318 if (row
->y
< min_y
)
16319 row
->visible_height
-= min_y
- row
->y
;
16320 if (row
->y
+ row
->height
> max_y
)
16321 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16322 if (row
->fringe_bitmap_periodic_p
)
16323 row
->redraw_fringe_bitmaps_p
= 1;
16326 /* Scroll the current matrix. */
16327 xassert (nrows_scrolled
> 0);
16328 rotate_matrix (w
->current_matrix
,
16330 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16333 /* Disable rows not reused. */
16334 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16335 row
->enabled_p
= 0;
16337 /* Point may have moved to a different line, so we cannot assume that
16338 the previous cursor position is valid; locate the correct row. */
16341 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16342 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16346 w
->cursor
.y
= row
->y
;
16348 if (row
< bottom_row
)
16350 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16351 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16353 /* Can't use this optimization with bidi-reordered glyph
16354 rows, unless cursor is already at point. */
16355 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16357 if (!(w
->cursor
.hpos
>= 0
16358 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16359 && BUFFERP (glyph
->object
)
16360 && glyph
->charpos
== PT
))
16365 && (!BUFFERP (glyph
->object
)
16366 || glyph
->charpos
< PT
);
16370 w
->cursor
.x
+= glyph
->pixel_width
;
16375 /* Adjust window end. A null value of last_text_row means that
16376 the window end is in reused rows which in turn means that
16377 only its vpos can have changed. */
16380 w
->window_end_bytepos
16381 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16383 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16385 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16390 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16393 w
->window_end_valid
= Qnil
;
16394 w
->desired_matrix
->no_scrolling_p
= 1;
16397 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16407 /************************************************************************
16408 Window redisplay reusing current matrix when buffer has changed
16409 ************************************************************************/
16411 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16412 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16413 ptrdiff_t *, ptrdiff_t *);
16414 static struct glyph_row
*
16415 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16416 struct glyph_row
*);
16419 /* Return the last row in MATRIX displaying text. If row START is
16420 non-null, start searching with that row. IT gives the dimensions
16421 of the display. Value is null if matrix is empty; otherwise it is
16422 a pointer to the row found. */
16424 static struct glyph_row
*
16425 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16426 struct glyph_row
*start
)
16428 struct glyph_row
*row
, *row_found
;
16430 /* Set row_found to the last row in IT->w's current matrix
16431 displaying text. The loop looks funny but think of partially
16434 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16435 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16437 xassert (row
->enabled_p
);
16439 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16448 /* Return the last row in the current matrix of W that is not affected
16449 by changes at the start of current_buffer that occurred since W's
16450 current matrix was built. Value is null if no such row exists.
16452 BEG_UNCHANGED us the number of characters unchanged at the start of
16453 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16454 first changed character in current_buffer. Characters at positions <
16455 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16456 when the current matrix was built. */
16458 static struct glyph_row
*
16459 find_last_unchanged_at_beg_row (struct window
*w
)
16461 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16462 struct glyph_row
*row
;
16463 struct glyph_row
*row_found
= NULL
;
16464 int yb
= window_text_bottom_y (w
);
16466 /* Find the last row displaying unchanged text. */
16467 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16468 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16469 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16472 if (/* If row ends before first_changed_pos, it is unchanged,
16473 except in some case. */
16474 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16475 /* When row ends in ZV and we write at ZV it is not
16477 && !row
->ends_at_zv_p
16478 /* When first_changed_pos is the end of a continued line,
16479 row is not unchanged because it may be no longer
16481 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16482 && (row
->continued_p
16483 || row
->exact_window_width_line_p
)))
16486 /* Stop if last visible row. */
16487 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16495 /* Find the first glyph row in the current matrix of W that is not
16496 affected by changes at the end of current_buffer since the
16497 time W's current matrix was built.
16499 Return in *DELTA the number of chars by which buffer positions in
16500 unchanged text at the end of current_buffer must be adjusted.
16502 Return in *DELTA_BYTES the corresponding number of bytes.
16504 Value is null if no such row exists, i.e. all rows are affected by
16507 static struct glyph_row
*
16508 find_first_unchanged_at_end_row (struct window
*w
,
16509 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16511 struct glyph_row
*row
;
16512 struct glyph_row
*row_found
= NULL
;
16514 *delta
= *delta_bytes
= 0;
16516 /* Display must not have been paused, otherwise the current matrix
16517 is not up to date. */
16518 eassert (!NILP (w
->window_end_valid
));
16520 /* A value of window_end_pos >= END_UNCHANGED means that the window
16521 end is in the range of changed text. If so, there is no
16522 unchanged row at the end of W's current matrix. */
16523 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16526 /* Set row to the last row in W's current matrix displaying text. */
16527 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16529 /* If matrix is entirely empty, no unchanged row exists. */
16530 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16532 /* The value of row is the last glyph row in the matrix having a
16533 meaningful buffer position in it. The end position of row
16534 corresponds to window_end_pos. This allows us to translate
16535 buffer positions in the current matrix to current buffer
16536 positions for characters not in changed text. */
16538 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16539 ptrdiff_t Z_BYTE_old
=
16540 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16541 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16542 struct glyph_row
*first_text_row
16543 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16545 *delta
= Z
- Z_old
;
16546 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16548 /* Set last_unchanged_pos to the buffer position of the last
16549 character in the buffer that has not been changed. Z is the
16550 index + 1 of the last character in current_buffer, i.e. by
16551 subtracting END_UNCHANGED we get the index of the last
16552 unchanged character, and we have to add BEG to get its buffer
16554 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16555 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16557 /* Search backward from ROW for a row displaying a line that
16558 starts at a minimum position >= last_unchanged_pos_old. */
16559 for (; row
> first_text_row
; --row
)
16561 /* This used to abort, but it can happen.
16562 It is ok to just stop the search instead here. KFS. */
16563 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16566 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16571 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16577 /* Make sure that glyph rows in the current matrix of window W
16578 reference the same glyph memory as corresponding rows in the
16579 frame's frame matrix. This function is called after scrolling W's
16580 current matrix on a terminal frame in try_window_id and
16581 try_window_reusing_current_matrix. */
16584 sync_frame_with_window_matrix_rows (struct window
*w
)
16586 struct frame
*f
= XFRAME (w
->frame
);
16587 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16589 /* Preconditions: W must be a leaf window and full-width. Its frame
16590 must have a frame matrix. */
16591 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16592 xassert (WINDOW_FULL_WIDTH_P (w
));
16593 xassert (!FRAME_WINDOW_P (f
));
16595 /* If W is a full-width window, glyph pointers in W's current matrix
16596 have, by definition, to be the same as glyph pointers in the
16597 corresponding frame matrix. Note that frame matrices have no
16598 marginal areas (see build_frame_matrix). */
16599 window_row
= w
->current_matrix
->rows
;
16600 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16601 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16602 while (window_row
< window_row_end
)
16604 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16605 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16607 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16608 frame_row
->glyphs
[TEXT_AREA
] = start
;
16609 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16610 frame_row
->glyphs
[LAST_AREA
] = end
;
16612 /* Disable frame rows whose corresponding window rows have
16613 been disabled in try_window_id. */
16614 if (!window_row
->enabled_p
)
16615 frame_row
->enabled_p
= 0;
16617 ++window_row
, ++frame_row
;
16622 /* Find the glyph row in window W containing CHARPOS. Consider all
16623 rows between START and END (not inclusive). END null means search
16624 all rows to the end of the display area of W. Value is the row
16625 containing CHARPOS or null. */
16628 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16629 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16631 struct glyph_row
*row
= start
;
16632 struct glyph_row
*best_row
= NULL
;
16633 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16636 /* If we happen to start on a header-line, skip that. */
16637 if (row
->mode_line_p
)
16640 if ((end
&& row
>= end
) || !row
->enabled_p
)
16643 last_y
= window_text_bottom_y (w
) - dy
;
16647 /* Give up if we have gone too far. */
16648 if (end
&& row
>= end
)
16650 /* This formerly returned if they were equal.
16651 I think that both quantities are of a "last plus one" type;
16652 if so, when they are equal, the row is within the screen. -- rms. */
16653 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16656 /* If it is in this row, return this row. */
16657 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16658 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16659 /* The end position of a row equals the start
16660 position of the next row. If CHARPOS is there, we
16661 would rather display it in the next line, except
16662 when this line ends in ZV. */
16663 && !row
->ends_at_zv_p
16664 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16665 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16669 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16670 || (!best_row
&& !row
->continued_p
))
16672 /* In bidi-reordered rows, there could be several rows
16673 occluding point, all of them belonging to the same
16674 continued line. We need to find the row which fits
16675 CHARPOS the best. */
16676 for (g
= row
->glyphs
[TEXT_AREA
];
16677 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16680 if (!STRINGP (g
->object
))
16682 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16684 mindif
= eabs (g
->charpos
- charpos
);
16686 /* Exact match always wins. */
16693 else if (best_row
&& !row
->continued_p
)
16700 /* Try to redisplay window W by reusing its existing display. W's
16701 current matrix must be up to date when this function is called,
16702 i.e. window_end_valid must not be nil.
16706 1 if display has been updated
16707 0 if otherwise unsuccessful
16708 -1 if redisplay with same window start is known not to succeed
16710 The following steps are performed:
16712 1. Find the last row in the current matrix of W that is not
16713 affected by changes at the start of current_buffer. If no such row
16716 2. Find the first row in W's current matrix that is not affected by
16717 changes at the end of current_buffer. Maybe there is no such row.
16719 3. Display lines beginning with the row + 1 found in step 1 to the
16720 row found in step 2 or, if step 2 didn't find a row, to the end of
16723 4. If cursor is not known to appear on the window, give up.
16725 5. If display stopped at the row found in step 2, scroll the
16726 display and current matrix as needed.
16728 6. Maybe display some lines at the end of W, if we must. This can
16729 happen under various circumstances, like a partially visible line
16730 becoming fully visible, or because newly displayed lines are displayed
16731 in smaller font sizes.
16733 7. Update W's window end information. */
16736 try_window_id (struct window
*w
)
16738 struct frame
*f
= XFRAME (w
->frame
);
16739 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16740 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16741 struct glyph_row
*last_unchanged_at_beg_row
;
16742 struct glyph_row
*first_unchanged_at_end_row
;
16743 struct glyph_row
*row
;
16744 struct glyph_row
*bottom_row
;
16747 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
16749 struct text_pos start_pos
;
16751 int first_unchanged_at_end_vpos
= 0;
16752 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16753 struct text_pos start
;
16754 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
16757 if (inhibit_try_window_id
)
16761 /* This is handy for debugging. */
16763 #define GIVE_UP(X) \
16765 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16769 #define GIVE_UP(X) return 0
16772 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16774 /* Don't use this for mini-windows because these can show
16775 messages and mini-buffers, and we don't handle that here. */
16776 if (MINI_WINDOW_P (w
))
16779 /* This flag is used to prevent redisplay optimizations. */
16780 if (windows_or_buffers_changed
|| cursor_type_changed
)
16783 /* Verify that narrowing has not changed.
16784 Also verify that we were not told to prevent redisplay optimizations.
16785 It would be nice to further
16786 reduce the number of cases where this prevents try_window_id. */
16787 if (current_buffer
->clip_changed
16788 || current_buffer
->prevent_redisplay_optimizations_p
)
16791 /* Window must either use window-based redisplay or be full width. */
16792 if (!FRAME_WINDOW_P (f
)
16793 && (!FRAME_LINE_INS_DEL_OK (f
)
16794 || !WINDOW_FULL_WIDTH_P (w
)))
16797 /* Give up if point is known NOT to appear in W. */
16798 if (PT
< CHARPOS (start
))
16801 /* Another way to prevent redisplay optimizations. */
16802 if (XFASTINT (w
->last_modified
) == 0)
16805 /* Verify that window is not hscrolled. */
16806 if (XFASTINT (w
->hscroll
) != 0)
16809 /* Verify that display wasn't paused. */
16810 if (NILP (w
->window_end_valid
))
16813 /* Can't use this if highlighting a region because a cursor movement
16814 will do more than just set the cursor. */
16815 if (!NILP (Vtransient_mark_mode
)
16816 && !NILP (BVAR (current_buffer
, mark_active
)))
16819 /* Likewise if highlighting trailing whitespace. */
16820 if (!NILP (Vshow_trailing_whitespace
))
16823 /* Likewise if showing a region. */
16824 if (!NILP (w
->region_showing
))
16827 /* Can't use this if overlay arrow position and/or string have
16829 if (overlay_arrows_changed_p ())
16832 /* When word-wrap is on, adding a space to the first word of a
16833 wrapped line can change the wrap position, altering the line
16834 above it. It might be worthwhile to handle this more
16835 intelligently, but for now just redisplay from scratch. */
16836 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16839 /* Under bidi reordering, adding or deleting a character in the
16840 beginning of a paragraph, before the first strong directional
16841 character, can change the base direction of the paragraph (unless
16842 the buffer specifies a fixed paragraph direction), which will
16843 require to redisplay the whole paragraph. It might be worthwhile
16844 to find the paragraph limits and widen the range of redisplayed
16845 lines to that, but for now just give up this optimization and
16846 redisplay from scratch. */
16847 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16848 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16851 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16852 only if buffer has really changed. The reason is that the gap is
16853 initially at Z for freshly visited files. The code below would
16854 set end_unchanged to 0 in that case. */
16855 if (MODIFF
> SAVE_MODIFF
16856 /* This seems to happen sometimes after saving a buffer. */
16857 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16859 if (GPT
- BEG
< BEG_UNCHANGED
)
16860 BEG_UNCHANGED
= GPT
- BEG
;
16861 if (Z
- GPT
< END_UNCHANGED
)
16862 END_UNCHANGED
= Z
- GPT
;
16865 /* The position of the first and last character that has been changed. */
16866 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16867 last_changed_charpos
= Z
- END_UNCHANGED
;
16869 /* If window starts after a line end, and the last change is in
16870 front of that newline, then changes don't affect the display.
16871 This case happens with stealth-fontification. Note that although
16872 the display is unchanged, glyph positions in the matrix have to
16873 be adjusted, of course. */
16874 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16875 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16876 && ((last_changed_charpos
< CHARPOS (start
)
16877 && CHARPOS (start
) == BEGV
)
16878 || (last_changed_charpos
< CHARPOS (start
) - 1
16879 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16881 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16882 struct glyph_row
*r0
;
16884 /* Compute how many chars/bytes have been added to or removed
16885 from the buffer. */
16886 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16887 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16888 Z_delta
= Z
- Z_old
;
16889 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16891 /* Give up if PT is not in the window. Note that it already has
16892 been checked at the start of try_window_id that PT is not in
16893 front of the window start. */
16894 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16897 /* If window start is unchanged, we can reuse the whole matrix
16898 as is, after adjusting glyph positions. No need to compute
16899 the window end again, since its offset from Z hasn't changed. */
16900 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16901 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16902 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16903 /* PT must not be in a partially visible line. */
16904 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16905 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16907 /* Adjust positions in the glyph matrix. */
16908 if (Z_delta
|| Z_delta_bytes
)
16910 struct glyph_row
*r1
16911 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16912 increment_matrix_positions (w
->current_matrix
,
16913 MATRIX_ROW_VPOS (r0
, current_matrix
),
16914 MATRIX_ROW_VPOS (r1
, current_matrix
),
16915 Z_delta
, Z_delta_bytes
);
16918 /* Set the cursor. */
16919 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16921 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16928 /* Handle the case that changes are all below what is displayed in
16929 the window, and that PT is in the window. This shortcut cannot
16930 be taken if ZV is visible in the window, and text has been added
16931 there that is visible in the window. */
16932 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16933 /* ZV is not visible in the window, or there are no
16934 changes at ZV, actually. */
16935 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16936 || first_changed_charpos
== last_changed_charpos
))
16938 struct glyph_row
*r0
;
16940 /* Give up if PT is not in the window. Note that it already has
16941 been checked at the start of try_window_id that PT is not in
16942 front of the window start. */
16943 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16946 /* If window start is unchanged, we can reuse the whole matrix
16947 as is, without changing glyph positions since no text has
16948 been added/removed in front of the window end. */
16949 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16950 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16951 /* PT must not be in a partially visible line. */
16952 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16953 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16955 /* We have to compute the window end anew since text
16956 could have been added/removed after it. */
16958 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16959 w
->window_end_bytepos
16960 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16962 /* Set the cursor. */
16963 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16965 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16972 /* Give up if window start is in the changed area.
16974 The condition used to read
16976 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16978 but why that was tested escapes me at the moment. */
16979 if (CHARPOS (start
) >= first_changed_charpos
16980 && CHARPOS (start
) <= last_changed_charpos
)
16983 /* Check that window start agrees with the start of the first glyph
16984 row in its current matrix. Check this after we know the window
16985 start is not in changed text, otherwise positions would not be
16987 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16988 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16991 /* Give up if the window ends in strings. Overlay strings
16992 at the end are difficult to handle, so don't try. */
16993 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16994 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16997 /* Compute the position at which we have to start displaying new
16998 lines. Some of the lines at the top of the window might be
16999 reusable because they are not displaying changed text. Find the
17000 last row in W's current matrix not affected by changes at the
17001 start of current_buffer. Value is null if changes start in the
17002 first line of window. */
17003 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17004 if (last_unchanged_at_beg_row
)
17006 /* Avoid starting to display in the moddle of a character, a TAB
17007 for instance. This is easier than to set up the iterator
17008 exactly, and it's not a frequent case, so the additional
17009 effort wouldn't really pay off. */
17010 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17011 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17012 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17013 --last_unchanged_at_beg_row
;
17015 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17018 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17020 start_pos
= it
.current
.pos
;
17022 /* Start displaying new lines in the desired matrix at the same
17023 vpos we would use in the current matrix, i.e. below
17024 last_unchanged_at_beg_row. */
17025 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17027 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17028 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17030 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17034 /* There are no reusable lines at the start of the window.
17035 Start displaying in the first text line. */
17036 start_display (&it
, w
, start
);
17037 it
.vpos
= it
.first_vpos
;
17038 start_pos
= it
.current
.pos
;
17041 /* Find the first row that is not affected by changes at the end of
17042 the buffer. Value will be null if there is no unchanged row, in
17043 which case we must redisplay to the end of the window. delta
17044 will be set to the value by which buffer positions beginning with
17045 first_unchanged_at_end_row have to be adjusted due to text
17047 first_unchanged_at_end_row
17048 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17049 IF_DEBUG (debug_delta
= delta
);
17050 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17052 /* Set stop_pos to the buffer position up to which we will have to
17053 display new lines. If first_unchanged_at_end_row != NULL, this
17054 is the buffer position of the start of the line displayed in that
17055 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17056 that we don't stop at a buffer position. */
17058 if (first_unchanged_at_end_row
)
17060 xassert (last_unchanged_at_beg_row
== NULL
17061 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17063 /* If this is a continuation line, move forward to the next one
17064 that isn't. Changes in lines above affect this line.
17065 Caution: this may move first_unchanged_at_end_row to a row
17066 not displaying text. */
17067 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17068 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17069 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17070 < it
.last_visible_y
))
17071 ++first_unchanged_at_end_row
;
17073 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17074 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17075 >= it
.last_visible_y
))
17076 first_unchanged_at_end_row
= NULL
;
17079 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17081 first_unchanged_at_end_vpos
17082 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17083 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17086 else if (last_unchanged_at_beg_row
== NULL
)
17092 /* Either there is no unchanged row at the end, or the one we have
17093 now displays text. This is a necessary condition for the window
17094 end pos calculation at the end of this function. */
17095 xassert (first_unchanged_at_end_row
== NULL
17096 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17098 debug_last_unchanged_at_beg_vpos
17099 = (last_unchanged_at_beg_row
17100 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17102 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17104 #endif /* GLYPH_DEBUG != 0 */
17107 /* Display new lines. Set last_text_row to the last new line
17108 displayed which has text on it, i.e. might end up as being the
17109 line where the window_end_vpos is. */
17110 w
->cursor
.vpos
= -1;
17111 last_text_row
= NULL
;
17112 overlay_arrow_seen
= 0;
17113 while (it
.current_y
< it
.last_visible_y
17114 && !fonts_changed_p
17115 && (first_unchanged_at_end_row
== NULL
17116 || IT_CHARPOS (it
) < stop_pos
))
17118 if (display_line (&it
))
17119 last_text_row
= it
.glyph_row
- 1;
17122 if (fonts_changed_p
)
17126 /* Compute differences in buffer positions, y-positions etc. for
17127 lines reused at the bottom of the window. Compute what we can
17129 if (first_unchanged_at_end_row
17130 /* No lines reused because we displayed everything up to the
17131 bottom of the window. */
17132 && it
.current_y
< it
.last_visible_y
)
17135 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17137 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17138 run
.current_y
= first_unchanged_at_end_row
->y
;
17139 run
.desired_y
= run
.current_y
+ dy
;
17140 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17144 delta
= delta_bytes
= dvpos
= dy
17145 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17146 first_unchanged_at_end_row
= NULL
;
17148 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17151 /* Find the cursor if not already found. We have to decide whether
17152 PT will appear on this window (it sometimes doesn't, but this is
17153 not a very frequent case.) This decision has to be made before
17154 the current matrix is altered. A value of cursor.vpos < 0 means
17155 that PT is either in one of the lines beginning at
17156 first_unchanged_at_end_row or below the window. Don't care for
17157 lines that might be displayed later at the window end; as
17158 mentioned, this is not a frequent case. */
17159 if (w
->cursor
.vpos
< 0)
17161 /* Cursor in unchanged rows at the top? */
17162 if (PT
< CHARPOS (start_pos
)
17163 && last_unchanged_at_beg_row
)
17165 row
= row_containing_pos (w
, PT
,
17166 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17167 last_unchanged_at_beg_row
+ 1, 0);
17169 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17172 /* Start from first_unchanged_at_end_row looking for PT. */
17173 else if (first_unchanged_at_end_row
)
17175 row
= row_containing_pos (w
, PT
- delta
,
17176 first_unchanged_at_end_row
, NULL
, 0);
17178 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17179 delta_bytes
, dy
, dvpos
);
17182 /* Give up if cursor was not found. */
17183 if (w
->cursor
.vpos
< 0)
17185 clear_glyph_matrix (w
->desired_matrix
);
17190 /* Don't let the cursor end in the scroll margins. */
17192 int this_scroll_margin
, cursor_height
;
17194 this_scroll_margin
=
17195 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17196 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17197 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17199 if ((w
->cursor
.y
< this_scroll_margin
17200 && CHARPOS (start
) > BEGV
)
17201 /* Old redisplay didn't take scroll margin into account at the bottom,
17202 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17203 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17204 ? cursor_height
+ this_scroll_margin
17205 : 1)) > it
.last_visible_y
)
17207 w
->cursor
.vpos
= -1;
17208 clear_glyph_matrix (w
->desired_matrix
);
17213 /* Scroll the display. Do it before changing the current matrix so
17214 that xterm.c doesn't get confused about where the cursor glyph is
17216 if (dy
&& run
.height
)
17220 if (FRAME_WINDOW_P (f
))
17222 FRAME_RIF (f
)->update_window_begin_hook (w
);
17223 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17224 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17225 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17229 /* Terminal frame. In this case, dvpos gives the number of
17230 lines to scroll by; dvpos < 0 means scroll up. */
17232 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17233 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17234 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17235 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17236 + window_internal_height (w
));
17238 #if defined (HAVE_GPM) || defined (MSDOS)
17239 x_clear_window_mouse_face (w
);
17241 /* Perform the operation on the screen. */
17244 /* Scroll last_unchanged_at_beg_row to the end of the
17245 window down dvpos lines. */
17246 set_terminal_window (f
, end
);
17248 /* On dumb terminals delete dvpos lines at the end
17249 before inserting dvpos empty lines. */
17250 if (!FRAME_SCROLL_REGION_OK (f
))
17251 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17253 /* Insert dvpos empty lines in front of
17254 last_unchanged_at_beg_row. */
17255 ins_del_lines (f
, from
, dvpos
);
17257 else if (dvpos
< 0)
17259 /* Scroll up last_unchanged_at_beg_vpos to the end of
17260 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17261 set_terminal_window (f
, end
);
17263 /* Delete dvpos lines in front of
17264 last_unchanged_at_beg_vpos. ins_del_lines will set
17265 the cursor to the given vpos and emit |dvpos| delete
17267 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17269 /* On a dumb terminal insert dvpos empty lines at the
17271 if (!FRAME_SCROLL_REGION_OK (f
))
17272 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17275 set_terminal_window (f
, 0);
17281 /* Shift reused rows of the current matrix to the right position.
17282 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17284 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17285 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17288 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17289 bottom_vpos
, dvpos
);
17290 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17293 else if (dvpos
> 0)
17295 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17296 bottom_vpos
, dvpos
);
17297 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17298 first_unchanged_at_end_vpos
+ dvpos
, 0);
17301 /* For frame-based redisplay, make sure that current frame and window
17302 matrix are in sync with respect to glyph memory. */
17303 if (!FRAME_WINDOW_P (f
))
17304 sync_frame_with_window_matrix_rows (w
);
17306 /* Adjust buffer positions in reused rows. */
17307 if (delta
|| delta_bytes
)
17308 increment_matrix_positions (current_matrix
,
17309 first_unchanged_at_end_vpos
+ dvpos
,
17310 bottom_vpos
, delta
, delta_bytes
);
17312 /* Adjust Y positions. */
17314 shift_glyph_matrix (w
, current_matrix
,
17315 first_unchanged_at_end_vpos
+ dvpos
,
17318 if (first_unchanged_at_end_row
)
17320 first_unchanged_at_end_row
+= dvpos
;
17321 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17322 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17323 first_unchanged_at_end_row
= NULL
;
17326 /* If scrolling up, there may be some lines to display at the end of
17328 last_text_row_at_end
= NULL
;
17331 /* Scrolling up can leave for example a partially visible line
17332 at the end of the window to be redisplayed. */
17333 /* Set last_row to the glyph row in the current matrix where the
17334 window end line is found. It has been moved up or down in
17335 the matrix by dvpos. */
17336 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17337 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17339 /* If last_row is the window end line, it should display text. */
17340 xassert (last_row
->displays_text_p
);
17342 /* If window end line was partially visible before, begin
17343 displaying at that line. Otherwise begin displaying with the
17344 line following it. */
17345 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17347 init_to_row_start (&it
, w
, last_row
);
17348 it
.vpos
= last_vpos
;
17349 it
.current_y
= last_row
->y
;
17353 init_to_row_end (&it
, w
, last_row
);
17354 it
.vpos
= 1 + last_vpos
;
17355 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17359 /* We may start in a continuation line. If so, we have to
17360 get the right continuation_lines_width and current_x. */
17361 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17362 it
.hpos
= it
.current_x
= 0;
17364 /* Display the rest of the lines at the window end. */
17365 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17366 while (it
.current_y
< it
.last_visible_y
17367 && !fonts_changed_p
)
17369 /* Is it always sure that the display agrees with lines in
17370 the current matrix? I don't think so, so we mark rows
17371 displayed invalid in the current matrix by setting their
17372 enabled_p flag to zero. */
17373 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17374 if (display_line (&it
))
17375 last_text_row_at_end
= it
.glyph_row
- 1;
17379 /* Update window_end_pos and window_end_vpos. */
17380 if (first_unchanged_at_end_row
17381 && !last_text_row_at_end
)
17383 /* Window end line if one of the preserved rows from the current
17384 matrix. Set row to the last row displaying text in current
17385 matrix starting at first_unchanged_at_end_row, after
17387 xassert (first_unchanged_at_end_row
->displays_text_p
);
17388 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17389 first_unchanged_at_end_row
);
17390 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17392 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17393 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17395 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17396 xassert (w
->window_end_bytepos
>= 0);
17397 IF_DEBUG (debug_method_add (w
, "A"));
17399 else if (last_text_row_at_end
)
17402 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17403 w
->window_end_bytepos
17404 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17406 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17407 xassert (w
->window_end_bytepos
>= 0);
17408 IF_DEBUG (debug_method_add (w
, "B"));
17410 else if (last_text_row
)
17412 /* We have displayed either to the end of the window or at the
17413 end of the window, i.e. the last row with text is to be found
17414 in the desired matrix. */
17416 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17417 w
->window_end_bytepos
17418 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17420 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17421 xassert (w
->window_end_bytepos
>= 0);
17423 else if (first_unchanged_at_end_row
== NULL
17424 && last_text_row
== NULL
17425 && last_text_row_at_end
== NULL
)
17427 /* Displayed to end of window, but no line containing text was
17428 displayed. Lines were deleted at the end of the window. */
17429 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17430 int vpos
= XFASTINT (w
->window_end_vpos
);
17431 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17432 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17435 row
== NULL
&& vpos
>= first_vpos
;
17436 --vpos
, --current_row
, --desired_row
)
17438 if (desired_row
->enabled_p
)
17440 if (desired_row
->displays_text_p
)
17443 else if (current_row
->displays_text_p
)
17447 xassert (row
!= NULL
);
17448 w
->window_end_vpos
= make_number (vpos
+ 1);
17449 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17450 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17451 xassert (w
->window_end_bytepos
>= 0);
17452 IF_DEBUG (debug_method_add (w
, "C"));
17457 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17458 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17460 /* Record that display has not been completed. */
17461 w
->window_end_valid
= Qnil
;
17462 w
->desired_matrix
->no_scrolling_p
= 1;
17470 /***********************************************************************
17471 More debugging support
17472 ***********************************************************************/
17476 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17477 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17478 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17481 /* Dump the contents of glyph matrix MATRIX on stderr.
17483 GLYPHS 0 means don't show glyph contents.
17484 GLYPHS 1 means show glyphs in short form
17485 GLYPHS > 1 means show glyphs in long form. */
17488 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17491 for (i
= 0; i
< matrix
->nrows
; ++i
)
17492 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17496 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17497 the glyph row and area where the glyph comes from. */
17500 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17502 if (glyph
->type
== CHAR_GLYPH
)
17505 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17506 glyph
- row
->glyphs
[TEXT_AREA
],
17509 (BUFFERP (glyph
->object
)
17511 : (STRINGP (glyph
->object
)
17514 glyph
->pixel_width
,
17516 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17520 glyph
->left_box_line_p
,
17521 glyph
->right_box_line_p
);
17523 else if (glyph
->type
== STRETCH_GLYPH
)
17526 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17527 glyph
- row
->glyphs
[TEXT_AREA
],
17530 (BUFFERP (glyph
->object
)
17532 : (STRINGP (glyph
->object
)
17535 glyph
->pixel_width
,
17539 glyph
->left_box_line_p
,
17540 glyph
->right_box_line_p
);
17542 else if (glyph
->type
== IMAGE_GLYPH
)
17545 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17546 glyph
- row
->glyphs
[TEXT_AREA
],
17549 (BUFFERP (glyph
->object
)
17551 : (STRINGP (glyph
->object
)
17554 glyph
->pixel_width
,
17558 glyph
->left_box_line_p
,
17559 glyph
->right_box_line_p
);
17561 else if (glyph
->type
== COMPOSITE_GLYPH
)
17564 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17565 glyph
- row
->glyphs
[TEXT_AREA
],
17568 (BUFFERP (glyph
->object
)
17570 : (STRINGP (glyph
->object
)
17573 glyph
->pixel_width
,
17575 if (glyph
->u
.cmp
.automatic
)
17578 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17579 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17581 glyph
->left_box_line_p
,
17582 glyph
->right_box_line_p
);
17587 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17588 GLYPHS 0 means don't show glyph contents.
17589 GLYPHS 1 means show glyphs in short form
17590 GLYPHS > 1 means show glyphs in long form. */
17593 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17597 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17598 fprintf (stderr
, "======================================================================\n");
17600 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17601 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17603 MATRIX_ROW_START_CHARPOS (row
),
17604 MATRIX_ROW_END_CHARPOS (row
),
17605 row
->used
[TEXT_AREA
],
17606 row
->contains_overlapping_glyphs_p
,
17608 row
->truncated_on_left_p
,
17609 row
->truncated_on_right_p
,
17611 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17612 row
->displays_text_p
,
17615 row
->ends_in_middle_of_char_p
,
17616 row
->starts_in_middle_of_char_p
,
17622 row
->visible_height
,
17625 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17626 row
->end
.overlay_string_index
,
17627 row
->continuation_lines_width
);
17628 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17629 CHARPOS (row
->start
.string_pos
),
17630 CHARPOS (row
->end
.string_pos
));
17631 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17632 row
->end
.dpvec_index
);
17639 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17641 struct glyph
*glyph
= row
->glyphs
[area
];
17642 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17644 /* Glyph for a line end in text. */
17645 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17648 if (glyph
< glyph_end
)
17649 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17651 for (; glyph
< glyph_end
; ++glyph
)
17652 dump_glyph (row
, glyph
, area
);
17655 else if (glyphs
== 1)
17659 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17661 char *s
= (char *) alloca (row
->used
[area
] + 1);
17664 for (i
= 0; i
< row
->used
[area
]; ++i
)
17666 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17667 if (glyph
->type
== CHAR_GLYPH
17668 && glyph
->u
.ch
< 0x80
17669 && glyph
->u
.ch
>= ' ')
17670 s
[i
] = glyph
->u
.ch
;
17676 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17682 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17683 Sdump_glyph_matrix
, 0, 1, "p",
17684 doc
: /* Dump the current matrix of the selected window to stderr.
17685 Shows contents of glyph row structures. With non-nil
17686 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17687 glyphs in short form, otherwise show glyphs in long form. */)
17688 (Lisp_Object glyphs
)
17690 struct window
*w
= XWINDOW (selected_window
);
17691 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17693 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17694 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17695 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17696 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17697 fprintf (stderr
, "=============================================\n");
17698 dump_glyph_matrix (w
->current_matrix
,
17699 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
17704 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17705 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17708 struct frame
*f
= XFRAME (selected_frame
);
17709 dump_glyph_matrix (f
->current_matrix
, 1);
17714 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17715 doc
: /* Dump glyph row ROW to stderr.
17716 GLYPH 0 means don't dump glyphs.
17717 GLYPH 1 means dump glyphs in short form.
17718 GLYPH > 1 or omitted means dump glyphs in long form. */)
17719 (Lisp_Object row
, Lisp_Object glyphs
)
17721 struct glyph_matrix
*matrix
;
17724 CHECK_NUMBER (row
);
17725 matrix
= XWINDOW (selected_window
)->current_matrix
;
17727 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17728 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17730 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17735 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17736 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17737 GLYPH 0 means don't dump glyphs.
17738 GLYPH 1 means dump glyphs in short form.
17739 GLYPH > 1 or omitted means dump glyphs in long form. */)
17740 (Lisp_Object row
, Lisp_Object glyphs
)
17742 struct frame
*sf
= SELECTED_FRAME ();
17743 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17746 CHECK_NUMBER (row
);
17748 if (vpos
>= 0 && vpos
< m
->nrows
)
17749 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17750 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
17755 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17756 doc
: /* Toggle tracing of redisplay.
17757 With ARG, turn tracing on if and only if ARG is positive. */)
17761 trace_redisplay_p
= !trace_redisplay_p
;
17764 arg
= Fprefix_numeric_value (arg
);
17765 trace_redisplay_p
= XINT (arg
) > 0;
17772 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17773 doc
: /* Like `format', but print result to stderr.
17774 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17775 (ptrdiff_t nargs
, Lisp_Object
*args
)
17777 Lisp_Object s
= Fformat (nargs
, args
);
17778 fprintf (stderr
, "%s", SDATA (s
));
17782 #endif /* GLYPH_DEBUG */
17786 /***********************************************************************
17787 Building Desired Matrix Rows
17788 ***********************************************************************/
17790 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17791 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17793 static struct glyph_row
*
17794 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17796 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17797 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17798 struct buffer
*old
= current_buffer
;
17799 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17800 int arrow_len
= SCHARS (overlay_arrow_string
);
17801 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17802 const unsigned char *p
;
17805 int n_glyphs_before
;
17807 set_buffer_temp (buffer
);
17808 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17809 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17810 SET_TEXT_POS (it
.position
, 0, 0);
17812 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17814 while (p
< arrow_end
)
17816 Lisp_Object face
, ilisp
;
17818 /* Get the next character. */
17820 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17823 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17824 if (! ASCII_CHAR_P (it
.c
))
17825 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17829 /* Get its face. */
17830 ilisp
= make_number (p
- arrow_string
);
17831 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17832 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17834 /* Compute its width, get its glyphs. */
17835 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17836 SET_TEXT_POS (it
.position
, -1, -1);
17837 PRODUCE_GLYPHS (&it
);
17839 /* If this character doesn't fit any more in the line, we have
17840 to remove some glyphs. */
17841 if (it
.current_x
> it
.last_visible_x
)
17843 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17848 set_buffer_temp (old
);
17849 return it
.glyph_row
;
17853 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17854 glyphs are only inserted for terminal frames since we can't really
17855 win with truncation glyphs when partially visible glyphs are
17856 involved. Which glyphs to insert is determined by
17857 produce_special_glyphs. */
17860 insert_left_trunc_glyphs (struct it
*it
)
17862 struct it truncate_it
;
17863 struct glyph
*from
, *end
, *to
, *toend
;
17865 xassert (!FRAME_WINDOW_P (it
->f
));
17867 /* Get the truncation glyphs. */
17869 truncate_it
.current_x
= 0;
17870 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17871 truncate_it
.glyph_row
= &scratch_glyph_row
;
17872 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17873 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17874 truncate_it
.object
= make_number (0);
17875 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17877 /* Overwrite glyphs from IT with truncation glyphs. */
17878 if (!it
->glyph_row
->reversed_p
)
17880 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17881 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17882 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17883 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17888 /* There may be padding glyphs left over. Overwrite them too. */
17889 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17891 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17897 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17901 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17902 that back to front. */
17903 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17904 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17905 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17906 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17908 while (from
>= end
&& to
>= toend
)
17910 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17913 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17914 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17915 while (from
>= end
&& to
>= toend
)
17920 /* Need to free some room before prepending additional
17922 int move_by
= from
- end
+ 1;
17923 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17924 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17926 for ( ; g
>= g0
; g
--)
17928 while (from
>= end
)
17930 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17936 /* Compute the pixel height and width of IT->glyph_row.
17938 Most of the time, ascent and height of a display line will be equal
17939 to the max_ascent and max_height values of the display iterator
17940 structure. This is not the case if
17942 1. We hit ZV without displaying anything. In this case, max_ascent
17943 and max_height will be zero.
17945 2. We have some glyphs that don't contribute to the line height.
17946 (The glyph row flag contributes_to_line_height_p is for future
17947 pixmap extensions).
17949 The first case is easily covered by using default values because in
17950 these cases, the line height does not really matter, except that it
17951 must not be zero. */
17954 compute_line_metrics (struct it
*it
)
17956 struct glyph_row
*row
= it
->glyph_row
;
17958 if (FRAME_WINDOW_P (it
->f
))
17960 int i
, min_y
, max_y
;
17962 /* The line may consist of one space only, that was added to
17963 place the cursor on it. If so, the row's height hasn't been
17965 if (row
->height
== 0)
17967 if (it
->max_ascent
+ it
->max_descent
== 0)
17968 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17969 row
->ascent
= it
->max_ascent
;
17970 row
->height
= it
->max_ascent
+ it
->max_descent
;
17971 row
->phys_ascent
= it
->max_phys_ascent
;
17972 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17973 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17976 /* Compute the width of this line. */
17977 row
->pixel_width
= row
->x
;
17978 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17979 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17981 xassert (row
->pixel_width
>= 0);
17982 xassert (row
->ascent
>= 0 && row
->height
> 0);
17984 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17985 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17987 /* If first line's physical ascent is larger than its logical
17988 ascent, use the physical ascent, and make the row taller.
17989 This makes accented characters fully visible. */
17990 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17991 && row
->phys_ascent
> row
->ascent
)
17993 row
->height
+= row
->phys_ascent
- row
->ascent
;
17994 row
->ascent
= row
->phys_ascent
;
17997 /* Compute how much of the line is visible. */
17998 row
->visible_height
= row
->height
;
18000 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18001 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18003 if (row
->y
< min_y
)
18004 row
->visible_height
-= min_y
- row
->y
;
18005 if (row
->y
+ row
->height
> max_y
)
18006 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18010 row
->pixel_width
= row
->used
[TEXT_AREA
];
18011 if (row
->continued_p
)
18012 row
->pixel_width
-= it
->continuation_pixel_width
;
18013 else if (row
->truncated_on_right_p
)
18014 row
->pixel_width
-= it
->truncation_pixel_width
;
18015 row
->ascent
= row
->phys_ascent
= 0;
18016 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18017 row
->extra_line_spacing
= 0;
18020 /* Compute a hash code for this row. */
18024 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18025 for (i
= 0; i
< row
->used
[area
]; ++i
)
18026 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
18027 + row
->glyphs
[area
][i
].u
.val
18028 + row
->glyphs
[area
][i
].face_id
18029 + row
->glyphs
[area
][i
].padding_p
18030 + (row
->glyphs
[area
][i
].type
<< 2));
18033 it
->max_ascent
= it
->max_descent
= 0;
18034 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18038 /* Append one space to the glyph row of iterator IT if doing a
18039 window-based redisplay. The space has the same face as
18040 IT->face_id. Value is non-zero if a space was added.
18042 This function is called to make sure that there is always one glyph
18043 at the end of a glyph row that the cursor can be set on under
18044 window-systems. (If there weren't such a glyph we would not know
18045 how wide and tall a box cursor should be displayed).
18047 At the same time this space let's a nicely handle clearing to the
18048 end of the line if the row ends in italic text. */
18051 append_space_for_newline (struct it
*it
, int default_face_p
)
18053 if (FRAME_WINDOW_P (it
->f
))
18055 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18057 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18058 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18060 /* Save some values that must not be changed.
18061 Must save IT->c and IT->len because otherwise
18062 ITERATOR_AT_END_P wouldn't work anymore after
18063 append_space_for_newline has been called. */
18064 enum display_element_type saved_what
= it
->what
;
18065 int saved_c
= it
->c
, saved_len
= it
->len
;
18066 int saved_char_to_display
= it
->char_to_display
;
18067 int saved_x
= it
->current_x
;
18068 int saved_face_id
= it
->face_id
;
18069 struct text_pos saved_pos
;
18070 Lisp_Object saved_object
;
18073 saved_object
= it
->object
;
18074 saved_pos
= it
->position
;
18076 it
->what
= IT_CHARACTER
;
18077 memset (&it
->position
, 0, sizeof it
->position
);
18078 it
->object
= make_number (0);
18079 it
->c
= it
->char_to_display
= ' ';
18082 if (default_face_p
)
18083 it
->face_id
= DEFAULT_FACE_ID
;
18084 else if (it
->face_before_selective_p
)
18085 it
->face_id
= it
->saved_face_id
;
18086 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18087 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18089 PRODUCE_GLYPHS (it
);
18091 it
->override_ascent
= -1;
18092 it
->constrain_row_ascent_descent_p
= 0;
18093 it
->current_x
= saved_x
;
18094 it
->object
= saved_object
;
18095 it
->position
= saved_pos
;
18096 it
->what
= saved_what
;
18097 it
->face_id
= saved_face_id
;
18098 it
->len
= saved_len
;
18100 it
->char_to_display
= saved_char_to_display
;
18109 /* Extend the face of the last glyph in the text area of IT->glyph_row
18110 to the end of the display line. Called from display_line. If the
18111 glyph row is empty, add a space glyph to it so that we know the
18112 face to draw. Set the glyph row flag fill_line_p. If the glyph
18113 row is R2L, prepend a stretch glyph to cover the empty space to the
18114 left of the leftmost glyph. */
18117 extend_face_to_end_of_line (struct it
*it
)
18120 struct frame
*f
= it
->f
;
18122 /* If line is already filled, do nothing. Non window-system frames
18123 get a grace of one more ``pixel'' because their characters are
18124 1-``pixel'' wide, so they hit the equality too early. This grace
18125 is needed only for R2L rows that are not continued, to produce
18126 one extra blank where we could display the cursor. */
18127 if (it
->current_x
>= it
->last_visible_x
18128 + (!FRAME_WINDOW_P (f
)
18129 && it
->glyph_row
->reversed_p
18130 && !it
->glyph_row
->continued_p
))
18133 /* Face extension extends the background and box of IT->face_id
18134 to the end of the line. If the background equals the background
18135 of the frame, we don't have to do anything. */
18136 if (it
->face_before_selective_p
)
18137 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18139 face
= FACE_FROM_ID (f
, it
->face_id
);
18141 if (FRAME_WINDOW_P (f
)
18142 && it
->glyph_row
->displays_text_p
18143 && face
->box
== FACE_NO_BOX
18144 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18146 && !it
->glyph_row
->reversed_p
)
18149 /* Set the glyph row flag indicating that the face of the last glyph
18150 in the text area has to be drawn to the end of the text area. */
18151 it
->glyph_row
->fill_line_p
= 1;
18153 /* If current character of IT is not ASCII, make sure we have the
18154 ASCII face. This will be automatically undone the next time
18155 get_next_display_element returns a multibyte character. Note
18156 that the character will always be single byte in unibyte
18158 if (!ASCII_CHAR_P (it
->c
))
18160 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18163 if (FRAME_WINDOW_P (f
))
18165 /* If the row is empty, add a space with the current face of IT,
18166 so that we know which face to draw. */
18167 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18169 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18170 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18171 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18173 #ifdef HAVE_WINDOW_SYSTEM
18174 if (it
->glyph_row
->reversed_p
)
18176 /* Prepend a stretch glyph to the row, such that the
18177 rightmost glyph will be drawn flushed all the way to the
18178 right margin of the window. The stretch glyph that will
18179 occupy the empty space, if any, to the left of the
18181 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18182 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18183 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18185 int row_width
, stretch_ascent
, stretch_width
;
18186 struct text_pos saved_pos
;
18187 int saved_face_id
, saved_avoid_cursor
;
18189 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18190 row_width
+= g
->pixel_width
;
18191 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18192 if (stretch_width
> 0)
18195 (((it
->ascent
+ it
->descent
)
18196 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18197 saved_pos
= it
->position
;
18198 memset (&it
->position
, 0, sizeof it
->position
);
18199 saved_avoid_cursor
= it
->avoid_cursor_p
;
18200 it
->avoid_cursor_p
= 1;
18201 saved_face_id
= it
->face_id
;
18202 /* The last row's stretch glyph should get the default
18203 face, to avoid painting the rest of the window with
18204 the region face, if the region ends at ZV. */
18205 if (it
->glyph_row
->ends_at_zv_p
)
18206 it
->face_id
= DEFAULT_FACE_ID
;
18208 it
->face_id
= face
->id
;
18209 append_stretch_glyph (it
, make_number (0), stretch_width
,
18210 it
->ascent
+ it
->descent
, stretch_ascent
);
18211 it
->position
= saved_pos
;
18212 it
->avoid_cursor_p
= saved_avoid_cursor
;
18213 it
->face_id
= saved_face_id
;
18216 #endif /* HAVE_WINDOW_SYSTEM */
18220 /* Save some values that must not be changed. */
18221 int saved_x
= it
->current_x
;
18222 struct text_pos saved_pos
;
18223 Lisp_Object saved_object
;
18224 enum display_element_type saved_what
= it
->what
;
18225 int saved_face_id
= it
->face_id
;
18227 saved_object
= it
->object
;
18228 saved_pos
= it
->position
;
18230 it
->what
= IT_CHARACTER
;
18231 memset (&it
->position
, 0, sizeof it
->position
);
18232 it
->object
= make_number (0);
18233 it
->c
= it
->char_to_display
= ' ';
18235 /* The last row's blank glyphs should get the default face, to
18236 avoid painting the rest of the window with the region face,
18237 if the region ends at ZV. */
18238 if (it
->glyph_row
->ends_at_zv_p
)
18239 it
->face_id
= DEFAULT_FACE_ID
;
18241 it
->face_id
= face
->id
;
18243 PRODUCE_GLYPHS (it
);
18245 while (it
->current_x
<= it
->last_visible_x
)
18246 PRODUCE_GLYPHS (it
);
18248 /* Don't count these blanks really. It would let us insert a left
18249 truncation glyph below and make us set the cursor on them, maybe. */
18250 it
->current_x
= saved_x
;
18251 it
->object
= saved_object
;
18252 it
->position
= saved_pos
;
18253 it
->what
= saved_what
;
18254 it
->face_id
= saved_face_id
;
18259 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18260 trailing whitespace. */
18263 trailing_whitespace_p (ptrdiff_t charpos
)
18265 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18268 while (bytepos
< ZV_BYTE
18269 && (c
= FETCH_CHAR (bytepos
),
18270 c
== ' ' || c
== '\t'))
18273 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18275 if (bytepos
!= PT_BYTE
)
18282 /* Highlight trailing whitespace, if any, in ROW. */
18285 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18287 int used
= row
->used
[TEXT_AREA
];
18291 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18292 struct glyph
*glyph
= start
+ used
- 1;
18294 if (row
->reversed_p
)
18296 /* Right-to-left rows need to be processed in the opposite
18297 direction, so swap the edge pointers. */
18299 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18302 /* Skip over glyphs inserted to display the cursor at the
18303 end of a line, for extending the face of the last glyph
18304 to the end of the line on terminals, and for truncation
18305 and continuation glyphs. */
18306 if (!row
->reversed_p
)
18308 while (glyph
>= start
18309 && glyph
->type
== CHAR_GLYPH
18310 && INTEGERP (glyph
->object
))
18315 while (glyph
<= start
18316 && glyph
->type
== CHAR_GLYPH
18317 && INTEGERP (glyph
->object
))
18321 /* If last glyph is a space or stretch, and it's trailing
18322 whitespace, set the face of all trailing whitespace glyphs in
18323 IT->glyph_row to `trailing-whitespace'. */
18324 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18325 && BUFFERP (glyph
->object
)
18326 && (glyph
->type
== STRETCH_GLYPH
18327 || (glyph
->type
== CHAR_GLYPH
18328 && glyph
->u
.ch
== ' '))
18329 && trailing_whitespace_p (glyph
->charpos
))
18331 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18335 if (!row
->reversed_p
)
18337 while (glyph
>= start
18338 && BUFFERP (glyph
->object
)
18339 && (glyph
->type
== STRETCH_GLYPH
18340 || (glyph
->type
== CHAR_GLYPH
18341 && glyph
->u
.ch
== ' ')))
18342 (glyph
--)->face_id
= face_id
;
18346 while (glyph
<= start
18347 && BUFFERP (glyph
->object
)
18348 && (glyph
->type
== STRETCH_GLYPH
18349 || (glyph
->type
== CHAR_GLYPH
18350 && glyph
->u
.ch
== ' ')))
18351 (glyph
++)->face_id
= face_id
;
18358 /* Value is non-zero if glyph row ROW should be
18359 used to hold the cursor. */
18362 cursor_row_p (struct glyph_row
*row
)
18366 if (PT
== CHARPOS (row
->end
.pos
)
18367 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18369 /* Suppose the row ends on a string.
18370 Unless the row is continued, that means it ends on a newline
18371 in the string. If it's anything other than a display string
18372 (e.g. a before-string from an overlay), we don't want the
18373 cursor there. (This heuristic seems to give the optimal
18374 behavior for the various types of multi-line strings.) */
18375 if (CHARPOS (row
->end
.string_pos
) >= 0)
18377 if (row
->continued_p
)
18381 /* Check for `display' property. */
18382 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18383 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18384 struct glyph
*glyph
;
18387 for (glyph
= end
; glyph
>= beg
; --glyph
)
18388 if (STRINGP (glyph
->object
))
18391 = Fget_char_property (make_number (PT
),
18395 && display_prop_string_p (prop
, glyph
->object
));
18400 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18402 /* If the row ends in middle of a real character,
18403 and the line is continued, we want the cursor here.
18404 That's because CHARPOS (ROW->end.pos) would equal
18405 PT if PT is before the character. */
18406 if (!row
->ends_in_ellipsis_p
)
18407 result
= row
->continued_p
;
18409 /* If the row ends in an ellipsis, then
18410 CHARPOS (ROW->end.pos) will equal point after the
18411 invisible text. We want that position to be displayed
18412 after the ellipsis. */
18415 /* If the row ends at ZV, display the cursor at the end of that
18416 row instead of at the start of the row below. */
18417 else if (row
->ends_at_zv_p
)
18428 /* Push the property PROP so that it will be rendered at the current
18429 position in IT. Return 1 if PROP was successfully pushed, 0
18430 otherwise. Called from handle_line_prefix to handle the
18431 `line-prefix' and `wrap-prefix' properties. */
18434 push_display_prop (struct it
*it
, Lisp_Object prop
)
18436 struct text_pos pos
=
18437 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18439 xassert (it
->method
== GET_FROM_BUFFER
18440 || it
->method
== GET_FROM_STRING
);
18442 /* We need to save the current buffer/string position, so it will be
18443 restored by pop_it, because iterate_out_of_display_property
18444 depends on that being set correctly, but some situations leave
18445 it->position not yet set when this function is called. */
18446 push_it (it
, &pos
);
18448 if (STRINGP (prop
))
18450 if (SCHARS (prop
) == 0)
18457 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18458 it
->current
.overlay_string_index
= -1;
18459 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18460 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18461 it
->method
= GET_FROM_STRING
;
18462 it
->stop_charpos
= 0;
18464 it
->base_level_stop
= 0;
18466 /* Force paragraph direction to be that of the parent
18468 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18469 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18471 it
->paragraph_embedding
= L2R
;
18473 /* Set up the bidi iterator for this display string. */
18476 it
->bidi_it
.string
.lstring
= it
->string
;
18477 it
->bidi_it
.string
.s
= NULL
;
18478 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18479 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18480 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18481 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18482 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18485 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18487 it
->method
= GET_FROM_STRETCH
;
18490 #ifdef HAVE_WINDOW_SYSTEM
18491 else if (IMAGEP (prop
))
18493 it
->what
= IT_IMAGE
;
18494 it
->image_id
= lookup_image (it
->f
, prop
);
18495 it
->method
= GET_FROM_IMAGE
;
18497 #endif /* HAVE_WINDOW_SYSTEM */
18500 pop_it (it
); /* bogus display property, give up */
18507 /* Return the character-property PROP at the current position in IT. */
18510 get_it_property (struct it
*it
, Lisp_Object prop
)
18512 Lisp_Object position
;
18514 if (STRINGP (it
->object
))
18515 position
= make_number (IT_STRING_CHARPOS (*it
));
18516 else if (BUFFERP (it
->object
))
18517 position
= make_number (IT_CHARPOS (*it
));
18521 return Fget_char_property (position
, prop
, it
->object
);
18524 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18527 handle_line_prefix (struct it
*it
)
18529 Lisp_Object prefix
;
18531 if (it
->continuation_lines_width
> 0)
18533 prefix
= get_it_property (it
, Qwrap_prefix
);
18535 prefix
= Vwrap_prefix
;
18539 prefix
= get_it_property (it
, Qline_prefix
);
18541 prefix
= Vline_prefix
;
18543 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18545 /* If the prefix is wider than the window, and we try to wrap
18546 it, it would acquire its own wrap prefix, and so on till the
18547 iterator stack overflows. So, don't wrap the prefix. */
18548 it
->line_wrap
= TRUNCATE
;
18549 it
->avoid_cursor_p
= 1;
18555 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18556 only for R2L lines from display_line and display_string, when they
18557 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18558 the line/string needs to be continued on the next glyph row. */
18560 unproduce_glyphs (struct it
*it
, int n
)
18562 struct glyph
*glyph
, *end
;
18564 xassert (it
->glyph_row
);
18565 xassert (it
->glyph_row
->reversed_p
);
18566 xassert (it
->area
== TEXT_AREA
);
18567 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18569 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18570 n
= it
->glyph_row
->used
[TEXT_AREA
];
18571 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18572 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18573 for ( ; glyph
< end
; glyph
++)
18574 glyph
[-n
] = *glyph
;
18577 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18578 and ROW->maxpos. */
18580 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18581 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18582 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18584 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18585 lines' rows is implemented for bidi-reordered rows. */
18587 /* ROW->minpos is the value of min_pos, the minimal buffer position
18588 we have in ROW, or ROW->start.pos if that is smaller. */
18589 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18590 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18592 /* We didn't find buffer positions smaller than ROW->start, or
18593 didn't find _any_ valid buffer positions in any of the glyphs,
18594 so we must trust the iterator's computed positions. */
18595 row
->minpos
= row
->start
.pos
;
18598 max_pos
= CHARPOS (it
->current
.pos
);
18599 max_bpos
= BYTEPOS (it
->current
.pos
);
18602 /* Here are the various use-cases for ending the row, and the
18603 corresponding values for ROW->maxpos:
18605 Line ends in a newline from buffer eol_pos + 1
18606 Line is continued from buffer max_pos + 1
18607 Line is truncated on right it->current.pos
18608 Line ends in a newline from string max_pos + 1(*)
18609 (*) + 1 only when line ends in a forward scan
18610 Line is continued from string max_pos
18611 Line is continued from display vector max_pos
18612 Line is entirely from a string min_pos == max_pos
18613 Line is entirely from a display vector min_pos == max_pos
18614 Line that ends at ZV ZV
18616 If you discover other use-cases, please add them here as
18618 if (row
->ends_at_zv_p
)
18619 row
->maxpos
= it
->current
.pos
;
18620 else if (row
->used
[TEXT_AREA
])
18622 int seen_this_string
= 0;
18623 struct glyph_row
*r1
= row
- 1;
18625 /* Did we see the same display string on the previous row? */
18626 if (STRINGP (it
->object
)
18627 /* this is not the first row */
18628 && row
> it
->w
->desired_matrix
->rows
18629 /* previous row is not the header line */
18630 && !r1
->mode_line_p
18631 /* previous row also ends in a newline from a string */
18632 && r1
->ends_in_newline_from_string_p
)
18634 struct glyph
*start
, *end
;
18636 /* Search for the last glyph of the previous row that came
18637 from buffer or string. Depending on whether the row is
18638 L2R or R2L, we need to process it front to back or the
18639 other way round. */
18640 if (!r1
->reversed_p
)
18642 start
= r1
->glyphs
[TEXT_AREA
];
18643 end
= start
+ r1
->used
[TEXT_AREA
];
18644 /* Glyphs inserted by redisplay have an integer (zero)
18645 as their object. */
18647 && INTEGERP ((end
- 1)->object
)
18648 && (end
- 1)->charpos
<= 0)
18652 if (EQ ((end
- 1)->object
, it
->object
))
18653 seen_this_string
= 1;
18656 /* If all the glyphs of the previous row were inserted
18657 by redisplay, it means the previous row was
18658 produced from a single newline, which is only
18659 possible if that newline came from the same string
18660 as the one which produced this ROW. */
18661 seen_this_string
= 1;
18665 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18666 start
= end
+ r1
->used
[TEXT_AREA
];
18668 && INTEGERP ((end
+ 1)->object
)
18669 && (end
+ 1)->charpos
<= 0)
18673 if (EQ ((end
+ 1)->object
, it
->object
))
18674 seen_this_string
= 1;
18677 seen_this_string
= 1;
18680 /* Take note of each display string that covers a newline only
18681 once, the first time we see it. This is for when a display
18682 string includes more than one newline in it. */
18683 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18685 /* If we were scanning the buffer forward when we displayed
18686 the string, we want to account for at least one buffer
18687 position that belongs to this row (position covered by
18688 the display string), so that cursor positioning will
18689 consider this row as a candidate when point is at the end
18690 of the visual line represented by this row. This is not
18691 required when scanning back, because max_pos will already
18692 have a much larger value. */
18693 if (CHARPOS (row
->end
.pos
) > max_pos
)
18694 INC_BOTH (max_pos
, max_bpos
);
18695 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18697 else if (CHARPOS (it
->eol_pos
) > 0)
18698 SET_TEXT_POS (row
->maxpos
,
18699 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18700 else if (row
->continued_p
)
18702 /* If max_pos is different from IT's current position, it
18703 means IT->method does not belong to the display element
18704 at max_pos. However, it also means that the display
18705 element at max_pos was displayed in its entirety on this
18706 line, which is equivalent to saying that the next line
18707 starts at the next buffer position. */
18708 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18709 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18712 INC_BOTH (max_pos
, max_bpos
);
18713 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18716 else if (row
->truncated_on_right_p
)
18717 /* display_line already called reseat_at_next_visible_line_start,
18718 which puts the iterator at the beginning of the next line, in
18719 the logical order. */
18720 row
->maxpos
= it
->current
.pos
;
18721 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18722 /* A line that is entirely from a string/image/stretch... */
18723 row
->maxpos
= row
->minpos
;
18728 row
->maxpos
= it
->current
.pos
;
18731 /* Construct the glyph row IT->glyph_row in the desired matrix of
18732 IT->w from text at the current position of IT. See dispextern.h
18733 for an overview of struct it. Value is non-zero if
18734 IT->glyph_row displays text, as opposed to a line displaying ZV
18738 display_line (struct it
*it
)
18740 struct glyph_row
*row
= it
->glyph_row
;
18741 Lisp_Object overlay_arrow_string
;
18743 void *wrap_data
= NULL
;
18744 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18745 int wrap_row_used
= -1;
18746 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18747 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18748 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18749 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18750 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18752 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
18753 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18755 /* We always start displaying at hpos zero even if hscrolled. */
18756 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18758 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18759 >= it
->w
->desired_matrix
->nrows
)
18761 it
->w
->nrows_scale_factor
++;
18762 fonts_changed_p
= 1;
18766 /* Is IT->w showing the region? */
18767 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18769 /* Clear the result glyph row and enable it. */
18770 prepare_desired_row (row
);
18772 row
->y
= it
->current_y
;
18773 row
->start
= it
->start
;
18774 row
->continuation_lines_width
= it
->continuation_lines_width
;
18775 row
->displays_text_p
= 1;
18776 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18777 it
->starts_in_middle_of_char_p
= 0;
18779 /* Arrange the overlays nicely for our purposes. Usually, we call
18780 display_line on only one line at a time, in which case this
18781 can't really hurt too much, or we call it on lines which appear
18782 one after another in the buffer, in which case all calls to
18783 recenter_overlay_lists but the first will be pretty cheap. */
18784 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18786 /* Move over display elements that are not visible because we are
18787 hscrolled. This may stop at an x-position < IT->first_visible_x
18788 if the first glyph is partially visible or if we hit a line end. */
18789 if (it
->current_x
< it
->first_visible_x
)
18791 this_line_min_pos
= row
->start
.pos
;
18792 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18793 MOVE_TO_POS
| MOVE_TO_X
);
18794 /* Record the smallest positions seen while we moved over
18795 display elements that are not visible. This is needed by
18796 redisplay_internal for optimizing the case where the cursor
18797 stays inside the same line. The rest of this function only
18798 considers positions that are actually displayed, so
18799 RECORD_MAX_MIN_POS will not otherwise record positions that
18800 are hscrolled to the left of the left edge of the window. */
18801 min_pos
= CHARPOS (this_line_min_pos
);
18802 min_bpos
= BYTEPOS (this_line_min_pos
);
18806 /* We only do this when not calling `move_it_in_display_line_to'
18807 above, because move_it_in_display_line_to calls
18808 handle_line_prefix itself. */
18809 handle_line_prefix (it
);
18812 /* Get the initial row height. This is either the height of the
18813 text hscrolled, if there is any, or zero. */
18814 row
->ascent
= it
->max_ascent
;
18815 row
->height
= it
->max_ascent
+ it
->max_descent
;
18816 row
->phys_ascent
= it
->max_phys_ascent
;
18817 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18818 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18820 /* Utility macro to record max and min buffer positions seen until now. */
18821 #define RECORD_MAX_MIN_POS(IT) \
18824 int composition_p = (IT)->what == IT_COMPOSITION; \
18825 ptrdiff_t current_pos = \
18826 composition_p ? (IT)->cmp_it.charpos \
18827 : IT_CHARPOS (*(IT)); \
18828 ptrdiff_t current_bpos = \
18829 composition_p ? CHAR_TO_BYTE (current_pos) \
18830 : IT_BYTEPOS (*(IT)); \
18831 if (current_pos < min_pos) \
18833 min_pos = current_pos; \
18834 min_bpos = current_bpos; \
18836 if (IT_CHARPOS (*it) > max_pos) \
18838 max_pos = IT_CHARPOS (*it); \
18839 max_bpos = IT_BYTEPOS (*it); \
18844 /* Loop generating characters. The loop is left with IT on the next
18845 character to display. */
18848 int n_glyphs_before
, hpos_before
, x_before
;
18850 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18852 /* Retrieve the next thing to display. Value is zero if end of
18854 if (!get_next_display_element (it
))
18856 /* Maybe add a space at the end of this line that is used to
18857 display the cursor there under X. Set the charpos of the
18858 first glyph of blank lines not corresponding to any text
18860 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18861 row
->exact_window_width_line_p
= 1;
18862 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18863 || row
->used
[TEXT_AREA
] == 0)
18865 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18866 row
->displays_text_p
= 0;
18868 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18869 && (!MINI_WINDOW_P (it
->w
)
18870 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18871 row
->indicate_empty_line_p
= 1;
18874 it
->continuation_lines_width
= 0;
18875 row
->ends_at_zv_p
= 1;
18876 /* A row that displays right-to-left text must always have
18877 its last face extended all the way to the end of line,
18878 even if this row ends in ZV, because we still write to
18879 the screen left to right. */
18880 if (row
->reversed_p
)
18881 extend_face_to_end_of_line (it
);
18885 /* Now, get the metrics of what we want to display. This also
18886 generates glyphs in `row' (which is IT->glyph_row). */
18887 n_glyphs_before
= row
->used
[TEXT_AREA
];
18890 /* Remember the line height so far in case the next element doesn't
18891 fit on the line. */
18892 if (it
->line_wrap
!= TRUNCATE
)
18894 ascent
= it
->max_ascent
;
18895 descent
= it
->max_descent
;
18896 phys_ascent
= it
->max_phys_ascent
;
18897 phys_descent
= it
->max_phys_descent
;
18899 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18901 if (IT_DISPLAYING_WHITESPACE (it
))
18905 SAVE_IT (wrap_it
, *it
, wrap_data
);
18907 wrap_row_used
= row
->used
[TEXT_AREA
];
18908 wrap_row_ascent
= row
->ascent
;
18909 wrap_row_height
= row
->height
;
18910 wrap_row_phys_ascent
= row
->phys_ascent
;
18911 wrap_row_phys_height
= row
->phys_height
;
18912 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18913 wrap_row_min_pos
= min_pos
;
18914 wrap_row_min_bpos
= min_bpos
;
18915 wrap_row_max_pos
= max_pos
;
18916 wrap_row_max_bpos
= max_bpos
;
18922 PRODUCE_GLYPHS (it
);
18924 /* If this display element was in marginal areas, continue with
18926 if (it
->area
!= TEXT_AREA
)
18928 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18929 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18930 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18931 row
->phys_height
= max (row
->phys_height
,
18932 it
->max_phys_ascent
+ it
->max_phys_descent
);
18933 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18934 it
->max_extra_line_spacing
);
18935 set_iterator_to_next (it
, 1);
18939 /* Does the display element fit on the line? If we truncate
18940 lines, we should draw past the right edge of the window. If
18941 we don't truncate, we want to stop so that we can display the
18942 continuation glyph before the right margin. If lines are
18943 continued, there are two possible strategies for characters
18944 resulting in more than 1 glyph (e.g. tabs): Display as many
18945 glyphs as possible in this line and leave the rest for the
18946 continuation line, or display the whole element in the next
18947 line. Original redisplay did the former, so we do it also. */
18948 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18949 hpos_before
= it
->hpos
;
18952 if (/* Not a newline. */
18954 /* Glyphs produced fit entirely in the line. */
18955 && it
->current_x
< it
->last_visible_x
)
18957 it
->hpos
+= nglyphs
;
18958 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18959 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18960 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18961 row
->phys_height
= max (row
->phys_height
,
18962 it
->max_phys_ascent
+ it
->max_phys_descent
);
18963 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18964 it
->max_extra_line_spacing
);
18965 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18966 row
->x
= x
- it
->first_visible_x
;
18967 /* Record the maximum and minimum buffer positions seen so
18968 far in glyphs that will be displayed by this row. */
18970 RECORD_MAX_MIN_POS (it
);
18975 struct glyph
*glyph
;
18977 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18979 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18980 new_x
= x
+ glyph
->pixel_width
;
18982 if (/* Lines are continued. */
18983 it
->line_wrap
!= TRUNCATE
18984 && (/* Glyph doesn't fit on the line. */
18985 new_x
> it
->last_visible_x
18986 /* Or it fits exactly on a window system frame. */
18987 || (new_x
== it
->last_visible_x
18988 && FRAME_WINDOW_P (it
->f
))))
18990 /* End of a continued line. */
18993 || (new_x
== it
->last_visible_x
18994 && FRAME_WINDOW_P (it
->f
)))
18996 /* Current glyph is the only one on the line or
18997 fits exactly on the line. We must continue
18998 the line because we can't draw the cursor
18999 after the glyph. */
19000 row
->continued_p
= 1;
19001 it
->current_x
= new_x
;
19002 it
->continuation_lines_width
+= new_x
;
19004 if (i
== nglyphs
- 1)
19006 /* If line-wrap is on, check if a previous
19007 wrap point was found. */
19008 if (wrap_row_used
> 0
19009 /* Even if there is a previous wrap
19010 point, continue the line here as
19011 usual, if (i) the previous character
19012 was a space or tab AND (ii) the
19013 current character is not. */
19015 || IT_DISPLAYING_WHITESPACE (it
)))
19018 /* Record the maximum and minimum buffer
19019 positions seen so far in glyphs that will be
19020 displayed by this row. */
19022 RECORD_MAX_MIN_POS (it
);
19023 set_iterator_to_next (it
, 1);
19024 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19026 if (!get_next_display_element (it
))
19028 row
->exact_window_width_line_p
= 1;
19029 it
->continuation_lines_width
= 0;
19030 row
->continued_p
= 0;
19031 row
->ends_at_zv_p
= 1;
19033 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19035 row
->continued_p
= 0;
19036 row
->exact_window_width_line_p
= 1;
19040 else if (it
->bidi_p
)
19041 RECORD_MAX_MIN_POS (it
);
19043 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19044 && !FRAME_WINDOW_P (it
->f
))
19046 /* A padding glyph that doesn't fit on this line.
19047 This means the whole character doesn't fit
19049 if (row
->reversed_p
)
19050 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19051 - n_glyphs_before
);
19052 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19054 /* Fill the rest of the row with continuation
19055 glyphs like in 20.x. */
19056 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19057 < row
->glyphs
[1 + TEXT_AREA
])
19058 produce_special_glyphs (it
, IT_CONTINUATION
);
19060 row
->continued_p
= 1;
19061 it
->current_x
= x_before
;
19062 it
->continuation_lines_width
+= x_before
;
19064 /* Restore the height to what it was before the
19065 element not fitting on the line. */
19066 it
->max_ascent
= ascent
;
19067 it
->max_descent
= descent
;
19068 it
->max_phys_ascent
= phys_ascent
;
19069 it
->max_phys_descent
= phys_descent
;
19071 else if (wrap_row_used
> 0)
19074 if (row
->reversed_p
)
19075 unproduce_glyphs (it
,
19076 row
->used
[TEXT_AREA
] - wrap_row_used
);
19077 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19078 it
->continuation_lines_width
+= wrap_x
;
19079 row
->used
[TEXT_AREA
] = wrap_row_used
;
19080 row
->ascent
= wrap_row_ascent
;
19081 row
->height
= wrap_row_height
;
19082 row
->phys_ascent
= wrap_row_phys_ascent
;
19083 row
->phys_height
= wrap_row_phys_height
;
19084 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19085 min_pos
= wrap_row_min_pos
;
19086 min_bpos
= wrap_row_min_bpos
;
19087 max_pos
= wrap_row_max_pos
;
19088 max_bpos
= wrap_row_max_bpos
;
19089 row
->continued_p
= 1;
19090 row
->ends_at_zv_p
= 0;
19091 row
->exact_window_width_line_p
= 0;
19092 it
->continuation_lines_width
+= x
;
19094 /* Make sure that a non-default face is extended
19095 up to the right margin of the window. */
19096 extend_face_to_end_of_line (it
);
19098 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19100 /* A TAB that extends past the right edge of the
19101 window. This produces a single glyph on
19102 window system frames. We leave the glyph in
19103 this row and let it fill the row, but don't
19104 consume the TAB. */
19105 it
->continuation_lines_width
+= it
->last_visible_x
;
19106 row
->ends_in_middle_of_char_p
= 1;
19107 row
->continued_p
= 1;
19108 glyph
->pixel_width
= it
->last_visible_x
- x
;
19109 it
->starts_in_middle_of_char_p
= 1;
19113 /* Something other than a TAB that draws past
19114 the right edge of the window. Restore
19115 positions to values before the element. */
19116 if (row
->reversed_p
)
19117 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19118 - (n_glyphs_before
+ i
));
19119 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19121 /* Display continuation glyphs. */
19122 if (!FRAME_WINDOW_P (it
->f
))
19123 produce_special_glyphs (it
, IT_CONTINUATION
);
19124 row
->continued_p
= 1;
19126 it
->current_x
= x_before
;
19127 it
->continuation_lines_width
+= x
;
19128 extend_face_to_end_of_line (it
);
19130 if (nglyphs
> 1 && i
> 0)
19132 row
->ends_in_middle_of_char_p
= 1;
19133 it
->starts_in_middle_of_char_p
= 1;
19136 /* Restore the height to what it was before the
19137 element not fitting on the line. */
19138 it
->max_ascent
= ascent
;
19139 it
->max_descent
= descent
;
19140 it
->max_phys_ascent
= phys_ascent
;
19141 it
->max_phys_descent
= phys_descent
;
19146 else if (new_x
> it
->first_visible_x
)
19148 /* Increment number of glyphs actually displayed. */
19151 /* Record the maximum and minimum buffer positions
19152 seen so far in glyphs that will be displayed by
19155 RECORD_MAX_MIN_POS (it
);
19157 if (x
< it
->first_visible_x
)
19158 /* Glyph is partially visible, i.e. row starts at
19159 negative X position. */
19160 row
->x
= x
- it
->first_visible_x
;
19164 /* Glyph is completely off the left margin of the
19165 window. This should not happen because of the
19166 move_it_in_display_line at the start of this
19167 function, unless the text display area of the
19168 window is empty. */
19169 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19172 /* Even if this display element produced no glyphs at all,
19173 we want to record its position. */
19174 if (it
->bidi_p
&& nglyphs
== 0)
19175 RECORD_MAX_MIN_POS (it
);
19177 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19178 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19179 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19180 row
->phys_height
= max (row
->phys_height
,
19181 it
->max_phys_ascent
+ it
->max_phys_descent
);
19182 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19183 it
->max_extra_line_spacing
);
19185 /* End of this display line if row is continued. */
19186 if (row
->continued_p
|| row
->ends_at_zv_p
)
19191 /* Is this a line end? If yes, we're also done, after making
19192 sure that a non-default face is extended up to the right
19193 margin of the window. */
19194 if (ITERATOR_AT_END_OF_LINE_P (it
))
19196 int used_before
= row
->used
[TEXT_AREA
];
19198 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19200 /* Add a space at the end of the line that is used to
19201 display the cursor there. */
19202 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19203 append_space_for_newline (it
, 0);
19205 /* Extend the face to the end of the line. */
19206 extend_face_to_end_of_line (it
);
19208 /* Make sure we have the position. */
19209 if (used_before
== 0)
19210 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19212 /* Record the position of the newline, for use in
19214 it
->eol_pos
= it
->current
.pos
;
19216 /* Consume the line end. This skips over invisible lines. */
19217 set_iterator_to_next (it
, 1);
19218 it
->continuation_lines_width
= 0;
19222 /* Proceed with next display element. Note that this skips
19223 over lines invisible because of selective display. */
19224 set_iterator_to_next (it
, 1);
19226 /* If we truncate lines, we are done when the last displayed
19227 glyphs reach past the right margin of the window. */
19228 if (it
->line_wrap
== TRUNCATE
19229 && (FRAME_WINDOW_P (it
->f
)
19230 ? (it
->current_x
>= it
->last_visible_x
)
19231 : (it
->current_x
> it
->last_visible_x
)))
19233 /* Maybe add truncation glyphs. */
19234 if (!FRAME_WINDOW_P (it
->f
))
19238 if (!row
->reversed_p
)
19240 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19241 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19246 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19247 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19249 /* Remove any padding glyphs at the front of ROW, to
19250 make room for the truncation glyphs we will be
19251 adding below. The loop below always inserts at
19252 least one truncation glyph, so also remove the
19253 last glyph added to ROW. */
19254 unproduce_glyphs (it
, i
+ 1);
19255 /* Adjust i for the loop below. */
19256 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19259 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19261 row
->used
[TEXT_AREA
] = i
;
19262 produce_special_glyphs (it
, IT_TRUNCATION
);
19265 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19267 /* Don't truncate if we can overflow newline into fringe. */
19268 if (!get_next_display_element (it
))
19270 it
->continuation_lines_width
= 0;
19271 row
->ends_at_zv_p
= 1;
19272 row
->exact_window_width_line_p
= 1;
19275 if (ITERATOR_AT_END_OF_LINE_P (it
))
19277 row
->exact_window_width_line_p
= 1;
19278 goto at_end_of_line
;
19282 row
->truncated_on_right_p
= 1;
19283 it
->continuation_lines_width
= 0;
19284 reseat_at_next_visible_line_start (it
, 0);
19285 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19286 it
->hpos
= hpos_before
;
19287 it
->current_x
= x_before
;
19293 bidi_unshelve_cache (wrap_data
, 1);
19295 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19296 at the left window margin. */
19297 if (it
->first_visible_x
19298 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19300 if (!FRAME_WINDOW_P (it
->f
))
19301 insert_left_trunc_glyphs (it
);
19302 row
->truncated_on_left_p
= 1;
19305 /* Remember the position at which this line ends.
19307 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19308 cannot be before the call to find_row_edges below, since that is
19309 where these positions are determined. */
19310 row
->end
= it
->current
;
19313 row
->minpos
= row
->start
.pos
;
19314 row
->maxpos
= row
->end
.pos
;
19318 /* ROW->minpos and ROW->maxpos must be the smallest and
19319 `1 + the largest' buffer positions in ROW. But if ROW was
19320 bidi-reordered, these two positions can be anywhere in the
19321 row, so we must determine them now. */
19322 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19325 /* If the start of this line is the overlay arrow-position, then
19326 mark this glyph row as the one containing the overlay arrow.
19327 This is clearly a mess with variable size fonts. It would be
19328 better to let it be displayed like cursors under X. */
19329 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19330 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19331 !NILP (overlay_arrow_string
)))
19333 /* Overlay arrow in window redisplay is a fringe bitmap. */
19334 if (STRINGP (overlay_arrow_string
))
19336 struct glyph_row
*arrow_row
19337 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19338 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19339 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19340 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19341 struct glyph
*p2
, *end
;
19343 /* Copy the arrow glyphs. */
19344 while (glyph
< arrow_end
)
19347 /* Throw away padding glyphs. */
19349 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19350 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19356 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19361 xassert (INTEGERP (overlay_arrow_string
));
19362 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19364 overlay_arrow_seen
= 1;
19367 /* Compute pixel dimensions of this line. */
19368 compute_line_metrics (it
);
19370 /* Record whether this row ends inside an ellipsis. */
19371 row
->ends_in_ellipsis_p
19372 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19373 && it
->ellipsis_p
);
19375 /* Save fringe bitmaps in this row. */
19376 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19377 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19378 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19379 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19381 it
->left_user_fringe_bitmap
= 0;
19382 it
->left_user_fringe_face_id
= 0;
19383 it
->right_user_fringe_bitmap
= 0;
19384 it
->right_user_fringe_face_id
= 0;
19386 /* Maybe set the cursor. */
19387 cvpos
= it
->w
->cursor
.vpos
;
19389 /* In bidi-reordered rows, keep checking for proper cursor
19390 position even if one has been found already, because buffer
19391 positions in such rows change non-linearly with ROW->VPOS,
19392 when a line is continued. One exception: when we are at ZV,
19393 display cursor on the first suitable glyph row, since all
19394 the empty rows after that also have their position set to ZV. */
19395 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19396 lines' rows is implemented for bidi-reordered rows. */
19398 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19399 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19400 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19401 && cursor_row_p (row
))
19402 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19404 /* Highlight trailing whitespace. */
19405 if (!NILP (Vshow_trailing_whitespace
))
19406 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19408 /* Prepare for the next line. This line starts horizontally at (X
19409 HPOS) = (0 0). Vertical positions are incremented. As a
19410 convenience for the caller, IT->glyph_row is set to the next
19412 it
->current_x
= it
->hpos
= 0;
19413 it
->current_y
+= row
->height
;
19414 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19417 /* The next row should by default use the same value of the
19418 reversed_p flag as this one. set_iterator_to_next decides when
19419 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19420 the flag accordingly. */
19421 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19422 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19423 it
->start
= row
->end
;
19424 return row
->displays_text_p
;
19426 #undef RECORD_MAX_MIN_POS
19429 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19430 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19431 doc
: /* Return paragraph direction at point in BUFFER.
19432 Value is either `left-to-right' or `right-to-left'.
19433 If BUFFER is omitted or nil, it defaults to the current buffer.
19435 Paragraph direction determines how the text in the paragraph is displayed.
19436 In left-to-right paragraphs, text begins at the left margin of the window
19437 and the reading direction is generally left to right. In right-to-left
19438 paragraphs, text begins at the right margin and is read from right to left.
19440 See also `bidi-paragraph-direction'. */)
19441 (Lisp_Object buffer
)
19443 struct buffer
*buf
= current_buffer
;
19444 struct buffer
*old
= buf
;
19446 if (! NILP (buffer
))
19448 CHECK_BUFFER (buffer
);
19449 buf
= XBUFFER (buffer
);
19452 if (NILP (BVAR (buf
, bidi_display_reordering
))
19453 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19454 return Qleft_to_right
;
19455 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19456 return BVAR (buf
, bidi_paragraph_direction
);
19459 /* Determine the direction from buffer text. We could try to
19460 use current_matrix if it is up to date, but this seems fast
19461 enough as it is. */
19462 struct bidi_it itb
;
19463 ptrdiff_t pos
= BUF_PT (buf
);
19464 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19466 void *itb_data
= bidi_shelve_cache ();
19468 set_buffer_temp (buf
);
19469 /* bidi_paragraph_init finds the base direction of the paragraph
19470 by searching forward from paragraph start. We need the base
19471 direction of the current or _previous_ paragraph, so we need
19472 to make sure we are within that paragraph. To that end, find
19473 the previous non-empty line. */
19474 if (pos
>= ZV
&& pos
> BEGV
)
19477 bytepos
= CHAR_TO_BYTE (pos
);
19479 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19480 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19482 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19483 || c
== ' ' || c
== '\t' || c
== '\f')
19485 if (bytepos
<= BEGV_BYTE
)
19490 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19493 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19494 itb
.paragraph_dir
= NEUTRAL_DIR
;
19495 itb
.string
.s
= NULL
;
19496 itb
.string
.lstring
= Qnil
;
19497 itb
.string
.bufpos
= 0;
19498 itb
.string
.unibyte
= 0;
19499 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19500 bidi_unshelve_cache (itb_data
, 0);
19501 set_buffer_temp (old
);
19502 switch (itb
.paragraph_dir
)
19505 return Qleft_to_right
;
19508 return Qright_to_left
;
19518 /***********************************************************************
19520 ***********************************************************************/
19522 /* Redisplay the menu bar in the frame for window W.
19524 The menu bar of X frames that don't have X toolkit support is
19525 displayed in a special window W->frame->menu_bar_window.
19527 The menu bar of terminal frames is treated specially as far as
19528 glyph matrices are concerned. Menu bar lines are not part of
19529 windows, so the update is done directly on the frame matrix rows
19530 for the menu bar. */
19533 display_menu_bar (struct window
*w
)
19535 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19540 /* Don't do all this for graphical frames. */
19542 if (FRAME_W32_P (f
))
19545 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19551 if (FRAME_NS_P (f
))
19553 #endif /* HAVE_NS */
19555 #ifdef USE_X_TOOLKIT
19556 xassert (!FRAME_WINDOW_P (f
));
19557 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19558 it
.first_visible_x
= 0;
19559 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19560 #else /* not USE_X_TOOLKIT */
19561 if (FRAME_WINDOW_P (f
))
19563 /* Menu bar lines are displayed in the desired matrix of the
19564 dummy window menu_bar_window. */
19565 struct window
*menu_w
;
19566 xassert (WINDOWP (f
->menu_bar_window
));
19567 menu_w
= XWINDOW (f
->menu_bar_window
);
19568 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19570 it
.first_visible_x
= 0;
19571 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19575 /* This is a TTY frame, i.e. character hpos/vpos are used as
19577 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19579 it
.first_visible_x
= 0;
19580 it
.last_visible_x
= FRAME_COLS (f
);
19582 #endif /* not USE_X_TOOLKIT */
19584 /* FIXME: This should be controlled by a user option. See the
19585 comments in redisplay_tool_bar and display_mode_line about
19587 it
.paragraph_embedding
= L2R
;
19589 if (! mode_line_inverse_video
)
19590 /* Force the menu-bar to be displayed in the default face. */
19591 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19593 /* Clear all rows of the menu bar. */
19594 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19596 struct glyph_row
*row
= it
.glyph_row
+ i
;
19597 clear_glyph_row (row
);
19598 row
->enabled_p
= 1;
19599 row
->full_width_p
= 1;
19602 /* Display all items of the menu bar. */
19603 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19604 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19606 Lisp_Object string
;
19608 /* Stop at nil string. */
19609 string
= AREF (items
, i
+ 1);
19613 /* Remember where item was displayed. */
19614 ASET (items
, i
+ 3, make_number (it
.hpos
));
19616 /* Display the item, pad with one space. */
19617 if (it
.current_x
< it
.last_visible_x
)
19618 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19619 SCHARS (string
) + 1, 0, 0, -1);
19622 /* Fill out the line with spaces. */
19623 if (it
.current_x
< it
.last_visible_x
)
19624 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19626 /* Compute the total height of the lines. */
19627 compute_line_metrics (&it
);
19632 /***********************************************************************
19634 ***********************************************************************/
19636 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19637 FORCE is non-zero, redisplay mode lines unconditionally.
19638 Otherwise, redisplay only mode lines that are garbaged. Value is
19639 the number of windows whose mode lines were redisplayed. */
19642 redisplay_mode_lines (Lisp_Object window
, int force
)
19646 while (!NILP (window
))
19648 struct window
*w
= XWINDOW (window
);
19650 if (WINDOWP (w
->hchild
))
19651 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19652 else if (WINDOWP (w
->vchild
))
19653 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19655 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19656 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19658 struct text_pos lpoint
;
19659 struct buffer
*old
= current_buffer
;
19661 /* Set the window's buffer for the mode line display. */
19662 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19663 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19665 /* Point refers normally to the selected window. For any
19666 other window, set up appropriate value. */
19667 if (!EQ (window
, selected_window
))
19669 struct text_pos pt
;
19671 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19672 if (CHARPOS (pt
) < BEGV
)
19673 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19674 else if (CHARPOS (pt
) > (ZV
- 1))
19675 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19677 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19680 /* Display mode lines. */
19681 clear_glyph_matrix (w
->desired_matrix
);
19682 if (display_mode_lines (w
))
19685 w
->must_be_updated_p
= 1;
19688 /* Restore old settings. */
19689 set_buffer_internal_1 (old
);
19690 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19700 /* Display the mode and/or header line of window W. Value is the
19701 sum number of mode lines and header lines displayed. */
19704 display_mode_lines (struct window
*w
)
19706 Lisp_Object old_selected_window
, old_selected_frame
;
19709 old_selected_frame
= selected_frame
;
19710 selected_frame
= w
->frame
;
19711 old_selected_window
= selected_window
;
19712 XSETWINDOW (selected_window
, w
);
19714 /* These will be set while the mode line specs are processed. */
19715 line_number_displayed
= 0;
19716 w
->column_number_displayed
= Qnil
;
19718 if (WINDOW_WANTS_MODELINE_P (w
))
19720 struct window
*sel_w
= XWINDOW (old_selected_window
);
19722 /* Select mode line face based on the real selected window. */
19723 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19724 BVAR (current_buffer
, mode_line_format
));
19728 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19730 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19731 BVAR (current_buffer
, header_line_format
));
19735 selected_frame
= old_selected_frame
;
19736 selected_window
= old_selected_window
;
19741 /* Display mode or header line of window W. FACE_ID specifies which
19742 line to display; it is either MODE_LINE_FACE_ID or
19743 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19744 display. Value is the pixel height of the mode/header line
19748 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19752 ptrdiff_t count
= SPECPDL_INDEX ();
19754 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19755 /* Don't extend on a previously drawn mode-line.
19756 This may happen if called from pos_visible_p. */
19757 it
.glyph_row
->enabled_p
= 0;
19758 prepare_desired_row (it
.glyph_row
);
19760 it
.glyph_row
->mode_line_p
= 1;
19762 if (! mode_line_inverse_video
)
19763 /* Force the mode-line to be displayed in the default face. */
19764 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19766 /* FIXME: This should be controlled by a user option. But
19767 supporting such an option is not trivial, since the mode line is
19768 made up of many separate strings. */
19769 it
.paragraph_embedding
= L2R
;
19771 record_unwind_protect (unwind_format_mode_line
,
19772 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19774 mode_line_target
= MODE_LINE_DISPLAY
;
19776 /* Temporarily make frame's keyboard the current kboard so that
19777 kboard-local variables in the mode_line_format will get the right
19779 push_kboard (FRAME_KBOARD (it
.f
));
19780 record_unwind_save_match_data ();
19781 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19784 unbind_to (count
, Qnil
);
19786 /* Fill up with spaces. */
19787 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19789 compute_line_metrics (&it
);
19790 it
.glyph_row
->full_width_p
= 1;
19791 it
.glyph_row
->continued_p
= 0;
19792 it
.glyph_row
->truncated_on_left_p
= 0;
19793 it
.glyph_row
->truncated_on_right_p
= 0;
19795 /* Make a 3D mode-line have a shadow at its right end. */
19796 face
= FACE_FROM_ID (it
.f
, face_id
);
19797 extend_face_to_end_of_line (&it
);
19798 if (face
->box
!= FACE_NO_BOX
)
19800 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19801 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19802 last
->right_box_line_p
= 1;
19805 return it
.glyph_row
->height
;
19808 /* Move element ELT in LIST to the front of LIST.
19809 Return the updated list. */
19812 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19814 register Lisp_Object tail
, prev
;
19815 register Lisp_Object tem
;
19819 while (CONSP (tail
))
19825 /* Splice out the link TAIL. */
19827 list
= XCDR (tail
);
19829 Fsetcdr (prev
, XCDR (tail
));
19831 /* Now make it the first. */
19832 Fsetcdr (tail
, list
);
19837 tail
= XCDR (tail
);
19841 /* Not found--return unchanged LIST. */
19845 /* Contribute ELT to the mode line for window IT->w. How it
19846 translates into text depends on its data type.
19848 IT describes the display environment in which we display, as usual.
19850 DEPTH is the depth in recursion. It is used to prevent
19851 infinite recursion here.
19853 FIELD_WIDTH is the number of characters the display of ELT should
19854 occupy in the mode line, and PRECISION is the maximum number of
19855 characters to display from ELT's representation. See
19856 display_string for details.
19858 Returns the hpos of the end of the text generated by ELT.
19860 PROPS is a property list to add to any string we encounter.
19862 If RISKY is nonzero, remove (disregard) any properties in any string
19863 we encounter, and ignore :eval and :propertize.
19865 The global variable `mode_line_target' determines whether the
19866 output is passed to `store_mode_line_noprop',
19867 `store_mode_line_string', or `display_string'. */
19870 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19871 Lisp_Object elt
, Lisp_Object props
, int risky
)
19873 int n
= 0, field
, prec
;
19878 elt
= build_string ("*too-deep*");
19882 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19886 /* A string: output it and check for %-constructs within it. */
19888 ptrdiff_t offset
= 0;
19890 if (SCHARS (elt
) > 0
19891 && (!NILP (props
) || risky
))
19893 Lisp_Object oprops
, aelt
;
19894 oprops
= Ftext_properties_at (make_number (0), elt
);
19896 /* If the starting string's properties are not what
19897 we want, translate the string. Also, if the string
19898 is risky, do that anyway. */
19900 if (NILP (Fequal (props
, oprops
)) || risky
)
19902 /* If the starting string has properties,
19903 merge the specified ones onto the existing ones. */
19904 if (! NILP (oprops
) && !risky
)
19908 oprops
= Fcopy_sequence (oprops
);
19910 while (CONSP (tem
))
19912 oprops
= Fplist_put (oprops
, XCAR (tem
),
19913 XCAR (XCDR (tem
)));
19914 tem
= XCDR (XCDR (tem
));
19919 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19920 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19922 /* AELT is what we want. Move it to the front
19923 without consing. */
19925 mode_line_proptrans_alist
19926 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19932 /* If AELT has the wrong props, it is useless.
19933 so get rid of it. */
19935 mode_line_proptrans_alist
19936 = Fdelq (aelt
, mode_line_proptrans_alist
);
19938 elt
= Fcopy_sequence (elt
);
19939 Fset_text_properties (make_number (0), Flength (elt
),
19941 /* Add this item to mode_line_proptrans_alist. */
19942 mode_line_proptrans_alist
19943 = Fcons (Fcons (elt
, props
),
19944 mode_line_proptrans_alist
);
19945 /* Truncate mode_line_proptrans_alist
19946 to at most 50 elements. */
19947 tem
= Fnthcdr (make_number (50),
19948 mode_line_proptrans_alist
);
19950 XSETCDR (tem
, Qnil
);
19959 prec
= precision
- n
;
19960 switch (mode_line_target
)
19962 case MODE_LINE_NOPROP
:
19963 case MODE_LINE_TITLE
:
19964 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19966 case MODE_LINE_STRING
:
19967 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19969 case MODE_LINE_DISPLAY
:
19970 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19971 0, prec
, 0, STRING_MULTIBYTE (elt
));
19978 /* Handle the non-literal case. */
19980 while ((precision
<= 0 || n
< precision
)
19981 && SREF (elt
, offset
) != 0
19982 && (mode_line_target
!= MODE_LINE_DISPLAY
19983 || it
->current_x
< it
->last_visible_x
))
19985 ptrdiff_t last_offset
= offset
;
19987 /* Advance to end of string or next format specifier. */
19988 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19991 if (offset
- 1 != last_offset
)
19993 ptrdiff_t nchars
, nbytes
;
19995 /* Output to end of string or up to '%'. Field width
19996 is length of string. Don't output more than
19997 PRECISION allows us. */
20000 prec
= c_string_width (SDATA (elt
) + last_offset
,
20001 offset
- last_offset
, precision
- n
,
20004 switch (mode_line_target
)
20006 case MODE_LINE_NOPROP
:
20007 case MODE_LINE_TITLE
:
20008 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20010 case MODE_LINE_STRING
:
20012 ptrdiff_t bytepos
= last_offset
;
20013 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20014 ptrdiff_t endpos
= (precision
<= 0
20015 ? string_byte_to_char (elt
, offset
)
20016 : charpos
+ nchars
);
20018 n
+= store_mode_line_string (NULL
,
20019 Fsubstring (elt
, make_number (charpos
),
20020 make_number (endpos
)),
20024 case MODE_LINE_DISPLAY
:
20026 ptrdiff_t bytepos
= last_offset
;
20027 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20029 if (precision
<= 0)
20030 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20031 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20033 STRING_MULTIBYTE (elt
));
20038 else /* c == '%' */
20040 ptrdiff_t percent_position
= offset
;
20042 /* Get the specified minimum width. Zero means
20045 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20046 field
= field
* 10 + c
- '0';
20048 /* Don't pad beyond the total padding allowed. */
20049 if (field_width
- n
> 0 && field
> field_width
- n
)
20050 field
= field_width
- n
;
20052 /* Note that either PRECISION <= 0 or N < PRECISION. */
20053 prec
= precision
- n
;
20056 n
+= display_mode_element (it
, depth
, field
, prec
,
20057 Vglobal_mode_string
, props
,
20062 ptrdiff_t bytepos
, charpos
;
20064 Lisp_Object string
;
20066 bytepos
= percent_position
;
20067 charpos
= (STRING_MULTIBYTE (elt
)
20068 ? string_byte_to_char (elt
, bytepos
)
20070 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20071 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20073 switch (mode_line_target
)
20075 case MODE_LINE_NOPROP
:
20076 case MODE_LINE_TITLE
:
20077 n
+= store_mode_line_noprop (spec
, field
, prec
);
20079 case MODE_LINE_STRING
:
20081 Lisp_Object tem
= build_string (spec
);
20082 props
= Ftext_properties_at (make_number (charpos
), elt
);
20083 /* Should only keep face property in props */
20084 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20087 case MODE_LINE_DISPLAY
:
20089 int nglyphs_before
, nwritten
;
20091 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20092 nwritten
= display_string (spec
, string
, elt
,
20097 /* Assign to the glyphs written above the
20098 string where the `%x' came from, position
20102 struct glyph
*glyph
20103 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20107 for (i
= 0; i
< nwritten
; ++i
)
20109 glyph
[i
].object
= elt
;
20110 glyph
[i
].charpos
= charpos
;
20127 /* A symbol: process the value of the symbol recursively
20128 as if it appeared here directly. Avoid error if symbol void.
20129 Special case: if value of symbol is a string, output the string
20132 register Lisp_Object tem
;
20134 /* If the variable is not marked as risky to set
20135 then its contents are risky to use. */
20136 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20139 tem
= Fboundp (elt
);
20142 tem
= Fsymbol_value (elt
);
20143 /* If value is a string, output that string literally:
20144 don't check for % within it. */
20148 if (!EQ (tem
, elt
))
20150 /* Give up right away for nil or t. */
20160 register Lisp_Object car
, tem
;
20162 /* A cons cell: five distinct cases.
20163 If first element is :eval or :propertize, do something special.
20164 If first element is a string or a cons, process all the elements
20165 and effectively concatenate them.
20166 If first element is a negative number, truncate displaying cdr to
20167 at most that many characters. If positive, pad (with spaces)
20168 to at least that many characters.
20169 If first element is a symbol, process the cadr or caddr recursively
20170 according to whether the symbol's value is non-nil or nil. */
20172 if (EQ (car
, QCeval
))
20174 /* An element of the form (:eval FORM) means evaluate FORM
20175 and use the result as mode line elements. */
20180 if (CONSP (XCDR (elt
)))
20183 spec
= safe_eval (XCAR (XCDR (elt
)));
20184 n
+= display_mode_element (it
, depth
, field_width
- n
,
20185 precision
- n
, spec
, props
,
20189 else if (EQ (car
, QCpropertize
))
20191 /* An element of the form (:propertize ELT PROPS...)
20192 means display ELT but applying properties PROPS. */
20197 if (CONSP (XCDR (elt
)))
20198 n
+= display_mode_element (it
, depth
, field_width
- n
,
20199 precision
- n
, XCAR (XCDR (elt
)),
20200 XCDR (XCDR (elt
)), risky
);
20202 else if (SYMBOLP (car
))
20204 tem
= Fboundp (car
);
20208 /* elt is now the cdr, and we know it is a cons cell.
20209 Use its car if CAR has a non-nil value. */
20212 tem
= Fsymbol_value (car
);
20219 /* Symbol's value is nil (or symbol is unbound)
20220 Get the cddr of the original list
20221 and if possible find the caddr and use that. */
20225 else if (!CONSP (elt
))
20230 else if (INTEGERP (car
))
20232 register int lim
= XINT (car
);
20236 /* Negative int means reduce maximum width. */
20237 if (precision
<= 0)
20240 precision
= min (precision
, -lim
);
20244 /* Padding specified. Don't let it be more than
20245 current maximum. */
20247 lim
= min (precision
, lim
);
20249 /* If that's more padding than already wanted, queue it.
20250 But don't reduce padding already specified even if
20251 that is beyond the current truncation point. */
20252 field_width
= max (lim
, field_width
);
20256 else if (STRINGP (car
) || CONSP (car
))
20258 Lisp_Object halftail
= elt
;
20262 && (precision
<= 0 || n
< precision
))
20264 n
+= display_mode_element (it
, depth
,
20265 /* Do padding only after the last
20266 element in the list. */
20267 (! CONSP (XCDR (elt
))
20270 precision
- n
, XCAR (elt
),
20274 if ((len
& 1) == 0)
20275 halftail
= XCDR (halftail
);
20276 /* Check for cycle. */
20277 if (EQ (halftail
, elt
))
20286 elt
= build_string ("*invalid*");
20290 /* Pad to FIELD_WIDTH. */
20291 if (field_width
> 0 && n
< field_width
)
20293 switch (mode_line_target
)
20295 case MODE_LINE_NOPROP
:
20296 case MODE_LINE_TITLE
:
20297 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20299 case MODE_LINE_STRING
:
20300 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20302 case MODE_LINE_DISPLAY
:
20303 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20312 /* Store a mode-line string element in mode_line_string_list.
20314 If STRING is non-null, display that C string. Otherwise, the Lisp
20315 string LISP_STRING is displayed.
20317 FIELD_WIDTH is the minimum number of output glyphs to produce.
20318 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20319 with spaces. FIELD_WIDTH <= 0 means don't pad.
20321 PRECISION is the maximum number of characters to output from
20322 STRING. PRECISION <= 0 means don't truncate the string.
20324 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20325 properties to the string.
20327 PROPS are the properties to add to the string.
20328 The mode_line_string_face face property is always added to the string.
20332 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20333 int field_width
, int precision
, Lisp_Object props
)
20338 if (string
!= NULL
)
20340 len
= strlen (string
);
20341 if (precision
> 0 && len
> precision
)
20343 lisp_string
= make_string (string
, len
);
20345 props
= mode_line_string_face_prop
;
20346 else if (!NILP (mode_line_string_face
))
20348 Lisp_Object face
= Fplist_get (props
, Qface
);
20349 props
= Fcopy_sequence (props
);
20351 face
= mode_line_string_face
;
20353 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20354 props
= Fplist_put (props
, Qface
, face
);
20356 Fadd_text_properties (make_number (0), make_number (len
),
20357 props
, lisp_string
);
20361 len
= XFASTINT (Flength (lisp_string
));
20362 if (precision
> 0 && len
> precision
)
20365 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20368 if (!NILP (mode_line_string_face
))
20372 props
= Ftext_properties_at (make_number (0), lisp_string
);
20373 face
= Fplist_get (props
, Qface
);
20375 face
= mode_line_string_face
;
20377 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20378 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20380 lisp_string
= Fcopy_sequence (lisp_string
);
20383 Fadd_text_properties (make_number (0), make_number (len
),
20384 props
, lisp_string
);
20389 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20393 if (field_width
> len
)
20395 field_width
-= len
;
20396 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20398 Fadd_text_properties (make_number (0), make_number (field_width
),
20399 props
, lisp_string
);
20400 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20408 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20410 doc
: /* Format a string out of a mode line format specification.
20411 First arg FORMAT specifies the mode line format (see `mode-line-format'
20412 for details) to use.
20414 By default, the format is evaluated for the currently selected window.
20416 Optional second arg FACE specifies the face property to put on all
20417 characters for which no face is specified. The value nil means the
20418 default face. The value t means whatever face the window's mode line
20419 currently uses (either `mode-line' or `mode-line-inactive',
20420 depending on whether the window is the selected window or not).
20421 An integer value means the value string has no text
20424 Optional third and fourth args WINDOW and BUFFER specify the window
20425 and buffer to use as the context for the formatting (defaults
20426 are the selected window and the WINDOW's buffer). */)
20427 (Lisp_Object format
, Lisp_Object face
,
20428 Lisp_Object window
, Lisp_Object buffer
)
20433 struct buffer
*old_buffer
= NULL
;
20435 int no_props
= INTEGERP (face
);
20436 ptrdiff_t count
= SPECPDL_INDEX ();
20438 int string_start
= 0;
20441 window
= selected_window
;
20442 CHECK_WINDOW (window
);
20443 w
= XWINDOW (window
);
20446 buffer
= w
->buffer
;
20447 CHECK_BUFFER (buffer
);
20449 /* Make formatting the modeline a non-op when noninteractive, otherwise
20450 there will be problems later caused by a partially initialized frame. */
20451 if (NILP (format
) || noninteractive
)
20452 return empty_unibyte_string
;
20457 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20458 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20459 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20460 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20461 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20462 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20463 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20466 if (XBUFFER (buffer
) != current_buffer
)
20467 old_buffer
= current_buffer
;
20469 /* Save things including mode_line_proptrans_alist,
20470 and set that to nil so that we don't alter the outer value. */
20471 record_unwind_protect (unwind_format_mode_line
,
20472 format_mode_line_unwind_data
20473 (old_buffer
, selected_window
, 1));
20474 mode_line_proptrans_alist
= Qnil
;
20476 Fselect_window (window
, Qt
);
20478 set_buffer_internal_1 (XBUFFER (buffer
));
20480 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20484 mode_line_target
= MODE_LINE_NOPROP
;
20485 mode_line_string_face_prop
= Qnil
;
20486 mode_line_string_list
= Qnil
;
20487 string_start
= MODE_LINE_NOPROP_LEN (0);
20491 mode_line_target
= MODE_LINE_STRING
;
20492 mode_line_string_list
= Qnil
;
20493 mode_line_string_face
= face
;
20494 mode_line_string_face_prop
20495 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20498 push_kboard (FRAME_KBOARD (it
.f
));
20499 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20504 len
= MODE_LINE_NOPROP_LEN (string_start
);
20505 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20509 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20510 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20511 empty_unibyte_string
);
20514 unbind_to (count
, Qnil
);
20518 /* Write a null-terminated, right justified decimal representation of
20519 the positive integer D to BUF using a minimal field width WIDTH. */
20522 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20524 register char *p
= buf
;
20532 *p
++ = d
% 10 + '0';
20537 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20548 /* Write a null-terminated, right justified decimal and "human
20549 readable" representation of the nonnegative integer D to BUF using
20550 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20552 static const char power_letter
[] =
20566 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
20568 /* We aim to represent the nonnegative integer D as
20569 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20570 ptrdiff_t quotient
= d
;
20572 /* -1 means: do not use TENTHS. */
20576 /* Length of QUOTIENT.TENTHS as a string. */
20582 if (1000 <= quotient
)
20584 /* Scale to the appropriate EXPONENT. */
20587 remainder
= quotient
% 1000;
20591 while (1000 <= quotient
);
20593 /* Round to nearest and decide whether to use TENTHS or not. */
20596 tenths
= remainder
/ 100;
20597 if (50 <= remainder
% 100)
20604 if (quotient
== 10)
20612 if (500 <= remainder
)
20614 if (quotient
< 999)
20625 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20626 if (tenths
== -1 && quotient
<= 99)
20633 p
= psuffix
= buf
+ max (width
, length
);
20635 /* Print EXPONENT. */
20636 *psuffix
++ = power_letter
[exponent
];
20639 /* Print TENTHS. */
20642 *--p
= '0' + tenths
;
20646 /* Print QUOTIENT. */
20649 int digit
= quotient
% 10;
20650 *--p
= '0' + digit
;
20652 while ((quotient
/= 10) != 0);
20654 /* Print leading spaces. */
20659 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20660 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20661 type of CODING_SYSTEM. Return updated pointer into BUF. */
20663 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20666 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20669 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20670 const unsigned char *eol_str
;
20672 /* The EOL conversion we are using. */
20673 Lisp_Object eoltype
;
20675 val
= CODING_SYSTEM_SPEC (coding_system
);
20678 if (!VECTORP (val
)) /* Not yet decided. */
20683 eoltype
= eol_mnemonic_undecided
;
20684 /* Don't mention EOL conversion if it isn't decided. */
20689 Lisp_Object eolvalue
;
20691 attrs
= AREF (val
, 0);
20692 eolvalue
= AREF (val
, 2);
20695 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20699 /* The EOL conversion that is normal on this system. */
20701 if (NILP (eolvalue
)) /* Not yet decided. */
20702 eoltype
= eol_mnemonic_undecided
;
20703 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20704 eoltype
= eol_mnemonic_undecided
;
20705 else /* eolvalue is Qunix, Qdos, or Qmac. */
20706 eoltype
= (EQ (eolvalue
, Qunix
)
20707 ? eol_mnemonic_unix
20708 : (EQ (eolvalue
, Qdos
) == 1
20709 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20715 /* Mention the EOL conversion if it is not the usual one. */
20716 if (STRINGP (eoltype
))
20718 eol_str
= SDATA (eoltype
);
20719 eol_str_len
= SBYTES (eoltype
);
20721 else if (CHARACTERP (eoltype
))
20723 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20724 int c
= XFASTINT (eoltype
);
20725 eol_str_len
= CHAR_STRING (c
, tmp
);
20730 eol_str
= invalid_eol_type
;
20731 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20733 memcpy (buf
, eol_str
, eol_str_len
);
20734 buf
+= eol_str_len
;
20740 /* Return a string for the output of a mode line %-spec for window W,
20741 generated by character C. FIELD_WIDTH > 0 means pad the string
20742 returned with spaces to that value. Return a Lisp string in
20743 *STRING if the resulting string is taken from that Lisp string.
20745 Note we operate on the current buffer for most purposes,
20746 the exception being w->base_line_pos. */
20748 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20750 static const char *
20751 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20752 Lisp_Object
*string
)
20755 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20756 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20757 struct buffer
*b
= current_buffer
;
20765 if (!NILP (BVAR (b
, read_only
)))
20767 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20772 /* This differs from %* only for a modified read-only buffer. */
20773 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20775 if (!NILP (BVAR (b
, read_only
)))
20780 /* This differs from %* in ignoring read-only-ness. */
20781 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20793 if (command_loop_level
> 5)
20795 p
= decode_mode_spec_buf
;
20796 for (i
= 0; i
< command_loop_level
; i
++)
20799 return decode_mode_spec_buf
;
20807 if (command_loop_level
> 5)
20809 p
= decode_mode_spec_buf
;
20810 for (i
= 0; i
< command_loop_level
; i
++)
20813 return decode_mode_spec_buf
;
20820 /* Let lots_of_dashes be a string of infinite length. */
20821 if (mode_line_target
== MODE_LINE_NOPROP
||
20822 mode_line_target
== MODE_LINE_STRING
)
20824 if (field_width
<= 0
20825 || field_width
> sizeof (lots_of_dashes
))
20827 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20828 decode_mode_spec_buf
[i
] = '-';
20829 decode_mode_spec_buf
[i
] = '\0';
20830 return decode_mode_spec_buf
;
20833 return lots_of_dashes
;
20837 obj
= BVAR (b
, name
);
20841 /* %c and %l are ignored in `frame-title-format'.
20842 (In redisplay_internal, the frame title is drawn _before_ the
20843 windows are updated, so the stuff which depends on actual
20844 window contents (such as %l) may fail to render properly, or
20845 even crash emacs.) */
20846 if (mode_line_target
== MODE_LINE_TITLE
)
20850 ptrdiff_t col
= current_column ();
20851 w
->column_number_displayed
= make_number (col
);
20852 pint2str (decode_mode_spec_buf
, field_width
, col
);
20853 return decode_mode_spec_buf
;
20857 #ifndef SYSTEM_MALLOC
20859 if (NILP (Vmemory_full
))
20862 return "!MEM FULL! ";
20869 /* %F displays the frame name. */
20870 if (!NILP (f
->title
))
20871 return SSDATA (f
->title
);
20872 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20873 return SSDATA (f
->name
);
20877 obj
= BVAR (b
, filename
);
20882 ptrdiff_t size
= ZV
- BEGV
;
20883 pint2str (decode_mode_spec_buf
, field_width
, size
);
20884 return decode_mode_spec_buf
;
20889 ptrdiff_t size
= ZV
- BEGV
;
20890 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20891 return decode_mode_spec_buf
;
20896 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20897 ptrdiff_t topline
, nlines
, height
;
20900 /* %c and %l are ignored in `frame-title-format'. */
20901 if (mode_line_target
== MODE_LINE_TITLE
)
20904 startpos
= XMARKER (w
->start
)->charpos
;
20905 startpos_byte
= marker_byte_position (w
->start
);
20906 height
= WINDOW_TOTAL_LINES (w
);
20908 /* If we decided that this buffer isn't suitable for line numbers,
20909 don't forget that too fast. */
20910 if (EQ (w
->base_line_pos
, w
->buffer
))
20912 /* But do forget it, if the window shows a different buffer now. */
20913 else if (BUFFERP (w
->base_line_pos
))
20914 w
->base_line_pos
= Qnil
;
20916 /* If the buffer is very big, don't waste time. */
20917 if (INTEGERP (Vline_number_display_limit
)
20918 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20920 w
->base_line_pos
= Qnil
;
20921 w
->base_line_number
= Qnil
;
20925 if (INTEGERP (w
->base_line_number
)
20926 && INTEGERP (w
->base_line_pos
)
20927 && XFASTINT (w
->base_line_pos
) <= startpos
)
20929 line
= XFASTINT (w
->base_line_number
);
20930 linepos
= XFASTINT (w
->base_line_pos
);
20931 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20936 linepos
= BUF_BEGV (b
);
20937 linepos_byte
= BUF_BEGV_BYTE (b
);
20940 /* Count lines from base line to window start position. */
20941 nlines
= display_count_lines (linepos_byte
,
20945 topline
= nlines
+ line
;
20947 /* Determine a new base line, if the old one is too close
20948 or too far away, or if we did not have one.
20949 "Too close" means it's plausible a scroll-down would
20950 go back past it. */
20951 if (startpos
== BUF_BEGV (b
))
20953 w
->base_line_number
= make_number (topline
);
20954 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20956 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20957 || linepos
== BUF_BEGV (b
))
20959 ptrdiff_t limit
= BUF_BEGV (b
);
20960 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
20961 ptrdiff_t position
;
20962 ptrdiff_t distance
=
20963 (height
* 2 + 30) * line_number_display_limit_width
;
20965 if (startpos
- distance
> limit
)
20967 limit
= startpos
- distance
;
20968 limit_byte
= CHAR_TO_BYTE (limit
);
20971 nlines
= display_count_lines (startpos_byte
,
20973 - (height
* 2 + 30),
20975 /* If we couldn't find the lines we wanted within
20976 line_number_display_limit_width chars per line,
20977 give up on line numbers for this window. */
20978 if (position
== limit_byte
&& limit
== startpos
- distance
)
20980 w
->base_line_pos
= w
->buffer
;
20981 w
->base_line_number
= Qnil
;
20985 w
->base_line_number
= make_number (topline
- nlines
);
20986 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20989 /* Now count lines from the start pos to point. */
20990 nlines
= display_count_lines (startpos_byte
,
20991 PT_BYTE
, PT
, &junk
);
20993 /* Record that we did display the line number. */
20994 line_number_displayed
= 1;
20996 /* Make the string to show. */
20997 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20998 return decode_mode_spec_buf
;
21001 char* p
= decode_mode_spec_buf
;
21002 int pad
= field_width
- 2;
21008 return decode_mode_spec_buf
;
21014 obj
= BVAR (b
, mode_name
);
21018 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21024 ptrdiff_t pos
= marker_position (w
->start
);
21025 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21027 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21029 if (pos
<= BUF_BEGV (b
))
21034 else if (pos
<= BUF_BEGV (b
))
21038 if (total
> 1000000)
21039 /* Do it differently for a large value, to avoid overflow. */
21040 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21042 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21043 /* We can't normally display a 3-digit number,
21044 so get us a 2-digit number that is close. */
21047 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21048 return decode_mode_spec_buf
;
21052 /* Display percentage of size above the bottom of the screen. */
21055 ptrdiff_t toppos
= marker_position (w
->start
);
21056 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21057 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21059 if (botpos
>= BUF_ZV (b
))
21061 if (toppos
<= BUF_BEGV (b
))
21068 if (total
> 1000000)
21069 /* Do it differently for a large value, to avoid overflow. */
21070 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21072 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21073 /* We can't normally display a 3-digit number,
21074 so get us a 2-digit number that is close. */
21077 if (toppos
<= BUF_BEGV (b
))
21078 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21080 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21081 return decode_mode_spec_buf
;
21086 /* status of process */
21087 obj
= Fget_buffer_process (Fcurrent_buffer ());
21089 return "no process";
21091 obj
= Fsymbol_name (Fprocess_status (obj
));
21097 ptrdiff_t count
= inhibit_garbage_collection ();
21098 Lisp_Object val
= call1 (intern ("file-remote-p"),
21099 BVAR (current_buffer
, directory
));
21100 unbind_to (count
, Qnil
);
21108 case 't': /* indicate TEXT or BINARY */
21112 /* coding-system (not including end-of-line format) */
21114 /* coding-system (including end-of-line type) */
21116 int eol_flag
= (c
== 'Z');
21117 char *p
= decode_mode_spec_buf
;
21119 if (! FRAME_WINDOW_P (f
))
21121 /* No need to mention EOL here--the terminal never needs
21122 to do EOL conversion. */
21123 p
= decode_mode_spec_coding (CODING_ID_NAME
21124 (FRAME_KEYBOARD_CODING (f
)->id
),
21126 p
= decode_mode_spec_coding (CODING_ID_NAME
21127 (FRAME_TERMINAL_CODING (f
)->id
),
21130 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21133 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21134 #ifdef subprocesses
21135 obj
= Fget_buffer_process (Fcurrent_buffer ());
21136 if (PROCESSP (obj
))
21138 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21140 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21143 #endif /* subprocesses */
21146 return decode_mode_spec_buf
;
21153 return SSDATA (obj
);
21160 /* Count up to COUNT lines starting from START_BYTE.
21161 But don't go beyond LIMIT_BYTE.
21162 Return the number of lines thus found (always nonnegative).
21164 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21167 display_count_lines (ptrdiff_t start_byte
,
21168 ptrdiff_t limit_byte
, ptrdiff_t count
,
21169 ptrdiff_t *byte_pos_ptr
)
21171 register unsigned char *cursor
;
21172 unsigned char *base
;
21174 register ptrdiff_t ceiling
;
21175 register unsigned char *ceiling_addr
;
21176 ptrdiff_t orig_count
= count
;
21178 /* If we are not in selective display mode,
21179 check only for newlines. */
21180 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21181 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21185 while (start_byte
< limit_byte
)
21187 ceiling
= BUFFER_CEILING_OF (start_byte
);
21188 ceiling
= min (limit_byte
- 1, ceiling
);
21189 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21190 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21193 if (selective_display
)
21194 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21197 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21200 if (cursor
!= ceiling_addr
)
21204 start_byte
+= cursor
- base
+ 1;
21205 *byte_pos_ptr
= start_byte
;
21209 if (++cursor
== ceiling_addr
)
21215 start_byte
+= cursor
- base
;
21220 while (start_byte
> limit_byte
)
21222 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21223 ceiling
= max (limit_byte
, ceiling
);
21224 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21225 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21228 if (selective_display
)
21229 while (--cursor
!= ceiling_addr
21230 && *cursor
!= '\n' && *cursor
!= 015)
21233 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21236 if (cursor
!= ceiling_addr
)
21240 start_byte
+= cursor
- base
+ 1;
21241 *byte_pos_ptr
= start_byte
;
21242 /* When scanning backwards, we should
21243 not count the newline posterior to which we stop. */
21244 return - orig_count
- 1;
21250 /* Here we add 1 to compensate for the last decrement
21251 of CURSOR, which took it past the valid range. */
21252 start_byte
+= cursor
- base
+ 1;
21256 *byte_pos_ptr
= limit_byte
;
21259 return - orig_count
+ count
;
21260 return orig_count
- count
;
21266 /***********************************************************************
21268 ***********************************************************************/
21270 /* Display a NUL-terminated string, starting with index START.
21272 If STRING is non-null, display that C string. Otherwise, the Lisp
21273 string LISP_STRING is displayed. There's a case that STRING is
21274 non-null and LISP_STRING is not nil. It means STRING is a string
21275 data of LISP_STRING. In that case, we display LISP_STRING while
21276 ignoring its text properties.
21278 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21279 FACE_STRING. Display STRING or LISP_STRING with the face at
21280 FACE_STRING_POS in FACE_STRING:
21282 Display the string in the environment given by IT, but use the
21283 standard display table, temporarily.
21285 FIELD_WIDTH is the minimum number of output glyphs to produce.
21286 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21287 with spaces. If STRING has more characters, more than FIELD_WIDTH
21288 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21290 PRECISION is the maximum number of characters to output from
21291 STRING. PRECISION < 0 means don't truncate the string.
21293 This is roughly equivalent to printf format specifiers:
21295 FIELD_WIDTH PRECISION PRINTF
21296 ----------------------------------------
21302 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21303 display them, and < 0 means obey the current buffer's value of
21304 enable_multibyte_characters.
21306 Value is the number of columns displayed. */
21309 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21310 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21311 int field_width
, int precision
, int max_x
, int multibyte
)
21313 int hpos_at_start
= it
->hpos
;
21314 int saved_face_id
= it
->face_id
;
21315 struct glyph_row
*row
= it
->glyph_row
;
21316 ptrdiff_t it_charpos
;
21318 /* Initialize the iterator IT for iteration over STRING beginning
21319 with index START. */
21320 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21321 precision
, field_width
, multibyte
);
21322 if (string
&& STRINGP (lisp_string
))
21323 /* LISP_STRING is the one returned by decode_mode_spec. We should
21324 ignore its text properties. */
21325 it
->stop_charpos
= it
->end_charpos
;
21327 /* If displaying STRING, set up the face of the iterator from
21328 FACE_STRING, if that's given. */
21329 if (STRINGP (face_string
))
21335 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21336 0, it
->region_beg_charpos
,
21337 it
->region_end_charpos
,
21338 &endptr
, it
->base_face_id
, 0);
21339 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21340 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21343 /* Set max_x to the maximum allowed X position. Don't let it go
21344 beyond the right edge of the window. */
21346 max_x
= it
->last_visible_x
;
21348 max_x
= min (max_x
, it
->last_visible_x
);
21350 /* Skip over display elements that are not visible. because IT->w is
21352 if (it
->current_x
< it
->first_visible_x
)
21353 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21354 MOVE_TO_POS
| MOVE_TO_X
);
21356 row
->ascent
= it
->max_ascent
;
21357 row
->height
= it
->max_ascent
+ it
->max_descent
;
21358 row
->phys_ascent
= it
->max_phys_ascent
;
21359 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21360 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21362 if (STRINGP (it
->string
))
21363 it_charpos
= IT_STRING_CHARPOS (*it
);
21365 it_charpos
= IT_CHARPOS (*it
);
21367 /* This condition is for the case that we are called with current_x
21368 past last_visible_x. */
21369 while (it
->current_x
< max_x
)
21371 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21373 /* Get the next display element. */
21374 if (!get_next_display_element (it
))
21377 /* Produce glyphs. */
21378 x_before
= it
->current_x
;
21379 n_glyphs_before
= row
->used
[TEXT_AREA
];
21380 PRODUCE_GLYPHS (it
);
21382 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21385 while (i
< nglyphs
)
21387 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21389 if (it
->line_wrap
!= TRUNCATE
21390 && x
+ glyph
->pixel_width
> max_x
)
21392 /* End of continued line or max_x reached. */
21393 if (CHAR_GLYPH_PADDING_P (*glyph
))
21395 /* A wide character is unbreakable. */
21396 if (row
->reversed_p
)
21397 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21398 - n_glyphs_before
);
21399 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21400 it
->current_x
= x_before
;
21404 if (row
->reversed_p
)
21405 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21406 - (n_glyphs_before
+ i
));
21407 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21412 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21414 /* Glyph is at least partially visible. */
21416 if (x
< it
->first_visible_x
)
21417 row
->x
= x
- it
->first_visible_x
;
21421 /* Glyph is off the left margin of the display area.
21422 Should not happen. */
21426 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21427 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21428 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21429 row
->phys_height
= max (row
->phys_height
,
21430 it
->max_phys_ascent
+ it
->max_phys_descent
);
21431 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21432 it
->max_extra_line_spacing
);
21433 x
+= glyph
->pixel_width
;
21437 /* Stop if max_x reached. */
21441 /* Stop at line ends. */
21442 if (ITERATOR_AT_END_OF_LINE_P (it
))
21444 it
->continuation_lines_width
= 0;
21448 set_iterator_to_next (it
, 1);
21449 if (STRINGP (it
->string
))
21450 it_charpos
= IT_STRING_CHARPOS (*it
);
21452 it_charpos
= IT_CHARPOS (*it
);
21454 /* Stop if truncating at the right edge. */
21455 if (it
->line_wrap
== TRUNCATE
21456 && it
->current_x
>= it
->last_visible_x
)
21458 /* Add truncation mark, but don't do it if the line is
21459 truncated at a padding space. */
21460 if (it_charpos
< it
->string_nchars
)
21462 if (!FRAME_WINDOW_P (it
->f
))
21466 if (it
->current_x
> it
->last_visible_x
)
21468 if (!row
->reversed_p
)
21470 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21471 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21476 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21477 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21479 unproduce_glyphs (it
, ii
+ 1);
21480 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21482 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21484 row
->used
[TEXT_AREA
] = ii
;
21485 produce_special_glyphs (it
, IT_TRUNCATION
);
21488 produce_special_glyphs (it
, IT_TRUNCATION
);
21490 row
->truncated_on_right_p
= 1;
21496 /* Maybe insert a truncation at the left. */
21497 if (it
->first_visible_x
21500 if (!FRAME_WINDOW_P (it
->f
))
21501 insert_left_trunc_glyphs (it
);
21502 row
->truncated_on_left_p
= 1;
21505 it
->face_id
= saved_face_id
;
21507 /* Value is number of columns displayed. */
21508 return it
->hpos
- hpos_at_start
;
21513 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21514 appears as an element of LIST or as the car of an element of LIST.
21515 If PROPVAL is a list, compare each element against LIST in that
21516 way, and return 1/2 if any element of PROPVAL is found in LIST.
21517 Otherwise return 0. This function cannot quit.
21518 The return value is 2 if the text is invisible but with an ellipsis
21519 and 1 if it's invisible and without an ellipsis. */
21522 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21524 register Lisp_Object tail
, proptail
;
21526 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21528 register Lisp_Object tem
;
21530 if (EQ (propval
, tem
))
21532 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21533 return NILP (XCDR (tem
)) ? 1 : 2;
21536 if (CONSP (propval
))
21538 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21540 Lisp_Object propelt
;
21541 propelt
= XCAR (proptail
);
21542 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21544 register Lisp_Object tem
;
21546 if (EQ (propelt
, tem
))
21548 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21549 return NILP (XCDR (tem
)) ? 1 : 2;
21557 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21558 doc
: /* Non-nil if the property makes the text invisible.
21559 POS-OR-PROP can be a marker or number, in which case it is taken to be
21560 a position in the current buffer and the value of the `invisible' property
21561 is checked; or it can be some other value, which is then presumed to be the
21562 value of the `invisible' property of the text of interest.
21563 The non-nil value returned can be t for truly invisible text or something
21564 else if the text is replaced by an ellipsis. */)
21565 (Lisp_Object pos_or_prop
)
21568 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21569 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21571 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21572 return (invis
== 0 ? Qnil
21574 : make_number (invis
));
21577 /* Calculate a width or height in pixels from a specification using
21578 the following elements:
21581 NUM - a (fractional) multiple of the default font width/height
21582 (NUM) - specifies exactly NUM pixels
21583 UNIT - a fixed number of pixels, see below.
21584 ELEMENT - size of a display element in pixels, see below.
21585 (NUM . SPEC) - equals NUM * SPEC
21586 (+ SPEC SPEC ...) - add pixel values
21587 (- SPEC SPEC ...) - subtract pixel values
21588 (- SPEC) - negate pixel value
21591 INT or FLOAT - a number constant
21592 SYMBOL - use symbol's (buffer local) variable binding.
21595 in - pixels per inch *)
21596 mm - pixels per 1/1000 meter *)
21597 cm - pixels per 1/100 meter *)
21598 width - width of current font in pixels.
21599 height - height of current font in pixels.
21601 *) using the ratio(s) defined in display-pixels-per-inch.
21605 left-fringe - left fringe width in pixels
21606 right-fringe - right fringe width in pixels
21608 left-margin - left margin width in pixels
21609 right-margin - right margin width in pixels
21611 scroll-bar - scroll-bar area width in pixels
21615 Pixels corresponding to 5 inches:
21618 Total width of non-text areas on left side of window (if scroll-bar is on left):
21619 '(space :width (+ left-fringe left-margin scroll-bar))
21621 Align to first text column (in header line):
21622 '(space :align-to 0)
21624 Align to middle of text area minus half the width of variable `my-image'
21625 containing a loaded image:
21626 '(space :align-to (0.5 . (- text my-image)))
21628 Width of left margin minus width of 1 character in the default font:
21629 '(space :width (- left-margin 1))
21631 Width of left margin minus width of 2 characters in the current font:
21632 '(space :width (- left-margin (2 . width)))
21634 Center 1 character over left-margin (in header line):
21635 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21637 Different ways to express width of left fringe plus left margin minus one pixel:
21638 '(space :width (- (+ left-fringe left-margin) (1)))
21639 '(space :width (+ left-fringe left-margin (- (1))))
21640 '(space :width (+ left-fringe left-margin (-1)))
21644 #define NUMVAL(X) \
21645 ((INTEGERP (X) || FLOATP (X)) \
21650 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21651 struct font
*font
, int width_p
, int *align_to
)
21655 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21656 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21659 return OK_PIXELS (0);
21661 xassert (FRAME_LIVE_P (it
->f
));
21663 if (SYMBOLP (prop
))
21665 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21667 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21669 if (unit
[0] == 'i' && unit
[1] == 'n')
21671 else if (unit
[0] == 'm' && unit
[1] == 'm')
21673 else if (unit
[0] == 'c' && unit
[1] == 'm')
21680 #ifdef HAVE_WINDOW_SYSTEM
21681 if (FRAME_WINDOW_P (it
->f
)
21683 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21684 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21686 return OK_PIXELS (ppi
/ pixels
);
21689 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21690 || (CONSP (Vdisplay_pixels_per_inch
)
21692 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21693 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21695 return OK_PIXELS (ppi
/ pixels
);
21701 #ifdef HAVE_WINDOW_SYSTEM
21702 if (EQ (prop
, Qheight
))
21703 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21704 if (EQ (prop
, Qwidth
))
21705 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21707 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21708 return OK_PIXELS (1);
21711 if (EQ (prop
, Qtext
))
21712 return OK_PIXELS (width_p
21713 ? window_box_width (it
->w
, TEXT_AREA
)
21714 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21716 if (align_to
&& *align_to
< 0)
21719 if (EQ (prop
, Qleft
))
21720 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21721 if (EQ (prop
, Qright
))
21722 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21723 if (EQ (prop
, Qcenter
))
21724 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21725 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21726 if (EQ (prop
, Qleft_fringe
))
21727 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21728 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21729 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21730 if (EQ (prop
, Qright_fringe
))
21731 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21732 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21733 : window_box_right_offset (it
->w
, TEXT_AREA
));
21734 if (EQ (prop
, Qleft_margin
))
21735 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21736 if (EQ (prop
, Qright_margin
))
21737 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21738 if (EQ (prop
, Qscroll_bar
))
21739 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21741 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21742 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21743 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21748 if (EQ (prop
, Qleft_fringe
))
21749 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21750 if (EQ (prop
, Qright_fringe
))
21751 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21752 if (EQ (prop
, Qleft_margin
))
21753 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21754 if (EQ (prop
, Qright_margin
))
21755 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21756 if (EQ (prop
, Qscroll_bar
))
21757 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21760 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21763 if (INTEGERP (prop
) || FLOATP (prop
))
21765 int base_unit
= (width_p
21766 ? FRAME_COLUMN_WIDTH (it
->f
)
21767 : FRAME_LINE_HEIGHT (it
->f
));
21768 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21773 Lisp_Object car
= XCAR (prop
);
21774 Lisp_Object cdr
= XCDR (prop
);
21778 #ifdef HAVE_WINDOW_SYSTEM
21779 if (FRAME_WINDOW_P (it
->f
)
21780 && valid_image_p (prop
))
21782 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21783 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21785 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21788 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21794 while (CONSP (cdr
))
21796 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21797 font
, width_p
, align_to
))
21800 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21805 if (EQ (car
, Qminus
))
21807 return OK_PIXELS (pixels
);
21810 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21813 if (INTEGERP (car
) || FLOATP (car
))
21816 pixels
= XFLOATINT (car
);
21818 return OK_PIXELS (pixels
);
21819 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21820 font
, width_p
, align_to
))
21821 return OK_PIXELS (pixels
* fact
);
21832 /***********************************************************************
21834 ***********************************************************************/
21836 #ifdef HAVE_WINDOW_SYSTEM
21841 dump_glyph_string (struct glyph_string
*s
)
21843 fprintf (stderr
, "glyph string\n");
21844 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21845 s
->x
, s
->y
, s
->width
, s
->height
);
21846 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21847 fprintf (stderr
, " hl = %d\n", s
->hl
);
21848 fprintf (stderr
, " left overhang = %d, right = %d\n",
21849 s
->left_overhang
, s
->right_overhang
);
21850 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21851 fprintf (stderr
, " extends to end of line = %d\n",
21852 s
->extends_to_end_of_line_p
);
21853 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21854 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21857 #endif /* GLYPH_DEBUG */
21859 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21860 of XChar2b structures for S; it can't be allocated in
21861 init_glyph_string because it must be allocated via `alloca'. W
21862 is the window on which S is drawn. ROW and AREA are the glyph row
21863 and area within the row from which S is constructed. START is the
21864 index of the first glyph structure covered by S. HL is a
21865 face-override for drawing S. */
21868 #define OPTIONAL_HDC(hdc) HDC hdc,
21869 #define DECLARE_HDC(hdc) HDC hdc;
21870 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21871 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21874 #ifndef OPTIONAL_HDC
21875 #define OPTIONAL_HDC(hdc)
21876 #define DECLARE_HDC(hdc)
21877 #define ALLOCATE_HDC(hdc, f)
21878 #define RELEASE_HDC(hdc, f)
21882 init_glyph_string (struct glyph_string
*s
,
21884 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21885 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21887 memset (s
, 0, sizeof *s
);
21889 s
->f
= XFRAME (w
->frame
);
21893 s
->display
= FRAME_X_DISPLAY (s
->f
);
21894 s
->window
= FRAME_X_WINDOW (s
->f
);
21895 s
->char2b
= char2b
;
21899 s
->first_glyph
= row
->glyphs
[area
] + start
;
21900 s
->height
= row
->height
;
21901 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21902 s
->ybase
= s
->y
+ row
->ascent
;
21906 /* Append the list of glyph strings with head H and tail T to the list
21907 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21910 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21911 struct glyph_string
*h
, struct glyph_string
*t
)
21925 /* Prepend the list of glyph strings with head H and tail T to the
21926 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21930 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21931 struct glyph_string
*h
, struct glyph_string
*t
)
21945 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21946 Set *HEAD and *TAIL to the resulting list. */
21949 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21950 struct glyph_string
*s
)
21952 s
->next
= s
->prev
= NULL
;
21953 append_glyph_string_lists (head
, tail
, s
, s
);
21957 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21958 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21959 make sure that X resources for the face returned are allocated.
21960 Value is a pointer to a realized face that is ready for display if
21961 DISPLAY_P is non-zero. */
21963 static inline struct face
*
21964 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21965 XChar2b
*char2b
, int display_p
)
21967 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21971 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21973 if (code
!= FONT_INVALID_CODE
)
21974 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21976 STORE_XCHAR2B (char2b
, 0, 0);
21979 /* Make sure X resources of the face are allocated. */
21980 #ifdef HAVE_X_WINDOWS
21984 xassert (face
!= NULL
);
21985 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21992 /* Get face and two-byte form of character glyph GLYPH on frame F.
21993 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21994 a pointer to a realized face that is ready for display. */
21996 static inline struct face
*
21997 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21998 XChar2b
*char2b
, int *two_byte_p
)
22002 xassert (glyph
->type
== CHAR_GLYPH
);
22003 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22012 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22013 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22015 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22017 if (code
!= FONT_INVALID_CODE
)
22018 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22020 STORE_XCHAR2B (char2b
, 0, 0);
22023 /* Make sure X resources of the face are allocated. */
22024 xassert (face
!= NULL
);
22025 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22030 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22031 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
22034 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22038 if (CHAR_BYTE8_P (c
))
22039 code
= CHAR_TO_BYTE8 (c
);
22041 code
= font
->driver
->encode_char (font
, c
);
22043 if (code
== FONT_INVALID_CODE
)
22045 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22050 /* Fill glyph string S with composition components specified by S->cmp.
22052 BASE_FACE is the base face of the composition.
22053 S->cmp_from is the index of the first component for S.
22055 OVERLAPS non-zero means S should draw the foreground only, and use
22056 its physical height for clipping. See also draw_glyphs.
22058 Value is the index of a component not in S. */
22061 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22065 /* For all glyphs of this composition, starting at the offset
22066 S->cmp_from, until we reach the end of the definition or encounter a
22067 glyph that requires the different face, add it to S. */
22072 s
->for_overlaps
= overlaps
;
22075 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22077 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22079 /* TAB in a composition means display glyphs with padding space
22080 on the left or right. */
22083 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22086 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22093 s
->font
= s
->face
->font
;
22095 else if (s
->face
!= face
)
22103 /* All glyph strings for the same composition has the same width,
22104 i.e. the width set for the first component of the composition. */
22105 s
->width
= s
->first_glyph
->pixel_width
;
22107 /* If the specified font could not be loaded, use the frame's
22108 default font, but record the fact that we couldn't load it in
22109 the glyph string so that we can draw rectangles for the
22110 characters of the glyph string. */
22111 if (s
->font
== NULL
)
22113 s
->font_not_found_p
= 1;
22114 s
->font
= FRAME_FONT (s
->f
);
22117 /* Adjust base line for subscript/superscript text. */
22118 s
->ybase
+= s
->first_glyph
->voffset
;
22120 /* This glyph string must always be drawn with 16-bit functions. */
22127 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22128 int start
, int end
, int overlaps
)
22130 struct glyph
*glyph
, *last
;
22131 Lisp_Object lgstring
;
22134 s
->for_overlaps
= overlaps
;
22135 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22136 last
= s
->row
->glyphs
[s
->area
] + end
;
22137 s
->cmp_id
= glyph
->u
.cmp
.id
;
22138 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22139 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22140 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22141 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22142 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22144 while (glyph
< last
22145 && glyph
->u
.cmp
.automatic
22146 && glyph
->u
.cmp
.id
== s
->cmp_id
22147 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22148 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22150 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22152 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22153 unsigned code
= LGLYPH_CODE (lglyph
);
22155 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22157 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22158 return glyph
- s
->row
->glyphs
[s
->area
];
22162 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22163 See the comment of fill_glyph_string for arguments.
22164 Value is the index of the first glyph not in S. */
22168 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22169 int start
, int end
, int overlaps
)
22171 struct glyph
*glyph
, *last
;
22174 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22175 s
->for_overlaps
= overlaps
;
22176 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22177 last
= s
->row
->glyphs
[s
->area
] + end
;
22178 voffset
= glyph
->voffset
;
22179 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22180 s
->font
= s
->face
->font
;
22182 s
->width
= glyph
->pixel_width
;
22184 while (glyph
< last
22185 && glyph
->type
== GLYPHLESS_GLYPH
22186 && glyph
->voffset
== voffset
22187 && glyph
->face_id
== face_id
)
22190 s
->width
+= glyph
->pixel_width
;
22193 s
->ybase
+= voffset
;
22194 return glyph
- s
->row
->glyphs
[s
->area
];
22198 /* Fill glyph string S from a sequence of character glyphs.
22200 FACE_ID is the face id of the string. START is the index of the
22201 first glyph to consider, END is the index of the last + 1.
22202 OVERLAPS non-zero means S should draw the foreground only, and use
22203 its physical height for clipping. See also draw_glyphs.
22205 Value is the index of the first glyph not in S. */
22208 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22209 int start
, int end
, int overlaps
)
22211 struct glyph
*glyph
, *last
;
22213 int glyph_not_available_p
;
22215 xassert (s
->f
== XFRAME (s
->w
->frame
));
22216 xassert (s
->nchars
== 0);
22217 xassert (start
>= 0 && end
> start
);
22219 s
->for_overlaps
= overlaps
;
22220 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22221 last
= s
->row
->glyphs
[s
->area
] + end
;
22222 voffset
= glyph
->voffset
;
22223 s
->padding_p
= glyph
->padding_p
;
22224 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22226 while (glyph
< last
22227 && glyph
->type
== CHAR_GLYPH
22228 && glyph
->voffset
== voffset
22229 /* Same face id implies same font, nowadays. */
22230 && glyph
->face_id
== face_id
22231 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22235 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22236 s
->char2b
+ s
->nchars
,
22238 s
->two_byte_p
= two_byte_p
;
22240 xassert (s
->nchars
<= end
- start
);
22241 s
->width
+= glyph
->pixel_width
;
22242 if (glyph
++->padding_p
!= s
->padding_p
)
22246 s
->font
= s
->face
->font
;
22248 /* If the specified font could not be loaded, use the frame's font,
22249 but record the fact that we couldn't load it in
22250 S->font_not_found_p so that we can draw rectangles for the
22251 characters of the glyph string. */
22252 if (s
->font
== NULL
|| glyph_not_available_p
)
22254 s
->font_not_found_p
= 1;
22255 s
->font
= FRAME_FONT (s
->f
);
22258 /* Adjust base line for subscript/superscript text. */
22259 s
->ybase
+= voffset
;
22261 xassert (s
->face
&& s
->face
->gc
);
22262 return glyph
- s
->row
->glyphs
[s
->area
];
22266 /* Fill glyph string S from image glyph S->first_glyph. */
22269 fill_image_glyph_string (struct glyph_string
*s
)
22271 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22272 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22274 s
->slice
= s
->first_glyph
->slice
.img
;
22275 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22276 s
->font
= s
->face
->font
;
22277 s
->width
= s
->first_glyph
->pixel_width
;
22279 /* Adjust base line for subscript/superscript text. */
22280 s
->ybase
+= s
->first_glyph
->voffset
;
22284 /* Fill glyph string S from a sequence of stretch glyphs.
22286 START is the index of the first glyph to consider,
22287 END is the index of the last + 1.
22289 Value is the index of the first glyph not in S. */
22292 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22294 struct glyph
*glyph
, *last
;
22295 int voffset
, face_id
;
22297 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22299 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22300 last
= s
->row
->glyphs
[s
->area
] + end
;
22301 face_id
= glyph
->face_id
;
22302 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22303 s
->font
= s
->face
->font
;
22304 s
->width
= glyph
->pixel_width
;
22306 voffset
= glyph
->voffset
;
22310 && glyph
->type
== STRETCH_GLYPH
22311 && glyph
->voffset
== voffset
22312 && glyph
->face_id
== face_id
);
22314 s
->width
+= glyph
->pixel_width
;
22316 /* Adjust base line for subscript/superscript text. */
22317 s
->ybase
+= voffset
;
22319 /* The case that face->gc == 0 is handled when drawing the glyph
22320 string by calling PREPARE_FACE_FOR_DISPLAY. */
22322 return glyph
- s
->row
->glyphs
[s
->area
];
22325 static struct font_metrics
*
22326 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22328 static struct font_metrics metrics
;
22329 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22331 if (! font
|| code
== FONT_INVALID_CODE
)
22333 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22338 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22339 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22340 assumed to be zero. */
22343 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22345 *left
= *right
= 0;
22347 if (glyph
->type
== CHAR_GLYPH
)
22351 struct font_metrics
*pcm
;
22353 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22354 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22356 if (pcm
->rbearing
> pcm
->width
)
22357 *right
= pcm
->rbearing
- pcm
->width
;
22358 if (pcm
->lbearing
< 0)
22359 *left
= -pcm
->lbearing
;
22362 else if (glyph
->type
== COMPOSITE_GLYPH
)
22364 if (! glyph
->u
.cmp
.automatic
)
22366 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22368 if (cmp
->rbearing
> cmp
->pixel_width
)
22369 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22370 if (cmp
->lbearing
< 0)
22371 *left
= - cmp
->lbearing
;
22375 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22376 struct font_metrics metrics
;
22378 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22379 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22380 if (metrics
.rbearing
> metrics
.width
)
22381 *right
= metrics
.rbearing
- metrics
.width
;
22382 if (metrics
.lbearing
< 0)
22383 *left
= - metrics
.lbearing
;
22389 /* Return the index of the first glyph preceding glyph string S that
22390 is overwritten by S because of S's left overhang. Value is -1
22391 if no glyphs are overwritten. */
22394 left_overwritten (struct glyph_string
*s
)
22398 if (s
->left_overhang
)
22401 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22402 int first
= s
->first_glyph
- glyphs
;
22404 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22405 x
-= glyphs
[i
].pixel_width
;
22416 /* Return the index of the first glyph preceding glyph string S that
22417 is overwriting S because of its right overhang. Value is -1 if no
22418 glyph in front of S overwrites S. */
22421 left_overwriting (struct glyph_string
*s
)
22424 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22425 int first
= s
->first_glyph
- glyphs
;
22429 for (i
= first
- 1; i
>= 0; --i
)
22432 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22435 x
-= glyphs
[i
].pixel_width
;
22442 /* Return the index of the last glyph following glyph string S that is
22443 overwritten by S because of S's right overhang. Value is -1 if
22444 no such glyph is found. */
22447 right_overwritten (struct glyph_string
*s
)
22451 if (s
->right_overhang
)
22454 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22455 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22456 int end
= s
->row
->used
[s
->area
];
22458 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22459 x
+= glyphs
[i
].pixel_width
;
22468 /* Return the index of the last glyph following glyph string S that
22469 overwrites S because of its left overhang. Value is negative
22470 if no such glyph is found. */
22473 right_overwriting (struct glyph_string
*s
)
22476 int end
= s
->row
->used
[s
->area
];
22477 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22478 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22482 for (i
= first
; i
< end
; ++i
)
22485 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22488 x
+= glyphs
[i
].pixel_width
;
22495 /* Set background width of glyph string S. START is the index of the
22496 first glyph following S. LAST_X is the right-most x-position + 1
22497 in the drawing area. */
22500 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22502 /* If the face of this glyph string has to be drawn to the end of
22503 the drawing area, set S->extends_to_end_of_line_p. */
22505 if (start
== s
->row
->used
[s
->area
]
22506 && s
->area
== TEXT_AREA
22507 && ((s
->row
->fill_line_p
22508 && (s
->hl
== DRAW_NORMAL_TEXT
22509 || s
->hl
== DRAW_IMAGE_RAISED
22510 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22511 || s
->hl
== DRAW_MOUSE_FACE
))
22512 s
->extends_to_end_of_line_p
= 1;
22514 /* If S extends its face to the end of the line, set its
22515 background_width to the distance to the right edge of the drawing
22517 if (s
->extends_to_end_of_line_p
)
22518 s
->background_width
= last_x
- s
->x
+ 1;
22520 s
->background_width
= s
->width
;
22524 /* Compute overhangs and x-positions for glyph string S and its
22525 predecessors, or successors. X is the starting x-position for S.
22526 BACKWARD_P non-zero means process predecessors. */
22529 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22535 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22536 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22546 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22547 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22557 /* The following macros are only called from draw_glyphs below.
22558 They reference the following parameters of that function directly:
22559 `w', `row', `area', and `overlap_p'
22560 as well as the following local variables:
22561 `s', `f', and `hdc' (in W32) */
22564 /* On W32, silently add local `hdc' variable to argument list of
22565 init_glyph_string. */
22566 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22567 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22569 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22570 init_glyph_string (s, char2b, w, row, area, start, hl)
22573 /* Add a glyph string for a stretch glyph to the list of strings
22574 between HEAD and TAIL. START is the index of the stretch glyph in
22575 row area AREA of glyph row ROW. END is the index of the last glyph
22576 in that glyph row area. X is the current output position assigned
22577 to the new glyph string constructed. HL overrides that face of the
22578 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22579 is the right-most x-position of the drawing area. */
22581 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22582 and below -- keep them on one line. */
22583 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22586 s = (struct glyph_string *) alloca (sizeof *s); \
22587 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22588 START = fill_stretch_glyph_string (s, START, END); \
22589 append_glyph_string (&HEAD, &TAIL, s); \
22595 /* Add a glyph string for an image glyph to the list of strings
22596 between HEAD and TAIL. START is the index of the image glyph in
22597 row area AREA of glyph row ROW. END is the index of the last glyph
22598 in that glyph row area. X is the current output position assigned
22599 to the new glyph string constructed. HL overrides that face of the
22600 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22601 is the right-most x-position of the drawing area. */
22603 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22606 s = (struct glyph_string *) alloca (sizeof *s); \
22607 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22608 fill_image_glyph_string (s); \
22609 append_glyph_string (&HEAD, &TAIL, s); \
22616 /* Add a glyph string for a sequence of character glyphs to the list
22617 of strings between HEAD and TAIL. START is the index of the first
22618 glyph in row area AREA of glyph row ROW that is part of the new
22619 glyph string. END is the index of the last glyph in that glyph row
22620 area. X is the current output position assigned to the new glyph
22621 string constructed. HL overrides that face of the glyph; e.g. it
22622 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22623 right-most x-position of the drawing area. */
22625 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22631 face_id = (row)->glyphs[area][START].face_id; \
22633 s = (struct glyph_string *) alloca (sizeof *s); \
22634 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22635 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22636 append_glyph_string (&HEAD, &TAIL, s); \
22638 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22643 /* Add a glyph string for a composite sequence to the list of strings
22644 between HEAD and TAIL. START is the index of the first glyph in
22645 row area AREA of glyph row ROW that is part of the new glyph
22646 string. END is the index of the last glyph in that glyph row area.
22647 X is the current output position assigned to the new glyph string
22648 constructed. HL overrides that face of the glyph; e.g. it is
22649 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22650 x-position of the drawing area. */
22652 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22654 int face_id = (row)->glyphs[area][START].face_id; \
22655 struct face *base_face = FACE_FROM_ID (f, face_id); \
22656 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22657 struct composition *cmp = composition_table[cmp_id]; \
22659 struct glyph_string *first_s IF_LINT (= NULL); \
22662 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22664 /* Make glyph_strings for each glyph sequence that is drawable by \
22665 the same face, and append them to HEAD/TAIL. */ \
22666 for (n = 0; n < cmp->glyph_len;) \
22668 s = (struct glyph_string *) alloca (sizeof *s); \
22669 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22670 append_glyph_string (&(HEAD), &(TAIL), s); \
22676 n = fill_composite_glyph_string (s, base_face, overlaps); \
22684 /* Add a glyph string for a glyph-string sequence to the list of strings
22685 between HEAD and TAIL. */
22687 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22691 Lisp_Object gstring; \
22693 face_id = (row)->glyphs[area][START].face_id; \
22694 gstring = (composition_gstring_from_id \
22695 ((row)->glyphs[area][START].u.cmp.id)); \
22696 s = (struct glyph_string *) alloca (sizeof *s); \
22697 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22698 * LGSTRING_GLYPH_LEN (gstring)); \
22699 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22700 append_glyph_string (&(HEAD), &(TAIL), s); \
22702 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22706 /* Add a glyph string for a sequence of glyphless character's glyphs
22707 to the list of strings between HEAD and TAIL. The meanings of
22708 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22710 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22715 face_id = (row)->glyphs[area][START].face_id; \
22717 s = (struct glyph_string *) alloca (sizeof *s); \
22718 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22719 append_glyph_string (&HEAD, &TAIL, s); \
22721 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22727 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22728 of AREA of glyph row ROW on window W between indices START and END.
22729 HL overrides the face for drawing glyph strings, e.g. it is
22730 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22731 x-positions of the drawing area.
22733 This is an ugly monster macro construct because we must use alloca
22734 to allocate glyph strings (because draw_glyphs can be called
22735 asynchronously). */
22737 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22740 HEAD = TAIL = NULL; \
22741 while (START < END) \
22743 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22744 switch (first_glyph->type) \
22747 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22751 case COMPOSITE_GLYPH: \
22752 if (first_glyph->u.cmp.automatic) \
22753 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22756 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22760 case STRETCH_GLYPH: \
22761 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22765 case IMAGE_GLYPH: \
22766 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22770 case GLYPHLESS_GLYPH: \
22771 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22781 set_glyph_string_background_width (s, START, LAST_X); \
22788 /* Draw glyphs between START and END in AREA of ROW on window W,
22789 starting at x-position X. X is relative to AREA in W. HL is a
22790 face-override with the following meaning:
22792 DRAW_NORMAL_TEXT draw normally
22793 DRAW_CURSOR draw in cursor face
22794 DRAW_MOUSE_FACE draw in mouse face.
22795 DRAW_INVERSE_VIDEO draw in mode line face
22796 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22797 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22799 If OVERLAPS is non-zero, draw only the foreground of characters and
22800 clip to the physical height of ROW. Non-zero value also defines
22801 the overlapping part to be drawn:
22803 OVERLAPS_PRED overlap with preceding rows
22804 OVERLAPS_SUCC overlap with succeeding rows
22805 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22806 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22808 Value is the x-position reached, relative to AREA of W. */
22811 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22812 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
22813 enum draw_glyphs_face hl
, int overlaps
)
22815 struct glyph_string
*head
, *tail
;
22816 struct glyph_string
*s
;
22817 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22818 int i
, j
, x_reached
, last_x
, area_left
= 0;
22819 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22822 ALLOCATE_HDC (hdc
, f
);
22824 /* Let's rather be paranoid than getting a SEGV. */
22825 end
= min (end
, row
->used
[area
]);
22826 start
= max (0, start
);
22827 start
= min (end
, start
);
22829 /* Translate X to frame coordinates. Set last_x to the right
22830 end of the drawing area. */
22831 if (row
->full_width_p
)
22833 /* X is relative to the left edge of W, without scroll bars
22835 area_left
= WINDOW_LEFT_EDGE_X (w
);
22836 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22840 area_left
= window_box_left (w
, area
);
22841 last_x
= area_left
+ window_box_width (w
, area
);
22845 /* Build a doubly-linked list of glyph_string structures between
22846 head and tail from what we have to draw. Note that the macro
22847 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22848 the reason we use a separate variable `i'. */
22850 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22852 x_reached
= tail
->x
+ tail
->background_width
;
22856 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22857 the row, redraw some glyphs in front or following the glyph
22858 strings built above. */
22859 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22861 struct glyph_string
*h
, *t
;
22862 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22863 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22864 int check_mouse_face
= 0;
22867 /* If mouse highlighting is on, we may need to draw adjacent
22868 glyphs using mouse-face highlighting. */
22869 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22871 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22873 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22874 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22876 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22878 check_mouse_face
= 1;
22879 mouse_beg_col
= (row
== mouse_beg_row
)
22880 ? hlinfo
->mouse_face_beg_col
: 0;
22881 mouse_end_col
= (row
== mouse_end_row
)
22882 ? hlinfo
->mouse_face_end_col
22883 : row
->used
[TEXT_AREA
];
22887 /* Compute overhangs for all glyph strings. */
22888 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22889 for (s
= head
; s
; s
= s
->next
)
22890 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22892 /* Prepend glyph strings for glyphs in front of the first glyph
22893 string that are overwritten because of the first glyph
22894 string's left overhang. The background of all strings
22895 prepended must be drawn because the first glyph string
22897 i
= left_overwritten (head
);
22900 enum draw_glyphs_face overlap_hl
;
22902 /* If this row contains mouse highlighting, attempt to draw
22903 the overlapped glyphs with the correct highlight. This
22904 code fails if the overlap encompasses more than one glyph
22905 and mouse-highlight spans only some of these glyphs.
22906 However, making it work perfectly involves a lot more
22907 code, and I don't know if the pathological case occurs in
22908 practice, so we'll stick to this for now. --- cyd */
22909 if (check_mouse_face
22910 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22911 overlap_hl
= DRAW_MOUSE_FACE
;
22913 overlap_hl
= DRAW_NORMAL_TEXT
;
22916 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22917 overlap_hl
, dummy_x
, last_x
);
22919 compute_overhangs_and_x (t
, head
->x
, 1);
22920 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22924 /* Prepend glyph strings for glyphs in front of the first glyph
22925 string that overwrite that glyph string because of their
22926 right overhang. For these strings, only the foreground must
22927 be drawn, because it draws over the glyph string at `head'.
22928 The background must not be drawn because this would overwrite
22929 right overhangs of preceding glyphs for which no glyph
22931 i
= left_overwriting (head
);
22934 enum draw_glyphs_face overlap_hl
;
22936 if (check_mouse_face
22937 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22938 overlap_hl
= DRAW_MOUSE_FACE
;
22940 overlap_hl
= DRAW_NORMAL_TEXT
;
22943 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22944 overlap_hl
, dummy_x
, last_x
);
22945 for (s
= h
; s
; s
= s
->next
)
22946 s
->background_filled_p
= 1;
22947 compute_overhangs_and_x (t
, head
->x
, 1);
22948 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22951 /* Append glyphs strings for glyphs following the last glyph
22952 string tail that are overwritten by tail. The background of
22953 these strings has to be drawn because tail's foreground draws
22955 i
= right_overwritten (tail
);
22958 enum draw_glyphs_face overlap_hl
;
22960 if (check_mouse_face
22961 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22962 overlap_hl
= DRAW_MOUSE_FACE
;
22964 overlap_hl
= DRAW_NORMAL_TEXT
;
22966 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22967 overlap_hl
, x
, last_x
);
22968 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22969 we don't have `end = i;' here. */
22970 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22971 append_glyph_string_lists (&head
, &tail
, h
, t
);
22975 /* Append glyph strings for glyphs following the last glyph
22976 string tail that overwrite tail. The foreground of such
22977 glyphs has to be drawn because it writes into the background
22978 of tail. The background must not be drawn because it could
22979 paint over the foreground of following glyphs. */
22980 i
= right_overwriting (tail
);
22983 enum draw_glyphs_face overlap_hl
;
22984 if (check_mouse_face
22985 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22986 overlap_hl
= DRAW_MOUSE_FACE
;
22988 overlap_hl
= DRAW_NORMAL_TEXT
;
22991 i
++; /* We must include the Ith glyph. */
22992 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22993 overlap_hl
, x
, last_x
);
22994 for (s
= h
; s
; s
= s
->next
)
22995 s
->background_filled_p
= 1;
22996 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22997 append_glyph_string_lists (&head
, &tail
, h
, t
);
22999 if (clip_head
|| clip_tail
)
23000 for (s
= head
; s
; s
= s
->next
)
23002 s
->clip_head
= clip_head
;
23003 s
->clip_tail
= clip_tail
;
23007 /* Draw all strings. */
23008 for (s
= head
; s
; s
= s
->next
)
23009 FRAME_RIF (f
)->draw_glyph_string (s
);
23012 /* When focus a sole frame and move horizontally, this sets on_p to 0
23013 causing a failure to erase prev cursor position. */
23014 if (area
== TEXT_AREA
23015 && !row
->full_width_p
23016 /* When drawing overlapping rows, only the glyph strings'
23017 foreground is drawn, which doesn't erase a cursor
23021 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23022 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23023 : (tail
? tail
->x
+ tail
->background_width
: x
));
23027 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23028 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23032 /* Value is the x-position up to which drawn, relative to AREA of W.
23033 This doesn't include parts drawn because of overhangs. */
23034 if (row
->full_width_p
)
23035 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23037 x_reached
-= area_left
;
23039 RELEASE_HDC (hdc
, f
);
23044 /* Expand row matrix if too narrow. Don't expand if area
23047 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23049 if (!fonts_changed_p \
23050 && (it->glyph_row->glyphs[area] \
23051 < it->glyph_row->glyphs[area + 1])) \
23053 it->w->ncols_scale_factor++; \
23054 fonts_changed_p = 1; \
23058 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23059 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23062 append_glyph (struct it
*it
)
23064 struct glyph
*glyph
;
23065 enum glyph_row_area area
= it
->area
;
23067 xassert (it
->glyph_row
);
23068 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23070 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23071 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23073 /* If the glyph row is reversed, we need to prepend the glyph
23074 rather than append it. */
23075 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23079 /* Make room for the additional glyph. */
23080 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23082 glyph
= it
->glyph_row
->glyphs
[area
];
23084 glyph
->charpos
= CHARPOS (it
->position
);
23085 glyph
->object
= it
->object
;
23086 if (it
->pixel_width
> 0)
23088 glyph
->pixel_width
= it
->pixel_width
;
23089 glyph
->padding_p
= 0;
23093 /* Assure at least 1-pixel width. Otherwise, cursor can't
23094 be displayed correctly. */
23095 glyph
->pixel_width
= 1;
23096 glyph
->padding_p
= 1;
23098 glyph
->ascent
= it
->ascent
;
23099 glyph
->descent
= it
->descent
;
23100 glyph
->voffset
= it
->voffset
;
23101 glyph
->type
= CHAR_GLYPH
;
23102 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23103 glyph
->multibyte_p
= it
->multibyte_p
;
23104 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23105 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23106 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23107 || it
->phys_descent
> it
->descent
);
23108 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23109 glyph
->face_id
= it
->face_id
;
23110 glyph
->u
.ch
= it
->char_to_display
;
23111 glyph
->slice
.img
= null_glyph_slice
;
23112 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23115 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23116 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23118 glyph
->bidi_type
= it
->bidi_it
.type
;
23122 glyph
->resolved_level
= 0;
23123 glyph
->bidi_type
= UNKNOWN_BT
;
23125 ++it
->glyph_row
->used
[area
];
23128 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23131 /* Store one glyph for the composition IT->cmp_it.id in
23132 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23136 append_composite_glyph (struct it
*it
)
23138 struct glyph
*glyph
;
23139 enum glyph_row_area area
= it
->area
;
23141 xassert (it
->glyph_row
);
23143 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23144 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23146 /* If the glyph row is reversed, we need to prepend the glyph
23147 rather than append it. */
23148 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23152 /* Make room for the new glyph. */
23153 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23155 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23157 glyph
->charpos
= it
->cmp_it
.charpos
;
23158 glyph
->object
= it
->object
;
23159 glyph
->pixel_width
= it
->pixel_width
;
23160 glyph
->ascent
= it
->ascent
;
23161 glyph
->descent
= it
->descent
;
23162 glyph
->voffset
= it
->voffset
;
23163 glyph
->type
= COMPOSITE_GLYPH
;
23164 if (it
->cmp_it
.ch
< 0)
23166 glyph
->u
.cmp
.automatic
= 0;
23167 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23168 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23172 glyph
->u
.cmp
.automatic
= 1;
23173 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23174 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23175 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23177 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23178 glyph
->multibyte_p
= it
->multibyte_p
;
23179 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23180 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23181 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23182 || it
->phys_descent
> it
->descent
);
23183 glyph
->padding_p
= 0;
23184 glyph
->glyph_not_available_p
= 0;
23185 glyph
->face_id
= it
->face_id
;
23186 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23189 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23190 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23192 glyph
->bidi_type
= it
->bidi_it
.type
;
23194 ++it
->glyph_row
->used
[area
];
23197 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23201 /* Change IT->ascent and IT->height according to the setting of
23205 take_vertical_position_into_account (struct it
*it
)
23209 if (it
->voffset
< 0)
23210 /* Increase the ascent so that we can display the text higher
23212 it
->ascent
-= it
->voffset
;
23214 /* Increase the descent so that we can display the text lower
23216 it
->descent
+= it
->voffset
;
23221 /* Produce glyphs/get display metrics for the image IT is loaded with.
23222 See the description of struct display_iterator in dispextern.h for
23223 an overview of struct display_iterator. */
23226 produce_image_glyph (struct it
*it
)
23230 int glyph_ascent
, crop
;
23231 struct glyph_slice slice
;
23233 xassert (it
->what
== IT_IMAGE
);
23235 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23237 /* Make sure X resources of the face is loaded. */
23238 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23240 if (it
->image_id
< 0)
23242 /* Fringe bitmap. */
23243 it
->ascent
= it
->phys_ascent
= 0;
23244 it
->descent
= it
->phys_descent
= 0;
23245 it
->pixel_width
= 0;
23250 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23252 /* Make sure X resources of the image is loaded. */
23253 prepare_image_for_display (it
->f
, img
);
23255 slice
.x
= slice
.y
= 0;
23256 slice
.width
= img
->width
;
23257 slice
.height
= img
->height
;
23259 if (INTEGERP (it
->slice
.x
))
23260 slice
.x
= XINT (it
->slice
.x
);
23261 else if (FLOATP (it
->slice
.x
))
23262 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23264 if (INTEGERP (it
->slice
.y
))
23265 slice
.y
= XINT (it
->slice
.y
);
23266 else if (FLOATP (it
->slice
.y
))
23267 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23269 if (INTEGERP (it
->slice
.width
))
23270 slice
.width
= XINT (it
->slice
.width
);
23271 else if (FLOATP (it
->slice
.width
))
23272 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23274 if (INTEGERP (it
->slice
.height
))
23275 slice
.height
= XINT (it
->slice
.height
);
23276 else if (FLOATP (it
->slice
.height
))
23277 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23279 if (slice
.x
>= img
->width
)
23280 slice
.x
= img
->width
;
23281 if (slice
.y
>= img
->height
)
23282 slice
.y
= img
->height
;
23283 if (slice
.x
+ slice
.width
>= img
->width
)
23284 slice
.width
= img
->width
- slice
.x
;
23285 if (slice
.y
+ slice
.height
> img
->height
)
23286 slice
.height
= img
->height
- slice
.y
;
23288 if (slice
.width
== 0 || slice
.height
== 0)
23291 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23293 it
->descent
= slice
.height
- glyph_ascent
;
23295 it
->descent
+= img
->vmargin
;
23296 if (slice
.y
+ slice
.height
== img
->height
)
23297 it
->descent
+= img
->vmargin
;
23298 it
->phys_descent
= it
->descent
;
23300 it
->pixel_width
= slice
.width
;
23302 it
->pixel_width
+= img
->hmargin
;
23303 if (slice
.x
+ slice
.width
== img
->width
)
23304 it
->pixel_width
+= img
->hmargin
;
23306 /* It's quite possible for images to have an ascent greater than
23307 their height, so don't get confused in that case. */
23308 if (it
->descent
< 0)
23313 if (face
->box
!= FACE_NO_BOX
)
23315 if (face
->box_line_width
> 0)
23318 it
->ascent
+= face
->box_line_width
;
23319 if (slice
.y
+ slice
.height
== img
->height
)
23320 it
->descent
+= face
->box_line_width
;
23323 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23324 it
->pixel_width
+= eabs (face
->box_line_width
);
23325 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23326 it
->pixel_width
+= eabs (face
->box_line_width
);
23329 take_vertical_position_into_account (it
);
23331 /* Automatically crop wide image glyphs at right edge so we can
23332 draw the cursor on same display row. */
23333 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23334 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23336 it
->pixel_width
-= crop
;
23337 slice
.width
-= crop
;
23342 struct glyph
*glyph
;
23343 enum glyph_row_area area
= it
->area
;
23345 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23346 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23348 glyph
->charpos
= CHARPOS (it
->position
);
23349 glyph
->object
= it
->object
;
23350 glyph
->pixel_width
= it
->pixel_width
;
23351 glyph
->ascent
= glyph_ascent
;
23352 glyph
->descent
= it
->descent
;
23353 glyph
->voffset
= it
->voffset
;
23354 glyph
->type
= IMAGE_GLYPH
;
23355 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23356 glyph
->multibyte_p
= it
->multibyte_p
;
23357 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23358 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23359 glyph
->overlaps_vertically_p
= 0;
23360 glyph
->padding_p
= 0;
23361 glyph
->glyph_not_available_p
= 0;
23362 glyph
->face_id
= it
->face_id
;
23363 glyph
->u
.img_id
= img
->id
;
23364 glyph
->slice
.img
= slice
;
23365 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23368 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23369 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23371 glyph
->bidi_type
= it
->bidi_it
.type
;
23373 ++it
->glyph_row
->used
[area
];
23376 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23381 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23382 of the glyph, WIDTH and HEIGHT are the width and height of the
23383 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23386 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23387 int width
, int height
, int ascent
)
23389 struct glyph
*glyph
;
23390 enum glyph_row_area area
= it
->area
;
23392 xassert (ascent
>= 0 && ascent
<= height
);
23394 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23395 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23397 /* If the glyph row is reversed, we need to prepend the glyph
23398 rather than append it. */
23399 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23403 /* Make room for the additional glyph. */
23404 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23406 glyph
= it
->glyph_row
->glyphs
[area
];
23408 glyph
->charpos
= CHARPOS (it
->position
);
23409 glyph
->object
= object
;
23410 glyph
->pixel_width
= width
;
23411 glyph
->ascent
= ascent
;
23412 glyph
->descent
= height
- ascent
;
23413 glyph
->voffset
= it
->voffset
;
23414 glyph
->type
= STRETCH_GLYPH
;
23415 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23416 glyph
->multibyte_p
= it
->multibyte_p
;
23417 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23418 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23419 glyph
->overlaps_vertically_p
= 0;
23420 glyph
->padding_p
= 0;
23421 glyph
->glyph_not_available_p
= 0;
23422 glyph
->face_id
= it
->face_id
;
23423 glyph
->u
.stretch
.ascent
= ascent
;
23424 glyph
->u
.stretch
.height
= height
;
23425 glyph
->slice
.img
= null_glyph_slice
;
23426 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23429 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23430 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23432 glyph
->bidi_type
= it
->bidi_it
.type
;
23436 glyph
->resolved_level
= 0;
23437 glyph
->bidi_type
= UNKNOWN_BT
;
23439 ++it
->glyph_row
->used
[area
];
23442 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23445 #endif /* HAVE_WINDOW_SYSTEM */
23447 /* Produce a stretch glyph for iterator IT. IT->object is the value
23448 of the glyph property displayed. The value must be a list
23449 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23452 1. `:width WIDTH' specifies that the space should be WIDTH *
23453 canonical char width wide. WIDTH may be an integer or floating
23456 2. `:relative-width FACTOR' specifies that the width of the stretch
23457 should be computed from the width of the first character having the
23458 `glyph' property, and should be FACTOR times that width.
23460 3. `:align-to HPOS' specifies that the space should be wide enough
23461 to reach HPOS, a value in canonical character units.
23463 Exactly one of the above pairs must be present.
23465 4. `:height HEIGHT' specifies that the height of the stretch produced
23466 should be HEIGHT, measured in canonical character units.
23468 5. `:relative-height FACTOR' specifies that the height of the
23469 stretch should be FACTOR times the height of the characters having
23470 the glyph property.
23472 Either none or exactly one of 4 or 5 must be present.
23474 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23475 of the stretch should be used for the ascent of the stretch.
23476 ASCENT must be in the range 0 <= ASCENT <= 100. */
23479 produce_stretch_glyph (struct it
*it
)
23481 /* (space :width WIDTH :height HEIGHT ...) */
23482 Lisp_Object prop
, plist
;
23483 int width
= 0, height
= 0, align_to
= -1;
23484 int zero_width_ok_p
= 0;
23487 struct face
*face
= NULL
;
23488 struct font
*font
= NULL
;
23490 #ifdef HAVE_WINDOW_SYSTEM
23491 int zero_height_ok_p
= 0;
23493 if (FRAME_WINDOW_P (it
->f
))
23495 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23496 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23497 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23501 /* List should start with `space'. */
23502 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23503 plist
= XCDR (it
->object
);
23505 /* Compute the width of the stretch. */
23506 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23507 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23509 /* Absolute width `:width WIDTH' specified and valid. */
23510 zero_width_ok_p
= 1;
23513 #ifdef HAVE_WINDOW_SYSTEM
23514 else if (FRAME_WINDOW_P (it
->f
)
23515 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23517 /* Relative width `:relative-width FACTOR' specified and valid.
23518 Compute the width of the characters having the `glyph'
23521 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23524 if (it
->multibyte_p
)
23525 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23528 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23529 if (! ASCII_CHAR_P (it2
.c
))
23530 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23533 it2
.glyph_row
= NULL
;
23534 it2
.what
= IT_CHARACTER
;
23535 x_produce_glyphs (&it2
);
23536 width
= NUMVAL (prop
) * it2
.pixel_width
;
23538 #endif /* HAVE_WINDOW_SYSTEM */
23539 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23540 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23542 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23543 align_to
= (align_to
< 0
23545 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23546 else if (align_to
< 0)
23547 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23548 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23549 zero_width_ok_p
= 1;
23552 /* Nothing specified -> width defaults to canonical char width. */
23553 width
= FRAME_COLUMN_WIDTH (it
->f
);
23555 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23558 #ifdef HAVE_WINDOW_SYSTEM
23559 /* Compute height. */
23560 if (FRAME_WINDOW_P (it
->f
))
23562 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23563 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23566 zero_height_ok_p
= 1;
23568 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23570 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23572 height
= FONT_HEIGHT (font
);
23574 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23577 /* Compute percentage of height used for ascent. If
23578 `:ascent ASCENT' is present and valid, use that. Otherwise,
23579 derive the ascent from the font in use. */
23580 if (prop
= Fplist_get (plist
, QCascent
),
23581 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23582 ascent
= height
* NUMVAL (prop
) / 100.0;
23583 else if (!NILP (prop
)
23584 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23585 ascent
= min (max (0, (int)tem
), height
);
23587 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23590 #endif /* HAVE_WINDOW_SYSTEM */
23593 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23594 && it
->current_x
+ width
> it
->last_visible_x
)
23596 width
= it
->last_visible_x
- it
->current_x
;
23597 #ifdef HAVE_WINDOW_SYSTEM
23598 /* Subtact one more pixel from the stretch width, but only on
23599 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23600 width
-= FRAME_WINDOW_P (it
->f
);
23604 if (width
> 0 && height
> 0 && it
->glyph_row
)
23606 Lisp_Object o_object
= it
->object
;
23607 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23610 if (!STRINGP (object
))
23611 object
= it
->w
->buffer
;
23612 #ifdef HAVE_WINDOW_SYSTEM
23613 if (FRAME_WINDOW_P (it
->f
))
23614 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23618 it
->object
= object
;
23619 it
->char_to_display
= ' ';
23620 it
->pixel_width
= it
->len
= 1;
23622 tty_append_glyph (it
);
23623 it
->object
= o_object
;
23627 it
->pixel_width
= width
;
23628 #ifdef HAVE_WINDOW_SYSTEM
23629 if (FRAME_WINDOW_P (it
->f
))
23631 it
->ascent
= it
->phys_ascent
= ascent
;
23632 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23633 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23634 take_vertical_position_into_account (it
);
23638 it
->nglyphs
= width
;
23641 #ifdef HAVE_WINDOW_SYSTEM
23643 /* Calculate line-height and line-spacing properties.
23644 An integer value specifies explicit pixel value.
23645 A float value specifies relative value to current face height.
23646 A cons (float . face-name) specifies relative value to
23647 height of specified face font.
23649 Returns height in pixels, or nil. */
23653 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23654 int boff
, int override
)
23656 Lisp_Object face_name
= Qnil
;
23657 int ascent
, descent
, height
;
23659 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23664 face_name
= XCAR (val
);
23666 if (!NUMBERP (val
))
23667 val
= make_number (1);
23668 if (NILP (face_name
))
23670 height
= it
->ascent
+ it
->descent
;
23675 if (NILP (face_name
))
23677 font
= FRAME_FONT (it
->f
);
23678 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23680 else if (EQ (face_name
, Qt
))
23689 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23691 return make_number (-1);
23693 face
= FACE_FROM_ID (it
->f
, face_id
);
23696 return make_number (-1);
23697 boff
= font
->baseline_offset
;
23698 if (font
->vertical_centering
)
23699 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23702 ascent
= FONT_BASE (font
) + boff
;
23703 descent
= FONT_DESCENT (font
) - boff
;
23707 it
->override_ascent
= ascent
;
23708 it
->override_descent
= descent
;
23709 it
->override_boff
= boff
;
23712 height
= ascent
+ descent
;
23716 height
= (int)(XFLOAT_DATA (val
) * height
);
23717 else if (INTEGERP (val
))
23718 height
*= XINT (val
);
23720 return make_number (height
);
23724 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23725 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23726 and only if this is for a character for which no font was found.
23728 If the display method (it->glyphless_method) is
23729 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23730 length of the acronym or the hexadecimal string, UPPER_XOFF and
23731 UPPER_YOFF are pixel offsets for the upper part of the string,
23732 LOWER_XOFF and LOWER_YOFF are for the lower part.
23734 For the other display methods, LEN through LOWER_YOFF are zero. */
23737 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23738 short upper_xoff
, short upper_yoff
,
23739 short lower_xoff
, short lower_yoff
)
23741 struct glyph
*glyph
;
23742 enum glyph_row_area area
= it
->area
;
23744 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23745 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23747 /* If the glyph row is reversed, we need to prepend the glyph
23748 rather than append it. */
23749 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23753 /* Make room for the additional glyph. */
23754 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23756 glyph
= it
->glyph_row
->glyphs
[area
];
23758 glyph
->charpos
= CHARPOS (it
->position
);
23759 glyph
->object
= it
->object
;
23760 glyph
->pixel_width
= it
->pixel_width
;
23761 glyph
->ascent
= it
->ascent
;
23762 glyph
->descent
= it
->descent
;
23763 glyph
->voffset
= it
->voffset
;
23764 glyph
->type
= GLYPHLESS_GLYPH
;
23765 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23766 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23767 glyph
->u
.glyphless
.len
= len
;
23768 glyph
->u
.glyphless
.ch
= it
->c
;
23769 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23770 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23771 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23772 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23773 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23774 glyph
->multibyte_p
= it
->multibyte_p
;
23775 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23776 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23777 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23778 || it
->phys_descent
> it
->descent
);
23779 glyph
->padding_p
= 0;
23780 glyph
->glyph_not_available_p
= 0;
23781 glyph
->face_id
= face_id
;
23782 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23785 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23786 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23788 glyph
->bidi_type
= it
->bidi_it
.type
;
23790 ++it
->glyph_row
->used
[area
];
23793 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23797 /* Produce a glyph for a glyphless character for iterator IT.
23798 IT->glyphless_method specifies which method to use for displaying
23799 the character. See the description of enum
23800 glyphless_display_method in dispextern.h for the detail.
23802 FOR_NO_FONT is nonzero if and only if this is for a character for
23803 which no font was found. ACRONYM, if non-nil, is an acronym string
23804 for the character. */
23807 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23812 int base_width
, base_height
, width
, height
;
23813 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23816 /* Get the metrics of the base font. We always refer to the current
23818 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23819 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23820 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23821 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23822 base_height
= it
->ascent
+ it
->descent
;
23823 base_width
= font
->average_width
;
23825 /* Get a face ID for the glyph by utilizing a cache (the same way as
23826 done for `escape-glyph' in get_next_display_element). */
23827 if (it
->f
== last_glyphless_glyph_frame
23828 && it
->face_id
== last_glyphless_glyph_face_id
)
23830 face_id
= last_glyphless_glyph_merged_face_id
;
23834 /* Merge the `glyphless-char' face into the current face. */
23835 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23836 last_glyphless_glyph_frame
= it
->f
;
23837 last_glyphless_glyph_face_id
= it
->face_id
;
23838 last_glyphless_glyph_merged_face_id
= face_id
;
23841 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23843 it
->pixel_width
= THIN_SPACE_WIDTH
;
23845 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23847 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23849 width
= CHAR_WIDTH (it
->c
);
23852 else if (width
> 4)
23854 it
->pixel_width
= base_width
* width
;
23856 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23862 unsigned int code
[6];
23864 int ascent
, descent
;
23865 struct font_metrics metrics_upper
, metrics_lower
;
23867 face
= FACE_FROM_ID (it
->f
, face_id
);
23868 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23869 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23871 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23873 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23874 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23875 if (CONSP (acronym
))
23876 acronym
= XCAR (acronym
);
23877 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23881 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23882 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23885 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23886 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23887 upper_len
= (len
+ 1) / 2;
23888 font
->driver
->text_extents (font
, code
, upper_len
,
23890 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23895 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23896 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23897 upper_xoff
= upper_yoff
= 2; /* the typical case */
23898 if (base_width
>= width
)
23900 /* Align the upper to the left, the lower to the right. */
23901 it
->pixel_width
= base_width
;
23902 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23906 /* Center the shorter one. */
23907 it
->pixel_width
= width
;
23908 if (metrics_upper
.width
>= metrics_lower
.width
)
23909 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23912 /* FIXME: This code doesn't look right. It formerly was
23913 missing the "lower_xoff = 0;", which couldn't have
23914 been right since it left lower_xoff uninitialized. */
23916 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23920 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23921 top, bottom, and between upper and lower strings. */
23922 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23923 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23924 /* Center vertically.
23925 H:base_height, D:base_descent
23926 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23928 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23929 descent = D - H/2 + h/2;
23930 lower_yoff = descent - 2 - ld;
23931 upper_yoff = lower_yoff - la - 1 - ud; */
23932 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23933 descent
= it
->descent
- (base_height
- height
) / 2;
23934 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23935 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23936 - metrics_upper
.descent
);
23937 /* Don't make the height shorter than the base height. */
23938 if (height
> base_height
)
23940 it
->ascent
= ascent
;
23941 it
->descent
= descent
;
23945 it
->phys_ascent
= it
->ascent
;
23946 it
->phys_descent
= it
->descent
;
23948 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23949 upper_xoff
, upper_yoff
,
23950 lower_xoff
, lower_yoff
);
23952 take_vertical_position_into_account (it
);
23957 Produce glyphs/get display metrics for the display element IT is
23958 loaded with. See the description of struct it in dispextern.h
23959 for an overview of struct it. */
23962 x_produce_glyphs (struct it
*it
)
23964 int extra_line_spacing
= it
->extra_line_spacing
;
23966 it
->glyph_not_available_p
= 0;
23968 if (it
->what
== IT_CHARACTER
)
23971 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23972 struct font
*font
= face
->font
;
23973 struct font_metrics
*pcm
= NULL
;
23974 int boff
; /* baseline offset */
23978 /* When no suitable font is found, display this character by
23979 the method specified in the first extra slot of
23980 Vglyphless_char_display. */
23981 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23983 xassert (it
->what
== IT_GLYPHLESS
);
23984 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23988 boff
= font
->baseline_offset
;
23989 if (font
->vertical_centering
)
23990 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23992 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23998 if (it
->override_ascent
>= 0)
24000 it
->ascent
= it
->override_ascent
;
24001 it
->descent
= it
->override_descent
;
24002 boff
= it
->override_boff
;
24006 it
->ascent
= FONT_BASE (font
) + boff
;
24007 it
->descent
= FONT_DESCENT (font
) - boff
;
24010 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24012 pcm
= get_per_char_metric (font
, &char2b
);
24013 if (pcm
->width
== 0
24014 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24020 it
->phys_ascent
= pcm
->ascent
+ boff
;
24021 it
->phys_descent
= pcm
->descent
- boff
;
24022 it
->pixel_width
= pcm
->width
;
24026 it
->glyph_not_available_p
= 1;
24027 it
->phys_ascent
= it
->ascent
;
24028 it
->phys_descent
= it
->descent
;
24029 it
->pixel_width
= font
->space_width
;
24032 if (it
->constrain_row_ascent_descent_p
)
24034 if (it
->descent
> it
->max_descent
)
24036 it
->ascent
+= it
->descent
- it
->max_descent
;
24037 it
->descent
= it
->max_descent
;
24039 if (it
->ascent
> it
->max_ascent
)
24041 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24042 it
->ascent
= it
->max_ascent
;
24044 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24045 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24046 extra_line_spacing
= 0;
24049 /* If this is a space inside a region of text with
24050 `space-width' property, change its width. */
24051 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24053 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24055 /* If face has a box, add the box thickness to the character
24056 height. If character has a box line to the left and/or
24057 right, add the box line width to the character's width. */
24058 if (face
->box
!= FACE_NO_BOX
)
24060 int thick
= face
->box_line_width
;
24064 it
->ascent
+= thick
;
24065 it
->descent
+= thick
;
24070 if (it
->start_of_box_run_p
)
24071 it
->pixel_width
+= thick
;
24072 if (it
->end_of_box_run_p
)
24073 it
->pixel_width
+= thick
;
24076 /* If face has an overline, add the height of the overline
24077 (1 pixel) and a 1 pixel margin to the character height. */
24078 if (face
->overline_p
)
24079 it
->ascent
+= overline_margin
;
24081 if (it
->constrain_row_ascent_descent_p
)
24083 if (it
->ascent
> it
->max_ascent
)
24084 it
->ascent
= it
->max_ascent
;
24085 if (it
->descent
> it
->max_descent
)
24086 it
->descent
= it
->max_descent
;
24089 take_vertical_position_into_account (it
);
24091 /* If we have to actually produce glyphs, do it. */
24096 /* Translate a space with a `space-width' property
24097 into a stretch glyph. */
24098 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24099 / FONT_HEIGHT (font
));
24100 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24101 it
->ascent
+ it
->descent
, ascent
);
24106 /* If characters with lbearing or rbearing are displayed
24107 in this line, record that fact in a flag of the
24108 glyph row. This is used to optimize X output code. */
24109 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24110 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24112 if (! stretched_p
&& it
->pixel_width
== 0)
24113 /* We assure that all visible glyphs have at least 1-pixel
24115 it
->pixel_width
= 1;
24117 else if (it
->char_to_display
== '\n')
24119 /* A newline has no width, but we need the height of the
24120 line. But if previous part of the line sets a height,
24121 don't increase that height */
24123 Lisp_Object height
;
24124 Lisp_Object total_height
= Qnil
;
24126 it
->override_ascent
= -1;
24127 it
->pixel_width
= 0;
24130 height
= get_it_property (it
, Qline_height
);
24131 /* Split (line-height total-height) list */
24133 && CONSP (XCDR (height
))
24134 && NILP (XCDR (XCDR (height
))))
24136 total_height
= XCAR (XCDR (height
));
24137 height
= XCAR (height
);
24139 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24141 if (it
->override_ascent
>= 0)
24143 it
->ascent
= it
->override_ascent
;
24144 it
->descent
= it
->override_descent
;
24145 boff
= it
->override_boff
;
24149 it
->ascent
= FONT_BASE (font
) + boff
;
24150 it
->descent
= FONT_DESCENT (font
) - boff
;
24153 if (EQ (height
, Qt
))
24155 if (it
->descent
> it
->max_descent
)
24157 it
->ascent
+= it
->descent
- it
->max_descent
;
24158 it
->descent
= it
->max_descent
;
24160 if (it
->ascent
> it
->max_ascent
)
24162 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24163 it
->ascent
= it
->max_ascent
;
24165 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24166 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24167 it
->constrain_row_ascent_descent_p
= 1;
24168 extra_line_spacing
= 0;
24172 Lisp_Object spacing
;
24174 it
->phys_ascent
= it
->ascent
;
24175 it
->phys_descent
= it
->descent
;
24177 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24178 && face
->box
!= FACE_NO_BOX
24179 && face
->box_line_width
> 0)
24181 it
->ascent
+= face
->box_line_width
;
24182 it
->descent
+= face
->box_line_width
;
24185 && XINT (height
) > it
->ascent
+ it
->descent
)
24186 it
->ascent
= XINT (height
) - it
->descent
;
24188 if (!NILP (total_height
))
24189 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24192 spacing
= get_it_property (it
, Qline_spacing
);
24193 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24195 if (INTEGERP (spacing
))
24197 extra_line_spacing
= XINT (spacing
);
24198 if (!NILP (total_height
))
24199 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24203 else /* i.e. (it->char_to_display == '\t') */
24205 if (font
->space_width
> 0)
24207 int tab_width
= it
->tab_width
* font
->space_width
;
24208 int x
= it
->current_x
+ it
->continuation_lines_width
;
24209 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24211 /* If the distance from the current position to the next tab
24212 stop is less than a space character width, use the
24213 tab stop after that. */
24214 if (next_tab_x
- x
< font
->space_width
)
24215 next_tab_x
+= tab_width
;
24217 it
->pixel_width
= next_tab_x
- x
;
24219 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24220 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24224 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24225 it
->ascent
+ it
->descent
, it
->ascent
);
24230 it
->pixel_width
= 0;
24235 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24237 /* A static composition.
24239 Note: A composition is represented as one glyph in the
24240 glyph matrix. There are no padding glyphs.
24242 Important note: pixel_width, ascent, and descent are the
24243 values of what is drawn by draw_glyphs (i.e. the values of
24244 the overall glyphs composed). */
24245 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24246 int boff
; /* baseline offset */
24247 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24248 int glyph_len
= cmp
->glyph_len
;
24249 struct font
*font
= face
->font
;
24253 /* If we have not yet calculated pixel size data of glyphs of
24254 the composition for the current face font, calculate them
24255 now. Theoretically, we have to check all fonts for the
24256 glyphs, but that requires much time and memory space. So,
24257 here we check only the font of the first glyph. This may
24258 lead to incorrect display, but it's very rare, and C-l
24259 (recenter-top-bottom) can correct the display anyway. */
24260 if (! cmp
->font
|| cmp
->font
!= font
)
24262 /* Ascent and descent of the font of the first character
24263 of this composition (adjusted by baseline offset).
24264 Ascent and descent of overall glyphs should not be less
24265 than these, respectively. */
24266 int font_ascent
, font_descent
, font_height
;
24267 /* Bounding box of the overall glyphs. */
24268 int leftmost
, rightmost
, lowest
, highest
;
24269 int lbearing
, rbearing
;
24270 int i
, width
, ascent
, descent
;
24271 int left_padded
= 0, right_padded
= 0;
24272 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24274 struct font_metrics
*pcm
;
24275 int font_not_found_p
;
24278 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24279 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24281 if (glyph_len
< cmp
->glyph_len
)
24283 for (i
= 0; i
< glyph_len
; i
++)
24285 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24287 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24292 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24293 : IT_CHARPOS (*it
));
24294 /* If no suitable font is found, use the default font. */
24295 font_not_found_p
= font
== NULL
;
24296 if (font_not_found_p
)
24298 face
= face
->ascii_face
;
24301 boff
= font
->baseline_offset
;
24302 if (font
->vertical_centering
)
24303 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24304 font_ascent
= FONT_BASE (font
) + boff
;
24305 font_descent
= FONT_DESCENT (font
) - boff
;
24306 font_height
= FONT_HEIGHT (font
);
24308 cmp
->font
= (void *) font
;
24311 if (! font_not_found_p
)
24313 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24315 pcm
= get_per_char_metric (font
, &char2b
);
24318 /* Initialize the bounding box. */
24321 width
= pcm
->width
;
24322 ascent
= pcm
->ascent
;
24323 descent
= pcm
->descent
;
24324 lbearing
= pcm
->lbearing
;
24325 rbearing
= pcm
->rbearing
;
24329 width
= font
->space_width
;
24330 ascent
= FONT_BASE (font
);
24331 descent
= FONT_DESCENT (font
);
24338 lowest
= - descent
+ boff
;
24339 highest
= ascent
+ boff
;
24341 if (! font_not_found_p
24342 && font
->default_ascent
24343 && CHAR_TABLE_P (Vuse_default_ascent
)
24344 && !NILP (Faref (Vuse_default_ascent
,
24345 make_number (it
->char_to_display
))))
24346 highest
= font
->default_ascent
+ boff
;
24348 /* Draw the first glyph at the normal position. It may be
24349 shifted to right later if some other glyphs are drawn
24351 cmp
->offsets
[i
* 2] = 0;
24352 cmp
->offsets
[i
* 2 + 1] = boff
;
24353 cmp
->lbearing
= lbearing
;
24354 cmp
->rbearing
= rbearing
;
24356 /* Set cmp->offsets for the remaining glyphs. */
24357 for (i
++; i
< glyph_len
; i
++)
24359 int left
, right
, btm
, top
;
24360 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24362 struct face
*this_face
;
24366 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24367 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24368 font
= this_face
->font
;
24374 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24376 pcm
= get_per_char_metric (font
, &char2b
);
24379 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24382 width
= pcm
->width
;
24383 ascent
= pcm
->ascent
;
24384 descent
= pcm
->descent
;
24385 lbearing
= pcm
->lbearing
;
24386 rbearing
= pcm
->rbearing
;
24387 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24389 /* Relative composition with or without
24390 alternate chars. */
24391 left
= (leftmost
+ rightmost
- width
) / 2;
24392 btm
= - descent
+ boff
;
24393 if (font
->relative_compose
24394 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24395 || NILP (Faref (Vignore_relative_composition
,
24396 make_number (ch
)))))
24399 if (- descent
>= font
->relative_compose
)
24400 /* One extra pixel between two glyphs. */
24402 else if (ascent
<= 0)
24403 /* One extra pixel between two glyphs. */
24404 btm
= lowest
- 1 - ascent
- descent
;
24409 /* A composition rule is specified by an integer
24410 value that encodes global and new reference
24411 points (GREF and NREF). GREF and NREF are
24412 specified by numbers as below:
24414 0---1---2 -- ascent
24418 9--10--11 -- center
24420 ---3---4---5--- baseline
24422 6---7---8 -- descent
24424 int rule
= COMPOSITION_RULE (cmp
, i
);
24425 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24427 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24428 grefx
= gref
% 3, nrefx
= nref
% 3;
24429 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24431 xoff
= font_height
* (xoff
- 128) / 256;
24433 yoff
= font_height
* (yoff
- 128) / 256;
24436 + grefx
* (rightmost
- leftmost
) / 2
24437 - nrefx
* width
/ 2
24440 btm
= ((grefy
== 0 ? highest
24442 : grefy
== 2 ? lowest
24443 : (highest
+ lowest
) / 2)
24444 - (nrefy
== 0 ? ascent
+ descent
24445 : nrefy
== 1 ? descent
- boff
24447 : (ascent
+ descent
) / 2)
24451 cmp
->offsets
[i
* 2] = left
;
24452 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24454 /* Update the bounding box of the overall glyphs. */
24457 right
= left
+ width
;
24458 if (left
< leftmost
)
24460 if (right
> rightmost
)
24463 top
= btm
+ descent
+ ascent
;
24469 if (cmp
->lbearing
> left
+ lbearing
)
24470 cmp
->lbearing
= left
+ lbearing
;
24471 if (cmp
->rbearing
< left
+ rbearing
)
24472 cmp
->rbearing
= left
+ rbearing
;
24476 /* If there are glyphs whose x-offsets are negative,
24477 shift all glyphs to the right and make all x-offsets
24481 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24482 cmp
->offsets
[i
* 2] -= leftmost
;
24483 rightmost
-= leftmost
;
24484 cmp
->lbearing
-= leftmost
;
24485 cmp
->rbearing
-= leftmost
;
24488 if (left_padded
&& cmp
->lbearing
< 0)
24490 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24491 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24492 rightmost
-= cmp
->lbearing
;
24493 cmp
->rbearing
-= cmp
->lbearing
;
24496 if (right_padded
&& rightmost
< cmp
->rbearing
)
24498 rightmost
= cmp
->rbearing
;
24501 cmp
->pixel_width
= rightmost
;
24502 cmp
->ascent
= highest
;
24503 cmp
->descent
= - lowest
;
24504 if (cmp
->ascent
< font_ascent
)
24505 cmp
->ascent
= font_ascent
;
24506 if (cmp
->descent
< font_descent
)
24507 cmp
->descent
= font_descent
;
24511 && (cmp
->lbearing
< 0
24512 || cmp
->rbearing
> cmp
->pixel_width
))
24513 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24515 it
->pixel_width
= cmp
->pixel_width
;
24516 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24517 it
->descent
= it
->phys_descent
= cmp
->descent
;
24518 if (face
->box
!= FACE_NO_BOX
)
24520 int thick
= face
->box_line_width
;
24524 it
->ascent
+= thick
;
24525 it
->descent
+= thick
;
24530 if (it
->start_of_box_run_p
)
24531 it
->pixel_width
+= thick
;
24532 if (it
->end_of_box_run_p
)
24533 it
->pixel_width
+= thick
;
24536 /* If face has an overline, add the height of the overline
24537 (1 pixel) and a 1 pixel margin to the character height. */
24538 if (face
->overline_p
)
24539 it
->ascent
+= overline_margin
;
24541 take_vertical_position_into_account (it
);
24542 if (it
->ascent
< 0)
24544 if (it
->descent
< 0)
24548 append_composite_glyph (it
);
24550 else if (it
->what
== IT_COMPOSITION
)
24552 /* A dynamic (automatic) composition. */
24553 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24554 Lisp_Object gstring
;
24555 struct font_metrics metrics
;
24559 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24561 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24564 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24565 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24566 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24567 it
->descent
= it
->phys_descent
= metrics
.descent
;
24568 if (face
->box
!= FACE_NO_BOX
)
24570 int thick
= face
->box_line_width
;
24574 it
->ascent
+= thick
;
24575 it
->descent
+= thick
;
24580 if (it
->start_of_box_run_p
)
24581 it
->pixel_width
+= thick
;
24582 if (it
->end_of_box_run_p
)
24583 it
->pixel_width
+= thick
;
24585 /* If face has an overline, add the height of the overline
24586 (1 pixel) and a 1 pixel margin to the character height. */
24587 if (face
->overline_p
)
24588 it
->ascent
+= overline_margin
;
24589 take_vertical_position_into_account (it
);
24590 if (it
->ascent
< 0)
24592 if (it
->descent
< 0)
24596 append_composite_glyph (it
);
24598 else if (it
->what
== IT_GLYPHLESS
)
24599 produce_glyphless_glyph (it
, 0, Qnil
);
24600 else if (it
->what
== IT_IMAGE
)
24601 produce_image_glyph (it
);
24602 else if (it
->what
== IT_STRETCH
)
24603 produce_stretch_glyph (it
);
24606 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24607 because this isn't true for images with `:ascent 100'. */
24608 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24609 if (it
->area
== TEXT_AREA
)
24610 it
->current_x
+= it
->pixel_width
;
24612 if (extra_line_spacing
> 0)
24614 it
->descent
+= extra_line_spacing
;
24615 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24616 it
->max_extra_line_spacing
= extra_line_spacing
;
24619 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24620 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24621 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24622 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24626 Output LEN glyphs starting at START at the nominal cursor position.
24627 Advance the nominal cursor over the text. The global variable
24628 updated_window contains the window being updated, updated_row is
24629 the glyph row being updated, and updated_area is the area of that
24630 row being updated. */
24633 x_write_glyphs (struct glyph
*start
, int len
)
24637 xassert (updated_window
&& updated_row
);
24640 /* Write glyphs. */
24642 hpos
= start
- updated_row
->glyphs
[updated_area
];
24643 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24644 updated_row
, updated_area
,
24646 DRAW_NORMAL_TEXT
, 0);
24648 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24649 if (updated_area
== TEXT_AREA
24650 && updated_window
->phys_cursor_on_p
24651 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24652 && updated_window
->phys_cursor
.hpos
>= hpos
24653 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24654 updated_window
->phys_cursor_on_p
= 0;
24658 /* Advance the output cursor. */
24659 output_cursor
.hpos
+= len
;
24660 output_cursor
.x
= x
;
24665 Insert LEN glyphs from START at the nominal cursor position. */
24668 x_insert_glyphs (struct glyph
*start
, int len
)
24672 int line_height
, shift_by_width
, shifted_region_width
;
24673 struct glyph_row
*row
;
24674 struct glyph
*glyph
;
24675 int frame_x
, frame_y
;
24678 xassert (updated_window
&& updated_row
);
24680 w
= updated_window
;
24681 f
= XFRAME (WINDOW_FRAME (w
));
24683 /* Get the height of the line we are in. */
24685 line_height
= row
->height
;
24687 /* Get the width of the glyphs to insert. */
24688 shift_by_width
= 0;
24689 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24690 shift_by_width
+= glyph
->pixel_width
;
24692 /* Get the width of the region to shift right. */
24693 shifted_region_width
= (window_box_width (w
, updated_area
)
24698 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24699 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24701 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24702 line_height
, shift_by_width
);
24704 /* Write the glyphs. */
24705 hpos
= start
- row
->glyphs
[updated_area
];
24706 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24708 DRAW_NORMAL_TEXT
, 0);
24710 /* Advance the output cursor. */
24711 output_cursor
.hpos
+= len
;
24712 output_cursor
.x
+= shift_by_width
;
24718 Erase the current text line from the nominal cursor position
24719 (inclusive) to pixel column TO_X (exclusive). The idea is that
24720 everything from TO_X onward is already erased.
24722 TO_X is a pixel position relative to updated_area of
24723 updated_window. TO_X == -1 means clear to the end of this area. */
24726 x_clear_end_of_line (int to_x
)
24729 struct window
*w
= updated_window
;
24730 int max_x
, min_y
, max_y
;
24731 int from_x
, from_y
, to_y
;
24733 xassert (updated_window
&& updated_row
);
24734 f
= XFRAME (w
->frame
);
24736 if (updated_row
->full_width_p
)
24737 max_x
= WINDOW_TOTAL_WIDTH (w
);
24739 max_x
= window_box_width (w
, updated_area
);
24740 max_y
= window_text_bottom_y (w
);
24742 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24743 of window. For TO_X > 0, truncate to end of drawing area. */
24749 to_x
= min (to_x
, max_x
);
24751 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24753 /* Notice if the cursor will be cleared by this operation. */
24754 if (!updated_row
->full_width_p
)
24755 notice_overwritten_cursor (w
, updated_area
,
24756 output_cursor
.x
, -1,
24758 MATRIX_ROW_BOTTOM_Y (updated_row
));
24760 from_x
= output_cursor
.x
;
24762 /* Translate to frame coordinates. */
24763 if (updated_row
->full_width_p
)
24765 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24766 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24770 int area_left
= window_box_left (w
, updated_area
);
24771 from_x
+= area_left
;
24775 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24776 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24777 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24779 /* Prevent inadvertently clearing to end of the X window. */
24780 if (to_x
> from_x
&& to_y
> from_y
)
24783 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24784 to_x
- from_x
, to_y
- from_y
);
24789 #endif /* HAVE_WINDOW_SYSTEM */
24793 /***********************************************************************
24795 ***********************************************************************/
24797 /* Value is the internal representation of the specified cursor type
24798 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24799 of the bar cursor. */
24801 static enum text_cursor_kinds
24802 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24804 enum text_cursor_kinds type
;
24809 if (EQ (arg
, Qbox
))
24810 return FILLED_BOX_CURSOR
;
24812 if (EQ (arg
, Qhollow
))
24813 return HOLLOW_BOX_CURSOR
;
24815 if (EQ (arg
, Qbar
))
24822 && EQ (XCAR (arg
), Qbar
)
24823 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
24825 *width
= XINT (XCDR (arg
));
24829 if (EQ (arg
, Qhbar
))
24832 return HBAR_CURSOR
;
24836 && EQ (XCAR (arg
), Qhbar
)
24837 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
24839 *width
= XINT (XCDR (arg
));
24840 return HBAR_CURSOR
;
24843 /* Treat anything unknown as "hollow box cursor".
24844 It was bad to signal an error; people have trouble fixing
24845 .Xdefaults with Emacs, when it has something bad in it. */
24846 type
= HOLLOW_BOX_CURSOR
;
24851 /* Set the default cursor types for specified frame. */
24853 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24858 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24859 FRAME_CURSOR_WIDTH (f
) = width
;
24861 /* By default, set up the blink-off state depending on the on-state. */
24863 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24866 FRAME_BLINK_OFF_CURSOR (f
)
24867 = get_specified_cursor_type (XCDR (tem
), &width
);
24868 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24871 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24875 #ifdef HAVE_WINDOW_SYSTEM
24877 /* Return the cursor we want to be displayed in window W. Return
24878 width of bar/hbar cursor through WIDTH arg. Return with
24879 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24880 (i.e. if the `system caret' should track this cursor).
24882 In a mini-buffer window, we want the cursor only to appear if we
24883 are reading input from this window. For the selected window, we
24884 want the cursor type given by the frame parameter or buffer local
24885 setting of cursor-type. If explicitly marked off, draw no cursor.
24886 In all other cases, we want a hollow box cursor. */
24888 static enum text_cursor_kinds
24889 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24890 int *active_cursor
)
24892 struct frame
*f
= XFRAME (w
->frame
);
24893 struct buffer
*b
= XBUFFER (w
->buffer
);
24894 int cursor_type
= DEFAULT_CURSOR
;
24895 Lisp_Object alt_cursor
;
24896 int non_selected
= 0;
24898 *active_cursor
= 1;
24901 if (cursor_in_echo_area
24902 && FRAME_HAS_MINIBUF_P (f
)
24903 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24905 if (w
== XWINDOW (echo_area_window
))
24907 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24909 *width
= FRAME_CURSOR_WIDTH (f
);
24910 return FRAME_DESIRED_CURSOR (f
);
24913 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24916 *active_cursor
= 0;
24920 /* Detect a nonselected window or nonselected frame. */
24921 else if (w
!= XWINDOW (f
->selected_window
)
24922 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24924 *active_cursor
= 0;
24926 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24932 /* Never display a cursor in a window in which cursor-type is nil. */
24933 if (NILP (BVAR (b
, cursor_type
)))
24936 /* Get the normal cursor type for this window. */
24937 if (EQ (BVAR (b
, cursor_type
), Qt
))
24939 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24940 *width
= FRAME_CURSOR_WIDTH (f
);
24943 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24945 /* Use cursor-in-non-selected-windows instead
24946 for non-selected window or frame. */
24949 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24950 if (!EQ (Qt
, alt_cursor
))
24951 return get_specified_cursor_type (alt_cursor
, width
);
24952 /* t means modify the normal cursor type. */
24953 if (cursor_type
== FILLED_BOX_CURSOR
)
24954 cursor_type
= HOLLOW_BOX_CURSOR
;
24955 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24957 return cursor_type
;
24960 /* Use normal cursor if not blinked off. */
24961 if (!w
->cursor_off_p
)
24963 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24965 if (cursor_type
== FILLED_BOX_CURSOR
)
24967 /* Using a block cursor on large images can be very annoying.
24968 So use a hollow cursor for "large" images.
24969 If image is not transparent (no mask), also use hollow cursor. */
24970 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24971 if (img
!= NULL
&& IMAGEP (img
->spec
))
24973 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24974 where N = size of default frame font size.
24975 This should cover most of the "tiny" icons people may use. */
24977 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24978 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24979 cursor_type
= HOLLOW_BOX_CURSOR
;
24982 else if (cursor_type
!= NO_CURSOR
)
24984 /* Display current only supports BOX and HOLLOW cursors for images.
24985 So for now, unconditionally use a HOLLOW cursor when cursor is
24986 not a solid box cursor. */
24987 cursor_type
= HOLLOW_BOX_CURSOR
;
24990 return cursor_type
;
24993 /* Cursor is blinked off, so determine how to "toggle" it. */
24995 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24996 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24997 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24999 /* Then see if frame has specified a specific blink off cursor type. */
25000 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25002 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25003 return FRAME_BLINK_OFF_CURSOR (f
);
25007 /* Some people liked having a permanently visible blinking cursor,
25008 while others had very strong opinions against it. So it was
25009 decided to remove it. KFS 2003-09-03 */
25011 /* Finally perform built-in cursor blinking:
25012 filled box <-> hollow box
25013 wide [h]bar <-> narrow [h]bar
25014 narrow [h]bar <-> no cursor
25015 other type <-> no cursor */
25017 if (cursor_type
== FILLED_BOX_CURSOR
)
25018 return HOLLOW_BOX_CURSOR
;
25020 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25023 return cursor_type
;
25031 /* Notice when the text cursor of window W has been completely
25032 overwritten by a drawing operation that outputs glyphs in AREA
25033 starting at X0 and ending at X1 in the line starting at Y0 and
25034 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25035 the rest of the line after X0 has been written. Y coordinates
25036 are window-relative. */
25039 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25040 int x0
, int x1
, int y0
, int y1
)
25042 int cx0
, cx1
, cy0
, cy1
;
25043 struct glyph_row
*row
;
25045 if (!w
->phys_cursor_on_p
)
25047 if (area
!= TEXT_AREA
)
25050 if (w
->phys_cursor
.vpos
< 0
25051 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25052 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25053 !(row
->enabled_p
&& row
->displays_text_p
)))
25056 if (row
->cursor_in_fringe_p
)
25058 row
->cursor_in_fringe_p
= 0;
25059 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25060 w
->phys_cursor_on_p
= 0;
25064 cx0
= w
->phys_cursor
.x
;
25065 cx1
= cx0
+ w
->phys_cursor_width
;
25066 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25069 /* The cursor image will be completely removed from the
25070 screen if the output area intersects the cursor area in
25071 y-direction. When we draw in [y0 y1[, and some part of
25072 the cursor is at y < y0, that part must have been drawn
25073 before. When scrolling, the cursor is erased before
25074 actually scrolling, so we don't come here. When not
25075 scrolling, the rows above the old cursor row must have
25076 changed, and in this case these rows must have written
25077 over the cursor image.
25079 Likewise if part of the cursor is below y1, with the
25080 exception of the cursor being in the first blank row at
25081 the buffer and window end because update_text_area
25082 doesn't draw that row. (Except when it does, but
25083 that's handled in update_text_area.) */
25085 cy0
= w
->phys_cursor
.y
;
25086 cy1
= cy0
+ w
->phys_cursor_height
;
25087 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25090 w
->phys_cursor_on_p
= 0;
25093 #endif /* HAVE_WINDOW_SYSTEM */
25096 /************************************************************************
25098 ************************************************************************/
25100 #ifdef HAVE_WINDOW_SYSTEM
25103 Fix the display of area AREA of overlapping row ROW in window W
25104 with respect to the overlapping part OVERLAPS. */
25107 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25108 enum glyph_row_area area
, int overlaps
)
25115 for (i
= 0; i
< row
->used
[area
];)
25117 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25119 int start
= i
, start_x
= x
;
25123 x
+= row
->glyphs
[area
][i
].pixel_width
;
25126 while (i
< row
->used
[area
]
25127 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25129 draw_glyphs (w
, start_x
, row
, area
,
25131 DRAW_NORMAL_TEXT
, overlaps
);
25135 x
+= row
->glyphs
[area
][i
].pixel_width
;
25145 Draw the cursor glyph of window W in glyph row ROW. See the
25146 comment of draw_glyphs for the meaning of HL. */
25149 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25150 enum draw_glyphs_face hl
)
25152 /* If cursor hpos is out of bounds, don't draw garbage. This can
25153 happen in mini-buffer windows when switching between echo area
25154 glyphs and mini-buffer. */
25155 if ((row
->reversed_p
25156 ? (w
->phys_cursor
.hpos
>= 0)
25157 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25159 int on_p
= w
->phys_cursor_on_p
;
25161 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
25162 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
25164 w
->phys_cursor_on_p
= on_p
;
25166 if (hl
== DRAW_CURSOR
)
25167 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25168 /* When we erase the cursor, and ROW is overlapped by other
25169 rows, make sure that these overlapping parts of other rows
25171 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25173 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25175 if (row
> w
->current_matrix
->rows
25176 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25177 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25178 OVERLAPS_ERASED_CURSOR
);
25180 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25181 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25182 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25183 OVERLAPS_ERASED_CURSOR
);
25190 Erase the image of a cursor of window W from the screen. */
25193 erase_phys_cursor (struct window
*w
)
25195 struct frame
*f
= XFRAME (w
->frame
);
25196 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25197 int hpos
= w
->phys_cursor
.hpos
;
25198 int vpos
= w
->phys_cursor
.vpos
;
25199 int mouse_face_here_p
= 0;
25200 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25201 struct glyph_row
*cursor_row
;
25202 struct glyph
*cursor_glyph
;
25203 enum draw_glyphs_face hl
;
25205 /* No cursor displayed or row invalidated => nothing to do on the
25207 if (w
->phys_cursor_type
== NO_CURSOR
)
25208 goto mark_cursor_off
;
25210 /* VPOS >= active_glyphs->nrows means that window has been resized.
25211 Don't bother to erase the cursor. */
25212 if (vpos
>= active_glyphs
->nrows
)
25213 goto mark_cursor_off
;
25215 /* If row containing cursor is marked invalid, there is nothing we
25217 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25218 if (!cursor_row
->enabled_p
)
25219 goto mark_cursor_off
;
25221 /* If line spacing is > 0, old cursor may only be partially visible in
25222 window after split-window. So adjust visible height. */
25223 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25224 window_text_bottom_y (w
) - cursor_row
->y
);
25226 /* If row is completely invisible, don't attempt to delete a cursor which
25227 isn't there. This can happen if cursor is at top of a window, and
25228 we switch to a buffer with a header line in that window. */
25229 if (cursor_row
->visible_height
<= 0)
25230 goto mark_cursor_off
;
25232 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25233 if (cursor_row
->cursor_in_fringe_p
)
25235 cursor_row
->cursor_in_fringe_p
= 0;
25236 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25237 goto mark_cursor_off
;
25240 /* This can happen when the new row is shorter than the old one.
25241 In this case, either draw_glyphs or clear_end_of_line
25242 should have cleared the cursor. Note that we wouldn't be
25243 able to erase the cursor in this case because we don't have a
25244 cursor glyph at hand. */
25245 if ((cursor_row
->reversed_p
25246 ? (w
->phys_cursor
.hpos
< 0)
25247 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25248 goto mark_cursor_off
;
25250 /* If the cursor is in the mouse face area, redisplay that when
25251 we clear the cursor. */
25252 if (! NILP (hlinfo
->mouse_face_window
)
25253 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25254 /* Don't redraw the cursor's spot in mouse face if it is at the
25255 end of a line (on a newline). The cursor appears there, but
25256 mouse highlighting does not. */
25257 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25258 mouse_face_here_p
= 1;
25260 /* Maybe clear the display under the cursor. */
25261 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25264 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25267 cursor_glyph
= get_phys_cursor_glyph (w
);
25268 if (cursor_glyph
== NULL
)
25269 goto mark_cursor_off
;
25271 width
= cursor_glyph
->pixel_width
;
25272 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25273 x
= w
->phys_cursor
.x
;
25275 width
-= left_x
- x
;
25276 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25277 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25278 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25281 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25284 /* Erase the cursor by redrawing the character underneath it. */
25285 if (mouse_face_here_p
)
25286 hl
= DRAW_MOUSE_FACE
;
25288 hl
= DRAW_NORMAL_TEXT
;
25289 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25292 w
->phys_cursor_on_p
= 0;
25293 w
->phys_cursor_type
= NO_CURSOR
;
25298 Display or clear cursor of window W. If ON is zero, clear the
25299 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25300 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25303 display_and_set_cursor (struct window
*w
, int on
,
25304 int hpos
, int vpos
, int x
, int y
)
25306 struct frame
*f
= XFRAME (w
->frame
);
25307 int new_cursor_type
;
25308 int new_cursor_width
;
25310 struct glyph_row
*glyph_row
;
25311 struct glyph
*glyph
;
25313 /* This is pointless on invisible frames, and dangerous on garbaged
25314 windows and frames; in the latter case, the frame or window may
25315 be in the midst of changing its size, and x and y may be off the
25317 if (! FRAME_VISIBLE_P (f
)
25318 || FRAME_GARBAGED_P (f
)
25319 || vpos
>= w
->current_matrix
->nrows
25320 || hpos
>= w
->current_matrix
->matrix_w
)
25323 /* If cursor is off and we want it off, return quickly. */
25324 if (!on
&& !w
->phys_cursor_on_p
)
25327 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25328 /* If cursor row is not enabled, we don't really know where to
25329 display the cursor. */
25330 if (!glyph_row
->enabled_p
)
25332 w
->phys_cursor_on_p
= 0;
25337 if (!glyph_row
->exact_window_width_line_p
25338 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25339 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25341 xassert (interrupt_input_blocked
);
25343 /* Set new_cursor_type to the cursor we want to be displayed. */
25344 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25345 &new_cursor_width
, &active_cursor
);
25347 /* If cursor is currently being shown and we don't want it to be or
25348 it is in the wrong place, or the cursor type is not what we want,
25350 if (w
->phys_cursor_on_p
25352 || w
->phys_cursor
.x
!= x
25353 || w
->phys_cursor
.y
!= y
25354 || new_cursor_type
!= w
->phys_cursor_type
25355 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25356 && new_cursor_width
!= w
->phys_cursor_width
)))
25357 erase_phys_cursor (w
);
25359 /* Don't check phys_cursor_on_p here because that flag is only set
25360 to zero in some cases where we know that the cursor has been
25361 completely erased, to avoid the extra work of erasing the cursor
25362 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25363 still not be visible, or it has only been partly erased. */
25366 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25367 w
->phys_cursor_height
= glyph_row
->height
;
25369 /* Set phys_cursor_.* before x_draw_.* is called because some
25370 of them may need the information. */
25371 w
->phys_cursor
.x
= x
;
25372 w
->phys_cursor
.y
= glyph_row
->y
;
25373 w
->phys_cursor
.hpos
= hpos
;
25374 w
->phys_cursor
.vpos
= vpos
;
25377 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25378 new_cursor_type
, new_cursor_width
,
25379 on
, active_cursor
);
25383 /* Switch the display of W's cursor on or off, according to the value
25387 update_window_cursor (struct window
*w
, int on
)
25389 /* Don't update cursor in windows whose frame is in the process
25390 of being deleted. */
25391 if (w
->current_matrix
)
25394 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25395 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25401 /* Call update_window_cursor with parameter ON_P on all leaf windows
25402 in the window tree rooted at W. */
25405 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25409 if (!NILP (w
->hchild
))
25410 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25411 else if (!NILP (w
->vchild
))
25412 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25414 update_window_cursor (w
, on_p
);
25416 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25422 Display the cursor on window W, or clear it, according to ON_P.
25423 Don't change the cursor's position. */
25426 x_update_cursor (struct frame
*f
, int on_p
)
25428 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25433 Clear the cursor of window W to background color, and mark the
25434 cursor as not shown. This is used when the text where the cursor
25435 is about to be rewritten. */
25438 x_clear_cursor (struct window
*w
)
25440 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25441 update_window_cursor (w
, 0);
25444 #endif /* HAVE_WINDOW_SYSTEM */
25446 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25449 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25450 int start_hpos
, int end_hpos
,
25451 enum draw_glyphs_face draw
)
25453 #ifdef HAVE_WINDOW_SYSTEM
25454 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25456 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25460 #if defined (HAVE_GPM) || defined (MSDOS)
25461 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25465 /* Display the active region described by mouse_face_* according to DRAW. */
25468 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25470 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25471 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25473 if (/* If window is in the process of being destroyed, don't bother
25475 w
->current_matrix
!= NULL
25476 /* Don't update mouse highlight if hidden */
25477 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25478 /* Recognize when we are called to operate on rows that don't exist
25479 anymore. This can happen when a window is split. */
25480 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25482 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25483 struct glyph_row
*row
, *first
, *last
;
25485 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25486 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25488 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25490 int start_hpos
, end_hpos
, start_x
;
25492 /* For all but the first row, the highlight starts at column 0. */
25495 /* R2L rows have BEG and END in reversed order, but the
25496 screen drawing geometry is always left to right. So
25497 we need to mirror the beginning and end of the
25498 highlighted area in R2L rows. */
25499 if (!row
->reversed_p
)
25501 start_hpos
= hlinfo
->mouse_face_beg_col
;
25502 start_x
= hlinfo
->mouse_face_beg_x
;
25504 else if (row
== last
)
25506 start_hpos
= hlinfo
->mouse_face_end_col
;
25507 start_x
= hlinfo
->mouse_face_end_x
;
25515 else if (row
->reversed_p
&& row
== last
)
25517 start_hpos
= hlinfo
->mouse_face_end_col
;
25518 start_x
= hlinfo
->mouse_face_end_x
;
25528 if (!row
->reversed_p
)
25529 end_hpos
= hlinfo
->mouse_face_end_col
;
25530 else if (row
== first
)
25531 end_hpos
= hlinfo
->mouse_face_beg_col
;
25534 end_hpos
= row
->used
[TEXT_AREA
];
25535 if (draw
== DRAW_NORMAL_TEXT
)
25536 row
->fill_line_p
= 1; /* Clear to end of line */
25539 else if (row
->reversed_p
&& row
== first
)
25540 end_hpos
= hlinfo
->mouse_face_beg_col
;
25543 end_hpos
= row
->used
[TEXT_AREA
];
25544 if (draw
== DRAW_NORMAL_TEXT
)
25545 row
->fill_line_p
= 1; /* Clear to end of line */
25548 if (end_hpos
> start_hpos
)
25550 draw_row_with_mouse_face (w
, start_x
, row
,
25551 start_hpos
, end_hpos
, draw
);
25554 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25558 #ifdef HAVE_WINDOW_SYSTEM
25559 /* When we've written over the cursor, arrange for it to
25560 be displayed again. */
25561 if (FRAME_WINDOW_P (f
)
25562 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25565 display_and_set_cursor (w
, 1,
25566 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25567 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25570 #endif /* HAVE_WINDOW_SYSTEM */
25573 #ifdef HAVE_WINDOW_SYSTEM
25574 /* Change the mouse cursor. */
25575 if (FRAME_WINDOW_P (f
))
25577 if (draw
== DRAW_NORMAL_TEXT
25578 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25579 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25580 else if (draw
== DRAW_MOUSE_FACE
)
25581 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25583 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25585 #endif /* HAVE_WINDOW_SYSTEM */
25589 Clear out the mouse-highlighted active region.
25590 Redraw it un-highlighted first. Value is non-zero if mouse
25591 face was actually drawn unhighlighted. */
25594 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25598 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25600 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25604 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25605 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25606 hlinfo
->mouse_face_window
= Qnil
;
25607 hlinfo
->mouse_face_overlay
= Qnil
;
25611 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25612 within the mouse face on that window. */
25614 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25616 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25618 /* Quickly resolve the easy cases. */
25619 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25620 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25622 if (vpos
< hlinfo
->mouse_face_beg_row
25623 || vpos
> hlinfo
->mouse_face_end_row
)
25625 if (vpos
> hlinfo
->mouse_face_beg_row
25626 && vpos
< hlinfo
->mouse_face_end_row
)
25629 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25631 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25633 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25636 else if ((vpos
== hlinfo
->mouse_face_beg_row
25637 && hpos
>= hlinfo
->mouse_face_beg_col
)
25638 || (vpos
== hlinfo
->mouse_face_end_row
25639 && hpos
< hlinfo
->mouse_face_end_col
))
25644 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25646 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25649 else if ((vpos
== hlinfo
->mouse_face_beg_row
25650 && hpos
<= hlinfo
->mouse_face_beg_col
)
25651 || (vpos
== hlinfo
->mouse_face_end_row
25652 && hpos
> hlinfo
->mouse_face_end_col
))
25660 Non-zero if physical cursor of window W is within mouse face. */
25663 cursor_in_mouse_face_p (struct window
*w
)
25665 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25670 /* Find the glyph rows START_ROW and END_ROW of window W that display
25671 characters between buffer positions START_CHARPOS and END_CHARPOS
25672 (excluding END_CHARPOS). This is similar to row_containing_pos,
25673 but is more accurate when bidi reordering makes buffer positions
25674 change non-linearly with glyph rows. */
25676 rows_from_pos_range (struct window
*w
,
25677 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
25678 struct glyph_row
**start
, struct glyph_row
**end
)
25680 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25681 int last_y
= window_text_bottom_y (w
);
25682 struct glyph_row
*row
;
25687 while (!first
->enabled_p
25688 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25691 /* Find the START row. */
25693 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25696 /* A row can potentially be the START row if the range of the
25697 characters it displays intersects the range
25698 [START_CHARPOS..END_CHARPOS). */
25699 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25700 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25701 /* See the commentary in row_containing_pos, for the
25702 explanation of the complicated way to check whether
25703 some position is beyond the end of the characters
25704 displayed by a row. */
25705 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25706 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25707 && !row
->ends_at_zv_p
25708 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25709 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25710 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25711 && !row
->ends_at_zv_p
25712 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25714 /* Found a candidate row. Now make sure at least one of the
25715 glyphs it displays has a charpos from the range
25716 [START_CHARPOS..END_CHARPOS).
25718 This is not obvious because bidi reordering could make
25719 buffer positions of a row be 1,2,3,102,101,100, and if we
25720 want to highlight characters in [50..60), we don't want
25721 this row, even though [50..60) does intersect [1..103),
25722 the range of character positions given by the row's start
25723 and end positions. */
25724 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25725 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25729 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25730 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25739 /* Find the END row. */
25741 /* If the last row is partially visible, start looking for END
25742 from that row, instead of starting from FIRST. */
25743 && !(row
->enabled_p
25744 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25746 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25748 struct glyph_row
*next
= row
+ 1;
25750 if (!next
->enabled_p
25751 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25752 /* The first row >= START whose range of displayed characters
25753 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25754 is the row END + 1. */
25755 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25756 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25757 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25758 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25759 && !next
->ends_at_zv_p
25760 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25761 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25762 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25763 && !next
->ends_at_zv_p
25764 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25771 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25772 but none of the characters it displays are in the range, it is
25774 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25775 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25779 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25780 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25793 /* This function sets the mouse_face_* elements of HLINFO, assuming
25794 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25795 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25796 for the overlay or run of text properties specifying the mouse
25797 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25798 before-string and after-string that must also be highlighted.
25799 COVER_STRING, if non-nil, is a display string that may cover some
25800 or all of the highlighted text. */
25803 mouse_face_from_buffer_pos (Lisp_Object window
,
25804 Mouse_HLInfo
*hlinfo
,
25805 ptrdiff_t mouse_charpos
,
25806 ptrdiff_t start_charpos
,
25807 ptrdiff_t end_charpos
,
25808 Lisp_Object before_string
,
25809 Lisp_Object after_string
,
25810 Lisp_Object cover_string
)
25812 struct window
*w
= XWINDOW (window
);
25813 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25814 struct glyph_row
*r1
, *r2
;
25815 struct glyph
*glyph
, *end
;
25816 ptrdiff_t ignore
, pos
;
25819 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25820 xassert (NILP (before_string
) || STRINGP (before_string
));
25821 xassert (NILP (after_string
) || STRINGP (after_string
));
25823 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25824 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25826 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25827 /* If the before-string or display-string contains newlines,
25828 rows_from_pos_range skips to its last row. Move back. */
25829 if (!NILP (before_string
) || !NILP (cover_string
))
25831 struct glyph_row
*prev
;
25832 while ((prev
= r1
- 1, prev
>= first
)
25833 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25834 && prev
->used
[TEXT_AREA
] > 0)
25836 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25837 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25838 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25840 || !(EQ (glyph
->object
, before_string
)
25841 || EQ (glyph
->object
, cover_string
)))
25848 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25849 hlinfo
->mouse_face_past_end
= 1;
25851 else if (!NILP (after_string
))
25853 /* If the after-string has newlines, advance to its last row. */
25854 struct glyph_row
*next
;
25855 struct glyph_row
*last
25856 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25858 for (next
= r2
+ 1;
25860 && next
->used
[TEXT_AREA
] > 0
25861 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25865 /* The rest of the display engine assumes that mouse_face_beg_row is
25866 either above below mouse_face_end_row or identical to it. But
25867 with bidi-reordered continued lines, the row for START_CHARPOS
25868 could be below the row for END_CHARPOS. If so, swap the rows and
25869 store them in correct order. */
25872 struct glyph_row
*tem
= r2
;
25878 hlinfo
->mouse_face_beg_y
= r1
->y
;
25879 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25880 hlinfo
->mouse_face_end_y
= r2
->y
;
25881 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25883 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25884 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25885 could be anywhere in the row and in any order. The strategy
25886 below is to find the leftmost and the rightmost glyph that
25887 belongs to either of these 3 strings, or whose position is
25888 between START_CHARPOS and END_CHARPOS, and highlight all the
25889 glyphs between those two. This may cover more than just the text
25890 between START_CHARPOS and END_CHARPOS if the range of characters
25891 strides the bidi level boundary, e.g. if the beginning is in R2L
25892 text while the end is in L2R text or vice versa. */
25893 if (!r1
->reversed_p
)
25895 /* This row is in a left to right paragraph. Scan it left to
25897 glyph
= r1
->glyphs
[TEXT_AREA
];
25898 end
= glyph
+ r1
->used
[TEXT_AREA
];
25901 /* Skip truncation glyphs at the start of the glyph row. */
25902 if (r1
->displays_text_p
)
25904 && INTEGERP (glyph
->object
)
25905 && glyph
->charpos
< 0;
25907 x
+= glyph
->pixel_width
;
25909 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25910 or COVER_STRING, and the first glyph from buffer whose
25911 position is between START_CHARPOS and END_CHARPOS. */
25913 && !INTEGERP (glyph
->object
)
25914 && !EQ (glyph
->object
, cover_string
)
25915 && !(BUFFERP (glyph
->object
)
25916 && (glyph
->charpos
>= start_charpos
25917 && glyph
->charpos
< end_charpos
));
25920 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25921 are present at buffer positions between START_CHARPOS and
25922 END_CHARPOS, or if they come from an overlay. */
25923 if (EQ (glyph
->object
, before_string
))
25925 pos
= string_buffer_position (before_string
,
25927 /* If pos == 0, it means before_string came from an
25928 overlay, not from a buffer position. */
25929 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25932 else if (EQ (glyph
->object
, after_string
))
25934 pos
= string_buffer_position (after_string
, end_charpos
);
25935 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25938 x
+= glyph
->pixel_width
;
25940 hlinfo
->mouse_face_beg_x
= x
;
25941 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25945 /* This row is in a right to left paragraph. Scan it right to
25949 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25950 glyph
= end
+ r1
->used
[TEXT_AREA
];
25952 /* Skip truncation glyphs at the start of the glyph row. */
25953 if (r1
->displays_text_p
)
25955 && INTEGERP (glyph
->object
)
25956 && glyph
->charpos
< 0;
25960 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25961 or COVER_STRING, and the first glyph from buffer whose
25962 position is between START_CHARPOS and END_CHARPOS. */
25964 && !INTEGERP (glyph
->object
)
25965 && !EQ (glyph
->object
, cover_string
)
25966 && !(BUFFERP (glyph
->object
)
25967 && (glyph
->charpos
>= start_charpos
25968 && glyph
->charpos
< end_charpos
));
25971 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25972 are present at buffer positions between START_CHARPOS and
25973 END_CHARPOS, or if they come from an overlay. */
25974 if (EQ (glyph
->object
, before_string
))
25976 pos
= string_buffer_position (before_string
, start_charpos
);
25977 /* If pos == 0, it means before_string came from an
25978 overlay, not from a buffer position. */
25979 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25982 else if (EQ (glyph
->object
, after_string
))
25984 pos
= string_buffer_position (after_string
, end_charpos
);
25985 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25990 glyph
++; /* first glyph to the right of the highlighted area */
25991 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25992 x
+= g
->pixel_width
;
25993 hlinfo
->mouse_face_beg_x
= x
;
25994 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25997 /* If the highlight ends in a different row, compute GLYPH and END
25998 for the end row. Otherwise, reuse the values computed above for
25999 the row where the highlight begins. */
26002 if (!r2
->reversed_p
)
26004 glyph
= r2
->glyphs
[TEXT_AREA
];
26005 end
= glyph
+ r2
->used
[TEXT_AREA
];
26010 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26011 glyph
= end
+ r2
->used
[TEXT_AREA
];
26015 if (!r2
->reversed_p
)
26017 /* Skip truncation and continuation glyphs near the end of the
26018 row, and also blanks and stretch glyphs inserted by
26019 extend_face_to_end_of_line. */
26021 && INTEGERP ((end
- 1)->object
)
26022 && (end
- 1)->charpos
<= 0)
26024 /* Scan the rest of the glyph row from the end, looking for the
26025 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26026 COVER_STRING, or whose position is between START_CHARPOS
26030 && !INTEGERP (end
->object
)
26031 && !EQ (end
->object
, cover_string
)
26032 && !(BUFFERP (end
->object
)
26033 && (end
->charpos
>= start_charpos
26034 && end
->charpos
< end_charpos
));
26037 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26038 are present at buffer positions between START_CHARPOS and
26039 END_CHARPOS, or if they come from an overlay. */
26040 if (EQ (end
->object
, before_string
))
26042 pos
= string_buffer_position (before_string
, start_charpos
);
26043 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26046 else if (EQ (end
->object
, after_string
))
26048 pos
= string_buffer_position (after_string
, end_charpos
);
26049 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26053 /* Find the X coordinate of the last glyph to be highlighted. */
26054 for (; glyph
<= end
; ++glyph
)
26055 x
+= glyph
->pixel_width
;
26057 hlinfo
->mouse_face_end_x
= x
;
26058 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26062 /* Skip truncation and continuation glyphs near the end of the
26063 row, and also blanks and stretch glyphs inserted by
26064 extend_face_to_end_of_line. */
26068 && INTEGERP (end
->object
)
26069 && end
->charpos
<= 0)
26071 x
+= end
->pixel_width
;
26074 /* Scan the rest of the glyph row from the end, looking for the
26075 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26076 COVER_STRING, or whose position is between START_CHARPOS
26080 && !INTEGERP (end
->object
)
26081 && !EQ (end
->object
, cover_string
)
26082 && !(BUFFERP (end
->object
)
26083 && (end
->charpos
>= start_charpos
26084 && end
->charpos
< end_charpos
));
26087 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26088 are present at buffer positions between START_CHARPOS and
26089 END_CHARPOS, or if they come from an overlay. */
26090 if (EQ (end
->object
, before_string
))
26092 pos
= string_buffer_position (before_string
, start_charpos
);
26093 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26096 else if (EQ (end
->object
, after_string
))
26098 pos
= string_buffer_position (after_string
, end_charpos
);
26099 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26102 x
+= end
->pixel_width
;
26104 hlinfo
->mouse_face_end_x
= x
;
26105 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26108 hlinfo
->mouse_face_window
= window
;
26109 hlinfo
->mouse_face_face_id
26110 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26112 !hlinfo
->mouse_face_hidden
, -1);
26113 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26116 /* The following function is not used anymore (replaced with
26117 mouse_face_from_string_pos), but I leave it here for the time
26118 being, in case someone would. */
26120 #if 0 /* not used */
26122 /* Find the position of the glyph for position POS in OBJECT in
26123 window W's current matrix, and return in *X, *Y the pixel
26124 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26126 RIGHT_P non-zero means return the position of the right edge of the
26127 glyph, RIGHT_P zero means return the left edge position.
26129 If no glyph for POS exists in the matrix, return the position of
26130 the glyph with the next smaller position that is in the matrix, if
26131 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26132 exists in the matrix, return the position of the glyph with the
26133 next larger position in OBJECT.
26135 Value is non-zero if a glyph was found. */
26138 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26139 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26141 int yb
= window_text_bottom_y (w
);
26142 struct glyph_row
*r
;
26143 struct glyph
*best_glyph
= NULL
;
26144 struct glyph_row
*best_row
= NULL
;
26147 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26148 r
->enabled_p
&& r
->y
< yb
;
26151 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26152 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26155 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26156 if (EQ (g
->object
, object
))
26158 if (g
->charpos
== pos
)
26165 else if (best_glyph
== NULL
26166 || ((eabs (g
->charpos
- pos
)
26167 < eabs (best_glyph
->charpos
- pos
))
26170 : g
->charpos
> pos
)))
26184 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26188 *x
+= best_glyph
->pixel_width
;
26193 *vpos
= best_row
- w
->current_matrix
->rows
;
26196 return best_glyph
!= NULL
;
26198 #endif /* not used */
26200 /* Find the positions of the first and the last glyphs in window W's
26201 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26202 (assumed to be a string), and return in HLINFO's mouse_face_*
26203 members the pixel and column/row coordinates of those glyphs. */
26206 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26207 Lisp_Object object
,
26208 ptrdiff_t startpos
, ptrdiff_t endpos
)
26210 int yb
= window_text_bottom_y (w
);
26211 struct glyph_row
*r
;
26212 struct glyph
*g
, *e
;
26216 /* Find the glyph row with at least one position in the range
26217 [STARTPOS..ENDPOS], and the first glyph in that row whose
26218 position belongs to that range. */
26219 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26220 r
->enabled_p
&& r
->y
< yb
;
26223 if (!r
->reversed_p
)
26225 g
= r
->glyphs
[TEXT_AREA
];
26226 e
= g
+ r
->used
[TEXT_AREA
];
26227 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26228 if (EQ (g
->object
, object
)
26229 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26231 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26232 hlinfo
->mouse_face_beg_y
= r
->y
;
26233 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26234 hlinfo
->mouse_face_beg_x
= gx
;
26243 e
= r
->glyphs
[TEXT_AREA
];
26244 g
= e
+ r
->used
[TEXT_AREA
];
26245 for ( ; g
> e
; --g
)
26246 if (EQ ((g
-1)->object
, object
)
26247 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26249 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26250 hlinfo
->mouse_face_beg_y
= r
->y
;
26251 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26252 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26253 gx
+= g1
->pixel_width
;
26254 hlinfo
->mouse_face_beg_x
= gx
;
26266 /* Starting with the next row, look for the first row which does NOT
26267 include any glyphs whose positions are in the range. */
26268 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26270 g
= r
->glyphs
[TEXT_AREA
];
26271 e
= g
+ r
->used
[TEXT_AREA
];
26273 for ( ; g
< e
; ++g
)
26274 if (EQ (g
->object
, object
)
26275 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26284 /* The highlighted region ends on the previous row. */
26287 /* Set the end row and its vertical pixel coordinate. */
26288 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26289 hlinfo
->mouse_face_end_y
= r
->y
;
26291 /* Compute and set the end column and the end column's horizontal
26292 pixel coordinate. */
26293 if (!r
->reversed_p
)
26295 g
= r
->glyphs
[TEXT_AREA
];
26296 e
= g
+ r
->used
[TEXT_AREA
];
26297 for ( ; e
> g
; --e
)
26298 if (EQ ((e
-1)->object
, object
)
26299 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26301 hlinfo
->mouse_face_end_col
= e
- g
;
26303 for (gx
= r
->x
; g
< e
; ++g
)
26304 gx
+= g
->pixel_width
;
26305 hlinfo
->mouse_face_end_x
= gx
;
26309 e
= r
->glyphs
[TEXT_AREA
];
26310 g
= e
+ r
->used
[TEXT_AREA
];
26311 for (gx
= r
->x
; e
< g
; ++e
)
26313 if (EQ (e
->object
, object
)
26314 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26316 gx
+= e
->pixel_width
;
26318 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26319 hlinfo
->mouse_face_end_x
= gx
;
26323 #ifdef HAVE_WINDOW_SYSTEM
26325 /* See if position X, Y is within a hot-spot of an image. */
26328 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26330 if (!CONSP (hot_spot
))
26333 if (EQ (XCAR (hot_spot
), Qrect
))
26335 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26336 Lisp_Object rect
= XCDR (hot_spot
);
26340 if (!CONSP (XCAR (rect
)))
26342 if (!CONSP (XCDR (rect
)))
26344 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26346 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26348 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26350 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26354 else if (EQ (XCAR (hot_spot
), Qcircle
))
26356 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26357 Lisp_Object circ
= XCDR (hot_spot
);
26358 Lisp_Object lr
, lx0
, ly0
;
26360 && CONSP (XCAR (circ
))
26361 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26362 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26363 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26365 double r
= XFLOATINT (lr
);
26366 double dx
= XINT (lx0
) - x
;
26367 double dy
= XINT (ly0
) - y
;
26368 return (dx
* dx
+ dy
* dy
<= r
* r
);
26371 else if (EQ (XCAR (hot_spot
), Qpoly
))
26373 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26374 if (VECTORP (XCDR (hot_spot
)))
26376 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26377 Lisp_Object
*poly
= v
->contents
;
26378 ptrdiff_t n
= v
->header
.size
;
26381 Lisp_Object lx
, ly
;
26384 /* Need an even number of coordinates, and at least 3 edges. */
26385 if (n
< 6 || n
& 1)
26388 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26389 If count is odd, we are inside polygon. Pixels on edges
26390 may or may not be included depending on actual geometry of the
26392 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26393 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26395 x0
= XINT (lx
), y0
= XINT (ly
);
26396 for (i
= 0; i
< n
; i
+= 2)
26398 int x1
= x0
, y1
= y0
;
26399 if ((lx
= poly
[i
], !INTEGERP (lx
))
26400 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26402 x0
= XINT (lx
), y0
= XINT (ly
);
26404 /* Does this segment cross the X line? */
26412 if (y
> y0
&& y
> y1
)
26414 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26424 find_hot_spot (Lisp_Object map
, int x
, int y
)
26426 while (CONSP (map
))
26428 if (CONSP (XCAR (map
))
26429 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26437 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26439 doc
: /* Lookup in image map MAP coordinates X and Y.
26440 An image map is an alist where each element has the format (AREA ID PLIST).
26441 An AREA is specified as either a rectangle, a circle, or a polygon:
26442 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26443 pixel coordinates of the upper left and bottom right corners.
26444 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26445 and the radius of the circle; r may be a float or integer.
26446 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26447 vector describes one corner in the polygon.
26448 Returns the alist element for the first matching AREA in MAP. */)
26449 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26457 return find_hot_spot (map
,
26458 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
26459 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
26463 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26465 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26467 /* Do not change cursor shape while dragging mouse. */
26468 if (!NILP (do_mouse_tracking
))
26471 if (!NILP (pointer
))
26473 if (EQ (pointer
, Qarrow
))
26474 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26475 else if (EQ (pointer
, Qhand
))
26476 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26477 else if (EQ (pointer
, Qtext
))
26478 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26479 else if (EQ (pointer
, intern ("hdrag")))
26480 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26481 #ifdef HAVE_X_WINDOWS
26482 else if (EQ (pointer
, intern ("vdrag")))
26483 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26485 else if (EQ (pointer
, intern ("hourglass")))
26486 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26487 else if (EQ (pointer
, Qmodeline
))
26488 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26490 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26493 if (cursor
!= No_Cursor
)
26494 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26497 #endif /* HAVE_WINDOW_SYSTEM */
26499 /* Take proper action when mouse has moved to the mode or header line
26500 or marginal area AREA of window W, x-position X and y-position Y.
26501 X is relative to the start of the text display area of W, so the
26502 width of bitmap areas and scroll bars must be subtracted to get a
26503 position relative to the start of the mode line. */
26506 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26507 enum window_part area
)
26509 struct window
*w
= XWINDOW (window
);
26510 struct frame
*f
= XFRAME (w
->frame
);
26511 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26512 #ifdef HAVE_WINDOW_SYSTEM
26513 Display_Info
*dpyinfo
;
26515 Cursor cursor
= No_Cursor
;
26516 Lisp_Object pointer
= Qnil
;
26517 int dx
, dy
, width
, height
;
26519 Lisp_Object string
, object
= Qnil
;
26520 Lisp_Object pos
, help
;
26522 Lisp_Object mouse_face
;
26523 int original_x_pixel
= x
;
26524 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26525 struct glyph_row
*row
;
26527 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26532 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26533 returns them in row/column units! */
26534 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26535 &object
, &dx
, &dy
, &width
, &height
);
26537 row
= (area
== ON_MODE_LINE
26538 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26539 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26541 /* Find the glyph under the mouse pointer. */
26542 if (row
->mode_line_p
&& row
->enabled_p
)
26544 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26545 end
= glyph
+ row
->used
[TEXT_AREA
];
26547 for (x0
= original_x_pixel
;
26548 glyph
< end
&& x0
>= glyph
->pixel_width
;
26550 x0
-= glyph
->pixel_width
;
26558 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26559 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26560 returns them in row/column units! */
26561 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26562 &object
, &dx
, &dy
, &width
, &height
);
26567 #ifdef HAVE_WINDOW_SYSTEM
26568 if (IMAGEP (object
))
26570 Lisp_Object image_map
, hotspot
;
26571 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26573 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26575 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26579 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26580 If so, we could look for mouse-enter, mouse-leave
26581 properties in PLIST (and do something...). */
26582 hotspot
= XCDR (hotspot
);
26583 if (CONSP (hotspot
)
26584 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26586 pointer
= Fplist_get (plist
, Qpointer
);
26587 if (NILP (pointer
))
26589 help
= Fplist_get (plist
, Qhelp_echo
);
26592 help_echo_string
= help
;
26593 /* Is this correct? ++kfs */
26594 XSETWINDOW (help_echo_window
, w
);
26595 help_echo_object
= w
->buffer
;
26596 help_echo_pos
= charpos
;
26600 if (NILP (pointer
))
26601 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26603 #endif /* HAVE_WINDOW_SYSTEM */
26605 if (STRINGP (string
))
26607 pos
= make_number (charpos
);
26608 /* If we're on a string with `help-echo' text property, arrange
26609 for the help to be displayed. This is done by setting the
26610 global variable help_echo_string to the help string. */
26613 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26616 help_echo_string
= help
;
26617 XSETWINDOW (help_echo_window
, w
);
26618 help_echo_object
= string
;
26619 help_echo_pos
= charpos
;
26623 #ifdef HAVE_WINDOW_SYSTEM
26624 if (FRAME_WINDOW_P (f
))
26626 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26627 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26628 if (NILP (pointer
))
26629 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26631 /* Change the mouse pointer according to what is under X/Y. */
26633 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26636 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26637 if (!KEYMAPP (map
))
26638 map
= Fget_text_property (pos
, Qkeymap
, string
);
26639 if (!KEYMAPP (map
))
26640 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26645 /* Change the mouse face according to what is under X/Y. */
26646 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26647 if (!NILP (mouse_face
)
26648 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26653 struct glyph
* tmp_glyph
;
26657 int total_pixel_width
;
26658 ptrdiff_t begpos
, endpos
, ignore
;
26662 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26663 Qmouse_face
, string
, Qnil
);
26669 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26671 endpos
= SCHARS (string
);
26675 /* Calculate the glyph position GPOS of GLYPH in the
26676 displayed string, relative to the beginning of the
26677 highlighted part of the string.
26679 Note: GPOS is different from CHARPOS. CHARPOS is the
26680 position of GLYPH in the internal string object. A mode
26681 line string format has structures which are converted to
26682 a flattened string by the Emacs Lisp interpreter. The
26683 internal string is an element of those structures. The
26684 displayed string is the flattened string. */
26685 tmp_glyph
= row_start_glyph
;
26686 while (tmp_glyph
< glyph
26687 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26688 && begpos
<= tmp_glyph
->charpos
26689 && tmp_glyph
->charpos
< endpos
)))
26691 gpos
= glyph
- tmp_glyph
;
26693 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26694 the highlighted part of the displayed string to which
26695 GLYPH belongs. Note: GSEQ_LENGTH is different from
26696 SCHARS (STRING), because the latter returns the length of
26697 the internal string. */
26698 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26700 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26701 && begpos
<= tmp_glyph
->charpos
26702 && tmp_glyph
->charpos
< endpos
));
26705 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26707 /* Calculate the total pixel width of all the glyphs between
26708 the beginning of the highlighted area and GLYPH. */
26709 total_pixel_width
= 0;
26710 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26711 total_pixel_width
+= tmp_glyph
->pixel_width
;
26713 /* Pre calculation of re-rendering position. Note: X is in
26714 column units here, after the call to mode_line_string or
26715 marginal_area_string. */
26717 vpos
= (area
== ON_MODE_LINE
26718 ? (w
->current_matrix
)->nrows
- 1
26721 /* If GLYPH's position is included in the region that is
26722 already drawn in mouse face, we have nothing to do. */
26723 if ( EQ (window
, hlinfo
->mouse_face_window
)
26724 && (!row
->reversed_p
26725 ? (hlinfo
->mouse_face_beg_col
<= hpos
26726 && hpos
< hlinfo
->mouse_face_end_col
)
26727 /* In R2L rows we swap BEG and END, see below. */
26728 : (hlinfo
->mouse_face_end_col
<= hpos
26729 && hpos
< hlinfo
->mouse_face_beg_col
))
26730 && hlinfo
->mouse_face_beg_row
== vpos
)
26733 if (clear_mouse_face (hlinfo
))
26734 cursor
= No_Cursor
;
26736 if (!row
->reversed_p
)
26738 hlinfo
->mouse_face_beg_col
= hpos
;
26739 hlinfo
->mouse_face_beg_x
= original_x_pixel
26740 - (total_pixel_width
+ dx
);
26741 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26742 hlinfo
->mouse_face_end_x
= 0;
26746 /* In R2L rows, show_mouse_face expects BEG and END
26747 coordinates to be swapped. */
26748 hlinfo
->mouse_face_end_col
= hpos
;
26749 hlinfo
->mouse_face_end_x
= original_x_pixel
26750 - (total_pixel_width
+ dx
);
26751 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26752 hlinfo
->mouse_face_beg_x
= 0;
26755 hlinfo
->mouse_face_beg_row
= vpos
;
26756 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26757 hlinfo
->mouse_face_beg_y
= 0;
26758 hlinfo
->mouse_face_end_y
= 0;
26759 hlinfo
->mouse_face_past_end
= 0;
26760 hlinfo
->mouse_face_window
= window
;
26762 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26768 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26770 if (NILP (pointer
))
26773 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26774 clear_mouse_face (hlinfo
);
26776 #ifdef HAVE_WINDOW_SYSTEM
26777 if (FRAME_WINDOW_P (f
))
26778 define_frame_cursor1 (f
, cursor
, pointer
);
26784 Take proper action when the mouse has moved to position X, Y on
26785 frame F as regards highlighting characters that have mouse-face
26786 properties. Also de-highlighting chars where the mouse was before.
26787 X and Y can be negative or out of range. */
26790 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26792 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26793 enum window_part part
;
26794 Lisp_Object window
;
26796 Cursor cursor
= No_Cursor
;
26797 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26800 /* When a menu is active, don't highlight because this looks odd. */
26801 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26802 if (popup_activated ())
26806 if (NILP (Vmouse_highlight
)
26807 || !f
->glyphs_initialized_p
26808 || f
->pointer_invisible
)
26811 hlinfo
->mouse_face_mouse_x
= x
;
26812 hlinfo
->mouse_face_mouse_y
= y
;
26813 hlinfo
->mouse_face_mouse_frame
= f
;
26815 if (hlinfo
->mouse_face_defer
)
26818 if (gc_in_progress
)
26820 hlinfo
->mouse_face_deferred_gc
= 1;
26824 /* Which window is that in? */
26825 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26827 /* If we were displaying active text in another window, clear that.
26828 Also clear if we move out of text area in same window. */
26829 if (! EQ (window
, hlinfo
->mouse_face_window
)
26830 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26831 && !NILP (hlinfo
->mouse_face_window
)))
26832 clear_mouse_face (hlinfo
);
26834 /* Not on a window -> return. */
26835 if (!WINDOWP (window
))
26838 /* Reset help_echo_string. It will get recomputed below. */
26839 help_echo_string
= Qnil
;
26841 /* Convert to window-relative pixel coordinates. */
26842 w
= XWINDOW (window
);
26843 frame_to_window_pixel_xy (w
, &x
, &y
);
26845 #ifdef HAVE_WINDOW_SYSTEM
26846 /* Handle tool-bar window differently since it doesn't display a
26848 if (EQ (window
, f
->tool_bar_window
))
26850 note_tool_bar_highlight (f
, x
, y
);
26855 /* Mouse is on the mode, header line or margin? */
26856 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26857 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26859 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26863 #ifdef HAVE_WINDOW_SYSTEM
26864 if (part
== ON_VERTICAL_BORDER
)
26866 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26867 help_echo_string
= build_string ("drag-mouse-1: resize");
26869 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26870 || part
== ON_SCROLL_BAR
)
26871 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26873 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26876 /* Are we in a window whose display is up to date?
26877 And verify the buffer's text has not changed. */
26878 b
= XBUFFER (w
->buffer
);
26879 if (part
== ON_TEXT
26880 && EQ (w
->window_end_valid
, w
->buffer
)
26881 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26882 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26884 int hpos
, vpos
, dx
, dy
, area
;
26886 struct glyph
*glyph
;
26887 Lisp_Object object
;
26888 Lisp_Object mouse_face
= Qnil
, position
;
26889 Lisp_Object
*overlay_vec
= NULL
;
26890 ptrdiff_t i
, noverlays
;
26891 struct buffer
*obuf
;
26892 ptrdiff_t obegv
, ozv
;
26895 /* Find the glyph under X/Y. */
26896 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26898 #ifdef HAVE_WINDOW_SYSTEM
26899 /* Look for :pointer property on image. */
26900 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26902 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26903 if (img
!= NULL
&& IMAGEP (img
->spec
))
26905 Lisp_Object image_map
, hotspot
;
26906 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26908 && (hotspot
= find_hot_spot (image_map
,
26909 glyph
->slice
.img
.x
+ dx
,
26910 glyph
->slice
.img
.y
+ dy
),
26912 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26916 /* Could check XCAR (hotspot) to see if we enter/leave
26918 If so, we could look for mouse-enter, mouse-leave
26919 properties in PLIST (and do something...). */
26920 hotspot
= XCDR (hotspot
);
26921 if (CONSP (hotspot
)
26922 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26924 pointer
= Fplist_get (plist
, Qpointer
);
26925 if (NILP (pointer
))
26927 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26928 if (!NILP (help_echo_string
))
26930 help_echo_window
= window
;
26931 help_echo_object
= glyph
->object
;
26932 help_echo_pos
= glyph
->charpos
;
26936 if (NILP (pointer
))
26937 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26940 #endif /* HAVE_WINDOW_SYSTEM */
26942 /* Clear mouse face if X/Y not over text. */
26944 || area
!= TEXT_AREA
26945 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26946 /* Glyph's OBJECT is an integer for glyphs inserted by the
26947 display engine for its internal purposes, like truncation
26948 and continuation glyphs and blanks beyond the end of
26949 line's text on text terminals. If we are over such a
26950 glyph, we are not over any text. */
26951 || INTEGERP (glyph
->object
)
26952 /* R2L rows have a stretch glyph at their front, which
26953 stands for no text, whereas L2R rows have no glyphs at
26954 all beyond the end of text. Treat such stretch glyphs
26955 like we do with NULL glyphs in L2R rows. */
26956 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26957 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26958 && glyph
->type
== STRETCH_GLYPH
26959 && glyph
->avoid_cursor_p
))
26961 if (clear_mouse_face (hlinfo
))
26962 cursor
= No_Cursor
;
26963 #ifdef HAVE_WINDOW_SYSTEM
26964 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26966 if (area
!= TEXT_AREA
)
26967 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26969 pointer
= Vvoid_text_area_pointer
;
26975 pos
= glyph
->charpos
;
26976 object
= glyph
->object
;
26977 if (!STRINGP (object
) && !BUFFERP (object
))
26980 /* If we get an out-of-range value, return now; avoid an error. */
26981 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26984 /* Make the window's buffer temporarily current for
26985 overlays_at and compute_char_face. */
26986 obuf
= current_buffer
;
26987 current_buffer
= b
;
26993 /* Is this char mouse-active or does it have help-echo? */
26994 position
= make_number (pos
);
26996 if (BUFFERP (object
))
26998 /* Put all the overlays we want in a vector in overlay_vec. */
26999 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27000 /* Sort overlays into increasing priority order. */
27001 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27006 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27009 cursor
= No_Cursor
;
27011 /* Check mouse-face highlighting. */
27013 /* If there exists an overlay with mouse-face overlapping
27014 the one we are currently highlighting, we have to
27015 check if we enter the overlapping overlay, and then
27016 highlight only that. */
27017 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27018 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27020 /* Find the highest priority overlay with a mouse-face. */
27021 Lisp_Object overlay
= Qnil
;
27022 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27024 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27025 if (!NILP (mouse_face
))
27026 overlay
= overlay_vec
[i
];
27029 /* If we're highlighting the same overlay as before, there's
27030 no need to do that again. */
27031 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27032 goto check_help_echo
;
27033 hlinfo
->mouse_face_overlay
= overlay
;
27035 /* Clear the display of the old active region, if any. */
27036 if (clear_mouse_face (hlinfo
))
27037 cursor
= No_Cursor
;
27039 /* If no overlay applies, get a text property. */
27040 if (NILP (overlay
))
27041 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27043 /* Next, compute the bounds of the mouse highlighting and
27045 if (!NILP (mouse_face
) && STRINGP (object
))
27047 /* The mouse-highlighting comes from a display string
27048 with a mouse-face. */
27052 s
= Fprevious_single_property_change
27053 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27054 e
= Fnext_single_property_change
27055 (position
, Qmouse_face
, object
, Qnil
);
27057 s
= make_number (0);
27059 e
= make_number (SCHARS (object
) - 1);
27060 mouse_face_from_string_pos (w
, hlinfo
, object
,
27061 XINT (s
), XINT (e
));
27062 hlinfo
->mouse_face_past_end
= 0;
27063 hlinfo
->mouse_face_window
= window
;
27064 hlinfo
->mouse_face_face_id
27065 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27066 glyph
->face_id
, 1);
27067 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27068 cursor
= No_Cursor
;
27072 /* The mouse-highlighting, if any, comes from an overlay
27073 or text property in the buffer. */
27074 Lisp_Object buffer
IF_LINT (= Qnil
);
27075 Lisp_Object cover_string
IF_LINT (= Qnil
);
27077 if (STRINGP (object
))
27079 /* If we are on a display string with no mouse-face,
27080 check if the text under it has one. */
27081 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27082 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27083 pos
= string_buffer_position (object
, start
);
27086 mouse_face
= get_char_property_and_overlay
27087 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27088 buffer
= w
->buffer
;
27089 cover_string
= object
;
27095 cover_string
= Qnil
;
27098 if (!NILP (mouse_face
))
27100 Lisp_Object before
, after
;
27101 Lisp_Object before_string
, after_string
;
27102 /* To correctly find the limits of mouse highlight
27103 in a bidi-reordered buffer, we must not use the
27104 optimization of limiting the search in
27105 previous-single-property-change and
27106 next-single-property-change, because
27107 rows_from_pos_range needs the real start and end
27108 positions to DTRT in this case. That's because
27109 the first row visible in a window does not
27110 necessarily display the character whose position
27111 is the smallest. */
27113 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27114 ? Fmarker_position (w
->start
)
27117 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27118 ? make_number (BUF_Z (XBUFFER (buffer
))
27119 - XFASTINT (w
->window_end_pos
))
27122 if (NILP (overlay
))
27124 /* Handle the text property case. */
27125 before
= Fprevious_single_property_change
27126 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27127 after
= Fnext_single_property_change
27128 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27129 before_string
= after_string
= Qnil
;
27133 /* Handle the overlay case. */
27134 before
= Foverlay_start (overlay
);
27135 after
= Foverlay_end (overlay
);
27136 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27137 after_string
= Foverlay_get (overlay
, Qafter_string
);
27139 if (!STRINGP (before_string
)) before_string
= Qnil
;
27140 if (!STRINGP (after_string
)) after_string
= Qnil
;
27143 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27146 before_string
, after_string
,
27148 cursor
= No_Cursor
;
27155 /* Look for a `help-echo' property. */
27156 if (NILP (help_echo_string
)) {
27157 Lisp_Object help
, overlay
;
27159 /* Check overlays first. */
27160 help
= overlay
= Qnil
;
27161 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27163 overlay
= overlay_vec
[i
];
27164 help
= Foverlay_get (overlay
, Qhelp_echo
);
27169 help_echo_string
= help
;
27170 help_echo_window
= window
;
27171 help_echo_object
= overlay
;
27172 help_echo_pos
= pos
;
27176 Lisp_Object obj
= glyph
->object
;
27177 ptrdiff_t charpos
= glyph
->charpos
;
27179 /* Try text properties. */
27182 && charpos
< SCHARS (obj
))
27184 help
= Fget_text_property (make_number (charpos
),
27188 /* If the string itself doesn't specify a help-echo,
27189 see if the buffer text ``under'' it does. */
27190 struct glyph_row
*r
27191 = MATRIX_ROW (w
->current_matrix
, vpos
);
27192 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27193 ptrdiff_t p
= string_buffer_position (obj
, start
);
27196 help
= Fget_char_property (make_number (p
),
27197 Qhelp_echo
, w
->buffer
);
27206 else if (BUFFERP (obj
)
27209 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27214 help_echo_string
= help
;
27215 help_echo_window
= window
;
27216 help_echo_object
= obj
;
27217 help_echo_pos
= charpos
;
27222 #ifdef HAVE_WINDOW_SYSTEM
27223 /* Look for a `pointer' property. */
27224 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27226 /* Check overlays first. */
27227 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27228 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27230 if (NILP (pointer
))
27232 Lisp_Object obj
= glyph
->object
;
27233 ptrdiff_t charpos
= glyph
->charpos
;
27235 /* Try text properties. */
27238 && charpos
< SCHARS (obj
))
27240 pointer
= Fget_text_property (make_number (charpos
),
27242 if (NILP (pointer
))
27244 /* If the string itself doesn't specify a pointer,
27245 see if the buffer text ``under'' it does. */
27246 struct glyph_row
*r
27247 = MATRIX_ROW (w
->current_matrix
, vpos
);
27248 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27249 ptrdiff_t p
= string_buffer_position (obj
, start
);
27251 pointer
= Fget_char_property (make_number (p
),
27252 Qpointer
, w
->buffer
);
27255 else if (BUFFERP (obj
)
27258 pointer
= Fget_text_property (make_number (charpos
),
27262 #endif /* HAVE_WINDOW_SYSTEM */
27266 current_buffer
= obuf
;
27271 #ifdef HAVE_WINDOW_SYSTEM
27272 if (FRAME_WINDOW_P (f
))
27273 define_frame_cursor1 (f
, cursor
, pointer
);
27275 /* This is here to prevent a compiler error, about "label at end of
27276 compound statement". */
27283 Clear any mouse-face on window W. This function is part of the
27284 redisplay interface, and is called from try_window_id and similar
27285 functions to ensure the mouse-highlight is off. */
27288 x_clear_window_mouse_face (struct window
*w
)
27290 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27291 Lisp_Object window
;
27294 XSETWINDOW (window
, w
);
27295 if (EQ (window
, hlinfo
->mouse_face_window
))
27296 clear_mouse_face (hlinfo
);
27302 Just discard the mouse face information for frame F, if any.
27303 This is used when the size of F is changed. */
27306 cancel_mouse_face (struct frame
*f
)
27308 Lisp_Object window
;
27309 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27311 window
= hlinfo
->mouse_face_window
;
27312 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27314 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27315 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27316 hlinfo
->mouse_face_window
= Qnil
;
27322 /***********************************************************************
27324 ***********************************************************************/
27326 #ifdef HAVE_WINDOW_SYSTEM
27328 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27329 which intersects rectangle R. R is in window-relative coordinates. */
27332 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27333 enum glyph_row_area area
)
27335 struct glyph
*first
= row
->glyphs
[area
];
27336 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27337 struct glyph
*last
;
27338 int first_x
, start_x
, x
;
27340 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27341 /* If row extends face to end of line write the whole line. */
27342 draw_glyphs (w
, 0, row
, area
,
27343 0, row
->used
[area
],
27344 DRAW_NORMAL_TEXT
, 0);
27347 /* Set START_X to the window-relative start position for drawing glyphs of
27348 AREA. The first glyph of the text area can be partially visible.
27349 The first glyphs of other areas cannot. */
27350 start_x
= window_box_left_offset (w
, area
);
27352 if (area
== TEXT_AREA
)
27355 /* Find the first glyph that must be redrawn. */
27357 && x
+ first
->pixel_width
< r
->x
)
27359 x
+= first
->pixel_width
;
27363 /* Find the last one. */
27367 && x
< r
->x
+ r
->width
)
27369 x
+= last
->pixel_width
;
27375 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27376 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27377 DRAW_NORMAL_TEXT
, 0);
27382 /* Redraw the parts of the glyph row ROW on window W intersecting
27383 rectangle R. R is in window-relative coordinates. Value is
27384 non-zero if mouse-face was overwritten. */
27387 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27389 xassert (row
->enabled_p
);
27391 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27392 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27393 0, row
->used
[TEXT_AREA
],
27394 DRAW_NORMAL_TEXT
, 0);
27397 if (row
->used
[LEFT_MARGIN_AREA
])
27398 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27399 if (row
->used
[TEXT_AREA
])
27400 expose_area (w
, row
, r
, TEXT_AREA
);
27401 if (row
->used
[RIGHT_MARGIN_AREA
])
27402 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27403 draw_row_fringe_bitmaps (w
, row
);
27406 return row
->mouse_face_p
;
27410 /* Redraw those parts of glyphs rows during expose event handling that
27411 overlap other rows. Redrawing of an exposed line writes over parts
27412 of lines overlapping that exposed line; this function fixes that.
27414 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27415 row in W's current matrix that is exposed and overlaps other rows.
27416 LAST_OVERLAPPING_ROW is the last such row. */
27419 expose_overlaps (struct window
*w
,
27420 struct glyph_row
*first_overlapping_row
,
27421 struct glyph_row
*last_overlapping_row
,
27424 struct glyph_row
*row
;
27426 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27427 if (row
->overlapping_p
)
27429 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27432 if (row
->used
[LEFT_MARGIN_AREA
])
27433 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27435 if (row
->used
[TEXT_AREA
])
27436 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27438 if (row
->used
[RIGHT_MARGIN_AREA
])
27439 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27445 /* Return non-zero if W's cursor intersects rectangle R. */
27448 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27450 XRectangle cr
, result
;
27451 struct glyph
*cursor_glyph
;
27452 struct glyph_row
*row
;
27454 if (w
->phys_cursor
.vpos
>= 0
27455 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27456 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27458 && row
->cursor_in_fringe_p
)
27460 /* Cursor is in the fringe. */
27461 cr
.x
= window_box_right_offset (w
,
27462 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27463 ? RIGHT_MARGIN_AREA
27466 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27467 cr
.height
= row
->height
;
27468 return x_intersect_rectangles (&cr
, r
, &result
);
27471 cursor_glyph
= get_phys_cursor_glyph (w
);
27474 /* r is relative to W's box, but w->phys_cursor.x is relative
27475 to left edge of W's TEXT area. Adjust it. */
27476 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27477 cr
.y
= w
->phys_cursor
.y
;
27478 cr
.width
= cursor_glyph
->pixel_width
;
27479 cr
.height
= w
->phys_cursor_height
;
27480 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27481 I assume the effect is the same -- and this is portable. */
27482 return x_intersect_rectangles (&cr
, r
, &result
);
27484 /* If we don't understand the format, pretend we're not in the hot-spot. */
27490 Draw a vertical window border to the right of window W if W doesn't
27491 have vertical scroll bars. */
27494 x_draw_vertical_border (struct window
*w
)
27496 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27498 /* We could do better, if we knew what type of scroll-bar the adjacent
27499 windows (on either side) have... But we don't :-(
27500 However, I think this works ok. ++KFS 2003-04-25 */
27502 /* Redraw borders between horizontally adjacent windows. Don't
27503 do it for frames with vertical scroll bars because either the
27504 right scroll bar of a window, or the left scroll bar of its
27505 neighbor will suffice as a border. */
27506 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27509 if (!WINDOW_RIGHTMOST_P (w
)
27510 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27512 int x0
, x1
, y0
, y1
;
27514 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27517 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27520 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27522 else if (!WINDOW_LEFTMOST_P (w
)
27523 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27525 int x0
, x1
, y0
, y1
;
27527 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27530 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27533 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27538 /* Redraw the part of window W intersection rectangle FR. Pixel
27539 coordinates in FR are frame-relative. Call this function with
27540 input blocked. Value is non-zero if the exposure overwrites
27544 expose_window (struct window
*w
, XRectangle
*fr
)
27546 struct frame
*f
= XFRAME (w
->frame
);
27548 int mouse_face_overwritten_p
= 0;
27550 /* If window is not yet fully initialized, do nothing. This can
27551 happen when toolkit scroll bars are used and a window is split.
27552 Reconfiguring the scroll bar will generate an expose for a newly
27554 if (w
->current_matrix
== NULL
)
27557 /* When we're currently updating the window, display and current
27558 matrix usually don't agree. Arrange for a thorough display
27560 if (w
== updated_window
)
27562 SET_FRAME_GARBAGED (f
);
27566 /* Frame-relative pixel rectangle of W. */
27567 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27568 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27569 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27570 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27572 if (x_intersect_rectangles (fr
, &wr
, &r
))
27574 int yb
= window_text_bottom_y (w
);
27575 struct glyph_row
*row
;
27576 int cursor_cleared_p
, phys_cursor_on_p
;
27577 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27579 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27580 r
.x
, r
.y
, r
.width
, r
.height
));
27582 /* Convert to window coordinates. */
27583 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27584 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27586 /* Turn off the cursor. */
27587 if (!w
->pseudo_window_p
27588 && phys_cursor_in_rect_p (w
, &r
))
27590 x_clear_cursor (w
);
27591 cursor_cleared_p
= 1;
27594 cursor_cleared_p
= 0;
27596 /* If the row containing the cursor extends face to end of line,
27597 then expose_area might overwrite the cursor outside the
27598 rectangle and thus notice_overwritten_cursor might clear
27599 w->phys_cursor_on_p. We remember the original value and
27600 check later if it is changed. */
27601 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27603 /* Update lines intersecting rectangle R. */
27604 first_overlapping_row
= last_overlapping_row
= NULL
;
27605 for (row
= w
->current_matrix
->rows
;
27610 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27612 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27613 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27614 || (r
.y
>= y0
&& r
.y
< y1
)
27615 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27617 /* A header line may be overlapping, but there is no need
27618 to fix overlapping areas for them. KFS 2005-02-12 */
27619 if (row
->overlapping_p
&& !row
->mode_line_p
)
27621 if (first_overlapping_row
== NULL
)
27622 first_overlapping_row
= row
;
27623 last_overlapping_row
= row
;
27627 if (expose_line (w
, row
, &r
))
27628 mouse_face_overwritten_p
= 1;
27631 else if (row
->overlapping_p
)
27633 /* We must redraw a row overlapping the exposed area. */
27635 ? y0
+ row
->phys_height
> r
.y
27636 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27638 if (first_overlapping_row
== NULL
)
27639 first_overlapping_row
= row
;
27640 last_overlapping_row
= row
;
27648 /* Display the mode line if there is one. */
27649 if (WINDOW_WANTS_MODELINE_P (w
)
27650 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27652 && row
->y
< r
.y
+ r
.height
)
27654 if (expose_line (w
, row
, &r
))
27655 mouse_face_overwritten_p
= 1;
27658 if (!w
->pseudo_window_p
)
27660 /* Fix the display of overlapping rows. */
27661 if (first_overlapping_row
)
27662 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27665 /* Draw border between windows. */
27666 x_draw_vertical_border (w
);
27668 /* Turn the cursor on again. */
27669 if (cursor_cleared_p
27670 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27671 update_window_cursor (w
, 1);
27675 return mouse_face_overwritten_p
;
27680 /* Redraw (parts) of all windows in the window tree rooted at W that
27681 intersect R. R contains frame pixel coordinates. Value is
27682 non-zero if the exposure overwrites mouse-face. */
27685 expose_window_tree (struct window
*w
, XRectangle
*r
)
27687 struct frame
*f
= XFRAME (w
->frame
);
27688 int mouse_face_overwritten_p
= 0;
27690 while (w
&& !FRAME_GARBAGED_P (f
))
27692 if (!NILP (w
->hchild
))
27693 mouse_face_overwritten_p
27694 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27695 else if (!NILP (w
->vchild
))
27696 mouse_face_overwritten_p
27697 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27699 mouse_face_overwritten_p
|= expose_window (w
, r
);
27701 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27704 return mouse_face_overwritten_p
;
27709 Redisplay an exposed area of frame F. X and Y are the upper-left
27710 corner of the exposed rectangle. W and H are width and height of
27711 the exposed area. All are pixel values. W or H zero means redraw
27712 the entire frame. */
27715 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27718 int mouse_face_overwritten_p
= 0;
27720 TRACE ((stderr
, "expose_frame "));
27722 /* No need to redraw if frame will be redrawn soon. */
27723 if (FRAME_GARBAGED_P (f
))
27725 TRACE ((stderr
, " garbaged\n"));
27729 /* If basic faces haven't been realized yet, there is no point in
27730 trying to redraw anything. This can happen when we get an expose
27731 event while Emacs is starting, e.g. by moving another window. */
27732 if (FRAME_FACE_CACHE (f
) == NULL
27733 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27735 TRACE ((stderr
, " no faces\n"));
27739 if (w
== 0 || h
== 0)
27742 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27743 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27753 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27754 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27756 if (WINDOWP (f
->tool_bar_window
))
27757 mouse_face_overwritten_p
27758 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27760 #ifdef HAVE_X_WINDOWS
27762 #ifndef USE_X_TOOLKIT
27763 if (WINDOWP (f
->menu_bar_window
))
27764 mouse_face_overwritten_p
27765 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27766 #endif /* not USE_X_TOOLKIT */
27770 /* Some window managers support a focus-follows-mouse style with
27771 delayed raising of frames. Imagine a partially obscured frame,
27772 and moving the mouse into partially obscured mouse-face on that
27773 frame. The visible part of the mouse-face will be highlighted,
27774 then the WM raises the obscured frame. With at least one WM, KDE
27775 2.1, Emacs is not getting any event for the raising of the frame
27776 (even tried with SubstructureRedirectMask), only Expose events.
27777 These expose events will draw text normally, i.e. not
27778 highlighted. Which means we must redo the highlight here.
27779 Subsume it under ``we love X''. --gerd 2001-08-15 */
27780 /* Included in Windows version because Windows most likely does not
27781 do the right thing if any third party tool offers
27782 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27783 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27785 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27786 if (f
== hlinfo
->mouse_face_mouse_frame
)
27788 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27789 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27790 clear_mouse_face (hlinfo
);
27791 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27798 Determine the intersection of two rectangles R1 and R2. Return
27799 the intersection in *RESULT. Value is non-zero if RESULT is not
27803 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27805 XRectangle
*left
, *right
;
27806 XRectangle
*upper
, *lower
;
27807 int intersection_p
= 0;
27809 /* Rearrange so that R1 is the left-most rectangle. */
27811 left
= r1
, right
= r2
;
27813 left
= r2
, right
= r1
;
27815 /* X0 of the intersection is right.x0, if this is inside R1,
27816 otherwise there is no intersection. */
27817 if (right
->x
<= left
->x
+ left
->width
)
27819 result
->x
= right
->x
;
27821 /* The right end of the intersection is the minimum of
27822 the right ends of left and right. */
27823 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27826 /* Same game for Y. */
27828 upper
= r1
, lower
= r2
;
27830 upper
= r2
, lower
= r1
;
27832 /* The upper end of the intersection is lower.y0, if this is inside
27833 of upper. Otherwise, there is no intersection. */
27834 if (lower
->y
<= upper
->y
+ upper
->height
)
27836 result
->y
= lower
->y
;
27838 /* The lower end of the intersection is the minimum of the lower
27839 ends of upper and lower. */
27840 result
->height
= (min (lower
->y
+ lower
->height
,
27841 upper
->y
+ upper
->height
)
27843 intersection_p
= 1;
27847 return intersection_p
;
27850 #endif /* HAVE_WINDOW_SYSTEM */
27853 /***********************************************************************
27855 ***********************************************************************/
27858 syms_of_xdisp (void)
27860 Vwith_echo_area_save_vector
= Qnil
;
27861 staticpro (&Vwith_echo_area_save_vector
);
27863 Vmessage_stack
= Qnil
;
27864 staticpro (&Vmessage_stack
);
27866 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27868 message_dolog_marker1
= Fmake_marker ();
27869 staticpro (&message_dolog_marker1
);
27870 message_dolog_marker2
= Fmake_marker ();
27871 staticpro (&message_dolog_marker2
);
27872 message_dolog_marker3
= Fmake_marker ();
27873 staticpro (&message_dolog_marker3
);
27876 defsubr (&Sdump_frame_glyph_matrix
);
27877 defsubr (&Sdump_glyph_matrix
);
27878 defsubr (&Sdump_glyph_row
);
27879 defsubr (&Sdump_tool_bar_row
);
27880 defsubr (&Strace_redisplay
);
27881 defsubr (&Strace_to_stderr
);
27883 #ifdef HAVE_WINDOW_SYSTEM
27884 defsubr (&Stool_bar_lines_needed
);
27885 defsubr (&Slookup_image_map
);
27887 defsubr (&Sformat_mode_line
);
27888 defsubr (&Sinvisible_p
);
27889 defsubr (&Scurrent_bidi_paragraph_direction
);
27891 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27892 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27893 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27894 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27895 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27896 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27897 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27898 DEFSYM (Qeval
, "eval");
27899 DEFSYM (QCdata
, ":data");
27900 DEFSYM (Qdisplay
, "display");
27901 DEFSYM (Qspace_width
, "space-width");
27902 DEFSYM (Qraise
, "raise");
27903 DEFSYM (Qslice
, "slice");
27904 DEFSYM (Qspace
, "space");
27905 DEFSYM (Qmargin
, "margin");
27906 DEFSYM (Qpointer
, "pointer");
27907 DEFSYM (Qleft_margin
, "left-margin");
27908 DEFSYM (Qright_margin
, "right-margin");
27909 DEFSYM (Qcenter
, "center");
27910 DEFSYM (Qline_height
, "line-height");
27911 DEFSYM (QCalign_to
, ":align-to");
27912 DEFSYM (QCrelative_width
, ":relative-width");
27913 DEFSYM (QCrelative_height
, ":relative-height");
27914 DEFSYM (QCeval
, ":eval");
27915 DEFSYM (QCpropertize
, ":propertize");
27916 DEFSYM (QCfile
, ":file");
27917 DEFSYM (Qfontified
, "fontified");
27918 DEFSYM (Qfontification_functions
, "fontification-functions");
27919 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27920 DEFSYM (Qescape_glyph
, "escape-glyph");
27921 DEFSYM (Qnobreak_space
, "nobreak-space");
27922 DEFSYM (Qimage
, "image");
27923 DEFSYM (Qtext
, "text");
27924 DEFSYM (Qboth
, "both");
27925 DEFSYM (Qboth_horiz
, "both-horiz");
27926 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27927 DEFSYM (QCmap
, ":map");
27928 DEFSYM (QCpointer
, ":pointer");
27929 DEFSYM (Qrect
, "rect");
27930 DEFSYM (Qcircle
, "circle");
27931 DEFSYM (Qpoly
, "poly");
27932 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27933 DEFSYM (Qgrow_only
, "grow-only");
27934 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27935 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27936 DEFSYM (Qposition
, "position");
27937 DEFSYM (Qbuffer_position
, "buffer-position");
27938 DEFSYM (Qobject
, "object");
27939 DEFSYM (Qbar
, "bar");
27940 DEFSYM (Qhbar
, "hbar");
27941 DEFSYM (Qbox
, "box");
27942 DEFSYM (Qhollow
, "hollow");
27943 DEFSYM (Qhand
, "hand");
27944 DEFSYM (Qarrow
, "arrow");
27945 DEFSYM (Qtext
, "text");
27946 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27948 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27949 Fcons (intern_c_string ("void-variable"), Qnil
)),
27951 staticpro (&list_of_error
);
27953 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27954 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27955 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27956 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27958 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27959 staticpro (&echo_buffer
[0]);
27960 staticpro (&echo_buffer
[1]);
27962 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27963 staticpro (&echo_area_buffer
[0]);
27964 staticpro (&echo_area_buffer
[1]);
27966 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27967 staticpro (&Vmessages_buffer_name
);
27969 mode_line_proptrans_alist
= Qnil
;
27970 staticpro (&mode_line_proptrans_alist
);
27971 mode_line_string_list
= Qnil
;
27972 staticpro (&mode_line_string_list
);
27973 mode_line_string_face
= Qnil
;
27974 staticpro (&mode_line_string_face
);
27975 mode_line_string_face_prop
= Qnil
;
27976 staticpro (&mode_line_string_face_prop
);
27977 Vmode_line_unwind_vector
= Qnil
;
27978 staticpro (&Vmode_line_unwind_vector
);
27980 help_echo_string
= Qnil
;
27981 staticpro (&help_echo_string
);
27982 help_echo_object
= Qnil
;
27983 staticpro (&help_echo_object
);
27984 help_echo_window
= Qnil
;
27985 staticpro (&help_echo_window
);
27986 previous_help_echo_string
= Qnil
;
27987 staticpro (&previous_help_echo_string
);
27988 help_echo_pos
= -1;
27990 DEFSYM (Qright_to_left
, "right-to-left");
27991 DEFSYM (Qleft_to_right
, "left-to-right");
27993 #ifdef HAVE_WINDOW_SYSTEM
27994 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27995 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27996 For example, if a block cursor is over a tab, it will be drawn as
27997 wide as that tab on the display. */);
27998 x_stretch_cursor_p
= 0;
28001 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28002 doc
: /* *Non-nil means highlight trailing whitespace.
28003 The face used for trailing whitespace is `trailing-whitespace'. */);
28004 Vshow_trailing_whitespace
= Qnil
;
28006 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28007 doc
: /* *Control highlighting of nobreak space and soft hyphen.
28008 A value of t means highlight the character itself (for nobreak space,
28009 use face `nobreak-space').
28010 A value of nil means no highlighting.
28011 Other values mean display the escape glyph followed by an ordinary
28012 space or ordinary hyphen. */);
28013 Vnobreak_char_display
= Qt
;
28015 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28016 doc
: /* *The pointer shape to show in void text areas.
28017 A value of nil means to show the text pointer. Other options are `arrow',
28018 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28019 Vvoid_text_area_pointer
= Qarrow
;
28021 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28022 doc
: /* Non-nil means don't actually do any redisplay.
28023 This is used for internal purposes. */);
28024 Vinhibit_redisplay
= Qnil
;
28026 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28027 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28028 Vglobal_mode_string
= Qnil
;
28030 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28031 doc
: /* Marker for where to display an arrow on top of the buffer text.
28032 This must be the beginning of a line in order to work.
28033 See also `overlay-arrow-string'. */);
28034 Voverlay_arrow_position
= Qnil
;
28036 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28037 doc
: /* String to display as an arrow in non-window frames.
28038 See also `overlay-arrow-position'. */);
28039 Voverlay_arrow_string
= make_pure_c_string ("=>");
28041 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28042 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28043 The symbols on this list are examined during redisplay to determine
28044 where to display overlay arrows. */);
28045 Voverlay_arrow_variable_list
28046 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28048 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28049 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28050 If that fails to bring point back on frame, point is centered instead.
28051 If this is zero, point is always centered after it moves off frame.
28052 If you want scrolling to always be a line at a time, you should set
28053 `scroll-conservatively' to a large value rather than set this to 1. */);
28055 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28056 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28057 If point moves off-screen, redisplay will scroll by up to
28058 `scroll-conservatively' lines in order to bring point just barely
28059 onto the screen again. If that cannot be done, then redisplay
28060 recenters point as usual.
28062 If the value is greater than 100, redisplay will never recenter point,
28063 but will always scroll just enough text to bring point into view, even
28064 if you move far away.
28066 A value of zero means always recenter point if it moves off screen. */);
28067 scroll_conservatively
= 0;
28069 DEFVAR_INT ("scroll-margin", scroll_margin
,
28070 doc
: /* *Number of lines of margin at the top and bottom of a window.
28071 Recenter the window whenever point gets within this many lines
28072 of the top or bottom of the window. */);
28075 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28076 doc
: /* Pixels per inch value for non-window system displays.
28077 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28078 Vdisplay_pixels_per_inch
= make_float (72.0);
28081 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28084 DEFVAR_LISP ("truncate-partial-width-windows",
28085 Vtruncate_partial_width_windows
,
28086 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28087 For an integer value, truncate lines in each window narrower than the
28088 full frame width, provided the window width is less than that integer;
28089 otherwise, respect the value of `truncate-lines'.
28091 For any other non-nil value, truncate lines in all windows that do
28092 not span the full frame width.
28094 A value of nil means to respect the value of `truncate-lines'.
28096 If `word-wrap' is enabled, you might want to reduce this. */);
28097 Vtruncate_partial_width_windows
= make_number (50);
28099 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28100 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28101 Any other value means to use the appropriate face, `mode-line',
28102 `header-line', or `menu' respectively. */);
28103 mode_line_inverse_video
= 1;
28105 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28106 doc
: /* *Maximum buffer size for which line number should be displayed.
28107 If the buffer is bigger than this, the line number does not appear
28108 in the mode line. A value of nil means no limit. */);
28109 Vline_number_display_limit
= Qnil
;
28111 DEFVAR_INT ("line-number-display-limit-width",
28112 line_number_display_limit_width
,
28113 doc
: /* *Maximum line width (in characters) for line number display.
28114 If the average length of the lines near point is bigger than this, then the
28115 line number may be omitted from the mode line. */);
28116 line_number_display_limit_width
= 200;
28118 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28119 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28120 highlight_nonselected_windows
= 0;
28122 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28123 doc
: /* Non-nil if more than one frame is visible on this display.
28124 Minibuffer-only frames don't count, but iconified frames do.
28125 This variable is not guaranteed to be accurate except while processing
28126 `frame-title-format' and `icon-title-format'. */);
28128 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28129 doc
: /* Template for displaying the title bar of visible frames.
28130 \(Assuming the window manager supports this feature.)
28132 This variable has the same structure as `mode-line-format', except that
28133 the %c and %l constructs are ignored. It is used only on frames for
28134 which no explicit name has been set \(see `modify-frame-parameters'). */);
28136 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28137 doc
: /* Template for displaying the title bar of an iconified frame.
28138 \(Assuming the window manager supports this feature.)
28139 This variable has the same structure as `mode-line-format' (which see),
28140 and is used only on frames for which no explicit name has been set
28141 \(see `modify-frame-parameters'). */);
28143 = Vframe_title_format
28144 = pure_cons (intern_c_string ("multiple-frames"),
28145 pure_cons (make_pure_c_string ("%b"),
28146 pure_cons (pure_cons (empty_unibyte_string
,
28147 pure_cons (intern_c_string ("invocation-name"),
28148 pure_cons (make_pure_c_string ("@"),
28149 pure_cons (intern_c_string ("system-name"),
28153 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28154 doc
: /* Maximum number of lines to keep in the message log buffer.
28155 If nil, disable message logging. If t, log messages but don't truncate
28156 the buffer when it becomes large. */);
28157 Vmessage_log_max
= make_number (100);
28159 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28160 doc
: /* Functions called before redisplay, if window sizes have changed.
28161 The value should be a list of functions that take one argument.
28162 Just before redisplay, for each frame, if any of its windows have changed
28163 size since the last redisplay, or have been split or deleted,
28164 all the functions in the list are called, with the frame as argument. */);
28165 Vwindow_size_change_functions
= Qnil
;
28167 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28168 doc
: /* List of functions to call before redisplaying a window with scrolling.
28169 Each function is called with two arguments, the window and its new
28170 display-start position. Note that these functions are also called by
28171 `set-window-buffer'. Also note that the value of `window-end' is not
28172 valid when these functions are called. */);
28173 Vwindow_scroll_functions
= Qnil
;
28175 DEFVAR_LISP ("window-text-change-functions",
28176 Vwindow_text_change_functions
,
28177 doc
: /* Functions to call in redisplay when text in the window might change. */);
28178 Vwindow_text_change_functions
= Qnil
;
28180 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28181 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28182 Each function is called with two arguments, the window and the end trigger value.
28183 See `set-window-redisplay-end-trigger'. */);
28184 Vredisplay_end_trigger_functions
= Qnil
;
28186 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28187 doc
: /* *Non-nil means autoselect window with mouse pointer.
28188 If nil, do not autoselect windows.
28189 A positive number means delay autoselection by that many seconds: a
28190 window is autoselected only after the mouse has remained in that
28191 window for the duration of the delay.
28192 A negative number has a similar effect, but causes windows to be
28193 autoselected only after the mouse has stopped moving. \(Because of
28194 the way Emacs compares mouse events, you will occasionally wait twice
28195 that time before the window gets selected.\)
28196 Any other value means to autoselect window instantaneously when the
28197 mouse pointer enters it.
28199 Autoselection selects the minibuffer only if it is active, and never
28200 unselects the minibuffer if it is active.
28202 When customizing this variable make sure that the actual value of
28203 `focus-follows-mouse' matches the behavior of your window manager. */);
28204 Vmouse_autoselect_window
= Qnil
;
28206 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28207 doc
: /* *Non-nil means automatically resize tool-bars.
28208 This dynamically changes the tool-bar's height to the minimum height
28209 that is needed to make all tool-bar items visible.
28210 If value is `grow-only', the tool-bar's height is only increased
28211 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28212 Vauto_resize_tool_bars
= Qt
;
28214 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28215 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28216 auto_raise_tool_bar_buttons_p
= 1;
28218 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28219 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28220 make_cursor_line_fully_visible_p
= 1;
28222 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28223 doc
: /* *Border below tool-bar in pixels.
28224 If an integer, use it as the height of the border.
28225 If it is one of `internal-border-width' or `border-width', use the
28226 value of the corresponding frame parameter.
28227 Otherwise, no border is added below the tool-bar. */);
28228 Vtool_bar_border
= Qinternal_border_width
;
28230 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28231 doc
: /* *Margin around tool-bar buttons in pixels.
28232 If an integer, use that for both horizontal and vertical margins.
28233 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28234 HORZ specifying the horizontal margin, and VERT specifying the
28235 vertical margin. */);
28236 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28238 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28239 doc
: /* *Relief thickness of tool-bar buttons. */);
28240 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28242 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28243 doc
: /* Tool bar style to use.
28245 image - show images only
28246 text - show text only
28247 both - show both, text below image
28248 both-horiz - show text to the right of the image
28249 text-image-horiz - show text to the left of the image
28250 any other - use system default or image if no system default. */);
28251 Vtool_bar_style
= Qnil
;
28253 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28254 doc
: /* *Maximum number of characters a label can have to be shown.
28255 The tool bar style must also show labels for this to have any effect, see
28256 `tool-bar-style'. */);
28257 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28259 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28260 doc
: /* List of functions to call to fontify regions of text.
28261 Each function is called with one argument POS. Functions must
28262 fontify a region starting at POS in the current buffer, and give
28263 fontified regions the property `fontified'. */);
28264 Vfontification_functions
= Qnil
;
28265 Fmake_variable_buffer_local (Qfontification_functions
);
28267 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28268 unibyte_display_via_language_environment
,
28269 doc
: /* *Non-nil means display unibyte text according to language environment.
28270 Specifically, this means that raw bytes in the range 160-255 decimal
28271 are displayed by converting them to the equivalent multibyte characters
28272 according to the current language environment. As a result, they are
28273 displayed according to the current fontset.
28275 Note that this variable affects only how these bytes are displayed,
28276 but does not change the fact they are interpreted as raw bytes. */);
28277 unibyte_display_via_language_environment
= 0;
28279 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28280 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28281 If a float, it specifies a fraction of the mini-window frame's height.
28282 If an integer, it specifies a number of lines. */);
28283 Vmax_mini_window_height
= make_float (0.25);
28285 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28286 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28287 A value of nil means don't automatically resize mini-windows.
28288 A value of t means resize them to fit the text displayed in them.
28289 A value of `grow-only', the default, means let mini-windows grow only;
28290 they return to their normal size when the minibuffer is closed, or the
28291 echo area becomes empty. */);
28292 Vresize_mini_windows
= Qgrow_only
;
28294 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28295 doc
: /* Alist specifying how to blink the cursor off.
28296 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28297 `cursor-type' frame-parameter or variable equals ON-STATE,
28298 comparing using `equal', Emacs uses OFF-STATE to specify
28299 how to blink it off. ON-STATE and OFF-STATE are values for
28300 the `cursor-type' frame parameter.
28302 If a frame's ON-STATE has no entry in this list,
28303 the frame's other specifications determine how to blink the cursor off. */);
28304 Vblink_cursor_alist
= Qnil
;
28306 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28307 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28308 If non-nil, windows are automatically scrolled horizontally to make
28309 point visible. */);
28310 automatic_hscrolling_p
= 1;
28311 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28313 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28314 doc
: /* *How many columns away from the window edge point is allowed to get
28315 before automatic hscrolling will horizontally scroll the window. */);
28316 hscroll_margin
= 5;
28318 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28319 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28320 When point is less than `hscroll-margin' columns from the window
28321 edge, automatic hscrolling will scroll the window by the amount of columns
28322 determined by this variable. If its value is a positive integer, scroll that
28323 many columns. If it's a positive floating-point number, it specifies the
28324 fraction of the window's width to scroll. If it's nil or zero, point will be
28325 centered horizontally after the scroll. Any other value, including negative
28326 numbers, are treated as if the value were zero.
28328 Automatic hscrolling always moves point outside the scroll margin, so if
28329 point was more than scroll step columns inside the margin, the window will
28330 scroll more than the value given by the scroll step.
28332 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28333 and `scroll-right' overrides this variable's effect. */);
28334 Vhscroll_step
= make_number (0);
28336 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28337 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28338 Bind this around calls to `message' to let it take effect. */);
28339 message_truncate_lines
= 0;
28341 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28342 doc
: /* Normal hook run to update the menu bar definitions.
28343 Redisplay runs this hook before it redisplays the menu bar.
28344 This is used to update submenus such as Buffers,
28345 whose contents depend on various data. */);
28346 Vmenu_bar_update_hook
= Qnil
;
28348 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28349 doc
: /* Frame for which we are updating a menu.
28350 The enable predicate for a menu binding should check this variable. */);
28351 Vmenu_updating_frame
= Qnil
;
28353 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28354 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28355 inhibit_menubar_update
= 0;
28357 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28358 doc
: /* Prefix prepended to all continuation lines at display time.
28359 The value may be a string, an image, or a stretch-glyph; it is
28360 interpreted in the same way as the value of a `display' text property.
28362 This variable is overridden by any `wrap-prefix' text or overlay
28365 To add a prefix to non-continuation lines, use `line-prefix'. */);
28366 Vwrap_prefix
= Qnil
;
28367 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28368 Fmake_variable_buffer_local (Qwrap_prefix
);
28370 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28371 doc
: /* Prefix prepended to all non-continuation lines at display time.
28372 The value may be a string, an image, or a stretch-glyph; it is
28373 interpreted in the same way as the value of a `display' text property.
28375 This variable is overridden by any `line-prefix' text or overlay
28378 To add a prefix to continuation lines, use `wrap-prefix'. */);
28379 Vline_prefix
= Qnil
;
28380 DEFSYM (Qline_prefix
, "line-prefix");
28381 Fmake_variable_buffer_local (Qline_prefix
);
28383 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28384 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28385 inhibit_eval_during_redisplay
= 0;
28387 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28388 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28389 inhibit_free_realized_faces
= 0;
28392 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28393 doc
: /* Inhibit try_window_id display optimization. */);
28394 inhibit_try_window_id
= 0;
28396 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28397 doc
: /* Inhibit try_window_reusing display optimization. */);
28398 inhibit_try_window_reusing
= 0;
28400 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28401 doc
: /* Inhibit try_cursor_movement display optimization. */);
28402 inhibit_try_cursor_movement
= 0;
28403 #endif /* GLYPH_DEBUG */
28405 DEFVAR_INT ("overline-margin", overline_margin
,
28406 doc
: /* *Space between overline and text, in pixels.
28407 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28408 margin to the caracter height. */);
28409 overline_margin
= 2;
28411 DEFVAR_INT ("underline-minimum-offset",
28412 underline_minimum_offset
,
28413 doc
: /* Minimum distance between baseline and underline.
28414 This can improve legibility of underlined text at small font sizes,
28415 particularly when using variable `x-use-underline-position-properties'
28416 with fonts that specify an UNDERLINE_POSITION relatively close to the
28417 baseline. The default value is 1. */);
28418 underline_minimum_offset
= 1;
28420 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28421 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28422 This feature only works when on a window system that can change
28423 cursor shapes. */);
28424 display_hourglass_p
= 1;
28426 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28427 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28428 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28430 hourglass_atimer
= NULL
;
28431 hourglass_shown_p
= 0;
28433 DEFSYM (Qglyphless_char
, "glyphless-char");
28434 DEFSYM (Qhex_code
, "hex-code");
28435 DEFSYM (Qempty_box
, "empty-box");
28436 DEFSYM (Qthin_space
, "thin-space");
28437 DEFSYM (Qzero_width
, "zero-width");
28439 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28440 /* Intern this now in case it isn't already done.
28441 Setting this variable twice is harmless.
28442 But don't staticpro it here--that is done in alloc.c. */
28443 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28444 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28446 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28447 doc
: /* Char-table defining glyphless characters.
28448 Each element, if non-nil, should be one of the following:
28449 an ASCII acronym string: display this string in a box
28450 `hex-code': display the hexadecimal code of a character in a box
28451 `empty-box': display as an empty box
28452 `thin-space': display as 1-pixel width space
28453 `zero-width': don't display
28454 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28455 display method for graphical terminals and text terminals respectively.
28456 GRAPHICAL and TEXT should each have one of the values listed above.
28458 The char-table has one extra slot to control the display of a character for
28459 which no font is found. This slot only takes effect on graphical terminals.
28460 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28461 `thin-space'. The default is `empty-box'. */);
28462 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28463 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28468 /* Initialize this module when Emacs starts. */
28473 current_header_line_height
= current_mode_line_height
= -1;
28475 CHARPOS (this_line_start_pos
) = 0;
28477 if (!noninteractive
)
28479 struct window
*m
= XWINDOW (minibuf_window
);
28480 Lisp_Object frame
= m
->frame
;
28481 struct frame
*f
= XFRAME (frame
);
28482 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28483 struct window
*r
= XWINDOW (root
);
28486 echo_area_window
= minibuf_window
;
28488 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28489 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28490 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28491 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28492 XSETFASTINT (m
->total_lines
, 1);
28493 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28495 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28496 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28497 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28499 /* The default ellipsis glyphs `...'. */
28500 for (i
= 0; i
< 3; ++i
)
28501 default_invis_vector
[i
] = make_number ('.');
28505 /* Allocate the buffer for frame titles.
28506 Also used for `format-mode-line'. */
28508 mode_line_noprop_buf
= (char *) xmalloc (size
);
28509 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28510 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28511 mode_line_target
= MODE_LINE_DISPLAY
;
28514 help_echo_showing_p
= 0;
28517 /* Since w32 does not support atimers, it defines its own implementation of
28518 the following three functions in w32fns.c. */
28521 /* Platform-independent portion of hourglass implementation. */
28523 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28525 hourglass_started (void)
28527 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28530 /* Cancel a currently active hourglass timer, and start a new one. */
28532 start_hourglass (void)
28534 #if defined (HAVE_WINDOW_SYSTEM)
28536 int secs
= DEFAULT_HOURGLASS_DELAY
, usecs
= 0;
28538 cancel_hourglass ();
28540 if (NUMBERP (Vhourglass_delay
))
28542 double duration
= extract_float (Vhourglass_delay
);
28544 duration_to_sec_usec (duration
, &secs
, &usecs
);
28547 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28548 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28549 show_hourglass
, NULL
);
28554 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28557 cancel_hourglass (void)
28559 #if defined (HAVE_WINDOW_SYSTEM)
28560 if (hourglass_atimer
)
28562 cancel_atimer (hourglass_atimer
);
28563 hourglass_atimer
= NULL
;
28566 if (hourglass_shown_p
)
28570 #endif /* ! WINDOWSNT */