1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
284 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT, or the underlying buffer
387 or string character, is a space or a TAB character. This is used
388 to determine where word wrapping can occur. */
390 #define IT_DISPLAYING_WHITESPACE(it) \
391 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
392 || ((STRINGP (it->string) \
393 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
394 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
396 && (it->s[IT_BYTEPOS (*it)] == ' ' \
397 || it->s[IT_BYTEPOS (*it)] == '\t')) \
398 || (IT_BYTEPOS (*it) < ZV_BYTE \
399 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
400 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
402 /* Name of the face used to highlight trailing whitespace. */
404 static Lisp_Object Qtrailing_whitespace
;
406 /* Name and number of the face used to highlight escape glyphs. */
408 static Lisp_Object Qescape_glyph
;
410 /* Name and number of the face used to highlight non-breaking spaces. */
412 static Lisp_Object Qnobreak_space
;
414 /* The symbol `image' which is the car of the lists used to represent
415 images in Lisp. Also a tool bar style. */
419 /* The image map types. */
421 static Lisp_Object QCpointer
;
422 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
424 /* Tool bar styles */
425 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
427 /* Non-zero means print newline to stdout before next mini-buffer
430 int noninteractive_need_newline
;
432 /* Non-zero means print newline to message log before next message. */
434 static int message_log_need_newline
;
436 /* Three markers that message_dolog uses.
437 It could allocate them itself, but that causes trouble
438 in handling memory-full errors. */
439 static Lisp_Object message_dolog_marker1
;
440 static Lisp_Object message_dolog_marker2
;
441 static Lisp_Object message_dolog_marker3
;
443 /* The buffer position of the first character appearing entirely or
444 partially on the line of the selected window which contains the
445 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
446 redisplay optimization in redisplay_internal. */
448 static struct text_pos this_line_start_pos
;
450 /* Number of characters past the end of the line above, including the
451 terminating newline. */
453 static struct text_pos this_line_end_pos
;
455 /* The vertical positions and the height of this line. */
457 static int this_line_vpos
;
458 static int this_line_y
;
459 static int this_line_pixel_height
;
461 /* X position at which this display line starts. Usually zero;
462 negative if first character is partially visible. */
464 static int this_line_start_x
;
466 /* The smallest character position seen by move_it_* functions as they
467 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
468 hscrolled lines, see display_line. */
470 static struct text_pos this_line_min_pos
;
472 /* Buffer that this_line_.* variables are referring to. */
474 static struct buffer
*this_line_buffer
;
477 /* Values of those variables at last redisplay are stored as
478 properties on `overlay-arrow-position' symbol. However, if
479 Voverlay_arrow_position is a marker, last-arrow-position is its
480 numerical position. */
482 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
484 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
485 properties on a symbol in overlay-arrow-variable-list. */
487 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
489 Lisp_Object Qmenu_bar_update_hook
;
491 /* Nonzero if an overlay arrow has been displayed in this window. */
493 static int overlay_arrow_seen
;
495 /* Number of windows showing the buffer of the selected window (or
496 another buffer with the same base buffer). keyboard.c refers to
501 /* Vector containing glyphs for an ellipsis `...'. */
503 static Lisp_Object default_invis_vector
[3];
505 /* This is the window where the echo area message was displayed. It
506 is always a mini-buffer window, but it may not be the same window
507 currently active as a mini-buffer. */
509 Lisp_Object echo_area_window
;
511 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
512 pushes the current message and the value of
513 message_enable_multibyte on the stack, the function restore_message
514 pops the stack and displays MESSAGE again. */
516 static Lisp_Object Vmessage_stack
;
518 /* Nonzero means multibyte characters were enabled when the echo area
519 message was specified. */
521 static int message_enable_multibyte
;
523 /* Nonzero if we should redraw the mode lines on the next redisplay. */
525 int update_mode_lines
;
527 /* Nonzero if window sizes or contents have changed since last
528 redisplay that finished. */
530 int windows_or_buffers_changed
;
532 /* Nonzero means a frame's cursor type has been changed. */
534 int cursor_type_changed
;
536 /* Nonzero after display_mode_line if %l was used and it displayed a
539 static int line_number_displayed
;
541 /* The name of the *Messages* buffer, a string. */
543 static Lisp_Object Vmessages_buffer_name
;
545 /* Current, index 0, and last displayed echo area message. Either
546 buffers from echo_buffers, or nil to indicate no message. */
548 Lisp_Object echo_area_buffer
[2];
550 /* The buffers referenced from echo_area_buffer. */
552 static Lisp_Object echo_buffer
[2];
554 /* A vector saved used in with_area_buffer to reduce consing. */
556 static Lisp_Object Vwith_echo_area_save_vector
;
558 /* Non-zero means display_echo_area should display the last echo area
559 message again. Set by redisplay_preserve_echo_area. */
561 static int display_last_displayed_message_p
;
563 /* Nonzero if echo area is being used by print; zero if being used by
566 static int message_buf_print
;
568 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
570 static Lisp_Object Qinhibit_menubar_update
;
571 static Lisp_Object Qmessage_truncate_lines
;
573 /* Set to 1 in clear_message to make redisplay_internal aware
574 of an emptied echo area. */
576 static int message_cleared_p
;
578 /* A scratch glyph row with contents used for generating truncation
579 glyphs. Also used in direct_output_for_insert. */
581 #define MAX_SCRATCH_GLYPHS 100
582 static struct glyph_row scratch_glyph_row
;
583 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
585 /* Ascent and height of the last line processed by move_it_to. */
587 static int last_max_ascent
, last_height
;
589 /* Non-zero if there's a help-echo in the echo area. */
591 int help_echo_showing_p
;
593 /* If >= 0, computed, exact values of mode-line and header-line height
594 to use in the macros CURRENT_MODE_LINE_HEIGHT and
595 CURRENT_HEADER_LINE_HEIGHT. */
597 int current_mode_line_height
, current_header_line_height
;
599 /* The maximum distance to look ahead for text properties. Values
600 that are too small let us call compute_char_face and similar
601 functions too often which is expensive. Values that are too large
602 let us call compute_char_face and alike too often because we
603 might not be interested in text properties that far away. */
605 #define TEXT_PROP_DISTANCE_LIMIT 100
607 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
608 iterator state and later restore it. This is needed because the
609 bidi iterator on bidi.c keeps a stacked cache of its states, which
610 is really a singleton. When we use scratch iterator objects to
611 move around the buffer, we can cause the bidi cache to be pushed or
612 popped, and therefore we need to restore the cache state when we
613 return to the original iterator. */
614 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
617 bidi_unshelve_cache (CACHE, 1); \
619 CACHE = bidi_shelve_cache (); \
622 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
624 if (pITORIG != pITCOPY) \
625 *(pITORIG) = *(pITCOPY); \
626 bidi_unshelve_cache (CACHE, 0); \
632 /* Non-zero means print traces of redisplay if compiled with
633 GLYPH_DEBUG defined. */
635 int trace_redisplay_p
;
637 #endif /* GLYPH_DEBUG */
639 #ifdef DEBUG_TRACE_MOVE
640 /* Non-zero means trace with TRACE_MOVE to stderr. */
643 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
645 #define TRACE_MOVE(x) (void) 0
648 static Lisp_Object Qauto_hscroll_mode
;
650 /* Buffer being redisplayed -- for redisplay_window_error. */
652 static struct buffer
*displayed_buffer
;
654 /* Value returned from text property handlers (see below). */
659 HANDLED_RECOMPUTE_PROPS
,
660 HANDLED_OVERLAY_STRING_CONSUMED
,
664 /* A description of text properties that redisplay is interested
669 /* The name of the property. */
672 /* A unique index for the property. */
675 /* A handler function called to set up iterator IT from the property
676 at IT's current position. Value is used to steer handle_stop. */
677 enum prop_handled (*handler
) (struct it
*it
);
680 static enum prop_handled
handle_face_prop (struct it
*);
681 static enum prop_handled
handle_invisible_prop (struct it
*);
682 static enum prop_handled
handle_display_prop (struct it
*);
683 static enum prop_handled
handle_composition_prop (struct it
*);
684 static enum prop_handled
handle_overlay_change (struct it
*);
685 static enum prop_handled
handle_fontified_prop (struct it
*);
687 /* Properties handled by iterators. */
689 static struct props it_props
[] =
691 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
692 /* Handle `face' before `display' because some sub-properties of
693 `display' need to know the face. */
694 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
695 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
696 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
697 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
701 /* Value is the position described by X. If X is a marker, value is
702 the marker_position of X. Otherwise, value is X. */
704 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
706 /* Enumeration returned by some move_it_.* functions internally. */
710 /* Not used. Undefined value. */
713 /* Move ended at the requested buffer position or ZV. */
714 MOVE_POS_MATCH_OR_ZV
,
716 /* Move ended at the requested X pixel position. */
719 /* Move within a line ended at the end of a line that must be
723 /* Move within a line ended at the end of a line that would
724 be displayed truncated. */
727 /* Move within a line ended at a line end. */
731 /* This counter is used to clear the face cache every once in a while
732 in redisplay_internal. It is incremented for each redisplay.
733 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
736 #define CLEAR_FACE_CACHE_COUNT 500
737 static int clear_face_cache_count
;
739 /* Similarly for the image cache. */
741 #ifdef HAVE_WINDOW_SYSTEM
742 #define CLEAR_IMAGE_CACHE_COUNT 101
743 static int clear_image_cache_count
;
745 /* Null glyph slice */
746 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
749 /* Non-zero while redisplay_internal is in progress. */
753 static Lisp_Object Qinhibit_free_realized_faces
;
754 static Lisp_Object Qmode_line_default_help_echo
;
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 /* Non-zero means an hourglass cursor is currently shown. */
771 int hourglass_shown_p
;
773 /* If non-null, an asynchronous timer that, when it expires, displays
774 an hourglass cursor on all frames. */
775 struct atimer
*hourglass_atimer
;
777 /* Name of the face used to display glyphless characters. */
778 Lisp_Object Qglyphless_char
;
780 /* Symbol for the purpose of Vglyphless_char_display. */
781 static Lisp_Object Qglyphless_char_display
;
783 /* Method symbols for Vglyphless_char_display. */
784 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
786 /* Default pixel width of `thin-space' display method. */
787 #define THIN_SPACE_WIDTH 1
789 /* Default number of seconds to wait before displaying an hourglass
791 #define DEFAULT_HOURGLASS_DELAY 1
794 /* Function prototypes. */
796 static void setup_for_ellipsis (struct it
*, int);
797 static void set_iterator_to_next (struct it
*, int);
798 static void mark_window_display_accurate_1 (struct window
*, int);
799 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
800 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
801 static int cursor_row_p (struct glyph_row
*);
802 static int redisplay_mode_lines (Lisp_Object
, int);
803 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
805 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
807 static void handle_line_prefix (struct it
*);
809 static void pint2str (char *, int, ptrdiff_t);
810 static void pint2hrstr (char *, int, ptrdiff_t);
811 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
813 static void reconsider_clip_changes (struct window
*, struct buffer
*);
814 static int text_outside_line_unchanged_p (struct window
*,
815 ptrdiff_t, ptrdiff_t);
816 static void store_mode_line_noprop_char (char);
817 static int store_mode_line_noprop (const char *, int, int);
818 static void handle_stop (struct it
*);
819 static void handle_stop_backwards (struct it
*, ptrdiff_t);
820 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
821 static void ensure_echo_area_buffers (void);
822 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
823 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
824 static int with_echo_area_buffer (struct window
*, int,
825 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
826 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
827 static void clear_garbaged_frames (void);
828 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
829 static void pop_message (void);
830 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
831 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
832 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
833 static int display_echo_area (struct window
*);
834 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
835 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
836 static Lisp_Object
unwind_redisplay (Lisp_Object
);
837 static int string_char_and_length (const unsigned char *, int *);
838 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
840 static int compute_window_start_on_continuation_line (struct window
*);
841 static Lisp_Object
safe_eval_handler (Lisp_Object
);
842 static void insert_left_trunc_glyphs (struct it
*);
843 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
845 static void extend_face_to_end_of_line (struct it
*);
846 static int append_space_for_newline (struct it
*, int);
847 static int cursor_row_fully_visible_p (struct window
*, int, int);
848 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
849 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
850 static int trailing_whitespace_p (ptrdiff_t);
851 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
852 static void push_it (struct it
*, struct text_pos
*);
853 static void iterate_out_of_display_property (struct it
*);
854 static void pop_it (struct it
*);
855 static void sync_frame_with_window_matrix_rows (struct window
*);
856 static void select_frame_for_redisplay (Lisp_Object
);
857 static void redisplay_internal (void);
858 static int echo_area_display (int);
859 static void redisplay_windows (Lisp_Object
);
860 static void redisplay_window (Lisp_Object
, int);
861 static Lisp_Object
redisplay_window_error (Lisp_Object
);
862 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
863 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
864 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
865 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
867 static int update_menu_bar (struct frame
*, int, int);
868 static int try_window_reusing_current_matrix (struct window
*);
869 static int try_window_id (struct window
*);
870 static int display_line (struct it
*);
871 static int display_mode_lines (struct window
*);
872 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
873 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
874 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
875 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
876 static void display_menu_bar (struct window
*);
877 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
879 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
880 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
881 static void compute_line_metrics (struct it
*);
882 static void run_redisplay_end_trigger_hook (struct it
*);
883 static int get_overlay_strings (struct it
*, ptrdiff_t);
884 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
885 static void next_overlay_string (struct it
*);
886 static void reseat (struct it
*, struct text_pos
, int);
887 static void reseat_1 (struct it
*, struct text_pos
, int);
888 static void back_to_previous_visible_line_start (struct it
*);
889 void reseat_at_previous_visible_line_start (struct it
*);
890 static void reseat_at_next_visible_line_start (struct it
*, int);
891 static int next_element_from_ellipsis (struct it
*);
892 static int next_element_from_display_vector (struct it
*);
893 static int next_element_from_string (struct it
*);
894 static int next_element_from_c_string (struct it
*);
895 static int next_element_from_buffer (struct it
*);
896 static int next_element_from_composition (struct it
*);
897 static int next_element_from_image (struct it
*);
898 static int next_element_from_stretch (struct it
*);
899 static void load_overlay_strings (struct it
*, ptrdiff_t);
900 static int init_from_display_pos (struct it
*, struct window
*,
901 struct display_pos
*);
902 static void reseat_to_string (struct it
*, const char *,
903 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
904 static int get_next_display_element (struct it
*);
905 static enum move_it_result
906 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
907 enum move_operation_enum
);
908 void move_it_vertically_backward (struct it
*, int);
909 static void init_to_row_start (struct it
*, struct window
*,
911 static int init_to_row_end (struct it
*, struct window
*,
913 static void back_to_previous_line_start (struct it
*);
914 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
915 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
916 Lisp_Object
, ptrdiff_t);
917 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
918 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
919 static ptrdiff_t number_of_chars (const char *, int);
920 static void compute_stop_pos (struct it
*);
921 static void compute_string_pos (struct text_pos
*, struct text_pos
,
923 static int face_before_or_after_it_pos (struct it
*, int);
924 static ptrdiff_t next_overlay_change (ptrdiff_t);
925 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
926 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
927 static int handle_single_display_spec (struct it
*, Lisp_Object
,
928 Lisp_Object
, Lisp_Object
,
929 struct text_pos
*, ptrdiff_t, int, int);
930 static int underlying_face_id (struct it
*);
931 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
934 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
935 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
937 #ifdef HAVE_WINDOW_SYSTEM
939 static void x_consider_frame_title (Lisp_Object
);
940 static int tool_bar_lines_needed (struct frame
*, int *);
941 static void update_tool_bar (struct frame
*, int);
942 static void build_desired_tool_bar_string (struct frame
*f
);
943 static int redisplay_tool_bar (struct frame
*);
944 static void display_tool_bar_line (struct it
*, int);
945 static void notice_overwritten_cursor (struct window
*,
948 static void append_stretch_glyph (struct it
*, Lisp_Object
,
952 #endif /* HAVE_WINDOW_SYSTEM */
954 static void produce_special_glyphs (struct it
*, enum display_element_type
);
955 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
956 static int coords_in_mouse_face_p (struct window
*, int, int);
960 /***********************************************************************
961 Window display dimensions
962 ***********************************************************************/
964 /* Return the bottom boundary y-position for text lines in window W.
965 This is the first y position at which a line cannot start.
966 It is relative to the top of the window.
968 This is the height of W minus the height of a mode line, if any. */
971 window_text_bottom_y (struct window
*w
)
973 int height
= WINDOW_TOTAL_HEIGHT (w
);
975 if (WINDOW_WANTS_MODELINE_P (w
))
976 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
980 /* Return the pixel width of display area AREA of window W. AREA < 0
981 means return the total width of W, not including fringes to
982 the left and right of the window. */
985 window_box_width (struct window
*w
, int area
)
987 int cols
= XFASTINT (w
->total_cols
);
990 if (!w
->pseudo_window_p
)
992 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
994 if (area
== TEXT_AREA
)
996 if (INTEGERP (w
->left_margin_cols
))
997 cols
-= XFASTINT (w
->left_margin_cols
);
998 if (INTEGERP (w
->right_margin_cols
))
999 cols
-= XFASTINT (w
->right_margin_cols
);
1000 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1002 else if (area
== LEFT_MARGIN_AREA
)
1004 cols
= (INTEGERP (w
->left_margin_cols
)
1005 ? XFASTINT (w
->left_margin_cols
) : 0);
1008 else if (area
== RIGHT_MARGIN_AREA
)
1010 cols
= (INTEGERP (w
->right_margin_cols
)
1011 ? XFASTINT (w
->right_margin_cols
) : 0);
1016 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1020 /* Return the pixel height of the display area of window W, not
1021 including mode lines of W, if any. */
1024 window_box_height (struct window
*w
)
1026 struct frame
*f
= XFRAME (w
->frame
);
1027 int height
= WINDOW_TOTAL_HEIGHT (w
);
1029 eassert (height
>= 0);
1031 /* Note: the code below that determines the mode-line/header-line
1032 height is essentially the same as that contained in the macro
1033 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1034 the appropriate glyph row has its `mode_line_p' flag set,
1035 and if it doesn't, uses estimate_mode_line_height instead. */
1037 if (WINDOW_WANTS_MODELINE_P (w
))
1039 struct glyph_row
*ml_row
1040 = (w
->current_matrix
&& w
->current_matrix
->rows
1041 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1043 if (ml_row
&& ml_row
->mode_line_p
)
1044 height
-= ml_row
->height
;
1046 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1049 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1051 struct glyph_row
*hl_row
1052 = (w
->current_matrix
&& w
->current_matrix
->rows
1053 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1055 if (hl_row
&& hl_row
->mode_line_p
)
1056 height
-= hl_row
->height
;
1058 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1061 /* With a very small font and a mode-line that's taller than
1062 default, we might end up with a negative height. */
1063 return max (0, height
);
1066 /* Return the window-relative coordinate of the left edge of display
1067 area AREA of window W. AREA < 0 means return the left edge of the
1068 whole window, to the right of the left fringe of W. */
1071 window_box_left_offset (struct window
*w
, int area
)
1075 if (w
->pseudo_window_p
)
1078 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1080 if (area
== TEXT_AREA
)
1081 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1082 + window_box_width (w
, LEFT_MARGIN_AREA
));
1083 else if (area
== RIGHT_MARGIN_AREA
)
1084 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1085 + window_box_width (w
, LEFT_MARGIN_AREA
)
1086 + window_box_width (w
, TEXT_AREA
)
1087 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1089 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1090 else if (area
== LEFT_MARGIN_AREA
1091 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1092 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1098 /* Return the window-relative coordinate of the right edge of display
1099 area AREA of window W. AREA < 0 means return the right edge of the
1100 whole window, to the left of the right fringe of W. */
1103 window_box_right_offset (struct window
*w
, int area
)
1105 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1108 /* Return the frame-relative coordinate of the left edge of display
1109 area AREA of window W. AREA < 0 means return the left edge of the
1110 whole window, to the right of the left fringe of W. */
1113 window_box_left (struct window
*w
, int area
)
1115 struct frame
*f
= XFRAME (w
->frame
);
1118 if (w
->pseudo_window_p
)
1119 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1121 x
= (WINDOW_LEFT_EDGE_X (w
)
1122 + window_box_left_offset (w
, area
));
1128 /* Return the frame-relative coordinate of the right edge of display
1129 area AREA of window W. AREA < 0 means return the right edge of the
1130 whole window, to the left of the right fringe of W. */
1133 window_box_right (struct window
*w
, int area
)
1135 return window_box_left (w
, area
) + window_box_width (w
, area
);
1138 /* Get the bounding box of the display area AREA of window W, without
1139 mode lines, in frame-relative coordinates. AREA < 0 means the
1140 whole window, not including the left and right fringes of
1141 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1142 coordinates of the upper-left corner of the box. Return in
1143 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1146 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1147 int *box_width
, int *box_height
)
1150 *box_width
= window_box_width (w
, area
);
1152 *box_height
= window_box_height (w
);
1154 *box_x
= window_box_left (w
, area
);
1157 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1158 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1159 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1164 /* Get the bounding box of the display area AREA of window W, without
1165 mode lines. AREA < 0 means the whole window, not including the
1166 left and right fringe of the window. Return in *TOP_LEFT_X
1167 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1168 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1169 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1173 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1174 int *bottom_right_x
, int *bottom_right_y
)
1176 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1178 *bottom_right_x
+= *top_left_x
;
1179 *bottom_right_y
+= *top_left_y
;
1184 /***********************************************************************
1186 ***********************************************************************/
1188 /* Return the bottom y-position of the line the iterator IT is in.
1189 This can modify IT's settings. */
1192 line_bottom_y (struct it
*it
)
1194 int line_height
= it
->max_ascent
+ it
->max_descent
;
1195 int line_top_y
= it
->current_y
;
1197 if (line_height
== 0)
1200 line_height
= last_height
;
1201 else if (IT_CHARPOS (*it
) < ZV
)
1203 move_it_by_lines (it
, 1);
1204 line_height
= (it
->max_ascent
|| it
->max_descent
1205 ? it
->max_ascent
+ it
->max_descent
1210 struct glyph_row
*row
= it
->glyph_row
;
1212 /* Use the default character height. */
1213 it
->glyph_row
= NULL
;
1214 it
->what
= IT_CHARACTER
;
1217 PRODUCE_GLYPHS (it
);
1218 line_height
= it
->ascent
+ it
->descent
;
1219 it
->glyph_row
= row
;
1223 return line_top_y
+ line_height
;
1226 /* Subroutine of pos_visible_p below. Extracts a display string, if
1227 any, from the display spec given as its argument. */
1229 string_from_display_spec (Lisp_Object spec
)
1233 while (CONSP (spec
))
1235 if (STRINGP (XCAR (spec
)))
1240 else if (VECTORP (spec
))
1244 for (i
= 0; i
< ASIZE (spec
); i
++)
1246 if (STRINGP (AREF (spec
, i
)))
1247 return AREF (spec
, i
);
1256 /* Limit insanely large values of W->hscroll on frame F to the largest
1257 value that will still prevent first_visible_x and last_visible_x of
1258 'struct it' from overflowing an int. */
1260 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1262 ptrdiff_t window_hscroll
= w
->hscroll
;
1263 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1264 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1266 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1267 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1269 return window_hscroll
;
1272 /* Return 1 if position CHARPOS is visible in window W.
1273 CHARPOS < 0 means return info about WINDOW_END position.
1274 If visible, set *X and *Y to pixel coordinates of top left corner.
1275 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1276 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1279 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1280 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1283 void *itdata
= bidi_shelve_cache ();
1284 struct text_pos top
;
1286 struct buffer
*old_buffer
= NULL
;
1288 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1291 if (XBUFFER (w
->buffer
) != current_buffer
)
1293 old_buffer
= current_buffer
;
1294 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1297 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1298 /* Scrolling a minibuffer window via scroll bar when the echo area
1299 shows long text sometimes resets the minibuffer contents behind
1301 if (CHARPOS (top
) > ZV
)
1302 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1304 /* Compute exact mode line heights. */
1305 if (WINDOW_WANTS_MODELINE_P (w
))
1306 current_mode_line_height
1307 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1308 BVAR (current_buffer
, mode_line_format
));
1310 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1311 current_header_line_height
1312 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1313 BVAR (current_buffer
, header_line_format
));
1315 start_display (&it
, w
, top
);
1316 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1317 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1320 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1321 && IT_CHARPOS (it
) >= charpos
)
1322 /* When scanning backwards under bidi iteration, move_it_to
1323 stops at or _before_ CHARPOS, because it stops at or to
1324 the _right_ of the character at CHARPOS. */
1325 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1326 && IT_CHARPOS (it
) <= charpos
)))
1328 /* We have reached CHARPOS, or passed it. How the call to
1329 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1330 or covered by a display property, move_it_to stops at the end
1331 of the invisible text, to the right of CHARPOS. (ii) If
1332 CHARPOS is in a display vector, move_it_to stops on its last
1334 int top_x
= it
.current_x
;
1335 int top_y
= it
.current_y
;
1336 /* Calling line_bottom_y may change it.method, it.position, etc. */
1337 enum it_method it_method
= it
.method
;
1338 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1339 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1341 if (top_y
< window_top_y
)
1342 visible_p
= bottom_y
> window_top_y
;
1343 else if (top_y
< it
.last_visible_y
)
1345 if (bottom_y
>= it
.last_visible_y
1346 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1347 && IT_CHARPOS (it
) < charpos
)
1349 /* When the last line of the window is scanned backwards
1350 under bidi iteration, we could be duped into thinking
1351 that we have passed CHARPOS, when in fact move_it_to
1352 simply stopped short of CHARPOS because it reached
1353 last_visible_y. To see if that's what happened, we call
1354 move_it_to again with a slightly larger vertical limit,
1355 and see if it actually moved vertically; if it did, we
1356 didn't really reach CHARPOS, which is beyond window end. */
1357 struct it save_it
= it
;
1358 /* Why 10? because we don't know how many canonical lines
1359 will the height of the next line(s) be. So we guess. */
1360 int ten_more_lines
=
1361 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1363 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1364 MOVE_TO_POS
| MOVE_TO_Y
);
1365 if (it
.current_y
> top_y
)
1372 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1374 /* We stopped on the last glyph of a display vector.
1375 Try and recompute. Hack alert! */
1376 if (charpos
< 2 || top
.charpos
>= charpos
)
1377 top_x
= it
.glyph_row
->x
;
1381 start_display (&it2
, w
, top
);
1382 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1383 get_next_display_element (&it2
);
1384 PRODUCE_GLYPHS (&it2
);
1385 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1386 || it2
.current_x
> it2
.last_visible_x
)
1387 top_x
= it
.glyph_row
->x
;
1390 top_x
= it2
.current_x
;
1391 top_y
= it2
.current_y
;
1395 else if (IT_CHARPOS (it
) != charpos
)
1397 Lisp_Object cpos
= make_number (charpos
);
1398 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1399 Lisp_Object string
= string_from_display_spec (spec
);
1400 int newline_in_string
= 0;
1402 if (STRINGP (string
))
1404 const char *s
= SSDATA (string
);
1405 const char *e
= s
+ SBYTES (string
);
1410 newline_in_string
= 1;
1415 /* The tricky code below is needed because there's a
1416 discrepancy between move_it_to and how we set cursor
1417 when the display line ends in a newline from a
1418 display string. move_it_to will stop _after_ such
1419 display strings, whereas set_cursor_from_row
1420 conspires with cursor_row_p to place the cursor on
1421 the first glyph produced from the display string. */
1423 /* We have overshoot PT because it is covered by a
1424 display property whose value is a string. If the
1425 string includes embedded newlines, we are also in the
1426 wrong display line. Backtrack to the correct line,
1427 where the display string begins. */
1428 if (newline_in_string
)
1430 Lisp_Object startpos
, endpos
;
1431 EMACS_INT start
, end
;
1435 /* Find the first and the last buffer positions
1436 covered by the display string. */
1438 Fnext_single_char_property_change (cpos
, Qdisplay
,
1441 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1443 start
= XFASTINT (startpos
);
1444 end
= XFASTINT (endpos
);
1445 /* Move to the last buffer position before the
1446 display property. */
1447 start_display (&it3
, w
, top
);
1448 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1449 /* Move forward one more line if the position before
1450 the display string is a newline or if it is the
1451 rightmost character on a line that is
1452 continued or word-wrapped. */
1453 if (it3
.method
== GET_FROM_BUFFER
1455 move_it_by_lines (&it3
, 1);
1456 else if (move_it_in_display_line_to (&it3
, -1,
1460 == MOVE_LINE_CONTINUED
)
1462 move_it_by_lines (&it3
, 1);
1463 /* When we are under word-wrap, the #$@%!
1464 move_it_by_lines moves 2 lines, so we need to
1466 if (it3
.line_wrap
== WORD_WRAP
)
1467 move_it_by_lines (&it3
, -1);
1470 /* Record the vertical coordinate of the display
1471 line where we wound up. */
1472 top_y
= it3
.current_y
;
1475 /* When characters are reordered for display,
1476 the character displayed to the left of the
1477 display string could be _after_ the display
1478 property in the logical order. Use the
1479 smallest vertical position of these two. */
1480 start_display (&it3
, w
, top
);
1481 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1482 if (it3
.current_y
< top_y
)
1483 top_y
= it3
.current_y
;
1485 /* Move from the top of the window to the beginning
1486 of the display line where the display string
1488 start_display (&it3
, w
, top
);
1489 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1490 /* If it3_moved stays zero after the 'while' loop
1491 below, that means we already were at a newline
1492 before the loop (e.g., the display string begins
1493 with a newline), so we don't need to (and cannot)
1494 inspect the glyphs of it3.glyph_row, because
1495 PRODUCE_GLYPHS will not produce anything for a
1496 newline, and thus it3.glyph_row stays at its
1497 stale content it got at top of the window. */
1499 /* Finally, advance the iterator until we hit the
1500 first display element whose character position is
1501 CHARPOS, or until the first newline from the
1502 display string, which signals the end of the
1504 while (get_next_display_element (&it3
))
1506 PRODUCE_GLYPHS (&it3
);
1507 if (IT_CHARPOS (it3
) == charpos
1508 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1511 set_iterator_to_next (&it3
, 0);
1513 top_x
= it3
.current_x
- it3
.pixel_width
;
1514 /* Normally, we would exit the above loop because we
1515 found the display element whose character
1516 position is CHARPOS. For the contingency that we
1517 didn't, and stopped at the first newline from the
1518 display string, move back over the glyphs
1519 produced from the string, until we find the
1520 rightmost glyph not from the string. */
1522 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1524 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1525 + it3
.glyph_row
->used
[TEXT_AREA
];
1527 while (EQ ((g
- 1)->object
, string
))
1530 top_x
-= g
->pixel_width
;
1532 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1533 + it3
.glyph_row
->used
[TEXT_AREA
]);
1539 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1540 *rtop
= max (0, window_top_y
- top_y
);
1541 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1542 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1543 - max (top_y
, window_top_y
)));
1549 /* We were asked to provide info about WINDOW_END. */
1551 void *it2data
= NULL
;
1553 SAVE_IT (it2
, it
, it2data
);
1554 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1555 move_it_by_lines (&it
, 1);
1556 if (charpos
< IT_CHARPOS (it
)
1557 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1560 RESTORE_IT (&it2
, &it2
, it2data
);
1561 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1563 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1564 *rtop
= max (0, -it2
.current_y
);
1565 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1566 - it
.last_visible_y
));
1567 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1569 - max (it2
.current_y
,
1570 WINDOW_HEADER_LINE_HEIGHT (w
))));
1574 bidi_unshelve_cache (it2data
, 1);
1576 bidi_unshelve_cache (itdata
, 0);
1579 set_buffer_internal_1 (old_buffer
);
1581 current_header_line_height
= current_mode_line_height
= -1;
1583 if (visible_p
&& w
->hscroll
> 0)
1585 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1586 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1589 /* Debugging code. */
1591 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1592 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1594 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1601 /* Return the next character from STR. Return in *LEN the length of
1602 the character. This is like STRING_CHAR_AND_LENGTH but never
1603 returns an invalid character. If we find one, we return a `?', but
1604 with the length of the invalid character. */
1607 string_char_and_length (const unsigned char *str
, int *len
)
1611 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1612 if (!CHAR_VALID_P (c
))
1613 /* We may not change the length here because other places in Emacs
1614 don't use this function, i.e. they silently accept invalid
1623 /* Given a position POS containing a valid character and byte position
1624 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1626 static struct text_pos
1627 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1629 eassert (STRINGP (string
) && nchars
>= 0);
1631 if (STRING_MULTIBYTE (string
))
1633 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1638 string_char_and_length (p
, &len
);
1641 BYTEPOS (pos
) += len
;
1645 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1651 /* Value is the text position, i.e. character and byte position,
1652 for character position CHARPOS in STRING. */
1654 static inline struct text_pos
1655 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1657 struct text_pos pos
;
1658 eassert (STRINGP (string
));
1659 eassert (charpos
>= 0);
1660 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1665 /* Value is a text position, i.e. character and byte position, for
1666 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1667 means recognize multibyte characters. */
1669 static struct text_pos
1670 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1672 struct text_pos pos
;
1674 eassert (s
!= NULL
);
1675 eassert (charpos
>= 0);
1681 SET_TEXT_POS (pos
, 0, 0);
1684 string_char_and_length ((const unsigned char *) s
, &len
);
1687 BYTEPOS (pos
) += len
;
1691 SET_TEXT_POS (pos
, charpos
, charpos
);
1697 /* Value is the number of characters in C string S. MULTIBYTE_P
1698 non-zero means recognize multibyte characters. */
1701 number_of_chars (const char *s
, int multibyte_p
)
1707 ptrdiff_t rest
= strlen (s
);
1709 const unsigned char *p
= (const unsigned char *) s
;
1711 for (nchars
= 0; rest
> 0; ++nchars
)
1713 string_char_and_length (p
, &len
);
1714 rest
-= len
, p
+= len
;
1718 nchars
= strlen (s
);
1724 /* Compute byte position NEWPOS->bytepos corresponding to
1725 NEWPOS->charpos. POS is a known position in string STRING.
1726 NEWPOS->charpos must be >= POS.charpos. */
1729 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1731 eassert (STRINGP (string
));
1732 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1734 if (STRING_MULTIBYTE (string
))
1735 *newpos
= string_pos_nchars_ahead (pos
, string
,
1736 CHARPOS (*newpos
) - CHARPOS (pos
));
1738 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1742 Return an estimation of the pixel height of mode or header lines on
1743 frame F. FACE_ID specifies what line's height to estimate. */
1746 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1748 #ifdef HAVE_WINDOW_SYSTEM
1749 if (FRAME_WINDOW_P (f
))
1751 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1753 /* This function is called so early when Emacs starts that the face
1754 cache and mode line face are not yet initialized. */
1755 if (FRAME_FACE_CACHE (f
))
1757 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1761 height
= FONT_HEIGHT (face
->font
);
1762 if (face
->box_line_width
> 0)
1763 height
+= 2 * face
->box_line_width
;
1774 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1775 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1776 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1777 not force the value into range. */
1780 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1781 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1784 #ifdef HAVE_WINDOW_SYSTEM
1785 if (FRAME_WINDOW_P (f
))
1787 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1788 even for negative values. */
1790 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1792 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1794 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1795 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1798 STORE_NATIVE_RECT (*bounds
,
1799 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1800 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1801 FRAME_COLUMN_WIDTH (f
) - 1,
1802 FRAME_LINE_HEIGHT (f
) - 1);
1808 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1809 pix_x
= FRAME_TOTAL_COLS (f
);
1813 else if (pix_y
> FRAME_LINES (f
))
1814 pix_y
= FRAME_LINES (f
);
1824 /* Find the glyph under window-relative coordinates X/Y in window W.
1825 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1826 strings. Return in *HPOS and *VPOS the row and column number of
1827 the glyph found. Return in *AREA the glyph area containing X.
1828 Value is a pointer to the glyph found or null if X/Y is not on
1829 text, or we can't tell because W's current matrix is not up to
1834 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1835 int *dx
, int *dy
, int *area
)
1837 struct glyph
*glyph
, *end
;
1838 struct glyph_row
*row
= NULL
;
1841 /* Find row containing Y. Give up if some row is not enabled. */
1842 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1844 row
= MATRIX_ROW (w
->current_matrix
, i
);
1845 if (!row
->enabled_p
)
1847 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1854 /* Give up if Y is not in the window. */
1855 if (i
== w
->current_matrix
->nrows
)
1858 /* Get the glyph area containing X. */
1859 if (w
->pseudo_window_p
)
1866 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1868 *area
= LEFT_MARGIN_AREA
;
1869 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1871 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1874 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1878 *area
= RIGHT_MARGIN_AREA
;
1879 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1883 /* Find glyph containing X. */
1884 glyph
= row
->glyphs
[*area
];
1885 end
= glyph
+ row
->used
[*area
];
1887 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1889 x
-= glyph
->pixel_width
;
1899 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1902 *hpos
= glyph
- row
->glyphs
[*area
];
1906 /* Convert frame-relative x/y to coordinates relative to window W.
1907 Takes pseudo-windows into account. */
1910 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1912 if (w
->pseudo_window_p
)
1914 /* A pseudo-window is always full-width, and starts at the
1915 left edge of the frame, plus a frame border. */
1916 struct frame
*f
= XFRAME (w
->frame
);
1917 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1918 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1922 *x
-= WINDOW_LEFT_EDGE_X (w
);
1923 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1927 #ifdef HAVE_WINDOW_SYSTEM
1930 Return in RECTS[] at most N clipping rectangles for glyph string S.
1931 Return the number of stored rectangles. */
1934 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1941 if (s
->row
->full_width_p
)
1943 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1944 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1945 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1947 /* Unless displaying a mode or menu bar line, which are always
1948 fully visible, clip to the visible part of the row. */
1949 if (s
->w
->pseudo_window_p
)
1950 r
.height
= s
->row
->visible_height
;
1952 r
.height
= s
->height
;
1956 /* This is a text line that may be partially visible. */
1957 r
.x
= window_box_left (s
->w
, s
->area
);
1958 r
.width
= window_box_width (s
->w
, s
->area
);
1959 r
.height
= s
->row
->visible_height
;
1963 if (r
.x
< s
->clip_head
->x
)
1965 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1966 r
.width
-= s
->clip_head
->x
- r
.x
;
1969 r
.x
= s
->clip_head
->x
;
1972 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1974 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1975 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1980 /* If S draws overlapping rows, it's sufficient to use the top and
1981 bottom of the window for clipping because this glyph string
1982 intentionally draws over other lines. */
1983 if (s
->for_overlaps
)
1985 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1986 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1988 /* Alas, the above simple strategy does not work for the
1989 environments with anti-aliased text: if the same text is
1990 drawn onto the same place multiple times, it gets thicker.
1991 If the overlap we are processing is for the erased cursor, we
1992 take the intersection with the rectangle of the cursor. */
1993 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1995 XRectangle rc
, r_save
= r
;
1997 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1998 rc
.y
= s
->w
->phys_cursor
.y
;
1999 rc
.width
= s
->w
->phys_cursor_width
;
2000 rc
.height
= s
->w
->phys_cursor_height
;
2002 x_intersect_rectangles (&r_save
, &rc
, &r
);
2007 /* Don't use S->y for clipping because it doesn't take partially
2008 visible lines into account. For example, it can be negative for
2009 partially visible lines at the top of a window. */
2010 if (!s
->row
->full_width_p
2011 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2012 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2014 r
.y
= max (0, s
->row
->y
);
2017 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2019 /* If drawing the cursor, don't let glyph draw outside its
2020 advertised boundaries. Cleartype does this under some circumstances. */
2021 if (s
->hl
== DRAW_CURSOR
)
2023 struct glyph
*glyph
= s
->first_glyph
;
2028 r
.width
-= s
->x
- r
.x
;
2031 r
.width
= min (r
.width
, glyph
->pixel_width
);
2033 /* If r.y is below window bottom, ensure that we still see a cursor. */
2034 height
= min (glyph
->ascent
+ glyph
->descent
,
2035 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2036 max_y
= window_text_bottom_y (s
->w
) - height
;
2037 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2038 if (s
->ybase
- glyph
->ascent
> max_y
)
2045 /* Don't draw cursor glyph taller than our actual glyph. */
2046 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2047 if (height
< r
.height
)
2049 max_y
= r
.y
+ r
.height
;
2050 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2051 r
.height
= min (max_y
- r
.y
, height
);
2058 XRectangle r_save
= r
;
2060 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2064 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2065 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2067 #ifdef CONVERT_FROM_XRECT
2068 CONVERT_FROM_XRECT (r
, *rects
);
2076 /* If we are processing overlapping and allowed to return
2077 multiple clipping rectangles, we exclude the row of the glyph
2078 string from the clipping rectangle. This is to avoid drawing
2079 the same text on the environment with anti-aliasing. */
2080 #ifdef CONVERT_FROM_XRECT
2083 XRectangle
*rs
= rects
;
2085 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2087 if (s
->for_overlaps
& OVERLAPS_PRED
)
2090 if (r
.y
+ r
.height
> row_y
)
2093 rs
[i
].height
= row_y
- r
.y
;
2099 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2102 if (r
.y
< row_y
+ s
->row
->visible_height
)
2104 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2106 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2107 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2116 #ifdef CONVERT_FROM_XRECT
2117 for (i
= 0; i
< n
; i
++)
2118 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2125 Return in *NR the clipping rectangle for glyph string S. */
2128 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2130 get_glyph_string_clip_rects (s
, nr
, 1);
2135 Return the position and height of the phys cursor in window W.
2136 Set w->phys_cursor_width to width of phys cursor.
2140 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2141 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2143 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2144 int x
, y
, wd
, h
, h0
, y0
;
2146 /* Compute the width of the rectangle to draw. If on a stretch
2147 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2148 rectangle as wide as the glyph, but use a canonical character
2150 wd
= glyph
->pixel_width
- 1;
2151 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2155 x
= w
->phys_cursor
.x
;
2162 if (glyph
->type
== STRETCH_GLYPH
2163 && !x_stretch_cursor_p
)
2164 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2165 w
->phys_cursor_width
= wd
;
2167 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2169 /* If y is below window bottom, ensure that we still see a cursor. */
2170 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2172 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2173 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2175 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2178 h
= max (h
- (y0
- y
) + 1, h0
);
2183 y0
= window_text_bottom_y (w
) - h0
;
2191 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2192 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2197 * Remember which glyph the mouse is over.
2201 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2205 struct glyph_row
*r
, *gr
, *end_row
;
2206 enum window_part part
;
2207 enum glyph_row_area area
;
2208 int x
, y
, width
, height
;
2210 /* Try to determine frame pixel position and size of the glyph under
2211 frame pixel coordinates X/Y on frame F. */
2213 if (!f
->glyphs_initialized_p
2214 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2217 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2218 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2222 w
= XWINDOW (window
);
2223 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2224 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2226 x
= window_relative_x_coord (w
, part
, gx
);
2227 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2229 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2230 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2232 if (w
->pseudo_window_p
)
2235 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2241 case ON_LEFT_MARGIN
:
2242 area
= LEFT_MARGIN_AREA
;
2245 case ON_RIGHT_MARGIN
:
2246 area
= RIGHT_MARGIN_AREA
;
2249 case ON_HEADER_LINE
:
2251 gr
= (part
== ON_HEADER_LINE
2252 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2253 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2256 goto text_glyph_row_found
;
2263 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2264 if (r
->y
+ r
->height
> y
)
2270 text_glyph_row_found
:
2273 struct glyph
*g
= gr
->glyphs
[area
];
2274 struct glyph
*end
= g
+ gr
->used
[area
];
2276 height
= gr
->height
;
2277 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2278 if (gx
+ g
->pixel_width
> x
)
2283 if (g
->type
== IMAGE_GLYPH
)
2285 /* Don't remember when mouse is over image, as
2286 image may have hot-spots. */
2287 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2290 width
= g
->pixel_width
;
2294 /* Use nominal char spacing at end of line. */
2296 gx
+= (x
/ width
) * width
;
2299 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2300 gx
+= window_box_left_offset (w
, area
);
2304 /* Use nominal line height at end of window. */
2305 gx
= (x
/ width
) * width
;
2307 gy
+= (y
/ height
) * height
;
2311 case ON_LEFT_FRINGE
:
2312 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2313 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2314 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2315 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2318 case ON_RIGHT_FRINGE
:
2319 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2320 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2321 : window_box_right_offset (w
, TEXT_AREA
));
2322 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2326 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2328 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2329 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2330 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2332 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2336 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2337 if (r
->y
+ r
->height
> y
)
2344 height
= gr
->height
;
2347 /* Use nominal line height at end of window. */
2349 gy
+= (y
/ height
) * height
;
2356 /* If there is no glyph under the mouse, then we divide the screen
2357 into a grid of the smallest glyph in the frame, and use that
2360 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2361 round down even for negative values. */
2367 gx
= (gx
/ width
) * width
;
2368 gy
= (gy
/ height
) * height
;
2373 gx
+= WINDOW_LEFT_EDGE_X (w
);
2374 gy
+= WINDOW_TOP_EDGE_Y (w
);
2377 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2379 /* Visible feedback for debugging. */
2382 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2383 f
->output_data
.x
->normal_gc
,
2384 gx
, gy
, width
, height
);
2390 #endif /* HAVE_WINDOW_SYSTEM */
2393 /***********************************************************************
2394 Lisp form evaluation
2395 ***********************************************************************/
2397 /* Error handler for safe_eval and safe_call. */
2400 safe_eval_handler (Lisp_Object arg
)
2402 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2407 /* Evaluate SEXPR and return the result, or nil if something went
2408 wrong. Prevent redisplay during the evaluation. */
2410 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2411 Return the result, or nil if something went wrong. Prevent
2412 redisplay during the evaluation. */
2415 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2419 if (inhibit_eval_during_redisplay
)
2423 ptrdiff_t count
= SPECPDL_INDEX ();
2424 struct gcpro gcpro1
;
2427 gcpro1
.nvars
= nargs
;
2428 specbind (Qinhibit_redisplay
, Qt
);
2429 /* Use Qt to ensure debugger does not run,
2430 so there is no possibility of wanting to redisplay. */
2431 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2434 val
= unbind_to (count
, val
);
2441 /* Call function FN with one argument ARG.
2442 Return the result, or nil if something went wrong. */
2445 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2447 Lisp_Object args
[2];
2450 return safe_call (2, args
);
2453 static Lisp_Object Qeval
;
2456 safe_eval (Lisp_Object sexpr
)
2458 return safe_call1 (Qeval
, sexpr
);
2461 /* Call function FN with one argument ARG.
2462 Return the result, or nil if something went wrong. */
2465 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2467 Lisp_Object args
[3];
2471 return safe_call (3, args
);
2476 /***********************************************************************
2478 ***********************************************************************/
2482 /* Define CHECK_IT to perform sanity checks on iterators.
2483 This is for debugging. It is too slow to do unconditionally. */
2486 check_it (struct it
*it
)
2488 if (it
->method
== GET_FROM_STRING
)
2490 eassert (STRINGP (it
->string
));
2491 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2495 eassert (IT_STRING_CHARPOS (*it
) < 0);
2496 if (it
->method
== GET_FROM_BUFFER
)
2498 /* Check that character and byte positions agree. */
2499 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2504 eassert (it
->current
.dpvec_index
>= 0);
2506 eassert (it
->current
.dpvec_index
< 0);
2509 #define CHECK_IT(IT) check_it ((IT))
2513 #define CHECK_IT(IT) (void) 0
2518 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2520 /* Check that the window end of window W is what we expect it
2521 to be---the last row in the current matrix displaying text. */
2524 check_window_end (struct window
*w
)
2526 if (!MINI_WINDOW_P (w
)
2527 && !NILP (w
->window_end_valid
))
2529 struct glyph_row
*row
;
2530 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2531 XFASTINT (w
->window_end_vpos
)),
2533 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2534 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2538 #define CHECK_WINDOW_END(W) check_window_end ((W))
2542 #define CHECK_WINDOW_END(W) (void) 0
2544 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2548 /***********************************************************************
2549 Iterator initialization
2550 ***********************************************************************/
2552 /* Initialize IT for displaying current_buffer in window W, starting
2553 at character position CHARPOS. CHARPOS < 0 means that no buffer
2554 position is specified which is useful when the iterator is assigned
2555 a position later. BYTEPOS is the byte position corresponding to
2556 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2558 If ROW is not null, calls to produce_glyphs with IT as parameter
2559 will produce glyphs in that row.
2561 BASE_FACE_ID is the id of a base face to use. It must be one of
2562 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2563 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2564 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2566 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2567 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2568 will be initialized to use the corresponding mode line glyph row of
2569 the desired matrix of W. */
2572 init_iterator (struct it
*it
, struct window
*w
,
2573 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2574 struct glyph_row
*row
, enum face_id base_face_id
)
2576 int highlight_region_p
;
2577 enum face_id remapped_base_face_id
= base_face_id
;
2579 /* Some precondition checks. */
2580 eassert (w
!= NULL
&& it
!= NULL
);
2581 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2584 /* If face attributes have been changed since the last redisplay,
2585 free realized faces now because they depend on face definitions
2586 that might have changed. Don't free faces while there might be
2587 desired matrices pending which reference these faces. */
2588 if (face_change_count
&& !inhibit_free_realized_faces
)
2590 face_change_count
= 0;
2591 free_all_realized_faces (Qnil
);
2594 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2595 if (! NILP (Vface_remapping_alist
))
2596 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2598 /* Use one of the mode line rows of W's desired matrix if
2602 if (base_face_id
== MODE_LINE_FACE_ID
2603 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2604 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2605 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2606 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2610 memset (it
, 0, sizeof *it
);
2611 it
->current
.overlay_string_index
= -1;
2612 it
->current
.dpvec_index
= -1;
2613 it
->base_face_id
= remapped_base_face_id
;
2615 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2616 it
->paragraph_embedding
= L2R
;
2617 it
->bidi_it
.string
.lstring
= Qnil
;
2618 it
->bidi_it
.string
.s
= NULL
;
2619 it
->bidi_it
.string
.bufpos
= 0;
2621 /* The window in which we iterate over current_buffer: */
2622 XSETWINDOW (it
->window
, w
);
2624 it
->f
= XFRAME (w
->frame
);
2628 /* Extra space between lines (on window systems only). */
2629 if (base_face_id
== DEFAULT_FACE_ID
2630 && FRAME_WINDOW_P (it
->f
))
2632 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2633 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2634 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2635 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2636 * FRAME_LINE_HEIGHT (it
->f
));
2637 else if (it
->f
->extra_line_spacing
> 0)
2638 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2639 it
->max_extra_line_spacing
= 0;
2642 /* If realized faces have been removed, e.g. because of face
2643 attribute changes of named faces, recompute them. When running
2644 in batch mode, the face cache of the initial frame is null. If
2645 we happen to get called, make a dummy face cache. */
2646 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2647 init_frame_faces (it
->f
);
2648 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2649 recompute_basic_faces (it
->f
);
2651 /* Current value of the `slice', `space-width', and 'height' properties. */
2652 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2653 it
->space_width
= Qnil
;
2654 it
->font_height
= Qnil
;
2655 it
->override_ascent
= -1;
2657 /* Are control characters displayed as `^C'? */
2658 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2660 /* -1 means everything between a CR and the following line end
2661 is invisible. >0 means lines indented more than this value are
2663 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2664 ? clip_to_bounds (-1, XINT (BVAR (current_buffer
,
2665 selective_display
)),
2667 : (!NILP (BVAR (current_buffer
, selective_display
))
2669 it
->selective_display_ellipsis_p
2670 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2672 /* Display table to use. */
2673 it
->dp
= window_display_table (w
);
2675 /* Are multibyte characters enabled in current_buffer? */
2676 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2678 /* Non-zero if we should highlight the region. */
2680 = (!NILP (Vtransient_mark_mode
)
2681 && !NILP (BVAR (current_buffer
, mark_active
))
2682 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2684 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2685 start and end of a visible region in window IT->w. Set both to
2686 -1 to indicate no region. */
2687 if (highlight_region_p
2688 /* Maybe highlight only in selected window. */
2689 && (/* Either show region everywhere. */
2690 highlight_nonselected_windows
2691 /* Or show region in the selected window. */
2692 || w
== XWINDOW (selected_window
)
2693 /* Or show the region if we are in the mini-buffer and W is
2694 the window the mini-buffer refers to. */
2695 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2696 && WINDOWP (minibuf_selected_window
)
2697 && w
== XWINDOW (minibuf_selected_window
))))
2699 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2700 it
->region_beg_charpos
= min (PT
, markpos
);
2701 it
->region_end_charpos
= max (PT
, markpos
);
2704 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2706 /* Get the position at which the redisplay_end_trigger hook should
2707 be run, if it is to be run at all. */
2708 if (MARKERP (w
->redisplay_end_trigger
)
2709 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2710 it
->redisplay_end_trigger_charpos
2711 = marker_position (w
->redisplay_end_trigger
);
2712 else if (INTEGERP (w
->redisplay_end_trigger
))
2713 it
->redisplay_end_trigger_charpos
=
2714 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2716 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2718 /* Are lines in the display truncated? */
2719 if (base_face_id
!= DEFAULT_FACE_ID
2721 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2722 && ((!NILP (Vtruncate_partial_width_windows
)
2723 && !INTEGERP (Vtruncate_partial_width_windows
))
2724 || (INTEGERP (Vtruncate_partial_width_windows
)
2725 && (WINDOW_TOTAL_COLS (it
->w
)
2726 < XINT (Vtruncate_partial_width_windows
))))))
2727 it
->line_wrap
= TRUNCATE
;
2728 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2729 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2730 ? WINDOW_WRAP
: WORD_WRAP
;
2732 it
->line_wrap
= TRUNCATE
;
2734 /* Get dimensions of truncation and continuation glyphs. These are
2735 displayed as fringe bitmaps under X, but we need them for such
2736 frames when the fringes are turned off. */
2737 if (it
->line_wrap
== TRUNCATE
)
2739 /* We will need the truncation glyph. */
2740 eassert (it
->glyph_row
== NULL
);
2741 produce_special_glyphs (it
, IT_TRUNCATION
);
2742 it
->truncation_pixel_width
= it
->pixel_width
;
2746 /* We will need the continuation glyph. */
2747 eassert (it
->glyph_row
== NULL
);
2748 produce_special_glyphs (it
, IT_CONTINUATION
);
2749 it
->continuation_pixel_width
= it
->pixel_width
;
2752 /* Reset these values to zero because the produce_special_glyphs
2753 above has changed them. */
2754 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2755 it
->phys_ascent
= it
->phys_descent
= 0;
2757 /* Set this after getting the dimensions of truncation and
2758 continuation glyphs, so that we don't produce glyphs when calling
2759 produce_special_glyphs, above. */
2760 it
->glyph_row
= row
;
2761 it
->area
= TEXT_AREA
;
2763 /* Forget any previous info about this row being reversed. */
2765 it
->glyph_row
->reversed_p
= 0;
2767 /* Get the dimensions of the display area. The display area
2768 consists of the visible window area plus a horizontally scrolled
2769 part to the left of the window. All x-values are relative to the
2770 start of this total display area. */
2771 if (base_face_id
!= DEFAULT_FACE_ID
)
2773 /* Mode lines, menu bar in terminal frames. */
2774 it
->first_visible_x
= 0;
2775 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2779 it
->first_visible_x
=
2780 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2781 it
->last_visible_x
= (it
->first_visible_x
2782 + window_box_width (w
, TEXT_AREA
));
2784 /* If we truncate lines, leave room for the truncation glyph(s) at
2785 the right margin. Otherwise, leave room for the continuation
2786 glyph(s). Done only if the window has no fringes. Since we
2787 don't know at this point whether there will be any R2L lines in
2788 the window, we reserve space for truncation/continuation glyphs
2789 even if only one of the fringes is absent. */
2790 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2791 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2793 if (it
->line_wrap
== TRUNCATE
)
2794 it
->last_visible_x
-= it
->truncation_pixel_width
;
2796 it
->last_visible_x
-= it
->continuation_pixel_width
;
2799 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2800 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2803 /* Leave room for a border glyph. */
2804 if (!FRAME_WINDOW_P (it
->f
)
2805 && !WINDOW_RIGHTMOST_P (it
->w
))
2806 it
->last_visible_x
-= 1;
2808 it
->last_visible_y
= window_text_bottom_y (w
);
2810 /* For mode lines and alike, arrange for the first glyph having a
2811 left box line if the face specifies a box. */
2812 if (base_face_id
!= DEFAULT_FACE_ID
)
2816 it
->face_id
= remapped_base_face_id
;
2818 /* If we have a boxed mode line, make the first character appear
2819 with a left box line. */
2820 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2821 if (face
->box
!= FACE_NO_BOX
)
2822 it
->start_of_box_run_p
= 1;
2825 /* If a buffer position was specified, set the iterator there,
2826 getting overlays and face properties from that position. */
2827 if (charpos
>= BUF_BEG (current_buffer
))
2829 it
->end_charpos
= ZV
;
2830 IT_CHARPOS (*it
) = charpos
;
2832 /* We will rely on `reseat' to set this up properly, via
2833 handle_face_prop. */
2834 it
->face_id
= it
->base_face_id
;
2836 /* Compute byte position if not specified. */
2837 if (bytepos
< charpos
)
2838 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2840 IT_BYTEPOS (*it
) = bytepos
;
2842 it
->start
= it
->current
;
2843 /* Do we need to reorder bidirectional text? Not if this is a
2844 unibyte buffer: by definition, none of the single-byte
2845 characters are strong R2L, so no reordering is needed. And
2846 bidi.c doesn't support unibyte buffers anyway. Also, don't
2847 reorder while we are loading loadup.el, since the tables of
2848 character properties needed for reordering are not yet
2852 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2855 /* If we are to reorder bidirectional text, init the bidi
2859 /* Note the paragraph direction that this buffer wants to
2861 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2863 it
->paragraph_embedding
= L2R
;
2864 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2866 it
->paragraph_embedding
= R2L
;
2868 it
->paragraph_embedding
= NEUTRAL_DIR
;
2869 bidi_unshelve_cache (NULL
, 0);
2870 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2874 /* Compute faces etc. */
2875 reseat (it
, it
->current
.pos
, 1);
2882 /* Initialize IT for the display of window W with window start POS. */
2885 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2887 struct glyph_row
*row
;
2888 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2890 row
= w
->desired_matrix
->rows
+ first_vpos
;
2891 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2892 it
->first_vpos
= first_vpos
;
2894 /* Don't reseat to previous visible line start if current start
2895 position is in a string or image. */
2896 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2898 int start_at_line_beg_p
;
2899 int first_y
= it
->current_y
;
2901 /* If window start is not at a line start, skip forward to POS to
2902 get the correct continuation lines width. */
2903 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2904 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2905 if (!start_at_line_beg_p
)
2909 reseat_at_previous_visible_line_start (it
);
2910 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2912 new_x
= it
->current_x
+ it
->pixel_width
;
2914 /* If lines are continued, this line may end in the middle
2915 of a multi-glyph character (e.g. a control character
2916 displayed as \003, or in the middle of an overlay
2917 string). In this case move_it_to above will not have
2918 taken us to the start of the continuation line but to the
2919 end of the continued line. */
2920 if (it
->current_x
> 0
2921 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2922 && (/* And glyph doesn't fit on the line. */
2923 new_x
> it
->last_visible_x
2924 /* Or it fits exactly and we're on a window
2926 || (new_x
== it
->last_visible_x
2927 && FRAME_WINDOW_P (it
->f
)
2928 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2929 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2930 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2932 if ((it
->current
.dpvec_index
>= 0
2933 || it
->current
.overlay_string_index
>= 0)
2934 /* If we are on a newline from a display vector or
2935 overlay string, then we are already at the end of
2936 a screen line; no need to go to the next line in
2937 that case, as this line is not really continued.
2938 (If we do go to the next line, C-e will not DTRT.) */
2941 set_iterator_to_next (it
, 1);
2942 move_it_in_display_line_to (it
, -1, -1, 0);
2945 it
->continuation_lines_width
+= it
->current_x
;
2947 /* If the character at POS is displayed via a display
2948 vector, move_it_to above stops at the final glyph of
2949 IT->dpvec. To make the caller redisplay that character
2950 again (a.k.a. start at POS), we need to reset the
2951 dpvec_index to the beginning of IT->dpvec. */
2952 else if (it
->current
.dpvec_index
>= 0)
2953 it
->current
.dpvec_index
= 0;
2955 /* We're starting a new display line, not affected by the
2956 height of the continued line, so clear the appropriate
2957 fields in the iterator structure. */
2958 it
->max_ascent
= it
->max_descent
= 0;
2959 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2961 it
->current_y
= first_y
;
2963 it
->current_x
= it
->hpos
= 0;
2969 /* Return 1 if POS is a position in ellipses displayed for invisible
2970 text. W is the window we display, for text property lookup. */
2973 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2975 Lisp_Object prop
, window
;
2977 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2979 /* If POS specifies a position in a display vector, this might
2980 be for an ellipsis displayed for invisible text. We won't
2981 get the iterator set up for delivering that ellipsis unless
2982 we make sure that it gets aware of the invisible text. */
2983 if (pos
->dpvec_index
>= 0
2984 && pos
->overlay_string_index
< 0
2985 && CHARPOS (pos
->string_pos
) < 0
2987 && (XSETWINDOW (window
, w
),
2988 prop
= Fget_char_property (make_number (charpos
),
2989 Qinvisible
, window
),
2990 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2992 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2994 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3001 /* Initialize IT for stepping through current_buffer in window W,
3002 starting at position POS that includes overlay string and display
3003 vector/ control character translation position information. Value
3004 is zero if there are overlay strings with newlines at POS. */
3007 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3009 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3010 int i
, overlay_strings_with_newlines
= 0;
3012 /* If POS specifies a position in a display vector, this might
3013 be for an ellipsis displayed for invisible text. We won't
3014 get the iterator set up for delivering that ellipsis unless
3015 we make sure that it gets aware of the invisible text. */
3016 if (in_ellipses_for_invisible_text_p (pos
, w
))
3022 /* Keep in mind: the call to reseat in init_iterator skips invisible
3023 text, so we might end up at a position different from POS. This
3024 is only a problem when POS is a row start after a newline and an
3025 overlay starts there with an after-string, and the overlay has an
3026 invisible property. Since we don't skip invisible text in
3027 display_line and elsewhere immediately after consuming the
3028 newline before the row start, such a POS will not be in a string,
3029 but the call to init_iterator below will move us to the
3031 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3033 /* This only scans the current chunk -- it should scan all chunks.
3034 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3035 to 16 in 22.1 to make this a lesser problem. */
3036 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3038 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3039 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3041 while (s
< e
&& *s
!= '\n')
3046 overlay_strings_with_newlines
= 1;
3051 /* If position is within an overlay string, set up IT to the right
3053 if (pos
->overlay_string_index
>= 0)
3057 /* If the first overlay string happens to have a `display'
3058 property for an image, the iterator will be set up for that
3059 image, and we have to undo that setup first before we can
3060 correct the overlay string index. */
3061 if (it
->method
== GET_FROM_IMAGE
)
3064 /* We already have the first chunk of overlay strings in
3065 IT->overlay_strings. Load more until the one for
3066 pos->overlay_string_index is in IT->overlay_strings. */
3067 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3069 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3070 it
->current
.overlay_string_index
= 0;
3073 load_overlay_strings (it
, 0);
3074 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3078 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3079 relative_index
= (it
->current
.overlay_string_index
3080 % OVERLAY_STRING_CHUNK_SIZE
);
3081 it
->string
= it
->overlay_strings
[relative_index
];
3082 eassert (STRINGP (it
->string
));
3083 it
->current
.string_pos
= pos
->string_pos
;
3084 it
->method
= GET_FROM_STRING
;
3087 if (CHARPOS (pos
->string_pos
) >= 0)
3089 /* Recorded position is not in an overlay string, but in another
3090 string. This can only be a string from a `display' property.
3091 IT should already be filled with that string. */
3092 it
->current
.string_pos
= pos
->string_pos
;
3093 eassert (STRINGP (it
->string
));
3096 /* Restore position in display vector translations, control
3097 character translations or ellipses. */
3098 if (pos
->dpvec_index
>= 0)
3100 if (it
->dpvec
== NULL
)
3101 get_next_display_element (it
);
3102 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3103 it
->current
.dpvec_index
= pos
->dpvec_index
;
3107 return !overlay_strings_with_newlines
;
3111 /* Initialize IT for stepping through current_buffer in window W
3112 starting at ROW->start. */
3115 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3117 init_from_display_pos (it
, w
, &row
->start
);
3118 it
->start
= row
->start
;
3119 it
->continuation_lines_width
= row
->continuation_lines_width
;
3124 /* Initialize IT for stepping through current_buffer in window W
3125 starting in the line following ROW, i.e. starting at ROW->end.
3126 Value is zero if there are overlay strings with newlines at ROW's
3130 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3134 if (init_from_display_pos (it
, w
, &row
->end
))
3136 if (row
->continued_p
)
3137 it
->continuation_lines_width
3138 = row
->continuation_lines_width
+ row
->pixel_width
;
3149 /***********************************************************************
3151 ***********************************************************************/
3153 /* Called when IT reaches IT->stop_charpos. Handle text property and
3154 overlay changes. Set IT->stop_charpos to the next position where
3158 handle_stop (struct it
*it
)
3160 enum prop_handled handled
;
3161 int handle_overlay_change_p
;
3165 it
->current
.dpvec_index
= -1;
3166 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3167 it
->ignore_overlay_strings_at_pos_p
= 0;
3170 /* Use face of preceding text for ellipsis (if invisible) */
3171 if (it
->selective_display_ellipsis_p
)
3172 it
->saved_face_id
= it
->face_id
;
3176 handled
= HANDLED_NORMALLY
;
3178 /* Call text property handlers. */
3179 for (p
= it_props
; p
->handler
; ++p
)
3181 handled
= p
->handler (it
);
3183 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3185 else if (handled
== HANDLED_RETURN
)
3187 /* We still want to show before and after strings from
3188 overlays even if the actual buffer text is replaced. */
3189 if (!handle_overlay_change_p
3191 /* Don't call get_overlay_strings_1 if we already
3192 have overlay strings loaded, because doing so
3193 will load them again and push the iterator state
3194 onto the stack one more time, which is not
3195 expected by the rest of the code that processes
3197 || (it
->current
.overlay_string_index
< 0
3198 ? !get_overlay_strings_1 (it
, 0, 0)
3202 setup_for_ellipsis (it
, 0);
3203 /* When handling a display spec, we might load an
3204 empty string. In that case, discard it here. We
3205 used to discard it in handle_single_display_spec,
3206 but that causes get_overlay_strings_1, above, to
3207 ignore overlay strings that we must check. */
3208 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3212 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3216 it
->ignore_overlay_strings_at_pos_p
= 1;
3217 it
->string_from_display_prop_p
= 0;
3218 it
->from_disp_prop_p
= 0;
3219 handle_overlay_change_p
= 0;
3221 handled
= HANDLED_RECOMPUTE_PROPS
;
3224 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3225 handle_overlay_change_p
= 0;
3228 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3230 /* Don't check for overlay strings below when set to deliver
3231 characters from a display vector. */
3232 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3233 handle_overlay_change_p
= 0;
3235 /* Handle overlay changes.
3236 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3237 if it finds overlays. */
3238 if (handle_overlay_change_p
)
3239 handled
= handle_overlay_change (it
);
3244 setup_for_ellipsis (it
, 0);
3248 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3250 /* Determine where to stop next. */
3251 if (handled
== HANDLED_NORMALLY
)
3252 compute_stop_pos (it
);
3256 /* Compute IT->stop_charpos from text property and overlay change
3257 information for IT's current position. */
3260 compute_stop_pos (struct it
*it
)
3262 register INTERVAL iv
, next_iv
;
3263 Lisp_Object object
, limit
, position
;
3264 ptrdiff_t charpos
, bytepos
;
3266 if (STRINGP (it
->string
))
3268 /* Strings are usually short, so don't limit the search for
3270 it
->stop_charpos
= it
->end_charpos
;
3271 object
= it
->string
;
3273 charpos
= IT_STRING_CHARPOS (*it
);
3274 bytepos
= IT_STRING_BYTEPOS (*it
);
3280 /* If end_charpos is out of range for some reason, such as a
3281 misbehaving display function, rationalize it (Bug#5984). */
3282 if (it
->end_charpos
> ZV
)
3283 it
->end_charpos
= ZV
;
3284 it
->stop_charpos
= it
->end_charpos
;
3286 /* If next overlay change is in front of the current stop pos
3287 (which is IT->end_charpos), stop there. Note: value of
3288 next_overlay_change is point-max if no overlay change
3290 charpos
= IT_CHARPOS (*it
);
3291 bytepos
= IT_BYTEPOS (*it
);
3292 pos
= next_overlay_change (charpos
);
3293 if (pos
< it
->stop_charpos
)
3294 it
->stop_charpos
= pos
;
3296 /* If showing the region, we have to stop at the region
3297 start or end because the face might change there. */
3298 if (it
->region_beg_charpos
> 0)
3300 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3301 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3302 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3303 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3306 /* Set up variables for computing the stop position from text
3307 property changes. */
3308 XSETBUFFER (object
, current_buffer
);
3309 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3312 /* Get the interval containing IT's position. Value is a null
3313 interval if there isn't such an interval. */
3314 position
= make_number (charpos
);
3315 iv
= validate_interval_range (object
, &position
, &position
, 0);
3316 if (!NULL_INTERVAL_P (iv
))
3318 Lisp_Object values_here
[LAST_PROP_IDX
];
3321 /* Get properties here. */
3322 for (p
= it_props
; p
->handler
; ++p
)
3323 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3325 /* Look for an interval following iv that has different
3327 for (next_iv
= next_interval (iv
);
3328 (!NULL_INTERVAL_P (next_iv
)
3330 || XFASTINT (limit
) > next_iv
->position
));
3331 next_iv
= next_interval (next_iv
))
3333 for (p
= it_props
; p
->handler
; ++p
)
3335 Lisp_Object new_value
;
3337 new_value
= textget (next_iv
->plist
, *p
->name
);
3338 if (!EQ (values_here
[p
->idx
], new_value
))
3346 if (!NULL_INTERVAL_P (next_iv
))
3348 if (INTEGERP (limit
)
3349 && next_iv
->position
>= XFASTINT (limit
))
3350 /* No text property change up to limit. */
3351 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3353 /* Text properties change in next_iv. */
3354 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3358 if (it
->cmp_it
.id
< 0)
3360 ptrdiff_t stoppos
= it
->end_charpos
;
3362 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3364 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3365 stoppos
, it
->string
);
3368 eassert (STRINGP (it
->string
)
3369 || (it
->stop_charpos
>= BEGV
3370 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3374 /* Return the position of the next overlay change after POS in
3375 current_buffer. Value is point-max if no overlay change
3376 follows. This is like `next-overlay-change' but doesn't use
3380 next_overlay_change (ptrdiff_t pos
)
3382 ptrdiff_t i
, noverlays
;
3384 Lisp_Object
*overlays
;
3386 /* Get all overlays at the given position. */
3387 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3389 /* If any of these overlays ends before endpos,
3390 use its ending point instead. */
3391 for (i
= 0; i
< noverlays
; ++i
)
3396 oend
= OVERLAY_END (overlays
[i
]);
3397 oendpos
= OVERLAY_POSITION (oend
);
3398 endpos
= min (endpos
, oendpos
);
3404 /* How many characters forward to search for a display property or
3405 display string. Searching too far forward makes the bidi display
3406 sluggish, especially in small windows. */
3407 #define MAX_DISP_SCAN 250
3409 /* Return the character position of a display string at or after
3410 position specified by POSITION. If no display string exists at or
3411 after POSITION, return ZV. A display string is either an overlay
3412 with `display' property whose value is a string, or a `display'
3413 text property whose value is a string. STRING is data about the
3414 string to iterate; if STRING->lstring is nil, we are iterating a
3415 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3416 on a GUI frame. DISP_PROP is set to zero if we searched
3417 MAX_DISP_SCAN characters forward without finding any display
3418 strings, non-zero otherwise. It is set to 2 if the display string
3419 uses any kind of `(space ...)' spec that will produce a stretch of
3420 white space in the text area. */
3422 compute_display_string_pos (struct text_pos
*position
,
3423 struct bidi_string_data
*string
,
3424 int frame_window_p
, int *disp_prop
)
3426 /* OBJECT = nil means current buffer. */
3427 Lisp_Object object
=
3428 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3429 Lisp_Object pos
, spec
, limpos
;
3430 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3431 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3432 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3433 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3435 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3436 struct text_pos tpos
;
3442 /* We don't support display properties whose values are strings
3443 that have display string properties. */
3444 || string
->from_disp_str
3445 /* C strings cannot have display properties. */
3446 || (string
->s
&& !STRINGP (object
)))
3452 /* If the character at CHARPOS is where the display string begins,
3454 pos
= make_number (charpos
);
3455 if (STRINGP (object
))
3456 bufpos
= string
->bufpos
;
3460 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3462 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3465 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3473 /* Look forward for the first character with a `display' property
3474 that will replace the underlying text when displayed. */
3475 limpos
= make_number (lim
);
3477 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3478 CHARPOS (tpos
) = XFASTINT (pos
);
3479 if (CHARPOS (tpos
) >= lim
)
3484 if (STRINGP (object
))
3485 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3487 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3488 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3489 if (!STRINGP (object
))
3490 bufpos
= CHARPOS (tpos
);
3491 } while (NILP (spec
)
3492 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3493 bufpos
, frame_window_p
)));
3497 return CHARPOS (tpos
);
3500 /* Return the character position of the end of the display string that
3501 started at CHARPOS. If there's no display string at CHARPOS,
3502 return -1. A display string is either an overlay with `display'
3503 property whose value is a string or a `display' text property whose
3504 value is a string. */
3506 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3508 /* OBJECT = nil means current buffer. */
3509 Lisp_Object object
=
3510 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3511 Lisp_Object pos
= make_number (charpos
);
3513 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3515 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3518 /* It could happen that the display property or overlay was removed
3519 since we found it in compute_display_string_pos above. One way
3520 this can happen is if JIT font-lock was called (through
3521 handle_fontified_prop), and jit-lock-functions remove text
3522 properties or overlays from the portion of buffer that includes
3523 CHARPOS. Muse mode is known to do that, for example. In this
3524 case, we return -1 to the caller, to signal that no display
3525 string is actually present at CHARPOS. See bidi_fetch_char for
3526 how this is handled.
3528 An alternative would be to never look for display properties past
3529 it->stop_charpos. But neither compute_display_string_pos nor
3530 bidi_fetch_char that calls it know or care where the next
3532 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3535 /* Look forward for the first character where the `display' property
3537 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3539 return XFASTINT (pos
);
3544 /***********************************************************************
3546 ***********************************************************************/
3548 /* Handle changes in the `fontified' property of the current buffer by
3549 calling hook functions from Qfontification_functions to fontify
3552 static enum prop_handled
3553 handle_fontified_prop (struct it
*it
)
3555 Lisp_Object prop
, pos
;
3556 enum prop_handled handled
= HANDLED_NORMALLY
;
3558 if (!NILP (Vmemory_full
))
3561 /* Get the value of the `fontified' property at IT's current buffer
3562 position. (The `fontified' property doesn't have a special
3563 meaning in strings.) If the value is nil, call functions from
3564 Qfontification_functions. */
3565 if (!STRINGP (it
->string
)
3567 && !NILP (Vfontification_functions
)
3568 && !NILP (Vrun_hooks
)
3569 && (pos
= make_number (IT_CHARPOS (*it
)),
3570 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3571 /* Ignore the special cased nil value always present at EOB since
3572 no amount of fontifying will be able to change it. */
3573 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3575 ptrdiff_t count
= SPECPDL_INDEX ();
3577 struct buffer
*obuf
= current_buffer
;
3578 int begv
= BEGV
, zv
= ZV
;
3579 int old_clip_changed
= current_buffer
->clip_changed
;
3581 val
= Vfontification_functions
;
3582 specbind (Qfontification_functions
, Qnil
);
3584 eassert (it
->end_charpos
== ZV
);
3586 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3587 safe_call1 (val
, pos
);
3590 Lisp_Object fns
, fn
;
3591 struct gcpro gcpro1
, gcpro2
;
3596 for (; CONSP (val
); val
= XCDR (val
))
3602 /* A value of t indicates this hook has a local
3603 binding; it means to run the global binding too.
3604 In a global value, t should not occur. If it
3605 does, we must ignore it to avoid an endless
3607 for (fns
= Fdefault_value (Qfontification_functions
);
3613 safe_call1 (fn
, pos
);
3617 safe_call1 (fn
, pos
);
3623 unbind_to (count
, Qnil
);
3625 /* Fontification functions routinely call `save-restriction'.
3626 Normally, this tags clip_changed, which can confuse redisplay
3627 (see discussion in Bug#6671). Since we don't perform any
3628 special handling of fontification changes in the case where
3629 `save-restriction' isn't called, there's no point doing so in
3630 this case either. So, if the buffer's restrictions are
3631 actually left unchanged, reset clip_changed. */
3632 if (obuf
== current_buffer
)
3634 if (begv
== BEGV
&& zv
== ZV
)
3635 current_buffer
->clip_changed
= old_clip_changed
;
3637 /* There isn't much we can reasonably do to protect against
3638 misbehaving fontification, but here's a fig leaf. */
3639 else if (!NILP (BVAR (obuf
, name
)))
3640 set_buffer_internal_1 (obuf
);
3642 /* The fontification code may have added/removed text.
3643 It could do even a lot worse, but let's at least protect against
3644 the most obvious case where only the text past `pos' gets changed',
3645 as is/was done in grep.el where some escapes sequences are turned
3646 into face properties (bug#7876). */
3647 it
->end_charpos
= ZV
;
3649 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3650 something. This avoids an endless loop if they failed to
3651 fontify the text for which reason ever. */
3652 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3653 handled
= HANDLED_RECOMPUTE_PROPS
;
3661 /***********************************************************************
3663 ***********************************************************************/
3665 /* Set up iterator IT from face properties at its current position.
3666 Called from handle_stop. */
3668 static enum prop_handled
3669 handle_face_prop (struct it
*it
)
3672 ptrdiff_t next_stop
;
3674 if (!STRINGP (it
->string
))
3677 = face_at_buffer_position (it
->w
,
3679 it
->region_beg_charpos
,
3680 it
->region_end_charpos
,
3683 + TEXT_PROP_DISTANCE_LIMIT
),
3684 0, it
->base_face_id
);
3686 /* Is this a start of a run of characters with box face?
3687 Caveat: this can be called for a freshly initialized
3688 iterator; face_id is -1 in this case. We know that the new
3689 face will not change until limit, i.e. if the new face has a
3690 box, all characters up to limit will have one. But, as
3691 usual, we don't know whether limit is really the end. */
3692 if (new_face_id
!= it
->face_id
)
3694 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3696 /* If new face has a box but old face has not, this is
3697 the start of a run of characters with box, i.e. it has
3698 a shadow on the left side. The value of face_id of the
3699 iterator will be -1 if this is the initial call that gets
3700 the face. In this case, we have to look in front of IT's
3701 position and see whether there is a face != new_face_id. */
3702 it
->start_of_box_run_p
3703 = (new_face
->box
!= FACE_NO_BOX
3704 && (it
->face_id
>= 0
3705 || IT_CHARPOS (*it
) == BEG
3706 || new_face_id
!= face_before_it_pos (it
)));
3707 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3715 Lisp_Object from_overlay
3716 = (it
->current
.overlay_string_index
>= 0
3717 ? it
->string_overlays
[it
->current
.overlay_string_index
3718 % OVERLAY_STRING_CHUNK_SIZE
]
3721 /* See if we got to this string directly or indirectly from
3722 an overlay property. That includes the before-string or
3723 after-string of an overlay, strings in display properties
3724 provided by an overlay, their text properties, etc.
3726 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3727 if (! NILP (from_overlay
))
3728 for (i
= it
->sp
- 1; i
>= 0; i
--)
3730 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3732 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3733 % OVERLAY_STRING_CHUNK_SIZE
];
3734 else if (! NILP (it
->stack
[i
].from_overlay
))
3735 from_overlay
= it
->stack
[i
].from_overlay
;
3737 if (!NILP (from_overlay
))
3741 if (! NILP (from_overlay
))
3743 bufpos
= IT_CHARPOS (*it
);
3744 /* For a string from an overlay, the base face depends
3745 only on text properties and ignores overlays. */
3747 = face_for_overlay_string (it
->w
,
3749 it
->region_beg_charpos
,
3750 it
->region_end_charpos
,
3753 + TEXT_PROP_DISTANCE_LIMIT
),
3761 /* For strings from a `display' property, use the face at
3762 IT's current buffer position as the base face to merge
3763 with, so that overlay strings appear in the same face as
3764 surrounding text, unless they specify their own
3766 base_face_id
= it
->string_from_prefix_prop_p
3768 : underlying_face_id (it
);
3771 new_face_id
= face_at_string_position (it
->w
,
3773 IT_STRING_CHARPOS (*it
),
3775 it
->region_beg_charpos
,
3776 it
->region_end_charpos
,
3780 /* Is this a start of a run of characters with box? Caveat:
3781 this can be called for a freshly allocated iterator; face_id
3782 is -1 is this case. We know that the new face will not
3783 change until the next check pos, i.e. if the new face has a
3784 box, all characters up to that position will have a
3785 box. But, as usual, we don't know whether that position
3786 is really the end. */
3787 if (new_face_id
!= it
->face_id
)
3789 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3790 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3792 /* If new face has a box but old face hasn't, this is the
3793 start of a run of characters with box, i.e. it has a
3794 shadow on the left side. */
3795 it
->start_of_box_run_p
3796 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3797 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3801 it
->face_id
= new_face_id
;
3802 return HANDLED_NORMALLY
;
3806 /* Return the ID of the face ``underlying'' IT's current position,
3807 which is in a string. If the iterator is associated with a
3808 buffer, return the face at IT's current buffer position.
3809 Otherwise, use the iterator's base_face_id. */
3812 underlying_face_id (struct it
*it
)
3814 int face_id
= it
->base_face_id
, i
;
3816 eassert (STRINGP (it
->string
));
3818 for (i
= it
->sp
- 1; i
>= 0; --i
)
3819 if (NILP (it
->stack
[i
].string
))
3820 face_id
= it
->stack
[i
].face_id
;
3826 /* Compute the face one character before or after the current position
3827 of IT, in the visual order. BEFORE_P non-zero means get the face
3828 in front (to the left in L2R paragraphs, to the right in R2L
3829 paragraphs) of IT's screen position. Value is the ID of the face. */
3832 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3835 ptrdiff_t next_check_charpos
;
3837 void *it_copy_data
= NULL
;
3839 eassert (it
->s
== NULL
);
3841 if (STRINGP (it
->string
))
3843 ptrdiff_t bufpos
, charpos
;
3846 /* No face change past the end of the string (for the case
3847 we are padding with spaces). No face change before the
3849 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3850 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3855 /* Set charpos to the position before or after IT's current
3856 position, in the logical order, which in the non-bidi
3857 case is the same as the visual order. */
3859 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3860 else if (it
->what
== IT_COMPOSITION
)
3861 /* For composition, we must check the character after the
3863 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3865 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3871 /* With bidi iteration, the character before the current
3872 in the visual order cannot be found by simple
3873 iteration, because "reverse" reordering is not
3874 supported. Instead, we need to use the move_it_*
3875 family of functions. */
3876 /* Ignore face changes before the first visible
3877 character on this display line. */
3878 if (it
->current_x
<= it
->first_visible_x
)
3880 SAVE_IT (it_copy
, *it
, it_copy_data
);
3881 /* Implementation note: Since move_it_in_display_line
3882 works in the iterator geometry, and thinks the first
3883 character is always the leftmost, even in R2L lines,
3884 we don't need to distinguish between the R2L and L2R
3886 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3887 it_copy
.current_x
- 1, MOVE_TO_X
);
3888 charpos
= IT_STRING_CHARPOS (it_copy
);
3889 RESTORE_IT (it
, it
, it_copy_data
);
3893 /* Set charpos to the string position of the character
3894 that comes after IT's current position in the visual
3896 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3900 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3902 charpos
= it_copy
.bidi_it
.charpos
;
3905 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3907 if (it
->current
.overlay_string_index
>= 0)
3908 bufpos
= IT_CHARPOS (*it
);
3912 base_face_id
= underlying_face_id (it
);
3914 /* Get the face for ASCII, or unibyte. */
3915 face_id
= face_at_string_position (it
->w
,
3919 it
->region_beg_charpos
,
3920 it
->region_end_charpos
,
3921 &next_check_charpos
,
3924 /* Correct the face for charsets different from ASCII. Do it
3925 for the multibyte case only. The face returned above is
3926 suitable for unibyte text if IT->string is unibyte. */
3927 if (STRING_MULTIBYTE (it
->string
))
3929 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3930 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3932 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3934 c
= string_char_and_length (p
, &len
);
3935 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3940 struct text_pos pos
;
3942 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3943 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3946 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3947 pos
= it
->current
.pos
;
3952 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3955 if (it
->what
== IT_COMPOSITION
)
3957 /* For composition, we must check the position after
3959 pos
.charpos
+= it
->cmp_it
.nchars
;
3960 pos
.bytepos
+= it
->len
;
3963 INC_TEXT_POS (pos
, it
->multibyte_p
);
3970 /* With bidi iteration, the character before the current
3971 in the visual order cannot be found by simple
3972 iteration, because "reverse" reordering is not
3973 supported. Instead, we need to use the move_it_*
3974 family of functions. */
3975 /* Ignore face changes before the first visible
3976 character on this display line. */
3977 if (it
->current_x
<= it
->first_visible_x
)
3979 SAVE_IT (it_copy
, *it
, it_copy_data
);
3980 /* Implementation note: Since move_it_in_display_line
3981 works in the iterator geometry, and thinks the first
3982 character is always the leftmost, even in R2L lines,
3983 we don't need to distinguish between the R2L and L2R
3985 move_it_in_display_line (&it_copy
, ZV
,
3986 it_copy
.current_x
- 1, MOVE_TO_X
);
3987 pos
= it_copy
.current
.pos
;
3988 RESTORE_IT (it
, it
, it_copy_data
);
3992 /* Set charpos to the buffer position of the character
3993 that comes after IT's current position in the visual
3995 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3999 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4002 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4005 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4007 /* Determine face for CHARSET_ASCII, or unibyte. */
4008 face_id
= face_at_buffer_position (it
->w
,
4010 it
->region_beg_charpos
,
4011 it
->region_end_charpos
,
4012 &next_check_charpos
,
4015 /* Correct the face for charsets different from ASCII. Do it
4016 for the multibyte case only. The face returned above is
4017 suitable for unibyte text if current_buffer is unibyte. */
4018 if (it
->multibyte_p
)
4020 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4021 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4022 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4031 /***********************************************************************
4033 ***********************************************************************/
4035 /* Set up iterator IT from invisible properties at its current
4036 position. Called from handle_stop. */
4038 static enum prop_handled
4039 handle_invisible_prop (struct it
*it
)
4041 enum prop_handled handled
= HANDLED_NORMALLY
;
4043 if (STRINGP (it
->string
))
4045 Lisp_Object prop
, end_charpos
, limit
, charpos
;
4047 /* Get the value of the invisible text property at the
4048 current position. Value will be nil if there is no such
4050 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4051 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4054 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4058 handled
= HANDLED_RECOMPUTE_PROPS
;
4060 /* Get the position at which the next change of the
4061 invisible text property can be found in IT->string.
4062 Value will be nil if the property value is the same for
4063 all the rest of IT->string. */
4064 XSETINT (limit
, SCHARS (it
->string
));
4065 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4068 /* Text at current position is invisible. The next
4069 change in the property is at position end_charpos.
4070 Move IT's current position to that position. */
4071 if (INTEGERP (end_charpos
)
4072 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
4074 struct text_pos old
;
4077 old
= it
->current
.string_pos
;
4078 oldpos
= CHARPOS (old
);
4081 if (it
->bidi_it
.first_elt
4082 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4083 bidi_paragraph_init (it
->paragraph_embedding
,
4085 /* Bidi-iterate out of the invisible text. */
4088 bidi_move_to_visually_next (&it
->bidi_it
);
4090 while (oldpos
<= it
->bidi_it
.charpos
4091 && it
->bidi_it
.charpos
< endpos
);
4093 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4094 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4095 if (IT_CHARPOS (*it
) >= endpos
)
4096 it
->prev_stop
= endpos
;
4100 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4101 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4106 /* The rest of the string is invisible. If this is an
4107 overlay string, proceed with the next overlay string
4108 or whatever comes and return a character from there. */
4109 if (it
->current
.overlay_string_index
>= 0)
4111 next_overlay_string (it
);
4112 /* Don't check for overlay strings when we just
4113 finished processing them. */
4114 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4118 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4119 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4127 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4128 Lisp_Object pos
, prop
, overlay
;
4130 /* First of all, is there invisible text at this position? */
4131 tem
= start_charpos
= IT_CHARPOS (*it
);
4132 pos
= make_number (tem
);
4133 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4135 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4137 /* If we are on invisible text, skip over it. */
4138 if (invis_p
&& start_charpos
< it
->end_charpos
)
4140 /* Record whether we have to display an ellipsis for the
4142 int display_ellipsis_p
= invis_p
== 2;
4144 handled
= HANDLED_RECOMPUTE_PROPS
;
4146 /* Loop skipping over invisible text. The loop is left at
4147 ZV or with IT on the first char being visible again. */
4150 /* Try to skip some invisible text. Return value is the
4151 position reached which can be equal to where we start
4152 if there is nothing invisible there. This skips both
4153 over invisible text properties and overlays with
4154 invisible property. */
4155 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4157 /* If we skipped nothing at all we weren't at invisible
4158 text in the first place. If everything to the end of
4159 the buffer was skipped, end the loop. */
4160 if (newpos
== tem
|| newpos
>= ZV
)
4164 /* We skipped some characters but not necessarily
4165 all there are. Check if we ended up on visible
4166 text. Fget_char_property returns the property of
4167 the char before the given position, i.e. if we
4168 get invis_p = 0, this means that the char at
4169 newpos is visible. */
4170 pos
= make_number (newpos
);
4171 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4172 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4175 /* If we ended up on invisible text, proceed to
4176 skip starting with next_stop. */
4180 /* If there are adjacent invisible texts, don't lose the
4181 second one's ellipsis. */
4183 display_ellipsis_p
= 1;
4187 /* The position newpos is now either ZV or on visible text. */
4190 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4192 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4194 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4196 /* If the invisible text ends on a newline or on a
4197 character after a newline, we can avoid the costly,
4198 character by character, bidi iteration to NEWPOS, and
4199 instead simply reseat the iterator there. That's
4200 because all bidi reordering information is tossed at
4201 the newline. This is a big win for modes that hide
4202 complete lines, like Outline, Org, etc. */
4203 if (on_newline
|| after_newline
)
4205 struct text_pos tpos
;
4206 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4208 SET_TEXT_POS (tpos
, newpos
, bpos
);
4209 reseat_1 (it
, tpos
, 0);
4210 /* If we reseat on a newline/ZV, we need to prep the
4211 bidi iterator for advancing to the next character
4212 after the newline/EOB, keeping the current paragraph
4213 direction (so that PRODUCE_GLYPHS does TRT wrt
4214 prepending/appending glyphs to a glyph row). */
4217 it
->bidi_it
.first_elt
= 0;
4218 it
->bidi_it
.paragraph_dir
= pdir
;
4219 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4220 it
->bidi_it
.nchars
= 1;
4221 it
->bidi_it
.ch_len
= 1;
4224 else /* Must use the slow method. */
4226 /* With bidi iteration, the region of invisible text
4227 could start and/or end in the middle of a
4228 non-base embedding level. Therefore, we need to
4229 skip invisible text using the bidi iterator,
4230 starting at IT's current position, until we find
4231 ourselves outside of the invisible text.
4232 Skipping invisible text _after_ bidi iteration
4233 avoids affecting the visual order of the
4234 displayed text when invisible properties are
4235 added or removed. */
4236 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4238 /* If we were `reseat'ed to a new paragraph,
4239 determine the paragraph base direction. We
4240 need to do it now because
4241 next_element_from_buffer may not have a
4242 chance to do it, if we are going to skip any
4243 text at the beginning, which resets the
4245 bidi_paragraph_init (it
->paragraph_embedding
,
4250 bidi_move_to_visually_next (&it
->bidi_it
);
4252 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4253 && it
->bidi_it
.charpos
< newpos
);
4254 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4255 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4256 /* If we overstepped NEWPOS, record its position in
4257 the iterator, so that we skip invisible text if
4258 later the bidi iteration lands us in the
4259 invisible region again. */
4260 if (IT_CHARPOS (*it
) >= newpos
)
4261 it
->prev_stop
= newpos
;
4266 IT_CHARPOS (*it
) = newpos
;
4267 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4270 /* If there are before-strings at the start of invisible
4271 text, and the text is invisible because of a text
4272 property, arrange to show before-strings because 20.x did
4273 it that way. (If the text is invisible because of an
4274 overlay property instead of a text property, this is
4275 already handled in the overlay code.) */
4277 && get_overlay_strings (it
, it
->stop_charpos
))
4279 handled
= HANDLED_RECOMPUTE_PROPS
;
4280 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4282 else if (display_ellipsis_p
)
4284 /* Make sure that the glyphs of the ellipsis will get
4285 correct `charpos' values. If we would not update
4286 it->position here, the glyphs would belong to the
4287 last visible character _before_ the invisible
4288 text, which confuses `set_cursor_from_row'.
4290 We use the last invisible position instead of the
4291 first because this way the cursor is always drawn on
4292 the first "." of the ellipsis, whenever PT is inside
4293 the invisible text. Otherwise the cursor would be
4294 placed _after_ the ellipsis when the point is after the
4295 first invisible character. */
4296 if (!STRINGP (it
->object
))
4298 it
->position
.charpos
= newpos
- 1;
4299 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4302 /* Let the ellipsis display before
4303 considering any properties of the following char.
4304 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4305 handled
= HANDLED_RETURN
;
4314 /* Make iterator IT return `...' next.
4315 Replaces LEN characters from buffer. */
4318 setup_for_ellipsis (struct it
*it
, int len
)
4320 /* Use the display table definition for `...'. Invalid glyphs
4321 will be handled by the method returning elements from dpvec. */
4322 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4324 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4325 it
->dpvec
= v
->contents
;
4326 it
->dpend
= v
->contents
+ v
->header
.size
;
4330 /* Default `...'. */
4331 it
->dpvec
= default_invis_vector
;
4332 it
->dpend
= default_invis_vector
+ 3;
4335 it
->dpvec_char_len
= len
;
4336 it
->current
.dpvec_index
= 0;
4337 it
->dpvec_face_id
= -1;
4339 /* Remember the current face id in case glyphs specify faces.
4340 IT's face is restored in set_iterator_to_next.
4341 saved_face_id was set to preceding char's face in handle_stop. */
4342 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4343 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4345 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4351 /***********************************************************************
4353 ***********************************************************************/
4355 /* Set up iterator IT from `display' property at its current position.
4356 Called from handle_stop.
4357 We return HANDLED_RETURN if some part of the display property
4358 overrides the display of the buffer text itself.
4359 Otherwise we return HANDLED_NORMALLY. */
4361 static enum prop_handled
4362 handle_display_prop (struct it
*it
)
4364 Lisp_Object propval
, object
, overlay
;
4365 struct text_pos
*position
;
4367 /* Nonzero if some property replaces the display of the text itself. */
4368 int display_replaced_p
= 0;
4370 if (STRINGP (it
->string
))
4372 object
= it
->string
;
4373 position
= &it
->current
.string_pos
;
4374 bufpos
= CHARPOS (it
->current
.pos
);
4378 XSETWINDOW (object
, it
->w
);
4379 position
= &it
->current
.pos
;
4380 bufpos
= CHARPOS (*position
);
4383 /* Reset those iterator values set from display property values. */
4384 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4385 it
->space_width
= Qnil
;
4386 it
->font_height
= Qnil
;
4389 /* We don't support recursive `display' properties, i.e. string
4390 values that have a string `display' property, that have a string
4391 `display' property etc. */
4392 if (!it
->string_from_display_prop_p
)
4393 it
->area
= TEXT_AREA
;
4395 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4396 Qdisplay
, object
, &overlay
);
4398 return HANDLED_NORMALLY
;
4399 /* Now OVERLAY is the overlay that gave us this property, or nil
4400 if it was a text property. */
4402 if (!STRINGP (it
->string
))
4403 object
= it
->w
->buffer
;
4405 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4407 FRAME_WINDOW_P (it
->f
));
4409 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4412 /* Subroutine of handle_display_prop. Returns non-zero if the display
4413 specification in SPEC is a replacing specification, i.e. it would
4414 replace the text covered by `display' property with something else,
4415 such as an image or a display string. If SPEC includes any kind or
4416 `(space ...) specification, the value is 2; this is used by
4417 compute_display_string_pos, which see.
4419 See handle_single_display_spec for documentation of arguments.
4420 frame_window_p is non-zero if the window being redisplayed is on a
4421 GUI frame; this argument is used only if IT is NULL, see below.
4423 IT can be NULL, if this is called by the bidi reordering code
4424 through compute_display_string_pos, which see. In that case, this
4425 function only examines SPEC, but does not otherwise "handle" it, in
4426 the sense that it doesn't set up members of IT from the display
4429 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4430 Lisp_Object overlay
, struct text_pos
*position
,
4431 ptrdiff_t bufpos
, int frame_window_p
)
4433 int replacing_p
= 0;
4437 /* Simple specifications. */
4438 && !EQ (XCAR (spec
), Qimage
)
4439 && !EQ (XCAR (spec
), Qspace
)
4440 && !EQ (XCAR (spec
), Qwhen
)
4441 && !EQ (XCAR (spec
), Qslice
)
4442 && !EQ (XCAR (spec
), Qspace_width
)
4443 && !EQ (XCAR (spec
), Qheight
)
4444 && !EQ (XCAR (spec
), Qraise
)
4445 /* Marginal area specifications. */
4446 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4447 && !EQ (XCAR (spec
), Qleft_fringe
)
4448 && !EQ (XCAR (spec
), Qright_fringe
)
4449 && !NILP (XCAR (spec
)))
4451 for (; CONSP (spec
); spec
= XCDR (spec
))
4453 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4454 overlay
, position
, bufpos
,
4455 replacing_p
, frame_window_p
)))
4458 /* If some text in a string is replaced, `position' no
4459 longer points to the position of `object'. */
4460 if (!it
|| STRINGP (object
))
4465 else if (VECTORP (spec
))
4468 for (i
= 0; i
< ASIZE (spec
); ++i
)
4469 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4470 overlay
, position
, bufpos
,
4471 replacing_p
, frame_window_p
)))
4474 /* If some text in a string is replaced, `position' no
4475 longer points to the position of `object'. */
4476 if (!it
|| STRINGP (object
))
4482 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4483 position
, bufpos
, 0,
4491 /* Value is the position of the end of the `display' property starting
4492 at START_POS in OBJECT. */
4494 static struct text_pos
4495 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4498 struct text_pos end_pos
;
4500 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4501 Qdisplay
, object
, Qnil
);
4502 CHARPOS (end_pos
) = XFASTINT (end
);
4503 if (STRINGP (object
))
4504 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4506 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4512 /* Set up IT from a single `display' property specification SPEC. OBJECT
4513 is the object in which the `display' property was found. *POSITION
4514 is the position in OBJECT at which the `display' property was found.
4515 BUFPOS is the buffer position of OBJECT (different from POSITION if
4516 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4517 previously saw a display specification which already replaced text
4518 display with something else, for example an image; we ignore such
4519 properties after the first one has been processed.
4521 OVERLAY is the overlay this `display' property came from,
4522 or nil if it was a text property.
4524 If SPEC is a `space' or `image' specification, and in some other
4525 cases too, set *POSITION to the position where the `display'
4528 If IT is NULL, only examine the property specification in SPEC, but
4529 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4530 is intended to be displayed in a window on a GUI frame.
4532 Value is non-zero if something was found which replaces the display
4533 of buffer or string text. */
4536 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4537 Lisp_Object overlay
, struct text_pos
*position
,
4538 ptrdiff_t bufpos
, int display_replaced_p
,
4542 Lisp_Object location
, value
;
4543 struct text_pos start_pos
= *position
;
4546 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4547 If the result is non-nil, use VALUE instead of SPEC. */
4549 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4558 if (!NILP (form
) && !EQ (form
, Qt
))
4560 ptrdiff_t count
= SPECPDL_INDEX ();
4561 struct gcpro gcpro1
;
4563 /* Bind `object' to the object having the `display' property, a
4564 buffer or string. Bind `position' to the position in the
4565 object where the property was found, and `buffer-position'
4566 to the current position in the buffer. */
4569 XSETBUFFER (object
, current_buffer
);
4570 specbind (Qobject
, object
);
4571 specbind (Qposition
, make_number (CHARPOS (*position
)));
4572 specbind (Qbuffer_position
, make_number (bufpos
));
4574 form
= safe_eval (form
);
4576 unbind_to (count
, Qnil
);
4582 /* Handle `(height HEIGHT)' specifications. */
4584 && EQ (XCAR (spec
), Qheight
)
4585 && CONSP (XCDR (spec
)))
4589 if (!FRAME_WINDOW_P (it
->f
))
4592 it
->font_height
= XCAR (XCDR (spec
));
4593 if (!NILP (it
->font_height
))
4595 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4596 int new_height
= -1;
4598 if (CONSP (it
->font_height
)
4599 && (EQ (XCAR (it
->font_height
), Qplus
)
4600 || EQ (XCAR (it
->font_height
), Qminus
))
4601 && CONSP (XCDR (it
->font_height
))
4602 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4604 /* `(+ N)' or `(- N)' where N is an integer. */
4605 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4606 if (EQ (XCAR (it
->font_height
), Qplus
))
4608 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4610 else if (FUNCTIONP (it
->font_height
))
4612 /* Call function with current height as argument.
4613 Value is the new height. */
4615 height
= safe_call1 (it
->font_height
,
4616 face
->lface
[LFACE_HEIGHT_INDEX
]);
4617 if (NUMBERP (height
))
4618 new_height
= XFLOATINT (height
);
4620 else if (NUMBERP (it
->font_height
))
4622 /* Value is a multiple of the canonical char height. */
4625 f
= FACE_FROM_ID (it
->f
,
4626 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4627 new_height
= (XFLOATINT (it
->font_height
)
4628 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4632 /* Evaluate IT->font_height with `height' bound to the
4633 current specified height to get the new height. */
4634 ptrdiff_t count
= SPECPDL_INDEX ();
4636 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4637 value
= safe_eval (it
->font_height
);
4638 unbind_to (count
, Qnil
);
4640 if (NUMBERP (value
))
4641 new_height
= XFLOATINT (value
);
4645 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4652 /* Handle `(space-width WIDTH)'. */
4654 && EQ (XCAR (spec
), Qspace_width
)
4655 && CONSP (XCDR (spec
)))
4659 if (!FRAME_WINDOW_P (it
->f
))
4662 value
= XCAR (XCDR (spec
));
4663 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4664 it
->space_width
= value
;
4670 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4672 && EQ (XCAR (spec
), Qslice
))
4678 if (!FRAME_WINDOW_P (it
->f
))
4681 if (tem
= XCDR (spec
), CONSP (tem
))
4683 it
->slice
.x
= XCAR (tem
);
4684 if (tem
= XCDR (tem
), CONSP (tem
))
4686 it
->slice
.y
= XCAR (tem
);
4687 if (tem
= XCDR (tem
), CONSP (tem
))
4689 it
->slice
.width
= XCAR (tem
);
4690 if (tem
= XCDR (tem
), CONSP (tem
))
4691 it
->slice
.height
= XCAR (tem
);
4700 /* Handle `(raise FACTOR)'. */
4702 && EQ (XCAR (spec
), Qraise
)
4703 && CONSP (XCDR (spec
)))
4707 if (!FRAME_WINDOW_P (it
->f
))
4710 #ifdef HAVE_WINDOW_SYSTEM
4711 value
= XCAR (XCDR (spec
));
4712 if (NUMBERP (value
))
4714 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4715 it
->voffset
= - (XFLOATINT (value
)
4716 * (FONT_HEIGHT (face
->font
)));
4718 #endif /* HAVE_WINDOW_SYSTEM */
4724 /* Don't handle the other kinds of display specifications
4725 inside a string that we got from a `display' property. */
4726 if (it
&& it
->string_from_display_prop_p
)
4729 /* Characters having this form of property are not displayed, so
4730 we have to find the end of the property. */
4733 start_pos
= *position
;
4734 *position
= display_prop_end (it
, object
, start_pos
);
4738 /* Stop the scan at that end position--we assume that all
4739 text properties change there. */
4741 it
->stop_charpos
= position
->charpos
;
4743 /* Handle `(left-fringe BITMAP [FACE])'
4744 and `(right-fringe BITMAP [FACE])'. */
4746 && (EQ (XCAR (spec
), Qleft_fringe
)
4747 || EQ (XCAR (spec
), Qright_fringe
))
4748 && CONSP (XCDR (spec
)))
4754 if (!FRAME_WINDOW_P (it
->f
))
4755 /* If we return here, POSITION has been advanced
4756 across the text with this property. */
4758 /* Synchronize the bidi iterator with POSITION. This is
4759 needed because we are not going to push the iterator
4760 on behalf of this display property, so there will be
4761 no pop_it call to do this synchronization for us. */
4764 it
->position
= *position
;
4765 iterate_out_of_display_property (it
);
4766 *position
= it
->position
;
4771 else if (!frame_window_p
)
4774 #ifdef HAVE_WINDOW_SYSTEM
4775 value
= XCAR (XCDR (spec
));
4776 if (!SYMBOLP (value
)
4777 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4778 /* If we return here, POSITION has been advanced
4779 across the text with this property. */
4781 if (it
&& it
->bidi_p
)
4783 it
->position
= *position
;
4784 iterate_out_of_display_property (it
);
4785 *position
= it
->position
;
4792 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4794 if (CONSP (XCDR (XCDR (spec
))))
4796 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4797 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4803 /* Save current settings of IT so that we can restore them
4804 when we are finished with the glyph property value. */
4805 push_it (it
, position
);
4807 it
->area
= TEXT_AREA
;
4808 it
->what
= IT_IMAGE
;
4809 it
->image_id
= -1; /* no image */
4810 it
->position
= start_pos
;
4811 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4812 it
->method
= GET_FROM_IMAGE
;
4813 it
->from_overlay
= Qnil
;
4814 it
->face_id
= face_id
;
4815 it
->from_disp_prop_p
= 1;
4817 /* Say that we haven't consumed the characters with
4818 `display' property yet. The call to pop_it in
4819 set_iterator_to_next will clean this up. */
4820 *position
= start_pos
;
4822 if (EQ (XCAR (spec
), Qleft_fringe
))
4824 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4825 it
->left_user_fringe_face_id
= face_id
;
4829 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4830 it
->right_user_fringe_face_id
= face_id
;
4833 #endif /* HAVE_WINDOW_SYSTEM */
4837 /* Prepare to handle `((margin left-margin) ...)',
4838 `((margin right-margin) ...)' and `((margin nil) ...)'
4839 prefixes for display specifications. */
4840 location
= Qunbound
;
4841 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4845 value
= XCDR (spec
);
4847 value
= XCAR (value
);
4850 if (EQ (XCAR (tem
), Qmargin
)
4851 && (tem
= XCDR (tem
),
4852 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4854 || EQ (tem
, Qleft_margin
)
4855 || EQ (tem
, Qright_margin
))))
4859 if (EQ (location
, Qunbound
))
4865 /* After this point, VALUE is the property after any
4866 margin prefix has been stripped. It must be a string,
4867 an image specification, or `(space ...)'.
4869 LOCATION specifies where to display: `left-margin',
4870 `right-margin' or nil. */
4872 valid_p
= (STRINGP (value
)
4873 #ifdef HAVE_WINDOW_SYSTEM
4874 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4875 && valid_image_p (value
))
4876 #endif /* not HAVE_WINDOW_SYSTEM */
4877 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4879 if (valid_p
&& !display_replaced_p
)
4885 /* Callers need to know whether the display spec is any kind
4886 of `(space ...)' spec that is about to affect text-area
4888 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4893 /* Save current settings of IT so that we can restore them
4894 when we are finished with the glyph property value. */
4895 push_it (it
, position
);
4896 it
->from_overlay
= overlay
;
4897 it
->from_disp_prop_p
= 1;
4899 if (NILP (location
))
4900 it
->area
= TEXT_AREA
;
4901 else if (EQ (location
, Qleft_margin
))
4902 it
->area
= LEFT_MARGIN_AREA
;
4904 it
->area
= RIGHT_MARGIN_AREA
;
4906 if (STRINGP (value
))
4909 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4910 it
->current
.overlay_string_index
= -1;
4911 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4912 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4913 it
->method
= GET_FROM_STRING
;
4914 it
->stop_charpos
= 0;
4916 it
->base_level_stop
= 0;
4917 it
->string_from_display_prop_p
= 1;
4918 /* Say that we haven't consumed the characters with
4919 `display' property yet. The call to pop_it in
4920 set_iterator_to_next will clean this up. */
4921 if (BUFFERP (object
))
4922 *position
= start_pos
;
4924 /* Force paragraph direction to be that of the parent
4925 object. If the parent object's paragraph direction is
4926 not yet determined, default to L2R. */
4927 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4928 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4930 it
->paragraph_embedding
= L2R
;
4932 /* Set up the bidi iterator for this display string. */
4935 it
->bidi_it
.string
.lstring
= it
->string
;
4936 it
->bidi_it
.string
.s
= NULL
;
4937 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4938 it
->bidi_it
.string
.bufpos
= bufpos
;
4939 it
->bidi_it
.string
.from_disp_str
= 1;
4940 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4941 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4944 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4946 it
->method
= GET_FROM_STRETCH
;
4948 *position
= it
->position
= start_pos
;
4949 retval
= 1 + (it
->area
== TEXT_AREA
);
4951 #ifdef HAVE_WINDOW_SYSTEM
4954 it
->what
= IT_IMAGE
;
4955 it
->image_id
= lookup_image (it
->f
, value
);
4956 it
->position
= start_pos
;
4957 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4958 it
->method
= GET_FROM_IMAGE
;
4960 /* Say that we haven't consumed the characters with
4961 `display' property yet. The call to pop_it in
4962 set_iterator_to_next will clean this up. */
4963 *position
= start_pos
;
4965 #endif /* HAVE_WINDOW_SYSTEM */
4970 /* Invalid property or property not supported. Restore
4971 POSITION to what it was before. */
4972 *position
= start_pos
;
4976 /* Check if PROP is a display property value whose text should be
4977 treated as intangible. OVERLAY is the overlay from which PROP
4978 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4979 specify the buffer position covered by PROP. */
4982 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4983 ptrdiff_t charpos
, ptrdiff_t bytepos
)
4985 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4986 struct text_pos position
;
4988 SET_TEXT_POS (position
, charpos
, bytepos
);
4989 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4990 &position
, charpos
, frame_window_p
);
4994 /* Return 1 if PROP is a display sub-property value containing STRING.
4996 Implementation note: this and the following function are really
4997 special cases of handle_display_spec and
4998 handle_single_display_spec, and should ideally use the same code.
4999 Until they do, these two pairs must be consistent and must be
5000 modified in sync. */
5003 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5005 if (EQ (string
, prop
))
5008 /* Skip over `when FORM'. */
5009 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5014 /* Actually, the condition following `when' should be eval'ed,
5015 like handle_single_display_spec does, and we should return
5016 zero if it evaluates to nil. However, this function is
5017 called only when the buffer was already displayed and some
5018 glyph in the glyph matrix was found to come from a display
5019 string. Therefore, the condition was already evaluated, and
5020 the result was non-nil, otherwise the display string wouldn't
5021 have been displayed and we would have never been called for
5022 this property. Thus, we can skip the evaluation and assume
5023 its result is non-nil. */
5028 /* Skip over `margin LOCATION'. */
5029 if (EQ (XCAR (prop
), Qmargin
))
5040 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5044 /* Return 1 if STRING appears in the `display' property PROP. */
5047 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5050 && !EQ (XCAR (prop
), Qwhen
)
5051 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5053 /* A list of sub-properties. */
5054 while (CONSP (prop
))
5056 if (single_display_spec_string_p (XCAR (prop
), string
))
5061 else if (VECTORP (prop
))
5063 /* A vector of sub-properties. */
5065 for (i
= 0; i
< ASIZE (prop
); ++i
)
5066 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5070 return single_display_spec_string_p (prop
, string
);
5075 /* Look for STRING in overlays and text properties in the current
5076 buffer, between character positions FROM and TO (excluding TO).
5077 BACK_P non-zero means look back (in this case, TO is supposed to be
5079 Value is the first character position where STRING was found, or
5080 zero if it wasn't found before hitting TO.
5082 This function may only use code that doesn't eval because it is
5083 called asynchronously from note_mouse_highlight. */
5086 string_buffer_position_lim (Lisp_Object string
,
5087 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5089 Lisp_Object limit
, prop
, pos
;
5092 pos
= make_number (max (from
, BEGV
));
5094 if (!back_p
) /* looking forward */
5096 limit
= make_number (min (to
, ZV
));
5097 while (!found
&& !EQ (pos
, limit
))
5099 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5100 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5103 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5107 else /* looking back */
5109 limit
= make_number (max (to
, BEGV
));
5110 while (!found
&& !EQ (pos
, limit
))
5112 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5113 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5116 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5121 return found
? XINT (pos
) : 0;
5124 /* Determine which buffer position in current buffer STRING comes from.
5125 AROUND_CHARPOS is an approximate position where it could come from.
5126 Value is the buffer position or 0 if it couldn't be determined.
5128 This function is necessary because we don't record buffer positions
5129 in glyphs generated from strings (to keep struct glyph small).
5130 This function may only use code that doesn't eval because it is
5131 called asynchronously from note_mouse_highlight. */
5134 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5136 const int MAX_DISTANCE
= 1000;
5137 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5138 around_charpos
+ MAX_DISTANCE
,
5142 found
= string_buffer_position_lim (string
, around_charpos
,
5143 around_charpos
- MAX_DISTANCE
, 1);
5149 /***********************************************************************
5150 `composition' property
5151 ***********************************************************************/
5153 /* Set up iterator IT from `composition' property at its current
5154 position. Called from handle_stop. */
5156 static enum prop_handled
5157 handle_composition_prop (struct it
*it
)
5159 Lisp_Object prop
, string
;
5160 ptrdiff_t pos
, pos_byte
, start
, end
;
5162 if (STRINGP (it
->string
))
5166 pos
= IT_STRING_CHARPOS (*it
);
5167 pos_byte
= IT_STRING_BYTEPOS (*it
);
5168 string
= it
->string
;
5169 s
= SDATA (string
) + pos_byte
;
5170 it
->c
= STRING_CHAR (s
);
5174 pos
= IT_CHARPOS (*it
);
5175 pos_byte
= IT_BYTEPOS (*it
);
5177 it
->c
= FETCH_CHAR (pos_byte
);
5180 /* If there's a valid composition and point is not inside of the
5181 composition (in the case that the composition is from the current
5182 buffer), draw a glyph composed from the composition components. */
5183 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5184 && COMPOSITION_VALID_P (start
, end
, prop
)
5185 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5188 /* As we can't handle this situation (perhaps font-lock added
5189 a new composition), we just return here hoping that next
5190 redisplay will detect this composition much earlier. */
5191 return HANDLED_NORMALLY
;
5194 if (STRINGP (it
->string
))
5195 pos_byte
= string_char_to_byte (it
->string
, start
);
5197 pos_byte
= CHAR_TO_BYTE (start
);
5199 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5202 if (it
->cmp_it
.id
>= 0)
5205 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5206 it
->cmp_it
.nglyphs
= -1;
5210 return HANDLED_NORMALLY
;
5215 /***********************************************************************
5217 ***********************************************************************/
5219 /* The following structure is used to record overlay strings for
5220 later sorting in load_overlay_strings. */
5222 struct overlay_entry
5224 Lisp_Object overlay
;
5231 /* Set up iterator IT from overlay strings at its current position.
5232 Called from handle_stop. */
5234 static enum prop_handled
5235 handle_overlay_change (struct it
*it
)
5237 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5238 return HANDLED_RECOMPUTE_PROPS
;
5240 return HANDLED_NORMALLY
;
5244 /* Set up the next overlay string for delivery by IT, if there is an
5245 overlay string to deliver. Called by set_iterator_to_next when the
5246 end of the current overlay string is reached. If there are more
5247 overlay strings to display, IT->string and
5248 IT->current.overlay_string_index are set appropriately here.
5249 Otherwise IT->string is set to nil. */
5252 next_overlay_string (struct it
*it
)
5254 ++it
->current
.overlay_string_index
;
5255 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5257 /* No more overlay strings. Restore IT's settings to what
5258 they were before overlay strings were processed, and
5259 continue to deliver from current_buffer. */
5261 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5264 || (NILP (it
->string
)
5265 && it
->method
== GET_FROM_BUFFER
5266 && it
->stop_charpos
>= BEGV
5267 && it
->stop_charpos
<= it
->end_charpos
));
5268 it
->current
.overlay_string_index
= -1;
5269 it
->n_overlay_strings
= 0;
5270 it
->overlay_strings_charpos
= -1;
5271 /* If there's an empty display string on the stack, pop the
5272 stack, to resync the bidi iterator with IT's position. Such
5273 empty strings are pushed onto the stack in
5274 get_overlay_strings_1. */
5275 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5278 /* If we're at the end of the buffer, record that we have
5279 processed the overlay strings there already, so that
5280 next_element_from_buffer doesn't try it again. */
5281 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5282 it
->overlay_strings_at_end_processed_p
= 1;
5286 /* There are more overlay strings to process. If
5287 IT->current.overlay_string_index has advanced to a position
5288 where we must load IT->overlay_strings with more strings, do
5289 it. We must load at the IT->overlay_strings_charpos where
5290 IT->n_overlay_strings was originally computed; when invisible
5291 text is present, this might not be IT_CHARPOS (Bug#7016). */
5292 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5294 if (it
->current
.overlay_string_index
&& i
== 0)
5295 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5297 /* Initialize IT to deliver display elements from the overlay
5299 it
->string
= it
->overlay_strings
[i
];
5300 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5301 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5302 it
->method
= GET_FROM_STRING
;
5303 it
->stop_charpos
= 0;
5304 if (it
->cmp_it
.stop_pos
>= 0)
5305 it
->cmp_it
.stop_pos
= 0;
5307 it
->base_level_stop
= 0;
5309 /* Set up the bidi iterator for this overlay string. */
5312 it
->bidi_it
.string
.lstring
= it
->string
;
5313 it
->bidi_it
.string
.s
= NULL
;
5314 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5315 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5316 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5317 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5318 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5326 /* Compare two overlay_entry structures E1 and E2. Used as a
5327 comparison function for qsort in load_overlay_strings. Overlay
5328 strings for the same position are sorted so that
5330 1. All after-strings come in front of before-strings, except
5331 when they come from the same overlay.
5333 2. Within after-strings, strings are sorted so that overlay strings
5334 from overlays with higher priorities come first.
5336 2. Within before-strings, strings are sorted so that overlay
5337 strings from overlays with higher priorities come last.
5339 Value is analogous to strcmp. */
5343 compare_overlay_entries (const void *e1
, const void *e2
)
5345 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5346 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5349 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5351 /* Let after-strings appear in front of before-strings if
5352 they come from different overlays. */
5353 if (EQ (entry1
->overlay
, entry2
->overlay
))
5354 result
= entry1
->after_string_p
? 1 : -1;
5356 result
= entry1
->after_string_p
? -1 : 1;
5358 else if (entry1
->priority
!= entry2
->priority
)
5360 if (entry1
->after_string_p
)
5361 /* After-strings sorted in order of decreasing priority. */
5362 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5364 /* Before-strings sorted in order of increasing priority. */
5365 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5374 /* Load the vector IT->overlay_strings with overlay strings from IT's
5375 current buffer position, or from CHARPOS if that is > 0. Set
5376 IT->n_overlays to the total number of overlay strings found.
5378 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5379 a time. On entry into load_overlay_strings,
5380 IT->current.overlay_string_index gives the number of overlay
5381 strings that have already been loaded by previous calls to this
5384 IT->add_overlay_start contains an additional overlay start
5385 position to consider for taking overlay strings from, if non-zero.
5386 This position comes into play when the overlay has an `invisible'
5387 property, and both before and after-strings. When we've skipped to
5388 the end of the overlay, because of its `invisible' property, we
5389 nevertheless want its before-string to appear.
5390 IT->add_overlay_start will contain the overlay start position
5393 Overlay strings are sorted so that after-string strings come in
5394 front of before-string strings. Within before and after-strings,
5395 strings are sorted by overlay priority. See also function
5396 compare_overlay_entries. */
5399 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5401 Lisp_Object overlay
, window
, str
, invisible
;
5402 struct Lisp_Overlay
*ov
;
5403 ptrdiff_t start
, end
;
5404 ptrdiff_t size
= 20;
5405 ptrdiff_t n
= 0, i
, j
;
5407 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5411 charpos
= IT_CHARPOS (*it
);
5413 /* Append the overlay string STRING of overlay OVERLAY to vector
5414 `entries' which has size `size' and currently contains `n'
5415 elements. AFTER_P non-zero means STRING is an after-string of
5417 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5420 Lisp_Object priority; \
5424 struct overlay_entry *old = entries; \
5425 SAFE_NALLOCA (entries, 2, size); \
5426 memcpy (entries, old, size * sizeof *entries); \
5430 entries[n].string = (STRING); \
5431 entries[n].overlay = (OVERLAY); \
5432 priority = Foverlay_get ((OVERLAY), Qpriority); \
5433 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5434 entries[n].after_string_p = (AFTER_P); \
5439 /* Process overlay before the overlay center. */
5440 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5442 XSETMISC (overlay
, ov
);
5443 eassert (OVERLAYP (overlay
));
5444 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5445 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5450 /* Skip this overlay if it doesn't start or end at IT's current
5452 if (end
!= charpos
&& start
!= charpos
)
5455 /* Skip this overlay if it doesn't apply to IT->w. */
5456 window
= Foverlay_get (overlay
, Qwindow
);
5457 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5460 /* If the text ``under'' the overlay is invisible, both before-
5461 and after-strings from this overlay are visible; start and
5462 end position are indistinguishable. */
5463 invisible
= Foverlay_get (overlay
, Qinvisible
);
5464 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5466 /* If overlay has a non-empty before-string, record it. */
5467 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5468 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5470 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5472 /* If overlay has a non-empty after-string, record it. */
5473 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5474 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5476 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5479 /* Process overlays after the overlay center. */
5480 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5482 XSETMISC (overlay
, ov
);
5483 eassert (OVERLAYP (overlay
));
5484 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5485 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5487 if (start
> charpos
)
5490 /* Skip this overlay if it doesn't start or end at IT's current
5492 if (end
!= charpos
&& start
!= charpos
)
5495 /* Skip this overlay if it doesn't apply to IT->w. */
5496 window
= Foverlay_get (overlay
, Qwindow
);
5497 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5500 /* If the text ``under'' the overlay is invisible, it has a zero
5501 dimension, and both before- and after-strings apply. */
5502 invisible
= Foverlay_get (overlay
, Qinvisible
);
5503 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5505 /* If overlay has a non-empty before-string, record it. */
5506 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5507 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5509 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5511 /* If overlay has a non-empty after-string, record it. */
5512 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5513 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5515 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5518 #undef RECORD_OVERLAY_STRING
5522 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5524 /* Record number of overlay strings, and where we computed it. */
5525 it
->n_overlay_strings
= n
;
5526 it
->overlay_strings_charpos
= charpos
;
5528 /* IT->current.overlay_string_index is the number of overlay strings
5529 that have already been consumed by IT. Copy some of the
5530 remaining overlay strings to IT->overlay_strings. */
5532 j
= it
->current
.overlay_string_index
;
5533 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5535 it
->overlay_strings
[i
] = entries
[j
].string
;
5536 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5544 /* Get the first chunk of overlay strings at IT's current buffer
5545 position, or at CHARPOS if that is > 0. Value is non-zero if at
5546 least one overlay string was found. */
5549 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5551 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5552 process. This fills IT->overlay_strings with strings, and sets
5553 IT->n_overlay_strings to the total number of strings to process.
5554 IT->pos.overlay_string_index has to be set temporarily to zero
5555 because load_overlay_strings needs this; it must be set to -1
5556 when no overlay strings are found because a zero value would
5557 indicate a position in the first overlay string. */
5558 it
->current
.overlay_string_index
= 0;
5559 load_overlay_strings (it
, charpos
);
5561 /* If we found overlay strings, set up IT to deliver display
5562 elements from the first one. Otherwise set up IT to deliver
5563 from current_buffer. */
5564 if (it
->n_overlay_strings
)
5566 /* Make sure we know settings in current_buffer, so that we can
5567 restore meaningful values when we're done with the overlay
5570 compute_stop_pos (it
);
5571 eassert (it
->face_id
>= 0);
5573 /* Save IT's settings. They are restored after all overlay
5574 strings have been processed. */
5575 eassert (!compute_stop_p
|| it
->sp
== 0);
5577 /* When called from handle_stop, there might be an empty display
5578 string loaded. In that case, don't bother saving it. But
5579 don't use this optimization with the bidi iterator, since we
5580 need the corresponding pop_it call to resync the bidi
5581 iterator's position with IT's position, after we are done
5582 with the overlay strings. (The corresponding call to pop_it
5583 in case of an empty display string is in
5584 next_overlay_string.) */
5586 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5589 /* Set up IT to deliver display elements from the first overlay
5591 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5592 it
->string
= it
->overlay_strings
[0];
5593 it
->from_overlay
= Qnil
;
5594 it
->stop_charpos
= 0;
5595 eassert (STRINGP (it
->string
));
5596 it
->end_charpos
= SCHARS (it
->string
);
5598 it
->base_level_stop
= 0;
5599 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5600 it
->method
= GET_FROM_STRING
;
5601 it
->from_disp_prop_p
= 0;
5603 /* Force paragraph direction to be that of the parent
5605 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5606 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5608 it
->paragraph_embedding
= L2R
;
5610 /* Set up the bidi iterator for this overlay string. */
5613 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5615 it
->bidi_it
.string
.lstring
= it
->string
;
5616 it
->bidi_it
.string
.s
= NULL
;
5617 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5618 it
->bidi_it
.string
.bufpos
= pos
;
5619 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5620 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5621 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5626 it
->current
.overlay_string_index
= -1;
5631 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5634 it
->method
= GET_FROM_BUFFER
;
5636 (void) get_overlay_strings_1 (it
, charpos
, 1);
5640 /* Value is non-zero if we found at least one overlay string. */
5641 return STRINGP (it
->string
);
5646 /***********************************************************************
5647 Saving and restoring state
5648 ***********************************************************************/
5650 /* Save current settings of IT on IT->stack. Called, for example,
5651 before setting up IT for an overlay string, to be able to restore
5652 IT's settings to what they were after the overlay string has been
5653 processed. If POSITION is non-NULL, it is the position to save on
5654 the stack instead of IT->position. */
5657 push_it (struct it
*it
, struct text_pos
*position
)
5659 struct iterator_stack_entry
*p
;
5661 eassert (it
->sp
< IT_STACK_SIZE
);
5662 p
= it
->stack
+ it
->sp
;
5664 p
->stop_charpos
= it
->stop_charpos
;
5665 p
->prev_stop
= it
->prev_stop
;
5666 p
->base_level_stop
= it
->base_level_stop
;
5667 p
->cmp_it
= it
->cmp_it
;
5668 eassert (it
->face_id
>= 0);
5669 p
->face_id
= it
->face_id
;
5670 p
->string
= it
->string
;
5671 p
->method
= it
->method
;
5672 p
->from_overlay
= it
->from_overlay
;
5675 case GET_FROM_IMAGE
:
5676 p
->u
.image
.object
= it
->object
;
5677 p
->u
.image
.image_id
= it
->image_id
;
5678 p
->u
.image
.slice
= it
->slice
;
5680 case GET_FROM_STRETCH
:
5681 p
->u
.stretch
.object
= it
->object
;
5684 p
->position
= position
? *position
: it
->position
;
5685 p
->current
= it
->current
;
5686 p
->end_charpos
= it
->end_charpos
;
5687 p
->string_nchars
= it
->string_nchars
;
5689 p
->multibyte_p
= it
->multibyte_p
;
5690 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5691 p
->space_width
= it
->space_width
;
5692 p
->font_height
= it
->font_height
;
5693 p
->voffset
= it
->voffset
;
5694 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5695 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5696 p
->display_ellipsis_p
= 0;
5697 p
->line_wrap
= it
->line_wrap
;
5698 p
->bidi_p
= it
->bidi_p
;
5699 p
->paragraph_embedding
= it
->paragraph_embedding
;
5700 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5703 /* Save the state of the bidi iterator as well. */
5705 bidi_push_it (&it
->bidi_it
);
5709 iterate_out_of_display_property (struct it
*it
)
5711 int buffer_p
= !STRINGP (it
->string
);
5712 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5713 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5715 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5717 /* Maybe initialize paragraph direction. If we are at the beginning
5718 of a new paragraph, next_element_from_buffer may not have a
5719 chance to do that. */
5720 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5721 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5722 /* prev_stop can be zero, so check against BEGV as well. */
5723 while (it
->bidi_it
.charpos
>= bob
5724 && it
->prev_stop
<= it
->bidi_it
.charpos
5725 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5726 && it
->bidi_it
.charpos
< eob
)
5727 bidi_move_to_visually_next (&it
->bidi_it
);
5728 /* Record the stop_pos we just crossed, for when we cross it
5730 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5731 it
->prev_stop
= CHARPOS (it
->position
);
5732 /* If we ended up not where pop_it put us, resync IT's
5733 positional members with the bidi iterator. */
5734 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5735 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5737 it
->current
.pos
= it
->position
;
5739 it
->current
.string_pos
= it
->position
;
5742 /* Restore IT's settings from IT->stack. Called, for example, when no
5743 more overlay strings must be processed, and we return to delivering
5744 display elements from a buffer, or when the end of a string from a
5745 `display' property is reached and we return to delivering display
5746 elements from an overlay string, or from a buffer. */
5749 pop_it (struct it
*it
)
5751 struct iterator_stack_entry
*p
;
5752 int from_display_prop
= it
->from_disp_prop_p
;
5754 eassert (it
->sp
> 0);
5756 p
= it
->stack
+ it
->sp
;
5757 it
->stop_charpos
= p
->stop_charpos
;
5758 it
->prev_stop
= p
->prev_stop
;
5759 it
->base_level_stop
= p
->base_level_stop
;
5760 it
->cmp_it
= p
->cmp_it
;
5761 it
->face_id
= p
->face_id
;
5762 it
->current
= p
->current
;
5763 it
->position
= p
->position
;
5764 it
->string
= p
->string
;
5765 it
->from_overlay
= p
->from_overlay
;
5766 if (NILP (it
->string
))
5767 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5768 it
->method
= p
->method
;
5771 case GET_FROM_IMAGE
:
5772 it
->image_id
= p
->u
.image
.image_id
;
5773 it
->object
= p
->u
.image
.object
;
5774 it
->slice
= p
->u
.image
.slice
;
5776 case GET_FROM_STRETCH
:
5777 it
->object
= p
->u
.stretch
.object
;
5779 case GET_FROM_BUFFER
:
5780 it
->object
= it
->w
->buffer
;
5782 case GET_FROM_STRING
:
5783 it
->object
= it
->string
;
5785 case GET_FROM_DISPLAY_VECTOR
:
5787 it
->method
= GET_FROM_C_STRING
;
5788 else if (STRINGP (it
->string
))
5789 it
->method
= GET_FROM_STRING
;
5792 it
->method
= GET_FROM_BUFFER
;
5793 it
->object
= it
->w
->buffer
;
5796 it
->end_charpos
= p
->end_charpos
;
5797 it
->string_nchars
= p
->string_nchars
;
5799 it
->multibyte_p
= p
->multibyte_p
;
5800 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5801 it
->space_width
= p
->space_width
;
5802 it
->font_height
= p
->font_height
;
5803 it
->voffset
= p
->voffset
;
5804 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5805 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5806 it
->line_wrap
= p
->line_wrap
;
5807 it
->bidi_p
= p
->bidi_p
;
5808 it
->paragraph_embedding
= p
->paragraph_embedding
;
5809 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5812 bidi_pop_it (&it
->bidi_it
);
5813 /* Bidi-iterate until we get out of the portion of text, if any,
5814 covered by a `display' text property or by an overlay with
5815 `display' property. (We cannot just jump there, because the
5816 internal coherency of the bidi iterator state can not be
5817 preserved across such jumps.) We also must determine the
5818 paragraph base direction if the overlay we just processed is
5819 at the beginning of a new paragraph. */
5820 if (from_display_prop
5821 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5822 iterate_out_of_display_property (it
);
5824 eassert ((BUFFERP (it
->object
)
5825 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5826 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5827 || (STRINGP (it
->object
)
5828 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5829 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5830 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5836 /***********************************************************************
5838 ***********************************************************************/
5840 /* Set IT's current position to the previous line start. */
5843 back_to_previous_line_start (struct it
*it
)
5845 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5846 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5850 /* Move IT to the next line start.
5852 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5853 we skipped over part of the text (as opposed to moving the iterator
5854 continuously over the text). Otherwise, don't change the value
5857 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5858 iterator on the newline, if it was found.
5860 Newlines may come from buffer text, overlay strings, or strings
5861 displayed via the `display' property. That's the reason we can't
5862 simply use find_next_newline_no_quit.
5864 Note that this function may not skip over invisible text that is so
5865 because of text properties and immediately follows a newline. If
5866 it would, function reseat_at_next_visible_line_start, when called
5867 from set_iterator_to_next, would effectively make invisible
5868 characters following a newline part of the wrong glyph row, which
5869 leads to wrong cursor motion. */
5872 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5873 struct bidi_it
*bidi_it_prev
)
5875 ptrdiff_t old_selective
;
5876 int newline_found_p
, n
;
5877 const int MAX_NEWLINE_DISTANCE
= 500;
5879 /* If already on a newline, just consume it to avoid unintended
5880 skipping over invisible text below. */
5881 if (it
->what
== IT_CHARACTER
5883 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5885 if (it
->bidi_p
&& bidi_it_prev
)
5886 *bidi_it_prev
= it
->bidi_it
;
5887 set_iterator_to_next (it
, 0);
5892 /* Don't handle selective display in the following. It's (a)
5893 unnecessary because it's done by the caller, and (b) leads to an
5894 infinite recursion because next_element_from_ellipsis indirectly
5895 calls this function. */
5896 old_selective
= it
->selective
;
5899 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5900 from buffer text. */
5901 for (n
= newline_found_p
= 0;
5902 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5903 n
+= STRINGP (it
->string
) ? 0 : 1)
5905 if (!get_next_display_element (it
))
5907 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5908 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5909 *bidi_it_prev
= it
->bidi_it
;
5910 set_iterator_to_next (it
, 0);
5913 /* If we didn't find a newline near enough, see if we can use a
5915 if (!newline_found_p
)
5917 ptrdiff_t start
= IT_CHARPOS (*it
);
5918 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5921 eassert (!STRINGP (it
->string
));
5923 /* If there isn't any `display' property in sight, and no
5924 overlays, we can just use the position of the newline in
5926 if (it
->stop_charpos
>= limit
5927 || ((pos
= Fnext_single_property_change (make_number (start
),
5929 make_number (limit
)),
5931 && next_overlay_change (start
) == ZV
))
5935 IT_CHARPOS (*it
) = limit
;
5936 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5940 struct bidi_it bprev
;
5942 /* Help bidi.c avoid expensive searches for display
5943 properties and overlays, by telling it that there are
5944 none up to `limit'. */
5945 if (it
->bidi_it
.disp_pos
< limit
)
5947 it
->bidi_it
.disp_pos
= limit
;
5948 it
->bidi_it
.disp_prop
= 0;
5951 bprev
= it
->bidi_it
;
5952 bidi_move_to_visually_next (&it
->bidi_it
);
5953 } while (it
->bidi_it
.charpos
!= limit
);
5954 IT_CHARPOS (*it
) = limit
;
5955 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5957 *bidi_it_prev
= bprev
;
5959 *skipped_p
= newline_found_p
= 1;
5963 while (get_next_display_element (it
)
5964 && !newline_found_p
)
5966 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5967 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5968 *bidi_it_prev
= it
->bidi_it
;
5969 set_iterator_to_next (it
, 0);
5974 it
->selective
= old_selective
;
5975 return newline_found_p
;
5979 /* Set IT's current position to the previous visible line start. Skip
5980 invisible text that is so either due to text properties or due to
5981 selective display. Caution: this does not change IT->current_x and
5985 back_to_previous_visible_line_start (struct it
*it
)
5987 while (IT_CHARPOS (*it
) > BEGV
)
5989 back_to_previous_line_start (it
);
5991 if (IT_CHARPOS (*it
) <= BEGV
)
5994 /* If selective > 0, then lines indented more than its value are
5996 if (it
->selective
> 0
5997 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6001 /* Check the newline before point for invisibility. */
6004 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6005 Qinvisible
, it
->window
);
6006 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6010 if (IT_CHARPOS (*it
) <= BEGV
)
6015 void *it2data
= NULL
;
6018 Lisp_Object val
, overlay
;
6020 SAVE_IT (it2
, *it
, it2data
);
6022 /* If newline is part of a composition, continue from start of composition */
6023 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6024 && beg
< IT_CHARPOS (*it
))
6027 /* If newline is replaced by a display property, find start of overlay
6028 or interval and continue search from that point. */
6029 pos
= --IT_CHARPOS (it2
);
6032 bidi_unshelve_cache (NULL
, 0);
6033 it2
.string_from_display_prop_p
= 0;
6034 it2
.from_disp_prop_p
= 0;
6035 if (handle_display_prop (&it2
) == HANDLED_RETURN
6036 && !NILP (val
= get_char_property_and_overlay
6037 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6038 && (OVERLAYP (overlay
)
6039 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6040 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6042 RESTORE_IT (it
, it
, it2data
);
6046 /* Newline is not replaced by anything -- so we are done. */
6047 RESTORE_IT (it
, it
, it2data
);
6053 IT_CHARPOS (*it
) = beg
;
6054 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6058 it
->continuation_lines_width
= 0;
6060 eassert (IT_CHARPOS (*it
) >= BEGV
);
6061 eassert (IT_CHARPOS (*it
) == BEGV
6062 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6067 /* Reseat iterator IT at the previous visible line start. Skip
6068 invisible text that is so either due to text properties or due to
6069 selective display. At the end, update IT's overlay information,
6070 face information etc. */
6073 reseat_at_previous_visible_line_start (struct it
*it
)
6075 back_to_previous_visible_line_start (it
);
6076 reseat (it
, it
->current
.pos
, 1);
6081 /* Reseat iterator IT on the next visible line start in the current
6082 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6083 preceding the line start. Skip over invisible text that is so
6084 because of selective display. Compute faces, overlays etc at the
6085 new position. Note that this function does not skip over text that
6086 is invisible because of text properties. */
6089 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6091 int newline_found_p
, skipped_p
= 0;
6092 struct bidi_it bidi_it_prev
;
6094 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6096 /* Skip over lines that are invisible because they are indented
6097 more than the value of IT->selective. */
6098 if (it
->selective
> 0)
6099 while (IT_CHARPOS (*it
) < ZV
6100 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6103 eassert (IT_BYTEPOS (*it
) == BEGV
6104 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6106 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6109 /* Position on the newline if that's what's requested. */
6110 if (on_newline_p
&& newline_found_p
)
6112 if (STRINGP (it
->string
))
6114 if (IT_STRING_CHARPOS (*it
) > 0)
6118 --IT_STRING_CHARPOS (*it
);
6119 --IT_STRING_BYTEPOS (*it
);
6123 /* We need to restore the bidi iterator to the state
6124 it had on the newline, and resync the IT's
6125 position with that. */
6126 it
->bidi_it
= bidi_it_prev
;
6127 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6128 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6132 else if (IT_CHARPOS (*it
) > BEGV
)
6141 /* We need to restore the bidi iterator to the state it
6142 had on the newline and resync IT with that. */
6143 it
->bidi_it
= bidi_it_prev
;
6144 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6145 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6147 reseat (it
, it
->current
.pos
, 0);
6151 reseat (it
, it
->current
.pos
, 0);
6158 /***********************************************************************
6159 Changing an iterator's position
6160 ***********************************************************************/
6162 /* Change IT's current position to POS in current_buffer. If FORCE_P
6163 is non-zero, always check for text properties at the new position.
6164 Otherwise, text properties are only looked up if POS >=
6165 IT->check_charpos of a property. */
6168 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6170 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6172 reseat_1 (it
, pos
, 0);
6174 /* Determine where to check text properties. Avoid doing it
6175 where possible because text property lookup is very expensive. */
6177 || CHARPOS (pos
) > it
->stop_charpos
6178 || CHARPOS (pos
) < original_pos
)
6182 /* For bidi iteration, we need to prime prev_stop and
6183 base_level_stop with our best estimations. */
6184 /* Implementation note: Of course, POS is not necessarily a
6185 stop position, so assigning prev_pos to it is a lie; we
6186 should have called compute_stop_backwards. However, if
6187 the current buffer does not include any R2L characters,
6188 that call would be a waste of cycles, because the
6189 iterator will never move back, and thus never cross this
6190 "fake" stop position. So we delay that backward search
6191 until the time we really need it, in next_element_from_buffer. */
6192 if (CHARPOS (pos
) != it
->prev_stop
)
6193 it
->prev_stop
= CHARPOS (pos
);
6194 if (CHARPOS (pos
) < it
->base_level_stop
)
6195 it
->base_level_stop
= 0; /* meaning it's unknown */
6201 it
->prev_stop
= it
->base_level_stop
= 0;
6210 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6211 IT->stop_pos to POS, also. */
6214 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6216 /* Don't call this function when scanning a C string. */
6217 eassert (it
->s
== NULL
);
6219 /* POS must be a reasonable value. */
6220 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6222 it
->current
.pos
= it
->position
= pos
;
6223 it
->end_charpos
= ZV
;
6225 it
->current
.dpvec_index
= -1;
6226 it
->current
.overlay_string_index
= -1;
6227 IT_STRING_CHARPOS (*it
) = -1;
6228 IT_STRING_BYTEPOS (*it
) = -1;
6230 it
->method
= GET_FROM_BUFFER
;
6231 it
->object
= it
->w
->buffer
;
6232 it
->area
= TEXT_AREA
;
6233 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6235 it
->string_from_display_prop_p
= 0;
6236 it
->string_from_prefix_prop_p
= 0;
6238 it
->from_disp_prop_p
= 0;
6239 it
->face_before_selective_p
= 0;
6242 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6244 bidi_unshelve_cache (NULL
, 0);
6245 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6246 it
->bidi_it
.string
.s
= NULL
;
6247 it
->bidi_it
.string
.lstring
= Qnil
;
6248 it
->bidi_it
.string
.bufpos
= 0;
6249 it
->bidi_it
.string
.unibyte
= 0;
6254 it
->stop_charpos
= CHARPOS (pos
);
6255 it
->base_level_stop
= CHARPOS (pos
);
6260 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6261 If S is non-null, it is a C string to iterate over. Otherwise,
6262 STRING gives a Lisp string to iterate over.
6264 If PRECISION > 0, don't return more then PRECISION number of
6265 characters from the string.
6267 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6268 characters have been returned. FIELD_WIDTH < 0 means an infinite
6271 MULTIBYTE = 0 means disable processing of multibyte characters,
6272 MULTIBYTE > 0 means enable it,
6273 MULTIBYTE < 0 means use IT->multibyte_p.
6275 IT must be initialized via a prior call to init_iterator before
6276 calling this function. */
6279 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6280 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6283 /* No region in strings. */
6284 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6286 /* No text property checks performed by default, but see below. */
6287 it
->stop_charpos
= -1;
6289 /* Set iterator position and end position. */
6290 memset (&it
->current
, 0, sizeof it
->current
);
6291 it
->current
.overlay_string_index
= -1;
6292 it
->current
.dpvec_index
= -1;
6293 eassert (charpos
>= 0);
6295 /* If STRING is specified, use its multibyteness, otherwise use the
6296 setting of MULTIBYTE, if specified. */
6298 it
->multibyte_p
= multibyte
> 0;
6300 /* Bidirectional reordering of strings is controlled by the default
6301 value of bidi-display-reordering. Don't try to reorder while
6302 loading loadup.el, as the necessary character property tables are
6303 not yet available. */
6306 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6310 eassert (STRINGP (string
));
6311 it
->string
= string
;
6313 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6314 it
->method
= GET_FROM_STRING
;
6315 it
->current
.string_pos
= string_pos (charpos
, string
);
6319 it
->bidi_it
.string
.lstring
= string
;
6320 it
->bidi_it
.string
.s
= NULL
;
6321 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6322 it
->bidi_it
.string
.bufpos
= 0;
6323 it
->bidi_it
.string
.from_disp_str
= 0;
6324 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6325 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6326 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6331 it
->s
= (const unsigned char *) s
;
6334 /* Note that we use IT->current.pos, not it->current.string_pos,
6335 for displaying C strings. */
6336 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6337 if (it
->multibyte_p
)
6339 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6340 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6344 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6345 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6350 it
->bidi_it
.string
.lstring
= Qnil
;
6351 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6352 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6353 it
->bidi_it
.string
.bufpos
= 0;
6354 it
->bidi_it
.string
.from_disp_str
= 0;
6355 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6356 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6359 it
->method
= GET_FROM_C_STRING
;
6362 /* PRECISION > 0 means don't return more than PRECISION characters
6364 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6366 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6368 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6371 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6372 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6373 FIELD_WIDTH < 0 means infinite field width. This is useful for
6374 padding with `-' at the end of a mode line. */
6375 if (field_width
< 0)
6376 field_width
= INFINITY
;
6377 /* Implementation note: We deliberately don't enlarge
6378 it->bidi_it.string.schars here to fit it->end_charpos, because
6379 the bidi iterator cannot produce characters out of thin air. */
6380 if (field_width
> it
->end_charpos
- charpos
)
6381 it
->end_charpos
= charpos
+ field_width
;
6383 /* Use the standard display table for displaying strings. */
6384 if (DISP_TABLE_P (Vstandard_display_table
))
6385 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6387 it
->stop_charpos
= charpos
;
6388 it
->prev_stop
= charpos
;
6389 it
->base_level_stop
= 0;
6392 it
->bidi_it
.first_elt
= 1;
6393 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6394 it
->bidi_it
.disp_pos
= -1;
6396 if (s
== NULL
&& it
->multibyte_p
)
6398 ptrdiff_t endpos
= SCHARS (it
->string
);
6399 if (endpos
> it
->end_charpos
)
6400 endpos
= it
->end_charpos
;
6401 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6409 /***********************************************************************
6411 ***********************************************************************/
6413 /* Map enum it_method value to corresponding next_element_from_* function. */
6415 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6417 next_element_from_buffer
,
6418 next_element_from_display_vector
,
6419 next_element_from_string
,
6420 next_element_from_c_string
,
6421 next_element_from_image
,
6422 next_element_from_stretch
6425 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6428 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6429 (possibly with the following characters). */
6431 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6432 ((IT)->cmp_it.id >= 0 \
6433 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6434 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6435 END_CHARPOS, (IT)->w, \
6436 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6440 /* Lookup the char-table Vglyphless_char_display for character C (-1
6441 if we want information for no-font case), and return the display
6442 method symbol. By side-effect, update it->what and
6443 it->glyphless_method. This function is called from
6444 get_next_display_element for each character element, and from
6445 x_produce_glyphs when no suitable font was found. */
6448 lookup_glyphless_char_display (int c
, struct it
*it
)
6450 Lisp_Object glyphless_method
= Qnil
;
6452 if (CHAR_TABLE_P (Vglyphless_char_display
)
6453 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6457 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6458 if (CONSP (glyphless_method
))
6459 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6460 ? XCAR (glyphless_method
)
6461 : XCDR (glyphless_method
);
6464 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6468 if (NILP (glyphless_method
))
6471 /* The default is to display the character by a proper font. */
6473 /* The default for the no-font case is to display an empty box. */
6474 glyphless_method
= Qempty_box
;
6476 if (EQ (glyphless_method
, Qzero_width
))
6479 return glyphless_method
;
6480 /* This method can't be used for the no-font case. */
6481 glyphless_method
= Qempty_box
;
6483 if (EQ (glyphless_method
, Qthin_space
))
6484 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6485 else if (EQ (glyphless_method
, Qempty_box
))
6486 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6487 else if (EQ (glyphless_method
, Qhex_code
))
6488 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6489 else if (STRINGP (glyphless_method
))
6490 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6493 /* Invalid value. We use the default method. */
6494 glyphless_method
= Qnil
;
6497 it
->what
= IT_GLYPHLESS
;
6498 return glyphless_method
;
6501 /* Load IT's display element fields with information about the next
6502 display element from the current position of IT. Value is zero if
6503 end of buffer (or C string) is reached. */
6505 static struct frame
*last_escape_glyph_frame
= NULL
;
6506 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6507 static int last_escape_glyph_merged_face_id
= 0;
6509 struct frame
*last_glyphless_glyph_frame
= NULL
;
6510 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6511 int last_glyphless_glyph_merged_face_id
= 0;
6514 get_next_display_element (struct it
*it
)
6516 /* Non-zero means that we found a display element. Zero means that
6517 we hit the end of what we iterate over. Performance note: the
6518 function pointer `method' used here turns out to be faster than
6519 using a sequence of if-statements. */
6523 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6525 if (it
->what
== IT_CHARACTER
)
6527 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6528 and only if (a) the resolved directionality of that character
6530 /* FIXME: Do we need an exception for characters from display
6532 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6533 it
->c
= bidi_mirror_char (it
->c
);
6534 /* Map via display table or translate control characters.
6535 IT->c, IT->len etc. have been set to the next character by
6536 the function call above. If we have a display table, and it
6537 contains an entry for IT->c, translate it. Don't do this if
6538 IT->c itself comes from a display table, otherwise we could
6539 end up in an infinite recursion. (An alternative could be to
6540 count the recursion depth of this function and signal an
6541 error when a certain maximum depth is reached.) Is it worth
6543 if (success_p
&& it
->dpvec
== NULL
)
6546 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6547 int nonascii_space_p
= 0;
6548 int nonascii_hyphen_p
= 0;
6549 int c
= it
->c
; /* This is the character to display. */
6551 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6553 eassert (SINGLE_BYTE_CHAR_P (c
));
6554 if (unibyte_display_via_language_environment
)
6556 c
= DECODE_CHAR (unibyte
, c
);
6558 c
= BYTE8_TO_CHAR (it
->c
);
6561 c
= BYTE8_TO_CHAR (it
->c
);
6565 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6568 struct Lisp_Vector
*v
= XVECTOR (dv
);
6570 /* Return the first character from the display table
6571 entry, if not empty. If empty, don't display the
6572 current character. */
6575 it
->dpvec_char_len
= it
->len
;
6576 it
->dpvec
= v
->contents
;
6577 it
->dpend
= v
->contents
+ v
->header
.size
;
6578 it
->current
.dpvec_index
= 0;
6579 it
->dpvec_face_id
= -1;
6580 it
->saved_face_id
= it
->face_id
;
6581 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6586 set_iterator_to_next (it
, 0);
6591 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6593 if (it
->what
== IT_GLYPHLESS
)
6595 /* Don't display this character. */
6596 set_iterator_to_next (it
, 0);
6600 /* If `nobreak-char-display' is non-nil, we display
6601 non-ASCII spaces and hyphens specially. */
6602 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6605 nonascii_space_p
= 1;
6606 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6607 nonascii_hyphen_p
= 1;
6610 /* Translate control characters into `\003' or `^C' form.
6611 Control characters coming from a display table entry are
6612 currently not translated because we use IT->dpvec to hold
6613 the translation. This could easily be changed but I
6614 don't believe that it is worth doing.
6616 The characters handled by `nobreak-char-display' must be
6619 Non-printable characters and raw-byte characters are also
6620 translated to octal form. */
6621 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6622 ? (it
->area
!= TEXT_AREA
6623 /* In mode line, treat \n, \t like other crl chars. */
6626 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6627 || (c
!= '\n' && c
!= '\t'))
6629 || nonascii_hyphen_p
6631 || ! CHAR_PRINTABLE_P (c
))))
6633 /* C is a control character, non-ASCII space/hyphen,
6634 raw-byte, or a non-printable character which must be
6635 displayed either as '\003' or as `^C' where the '\\'
6636 and '^' can be defined in the display table. Fill
6637 IT->ctl_chars with glyphs for what we have to
6638 display. Then, set IT->dpvec to these glyphs. */
6645 /* Handle control characters with ^. */
6647 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6651 g
= '^'; /* default glyph for Control */
6652 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6654 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6656 g
= GLYPH_CODE_CHAR (gc
);
6657 lface_id
= GLYPH_CODE_FACE (gc
);
6661 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6663 else if (it
->f
== last_escape_glyph_frame
6664 && it
->face_id
== last_escape_glyph_face_id
)
6666 face_id
= last_escape_glyph_merged_face_id
;
6670 /* Merge the escape-glyph face into the current face. */
6671 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6673 last_escape_glyph_frame
= it
->f
;
6674 last_escape_glyph_face_id
= it
->face_id
;
6675 last_escape_glyph_merged_face_id
= face_id
;
6678 XSETINT (it
->ctl_chars
[0], g
);
6679 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6681 goto display_control
;
6684 /* Handle non-ascii space in the mode where it only gets
6687 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6689 /* Merge `nobreak-space' into the current face. */
6690 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6692 XSETINT (it
->ctl_chars
[0], ' ');
6694 goto display_control
;
6697 /* Handle sequences that start with the "escape glyph". */
6699 /* the default escape glyph is \. */
6700 escape_glyph
= '\\';
6703 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6705 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6706 lface_id
= GLYPH_CODE_FACE (gc
);
6710 /* The display table specified a face.
6711 Merge it into face_id and also into escape_glyph. */
6712 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6715 else if (it
->f
== last_escape_glyph_frame
6716 && it
->face_id
== last_escape_glyph_face_id
)
6718 face_id
= last_escape_glyph_merged_face_id
;
6722 /* Merge the escape-glyph face into the current face. */
6723 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6725 last_escape_glyph_frame
= it
->f
;
6726 last_escape_glyph_face_id
= it
->face_id
;
6727 last_escape_glyph_merged_face_id
= face_id
;
6730 /* Draw non-ASCII hyphen with just highlighting: */
6732 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6734 XSETINT (it
->ctl_chars
[0], '-');
6736 goto display_control
;
6739 /* Draw non-ASCII space/hyphen with escape glyph: */
6741 if (nonascii_space_p
|| nonascii_hyphen_p
)
6743 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6744 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6746 goto display_control
;
6753 if (CHAR_BYTE8_P (c
))
6754 /* Display \200 instead of \17777600. */
6755 c
= CHAR_TO_BYTE8 (c
);
6756 len
= sprintf (str
, "%03o", c
);
6758 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6759 for (i
= 0; i
< len
; i
++)
6760 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6765 /* Set up IT->dpvec and return first character from it. */
6766 it
->dpvec_char_len
= it
->len
;
6767 it
->dpvec
= it
->ctl_chars
;
6768 it
->dpend
= it
->dpvec
+ ctl_len
;
6769 it
->current
.dpvec_index
= 0;
6770 it
->dpvec_face_id
= face_id
;
6771 it
->saved_face_id
= it
->face_id
;
6772 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6776 it
->char_to_display
= c
;
6780 it
->char_to_display
= it
->c
;
6784 /* Adjust face id for a multibyte character. There are no multibyte
6785 character in unibyte text. */
6786 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6789 && FRAME_WINDOW_P (it
->f
))
6791 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6793 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6795 /* Automatic composition with glyph-string. */
6796 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6798 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6802 ptrdiff_t pos
= (it
->s
? -1
6803 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6804 : IT_CHARPOS (*it
));
6807 if (it
->what
== IT_CHARACTER
)
6808 c
= it
->char_to_display
;
6811 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6815 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6816 /* TAB in a composition means display glyphs with
6817 padding space on the left or right. */
6818 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6821 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6826 /* Is this character the last one of a run of characters with
6827 box? If yes, set IT->end_of_box_run_p to 1. */
6831 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6833 int face_id
= underlying_face_id (it
);
6834 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6838 if (face
->box
== FACE_NO_BOX
)
6840 /* If the box comes from face properties in a
6841 display string, check faces in that string. */
6842 int string_face_id
= face_after_it_pos (it
);
6843 it
->end_of_box_run_p
6844 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6847 /* Otherwise, the box comes from the underlying face.
6848 If this is the last string character displayed, check
6849 the next buffer location. */
6850 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6851 && (it
->current
.overlay_string_index
6852 == it
->n_overlay_strings
- 1))
6856 struct text_pos pos
= it
->current
.pos
;
6857 INC_TEXT_POS (pos
, it
->multibyte_p
);
6859 next_face_id
= face_at_buffer_position
6860 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6861 it
->region_end_charpos
, &ignore
,
6862 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6864 it
->end_of_box_run_p
6865 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6872 int face_id
= face_after_it_pos (it
);
6873 it
->end_of_box_run_p
6874 = (face_id
!= it
->face_id
6875 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6878 /* If we reached the end of the object we've been iterating (e.g., a
6879 display string or an overlay string), and there's something on
6880 IT->stack, proceed with what's on the stack. It doesn't make
6881 sense to return zero if there's unprocessed stuff on the stack,
6882 because otherwise that stuff will never be displayed. */
6883 if (!success_p
&& it
->sp
> 0)
6885 set_iterator_to_next (it
, 0);
6886 success_p
= get_next_display_element (it
);
6889 /* Value is 0 if end of buffer or string reached. */
6894 /* Move IT to the next display element.
6896 RESEAT_P non-zero means if called on a newline in buffer text,
6897 skip to the next visible line start.
6899 Functions get_next_display_element and set_iterator_to_next are
6900 separate because I find this arrangement easier to handle than a
6901 get_next_display_element function that also increments IT's
6902 position. The way it is we can first look at an iterator's current
6903 display element, decide whether it fits on a line, and if it does,
6904 increment the iterator position. The other way around we probably
6905 would either need a flag indicating whether the iterator has to be
6906 incremented the next time, or we would have to implement a
6907 decrement position function which would not be easy to write. */
6910 set_iterator_to_next (struct it
*it
, int reseat_p
)
6912 /* Reset flags indicating start and end of a sequence of characters
6913 with box. Reset them at the start of this function because
6914 moving the iterator to a new position might set them. */
6915 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6919 case GET_FROM_BUFFER
:
6920 /* The current display element of IT is a character from
6921 current_buffer. Advance in the buffer, and maybe skip over
6922 invisible lines that are so because of selective display. */
6923 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6924 reseat_at_next_visible_line_start (it
, 0);
6925 else if (it
->cmp_it
.id
>= 0)
6927 /* We are currently getting glyphs from a composition. */
6932 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6933 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6934 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6936 it
->cmp_it
.from
= it
->cmp_it
.to
;
6941 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6943 it
->end_charpos
, Qnil
);
6946 else if (! it
->cmp_it
.reversed_p
)
6948 /* Composition created while scanning forward. */
6949 /* Update IT's char/byte positions to point to the first
6950 character of the next grapheme cluster, or to the
6951 character visually after the current composition. */
6952 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6953 bidi_move_to_visually_next (&it
->bidi_it
);
6954 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6955 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6957 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6959 /* Proceed to the next grapheme cluster. */
6960 it
->cmp_it
.from
= it
->cmp_it
.to
;
6964 /* No more grapheme clusters in this composition.
6965 Find the next stop position. */
6966 ptrdiff_t stop
= it
->end_charpos
;
6967 if (it
->bidi_it
.scan_dir
< 0)
6968 /* Now we are scanning backward and don't know
6971 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6972 IT_BYTEPOS (*it
), stop
, Qnil
);
6977 /* Composition created while scanning backward. */
6978 /* Update IT's char/byte positions to point to the last
6979 character of the previous grapheme cluster, or the
6980 character visually after the current composition. */
6981 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6982 bidi_move_to_visually_next (&it
->bidi_it
);
6983 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6984 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6985 if (it
->cmp_it
.from
> 0)
6987 /* Proceed to the previous grapheme cluster. */
6988 it
->cmp_it
.to
= it
->cmp_it
.from
;
6992 /* No more grapheme clusters in this composition.
6993 Find the next stop position. */
6994 ptrdiff_t stop
= it
->end_charpos
;
6995 if (it
->bidi_it
.scan_dir
< 0)
6996 /* Now we are scanning backward and don't know
6999 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7000 IT_BYTEPOS (*it
), stop
, Qnil
);
7006 eassert (it
->len
!= 0);
7010 IT_BYTEPOS (*it
) += it
->len
;
7011 IT_CHARPOS (*it
) += 1;
7015 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7016 /* If this is a new paragraph, determine its base
7017 direction (a.k.a. its base embedding level). */
7018 if (it
->bidi_it
.new_paragraph
)
7019 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7020 bidi_move_to_visually_next (&it
->bidi_it
);
7021 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7022 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7023 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7025 /* As the scan direction was changed, we must
7026 re-compute the stop position for composition. */
7027 ptrdiff_t stop
= it
->end_charpos
;
7028 if (it
->bidi_it
.scan_dir
< 0)
7030 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7031 IT_BYTEPOS (*it
), stop
, Qnil
);
7034 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7038 case GET_FROM_C_STRING
:
7039 /* Current display element of IT is from a C string. */
7041 /* If the string position is beyond string's end, it means
7042 next_element_from_c_string is padding the string with
7043 blanks, in which case we bypass the bidi iterator,
7044 because it cannot deal with such virtual characters. */
7045 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7047 IT_BYTEPOS (*it
) += it
->len
;
7048 IT_CHARPOS (*it
) += 1;
7052 bidi_move_to_visually_next (&it
->bidi_it
);
7053 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7054 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7058 case GET_FROM_DISPLAY_VECTOR
:
7059 /* Current display element of IT is from a display table entry.
7060 Advance in the display table definition. Reset it to null if
7061 end reached, and continue with characters from buffers/
7063 ++it
->current
.dpvec_index
;
7065 /* Restore face of the iterator to what they were before the
7066 display vector entry (these entries may contain faces). */
7067 it
->face_id
= it
->saved_face_id
;
7069 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7071 int recheck_faces
= it
->ellipsis_p
;
7074 it
->method
= GET_FROM_C_STRING
;
7075 else if (STRINGP (it
->string
))
7076 it
->method
= GET_FROM_STRING
;
7079 it
->method
= GET_FROM_BUFFER
;
7080 it
->object
= it
->w
->buffer
;
7084 it
->current
.dpvec_index
= -1;
7086 /* Skip over characters which were displayed via IT->dpvec. */
7087 if (it
->dpvec_char_len
< 0)
7088 reseat_at_next_visible_line_start (it
, 1);
7089 else if (it
->dpvec_char_len
> 0)
7091 if (it
->method
== GET_FROM_STRING
7092 && it
->n_overlay_strings
> 0)
7093 it
->ignore_overlay_strings_at_pos_p
= 1;
7094 it
->len
= it
->dpvec_char_len
;
7095 set_iterator_to_next (it
, reseat_p
);
7098 /* Maybe recheck faces after display vector */
7100 it
->stop_charpos
= IT_CHARPOS (*it
);
7104 case GET_FROM_STRING
:
7105 /* Current display element is a character from a Lisp string. */
7106 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7107 /* Don't advance past string end. These conditions are true
7108 when set_iterator_to_next is called at the end of
7109 get_next_display_element, in which case the Lisp string is
7110 already exhausted, and all we want is pop the iterator
7112 if (it
->current
.overlay_string_index
>= 0)
7114 /* This is an overlay string, so there's no padding with
7115 spaces, and the number of characters in the string is
7116 where the string ends. */
7117 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7118 goto consider_string_end
;
7122 /* Not an overlay string. There could be padding, so test
7123 against it->end_charpos . */
7124 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7125 goto consider_string_end
;
7127 if (it
->cmp_it
.id
>= 0)
7133 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7134 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7135 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7136 it
->cmp_it
.from
= it
->cmp_it
.to
;
7140 composition_compute_stop_pos (&it
->cmp_it
,
7141 IT_STRING_CHARPOS (*it
),
7142 IT_STRING_BYTEPOS (*it
),
7143 it
->end_charpos
, it
->string
);
7146 else if (! it
->cmp_it
.reversed_p
)
7148 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7149 bidi_move_to_visually_next (&it
->bidi_it
);
7150 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7151 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7153 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7154 it
->cmp_it
.from
= it
->cmp_it
.to
;
7157 ptrdiff_t stop
= it
->end_charpos
;
7158 if (it
->bidi_it
.scan_dir
< 0)
7160 composition_compute_stop_pos (&it
->cmp_it
,
7161 IT_STRING_CHARPOS (*it
),
7162 IT_STRING_BYTEPOS (*it
), stop
,
7168 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7169 bidi_move_to_visually_next (&it
->bidi_it
);
7170 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7171 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7172 if (it
->cmp_it
.from
> 0)
7173 it
->cmp_it
.to
= it
->cmp_it
.from
;
7176 ptrdiff_t stop
= it
->end_charpos
;
7177 if (it
->bidi_it
.scan_dir
< 0)
7179 composition_compute_stop_pos (&it
->cmp_it
,
7180 IT_STRING_CHARPOS (*it
),
7181 IT_STRING_BYTEPOS (*it
), stop
,
7189 /* If the string position is beyond string's end, it
7190 means next_element_from_string is padding the string
7191 with blanks, in which case we bypass the bidi
7192 iterator, because it cannot deal with such virtual
7194 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7196 IT_STRING_BYTEPOS (*it
) += it
->len
;
7197 IT_STRING_CHARPOS (*it
) += 1;
7201 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7203 bidi_move_to_visually_next (&it
->bidi_it
);
7204 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7205 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7206 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7208 ptrdiff_t stop
= it
->end_charpos
;
7210 if (it
->bidi_it
.scan_dir
< 0)
7212 composition_compute_stop_pos (&it
->cmp_it
,
7213 IT_STRING_CHARPOS (*it
),
7214 IT_STRING_BYTEPOS (*it
), stop
,
7220 consider_string_end
:
7222 if (it
->current
.overlay_string_index
>= 0)
7224 /* IT->string is an overlay string. Advance to the
7225 next, if there is one. */
7226 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7229 next_overlay_string (it
);
7231 setup_for_ellipsis (it
, 0);
7236 /* IT->string is not an overlay string. If we reached
7237 its end, and there is something on IT->stack, proceed
7238 with what is on the stack. This can be either another
7239 string, this time an overlay string, or a buffer. */
7240 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7244 if (it
->method
== GET_FROM_STRING
)
7245 goto consider_string_end
;
7250 case GET_FROM_IMAGE
:
7251 case GET_FROM_STRETCH
:
7252 /* The position etc with which we have to proceed are on
7253 the stack. The position may be at the end of a string,
7254 if the `display' property takes up the whole string. */
7255 eassert (it
->sp
> 0);
7257 if (it
->method
== GET_FROM_STRING
)
7258 goto consider_string_end
;
7262 /* There are no other methods defined, so this should be a bug. */
7266 eassert (it
->method
!= GET_FROM_STRING
7267 || (STRINGP (it
->string
)
7268 && IT_STRING_CHARPOS (*it
) >= 0));
7271 /* Load IT's display element fields with information about the next
7272 display element which comes from a display table entry or from the
7273 result of translating a control character to one of the forms `^C'
7276 IT->dpvec holds the glyphs to return as characters.
7277 IT->saved_face_id holds the face id before the display vector--it
7278 is restored into IT->face_id in set_iterator_to_next. */
7281 next_element_from_display_vector (struct it
*it
)
7286 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7288 it
->face_id
= it
->saved_face_id
;
7290 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7291 That seemed totally bogus - so I changed it... */
7292 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7294 if (GLYPH_CODE_P (gc
))
7296 it
->c
= GLYPH_CODE_CHAR (gc
);
7297 it
->len
= CHAR_BYTES (it
->c
);
7299 /* The entry may contain a face id to use. Such a face id is
7300 the id of a Lisp face, not a realized face. A face id of
7301 zero means no face is specified. */
7302 if (it
->dpvec_face_id
>= 0)
7303 it
->face_id
= it
->dpvec_face_id
;
7306 int lface_id
= GLYPH_CODE_FACE (gc
);
7308 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7313 /* Display table entry is invalid. Return a space. */
7314 it
->c
= ' ', it
->len
= 1;
7316 /* Don't change position and object of the iterator here. They are
7317 still the values of the character that had this display table
7318 entry or was translated, and that's what we want. */
7319 it
->what
= IT_CHARACTER
;
7323 /* Get the first element of string/buffer in the visual order, after
7324 being reseated to a new position in a string or a buffer. */
7326 get_visually_first_element (struct it
*it
)
7328 int string_p
= STRINGP (it
->string
) || it
->s
;
7329 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7330 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7332 if (STRINGP (it
->string
))
7334 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7335 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7339 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7340 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7343 if (it
->bidi_it
.charpos
== eob
)
7345 /* Nothing to do, but reset the FIRST_ELT flag, like
7346 bidi_paragraph_init does, because we are not going to
7348 it
->bidi_it
.first_elt
= 0;
7350 else if (it
->bidi_it
.charpos
== bob
7352 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7353 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7355 /* If we are at the beginning of a line/string, we can produce
7356 the next element right away. */
7357 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7358 bidi_move_to_visually_next (&it
->bidi_it
);
7362 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7364 /* We need to prime the bidi iterator starting at the line's or
7365 string's beginning, before we will be able to produce the
7368 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7371 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7373 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7375 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7378 /* Now return to buffer/string position where we were asked
7379 to get the next display element, and produce that. */
7380 bidi_move_to_visually_next (&it
->bidi_it
);
7382 while (it
->bidi_it
.bytepos
!= orig_bytepos
7383 && it
->bidi_it
.charpos
< eob
);
7386 /* Adjust IT's position information to where we ended up. */
7387 if (STRINGP (it
->string
))
7389 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7390 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7394 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7395 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7398 if (STRINGP (it
->string
) || !it
->s
)
7400 ptrdiff_t stop
, charpos
, bytepos
;
7402 if (STRINGP (it
->string
))
7405 stop
= SCHARS (it
->string
);
7406 if (stop
> it
->end_charpos
)
7407 stop
= it
->end_charpos
;
7408 charpos
= IT_STRING_CHARPOS (*it
);
7409 bytepos
= IT_STRING_BYTEPOS (*it
);
7413 stop
= it
->end_charpos
;
7414 charpos
= IT_CHARPOS (*it
);
7415 bytepos
= IT_BYTEPOS (*it
);
7417 if (it
->bidi_it
.scan_dir
< 0)
7419 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7424 /* Load IT with the next display element from Lisp string IT->string.
7425 IT->current.string_pos is the current position within the string.
7426 If IT->current.overlay_string_index >= 0, the Lisp string is an
7430 next_element_from_string (struct it
*it
)
7432 struct text_pos position
;
7434 eassert (STRINGP (it
->string
));
7435 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7436 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7437 position
= it
->current
.string_pos
;
7439 /* With bidi reordering, the character to display might not be the
7440 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7441 that we were reseat()ed to a new string, whose paragraph
7442 direction is not known. */
7443 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7445 get_visually_first_element (it
);
7446 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7449 /* Time to check for invisible text? */
7450 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7452 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7455 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7456 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7458 /* With bidi non-linear iteration, we could find
7459 ourselves far beyond the last computed stop_charpos,
7460 with several other stop positions in between that we
7461 missed. Scan them all now, in buffer's logical
7462 order, until we find and handle the last stop_charpos
7463 that precedes our current position. */
7464 handle_stop_backwards (it
, it
->stop_charpos
);
7465 return GET_NEXT_DISPLAY_ELEMENT (it
);
7471 /* Take note of the stop position we just moved
7472 across, for when we will move back across it. */
7473 it
->prev_stop
= it
->stop_charpos
;
7474 /* If we are at base paragraph embedding level, take
7475 note of the last stop position seen at this
7477 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7478 it
->base_level_stop
= it
->stop_charpos
;
7482 /* Since a handler may have changed IT->method, we must
7484 return GET_NEXT_DISPLAY_ELEMENT (it
);
7488 /* If we are before prev_stop, we may have overstepped
7489 on our way backwards a stop_pos, and if so, we need
7490 to handle that stop_pos. */
7491 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7492 /* We can sometimes back up for reasons that have nothing
7493 to do with bidi reordering. E.g., compositions. The
7494 code below is only needed when we are above the base
7495 embedding level, so test for that explicitly. */
7496 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7498 /* If we lost track of base_level_stop, we have no better
7499 place for handle_stop_backwards to start from than string
7500 beginning. This happens, e.g., when we were reseated to
7501 the previous screenful of text by vertical-motion. */
7502 if (it
->base_level_stop
<= 0
7503 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7504 it
->base_level_stop
= 0;
7505 handle_stop_backwards (it
, it
->base_level_stop
);
7506 return GET_NEXT_DISPLAY_ELEMENT (it
);
7510 if (it
->current
.overlay_string_index
>= 0)
7512 /* Get the next character from an overlay string. In overlay
7513 strings, there is no field width or padding with spaces to
7515 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7520 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7521 IT_STRING_BYTEPOS (*it
),
7522 it
->bidi_it
.scan_dir
< 0
7524 : SCHARS (it
->string
))
7525 && next_element_from_composition (it
))
7529 else if (STRING_MULTIBYTE (it
->string
))
7531 const unsigned char *s
= (SDATA (it
->string
)
7532 + IT_STRING_BYTEPOS (*it
));
7533 it
->c
= string_char_and_length (s
, &it
->len
);
7537 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7543 /* Get the next character from a Lisp string that is not an
7544 overlay string. Such strings come from the mode line, for
7545 example. We may have to pad with spaces, or truncate the
7546 string. See also next_element_from_c_string. */
7547 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7552 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7554 /* Pad with spaces. */
7555 it
->c
= ' ', it
->len
= 1;
7556 CHARPOS (position
) = BYTEPOS (position
) = -1;
7558 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7559 IT_STRING_BYTEPOS (*it
),
7560 it
->bidi_it
.scan_dir
< 0
7562 : it
->string_nchars
)
7563 && next_element_from_composition (it
))
7567 else if (STRING_MULTIBYTE (it
->string
))
7569 const unsigned char *s
= (SDATA (it
->string
)
7570 + IT_STRING_BYTEPOS (*it
));
7571 it
->c
= string_char_and_length (s
, &it
->len
);
7575 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7580 /* Record what we have and where it came from. */
7581 it
->what
= IT_CHARACTER
;
7582 it
->object
= it
->string
;
7583 it
->position
= position
;
7588 /* Load IT with next display element from C string IT->s.
7589 IT->string_nchars is the maximum number of characters to return
7590 from the string. IT->end_charpos may be greater than
7591 IT->string_nchars when this function is called, in which case we
7592 may have to return padding spaces. Value is zero if end of string
7593 reached, including padding spaces. */
7596 next_element_from_c_string (struct it
*it
)
7601 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7602 it
->what
= IT_CHARACTER
;
7603 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7606 /* With bidi reordering, the character to display might not be the
7607 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7608 we were reseated to a new string, whose paragraph direction is
7610 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7611 get_visually_first_element (it
);
7613 /* IT's position can be greater than IT->string_nchars in case a
7614 field width or precision has been specified when the iterator was
7616 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7618 /* End of the game. */
7622 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7624 /* Pad with spaces. */
7625 it
->c
= ' ', it
->len
= 1;
7626 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7628 else if (it
->multibyte_p
)
7629 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7631 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7637 /* Set up IT to return characters from an ellipsis, if appropriate.
7638 The definition of the ellipsis glyphs may come from a display table
7639 entry. This function fills IT with the first glyph from the
7640 ellipsis if an ellipsis is to be displayed. */
7643 next_element_from_ellipsis (struct it
*it
)
7645 if (it
->selective_display_ellipsis_p
)
7646 setup_for_ellipsis (it
, it
->len
);
7649 /* The face at the current position may be different from the
7650 face we find after the invisible text. Remember what it
7651 was in IT->saved_face_id, and signal that it's there by
7652 setting face_before_selective_p. */
7653 it
->saved_face_id
= it
->face_id
;
7654 it
->method
= GET_FROM_BUFFER
;
7655 it
->object
= it
->w
->buffer
;
7656 reseat_at_next_visible_line_start (it
, 1);
7657 it
->face_before_selective_p
= 1;
7660 return GET_NEXT_DISPLAY_ELEMENT (it
);
7664 /* Deliver an image display element. The iterator IT is already
7665 filled with image information (done in handle_display_prop). Value
7670 next_element_from_image (struct it
*it
)
7672 it
->what
= IT_IMAGE
;
7673 it
->ignore_overlay_strings_at_pos_p
= 0;
7678 /* Fill iterator IT with next display element from a stretch glyph
7679 property. IT->object is the value of the text property. Value is
7683 next_element_from_stretch (struct it
*it
)
7685 it
->what
= IT_STRETCH
;
7689 /* Scan backwards from IT's current position until we find a stop
7690 position, or until BEGV. This is called when we find ourself
7691 before both the last known prev_stop and base_level_stop while
7692 reordering bidirectional text. */
7695 compute_stop_pos_backwards (struct it
*it
)
7697 const int SCAN_BACK_LIMIT
= 1000;
7698 struct text_pos pos
;
7699 struct display_pos save_current
= it
->current
;
7700 struct text_pos save_position
= it
->position
;
7701 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7702 ptrdiff_t where_we_are
= charpos
;
7703 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7704 ptrdiff_t save_end_pos
= it
->end_charpos
;
7706 eassert (NILP (it
->string
) && !it
->s
);
7707 eassert (it
->bidi_p
);
7711 it
->end_charpos
= min (charpos
+ 1, ZV
);
7712 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7713 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7714 reseat_1 (it
, pos
, 0);
7715 compute_stop_pos (it
);
7716 /* We must advance forward, right? */
7717 if (it
->stop_charpos
<= charpos
)
7720 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7722 if (it
->stop_charpos
<= where_we_are
)
7723 it
->prev_stop
= it
->stop_charpos
;
7725 it
->prev_stop
= BEGV
;
7727 it
->current
= save_current
;
7728 it
->position
= save_position
;
7729 it
->stop_charpos
= save_stop_pos
;
7730 it
->end_charpos
= save_end_pos
;
7733 /* Scan forward from CHARPOS in the current buffer/string, until we
7734 find a stop position > current IT's position. Then handle the stop
7735 position before that. This is called when we bump into a stop
7736 position while reordering bidirectional text. CHARPOS should be
7737 the last previously processed stop_pos (or BEGV/0, if none were
7738 processed yet) whose position is less that IT's current
7742 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7744 int bufp
= !STRINGP (it
->string
);
7745 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7746 struct display_pos save_current
= it
->current
;
7747 struct text_pos save_position
= it
->position
;
7748 struct text_pos pos1
;
7749 ptrdiff_t next_stop
;
7751 /* Scan in strict logical order. */
7752 eassert (it
->bidi_p
);
7756 it
->prev_stop
= charpos
;
7759 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7760 reseat_1 (it
, pos1
, 0);
7763 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7764 compute_stop_pos (it
);
7765 /* We must advance forward, right? */
7766 if (it
->stop_charpos
<= it
->prev_stop
)
7768 charpos
= it
->stop_charpos
;
7770 while (charpos
<= where_we_are
);
7773 it
->current
= save_current
;
7774 it
->position
= save_position
;
7775 next_stop
= it
->stop_charpos
;
7776 it
->stop_charpos
= it
->prev_stop
;
7778 it
->stop_charpos
= next_stop
;
7781 /* Load IT with the next display element from current_buffer. Value
7782 is zero if end of buffer reached. IT->stop_charpos is the next
7783 position at which to stop and check for text properties or buffer
7787 next_element_from_buffer (struct it
*it
)
7791 eassert (IT_CHARPOS (*it
) >= BEGV
);
7792 eassert (NILP (it
->string
) && !it
->s
);
7793 eassert (!it
->bidi_p
7794 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7795 && it
->bidi_it
.string
.s
== NULL
));
7797 /* With bidi reordering, the character to display might not be the
7798 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7799 we were reseat()ed to a new buffer position, which is potentially
7800 a different paragraph. */
7801 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7803 get_visually_first_element (it
);
7804 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7807 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7809 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7811 int overlay_strings_follow_p
;
7813 /* End of the game, except when overlay strings follow that
7814 haven't been returned yet. */
7815 if (it
->overlay_strings_at_end_processed_p
)
7816 overlay_strings_follow_p
= 0;
7819 it
->overlay_strings_at_end_processed_p
= 1;
7820 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7823 if (overlay_strings_follow_p
)
7824 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7828 it
->position
= it
->current
.pos
;
7832 else if (!(!it
->bidi_p
7833 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7834 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7836 /* With bidi non-linear iteration, we could find ourselves
7837 far beyond the last computed stop_charpos, with several
7838 other stop positions in between that we missed. Scan
7839 them all now, in buffer's logical order, until we find
7840 and handle the last stop_charpos that precedes our
7841 current position. */
7842 handle_stop_backwards (it
, it
->stop_charpos
);
7843 return GET_NEXT_DISPLAY_ELEMENT (it
);
7849 /* Take note of the stop position we just moved across,
7850 for when we will move back across it. */
7851 it
->prev_stop
= it
->stop_charpos
;
7852 /* If we are at base paragraph embedding level, take
7853 note of the last stop position seen at this
7855 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7856 it
->base_level_stop
= it
->stop_charpos
;
7859 return GET_NEXT_DISPLAY_ELEMENT (it
);
7863 /* If we are before prev_stop, we may have overstepped on
7864 our way backwards a stop_pos, and if so, we need to
7865 handle that stop_pos. */
7866 && IT_CHARPOS (*it
) < it
->prev_stop
7867 /* We can sometimes back up for reasons that have nothing
7868 to do with bidi reordering. E.g., compositions. The
7869 code below is only needed when we are above the base
7870 embedding level, so test for that explicitly. */
7871 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7873 if (it
->base_level_stop
<= 0
7874 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7876 /* If we lost track of base_level_stop, we need to find
7877 prev_stop by looking backwards. This happens, e.g., when
7878 we were reseated to the previous screenful of text by
7880 it
->base_level_stop
= BEGV
;
7881 compute_stop_pos_backwards (it
);
7882 handle_stop_backwards (it
, it
->prev_stop
);
7885 handle_stop_backwards (it
, it
->base_level_stop
);
7886 return GET_NEXT_DISPLAY_ELEMENT (it
);
7890 /* No face changes, overlays etc. in sight, so just return a
7891 character from current_buffer. */
7895 /* Maybe run the redisplay end trigger hook. Performance note:
7896 This doesn't seem to cost measurable time. */
7897 if (it
->redisplay_end_trigger_charpos
7899 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7900 run_redisplay_end_trigger_hook (it
);
7902 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7903 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7905 && next_element_from_composition (it
))
7910 /* Get the next character, maybe multibyte. */
7911 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7912 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7913 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7915 it
->c
= *p
, it
->len
= 1;
7917 /* Record what we have and where it came from. */
7918 it
->what
= IT_CHARACTER
;
7919 it
->object
= it
->w
->buffer
;
7920 it
->position
= it
->current
.pos
;
7922 /* Normally we return the character found above, except when we
7923 really want to return an ellipsis for selective display. */
7928 /* A value of selective > 0 means hide lines indented more
7929 than that number of columns. */
7930 if (it
->selective
> 0
7931 && IT_CHARPOS (*it
) + 1 < ZV
7932 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7933 IT_BYTEPOS (*it
) + 1,
7936 success_p
= next_element_from_ellipsis (it
);
7937 it
->dpvec_char_len
= -1;
7940 else if (it
->c
== '\r' && it
->selective
== -1)
7942 /* A value of selective == -1 means that everything from the
7943 CR to the end of the line is invisible, with maybe an
7944 ellipsis displayed for it. */
7945 success_p
= next_element_from_ellipsis (it
);
7946 it
->dpvec_char_len
= -1;
7951 /* Value is zero if end of buffer reached. */
7952 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7957 /* Run the redisplay end trigger hook for IT. */
7960 run_redisplay_end_trigger_hook (struct it
*it
)
7962 Lisp_Object args
[3];
7964 /* IT->glyph_row should be non-null, i.e. we should be actually
7965 displaying something, or otherwise we should not run the hook. */
7966 eassert (it
->glyph_row
);
7968 /* Set up hook arguments. */
7969 args
[0] = Qredisplay_end_trigger_functions
;
7970 args
[1] = it
->window
;
7971 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7972 it
->redisplay_end_trigger_charpos
= 0;
7974 /* Since we are *trying* to run these functions, don't try to run
7975 them again, even if they get an error. */
7976 it
->w
->redisplay_end_trigger
= Qnil
;
7977 Frun_hook_with_args (3, args
);
7979 /* Notice if it changed the face of the character we are on. */
7980 handle_face_prop (it
);
7984 /* Deliver a composition display element. Unlike the other
7985 next_element_from_XXX, this function is not registered in the array
7986 get_next_element[]. It is called from next_element_from_buffer and
7987 next_element_from_string when necessary. */
7990 next_element_from_composition (struct it
*it
)
7992 it
->what
= IT_COMPOSITION
;
7993 it
->len
= it
->cmp_it
.nbytes
;
7994 if (STRINGP (it
->string
))
7998 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7999 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8002 it
->position
= it
->current
.string_pos
;
8003 it
->object
= it
->string
;
8004 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8005 IT_STRING_BYTEPOS (*it
), it
->string
);
8011 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8012 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8015 if (it
->bidi_it
.new_paragraph
)
8016 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8017 /* Resync the bidi iterator with IT's new position.
8018 FIXME: this doesn't support bidirectional text. */
8019 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8020 bidi_move_to_visually_next (&it
->bidi_it
);
8024 it
->position
= it
->current
.pos
;
8025 it
->object
= it
->w
->buffer
;
8026 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8027 IT_BYTEPOS (*it
), Qnil
);
8034 /***********************************************************************
8035 Moving an iterator without producing glyphs
8036 ***********************************************************************/
8038 /* Check if iterator is at a position corresponding to a valid buffer
8039 position after some move_it_ call. */
8041 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8042 ((it)->method == GET_FROM_STRING \
8043 ? IT_STRING_CHARPOS (*it) == 0 \
8047 /* Move iterator IT to a specified buffer or X position within one
8048 line on the display without producing glyphs.
8050 OP should be a bit mask including some or all of these bits:
8051 MOVE_TO_X: Stop upon reaching x-position TO_X.
8052 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8053 Regardless of OP's value, stop upon reaching the end of the display line.
8055 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8056 This means, in particular, that TO_X includes window's horizontal
8059 The return value has several possible values that
8060 say what condition caused the scan to stop:
8062 MOVE_POS_MATCH_OR_ZV
8063 - when TO_POS or ZV was reached.
8066 -when TO_X was reached before TO_POS or ZV were reached.
8069 - when we reached the end of the display area and the line must
8073 - when we reached the end of the display area and the line is
8077 - when we stopped at a line end, i.e. a newline or a CR and selective
8080 static enum move_it_result
8081 move_it_in_display_line_to (struct it
*it
,
8082 ptrdiff_t to_charpos
, int to_x
,
8083 enum move_operation_enum op
)
8085 enum move_it_result result
= MOVE_UNDEFINED
;
8086 struct glyph_row
*saved_glyph_row
;
8087 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8088 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8089 void *ppos_data
= NULL
;
8091 enum it_method prev_method
= it
->method
;
8092 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8093 int saw_smaller_pos
= prev_pos
< to_charpos
;
8095 /* Don't produce glyphs in produce_glyphs. */
8096 saved_glyph_row
= it
->glyph_row
;
8097 it
->glyph_row
= NULL
;
8099 /* Use wrap_it to save a copy of IT wherever a word wrap could
8100 occur. Use atpos_it to save a copy of IT at the desired buffer
8101 position, if found, so that we can scan ahead and check if the
8102 word later overshoots the window edge. Use atx_it similarly, for
8108 /* Use ppos_it under bidi reordering to save a copy of IT for the
8109 position > CHARPOS that is the closest to CHARPOS. We restore
8110 that position in IT when we have scanned the entire display line
8111 without finding a match for CHARPOS and all the character
8112 positions are greater than CHARPOS. */
8115 SAVE_IT (ppos_it
, *it
, ppos_data
);
8116 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8117 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8118 SAVE_IT (ppos_it
, *it
, ppos_data
);
8121 #define BUFFER_POS_REACHED_P() \
8122 ((op & MOVE_TO_POS) != 0 \
8123 && BUFFERP (it->object) \
8124 && (IT_CHARPOS (*it) == to_charpos \
8126 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8127 && IT_CHARPOS (*it) > to_charpos) \
8128 || (it->what == IT_COMPOSITION \
8129 && ((IT_CHARPOS (*it) > to_charpos \
8130 && to_charpos >= it->cmp_it.charpos) \
8131 || (IT_CHARPOS (*it) < to_charpos \
8132 && to_charpos <= it->cmp_it.charpos)))) \
8133 && (it->method == GET_FROM_BUFFER \
8134 || (it->method == GET_FROM_DISPLAY_VECTOR \
8135 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8137 /* If there's a line-/wrap-prefix, handle it. */
8138 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8139 && it
->current_y
< it
->last_visible_y
)
8140 handle_line_prefix (it
);
8142 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8143 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8147 int x
, i
, ascent
= 0, descent
= 0;
8149 /* Utility macro to reset an iterator with x, ascent, and descent. */
8150 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8151 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8152 (IT)->max_descent = descent)
8154 /* Stop if we move beyond TO_CHARPOS (after an image or a
8155 display string or stretch glyph). */
8156 if ((op
& MOVE_TO_POS
) != 0
8157 && BUFFERP (it
->object
)
8158 && it
->method
== GET_FROM_BUFFER
8160 /* When the iterator is at base embedding level, we
8161 are guaranteed that characters are delivered for
8162 display in strictly increasing order of their
8163 buffer positions. */
8164 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8165 && IT_CHARPOS (*it
) > to_charpos
)
8167 && (prev_method
== GET_FROM_IMAGE
8168 || prev_method
== GET_FROM_STRETCH
8169 || prev_method
== GET_FROM_STRING
)
8170 /* Passed TO_CHARPOS from left to right. */
8171 && ((prev_pos
< to_charpos
8172 && IT_CHARPOS (*it
) > to_charpos
)
8173 /* Passed TO_CHARPOS from right to left. */
8174 || (prev_pos
> to_charpos
8175 && IT_CHARPOS (*it
) < to_charpos
)))))
8177 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8179 result
= MOVE_POS_MATCH_OR_ZV
;
8182 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8183 /* If wrap_it is valid, the current position might be in a
8184 word that is wrapped. So, save the iterator in
8185 atpos_it and continue to see if wrapping happens. */
8186 SAVE_IT (atpos_it
, *it
, atpos_data
);
8189 /* Stop when ZV reached.
8190 We used to stop here when TO_CHARPOS reached as well, but that is
8191 too soon if this glyph does not fit on this line. So we handle it
8192 explicitly below. */
8193 if (!get_next_display_element (it
))
8195 result
= MOVE_POS_MATCH_OR_ZV
;
8199 if (it
->line_wrap
== TRUNCATE
)
8201 if (BUFFER_POS_REACHED_P ())
8203 result
= MOVE_POS_MATCH_OR_ZV
;
8209 if (it
->line_wrap
== WORD_WRAP
)
8211 if (IT_DISPLAYING_WHITESPACE (it
))
8215 /* We have reached a glyph that follows one or more
8216 whitespace characters. If the position is
8217 already found, we are done. */
8218 if (atpos_it
.sp
>= 0)
8220 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8221 result
= MOVE_POS_MATCH_OR_ZV
;
8226 RESTORE_IT (it
, &atx_it
, atx_data
);
8227 result
= MOVE_X_REACHED
;
8230 /* Otherwise, we can wrap here. */
8231 SAVE_IT (wrap_it
, *it
, wrap_data
);
8237 /* Remember the line height for the current line, in case
8238 the next element doesn't fit on the line. */
8239 ascent
= it
->max_ascent
;
8240 descent
= it
->max_descent
;
8242 /* The call to produce_glyphs will get the metrics of the
8243 display element IT is loaded with. Record the x-position
8244 before this display element, in case it doesn't fit on the
8248 PRODUCE_GLYPHS (it
);
8250 if (it
->area
!= TEXT_AREA
)
8252 prev_method
= it
->method
;
8253 if (it
->method
== GET_FROM_BUFFER
)
8254 prev_pos
= IT_CHARPOS (*it
);
8255 set_iterator_to_next (it
, 1);
8256 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8257 SET_TEXT_POS (this_line_min_pos
,
8258 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8260 && (op
& MOVE_TO_POS
)
8261 && IT_CHARPOS (*it
) > to_charpos
8262 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8263 SAVE_IT (ppos_it
, *it
, ppos_data
);
8267 /* The number of glyphs we get back in IT->nglyphs will normally
8268 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8269 character on a terminal frame, or (iii) a line end. For the
8270 second case, IT->nglyphs - 1 padding glyphs will be present.
8271 (On X frames, there is only one glyph produced for a
8272 composite character.)
8274 The behavior implemented below means, for continuation lines,
8275 that as many spaces of a TAB as fit on the current line are
8276 displayed there. For terminal frames, as many glyphs of a
8277 multi-glyph character are displayed in the current line, too.
8278 This is what the old redisplay code did, and we keep it that
8279 way. Under X, the whole shape of a complex character must
8280 fit on the line or it will be completely displayed in the
8283 Note that both for tabs and padding glyphs, all glyphs have
8287 /* More than one glyph or glyph doesn't fit on line. All
8288 glyphs have the same width. */
8289 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8291 int x_before_this_char
= x
;
8292 int hpos_before_this_char
= it
->hpos
;
8294 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8296 new_x
= x
+ single_glyph_width
;
8298 /* We want to leave anything reaching TO_X to the caller. */
8299 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8301 if (BUFFER_POS_REACHED_P ())
8303 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8304 goto buffer_pos_reached
;
8305 if (atpos_it
.sp
< 0)
8307 SAVE_IT (atpos_it
, *it
, atpos_data
);
8308 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8313 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8316 result
= MOVE_X_REACHED
;
8321 SAVE_IT (atx_it
, *it
, atx_data
);
8322 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8327 if (/* Lines are continued. */
8328 it
->line_wrap
!= TRUNCATE
8329 && (/* And glyph doesn't fit on the line. */
8330 new_x
> it
->last_visible_x
8331 /* Or it fits exactly and we're on a window
8333 || (new_x
== it
->last_visible_x
8334 && FRAME_WINDOW_P (it
->f
)
8335 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8336 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8337 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8339 if (/* IT->hpos == 0 means the very first glyph
8340 doesn't fit on the line, e.g. a wide image. */
8342 || (new_x
== it
->last_visible_x
8343 && FRAME_WINDOW_P (it
->f
)))
8346 it
->current_x
= new_x
;
8348 /* The character's last glyph just barely fits
8350 if (i
== it
->nglyphs
- 1)
8352 /* If this is the destination position,
8353 return a position *before* it in this row,
8354 now that we know it fits in this row. */
8355 if (BUFFER_POS_REACHED_P ())
8357 if (it
->line_wrap
!= WORD_WRAP
8360 it
->hpos
= hpos_before_this_char
;
8361 it
->current_x
= x_before_this_char
;
8362 result
= MOVE_POS_MATCH_OR_ZV
;
8365 if (it
->line_wrap
== WORD_WRAP
8368 SAVE_IT (atpos_it
, *it
, atpos_data
);
8369 atpos_it
.current_x
= x_before_this_char
;
8370 atpos_it
.hpos
= hpos_before_this_char
;
8374 prev_method
= it
->method
;
8375 if (it
->method
== GET_FROM_BUFFER
)
8376 prev_pos
= IT_CHARPOS (*it
);
8377 set_iterator_to_next (it
, 1);
8378 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8379 SET_TEXT_POS (this_line_min_pos
,
8380 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8381 /* On graphical terminals, newlines may
8382 "overflow" into the fringe if
8383 overflow-newline-into-fringe is non-nil.
8384 On text terminals, and on graphical
8385 terminals with no right margin, newlines
8386 may overflow into the last glyph on the
8388 if (!FRAME_WINDOW_P (it
->f
)
8390 && it
->bidi_it
.paragraph_dir
== R2L
)
8391 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8392 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8393 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8395 if (!get_next_display_element (it
))
8397 result
= MOVE_POS_MATCH_OR_ZV
;
8400 if (BUFFER_POS_REACHED_P ())
8402 if (ITERATOR_AT_END_OF_LINE_P (it
))
8403 result
= MOVE_POS_MATCH_OR_ZV
;
8405 result
= MOVE_LINE_CONTINUED
;
8408 if (ITERATOR_AT_END_OF_LINE_P (it
))
8410 result
= MOVE_NEWLINE_OR_CR
;
8417 IT_RESET_X_ASCENT_DESCENT (it
);
8419 if (wrap_it
.sp
>= 0)
8421 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8426 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8428 result
= MOVE_LINE_CONTINUED
;
8432 if (BUFFER_POS_REACHED_P ())
8434 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8435 goto buffer_pos_reached
;
8436 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8438 SAVE_IT (atpos_it
, *it
, atpos_data
);
8439 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8443 if (new_x
> it
->first_visible_x
)
8445 /* Glyph is visible. Increment number of glyphs that
8446 would be displayed. */
8451 if (result
!= MOVE_UNDEFINED
)
8454 else if (BUFFER_POS_REACHED_P ())
8457 IT_RESET_X_ASCENT_DESCENT (it
);
8458 result
= MOVE_POS_MATCH_OR_ZV
;
8461 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8463 /* Stop when TO_X specified and reached. This check is
8464 necessary here because of lines consisting of a line end,
8465 only. The line end will not produce any glyphs and we
8466 would never get MOVE_X_REACHED. */
8467 eassert (it
->nglyphs
== 0);
8468 result
= MOVE_X_REACHED
;
8472 /* Is this a line end? If yes, we're done. */
8473 if (ITERATOR_AT_END_OF_LINE_P (it
))
8475 /* If we are past TO_CHARPOS, but never saw any character
8476 positions smaller than TO_CHARPOS, return
8477 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8479 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8481 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8483 if (IT_CHARPOS (ppos_it
) < ZV
)
8485 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8486 result
= MOVE_POS_MATCH_OR_ZV
;
8489 goto buffer_pos_reached
;
8491 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8492 && IT_CHARPOS (*it
) > to_charpos
)
8493 goto buffer_pos_reached
;
8495 result
= MOVE_NEWLINE_OR_CR
;
8498 result
= MOVE_NEWLINE_OR_CR
;
8502 prev_method
= it
->method
;
8503 if (it
->method
== GET_FROM_BUFFER
)
8504 prev_pos
= IT_CHARPOS (*it
);
8505 /* The current display element has been consumed. Advance
8507 set_iterator_to_next (it
, 1);
8508 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8509 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8510 if (IT_CHARPOS (*it
) < to_charpos
)
8511 saw_smaller_pos
= 1;
8513 && (op
& MOVE_TO_POS
)
8514 && IT_CHARPOS (*it
) >= to_charpos
8515 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8516 SAVE_IT (ppos_it
, *it
, ppos_data
);
8518 /* Stop if lines are truncated and IT's current x-position is
8519 past the right edge of the window now. */
8520 if (it
->line_wrap
== TRUNCATE
8521 && it
->current_x
>= it
->last_visible_x
)
8523 if (!FRAME_WINDOW_P (it
->f
)
8524 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8525 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8526 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8527 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8531 if ((at_eob_p
= !get_next_display_element (it
))
8532 || BUFFER_POS_REACHED_P ()
8533 /* If we are past TO_CHARPOS, but never saw any
8534 character positions smaller than TO_CHARPOS,
8535 return MOVE_POS_MATCH_OR_ZV, like the
8536 unidirectional display did. */
8537 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8539 && IT_CHARPOS (*it
) > to_charpos
))
8542 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8543 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8544 result
= MOVE_POS_MATCH_OR_ZV
;
8547 if (ITERATOR_AT_END_OF_LINE_P (it
))
8549 result
= MOVE_NEWLINE_OR_CR
;
8553 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8555 && IT_CHARPOS (*it
) > to_charpos
)
8557 if (IT_CHARPOS (ppos_it
) < ZV
)
8558 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8559 result
= MOVE_POS_MATCH_OR_ZV
;
8562 result
= MOVE_LINE_TRUNCATED
;
8565 #undef IT_RESET_X_ASCENT_DESCENT
8568 #undef BUFFER_POS_REACHED_P
8570 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8571 restore the saved iterator. */
8572 if (atpos_it
.sp
>= 0)
8573 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8574 else if (atx_it
.sp
>= 0)
8575 RESTORE_IT (it
, &atx_it
, atx_data
);
8580 bidi_unshelve_cache (atpos_data
, 1);
8582 bidi_unshelve_cache (atx_data
, 1);
8584 bidi_unshelve_cache (wrap_data
, 1);
8586 bidi_unshelve_cache (ppos_data
, 1);
8588 /* Restore the iterator settings altered at the beginning of this
8590 it
->glyph_row
= saved_glyph_row
;
8594 /* For external use. */
8596 move_it_in_display_line (struct it
*it
,
8597 ptrdiff_t to_charpos
, int to_x
,
8598 enum move_operation_enum op
)
8600 if (it
->line_wrap
== WORD_WRAP
8601 && (op
& MOVE_TO_X
))
8604 void *save_data
= NULL
;
8607 SAVE_IT (save_it
, *it
, save_data
);
8608 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8609 /* When word-wrap is on, TO_X may lie past the end
8610 of a wrapped line. Then it->current is the
8611 character on the next line, so backtrack to the
8612 space before the wrap point. */
8613 if (skip
== MOVE_LINE_CONTINUED
)
8615 int prev_x
= max (it
->current_x
- 1, 0);
8616 RESTORE_IT (it
, &save_it
, save_data
);
8617 move_it_in_display_line_to
8618 (it
, -1, prev_x
, MOVE_TO_X
);
8621 bidi_unshelve_cache (save_data
, 1);
8624 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8628 /* Move IT forward until it satisfies one or more of the criteria in
8629 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8631 OP is a bit-mask that specifies where to stop, and in particular,
8632 which of those four position arguments makes a difference. See the
8633 description of enum move_operation_enum.
8635 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8636 screen line, this function will set IT to the next position that is
8637 displayed to the right of TO_CHARPOS on the screen. */
8640 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8642 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8643 int line_height
, line_start_x
= 0, reached
= 0;
8644 void *backup_data
= NULL
;
8648 if (op
& MOVE_TO_VPOS
)
8650 /* If no TO_CHARPOS and no TO_X specified, stop at the
8651 start of the line TO_VPOS. */
8652 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8654 if (it
->vpos
== to_vpos
)
8660 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8664 /* TO_VPOS >= 0 means stop at TO_X in the line at
8665 TO_VPOS, or at TO_POS, whichever comes first. */
8666 if (it
->vpos
== to_vpos
)
8672 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8674 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8679 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8681 /* We have reached TO_X but not in the line we want. */
8682 skip
= move_it_in_display_line_to (it
, to_charpos
,
8684 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8692 else if (op
& MOVE_TO_Y
)
8694 struct it it_backup
;
8696 if (it
->line_wrap
== WORD_WRAP
)
8697 SAVE_IT (it_backup
, *it
, backup_data
);
8699 /* TO_Y specified means stop at TO_X in the line containing
8700 TO_Y---or at TO_CHARPOS if this is reached first. The
8701 problem is that we can't really tell whether the line
8702 contains TO_Y before we have completely scanned it, and
8703 this may skip past TO_X. What we do is to first scan to
8706 If TO_X is not specified, use a TO_X of zero. The reason
8707 is to make the outcome of this function more predictable.
8708 If we didn't use TO_X == 0, we would stop at the end of
8709 the line which is probably not what a caller would expect
8711 skip
= move_it_in_display_line_to
8712 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8713 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8715 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8716 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8718 else if (skip
== MOVE_X_REACHED
)
8720 /* If TO_X was reached, we want to know whether TO_Y is
8721 in the line. We know this is the case if the already
8722 scanned glyphs make the line tall enough. Otherwise,
8723 we must check by scanning the rest of the line. */
8724 line_height
= it
->max_ascent
+ it
->max_descent
;
8725 if (to_y
>= it
->current_y
8726 && to_y
< it
->current_y
+ line_height
)
8731 SAVE_IT (it_backup
, *it
, backup_data
);
8732 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8733 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8735 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8736 line_height
= it
->max_ascent
+ it
->max_descent
;
8737 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8739 if (to_y
>= it
->current_y
8740 && to_y
< it
->current_y
+ line_height
)
8742 /* If TO_Y is in this line and TO_X was reached
8743 above, we scanned too far. We have to restore
8744 IT's settings to the ones before skipping. But
8745 keep the more accurate values of max_ascent and
8746 max_descent we've found while skipping the rest
8747 of the line, for the sake of callers, such as
8748 pos_visible_p, that need to know the line
8750 int max_ascent
= it
->max_ascent
;
8751 int max_descent
= it
->max_descent
;
8753 RESTORE_IT (it
, &it_backup
, backup_data
);
8754 it
->max_ascent
= max_ascent
;
8755 it
->max_descent
= max_descent
;
8761 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8767 /* Check whether TO_Y is in this line. */
8768 line_height
= it
->max_ascent
+ it
->max_descent
;
8769 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8771 if (to_y
>= it
->current_y
8772 && to_y
< it
->current_y
+ line_height
)
8774 /* When word-wrap is on, TO_X may lie past the end
8775 of a wrapped line. Then it->current is the
8776 character on the next line, so backtrack to the
8777 space before the wrap point. */
8778 if (skip
== MOVE_LINE_CONTINUED
8779 && it
->line_wrap
== WORD_WRAP
)
8781 int prev_x
= max (it
->current_x
- 1, 0);
8782 RESTORE_IT (it
, &it_backup
, backup_data
);
8783 skip
= move_it_in_display_line_to
8784 (it
, -1, prev_x
, MOVE_TO_X
);
8793 else if (BUFFERP (it
->object
)
8794 && (it
->method
== GET_FROM_BUFFER
8795 || it
->method
== GET_FROM_STRETCH
)
8796 && IT_CHARPOS (*it
) >= to_charpos
8797 /* Under bidi iteration, a call to set_iterator_to_next
8798 can scan far beyond to_charpos if the initial
8799 portion of the next line needs to be reordered. In
8800 that case, give move_it_in_display_line_to another
8803 && it
->bidi_it
.scan_dir
== -1))
8804 skip
= MOVE_POS_MATCH_OR_ZV
;
8806 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8810 case MOVE_POS_MATCH_OR_ZV
:
8814 case MOVE_NEWLINE_OR_CR
:
8815 set_iterator_to_next (it
, 1);
8816 it
->continuation_lines_width
= 0;
8819 case MOVE_LINE_TRUNCATED
:
8820 it
->continuation_lines_width
= 0;
8821 reseat_at_next_visible_line_start (it
, 0);
8822 if ((op
& MOVE_TO_POS
) != 0
8823 && IT_CHARPOS (*it
) > to_charpos
)
8830 case MOVE_LINE_CONTINUED
:
8831 /* For continued lines ending in a tab, some of the glyphs
8832 associated with the tab are displayed on the current
8833 line. Since it->current_x does not include these glyphs,
8834 we use it->last_visible_x instead. */
8837 it
->continuation_lines_width
+= it
->last_visible_x
;
8838 /* When moving by vpos, ensure that the iterator really
8839 advances to the next line (bug#847, bug#969). Fixme:
8840 do we need to do this in other circumstances? */
8841 if (it
->current_x
!= it
->last_visible_x
8842 && (op
& MOVE_TO_VPOS
)
8843 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8845 line_start_x
= it
->current_x
+ it
->pixel_width
8846 - it
->last_visible_x
;
8847 set_iterator_to_next (it
, 0);
8851 it
->continuation_lines_width
+= it
->current_x
;
8858 /* Reset/increment for the next run. */
8859 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8860 it
->current_x
= line_start_x
;
8863 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8865 last_height
= it
->max_ascent
+ it
->max_descent
;
8866 last_max_ascent
= it
->max_ascent
;
8867 it
->max_ascent
= it
->max_descent
= 0;
8872 /* On text terminals, we may stop at the end of a line in the middle
8873 of a multi-character glyph. If the glyph itself is continued,
8874 i.e. it is actually displayed on the next line, don't treat this
8875 stopping point as valid; move to the next line instead (unless
8876 that brings us offscreen). */
8877 if (!FRAME_WINDOW_P (it
->f
)
8879 && IT_CHARPOS (*it
) == to_charpos
8880 && it
->what
== IT_CHARACTER
8882 && it
->line_wrap
== WINDOW_WRAP
8883 && it
->current_x
== it
->last_visible_x
- 1
8886 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8888 it
->continuation_lines_width
+= it
->current_x
;
8889 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8890 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8892 last_height
= it
->max_ascent
+ it
->max_descent
;
8893 last_max_ascent
= it
->max_ascent
;
8897 bidi_unshelve_cache (backup_data
, 1);
8899 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8903 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8905 If DY > 0, move IT backward at least that many pixels. DY = 0
8906 means move IT backward to the preceding line start or BEGV. This
8907 function may move over more than DY pixels if IT->current_y - DY
8908 ends up in the middle of a line; in this case IT->current_y will be
8909 set to the top of the line moved to. */
8912 move_it_vertically_backward (struct it
*it
, int dy
)
8916 void *it2data
= NULL
, *it3data
= NULL
;
8917 ptrdiff_t start_pos
;
8922 start_pos
= IT_CHARPOS (*it
);
8924 /* Estimate how many newlines we must move back. */
8925 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8927 /* Set the iterator's position that many lines back. */
8928 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8929 back_to_previous_visible_line_start (it
);
8931 /* Reseat the iterator here. When moving backward, we don't want
8932 reseat to skip forward over invisible text, set up the iterator
8933 to deliver from overlay strings at the new position etc. So,
8934 use reseat_1 here. */
8935 reseat_1 (it
, it
->current
.pos
, 1);
8937 /* We are now surely at a line start. */
8938 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8939 reordering is in effect. */
8940 it
->continuation_lines_width
= 0;
8942 /* Move forward and see what y-distance we moved. First move to the
8943 start of the next line so that we get its height. We need this
8944 height to be able to tell whether we reached the specified
8946 SAVE_IT (it2
, *it
, it2data
);
8947 it2
.max_ascent
= it2
.max_descent
= 0;
8950 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8951 MOVE_TO_POS
| MOVE_TO_VPOS
);
8953 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8954 /* If we are in a display string which starts at START_POS,
8955 and that display string includes a newline, and we are
8956 right after that newline (i.e. at the beginning of a
8957 display line), exit the loop, because otherwise we will
8958 infloop, since move_it_to will see that it is already at
8959 START_POS and will not move. */
8960 || (it2
.method
== GET_FROM_STRING
8961 && IT_CHARPOS (it2
) == start_pos
8962 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8963 eassert (IT_CHARPOS (*it
) >= BEGV
);
8964 SAVE_IT (it3
, it2
, it3data
);
8966 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8967 eassert (IT_CHARPOS (*it
) >= BEGV
);
8968 /* H is the actual vertical distance from the position in *IT
8969 and the starting position. */
8970 h
= it2
.current_y
- it
->current_y
;
8971 /* NLINES is the distance in number of lines. */
8972 nlines
= it2
.vpos
- it
->vpos
;
8974 /* Correct IT's y and vpos position
8975 so that they are relative to the starting point. */
8981 /* DY == 0 means move to the start of the screen line. The
8982 value of nlines is > 0 if continuation lines were involved,
8983 or if the original IT position was at start of a line. */
8984 RESTORE_IT (it
, it
, it2data
);
8986 move_it_by_lines (it
, nlines
);
8987 /* The above code moves us to some position NLINES down,
8988 usually to its first glyph (leftmost in an L2R line), but
8989 that's not necessarily the start of the line, under bidi
8990 reordering. We want to get to the character position
8991 that is immediately after the newline of the previous
8994 && !it
->continuation_lines_width
8995 && !STRINGP (it
->string
)
8996 && IT_CHARPOS (*it
) > BEGV
8997 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9000 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9002 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9004 bidi_unshelve_cache (it3data
, 1);
9008 /* The y-position we try to reach, relative to *IT.
9009 Note that H has been subtracted in front of the if-statement. */
9010 int target_y
= it
->current_y
+ h
- dy
;
9011 int y0
= it3
.current_y
;
9015 RESTORE_IT (&it3
, &it3
, it3data
);
9016 y1
= line_bottom_y (&it3
);
9017 line_height
= y1
- y0
;
9018 RESTORE_IT (it
, it
, it2data
);
9019 /* If we did not reach target_y, try to move further backward if
9020 we can. If we moved too far backward, try to move forward. */
9021 if (target_y
< it
->current_y
9022 /* This is heuristic. In a window that's 3 lines high, with
9023 a line height of 13 pixels each, recentering with point
9024 on the bottom line will try to move -39/2 = 19 pixels
9025 backward. Try to avoid moving into the first line. */
9026 && (it
->current_y
- target_y
9027 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9028 && IT_CHARPOS (*it
) > BEGV
)
9030 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9031 target_y
- it
->current_y
));
9032 dy
= it
->current_y
- target_y
;
9033 goto move_further_back
;
9035 else if (target_y
>= it
->current_y
+ line_height
9036 && IT_CHARPOS (*it
) < ZV
)
9038 /* Should move forward by at least one line, maybe more.
9040 Note: Calling move_it_by_lines can be expensive on
9041 terminal frames, where compute_motion is used (via
9042 vmotion) to do the job, when there are very long lines
9043 and truncate-lines is nil. That's the reason for
9044 treating terminal frames specially here. */
9046 if (!FRAME_WINDOW_P (it
->f
))
9047 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9052 move_it_by_lines (it
, 1);
9054 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9061 /* Move IT by a specified amount of pixel lines DY. DY negative means
9062 move backwards. DY = 0 means move to start of screen line. At the
9063 end, IT will be on the start of a screen line. */
9066 move_it_vertically (struct it
*it
, int dy
)
9069 move_it_vertically_backward (it
, -dy
);
9072 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9073 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9074 MOVE_TO_POS
| MOVE_TO_Y
);
9075 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9077 /* If buffer ends in ZV without a newline, move to the start of
9078 the line to satisfy the post-condition. */
9079 if (IT_CHARPOS (*it
) == ZV
9081 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9082 move_it_by_lines (it
, 0);
9087 /* Move iterator IT past the end of the text line it is in. */
9090 move_it_past_eol (struct it
*it
)
9092 enum move_it_result rc
;
9094 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9095 if (rc
== MOVE_NEWLINE_OR_CR
)
9096 set_iterator_to_next (it
, 0);
9100 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9101 negative means move up. DVPOS == 0 means move to the start of the
9104 Optimization idea: If we would know that IT->f doesn't use
9105 a face with proportional font, we could be faster for
9106 truncate-lines nil. */
9109 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9112 /* The commented-out optimization uses vmotion on terminals. This
9113 gives bad results, because elements like it->what, on which
9114 callers such as pos_visible_p rely, aren't updated. */
9115 /* struct position pos;
9116 if (!FRAME_WINDOW_P (it->f))
9118 struct text_pos textpos;
9120 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9121 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9122 reseat (it, textpos, 1);
9123 it->vpos += pos.vpos;
9124 it->current_y += pos.vpos;
9130 /* DVPOS == 0 means move to the start of the screen line. */
9131 move_it_vertically_backward (it
, 0);
9132 /* Let next call to line_bottom_y calculate real line height */
9137 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9138 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9140 /* Only move to the next buffer position if we ended up in a
9141 string from display property, not in an overlay string
9142 (before-string or after-string). That is because the
9143 latter don't conceal the underlying buffer position, so
9144 we can ask to move the iterator to the exact position we
9145 are interested in. Note that, even if we are already at
9146 IT_CHARPOS (*it), the call below is not a no-op, as it
9147 will detect that we are at the end of the string, pop the
9148 iterator, and compute it->current_x and it->hpos
9150 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9151 -1, -1, -1, MOVE_TO_POS
);
9157 void *it2data
= NULL
;
9158 ptrdiff_t start_charpos
, i
;
9160 /* Start at the beginning of the screen line containing IT's
9161 position. This may actually move vertically backwards,
9162 in case of overlays, so adjust dvpos accordingly. */
9164 move_it_vertically_backward (it
, 0);
9167 /* Go back -DVPOS visible lines and reseat the iterator there. */
9168 start_charpos
= IT_CHARPOS (*it
);
9169 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9170 back_to_previous_visible_line_start (it
);
9171 reseat (it
, it
->current
.pos
, 1);
9173 /* Move further back if we end up in a string or an image. */
9174 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9176 /* First try to move to start of display line. */
9178 move_it_vertically_backward (it
, 0);
9180 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9182 /* If start of line is still in string or image,
9183 move further back. */
9184 back_to_previous_visible_line_start (it
);
9185 reseat (it
, it
->current
.pos
, 1);
9189 it
->current_x
= it
->hpos
= 0;
9191 /* Above call may have moved too far if continuation lines
9192 are involved. Scan forward and see if it did. */
9193 SAVE_IT (it2
, *it
, it2data
);
9194 it2
.vpos
= it2
.current_y
= 0;
9195 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9196 it
->vpos
-= it2
.vpos
;
9197 it
->current_y
-= it2
.current_y
;
9198 it
->current_x
= it
->hpos
= 0;
9200 /* If we moved too far back, move IT some lines forward. */
9201 if (it2
.vpos
> -dvpos
)
9203 int delta
= it2
.vpos
+ dvpos
;
9205 RESTORE_IT (&it2
, &it2
, it2data
);
9206 SAVE_IT (it2
, *it
, it2data
);
9207 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9208 /* Move back again if we got too far ahead. */
9209 if (IT_CHARPOS (*it
) >= start_charpos
)
9210 RESTORE_IT (it
, &it2
, it2data
);
9212 bidi_unshelve_cache (it2data
, 1);
9215 RESTORE_IT (it
, it
, it2data
);
9219 /* Return 1 if IT points into the middle of a display vector. */
9222 in_display_vector_p (struct it
*it
)
9224 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9225 && it
->current
.dpvec_index
> 0
9226 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9230 /***********************************************************************
9232 ***********************************************************************/
9235 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9239 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9241 Lisp_Object args
[3];
9242 Lisp_Object msg
, fmt
;
9245 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9248 /* Do nothing if called asynchronously. Inserting text into
9249 a buffer may call after-change-functions and alike and
9250 that would means running Lisp asynchronously. */
9251 if (handling_signal
)
9255 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9257 args
[0] = fmt
= build_string (format
);
9260 msg
= Fformat (3, args
);
9262 len
= SBYTES (msg
) + 1;
9263 SAFE_ALLOCA (buffer
, char *, len
);
9264 memcpy (buffer
, SDATA (msg
), len
);
9266 message_dolog (buffer
, len
- 1, 1, 0);
9273 /* Output a newline in the *Messages* buffer if "needs" one. */
9276 message_log_maybe_newline (void)
9278 if (message_log_need_newline
)
9279 message_dolog ("", 0, 1, 0);
9283 /* Add a string M of length NBYTES to the message log, optionally
9284 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9285 nonzero, means interpret the contents of M as multibyte. This
9286 function calls low-level routines in order to bypass text property
9287 hooks, etc. which might not be safe to run.
9289 This may GC (insert may run before/after change hooks),
9290 so the buffer M must NOT point to a Lisp string. */
9293 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9295 const unsigned char *msg
= (const unsigned char *) m
;
9297 if (!NILP (Vmemory_full
))
9300 if (!NILP (Vmessage_log_max
))
9302 struct buffer
*oldbuf
;
9303 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9304 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9305 ptrdiff_t point_at_end
= 0;
9306 ptrdiff_t zv_at_end
= 0;
9307 Lisp_Object old_deactivate_mark
, tem
;
9308 struct gcpro gcpro1
;
9310 old_deactivate_mark
= Vdeactivate_mark
;
9311 oldbuf
= current_buffer
;
9312 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9313 BVAR (current_buffer
, undo_list
) = Qt
;
9315 oldpoint
= message_dolog_marker1
;
9316 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9317 oldbegv
= message_dolog_marker2
;
9318 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9319 oldzv
= message_dolog_marker3
;
9320 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9321 GCPRO1 (old_deactivate_mark
);
9329 BEGV_BYTE
= BEG_BYTE
;
9332 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9334 /* Insert the string--maybe converting multibyte to single byte
9335 or vice versa, so that all the text fits the buffer. */
9337 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9343 /* Convert a multibyte string to single-byte
9344 for the *Message* buffer. */
9345 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9347 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9348 work
[0] = (ASCII_CHAR_P (c
)
9350 : multibyte_char_to_unibyte (c
));
9351 insert_1_both (work
, 1, 1, 1, 0, 0);
9354 else if (! multibyte
9355 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9359 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9360 /* Convert a single-byte string to multibyte
9361 for the *Message* buffer. */
9362 for (i
= 0; i
< nbytes
; i
++)
9365 MAKE_CHAR_MULTIBYTE (c
);
9366 char_bytes
= CHAR_STRING (c
, str
);
9367 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9371 insert_1 (m
, nbytes
, 1, 0, 0);
9375 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9377 insert_1 ("\n", 1, 1, 0, 0);
9379 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9381 this_bol_byte
= PT_BYTE
;
9383 /* See if this line duplicates the previous one.
9384 If so, combine duplicates. */
9387 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9389 prev_bol_byte
= PT_BYTE
;
9391 dups
= message_log_check_duplicate (prev_bol_byte
,
9395 del_range_both (prev_bol
, prev_bol_byte
,
9396 this_bol
, this_bol_byte
, 0);
9399 char dupstr
[sizeof " [ times]"
9400 + INT_STRLEN_BOUND (printmax_t
)];
9402 /* If you change this format, don't forget to also
9403 change message_log_check_duplicate. */
9404 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9405 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9406 insert_1 (dupstr
, duplen
, 1, 0, 1);
9411 /* If we have more than the desired maximum number of lines
9412 in the *Messages* buffer now, delete the oldest ones.
9413 This is safe because we don't have undo in this buffer. */
9415 if (NATNUMP (Vmessage_log_max
))
9417 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9418 -XFASTINT (Vmessage_log_max
) - 1, 0);
9419 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9422 BEGV
= XMARKER (oldbegv
)->charpos
;
9423 BEGV_BYTE
= marker_byte_position (oldbegv
);
9432 ZV
= XMARKER (oldzv
)->charpos
;
9433 ZV_BYTE
= marker_byte_position (oldzv
);
9437 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9439 /* We can't do Fgoto_char (oldpoint) because it will run some
9441 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9442 XMARKER (oldpoint
)->bytepos
);
9445 unchain_marker (XMARKER (oldpoint
));
9446 unchain_marker (XMARKER (oldbegv
));
9447 unchain_marker (XMARKER (oldzv
));
9449 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9450 set_buffer_internal (oldbuf
);
9452 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9453 message_log_need_newline
= !nlflag
;
9454 Vdeactivate_mark
= old_deactivate_mark
;
9459 /* We are at the end of the buffer after just having inserted a newline.
9460 (Note: We depend on the fact we won't be crossing the gap.)
9461 Check to see if the most recent message looks a lot like the previous one.
9462 Return 0 if different, 1 if the new one should just replace it, or a
9463 value N > 1 if we should also append " [N times]". */
9466 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9469 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9471 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9472 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9474 for (i
= 0; i
< len
; i
++)
9476 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9484 if (*p1
++ == ' ' && *p1
++ == '[')
9487 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9488 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9495 /* Display an echo area message M with a specified length of NBYTES
9496 bytes. The string may include null characters. If M is 0, clear
9497 out any existing message, and let the mini-buffer text show
9500 This may GC, so the buffer M must NOT point to a Lisp string. */
9503 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9505 /* First flush out any partial line written with print. */
9506 message_log_maybe_newline ();
9508 message_dolog (m
, nbytes
, 1, multibyte
);
9509 message2_nolog (m
, nbytes
, multibyte
);
9513 /* The non-logging counterpart of message2. */
9516 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9518 struct frame
*sf
= SELECTED_FRAME ();
9519 message_enable_multibyte
= multibyte
;
9521 if (FRAME_INITIAL_P (sf
))
9523 if (noninteractive_need_newline
)
9524 putc ('\n', stderr
);
9525 noninteractive_need_newline
= 0;
9527 fwrite (m
, nbytes
, 1, stderr
);
9528 if (cursor_in_echo_area
== 0)
9529 fprintf (stderr
, "\n");
9532 /* A null message buffer means that the frame hasn't really been
9533 initialized yet. Error messages get reported properly by
9534 cmd_error, so this must be just an informative message; toss it. */
9535 else if (INTERACTIVE
9536 && sf
->glyphs_initialized_p
9537 && FRAME_MESSAGE_BUF (sf
))
9539 Lisp_Object mini_window
;
9542 /* Get the frame containing the mini-buffer
9543 that the selected frame is using. */
9544 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9545 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9547 FRAME_SAMPLE_VISIBILITY (f
);
9548 if (FRAME_VISIBLE_P (sf
)
9549 && ! FRAME_VISIBLE_P (f
))
9550 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9554 set_message (m
, Qnil
, nbytes
, multibyte
);
9555 if (minibuffer_auto_raise
)
9556 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9559 clear_message (1, 1);
9561 do_pending_window_change (0);
9562 echo_area_display (1);
9563 do_pending_window_change (0);
9564 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9565 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9570 /* Display an echo area message M with a specified length of NBYTES
9571 bytes. The string may include null characters. If M is not a
9572 string, clear out any existing message, and let the mini-buffer
9575 This function cancels echoing. */
9578 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9580 struct gcpro gcpro1
;
9583 clear_message (1,1);
9586 /* First flush out any partial line written with print. */
9587 message_log_maybe_newline ();
9593 SAFE_ALLOCA (buffer
, char *, nbytes
);
9594 memcpy (buffer
, SDATA (m
), nbytes
);
9595 message_dolog (buffer
, nbytes
, 1, multibyte
);
9598 message3_nolog (m
, nbytes
, multibyte
);
9604 /* The non-logging version of message3.
9605 This does not cancel echoing, because it is used for echoing.
9606 Perhaps we need to make a separate function for echoing
9607 and make this cancel echoing. */
9610 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9612 struct frame
*sf
= SELECTED_FRAME ();
9613 message_enable_multibyte
= multibyte
;
9615 if (FRAME_INITIAL_P (sf
))
9617 if (noninteractive_need_newline
)
9618 putc ('\n', stderr
);
9619 noninteractive_need_newline
= 0;
9621 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9622 if (cursor_in_echo_area
== 0)
9623 fprintf (stderr
, "\n");
9626 /* A null message buffer means that the frame hasn't really been
9627 initialized yet. Error messages get reported properly by
9628 cmd_error, so this must be just an informative message; toss it. */
9629 else if (INTERACTIVE
9630 && sf
->glyphs_initialized_p
9631 && FRAME_MESSAGE_BUF (sf
))
9633 Lisp_Object mini_window
;
9637 /* Get the frame containing the mini-buffer
9638 that the selected frame is using. */
9639 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9640 frame
= XWINDOW (mini_window
)->frame
;
9643 FRAME_SAMPLE_VISIBILITY (f
);
9644 if (FRAME_VISIBLE_P (sf
)
9645 && !FRAME_VISIBLE_P (f
))
9646 Fmake_frame_visible (frame
);
9648 if (STRINGP (m
) && SCHARS (m
) > 0)
9650 set_message (NULL
, m
, nbytes
, multibyte
);
9651 if (minibuffer_auto_raise
)
9652 Fraise_frame (frame
);
9653 /* Assume we are not echoing.
9654 (If we are, echo_now will override this.) */
9655 echo_message_buffer
= Qnil
;
9658 clear_message (1, 1);
9660 do_pending_window_change (0);
9661 echo_area_display (1);
9662 do_pending_window_change (0);
9663 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9664 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9669 /* Display a null-terminated echo area message M. If M is 0, clear
9670 out any existing message, and let the mini-buffer text show through.
9672 The buffer M must continue to exist until after the echo area gets
9673 cleared or some other message gets displayed there. Do not pass
9674 text that is stored in a Lisp string. Do not pass text in a buffer
9675 that was alloca'd. */
9678 message1 (const char *m
)
9680 message2 (m
, (m
? strlen (m
) : 0), 0);
9684 /* The non-logging counterpart of message1. */
9687 message1_nolog (const char *m
)
9689 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9692 /* Display a message M which contains a single %s
9693 which gets replaced with STRING. */
9696 message_with_string (const char *m
, Lisp_Object string
, int log
)
9698 CHECK_STRING (string
);
9704 if (noninteractive_need_newline
)
9705 putc ('\n', stderr
);
9706 noninteractive_need_newline
= 0;
9707 fprintf (stderr
, m
, SDATA (string
));
9708 if (!cursor_in_echo_area
)
9709 fprintf (stderr
, "\n");
9713 else if (INTERACTIVE
)
9715 /* The frame whose minibuffer we're going to display the message on.
9716 It may be larger than the selected frame, so we need
9717 to use its buffer, not the selected frame's buffer. */
9718 Lisp_Object mini_window
;
9719 struct frame
*f
, *sf
= SELECTED_FRAME ();
9721 /* Get the frame containing the minibuffer
9722 that the selected frame is using. */
9723 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9724 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9726 /* A null message buffer means that the frame hasn't really been
9727 initialized yet. Error messages get reported properly by
9728 cmd_error, so this must be just an informative message; toss it. */
9729 if (FRAME_MESSAGE_BUF (f
))
9731 Lisp_Object args
[2], msg
;
9732 struct gcpro gcpro1
, gcpro2
;
9734 args
[0] = build_string (m
);
9735 args
[1] = msg
= string
;
9736 GCPRO2 (args
[0], msg
);
9739 msg
= Fformat (2, args
);
9742 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9744 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9748 /* Print should start at the beginning of the message
9749 buffer next time. */
9750 message_buf_print
= 0;
9756 /* Dump an informative message to the minibuf. If M is 0, clear out
9757 any existing message, and let the mini-buffer text show through. */
9760 vmessage (const char *m
, va_list ap
)
9766 if (noninteractive_need_newline
)
9767 putc ('\n', stderr
);
9768 noninteractive_need_newline
= 0;
9769 vfprintf (stderr
, m
, ap
);
9770 if (cursor_in_echo_area
== 0)
9771 fprintf (stderr
, "\n");
9775 else if (INTERACTIVE
)
9777 /* The frame whose mini-buffer we're going to display the message
9778 on. It may be larger than the selected frame, so we need to
9779 use its buffer, not the selected frame's buffer. */
9780 Lisp_Object mini_window
;
9781 struct frame
*f
, *sf
= SELECTED_FRAME ();
9783 /* Get the frame containing the mini-buffer
9784 that the selected frame is using. */
9785 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9786 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9788 /* A null message buffer means that the frame hasn't really been
9789 initialized yet. Error messages get reported properly by
9790 cmd_error, so this must be just an informative message; toss
9792 if (FRAME_MESSAGE_BUF (f
))
9798 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9799 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9801 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9806 /* Print should start at the beginning of the message
9807 buffer next time. */
9808 message_buf_print
= 0;
9814 message (const char *m
, ...)
9824 /* The non-logging version of message. */
9827 message_nolog (const char *m
, ...)
9829 Lisp_Object old_log_max
;
9832 old_log_max
= Vmessage_log_max
;
9833 Vmessage_log_max
= Qnil
;
9835 Vmessage_log_max
= old_log_max
;
9841 /* Display the current message in the current mini-buffer. This is
9842 only called from error handlers in process.c, and is not time
9846 update_echo_area (void)
9848 if (!NILP (echo_area_buffer
[0]))
9851 string
= Fcurrent_message ();
9852 message3 (string
, SBYTES (string
),
9853 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9858 /* Make sure echo area buffers in `echo_buffers' are live.
9859 If they aren't, make new ones. */
9862 ensure_echo_area_buffers (void)
9866 for (i
= 0; i
< 2; ++i
)
9867 if (!BUFFERP (echo_buffer
[i
])
9868 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9871 Lisp_Object old_buffer
;
9874 old_buffer
= echo_buffer
[i
];
9875 echo_buffer
[i
] = Fget_buffer_create
9876 (make_formatted_string (name
, " *Echo Area %d*", i
));
9877 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9878 /* to force word wrap in echo area -
9879 it was decided to postpone this*/
9880 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9882 for (j
= 0; j
< 2; ++j
)
9883 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9884 echo_area_buffer
[j
] = echo_buffer
[i
];
9889 /* Call FN with args A1..A4 with either the current or last displayed
9890 echo_area_buffer as current buffer.
9892 WHICH zero means use the current message buffer
9893 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9894 from echo_buffer[] and clear it.
9896 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9897 suitable buffer from echo_buffer[] and clear it.
9899 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9900 that the current message becomes the last displayed one, make
9901 choose a suitable buffer for echo_area_buffer[0], and clear it.
9903 Value is what FN returns. */
9906 with_echo_area_buffer (struct window
*w
, int which
,
9907 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9908 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9911 int this_one
, the_other
, clear_buffer_p
, rc
;
9912 ptrdiff_t count
= SPECPDL_INDEX ();
9914 /* If buffers aren't live, make new ones. */
9915 ensure_echo_area_buffers ();
9920 this_one
= 0, the_other
= 1;
9922 this_one
= 1, the_other
= 0;
9925 this_one
= 0, the_other
= 1;
9928 /* We need a fresh one in case the current echo buffer equals
9929 the one containing the last displayed echo area message. */
9930 if (!NILP (echo_area_buffer
[this_one
])
9931 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9932 echo_area_buffer
[this_one
] = Qnil
;
9935 /* Choose a suitable buffer from echo_buffer[] is we don't
9937 if (NILP (echo_area_buffer
[this_one
]))
9939 echo_area_buffer
[this_one
]
9940 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9941 ? echo_buffer
[the_other
]
9942 : echo_buffer
[this_one
]);
9946 buffer
= echo_area_buffer
[this_one
];
9948 /* Don't get confused by reusing the buffer used for echoing
9949 for a different purpose. */
9950 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9953 record_unwind_protect (unwind_with_echo_area_buffer
,
9954 with_echo_area_buffer_unwind_data (w
));
9956 /* Make the echo area buffer current. Note that for display
9957 purposes, it is not necessary that the displayed window's buffer
9958 == current_buffer, except for text property lookup. So, let's
9959 only set that buffer temporarily here without doing a full
9960 Fset_window_buffer. We must also change w->pointm, though,
9961 because otherwise an assertions in unshow_buffer fails, and Emacs
9963 set_buffer_internal_1 (XBUFFER (buffer
));
9967 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9970 BVAR (current_buffer
, undo_list
) = Qt
;
9971 BVAR (current_buffer
, read_only
) = Qnil
;
9972 specbind (Qinhibit_read_only
, Qt
);
9973 specbind (Qinhibit_modification_hooks
, Qt
);
9975 if (clear_buffer_p
&& Z
> BEG
)
9978 eassert (BEGV
>= BEG
);
9979 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9981 rc
= fn (a1
, a2
, a3
, a4
);
9983 eassert (BEGV
>= BEG
);
9984 eassert (ZV
<= Z
&& ZV
>= BEGV
);
9986 unbind_to (count
, Qnil
);
9991 /* Save state that should be preserved around the call to the function
9992 FN called in with_echo_area_buffer. */
9995 with_echo_area_buffer_unwind_data (struct window
*w
)
9998 Lisp_Object vector
, tmp
;
10000 /* Reduce consing by keeping one vector in
10001 Vwith_echo_area_save_vector. */
10002 vector
= Vwith_echo_area_save_vector
;
10003 Vwith_echo_area_save_vector
= Qnil
;
10006 vector
= Fmake_vector (make_number (7), Qnil
);
10008 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10009 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10010 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10014 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10015 ASET (vector
, i
, w
->buffer
); ++i
;
10016 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10017 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10022 for (; i
< end
; ++i
)
10023 ASET (vector
, i
, Qnil
);
10026 eassert (i
== ASIZE (vector
));
10031 /* Restore global state from VECTOR which was created by
10032 with_echo_area_buffer_unwind_data. */
10035 unwind_with_echo_area_buffer (Lisp_Object vector
)
10037 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10038 Vdeactivate_mark
= AREF (vector
, 1);
10039 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10041 if (WINDOWP (AREF (vector
, 3)))
10044 Lisp_Object buffer
, charpos
, bytepos
;
10046 w
= XWINDOW (AREF (vector
, 3));
10047 buffer
= AREF (vector
, 4);
10048 charpos
= AREF (vector
, 5);
10049 bytepos
= AREF (vector
, 6);
10051 w
->buffer
= buffer
;
10052 set_marker_both (w
->pointm
, buffer
,
10053 XFASTINT (charpos
), XFASTINT (bytepos
));
10056 Vwith_echo_area_save_vector
= vector
;
10061 /* Set up the echo area for use by print functions. MULTIBYTE_P
10062 non-zero means we will print multibyte. */
10065 setup_echo_area_for_printing (int multibyte_p
)
10067 /* If we can't find an echo area any more, exit. */
10068 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10069 Fkill_emacs (Qnil
);
10071 ensure_echo_area_buffers ();
10073 if (!message_buf_print
)
10075 /* A message has been output since the last time we printed.
10076 Choose a fresh echo area buffer. */
10077 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10078 echo_area_buffer
[0] = echo_buffer
[1];
10080 echo_area_buffer
[0] = echo_buffer
[0];
10082 /* Switch to that buffer and clear it. */
10083 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10084 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10088 ptrdiff_t count
= SPECPDL_INDEX ();
10089 specbind (Qinhibit_read_only
, Qt
);
10090 /* Note that undo recording is always disabled. */
10091 del_range (BEG
, Z
);
10092 unbind_to (count
, Qnil
);
10094 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10096 /* Set up the buffer for the multibyteness we need. */
10098 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10099 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10101 /* Raise the frame containing the echo area. */
10102 if (minibuffer_auto_raise
)
10104 struct frame
*sf
= SELECTED_FRAME ();
10105 Lisp_Object mini_window
;
10106 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10107 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10110 message_log_maybe_newline ();
10111 message_buf_print
= 1;
10115 if (NILP (echo_area_buffer
[0]))
10117 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10118 echo_area_buffer
[0] = echo_buffer
[1];
10120 echo_area_buffer
[0] = echo_buffer
[0];
10123 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10125 /* Someone switched buffers between print requests. */
10126 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10127 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10133 /* Display an echo area message in window W. Value is non-zero if W's
10134 height is changed. If display_last_displayed_message_p is
10135 non-zero, display the message that was last displayed, otherwise
10136 display the current message. */
10139 display_echo_area (struct window
*w
)
10141 int i
, no_message_p
, window_height_changed_p
;
10143 /* Temporarily disable garbage collections while displaying the echo
10144 area. This is done because a GC can print a message itself.
10145 That message would modify the echo area buffer's contents while a
10146 redisplay of the buffer is going on, and seriously confuse
10148 ptrdiff_t count
= inhibit_garbage_collection ();
10150 /* If there is no message, we must call display_echo_area_1
10151 nevertheless because it resizes the window. But we will have to
10152 reset the echo_area_buffer in question to nil at the end because
10153 with_echo_area_buffer will sets it to an empty buffer. */
10154 i
= display_last_displayed_message_p
? 1 : 0;
10155 no_message_p
= NILP (echo_area_buffer
[i
]);
10157 window_height_changed_p
10158 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10159 display_echo_area_1
,
10160 (intptr_t) w
, Qnil
, 0, 0);
10163 echo_area_buffer
[i
] = Qnil
;
10165 unbind_to (count
, Qnil
);
10166 return window_height_changed_p
;
10170 /* Helper for display_echo_area. Display the current buffer which
10171 contains the current echo area message in window W, a mini-window,
10172 a pointer to which is passed in A1. A2..A4 are currently not used.
10173 Change the height of W so that all of the message is displayed.
10174 Value is non-zero if height of W was changed. */
10177 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10180 struct window
*w
= (struct window
*) i1
;
10181 Lisp_Object window
;
10182 struct text_pos start
;
10183 int window_height_changed_p
= 0;
10185 /* Do this before displaying, so that we have a large enough glyph
10186 matrix for the display. If we can't get enough space for the
10187 whole text, display the last N lines. That works by setting w->start. */
10188 window_height_changed_p
= resize_mini_window (w
, 0);
10190 /* Use the starting position chosen by resize_mini_window. */
10191 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10194 clear_glyph_matrix (w
->desired_matrix
);
10195 XSETWINDOW (window
, w
);
10196 try_window (window
, start
, 0);
10198 return window_height_changed_p
;
10202 /* Resize the echo area window to exactly the size needed for the
10203 currently displayed message, if there is one. If a mini-buffer
10204 is active, don't shrink it. */
10207 resize_echo_area_exactly (void)
10209 if (BUFFERP (echo_area_buffer
[0])
10210 && WINDOWP (echo_area_window
))
10212 struct window
*w
= XWINDOW (echo_area_window
);
10214 Lisp_Object resize_exactly
;
10216 if (minibuf_level
== 0)
10217 resize_exactly
= Qt
;
10219 resize_exactly
= Qnil
;
10221 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10222 (intptr_t) w
, resize_exactly
,
10226 ++windows_or_buffers_changed
;
10227 ++update_mode_lines
;
10228 redisplay_internal ();
10234 /* Callback function for with_echo_area_buffer, when used from
10235 resize_echo_area_exactly. A1 contains a pointer to the window to
10236 resize, EXACTLY non-nil means resize the mini-window exactly to the
10237 size of the text displayed. A3 and A4 are not used. Value is what
10238 resize_mini_window returns. */
10241 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10244 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10248 /* Resize mini-window W to fit the size of its contents. EXACT_P
10249 means size the window exactly to the size needed. Otherwise, it's
10250 only enlarged until W's buffer is empty.
10252 Set W->start to the right place to begin display. If the whole
10253 contents fit, start at the beginning. Otherwise, start so as
10254 to make the end of the contents appear. This is particularly
10255 important for y-or-n-p, but seems desirable generally.
10257 Value is non-zero if the window height has been changed. */
10260 resize_mini_window (struct window
*w
, int exact_p
)
10262 struct frame
*f
= XFRAME (w
->frame
);
10263 int window_height_changed_p
= 0;
10265 eassert (MINI_WINDOW_P (w
));
10267 /* By default, start display at the beginning. */
10268 set_marker_both (w
->start
, w
->buffer
,
10269 BUF_BEGV (XBUFFER (w
->buffer
)),
10270 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10272 /* Don't resize windows while redisplaying a window; it would
10273 confuse redisplay functions when the size of the window they are
10274 displaying changes from under them. Such a resizing can happen,
10275 for instance, when which-func prints a long message while
10276 we are running fontification-functions. We're running these
10277 functions with safe_call which binds inhibit-redisplay to t. */
10278 if (!NILP (Vinhibit_redisplay
))
10281 /* Nil means don't try to resize. */
10282 if (NILP (Vresize_mini_windows
)
10283 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10286 if (!FRAME_MINIBUF_ONLY_P (f
))
10289 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10290 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10292 EMACS_INT max_height
;
10293 int unit
= FRAME_LINE_HEIGHT (f
);
10294 struct text_pos start
;
10295 struct buffer
*old_current_buffer
= NULL
;
10297 if (current_buffer
!= XBUFFER (w
->buffer
))
10299 old_current_buffer
= current_buffer
;
10300 set_buffer_internal (XBUFFER (w
->buffer
));
10303 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10305 /* Compute the max. number of lines specified by the user. */
10306 if (FLOATP (Vmax_mini_window_height
))
10307 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10308 else if (INTEGERP (Vmax_mini_window_height
))
10309 max_height
= XINT (Vmax_mini_window_height
);
10311 max_height
= total_height
/ 4;
10313 /* Correct that max. height if it's bogus. */
10314 max_height
= max (1, max_height
);
10315 max_height
= min (total_height
, max_height
);
10317 /* Find out the height of the text in the window. */
10318 if (it
.line_wrap
== TRUNCATE
)
10323 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10324 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10325 height
= it
.current_y
+ last_height
;
10327 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10328 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10329 height
= (height
+ unit
- 1) / unit
;
10332 /* Compute a suitable window start. */
10333 if (height
> max_height
)
10335 height
= max_height
;
10336 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10337 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10338 start
= it
.current
.pos
;
10341 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10342 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10344 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10346 /* Let it grow only, until we display an empty message, in which
10347 case the window shrinks again. */
10348 if (height
> WINDOW_TOTAL_LINES (w
))
10350 int old_height
= WINDOW_TOTAL_LINES (w
);
10351 freeze_window_starts (f
, 1);
10352 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10353 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10355 else if (height
< WINDOW_TOTAL_LINES (w
)
10356 && (exact_p
|| BEGV
== ZV
))
10358 int old_height
= WINDOW_TOTAL_LINES (w
);
10359 freeze_window_starts (f
, 0);
10360 shrink_mini_window (w
);
10361 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10366 /* Always resize to exact size needed. */
10367 if (height
> WINDOW_TOTAL_LINES (w
))
10369 int old_height
= WINDOW_TOTAL_LINES (w
);
10370 freeze_window_starts (f
, 1);
10371 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10372 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10374 else if (height
< WINDOW_TOTAL_LINES (w
))
10376 int old_height
= WINDOW_TOTAL_LINES (w
);
10377 freeze_window_starts (f
, 0);
10378 shrink_mini_window (w
);
10382 freeze_window_starts (f
, 1);
10383 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10386 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10390 if (old_current_buffer
)
10391 set_buffer_internal (old_current_buffer
);
10394 return window_height_changed_p
;
10398 /* Value is the current message, a string, or nil if there is no
10399 current message. */
10402 current_message (void)
10406 if (!BUFFERP (echo_area_buffer
[0]))
10410 with_echo_area_buffer (0, 0, current_message_1
,
10411 (intptr_t) &msg
, Qnil
, 0, 0);
10413 echo_area_buffer
[0] = Qnil
;
10421 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10424 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10427 *msg
= make_buffer_string (BEG
, Z
, 1);
10434 /* Push the current message on Vmessage_stack for later restoration
10435 by restore_message. Value is non-zero if the current message isn't
10436 empty. This is a relatively infrequent operation, so it's not
10437 worth optimizing. */
10440 push_message (void)
10443 msg
= current_message ();
10444 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10445 return STRINGP (msg
);
10449 /* Restore message display from the top of Vmessage_stack. */
10452 restore_message (void)
10456 eassert (CONSP (Vmessage_stack
));
10457 msg
= XCAR (Vmessage_stack
);
10459 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10461 message3_nolog (msg
, 0, 0);
10465 /* Handler for record_unwind_protect calling pop_message. */
10468 pop_message_unwind (Lisp_Object dummy
)
10474 /* Pop the top-most entry off Vmessage_stack. */
10479 eassert (CONSP (Vmessage_stack
));
10480 Vmessage_stack
= XCDR (Vmessage_stack
);
10484 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10485 exits. If the stack is not empty, we have a missing pop_message
10489 check_message_stack (void)
10491 if (!NILP (Vmessage_stack
))
10496 /* Truncate to NCHARS what will be displayed in the echo area the next
10497 time we display it---but don't redisplay it now. */
10500 truncate_echo_area (ptrdiff_t nchars
)
10503 echo_area_buffer
[0] = Qnil
;
10504 /* A null message buffer means that the frame hasn't really been
10505 initialized yet. Error messages get reported properly by
10506 cmd_error, so this must be just an informative message; toss it. */
10507 else if (!noninteractive
10509 && !NILP (echo_area_buffer
[0]))
10511 struct frame
*sf
= SELECTED_FRAME ();
10512 if (FRAME_MESSAGE_BUF (sf
))
10513 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10518 /* Helper function for truncate_echo_area. Truncate the current
10519 message to at most NCHARS characters. */
10522 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10524 if (BEG
+ nchars
< Z
)
10525 del_range (BEG
+ nchars
, Z
);
10527 echo_area_buffer
[0] = Qnil
;
10532 /* Set the current message to a substring of S or STRING.
10534 If STRING is a Lisp string, set the message to the first NBYTES
10535 bytes from STRING. NBYTES zero means use the whole string. If
10536 STRING is multibyte, the message will be displayed multibyte.
10538 If S is not null, set the message to the first LEN bytes of S. LEN
10539 zero means use the whole string. MULTIBYTE_P non-zero means S is
10540 multibyte. Display the message multibyte in that case.
10542 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10543 to t before calling set_message_1 (which calls insert).
10547 set_message (const char *s
, Lisp_Object string
,
10548 ptrdiff_t nbytes
, int multibyte_p
)
10550 message_enable_multibyte
10551 = ((s
&& multibyte_p
)
10552 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10554 with_echo_area_buffer (0, -1, set_message_1
,
10555 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10556 message_buf_print
= 0;
10557 help_echo_showing_p
= 0;
10561 /* Helper function for set_message. Arguments have the same meaning
10562 as there, with A1 corresponding to S and A2 corresponding to STRING
10563 This function is called with the echo area buffer being
10567 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10570 const char *s
= (const char *) i1
;
10571 const unsigned char *msg
= (const unsigned char *) s
;
10572 Lisp_Object string
= a2
;
10574 /* Change multibyteness of the echo buffer appropriately. */
10575 if (message_enable_multibyte
10576 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10577 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10579 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10580 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10581 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10583 /* Insert new message at BEG. */
10584 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10586 if (STRINGP (string
))
10591 nbytes
= SBYTES (string
);
10592 nchars
= string_byte_to_char (string
, nbytes
);
10594 /* This function takes care of single/multibyte conversion. We
10595 just have to ensure that the echo area buffer has the right
10596 setting of enable_multibyte_characters. */
10597 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10602 nbytes
= strlen (s
);
10604 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10606 /* Convert from multi-byte to single-byte. */
10611 /* Convert a multibyte string to single-byte. */
10612 for (i
= 0; i
< nbytes
; i
+= n
)
10614 c
= string_char_and_length (msg
+ i
, &n
);
10615 work
[0] = (ASCII_CHAR_P (c
)
10617 : multibyte_char_to_unibyte (c
));
10618 insert_1_both (work
, 1, 1, 1, 0, 0);
10621 else if (!multibyte_p
10622 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10624 /* Convert from single-byte to multi-byte. */
10627 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10629 /* Convert a single-byte string to multibyte. */
10630 for (i
= 0; i
< nbytes
; i
++)
10633 MAKE_CHAR_MULTIBYTE (c
);
10634 n
= CHAR_STRING (c
, str
);
10635 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10639 insert_1 (s
, nbytes
, 1, 0, 0);
10646 /* Clear messages. CURRENT_P non-zero means clear the current
10647 message. LAST_DISPLAYED_P non-zero means clear the message
10651 clear_message (int current_p
, int last_displayed_p
)
10655 echo_area_buffer
[0] = Qnil
;
10656 message_cleared_p
= 1;
10659 if (last_displayed_p
)
10660 echo_area_buffer
[1] = Qnil
;
10662 message_buf_print
= 0;
10665 /* Clear garbaged frames.
10667 This function is used where the old redisplay called
10668 redraw_garbaged_frames which in turn called redraw_frame which in
10669 turn called clear_frame. The call to clear_frame was a source of
10670 flickering. I believe a clear_frame is not necessary. It should
10671 suffice in the new redisplay to invalidate all current matrices,
10672 and ensure a complete redisplay of all windows. */
10675 clear_garbaged_frames (void)
10677 if (frame_garbaged
)
10679 Lisp_Object tail
, frame
;
10680 int changed_count
= 0;
10682 FOR_EACH_FRAME (tail
, frame
)
10684 struct frame
*f
= XFRAME (frame
);
10686 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10690 Fredraw_frame (frame
);
10691 f
->force_flush_display_p
= 1;
10693 clear_current_matrices (f
);
10700 frame_garbaged
= 0;
10702 ++windows_or_buffers_changed
;
10707 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10708 is non-zero update selected_frame. Value is non-zero if the
10709 mini-windows height has been changed. */
10712 echo_area_display (int update_frame_p
)
10714 Lisp_Object mini_window
;
10717 int window_height_changed_p
= 0;
10718 struct frame
*sf
= SELECTED_FRAME ();
10720 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10721 w
= XWINDOW (mini_window
);
10722 f
= XFRAME (WINDOW_FRAME (w
));
10724 /* Don't display if frame is invisible or not yet initialized. */
10725 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10728 #ifdef HAVE_WINDOW_SYSTEM
10729 /* When Emacs starts, selected_frame may be the initial terminal
10730 frame. If we let this through, a message would be displayed on
10732 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10734 #endif /* HAVE_WINDOW_SYSTEM */
10736 /* Redraw garbaged frames. */
10737 if (frame_garbaged
)
10738 clear_garbaged_frames ();
10740 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10742 echo_area_window
= mini_window
;
10743 window_height_changed_p
= display_echo_area (w
);
10744 w
->must_be_updated_p
= 1;
10746 /* Update the display, unless called from redisplay_internal.
10747 Also don't update the screen during redisplay itself. The
10748 update will happen at the end of redisplay, and an update
10749 here could cause confusion. */
10750 if (update_frame_p
&& !redisplaying_p
)
10754 /* If the display update has been interrupted by pending
10755 input, update mode lines in the frame. Due to the
10756 pending input, it might have been that redisplay hasn't
10757 been called, so that mode lines above the echo area are
10758 garbaged. This looks odd, so we prevent it here. */
10759 if (!display_completed
)
10760 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10762 if (window_height_changed_p
10763 /* Don't do this if Emacs is shutting down. Redisplay
10764 needs to run hooks. */
10765 && !NILP (Vrun_hooks
))
10767 /* Must update other windows. Likewise as in other
10768 cases, don't let this update be interrupted by
10770 ptrdiff_t count
= SPECPDL_INDEX ();
10771 specbind (Qredisplay_dont_pause
, Qt
);
10772 windows_or_buffers_changed
= 1;
10773 redisplay_internal ();
10774 unbind_to (count
, Qnil
);
10776 else if (FRAME_WINDOW_P (f
) && n
== 0)
10778 /* Window configuration is the same as before.
10779 Can do with a display update of the echo area,
10780 unless we displayed some mode lines. */
10781 update_single_window (w
, 1);
10782 FRAME_RIF (f
)->flush_display (f
);
10785 update_frame (f
, 1, 1);
10787 /* If cursor is in the echo area, make sure that the next
10788 redisplay displays the minibuffer, so that the cursor will
10789 be replaced with what the minibuffer wants. */
10790 if (cursor_in_echo_area
)
10791 ++windows_or_buffers_changed
;
10794 else if (!EQ (mini_window
, selected_window
))
10795 windows_or_buffers_changed
++;
10797 /* Last displayed message is now the current message. */
10798 echo_area_buffer
[1] = echo_area_buffer
[0];
10799 /* Inform read_char that we're not echoing. */
10800 echo_message_buffer
= Qnil
;
10802 /* Prevent redisplay optimization in redisplay_internal by resetting
10803 this_line_start_pos. This is done because the mini-buffer now
10804 displays the message instead of its buffer text. */
10805 if (EQ (mini_window
, selected_window
))
10806 CHARPOS (this_line_start_pos
) = 0;
10808 return window_height_changed_p
;
10813 /***********************************************************************
10814 Mode Lines and Frame Titles
10815 ***********************************************************************/
10817 /* A buffer for constructing non-propertized mode-line strings and
10818 frame titles in it; allocated from the heap in init_xdisp and
10819 resized as needed in store_mode_line_noprop_char. */
10821 static char *mode_line_noprop_buf
;
10823 /* The buffer's end, and a current output position in it. */
10825 static char *mode_line_noprop_buf_end
;
10826 static char *mode_line_noprop_ptr
;
10828 #define MODE_LINE_NOPROP_LEN(start) \
10829 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10832 MODE_LINE_DISPLAY
= 0,
10836 } mode_line_target
;
10838 /* Alist that caches the results of :propertize.
10839 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10840 static Lisp_Object mode_line_proptrans_alist
;
10842 /* List of strings making up the mode-line. */
10843 static Lisp_Object mode_line_string_list
;
10845 /* Base face property when building propertized mode line string. */
10846 static Lisp_Object mode_line_string_face
;
10847 static Lisp_Object mode_line_string_face_prop
;
10850 /* Unwind data for mode line strings */
10852 static Lisp_Object Vmode_line_unwind_vector
;
10855 format_mode_line_unwind_data (struct frame
*target_frame
,
10856 struct buffer
*obuf
,
10858 int save_proptrans
)
10860 Lisp_Object vector
, tmp
;
10862 /* Reduce consing by keeping one vector in
10863 Vwith_echo_area_save_vector. */
10864 vector
= Vmode_line_unwind_vector
;
10865 Vmode_line_unwind_vector
= Qnil
;
10868 vector
= Fmake_vector (make_number (10), Qnil
);
10870 ASET (vector
, 0, make_number (mode_line_target
));
10871 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10872 ASET (vector
, 2, mode_line_string_list
);
10873 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10874 ASET (vector
, 4, mode_line_string_face
);
10875 ASET (vector
, 5, mode_line_string_face_prop
);
10878 XSETBUFFER (tmp
, obuf
);
10881 ASET (vector
, 6, tmp
);
10882 ASET (vector
, 7, owin
);
10885 /* Similarly to `with-selected-window', if the operation selects
10886 a window on another frame, we must restore that frame's
10887 selected window, and (for a tty) the top-frame. */
10888 ASET (vector
, 8, target_frame
->selected_window
);
10889 if (FRAME_TERMCAP_P (target_frame
))
10890 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10897 unwind_format_mode_line (Lisp_Object vector
)
10899 Lisp_Object old_window
= AREF (vector
, 7);
10900 Lisp_Object target_frame_window
= AREF (vector
, 8);
10901 Lisp_Object old_top_frame
= AREF (vector
, 9);
10903 mode_line_target
= XINT (AREF (vector
, 0));
10904 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10905 mode_line_string_list
= AREF (vector
, 2);
10906 if (! EQ (AREF (vector
, 3), Qt
))
10907 mode_line_proptrans_alist
= AREF (vector
, 3);
10908 mode_line_string_face
= AREF (vector
, 4);
10909 mode_line_string_face_prop
= AREF (vector
, 5);
10911 /* Select window before buffer, since it may change the buffer. */
10912 if (!NILP (old_window
))
10914 /* If the operation that we are unwinding had selected a window
10915 on a different frame, reset its frame-selected-window. For a
10916 text terminal, reset its top-frame if necessary. */
10917 if (!NILP (target_frame_window
))
10920 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10922 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10923 Fselect_window (target_frame_window
, Qt
);
10925 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10926 Fselect_frame (old_top_frame
, Qt
);
10929 Fselect_window (old_window
, Qt
);
10932 if (!NILP (AREF (vector
, 6)))
10934 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10935 ASET (vector
, 6, Qnil
);
10938 Vmode_line_unwind_vector
= vector
;
10943 /* Store a single character C for the frame title in mode_line_noprop_buf.
10944 Re-allocate mode_line_noprop_buf if necessary. */
10947 store_mode_line_noprop_char (char c
)
10949 /* If output position has reached the end of the allocated buffer,
10950 increase the buffer's size. */
10951 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10953 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10954 ptrdiff_t size
= len
;
10955 mode_line_noprop_buf
=
10956 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10957 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10958 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10961 *mode_line_noprop_ptr
++ = c
;
10965 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10966 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10967 characters that yield more columns than PRECISION; PRECISION <= 0
10968 means copy the whole string. Pad with spaces until FIELD_WIDTH
10969 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10970 pad. Called from display_mode_element when it is used to build a
10974 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10976 const unsigned char *str
= (const unsigned char *) string
;
10978 ptrdiff_t dummy
, nbytes
;
10980 /* Copy at most PRECISION chars from STR. */
10981 nbytes
= strlen (string
);
10982 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10984 store_mode_line_noprop_char (*str
++);
10986 /* Fill up with spaces until FIELD_WIDTH reached. */
10987 while (field_width
> 0
10988 && n
< field_width
)
10990 store_mode_line_noprop_char (' ');
10997 /***********************************************************************
10999 ***********************************************************************/
11001 #ifdef HAVE_WINDOW_SYSTEM
11003 /* Set the title of FRAME, if it has changed. The title format is
11004 Vicon_title_format if FRAME is iconified, otherwise it is
11005 frame_title_format. */
11008 x_consider_frame_title (Lisp_Object frame
)
11010 struct frame
*f
= XFRAME (frame
);
11012 if (FRAME_WINDOW_P (f
)
11013 || FRAME_MINIBUF_ONLY_P (f
)
11014 || f
->explicit_name
)
11016 /* Do we have more than one visible frame on this X display? */
11019 ptrdiff_t title_start
;
11023 ptrdiff_t count
= SPECPDL_INDEX ();
11025 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11027 Lisp_Object other_frame
= XCAR (tail
);
11028 struct frame
*tf
= XFRAME (other_frame
);
11031 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11032 && !FRAME_MINIBUF_ONLY_P (tf
)
11033 && !EQ (other_frame
, tip_frame
)
11034 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11038 /* Set global variable indicating that multiple frames exist. */
11039 multiple_frames
= CONSP (tail
);
11041 /* Switch to the buffer of selected window of the frame. Set up
11042 mode_line_target so that display_mode_element will output into
11043 mode_line_noprop_buf; then display the title. */
11044 record_unwind_protect (unwind_format_mode_line
,
11045 format_mode_line_unwind_data
11046 (f
, current_buffer
, selected_window
, 0));
11048 Fselect_window (f
->selected_window
, Qt
);
11049 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11050 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11052 mode_line_target
= MODE_LINE_TITLE
;
11053 title_start
= MODE_LINE_NOPROP_LEN (0);
11054 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11055 NULL
, DEFAULT_FACE_ID
);
11056 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11057 len
= MODE_LINE_NOPROP_LEN (title_start
);
11058 title
= mode_line_noprop_buf
+ title_start
;
11059 unbind_to (count
, Qnil
);
11061 /* Set the title only if it's changed. This avoids consing in
11062 the common case where it hasn't. (If it turns out that we've
11063 already wasted too much time by walking through the list with
11064 display_mode_element, then we might need to optimize at a
11065 higher level than this.) */
11066 if (! STRINGP (f
->name
)
11067 || SBYTES (f
->name
) != len
11068 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11069 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11073 #endif /* not HAVE_WINDOW_SYSTEM */
11076 /***********************************************************************
11078 ***********************************************************************/
11081 /* Prepare for redisplay by updating menu-bar item lists when
11082 appropriate. This can call eval. */
11085 prepare_menu_bars (void)
11088 struct gcpro gcpro1
, gcpro2
;
11090 Lisp_Object tooltip_frame
;
11092 #ifdef HAVE_WINDOW_SYSTEM
11093 tooltip_frame
= tip_frame
;
11095 tooltip_frame
= Qnil
;
11098 /* Update all frame titles based on their buffer names, etc. We do
11099 this before the menu bars so that the buffer-menu will show the
11100 up-to-date frame titles. */
11101 #ifdef HAVE_WINDOW_SYSTEM
11102 if (windows_or_buffers_changed
|| update_mode_lines
)
11104 Lisp_Object tail
, frame
;
11106 FOR_EACH_FRAME (tail
, frame
)
11108 f
= XFRAME (frame
);
11109 if (!EQ (frame
, tooltip_frame
)
11110 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11111 x_consider_frame_title (frame
);
11114 #endif /* HAVE_WINDOW_SYSTEM */
11116 /* Update the menu bar item lists, if appropriate. This has to be
11117 done before any actual redisplay or generation of display lines. */
11118 all_windows
= (update_mode_lines
11119 || buffer_shared
> 1
11120 || windows_or_buffers_changed
);
11123 Lisp_Object tail
, frame
;
11124 ptrdiff_t count
= SPECPDL_INDEX ();
11125 /* 1 means that update_menu_bar has run its hooks
11126 so any further calls to update_menu_bar shouldn't do so again. */
11127 int menu_bar_hooks_run
= 0;
11129 record_unwind_save_match_data ();
11131 FOR_EACH_FRAME (tail
, frame
)
11133 f
= XFRAME (frame
);
11135 /* Ignore tooltip frame. */
11136 if (EQ (frame
, tooltip_frame
))
11139 /* If a window on this frame changed size, report that to
11140 the user and clear the size-change flag. */
11141 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11143 Lisp_Object functions
;
11145 /* Clear flag first in case we get an error below. */
11146 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11147 functions
= Vwindow_size_change_functions
;
11148 GCPRO2 (tail
, functions
);
11150 while (CONSP (functions
))
11152 if (!EQ (XCAR (functions
), Qt
))
11153 call1 (XCAR (functions
), frame
);
11154 functions
= XCDR (functions
);
11160 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11161 #ifdef HAVE_WINDOW_SYSTEM
11162 update_tool_bar (f
, 0);
11165 if (windows_or_buffers_changed
11167 ns_set_doc_edited (f
, Fbuffer_modified_p
11168 (XWINDOW (f
->selected_window
)->buffer
));
11173 unbind_to (count
, Qnil
);
11177 struct frame
*sf
= SELECTED_FRAME ();
11178 update_menu_bar (sf
, 1, 0);
11179 #ifdef HAVE_WINDOW_SYSTEM
11180 update_tool_bar (sf
, 1);
11186 /* Update the menu bar item list for frame F. This has to be done
11187 before we start to fill in any display lines, because it can call
11190 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11192 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11193 already ran the menu bar hooks for this redisplay, so there
11194 is no need to run them again. The return value is the
11195 updated value of this flag, to pass to the next call. */
11198 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11200 Lisp_Object window
;
11201 register struct window
*w
;
11203 /* If called recursively during a menu update, do nothing. This can
11204 happen when, for instance, an activate-menubar-hook causes a
11206 if (inhibit_menubar_update
)
11209 window
= FRAME_SELECTED_WINDOW (f
);
11210 w
= XWINDOW (window
);
11212 if (FRAME_WINDOW_P (f
)
11214 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11215 || defined (HAVE_NS) || defined (USE_GTK)
11216 FRAME_EXTERNAL_MENU_BAR (f
)
11218 FRAME_MENU_BAR_LINES (f
) > 0
11220 : FRAME_MENU_BAR_LINES (f
) > 0)
11222 /* If the user has switched buffers or windows, we need to
11223 recompute to reflect the new bindings. But we'll
11224 recompute when update_mode_lines is set too; that means
11225 that people can use force-mode-line-update to request
11226 that the menu bar be recomputed. The adverse effect on
11227 the rest of the redisplay algorithm is about the same as
11228 windows_or_buffers_changed anyway. */
11229 if (windows_or_buffers_changed
11230 /* This used to test w->update_mode_line, but we believe
11231 there is no need to recompute the menu in that case. */
11232 || update_mode_lines
11233 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11234 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11235 != w
->last_had_star
)
11236 || ((!NILP (Vtransient_mark_mode
)
11237 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11238 != !NILP (w
->region_showing
)))
11240 struct buffer
*prev
= current_buffer
;
11241 ptrdiff_t count
= SPECPDL_INDEX ();
11243 specbind (Qinhibit_menubar_update
, Qt
);
11245 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11246 if (save_match_data
)
11247 record_unwind_save_match_data ();
11248 if (NILP (Voverriding_local_map_menu_flag
))
11250 specbind (Qoverriding_terminal_local_map
, Qnil
);
11251 specbind (Qoverriding_local_map
, Qnil
);
11256 /* Run the Lucid hook. */
11257 safe_run_hooks (Qactivate_menubar_hook
);
11259 /* If it has changed current-menubar from previous value,
11260 really recompute the menu-bar from the value. */
11261 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11262 call0 (Qrecompute_lucid_menubar
);
11264 safe_run_hooks (Qmenu_bar_update_hook
);
11269 XSETFRAME (Vmenu_updating_frame
, f
);
11270 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11272 /* Redisplay the menu bar in case we changed it. */
11273 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11274 || defined (HAVE_NS) || defined (USE_GTK)
11275 if (FRAME_WINDOW_P (f
))
11277 #if defined (HAVE_NS)
11278 /* All frames on Mac OS share the same menubar. So only
11279 the selected frame should be allowed to set it. */
11280 if (f
== SELECTED_FRAME ())
11282 set_frame_menubar (f
, 0, 0);
11285 /* On a terminal screen, the menu bar is an ordinary screen
11286 line, and this makes it get updated. */
11287 w
->update_mode_line
= 1;
11288 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11289 /* In the non-toolkit version, the menu bar is an ordinary screen
11290 line, and this makes it get updated. */
11291 w
->update_mode_line
= 1;
11292 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11294 unbind_to (count
, Qnil
);
11295 set_buffer_internal_1 (prev
);
11304 /***********************************************************************
11306 ***********************************************************************/
11308 #ifdef HAVE_WINDOW_SYSTEM
11311 Nominal cursor position -- where to draw output.
11312 HPOS and VPOS are window relative glyph matrix coordinates.
11313 X and Y are window relative pixel coordinates. */
11315 struct cursor_pos output_cursor
;
11319 Set the global variable output_cursor to CURSOR. All cursor
11320 positions are relative to updated_window. */
11323 set_output_cursor (struct cursor_pos
*cursor
)
11325 output_cursor
.hpos
= cursor
->hpos
;
11326 output_cursor
.vpos
= cursor
->vpos
;
11327 output_cursor
.x
= cursor
->x
;
11328 output_cursor
.y
= cursor
->y
;
11333 Set a nominal cursor position.
11335 HPOS and VPOS are column/row positions in a window glyph matrix. X
11336 and Y are window text area relative pixel positions.
11338 If this is done during an update, updated_window will contain the
11339 window that is being updated and the position is the future output
11340 cursor position for that window. If updated_window is null, use
11341 selected_window and display the cursor at the given position. */
11344 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11348 /* If updated_window is not set, work on selected_window. */
11349 if (updated_window
)
11350 w
= updated_window
;
11352 w
= XWINDOW (selected_window
);
11354 /* Set the output cursor. */
11355 output_cursor
.hpos
= hpos
;
11356 output_cursor
.vpos
= vpos
;
11357 output_cursor
.x
= x
;
11358 output_cursor
.y
= y
;
11360 /* If not called as part of an update, really display the cursor.
11361 This will also set the cursor position of W. */
11362 if (updated_window
== NULL
)
11365 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11366 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11367 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11372 #endif /* HAVE_WINDOW_SYSTEM */
11375 /***********************************************************************
11377 ***********************************************************************/
11379 #ifdef HAVE_WINDOW_SYSTEM
11381 /* Where the mouse was last time we reported a mouse event. */
11383 FRAME_PTR last_mouse_frame
;
11385 /* Tool-bar item index of the item on which a mouse button was pressed
11388 int last_tool_bar_item
;
11392 update_tool_bar_unwind (Lisp_Object frame
)
11394 selected_frame
= frame
;
11398 /* Update the tool-bar item list for frame F. This has to be done
11399 before we start to fill in any display lines. Called from
11400 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11401 and restore it here. */
11404 update_tool_bar (struct frame
*f
, int save_match_data
)
11406 #if defined (USE_GTK) || defined (HAVE_NS)
11407 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11409 int do_update
= WINDOWP (f
->tool_bar_window
)
11410 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11415 Lisp_Object window
;
11418 window
= FRAME_SELECTED_WINDOW (f
);
11419 w
= XWINDOW (window
);
11421 /* If the user has switched buffers or windows, we need to
11422 recompute to reflect the new bindings. But we'll
11423 recompute when update_mode_lines is set too; that means
11424 that people can use force-mode-line-update to request
11425 that the menu bar be recomputed. The adverse effect on
11426 the rest of the redisplay algorithm is about the same as
11427 windows_or_buffers_changed anyway. */
11428 if (windows_or_buffers_changed
11429 || w
->update_mode_line
11430 || update_mode_lines
11431 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11432 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11433 != w
->last_had_star
)
11434 || ((!NILP (Vtransient_mark_mode
)
11435 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11436 != !NILP (w
->region_showing
)))
11438 struct buffer
*prev
= current_buffer
;
11439 ptrdiff_t count
= SPECPDL_INDEX ();
11440 Lisp_Object frame
, new_tool_bar
;
11441 int new_n_tool_bar
;
11442 struct gcpro gcpro1
;
11444 /* Set current_buffer to the buffer of the selected
11445 window of the frame, so that we get the right local
11447 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11449 /* Save match data, if we must. */
11450 if (save_match_data
)
11451 record_unwind_save_match_data ();
11453 /* Make sure that we don't accidentally use bogus keymaps. */
11454 if (NILP (Voverriding_local_map_menu_flag
))
11456 specbind (Qoverriding_terminal_local_map
, Qnil
);
11457 specbind (Qoverriding_local_map
, Qnil
);
11460 GCPRO1 (new_tool_bar
);
11462 /* We must temporarily set the selected frame to this frame
11463 before calling tool_bar_items, because the calculation of
11464 the tool-bar keymap uses the selected frame (see
11465 `tool-bar-make-keymap' in tool-bar.el). */
11466 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11467 XSETFRAME (frame
, f
);
11468 selected_frame
= frame
;
11470 /* Build desired tool-bar items from keymaps. */
11471 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11474 /* Redisplay the tool-bar if we changed it. */
11475 if (new_n_tool_bar
!= f
->n_tool_bar_items
11476 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11478 /* Redisplay that happens asynchronously due to an expose event
11479 may access f->tool_bar_items. Make sure we update both
11480 variables within BLOCK_INPUT so no such event interrupts. */
11482 f
->tool_bar_items
= new_tool_bar
;
11483 f
->n_tool_bar_items
= new_n_tool_bar
;
11484 w
->update_mode_line
= 1;
11490 unbind_to (count
, Qnil
);
11491 set_buffer_internal_1 (prev
);
11497 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11498 F's desired tool-bar contents. F->tool_bar_items must have
11499 been set up previously by calling prepare_menu_bars. */
11502 build_desired_tool_bar_string (struct frame
*f
)
11504 int i
, size
, size_needed
;
11505 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11506 Lisp_Object image
, plist
, props
;
11508 image
= plist
= props
= Qnil
;
11509 GCPRO3 (image
, plist
, props
);
11511 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11512 Otherwise, make a new string. */
11514 /* The size of the string we might be able to reuse. */
11515 size
= (STRINGP (f
->desired_tool_bar_string
)
11516 ? SCHARS (f
->desired_tool_bar_string
)
11519 /* We need one space in the string for each image. */
11520 size_needed
= f
->n_tool_bar_items
;
11522 /* Reuse f->desired_tool_bar_string, if possible. */
11523 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11524 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11525 make_number (' '));
11528 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11529 Fremove_text_properties (make_number (0), make_number (size
),
11530 props
, f
->desired_tool_bar_string
);
11533 /* Put a `display' property on the string for the images to display,
11534 put a `menu_item' property on tool-bar items with a value that
11535 is the index of the item in F's tool-bar item vector. */
11536 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11538 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11540 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11541 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11542 int hmargin
, vmargin
, relief
, idx
, end
;
11544 /* If image is a vector, choose the image according to the
11546 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11547 if (VECTORP (image
))
11551 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11552 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11555 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11556 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11558 eassert (ASIZE (image
) >= idx
);
11559 image
= AREF (image
, idx
);
11564 /* Ignore invalid image specifications. */
11565 if (!valid_image_p (image
))
11568 /* Display the tool-bar button pressed, or depressed. */
11569 plist
= Fcopy_sequence (XCDR (image
));
11571 /* Compute margin and relief to draw. */
11572 relief
= (tool_bar_button_relief
>= 0
11573 ? tool_bar_button_relief
11574 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11575 hmargin
= vmargin
= relief
;
11577 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11578 INT_MAX
- max (hmargin
, vmargin
)))
11580 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11581 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11583 else if (CONSP (Vtool_bar_button_margin
))
11585 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11586 INT_MAX
- hmargin
))
11587 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11589 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11590 INT_MAX
- vmargin
))
11591 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11594 if (auto_raise_tool_bar_buttons_p
)
11596 /* Add a `:relief' property to the image spec if the item is
11600 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11607 /* If image is selected, display it pressed, i.e. with a
11608 negative relief. If it's not selected, display it with a
11610 plist
= Fplist_put (plist
, QCrelief
,
11612 ? make_number (-relief
)
11613 : make_number (relief
)));
11618 /* Put a margin around the image. */
11619 if (hmargin
|| vmargin
)
11621 if (hmargin
== vmargin
)
11622 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11624 plist
= Fplist_put (plist
, QCmargin
,
11625 Fcons (make_number (hmargin
),
11626 make_number (vmargin
)));
11629 /* If button is not enabled, and we don't have special images
11630 for the disabled state, make the image appear disabled by
11631 applying an appropriate algorithm to it. */
11632 if (!enabled_p
&& idx
< 0)
11633 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11635 /* Put a `display' text property on the string for the image to
11636 display. Put a `menu-item' property on the string that gives
11637 the start of this item's properties in the tool-bar items
11639 image
= Fcons (Qimage
, plist
);
11640 props
= list4 (Qdisplay
, image
,
11641 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11643 /* Let the last image hide all remaining spaces in the tool bar
11644 string. The string can be longer than needed when we reuse a
11645 previous string. */
11646 if (i
+ 1 == f
->n_tool_bar_items
)
11647 end
= SCHARS (f
->desired_tool_bar_string
);
11650 Fadd_text_properties (make_number (i
), make_number (end
),
11651 props
, f
->desired_tool_bar_string
);
11659 /* Display one line of the tool-bar of frame IT->f.
11661 HEIGHT specifies the desired height of the tool-bar line.
11662 If the actual height of the glyph row is less than HEIGHT, the
11663 row's height is increased to HEIGHT, and the icons are centered
11664 vertically in the new height.
11666 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11667 count a final empty row in case the tool-bar width exactly matches
11672 display_tool_bar_line (struct it
*it
, int height
)
11674 struct glyph_row
*row
= it
->glyph_row
;
11675 int max_x
= it
->last_visible_x
;
11676 struct glyph
*last
;
11678 prepare_desired_row (row
);
11679 row
->y
= it
->current_y
;
11681 /* Note that this isn't made use of if the face hasn't a box,
11682 so there's no need to check the face here. */
11683 it
->start_of_box_run_p
= 1;
11685 while (it
->current_x
< max_x
)
11687 int x
, n_glyphs_before
, i
, nglyphs
;
11688 struct it it_before
;
11690 /* Get the next display element. */
11691 if (!get_next_display_element (it
))
11693 /* Don't count empty row if we are counting needed tool-bar lines. */
11694 if (height
< 0 && !it
->hpos
)
11699 /* Produce glyphs. */
11700 n_glyphs_before
= row
->used
[TEXT_AREA
];
11703 PRODUCE_GLYPHS (it
);
11705 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11707 x
= it_before
.current_x
;
11708 while (i
< nglyphs
)
11710 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11712 if (x
+ glyph
->pixel_width
> max_x
)
11714 /* Glyph doesn't fit on line. Backtrack. */
11715 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11717 /* If this is the only glyph on this line, it will never fit on the
11718 tool-bar, so skip it. But ensure there is at least one glyph,
11719 so we don't accidentally disable the tool-bar. */
11720 if (n_glyphs_before
== 0
11721 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11727 x
+= glyph
->pixel_width
;
11731 /* Stop at line end. */
11732 if (ITERATOR_AT_END_OF_LINE_P (it
))
11735 set_iterator_to_next (it
, 1);
11740 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11742 /* Use default face for the border below the tool bar.
11744 FIXME: When auto-resize-tool-bars is grow-only, there is
11745 no additional border below the possibly empty tool-bar lines.
11746 So to make the extra empty lines look "normal", we have to
11747 use the tool-bar face for the border too. */
11748 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11749 it
->face_id
= DEFAULT_FACE_ID
;
11751 extend_face_to_end_of_line (it
);
11752 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11753 last
->right_box_line_p
= 1;
11754 if (last
== row
->glyphs
[TEXT_AREA
])
11755 last
->left_box_line_p
= 1;
11757 /* Make line the desired height and center it vertically. */
11758 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11760 /* Don't add more than one line height. */
11761 height
%= FRAME_LINE_HEIGHT (it
->f
);
11762 it
->max_ascent
+= height
/ 2;
11763 it
->max_descent
+= (height
+ 1) / 2;
11766 compute_line_metrics (it
);
11768 /* If line is empty, make it occupy the rest of the tool-bar. */
11769 if (!row
->displays_text_p
)
11771 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11772 row
->visible_height
= row
->height
;
11773 row
->ascent
= row
->phys_ascent
= 0;
11774 row
->extra_line_spacing
= 0;
11777 row
->full_width_p
= 1;
11778 row
->continued_p
= 0;
11779 row
->truncated_on_left_p
= 0;
11780 row
->truncated_on_right_p
= 0;
11782 it
->current_x
= it
->hpos
= 0;
11783 it
->current_y
+= row
->height
;
11789 /* Max tool-bar height. */
11791 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11792 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11794 /* Value is the number of screen lines needed to make all tool-bar
11795 items of frame F visible. The number of actual rows needed is
11796 returned in *N_ROWS if non-NULL. */
11799 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11801 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11803 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11804 the desired matrix, so use (unused) mode-line row as temporary row to
11805 avoid destroying the first tool-bar row. */
11806 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11808 /* Initialize an iterator for iteration over
11809 F->desired_tool_bar_string in the tool-bar window of frame F. */
11810 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11811 it
.first_visible_x
= 0;
11812 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11813 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11814 it
.paragraph_embedding
= L2R
;
11816 while (!ITERATOR_AT_END_P (&it
))
11818 clear_glyph_row (temp_row
);
11819 it
.glyph_row
= temp_row
;
11820 display_tool_bar_line (&it
, -1);
11822 clear_glyph_row (temp_row
);
11824 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11826 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11828 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11832 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11834 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11835 (Lisp_Object frame
)
11842 frame
= selected_frame
;
11844 CHECK_FRAME (frame
);
11845 f
= XFRAME (frame
);
11847 if (WINDOWP (f
->tool_bar_window
)
11848 && (w
= XWINDOW (f
->tool_bar_window
),
11849 WINDOW_TOTAL_LINES (w
) > 0))
11851 update_tool_bar (f
, 1);
11852 if (f
->n_tool_bar_items
)
11854 build_desired_tool_bar_string (f
);
11855 nlines
= tool_bar_lines_needed (f
, NULL
);
11859 return make_number (nlines
);
11863 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11864 height should be changed. */
11867 redisplay_tool_bar (struct frame
*f
)
11871 struct glyph_row
*row
;
11873 #if defined (USE_GTK) || defined (HAVE_NS)
11874 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11875 update_frame_tool_bar (f
);
11879 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11880 do anything. This means you must start with tool-bar-lines
11881 non-zero to get the auto-sizing effect. Or in other words, you
11882 can turn off tool-bars by specifying tool-bar-lines zero. */
11883 if (!WINDOWP (f
->tool_bar_window
)
11884 || (w
= XWINDOW (f
->tool_bar_window
),
11885 WINDOW_TOTAL_LINES (w
) == 0))
11888 /* Set up an iterator for the tool-bar window. */
11889 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11890 it
.first_visible_x
= 0;
11891 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11892 row
= it
.glyph_row
;
11894 /* Build a string that represents the contents of the tool-bar. */
11895 build_desired_tool_bar_string (f
);
11896 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11897 /* FIXME: This should be controlled by a user option. But it
11898 doesn't make sense to have an R2L tool bar if the menu bar cannot
11899 be drawn also R2L, and making the menu bar R2L is tricky due
11900 toolkit-specific code that implements it. If an R2L tool bar is
11901 ever supported, display_tool_bar_line should also be augmented to
11902 call unproduce_glyphs like display_line and display_string
11904 it
.paragraph_embedding
= L2R
;
11906 if (f
->n_tool_bar_rows
== 0)
11910 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11911 nlines
!= WINDOW_TOTAL_LINES (w
)))
11914 int old_height
= WINDOW_TOTAL_LINES (w
);
11916 XSETFRAME (frame
, f
);
11917 Fmodify_frame_parameters (frame
,
11918 Fcons (Fcons (Qtool_bar_lines
,
11919 make_number (nlines
)),
11921 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11923 clear_glyph_matrix (w
->desired_matrix
);
11924 fonts_changed_p
= 1;
11930 /* Display as many lines as needed to display all tool-bar items. */
11932 if (f
->n_tool_bar_rows
> 0)
11934 int border
, rows
, height
, extra
;
11936 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11937 border
= XINT (Vtool_bar_border
);
11938 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11939 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11940 else if (EQ (Vtool_bar_border
, Qborder_width
))
11941 border
= f
->border_width
;
11947 rows
= f
->n_tool_bar_rows
;
11948 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11949 extra
= it
.last_visible_y
- border
- height
* rows
;
11951 while (it
.current_y
< it
.last_visible_y
)
11954 if (extra
> 0 && rows
-- > 0)
11956 h
= (extra
+ rows
- 1) / rows
;
11959 display_tool_bar_line (&it
, height
+ h
);
11964 while (it
.current_y
< it
.last_visible_y
)
11965 display_tool_bar_line (&it
, 0);
11968 /* It doesn't make much sense to try scrolling in the tool-bar
11969 window, so don't do it. */
11970 w
->desired_matrix
->no_scrolling_p
= 1;
11971 w
->must_be_updated_p
= 1;
11973 if (!NILP (Vauto_resize_tool_bars
))
11975 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11976 int change_height_p
= 0;
11978 /* If we couldn't display everything, change the tool-bar's
11979 height if there is room for more. */
11980 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11981 && it
.current_y
< max_tool_bar_height
)
11982 change_height_p
= 1;
11984 row
= it
.glyph_row
- 1;
11986 /* If there are blank lines at the end, except for a partially
11987 visible blank line at the end that is smaller than
11988 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11989 if (!row
->displays_text_p
11990 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11991 change_height_p
= 1;
11993 /* If row displays tool-bar items, but is partially visible,
11994 change the tool-bar's height. */
11995 if (row
->displays_text_p
11996 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11997 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11998 change_height_p
= 1;
12000 /* Resize windows as needed by changing the `tool-bar-lines'
12001 frame parameter. */
12002 if (change_height_p
)
12005 int old_height
= WINDOW_TOTAL_LINES (w
);
12007 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12009 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12010 && !f
->minimize_tool_bar_window_p
)
12011 ? (nlines
> old_height
)
12012 : (nlines
!= old_height
));
12013 f
->minimize_tool_bar_window_p
= 0;
12015 if (change_height_p
)
12017 XSETFRAME (frame
, f
);
12018 Fmodify_frame_parameters (frame
,
12019 Fcons (Fcons (Qtool_bar_lines
,
12020 make_number (nlines
)),
12022 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12024 clear_glyph_matrix (w
->desired_matrix
);
12025 f
->n_tool_bar_rows
= nrows
;
12026 fonts_changed_p
= 1;
12033 f
->minimize_tool_bar_window_p
= 0;
12038 /* Get information about the tool-bar item which is displayed in GLYPH
12039 on frame F. Return in *PROP_IDX the index where tool-bar item
12040 properties start in F->tool_bar_items. Value is zero if
12041 GLYPH doesn't display a tool-bar item. */
12044 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12050 /* This function can be called asynchronously, which means we must
12051 exclude any possibility that Fget_text_property signals an
12053 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12054 charpos
= max (0, charpos
);
12056 /* Get the text property `menu-item' at pos. The value of that
12057 property is the start index of this item's properties in
12058 F->tool_bar_items. */
12059 prop
= Fget_text_property (make_number (charpos
),
12060 Qmenu_item
, f
->current_tool_bar_string
);
12061 if (INTEGERP (prop
))
12063 *prop_idx
= XINT (prop
);
12073 /* Get information about the tool-bar item at position X/Y on frame F.
12074 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12075 the current matrix of the tool-bar window of F, or NULL if not
12076 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12077 item in F->tool_bar_items. Value is
12079 -1 if X/Y is not on a tool-bar item
12080 0 if X/Y is on the same item that was highlighted before.
12084 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12085 int *hpos
, int *vpos
, int *prop_idx
)
12087 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12088 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12091 /* Find the glyph under X/Y. */
12092 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12093 if (*glyph
== NULL
)
12096 /* Get the start of this tool-bar item's properties in
12097 f->tool_bar_items. */
12098 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12101 /* Is mouse on the highlighted item? */
12102 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12103 && *vpos
>= hlinfo
->mouse_face_beg_row
12104 && *vpos
<= hlinfo
->mouse_face_end_row
12105 && (*vpos
> hlinfo
->mouse_face_beg_row
12106 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12107 && (*vpos
< hlinfo
->mouse_face_end_row
12108 || *hpos
< hlinfo
->mouse_face_end_col
12109 || hlinfo
->mouse_face_past_end
))
12117 Handle mouse button event on the tool-bar of frame F, at
12118 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12119 0 for button release. MODIFIERS is event modifiers for button
12123 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12126 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12127 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12128 int hpos
, vpos
, prop_idx
;
12129 struct glyph
*glyph
;
12130 Lisp_Object enabled_p
;
12132 /* If not on the highlighted tool-bar item, return. */
12133 frame_to_window_pixel_xy (w
, &x
, &y
);
12134 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12137 /* If item is disabled, do nothing. */
12138 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12139 if (NILP (enabled_p
))
12144 /* Show item in pressed state. */
12145 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12146 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12147 last_tool_bar_item
= prop_idx
;
12151 Lisp_Object key
, frame
;
12152 struct input_event event
;
12153 EVENT_INIT (event
);
12155 /* Show item in released state. */
12156 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12157 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12159 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12161 XSETFRAME (frame
, f
);
12162 event
.kind
= TOOL_BAR_EVENT
;
12163 event
.frame_or_window
= frame
;
12165 kbd_buffer_store_event (&event
);
12167 event
.kind
= TOOL_BAR_EVENT
;
12168 event
.frame_or_window
= frame
;
12170 event
.modifiers
= modifiers
;
12171 kbd_buffer_store_event (&event
);
12172 last_tool_bar_item
= -1;
12177 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12178 tool-bar window-relative coordinates X/Y. Called from
12179 note_mouse_highlight. */
12182 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12184 Lisp_Object window
= f
->tool_bar_window
;
12185 struct window
*w
= XWINDOW (window
);
12186 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12187 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12189 struct glyph
*glyph
;
12190 struct glyph_row
*row
;
12192 Lisp_Object enabled_p
;
12194 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12195 int mouse_down_p
, rc
;
12197 /* Function note_mouse_highlight is called with negative X/Y
12198 values when mouse moves outside of the frame. */
12199 if (x
<= 0 || y
<= 0)
12201 clear_mouse_face (hlinfo
);
12205 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12208 /* Not on tool-bar item. */
12209 clear_mouse_face (hlinfo
);
12213 /* On same tool-bar item as before. */
12214 goto set_help_echo
;
12216 clear_mouse_face (hlinfo
);
12218 /* Mouse is down, but on different tool-bar item? */
12219 mouse_down_p
= (dpyinfo
->grabbed
12220 && f
== last_mouse_frame
12221 && FRAME_LIVE_P (f
));
12223 && last_tool_bar_item
!= prop_idx
)
12226 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12227 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12229 /* If tool-bar item is not enabled, don't highlight it. */
12230 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12231 if (!NILP (enabled_p
))
12233 /* Compute the x-position of the glyph. In front and past the
12234 image is a space. We include this in the highlighted area. */
12235 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12236 for (i
= x
= 0; i
< hpos
; ++i
)
12237 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12239 /* Record this as the current active region. */
12240 hlinfo
->mouse_face_beg_col
= hpos
;
12241 hlinfo
->mouse_face_beg_row
= vpos
;
12242 hlinfo
->mouse_face_beg_x
= x
;
12243 hlinfo
->mouse_face_beg_y
= row
->y
;
12244 hlinfo
->mouse_face_past_end
= 0;
12246 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12247 hlinfo
->mouse_face_end_row
= vpos
;
12248 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12249 hlinfo
->mouse_face_end_y
= row
->y
;
12250 hlinfo
->mouse_face_window
= window
;
12251 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12253 /* Display it as active. */
12254 show_mouse_face (hlinfo
, draw
);
12255 hlinfo
->mouse_face_image_state
= draw
;
12260 /* Set help_echo_string to a help string to display for this tool-bar item.
12261 XTread_socket does the rest. */
12262 help_echo_object
= help_echo_window
= Qnil
;
12263 help_echo_pos
= -1;
12264 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12265 if (NILP (help_echo_string
))
12266 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12269 #endif /* HAVE_WINDOW_SYSTEM */
12273 /************************************************************************
12274 Horizontal scrolling
12275 ************************************************************************/
12277 static int hscroll_window_tree (Lisp_Object
);
12278 static int hscroll_windows (Lisp_Object
);
12280 /* For all leaf windows in the window tree rooted at WINDOW, set their
12281 hscroll value so that PT is (i) visible in the window, and (ii) so
12282 that it is not within a certain margin at the window's left and
12283 right border. Value is non-zero if any window's hscroll has been
12287 hscroll_window_tree (Lisp_Object window
)
12289 int hscrolled_p
= 0;
12290 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12291 int hscroll_step_abs
= 0;
12292 double hscroll_step_rel
= 0;
12294 if (hscroll_relative_p
)
12296 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12297 if (hscroll_step_rel
< 0)
12299 hscroll_relative_p
= 0;
12300 hscroll_step_abs
= 0;
12303 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12305 hscroll_step_abs
= XINT (Vhscroll_step
);
12306 if (hscroll_step_abs
< 0)
12307 hscroll_step_abs
= 0;
12310 hscroll_step_abs
= 0;
12312 while (WINDOWP (window
))
12314 struct window
*w
= XWINDOW (window
);
12316 if (WINDOWP (w
->hchild
))
12317 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12318 else if (WINDOWP (w
->vchild
))
12319 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12320 else if (w
->cursor
.vpos
>= 0)
12323 int text_area_width
;
12324 struct glyph_row
*current_cursor_row
12325 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12326 struct glyph_row
*desired_cursor_row
12327 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12328 struct glyph_row
*cursor_row
12329 = (desired_cursor_row
->enabled_p
12330 ? desired_cursor_row
12331 : current_cursor_row
);
12332 int row_r2l_p
= cursor_row
->reversed_p
;
12334 text_area_width
= window_box_width (w
, TEXT_AREA
);
12336 /* Scroll when cursor is inside this scroll margin. */
12337 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12339 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12340 /* For left-to-right rows, hscroll when cursor is either
12341 (i) inside the right hscroll margin, or (ii) if it is
12342 inside the left margin and the window is already
12346 && w
->cursor
.x
<= h_margin
)
12347 || (cursor_row
->enabled_p
12348 && cursor_row
->truncated_on_right_p
12349 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12350 /* For right-to-left rows, the logic is similar,
12351 except that rules for scrolling to left and right
12352 are reversed. E.g., if cursor.x <= h_margin, we
12353 need to hscroll "to the right" unconditionally,
12354 and that will scroll the screen to the left so as
12355 to reveal the next portion of the row. */
12357 && ((cursor_row
->enabled_p
12358 /* FIXME: It is confusing to set the
12359 truncated_on_right_p flag when R2L rows
12360 are actually truncated on the left. */
12361 && cursor_row
->truncated_on_right_p
12362 && w
->cursor
.x
<= h_margin
)
12364 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12368 struct buffer
*saved_current_buffer
;
12372 /* Find point in a display of infinite width. */
12373 saved_current_buffer
= current_buffer
;
12374 current_buffer
= XBUFFER (w
->buffer
);
12376 if (w
== XWINDOW (selected_window
))
12380 pt
= marker_position (w
->pointm
);
12381 pt
= max (BEGV
, pt
);
12385 /* Move iterator to pt starting at cursor_row->start in
12386 a line with infinite width. */
12387 init_to_row_start (&it
, w
, cursor_row
);
12388 it
.last_visible_x
= INFINITY
;
12389 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12390 current_buffer
= saved_current_buffer
;
12392 /* Position cursor in window. */
12393 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12394 hscroll
= max (0, (it
.current_x
12395 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12396 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12397 : (text_area_width
/ 2))))
12398 / FRAME_COLUMN_WIDTH (it
.f
);
12399 else if ((!row_r2l_p
12400 && w
->cursor
.x
>= text_area_width
- h_margin
)
12401 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12403 if (hscroll_relative_p
)
12404 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12407 wanted_x
= text_area_width
12408 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12411 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12415 if (hscroll_relative_p
)
12416 wanted_x
= text_area_width
* hscroll_step_rel
12419 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12422 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12424 hscroll
= max (hscroll
, w
->min_hscroll
);
12426 /* Don't prevent redisplay optimizations if hscroll
12427 hasn't changed, as it will unnecessarily slow down
12429 if (w
->hscroll
!= hscroll
)
12431 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12432 w
->hscroll
= hscroll
;
12441 /* Value is non-zero if hscroll of any leaf window has been changed. */
12442 return hscrolled_p
;
12446 /* Set hscroll so that cursor is visible and not inside horizontal
12447 scroll margins for all windows in the tree rooted at WINDOW. See
12448 also hscroll_window_tree above. Value is non-zero if any window's
12449 hscroll has been changed. If it has, desired matrices on the frame
12450 of WINDOW are cleared. */
12453 hscroll_windows (Lisp_Object window
)
12455 int hscrolled_p
= hscroll_window_tree (window
);
12457 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12458 return hscrolled_p
;
12463 /************************************************************************
12465 ************************************************************************/
12467 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12468 to a non-zero value. This is sometimes handy to have in a debugger
12473 /* First and last unchanged row for try_window_id. */
12475 static int debug_first_unchanged_at_end_vpos
;
12476 static int debug_last_unchanged_at_beg_vpos
;
12478 /* Delta vpos and y. */
12480 static int debug_dvpos
, debug_dy
;
12482 /* Delta in characters and bytes for try_window_id. */
12484 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12486 /* Values of window_end_pos and window_end_vpos at the end of
12489 static ptrdiff_t debug_end_vpos
;
12491 /* Append a string to W->desired_matrix->method. FMT is a printf
12492 format string. If trace_redisplay_p is non-zero also printf the
12493 resulting string to stderr. */
12495 static void debug_method_add (struct window
*, char const *, ...)
12496 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12499 debug_method_add (struct window
*w
, char const *fmt
, ...)
12501 char *method
= w
->desired_matrix
->method
;
12502 int len
= strlen (method
);
12503 int size
= sizeof w
->desired_matrix
->method
;
12504 int remaining
= size
- len
- 1;
12507 if (len
&& remaining
)
12510 --remaining
, ++len
;
12513 va_start (ap
, fmt
);
12514 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12517 if (trace_redisplay_p
)
12518 fprintf (stderr
, "%p (%s): %s\n",
12520 ((BUFFERP (w
->buffer
)
12521 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12522 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12527 #endif /* GLYPH_DEBUG */
12530 /* Value is non-zero if all changes in window W, which displays
12531 current_buffer, are in the text between START and END. START is a
12532 buffer position, END is given as a distance from Z. Used in
12533 redisplay_internal for display optimization. */
12536 text_outside_line_unchanged_p (struct window
*w
,
12537 ptrdiff_t start
, ptrdiff_t end
)
12539 int unchanged_p
= 1;
12541 /* If text or overlays have changed, see where. */
12542 if (w
->last_modified
< MODIFF
12543 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12545 /* Gap in the line? */
12546 if (GPT
< start
|| Z
- GPT
< end
)
12549 /* Changes start in front of the line, or end after it? */
12551 && (BEG_UNCHANGED
< start
- 1
12552 || END_UNCHANGED
< end
))
12555 /* If selective display, can't optimize if changes start at the
12556 beginning of the line. */
12558 && INTEGERP (BVAR (current_buffer
, selective_display
))
12559 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12560 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12563 /* If there are overlays at the start or end of the line, these
12564 may have overlay strings with newlines in them. A change at
12565 START, for instance, may actually concern the display of such
12566 overlay strings as well, and they are displayed on different
12567 lines. So, quickly rule out this case. (For the future, it
12568 might be desirable to implement something more telling than
12569 just BEG/END_UNCHANGED.) */
12572 if (BEG
+ BEG_UNCHANGED
== start
12573 && overlay_touches_p (start
))
12575 if (END_UNCHANGED
== end
12576 && overlay_touches_p (Z
- end
))
12580 /* Under bidi reordering, adding or deleting a character in the
12581 beginning of a paragraph, before the first strong directional
12582 character, can change the base direction of the paragraph (unless
12583 the buffer specifies a fixed paragraph direction), which will
12584 require to redisplay the whole paragraph. It might be worthwhile
12585 to find the paragraph limits and widen the range of redisplayed
12586 lines to that, but for now just give up this optimization. */
12587 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12588 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12592 return unchanged_p
;
12596 /* Do a frame update, taking possible shortcuts into account. This is
12597 the main external entry point for redisplay.
12599 If the last redisplay displayed an echo area message and that message
12600 is no longer requested, we clear the echo area or bring back the
12601 mini-buffer if that is in use. */
12606 redisplay_internal ();
12611 overlay_arrow_string_or_property (Lisp_Object var
)
12615 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12618 return Voverlay_arrow_string
;
12621 /* Return 1 if there are any overlay-arrows in current_buffer. */
12623 overlay_arrow_in_current_buffer_p (void)
12627 for (vlist
= Voverlay_arrow_variable_list
;
12629 vlist
= XCDR (vlist
))
12631 Lisp_Object var
= XCAR (vlist
);
12634 if (!SYMBOLP (var
))
12636 val
= find_symbol_value (var
);
12638 && current_buffer
== XMARKER (val
)->buffer
)
12645 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12649 overlay_arrows_changed_p (void)
12653 for (vlist
= Voverlay_arrow_variable_list
;
12655 vlist
= XCDR (vlist
))
12657 Lisp_Object var
= XCAR (vlist
);
12658 Lisp_Object val
, pstr
;
12660 if (!SYMBOLP (var
))
12662 val
= find_symbol_value (var
);
12663 if (!MARKERP (val
))
12665 if (! EQ (COERCE_MARKER (val
),
12666 Fget (var
, Qlast_arrow_position
))
12667 || ! (pstr
= overlay_arrow_string_or_property (var
),
12668 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12674 /* Mark overlay arrows to be updated on next redisplay. */
12677 update_overlay_arrows (int up_to_date
)
12681 for (vlist
= Voverlay_arrow_variable_list
;
12683 vlist
= XCDR (vlist
))
12685 Lisp_Object var
= XCAR (vlist
);
12687 if (!SYMBOLP (var
))
12690 if (up_to_date
> 0)
12692 Lisp_Object val
= find_symbol_value (var
);
12693 Fput (var
, Qlast_arrow_position
,
12694 COERCE_MARKER (val
));
12695 Fput (var
, Qlast_arrow_string
,
12696 overlay_arrow_string_or_property (var
));
12698 else if (up_to_date
< 0
12699 || !NILP (Fget (var
, Qlast_arrow_position
)))
12701 Fput (var
, Qlast_arrow_position
, Qt
);
12702 Fput (var
, Qlast_arrow_string
, Qt
);
12708 /* Return overlay arrow string to display at row.
12709 Return integer (bitmap number) for arrow bitmap in left fringe.
12710 Return nil if no overlay arrow. */
12713 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12717 for (vlist
= Voverlay_arrow_variable_list
;
12719 vlist
= XCDR (vlist
))
12721 Lisp_Object var
= XCAR (vlist
);
12724 if (!SYMBOLP (var
))
12727 val
= find_symbol_value (var
);
12730 && current_buffer
== XMARKER (val
)->buffer
12731 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12733 if (FRAME_WINDOW_P (it
->f
)
12734 /* FIXME: if ROW->reversed_p is set, this should test
12735 the right fringe, not the left one. */
12736 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12738 #ifdef HAVE_WINDOW_SYSTEM
12739 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12742 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12743 return make_number (fringe_bitmap
);
12746 return make_number (-1); /* Use default arrow bitmap */
12748 return overlay_arrow_string_or_property (var
);
12755 /* Return 1 if point moved out of or into a composition. Otherwise
12756 return 0. PREV_BUF and PREV_PT are the last point buffer and
12757 position. BUF and PT are the current point buffer and position. */
12760 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12761 struct buffer
*buf
, ptrdiff_t pt
)
12763 ptrdiff_t start
, end
;
12765 Lisp_Object buffer
;
12767 XSETBUFFER (buffer
, buf
);
12768 /* Check a composition at the last point if point moved within the
12770 if (prev_buf
== buf
)
12773 /* Point didn't move. */
12776 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12777 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12778 && COMPOSITION_VALID_P (start
, end
, prop
)
12779 && start
< prev_pt
&& end
> prev_pt
)
12780 /* The last point was within the composition. Return 1 iff
12781 point moved out of the composition. */
12782 return (pt
<= start
|| pt
>= end
);
12785 /* Check a composition at the current point. */
12786 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12787 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12788 && COMPOSITION_VALID_P (start
, end
, prop
)
12789 && start
< pt
&& end
> pt
);
12793 /* Reconsider the setting of B->clip_changed which is displayed
12797 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12799 if (b
->clip_changed
12800 && !NILP (w
->window_end_valid
)
12801 && w
->current_matrix
->buffer
== b
12802 && w
->current_matrix
->zv
== BUF_ZV (b
)
12803 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12804 b
->clip_changed
= 0;
12806 /* If display wasn't paused, and W is not a tool bar window, see if
12807 point has been moved into or out of a composition. In that case,
12808 we set b->clip_changed to 1 to force updating the screen. If
12809 b->clip_changed has already been set to 1, we can skip this
12811 if (!b
->clip_changed
12812 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12816 if (w
== XWINDOW (selected_window
))
12819 pt
= marker_position (w
->pointm
);
12821 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12822 || pt
!= w
->last_point
)
12823 && check_point_in_composition (w
->current_matrix
->buffer
,
12825 XBUFFER (w
->buffer
), pt
))
12826 b
->clip_changed
= 1;
12831 /* Select FRAME to forward the values of frame-local variables into C
12832 variables so that the redisplay routines can access those values
12836 select_frame_for_redisplay (Lisp_Object frame
)
12838 Lisp_Object tail
, tem
;
12839 Lisp_Object old
= selected_frame
;
12840 struct Lisp_Symbol
*sym
;
12842 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12844 selected_frame
= frame
;
12847 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12848 if (CONSP (XCAR (tail
))
12849 && (tem
= XCAR (XCAR (tail
)),
12851 && (sym
= indirect_variable (XSYMBOL (tem
)),
12852 sym
->redirect
== SYMBOL_LOCALIZED
)
12853 && sym
->val
.blv
->frame_local
)
12854 /* Use find_symbol_value rather than Fsymbol_value
12855 to avoid an error if it is void. */
12856 find_symbol_value (tem
);
12857 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12861 #define STOP_POLLING \
12862 do { if (! polling_stopped_here) stop_polling (); \
12863 polling_stopped_here = 1; } while (0)
12865 #define RESUME_POLLING \
12866 do { if (polling_stopped_here) start_polling (); \
12867 polling_stopped_here = 0; } while (0)
12870 /* Perhaps in the future avoid recentering windows if it
12871 is not necessary; currently that causes some problems. */
12874 redisplay_internal (void)
12876 struct window
*w
= XWINDOW (selected_window
);
12880 int must_finish
= 0;
12881 struct text_pos tlbufpos
, tlendpos
;
12882 int number_of_visible_frames
;
12883 ptrdiff_t count
, count1
;
12885 int polling_stopped_here
= 0;
12886 Lisp_Object old_frame
= selected_frame
;
12888 /* Non-zero means redisplay has to consider all windows on all
12889 frames. Zero means, only selected_window is considered. */
12890 int consider_all_windows_p
;
12892 /* Non-zero means redisplay has to redisplay the miniwindow */
12893 int update_miniwindow_p
= 0;
12895 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12897 /* No redisplay if running in batch mode or frame is not yet fully
12898 initialized, or redisplay is explicitly turned off by setting
12899 Vinhibit_redisplay. */
12900 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12901 || !NILP (Vinhibit_redisplay
))
12904 /* Don't examine these until after testing Vinhibit_redisplay.
12905 When Emacs is shutting down, perhaps because its connection to
12906 X has dropped, we should not look at them at all. */
12907 fr
= XFRAME (w
->frame
);
12908 sf
= SELECTED_FRAME ();
12910 if (!fr
->glyphs_initialized_p
)
12913 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12914 if (popup_activated ())
12918 /* I don't think this happens but let's be paranoid. */
12919 if (redisplaying_p
)
12922 /* Record a function that resets redisplaying_p to its old value
12923 when we leave this function. */
12924 count
= SPECPDL_INDEX ();
12925 record_unwind_protect (unwind_redisplay
,
12926 Fcons (make_number (redisplaying_p
), selected_frame
));
12928 specbind (Qinhibit_free_realized_faces
, Qnil
);
12931 Lisp_Object tail
, frame
;
12933 FOR_EACH_FRAME (tail
, frame
)
12935 struct frame
*f
= XFRAME (frame
);
12936 f
->already_hscrolled_p
= 0;
12941 /* Remember the currently selected window. */
12944 if (!EQ (old_frame
, selected_frame
)
12945 && FRAME_LIVE_P (XFRAME (old_frame
)))
12946 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12947 selected_frame and selected_window to be temporarily out-of-sync so
12948 when we come back here via `goto retry', we need to resync because we
12949 may need to run Elisp code (via prepare_menu_bars). */
12950 select_frame_for_redisplay (old_frame
);
12953 reconsider_clip_changes (w
, current_buffer
);
12954 last_escape_glyph_frame
= NULL
;
12955 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12956 last_glyphless_glyph_frame
= NULL
;
12957 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12959 /* If new fonts have been loaded that make a glyph matrix adjustment
12960 necessary, do it. */
12961 if (fonts_changed_p
)
12963 adjust_glyphs (NULL
);
12964 ++windows_or_buffers_changed
;
12965 fonts_changed_p
= 0;
12968 /* If face_change_count is non-zero, init_iterator will free all
12969 realized faces, which includes the faces referenced from current
12970 matrices. So, we can't reuse current matrices in this case. */
12971 if (face_change_count
)
12972 ++windows_or_buffers_changed
;
12974 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12975 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12977 /* Since frames on a single ASCII terminal share the same
12978 display area, displaying a different frame means redisplay
12979 the whole thing. */
12980 windows_or_buffers_changed
++;
12981 SET_FRAME_GARBAGED (sf
);
12983 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12985 FRAME_TTY (sf
)->previous_frame
= sf
;
12988 /* Set the visible flags for all frames. Do this before checking
12989 for resized or garbaged frames; they want to know if their frames
12990 are visible. See the comment in frame.h for
12991 FRAME_SAMPLE_VISIBILITY. */
12993 Lisp_Object tail
, frame
;
12995 number_of_visible_frames
= 0;
12997 FOR_EACH_FRAME (tail
, frame
)
12999 struct frame
*f
= XFRAME (frame
);
13001 FRAME_SAMPLE_VISIBILITY (f
);
13002 if (FRAME_VISIBLE_P (f
))
13003 ++number_of_visible_frames
;
13004 clear_desired_matrices (f
);
13008 /* Notice any pending interrupt request to change frame size. */
13009 do_pending_window_change (1);
13011 /* do_pending_window_change could change the selected_window due to
13012 frame resizing which makes the selected window too small. */
13013 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13016 reconsider_clip_changes (w
, current_buffer
);
13019 /* Clear frames marked as garbaged. */
13020 if (frame_garbaged
)
13021 clear_garbaged_frames ();
13023 /* Build menubar and tool-bar items. */
13024 if (NILP (Vmemory_full
))
13025 prepare_menu_bars ();
13027 if (windows_or_buffers_changed
)
13028 update_mode_lines
++;
13030 /* Detect case that we need to write or remove a star in the mode line. */
13031 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13033 w
->update_mode_line
= 1;
13034 if (buffer_shared
> 1)
13035 update_mode_lines
++;
13038 /* Avoid invocation of point motion hooks by `current_column' below. */
13039 count1
= SPECPDL_INDEX ();
13040 specbind (Qinhibit_point_motion_hooks
, Qt
);
13042 /* If %c is in the mode line, update it if needed. */
13043 if (!NILP (w
->column_number_displayed
)
13044 /* This alternative quickly identifies a common case
13045 where no change is needed. */
13046 && !(PT
== w
->last_point
13047 && w
->last_modified
>= MODIFF
13048 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13049 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13050 w
->update_mode_line
= 1;
13052 unbind_to (count1
, Qnil
);
13054 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13056 /* The variable buffer_shared is set in redisplay_window and
13057 indicates that we redisplay a buffer in different windows. See
13059 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13060 || cursor_type_changed
);
13062 /* If specs for an arrow have changed, do thorough redisplay
13063 to ensure we remove any arrow that should no longer exist. */
13064 if (overlay_arrows_changed_p ())
13065 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13067 /* Normally the message* functions will have already displayed and
13068 updated the echo area, but the frame may have been trashed, or
13069 the update may have been preempted, so display the echo area
13070 again here. Checking message_cleared_p captures the case that
13071 the echo area should be cleared. */
13072 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13073 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13074 || (message_cleared_p
13075 && minibuf_level
== 0
13076 /* If the mini-window is currently selected, this means the
13077 echo-area doesn't show through. */
13078 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13080 int window_height_changed_p
= echo_area_display (0);
13082 if (message_cleared_p
)
13083 update_miniwindow_p
= 1;
13087 /* If we don't display the current message, don't clear the
13088 message_cleared_p flag, because, if we did, we wouldn't clear
13089 the echo area in the next redisplay which doesn't preserve
13091 if (!display_last_displayed_message_p
)
13092 message_cleared_p
= 0;
13094 if (fonts_changed_p
)
13096 else if (window_height_changed_p
)
13098 consider_all_windows_p
= 1;
13099 ++update_mode_lines
;
13100 ++windows_or_buffers_changed
;
13102 /* If window configuration was changed, frames may have been
13103 marked garbaged. Clear them or we will experience
13104 surprises wrt scrolling. */
13105 if (frame_garbaged
)
13106 clear_garbaged_frames ();
13109 else if (EQ (selected_window
, minibuf_window
)
13110 && (current_buffer
->clip_changed
13111 || w
->last_modified
< MODIFF
13112 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13113 && resize_mini_window (w
, 0))
13115 /* Resized active mini-window to fit the size of what it is
13116 showing if its contents might have changed. */
13118 /* FIXME: this causes all frames to be updated, which seems unnecessary
13119 since only the current frame needs to be considered. This function needs
13120 to be rewritten with two variables, consider_all_windows and
13121 consider_all_frames. */
13122 consider_all_windows_p
= 1;
13123 ++windows_or_buffers_changed
;
13124 ++update_mode_lines
;
13126 /* If window configuration was changed, frames may have been
13127 marked garbaged. Clear them or we will experience
13128 surprises wrt scrolling. */
13129 if (frame_garbaged
)
13130 clear_garbaged_frames ();
13134 /* If showing the region, and mark has changed, we must redisplay
13135 the whole window. The assignment to this_line_start_pos prevents
13136 the optimization directly below this if-statement. */
13137 if (((!NILP (Vtransient_mark_mode
)
13138 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13139 != !NILP (w
->region_showing
))
13140 || (!NILP (w
->region_showing
)
13141 && !EQ (w
->region_showing
,
13142 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13143 CHARPOS (this_line_start_pos
) = 0;
13145 /* Optimize the case that only the line containing the cursor in the
13146 selected window has changed. Variables starting with this_ are
13147 set in display_line and record information about the line
13148 containing the cursor. */
13149 tlbufpos
= this_line_start_pos
;
13150 tlendpos
= this_line_end_pos
;
13151 if (!consider_all_windows_p
13152 && CHARPOS (tlbufpos
) > 0
13153 && !w
->update_mode_line
13154 && !current_buffer
->clip_changed
13155 && !current_buffer
->prevent_redisplay_optimizations_p
13156 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13157 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13158 /* Make sure recorded data applies to current buffer, etc. */
13159 && this_line_buffer
== current_buffer
13160 && current_buffer
== XBUFFER (w
->buffer
)
13162 && !w
->optional_new_start
13163 /* Point must be on the line that we have info recorded about. */
13164 && PT
>= CHARPOS (tlbufpos
)
13165 && PT
<= Z
- CHARPOS (tlendpos
)
13166 /* All text outside that line, including its final newline,
13167 must be unchanged. */
13168 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13169 CHARPOS (tlendpos
)))
13171 if (CHARPOS (tlbufpos
) > BEGV
13172 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13173 && (CHARPOS (tlbufpos
) == ZV
13174 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13175 /* Former continuation line has disappeared by becoming empty. */
13177 else if (w
->last_modified
< MODIFF
13178 || w
->last_overlay_modified
< OVERLAY_MODIFF
13179 || MINI_WINDOW_P (w
))
13181 /* We have to handle the case of continuation around a
13182 wide-column character (see the comment in indent.c around
13185 For instance, in the following case:
13187 -------- Insert --------
13188 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13189 J_I_ ==> J_I_ `^^' are cursors.
13193 As we have to redraw the line above, we cannot use this
13197 int line_height_before
= this_line_pixel_height
;
13199 /* Note that start_display will handle the case that the
13200 line starting at tlbufpos is a continuation line. */
13201 start_display (&it
, w
, tlbufpos
);
13203 /* Implementation note: It this still necessary? */
13204 if (it
.current_x
!= this_line_start_x
)
13207 TRACE ((stderr
, "trying display optimization 1\n"));
13208 w
->cursor
.vpos
= -1;
13209 overlay_arrow_seen
= 0;
13210 it
.vpos
= this_line_vpos
;
13211 it
.current_y
= this_line_y
;
13212 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13213 display_line (&it
);
13215 /* If line contains point, is not continued,
13216 and ends at same distance from eob as before, we win. */
13217 if (w
->cursor
.vpos
>= 0
13218 /* Line is not continued, otherwise this_line_start_pos
13219 would have been set to 0 in display_line. */
13220 && CHARPOS (this_line_start_pos
)
13221 /* Line ends as before. */
13222 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13223 /* Line has same height as before. Otherwise other lines
13224 would have to be shifted up or down. */
13225 && this_line_pixel_height
== line_height_before
)
13227 /* If this is not the window's last line, we must adjust
13228 the charstarts of the lines below. */
13229 if (it
.current_y
< it
.last_visible_y
)
13231 struct glyph_row
*row
13232 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13233 ptrdiff_t delta
, delta_bytes
;
13235 /* We used to distinguish between two cases here,
13236 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13237 when the line ends in a newline or the end of the
13238 buffer's accessible portion. But both cases did
13239 the same, so they were collapsed. */
13241 - CHARPOS (tlendpos
)
13242 - MATRIX_ROW_START_CHARPOS (row
));
13243 delta_bytes
= (Z_BYTE
13244 - BYTEPOS (tlendpos
)
13245 - MATRIX_ROW_START_BYTEPOS (row
));
13247 increment_matrix_positions (w
->current_matrix
,
13248 this_line_vpos
+ 1,
13249 w
->current_matrix
->nrows
,
13250 delta
, delta_bytes
);
13253 /* If this row displays text now but previously didn't,
13254 or vice versa, w->window_end_vpos may have to be
13256 if ((it
.glyph_row
- 1)->displays_text_p
)
13258 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13259 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13261 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13262 && this_line_vpos
> 0)
13263 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13264 w
->window_end_valid
= Qnil
;
13266 /* Update hint: No need to try to scroll in update_window. */
13267 w
->desired_matrix
->no_scrolling_p
= 1;
13270 *w
->desired_matrix
->method
= 0;
13271 debug_method_add (w
, "optimization 1");
13273 #ifdef HAVE_WINDOW_SYSTEM
13274 update_window_fringes (w
, 0);
13281 else if (/* Cursor position hasn't changed. */
13282 PT
== w
->last_point
13283 /* Make sure the cursor was last displayed
13284 in this window. Otherwise we have to reposition it. */
13285 && 0 <= w
->cursor
.vpos
13286 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13290 do_pending_window_change (1);
13291 /* If selected_window changed, redisplay again. */
13292 if (WINDOWP (selected_window
)
13293 && (w
= XWINDOW (selected_window
)) != sw
)
13296 /* We used to always goto end_of_redisplay here, but this
13297 isn't enough if we have a blinking cursor. */
13298 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13299 goto end_of_redisplay
;
13303 /* If highlighting the region, or if the cursor is in the echo area,
13304 then we can't just move the cursor. */
13305 else if (! (!NILP (Vtransient_mark_mode
)
13306 && !NILP (BVAR (current_buffer
, mark_active
)))
13307 && (EQ (selected_window
,
13308 BVAR (current_buffer
, last_selected_window
))
13309 || highlight_nonselected_windows
)
13310 && NILP (w
->region_showing
)
13311 && NILP (Vshow_trailing_whitespace
)
13312 && !cursor_in_echo_area
)
13315 struct glyph_row
*row
;
13317 /* Skip from tlbufpos to PT and see where it is. Note that
13318 PT may be in invisible text. If so, we will end at the
13319 next visible position. */
13320 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13321 NULL
, DEFAULT_FACE_ID
);
13322 it
.current_x
= this_line_start_x
;
13323 it
.current_y
= this_line_y
;
13324 it
.vpos
= this_line_vpos
;
13326 /* The call to move_it_to stops in front of PT, but
13327 moves over before-strings. */
13328 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13330 if (it
.vpos
== this_line_vpos
13331 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13334 eassert (this_line_vpos
== it
.vpos
);
13335 eassert (this_line_y
== it
.current_y
);
13336 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13338 *w
->desired_matrix
->method
= 0;
13339 debug_method_add (w
, "optimization 3");
13348 /* Text changed drastically or point moved off of line. */
13349 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13352 CHARPOS (this_line_start_pos
) = 0;
13353 consider_all_windows_p
|= buffer_shared
> 1;
13354 ++clear_face_cache_count
;
13355 #ifdef HAVE_WINDOW_SYSTEM
13356 ++clear_image_cache_count
;
13359 /* Build desired matrices, and update the display. If
13360 consider_all_windows_p is non-zero, do it for all windows on all
13361 frames. Otherwise do it for selected_window, only. */
13363 if (consider_all_windows_p
)
13365 Lisp_Object tail
, frame
;
13367 FOR_EACH_FRAME (tail
, frame
)
13368 XFRAME (frame
)->updated_p
= 0;
13370 /* Recompute # windows showing selected buffer. This will be
13371 incremented each time such a window is displayed. */
13374 FOR_EACH_FRAME (tail
, frame
)
13376 struct frame
*f
= XFRAME (frame
);
13378 /* We don't have to do anything for unselected terminal
13380 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13381 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13384 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13386 if (! EQ (frame
, selected_frame
))
13387 /* Select the frame, for the sake of frame-local
13389 select_frame_for_redisplay (frame
);
13391 /* Mark all the scroll bars to be removed; we'll redeem
13392 the ones we want when we redisplay their windows. */
13393 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13394 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13396 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13397 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13399 /* The X error handler may have deleted that frame. */
13400 if (!FRAME_LIVE_P (f
))
13403 /* Any scroll bars which redisplay_windows should have
13404 nuked should now go away. */
13405 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13406 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13408 /* If fonts changed, display again. */
13409 /* ??? rms: I suspect it is a mistake to jump all the way
13410 back to retry here. It should just retry this frame. */
13411 if (fonts_changed_p
)
13414 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13416 /* See if we have to hscroll. */
13417 if (!f
->already_hscrolled_p
)
13419 f
->already_hscrolled_p
= 1;
13420 if (hscroll_windows (f
->root_window
))
13424 /* Prevent various kinds of signals during display
13425 update. stdio is not robust about handling
13426 signals, which can cause an apparent I/O
13428 if (interrupt_input
)
13429 unrequest_sigio ();
13432 /* Update the display. */
13433 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13434 pending
|= update_frame (f
, 0, 0);
13440 if (!EQ (old_frame
, selected_frame
)
13441 && FRAME_LIVE_P (XFRAME (old_frame
)))
13442 /* We played a bit fast-and-loose above and allowed selected_frame
13443 and selected_window to be temporarily out-of-sync but let's make
13444 sure this stays contained. */
13445 select_frame_for_redisplay (old_frame
);
13446 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13450 /* Do the mark_window_display_accurate after all windows have
13451 been redisplayed because this call resets flags in buffers
13452 which are needed for proper redisplay. */
13453 FOR_EACH_FRAME (tail
, frame
)
13455 struct frame
*f
= XFRAME (frame
);
13458 mark_window_display_accurate (f
->root_window
, 1);
13459 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13460 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13465 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13467 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13468 struct frame
*mini_frame
;
13470 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13471 /* Use list_of_error, not Qerror, so that
13472 we catch only errors and don't run the debugger. */
13473 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13475 redisplay_window_error
);
13476 if (update_miniwindow_p
)
13477 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13479 redisplay_window_error
);
13481 /* Compare desired and current matrices, perform output. */
13484 /* If fonts changed, display again. */
13485 if (fonts_changed_p
)
13488 /* Prevent various kinds of signals during display update.
13489 stdio is not robust about handling signals,
13490 which can cause an apparent I/O error. */
13491 if (interrupt_input
)
13492 unrequest_sigio ();
13495 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13497 if (hscroll_windows (selected_window
))
13500 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13501 pending
= update_frame (sf
, 0, 0);
13504 /* We may have called echo_area_display at the top of this
13505 function. If the echo area is on another frame, that may
13506 have put text on a frame other than the selected one, so the
13507 above call to update_frame would not have caught it. Catch
13509 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13510 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13512 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13514 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13515 pending
|= update_frame (mini_frame
, 0, 0);
13516 if (!pending
&& hscroll_windows (mini_window
))
13521 /* If display was paused because of pending input, make sure we do a
13522 thorough update the next time. */
13525 /* Prevent the optimization at the beginning of
13526 redisplay_internal that tries a single-line update of the
13527 line containing the cursor in the selected window. */
13528 CHARPOS (this_line_start_pos
) = 0;
13530 /* Let the overlay arrow be updated the next time. */
13531 update_overlay_arrows (0);
13533 /* If we pause after scrolling, some rows in the current
13534 matrices of some windows are not valid. */
13535 if (!WINDOW_FULL_WIDTH_P (w
)
13536 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13537 update_mode_lines
= 1;
13541 if (!consider_all_windows_p
)
13543 /* This has already been done above if
13544 consider_all_windows_p is set. */
13545 mark_window_display_accurate_1 (w
, 1);
13547 /* Say overlay arrows are up to date. */
13548 update_overlay_arrows (1);
13550 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13551 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13554 update_mode_lines
= 0;
13555 windows_or_buffers_changed
= 0;
13556 cursor_type_changed
= 0;
13559 /* Start SIGIO interrupts coming again. Having them off during the
13560 code above makes it less likely one will discard output, but not
13561 impossible, since there might be stuff in the system buffer here.
13562 But it is much hairier to try to do anything about that. */
13563 if (interrupt_input
)
13567 /* If a frame has become visible which was not before, redisplay
13568 again, so that we display it. Expose events for such a frame
13569 (which it gets when becoming visible) don't call the parts of
13570 redisplay constructing glyphs, so simply exposing a frame won't
13571 display anything in this case. So, we have to display these
13572 frames here explicitly. */
13575 Lisp_Object tail
, frame
;
13578 FOR_EACH_FRAME (tail
, frame
)
13580 int this_is_visible
= 0;
13582 if (XFRAME (frame
)->visible
)
13583 this_is_visible
= 1;
13584 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13585 if (XFRAME (frame
)->visible
)
13586 this_is_visible
= 1;
13588 if (this_is_visible
)
13592 if (new_count
!= number_of_visible_frames
)
13593 windows_or_buffers_changed
++;
13596 /* Change frame size now if a change is pending. */
13597 do_pending_window_change (1);
13599 /* If we just did a pending size change, or have additional
13600 visible frames, or selected_window changed, redisplay again. */
13601 if ((windows_or_buffers_changed
&& !pending
)
13602 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13605 /* Clear the face and image caches.
13607 We used to do this only if consider_all_windows_p. But the cache
13608 needs to be cleared if a timer creates images in the current
13609 buffer (e.g. the test case in Bug#6230). */
13611 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13613 clear_face_cache (0);
13614 clear_face_cache_count
= 0;
13617 #ifdef HAVE_WINDOW_SYSTEM
13618 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13620 clear_image_caches (Qnil
);
13621 clear_image_cache_count
= 0;
13623 #endif /* HAVE_WINDOW_SYSTEM */
13626 unbind_to (count
, Qnil
);
13631 /* Redisplay, but leave alone any recent echo area message unless
13632 another message has been requested in its place.
13634 This is useful in situations where you need to redisplay but no
13635 user action has occurred, making it inappropriate for the message
13636 area to be cleared. See tracking_off and
13637 wait_reading_process_output for examples of these situations.
13639 FROM_WHERE is an integer saying from where this function was
13640 called. This is useful for debugging. */
13643 redisplay_preserve_echo_area (int from_where
)
13645 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13647 if (!NILP (echo_area_buffer
[1]))
13649 /* We have a previously displayed message, but no current
13650 message. Redisplay the previous message. */
13651 display_last_displayed_message_p
= 1;
13652 redisplay_internal ();
13653 display_last_displayed_message_p
= 0;
13656 redisplay_internal ();
13658 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13659 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13660 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13664 /* Function registered with record_unwind_protect in
13665 redisplay_internal. Reset redisplaying_p to the value it had
13666 before redisplay_internal was called, and clear
13667 prevent_freeing_realized_faces_p. It also selects the previously
13668 selected frame, unless it has been deleted (by an X connection
13669 failure during redisplay, for example). */
13672 unwind_redisplay (Lisp_Object val
)
13674 Lisp_Object old_redisplaying_p
, old_frame
;
13676 old_redisplaying_p
= XCAR (val
);
13677 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13678 old_frame
= XCDR (val
);
13679 if (! EQ (old_frame
, selected_frame
)
13680 && FRAME_LIVE_P (XFRAME (old_frame
)))
13681 select_frame_for_redisplay (old_frame
);
13686 /* Mark the display of window W as accurate or inaccurate. If
13687 ACCURATE_P is non-zero mark display of W as accurate. If
13688 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13689 redisplay_internal is called. */
13692 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13694 if (BUFFERP (w
->buffer
))
13696 struct buffer
*b
= XBUFFER (w
->buffer
);
13698 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13699 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13701 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13705 b
->clip_changed
= 0;
13706 b
->prevent_redisplay_optimizations_p
= 0;
13708 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13709 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13710 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13711 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13713 w
->current_matrix
->buffer
= b
;
13714 w
->current_matrix
->begv
= BUF_BEGV (b
);
13715 w
->current_matrix
->zv
= BUF_ZV (b
);
13717 w
->last_cursor
= w
->cursor
;
13718 w
->last_cursor_off_p
= w
->cursor_off_p
;
13720 if (w
== XWINDOW (selected_window
))
13721 w
->last_point
= BUF_PT (b
);
13723 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13729 w
->window_end_valid
= w
->buffer
;
13730 w
->update_mode_line
= 0;
13735 /* Mark the display of windows in the window tree rooted at WINDOW as
13736 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13737 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13738 be redisplayed the next time redisplay_internal is called. */
13741 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13745 for (; !NILP (window
); window
= w
->next
)
13747 w
= XWINDOW (window
);
13748 mark_window_display_accurate_1 (w
, accurate_p
);
13750 if (!NILP (w
->vchild
))
13751 mark_window_display_accurate (w
->vchild
, accurate_p
);
13752 if (!NILP (w
->hchild
))
13753 mark_window_display_accurate (w
->hchild
, accurate_p
);
13758 update_overlay_arrows (1);
13762 /* Force a thorough redisplay the next time by setting
13763 last_arrow_position and last_arrow_string to t, which is
13764 unequal to any useful value of Voverlay_arrow_... */
13765 update_overlay_arrows (-1);
13770 /* Return value in display table DP (Lisp_Char_Table *) for character
13771 C. Since a display table doesn't have any parent, we don't have to
13772 follow parent. Do not call this function directly but use the
13773 macro DISP_CHAR_VECTOR. */
13776 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13780 if (ASCII_CHAR_P (c
))
13783 if (SUB_CHAR_TABLE_P (val
))
13784 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13790 XSETCHAR_TABLE (table
, dp
);
13791 val
= char_table_ref (table
, c
);
13800 /***********************************************************************
13802 ***********************************************************************/
13804 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13807 redisplay_windows (Lisp_Object window
)
13809 while (!NILP (window
))
13811 struct window
*w
= XWINDOW (window
);
13813 if (!NILP (w
->hchild
))
13814 redisplay_windows (w
->hchild
);
13815 else if (!NILP (w
->vchild
))
13816 redisplay_windows (w
->vchild
);
13817 else if (!NILP (w
->buffer
))
13819 displayed_buffer
= XBUFFER (w
->buffer
);
13820 /* Use list_of_error, not Qerror, so that
13821 we catch only errors and don't run the debugger. */
13822 internal_condition_case_1 (redisplay_window_0
, window
,
13824 redisplay_window_error
);
13832 redisplay_window_error (Lisp_Object ignore
)
13834 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13839 redisplay_window_0 (Lisp_Object window
)
13841 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13842 redisplay_window (window
, 0);
13847 redisplay_window_1 (Lisp_Object window
)
13849 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13850 redisplay_window (window
, 1);
13855 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13856 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13857 which positions recorded in ROW differ from current buffer
13860 Return 0 if cursor is not on this row, 1 otherwise. */
13863 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13864 struct glyph_matrix
*matrix
,
13865 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13868 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13869 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13870 struct glyph
*cursor
= NULL
;
13871 /* The last known character position in row. */
13872 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13874 ptrdiff_t pt_old
= PT
- delta
;
13875 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13876 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13877 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13878 /* A glyph beyond the edge of TEXT_AREA which we should never
13880 struct glyph
*glyphs_end
= end
;
13881 /* Non-zero means we've found a match for cursor position, but that
13882 glyph has the avoid_cursor_p flag set. */
13883 int match_with_avoid_cursor
= 0;
13884 /* Non-zero means we've seen at least one glyph that came from a
13886 int string_seen
= 0;
13887 /* Largest and smallest buffer positions seen so far during scan of
13889 ptrdiff_t bpos_max
= pos_before
;
13890 ptrdiff_t bpos_min
= pos_after
;
13891 /* Last buffer position covered by an overlay string with an integer
13892 `cursor' property. */
13893 ptrdiff_t bpos_covered
= 0;
13894 /* Non-zero means the display string on which to display the cursor
13895 comes from a text property, not from an overlay. */
13896 int string_from_text_prop
= 0;
13898 /* Don't even try doing anything if called for a mode-line or
13899 header-line row, since the rest of the code isn't prepared to
13900 deal with such calamities. */
13901 eassert (!row
->mode_line_p
);
13902 if (row
->mode_line_p
)
13905 /* Skip over glyphs not having an object at the start and the end of
13906 the row. These are special glyphs like truncation marks on
13907 terminal frames. */
13908 if (row
->displays_text_p
)
13910 if (!row
->reversed_p
)
13913 && INTEGERP (glyph
->object
)
13914 && glyph
->charpos
< 0)
13916 x
+= glyph
->pixel_width
;
13920 && INTEGERP ((end
- 1)->object
)
13921 /* CHARPOS is zero for blanks and stretch glyphs
13922 inserted by extend_face_to_end_of_line. */
13923 && (end
- 1)->charpos
<= 0)
13925 glyph_before
= glyph
- 1;
13932 /* If the glyph row is reversed, we need to process it from back
13933 to front, so swap the edge pointers. */
13934 glyphs_end
= end
= glyph
- 1;
13935 glyph
+= row
->used
[TEXT_AREA
] - 1;
13937 while (glyph
> end
+ 1
13938 && INTEGERP (glyph
->object
)
13939 && glyph
->charpos
< 0)
13942 x
-= glyph
->pixel_width
;
13944 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13946 /* By default, in reversed rows we put the cursor on the
13947 rightmost (first in the reading order) glyph. */
13948 for (g
= end
+ 1; g
< glyph
; g
++)
13949 x
+= g
->pixel_width
;
13951 && INTEGERP ((end
+ 1)->object
)
13952 && (end
+ 1)->charpos
<= 0)
13954 glyph_before
= glyph
+ 1;
13958 else if (row
->reversed_p
)
13960 /* In R2L rows that don't display text, put the cursor on the
13961 rightmost glyph. Case in point: an empty last line that is
13962 part of an R2L paragraph. */
13964 /* Avoid placing the cursor on the last glyph of the row, where
13965 on terminal frames we hold the vertical border between
13966 adjacent windows. */
13967 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13968 && !WINDOW_RIGHTMOST_P (w
)
13969 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13971 x
= -1; /* will be computed below, at label compute_x */
13974 /* Step 1: Try to find the glyph whose character position
13975 corresponds to point. If that's not possible, find 2 glyphs
13976 whose character positions are the closest to point, one before
13977 point, the other after it. */
13978 if (!row
->reversed_p
)
13979 while (/* not marched to end of glyph row */
13981 /* glyph was not inserted by redisplay for internal purposes */
13982 && !INTEGERP (glyph
->object
))
13984 if (BUFFERP (glyph
->object
))
13986 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13988 if (glyph
->charpos
> bpos_max
)
13989 bpos_max
= glyph
->charpos
;
13990 if (glyph
->charpos
< bpos_min
)
13991 bpos_min
= glyph
->charpos
;
13992 if (!glyph
->avoid_cursor_p
)
13994 /* If we hit point, we've found the glyph on which to
13995 display the cursor. */
13998 match_with_avoid_cursor
= 0;
14001 /* See if we've found a better approximation to
14002 POS_BEFORE or to POS_AFTER. */
14003 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14005 pos_before
= glyph
->charpos
;
14006 glyph_before
= glyph
;
14008 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14010 pos_after
= glyph
->charpos
;
14011 glyph_after
= glyph
;
14014 else if (dpos
== 0)
14015 match_with_avoid_cursor
= 1;
14017 else if (STRINGP (glyph
->object
))
14019 Lisp_Object chprop
;
14020 ptrdiff_t glyph_pos
= glyph
->charpos
;
14022 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14024 if (!NILP (chprop
))
14026 /* If the string came from a `display' text property,
14027 look up the buffer position of that property and
14028 use that position to update bpos_max, as if we
14029 actually saw such a position in one of the row's
14030 glyphs. This helps with supporting integer values
14031 of `cursor' property on the display string in
14032 situations where most or all of the row's buffer
14033 text is completely covered by display properties,
14034 so that no glyph with valid buffer positions is
14035 ever seen in the row. */
14036 ptrdiff_t prop_pos
=
14037 string_buffer_position_lim (glyph
->object
, pos_before
,
14040 if (prop_pos
>= pos_before
)
14041 bpos_max
= prop_pos
- 1;
14043 if (INTEGERP (chprop
))
14045 bpos_covered
= bpos_max
+ XINT (chprop
);
14046 /* If the `cursor' property covers buffer positions up
14047 to and including point, we should display cursor on
14048 this glyph. Note that, if a `cursor' property on one
14049 of the string's characters has an integer value, we
14050 will break out of the loop below _before_ we get to
14051 the position match above. IOW, integer values of
14052 the `cursor' property override the "exact match for
14053 point" strategy of positioning the cursor. */
14054 /* Implementation note: bpos_max == pt_old when, e.g.,
14055 we are in an empty line, where bpos_max is set to
14056 MATRIX_ROW_START_CHARPOS, see above. */
14057 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14066 x
+= glyph
->pixel_width
;
14069 else if (glyph
> end
) /* row is reversed */
14070 while (!INTEGERP (glyph
->object
))
14072 if (BUFFERP (glyph
->object
))
14074 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14076 if (glyph
->charpos
> bpos_max
)
14077 bpos_max
= glyph
->charpos
;
14078 if (glyph
->charpos
< bpos_min
)
14079 bpos_min
= glyph
->charpos
;
14080 if (!glyph
->avoid_cursor_p
)
14084 match_with_avoid_cursor
= 0;
14087 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14089 pos_before
= glyph
->charpos
;
14090 glyph_before
= glyph
;
14092 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14094 pos_after
= glyph
->charpos
;
14095 glyph_after
= glyph
;
14098 else if (dpos
== 0)
14099 match_with_avoid_cursor
= 1;
14101 else if (STRINGP (glyph
->object
))
14103 Lisp_Object chprop
;
14104 ptrdiff_t glyph_pos
= glyph
->charpos
;
14106 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14108 if (!NILP (chprop
))
14110 ptrdiff_t prop_pos
=
14111 string_buffer_position_lim (glyph
->object
, pos_before
,
14114 if (prop_pos
>= pos_before
)
14115 bpos_max
= prop_pos
- 1;
14117 if (INTEGERP (chprop
))
14119 bpos_covered
= bpos_max
+ XINT (chprop
);
14120 /* If the `cursor' property covers buffer positions up
14121 to and including point, we should display cursor on
14123 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14132 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14134 x
--; /* can't use any pixel_width */
14137 x
-= glyph
->pixel_width
;
14140 /* Step 2: If we didn't find an exact match for point, we need to
14141 look for a proper place to put the cursor among glyphs between
14142 GLYPH_BEFORE and GLYPH_AFTER. */
14143 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14144 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14145 && bpos_covered
< pt_old
)
14147 /* An empty line has a single glyph whose OBJECT is zero and
14148 whose CHARPOS is the position of a newline on that line.
14149 Note that on a TTY, there are more glyphs after that, which
14150 were produced by extend_face_to_end_of_line, but their
14151 CHARPOS is zero or negative. */
14153 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14154 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14156 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14158 ptrdiff_t ellipsis_pos
;
14160 /* Scan back over the ellipsis glyphs. */
14161 if (!row
->reversed_p
)
14163 ellipsis_pos
= (glyph
- 1)->charpos
;
14164 while (glyph
> row
->glyphs
[TEXT_AREA
]
14165 && (glyph
- 1)->charpos
== ellipsis_pos
)
14166 glyph
--, x
-= glyph
->pixel_width
;
14167 /* That loop always goes one position too far, including
14168 the glyph before the ellipsis. So scan forward over
14170 x
+= glyph
->pixel_width
;
14173 else /* row is reversed */
14175 ellipsis_pos
= (glyph
+ 1)->charpos
;
14176 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14177 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14178 glyph
++, x
+= glyph
->pixel_width
;
14179 x
-= glyph
->pixel_width
;
14183 else if (match_with_avoid_cursor
)
14185 cursor
= glyph_after
;
14188 else if (string_seen
)
14190 int incr
= row
->reversed_p
? -1 : +1;
14192 /* Need to find the glyph that came out of a string which is
14193 present at point. That glyph is somewhere between
14194 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14195 positioned between POS_BEFORE and POS_AFTER in the
14197 struct glyph
*start
, *stop
;
14198 ptrdiff_t pos
= pos_before
;
14202 /* If the row ends in a newline from a display string,
14203 reordering could have moved the glyphs belonging to the
14204 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14205 in this case we extend the search to the last glyph in
14206 the row that was not inserted by redisplay. */
14207 if (row
->ends_in_newline_from_string_p
)
14210 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14213 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14214 correspond to POS_BEFORE and POS_AFTER, respectively. We
14215 need START and STOP in the order that corresponds to the
14216 row's direction as given by its reversed_p flag. If the
14217 directionality of characters between POS_BEFORE and
14218 POS_AFTER is the opposite of the row's base direction,
14219 these characters will have been reordered for display,
14220 and we need to reverse START and STOP. */
14221 if (!row
->reversed_p
)
14223 start
= min (glyph_before
, glyph_after
);
14224 stop
= max (glyph_before
, glyph_after
);
14228 start
= max (glyph_before
, glyph_after
);
14229 stop
= min (glyph_before
, glyph_after
);
14231 for (glyph
= start
+ incr
;
14232 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14235 /* Any glyphs that come from the buffer are here because
14236 of bidi reordering. Skip them, and only pay
14237 attention to glyphs that came from some string. */
14238 if (STRINGP (glyph
->object
))
14242 /* If the display property covers the newline, we
14243 need to search for it one position farther. */
14244 ptrdiff_t lim
= pos_after
14245 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14247 string_from_text_prop
= 0;
14248 str
= glyph
->object
;
14249 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14250 if (tem
== 0 /* from overlay */
14253 /* If the string from which this glyph came is
14254 found in the buffer at point, or at position
14255 that is closer to point than pos_after, then
14256 we've found the glyph we've been looking for.
14257 If it comes from an overlay (tem == 0), and
14258 it has the `cursor' property on one of its
14259 glyphs, record that glyph as a candidate for
14260 displaying the cursor. (As in the
14261 unidirectional version, we will display the
14262 cursor on the last candidate we find.) */
14265 || (tem
- pt_old
> 0 && tem
< pos_after
))
14267 /* The glyphs from this string could have
14268 been reordered. Find the one with the
14269 smallest string position. Or there could
14270 be a character in the string with the
14271 `cursor' property, which means display
14272 cursor on that character's glyph. */
14273 ptrdiff_t strpos
= glyph
->charpos
;
14278 string_from_text_prop
= 1;
14281 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14282 && EQ (glyph
->object
, str
);
14286 ptrdiff_t gpos
= glyph
->charpos
;
14288 cprop
= Fget_char_property (make_number (gpos
),
14296 if (tem
&& glyph
->charpos
< strpos
)
14298 strpos
= glyph
->charpos
;
14304 || (tem
- pt_old
> 0 && tem
< pos_after
))
14308 pos
= tem
+ 1; /* don't find previous instances */
14310 /* This string is not what we want; skip all of the
14311 glyphs that came from it. */
14312 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14313 && EQ (glyph
->object
, str
))
14320 /* If we reached the end of the line, and END was from a string,
14321 the cursor is not on this line. */
14323 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14324 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14325 && STRINGP (end
->object
)
14326 && row
->continued_p
)
14329 /* A truncated row may not include PT among its character positions.
14330 Setting the cursor inside the scroll margin will trigger
14331 recalculation of hscroll in hscroll_window_tree. But if a
14332 display string covers point, defer to the string-handling
14333 code below to figure this out. */
14334 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14336 cursor
= glyph_before
;
14339 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14340 /* Zero-width characters produce no glyphs. */
14342 && (row
->reversed_p
14343 ? glyph_after
> glyphs_end
14344 : glyph_after
< glyphs_end
)))
14346 cursor
= glyph_after
;
14352 if (cursor
!= NULL
)
14354 else if (glyph
== glyphs_end
14355 && pos_before
== pos_after
14356 && STRINGP ((row
->reversed_p
14357 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14358 : row
->glyphs
[TEXT_AREA
])->object
))
14360 /* If all the glyphs of this row came from strings, put the
14361 cursor on the first glyph of the row. This avoids having the
14362 cursor outside of the text area in this very rare and hard
14366 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14367 : row
->glyphs
[TEXT_AREA
];
14373 /* Need to compute x that corresponds to GLYPH. */
14374 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14376 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14378 x
+= g
->pixel_width
;
14382 /* ROW could be part of a continued line, which, under bidi
14383 reordering, might have other rows whose start and end charpos
14384 occlude point. Only set w->cursor if we found a better
14385 approximation to the cursor position than we have from previously
14386 examined candidate rows belonging to the same continued line. */
14387 if (/* we already have a candidate row */
14388 w
->cursor
.vpos
>= 0
14389 /* that candidate is not the row we are processing */
14390 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14391 /* Make sure cursor.vpos specifies a row whose start and end
14392 charpos occlude point, and it is valid candidate for being a
14393 cursor-row. This is because some callers of this function
14394 leave cursor.vpos at the row where the cursor was displayed
14395 during the last redisplay cycle. */
14396 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14397 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14398 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14401 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14403 /* Don't consider glyphs that are outside TEXT_AREA. */
14404 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14406 /* Keep the candidate whose buffer position is the closest to
14407 point or has the `cursor' property. */
14408 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14409 w
->cursor
.hpos
>= 0
14410 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14411 && ((BUFFERP (g1
->object
)
14412 && (g1
->charpos
== pt_old
/* an exact match always wins */
14413 || (BUFFERP (glyph
->object
)
14414 && eabs (g1
->charpos
- pt_old
)
14415 < eabs (glyph
->charpos
- pt_old
))))
14416 /* previous candidate is a glyph from a string that has
14417 a non-nil `cursor' property */
14418 || (STRINGP (g1
->object
)
14419 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14420 Qcursor
, g1
->object
))
14421 /* previous candidate is from the same display
14422 string as this one, and the display string
14423 came from a text property */
14424 || (EQ (g1
->object
, glyph
->object
)
14425 && string_from_text_prop
)
14426 /* this candidate is from newline and its
14427 position is not an exact match */
14428 || (INTEGERP (glyph
->object
)
14429 && glyph
->charpos
!= pt_old
)))))
14431 /* If this candidate gives an exact match, use that. */
14432 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14433 /* If this candidate is a glyph created for the
14434 terminating newline of a line, and point is on that
14435 newline, it wins because it's an exact match. */
14436 || (!row
->continued_p
14437 && INTEGERP (glyph
->object
)
14438 && glyph
->charpos
== 0
14439 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14440 /* Otherwise, keep the candidate that comes from a row
14441 spanning less buffer positions. This may win when one or
14442 both candidate positions are on glyphs that came from
14443 display strings, for which we cannot compare buffer
14445 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14446 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14447 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14450 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14452 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14453 w
->cursor
.y
= row
->y
+ dy
;
14455 if (w
== XWINDOW (selected_window
))
14457 if (!row
->continued_p
14458 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14461 this_line_buffer
= XBUFFER (w
->buffer
);
14463 CHARPOS (this_line_start_pos
)
14464 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14465 BYTEPOS (this_line_start_pos
)
14466 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14468 CHARPOS (this_line_end_pos
)
14469 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14470 BYTEPOS (this_line_end_pos
)
14471 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14473 this_line_y
= w
->cursor
.y
;
14474 this_line_pixel_height
= row
->height
;
14475 this_line_vpos
= w
->cursor
.vpos
;
14476 this_line_start_x
= row
->x
;
14479 CHARPOS (this_line_start_pos
) = 0;
14486 /* Run window scroll functions, if any, for WINDOW with new window
14487 start STARTP. Sets the window start of WINDOW to that position.
14489 We assume that the window's buffer is really current. */
14491 static inline struct text_pos
14492 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14494 struct window
*w
= XWINDOW (window
);
14495 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14497 if (current_buffer
!= XBUFFER (w
->buffer
))
14500 if (!NILP (Vwindow_scroll_functions
))
14502 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14503 make_number (CHARPOS (startp
)));
14504 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14505 /* In case the hook functions switch buffers. */
14506 if (current_buffer
!= XBUFFER (w
->buffer
))
14507 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14514 /* Make sure the line containing the cursor is fully visible.
14515 A value of 1 means there is nothing to be done.
14516 (Either the line is fully visible, or it cannot be made so,
14517 or we cannot tell.)
14519 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14520 is higher than window.
14522 A value of 0 means the caller should do scrolling
14523 as if point had gone off the screen. */
14526 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14528 struct glyph_matrix
*matrix
;
14529 struct glyph_row
*row
;
14532 if (!make_cursor_line_fully_visible_p
)
14535 /* It's not always possible to find the cursor, e.g, when a window
14536 is full of overlay strings. Don't do anything in that case. */
14537 if (w
->cursor
.vpos
< 0)
14540 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14541 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14543 /* If the cursor row is not partially visible, there's nothing to do. */
14544 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14547 /* If the row the cursor is in is taller than the window's height,
14548 it's not clear what to do, so do nothing. */
14549 window_height
= window_box_height (w
);
14550 if (row
->height
>= window_height
)
14552 if (!force_p
|| MINI_WINDOW_P (w
)
14553 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14560 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14561 non-zero means only WINDOW is redisplayed in redisplay_internal.
14562 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14563 in redisplay_window to bring a partially visible line into view in
14564 the case that only the cursor has moved.
14566 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14567 last screen line's vertical height extends past the end of the screen.
14571 1 if scrolling succeeded
14573 0 if scrolling didn't find point.
14575 -1 if new fonts have been loaded so that we must interrupt
14576 redisplay, adjust glyph matrices, and try again. */
14582 SCROLLING_NEED_LARGER_MATRICES
14585 /* If scroll-conservatively is more than this, never recenter.
14587 If you change this, don't forget to update the doc string of
14588 `scroll-conservatively' and the Emacs manual. */
14589 #define SCROLL_LIMIT 100
14592 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14593 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14594 int temp_scroll_step
, int last_line_misfit
)
14596 struct window
*w
= XWINDOW (window
);
14597 struct frame
*f
= XFRAME (w
->frame
);
14598 struct text_pos pos
, startp
;
14600 int this_scroll_margin
, scroll_max
, rc
, height
;
14601 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14602 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14603 Lisp_Object aggressive
;
14604 /* We will never try scrolling more than this number of lines. */
14605 int scroll_limit
= SCROLL_LIMIT
;
14608 debug_method_add (w
, "try_scrolling");
14611 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14613 /* Compute scroll margin height in pixels. We scroll when point is
14614 within this distance from the top or bottom of the window. */
14615 if (scroll_margin
> 0)
14616 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14617 * FRAME_LINE_HEIGHT (f
);
14619 this_scroll_margin
= 0;
14621 /* Force arg_scroll_conservatively to have a reasonable value, to
14622 avoid scrolling too far away with slow move_it_* functions. Note
14623 that the user can supply scroll-conservatively equal to
14624 `most-positive-fixnum', which can be larger than INT_MAX. */
14625 if (arg_scroll_conservatively
> scroll_limit
)
14627 arg_scroll_conservatively
= scroll_limit
+ 1;
14628 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14630 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14631 /* Compute how much we should try to scroll maximally to bring
14632 point into view. */
14633 scroll_max
= (max (scroll_step
,
14634 max (arg_scroll_conservatively
, temp_scroll_step
))
14635 * FRAME_LINE_HEIGHT (f
));
14636 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14637 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14638 /* We're trying to scroll because of aggressive scrolling but no
14639 scroll_step is set. Choose an arbitrary one. */
14640 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14646 /* Decide whether to scroll down. */
14647 if (PT
> CHARPOS (startp
))
14649 int scroll_margin_y
;
14651 /* Compute the pixel ypos of the scroll margin, then move IT to
14652 either that ypos or PT, whichever comes first. */
14653 start_display (&it
, w
, startp
);
14654 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14655 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14656 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14657 (MOVE_TO_POS
| MOVE_TO_Y
));
14659 if (PT
> CHARPOS (it
.current
.pos
))
14661 int y0
= line_bottom_y (&it
);
14662 /* Compute how many pixels below window bottom to stop searching
14663 for PT. This avoids costly search for PT that is far away if
14664 the user limited scrolling by a small number of lines, but
14665 always finds PT if scroll_conservatively is set to a large
14666 number, such as most-positive-fixnum. */
14667 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14668 int y_to_move
= it
.last_visible_y
+ slack
;
14670 /* Compute the distance from the scroll margin to PT or to
14671 the scroll limit, whichever comes first. This should
14672 include the height of the cursor line, to make that line
14674 move_it_to (&it
, PT
, -1, y_to_move
,
14675 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14676 dy
= line_bottom_y (&it
) - y0
;
14678 if (dy
> scroll_max
)
14679 return SCROLLING_FAILED
;
14688 /* Point is in or below the bottom scroll margin, so move the
14689 window start down. If scrolling conservatively, move it just
14690 enough down to make point visible. If scroll_step is set,
14691 move it down by scroll_step. */
14692 if (arg_scroll_conservatively
)
14694 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14695 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14696 else if (scroll_step
|| temp_scroll_step
)
14697 amount_to_scroll
= scroll_max
;
14700 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14701 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14702 if (NUMBERP (aggressive
))
14704 double float_amount
= XFLOATINT (aggressive
) * height
;
14705 amount_to_scroll
= float_amount
;
14706 if (amount_to_scroll
== 0 && float_amount
> 0)
14707 amount_to_scroll
= 1;
14708 /* Don't let point enter the scroll margin near top of
14710 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14711 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14715 if (amount_to_scroll
<= 0)
14716 return SCROLLING_FAILED
;
14718 start_display (&it
, w
, startp
);
14719 if (arg_scroll_conservatively
<= scroll_limit
)
14720 move_it_vertically (&it
, amount_to_scroll
);
14723 /* Extra precision for users who set scroll-conservatively
14724 to a large number: make sure the amount we scroll
14725 the window start is never less than amount_to_scroll,
14726 which was computed as distance from window bottom to
14727 point. This matters when lines at window top and lines
14728 below window bottom have different height. */
14730 void *it1data
= NULL
;
14731 /* We use a temporary it1 because line_bottom_y can modify
14732 its argument, if it moves one line down; see there. */
14735 SAVE_IT (it1
, it
, it1data
);
14736 start_y
= line_bottom_y (&it1
);
14738 RESTORE_IT (&it
, &it
, it1data
);
14739 move_it_by_lines (&it
, 1);
14740 SAVE_IT (it1
, it
, it1data
);
14741 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14744 /* If STARTP is unchanged, move it down another screen line. */
14745 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14746 move_it_by_lines (&it
, 1);
14747 startp
= it
.current
.pos
;
14751 struct text_pos scroll_margin_pos
= startp
;
14753 /* See if point is inside the scroll margin at the top of the
14755 if (this_scroll_margin
)
14757 start_display (&it
, w
, startp
);
14758 move_it_vertically (&it
, this_scroll_margin
);
14759 scroll_margin_pos
= it
.current
.pos
;
14762 if (PT
< CHARPOS (scroll_margin_pos
))
14764 /* Point is in the scroll margin at the top of the window or
14765 above what is displayed in the window. */
14768 /* Compute the vertical distance from PT to the scroll
14769 margin position. Move as far as scroll_max allows, or
14770 one screenful, or 10 screen lines, whichever is largest.
14771 Give up if distance is greater than scroll_max. */
14772 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14773 start_display (&it
, w
, pos
);
14775 y_to_move
= max (it
.last_visible_y
,
14776 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14777 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14779 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14780 dy
= it
.current_y
- y0
;
14781 if (dy
> scroll_max
)
14782 return SCROLLING_FAILED
;
14784 /* Compute new window start. */
14785 start_display (&it
, w
, startp
);
14787 if (arg_scroll_conservatively
)
14788 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14789 max (scroll_step
, temp_scroll_step
));
14790 else if (scroll_step
|| temp_scroll_step
)
14791 amount_to_scroll
= scroll_max
;
14794 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14795 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14796 if (NUMBERP (aggressive
))
14798 double float_amount
= XFLOATINT (aggressive
) * height
;
14799 amount_to_scroll
= float_amount
;
14800 if (amount_to_scroll
== 0 && float_amount
> 0)
14801 amount_to_scroll
= 1;
14802 amount_to_scroll
-=
14803 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14804 /* Don't let point enter the scroll margin near
14805 bottom of the window. */
14806 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14807 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14811 if (amount_to_scroll
<= 0)
14812 return SCROLLING_FAILED
;
14814 move_it_vertically_backward (&it
, amount_to_scroll
);
14815 startp
= it
.current
.pos
;
14819 /* Run window scroll functions. */
14820 startp
= run_window_scroll_functions (window
, startp
);
14822 /* Display the window. Give up if new fonts are loaded, or if point
14824 if (!try_window (window
, startp
, 0))
14825 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14826 else if (w
->cursor
.vpos
< 0)
14828 clear_glyph_matrix (w
->desired_matrix
);
14829 rc
= SCROLLING_FAILED
;
14833 /* Maybe forget recorded base line for line number display. */
14834 if (!just_this_one_p
14835 || current_buffer
->clip_changed
14836 || BEG_UNCHANGED
< CHARPOS (startp
))
14837 w
->base_line_number
= Qnil
;
14839 /* If cursor ends up on a partially visible line,
14840 treat that as being off the bottom of the screen. */
14841 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14842 /* It's possible that the cursor is on the first line of the
14843 buffer, which is partially obscured due to a vscroll
14844 (Bug#7537). In that case, avoid looping forever . */
14845 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14847 clear_glyph_matrix (w
->desired_matrix
);
14848 ++extra_scroll_margin_lines
;
14851 rc
= SCROLLING_SUCCESS
;
14858 /* Compute a suitable window start for window W if display of W starts
14859 on a continuation line. Value is non-zero if a new window start
14862 The new window start will be computed, based on W's width, starting
14863 from the start of the continued line. It is the start of the
14864 screen line with the minimum distance from the old start W->start. */
14867 compute_window_start_on_continuation_line (struct window
*w
)
14869 struct text_pos pos
, start_pos
;
14870 int window_start_changed_p
= 0;
14872 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14874 /* If window start is on a continuation line... Window start may be
14875 < BEGV in case there's invisible text at the start of the
14876 buffer (M-x rmail, for example). */
14877 if (CHARPOS (start_pos
) > BEGV
14878 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14881 struct glyph_row
*row
;
14883 /* Handle the case that the window start is out of range. */
14884 if (CHARPOS (start_pos
) < BEGV
)
14885 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14886 else if (CHARPOS (start_pos
) > ZV
)
14887 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14889 /* Find the start of the continued line. This should be fast
14890 because scan_buffer is fast (newline cache). */
14891 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14892 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14893 row
, DEFAULT_FACE_ID
);
14894 reseat_at_previous_visible_line_start (&it
);
14896 /* If the line start is "too far" away from the window start,
14897 say it takes too much time to compute a new window start. */
14898 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14899 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14901 int min_distance
, distance
;
14903 /* Move forward by display lines to find the new window
14904 start. If window width was enlarged, the new start can
14905 be expected to be > the old start. If window width was
14906 decreased, the new window start will be < the old start.
14907 So, we're looking for the display line start with the
14908 minimum distance from the old window start. */
14909 pos
= it
.current
.pos
;
14910 min_distance
= INFINITY
;
14911 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14912 distance
< min_distance
)
14914 min_distance
= distance
;
14915 pos
= it
.current
.pos
;
14916 move_it_by_lines (&it
, 1);
14919 /* Set the window start there. */
14920 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14921 window_start_changed_p
= 1;
14925 return window_start_changed_p
;
14929 /* Try cursor movement in case text has not changed in window WINDOW,
14930 with window start STARTP. Value is
14932 CURSOR_MOVEMENT_SUCCESS if successful
14934 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14936 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14937 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14938 we want to scroll as if scroll-step were set to 1. See the code.
14940 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14941 which case we have to abort this redisplay, and adjust matrices
14946 CURSOR_MOVEMENT_SUCCESS
,
14947 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14948 CURSOR_MOVEMENT_MUST_SCROLL
,
14949 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14953 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14955 struct window
*w
= XWINDOW (window
);
14956 struct frame
*f
= XFRAME (w
->frame
);
14957 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14960 if (inhibit_try_cursor_movement
)
14964 /* Previously, there was a check for Lisp integer in the
14965 if-statement below. Now, this field is converted to
14966 ptrdiff_t, thus zero means invalid position in a buffer. */
14967 eassert (w
->last_point
> 0);
14969 /* Handle case where text has not changed, only point, and it has
14970 not moved off the frame. */
14971 if (/* Point may be in this window. */
14972 PT
>= CHARPOS (startp
)
14973 /* Selective display hasn't changed. */
14974 && !current_buffer
->clip_changed
14975 /* Function force-mode-line-update is used to force a thorough
14976 redisplay. It sets either windows_or_buffers_changed or
14977 update_mode_lines. So don't take a shortcut here for these
14979 && !update_mode_lines
14980 && !windows_or_buffers_changed
14981 && !cursor_type_changed
14982 /* Can't use this case if highlighting a region. When a
14983 region exists, cursor movement has to do more than just
14985 && !(!NILP (Vtransient_mark_mode
)
14986 && !NILP (BVAR (current_buffer
, mark_active
)))
14987 && NILP (w
->region_showing
)
14988 && NILP (Vshow_trailing_whitespace
)
14989 /* This code is not used for mini-buffer for the sake of the case
14990 of redisplaying to replace an echo area message; since in
14991 that case the mini-buffer contents per se are usually
14992 unchanged. This code is of no real use in the mini-buffer
14993 since the handling of this_line_start_pos, etc., in redisplay
14994 handles the same cases. */
14995 && !EQ (window
, minibuf_window
)
14996 /* When splitting windows or for new windows, it happens that
14997 redisplay is called with a nil window_end_vpos or one being
14998 larger than the window. This should really be fixed in
14999 window.c. I don't have this on my list, now, so we do
15000 approximately the same as the old redisplay code. --gerd. */
15001 && INTEGERP (w
->window_end_vpos
)
15002 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15003 && (FRAME_WINDOW_P (f
)
15004 || !overlay_arrow_in_current_buffer_p ()))
15006 int this_scroll_margin
, top_scroll_margin
;
15007 struct glyph_row
*row
= NULL
;
15010 debug_method_add (w
, "cursor movement");
15013 /* Scroll if point within this distance from the top or bottom
15014 of the window. This is a pixel value. */
15015 if (scroll_margin
> 0)
15017 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15018 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15021 this_scroll_margin
= 0;
15023 top_scroll_margin
= this_scroll_margin
;
15024 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15025 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15027 /* Start with the row the cursor was displayed during the last
15028 not paused redisplay. Give up if that row is not valid. */
15029 if (w
->last_cursor
.vpos
< 0
15030 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15031 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15034 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15035 if (row
->mode_line_p
)
15037 if (!row
->enabled_p
)
15038 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15041 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15043 int scroll_p
= 0, must_scroll
= 0;
15044 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15046 if (PT
> w
->last_point
)
15048 /* Point has moved forward. */
15049 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15050 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15052 eassert (row
->enabled_p
);
15056 /* If the end position of a row equals the start
15057 position of the next row, and PT is at that position,
15058 we would rather display cursor in the next line. */
15059 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15060 && MATRIX_ROW_END_CHARPOS (row
) == PT
15061 && row
< w
->current_matrix
->rows
15062 + w
->current_matrix
->nrows
- 1
15063 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15064 && !cursor_row_p (row
))
15067 /* If within the scroll margin, scroll. Note that
15068 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15069 the next line would be drawn, and that
15070 this_scroll_margin can be zero. */
15071 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15072 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15073 /* Line is completely visible last line in window
15074 and PT is to be set in the next line. */
15075 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15076 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15077 && !row
->ends_at_zv_p
15078 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15081 else if (PT
< w
->last_point
)
15083 /* Cursor has to be moved backward. Note that PT >=
15084 CHARPOS (startp) because of the outer if-statement. */
15085 while (!row
->mode_line_p
15086 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15087 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15088 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15089 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15090 row
> w
->current_matrix
->rows
15091 && (row
-1)->ends_in_newline_from_string_p
))))
15092 && (row
->y
> top_scroll_margin
15093 || CHARPOS (startp
) == BEGV
))
15095 eassert (row
->enabled_p
);
15099 /* Consider the following case: Window starts at BEGV,
15100 there is invisible, intangible text at BEGV, so that
15101 display starts at some point START > BEGV. It can
15102 happen that we are called with PT somewhere between
15103 BEGV and START. Try to handle that case. */
15104 if (row
< w
->current_matrix
->rows
15105 || row
->mode_line_p
)
15107 row
= w
->current_matrix
->rows
;
15108 if (row
->mode_line_p
)
15112 /* Due to newlines in overlay strings, we may have to
15113 skip forward over overlay strings. */
15114 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15115 && MATRIX_ROW_END_CHARPOS (row
) == PT
15116 && !cursor_row_p (row
))
15119 /* If within the scroll margin, scroll. */
15120 if (row
->y
< top_scroll_margin
15121 && CHARPOS (startp
) != BEGV
)
15126 /* Cursor did not move. So don't scroll even if cursor line
15127 is partially visible, as it was so before. */
15128 rc
= CURSOR_MOVEMENT_SUCCESS
;
15131 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15132 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15134 /* if PT is not in the glyph row, give up. */
15135 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15138 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15139 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15141 struct glyph_row
*row1
;
15143 /* If rows are bidi-reordered and point moved, back up
15144 until we find a row that does not belong to a
15145 continuation line. This is because we must consider
15146 all rows of a continued line as candidates for the
15147 new cursor positioning, since row start and end
15148 positions change non-linearly with vertical position
15150 /* FIXME: Revisit this when glyph ``spilling'' in
15151 continuation lines' rows is implemented for
15152 bidi-reordered rows. */
15153 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15154 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15157 /* If we hit the beginning of the displayed portion
15158 without finding the first row of a continued
15162 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15165 eassert (row
->enabled_p
);
15170 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15171 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15172 /* Make sure this isn't a header line by any chance, since
15173 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15174 && !row
->mode_line_p
15175 && make_cursor_line_fully_visible_p
)
15177 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15178 && !row
->ends_at_zv_p
15179 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15180 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15181 else if (row
->height
> window_box_height (w
))
15183 /* If we end up in a partially visible line, let's
15184 make it fully visible, except when it's taller
15185 than the window, in which case we can't do much
15188 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15192 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15193 if (!cursor_row_fully_visible_p (w
, 0, 1))
15194 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15196 rc
= CURSOR_MOVEMENT_SUCCESS
;
15200 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15201 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15202 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15204 /* With bidi-reordered rows, there could be more than
15205 one candidate row whose start and end positions
15206 occlude point. We need to let set_cursor_from_row
15207 find the best candidate. */
15208 /* FIXME: Revisit this when glyph ``spilling'' in
15209 continuation lines' rows is implemented for
15210 bidi-reordered rows. */
15215 int at_zv_p
= 0, exact_match_p
= 0;
15217 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15218 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15219 && cursor_row_p (row
))
15220 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15222 /* As soon as we've found the exact match for point,
15223 or the first suitable row whose ends_at_zv_p flag
15224 is set, we are done. */
15226 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15228 && w
->cursor
.hpos
>= 0
15229 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15232 struct glyph_row
*candidate
=
15233 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15235 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15236 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15239 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15240 || (INTEGERP (g
->object
)
15241 && (g
->charpos
== PT
15242 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15244 if (rv
&& (at_zv_p
|| exact_match_p
))
15246 rc
= CURSOR_MOVEMENT_SUCCESS
;
15249 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15253 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15254 || row
->continued_p
)
15255 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15256 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15257 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15258 /* If we didn't find any candidate rows, or exited the
15259 loop before all the candidates were examined, signal
15260 to the caller that this method failed. */
15261 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15263 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15264 && !row
->continued_p
))
15265 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15267 rc
= CURSOR_MOVEMENT_SUCCESS
;
15273 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15275 rc
= CURSOR_MOVEMENT_SUCCESS
;
15280 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15281 && MATRIX_ROW_START_CHARPOS (row
) == PT
15282 && cursor_row_p (row
));
15290 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15294 set_vertical_scroll_bar (struct window
*w
)
15296 ptrdiff_t start
, end
, whole
;
15298 /* Calculate the start and end positions for the current window.
15299 At some point, it would be nice to choose between scrollbars
15300 which reflect the whole buffer size, with special markers
15301 indicating narrowing, and scrollbars which reflect only the
15304 Note that mini-buffers sometimes aren't displaying any text. */
15305 if (!MINI_WINDOW_P (w
)
15306 || (w
== XWINDOW (minibuf_window
)
15307 && NILP (echo_area_buffer
[0])))
15309 struct buffer
*buf
= XBUFFER (w
->buffer
);
15310 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15311 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15312 /* I don't think this is guaranteed to be right. For the
15313 moment, we'll pretend it is. */
15314 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15318 if (whole
< (end
- start
))
15319 whole
= end
- start
;
15322 start
= end
= whole
= 0;
15324 /* Indicate what this scroll bar ought to be displaying now. */
15325 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15326 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15327 (w
, end
- start
, whole
, start
);
15331 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15332 selected_window is redisplayed.
15334 We can return without actually redisplaying the window if
15335 fonts_changed_p is nonzero. In that case, redisplay_internal will
15339 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15341 struct window
*w
= XWINDOW (window
);
15342 struct frame
*f
= XFRAME (w
->frame
);
15343 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15344 struct buffer
*old
= current_buffer
;
15345 struct text_pos lpoint
, opoint
, startp
;
15346 int update_mode_line
;
15349 /* Record it now because it's overwritten. */
15350 int current_matrix_up_to_date_p
= 0;
15351 int used_current_matrix_p
= 0;
15352 /* This is less strict than current_matrix_up_to_date_p.
15353 It indicates that the buffer contents and narrowing are unchanged. */
15354 int buffer_unchanged_p
= 0;
15355 int temp_scroll_step
= 0;
15356 ptrdiff_t count
= SPECPDL_INDEX ();
15358 int centering_position
= -1;
15359 int last_line_misfit
= 0;
15360 ptrdiff_t beg_unchanged
, end_unchanged
;
15362 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15365 /* W must be a leaf window here. */
15366 eassert (!NILP (w
->buffer
));
15368 *w
->desired_matrix
->method
= 0;
15372 reconsider_clip_changes (w
, buffer
);
15374 /* Has the mode line to be updated? */
15375 update_mode_line
= (w
->update_mode_line
15376 || update_mode_lines
15377 || buffer
->clip_changed
15378 || buffer
->prevent_redisplay_optimizations_p
);
15380 if (MINI_WINDOW_P (w
))
15382 if (w
== XWINDOW (echo_area_window
)
15383 && !NILP (echo_area_buffer
[0]))
15385 if (update_mode_line
)
15386 /* We may have to update a tty frame's menu bar or a
15387 tool-bar. Example `M-x C-h C-h C-g'. */
15388 goto finish_menu_bars
;
15390 /* We've already displayed the echo area glyphs in this window. */
15391 goto finish_scroll_bars
;
15393 else if ((w
!= XWINDOW (minibuf_window
)
15394 || minibuf_level
== 0)
15395 /* When buffer is nonempty, redisplay window normally. */
15396 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15397 /* Quail displays non-mini buffers in minibuffer window.
15398 In that case, redisplay the window normally. */
15399 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15401 /* W is a mini-buffer window, but it's not active, so clear
15403 int yb
= window_text_bottom_y (w
);
15404 struct glyph_row
*row
;
15407 for (y
= 0, row
= w
->desired_matrix
->rows
;
15409 y
+= row
->height
, ++row
)
15410 blank_row (w
, row
, y
);
15411 goto finish_scroll_bars
;
15414 clear_glyph_matrix (w
->desired_matrix
);
15417 /* Otherwise set up data on this window; select its buffer and point
15419 /* Really select the buffer, for the sake of buffer-local
15421 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15423 current_matrix_up_to_date_p
15424 = (!NILP (w
->window_end_valid
)
15425 && !current_buffer
->clip_changed
15426 && !current_buffer
->prevent_redisplay_optimizations_p
15427 && w
->last_modified
>= MODIFF
15428 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15430 /* Run the window-bottom-change-functions
15431 if it is possible that the text on the screen has changed
15432 (either due to modification of the text, or any other reason). */
15433 if (!current_matrix_up_to_date_p
15434 && !NILP (Vwindow_text_change_functions
))
15436 safe_run_hooks (Qwindow_text_change_functions
);
15440 beg_unchanged
= BEG_UNCHANGED
;
15441 end_unchanged
= END_UNCHANGED
;
15443 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15445 specbind (Qinhibit_point_motion_hooks
, Qt
);
15448 = (!NILP (w
->window_end_valid
)
15449 && !current_buffer
->clip_changed
15450 && w
->last_modified
>= MODIFF
15451 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15453 /* When windows_or_buffers_changed is non-zero, we can't rely on
15454 the window end being valid, so set it to nil there. */
15455 if (windows_or_buffers_changed
)
15457 /* If window starts on a continuation line, maybe adjust the
15458 window start in case the window's width changed. */
15459 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15460 compute_window_start_on_continuation_line (w
);
15462 w
->window_end_valid
= Qnil
;
15465 /* Some sanity checks. */
15466 CHECK_WINDOW_END (w
);
15467 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15469 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15472 /* If %c is in mode line, update it if needed. */
15473 if (!NILP (w
->column_number_displayed
)
15474 /* This alternative quickly identifies a common case
15475 where no change is needed. */
15476 && !(PT
== w
->last_point
15477 && w
->last_modified
>= MODIFF
15478 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15479 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15480 update_mode_line
= 1;
15482 /* Count number of windows showing the selected buffer. An indirect
15483 buffer counts as its base buffer. */
15484 if (!just_this_one_p
)
15486 struct buffer
*current_base
, *window_base
;
15487 current_base
= current_buffer
;
15488 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15489 if (current_base
->base_buffer
)
15490 current_base
= current_base
->base_buffer
;
15491 if (window_base
->base_buffer
)
15492 window_base
= window_base
->base_buffer
;
15493 if (current_base
== window_base
)
15497 /* Point refers normally to the selected window. For any other
15498 window, set up appropriate value. */
15499 if (!EQ (window
, selected_window
))
15501 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15502 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15506 new_pt_byte
= BEGV_BYTE
;
15507 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15509 else if (new_pt
> (ZV
- 1))
15512 new_pt_byte
= ZV_BYTE
;
15513 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15516 /* We don't use SET_PT so that the point-motion hooks don't run. */
15517 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15520 /* If any of the character widths specified in the display table
15521 have changed, invalidate the width run cache. It's true that
15522 this may be a bit late to catch such changes, but the rest of
15523 redisplay goes (non-fatally) haywire when the display table is
15524 changed, so why should we worry about doing any better? */
15525 if (current_buffer
->width_run_cache
)
15527 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15529 if (! disptab_matches_widthtab (disptab
,
15530 XVECTOR (BVAR (current_buffer
, width_table
))))
15532 invalidate_region_cache (current_buffer
,
15533 current_buffer
->width_run_cache
,
15535 recompute_width_table (current_buffer
, disptab
);
15539 /* If window-start is screwed up, choose a new one. */
15540 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15543 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15545 /* If someone specified a new starting point but did not insist,
15546 check whether it can be used. */
15547 if (w
->optional_new_start
15548 && CHARPOS (startp
) >= BEGV
15549 && CHARPOS (startp
) <= ZV
)
15551 w
->optional_new_start
= 0;
15552 start_display (&it
, w
, startp
);
15553 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15554 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15555 if (IT_CHARPOS (it
) == PT
)
15556 w
->force_start
= 1;
15557 /* IT may overshoot PT if text at PT is invisible. */
15558 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15559 w
->force_start
= 1;
15564 /* Handle case where place to start displaying has been specified,
15565 unless the specified location is outside the accessible range. */
15566 if (w
->force_start
|| w
->frozen_window_start_p
)
15568 /* We set this later on if we have to adjust point. */
15571 w
->force_start
= 0;
15573 w
->window_end_valid
= Qnil
;
15575 /* Forget any recorded base line for line number display. */
15576 if (!buffer_unchanged_p
)
15577 w
->base_line_number
= Qnil
;
15579 /* Redisplay the mode line. Select the buffer properly for that.
15580 Also, run the hook window-scroll-functions
15581 because we have scrolled. */
15582 /* Note, we do this after clearing force_start because
15583 if there's an error, it is better to forget about force_start
15584 than to get into an infinite loop calling the hook functions
15585 and having them get more errors. */
15586 if (!update_mode_line
15587 || ! NILP (Vwindow_scroll_functions
))
15589 update_mode_line
= 1;
15590 w
->update_mode_line
= 1;
15591 startp
= run_window_scroll_functions (window
, startp
);
15594 w
->last_modified
= 0;
15595 w
->last_overlay_modified
= 0;
15596 if (CHARPOS (startp
) < BEGV
)
15597 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15598 else if (CHARPOS (startp
) > ZV
)
15599 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15601 /* Redisplay, then check if cursor has been set during the
15602 redisplay. Give up if new fonts were loaded. */
15603 /* We used to issue a CHECK_MARGINS argument to try_window here,
15604 but this causes scrolling to fail when point begins inside
15605 the scroll margin (bug#148) -- cyd */
15606 if (!try_window (window
, startp
, 0))
15608 w
->force_start
= 1;
15609 clear_glyph_matrix (w
->desired_matrix
);
15610 goto need_larger_matrices
;
15613 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15615 /* If point does not appear, try to move point so it does
15616 appear. The desired matrix has been built above, so we
15617 can use it here. */
15618 new_vpos
= window_box_height (w
) / 2;
15621 if (!cursor_row_fully_visible_p (w
, 0, 0))
15623 /* Point does appear, but on a line partly visible at end of window.
15624 Move it back to a fully-visible line. */
15625 new_vpos
= window_box_height (w
);
15628 /* If we need to move point for either of the above reasons,
15629 now actually do it. */
15632 struct glyph_row
*row
;
15634 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15635 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15638 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15639 MATRIX_ROW_START_BYTEPOS (row
));
15641 if (w
!= XWINDOW (selected_window
))
15642 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15643 else if (current_buffer
== old
)
15644 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15646 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15648 /* If we are highlighting the region, then we just changed
15649 the region, so redisplay to show it. */
15650 if (!NILP (Vtransient_mark_mode
)
15651 && !NILP (BVAR (current_buffer
, mark_active
)))
15653 clear_glyph_matrix (w
->desired_matrix
);
15654 if (!try_window (window
, startp
, 0))
15655 goto need_larger_matrices
;
15660 debug_method_add (w
, "forced window start");
15665 /* Handle case where text has not changed, only point, and it has
15666 not moved off the frame, and we are not retrying after hscroll.
15667 (current_matrix_up_to_date_p is nonzero when retrying.) */
15668 if (current_matrix_up_to_date_p
15669 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15670 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15674 case CURSOR_MOVEMENT_SUCCESS
:
15675 used_current_matrix_p
= 1;
15678 case CURSOR_MOVEMENT_MUST_SCROLL
:
15679 goto try_to_scroll
;
15685 /* If current starting point was originally the beginning of a line
15686 but no longer is, find a new starting point. */
15687 else if (w
->start_at_line_beg
15688 && !(CHARPOS (startp
) <= BEGV
15689 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15692 debug_method_add (w
, "recenter 1");
15697 /* Try scrolling with try_window_id. Value is > 0 if update has
15698 been done, it is -1 if we know that the same window start will
15699 not work. It is 0 if unsuccessful for some other reason. */
15700 else if ((tem
= try_window_id (w
)) != 0)
15703 debug_method_add (w
, "try_window_id %d", tem
);
15706 if (fonts_changed_p
)
15707 goto need_larger_matrices
;
15711 /* Otherwise try_window_id has returned -1 which means that we
15712 don't want the alternative below this comment to execute. */
15714 else if (CHARPOS (startp
) >= BEGV
15715 && CHARPOS (startp
) <= ZV
15716 && PT
>= CHARPOS (startp
)
15717 && (CHARPOS (startp
) < ZV
15718 /* Avoid starting at end of buffer. */
15719 || CHARPOS (startp
) == BEGV
15720 || (w
->last_modified
>= MODIFF
15721 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15723 int d1
, d2
, d3
, d4
, d5
, d6
;
15725 /* If first window line is a continuation line, and window start
15726 is inside the modified region, but the first change is before
15727 current window start, we must select a new window start.
15729 However, if this is the result of a down-mouse event (e.g. by
15730 extending the mouse-drag-overlay), we don't want to select a
15731 new window start, since that would change the position under
15732 the mouse, resulting in an unwanted mouse-movement rather
15733 than a simple mouse-click. */
15734 if (!w
->start_at_line_beg
15735 && NILP (do_mouse_tracking
)
15736 && CHARPOS (startp
) > BEGV
15737 && CHARPOS (startp
) > BEG
+ beg_unchanged
15738 && CHARPOS (startp
) <= Z
- end_unchanged
15739 /* Even if w->start_at_line_beg is nil, a new window may
15740 start at a line_beg, since that's how set_buffer_window
15741 sets it. So, we need to check the return value of
15742 compute_window_start_on_continuation_line. (See also
15744 && XMARKER (w
->start
)->buffer
== current_buffer
15745 && compute_window_start_on_continuation_line (w
)
15746 /* It doesn't make sense to force the window start like we
15747 do at label force_start if it is already known that point
15748 will not be visible in the resulting window, because
15749 doing so will move point from its correct position
15750 instead of scrolling the window to bring point into view.
15752 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15754 w
->force_start
= 1;
15755 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15760 debug_method_add (w
, "same window start");
15763 /* Try to redisplay starting at same place as before.
15764 If point has not moved off frame, accept the results. */
15765 if (!current_matrix_up_to_date_p
15766 /* Don't use try_window_reusing_current_matrix in this case
15767 because a window scroll function can have changed the
15769 || !NILP (Vwindow_scroll_functions
)
15770 || MINI_WINDOW_P (w
)
15771 || !(used_current_matrix_p
15772 = try_window_reusing_current_matrix (w
)))
15774 IF_DEBUG (debug_method_add (w
, "1"));
15775 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15776 /* -1 means we need to scroll.
15777 0 means we need new matrices, but fonts_changed_p
15778 is set in that case, so we will detect it below. */
15779 goto try_to_scroll
;
15782 if (fonts_changed_p
)
15783 goto need_larger_matrices
;
15785 if (w
->cursor
.vpos
>= 0)
15787 if (!just_this_one_p
15788 || current_buffer
->clip_changed
15789 || BEG_UNCHANGED
< CHARPOS (startp
))
15790 /* Forget any recorded base line for line number display. */
15791 w
->base_line_number
= Qnil
;
15793 if (!cursor_row_fully_visible_p (w
, 1, 0))
15795 clear_glyph_matrix (w
->desired_matrix
);
15796 last_line_misfit
= 1;
15798 /* Drop through and scroll. */
15803 clear_glyph_matrix (w
->desired_matrix
);
15808 w
->last_modified
= 0;
15809 w
->last_overlay_modified
= 0;
15811 /* Redisplay the mode line. Select the buffer properly for that. */
15812 if (!update_mode_line
)
15814 update_mode_line
= 1;
15815 w
->update_mode_line
= 1;
15818 /* Try to scroll by specified few lines. */
15819 if ((scroll_conservatively
15820 || emacs_scroll_step
15821 || temp_scroll_step
15822 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15823 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15824 && CHARPOS (startp
) >= BEGV
15825 && CHARPOS (startp
) <= ZV
)
15827 /* The function returns -1 if new fonts were loaded, 1 if
15828 successful, 0 if not successful. */
15829 int ss
= try_scrolling (window
, just_this_one_p
,
15830 scroll_conservatively
,
15832 temp_scroll_step
, last_line_misfit
);
15835 case SCROLLING_SUCCESS
:
15838 case SCROLLING_NEED_LARGER_MATRICES
:
15839 goto need_larger_matrices
;
15841 case SCROLLING_FAILED
:
15849 /* Finally, just choose a place to start which positions point
15850 according to user preferences. */
15855 debug_method_add (w
, "recenter");
15858 /* w->vscroll = 0; */
15860 /* Forget any previously recorded base line for line number display. */
15861 if (!buffer_unchanged_p
)
15862 w
->base_line_number
= Qnil
;
15864 /* Determine the window start relative to point. */
15865 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15866 it
.current_y
= it
.last_visible_y
;
15867 if (centering_position
< 0)
15871 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15873 ptrdiff_t margin_pos
= CHARPOS (startp
);
15874 Lisp_Object aggressive
;
15877 /* If there is a scroll margin at the top of the window, find
15878 its character position. */
15880 /* Cannot call start_display if startp is not in the
15881 accessible region of the buffer. This can happen when we
15882 have just switched to a different buffer and/or changed
15883 its restriction. In that case, startp is initialized to
15884 the character position 1 (BEGV) because we did not yet
15885 have chance to display the buffer even once. */
15886 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15889 void *it1data
= NULL
;
15891 SAVE_IT (it1
, it
, it1data
);
15892 start_display (&it1
, w
, startp
);
15893 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15894 margin_pos
= IT_CHARPOS (it1
);
15895 RESTORE_IT (&it
, &it
, it1data
);
15897 scrolling_up
= PT
> margin_pos
;
15900 ? BVAR (current_buffer
, scroll_up_aggressively
)
15901 : BVAR (current_buffer
, scroll_down_aggressively
);
15903 if (!MINI_WINDOW_P (w
)
15904 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15908 /* Setting scroll-conservatively overrides
15909 scroll-*-aggressively. */
15910 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15912 double float_amount
= XFLOATINT (aggressive
);
15914 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15915 if (pt_offset
== 0 && float_amount
> 0)
15917 if (pt_offset
&& margin
> 0)
15920 /* Compute how much to move the window start backward from
15921 point so that point will be displayed where the user
15925 centering_position
= it
.last_visible_y
;
15927 centering_position
-= pt_offset
;
15928 centering_position
-=
15929 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15930 + WINDOW_HEADER_LINE_HEIGHT (w
);
15931 /* Don't let point enter the scroll margin near top of
15933 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15934 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15937 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15940 /* Set the window start half the height of the window backward
15942 centering_position
= window_box_height (w
) / 2;
15944 move_it_vertically_backward (&it
, centering_position
);
15946 eassert (IT_CHARPOS (it
) >= BEGV
);
15948 /* The function move_it_vertically_backward may move over more
15949 than the specified y-distance. If it->w is small, e.g. a
15950 mini-buffer window, we may end up in front of the window's
15951 display area. Start displaying at the start of the line
15952 containing PT in this case. */
15953 if (it
.current_y
<= 0)
15955 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15956 move_it_vertically_backward (&it
, 0);
15960 it
.current_x
= it
.hpos
= 0;
15962 /* Set the window start position here explicitly, to avoid an
15963 infinite loop in case the functions in window-scroll-functions
15965 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15967 /* Run scroll hooks. */
15968 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15970 /* Redisplay the window. */
15971 if (!current_matrix_up_to_date_p
15972 || windows_or_buffers_changed
15973 || cursor_type_changed
15974 /* Don't use try_window_reusing_current_matrix in this case
15975 because it can have changed the buffer. */
15976 || !NILP (Vwindow_scroll_functions
)
15977 || !just_this_one_p
15978 || MINI_WINDOW_P (w
)
15979 || !(used_current_matrix_p
15980 = try_window_reusing_current_matrix (w
)))
15981 try_window (window
, startp
, 0);
15983 /* If new fonts have been loaded (due to fontsets), give up. We
15984 have to start a new redisplay since we need to re-adjust glyph
15986 if (fonts_changed_p
)
15987 goto need_larger_matrices
;
15989 /* If cursor did not appear assume that the middle of the window is
15990 in the first line of the window. Do it again with the next line.
15991 (Imagine a window of height 100, displaying two lines of height
15992 60. Moving back 50 from it->last_visible_y will end in the first
15994 if (w
->cursor
.vpos
< 0)
15996 if (!NILP (w
->window_end_valid
)
15997 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15999 clear_glyph_matrix (w
->desired_matrix
);
16000 move_it_by_lines (&it
, 1);
16001 try_window (window
, it
.current
.pos
, 0);
16003 else if (PT
< IT_CHARPOS (it
))
16005 clear_glyph_matrix (w
->desired_matrix
);
16006 move_it_by_lines (&it
, -1);
16007 try_window (window
, it
.current
.pos
, 0);
16011 /* Not much we can do about it. */
16015 /* Consider the following case: Window starts at BEGV, there is
16016 invisible, intangible text at BEGV, so that display starts at
16017 some point START > BEGV. It can happen that we are called with
16018 PT somewhere between BEGV and START. Try to handle that case. */
16019 if (w
->cursor
.vpos
< 0)
16021 struct glyph_row
*row
= w
->current_matrix
->rows
;
16022 if (row
->mode_line_p
)
16024 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16027 if (!cursor_row_fully_visible_p (w
, 0, 0))
16029 /* If vscroll is enabled, disable it and try again. */
16033 clear_glyph_matrix (w
->desired_matrix
);
16037 /* Users who set scroll-conservatively to a large number want
16038 point just above/below the scroll margin. If we ended up
16039 with point's row partially visible, move the window start to
16040 make that row fully visible and out of the margin. */
16041 if (scroll_conservatively
> SCROLL_LIMIT
)
16045 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16047 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16049 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16050 clear_glyph_matrix (w
->desired_matrix
);
16051 if (1 == try_window (window
, it
.current
.pos
,
16052 TRY_WINDOW_CHECK_MARGINS
))
16056 /* If centering point failed to make the whole line visible,
16057 put point at the top instead. That has to make the whole line
16058 visible, if it can be done. */
16059 if (centering_position
== 0)
16062 clear_glyph_matrix (w
->desired_matrix
);
16063 centering_position
= 0;
16069 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16070 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16071 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16073 /* Display the mode line, if we must. */
16074 if ((update_mode_line
16075 /* If window not full width, must redo its mode line
16076 if (a) the window to its side is being redone and
16077 (b) we do a frame-based redisplay. This is a consequence
16078 of how inverted lines are drawn in frame-based redisplay. */
16079 || (!just_this_one_p
16080 && !FRAME_WINDOW_P (f
)
16081 && !WINDOW_FULL_WIDTH_P (w
))
16082 /* Line number to display. */
16083 || INTEGERP (w
->base_line_pos
)
16084 /* Column number is displayed and different from the one displayed. */
16085 || (!NILP (w
->column_number_displayed
)
16086 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16087 /* This means that the window has a mode line. */
16088 && (WINDOW_WANTS_MODELINE_P (w
)
16089 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16091 display_mode_lines (w
);
16093 /* If mode line height has changed, arrange for a thorough
16094 immediate redisplay using the correct mode line height. */
16095 if (WINDOW_WANTS_MODELINE_P (w
)
16096 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16098 fonts_changed_p
= 1;
16099 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16100 = DESIRED_MODE_LINE_HEIGHT (w
);
16103 /* If header line height has changed, arrange for a thorough
16104 immediate redisplay using the correct header line height. */
16105 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16106 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16108 fonts_changed_p
= 1;
16109 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16110 = DESIRED_HEADER_LINE_HEIGHT (w
);
16113 if (fonts_changed_p
)
16114 goto need_larger_matrices
;
16117 if (!line_number_displayed
16118 && !BUFFERP (w
->base_line_pos
))
16120 w
->base_line_pos
= Qnil
;
16121 w
->base_line_number
= Qnil
;
16126 /* When we reach a frame's selected window, redo the frame's menu bar. */
16127 if (update_mode_line
16128 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16130 int redisplay_menu_p
= 0;
16132 if (FRAME_WINDOW_P (f
))
16134 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16135 || defined (HAVE_NS) || defined (USE_GTK)
16136 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16138 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16142 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16144 if (redisplay_menu_p
)
16145 display_menu_bar (w
);
16147 #ifdef HAVE_WINDOW_SYSTEM
16148 if (FRAME_WINDOW_P (f
))
16150 #if defined (USE_GTK) || defined (HAVE_NS)
16151 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16152 redisplay_tool_bar (f
);
16154 if (WINDOWP (f
->tool_bar_window
)
16155 && (FRAME_TOOL_BAR_LINES (f
) > 0
16156 || !NILP (Vauto_resize_tool_bars
))
16157 && redisplay_tool_bar (f
))
16158 ignore_mouse_drag_p
= 1;
16164 #ifdef HAVE_WINDOW_SYSTEM
16165 if (FRAME_WINDOW_P (f
)
16166 && update_window_fringes (w
, (just_this_one_p
16167 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16168 || w
->pseudo_window_p
)))
16172 if (draw_window_fringes (w
, 1))
16173 x_draw_vertical_border (w
);
16177 #endif /* HAVE_WINDOW_SYSTEM */
16179 /* We go to this label, with fonts_changed_p nonzero,
16180 if it is necessary to try again using larger glyph matrices.
16181 We have to redeem the scroll bar even in this case,
16182 because the loop in redisplay_internal expects that. */
16183 need_larger_matrices
:
16185 finish_scroll_bars
:
16187 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16189 /* Set the thumb's position and size. */
16190 set_vertical_scroll_bar (w
);
16192 /* Note that we actually used the scroll bar attached to this
16193 window, so it shouldn't be deleted at the end of redisplay. */
16194 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16195 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16198 /* Restore current_buffer and value of point in it. The window
16199 update may have changed the buffer, so first make sure `opoint'
16200 is still valid (Bug#6177). */
16201 if (CHARPOS (opoint
) < BEGV
)
16202 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16203 else if (CHARPOS (opoint
) > ZV
)
16204 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16206 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16208 set_buffer_internal_1 (old
);
16209 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16210 shorter. This can be caused by log truncation in *Messages*. */
16211 if (CHARPOS (lpoint
) <= ZV
)
16212 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16214 unbind_to (count
, Qnil
);
16218 /* Build the complete desired matrix of WINDOW with a window start
16219 buffer position POS.
16221 Value is 1 if successful. It is zero if fonts were loaded during
16222 redisplay which makes re-adjusting glyph matrices necessary, and -1
16223 if point would appear in the scroll margins.
16224 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16225 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16229 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16231 struct window
*w
= XWINDOW (window
);
16233 struct glyph_row
*last_text_row
= NULL
;
16234 struct frame
*f
= XFRAME (w
->frame
);
16236 /* Make POS the new window start. */
16237 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16239 /* Mark cursor position as unknown. No overlay arrow seen. */
16240 w
->cursor
.vpos
= -1;
16241 overlay_arrow_seen
= 0;
16243 /* Initialize iterator and info to start at POS. */
16244 start_display (&it
, w
, pos
);
16246 /* Display all lines of W. */
16247 while (it
.current_y
< it
.last_visible_y
)
16249 if (display_line (&it
))
16250 last_text_row
= it
.glyph_row
- 1;
16251 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16255 /* Don't let the cursor end in the scroll margins. */
16256 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16257 && !MINI_WINDOW_P (w
))
16259 int this_scroll_margin
;
16261 if (scroll_margin
> 0)
16263 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16264 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16267 this_scroll_margin
= 0;
16269 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16270 && w
->cursor
.y
< this_scroll_margin
16271 && CHARPOS (pos
) > BEGV
16272 && IT_CHARPOS (it
) < ZV
)
16273 /* rms: considering make_cursor_line_fully_visible_p here
16274 seems to give wrong results. We don't want to recenter
16275 when the last line is partly visible, we want to allow
16276 that case to be handled in the usual way. */
16277 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16279 w
->cursor
.vpos
= -1;
16280 clear_glyph_matrix (w
->desired_matrix
);
16285 /* If bottom moved off end of frame, change mode line percentage. */
16286 if (XFASTINT (w
->window_end_pos
) <= 0
16287 && Z
!= IT_CHARPOS (it
))
16288 w
->update_mode_line
= 1;
16290 /* Set window_end_pos to the offset of the last character displayed
16291 on the window from the end of current_buffer. Set
16292 window_end_vpos to its row number. */
16295 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16296 w
->window_end_bytepos
16297 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16299 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16301 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16302 eassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16303 ->displays_text_p
);
16307 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16308 w
->window_end_pos
= make_number (Z
- ZV
);
16309 w
->window_end_vpos
= make_number (0);
16312 /* But that is not valid info until redisplay finishes. */
16313 w
->window_end_valid
= Qnil
;
16319 /************************************************************************
16320 Window redisplay reusing current matrix when buffer has not changed
16321 ************************************************************************/
16323 /* Try redisplay of window W showing an unchanged buffer with a
16324 different window start than the last time it was displayed by
16325 reusing its current matrix. Value is non-zero if successful.
16326 W->start is the new window start. */
16329 try_window_reusing_current_matrix (struct window
*w
)
16331 struct frame
*f
= XFRAME (w
->frame
);
16332 struct glyph_row
*bottom_row
;
16335 struct text_pos start
, new_start
;
16336 int nrows_scrolled
, i
;
16337 struct glyph_row
*last_text_row
;
16338 struct glyph_row
*last_reused_text_row
;
16339 struct glyph_row
*start_row
;
16340 int start_vpos
, min_y
, max_y
;
16343 if (inhibit_try_window_reusing
)
16347 if (/* This function doesn't handle terminal frames. */
16348 !FRAME_WINDOW_P (f
)
16349 /* Don't try to reuse the display if windows have been split
16351 || windows_or_buffers_changed
16352 || cursor_type_changed
)
16355 /* Can't do this if region may have changed. */
16356 if ((!NILP (Vtransient_mark_mode
)
16357 && !NILP (BVAR (current_buffer
, mark_active
)))
16358 || !NILP (w
->region_showing
)
16359 || !NILP (Vshow_trailing_whitespace
))
16362 /* If top-line visibility has changed, give up. */
16363 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16364 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16367 /* Give up if old or new display is scrolled vertically. We could
16368 make this function handle this, but right now it doesn't. */
16369 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16370 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16373 /* The variable new_start now holds the new window start. The old
16374 start `start' can be determined from the current matrix. */
16375 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16376 start
= start_row
->minpos
;
16377 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16379 /* Clear the desired matrix for the display below. */
16380 clear_glyph_matrix (w
->desired_matrix
);
16382 if (CHARPOS (new_start
) <= CHARPOS (start
))
16384 /* Don't use this method if the display starts with an ellipsis
16385 displayed for invisible text. It's not easy to handle that case
16386 below, and it's certainly not worth the effort since this is
16387 not a frequent case. */
16388 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16391 IF_DEBUG (debug_method_add (w
, "twu1"));
16393 /* Display up to a row that can be reused. The variable
16394 last_text_row is set to the last row displayed that displays
16395 text. Note that it.vpos == 0 if or if not there is a
16396 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16397 start_display (&it
, w
, new_start
);
16398 w
->cursor
.vpos
= -1;
16399 last_text_row
= last_reused_text_row
= NULL
;
16401 while (it
.current_y
< it
.last_visible_y
16402 && !fonts_changed_p
)
16404 /* If we have reached into the characters in the START row,
16405 that means the line boundaries have changed. So we
16406 can't start copying with the row START. Maybe it will
16407 work to start copying with the following row. */
16408 while (IT_CHARPOS (it
) > CHARPOS (start
))
16410 /* Advance to the next row as the "start". */
16412 start
= start_row
->minpos
;
16413 /* If there are no more rows to try, or just one, give up. */
16414 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16415 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16416 || CHARPOS (start
) == ZV
)
16418 clear_glyph_matrix (w
->desired_matrix
);
16422 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16424 /* If we have reached alignment, we can copy the rest of the
16426 if (IT_CHARPOS (it
) == CHARPOS (start
)
16427 /* Don't accept "alignment" inside a display vector,
16428 since start_row could have started in the middle of
16429 that same display vector (thus their character
16430 positions match), and we have no way of telling if
16431 that is the case. */
16432 && it
.current
.dpvec_index
< 0)
16435 if (display_line (&it
))
16436 last_text_row
= it
.glyph_row
- 1;
16440 /* A value of current_y < last_visible_y means that we stopped
16441 at the previous window start, which in turn means that we
16442 have at least one reusable row. */
16443 if (it
.current_y
< it
.last_visible_y
)
16445 struct glyph_row
*row
;
16447 /* IT.vpos always starts from 0; it counts text lines. */
16448 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16450 /* Find PT if not already found in the lines displayed. */
16451 if (w
->cursor
.vpos
< 0)
16453 int dy
= it
.current_y
- start_row
->y
;
16455 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16456 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16458 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16459 dy
, nrows_scrolled
);
16462 clear_glyph_matrix (w
->desired_matrix
);
16467 /* Scroll the display. Do it before the current matrix is
16468 changed. The problem here is that update has not yet
16469 run, i.e. part of the current matrix is not up to date.
16470 scroll_run_hook will clear the cursor, and use the
16471 current matrix to get the height of the row the cursor is
16473 run
.current_y
= start_row
->y
;
16474 run
.desired_y
= it
.current_y
;
16475 run
.height
= it
.last_visible_y
- it
.current_y
;
16477 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16480 FRAME_RIF (f
)->update_window_begin_hook (w
);
16481 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16482 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16483 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16487 /* Shift current matrix down by nrows_scrolled lines. */
16488 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16489 rotate_matrix (w
->current_matrix
,
16491 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16494 /* Disable lines that must be updated. */
16495 for (i
= 0; i
< nrows_scrolled
; ++i
)
16496 (start_row
+ i
)->enabled_p
= 0;
16498 /* Re-compute Y positions. */
16499 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16500 max_y
= it
.last_visible_y
;
16501 for (row
= start_row
+ nrows_scrolled
;
16505 row
->y
= it
.current_y
;
16506 row
->visible_height
= row
->height
;
16508 if (row
->y
< min_y
)
16509 row
->visible_height
-= min_y
- row
->y
;
16510 if (row
->y
+ row
->height
> max_y
)
16511 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16512 if (row
->fringe_bitmap_periodic_p
)
16513 row
->redraw_fringe_bitmaps_p
= 1;
16515 it
.current_y
+= row
->height
;
16517 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16518 last_reused_text_row
= row
;
16519 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16523 /* Disable lines in the current matrix which are now
16524 below the window. */
16525 for (++row
; row
< bottom_row
; ++row
)
16526 row
->enabled_p
= row
->mode_line_p
= 0;
16529 /* Update window_end_pos etc.; last_reused_text_row is the last
16530 reused row from the current matrix containing text, if any.
16531 The value of last_text_row is the last displayed line
16532 containing text. */
16533 if (last_reused_text_row
)
16535 w
->window_end_bytepos
16536 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16538 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16540 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16541 w
->current_matrix
));
16543 else if (last_text_row
)
16545 w
->window_end_bytepos
16546 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16548 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16550 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16554 /* This window must be completely empty. */
16555 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16556 w
->window_end_pos
= make_number (Z
- ZV
);
16557 w
->window_end_vpos
= make_number (0);
16559 w
->window_end_valid
= Qnil
;
16561 /* Update hint: don't try scrolling again in update_window. */
16562 w
->desired_matrix
->no_scrolling_p
= 1;
16565 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16569 else if (CHARPOS (new_start
) > CHARPOS (start
))
16571 struct glyph_row
*pt_row
, *row
;
16572 struct glyph_row
*first_reusable_row
;
16573 struct glyph_row
*first_row_to_display
;
16575 int yb
= window_text_bottom_y (w
);
16577 /* Find the row starting at new_start, if there is one. Don't
16578 reuse a partially visible line at the end. */
16579 first_reusable_row
= start_row
;
16580 while (first_reusable_row
->enabled_p
16581 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16582 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16583 < CHARPOS (new_start
)))
16584 ++first_reusable_row
;
16586 /* Give up if there is no row to reuse. */
16587 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16588 || !first_reusable_row
->enabled_p
16589 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16590 != CHARPOS (new_start
)))
16593 /* We can reuse fully visible rows beginning with
16594 first_reusable_row to the end of the window. Set
16595 first_row_to_display to the first row that cannot be reused.
16596 Set pt_row to the row containing point, if there is any. */
16598 for (first_row_to_display
= first_reusable_row
;
16599 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16600 ++first_row_to_display
)
16602 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16603 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16604 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16605 && first_row_to_display
->ends_at_zv_p
16606 && pt_row
== NULL
)))
16607 pt_row
= first_row_to_display
;
16610 /* Start displaying at the start of first_row_to_display. */
16611 eassert (first_row_to_display
->y
< yb
);
16612 init_to_row_start (&it
, w
, first_row_to_display
);
16614 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16616 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16618 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16619 + WINDOW_HEADER_LINE_HEIGHT (w
));
16621 /* Display lines beginning with first_row_to_display in the
16622 desired matrix. Set last_text_row to the last row displayed
16623 that displays text. */
16624 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16625 if (pt_row
== NULL
)
16626 w
->cursor
.vpos
= -1;
16627 last_text_row
= NULL
;
16628 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16629 if (display_line (&it
))
16630 last_text_row
= it
.glyph_row
- 1;
16632 /* If point is in a reused row, adjust y and vpos of the cursor
16636 w
->cursor
.vpos
-= nrows_scrolled
;
16637 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16640 /* Give up if point isn't in a row displayed or reused. (This
16641 also handles the case where w->cursor.vpos < nrows_scrolled
16642 after the calls to display_line, which can happen with scroll
16643 margins. See bug#1295.) */
16644 if (w
->cursor
.vpos
< 0)
16646 clear_glyph_matrix (w
->desired_matrix
);
16650 /* Scroll the display. */
16651 run
.current_y
= first_reusable_row
->y
;
16652 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16653 run
.height
= it
.last_visible_y
- run
.current_y
;
16654 dy
= run
.current_y
- run
.desired_y
;
16659 FRAME_RIF (f
)->update_window_begin_hook (w
);
16660 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16661 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16662 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16666 /* Adjust Y positions of reused rows. */
16667 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16668 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16669 max_y
= it
.last_visible_y
;
16670 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16673 row
->visible_height
= row
->height
;
16674 if (row
->y
< min_y
)
16675 row
->visible_height
-= min_y
- row
->y
;
16676 if (row
->y
+ row
->height
> max_y
)
16677 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16678 if (row
->fringe_bitmap_periodic_p
)
16679 row
->redraw_fringe_bitmaps_p
= 1;
16682 /* Scroll the current matrix. */
16683 eassert (nrows_scrolled
> 0);
16684 rotate_matrix (w
->current_matrix
,
16686 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16689 /* Disable rows not reused. */
16690 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16691 row
->enabled_p
= 0;
16693 /* Point may have moved to a different line, so we cannot assume that
16694 the previous cursor position is valid; locate the correct row. */
16697 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16699 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16700 && !row
->ends_at_zv_p
;
16704 w
->cursor
.y
= row
->y
;
16706 if (row
< bottom_row
)
16708 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16709 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16711 /* Can't use this optimization with bidi-reordered glyph
16712 rows, unless cursor is already at point. */
16713 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16715 if (!(w
->cursor
.hpos
>= 0
16716 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16717 && BUFFERP (glyph
->object
)
16718 && glyph
->charpos
== PT
))
16723 && (!BUFFERP (glyph
->object
)
16724 || glyph
->charpos
< PT
);
16728 w
->cursor
.x
+= glyph
->pixel_width
;
16733 /* Adjust window end. A null value of last_text_row means that
16734 the window end is in reused rows which in turn means that
16735 only its vpos can have changed. */
16738 w
->window_end_bytepos
16739 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16741 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16743 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16748 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16751 w
->window_end_valid
= Qnil
;
16752 w
->desired_matrix
->no_scrolling_p
= 1;
16755 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16765 /************************************************************************
16766 Window redisplay reusing current matrix when buffer has changed
16767 ************************************************************************/
16769 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16770 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16771 ptrdiff_t *, ptrdiff_t *);
16772 static struct glyph_row
*
16773 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16774 struct glyph_row
*);
16777 /* Return the last row in MATRIX displaying text. If row START is
16778 non-null, start searching with that row. IT gives the dimensions
16779 of the display. Value is null if matrix is empty; otherwise it is
16780 a pointer to the row found. */
16782 static struct glyph_row
*
16783 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16784 struct glyph_row
*start
)
16786 struct glyph_row
*row
, *row_found
;
16788 /* Set row_found to the last row in IT->w's current matrix
16789 displaying text. The loop looks funny but think of partially
16792 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16793 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16795 eassert (row
->enabled_p
);
16797 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16806 /* Return the last row in the current matrix of W that is not affected
16807 by changes at the start of current_buffer that occurred since W's
16808 current matrix was built. Value is null if no such row exists.
16810 BEG_UNCHANGED us the number of characters unchanged at the start of
16811 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16812 first changed character in current_buffer. Characters at positions <
16813 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16814 when the current matrix was built. */
16816 static struct glyph_row
*
16817 find_last_unchanged_at_beg_row (struct window
*w
)
16819 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16820 struct glyph_row
*row
;
16821 struct glyph_row
*row_found
= NULL
;
16822 int yb
= window_text_bottom_y (w
);
16824 /* Find the last row displaying unchanged text. */
16825 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16826 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16827 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16830 if (/* If row ends before first_changed_pos, it is unchanged,
16831 except in some case. */
16832 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16833 /* When row ends in ZV and we write at ZV it is not
16835 && !row
->ends_at_zv_p
16836 /* When first_changed_pos is the end of a continued line,
16837 row is not unchanged because it may be no longer
16839 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16840 && (row
->continued_p
16841 || row
->exact_window_width_line_p
))
16842 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16843 needs to be recomputed, so don't consider this row as
16844 unchanged. This happens when the last line was
16845 bidi-reordered and was killed immediately before this
16846 redisplay cycle. In that case, ROW->end stores the
16847 buffer position of the first visual-order character of
16848 the killed text, which is now beyond ZV. */
16849 && CHARPOS (row
->end
.pos
) <= ZV
)
16852 /* Stop if last visible row. */
16853 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16861 /* Find the first glyph row in the current matrix of W that is not
16862 affected by changes at the end of current_buffer since the
16863 time W's current matrix was built.
16865 Return in *DELTA the number of chars by which buffer positions in
16866 unchanged text at the end of current_buffer must be adjusted.
16868 Return in *DELTA_BYTES the corresponding number of bytes.
16870 Value is null if no such row exists, i.e. all rows are affected by
16873 static struct glyph_row
*
16874 find_first_unchanged_at_end_row (struct window
*w
,
16875 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16877 struct glyph_row
*row
;
16878 struct glyph_row
*row_found
= NULL
;
16880 *delta
= *delta_bytes
= 0;
16882 /* Display must not have been paused, otherwise the current matrix
16883 is not up to date. */
16884 eassert (!NILP (w
->window_end_valid
));
16886 /* A value of window_end_pos >= END_UNCHANGED means that the window
16887 end is in the range of changed text. If so, there is no
16888 unchanged row at the end of W's current matrix. */
16889 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16892 /* Set row to the last row in W's current matrix displaying text. */
16893 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16895 /* If matrix is entirely empty, no unchanged row exists. */
16896 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16898 /* The value of row is the last glyph row in the matrix having a
16899 meaningful buffer position in it. The end position of row
16900 corresponds to window_end_pos. This allows us to translate
16901 buffer positions in the current matrix to current buffer
16902 positions for characters not in changed text. */
16904 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16905 ptrdiff_t Z_BYTE_old
=
16906 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16907 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16908 struct glyph_row
*first_text_row
16909 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16911 *delta
= Z
- Z_old
;
16912 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16914 /* Set last_unchanged_pos to the buffer position of the last
16915 character in the buffer that has not been changed. Z is the
16916 index + 1 of the last character in current_buffer, i.e. by
16917 subtracting END_UNCHANGED we get the index of the last
16918 unchanged character, and we have to add BEG to get its buffer
16920 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16921 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16923 /* Search backward from ROW for a row displaying a line that
16924 starts at a minimum position >= last_unchanged_pos_old. */
16925 for (; row
> first_text_row
; --row
)
16927 /* This used to abort, but it can happen.
16928 It is ok to just stop the search instead here. KFS. */
16929 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16932 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16937 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16943 /* Make sure that glyph rows in the current matrix of window W
16944 reference the same glyph memory as corresponding rows in the
16945 frame's frame matrix. This function is called after scrolling W's
16946 current matrix on a terminal frame in try_window_id and
16947 try_window_reusing_current_matrix. */
16950 sync_frame_with_window_matrix_rows (struct window
*w
)
16952 struct frame
*f
= XFRAME (w
->frame
);
16953 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16955 /* Preconditions: W must be a leaf window and full-width. Its frame
16956 must have a frame matrix. */
16957 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16958 eassert (WINDOW_FULL_WIDTH_P (w
));
16959 eassert (!FRAME_WINDOW_P (f
));
16961 /* If W is a full-width window, glyph pointers in W's current matrix
16962 have, by definition, to be the same as glyph pointers in the
16963 corresponding frame matrix. Note that frame matrices have no
16964 marginal areas (see build_frame_matrix). */
16965 window_row
= w
->current_matrix
->rows
;
16966 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16967 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16968 while (window_row
< window_row_end
)
16970 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16971 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16973 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16974 frame_row
->glyphs
[TEXT_AREA
] = start
;
16975 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16976 frame_row
->glyphs
[LAST_AREA
] = end
;
16978 /* Disable frame rows whose corresponding window rows have
16979 been disabled in try_window_id. */
16980 if (!window_row
->enabled_p
)
16981 frame_row
->enabled_p
= 0;
16983 ++window_row
, ++frame_row
;
16988 /* Find the glyph row in window W containing CHARPOS. Consider all
16989 rows between START and END (not inclusive). END null means search
16990 all rows to the end of the display area of W. Value is the row
16991 containing CHARPOS or null. */
16994 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16995 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16997 struct glyph_row
*row
= start
;
16998 struct glyph_row
*best_row
= NULL
;
16999 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17002 /* If we happen to start on a header-line, skip that. */
17003 if (row
->mode_line_p
)
17006 if ((end
&& row
>= end
) || !row
->enabled_p
)
17009 last_y
= window_text_bottom_y (w
) - dy
;
17013 /* Give up if we have gone too far. */
17014 if (end
&& row
>= end
)
17016 /* This formerly returned if they were equal.
17017 I think that both quantities are of a "last plus one" type;
17018 if so, when they are equal, the row is within the screen. -- rms. */
17019 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17022 /* If it is in this row, return this row. */
17023 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17024 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17025 /* The end position of a row equals the start
17026 position of the next row. If CHARPOS is there, we
17027 would rather display it in the next line, except
17028 when this line ends in ZV. */
17029 && !row
->ends_at_zv_p
17030 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17031 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17035 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17036 || (!best_row
&& !row
->continued_p
))
17038 /* In bidi-reordered rows, there could be several rows
17039 occluding point, all of them belonging to the same
17040 continued line. We need to find the row which fits
17041 CHARPOS the best. */
17042 for (g
= row
->glyphs
[TEXT_AREA
];
17043 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17046 if (!STRINGP (g
->object
))
17048 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17050 mindif
= eabs (g
->charpos
- charpos
);
17052 /* Exact match always wins. */
17059 else if (best_row
&& !row
->continued_p
)
17066 /* Try to redisplay window W by reusing its existing display. W's
17067 current matrix must be up to date when this function is called,
17068 i.e. window_end_valid must not be nil.
17072 1 if display has been updated
17073 0 if otherwise unsuccessful
17074 -1 if redisplay with same window start is known not to succeed
17076 The following steps are performed:
17078 1. Find the last row in the current matrix of W that is not
17079 affected by changes at the start of current_buffer. If no such row
17082 2. Find the first row in W's current matrix that is not affected by
17083 changes at the end of current_buffer. Maybe there is no such row.
17085 3. Display lines beginning with the row + 1 found in step 1 to the
17086 row found in step 2 or, if step 2 didn't find a row, to the end of
17089 4. If cursor is not known to appear on the window, give up.
17091 5. If display stopped at the row found in step 2, scroll the
17092 display and current matrix as needed.
17094 6. Maybe display some lines at the end of W, if we must. This can
17095 happen under various circumstances, like a partially visible line
17096 becoming fully visible, or because newly displayed lines are displayed
17097 in smaller font sizes.
17099 7. Update W's window end information. */
17102 try_window_id (struct window
*w
)
17104 struct frame
*f
= XFRAME (w
->frame
);
17105 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17106 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17107 struct glyph_row
*last_unchanged_at_beg_row
;
17108 struct glyph_row
*first_unchanged_at_end_row
;
17109 struct glyph_row
*row
;
17110 struct glyph_row
*bottom_row
;
17113 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17115 struct text_pos start_pos
;
17117 int first_unchanged_at_end_vpos
= 0;
17118 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17119 struct text_pos start
;
17120 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17123 if (inhibit_try_window_id
)
17127 /* This is handy for debugging. */
17129 #define GIVE_UP(X) \
17131 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17135 #define GIVE_UP(X) return 0
17138 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17140 /* Don't use this for mini-windows because these can show
17141 messages and mini-buffers, and we don't handle that here. */
17142 if (MINI_WINDOW_P (w
))
17145 /* This flag is used to prevent redisplay optimizations. */
17146 if (windows_or_buffers_changed
|| cursor_type_changed
)
17149 /* Verify that narrowing has not changed.
17150 Also verify that we were not told to prevent redisplay optimizations.
17151 It would be nice to further
17152 reduce the number of cases where this prevents try_window_id. */
17153 if (current_buffer
->clip_changed
17154 || current_buffer
->prevent_redisplay_optimizations_p
)
17157 /* Window must either use window-based redisplay or be full width. */
17158 if (!FRAME_WINDOW_P (f
)
17159 && (!FRAME_LINE_INS_DEL_OK (f
)
17160 || !WINDOW_FULL_WIDTH_P (w
)))
17163 /* Give up if point is known NOT to appear in W. */
17164 if (PT
< CHARPOS (start
))
17167 /* Another way to prevent redisplay optimizations. */
17168 if (w
->last_modified
== 0)
17171 /* Verify that window is not hscrolled. */
17172 if (w
->hscroll
!= 0)
17175 /* Verify that display wasn't paused. */
17176 if (NILP (w
->window_end_valid
))
17179 /* Can't use this if highlighting a region because a cursor movement
17180 will do more than just set the cursor. */
17181 if (!NILP (Vtransient_mark_mode
)
17182 && !NILP (BVAR (current_buffer
, mark_active
)))
17185 /* Likewise if highlighting trailing whitespace. */
17186 if (!NILP (Vshow_trailing_whitespace
))
17189 /* Likewise if showing a region. */
17190 if (!NILP (w
->region_showing
))
17193 /* Can't use this if overlay arrow position and/or string have
17195 if (overlay_arrows_changed_p ())
17198 /* When word-wrap is on, adding a space to the first word of a
17199 wrapped line can change the wrap position, altering the line
17200 above it. It might be worthwhile to handle this more
17201 intelligently, but for now just redisplay from scratch. */
17202 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17205 /* Under bidi reordering, adding or deleting a character in the
17206 beginning of a paragraph, before the first strong directional
17207 character, can change the base direction of the paragraph (unless
17208 the buffer specifies a fixed paragraph direction), which will
17209 require to redisplay the whole paragraph. It might be worthwhile
17210 to find the paragraph limits and widen the range of redisplayed
17211 lines to that, but for now just give up this optimization and
17212 redisplay from scratch. */
17213 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17214 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17217 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17218 only if buffer has really changed. The reason is that the gap is
17219 initially at Z for freshly visited files. The code below would
17220 set end_unchanged to 0 in that case. */
17221 if (MODIFF
> SAVE_MODIFF
17222 /* This seems to happen sometimes after saving a buffer. */
17223 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17225 if (GPT
- BEG
< BEG_UNCHANGED
)
17226 BEG_UNCHANGED
= GPT
- BEG
;
17227 if (Z
- GPT
< END_UNCHANGED
)
17228 END_UNCHANGED
= Z
- GPT
;
17231 /* The position of the first and last character that has been changed. */
17232 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17233 last_changed_charpos
= Z
- END_UNCHANGED
;
17235 /* If window starts after a line end, and the last change is in
17236 front of that newline, then changes don't affect the display.
17237 This case happens with stealth-fontification. Note that although
17238 the display is unchanged, glyph positions in the matrix have to
17239 be adjusted, of course. */
17240 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17241 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17242 && ((last_changed_charpos
< CHARPOS (start
)
17243 && CHARPOS (start
) == BEGV
)
17244 || (last_changed_charpos
< CHARPOS (start
) - 1
17245 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17247 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17248 struct glyph_row
*r0
;
17250 /* Compute how many chars/bytes have been added to or removed
17251 from the buffer. */
17252 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17253 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17254 Z_delta
= Z
- Z_old
;
17255 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17257 /* Give up if PT is not in the window. Note that it already has
17258 been checked at the start of try_window_id that PT is not in
17259 front of the window start. */
17260 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17263 /* If window start is unchanged, we can reuse the whole matrix
17264 as is, after adjusting glyph positions. No need to compute
17265 the window end again, since its offset from Z hasn't changed. */
17266 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17267 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17268 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17269 /* PT must not be in a partially visible line. */
17270 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17271 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17273 /* Adjust positions in the glyph matrix. */
17274 if (Z_delta
|| Z_delta_bytes
)
17276 struct glyph_row
*r1
17277 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17278 increment_matrix_positions (w
->current_matrix
,
17279 MATRIX_ROW_VPOS (r0
, current_matrix
),
17280 MATRIX_ROW_VPOS (r1
, current_matrix
),
17281 Z_delta
, Z_delta_bytes
);
17284 /* Set the cursor. */
17285 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17287 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17294 /* Handle the case that changes are all below what is displayed in
17295 the window, and that PT is in the window. This shortcut cannot
17296 be taken if ZV is visible in the window, and text has been added
17297 there that is visible in the window. */
17298 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17299 /* ZV is not visible in the window, or there are no
17300 changes at ZV, actually. */
17301 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17302 || first_changed_charpos
== last_changed_charpos
))
17304 struct glyph_row
*r0
;
17306 /* Give up if PT is not in the window. Note that it already has
17307 been checked at the start of try_window_id that PT is not in
17308 front of the window start. */
17309 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17312 /* If window start is unchanged, we can reuse the whole matrix
17313 as is, without changing glyph positions since no text has
17314 been added/removed in front of the window end. */
17315 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17316 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17317 /* PT must not be in a partially visible line. */
17318 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17319 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17321 /* We have to compute the window end anew since text
17322 could have been added/removed after it. */
17324 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17325 w
->window_end_bytepos
17326 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17328 /* Set the cursor. */
17329 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17331 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17338 /* Give up if window start is in the changed area.
17340 The condition used to read
17342 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17344 but why that was tested escapes me at the moment. */
17345 if (CHARPOS (start
) >= first_changed_charpos
17346 && CHARPOS (start
) <= last_changed_charpos
)
17349 /* Check that window start agrees with the start of the first glyph
17350 row in its current matrix. Check this after we know the window
17351 start is not in changed text, otherwise positions would not be
17353 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17354 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17357 /* Give up if the window ends in strings. Overlay strings
17358 at the end are difficult to handle, so don't try. */
17359 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17360 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17363 /* Compute the position at which we have to start displaying new
17364 lines. Some of the lines at the top of the window might be
17365 reusable because they are not displaying changed text. Find the
17366 last row in W's current matrix not affected by changes at the
17367 start of current_buffer. Value is null if changes start in the
17368 first line of window. */
17369 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17370 if (last_unchanged_at_beg_row
)
17372 /* Avoid starting to display in the middle of a character, a TAB
17373 for instance. This is easier than to set up the iterator
17374 exactly, and it's not a frequent case, so the additional
17375 effort wouldn't really pay off. */
17376 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17377 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17378 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17379 --last_unchanged_at_beg_row
;
17381 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17384 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17386 start_pos
= it
.current
.pos
;
17388 /* Start displaying new lines in the desired matrix at the same
17389 vpos we would use in the current matrix, i.e. below
17390 last_unchanged_at_beg_row. */
17391 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17393 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17394 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17396 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17400 /* There are no reusable lines at the start of the window.
17401 Start displaying in the first text line. */
17402 start_display (&it
, w
, start
);
17403 it
.vpos
= it
.first_vpos
;
17404 start_pos
= it
.current
.pos
;
17407 /* Find the first row that is not affected by changes at the end of
17408 the buffer. Value will be null if there is no unchanged row, in
17409 which case we must redisplay to the end of the window. delta
17410 will be set to the value by which buffer positions beginning with
17411 first_unchanged_at_end_row have to be adjusted due to text
17413 first_unchanged_at_end_row
17414 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17415 IF_DEBUG (debug_delta
= delta
);
17416 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17418 /* Set stop_pos to the buffer position up to which we will have to
17419 display new lines. If first_unchanged_at_end_row != NULL, this
17420 is the buffer position of the start of the line displayed in that
17421 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17422 that we don't stop at a buffer position. */
17424 if (first_unchanged_at_end_row
)
17426 eassert (last_unchanged_at_beg_row
== NULL
17427 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17429 /* If this is a continuation line, move forward to the next one
17430 that isn't. Changes in lines above affect this line.
17431 Caution: this may move first_unchanged_at_end_row to a row
17432 not displaying text. */
17433 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17434 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17435 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17436 < it
.last_visible_y
))
17437 ++first_unchanged_at_end_row
;
17439 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17440 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17441 >= it
.last_visible_y
))
17442 first_unchanged_at_end_row
= NULL
;
17445 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17447 first_unchanged_at_end_vpos
17448 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17449 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17452 else if (last_unchanged_at_beg_row
== NULL
)
17458 /* Either there is no unchanged row at the end, or the one we have
17459 now displays text. This is a necessary condition for the window
17460 end pos calculation at the end of this function. */
17461 eassert (first_unchanged_at_end_row
== NULL
17462 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17464 debug_last_unchanged_at_beg_vpos
17465 = (last_unchanged_at_beg_row
17466 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17468 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17470 #endif /* GLYPH_DEBUG */
17473 /* Display new lines. Set last_text_row to the last new line
17474 displayed which has text on it, i.e. might end up as being the
17475 line where the window_end_vpos is. */
17476 w
->cursor
.vpos
= -1;
17477 last_text_row
= NULL
;
17478 overlay_arrow_seen
= 0;
17479 while (it
.current_y
< it
.last_visible_y
17480 && !fonts_changed_p
17481 && (first_unchanged_at_end_row
== NULL
17482 || IT_CHARPOS (it
) < stop_pos
))
17484 if (display_line (&it
))
17485 last_text_row
= it
.glyph_row
- 1;
17488 if (fonts_changed_p
)
17492 /* Compute differences in buffer positions, y-positions etc. for
17493 lines reused at the bottom of the window. Compute what we can
17495 if (first_unchanged_at_end_row
17496 /* No lines reused because we displayed everything up to the
17497 bottom of the window. */
17498 && it
.current_y
< it
.last_visible_y
)
17501 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17503 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17504 run
.current_y
= first_unchanged_at_end_row
->y
;
17505 run
.desired_y
= run
.current_y
+ dy
;
17506 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17510 delta
= delta_bytes
= dvpos
= dy
17511 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17512 first_unchanged_at_end_row
= NULL
;
17514 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17517 /* Find the cursor if not already found. We have to decide whether
17518 PT will appear on this window (it sometimes doesn't, but this is
17519 not a very frequent case.) This decision has to be made before
17520 the current matrix is altered. A value of cursor.vpos < 0 means
17521 that PT is either in one of the lines beginning at
17522 first_unchanged_at_end_row or below the window. Don't care for
17523 lines that might be displayed later at the window end; as
17524 mentioned, this is not a frequent case. */
17525 if (w
->cursor
.vpos
< 0)
17527 /* Cursor in unchanged rows at the top? */
17528 if (PT
< CHARPOS (start_pos
)
17529 && last_unchanged_at_beg_row
)
17531 row
= row_containing_pos (w
, PT
,
17532 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17533 last_unchanged_at_beg_row
+ 1, 0);
17535 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17538 /* Start from first_unchanged_at_end_row looking for PT. */
17539 else if (first_unchanged_at_end_row
)
17541 row
= row_containing_pos (w
, PT
- delta
,
17542 first_unchanged_at_end_row
, NULL
, 0);
17544 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17545 delta_bytes
, dy
, dvpos
);
17548 /* Give up if cursor was not found. */
17549 if (w
->cursor
.vpos
< 0)
17551 clear_glyph_matrix (w
->desired_matrix
);
17556 /* Don't let the cursor end in the scroll margins. */
17558 int this_scroll_margin
, cursor_height
;
17560 this_scroll_margin
=
17561 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17562 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17563 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17565 if ((w
->cursor
.y
< this_scroll_margin
17566 && CHARPOS (start
) > BEGV
)
17567 /* Old redisplay didn't take scroll margin into account at the bottom,
17568 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17569 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17570 ? cursor_height
+ this_scroll_margin
17571 : 1)) > it
.last_visible_y
)
17573 w
->cursor
.vpos
= -1;
17574 clear_glyph_matrix (w
->desired_matrix
);
17579 /* Scroll the display. Do it before changing the current matrix so
17580 that xterm.c doesn't get confused about where the cursor glyph is
17582 if (dy
&& run
.height
)
17586 if (FRAME_WINDOW_P (f
))
17588 FRAME_RIF (f
)->update_window_begin_hook (w
);
17589 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17590 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17591 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17595 /* Terminal frame. In this case, dvpos gives the number of
17596 lines to scroll by; dvpos < 0 means scroll up. */
17598 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17599 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17600 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17601 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17602 + window_internal_height (w
));
17604 #if defined (HAVE_GPM) || defined (MSDOS)
17605 x_clear_window_mouse_face (w
);
17607 /* Perform the operation on the screen. */
17610 /* Scroll last_unchanged_at_beg_row to the end of the
17611 window down dvpos lines. */
17612 set_terminal_window (f
, end
);
17614 /* On dumb terminals delete dvpos lines at the end
17615 before inserting dvpos empty lines. */
17616 if (!FRAME_SCROLL_REGION_OK (f
))
17617 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17619 /* Insert dvpos empty lines in front of
17620 last_unchanged_at_beg_row. */
17621 ins_del_lines (f
, from
, dvpos
);
17623 else if (dvpos
< 0)
17625 /* Scroll up last_unchanged_at_beg_vpos to the end of
17626 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17627 set_terminal_window (f
, end
);
17629 /* Delete dvpos lines in front of
17630 last_unchanged_at_beg_vpos. ins_del_lines will set
17631 the cursor to the given vpos and emit |dvpos| delete
17633 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17635 /* On a dumb terminal insert dvpos empty lines at the
17637 if (!FRAME_SCROLL_REGION_OK (f
))
17638 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17641 set_terminal_window (f
, 0);
17647 /* Shift reused rows of the current matrix to the right position.
17648 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17650 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17651 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17654 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17655 bottom_vpos
, dvpos
);
17656 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17659 else if (dvpos
> 0)
17661 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17662 bottom_vpos
, dvpos
);
17663 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17664 first_unchanged_at_end_vpos
+ dvpos
, 0);
17667 /* For frame-based redisplay, make sure that current frame and window
17668 matrix are in sync with respect to glyph memory. */
17669 if (!FRAME_WINDOW_P (f
))
17670 sync_frame_with_window_matrix_rows (w
);
17672 /* Adjust buffer positions in reused rows. */
17673 if (delta
|| delta_bytes
)
17674 increment_matrix_positions (current_matrix
,
17675 first_unchanged_at_end_vpos
+ dvpos
,
17676 bottom_vpos
, delta
, delta_bytes
);
17678 /* Adjust Y positions. */
17680 shift_glyph_matrix (w
, current_matrix
,
17681 first_unchanged_at_end_vpos
+ dvpos
,
17684 if (first_unchanged_at_end_row
)
17686 first_unchanged_at_end_row
+= dvpos
;
17687 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17688 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17689 first_unchanged_at_end_row
= NULL
;
17692 /* If scrolling up, there may be some lines to display at the end of
17694 last_text_row_at_end
= NULL
;
17697 /* Scrolling up can leave for example a partially visible line
17698 at the end of the window to be redisplayed. */
17699 /* Set last_row to the glyph row in the current matrix where the
17700 window end line is found. It has been moved up or down in
17701 the matrix by dvpos. */
17702 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17703 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17705 /* If last_row is the window end line, it should display text. */
17706 eassert (last_row
->displays_text_p
);
17708 /* If window end line was partially visible before, begin
17709 displaying at that line. Otherwise begin displaying with the
17710 line following it. */
17711 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17713 init_to_row_start (&it
, w
, last_row
);
17714 it
.vpos
= last_vpos
;
17715 it
.current_y
= last_row
->y
;
17719 init_to_row_end (&it
, w
, last_row
);
17720 it
.vpos
= 1 + last_vpos
;
17721 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17725 /* We may start in a continuation line. If so, we have to
17726 get the right continuation_lines_width and current_x. */
17727 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17728 it
.hpos
= it
.current_x
= 0;
17730 /* Display the rest of the lines at the window end. */
17731 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17732 while (it
.current_y
< it
.last_visible_y
17733 && !fonts_changed_p
)
17735 /* Is it always sure that the display agrees with lines in
17736 the current matrix? I don't think so, so we mark rows
17737 displayed invalid in the current matrix by setting their
17738 enabled_p flag to zero. */
17739 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17740 if (display_line (&it
))
17741 last_text_row_at_end
= it
.glyph_row
- 1;
17745 /* Update window_end_pos and window_end_vpos. */
17746 if (first_unchanged_at_end_row
17747 && !last_text_row_at_end
)
17749 /* Window end line if one of the preserved rows from the current
17750 matrix. Set row to the last row displaying text in current
17751 matrix starting at first_unchanged_at_end_row, after
17753 eassert (first_unchanged_at_end_row
->displays_text_p
);
17754 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17755 first_unchanged_at_end_row
);
17756 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17758 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17759 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17761 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17762 eassert (w
->window_end_bytepos
>= 0);
17763 IF_DEBUG (debug_method_add (w
, "A"));
17765 else if (last_text_row_at_end
)
17768 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17769 w
->window_end_bytepos
17770 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17772 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17773 eassert (w
->window_end_bytepos
>= 0);
17774 IF_DEBUG (debug_method_add (w
, "B"));
17776 else if (last_text_row
)
17778 /* We have displayed either to the end of the window or at the
17779 end of the window, i.e. the last row with text is to be found
17780 in the desired matrix. */
17782 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17783 w
->window_end_bytepos
17784 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17786 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17787 eassert (w
->window_end_bytepos
>= 0);
17789 else if (first_unchanged_at_end_row
== NULL
17790 && last_text_row
== NULL
17791 && last_text_row_at_end
== NULL
)
17793 /* Displayed to end of window, but no line containing text was
17794 displayed. Lines were deleted at the end of the window. */
17795 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17796 int vpos
= XFASTINT (w
->window_end_vpos
);
17797 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17798 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17801 row
== NULL
&& vpos
>= first_vpos
;
17802 --vpos
, --current_row
, --desired_row
)
17804 if (desired_row
->enabled_p
)
17806 if (desired_row
->displays_text_p
)
17809 else if (current_row
->displays_text_p
)
17813 eassert (row
!= NULL
);
17814 w
->window_end_vpos
= make_number (vpos
+ 1);
17815 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17816 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17817 eassert (w
->window_end_bytepos
>= 0);
17818 IF_DEBUG (debug_method_add (w
, "C"));
17823 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17824 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17826 /* Record that display has not been completed. */
17827 w
->window_end_valid
= Qnil
;
17828 w
->desired_matrix
->no_scrolling_p
= 1;
17836 /***********************************************************************
17837 More debugging support
17838 ***********************************************************************/
17842 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17843 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17844 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17847 /* Dump the contents of glyph matrix MATRIX on stderr.
17849 GLYPHS 0 means don't show glyph contents.
17850 GLYPHS 1 means show glyphs in short form
17851 GLYPHS > 1 means show glyphs in long form. */
17854 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17857 for (i
= 0; i
< matrix
->nrows
; ++i
)
17858 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17862 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17863 the glyph row and area where the glyph comes from. */
17866 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17868 if (glyph
->type
== CHAR_GLYPH
)
17871 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17872 glyph
- row
->glyphs
[TEXT_AREA
],
17875 (BUFFERP (glyph
->object
)
17877 : (STRINGP (glyph
->object
)
17880 glyph
->pixel_width
,
17882 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17886 glyph
->left_box_line_p
,
17887 glyph
->right_box_line_p
);
17889 else if (glyph
->type
== STRETCH_GLYPH
)
17892 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17893 glyph
- row
->glyphs
[TEXT_AREA
],
17896 (BUFFERP (glyph
->object
)
17898 : (STRINGP (glyph
->object
)
17901 glyph
->pixel_width
,
17905 glyph
->left_box_line_p
,
17906 glyph
->right_box_line_p
);
17908 else if (glyph
->type
== IMAGE_GLYPH
)
17911 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17912 glyph
- row
->glyphs
[TEXT_AREA
],
17915 (BUFFERP (glyph
->object
)
17917 : (STRINGP (glyph
->object
)
17920 glyph
->pixel_width
,
17924 glyph
->left_box_line_p
,
17925 glyph
->right_box_line_p
);
17927 else if (glyph
->type
== COMPOSITE_GLYPH
)
17930 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17931 glyph
- row
->glyphs
[TEXT_AREA
],
17934 (BUFFERP (glyph
->object
)
17936 : (STRINGP (glyph
->object
)
17939 glyph
->pixel_width
,
17941 if (glyph
->u
.cmp
.automatic
)
17944 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17945 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17947 glyph
->left_box_line_p
,
17948 glyph
->right_box_line_p
);
17953 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17954 GLYPHS 0 means don't show glyph contents.
17955 GLYPHS 1 means show glyphs in short form
17956 GLYPHS > 1 means show glyphs in long form. */
17959 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17963 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17964 fprintf (stderr
, "======================================================================\n");
17966 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17967 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17969 MATRIX_ROW_START_CHARPOS (row
),
17970 MATRIX_ROW_END_CHARPOS (row
),
17971 row
->used
[TEXT_AREA
],
17972 row
->contains_overlapping_glyphs_p
,
17974 row
->truncated_on_left_p
,
17975 row
->truncated_on_right_p
,
17977 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17978 row
->displays_text_p
,
17981 row
->ends_in_middle_of_char_p
,
17982 row
->starts_in_middle_of_char_p
,
17988 row
->visible_height
,
17991 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17992 row
->end
.overlay_string_index
,
17993 row
->continuation_lines_width
);
17994 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17995 CHARPOS (row
->start
.string_pos
),
17996 CHARPOS (row
->end
.string_pos
));
17997 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17998 row
->end
.dpvec_index
);
18005 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18007 struct glyph
*glyph
= row
->glyphs
[area
];
18008 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18010 /* Glyph for a line end in text. */
18011 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18014 if (glyph
< glyph_end
)
18015 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18017 for (; glyph
< glyph_end
; ++glyph
)
18018 dump_glyph (row
, glyph
, area
);
18021 else if (glyphs
== 1)
18025 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18027 char *s
= alloca (row
->used
[area
] + 1);
18030 for (i
= 0; i
< row
->used
[area
]; ++i
)
18032 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18033 if (glyph
->type
== CHAR_GLYPH
18034 && glyph
->u
.ch
< 0x80
18035 && glyph
->u
.ch
>= ' ')
18036 s
[i
] = glyph
->u
.ch
;
18042 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18048 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18049 Sdump_glyph_matrix
, 0, 1, "p",
18050 doc
: /* Dump the current matrix of the selected window to stderr.
18051 Shows contents of glyph row structures. With non-nil
18052 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18053 glyphs in short form, otherwise show glyphs in long form. */)
18054 (Lisp_Object glyphs
)
18056 struct window
*w
= XWINDOW (selected_window
);
18057 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18059 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18060 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18061 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18062 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18063 fprintf (stderr
, "=============================================\n");
18064 dump_glyph_matrix (w
->current_matrix
,
18065 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18070 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18071 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18074 struct frame
*f
= XFRAME (selected_frame
);
18075 dump_glyph_matrix (f
->current_matrix
, 1);
18080 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18081 doc
: /* Dump glyph row ROW to stderr.
18082 GLYPH 0 means don't dump glyphs.
18083 GLYPH 1 means dump glyphs in short form.
18084 GLYPH > 1 or omitted means dump glyphs in long form. */)
18085 (Lisp_Object row
, Lisp_Object glyphs
)
18087 struct glyph_matrix
*matrix
;
18090 CHECK_NUMBER (row
);
18091 matrix
= XWINDOW (selected_window
)->current_matrix
;
18093 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18094 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18096 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18101 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18102 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18103 GLYPH 0 means don't dump glyphs.
18104 GLYPH 1 means dump glyphs in short form.
18105 GLYPH > 1 or omitted means dump glyphs in long form. */)
18106 (Lisp_Object row
, Lisp_Object glyphs
)
18108 struct frame
*sf
= SELECTED_FRAME ();
18109 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18112 CHECK_NUMBER (row
);
18114 if (vpos
>= 0 && vpos
< m
->nrows
)
18115 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18116 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18121 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18122 doc
: /* Toggle tracing of redisplay.
18123 With ARG, turn tracing on if and only if ARG is positive. */)
18127 trace_redisplay_p
= !trace_redisplay_p
;
18130 arg
= Fprefix_numeric_value (arg
);
18131 trace_redisplay_p
= XINT (arg
) > 0;
18138 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18139 doc
: /* Like `format', but print result to stderr.
18140 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18141 (ptrdiff_t nargs
, Lisp_Object
*args
)
18143 Lisp_Object s
= Fformat (nargs
, args
);
18144 fprintf (stderr
, "%s", SDATA (s
));
18148 #endif /* GLYPH_DEBUG */
18152 /***********************************************************************
18153 Building Desired Matrix Rows
18154 ***********************************************************************/
18156 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18157 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18159 static struct glyph_row
*
18160 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18162 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18163 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18164 struct buffer
*old
= current_buffer
;
18165 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18166 int arrow_len
= SCHARS (overlay_arrow_string
);
18167 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18168 const unsigned char *p
;
18171 int n_glyphs_before
;
18173 set_buffer_temp (buffer
);
18174 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18175 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18176 SET_TEXT_POS (it
.position
, 0, 0);
18178 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18180 while (p
< arrow_end
)
18182 Lisp_Object face
, ilisp
;
18184 /* Get the next character. */
18186 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18189 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18190 if (! ASCII_CHAR_P (it
.c
))
18191 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18195 /* Get its face. */
18196 ilisp
= make_number (p
- arrow_string
);
18197 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18198 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18200 /* Compute its width, get its glyphs. */
18201 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18202 SET_TEXT_POS (it
.position
, -1, -1);
18203 PRODUCE_GLYPHS (&it
);
18205 /* If this character doesn't fit any more in the line, we have
18206 to remove some glyphs. */
18207 if (it
.current_x
> it
.last_visible_x
)
18209 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18214 set_buffer_temp (old
);
18215 return it
.glyph_row
;
18219 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18220 glyphs to insert is determined by produce_special_glyphs. */
18223 insert_left_trunc_glyphs (struct it
*it
)
18225 struct it truncate_it
;
18226 struct glyph
*from
, *end
, *to
, *toend
;
18228 eassert (!FRAME_WINDOW_P (it
->f
)
18229 || (!it
->glyph_row
->reversed_p
18230 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18231 || (it
->glyph_row
->reversed_p
18232 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18234 /* Get the truncation glyphs. */
18236 truncate_it
.current_x
= 0;
18237 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18238 truncate_it
.glyph_row
= &scratch_glyph_row
;
18239 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18240 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18241 truncate_it
.object
= make_number (0);
18242 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18244 /* Overwrite glyphs from IT with truncation glyphs. */
18245 if (!it
->glyph_row
->reversed_p
)
18247 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18249 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18250 end
= from
+ tused
;
18251 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18252 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18253 if (FRAME_WINDOW_P (it
->f
))
18255 /* On GUI frames, when variable-size fonts are displayed,
18256 the truncation glyphs may need more pixels than the row's
18257 glyphs they overwrite. We overwrite more glyphs to free
18258 enough screen real estate, and enlarge the stretch glyph
18259 on the right (see display_line), if there is one, to
18260 preserve the screen position of the truncation glyphs on
18263 struct glyph
*g
= to
;
18266 /* The first glyph could be partially visible, in which case
18267 it->glyph_row->x will be negative. But we want the left
18268 truncation glyphs to be aligned at the left margin of the
18269 window, so we override the x coordinate at which the row
18271 it
->glyph_row
->x
= 0;
18272 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18274 w
+= g
->pixel_width
;
18277 if (g
- to
- tused
> 0)
18279 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18280 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18282 used
= it
->glyph_row
->used
[TEXT_AREA
];
18283 if (it
->glyph_row
->truncated_on_right_p
18284 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18285 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18288 int extra
= w
- it
->truncation_pixel_width
;
18290 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18297 /* There may be padding glyphs left over. Overwrite them too. */
18298 if (!FRAME_WINDOW_P (it
->f
))
18300 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18302 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18309 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18313 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18315 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18316 that back to front. */
18317 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18318 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18319 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18320 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18321 if (FRAME_WINDOW_P (it
->f
))
18324 struct glyph
*g
= to
;
18326 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18328 w
+= g
->pixel_width
;
18331 if (to
- g
- tused
> 0)
18333 if (it
->glyph_row
->truncated_on_right_p
18334 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18335 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18337 int extra
= w
- it
->truncation_pixel_width
;
18339 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18343 while (from
>= end
&& to
>= toend
)
18345 if (!FRAME_WINDOW_P (it
->f
))
18347 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18350 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18351 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18352 while (from
>= end
&& to
>= toend
)
18358 /* Need to free some room before prepending additional
18360 int move_by
= from
- end
+ 1;
18361 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18362 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18364 for ( ; g
>= g0
; g
--)
18366 while (from
>= end
)
18368 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18373 /* Compute the hash code for ROW. */
18375 row_hash (struct glyph_row
*row
)
18378 unsigned hashval
= 0;
18380 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18381 for (k
= 0; k
< row
->used
[area
]; ++k
)
18382 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18383 + row
->glyphs
[area
][k
].u
.val
18384 + row
->glyphs
[area
][k
].face_id
18385 + row
->glyphs
[area
][k
].padding_p
18386 + (row
->glyphs
[area
][k
].type
<< 2));
18391 /* Compute the pixel height and width of IT->glyph_row.
18393 Most of the time, ascent and height of a display line will be equal
18394 to the max_ascent and max_height values of the display iterator
18395 structure. This is not the case if
18397 1. We hit ZV without displaying anything. In this case, max_ascent
18398 and max_height will be zero.
18400 2. We have some glyphs that don't contribute to the line height.
18401 (The glyph row flag contributes_to_line_height_p is for future
18402 pixmap extensions).
18404 The first case is easily covered by using default values because in
18405 these cases, the line height does not really matter, except that it
18406 must not be zero. */
18409 compute_line_metrics (struct it
*it
)
18411 struct glyph_row
*row
= it
->glyph_row
;
18413 if (FRAME_WINDOW_P (it
->f
))
18415 int i
, min_y
, max_y
;
18417 /* The line may consist of one space only, that was added to
18418 place the cursor on it. If so, the row's height hasn't been
18420 if (row
->height
== 0)
18422 if (it
->max_ascent
+ it
->max_descent
== 0)
18423 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18424 row
->ascent
= it
->max_ascent
;
18425 row
->height
= it
->max_ascent
+ it
->max_descent
;
18426 row
->phys_ascent
= it
->max_phys_ascent
;
18427 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18428 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18431 /* Compute the width of this line. */
18432 row
->pixel_width
= row
->x
;
18433 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18434 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18436 eassert (row
->pixel_width
>= 0);
18437 eassert (row
->ascent
>= 0 && row
->height
> 0);
18439 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18440 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18442 /* If first line's physical ascent is larger than its logical
18443 ascent, use the physical ascent, and make the row taller.
18444 This makes accented characters fully visible. */
18445 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18446 && row
->phys_ascent
> row
->ascent
)
18448 row
->height
+= row
->phys_ascent
- row
->ascent
;
18449 row
->ascent
= row
->phys_ascent
;
18452 /* Compute how much of the line is visible. */
18453 row
->visible_height
= row
->height
;
18455 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18456 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18458 if (row
->y
< min_y
)
18459 row
->visible_height
-= min_y
- row
->y
;
18460 if (row
->y
+ row
->height
> max_y
)
18461 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18465 row
->pixel_width
= row
->used
[TEXT_AREA
];
18466 if (row
->continued_p
)
18467 row
->pixel_width
-= it
->continuation_pixel_width
;
18468 else if (row
->truncated_on_right_p
)
18469 row
->pixel_width
-= it
->truncation_pixel_width
;
18470 row
->ascent
= row
->phys_ascent
= 0;
18471 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18472 row
->extra_line_spacing
= 0;
18475 /* Compute a hash code for this row. */
18476 row
->hash
= row_hash (row
);
18478 it
->max_ascent
= it
->max_descent
= 0;
18479 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18483 /* Append one space to the glyph row of iterator IT if doing a
18484 window-based redisplay. The space has the same face as
18485 IT->face_id. Value is non-zero if a space was added.
18487 This function is called to make sure that there is always one glyph
18488 at the end of a glyph row that the cursor can be set on under
18489 window-systems. (If there weren't such a glyph we would not know
18490 how wide and tall a box cursor should be displayed).
18492 At the same time this space let's a nicely handle clearing to the
18493 end of the line if the row ends in italic text. */
18496 append_space_for_newline (struct it
*it
, int default_face_p
)
18498 if (FRAME_WINDOW_P (it
->f
))
18500 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18502 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18503 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18505 /* Save some values that must not be changed.
18506 Must save IT->c and IT->len because otherwise
18507 ITERATOR_AT_END_P wouldn't work anymore after
18508 append_space_for_newline has been called. */
18509 enum display_element_type saved_what
= it
->what
;
18510 int saved_c
= it
->c
, saved_len
= it
->len
;
18511 int saved_char_to_display
= it
->char_to_display
;
18512 int saved_x
= it
->current_x
;
18513 int saved_face_id
= it
->face_id
;
18514 struct text_pos saved_pos
;
18515 Lisp_Object saved_object
;
18518 saved_object
= it
->object
;
18519 saved_pos
= it
->position
;
18521 it
->what
= IT_CHARACTER
;
18522 memset (&it
->position
, 0, sizeof it
->position
);
18523 it
->object
= make_number (0);
18524 it
->c
= it
->char_to_display
= ' ';
18527 /* If the default face was remapped, be sure to use the
18528 remapped face for the appended newline. */
18529 if (default_face_p
)
18530 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18531 else if (it
->face_before_selective_p
)
18532 it
->face_id
= it
->saved_face_id
;
18533 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18534 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18536 PRODUCE_GLYPHS (it
);
18538 it
->override_ascent
= -1;
18539 it
->constrain_row_ascent_descent_p
= 0;
18540 it
->current_x
= saved_x
;
18541 it
->object
= saved_object
;
18542 it
->position
= saved_pos
;
18543 it
->what
= saved_what
;
18544 it
->face_id
= saved_face_id
;
18545 it
->len
= saved_len
;
18547 it
->char_to_display
= saved_char_to_display
;
18556 /* Extend the face of the last glyph in the text area of IT->glyph_row
18557 to the end of the display line. Called from display_line. If the
18558 glyph row is empty, add a space glyph to it so that we know the
18559 face to draw. Set the glyph row flag fill_line_p. If the glyph
18560 row is R2L, prepend a stretch glyph to cover the empty space to the
18561 left of the leftmost glyph. */
18564 extend_face_to_end_of_line (struct it
*it
)
18566 struct face
*face
, *default_face
;
18567 struct frame
*f
= it
->f
;
18569 /* If line is already filled, do nothing. Non window-system frames
18570 get a grace of one more ``pixel'' because their characters are
18571 1-``pixel'' wide, so they hit the equality too early. This grace
18572 is needed only for R2L rows that are not continued, to produce
18573 one extra blank where we could display the cursor. */
18574 if (it
->current_x
>= it
->last_visible_x
18575 + (!FRAME_WINDOW_P (f
)
18576 && it
->glyph_row
->reversed_p
18577 && !it
->glyph_row
->continued_p
))
18580 /* The default face, possibly remapped. */
18581 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18583 /* Face extension extends the background and box of IT->face_id
18584 to the end of the line. If the background equals the background
18585 of the frame, we don't have to do anything. */
18586 if (it
->face_before_selective_p
)
18587 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18589 face
= FACE_FROM_ID (f
, it
->face_id
);
18591 if (FRAME_WINDOW_P (f
)
18592 && it
->glyph_row
->displays_text_p
18593 && face
->box
== FACE_NO_BOX
18594 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18596 && !it
->glyph_row
->reversed_p
)
18599 /* Set the glyph row flag indicating that the face of the last glyph
18600 in the text area has to be drawn to the end of the text area. */
18601 it
->glyph_row
->fill_line_p
= 1;
18603 /* If current character of IT is not ASCII, make sure we have the
18604 ASCII face. This will be automatically undone the next time
18605 get_next_display_element returns a multibyte character. Note
18606 that the character will always be single byte in unibyte
18608 if (!ASCII_CHAR_P (it
->c
))
18610 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18613 if (FRAME_WINDOW_P (f
))
18615 /* If the row is empty, add a space with the current face of IT,
18616 so that we know which face to draw. */
18617 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18619 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18620 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18621 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18623 #ifdef HAVE_WINDOW_SYSTEM
18624 if (it
->glyph_row
->reversed_p
)
18626 /* Prepend a stretch glyph to the row, such that the
18627 rightmost glyph will be drawn flushed all the way to the
18628 right margin of the window. The stretch glyph that will
18629 occupy the empty space, if any, to the left of the
18631 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18632 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18633 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18635 int row_width
, stretch_ascent
, stretch_width
;
18636 struct text_pos saved_pos
;
18637 int saved_face_id
, saved_avoid_cursor
;
18639 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18640 row_width
+= g
->pixel_width
;
18641 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18642 if (stretch_width
> 0)
18645 (((it
->ascent
+ it
->descent
)
18646 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18647 saved_pos
= it
->position
;
18648 memset (&it
->position
, 0, sizeof it
->position
);
18649 saved_avoid_cursor
= it
->avoid_cursor_p
;
18650 it
->avoid_cursor_p
= 1;
18651 saved_face_id
= it
->face_id
;
18652 /* The last row's stretch glyph should get the default
18653 face, to avoid painting the rest of the window with
18654 the region face, if the region ends at ZV. */
18655 if (it
->glyph_row
->ends_at_zv_p
)
18656 it
->face_id
= default_face
->id
;
18658 it
->face_id
= face
->id
;
18659 append_stretch_glyph (it
, make_number (0), stretch_width
,
18660 it
->ascent
+ it
->descent
, stretch_ascent
);
18661 it
->position
= saved_pos
;
18662 it
->avoid_cursor_p
= saved_avoid_cursor
;
18663 it
->face_id
= saved_face_id
;
18666 #endif /* HAVE_WINDOW_SYSTEM */
18670 /* Save some values that must not be changed. */
18671 int saved_x
= it
->current_x
;
18672 struct text_pos saved_pos
;
18673 Lisp_Object saved_object
;
18674 enum display_element_type saved_what
= it
->what
;
18675 int saved_face_id
= it
->face_id
;
18677 saved_object
= it
->object
;
18678 saved_pos
= it
->position
;
18680 it
->what
= IT_CHARACTER
;
18681 memset (&it
->position
, 0, sizeof it
->position
);
18682 it
->object
= make_number (0);
18683 it
->c
= it
->char_to_display
= ' ';
18685 /* The last row's blank glyphs should get the default face, to
18686 avoid painting the rest of the window with the region face,
18687 if the region ends at ZV. */
18688 if (it
->glyph_row
->ends_at_zv_p
)
18689 it
->face_id
= default_face
->id
;
18691 it
->face_id
= face
->id
;
18693 PRODUCE_GLYPHS (it
);
18695 while (it
->current_x
<= it
->last_visible_x
)
18696 PRODUCE_GLYPHS (it
);
18698 /* Don't count these blanks really. It would let us insert a left
18699 truncation glyph below and make us set the cursor on them, maybe. */
18700 it
->current_x
= saved_x
;
18701 it
->object
= saved_object
;
18702 it
->position
= saved_pos
;
18703 it
->what
= saved_what
;
18704 it
->face_id
= saved_face_id
;
18709 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18710 trailing whitespace. */
18713 trailing_whitespace_p (ptrdiff_t charpos
)
18715 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18718 while (bytepos
< ZV_BYTE
18719 && (c
= FETCH_CHAR (bytepos
),
18720 c
== ' ' || c
== '\t'))
18723 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18725 if (bytepos
!= PT_BYTE
)
18732 /* Highlight trailing whitespace, if any, in ROW. */
18735 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18737 int used
= row
->used
[TEXT_AREA
];
18741 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18742 struct glyph
*glyph
= start
+ used
- 1;
18744 if (row
->reversed_p
)
18746 /* Right-to-left rows need to be processed in the opposite
18747 direction, so swap the edge pointers. */
18749 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18752 /* Skip over glyphs inserted to display the cursor at the
18753 end of a line, for extending the face of the last glyph
18754 to the end of the line on terminals, and for truncation
18755 and continuation glyphs. */
18756 if (!row
->reversed_p
)
18758 while (glyph
>= start
18759 && glyph
->type
== CHAR_GLYPH
18760 && INTEGERP (glyph
->object
))
18765 while (glyph
<= start
18766 && glyph
->type
== CHAR_GLYPH
18767 && INTEGERP (glyph
->object
))
18771 /* If last glyph is a space or stretch, and it's trailing
18772 whitespace, set the face of all trailing whitespace glyphs in
18773 IT->glyph_row to `trailing-whitespace'. */
18774 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18775 && BUFFERP (glyph
->object
)
18776 && (glyph
->type
== STRETCH_GLYPH
18777 || (glyph
->type
== CHAR_GLYPH
18778 && glyph
->u
.ch
== ' '))
18779 && trailing_whitespace_p (glyph
->charpos
))
18781 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18785 if (!row
->reversed_p
)
18787 while (glyph
>= start
18788 && BUFFERP (glyph
->object
)
18789 && (glyph
->type
== STRETCH_GLYPH
18790 || (glyph
->type
== CHAR_GLYPH
18791 && glyph
->u
.ch
== ' ')))
18792 (glyph
--)->face_id
= face_id
;
18796 while (glyph
<= start
18797 && BUFFERP (glyph
->object
)
18798 && (glyph
->type
== STRETCH_GLYPH
18799 || (glyph
->type
== CHAR_GLYPH
18800 && glyph
->u
.ch
== ' ')))
18801 (glyph
++)->face_id
= face_id
;
18808 /* Value is non-zero if glyph row ROW should be
18809 used to hold the cursor. */
18812 cursor_row_p (struct glyph_row
*row
)
18816 if (PT
== CHARPOS (row
->end
.pos
)
18817 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18819 /* Suppose the row ends on a string.
18820 Unless the row is continued, that means it ends on a newline
18821 in the string. If it's anything other than a display string
18822 (e.g., a before-string from an overlay), we don't want the
18823 cursor there. (This heuristic seems to give the optimal
18824 behavior for the various types of multi-line strings.)
18825 One exception: if the string has `cursor' property on one of
18826 its characters, we _do_ want the cursor there. */
18827 if (CHARPOS (row
->end
.string_pos
) >= 0)
18829 if (row
->continued_p
)
18833 /* Check for `display' property. */
18834 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18835 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18836 struct glyph
*glyph
;
18839 for (glyph
= end
; glyph
>= beg
; --glyph
)
18840 if (STRINGP (glyph
->object
))
18843 = Fget_char_property (make_number (PT
),
18847 && display_prop_string_p (prop
, glyph
->object
));
18848 /* If there's a `cursor' property on one of the
18849 string's characters, this row is a cursor row,
18850 even though this is not a display string. */
18853 Lisp_Object s
= glyph
->object
;
18855 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18857 ptrdiff_t gpos
= glyph
->charpos
;
18859 if (!NILP (Fget_char_property (make_number (gpos
),
18871 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18873 /* If the row ends in middle of a real character,
18874 and the line is continued, we want the cursor here.
18875 That's because CHARPOS (ROW->end.pos) would equal
18876 PT if PT is before the character. */
18877 if (!row
->ends_in_ellipsis_p
)
18878 result
= row
->continued_p
;
18880 /* If the row ends in an ellipsis, then
18881 CHARPOS (ROW->end.pos) will equal point after the
18882 invisible text. We want that position to be displayed
18883 after the ellipsis. */
18886 /* If the row ends at ZV, display the cursor at the end of that
18887 row instead of at the start of the row below. */
18888 else if (row
->ends_at_zv_p
)
18899 /* Push the property PROP so that it will be rendered at the current
18900 position in IT. Return 1 if PROP was successfully pushed, 0
18901 otherwise. Called from handle_line_prefix to handle the
18902 `line-prefix' and `wrap-prefix' properties. */
18905 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18907 struct text_pos pos
=
18908 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18910 eassert (it
->method
== GET_FROM_BUFFER
18911 || it
->method
== GET_FROM_DISPLAY_VECTOR
18912 || it
->method
== GET_FROM_STRING
);
18914 /* We need to save the current buffer/string position, so it will be
18915 restored by pop_it, because iterate_out_of_display_property
18916 depends on that being set correctly, but some situations leave
18917 it->position not yet set when this function is called. */
18918 push_it (it
, &pos
);
18920 if (STRINGP (prop
))
18922 if (SCHARS (prop
) == 0)
18929 it
->string_from_prefix_prop_p
= 1;
18930 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18931 it
->current
.overlay_string_index
= -1;
18932 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18933 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18934 it
->method
= GET_FROM_STRING
;
18935 it
->stop_charpos
= 0;
18937 it
->base_level_stop
= 0;
18939 /* Force paragraph direction to be that of the parent
18941 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18942 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18944 it
->paragraph_embedding
= L2R
;
18946 /* Set up the bidi iterator for this display string. */
18949 it
->bidi_it
.string
.lstring
= it
->string
;
18950 it
->bidi_it
.string
.s
= NULL
;
18951 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18952 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18953 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18954 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18955 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18958 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18960 it
->method
= GET_FROM_STRETCH
;
18963 #ifdef HAVE_WINDOW_SYSTEM
18964 else if (IMAGEP (prop
))
18966 it
->what
= IT_IMAGE
;
18967 it
->image_id
= lookup_image (it
->f
, prop
);
18968 it
->method
= GET_FROM_IMAGE
;
18970 #endif /* HAVE_WINDOW_SYSTEM */
18973 pop_it (it
); /* bogus display property, give up */
18980 /* Return the character-property PROP at the current position in IT. */
18983 get_it_property (struct it
*it
, Lisp_Object prop
)
18985 Lisp_Object position
;
18987 if (STRINGP (it
->object
))
18988 position
= make_number (IT_STRING_CHARPOS (*it
));
18989 else if (BUFFERP (it
->object
))
18990 position
= make_number (IT_CHARPOS (*it
));
18994 return Fget_char_property (position
, prop
, it
->object
);
18997 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19000 handle_line_prefix (struct it
*it
)
19002 Lisp_Object prefix
;
19004 if (it
->continuation_lines_width
> 0)
19006 prefix
= get_it_property (it
, Qwrap_prefix
);
19008 prefix
= Vwrap_prefix
;
19012 prefix
= get_it_property (it
, Qline_prefix
);
19014 prefix
= Vline_prefix
;
19016 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19018 /* If the prefix is wider than the window, and we try to wrap
19019 it, it would acquire its own wrap prefix, and so on till the
19020 iterator stack overflows. So, don't wrap the prefix. */
19021 it
->line_wrap
= TRUNCATE
;
19022 it
->avoid_cursor_p
= 1;
19028 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19029 only for R2L lines from display_line and display_string, when they
19030 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19031 the line/string needs to be continued on the next glyph row. */
19033 unproduce_glyphs (struct it
*it
, int n
)
19035 struct glyph
*glyph
, *end
;
19037 eassert (it
->glyph_row
);
19038 eassert (it
->glyph_row
->reversed_p
);
19039 eassert (it
->area
== TEXT_AREA
);
19040 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19042 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19043 n
= it
->glyph_row
->used
[TEXT_AREA
];
19044 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19045 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19046 for ( ; glyph
< end
; glyph
++)
19047 glyph
[-n
] = *glyph
;
19050 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19051 and ROW->maxpos. */
19053 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19054 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19055 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19057 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19058 lines' rows is implemented for bidi-reordered rows. */
19060 /* ROW->minpos is the value of min_pos, the minimal buffer position
19061 we have in ROW, or ROW->start.pos if that is smaller. */
19062 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19063 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19065 /* We didn't find buffer positions smaller than ROW->start, or
19066 didn't find _any_ valid buffer positions in any of the glyphs,
19067 so we must trust the iterator's computed positions. */
19068 row
->minpos
= row
->start
.pos
;
19071 max_pos
= CHARPOS (it
->current
.pos
);
19072 max_bpos
= BYTEPOS (it
->current
.pos
);
19075 /* Here are the various use-cases for ending the row, and the
19076 corresponding values for ROW->maxpos:
19078 Line ends in a newline from buffer eol_pos + 1
19079 Line is continued from buffer max_pos + 1
19080 Line is truncated on right it->current.pos
19081 Line ends in a newline from string max_pos + 1(*)
19082 (*) + 1 only when line ends in a forward scan
19083 Line is continued from string max_pos
19084 Line is continued from display vector max_pos
19085 Line is entirely from a string min_pos == max_pos
19086 Line is entirely from a display vector min_pos == max_pos
19087 Line that ends at ZV ZV
19089 If you discover other use-cases, please add them here as
19091 if (row
->ends_at_zv_p
)
19092 row
->maxpos
= it
->current
.pos
;
19093 else if (row
->used
[TEXT_AREA
])
19095 int seen_this_string
= 0;
19096 struct glyph_row
*r1
= row
- 1;
19098 /* Did we see the same display string on the previous row? */
19099 if (STRINGP (it
->object
)
19100 /* this is not the first row */
19101 && row
> it
->w
->desired_matrix
->rows
19102 /* previous row is not the header line */
19103 && !r1
->mode_line_p
19104 /* previous row also ends in a newline from a string */
19105 && r1
->ends_in_newline_from_string_p
)
19107 struct glyph
*start
, *end
;
19109 /* Search for the last glyph of the previous row that came
19110 from buffer or string. Depending on whether the row is
19111 L2R or R2L, we need to process it front to back or the
19112 other way round. */
19113 if (!r1
->reversed_p
)
19115 start
= r1
->glyphs
[TEXT_AREA
];
19116 end
= start
+ r1
->used
[TEXT_AREA
];
19117 /* Glyphs inserted by redisplay have an integer (zero)
19118 as their object. */
19120 && INTEGERP ((end
- 1)->object
)
19121 && (end
- 1)->charpos
<= 0)
19125 if (EQ ((end
- 1)->object
, it
->object
))
19126 seen_this_string
= 1;
19129 /* If all the glyphs of the previous row were inserted
19130 by redisplay, it means the previous row was
19131 produced from a single newline, which is only
19132 possible if that newline came from the same string
19133 as the one which produced this ROW. */
19134 seen_this_string
= 1;
19138 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19139 start
= end
+ r1
->used
[TEXT_AREA
];
19141 && INTEGERP ((end
+ 1)->object
)
19142 && (end
+ 1)->charpos
<= 0)
19146 if (EQ ((end
+ 1)->object
, it
->object
))
19147 seen_this_string
= 1;
19150 seen_this_string
= 1;
19153 /* Take note of each display string that covers a newline only
19154 once, the first time we see it. This is for when a display
19155 string includes more than one newline in it. */
19156 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19158 /* If we were scanning the buffer forward when we displayed
19159 the string, we want to account for at least one buffer
19160 position that belongs to this row (position covered by
19161 the display string), so that cursor positioning will
19162 consider this row as a candidate when point is at the end
19163 of the visual line represented by this row. This is not
19164 required when scanning back, because max_pos will already
19165 have a much larger value. */
19166 if (CHARPOS (row
->end
.pos
) > max_pos
)
19167 INC_BOTH (max_pos
, max_bpos
);
19168 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19170 else if (CHARPOS (it
->eol_pos
) > 0)
19171 SET_TEXT_POS (row
->maxpos
,
19172 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19173 else if (row
->continued_p
)
19175 /* If max_pos is different from IT's current position, it
19176 means IT->method does not belong to the display element
19177 at max_pos. However, it also means that the display
19178 element at max_pos was displayed in its entirety on this
19179 line, which is equivalent to saying that the next line
19180 starts at the next buffer position. */
19181 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19182 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19185 INC_BOTH (max_pos
, max_bpos
);
19186 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19189 else if (row
->truncated_on_right_p
)
19190 /* display_line already called reseat_at_next_visible_line_start,
19191 which puts the iterator at the beginning of the next line, in
19192 the logical order. */
19193 row
->maxpos
= it
->current
.pos
;
19194 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19195 /* A line that is entirely from a string/image/stretch... */
19196 row
->maxpos
= row
->minpos
;
19201 row
->maxpos
= it
->current
.pos
;
19204 /* Construct the glyph row IT->glyph_row in the desired matrix of
19205 IT->w from text at the current position of IT. See dispextern.h
19206 for an overview of struct it. Value is non-zero if
19207 IT->glyph_row displays text, as opposed to a line displaying ZV
19211 display_line (struct it
*it
)
19213 struct glyph_row
*row
= it
->glyph_row
;
19214 Lisp_Object overlay_arrow_string
;
19216 void *wrap_data
= NULL
;
19217 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19218 int wrap_row_used
= -1;
19219 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19220 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19221 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19222 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19223 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19225 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19226 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19228 /* We always start displaying at hpos zero even if hscrolled. */
19229 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19231 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19232 >= it
->w
->desired_matrix
->nrows
)
19234 it
->w
->nrows_scale_factor
++;
19235 fonts_changed_p
= 1;
19239 /* Is IT->w showing the region? */
19240 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
19242 /* Clear the result glyph row and enable it. */
19243 prepare_desired_row (row
);
19245 row
->y
= it
->current_y
;
19246 row
->start
= it
->start
;
19247 row
->continuation_lines_width
= it
->continuation_lines_width
;
19248 row
->displays_text_p
= 1;
19249 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19250 it
->starts_in_middle_of_char_p
= 0;
19252 /* Arrange the overlays nicely for our purposes. Usually, we call
19253 display_line on only one line at a time, in which case this
19254 can't really hurt too much, or we call it on lines which appear
19255 one after another in the buffer, in which case all calls to
19256 recenter_overlay_lists but the first will be pretty cheap. */
19257 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19259 /* Move over display elements that are not visible because we are
19260 hscrolled. This may stop at an x-position < IT->first_visible_x
19261 if the first glyph is partially visible or if we hit a line end. */
19262 if (it
->current_x
< it
->first_visible_x
)
19264 enum move_it_result move_result
;
19266 this_line_min_pos
= row
->start
.pos
;
19267 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19268 MOVE_TO_POS
| MOVE_TO_X
);
19269 /* If we are under a large hscroll, move_it_in_display_line_to
19270 could hit the end of the line without reaching
19271 it->first_visible_x. Pretend that we did reach it. This is
19272 especially important on a TTY, where we will call
19273 extend_face_to_end_of_line, which needs to know how many
19274 blank glyphs to produce. */
19275 if (it
->current_x
< it
->first_visible_x
19276 && (move_result
== MOVE_NEWLINE_OR_CR
19277 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19278 it
->current_x
= it
->first_visible_x
;
19280 /* Record the smallest positions seen while we moved over
19281 display elements that are not visible. This is needed by
19282 redisplay_internal for optimizing the case where the cursor
19283 stays inside the same line. The rest of this function only
19284 considers positions that are actually displayed, so
19285 RECORD_MAX_MIN_POS will not otherwise record positions that
19286 are hscrolled to the left of the left edge of the window. */
19287 min_pos
= CHARPOS (this_line_min_pos
);
19288 min_bpos
= BYTEPOS (this_line_min_pos
);
19292 /* We only do this when not calling `move_it_in_display_line_to'
19293 above, because move_it_in_display_line_to calls
19294 handle_line_prefix itself. */
19295 handle_line_prefix (it
);
19298 /* Get the initial row height. This is either the height of the
19299 text hscrolled, if there is any, or zero. */
19300 row
->ascent
= it
->max_ascent
;
19301 row
->height
= it
->max_ascent
+ it
->max_descent
;
19302 row
->phys_ascent
= it
->max_phys_ascent
;
19303 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19304 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19306 /* Utility macro to record max and min buffer positions seen until now. */
19307 #define RECORD_MAX_MIN_POS(IT) \
19310 int composition_p = !STRINGP ((IT)->string) \
19311 && ((IT)->what == IT_COMPOSITION); \
19312 ptrdiff_t current_pos = \
19313 composition_p ? (IT)->cmp_it.charpos \
19314 : IT_CHARPOS (*(IT)); \
19315 ptrdiff_t current_bpos = \
19316 composition_p ? CHAR_TO_BYTE (current_pos) \
19317 : IT_BYTEPOS (*(IT)); \
19318 if (current_pos < min_pos) \
19320 min_pos = current_pos; \
19321 min_bpos = current_bpos; \
19323 if (IT_CHARPOS (*it) > max_pos) \
19325 max_pos = IT_CHARPOS (*it); \
19326 max_bpos = IT_BYTEPOS (*it); \
19331 /* Loop generating characters. The loop is left with IT on the next
19332 character to display. */
19335 int n_glyphs_before
, hpos_before
, x_before
;
19337 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19339 /* Retrieve the next thing to display. Value is zero if end of
19341 if (!get_next_display_element (it
))
19343 /* Maybe add a space at the end of this line that is used to
19344 display the cursor there under X. Set the charpos of the
19345 first glyph of blank lines not corresponding to any text
19347 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19348 row
->exact_window_width_line_p
= 1;
19349 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19350 || row
->used
[TEXT_AREA
] == 0)
19352 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19353 row
->displays_text_p
= 0;
19355 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19356 && (!MINI_WINDOW_P (it
->w
)
19357 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19358 row
->indicate_empty_line_p
= 1;
19361 it
->continuation_lines_width
= 0;
19362 row
->ends_at_zv_p
= 1;
19363 /* A row that displays right-to-left text must always have
19364 its last face extended all the way to the end of line,
19365 even if this row ends in ZV, because we still write to
19366 the screen left to right. We also need to extend the
19367 last face if the default face is remapped to some
19368 different face, otherwise the functions that clear
19369 portions of the screen will clear with the default face's
19370 background color. */
19371 if (row
->reversed_p
19372 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19373 extend_face_to_end_of_line (it
);
19377 /* Now, get the metrics of what we want to display. This also
19378 generates glyphs in `row' (which is IT->glyph_row). */
19379 n_glyphs_before
= row
->used
[TEXT_AREA
];
19382 /* Remember the line height so far in case the next element doesn't
19383 fit on the line. */
19384 if (it
->line_wrap
!= TRUNCATE
)
19386 ascent
= it
->max_ascent
;
19387 descent
= it
->max_descent
;
19388 phys_ascent
= it
->max_phys_ascent
;
19389 phys_descent
= it
->max_phys_descent
;
19391 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19393 if (IT_DISPLAYING_WHITESPACE (it
))
19397 SAVE_IT (wrap_it
, *it
, wrap_data
);
19399 wrap_row_used
= row
->used
[TEXT_AREA
];
19400 wrap_row_ascent
= row
->ascent
;
19401 wrap_row_height
= row
->height
;
19402 wrap_row_phys_ascent
= row
->phys_ascent
;
19403 wrap_row_phys_height
= row
->phys_height
;
19404 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19405 wrap_row_min_pos
= min_pos
;
19406 wrap_row_min_bpos
= min_bpos
;
19407 wrap_row_max_pos
= max_pos
;
19408 wrap_row_max_bpos
= max_bpos
;
19414 PRODUCE_GLYPHS (it
);
19416 /* If this display element was in marginal areas, continue with
19418 if (it
->area
!= TEXT_AREA
)
19420 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19421 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19422 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19423 row
->phys_height
= max (row
->phys_height
,
19424 it
->max_phys_ascent
+ it
->max_phys_descent
);
19425 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19426 it
->max_extra_line_spacing
);
19427 set_iterator_to_next (it
, 1);
19431 /* Does the display element fit on the line? If we truncate
19432 lines, we should draw past the right edge of the window. If
19433 we don't truncate, we want to stop so that we can display the
19434 continuation glyph before the right margin. If lines are
19435 continued, there are two possible strategies for characters
19436 resulting in more than 1 glyph (e.g. tabs): Display as many
19437 glyphs as possible in this line and leave the rest for the
19438 continuation line, or display the whole element in the next
19439 line. Original redisplay did the former, so we do it also. */
19440 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19441 hpos_before
= it
->hpos
;
19444 if (/* Not a newline. */
19446 /* Glyphs produced fit entirely in the line. */
19447 && it
->current_x
< it
->last_visible_x
)
19449 it
->hpos
+= nglyphs
;
19450 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19451 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19452 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19453 row
->phys_height
= max (row
->phys_height
,
19454 it
->max_phys_ascent
+ it
->max_phys_descent
);
19455 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19456 it
->max_extra_line_spacing
);
19457 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19458 row
->x
= x
- it
->first_visible_x
;
19459 /* Record the maximum and minimum buffer positions seen so
19460 far in glyphs that will be displayed by this row. */
19462 RECORD_MAX_MIN_POS (it
);
19467 struct glyph
*glyph
;
19469 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19471 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19472 new_x
= x
+ glyph
->pixel_width
;
19474 if (/* Lines are continued. */
19475 it
->line_wrap
!= TRUNCATE
19476 && (/* Glyph doesn't fit on the line. */
19477 new_x
> it
->last_visible_x
19478 /* Or it fits exactly on a window system frame. */
19479 || (new_x
== it
->last_visible_x
19480 && FRAME_WINDOW_P (it
->f
)
19481 && (row
->reversed_p
19482 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19483 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19485 /* End of a continued line. */
19488 || (new_x
== it
->last_visible_x
19489 && FRAME_WINDOW_P (it
->f
)
19490 && (row
->reversed_p
19491 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19492 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19494 /* Current glyph is the only one on the line or
19495 fits exactly on the line. We must continue
19496 the line because we can't draw the cursor
19497 after the glyph. */
19498 row
->continued_p
= 1;
19499 it
->current_x
= new_x
;
19500 it
->continuation_lines_width
+= new_x
;
19502 if (i
== nglyphs
- 1)
19504 /* If line-wrap is on, check if a previous
19505 wrap point was found. */
19506 if (wrap_row_used
> 0
19507 /* Even if there is a previous wrap
19508 point, continue the line here as
19509 usual, if (i) the previous character
19510 was a space or tab AND (ii) the
19511 current character is not. */
19513 || IT_DISPLAYING_WHITESPACE (it
)))
19516 /* Record the maximum and minimum buffer
19517 positions seen so far in glyphs that will be
19518 displayed by this row. */
19520 RECORD_MAX_MIN_POS (it
);
19521 set_iterator_to_next (it
, 1);
19522 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19524 if (!get_next_display_element (it
))
19526 row
->exact_window_width_line_p
= 1;
19527 it
->continuation_lines_width
= 0;
19528 row
->continued_p
= 0;
19529 row
->ends_at_zv_p
= 1;
19531 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19533 row
->continued_p
= 0;
19534 row
->exact_window_width_line_p
= 1;
19538 else if (it
->bidi_p
)
19539 RECORD_MAX_MIN_POS (it
);
19541 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19542 && !FRAME_WINDOW_P (it
->f
))
19544 /* A padding glyph that doesn't fit on this line.
19545 This means the whole character doesn't fit
19547 if (row
->reversed_p
)
19548 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19549 - n_glyphs_before
);
19550 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19552 /* Fill the rest of the row with continuation
19553 glyphs like in 20.x. */
19554 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19555 < row
->glyphs
[1 + TEXT_AREA
])
19556 produce_special_glyphs (it
, IT_CONTINUATION
);
19558 row
->continued_p
= 1;
19559 it
->current_x
= x_before
;
19560 it
->continuation_lines_width
+= x_before
;
19562 /* Restore the height to what it was before the
19563 element not fitting on the line. */
19564 it
->max_ascent
= ascent
;
19565 it
->max_descent
= descent
;
19566 it
->max_phys_ascent
= phys_ascent
;
19567 it
->max_phys_descent
= phys_descent
;
19569 else if (wrap_row_used
> 0)
19572 if (row
->reversed_p
)
19573 unproduce_glyphs (it
,
19574 row
->used
[TEXT_AREA
] - wrap_row_used
);
19575 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19576 it
->continuation_lines_width
+= wrap_x
;
19577 row
->used
[TEXT_AREA
] = wrap_row_used
;
19578 row
->ascent
= wrap_row_ascent
;
19579 row
->height
= wrap_row_height
;
19580 row
->phys_ascent
= wrap_row_phys_ascent
;
19581 row
->phys_height
= wrap_row_phys_height
;
19582 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19583 min_pos
= wrap_row_min_pos
;
19584 min_bpos
= wrap_row_min_bpos
;
19585 max_pos
= wrap_row_max_pos
;
19586 max_bpos
= wrap_row_max_bpos
;
19587 row
->continued_p
= 1;
19588 row
->ends_at_zv_p
= 0;
19589 row
->exact_window_width_line_p
= 0;
19590 it
->continuation_lines_width
+= x
;
19592 /* Make sure that a non-default face is extended
19593 up to the right margin of the window. */
19594 extend_face_to_end_of_line (it
);
19596 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19598 /* A TAB that extends past the right edge of the
19599 window. This produces a single glyph on
19600 window system frames. We leave the glyph in
19601 this row and let it fill the row, but don't
19602 consume the TAB. */
19603 if ((row
->reversed_p
19604 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19605 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19606 produce_special_glyphs (it
, IT_CONTINUATION
);
19607 it
->continuation_lines_width
+= it
->last_visible_x
;
19608 row
->ends_in_middle_of_char_p
= 1;
19609 row
->continued_p
= 1;
19610 glyph
->pixel_width
= it
->last_visible_x
- x
;
19611 it
->starts_in_middle_of_char_p
= 1;
19615 /* Something other than a TAB that draws past
19616 the right edge of the window. Restore
19617 positions to values before the element. */
19618 if (row
->reversed_p
)
19619 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19620 - (n_glyphs_before
+ i
));
19621 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19623 /* Display continuation glyphs. */
19624 it
->current_x
= x_before
;
19625 it
->continuation_lines_width
+= x
;
19626 if (!FRAME_WINDOW_P (it
->f
)
19627 || (row
->reversed_p
19628 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19629 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19630 produce_special_glyphs (it
, IT_CONTINUATION
);
19631 row
->continued_p
= 1;
19633 extend_face_to_end_of_line (it
);
19635 if (nglyphs
> 1 && i
> 0)
19637 row
->ends_in_middle_of_char_p
= 1;
19638 it
->starts_in_middle_of_char_p
= 1;
19641 /* Restore the height to what it was before the
19642 element not fitting on the line. */
19643 it
->max_ascent
= ascent
;
19644 it
->max_descent
= descent
;
19645 it
->max_phys_ascent
= phys_ascent
;
19646 it
->max_phys_descent
= phys_descent
;
19651 else if (new_x
> it
->first_visible_x
)
19653 /* Increment number of glyphs actually displayed. */
19656 /* Record the maximum and minimum buffer positions
19657 seen so far in glyphs that will be displayed by
19660 RECORD_MAX_MIN_POS (it
);
19662 if (x
< it
->first_visible_x
)
19663 /* Glyph is partially visible, i.e. row starts at
19664 negative X position. */
19665 row
->x
= x
- it
->first_visible_x
;
19669 /* Glyph is completely off the left margin of the
19670 window. This should not happen because of the
19671 move_it_in_display_line at the start of this
19672 function, unless the text display area of the
19673 window is empty. */
19674 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19677 /* Even if this display element produced no glyphs at all,
19678 we want to record its position. */
19679 if (it
->bidi_p
&& nglyphs
== 0)
19680 RECORD_MAX_MIN_POS (it
);
19682 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19683 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19684 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19685 row
->phys_height
= max (row
->phys_height
,
19686 it
->max_phys_ascent
+ it
->max_phys_descent
);
19687 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19688 it
->max_extra_line_spacing
);
19690 /* End of this display line if row is continued. */
19691 if (row
->continued_p
|| row
->ends_at_zv_p
)
19696 /* Is this a line end? If yes, we're also done, after making
19697 sure that a non-default face is extended up to the right
19698 margin of the window. */
19699 if (ITERATOR_AT_END_OF_LINE_P (it
))
19701 int used_before
= row
->used
[TEXT_AREA
];
19703 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19705 /* Add a space at the end of the line that is used to
19706 display the cursor there. */
19707 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19708 append_space_for_newline (it
, 0);
19710 /* Extend the face to the end of the line. */
19711 extend_face_to_end_of_line (it
);
19713 /* Make sure we have the position. */
19714 if (used_before
== 0)
19715 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19717 /* Record the position of the newline, for use in
19719 it
->eol_pos
= it
->current
.pos
;
19721 /* Consume the line end. This skips over invisible lines. */
19722 set_iterator_to_next (it
, 1);
19723 it
->continuation_lines_width
= 0;
19727 /* Proceed with next display element. Note that this skips
19728 over lines invisible because of selective display. */
19729 set_iterator_to_next (it
, 1);
19731 /* If we truncate lines, we are done when the last displayed
19732 glyphs reach past the right margin of the window. */
19733 if (it
->line_wrap
== TRUNCATE
19734 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19735 ? (it
->current_x
>= it
->last_visible_x
)
19736 : (it
->current_x
> it
->last_visible_x
)))
19738 /* Maybe add truncation glyphs. */
19739 if (!FRAME_WINDOW_P (it
->f
)
19740 || (row
->reversed_p
19741 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19742 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19746 if (!row
->reversed_p
)
19748 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19749 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19754 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19755 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19757 /* Remove any padding glyphs at the front of ROW, to
19758 make room for the truncation glyphs we will be
19759 adding below. The loop below always inserts at
19760 least one truncation glyph, so also remove the
19761 last glyph added to ROW. */
19762 unproduce_glyphs (it
, i
+ 1);
19763 /* Adjust i for the loop below. */
19764 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19767 it
->current_x
= x_before
;
19768 if (!FRAME_WINDOW_P (it
->f
))
19770 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19772 row
->used
[TEXT_AREA
] = i
;
19773 produce_special_glyphs (it
, IT_TRUNCATION
);
19778 row
->used
[TEXT_AREA
] = i
;
19779 produce_special_glyphs (it
, IT_TRUNCATION
);
19782 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19784 /* Don't truncate if we can overflow newline into fringe. */
19785 if (!get_next_display_element (it
))
19787 it
->continuation_lines_width
= 0;
19788 row
->ends_at_zv_p
= 1;
19789 row
->exact_window_width_line_p
= 1;
19792 if (ITERATOR_AT_END_OF_LINE_P (it
))
19794 row
->exact_window_width_line_p
= 1;
19795 goto at_end_of_line
;
19797 it
->current_x
= x_before
;
19800 row
->truncated_on_right_p
= 1;
19801 it
->continuation_lines_width
= 0;
19802 reseat_at_next_visible_line_start (it
, 0);
19803 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19804 it
->hpos
= hpos_before
;
19810 bidi_unshelve_cache (wrap_data
, 1);
19812 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19813 at the left window margin. */
19814 if (it
->first_visible_x
19815 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19817 if (!FRAME_WINDOW_P (it
->f
)
19818 || (row
->reversed_p
19819 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19820 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19821 insert_left_trunc_glyphs (it
);
19822 row
->truncated_on_left_p
= 1;
19825 /* Remember the position at which this line ends.
19827 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19828 cannot be before the call to find_row_edges below, since that is
19829 where these positions are determined. */
19830 row
->end
= it
->current
;
19833 row
->minpos
= row
->start
.pos
;
19834 row
->maxpos
= row
->end
.pos
;
19838 /* ROW->minpos and ROW->maxpos must be the smallest and
19839 `1 + the largest' buffer positions in ROW. But if ROW was
19840 bidi-reordered, these two positions can be anywhere in the
19841 row, so we must determine them now. */
19842 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19845 /* If the start of this line is the overlay arrow-position, then
19846 mark this glyph row as the one containing the overlay arrow.
19847 This is clearly a mess with variable size fonts. It would be
19848 better to let it be displayed like cursors under X. */
19849 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19850 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19851 !NILP (overlay_arrow_string
)))
19853 /* Overlay arrow in window redisplay is a fringe bitmap. */
19854 if (STRINGP (overlay_arrow_string
))
19856 struct glyph_row
*arrow_row
19857 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19858 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19859 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19860 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19861 struct glyph
*p2
, *end
;
19863 /* Copy the arrow glyphs. */
19864 while (glyph
< arrow_end
)
19867 /* Throw away padding glyphs. */
19869 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19870 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19876 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19881 eassert (INTEGERP (overlay_arrow_string
));
19882 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19884 overlay_arrow_seen
= 1;
19887 /* Highlight trailing whitespace. */
19888 if (!NILP (Vshow_trailing_whitespace
))
19889 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19891 /* Compute pixel dimensions of this line. */
19892 compute_line_metrics (it
);
19894 /* Implementation note: No changes in the glyphs of ROW or in their
19895 faces can be done past this point, because compute_line_metrics
19896 computes ROW's hash value and stores it within the glyph_row
19899 /* Record whether this row ends inside an ellipsis. */
19900 row
->ends_in_ellipsis_p
19901 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19902 && it
->ellipsis_p
);
19904 /* Save fringe bitmaps in this row. */
19905 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19906 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19907 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19908 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19910 it
->left_user_fringe_bitmap
= 0;
19911 it
->left_user_fringe_face_id
= 0;
19912 it
->right_user_fringe_bitmap
= 0;
19913 it
->right_user_fringe_face_id
= 0;
19915 /* Maybe set the cursor. */
19916 cvpos
= it
->w
->cursor
.vpos
;
19918 /* In bidi-reordered rows, keep checking for proper cursor
19919 position even if one has been found already, because buffer
19920 positions in such rows change non-linearly with ROW->VPOS,
19921 when a line is continued. One exception: when we are at ZV,
19922 display cursor on the first suitable glyph row, since all
19923 the empty rows after that also have their position set to ZV. */
19924 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19925 lines' rows is implemented for bidi-reordered rows. */
19927 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19928 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19929 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19930 && cursor_row_p (row
))
19931 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19933 /* Prepare for the next line. This line starts horizontally at (X
19934 HPOS) = (0 0). Vertical positions are incremented. As a
19935 convenience for the caller, IT->glyph_row is set to the next
19937 it
->current_x
= it
->hpos
= 0;
19938 it
->current_y
+= row
->height
;
19939 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19942 /* The next row should by default use the same value of the
19943 reversed_p flag as this one. set_iterator_to_next decides when
19944 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19945 the flag accordingly. */
19946 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19947 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19948 it
->start
= row
->end
;
19949 return row
->displays_text_p
;
19951 #undef RECORD_MAX_MIN_POS
19954 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19955 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19956 doc
: /* Return paragraph direction at point in BUFFER.
19957 Value is either `left-to-right' or `right-to-left'.
19958 If BUFFER is omitted or nil, it defaults to the current buffer.
19960 Paragraph direction determines how the text in the paragraph is displayed.
19961 In left-to-right paragraphs, text begins at the left margin of the window
19962 and the reading direction is generally left to right. In right-to-left
19963 paragraphs, text begins at the right margin and is read from right to left.
19965 See also `bidi-paragraph-direction'. */)
19966 (Lisp_Object buffer
)
19968 struct buffer
*buf
= current_buffer
;
19969 struct buffer
*old
= buf
;
19971 if (! NILP (buffer
))
19973 CHECK_BUFFER (buffer
);
19974 buf
= XBUFFER (buffer
);
19977 if (NILP (BVAR (buf
, bidi_display_reordering
))
19978 || NILP (BVAR (buf
, enable_multibyte_characters
))
19979 /* When we are loading loadup.el, the character property tables
19980 needed for bidi iteration are not yet available. */
19981 || !NILP (Vpurify_flag
))
19982 return Qleft_to_right
;
19983 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19984 return BVAR (buf
, bidi_paragraph_direction
);
19987 /* Determine the direction from buffer text. We could try to
19988 use current_matrix if it is up to date, but this seems fast
19989 enough as it is. */
19990 struct bidi_it itb
;
19991 ptrdiff_t pos
= BUF_PT (buf
);
19992 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19994 void *itb_data
= bidi_shelve_cache ();
19996 set_buffer_temp (buf
);
19997 /* bidi_paragraph_init finds the base direction of the paragraph
19998 by searching forward from paragraph start. We need the base
19999 direction of the current or _previous_ paragraph, so we need
20000 to make sure we are within that paragraph. To that end, find
20001 the previous non-empty line. */
20002 if (pos
>= ZV
&& pos
> BEGV
)
20005 bytepos
= CHAR_TO_BYTE (pos
);
20007 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20008 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20010 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20011 || c
== ' ' || c
== '\t' || c
== '\f')
20013 if (bytepos
<= BEGV_BYTE
)
20018 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20021 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20022 itb
.paragraph_dir
= NEUTRAL_DIR
;
20023 itb
.string
.s
= NULL
;
20024 itb
.string
.lstring
= Qnil
;
20025 itb
.string
.bufpos
= 0;
20026 itb
.string
.unibyte
= 0;
20027 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20028 bidi_unshelve_cache (itb_data
, 0);
20029 set_buffer_temp (old
);
20030 switch (itb
.paragraph_dir
)
20033 return Qleft_to_right
;
20036 return Qright_to_left
;
20046 /***********************************************************************
20048 ***********************************************************************/
20050 /* Redisplay the menu bar in the frame for window W.
20052 The menu bar of X frames that don't have X toolkit support is
20053 displayed in a special window W->frame->menu_bar_window.
20055 The menu bar of terminal frames is treated specially as far as
20056 glyph matrices are concerned. Menu bar lines are not part of
20057 windows, so the update is done directly on the frame matrix rows
20058 for the menu bar. */
20061 display_menu_bar (struct window
*w
)
20063 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20068 /* Don't do all this for graphical frames. */
20070 if (FRAME_W32_P (f
))
20073 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20079 if (FRAME_NS_P (f
))
20081 #endif /* HAVE_NS */
20083 #ifdef USE_X_TOOLKIT
20084 eassert (!FRAME_WINDOW_P (f
));
20085 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20086 it
.first_visible_x
= 0;
20087 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20088 #else /* not USE_X_TOOLKIT */
20089 if (FRAME_WINDOW_P (f
))
20091 /* Menu bar lines are displayed in the desired matrix of the
20092 dummy window menu_bar_window. */
20093 struct window
*menu_w
;
20094 eassert (WINDOWP (f
->menu_bar_window
));
20095 menu_w
= XWINDOW (f
->menu_bar_window
);
20096 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20098 it
.first_visible_x
= 0;
20099 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20103 /* This is a TTY frame, i.e. character hpos/vpos are used as
20105 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20107 it
.first_visible_x
= 0;
20108 it
.last_visible_x
= FRAME_COLS (f
);
20110 #endif /* not USE_X_TOOLKIT */
20112 /* FIXME: This should be controlled by a user option. See the
20113 comments in redisplay_tool_bar and display_mode_line about
20115 it
.paragraph_embedding
= L2R
;
20117 if (! mode_line_inverse_video
)
20118 /* Force the menu-bar to be displayed in the default face. */
20119 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20121 /* Clear all rows of the menu bar. */
20122 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20124 struct glyph_row
*row
= it
.glyph_row
+ i
;
20125 clear_glyph_row (row
);
20126 row
->enabled_p
= 1;
20127 row
->full_width_p
= 1;
20130 /* Display all items of the menu bar. */
20131 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20132 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20134 Lisp_Object string
;
20136 /* Stop at nil string. */
20137 string
= AREF (items
, i
+ 1);
20141 /* Remember where item was displayed. */
20142 ASET (items
, i
+ 3, make_number (it
.hpos
));
20144 /* Display the item, pad with one space. */
20145 if (it
.current_x
< it
.last_visible_x
)
20146 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20147 SCHARS (string
) + 1, 0, 0, -1);
20150 /* Fill out the line with spaces. */
20151 if (it
.current_x
< it
.last_visible_x
)
20152 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20154 /* Compute the total height of the lines. */
20155 compute_line_metrics (&it
);
20160 /***********************************************************************
20162 ***********************************************************************/
20164 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20165 FORCE is non-zero, redisplay mode lines unconditionally.
20166 Otherwise, redisplay only mode lines that are garbaged. Value is
20167 the number of windows whose mode lines were redisplayed. */
20170 redisplay_mode_lines (Lisp_Object window
, int force
)
20174 while (!NILP (window
))
20176 struct window
*w
= XWINDOW (window
);
20178 if (WINDOWP (w
->hchild
))
20179 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20180 else if (WINDOWP (w
->vchild
))
20181 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20183 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20184 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20186 struct text_pos lpoint
;
20187 struct buffer
*old
= current_buffer
;
20189 /* Set the window's buffer for the mode line display. */
20190 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20191 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20193 /* Point refers normally to the selected window. For any
20194 other window, set up appropriate value. */
20195 if (!EQ (window
, selected_window
))
20197 struct text_pos pt
;
20199 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20200 if (CHARPOS (pt
) < BEGV
)
20201 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20202 else if (CHARPOS (pt
) > (ZV
- 1))
20203 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20205 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20208 /* Display mode lines. */
20209 clear_glyph_matrix (w
->desired_matrix
);
20210 if (display_mode_lines (w
))
20213 w
->must_be_updated_p
= 1;
20216 /* Restore old settings. */
20217 set_buffer_internal_1 (old
);
20218 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20228 /* Display the mode and/or header line of window W. Value is the
20229 sum number of mode lines and header lines displayed. */
20232 display_mode_lines (struct window
*w
)
20234 Lisp_Object old_selected_window
, old_selected_frame
;
20237 old_selected_frame
= selected_frame
;
20238 selected_frame
= w
->frame
;
20239 old_selected_window
= selected_window
;
20240 XSETWINDOW (selected_window
, w
);
20242 /* These will be set while the mode line specs are processed. */
20243 line_number_displayed
= 0;
20244 w
->column_number_displayed
= Qnil
;
20246 if (WINDOW_WANTS_MODELINE_P (w
))
20248 struct window
*sel_w
= XWINDOW (old_selected_window
);
20250 /* Select mode line face based on the real selected window. */
20251 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20252 BVAR (current_buffer
, mode_line_format
));
20256 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20258 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20259 BVAR (current_buffer
, header_line_format
));
20263 selected_frame
= old_selected_frame
;
20264 selected_window
= old_selected_window
;
20269 /* Display mode or header line of window W. FACE_ID specifies which
20270 line to display; it is either MODE_LINE_FACE_ID or
20271 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20272 display. Value is the pixel height of the mode/header line
20276 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20280 ptrdiff_t count
= SPECPDL_INDEX ();
20282 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20283 /* Don't extend on a previously drawn mode-line.
20284 This may happen if called from pos_visible_p. */
20285 it
.glyph_row
->enabled_p
= 0;
20286 prepare_desired_row (it
.glyph_row
);
20288 it
.glyph_row
->mode_line_p
= 1;
20290 if (! mode_line_inverse_video
)
20291 /* Force the mode-line to be displayed in the default face. */
20292 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20294 /* FIXME: This should be controlled by a user option. But
20295 supporting such an option is not trivial, since the mode line is
20296 made up of many separate strings. */
20297 it
.paragraph_embedding
= L2R
;
20299 record_unwind_protect (unwind_format_mode_line
,
20300 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20302 mode_line_target
= MODE_LINE_DISPLAY
;
20304 /* Temporarily make frame's keyboard the current kboard so that
20305 kboard-local variables in the mode_line_format will get the right
20307 push_kboard (FRAME_KBOARD (it
.f
));
20308 record_unwind_save_match_data ();
20309 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20312 unbind_to (count
, Qnil
);
20314 /* Fill up with spaces. */
20315 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20317 compute_line_metrics (&it
);
20318 it
.glyph_row
->full_width_p
= 1;
20319 it
.glyph_row
->continued_p
= 0;
20320 it
.glyph_row
->truncated_on_left_p
= 0;
20321 it
.glyph_row
->truncated_on_right_p
= 0;
20323 /* Make a 3D mode-line have a shadow at its right end. */
20324 face
= FACE_FROM_ID (it
.f
, face_id
);
20325 extend_face_to_end_of_line (&it
);
20326 if (face
->box
!= FACE_NO_BOX
)
20328 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20329 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20330 last
->right_box_line_p
= 1;
20333 return it
.glyph_row
->height
;
20336 /* Move element ELT in LIST to the front of LIST.
20337 Return the updated list. */
20340 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20342 register Lisp_Object tail
, prev
;
20343 register Lisp_Object tem
;
20347 while (CONSP (tail
))
20353 /* Splice out the link TAIL. */
20355 list
= XCDR (tail
);
20357 Fsetcdr (prev
, XCDR (tail
));
20359 /* Now make it the first. */
20360 Fsetcdr (tail
, list
);
20365 tail
= XCDR (tail
);
20369 /* Not found--return unchanged LIST. */
20373 /* Contribute ELT to the mode line for window IT->w. How it
20374 translates into text depends on its data type.
20376 IT describes the display environment in which we display, as usual.
20378 DEPTH is the depth in recursion. It is used to prevent
20379 infinite recursion here.
20381 FIELD_WIDTH is the number of characters the display of ELT should
20382 occupy in the mode line, and PRECISION is the maximum number of
20383 characters to display from ELT's representation. See
20384 display_string for details.
20386 Returns the hpos of the end of the text generated by ELT.
20388 PROPS is a property list to add to any string we encounter.
20390 If RISKY is nonzero, remove (disregard) any properties in any string
20391 we encounter, and ignore :eval and :propertize.
20393 The global variable `mode_line_target' determines whether the
20394 output is passed to `store_mode_line_noprop',
20395 `store_mode_line_string', or `display_string'. */
20398 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20399 Lisp_Object elt
, Lisp_Object props
, int risky
)
20401 int n
= 0, field
, prec
;
20406 elt
= build_string ("*too-deep*");
20410 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20414 /* A string: output it and check for %-constructs within it. */
20416 ptrdiff_t offset
= 0;
20418 if (SCHARS (elt
) > 0
20419 && (!NILP (props
) || risky
))
20421 Lisp_Object oprops
, aelt
;
20422 oprops
= Ftext_properties_at (make_number (0), elt
);
20424 /* If the starting string's properties are not what
20425 we want, translate the string. Also, if the string
20426 is risky, do that anyway. */
20428 if (NILP (Fequal (props
, oprops
)) || risky
)
20430 /* If the starting string has properties,
20431 merge the specified ones onto the existing ones. */
20432 if (! NILP (oprops
) && !risky
)
20436 oprops
= Fcopy_sequence (oprops
);
20438 while (CONSP (tem
))
20440 oprops
= Fplist_put (oprops
, XCAR (tem
),
20441 XCAR (XCDR (tem
)));
20442 tem
= XCDR (XCDR (tem
));
20447 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20448 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20450 /* AELT is what we want. Move it to the front
20451 without consing. */
20453 mode_line_proptrans_alist
20454 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20460 /* If AELT has the wrong props, it is useless.
20461 so get rid of it. */
20463 mode_line_proptrans_alist
20464 = Fdelq (aelt
, mode_line_proptrans_alist
);
20466 elt
= Fcopy_sequence (elt
);
20467 Fset_text_properties (make_number (0), Flength (elt
),
20469 /* Add this item to mode_line_proptrans_alist. */
20470 mode_line_proptrans_alist
20471 = Fcons (Fcons (elt
, props
),
20472 mode_line_proptrans_alist
);
20473 /* Truncate mode_line_proptrans_alist
20474 to at most 50 elements. */
20475 tem
= Fnthcdr (make_number (50),
20476 mode_line_proptrans_alist
);
20478 XSETCDR (tem
, Qnil
);
20487 prec
= precision
- n
;
20488 switch (mode_line_target
)
20490 case MODE_LINE_NOPROP
:
20491 case MODE_LINE_TITLE
:
20492 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20494 case MODE_LINE_STRING
:
20495 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20497 case MODE_LINE_DISPLAY
:
20498 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20499 0, prec
, 0, STRING_MULTIBYTE (elt
));
20506 /* Handle the non-literal case. */
20508 while ((precision
<= 0 || n
< precision
)
20509 && SREF (elt
, offset
) != 0
20510 && (mode_line_target
!= MODE_LINE_DISPLAY
20511 || it
->current_x
< it
->last_visible_x
))
20513 ptrdiff_t last_offset
= offset
;
20515 /* Advance to end of string or next format specifier. */
20516 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20519 if (offset
- 1 != last_offset
)
20521 ptrdiff_t nchars
, nbytes
;
20523 /* Output to end of string or up to '%'. Field width
20524 is length of string. Don't output more than
20525 PRECISION allows us. */
20528 prec
= c_string_width (SDATA (elt
) + last_offset
,
20529 offset
- last_offset
, precision
- n
,
20532 switch (mode_line_target
)
20534 case MODE_LINE_NOPROP
:
20535 case MODE_LINE_TITLE
:
20536 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20538 case MODE_LINE_STRING
:
20540 ptrdiff_t bytepos
= last_offset
;
20541 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20542 ptrdiff_t endpos
= (precision
<= 0
20543 ? string_byte_to_char (elt
, offset
)
20544 : charpos
+ nchars
);
20546 n
+= store_mode_line_string (NULL
,
20547 Fsubstring (elt
, make_number (charpos
),
20548 make_number (endpos
)),
20552 case MODE_LINE_DISPLAY
:
20554 ptrdiff_t bytepos
= last_offset
;
20555 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20557 if (precision
<= 0)
20558 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20559 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20561 STRING_MULTIBYTE (elt
));
20566 else /* c == '%' */
20568 ptrdiff_t percent_position
= offset
;
20570 /* Get the specified minimum width. Zero means
20573 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20574 field
= field
* 10 + c
- '0';
20576 /* Don't pad beyond the total padding allowed. */
20577 if (field_width
- n
> 0 && field
> field_width
- n
)
20578 field
= field_width
- n
;
20580 /* Note that either PRECISION <= 0 or N < PRECISION. */
20581 prec
= precision
- n
;
20584 n
+= display_mode_element (it
, depth
, field
, prec
,
20585 Vglobal_mode_string
, props
,
20590 ptrdiff_t bytepos
, charpos
;
20592 Lisp_Object string
;
20594 bytepos
= percent_position
;
20595 charpos
= (STRING_MULTIBYTE (elt
)
20596 ? string_byte_to_char (elt
, bytepos
)
20598 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20599 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20601 switch (mode_line_target
)
20603 case MODE_LINE_NOPROP
:
20604 case MODE_LINE_TITLE
:
20605 n
+= store_mode_line_noprop (spec
, field
, prec
);
20607 case MODE_LINE_STRING
:
20609 Lisp_Object tem
= build_string (spec
);
20610 props
= Ftext_properties_at (make_number (charpos
), elt
);
20611 /* Should only keep face property in props */
20612 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20615 case MODE_LINE_DISPLAY
:
20617 int nglyphs_before
, nwritten
;
20619 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20620 nwritten
= display_string (spec
, string
, elt
,
20625 /* Assign to the glyphs written above the
20626 string where the `%x' came from, position
20630 struct glyph
*glyph
20631 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20635 for (i
= 0; i
< nwritten
; ++i
)
20637 glyph
[i
].object
= elt
;
20638 glyph
[i
].charpos
= charpos
;
20655 /* A symbol: process the value of the symbol recursively
20656 as if it appeared here directly. Avoid error if symbol void.
20657 Special case: if value of symbol is a string, output the string
20660 register Lisp_Object tem
;
20662 /* If the variable is not marked as risky to set
20663 then its contents are risky to use. */
20664 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20667 tem
= Fboundp (elt
);
20670 tem
= Fsymbol_value (elt
);
20671 /* If value is a string, output that string literally:
20672 don't check for % within it. */
20676 if (!EQ (tem
, elt
))
20678 /* Give up right away for nil or t. */
20688 register Lisp_Object car
, tem
;
20690 /* A cons cell: five distinct cases.
20691 If first element is :eval or :propertize, do something special.
20692 If first element is a string or a cons, process all the elements
20693 and effectively concatenate them.
20694 If first element is a negative number, truncate displaying cdr to
20695 at most that many characters. If positive, pad (with spaces)
20696 to at least that many characters.
20697 If first element is a symbol, process the cadr or caddr recursively
20698 according to whether the symbol's value is non-nil or nil. */
20700 if (EQ (car
, QCeval
))
20702 /* An element of the form (:eval FORM) means evaluate FORM
20703 and use the result as mode line elements. */
20708 if (CONSP (XCDR (elt
)))
20711 spec
= safe_eval (XCAR (XCDR (elt
)));
20712 n
+= display_mode_element (it
, depth
, field_width
- n
,
20713 precision
- n
, spec
, props
,
20717 else if (EQ (car
, QCpropertize
))
20719 /* An element of the form (:propertize ELT PROPS...)
20720 means display ELT but applying properties PROPS. */
20725 if (CONSP (XCDR (elt
)))
20726 n
+= display_mode_element (it
, depth
, field_width
- n
,
20727 precision
- n
, XCAR (XCDR (elt
)),
20728 XCDR (XCDR (elt
)), risky
);
20730 else if (SYMBOLP (car
))
20732 tem
= Fboundp (car
);
20736 /* elt is now the cdr, and we know it is a cons cell.
20737 Use its car if CAR has a non-nil value. */
20740 tem
= Fsymbol_value (car
);
20747 /* Symbol's value is nil (or symbol is unbound)
20748 Get the cddr of the original list
20749 and if possible find the caddr and use that. */
20753 else if (!CONSP (elt
))
20758 else if (INTEGERP (car
))
20760 register int lim
= XINT (car
);
20764 /* Negative int means reduce maximum width. */
20765 if (precision
<= 0)
20768 precision
= min (precision
, -lim
);
20772 /* Padding specified. Don't let it be more than
20773 current maximum. */
20775 lim
= min (precision
, lim
);
20777 /* If that's more padding than already wanted, queue it.
20778 But don't reduce padding already specified even if
20779 that is beyond the current truncation point. */
20780 field_width
= max (lim
, field_width
);
20784 else if (STRINGP (car
) || CONSP (car
))
20786 Lisp_Object halftail
= elt
;
20790 && (precision
<= 0 || n
< precision
))
20792 n
+= display_mode_element (it
, depth
,
20793 /* Do padding only after the last
20794 element in the list. */
20795 (! CONSP (XCDR (elt
))
20798 precision
- n
, XCAR (elt
),
20802 if ((len
& 1) == 0)
20803 halftail
= XCDR (halftail
);
20804 /* Check for cycle. */
20805 if (EQ (halftail
, elt
))
20814 elt
= build_string ("*invalid*");
20818 /* Pad to FIELD_WIDTH. */
20819 if (field_width
> 0 && n
< field_width
)
20821 switch (mode_line_target
)
20823 case MODE_LINE_NOPROP
:
20824 case MODE_LINE_TITLE
:
20825 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20827 case MODE_LINE_STRING
:
20828 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20830 case MODE_LINE_DISPLAY
:
20831 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20840 /* Store a mode-line string element in mode_line_string_list.
20842 If STRING is non-null, display that C string. Otherwise, the Lisp
20843 string LISP_STRING is displayed.
20845 FIELD_WIDTH is the minimum number of output glyphs to produce.
20846 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20847 with spaces. FIELD_WIDTH <= 0 means don't pad.
20849 PRECISION is the maximum number of characters to output from
20850 STRING. PRECISION <= 0 means don't truncate the string.
20852 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20853 properties to the string.
20855 PROPS are the properties to add to the string.
20856 The mode_line_string_face face property is always added to the string.
20860 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20861 int field_width
, int precision
, Lisp_Object props
)
20866 if (string
!= NULL
)
20868 len
= strlen (string
);
20869 if (precision
> 0 && len
> precision
)
20871 lisp_string
= make_string (string
, len
);
20873 props
= mode_line_string_face_prop
;
20874 else if (!NILP (mode_line_string_face
))
20876 Lisp_Object face
= Fplist_get (props
, Qface
);
20877 props
= Fcopy_sequence (props
);
20879 face
= mode_line_string_face
;
20881 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20882 props
= Fplist_put (props
, Qface
, face
);
20884 Fadd_text_properties (make_number (0), make_number (len
),
20885 props
, lisp_string
);
20889 len
= XFASTINT (Flength (lisp_string
));
20890 if (precision
> 0 && len
> precision
)
20893 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20896 if (!NILP (mode_line_string_face
))
20900 props
= Ftext_properties_at (make_number (0), lisp_string
);
20901 face
= Fplist_get (props
, Qface
);
20903 face
= mode_line_string_face
;
20905 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20906 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20908 lisp_string
= Fcopy_sequence (lisp_string
);
20911 Fadd_text_properties (make_number (0), make_number (len
),
20912 props
, lisp_string
);
20917 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20921 if (field_width
> len
)
20923 field_width
-= len
;
20924 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20926 Fadd_text_properties (make_number (0), make_number (field_width
),
20927 props
, lisp_string
);
20928 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20936 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20938 doc
: /* Format a string out of a mode line format specification.
20939 First arg FORMAT specifies the mode line format (see `mode-line-format'
20940 for details) to use.
20942 By default, the format is evaluated for the currently selected window.
20944 Optional second arg FACE specifies the face property to put on all
20945 characters for which no face is specified. The value nil means the
20946 default face. The value t means whatever face the window's mode line
20947 currently uses (either `mode-line' or `mode-line-inactive',
20948 depending on whether the window is the selected window or not).
20949 An integer value means the value string has no text
20952 Optional third and fourth args WINDOW and BUFFER specify the window
20953 and buffer to use as the context for the formatting (defaults
20954 are the selected window and the WINDOW's buffer). */)
20955 (Lisp_Object format
, Lisp_Object face
,
20956 Lisp_Object window
, Lisp_Object buffer
)
20961 struct buffer
*old_buffer
= NULL
;
20963 int no_props
= INTEGERP (face
);
20964 ptrdiff_t count
= SPECPDL_INDEX ();
20966 int string_start
= 0;
20969 window
= selected_window
;
20970 CHECK_WINDOW (window
);
20971 w
= XWINDOW (window
);
20974 buffer
= w
->buffer
;
20975 CHECK_BUFFER (buffer
);
20977 /* Make formatting the modeline a non-op when noninteractive, otherwise
20978 there will be problems later caused by a partially initialized frame. */
20979 if (NILP (format
) || noninteractive
)
20980 return empty_unibyte_string
;
20985 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20986 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20987 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20988 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20989 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20990 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20991 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20994 if (XBUFFER (buffer
) != current_buffer
)
20995 old_buffer
= current_buffer
;
20997 /* Save things including mode_line_proptrans_alist,
20998 and set that to nil so that we don't alter the outer value. */
20999 record_unwind_protect (unwind_format_mode_line
,
21000 format_mode_line_unwind_data
21001 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
21002 old_buffer
, selected_window
, 1));
21003 mode_line_proptrans_alist
= Qnil
;
21005 Fselect_window (window
, Qt
);
21007 set_buffer_internal_1 (XBUFFER (buffer
));
21009 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21013 mode_line_target
= MODE_LINE_NOPROP
;
21014 mode_line_string_face_prop
= Qnil
;
21015 mode_line_string_list
= Qnil
;
21016 string_start
= MODE_LINE_NOPROP_LEN (0);
21020 mode_line_target
= MODE_LINE_STRING
;
21021 mode_line_string_list
= Qnil
;
21022 mode_line_string_face
= face
;
21023 mode_line_string_face_prop
21024 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21027 push_kboard (FRAME_KBOARD (it
.f
));
21028 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21033 len
= MODE_LINE_NOPROP_LEN (string_start
);
21034 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21038 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21039 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21040 empty_unibyte_string
);
21043 unbind_to (count
, Qnil
);
21047 /* Write a null-terminated, right justified decimal representation of
21048 the positive integer D to BUF using a minimal field width WIDTH. */
21051 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21053 register char *p
= buf
;
21061 *p
++ = d
% 10 + '0';
21066 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21077 /* Write a null-terminated, right justified decimal and "human
21078 readable" representation of the nonnegative integer D to BUF using
21079 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21081 static const char power_letter
[] =
21095 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21097 /* We aim to represent the nonnegative integer D as
21098 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21099 ptrdiff_t quotient
= d
;
21101 /* -1 means: do not use TENTHS. */
21105 /* Length of QUOTIENT.TENTHS as a string. */
21111 if (1000 <= quotient
)
21113 /* Scale to the appropriate EXPONENT. */
21116 remainder
= quotient
% 1000;
21120 while (1000 <= quotient
);
21122 /* Round to nearest and decide whether to use TENTHS or not. */
21125 tenths
= remainder
/ 100;
21126 if (50 <= remainder
% 100)
21133 if (quotient
== 10)
21141 if (500 <= remainder
)
21143 if (quotient
< 999)
21154 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21155 if (tenths
== -1 && quotient
<= 99)
21162 p
= psuffix
= buf
+ max (width
, length
);
21164 /* Print EXPONENT. */
21165 *psuffix
++ = power_letter
[exponent
];
21168 /* Print TENTHS. */
21171 *--p
= '0' + tenths
;
21175 /* Print QUOTIENT. */
21178 int digit
= quotient
% 10;
21179 *--p
= '0' + digit
;
21181 while ((quotient
/= 10) != 0);
21183 /* Print leading spaces. */
21188 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21189 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21190 type of CODING_SYSTEM. Return updated pointer into BUF. */
21192 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21195 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21198 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21199 const unsigned char *eol_str
;
21201 /* The EOL conversion we are using. */
21202 Lisp_Object eoltype
;
21204 val
= CODING_SYSTEM_SPEC (coding_system
);
21207 if (!VECTORP (val
)) /* Not yet decided. */
21209 *buf
++ = multibyte
? '-' : ' ';
21211 eoltype
= eol_mnemonic_undecided
;
21212 /* Don't mention EOL conversion if it isn't decided. */
21217 Lisp_Object eolvalue
;
21219 attrs
= AREF (val
, 0);
21220 eolvalue
= AREF (val
, 2);
21223 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21228 /* The EOL conversion that is normal on this system. */
21230 if (NILP (eolvalue
)) /* Not yet decided. */
21231 eoltype
= eol_mnemonic_undecided
;
21232 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21233 eoltype
= eol_mnemonic_undecided
;
21234 else /* eolvalue is Qunix, Qdos, or Qmac. */
21235 eoltype
= (EQ (eolvalue
, Qunix
)
21236 ? eol_mnemonic_unix
21237 : (EQ (eolvalue
, Qdos
) == 1
21238 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21244 /* Mention the EOL conversion if it is not the usual one. */
21245 if (STRINGP (eoltype
))
21247 eol_str
= SDATA (eoltype
);
21248 eol_str_len
= SBYTES (eoltype
);
21250 else if (CHARACTERP (eoltype
))
21252 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21253 int c
= XFASTINT (eoltype
);
21254 eol_str_len
= CHAR_STRING (c
, tmp
);
21259 eol_str
= invalid_eol_type
;
21260 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21262 memcpy (buf
, eol_str
, eol_str_len
);
21263 buf
+= eol_str_len
;
21269 /* Return a string for the output of a mode line %-spec for window W,
21270 generated by character C. FIELD_WIDTH > 0 means pad the string
21271 returned with spaces to that value. Return a Lisp string in
21272 *STRING if the resulting string is taken from that Lisp string.
21274 Note we operate on the current buffer for most purposes,
21275 the exception being w->base_line_pos. */
21277 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21279 static const char *
21280 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21281 Lisp_Object
*string
)
21284 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21285 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21286 struct buffer
*b
= current_buffer
;
21294 if (!NILP (BVAR (b
, read_only
)))
21296 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21301 /* This differs from %* only for a modified read-only buffer. */
21302 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21304 if (!NILP (BVAR (b
, read_only
)))
21309 /* This differs from %* in ignoring read-only-ness. */
21310 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21322 if (command_loop_level
> 5)
21324 p
= decode_mode_spec_buf
;
21325 for (i
= 0; i
< command_loop_level
; i
++)
21328 return decode_mode_spec_buf
;
21336 if (command_loop_level
> 5)
21338 p
= decode_mode_spec_buf
;
21339 for (i
= 0; i
< command_loop_level
; i
++)
21342 return decode_mode_spec_buf
;
21349 /* Let lots_of_dashes be a string of infinite length. */
21350 if (mode_line_target
== MODE_LINE_NOPROP
||
21351 mode_line_target
== MODE_LINE_STRING
)
21353 if (field_width
<= 0
21354 || field_width
> sizeof (lots_of_dashes
))
21356 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21357 decode_mode_spec_buf
[i
] = '-';
21358 decode_mode_spec_buf
[i
] = '\0';
21359 return decode_mode_spec_buf
;
21362 return lots_of_dashes
;
21366 obj
= BVAR (b
, name
);
21370 /* %c and %l are ignored in `frame-title-format'.
21371 (In redisplay_internal, the frame title is drawn _before_ the
21372 windows are updated, so the stuff which depends on actual
21373 window contents (such as %l) may fail to render properly, or
21374 even crash emacs.) */
21375 if (mode_line_target
== MODE_LINE_TITLE
)
21379 ptrdiff_t col
= current_column ();
21380 w
->column_number_displayed
= make_number (col
);
21381 pint2str (decode_mode_spec_buf
, field_width
, col
);
21382 return decode_mode_spec_buf
;
21386 #ifndef SYSTEM_MALLOC
21388 if (NILP (Vmemory_full
))
21391 return "!MEM FULL! ";
21398 /* %F displays the frame name. */
21399 if (!NILP (f
->title
))
21400 return SSDATA (f
->title
);
21401 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21402 return SSDATA (f
->name
);
21406 obj
= BVAR (b
, filename
);
21411 ptrdiff_t size
= ZV
- BEGV
;
21412 pint2str (decode_mode_spec_buf
, field_width
, size
);
21413 return decode_mode_spec_buf
;
21418 ptrdiff_t size
= ZV
- BEGV
;
21419 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21420 return decode_mode_spec_buf
;
21425 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21426 ptrdiff_t topline
, nlines
, height
;
21429 /* %c and %l are ignored in `frame-title-format'. */
21430 if (mode_line_target
== MODE_LINE_TITLE
)
21433 startpos
= XMARKER (w
->start
)->charpos
;
21434 startpos_byte
= marker_byte_position (w
->start
);
21435 height
= WINDOW_TOTAL_LINES (w
);
21437 /* If we decided that this buffer isn't suitable for line numbers,
21438 don't forget that too fast. */
21439 if (EQ (w
->base_line_pos
, w
->buffer
))
21441 /* But do forget it, if the window shows a different buffer now. */
21442 else if (BUFFERP (w
->base_line_pos
))
21443 w
->base_line_pos
= Qnil
;
21445 /* If the buffer is very big, don't waste time. */
21446 if (INTEGERP (Vline_number_display_limit
)
21447 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21449 w
->base_line_pos
= Qnil
;
21450 w
->base_line_number
= Qnil
;
21454 if (INTEGERP (w
->base_line_number
)
21455 && INTEGERP (w
->base_line_pos
)
21456 && XFASTINT (w
->base_line_pos
) <= startpos
)
21458 line
= XFASTINT (w
->base_line_number
);
21459 linepos
= XFASTINT (w
->base_line_pos
);
21460 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21465 linepos
= BUF_BEGV (b
);
21466 linepos_byte
= BUF_BEGV_BYTE (b
);
21469 /* Count lines from base line to window start position. */
21470 nlines
= display_count_lines (linepos_byte
,
21474 topline
= nlines
+ line
;
21476 /* Determine a new base line, if the old one is too close
21477 or too far away, or if we did not have one.
21478 "Too close" means it's plausible a scroll-down would
21479 go back past it. */
21480 if (startpos
== BUF_BEGV (b
))
21482 w
->base_line_number
= make_number (topline
);
21483 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21485 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21486 || linepos
== BUF_BEGV (b
))
21488 ptrdiff_t limit
= BUF_BEGV (b
);
21489 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21490 ptrdiff_t position
;
21491 ptrdiff_t distance
=
21492 (height
* 2 + 30) * line_number_display_limit_width
;
21494 if (startpos
- distance
> limit
)
21496 limit
= startpos
- distance
;
21497 limit_byte
= CHAR_TO_BYTE (limit
);
21500 nlines
= display_count_lines (startpos_byte
,
21502 - (height
* 2 + 30),
21504 /* If we couldn't find the lines we wanted within
21505 line_number_display_limit_width chars per line,
21506 give up on line numbers for this window. */
21507 if (position
== limit_byte
&& limit
== startpos
- distance
)
21509 w
->base_line_pos
= w
->buffer
;
21510 w
->base_line_number
= Qnil
;
21514 w
->base_line_number
= make_number (topline
- nlines
);
21515 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21518 /* Now count lines from the start pos to point. */
21519 nlines
= display_count_lines (startpos_byte
,
21520 PT_BYTE
, PT
, &junk
);
21522 /* Record that we did display the line number. */
21523 line_number_displayed
= 1;
21525 /* Make the string to show. */
21526 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21527 return decode_mode_spec_buf
;
21530 char* p
= decode_mode_spec_buf
;
21531 int pad
= field_width
- 2;
21537 return decode_mode_spec_buf
;
21543 obj
= BVAR (b
, mode_name
);
21547 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21553 ptrdiff_t pos
= marker_position (w
->start
);
21554 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21556 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21558 if (pos
<= BUF_BEGV (b
))
21563 else if (pos
<= BUF_BEGV (b
))
21567 if (total
> 1000000)
21568 /* Do it differently for a large value, to avoid overflow. */
21569 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21571 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21572 /* We can't normally display a 3-digit number,
21573 so get us a 2-digit number that is close. */
21576 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21577 return decode_mode_spec_buf
;
21581 /* Display percentage of size above the bottom of the screen. */
21584 ptrdiff_t toppos
= marker_position (w
->start
);
21585 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21586 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21588 if (botpos
>= BUF_ZV (b
))
21590 if (toppos
<= BUF_BEGV (b
))
21597 if (total
> 1000000)
21598 /* Do it differently for a large value, to avoid overflow. */
21599 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21601 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21602 /* We can't normally display a 3-digit number,
21603 so get us a 2-digit number that is close. */
21606 if (toppos
<= BUF_BEGV (b
))
21607 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21609 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21610 return decode_mode_spec_buf
;
21615 /* status of process */
21616 obj
= Fget_buffer_process (Fcurrent_buffer ());
21618 return "no process";
21620 obj
= Fsymbol_name (Fprocess_status (obj
));
21626 ptrdiff_t count
= inhibit_garbage_collection ();
21627 Lisp_Object val
= call1 (intern ("file-remote-p"),
21628 BVAR (current_buffer
, directory
));
21629 unbind_to (count
, Qnil
);
21637 case 't': /* indicate TEXT or BINARY */
21641 /* coding-system (not including end-of-line format) */
21643 /* coding-system (including end-of-line type) */
21645 int eol_flag
= (c
== 'Z');
21646 char *p
= decode_mode_spec_buf
;
21648 if (! FRAME_WINDOW_P (f
))
21650 /* No need to mention EOL here--the terminal never needs
21651 to do EOL conversion. */
21652 p
= decode_mode_spec_coding (CODING_ID_NAME
21653 (FRAME_KEYBOARD_CODING (f
)->id
),
21655 p
= decode_mode_spec_coding (CODING_ID_NAME
21656 (FRAME_TERMINAL_CODING (f
)->id
),
21659 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21662 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21663 #ifdef subprocesses
21664 obj
= Fget_buffer_process (Fcurrent_buffer ());
21665 if (PROCESSP (obj
))
21667 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21669 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21672 #endif /* subprocesses */
21675 return decode_mode_spec_buf
;
21682 return SSDATA (obj
);
21689 /* Count up to COUNT lines starting from START_BYTE.
21690 But don't go beyond LIMIT_BYTE.
21691 Return the number of lines thus found (always nonnegative).
21693 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21696 display_count_lines (ptrdiff_t start_byte
,
21697 ptrdiff_t limit_byte
, ptrdiff_t count
,
21698 ptrdiff_t *byte_pos_ptr
)
21700 register unsigned char *cursor
;
21701 unsigned char *base
;
21703 register ptrdiff_t ceiling
;
21704 register unsigned char *ceiling_addr
;
21705 ptrdiff_t orig_count
= count
;
21707 /* If we are not in selective display mode,
21708 check only for newlines. */
21709 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21710 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21714 while (start_byte
< limit_byte
)
21716 ceiling
= BUFFER_CEILING_OF (start_byte
);
21717 ceiling
= min (limit_byte
- 1, ceiling
);
21718 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21719 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21722 if (selective_display
)
21723 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21726 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21729 if (cursor
!= ceiling_addr
)
21733 start_byte
+= cursor
- base
+ 1;
21734 *byte_pos_ptr
= start_byte
;
21738 if (++cursor
== ceiling_addr
)
21744 start_byte
+= cursor
- base
;
21749 while (start_byte
> limit_byte
)
21751 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21752 ceiling
= max (limit_byte
, ceiling
);
21753 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21754 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21757 if (selective_display
)
21758 while (--cursor
!= ceiling_addr
21759 && *cursor
!= '\n' && *cursor
!= 015)
21762 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21765 if (cursor
!= ceiling_addr
)
21769 start_byte
+= cursor
- base
+ 1;
21770 *byte_pos_ptr
= start_byte
;
21771 /* When scanning backwards, we should
21772 not count the newline posterior to which we stop. */
21773 return - orig_count
- 1;
21779 /* Here we add 1 to compensate for the last decrement
21780 of CURSOR, which took it past the valid range. */
21781 start_byte
+= cursor
- base
+ 1;
21785 *byte_pos_ptr
= limit_byte
;
21788 return - orig_count
+ count
;
21789 return orig_count
- count
;
21795 /***********************************************************************
21797 ***********************************************************************/
21799 /* Display a NUL-terminated string, starting with index START.
21801 If STRING is non-null, display that C string. Otherwise, the Lisp
21802 string LISP_STRING is displayed. There's a case that STRING is
21803 non-null and LISP_STRING is not nil. It means STRING is a string
21804 data of LISP_STRING. In that case, we display LISP_STRING while
21805 ignoring its text properties.
21807 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21808 FACE_STRING. Display STRING or LISP_STRING with the face at
21809 FACE_STRING_POS in FACE_STRING:
21811 Display the string in the environment given by IT, but use the
21812 standard display table, temporarily.
21814 FIELD_WIDTH is the minimum number of output glyphs to produce.
21815 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21816 with spaces. If STRING has more characters, more than FIELD_WIDTH
21817 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21819 PRECISION is the maximum number of characters to output from
21820 STRING. PRECISION < 0 means don't truncate the string.
21822 This is roughly equivalent to printf format specifiers:
21824 FIELD_WIDTH PRECISION PRINTF
21825 ----------------------------------------
21831 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21832 display them, and < 0 means obey the current buffer's value of
21833 enable_multibyte_characters.
21835 Value is the number of columns displayed. */
21838 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21839 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21840 int field_width
, int precision
, int max_x
, int multibyte
)
21842 int hpos_at_start
= it
->hpos
;
21843 int saved_face_id
= it
->face_id
;
21844 struct glyph_row
*row
= it
->glyph_row
;
21845 ptrdiff_t it_charpos
;
21847 /* Initialize the iterator IT for iteration over STRING beginning
21848 with index START. */
21849 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21850 precision
, field_width
, multibyte
);
21851 if (string
&& STRINGP (lisp_string
))
21852 /* LISP_STRING is the one returned by decode_mode_spec. We should
21853 ignore its text properties. */
21854 it
->stop_charpos
= it
->end_charpos
;
21856 /* If displaying STRING, set up the face of the iterator from
21857 FACE_STRING, if that's given. */
21858 if (STRINGP (face_string
))
21864 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21865 0, it
->region_beg_charpos
,
21866 it
->region_end_charpos
,
21867 &endptr
, it
->base_face_id
, 0);
21868 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21869 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21872 /* Set max_x to the maximum allowed X position. Don't let it go
21873 beyond the right edge of the window. */
21875 max_x
= it
->last_visible_x
;
21877 max_x
= min (max_x
, it
->last_visible_x
);
21879 /* Skip over display elements that are not visible. because IT->w is
21881 if (it
->current_x
< it
->first_visible_x
)
21882 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21883 MOVE_TO_POS
| MOVE_TO_X
);
21885 row
->ascent
= it
->max_ascent
;
21886 row
->height
= it
->max_ascent
+ it
->max_descent
;
21887 row
->phys_ascent
= it
->max_phys_ascent
;
21888 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21889 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21891 if (STRINGP (it
->string
))
21892 it_charpos
= IT_STRING_CHARPOS (*it
);
21894 it_charpos
= IT_CHARPOS (*it
);
21896 /* This condition is for the case that we are called with current_x
21897 past last_visible_x. */
21898 while (it
->current_x
< max_x
)
21900 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21902 /* Get the next display element. */
21903 if (!get_next_display_element (it
))
21906 /* Produce glyphs. */
21907 x_before
= it
->current_x
;
21908 n_glyphs_before
= row
->used
[TEXT_AREA
];
21909 PRODUCE_GLYPHS (it
);
21911 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21914 while (i
< nglyphs
)
21916 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21918 if (it
->line_wrap
!= TRUNCATE
21919 && x
+ glyph
->pixel_width
> max_x
)
21921 /* End of continued line or max_x reached. */
21922 if (CHAR_GLYPH_PADDING_P (*glyph
))
21924 /* A wide character is unbreakable. */
21925 if (row
->reversed_p
)
21926 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21927 - n_glyphs_before
);
21928 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21929 it
->current_x
= x_before
;
21933 if (row
->reversed_p
)
21934 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21935 - (n_glyphs_before
+ i
));
21936 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21941 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21943 /* Glyph is at least partially visible. */
21945 if (x
< it
->first_visible_x
)
21946 row
->x
= x
- it
->first_visible_x
;
21950 /* Glyph is off the left margin of the display area.
21951 Should not happen. */
21955 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21956 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21957 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21958 row
->phys_height
= max (row
->phys_height
,
21959 it
->max_phys_ascent
+ it
->max_phys_descent
);
21960 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21961 it
->max_extra_line_spacing
);
21962 x
+= glyph
->pixel_width
;
21966 /* Stop if max_x reached. */
21970 /* Stop at line ends. */
21971 if (ITERATOR_AT_END_OF_LINE_P (it
))
21973 it
->continuation_lines_width
= 0;
21977 set_iterator_to_next (it
, 1);
21978 if (STRINGP (it
->string
))
21979 it_charpos
= IT_STRING_CHARPOS (*it
);
21981 it_charpos
= IT_CHARPOS (*it
);
21983 /* Stop if truncating at the right edge. */
21984 if (it
->line_wrap
== TRUNCATE
21985 && it
->current_x
>= it
->last_visible_x
)
21987 /* Add truncation mark, but don't do it if the line is
21988 truncated at a padding space. */
21989 if (it_charpos
< it
->string_nchars
)
21991 if (!FRAME_WINDOW_P (it
->f
))
21995 if (it
->current_x
> it
->last_visible_x
)
21997 if (!row
->reversed_p
)
21999 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22000 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22005 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22006 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22008 unproduce_glyphs (it
, ii
+ 1);
22009 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22011 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22013 row
->used
[TEXT_AREA
] = ii
;
22014 produce_special_glyphs (it
, IT_TRUNCATION
);
22017 produce_special_glyphs (it
, IT_TRUNCATION
);
22019 row
->truncated_on_right_p
= 1;
22025 /* Maybe insert a truncation at the left. */
22026 if (it
->first_visible_x
22029 if (!FRAME_WINDOW_P (it
->f
)
22030 || (row
->reversed_p
22031 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22032 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22033 insert_left_trunc_glyphs (it
);
22034 row
->truncated_on_left_p
= 1;
22037 it
->face_id
= saved_face_id
;
22039 /* Value is number of columns displayed. */
22040 return it
->hpos
- hpos_at_start
;
22045 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22046 appears as an element of LIST or as the car of an element of LIST.
22047 If PROPVAL is a list, compare each element against LIST in that
22048 way, and return 1/2 if any element of PROPVAL is found in LIST.
22049 Otherwise return 0. This function cannot quit.
22050 The return value is 2 if the text is invisible but with an ellipsis
22051 and 1 if it's invisible and without an ellipsis. */
22054 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22056 register Lisp_Object tail
, proptail
;
22058 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22060 register Lisp_Object tem
;
22062 if (EQ (propval
, tem
))
22064 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22065 return NILP (XCDR (tem
)) ? 1 : 2;
22068 if (CONSP (propval
))
22070 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22072 Lisp_Object propelt
;
22073 propelt
= XCAR (proptail
);
22074 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22076 register Lisp_Object tem
;
22078 if (EQ (propelt
, tem
))
22080 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22081 return NILP (XCDR (tem
)) ? 1 : 2;
22089 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22090 doc
: /* Non-nil if the property makes the text invisible.
22091 POS-OR-PROP can be a marker or number, in which case it is taken to be
22092 a position in the current buffer and the value of the `invisible' property
22093 is checked; or it can be some other value, which is then presumed to be the
22094 value of the `invisible' property of the text of interest.
22095 The non-nil value returned can be t for truly invisible text or something
22096 else if the text is replaced by an ellipsis. */)
22097 (Lisp_Object pos_or_prop
)
22100 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22101 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22103 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22104 return (invis
== 0 ? Qnil
22106 : make_number (invis
));
22109 /* Calculate a width or height in pixels from a specification using
22110 the following elements:
22113 NUM - a (fractional) multiple of the default font width/height
22114 (NUM) - specifies exactly NUM pixels
22115 UNIT - a fixed number of pixels, see below.
22116 ELEMENT - size of a display element in pixels, see below.
22117 (NUM . SPEC) - equals NUM * SPEC
22118 (+ SPEC SPEC ...) - add pixel values
22119 (- SPEC SPEC ...) - subtract pixel values
22120 (- SPEC) - negate pixel value
22123 INT or FLOAT - a number constant
22124 SYMBOL - use symbol's (buffer local) variable binding.
22127 in - pixels per inch *)
22128 mm - pixels per 1/1000 meter *)
22129 cm - pixels per 1/100 meter *)
22130 width - width of current font in pixels.
22131 height - height of current font in pixels.
22133 *) using the ratio(s) defined in display-pixels-per-inch.
22137 left-fringe - left fringe width in pixels
22138 right-fringe - right fringe width in pixels
22140 left-margin - left margin width in pixels
22141 right-margin - right margin width in pixels
22143 scroll-bar - scroll-bar area width in pixels
22147 Pixels corresponding to 5 inches:
22150 Total width of non-text areas on left side of window (if scroll-bar is on left):
22151 '(space :width (+ left-fringe left-margin scroll-bar))
22153 Align to first text column (in header line):
22154 '(space :align-to 0)
22156 Align to middle of text area minus half the width of variable `my-image'
22157 containing a loaded image:
22158 '(space :align-to (0.5 . (- text my-image)))
22160 Width of left margin minus width of 1 character in the default font:
22161 '(space :width (- left-margin 1))
22163 Width of left margin minus width of 2 characters in the current font:
22164 '(space :width (- left-margin (2 . width)))
22166 Center 1 character over left-margin (in header line):
22167 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22169 Different ways to express width of left fringe plus left margin minus one pixel:
22170 '(space :width (- (+ left-fringe left-margin) (1)))
22171 '(space :width (+ left-fringe left-margin (- (1))))
22172 '(space :width (+ left-fringe left-margin (-1)))
22176 #define NUMVAL(X) \
22177 ((INTEGERP (X) || FLOATP (X)) \
22182 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22183 struct font
*font
, int width_p
, int *align_to
)
22187 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22188 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22191 return OK_PIXELS (0);
22193 eassert (FRAME_LIVE_P (it
->f
));
22195 if (SYMBOLP (prop
))
22197 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22199 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22201 if (unit
[0] == 'i' && unit
[1] == 'n')
22203 else if (unit
[0] == 'm' && unit
[1] == 'm')
22205 else if (unit
[0] == 'c' && unit
[1] == 'm')
22212 #ifdef HAVE_WINDOW_SYSTEM
22213 if (FRAME_WINDOW_P (it
->f
)
22215 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22216 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22218 return OK_PIXELS (ppi
/ pixels
);
22221 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22222 || (CONSP (Vdisplay_pixels_per_inch
)
22224 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22225 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22227 return OK_PIXELS (ppi
/ pixels
);
22233 #ifdef HAVE_WINDOW_SYSTEM
22234 if (EQ (prop
, Qheight
))
22235 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22236 if (EQ (prop
, Qwidth
))
22237 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22239 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22240 return OK_PIXELS (1);
22243 if (EQ (prop
, Qtext
))
22244 return OK_PIXELS (width_p
22245 ? window_box_width (it
->w
, TEXT_AREA
)
22246 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22248 if (align_to
&& *align_to
< 0)
22251 if (EQ (prop
, Qleft
))
22252 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22253 if (EQ (prop
, Qright
))
22254 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22255 if (EQ (prop
, Qcenter
))
22256 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22257 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22258 if (EQ (prop
, Qleft_fringe
))
22259 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22260 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22261 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22262 if (EQ (prop
, Qright_fringe
))
22263 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22264 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22265 : window_box_right_offset (it
->w
, TEXT_AREA
));
22266 if (EQ (prop
, Qleft_margin
))
22267 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22268 if (EQ (prop
, Qright_margin
))
22269 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22270 if (EQ (prop
, Qscroll_bar
))
22271 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22273 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22274 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22275 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22280 if (EQ (prop
, Qleft_fringe
))
22281 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22282 if (EQ (prop
, Qright_fringe
))
22283 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22284 if (EQ (prop
, Qleft_margin
))
22285 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22286 if (EQ (prop
, Qright_margin
))
22287 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22288 if (EQ (prop
, Qscroll_bar
))
22289 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22292 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22293 if (EQ (prop
, Qunbound
))
22297 if (INTEGERP (prop
) || FLOATP (prop
))
22299 int base_unit
= (width_p
22300 ? FRAME_COLUMN_WIDTH (it
->f
)
22301 : FRAME_LINE_HEIGHT (it
->f
));
22302 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22307 Lisp_Object car
= XCAR (prop
);
22308 Lisp_Object cdr
= XCDR (prop
);
22312 #ifdef HAVE_WINDOW_SYSTEM
22313 if (FRAME_WINDOW_P (it
->f
)
22314 && valid_image_p (prop
))
22316 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22317 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22319 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22322 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22328 while (CONSP (cdr
))
22330 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22331 font
, width_p
, align_to
))
22334 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22339 if (EQ (car
, Qminus
))
22341 return OK_PIXELS (pixels
);
22344 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22345 if (EQ (car
, Qunbound
))
22349 if (INTEGERP (car
) || FLOATP (car
))
22352 pixels
= XFLOATINT (car
);
22354 return OK_PIXELS (pixels
);
22355 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22356 font
, width_p
, align_to
))
22357 return OK_PIXELS (pixels
* fact
);
22368 /***********************************************************************
22370 ***********************************************************************/
22372 #ifdef HAVE_WINDOW_SYSTEM
22377 dump_glyph_string (struct glyph_string
*s
)
22379 fprintf (stderr
, "glyph string\n");
22380 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22381 s
->x
, s
->y
, s
->width
, s
->height
);
22382 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22383 fprintf (stderr
, " hl = %d\n", s
->hl
);
22384 fprintf (stderr
, " left overhang = %d, right = %d\n",
22385 s
->left_overhang
, s
->right_overhang
);
22386 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22387 fprintf (stderr
, " extends to end of line = %d\n",
22388 s
->extends_to_end_of_line_p
);
22389 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22390 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22393 #endif /* GLYPH_DEBUG */
22395 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22396 of XChar2b structures for S; it can't be allocated in
22397 init_glyph_string because it must be allocated via `alloca'. W
22398 is the window on which S is drawn. ROW and AREA are the glyph row
22399 and area within the row from which S is constructed. START is the
22400 index of the first glyph structure covered by S. HL is a
22401 face-override for drawing S. */
22404 #define OPTIONAL_HDC(hdc) HDC hdc,
22405 #define DECLARE_HDC(hdc) HDC hdc;
22406 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22407 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22410 #ifndef OPTIONAL_HDC
22411 #define OPTIONAL_HDC(hdc)
22412 #define DECLARE_HDC(hdc)
22413 #define ALLOCATE_HDC(hdc, f)
22414 #define RELEASE_HDC(hdc, f)
22418 init_glyph_string (struct glyph_string
*s
,
22420 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22421 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22423 memset (s
, 0, sizeof *s
);
22425 s
->f
= XFRAME (w
->frame
);
22429 s
->display
= FRAME_X_DISPLAY (s
->f
);
22430 s
->window
= FRAME_X_WINDOW (s
->f
);
22431 s
->char2b
= char2b
;
22435 s
->first_glyph
= row
->glyphs
[area
] + start
;
22436 s
->height
= row
->height
;
22437 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22438 s
->ybase
= s
->y
+ row
->ascent
;
22442 /* Append the list of glyph strings with head H and tail T to the list
22443 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22446 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22447 struct glyph_string
*h
, struct glyph_string
*t
)
22461 /* Prepend the list of glyph strings with head H and tail T to the
22462 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22466 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22467 struct glyph_string
*h
, struct glyph_string
*t
)
22481 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22482 Set *HEAD and *TAIL to the resulting list. */
22485 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22486 struct glyph_string
*s
)
22488 s
->next
= s
->prev
= NULL
;
22489 append_glyph_string_lists (head
, tail
, s
, s
);
22493 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22494 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22495 make sure that X resources for the face returned are allocated.
22496 Value is a pointer to a realized face that is ready for display if
22497 DISPLAY_P is non-zero. */
22499 static inline struct face
*
22500 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22501 XChar2b
*char2b
, int display_p
)
22503 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22507 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22509 if (code
!= FONT_INVALID_CODE
)
22510 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22512 STORE_XCHAR2B (char2b
, 0, 0);
22515 /* Make sure X resources of the face are allocated. */
22516 #ifdef HAVE_X_WINDOWS
22520 eassert (face
!= NULL
);
22521 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22528 /* Get face and two-byte form of character glyph GLYPH on frame F.
22529 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22530 a pointer to a realized face that is ready for display. */
22532 static inline struct face
*
22533 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22534 XChar2b
*char2b
, int *two_byte_p
)
22538 eassert (glyph
->type
== CHAR_GLYPH
);
22539 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22548 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22549 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22551 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22553 if (code
!= FONT_INVALID_CODE
)
22554 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22556 STORE_XCHAR2B (char2b
, 0, 0);
22559 /* Make sure X resources of the face are allocated. */
22560 eassert (face
!= NULL
);
22561 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22566 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22567 Return 1 if FONT has a glyph for C, otherwise return 0. */
22570 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22574 if (CHAR_BYTE8_P (c
))
22575 code
= CHAR_TO_BYTE8 (c
);
22577 code
= font
->driver
->encode_char (font
, c
);
22579 if (code
== FONT_INVALID_CODE
)
22581 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22586 /* Fill glyph string S with composition components specified by S->cmp.
22588 BASE_FACE is the base face of the composition.
22589 S->cmp_from is the index of the first component for S.
22591 OVERLAPS non-zero means S should draw the foreground only, and use
22592 its physical height for clipping. See also draw_glyphs.
22594 Value is the index of a component not in S. */
22597 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22601 /* For all glyphs of this composition, starting at the offset
22602 S->cmp_from, until we reach the end of the definition or encounter a
22603 glyph that requires the different face, add it to S. */
22608 s
->for_overlaps
= overlaps
;
22611 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22613 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22615 /* TAB in a composition means display glyphs with padding space
22616 on the left or right. */
22619 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22622 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22629 s
->font
= s
->face
->font
;
22631 else if (s
->face
!= face
)
22639 if (s
->face
== NULL
)
22641 s
->face
= base_face
->ascii_face
;
22642 s
->font
= s
->face
->font
;
22645 /* All glyph strings for the same composition has the same width,
22646 i.e. the width set for the first component of the composition. */
22647 s
->width
= s
->first_glyph
->pixel_width
;
22649 /* If the specified font could not be loaded, use the frame's
22650 default font, but record the fact that we couldn't load it in
22651 the glyph string so that we can draw rectangles for the
22652 characters of the glyph string. */
22653 if (s
->font
== NULL
)
22655 s
->font_not_found_p
= 1;
22656 s
->font
= FRAME_FONT (s
->f
);
22659 /* Adjust base line for subscript/superscript text. */
22660 s
->ybase
+= s
->first_glyph
->voffset
;
22662 /* This glyph string must always be drawn with 16-bit functions. */
22669 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22670 int start
, int end
, int overlaps
)
22672 struct glyph
*glyph
, *last
;
22673 Lisp_Object lgstring
;
22676 s
->for_overlaps
= overlaps
;
22677 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22678 last
= s
->row
->glyphs
[s
->area
] + end
;
22679 s
->cmp_id
= glyph
->u
.cmp
.id
;
22680 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22681 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22682 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22683 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22684 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22686 while (glyph
< last
22687 && glyph
->u
.cmp
.automatic
22688 && glyph
->u
.cmp
.id
== s
->cmp_id
22689 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22690 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22692 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22694 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22695 unsigned code
= LGLYPH_CODE (lglyph
);
22697 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22699 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22700 return glyph
- s
->row
->glyphs
[s
->area
];
22704 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22705 See the comment of fill_glyph_string for arguments.
22706 Value is the index of the first glyph not in S. */
22710 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22711 int start
, int end
, int overlaps
)
22713 struct glyph
*glyph
, *last
;
22716 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22717 s
->for_overlaps
= overlaps
;
22718 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22719 last
= s
->row
->glyphs
[s
->area
] + end
;
22720 voffset
= glyph
->voffset
;
22721 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22722 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22724 s
->width
= glyph
->pixel_width
;
22726 while (glyph
< last
22727 && glyph
->type
== GLYPHLESS_GLYPH
22728 && glyph
->voffset
== voffset
22729 && glyph
->face_id
== face_id
)
22732 s
->width
+= glyph
->pixel_width
;
22735 s
->ybase
+= voffset
;
22736 return glyph
- s
->row
->glyphs
[s
->area
];
22740 /* Fill glyph string S from a sequence of character glyphs.
22742 FACE_ID is the face id of the string. START is the index of the
22743 first glyph to consider, END is the index of the last + 1.
22744 OVERLAPS non-zero means S should draw the foreground only, and use
22745 its physical height for clipping. See also draw_glyphs.
22747 Value is the index of the first glyph not in S. */
22750 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22751 int start
, int end
, int overlaps
)
22753 struct glyph
*glyph
, *last
;
22755 int glyph_not_available_p
;
22757 eassert (s
->f
== XFRAME (s
->w
->frame
));
22758 eassert (s
->nchars
== 0);
22759 eassert (start
>= 0 && end
> start
);
22761 s
->for_overlaps
= overlaps
;
22762 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22763 last
= s
->row
->glyphs
[s
->area
] + end
;
22764 voffset
= glyph
->voffset
;
22765 s
->padding_p
= glyph
->padding_p
;
22766 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22768 while (glyph
< last
22769 && glyph
->type
== CHAR_GLYPH
22770 && glyph
->voffset
== voffset
22771 /* Same face id implies same font, nowadays. */
22772 && glyph
->face_id
== face_id
22773 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22777 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22778 s
->char2b
+ s
->nchars
,
22780 s
->two_byte_p
= two_byte_p
;
22782 eassert (s
->nchars
<= end
- start
);
22783 s
->width
+= glyph
->pixel_width
;
22784 if (glyph
++->padding_p
!= s
->padding_p
)
22788 s
->font
= s
->face
->font
;
22790 /* If the specified font could not be loaded, use the frame's font,
22791 but record the fact that we couldn't load it in
22792 S->font_not_found_p so that we can draw rectangles for the
22793 characters of the glyph string. */
22794 if (s
->font
== NULL
|| glyph_not_available_p
)
22796 s
->font_not_found_p
= 1;
22797 s
->font
= FRAME_FONT (s
->f
);
22800 /* Adjust base line for subscript/superscript text. */
22801 s
->ybase
+= voffset
;
22803 eassert (s
->face
&& s
->face
->gc
);
22804 return glyph
- s
->row
->glyphs
[s
->area
];
22808 /* Fill glyph string S from image glyph S->first_glyph. */
22811 fill_image_glyph_string (struct glyph_string
*s
)
22813 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22814 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22816 s
->slice
= s
->first_glyph
->slice
.img
;
22817 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22818 s
->font
= s
->face
->font
;
22819 s
->width
= s
->first_glyph
->pixel_width
;
22821 /* Adjust base line for subscript/superscript text. */
22822 s
->ybase
+= s
->first_glyph
->voffset
;
22826 /* Fill glyph string S from a sequence of stretch glyphs.
22828 START is the index of the first glyph to consider,
22829 END is the index of the last + 1.
22831 Value is the index of the first glyph not in S. */
22834 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22836 struct glyph
*glyph
, *last
;
22837 int voffset
, face_id
;
22839 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22841 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22842 last
= s
->row
->glyphs
[s
->area
] + end
;
22843 face_id
= glyph
->face_id
;
22844 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22845 s
->font
= s
->face
->font
;
22846 s
->width
= glyph
->pixel_width
;
22848 voffset
= glyph
->voffset
;
22852 && glyph
->type
== STRETCH_GLYPH
22853 && glyph
->voffset
== voffset
22854 && glyph
->face_id
== face_id
);
22856 s
->width
+= glyph
->pixel_width
;
22858 /* Adjust base line for subscript/superscript text. */
22859 s
->ybase
+= voffset
;
22861 /* The case that face->gc == 0 is handled when drawing the glyph
22862 string by calling PREPARE_FACE_FOR_DISPLAY. */
22864 return glyph
- s
->row
->glyphs
[s
->area
];
22867 static struct font_metrics
*
22868 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22870 static struct font_metrics metrics
;
22871 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22873 if (! font
|| code
== FONT_INVALID_CODE
)
22875 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22880 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22881 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22882 assumed to be zero. */
22885 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22887 *left
= *right
= 0;
22889 if (glyph
->type
== CHAR_GLYPH
)
22893 struct font_metrics
*pcm
;
22895 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22896 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22898 if (pcm
->rbearing
> pcm
->width
)
22899 *right
= pcm
->rbearing
- pcm
->width
;
22900 if (pcm
->lbearing
< 0)
22901 *left
= -pcm
->lbearing
;
22904 else if (glyph
->type
== COMPOSITE_GLYPH
)
22906 if (! glyph
->u
.cmp
.automatic
)
22908 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22910 if (cmp
->rbearing
> cmp
->pixel_width
)
22911 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22912 if (cmp
->lbearing
< 0)
22913 *left
= - cmp
->lbearing
;
22917 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22918 struct font_metrics metrics
;
22920 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22921 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22922 if (metrics
.rbearing
> metrics
.width
)
22923 *right
= metrics
.rbearing
- metrics
.width
;
22924 if (metrics
.lbearing
< 0)
22925 *left
= - metrics
.lbearing
;
22931 /* Return the index of the first glyph preceding glyph string S that
22932 is overwritten by S because of S's left overhang. Value is -1
22933 if no glyphs are overwritten. */
22936 left_overwritten (struct glyph_string
*s
)
22940 if (s
->left_overhang
)
22943 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22944 int first
= s
->first_glyph
- glyphs
;
22946 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22947 x
-= glyphs
[i
].pixel_width
;
22958 /* Return the index of the first glyph preceding glyph string S that
22959 is overwriting S because of its right overhang. Value is -1 if no
22960 glyph in front of S overwrites S. */
22963 left_overwriting (struct glyph_string
*s
)
22966 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22967 int first
= s
->first_glyph
- glyphs
;
22971 for (i
= first
- 1; i
>= 0; --i
)
22974 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22977 x
-= glyphs
[i
].pixel_width
;
22984 /* Return the index of the last glyph following glyph string S that is
22985 overwritten by S because of S's right overhang. Value is -1 if
22986 no such glyph is found. */
22989 right_overwritten (struct glyph_string
*s
)
22993 if (s
->right_overhang
)
22996 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22997 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22998 int end
= s
->row
->used
[s
->area
];
23000 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23001 x
+= glyphs
[i
].pixel_width
;
23010 /* Return the index of the last glyph following glyph string S that
23011 overwrites S because of its left overhang. Value is negative
23012 if no such glyph is found. */
23015 right_overwriting (struct glyph_string
*s
)
23018 int end
= s
->row
->used
[s
->area
];
23019 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23020 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
23024 for (i
= first
; i
< end
; ++i
)
23027 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23030 x
+= glyphs
[i
].pixel_width
;
23037 /* Set background width of glyph string S. START is the index of the
23038 first glyph following S. LAST_X is the right-most x-position + 1
23039 in the drawing area. */
23042 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23044 /* If the face of this glyph string has to be drawn to the end of
23045 the drawing area, set S->extends_to_end_of_line_p. */
23047 if (start
== s
->row
->used
[s
->area
]
23048 && s
->area
== TEXT_AREA
23049 && ((s
->row
->fill_line_p
23050 && (s
->hl
== DRAW_NORMAL_TEXT
23051 || s
->hl
== DRAW_IMAGE_RAISED
23052 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23053 || s
->hl
== DRAW_MOUSE_FACE
))
23054 s
->extends_to_end_of_line_p
= 1;
23056 /* If S extends its face to the end of the line, set its
23057 background_width to the distance to the right edge of the drawing
23059 if (s
->extends_to_end_of_line_p
)
23060 s
->background_width
= last_x
- s
->x
+ 1;
23062 s
->background_width
= s
->width
;
23066 /* Compute overhangs and x-positions for glyph string S and its
23067 predecessors, or successors. X is the starting x-position for S.
23068 BACKWARD_P non-zero means process predecessors. */
23071 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23077 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23078 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23088 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23089 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23099 /* The following macros are only called from draw_glyphs below.
23100 They reference the following parameters of that function directly:
23101 `w', `row', `area', and `overlap_p'
23102 as well as the following local variables:
23103 `s', `f', and `hdc' (in W32) */
23106 /* On W32, silently add local `hdc' variable to argument list of
23107 init_glyph_string. */
23108 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23109 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23111 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23112 init_glyph_string (s, char2b, w, row, area, start, hl)
23115 /* Add a glyph string for a stretch glyph to the list of strings
23116 between HEAD and TAIL. START is the index of the stretch glyph in
23117 row area AREA of glyph row ROW. END is the index of the last glyph
23118 in that glyph row area. X is the current output position assigned
23119 to the new glyph string constructed. HL overrides that face of the
23120 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23121 is the right-most x-position of the drawing area. */
23123 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23124 and below -- keep them on one line. */
23125 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23128 s = alloca (sizeof *s); \
23129 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23130 START = fill_stretch_glyph_string (s, START, END); \
23131 append_glyph_string (&HEAD, &TAIL, s); \
23137 /* Add a glyph string for an image glyph to the list of strings
23138 between HEAD and TAIL. START is the index of the image glyph in
23139 row area AREA of glyph row ROW. END is the index of the last glyph
23140 in that glyph row area. X is the current output position assigned
23141 to the new glyph string constructed. HL overrides that face of the
23142 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23143 is the right-most x-position of the drawing area. */
23145 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23148 s = alloca (sizeof *s); \
23149 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23150 fill_image_glyph_string (s); \
23151 append_glyph_string (&HEAD, &TAIL, s); \
23158 /* Add a glyph string for a sequence of character glyphs to the list
23159 of strings between HEAD and TAIL. START is the index of the first
23160 glyph in row area AREA of glyph row ROW that is part of the new
23161 glyph string. END is the index of the last glyph in that glyph row
23162 area. X is the current output position assigned to the new glyph
23163 string constructed. HL overrides that face of the glyph; e.g. it
23164 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23165 right-most x-position of the drawing area. */
23167 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23173 face_id = (row)->glyphs[area][START].face_id; \
23175 s = alloca (sizeof *s); \
23176 char2b = alloca ((END - START) * sizeof *char2b); \
23177 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23178 append_glyph_string (&HEAD, &TAIL, s); \
23180 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23185 /* Add a glyph string for a composite sequence to the list of strings
23186 between HEAD and TAIL. START is the index of the first glyph in
23187 row area AREA of glyph row ROW that is part of the new glyph
23188 string. END is the index of the last glyph in that glyph row area.
23189 X is the current output position assigned to the new glyph string
23190 constructed. HL overrides that face of the glyph; e.g. it is
23191 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23192 x-position of the drawing area. */
23194 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23196 int face_id = (row)->glyphs[area][START].face_id; \
23197 struct face *base_face = FACE_FROM_ID (f, face_id); \
23198 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23199 struct composition *cmp = composition_table[cmp_id]; \
23201 struct glyph_string *first_s = NULL; \
23204 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23206 /* Make glyph_strings for each glyph sequence that is drawable by \
23207 the same face, and append them to HEAD/TAIL. */ \
23208 for (n = 0; n < cmp->glyph_len;) \
23210 s = alloca (sizeof *s); \
23211 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23212 append_glyph_string (&(HEAD), &(TAIL), s); \
23218 n = fill_composite_glyph_string (s, base_face, overlaps); \
23226 /* Add a glyph string for a glyph-string sequence to the list of strings
23227 between HEAD and TAIL. */
23229 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23233 Lisp_Object gstring; \
23235 face_id = (row)->glyphs[area][START].face_id; \
23236 gstring = (composition_gstring_from_id \
23237 ((row)->glyphs[area][START].u.cmp.id)); \
23238 s = alloca (sizeof *s); \
23239 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23240 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23241 append_glyph_string (&(HEAD), &(TAIL), s); \
23243 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23247 /* Add a glyph string for a sequence of glyphless character's glyphs
23248 to the list of strings between HEAD and TAIL. The meanings of
23249 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23251 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23256 face_id = (row)->glyphs[area][START].face_id; \
23258 s = alloca (sizeof *s); \
23259 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23260 append_glyph_string (&HEAD, &TAIL, s); \
23262 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23268 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23269 of AREA of glyph row ROW on window W between indices START and END.
23270 HL overrides the face for drawing glyph strings, e.g. it is
23271 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23272 x-positions of the drawing area.
23274 This is an ugly monster macro construct because we must use alloca
23275 to allocate glyph strings (because draw_glyphs can be called
23276 asynchronously). */
23278 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23281 HEAD = TAIL = NULL; \
23282 while (START < END) \
23284 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23285 switch (first_glyph->type) \
23288 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23292 case COMPOSITE_GLYPH: \
23293 if (first_glyph->u.cmp.automatic) \
23294 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23297 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23301 case STRETCH_GLYPH: \
23302 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23306 case IMAGE_GLYPH: \
23307 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23311 case GLYPHLESS_GLYPH: \
23312 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23322 set_glyph_string_background_width (s, START, LAST_X); \
23329 /* Draw glyphs between START and END in AREA of ROW on window W,
23330 starting at x-position X. X is relative to AREA in W. HL is a
23331 face-override with the following meaning:
23333 DRAW_NORMAL_TEXT draw normally
23334 DRAW_CURSOR draw in cursor face
23335 DRAW_MOUSE_FACE draw in mouse face.
23336 DRAW_INVERSE_VIDEO draw in mode line face
23337 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23338 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23340 If OVERLAPS is non-zero, draw only the foreground of characters and
23341 clip to the physical height of ROW. Non-zero value also defines
23342 the overlapping part to be drawn:
23344 OVERLAPS_PRED overlap with preceding rows
23345 OVERLAPS_SUCC overlap with succeeding rows
23346 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23347 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23349 Value is the x-position reached, relative to AREA of W. */
23352 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23353 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23354 enum draw_glyphs_face hl
, int overlaps
)
23356 struct glyph_string
*head
, *tail
;
23357 struct glyph_string
*s
;
23358 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23359 int i
, j
, x_reached
, last_x
, area_left
= 0;
23360 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23363 ALLOCATE_HDC (hdc
, f
);
23365 /* Let's rather be paranoid than getting a SEGV. */
23366 end
= min (end
, row
->used
[area
]);
23367 start
= max (0, start
);
23368 start
= min (end
, start
);
23370 /* Translate X to frame coordinates. Set last_x to the right
23371 end of the drawing area. */
23372 if (row
->full_width_p
)
23374 /* X is relative to the left edge of W, without scroll bars
23376 area_left
= WINDOW_LEFT_EDGE_X (w
);
23377 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23381 area_left
= window_box_left (w
, area
);
23382 last_x
= area_left
+ window_box_width (w
, area
);
23386 /* Build a doubly-linked list of glyph_string structures between
23387 head and tail from what we have to draw. Note that the macro
23388 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23389 the reason we use a separate variable `i'. */
23391 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23393 x_reached
= tail
->x
+ tail
->background_width
;
23397 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23398 the row, redraw some glyphs in front or following the glyph
23399 strings built above. */
23400 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23402 struct glyph_string
*h
, *t
;
23403 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23404 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23405 int check_mouse_face
= 0;
23408 /* If mouse highlighting is on, we may need to draw adjacent
23409 glyphs using mouse-face highlighting. */
23410 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23412 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23414 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23415 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23417 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23419 check_mouse_face
= 1;
23420 mouse_beg_col
= (row
== mouse_beg_row
)
23421 ? hlinfo
->mouse_face_beg_col
: 0;
23422 mouse_end_col
= (row
== mouse_end_row
)
23423 ? hlinfo
->mouse_face_end_col
23424 : row
->used
[TEXT_AREA
];
23428 /* Compute overhangs for all glyph strings. */
23429 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23430 for (s
= head
; s
; s
= s
->next
)
23431 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23433 /* Prepend glyph strings for glyphs in front of the first glyph
23434 string that are overwritten because of the first glyph
23435 string's left overhang. The background of all strings
23436 prepended must be drawn because the first glyph string
23438 i
= left_overwritten (head
);
23441 enum draw_glyphs_face overlap_hl
;
23443 /* If this row contains mouse highlighting, attempt to draw
23444 the overlapped glyphs with the correct highlight. This
23445 code fails if the overlap encompasses more than one glyph
23446 and mouse-highlight spans only some of these glyphs.
23447 However, making it work perfectly involves a lot more
23448 code, and I don't know if the pathological case occurs in
23449 practice, so we'll stick to this for now. --- cyd */
23450 if (check_mouse_face
23451 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23452 overlap_hl
= DRAW_MOUSE_FACE
;
23454 overlap_hl
= DRAW_NORMAL_TEXT
;
23457 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23458 overlap_hl
, dummy_x
, last_x
);
23460 compute_overhangs_and_x (t
, head
->x
, 1);
23461 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23465 /* Prepend glyph strings for glyphs in front of the first glyph
23466 string that overwrite that glyph string because of their
23467 right overhang. For these strings, only the foreground must
23468 be drawn, because it draws over the glyph string at `head'.
23469 The background must not be drawn because this would overwrite
23470 right overhangs of preceding glyphs for which no glyph
23472 i
= left_overwriting (head
);
23475 enum draw_glyphs_face overlap_hl
;
23477 if (check_mouse_face
23478 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23479 overlap_hl
= DRAW_MOUSE_FACE
;
23481 overlap_hl
= DRAW_NORMAL_TEXT
;
23484 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23485 overlap_hl
, dummy_x
, last_x
);
23486 for (s
= h
; s
; s
= s
->next
)
23487 s
->background_filled_p
= 1;
23488 compute_overhangs_and_x (t
, head
->x
, 1);
23489 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23492 /* Append glyphs strings for glyphs following the last glyph
23493 string tail that are overwritten by tail. The background of
23494 these strings has to be drawn because tail's foreground draws
23496 i
= right_overwritten (tail
);
23499 enum draw_glyphs_face overlap_hl
;
23501 if (check_mouse_face
23502 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23503 overlap_hl
= DRAW_MOUSE_FACE
;
23505 overlap_hl
= DRAW_NORMAL_TEXT
;
23507 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23508 overlap_hl
, x
, last_x
);
23509 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23510 we don't have `end = i;' here. */
23511 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23512 append_glyph_string_lists (&head
, &tail
, h
, t
);
23516 /* Append glyph strings for glyphs following the last glyph
23517 string tail that overwrite tail. The foreground of such
23518 glyphs has to be drawn because it writes into the background
23519 of tail. The background must not be drawn because it could
23520 paint over the foreground of following glyphs. */
23521 i
= right_overwriting (tail
);
23524 enum draw_glyphs_face overlap_hl
;
23525 if (check_mouse_face
23526 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23527 overlap_hl
= DRAW_MOUSE_FACE
;
23529 overlap_hl
= DRAW_NORMAL_TEXT
;
23532 i
++; /* We must include the Ith glyph. */
23533 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23534 overlap_hl
, x
, last_x
);
23535 for (s
= h
; s
; s
= s
->next
)
23536 s
->background_filled_p
= 1;
23537 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23538 append_glyph_string_lists (&head
, &tail
, h
, t
);
23540 if (clip_head
|| clip_tail
)
23541 for (s
= head
; s
; s
= s
->next
)
23543 s
->clip_head
= clip_head
;
23544 s
->clip_tail
= clip_tail
;
23548 /* Draw all strings. */
23549 for (s
= head
; s
; s
= s
->next
)
23550 FRAME_RIF (f
)->draw_glyph_string (s
);
23553 /* When focus a sole frame and move horizontally, this sets on_p to 0
23554 causing a failure to erase prev cursor position. */
23555 if (area
== TEXT_AREA
23556 && !row
->full_width_p
23557 /* When drawing overlapping rows, only the glyph strings'
23558 foreground is drawn, which doesn't erase a cursor
23562 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23563 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23564 : (tail
? tail
->x
+ tail
->background_width
: x
));
23568 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23569 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23573 /* Value is the x-position up to which drawn, relative to AREA of W.
23574 This doesn't include parts drawn because of overhangs. */
23575 if (row
->full_width_p
)
23576 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23578 x_reached
-= area_left
;
23580 RELEASE_HDC (hdc
, f
);
23585 /* Expand row matrix if too narrow. Don't expand if area
23588 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23590 if (!fonts_changed_p \
23591 && (it->glyph_row->glyphs[area] \
23592 < it->glyph_row->glyphs[area + 1])) \
23594 it->w->ncols_scale_factor++; \
23595 fonts_changed_p = 1; \
23599 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23600 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23603 append_glyph (struct it
*it
)
23605 struct glyph
*glyph
;
23606 enum glyph_row_area area
= it
->area
;
23608 eassert (it
->glyph_row
);
23609 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23611 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23612 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23614 /* If the glyph row is reversed, we need to prepend the glyph
23615 rather than append it. */
23616 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23620 /* Make room for the additional glyph. */
23621 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23623 glyph
= it
->glyph_row
->glyphs
[area
];
23625 glyph
->charpos
= CHARPOS (it
->position
);
23626 glyph
->object
= it
->object
;
23627 if (it
->pixel_width
> 0)
23629 glyph
->pixel_width
= it
->pixel_width
;
23630 glyph
->padding_p
= 0;
23634 /* Assure at least 1-pixel width. Otherwise, cursor can't
23635 be displayed correctly. */
23636 glyph
->pixel_width
= 1;
23637 glyph
->padding_p
= 1;
23639 glyph
->ascent
= it
->ascent
;
23640 glyph
->descent
= it
->descent
;
23641 glyph
->voffset
= it
->voffset
;
23642 glyph
->type
= CHAR_GLYPH
;
23643 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23644 glyph
->multibyte_p
= it
->multibyte_p
;
23645 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23646 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23647 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23648 || it
->phys_descent
> it
->descent
);
23649 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23650 glyph
->face_id
= it
->face_id
;
23651 glyph
->u
.ch
= it
->char_to_display
;
23652 glyph
->slice
.img
= null_glyph_slice
;
23653 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23656 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23657 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23659 glyph
->bidi_type
= it
->bidi_it
.type
;
23663 glyph
->resolved_level
= 0;
23664 glyph
->bidi_type
= UNKNOWN_BT
;
23666 ++it
->glyph_row
->used
[area
];
23669 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23672 /* Store one glyph for the composition IT->cmp_it.id in
23673 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23677 append_composite_glyph (struct it
*it
)
23679 struct glyph
*glyph
;
23680 enum glyph_row_area area
= it
->area
;
23682 eassert (it
->glyph_row
);
23684 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23685 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23687 /* If the glyph row is reversed, we need to prepend the glyph
23688 rather than append it. */
23689 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23693 /* Make room for the new glyph. */
23694 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23696 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23698 glyph
->charpos
= it
->cmp_it
.charpos
;
23699 glyph
->object
= it
->object
;
23700 glyph
->pixel_width
= it
->pixel_width
;
23701 glyph
->ascent
= it
->ascent
;
23702 glyph
->descent
= it
->descent
;
23703 glyph
->voffset
= it
->voffset
;
23704 glyph
->type
= COMPOSITE_GLYPH
;
23705 if (it
->cmp_it
.ch
< 0)
23707 glyph
->u
.cmp
.automatic
= 0;
23708 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23709 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23713 glyph
->u
.cmp
.automatic
= 1;
23714 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23715 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23716 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23718 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23719 glyph
->multibyte_p
= it
->multibyte_p
;
23720 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23721 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23722 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23723 || it
->phys_descent
> it
->descent
);
23724 glyph
->padding_p
= 0;
23725 glyph
->glyph_not_available_p
= 0;
23726 glyph
->face_id
= it
->face_id
;
23727 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23730 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23731 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23733 glyph
->bidi_type
= it
->bidi_it
.type
;
23735 ++it
->glyph_row
->used
[area
];
23738 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23742 /* Change IT->ascent and IT->height according to the setting of
23746 take_vertical_position_into_account (struct it
*it
)
23750 if (it
->voffset
< 0)
23751 /* Increase the ascent so that we can display the text higher
23753 it
->ascent
-= it
->voffset
;
23755 /* Increase the descent so that we can display the text lower
23757 it
->descent
+= it
->voffset
;
23762 /* Produce glyphs/get display metrics for the image IT is loaded with.
23763 See the description of struct display_iterator in dispextern.h for
23764 an overview of struct display_iterator. */
23767 produce_image_glyph (struct it
*it
)
23771 int glyph_ascent
, crop
;
23772 struct glyph_slice slice
;
23774 eassert (it
->what
== IT_IMAGE
);
23776 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23778 /* Make sure X resources of the face is loaded. */
23779 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23781 if (it
->image_id
< 0)
23783 /* Fringe bitmap. */
23784 it
->ascent
= it
->phys_ascent
= 0;
23785 it
->descent
= it
->phys_descent
= 0;
23786 it
->pixel_width
= 0;
23791 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23793 /* Make sure X resources of the image is loaded. */
23794 prepare_image_for_display (it
->f
, img
);
23796 slice
.x
= slice
.y
= 0;
23797 slice
.width
= img
->width
;
23798 slice
.height
= img
->height
;
23800 if (INTEGERP (it
->slice
.x
))
23801 slice
.x
= XINT (it
->slice
.x
);
23802 else if (FLOATP (it
->slice
.x
))
23803 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23805 if (INTEGERP (it
->slice
.y
))
23806 slice
.y
= XINT (it
->slice
.y
);
23807 else if (FLOATP (it
->slice
.y
))
23808 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23810 if (INTEGERP (it
->slice
.width
))
23811 slice
.width
= XINT (it
->slice
.width
);
23812 else if (FLOATP (it
->slice
.width
))
23813 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23815 if (INTEGERP (it
->slice
.height
))
23816 slice
.height
= XINT (it
->slice
.height
);
23817 else if (FLOATP (it
->slice
.height
))
23818 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23820 if (slice
.x
>= img
->width
)
23821 slice
.x
= img
->width
;
23822 if (slice
.y
>= img
->height
)
23823 slice
.y
= img
->height
;
23824 if (slice
.x
+ slice
.width
>= img
->width
)
23825 slice
.width
= img
->width
- slice
.x
;
23826 if (slice
.y
+ slice
.height
> img
->height
)
23827 slice
.height
= img
->height
- slice
.y
;
23829 if (slice
.width
== 0 || slice
.height
== 0)
23832 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23834 it
->descent
= slice
.height
- glyph_ascent
;
23836 it
->descent
+= img
->vmargin
;
23837 if (slice
.y
+ slice
.height
== img
->height
)
23838 it
->descent
+= img
->vmargin
;
23839 it
->phys_descent
= it
->descent
;
23841 it
->pixel_width
= slice
.width
;
23843 it
->pixel_width
+= img
->hmargin
;
23844 if (slice
.x
+ slice
.width
== img
->width
)
23845 it
->pixel_width
+= img
->hmargin
;
23847 /* It's quite possible for images to have an ascent greater than
23848 their height, so don't get confused in that case. */
23849 if (it
->descent
< 0)
23854 if (face
->box
!= FACE_NO_BOX
)
23856 if (face
->box_line_width
> 0)
23859 it
->ascent
+= face
->box_line_width
;
23860 if (slice
.y
+ slice
.height
== img
->height
)
23861 it
->descent
+= face
->box_line_width
;
23864 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23865 it
->pixel_width
+= eabs (face
->box_line_width
);
23866 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23867 it
->pixel_width
+= eabs (face
->box_line_width
);
23870 take_vertical_position_into_account (it
);
23872 /* Automatically crop wide image glyphs at right edge so we can
23873 draw the cursor on same display row. */
23874 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23875 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23877 it
->pixel_width
-= crop
;
23878 slice
.width
-= crop
;
23883 struct glyph
*glyph
;
23884 enum glyph_row_area area
= it
->area
;
23886 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23887 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23889 glyph
->charpos
= CHARPOS (it
->position
);
23890 glyph
->object
= it
->object
;
23891 glyph
->pixel_width
= it
->pixel_width
;
23892 glyph
->ascent
= glyph_ascent
;
23893 glyph
->descent
= it
->descent
;
23894 glyph
->voffset
= it
->voffset
;
23895 glyph
->type
= IMAGE_GLYPH
;
23896 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23897 glyph
->multibyte_p
= it
->multibyte_p
;
23898 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23899 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23900 glyph
->overlaps_vertically_p
= 0;
23901 glyph
->padding_p
= 0;
23902 glyph
->glyph_not_available_p
= 0;
23903 glyph
->face_id
= it
->face_id
;
23904 glyph
->u
.img_id
= img
->id
;
23905 glyph
->slice
.img
= slice
;
23906 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23909 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23910 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23912 glyph
->bidi_type
= it
->bidi_it
.type
;
23914 ++it
->glyph_row
->used
[area
];
23917 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23922 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23923 of the glyph, WIDTH and HEIGHT are the width and height of the
23924 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23927 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23928 int width
, int height
, int ascent
)
23930 struct glyph
*glyph
;
23931 enum glyph_row_area area
= it
->area
;
23933 eassert (ascent
>= 0 && ascent
<= height
);
23935 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23936 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23938 /* If the glyph row is reversed, we need to prepend the glyph
23939 rather than append it. */
23940 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23944 /* Make room for the additional glyph. */
23945 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23947 glyph
= it
->glyph_row
->glyphs
[area
];
23949 glyph
->charpos
= CHARPOS (it
->position
);
23950 glyph
->object
= object
;
23951 glyph
->pixel_width
= width
;
23952 glyph
->ascent
= ascent
;
23953 glyph
->descent
= height
- ascent
;
23954 glyph
->voffset
= it
->voffset
;
23955 glyph
->type
= STRETCH_GLYPH
;
23956 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23957 glyph
->multibyte_p
= it
->multibyte_p
;
23958 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23959 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23960 glyph
->overlaps_vertically_p
= 0;
23961 glyph
->padding_p
= 0;
23962 glyph
->glyph_not_available_p
= 0;
23963 glyph
->face_id
= it
->face_id
;
23964 glyph
->u
.stretch
.ascent
= ascent
;
23965 glyph
->u
.stretch
.height
= height
;
23966 glyph
->slice
.img
= null_glyph_slice
;
23967 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23970 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23971 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23973 glyph
->bidi_type
= it
->bidi_it
.type
;
23977 glyph
->resolved_level
= 0;
23978 glyph
->bidi_type
= UNKNOWN_BT
;
23980 ++it
->glyph_row
->used
[area
];
23983 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23986 #endif /* HAVE_WINDOW_SYSTEM */
23988 /* Produce a stretch glyph for iterator IT. IT->object is the value
23989 of the glyph property displayed. The value must be a list
23990 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23993 1. `:width WIDTH' specifies that the space should be WIDTH *
23994 canonical char width wide. WIDTH may be an integer or floating
23997 2. `:relative-width FACTOR' specifies that the width of the stretch
23998 should be computed from the width of the first character having the
23999 `glyph' property, and should be FACTOR times that width.
24001 3. `:align-to HPOS' specifies that the space should be wide enough
24002 to reach HPOS, a value in canonical character units.
24004 Exactly one of the above pairs must be present.
24006 4. `:height HEIGHT' specifies that the height of the stretch produced
24007 should be HEIGHT, measured in canonical character units.
24009 5. `:relative-height FACTOR' specifies that the height of the
24010 stretch should be FACTOR times the height of the characters having
24011 the glyph property.
24013 Either none or exactly one of 4 or 5 must be present.
24015 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24016 of the stretch should be used for the ascent of the stretch.
24017 ASCENT must be in the range 0 <= ASCENT <= 100. */
24020 produce_stretch_glyph (struct it
*it
)
24022 /* (space :width WIDTH :height HEIGHT ...) */
24023 Lisp_Object prop
, plist
;
24024 int width
= 0, height
= 0, align_to
= -1;
24025 int zero_width_ok_p
= 0;
24028 struct face
*face
= NULL
;
24029 struct font
*font
= NULL
;
24031 #ifdef HAVE_WINDOW_SYSTEM
24032 int zero_height_ok_p
= 0;
24034 if (FRAME_WINDOW_P (it
->f
))
24036 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24037 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24038 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24042 /* List should start with `space'. */
24043 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24044 plist
= XCDR (it
->object
);
24046 /* Compute the width of the stretch. */
24047 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24048 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24050 /* Absolute width `:width WIDTH' specified and valid. */
24051 zero_width_ok_p
= 1;
24054 #ifdef HAVE_WINDOW_SYSTEM
24055 else if (FRAME_WINDOW_P (it
->f
)
24056 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24058 /* Relative width `:relative-width FACTOR' specified and valid.
24059 Compute the width of the characters having the `glyph'
24062 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24065 if (it
->multibyte_p
)
24066 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24069 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24070 if (! ASCII_CHAR_P (it2
.c
))
24071 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24074 it2
.glyph_row
= NULL
;
24075 it2
.what
= IT_CHARACTER
;
24076 x_produce_glyphs (&it2
);
24077 width
= NUMVAL (prop
) * it2
.pixel_width
;
24079 #endif /* HAVE_WINDOW_SYSTEM */
24080 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24081 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24083 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24084 align_to
= (align_to
< 0
24086 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24087 else if (align_to
< 0)
24088 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24089 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24090 zero_width_ok_p
= 1;
24093 /* Nothing specified -> width defaults to canonical char width. */
24094 width
= FRAME_COLUMN_WIDTH (it
->f
);
24096 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24099 #ifdef HAVE_WINDOW_SYSTEM
24100 /* Compute height. */
24101 if (FRAME_WINDOW_P (it
->f
))
24103 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24104 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24107 zero_height_ok_p
= 1;
24109 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24111 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24113 height
= FONT_HEIGHT (font
);
24115 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24118 /* Compute percentage of height used for ascent. If
24119 `:ascent ASCENT' is present and valid, use that. Otherwise,
24120 derive the ascent from the font in use. */
24121 if (prop
= Fplist_get (plist
, QCascent
),
24122 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24123 ascent
= height
* NUMVAL (prop
) / 100.0;
24124 else if (!NILP (prop
)
24125 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24126 ascent
= min (max (0, (int)tem
), height
);
24128 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24131 #endif /* HAVE_WINDOW_SYSTEM */
24134 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24135 && it
->current_x
+ width
> it
->last_visible_x
)
24137 width
= it
->last_visible_x
- it
->current_x
;
24138 #ifdef HAVE_WINDOW_SYSTEM
24139 /* Subtract one more pixel from the stretch width, but only on
24140 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24141 width
-= FRAME_WINDOW_P (it
->f
);
24145 if (width
> 0 && height
> 0 && it
->glyph_row
)
24147 Lisp_Object o_object
= it
->object
;
24148 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24151 if (!STRINGP (object
))
24152 object
= it
->w
->buffer
;
24153 #ifdef HAVE_WINDOW_SYSTEM
24154 if (FRAME_WINDOW_P (it
->f
))
24155 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24159 it
->object
= object
;
24160 it
->char_to_display
= ' ';
24161 it
->pixel_width
= it
->len
= 1;
24163 tty_append_glyph (it
);
24164 it
->object
= o_object
;
24168 it
->pixel_width
= width
;
24169 #ifdef HAVE_WINDOW_SYSTEM
24170 if (FRAME_WINDOW_P (it
->f
))
24172 it
->ascent
= it
->phys_ascent
= ascent
;
24173 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24174 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24175 take_vertical_position_into_account (it
);
24179 it
->nglyphs
= width
;
24182 /* Get information about special display element WHAT in an
24183 environment described by IT. WHAT is one of IT_TRUNCATION or
24184 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24185 non-null glyph_row member. This function ensures that fields like
24186 face_id, c, len of IT are left untouched. */
24189 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24196 temp_it
.object
= make_number (0);
24197 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24199 if (what
== IT_CONTINUATION
)
24201 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24202 if (it
->bidi_it
.paragraph_dir
== R2L
)
24203 SET_GLYPH_FROM_CHAR (glyph
, '/');
24205 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24207 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24209 /* FIXME: Should we mirror GC for R2L lines? */
24210 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24211 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24214 else if (what
== IT_TRUNCATION
)
24216 /* Truncation glyph. */
24217 SET_GLYPH_FROM_CHAR (glyph
, '$');
24219 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24221 /* FIXME: Should we mirror GC for R2L lines? */
24222 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24223 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24229 #ifdef HAVE_WINDOW_SYSTEM
24230 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24231 is turned off, we precede the truncation/continuation glyphs by a
24232 stretch glyph whose width is computed such that these special
24233 glyphs are aligned at the window margin, even when very different
24234 fonts are used in different glyph rows. */
24235 if (FRAME_WINDOW_P (temp_it
.f
)
24236 /* init_iterator calls this with it->glyph_row == NULL, and it
24237 wants only the pixel width of the truncation/continuation
24239 && temp_it
.glyph_row
24240 /* insert_left_trunc_glyphs calls us at the beginning of the
24241 row, and it has its own calculation of the stretch glyph
24243 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24244 && (temp_it
.glyph_row
->reversed_p
24245 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24246 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24248 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24250 if (stretch_width
> 0)
24252 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24253 struct font
*font
=
24254 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24255 int stretch_ascent
=
24256 (((temp_it
.ascent
+ temp_it
.descent
)
24257 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24259 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24260 temp_it
.ascent
+ temp_it
.descent
,
24267 temp_it
.what
= IT_CHARACTER
;
24269 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24270 temp_it
.face_id
= GLYPH_FACE (glyph
);
24271 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24273 PRODUCE_GLYPHS (&temp_it
);
24274 it
->pixel_width
= temp_it
.pixel_width
;
24275 it
->nglyphs
= temp_it
.pixel_width
;
24278 #ifdef HAVE_WINDOW_SYSTEM
24280 /* Calculate line-height and line-spacing properties.
24281 An integer value specifies explicit pixel value.
24282 A float value specifies relative value to current face height.
24283 A cons (float . face-name) specifies relative value to
24284 height of specified face font.
24286 Returns height in pixels, or nil. */
24290 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24291 int boff
, int override
)
24293 Lisp_Object face_name
= Qnil
;
24294 int ascent
, descent
, height
;
24296 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24301 face_name
= XCAR (val
);
24303 if (!NUMBERP (val
))
24304 val
= make_number (1);
24305 if (NILP (face_name
))
24307 height
= it
->ascent
+ it
->descent
;
24312 if (NILP (face_name
))
24314 font
= FRAME_FONT (it
->f
);
24315 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24317 else if (EQ (face_name
, Qt
))
24326 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24328 return make_number (-1);
24330 face
= FACE_FROM_ID (it
->f
, face_id
);
24333 return make_number (-1);
24334 boff
= font
->baseline_offset
;
24335 if (font
->vertical_centering
)
24336 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24339 ascent
= FONT_BASE (font
) + boff
;
24340 descent
= FONT_DESCENT (font
) - boff
;
24344 it
->override_ascent
= ascent
;
24345 it
->override_descent
= descent
;
24346 it
->override_boff
= boff
;
24349 height
= ascent
+ descent
;
24353 height
= (int)(XFLOAT_DATA (val
) * height
);
24354 else if (INTEGERP (val
))
24355 height
*= XINT (val
);
24357 return make_number (height
);
24361 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24362 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24363 and only if this is for a character for which no font was found.
24365 If the display method (it->glyphless_method) is
24366 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24367 length of the acronym or the hexadecimal string, UPPER_XOFF and
24368 UPPER_YOFF are pixel offsets for the upper part of the string,
24369 LOWER_XOFF and LOWER_YOFF are for the lower part.
24371 For the other display methods, LEN through LOWER_YOFF are zero. */
24374 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24375 short upper_xoff
, short upper_yoff
,
24376 short lower_xoff
, short lower_yoff
)
24378 struct glyph
*glyph
;
24379 enum glyph_row_area area
= it
->area
;
24381 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24382 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24384 /* If the glyph row is reversed, we need to prepend the glyph
24385 rather than append it. */
24386 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24390 /* Make room for the additional glyph. */
24391 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24393 glyph
= it
->glyph_row
->glyphs
[area
];
24395 glyph
->charpos
= CHARPOS (it
->position
);
24396 glyph
->object
= it
->object
;
24397 glyph
->pixel_width
= it
->pixel_width
;
24398 glyph
->ascent
= it
->ascent
;
24399 glyph
->descent
= it
->descent
;
24400 glyph
->voffset
= it
->voffset
;
24401 glyph
->type
= GLYPHLESS_GLYPH
;
24402 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24403 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24404 glyph
->u
.glyphless
.len
= len
;
24405 glyph
->u
.glyphless
.ch
= it
->c
;
24406 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24407 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24408 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24409 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24410 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24411 glyph
->multibyte_p
= it
->multibyte_p
;
24412 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24413 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24414 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24415 || it
->phys_descent
> it
->descent
);
24416 glyph
->padding_p
= 0;
24417 glyph
->glyph_not_available_p
= 0;
24418 glyph
->face_id
= face_id
;
24419 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24422 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24423 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24425 glyph
->bidi_type
= it
->bidi_it
.type
;
24427 ++it
->glyph_row
->used
[area
];
24430 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24434 /* Produce a glyph for a glyphless character for iterator IT.
24435 IT->glyphless_method specifies which method to use for displaying
24436 the character. See the description of enum
24437 glyphless_display_method in dispextern.h for the detail.
24439 FOR_NO_FONT is nonzero if and only if this is for a character for
24440 which no font was found. ACRONYM, if non-nil, is an acronym string
24441 for the character. */
24444 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24449 int base_width
, base_height
, width
, height
;
24450 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24453 /* Get the metrics of the base font. We always refer to the current
24455 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24456 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24457 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24458 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24459 base_height
= it
->ascent
+ it
->descent
;
24460 base_width
= font
->average_width
;
24462 /* Get a face ID for the glyph by utilizing a cache (the same way as
24463 done for `escape-glyph' in get_next_display_element). */
24464 if (it
->f
== last_glyphless_glyph_frame
24465 && it
->face_id
== last_glyphless_glyph_face_id
)
24467 face_id
= last_glyphless_glyph_merged_face_id
;
24471 /* Merge the `glyphless-char' face into the current face. */
24472 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24473 last_glyphless_glyph_frame
= it
->f
;
24474 last_glyphless_glyph_face_id
= it
->face_id
;
24475 last_glyphless_glyph_merged_face_id
= face_id
;
24478 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24480 it
->pixel_width
= THIN_SPACE_WIDTH
;
24482 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24484 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24486 width
= CHAR_WIDTH (it
->c
);
24489 else if (width
> 4)
24491 it
->pixel_width
= base_width
* width
;
24493 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24499 unsigned int code
[6];
24501 int ascent
, descent
;
24502 struct font_metrics metrics_upper
, metrics_lower
;
24504 face
= FACE_FROM_ID (it
->f
, face_id
);
24505 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24506 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24508 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24510 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24511 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24512 if (CONSP (acronym
))
24513 acronym
= XCAR (acronym
);
24514 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24518 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24519 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24522 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24523 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24524 upper_len
= (len
+ 1) / 2;
24525 font
->driver
->text_extents (font
, code
, upper_len
,
24527 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24532 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24533 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24534 upper_xoff
= upper_yoff
= 2; /* the typical case */
24535 if (base_width
>= width
)
24537 /* Align the upper to the left, the lower to the right. */
24538 it
->pixel_width
= base_width
;
24539 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24543 /* Center the shorter one. */
24544 it
->pixel_width
= width
;
24545 if (metrics_upper
.width
>= metrics_lower
.width
)
24546 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24549 /* FIXME: This code doesn't look right. It formerly was
24550 missing the "lower_xoff = 0;", which couldn't have
24551 been right since it left lower_xoff uninitialized. */
24553 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24557 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24558 top, bottom, and between upper and lower strings. */
24559 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24560 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24561 /* Center vertically.
24562 H:base_height, D:base_descent
24563 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24565 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24566 descent = D - H/2 + h/2;
24567 lower_yoff = descent - 2 - ld;
24568 upper_yoff = lower_yoff - la - 1 - ud; */
24569 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24570 descent
= it
->descent
- (base_height
- height
) / 2;
24571 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24572 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24573 - metrics_upper
.descent
);
24574 /* Don't make the height shorter than the base height. */
24575 if (height
> base_height
)
24577 it
->ascent
= ascent
;
24578 it
->descent
= descent
;
24582 it
->phys_ascent
= it
->ascent
;
24583 it
->phys_descent
= it
->descent
;
24585 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24586 upper_xoff
, upper_yoff
,
24587 lower_xoff
, lower_yoff
);
24589 take_vertical_position_into_account (it
);
24594 Produce glyphs/get display metrics for the display element IT is
24595 loaded with. See the description of struct it in dispextern.h
24596 for an overview of struct it. */
24599 x_produce_glyphs (struct it
*it
)
24601 int extra_line_spacing
= it
->extra_line_spacing
;
24603 it
->glyph_not_available_p
= 0;
24605 if (it
->what
== IT_CHARACTER
)
24608 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24609 struct font
*font
= face
->font
;
24610 struct font_metrics
*pcm
= NULL
;
24611 int boff
; /* baseline offset */
24615 /* When no suitable font is found, display this character by
24616 the method specified in the first extra slot of
24617 Vglyphless_char_display. */
24618 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24620 eassert (it
->what
== IT_GLYPHLESS
);
24621 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24625 boff
= font
->baseline_offset
;
24626 if (font
->vertical_centering
)
24627 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24629 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24635 if (it
->override_ascent
>= 0)
24637 it
->ascent
= it
->override_ascent
;
24638 it
->descent
= it
->override_descent
;
24639 boff
= it
->override_boff
;
24643 it
->ascent
= FONT_BASE (font
) + boff
;
24644 it
->descent
= FONT_DESCENT (font
) - boff
;
24647 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24649 pcm
= get_per_char_metric (font
, &char2b
);
24650 if (pcm
->width
== 0
24651 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24657 it
->phys_ascent
= pcm
->ascent
+ boff
;
24658 it
->phys_descent
= pcm
->descent
- boff
;
24659 it
->pixel_width
= pcm
->width
;
24663 it
->glyph_not_available_p
= 1;
24664 it
->phys_ascent
= it
->ascent
;
24665 it
->phys_descent
= it
->descent
;
24666 it
->pixel_width
= font
->space_width
;
24669 if (it
->constrain_row_ascent_descent_p
)
24671 if (it
->descent
> it
->max_descent
)
24673 it
->ascent
+= it
->descent
- it
->max_descent
;
24674 it
->descent
= it
->max_descent
;
24676 if (it
->ascent
> it
->max_ascent
)
24678 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24679 it
->ascent
= it
->max_ascent
;
24681 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24682 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24683 extra_line_spacing
= 0;
24686 /* If this is a space inside a region of text with
24687 `space-width' property, change its width. */
24688 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24690 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24692 /* If face has a box, add the box thickness to the character
24693 height. If character has a box line to the left and/or
24694 right, add the box line width to the character's width. */
24695 if (face
->box
!= FACE_NO_BOX
)
24697 int thick
= face
->box_line_width
;
24701 it
->ascent
+= thick
;
24702 it
->descent
+= thick
;
24707 if (it
->start_of_box_run_p
)
24708 it
->pixel_width
+= thick
;
24709 if (it
->end_of_box_run_p
)
24710 it
->pixel_width
+= thick
;
24713 /* If face has an overline, add the height of the overline
24714 (1 pixel) and a 1 pixel margin to the character height. */
24715 if (face
->overline_p
)
24716 it
->ascent
+= overline_margin
;
24718 if (it
->constrain_row_ascent_descent_p
)
24720 if (it
->ascent
> it
->max_ascent
)
24721 it
->ascent
= it
->max_ascent
;
24722 if (it
->descent
> it
->max_descent
)
24723 it
->descent
= it
->max_descent
;
24726 take_vertical_position_into_account (it
);
24728 /* If we have to actually produce glyphs, do it. */
24733 /* Translate a space with a `space-width' property
24734 into a stretch glyph. */
24735 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24736 / FONT_HEIGHT (font
));
24737 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24738 it
->ascent
+ it
->descent
, ascent
);
24743 /* If characters with lbearing or rbearing are displayed
24744 in this line, record that fact in a flag of the
24745 glyph row. This is used to optimize X output code. */
24746 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24747 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24749 if (! stretched_p
&& it
->pixel_width
== 0)
24750 /* We assure that all visible glyphs have at least 1-pixel
24752 it
->pixel_width
= 1;
24754 else if (it
->char_to_display
== '\n')
24756 /* A newline has no width, but we need the height of the
24757 line. But if previous part of the line sets a height,
24758 don't increase that height */
24760 Lisp_Object height
;
24761 Lisp_Object total_height
= Qnil
;
24763 it
->override_ascent
= -1;
24764 it
->pixel_width
= 0;
24767 height
= get_it_property (it
, Qline_height
);
24768 /* Split (line-height total-height) list */
24770 && CONSP (XCDR (height
))
24771 && NILP (XCDR (XCDR (height
))))
24773 total_height
= XCAR (XCDR (height
));
24774 height
= XCAR (height
);
24776 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24778 if (it
->override_ascent
>= 0)
24780 it
->ascent
= it
->override_ascent
;
24781 it
->descent
= it
->override_descent
;
24782 boff
= it
->override_boff
;
24786 it
->ascent
= FONT_BASE (font
) + boff
;
24787 it
->descent
= FONT_DESCENT (font
) - boff
;
24790 if (EQ (height
, Qt
))
24792 if (it
->descent
> it
->max_descent
)
24794 it
->ascent
+= it
->descent
- it
->max_descent
;
24795 it
->descent
= it
->max_descent
;
24797 if (it
->ascent
> it
->max_ascent
)
24799 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24800 it
->ascent
= it
->max_ascent
;
24802 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24803 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24804 it
->constrain_row_ascent_descent_p
= 1;
24805 extra_line_spacing
= 0;
24809 Lisp_Object spacing
;
24811 it
->phys_ascent
= it
->ascent
;
24812 it
->phys_descent
= it
->descent
;
24814 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24815 && face
->box
!= FACE_NO_BOX
24816 && face
->box_line_width
> 0)
24818 it
->ascent
+= face
->box_line_width
;
24819 it
->descent
+= face
->box_line_width
;
24822 && XINT (height
) > it
->ascent
+ it
->descent
)
24823 it
->ascent
= XINT (height
) - it
->descent
;
24825 if (!NILP (total_height
))
24826 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24829 spacing
= get_it_property (it
, Qline_spacing
);
24830 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24832 if (INTEGERP (spacing
))
24834 extra_line_spacing
= XINT (spacing
);
24835 if (!NILP (total_height
))
24836 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24840 else /* i.e. (it->char_to_display == '\t') */
24842 if (font
->space_width
> 0)
24844 int tab_width
= it
->tab_width
* font
->space_width
;
24845 int x
= it
->current_x
+ it
->continuation_lines_width
;
24846 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24848 /* If the distance from the current position to the next tab
24849 stop is less than a space character width, use the
24850 tab stop after that. */
24851 if (next_tab_x
- x
< font
->space_width
)
24852 next_tab_x
+= tab_width
;
24854 it
->pixel_width
= next_tab_x
- x
;
24856 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24857 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24861 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24862 it
->ascent
+ it
->descent
, it
->ascent
);
24867 it
->pixel_width
= 0;
24872 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24874 /* A static composition.
24876 Note: A composition is represented as one glyph in the
24877 glyph matrix. There are no padding glyphs.
24879 Important note: pixel_width, ascent, and descent are the
24880 values of what is drawn by draw_glyphs (i.e. the values of
24881 the overall glyphs composed). */
24882 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24883 int boff
; /* baseline offset */
24884 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24885 int glyph_len
= cmp
->glyph_len
;
24886 struct font
*font
= face
->font
;
24890 /* If we have not yet calculated pixel size data of glyphs of
24891 the composition for the current face font, calculate them
24892 now. Theoretically, we have to check all fonts for the
24893 glyphs, but that requires much time and memory space. So,
24894 here we check only the font of the first glyph. This may
24895 lead to incorrect display, but it's very rare, and C-l
24896 (recenter-top-bottom) can correct the display anyway. */
24897 if (! cmp
->font
|| cmp
->font
!= font
)
24899 /* Ascent and descent of the font of the first character
24900 of this composition (adjusted by baseline offset).
24901 Ascent and descent of overall glyphs should not be less
24902 than these, respectively. */
24903 int font_ascent
, font_descent
, font_height
;
24904 /* Bounding box of the overall glyphs. */
24905 int leftmost
, rightmost
, lowest
, highest
;
24906 int lbearing
, rbearing
;
24907 int i
, width
, ascent
, descent
;
24908 int left_padded
= 0, right_padded
= 0;
24909 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24911 struct font_metrics
*pcm
;
24912 int font_not_found_p
;
24915 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24916 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24918 if (glyph_len
< cmp
->glyph_len
)
24920 for (i
= 0; i
< glyph_len
; i
++)
24922 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24924 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24929 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24930 : IT_CHARPOS (*it
));
24931 /* If no suitable font is found, use the default font. */
24932 font_not_found_p
= font
== NULL
;
24933 if (font_not_found_p
)
24935 face
= face
->ascii_face
;
24938 boff
= font
->baseline_offset
;
24939 if (font
->vertical_centering
)
24940 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24941 font_ascent
= FONT_BASE (font
) + boff
;
24942 font_descent
= FONT_DESCENT (font
) - boff
;
24943 font_height
= FONT_HEIGHT (font
);
24945 cmp
->font
= (void *) font
;
24948 if (! font_not_found_p
)
24950 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24952 pcm
= get_per_char_metric (font
, &char2b
);
24955 /* Initialize the bounding box. */
24958 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24959 ascent
= pcm
->ascent
;
24960 descent
= pcm
->descent
;
24961 lbearing
= pcm
->lbearing
;
24962 rbearing
= pcm
->rbearing
;
24966 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24967 ascent
= FONT_BASE (font
);
24968 descent
= FONT_DESCENT (font
);
24975 lowest
= - descent
+ boff
;
24976 highest
= ascent
+ boff
;
24978 if (! font_not_found_p
24979 && font
->default_ascent
24980 && CHAR_TABLE_P (Vuse_default_ascent
)
24981 && !NILP (Faref (Vuse_default_ascent
,
24982 make_number (it
->char_to_display
))))
24983 highest
= font
->default_ascent
+ boff
;
24985 /* Draw the first glyph at the normal position. It may be
24986 shifted to right later if some other glyphs are drawn
24988 cmp
->offsets
[i
* 2] = 0;
24989 cmp
->offsets
[i
* 2 + 1] = boff
;
24990 cmp
->lbearing
= lbearing
;
24991 cmp
->rbearing
= rbearing
;
24993 /* Set cmp->offsets for the remaining glyphs. */
24994 for (i
++; i
< glyph_len
; i
++)
24996 int left
, right
, btm
, top
;
24997 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24999 struct face
*this_face
;
25003 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25004 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25005 font
= this_face
->font
;
25011 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25013 pcm
= get_per_char_metric (font
, &char2b
);
25016 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25019 width
= pcm
->width
;
25020 ascent
= pcm
->ascent
;
25021 descent
= pcm
->descent
;
25022 lbearing
= pcm
->lbearing
;
25023 rbearing
= pcm
->rbearing
;
25024 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25026 /* Relative composition with or without
25027 alternate chars. */
25028 left
= (leftmost
+ rightmost
- width
) / 2;
25029 btm
= - descent
+ boff
;
25030 if (font
->relative_compose
25031 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25032 || NILP (Faref (Vignore_relative_composition
,
25033 make_number (ch
)))))
25036 if (- descent
>= font
->relative_compose
)
25037 /* One extra pixel between two glyphs. */
25039 else if (ascent
<= 0)
25040 /* One extra pixel between two glyphs. */
25041 btm
= lowest
- 1 - ascent
- descent
;
25046 /* A composition rule is specified by an integer
25047 value that encodes global and new reference
25048 points (GREF and NREF). GREF and NREF are
25049 specified by numbers as below:
25051 0---1---2 -- ascent
25055 9--10--11 -- center
25057 ---3---4---5--- baseline
25059 6---7---8 -- descent
25061 int rule
= COMPOSITION_RULE (cmp
, i
);
25062 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25064 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25065 grefx
= gref
% 3, nrefx
= nref
% 3;
25066 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25068 xoff
= font_height
* (xoff
- 128) / 256;
25070 yoff
= font_height
* (yoff
- 128) / 256;
25073 + grefx
* (rightmost
- leftmost
) / 2
25074 - nrefx
* width
/ 2
25077 btm
= ((grefy
== 0 ? highest
25079 : grefy
== 2 ? lowest
25080 : (highest
+ lowest
) / 2)
25081 - (nrefy
== 0 ? ascent
+ descent
25082 : nrefy
== 1 ? descent
- boff
25084 : (ascent
+ descent
) / 2)
25088 cmp
->offsets
[i
* 2] = left
;
25089 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25091 /* Update the bounding box of the overall glyphs. */
25094 right
= left
+ width
;
25095 if (left
< leftmost
)
25097 if (right
> rightmost
)
25100 top
= btm
+ descent
+ ascent
;
25106 if (cmp
->lbearing
> left
+ lbearing
)
25107 cmp
->lbearing
= left
+ lbearing
;
25108 if (cmp
->rbearing
< left
+ rbearing
)
25109 cmp
->rbearing
= left
+ rbearing
;
25113 /* If there are glyphs whose x-offsets are negative,
25114 shift all glyphs to the right and make all x-offsets
25118 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25119 cmp
->offsets
[i
* 2] -= leftmost
;
25120 rightmost
-= leftmost
;
25121 cmp
->lbearing
-= leftmost
;
25122 cmp
->rbearing
-= leftmost
;
25125 if (left_padded
&& cmp
->lbearing
< 0)
25127 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25128 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25129 rightmost
-= cmp
->lbearing
;
25130 cmp
->rbearing
-= cmp
->lbearing
;
25133 if (right_padded
&& rightmost
< cmp
->rbearing
)
25135 rightmost
= cmp
->rbearing
;
25138 cmp
->pixel_width
= rightmost
;
25139 cmp
->ascent
= highest
;
25140 cmp
->descent
= - lowest
;
25141 if (cmp
->ascent
< font_ascent
)
25142 cmp
->ascent
= font_ascent
;
25143 if (cmp
->descent
< font_descent
)
25144 cmp
->descent
= font_descent
;
25148 && (cmp
->lbearing
< 0
25149 || cmp
->rbearing
> cmp
->pixel_width
))
25150 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25152 it
->pixel_width
= cmp
->pixel_width
;
25153 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25154 it
->descent
= it
->phys_descent
= cmp
->descent
;
25155 if (face
->box
!= FACE_NO_BOX
)
25157 int thick
= face
->box_line_width
;
25161 it
->ascent
+= thick
;
25162 it
->descent
+= thick
;
25167 if (it
->start_of_box_run_p
)
25168 it
->pixel_width
+= thick
;
25169 if (it
->end_of_box_run_p
)
25170 it
->pixel_width
+= thick
;
25173 /* If face has an overline, add the height of the overline
25174 (1 pixel) and a 1 pixel margin to the character height. */
25175 if (face
->overline_p
)
25176 it
->ascent
+= overline_margin
;
25178 take_vertical_position_into_account (it
);
25179 if (it
->ascent
< 0)
25181 if (it
->descent
< 0)
25184 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25185 append_composite_glyph (it
);
25187 else if (it
->what
== IT_COMPOSITION
)
25189 /* A dynamic (automatic) composition. */
25190 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25191 Lisp_Object gstring
;
25192 struct font_metrics metrics
;
25196 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25198 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25201 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25202 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25203 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25204 it
->descent
= it
->phys_descent
= metrics
.descent
;
25205 if (face
->box
!= FACE_NO_BOX
)
25207 int thick
= face
->box_line_width
;
25211 it
->ascent
+= thick
;
25212 it
->descent
+= thick
;
25217 if (it
->start_of_box_run_p
)
25218 it
->pixel_width
+= thick
;
25219 if (it
->end_of_box_run_p
)
25220 it
->pixel_width
+= thick
;
25222 /* If face has an overline, add the height of the overline
25223 (1 pixel) and a 1 pixel margin to the character height. */
25224 if (face
->overline_p
)
25225 it
->ascent
+= overline_margin
;
25226 take_vertical_position_into_account (it
);
25227 if (it
->ascent
< 0)
25229 if (it
->descent
< 0)
25233 append_composite_glyph (it
);
25235 else if (it
->what
== IT_GLYPHLESS
)
25236 produce_glyphless_glyph (it
, 0, Qnil
);
25237 else if (it
->what
== IT_IMAGE
)
25238 produce_image_glyph (it
);
25239 else if (it
->what
== IT_STRETCH
)
25240 produce_stretch_glyph (it
);
25243 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25244 because this isn't true for images with `:ascent 100'. */
25245 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25246 if (it
->area
== TEXT_AREA
)
25247 it
->current_x
+= it
->pixel_width
;
25249 if (extra_line_spacing
> 0)
25251 it
->descent
+= extra_line_spacing
;
25252 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25253 it
->max_extra_line_spacing
= extra_line_spacing
;
25256 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25257 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25258 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25259 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25263 Output LEN glyphs starting at START at the nominal cursor position.
25264 Advance the nominal cursor over the text. The global variable
25265 updated_window contains the window being updated, updated_row is
25266 the glyph row being updated, and updated_area is the area of that
25267 row being updated. */
25270 x_write_glyphs (struct glyph
*start
, int len
)
25272 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25274 eassert (updated_window
&& updated_row
);
25275 /* When the window is hscrolled, cursor hpos can legitimately be out
25276 of bounds, but we draw the cursor at the corresponding window
25277 margin in that case. */
25278 if (!updated_row
->reversed_p
&& chpos
< 0)
25280 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25281 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25285 /* Write glyphs. */
25287 hpos
= start
- updated_row
->glyphs
[updated_area
];
25288 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25289 updated_row
, updated_area
,
25291 DRAW_NORMAL_TEXT
, 0);
25293 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25294 if (updated_area
== TEXT_AREA
25295 && updated_window
->phys_cursor_on_p
25296 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25298 && chpos
< hpos
+ len
)
25299 updated_window
->phys_cursor_on_p
= 0;
25303 /* Advance the output cursor. */
25304 output_cursor
.hpos
+= len
;
25305 output_cursor
.x
= x
;
25310 Insert LEN glyphs from START at the nominal cursor position. */
25313 x_insert_glyphs (struct glyph
*start
, int len
)
25317 int line_height
, shift_by_width
, shifted_region_width
;
25318 struct glyph_row
*row
;
25319 struct glyph
*glyph
;
25320 int frame_x
, frame_y
;
25323 eassert (updated_window
&& updated_row
);
25325 w
= updated_window
;
25326 f
= XFRAME (WINDOW_FRAME (w
));
25328 /* Get the height of the line we are in. */
25330 line_height
= row
->height
;
25332 /* Get the width of the glyphs to insert. */
25333 shift_by_width
= 0;
25334 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25335 shift_by_width
+= glyph
->pixel_width
;
25337 /* Get the width of the region to shift right. */
25338 shifted_region_width
= (window_box_width (w
, updated_area
)
25343 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25344 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25346 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25347 line_height
, shift_by_width
);
25349 /* Write the glyphs. */
25350 hpos
= start
- row
->glyphs
[updated_area
];
25351 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25353 DRAW_NORMAL_TEXT
, 0);
25355 /* Advance the output cursor. */
25356 output_cursor
.hpos
+= len
;
25357 output_cursor
.x
+= shift_by_width
;
25363 Erase the current text line from the nominal cursor position
25364 (inclusive) to pixel column TO_X (exclusive). The idea is that
25365 everything from TO_X onward is already erased.
25367 TO_X is a pixel position relative to updated_area of
25368 updated_window. TO_X == -1 means clear to the end of this area. */
25371 x_clear_end_of_line (int to_x
)
25374 struct window
*w
= updated_window
;
25375 int max_x
, min_y
, max_y
;
25376 int from_x
, from_y
, to_y
;
25378 eassert (updated_window
&& updated_row
);
25379 f
= XFRAME (w
->frame
);
25381 if (updated_row
->full_width_p
)
25382 max_x
= WINDOW_TOTAL_WIDTH (w
);
25384 max_x
= window_box_width (w
, updated_area
);
25385 max_y
= window_text_bottom_y (w
);
25387 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25388 of window. For TO_X > 0, truncate to end of drawing area. */
25394 to_x
= min (to_x
, max_x
);
25396 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25398 /* Notice if the cursor will be cleared by this operation. */
25399 if (!updated_row
->full_width_p
)
25400 notice_overwritten_cursor (w
, updated_area
,
25401 output_cursor
.x
, -1,
25403 MATRIX_ROW_BOTTOM_Y (updated_row
));
25405 from_x
= output_cursor
.x
;
25407 /* Translate to frame coordinates. */
25408 if (updated_row
->full_width_p
)
25410 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25411 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25415 int area_left
= window_box_left (w
, updated_area
);
25416 from_x
+= area_left
;
25420 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25421 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25422 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25424 /* Prevent inadvertently clearing to end of the X window. */
25425 if (to_x
> from_x
&& to_y
> from_y
)
25428 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25429 to_x
- from_x
, to_y
- from_y
);
25434 #endif /* HAVE_WINDOW_SYSTEM */
25438 /***********************************************************************
25440 ***********************************************************************/
25442 /* Value is the internal representation of the specified cursor type
25443 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25444 of the bar cursor. */
25446 static enum text_cursor_kinds
25447 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25449 enum text_cursor_kinds type
;
25454 if (EQ (arg
, Qbox
))
25455 return FILLED_BOX_CURSOR
;
25457 if (EQ (arg
, Qhollow
))
25458 return HOLLOW_BOX_CURSOR
;
25460 if (EQ (arg
, Qbar
))
25467 && EQ (XCAR (arg
), Qbar
)
25468 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25470 *width
= XINT (XCDR (arg
));
25474 if (EQ (arg
, Qhbar
))
25477 return HBAR_CURSOR
;
25481 && EQ (XCAR (arg
), Qhbar
)
25482 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25484 *width
= XINT (XCDR (arg
));
25485 return HBAR_CURSOR
;
25488 /* Treat anything unknown as "hollow box cursor".
25489 It was bad to signal an error; people have trouble fixing
25490 .Xdefaults with Emacs, when it has something bad in it. */
25491 type
= HOLLOW_BOX_CURSOR
;
25496 /* Set the default cursor types for specified frame. */
25498 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25503 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25504 FRAME_CURSOR_WIDTH (f
) = width
;
25506 /* By default, set up the blink-off state depending on the on-state. */
25508 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25511 FRAME_BLINK_OFF_CURSOR (f
)
25512 = get_specified_cursor_type (XCDR (tem
), &width
);
25513 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25516 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25520 #ifdef HAVE_WINDOW_SYSTEM
25522 /* Return the cursor we want to be displayed in window W. Return
25523 width of bar/hbar cursor through WIDTH arg. Return with
25524 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25525 (i.e. if the `system caret' should track this cursor).
25527 In a mini-buffer window, we want the cursor only to appear if we
25528 are reading input from this window. For the selected window, we
25529 want the cursor type given by the frame parameter or buffer local
25530 setting of cursor-type. If explicitly marked off, draw no cursor.
25531 In all other cases, we want a hollow box cursor. */
25533 static enum text_cursor_kinds
25534 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25535 int *active_cursor
)
25537 struct frame
*f
= XFRAME (w
->frame
);
25538 struct buffer
*b
= XBUFFER (w
->buffer
);
25539 int cursor_type
= DEFAULT_CURSOR
;
25540 Lisp_Object alt_cursor
;
25541 int non_selected
= 0;
25543 *active_cursor
= 1;
25546 if (cursor_in_echo_area
25547 && FRAME_HAS_MINIBUF_P (f
)
25548 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25550 if (w
== XWINDOW (echo_area_window
))
25552 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25554 *width
= FRAME_CURSOR_WIDTH (f
);
25555 return FRAME_DESIRED_CURSOR (f
);
25558 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25561 *active_cursor
= 0;
25565 /* Detect a nonselected window or nonselected frame. */
25566 else if (w
!= XWINDOW (f
->selected_window
)
25567 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25569 *active_cursor
= 0;
25571 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25577 /* Never display a cursor in a window in which cursor-type is nil. */
25578 if (NILP (BVAR (b
, cursor_type
)))
25581 /* Get the normal cursor type for this window. */
25582 if (EQ (BVAR (b
, cursor_type
), Qt
))
25584 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25585 *width
= FRAME_CURSOR_WIDTH (f
);
25588 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25590 /* Use cursor-in-non-selected-windows instead
25591 for non-selected window or frame. */
25594 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25595 if (!EQ (Qt
, alt_cursor
))
25596 return get_specified_cursor_type (alt_cursor
, width
);
25597 /* t means modify the normal cursor type. */
25598 if (cursor_type
== FILLED_BOX_CURSOR
)
25599 cursor_type
= HOLLOW_BOX_CURSOR
;
25600 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25602 return cursor_type
;
25605 /* Use normal cursor if not blinked off. */
25606 if (!w
->cursor_off_p
)
25608 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25610 if (cursor_type
== FILLED_BOX_CURSOR
)
25612 /* Using a block cursor on large images can be very annoying.
25613 So use a hollow cursor for "large" images.
25614 If image is not transparent (no mask), also use hollow cursor. */
25615 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25616 if (img
!= NULL
&& IMAGEP (img
->spec
))
25618 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25619 where N = size of default frame font size.
25620 This should cover most of the "tiny" icons people may use. */
25622 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25623 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25624 cursor_type
= HOLLOW_BOX_CURSOR
;
25627 else if (cursor_type
!= NO_CURSOR
)
25629 /* Display current only supports BOX and HOLLOW cursors for images.
25630 So for now, unconditionally use a HOLLOW cursor when cursor is
25631 not a solid box cursor. */
25632 cursor_type
= HOLLOW_BOX_CURSOR
;
25635 return cursor_type
;
25638 /* Cursor is blinked off, so determine how to "toggle" it. */
25640 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25641 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25642 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25644 /* Then see if frame has specified a specific blink off cursor type. */
25645 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25647 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25648 return FRAME_BLINK_OFF_CURSOR (f
);
25652 /* Some people liked having a permanently visible blinking cursor,
25653 while others had very strong opinions against it. So it was
25654 decided to remove it. KFS 2003-09-03 */
25656 /* Finally perform built-in cursor blinking:
25657 filled box <-> hollow box
25658 wide [h]bar <-> narrow [h]bar
25659 narrow [h]bar <-> no cursor
25660 other type <-> no cursor */
25662 if (cursor_type
== FILLED_BOX_CURSOR
)
25663 return HOLLOW_BOX_CURSOR
;
25665 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25668 return cursor_type
;
25676 /* Notice when the text cursor of window W has been completely
25677 overwritten by a drawing operation that outputs glyphs in AREA
25678 starting at X0 and ending at X1 in the line starting at Y0 and
25679 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25680 the rest of the line after X0 has been written. Y coordinates
25681 are window-relative. */
25684 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25685 int x0
, int x1
, int y0
, int y1
)
25687 int cx0
, cx1
, cy0
, cy1
;
25688 struct glyph_row
*row
;
25690 if (!w
->phys_cursor_on_p
)
25692 if (area
!= TEXT_AREA
)
25695 if (w
->phys_cursor
.vpos
< 0
25696 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25697 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25698 !(row
->enabled_p
&& row
->displays_text_p
)))
25701 if (row
->cursor_in_fringe_p
)
25703 row
->cursor_in_fringe_p
= 0;
25704 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25705 w
->phys_cursor_on_p
= 0;
25709 cx0
= w
->phys_cursor
.x
;
25710 cx1
= cx0
+ w
->phys_cursor_width
;
25711 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25714 /* The cursor image will be completely removed from the
25715 screen if the output area intersects the cursor area in
25716 y-direction. When we draw in [y0 y1[, and some part of
25717 the cursor is at y < y0, that part must have been drawn
25718 before. When scrolling, the cursor is erased before
25719 actually scrolling, so we don't come here. When not
25720 scrolling, the rows above the old cursor row must have
25721 changed, and in this case these rows must have written
25722 over the cursor image.
25724 Likewise if part of the cursor is below y1, with the
25725 exception of the cursor being in the first blank row at
25726 the buffer and window end because update_text_area
25727 doesn't draw that row. (Except when it does, but
25728 that's handled in update_text_area.) */
25730 cy0
= w
->phys_cursor
.y
;
25731 cy1
= cy0
+ w
->phys_cursor_height
;
25732 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25735 w
->phys_cursor_on_p
= 0;
25738 #endif /* HAVE_WINDOW_SYSTEM */
25741 /************************************************************************
25743 ************************************************************************/
25745 #ifdef HAVE_WINDOW_SYSTEM
25748 Fix the display of area AREA of overlapping row ROW in window W
25749 with respect to the overlapping part OVERLAPS. */
25752 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25753 enum glyph_row_area area
, int overlaps
)
25760 for (i
= 0; i
< row
->used
[area
];)
25762 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25764 int start
= i
, start_x
= x
;
25768 x
+= row
->glyphs
[area
][i
].pixel_width
;
25771 while (i
< row
->used
[area
]
25772 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25774 draw_glyphs (w
, start_x
, row
, area
,
25776 DRAW_NORMAL_TEXT
, overlaps
);
25780 x
+= row
->glyphs
[area
][i
].pixel_width
;
25790 Draw the cursor glyph of window W in glyph row ROW. See the
25791 comment of draw_glyphs for the meaning of HL. */
25794 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25795 enum draw_glyphs_face hl
)
25797 /* If cursor hpos is out of bounds, don't draw garbage. This can
25798 happen in mini-buffer windows when switching between echo area
25799 glyphs and mini-buffer. */
25800 if ((row
->reversed_p
25801 ? (w
->phys_cursor
.hpos
>= 0)
25802 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25804 int on_p
= w
->phys_cursor_on_p
;
25806 int hpos
= w
->phys_cursor
.hpos
;
25808 /* When the window is hscrolled, cursor hpos can legitimately be
25809 out of bounds, but we draw the cursor at the corresponding
25810 window margin in that case. */
25811 if (!row
->reversed_p
&& hpos
< 0)
25813 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25814 hpos
= row
->used
[TEXT_AREA
] - 1;
25816 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25818 w
->phys_cursor_on_p
= on_p
;
25820 if (hl
== DRAW_CURSOR
)
25821 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25822 /* When we erase the cursor, and ROW is overlapped by other
25823 rows, make sure that these overlapping parts of other rows
25825 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25827 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25829 if (row
> w
->current_matrix
->rows
25830 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25831 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25832 OVERLAPS_ERASED_CURSOR
);
25834 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25835 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25836 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25837 OVERLAPS_ERASED_CURSOR
);
25844 Erase the image of a cursor of window W from the screen. */
25847 erase_phys_cursor (struct window
*w
)
25849 struct frame
*f
= XFRAME (w
->frame
);
25850 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25851 int hpos
= w
->phys_cursor
.hpos
;
25852 int vpos
= w
->phys_cursor
.vpos
;
25853 int mouse_face_here_p
= 0;
25854 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25855 struct glyph_row
*cursor_row
;
25856 struct glyph
*cursor_glyph
;
25857 enum draw_glyphs_face hl
;
25859 /* No cursor displayed or row invalidated => nothing to do on the
25861 if (w
->phys_cursor_type
== NO_CURSOR
)
25862 goto mark_cursor_off
;
25864 /* VPOS >= active_glyphs->nrows means that window has been resized.
25865 Don't bother to erase the cursor. */
25866 if (vpos
>= active_glyphs
->nrows
)
25867 goto mark_cursor_off
;
25869 /* If row containing cursor is marked invalid, there is nothing we
25871 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25872 if (!cursor_row
->enabled_p
)
25873 goto mark_cursor_off
;
25875 /* If line spacing is > 0, old cursor may only be partially visible in
25876 window after split-window. So adjust visible height. */
25877 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25878 window_text_bottom_y (w
) - cursor_row
->y
);
25880 /* If row is completely invisible, don't attempt to delete a cursor which
25881 isn't there. This can happen if cursor is at top of a window, and
25882 we switch to a buffer with a header line in that window. */
25883 if (cursor_row
->visible_height
<= 0)
25884 goto mark_cursor_off
;
25886 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25887 if (cursor_row
->cursor_in_fringe_p
)
25889 cursor_row
->cursor_in_fringe_p
= 0;
25890 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25891 goto mark_cursor_off
;
25894 /* This can happen when the new row is shorter than the old one.
25895 In this case, either draw_glyphs or clear_end_of_line
25896 should have cleared the cursor. Note that we wouldn't be
25897 able to erase the cursor in this case because we don't have a
25898 cursor glyph at hand. */
25899 if ((cursor_row
->reversed_p
25900 ? (w
->phys_cursor
.hpos
< 0)
25901 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25902 goto mark_cursor_off
;
25904 /* When the window is hscrolled, cursor hpos can legitimately be out
25905 of bounds, but we draw the cursor at the corresponding window
25906 margin in that case. */
25907 if (!cursor_row
->reversed_p
&& hpos
< 0)
25909 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25910 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25912 /* If the cursor is in the mouse face area, redisplay that when
25913 we clear the cursor. */
25914 if (! NILP (hlinfo
->mouse_face_window
)
25915 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25916 /* Don't redraw the cursor's spot in mouse face if it is at the
25917 end of a line (on a newline). The cursor appears there, but
25918 mouse highlighting does not. */
25919 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25920 mouse_face_here_p
= 1;
25922 /* Maybe clear the display under the cursor. */
25923 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25926 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25929 cursor_glyph
= get_phys_cursor_glyph (w
);
25930 if (cursor_glyph
== NULL
)
25931 goto mark_cursor_off
;
25933 width
= cursor_glyph
->pixel_width
;
25934 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25935 x
= w
->phys_cursor
.x
;
25937 width
-= left_x
- x
;
25938 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25939 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25940 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25943 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25946 /* Erase the cursor by redrawing the character underneath it. */
25947 if (mouse_face_here_p
)
25948 hl
= DRAW_MOUSE_FACE
;
25950 hl
= DRAW_NORMAL_TEXT
;
25951 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25954 w
->phys_cursor_on_p
= 0;
25955 w
->phys_cursor_type
= NO_CURSOR
;
25960 Display or clear cursor of window W. If ON is zero, clear the
25961 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25962 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25965 display_and_set_cursor (struct window
*w
, int on
,
25966 int hpos
, int vpos
, int x
, int y
)
25968 struct frame
*f
= XFRAME (w
->frame
);
25969 int new_cursor_type
;
25970 int new_cursor_width
;
25972 struct glyph_row
*glyph_row
;
25973 struct glyph
*glyph
;
25975 /* This is pointless on invisible frames, and dangerous on garbaged
25976 windows and frames; in the latter case, the frame or window may
25977 be in the midst of changing its size, and x and y may be off the
25979 if (! FRAME_VISIBLE_P (f
)
25980 || FRAME_GARBAGED_P (f
)
25981 || vpos
>= w
->current_matrix
->nrows
25982 || hpos
>= w
->current_matrix
->matrix_w
)
25985 /* If cursor is off and we want it off, return quickly. */
25986 if (!on
&& !w
->phys_cursor_on_p
)
25989 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25990 /* If cursor row is not enabled, we don't really know where to
25991 display the cursor. */
25992 if (!glyph_row
->enabled_p
)
25994 w
->phys_cursor_on_p
= 0;
25999 if (!glyph_row
->exact_window_width_line_p
26000 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26001 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26003 eassert (interrupt_input_blocked
);
26005 /* Set new_cursor_type to the cursor we want to be displayed. */
26006 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26007 &new_cursor_width
, &active_cursor
);
26009 /* If cursor is currently being shown and we don't want it to be or
26010 it is in the wrong place, or the cursor type is not what we want,
26012 if (w
->phys_cursor_on_p
26014 || w
->phys_cursor
.x
!= x
26015 || w
->phys_cursor
.y
!= y
26016 || new_cursor_type
!= w
->phys_cursor_type
26017 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26018 && new_cursor_width
!= w
->phys_cursor_width
)))
26019 erase_phys_cursor (w
);
26021 /* Don't check phys_cursor_on_p here because that flag is only set
26022 to zero in some cases where we know that the cursor has been
26023 completely erased, to avoid the extra work of erasing the cursor
26024 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26025 still not be visible, or it has only been partly erased. */
26028 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26029 w
->phys_cursor_height
= glyph_row
->height
;
26031 /* Set phys_cursor_.* before x_draw_.* is called because some
26032 of them may need the information. */
26033 w
->phys_cursor
.x
= x
;
26034 w
->phys_cursor
.y
= glyph_row
->y
;
26035 w
->phys_cursor
.hpos
= hpos
;
26036 w
->phys_cursor
.vpos
= vpos
;
26039 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26040 new_cursor_type
, new_cursor_width
,
26041 on
, active_cursor
);
26045 /* Switch the display of W's cursor on or off, according to the value
26049 update_window_cursor (struct window
*w
, int on
)
26051 /* Don't update cursor in windows whose frame is in the process
26052 of being deleted. */
26053 if (w
->current_matrix
)
26055 int hpos
= w
->phys_cursor
.hpos
;
26056 int vpos
= w
->phys_cursor
.vpos
;
26057 struct glyph_row
*row
;
26059 if (vpos
>= w
->current_matrix
->nrows
26060 || hpos
>= w
->current_matrix
->matrix_w
)
26063 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26065 /* When the window is hscrolled, cursor hpos can legitimately be
26066 out of bounds, but we draw the cursor at the corresponding
26067 window margin in that case. */
26068 if (!row
->reversed_p
&& hpos
< 0)
26070 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26071 hpos
= row
->used
[TEXT_AREA
] - 1;
26074 display_and_set_cursor (w
, on
, hpos
, vpos
,
26075 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26081 /* Call update_window_cursor with parameter ON_P on all leaf windows
26082 in the window tree rooted at W. */
26085 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26089 if (!NILP (w
->hchild
))
26090 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26091 else if (!NILP (w
->vchild
))
26092 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26094 update_window_cursor (w
, on_p
);
26096 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26102 Display the cursor on window W, or clear it, according to ON_P.
26103 Don't change the cursor's position. */
26106 x_update_cursor (struct frame
*f
, int on_p
)
26108 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26113 Clear the cursor of window W to background color, and mark the
26114 cursor as not shown. This is used when the text where the cursor
26115 is about to be rewritten. */
26118 x_clear_cursor (struct window
*w
)
26120 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26121 update_window_cursor (w
, 0);
26124 #endif /* HAVE_WINDOW_SYSTEM */
26126 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26129 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26130 int start_hpos
, int end_hpos
,
26131 enum draw_glyphs_face draw
)
26133 #ifdef HAVE_WINDOW_SYSTEM
26134 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26136 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26140 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26141 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26145 /* Display the active region described by mouse_face_* according to DRAW. */
26148 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26150 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26151 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26153 if (/* If window is in the process of being destroyed, don't bother
26155 w
->current_matrix
!= NULL
26156 /* Don't update mouse highlight if hidden */
26157 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26158 /* Recognize when we are called to operate on rows that don't exist
26159 anymore. This can happen when a window is split. */
26160 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26162 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26163 struct glyph_row
*row
, *first
, *last
;
26165 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26166 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26168 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26170 int start_hpos
, end_hpos
, start_x
;
26172 /* For all but the first row, the highlight starts at column 0. */
26175 /* R2L rows have BEG and END in reversed order, but the
26176 screen drawing geometry is always left to right. So
26177 we need to mirror the beginning and end of the
26178 highlighted area in R2L rows. */
26179 if (!row
->reversed_p
)
26181 start_hpos
= hlinfo
->mouse_face_beg_col
;
26182 start_x
= hlinfo
->mouse_face_beg_x
;
26184 else if (row
== last
)
26186 start_hpos
= hlinfo
->mouse_face_end_col
;
26187 start_x
= hlinfo
->mouse_face_end_x
;
26195 else if (row
->reversed_p
&& row
== last
)
26197 start_hpos
= hlinfo
->mouse_face_end_col
;
26198 start_x
= hlinfo
->mouse_face_end_x
;
26208 if (!row
->reversed_p
)
26209 end_hpos
= hlinfo
->mouse_face_end_col
;
26210 else if (row
== first
)
26211 end_hpos
= hlinfo
->mouse_face_beg_col
;
26214 end_hpos
= row
->used
[TEXT_AREA
];
26215 if (draw
== DRAW_NORMAL_TEXT
)
26216 row
->fill_line_p
= 1; /* Clear to end of line */
26219 else if (row
->reversed_p
&& row
== first
)
26220 end_hpos
= hlinfo
->mouse_face_beg_col
;
26223 end_hpos
= row
->used
[TEXT_AREA
];
26224 if (draw
== DRAW_NORMAL_TEXT
)
26225 row
->fill_line_p
= 1; /* Clear to end of line */
26228 if (end_hpos
> start_hpos
)
26230 draw_row_with_mouse_face (w
, start_x
, row
,
26231 start_hpos
, end_hpos
, draw
);
26234 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26238 #ifdef HAVE_WINDOW_SYSTEM
26239 /* When we've written over the cursor, arrange for it to
26240 be displayed again. */
26241 if (FRAME_WINDOW_P (f
)
26242 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26244 int hpos
= w
->phys_cursor
.hpos
;
26246 /* When the window is hscrolled, cursor hpos can legitimately be
26247 out of bounds, but we draw the cursor at the corresponding
26248 window margin in that case. */
26249 if (!row
->reversed_p
&& hpos
< 0)
26251 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26252 hpos
= row
->used
[TEXT_AREA
] - 1;
26255 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26256 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26259 #endif /* HAVE_WINDOW_SYSTEM */
26262 #ifdef HAVE_WINDOW_SYSTEM
26263 /* Change the mouse cursor. */
26264 if (FRAME_WINDOW_P (f
))
26266 if (draw
== DRAW_NORMAL_TEXT
26267 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26268 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26269 else if (draw
== DRAW_MOUSE_FACE
)
26270 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26272 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26274 #endif /* HAVE_WINDOW_SYSTEM */
26278 Clear out the mouse-highlighted active region.
26279 Redraw it un-highlighted first. Value is non-zero if mouse
26280 face was actually drawn unhighlighted. */
26283 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26287 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26289 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26293 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26294 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26295 hlinfo
->mouse_face_window
= Qnil
;
26296 hlinfo
->mouse_face_overlay
= Qnil
;
26300 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26301 within the mouse face on that window. */
26303 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26305 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26307 /* Quickly resolve the easy cases. */
26308 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26309 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26311 if (vpos
< hlinfo
->mouse_face_beg_row
26312 || vpos
> hlinfo
->mouse_face_end_row
)
26314 if (vpos
> hlinfo
->mouse_face_beg_row
26315 && vpos
< hlinfo
->mouse_face_end_row
)
26318 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26320 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26322 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26325 else if ((vpos
== hlinfo
->mouse_face_beg_row
26326 && hpos
>= hlinfo
->mouse_face_beg_col
)
26327 || (vpos
== hlinfo
->mouse_face_end_row
26328 && hpos
< hlinfo
->mouse_face_end_col
))
26333 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26335 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26338 else if ((vpos
== hlinfo
->mouse_face_beg_row
26339 && hpos
<= hlinfo
->mouse_face_beg_col
)
26340 || (vpos
== hlinfo
->mouse_face_end_row
26341 && hpos
> hlinfo
->mouse_face_end_col
))
26349 Non-zero if physical cursor of window W is within mouse face. */
26352 cursor_in_mouse_face_p (struct window
*w
)
26354 int hpos
= w
->phys_cursor
.hpos
;
26355 int vpos
= w
->phys_cursor
.vpos
;
26356 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26358 /* When the window is hscrolled, cursor hpos can legitimately be out
26359 of bounds, but we draw the cursor at the corresponding window
26360 margin in that case. */
26361 if (!row
->reversed_p
&& hpos
< 0)
26363 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26364 hpos
= row
->used
[TEXT_AREA
] - 1;
26366 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26371 /* Find the glyph rows START_ROW and END_ROW of window W that display
26372 characters between buffer positions START_CHARPOS and END_CHARPOS
26373 (excluding END_CHARPOS). DISP_STRING is a display string that
26374 covers these buffer positions. This is similar to
26375 row_containing_pos, but is more accurate when bidi reordering makes
26376 buffer positions change non-linearly with glyph rows. */
26378 rows_from_pos_range (struct window
*w
,
26379 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26380 Lisp_Object disp_string
,
26381 struct glyph_row
**start
, struct glyph_row
**end
)
26383 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26384 int last_y
= window_text_bottom_y (w
);
26385 struct glyph_row
*row
;
26390 while (!first
->enabled_p
26391 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26394 /* Find the START row. */
26396 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26399 /* A row can potentially be the START row if the range of the
26400 characters it displays intersects the range
26401 [START_CHARPOS..END_CHARPOS). */
26402 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26403 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26404 /* See the commentary in row_containing_pos, for the
26405 explanation of the complicated way to check whether
26406 some position is beyond the end of the characters
26407 displayed by a row. */
26408 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26409 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26410 && !row
->ends_at_zv_p
26411 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26412 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26413 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26414 && !row
->ends_at_zv_p
26415 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26417 /* Found a candidate row. Now make sure at least one of the
26418 glyphs it displays has a charpos from the range
26419 [START_CHARPOS..END_CHARPOS).
26421 This is not obvious because bidi reordering could make
26422 buffer positions of a row be 1,2,3,102,101,100, and if we
26423 want to highlight characters in [50..60), we don't want
26424 this row, even though [50..60) does intersect [1..103),
26425 the range of character positions given by the row's start
26426 and end positions. */
26427 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26428 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26432 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26433 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26434 /* A glyph that comes from DISP_STRING is by
26435 definition to be highlighted. */
26436 || EQ (g
->object
, disp_string
))
26445 /* Find the END row. */
26447 /* If the last row is partially visible, start looking for END
26448 from that row, instead of starting from FIRST. */
26449 && !(row
->enabled_p
26450 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26452 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26454 struct glyph_row
*next
= row
+ 1;
26455 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26457 if (!next
->enabled_p
26458 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26459 /* The first row >= START whose range of displayed characters
26460 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26461 is the row END + 1. */
26462 || (start_charpos
< next_start
26463 && end_charpos
< next_start
)
26464 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26465 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26466 && !next
->ends_at_zv_p
26467 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26468 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26469 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26470 && !next
->ends_at_zv_p
26471 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26478 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26479 but none of the characters it displays are in the range, it is
26481 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26482 struct glyph
*s
= g
;
26483 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26487 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26488 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26489 /* If the buffer position of the first glyph in
26490 the row is equal to END_CHARPOS, it means
26491 the last character to be highlighted is the
26492 newline of ROW, and we must consider NEXT as
26494 || (((!next
->reversed_p
&& g
== s
)
26495 || (next
->reversed_p
&& g
== e
- 1))
26496 && (g
->charpos
== end_charpos
26497 /* Special case for when NEXT is an
26498 empty line at ZV. */
26499 || (g
->charpos
== -1
26500 && !row
->ends_at_zv_p
26501 && next_start
== end_charpos
)))))
26502 /* A glyph that comes from DISP_STRING is by
26503 definition to be highlighted. */
26504 || EQ (g
->object
, disp_string
))
26513 /* The first row that ends at ZV must be the last to be
26515 else if (next
->ends_at_zv_p
)
26524 /* This function sets the mouse_face_* elements of HLINFO, assuming
26525 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26526 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26527 for the overlay or run of text properties specifying the mouse
26528 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26529 before-string and after-string that must also be highlighted.
26530 DISP_STRING, if non-nil, is a display string that may cover some
26531 or all of the highlighted text. */
26534 mouse_face_from_buffer_pos (Lisp_Object window
,
26535 Mouse_HLInfo
*hlinfo
,
26536 ptrdiff_t mouse_charpos
,
26537 ptrdiff_t start_charpos
,
26538 ptrdiff_t end_charpos
,
26539 Lisp_Object before_string
,
26540 Lisp_Object after_string
,
26541 Lisp_Object disp_string
)
26543 struct window
*w
= XWINDOW (window
);
26544 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26545 struct glyph_row
*r1
, *r2
;
26546 struct glyph
*glyph
, *end
;
26547 ptrdiff_t ignore
, pos
;
26550 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26551 eassert (NILP (before_string
) || STRINGP (before_string
));
26552 eassert (NILP (after_string
) || STRINGP (after_string
));
26554 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26555 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26557 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26558 /* If the before-string or display-string contains newlines,
26559 rows_from_pos_range skips to its last row. Move back. */
26560 if (!NILP (before_string
) || !NILP (disp_string
))
26562 struct glyph_row
*prev
;
26563 while ((prev
= r1
- 1, prev
>= first
)
26564 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26565 && prev
->used
[TEXT_AREA
] > 0)
26567 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26568 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26569 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26571 || !(EQ (glyph
->object
, before_string
)
26572 || EQ (glyph
->object
, disp_string
)))
26579 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26580 hlinfo
->mouse_face_past_end
= 1;
26582 else if (!NILP (after_string
))
26584 /* If the after-string has newlines, advance to its last row. */
26585 struct glyph_row
*next
;
26586 struct glyph_row
*last
26587 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26589 for (next
= r2
+ 1;
26591 && next
->used
[TEXT_AREA
] > 0
26592 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26596 /* The rest of the display engine assumes that mouse_face_beg_row is
26597 either above mouse_face_end_row or identical to it. But with
26598 bidi-reordered continued lines, the row for START_CHARPOS could
26599 be below the row for END_CHARPOS. If so, swap the rows and store
26600 them in correct order. */
26603 struct glyph_row
*tem
= r2
;
26609 hlinfo
->mouse_face_beg_y
= r1
->y
;
26610 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26611 hlinfo
->mouse_face_end_y
= r2
->y
;
26612 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26614 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26615 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26616 could be anywhere in the row and in any order. The strategy
26617 below is to find the leftmost and the rightmost glyph that
26618 belongs to either of these 3 strings, or whose position is
26619 between START_CHARPOS and END_CHARPOS, and highlight all the
26620 glyphs between those two. This may cover more than just the text
26621 between START_CHARPOS and END_CHARPOS if the range of characters
26622 strides the bidi level boundary, e.g. if the beginning is in R2L
26623 text while the end is in L2R text or vice versa. */
26624 if (!r1
->reversed_p
)
26626 /* This row is in a left to right paragraph. Scan it left to
26628 glyph
= r1
->glyphs
[TEXT_AREA
];
26629 end
= glyph
+ r1
->used
[TEXT_AREA
];
26632 /* Skip truncation glyphs at the start of the glyph row. */
26633 if (r1
->displays_text_p
)
26635 && INTEGERP (glyph
->object
)
26636 && glyph
->charpos
< 0;
26638 x
+= glyph
->pixel_width
;
26640 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26641 or DISP_STRING, and the first glyph from buffer whose
26642 position is between START_CHARPOS and END_CHARPOS. */
26644 && !INTEGERP (glyph
->object
)
26645 && !EQ (glyph
->object
, disp_string
)
26646 && !(BUFFERP (glyph
->object
)
26647 && (glyph
->charpos
>= start_charpos
26648 && glyph
->charpos
< end_charpos
));
26651 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26652 are present at buffer positions between START_CHARPOS and
26653 END_CHARPOS, or if they come from an overlay. */
26654 if (EQ (glyph
->object
, before_string
))
26656 pos
= string_buffer_position (before_string
,
26658 /* If pos == 0, it means before_string came from an
26659 overlay, not from a buffer position. */
26660 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26663 else if (EQ (glyph
->object
, after_string
))
26665 pos
= string_buffer_position (after_string
, end_charpos
);
26666 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26669 x
+= glyph
->pixel_width
;
26671 hlinfo
->mouse_face_beg_x
= x
;
26672 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26676 /* This row is in a right to left paragraph. Scan it right to
26680 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26681 glyph
= end
+ r1
->used
[TEXT_AREA
];
26683 /* Skip truncation glyphs at the start of the glyph row. */
26684 if (r1
->displays_text_p
)
26686 && INTEGERP (glyph
->object
)
26687 && glyph
->charpos
< 0;
26691 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26692 or DISP_STRING, and the first glyph from buffer whose
26693 position is between START_CHARPOS and END_CHARPOS. */
26695 && !INTEGERP (glyph
->object
)
26696 && !EQ (glyph
->object
, disp_string
)
26697 && !(BUFFERP (glyph
->object
)
26698 && (glyph
->charpos
>= start_charpos
26699 && glyph
->charpos
< end_charpos
));
26702 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26703 are present at buffer positions between START_CHARPOS and
26704 END_CHARPOS, or if they come from an overlay. */
26705 if (EQ (glyph
->object
, before_string
))
26707 pos
= string_buffer_position (before_string
, start_charpos
);
26708 /* If pos == 0, it means before_string came from an
26709 overlay, not from a buffer position. */
26710 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26713 else if (EQ (glyph
->object
, after_string
))
26715 pos
= string_buffer_position (after_string
, end_charpos
);
26716 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26721 glyph
++; /* first glyph to the right of the highlighted area */
26722 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26723 x
+= g
->pixel_width
;
26724 hlinfo
->mouse_face_beg_x
= x
;
26725 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26728 /* If the highlight ends in a different row, compute GLYPH and END
26729 for the end row. Otherwise, reuse the values computed above for
26730 the row where the highlight begins. */
26733 if (!r2
->reversed_p
)
26735 glyph
= r2
->glyphs
[TEXT_AREA
];
26736 end
= glyph
+ r2
->used
[TEXT_AREA
];
26741 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26742 glyph
= end
+ r2
->used
[TEXT_AREA
];
26746 if (!r2
->reversed_p
)
26748 /* Skip truncation and continuation glyphs near the end of the
26749 row, and also blanks and stretch glyphs inserted by
26750 extend_face_to_end_of_line. */
26752 && INTEGERP ((end
- 1)->object
))
26754 /* Scan the rest of the glyph row from the end, looking for the
26755 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26756 DISP_STRING, or whose position is between START_CHARPOS
26760 && !INTEGERP (end
->object
)
26761 && !EQ (end
->object
, disp_string
)
26762 && !(BUFFERP (end
->object
)
26763 && (end
->charpos
>= start_charpos
26764 && end
->charpos
< end_charpos
));
26767 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26768 are present at buffer positions between START_CHARPOS and
26769 END_CHARPOS, or if they come from an overlay. */
26770 if (EQ (end
->object
, before_string
))
26772 pos
= string_buffer_position (before_string
, start_charpos
);
26773 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26776 else if (EQ (end
->object
, after_string
))
26778 pos
= string_buffer_position (after_string
, end_charpos
);
26779 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26783 /* Find the X coordinate of the last glyph to be highlighted. */
26784 for (; glyph
<= end
; ++glyph
)
26785 x
+= glyph
->pixel_width
;
26787 hlinfo
->mouse_face_end_x
= x
;
26788 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26792 /* Skip truncation and continuation glyphs near the end of the
26793 row, and also blanks and stretch glyphs inserted by
26794 extend_face_to_end_of_line. */
26798 && INTEGERP (end
->object
))
26800 x
+= end
->pixel_width
;
26803 /* Scan the rest of the glyph row from the end, looking for the
26804 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26805 DISP_STRING, or whose position is between START_CHARPOS
26809 && !INTEGERP (end
->object
)
26810 && !EQ (end
->object
, disp_string
)
26811 && !(BUFFERP (end
->object
)
26812 && (end
->charpos
>= start_charpos
26813 && end
->charpos
< end_charpos
));
26816 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26817 are present at buffer positions between START_CHARPOS and
26818 END_CHARPOS, or if they come from an overlay. */
26819 if (EQ (end
->object
, before_string
))
26821 pos
= string_buffer_position (before_string
, start_charpos
);
26822 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26825 else if (EQ (end
->object
, after_string
))
26827 pos
= string_buffer_position (after_string
, end_charpos
);
26828 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26831 x
+= end
->pixel_width
;
26833 /* If we exited the above loop because we arrived at the last
26834 glyph of the row, and its buffer position is still not in
26835 range, it means the last character in range is the preceding
26836 newline. Bump the end column and x values to get past the
26839 && BUFFERP (end
->object
)
26840 && (end
->charpos
< start_charpos
26841 || end
->charpos
>= end_charpos
))
26843 x
+= end
->pixel_width
;
26846 hlinfo
->mouse_face_end_x
= x
;
26847 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26850 hlinfo
->mouse_face_window
= window
;
26851 hlinfo
->mouse_face_face_id
26852 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26854 !hlinfo
->mouse_face_hidden
, -1);
26855 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26858 /* The following function is not used anymore (replaced with
26859 mouse_face_from_string_pos), but I leave it here for the time
26860 being, in case someone would. */
26862 #if 0 /* not used */
26864 /* Find the position of the glyph for position POS in OBJECT in
26865 window W's current matrix, and return in *X, *Y the pixel
26866 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26868 RIGHT_P non-zero means return the position of the right edge of the
26869 glyph, RIGHT_P zero means return the left edge position.
26871 If no glyph for POS exists in the matrix, return the position of
26872 the glyph with the next smaller position that is in the matrix, if
26873 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26874 exists in the matrix, return the position of the glyph with the
26875 next larger position in OBJECT.
26877 Value is non-zero if a glyph was found. */
26880 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26881 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26883 int yb
= window_text_bottom_y (w
);
26884 struct glyph_row
*r
;
26885 struct glyph
*best_glyph
= NULL
;
26886 struct glyph_row
*best_row
= NULL
;
26889 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26890 r
->enabled_p
&& r
->y
< yb
;
26893 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26894 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26897 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26898 if (EQ (g
->object
, object
))
26900 if (g
->charpos
== pos
)
26907 else if (best_glyph
== NULL
26908 || ((eabs (g
->charpos
- pos
)
26909 < eabs (best_glyph
->charpos
- pos
))
26912 : g
->charpos
> pos
)))
26926 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26930 *x
+= best_glyph
->pixel_width
;
26935 *vpos
= best_row
- w
->current_matrix
->rows
;
26938 return best_glyph
!= NULL
;
26940 #endif /* not used */
26942 /* Find the positions of the first and the last glyphs in window W's
26943 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26944 (assumed to be a string), and return in HLINFO's mouse_face_*
26945 members the pixel and column/row coordinates of those glyphs. */
26948 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26949 Lisp_Object object
,
26950 ptrdiff_t startpos
, ptrdiff_t endpos
)
26952 int yb
= window_text_bottom_y (w
);
26953 struct glyph_row
*r
;
26954 struct glyph
*g
, *e
;
26958 /* Find the glyph row with at least one position in the range
26959 [STARTPOS..ENDPOS], and the first glyph in that row whose
26960 position belongs to that range. */
26961 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26962 r
->enabled_p
&& r
->y
< yb
;
26965 if (!r
->reversed_p
)
26967 g
= r
->glyphs
[TEXT_AREA
];
26968 e
= g
+ r
->used
[TEXT_AREA
];
26969 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26970 if (EQ (g
->object
, object
)
26971 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26973 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26974 hlinfo
->mouse_face_beg_y
= r
->y
;
26975 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26976 hlinfo
->mouse_face_beg_x
= gx
;
26985 e
= r
->glyphs
[TEXT_AREA
];
26986 g
= e
+ r
->used
[TEXT_AREA
];
26987 for ( ; g
> e
; --g
)
26988 if (EQ ((g
-1)->object
, object
)
26989 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26991 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26992 hlinfo
->mouse_face_beg_y
= r
->y
;
26993 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26994 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26995 gx
+= g1
->pixel_width
;
26996 hlinfo
->mouse_face_beg_x
= gx
;
27008 /* Starting with the next row, look for the first row which does NOT
27009 include any glyphs whose positions are in the range. */
27010 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27012 g
= r
->glyphs
[TEXT_AREA
];
27013 e
= g
+ r
->used
[TEXT_AREA
];
27015 for ( ; g
< e
; ++g
)
27016 if (EQ (g
->object
, object
)
27017 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27026 /* The highlighted region ends on the previous row. */
27029 /* Set the end row and its vertical pixel coordinate. */
27030 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27031 hlinfo
->mouse_face_end_y
= r
->y
;
27033 /* Compute and set the end column and the end column's horizontal
27034 pixel coordinate. */
27035 if (!r
->reversed_p
)
27037 g
= r
->glyphs
[TEXT_AREA
];
27038 e
= g
+ r
->used
[TEXT_AREA
];
27039 for ( ; e
> g
; --e
)
27040 if (EQ ((e
-1)->object
, object
)
27041 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27043 hlinfo
->mouse_face_end_col
= e
- g
;
27045 for (gx
= r
->x
; g
< e
; ++g
)
27046 gx
+= g
->pixel_width
;
27047 hlinfo
->mouse_face_end_x
= gx
;
27051 e
= r
->glyphs
[TEXT_AREA
];
27052 g
= e
+ r
->used
[TEXT_AREA
];
27053 for (gx
= r
->x
; e
< g
; ++e
)
27055 if (EQ (e
->object
, object
)
27056 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27058 gx
+= e
->pixel_width
;
27060 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27061 hlinfo
->mouse_face_end_x
= gx
;
27065 #ifdef HAVE_WINDOW_SYSTEM
27067 /* See if position X, Y is within a hot-spot of an image. */
27070 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27072 if (!CONSP (hot_spot
))
27075 if (EQ (XCAR (hot_spot
), Qrect
))
27077 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27078 Lisp_Object rect
= XCDR (hot_spot
);
27082 if (!CONSP (XCAR (rect
)))
27084 if (!CONSP (XCDR (rect
)))
27086 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27088 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27090 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27092 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27096 else if (EQ (XCAR (hot_spot
), Qcircle
))
27098 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27099 Lisp_Object circ
= XCDR (hot_spot
);
27100 Lisp_Object lr
, lx0
, ly0
;
27102 && CONSP (XCAR (circ
))
27103 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27104 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27105 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27107 double r
= XFLOATINT (lr
);
27108 double dx
= XINT (lx0
) - x
;
27109 double dy
= XINT (ly0
) - y
;
27110 return (dx
* dx
+ dy
* dy
<= r
* r
);
27113 else if (EQ (XCAR (hot_spot
), Qpoly
))
27115 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27116 if (VECTORP (XCDR (hot_spot
)))
27118 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27119 Lisp_Object
*poly
= v
->contents
;
27120 ptrdiff_t n
= v
->header
.size
;
27123 Lisp_Object lx
, ly
;
27126 /* Need an even number of coordinates, and at least 3 edges. */
27127 if (n
< 6 || n
& 1)
27130 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27131 If count is odd, we are inside polygon. Pixels on edges
27132 may or may not be included depending on actual geometry of the
27134 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27135 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27137 x0
= XINT (lx
), y0
= XINT (ly
);
27138 for (i
= 0; i
< n
; i
+= 2)
27140 int x1
= x0
, y1
= y0
;
27141 if ((lx
= poly
[i
], !INTEGERP (lx
))
27142 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27144 x0
= XINT (lx
), y0
= XINT (ly
);
27146 /* Does this segment cross the X line? */
27154 if (y
> y0
&& y
> y1
)
27156 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27166 find_hot_spot (Lisp_Object map
, int x
, int y
)
27168 while (CONSP (map
))
27170 if (CONSP (XCAR (map
))
27171 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27179 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27181 doc
: /* Lookup in image map MAP coordinates X and Y.
27182 An image map is an alist where each element has the format (AREA ID PLIST).
27183 An AREA is specified as either a rectangle, a circle, or a polygon:
27184 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27185 pixel coordinates of the upper left and bottom right corners.
27186 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27187 and the radius of the circle; r may be a float or integer.
27188 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27189 vector describes one corner in the polygon.
27190 Returns the alist element for the first matching AREA in MAP. */)
27191 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27199 return find_hot_spot (map
,
27200 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27201 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27205 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27207 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27209 /* Do not change cursor shape while dragging mouse. */
27210 if (!NILP (do_mouse_tracking
))
27213 if (!NILP (pointer
))
27215 if (EQ (pointer
, Qarrow
))
27216 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27217 else if (EQ (pointer
, Qhand
))
27218 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27219 else if (EQ (pointer
, Qtext
))
27220 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27221 else if (EQ (pointer
, intern ("hdrag")))
27222 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27223 #ifdef HAVE_X_WINDOWS
27224 else if (EQ (pointer
, intern ("vdrag")))
27225 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27227 else if (EQ (pointer
, intern ("hourglass")))
27228 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27229 else if (EQ (pointer
, Qmodeline
))
27230 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27232 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27235 if (cursor
!= No_Cursor
)
27236 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27239 #endif /* HAVE_WINDOW_SYSTEM */
27241 /* Take proper action when mouse has moved to the mode or header line
27242 or marginal area AREA of window W, x-position X and y-position Y.
27243 X is relative to the start of the text display area of W, so the
27244 width of bitmap areas and scroll bars must be subtracted to get a
27245 position relative to the start of the mode line. */
27248 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27249 enum window_part area
)
27251 struct window
*w
= XWINDOW (window
);
27252 struct frame
*f
= XFRAME (w
->frame
);
27253 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27254 #ifdef HAVE_WINDOW_SYSTEM
27255 Display_Info
*dpyinfo
;
27257 Cursor cursor
= No_Cursor
;
27258 Lisp_Object pointer
= Qnil
;
27259 int dx
, dy
, width
, height
;
27261 Lisp_Object string
, object
= Qnil
;
27262 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27264 Lisp_Object mouse_face
;
27265 int original_x_pixel
= x
;
27266 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27267 struct glyph_row
*row
IF_LINT (= 0);
27269 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27274 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27275 returns them in row/column units! */
27276 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27277 &object
, &dx
, &dy
, &width
, &height
);
27279 row
= (area
== ON_MODE_LINE
27280 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27281 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27283 /* Find the glyph under the mouse pointer. */
27284 if (row
->mode_line_p
&& row
->enabled_p
)
27286 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27287 end
= glyph
+ row
->used
[TEXT_AREA
];
27289 for (x0
= original_x_pixel
;
27290 glyph
< end
&& x0
>= glyph
->pixel_width
;
27292 x0
-= glyph
->pixel_width
;
27300 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27301 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27302 returns them in row/column units! */
27303 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27304 &object
, &dx
, &dy
, &width
, &height
);
27309 #ifdef HAVE_WINDOW_SYSTEM
27310 if (IMAGEP (object
))
27312 Lisp_Object image_map
, hotspot
;
27313 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27315 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27317 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27321 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27322 If so, we could look for mouse-enter, mouse-leave
27323 properties in PLIST (and do something...). */
27324 hotspot
= XCDR (hotspot
);
27325 if (CONSP (hotspot
)
27326 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27328 pointer
= Fplist_get (plist
, Qpointer
);
27329 if (NILP (pointer
))
27331 help
= Fplist_get (plist
, Qhelp_echo
);
27334 help_echo_string
= help
;
27335 XSETWINDOW (help_echo_window
, w
);
27336 help_echo_object
= w
->buffer
;
27337 help_echo_pos
= charpos
;
27341 if (NILP (pointer
))
27342 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27344 #endif /* HAVE_WINDOW_SYSTEM */
27346 if (STRINGP (string
))
27347 pos
= make_number (charpos
);
27349 /* Set the help text and mouse pointer. If the mouse is on a part
27350 of the mode line without any text (e.g. past the right edge of
27351 the mode line text), use the default help text and pointer. */
27352 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27354 /* Arrange to display the help by setting the global variables
27355 help_echo_string, help_echo_object, and help_echo_pos. */
27358 if (STRINGP (string
))
27359 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27363 help_echo_string
= help
;
27364 XSETWINDOW (help_echo_window
, w
);
27365 help_echo_object
= string
;
27366 help_echo_pos
= charpos
;
27368 else if (area
== ON_MODE_LINE
)
27370 Lisp_Object default_help
27371 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27374 if (STRINGP (default_help
))
27376 help_echo_string
= default_help
;
27377 XSETWINDOW (help_echo_window
, w
);
27378 help_echo_object
= Qnil
;
27379 help_echo_pos
= -1;
27384 #ifdef HAVE_WINDOW_SYSTEM
27385 /* Change the mouse pointer according to what is under it. */
27386 if (FRAME_WINDOW_P (f
))
27388 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27389 if (STRINGP (string
))
27391 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27393 if (NILP (pointer
))
27394 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27396 /* Change the mouse pointer according to what is under X/Y. */
27398 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27401 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27402 if (!KEYMAPP (map
))
27403 map
= Fget_text_property (pos
, Qkeymap
, string
);
27404 if (!KEYMAPP (map
))
27405 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27409 /* Default mode-line pointer. */
27410 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27415 /* Change the mouse face according to what is under X/Y. */
27416 if (STRINGP (string
))
27418 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27419 if (!NILP (mouse_face
)
27420 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27425 struct glyph
* tmp_glyph
;
27429 int total_pixel_width
;
27430 ptrdiff_t begpos
, endpos
, ignore
;
27434 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27435 Qmouse_face
, string
, Qnil
);
27441 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27443 endpos
= SCHARS (string
);
27447 /* Calculate the glyph position GPOS of GLYPH in the
27448 displayed string, relative to the beginning of the
27449 highlighted part of the string.
27451 Note: GPOS is different from CHARPOS. CHARPOS is the
27452 position of GLYPH in the internal string object. A mode
27453 line string format has structures which are converted to
27454 a flattened string by the Emacs Lisp interpreter. The
27455 internal string is an element of those structures. The
27456 displayed string is the flattened string. */
27457 tmp_glyph
= row_start_glyph
;
27458 while (tmp_glyph
< glyph
27459 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27460 && begpos
<= tmp_glyph
->charpos
27461 && tmp_glyph
->charpos
< endpos
)))
27463 gpos
= glyph
- tmp_glyph
;
27465 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27466 the highlighted part of the displayed string to which
27467 GLYPH belongs. Note: GSEQ_LENGTH is different from
27468 SCHARS (STRING), because the latter returns the length of
27469 the internal string. */
27470 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27472 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27473 && begpos
<= tmp_glyph
->charpos
27474 && tmp_glyph
->charpos
< endpos
));
27477 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27479 /* Calculate the total pixel width of all the glyphs between
27480 the beginning of the highlighted area and GLYPH. */
27481 total_pixel_width
= 0;
27482 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27483 total_pixel_width
+= tmp_glyph
->pixel_width
;
27485 /* Pre calculation of re-rendering position. Note: X is in
27486 column units here, after the call to mode_line_string or
27487 marginal_area_string. */
27489 vpos
= (area
== ON_MODE_LINE
27490 ? (w
->current_matrix
)->nrows
- 1
27493 /* If GLYPH's position is included in the region that is
27494 already drawn in mouse face, we have nothing to do. */
27495 if ( EQ (window
, hlinfo
->mouse_face_window
)
27496 && (!row
->reversed_p
27497 ? (hlinfo
->mouse_face_beg_col
<= hpos
27498 && hpos
< hlinfo
->mouse_face_end_col
)
27499 /* In R2L rows we swap BEG and END, see below. */
27500 : (hlinfo
->mouse_face_end_col
<= hpos
27501 && hpos
< hlinfo
->mouse_face_beg_col
))
27502 && hlinfo
->mouse_face_beg_row
== vpos
)
27505 if (clear_mouse_face (hlinfo
))
27506 cursor
= No_Cursor
;
27508 if (!row
->reversed_p
)
27510 hlinfo
->mouse_face_beg_col
= hpos
;
27511 hlinfo
->mouse_face_beg_x
= original_x_pixel
27512 - (total_pixel_width
+ dx
);
27513 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27514 hlinfo
->mouse_face_end_x
= 0;
27518 /* In R2L rows, show_mouse_face expects BEG and END
27519 coordinates to be swapped. */
27520 hlinfo
->mouse_face_end_col
= hpos
;
27521 hlinfo
->mouse_face_end_x
= original_x_pixel
27522 - (total_pixel_width
+ dx
);
27523 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27524 hlinfo
->mouse_face_beg_x
= 0;
27527 hlinfo
->mouse_face_beg_row
= vpos
;
27528 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27529 hlinfo
->mouse_face_beg_y
= 0;
27530 hlinfo
->mouse_face_end_y
= 0;
27531 hlinfo
->mouse_face_past_end
= 0;
27532 hlinfo
->mouse_face_window
= window
;
27534 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27540 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27542 if (NILP (pointer
))
27545 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27546 clear_mouse_face (hlinfo
);
27548 #ifdef HAVE_WINDOW_SYSTEM
27549 if (FRAME_WINDOW_P (f
))
27550 define_frame_cursor1 (f
, cursor
, pointer
);
27556 Take proper action when the mouse has moved to position X, Y on
27557 frame F as regards highlighting characters that have mouse-face
27558 properties. Also de-highlighting chars where the mouse was before.
27559 X and Y can be negative or out of range. */
27562 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27564 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27565 enum window_part part
= ON_NOTHING
;
27566 Lisp_Object window
;
27568 Cursor cursor
= No_Cursor
;
27569 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27572 /* When a menu is active, don't highlight because this looks odd. */
27573 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27574 if (popup_activated ())
27578 if (NILP (Vmouse_highlight
)
27579 || !f
->glyphs_initialized_p
27580 || f
->pointer_invisible
)
27583 hlinfo
->mouse_face_mouse_x
= x
;
27584 hlinfo
->mouse_face_mouse_y
= y
;
27585 hlinfo
->mouse_face_mouse_frame
= f
;
27587 if (hlinfo
->mouse_face_defer
)
27590 if (gc_in_progress
)
27592 hlinfo
->mouse_face_deferred_gc
= 1;
27596 /* Which window is that in? */
27597 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27599 /* If displaying active text in another window, clear that. */
27600 if (! EQ (window
, hlinfo
->mouse_face_window
)
27601 /* Also clear if we move out of text area in same window. */
27602 || (!NILP (hlinfo
->mouse_face_window
)
27605 && part
!= ON_MODE_LINE
27606 && part
!= ON_HEADER_LINE
))
27607 clear_mouse_face (hlinfo
);
27609 /* Not on a window -> return. */
27610 if (!WINDOWP (window
))
27613 /* Reset help_echo_string. It will get recomputed below. */
27614 help_echo_string
= Qnil
;
27616 /* Convert to window-relative pixel coordinates. */
27617 w
= XWINDOW (window
);
27618 frame_to_window_pixel_xy (w
, &x
, &y
);
27620 #ifdef HAVE_WINDOW_SYSTEM
27621 /* Handle tool-bar window differently since it doesn't display a
27623 if (EQ (window
, f
->tool_bar_window
))
27625 note_tool_bar_highlight (f
, x
, y
);
27630 /* Mouse is on the mode, header line or margin? */
27631 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27632 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27634 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27638 #ifdef HAVE_WINDOW_SYSTEM
27639 if (part
== ON_VERTICAL_BORDER
)
27641 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27642 help_echo_string
= build_string ("drag-mouse-1: resize");
27644 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27645 || part
== ON_SCROLL_BAR
)
27646 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27648 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27651 /* Are we in a window whose display is up to date?
27652 And verify the buffer's text has not changed. */
27653 b
= XBUFFER (w
->buffer
);
27654 if (part
== ON_TEXT
27655 && EQ (w
->window_end_valid
, w
->buffer
)
27656 && w
->last_modified
== BUF_MODIFF (b
)
27657 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27659 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27661 struct glyph
*glyph
;
27662 Lisp_Object object
;
27663 Lisp_Object mouse_face
= Qnil
, position
;
27664 Lisp_Object
*overlay_vec
= NULL
;
27665 ptrdiff_t i
, noverlays
;
27666 struct buffer
*obuf
;
27667 ptrdiff_t obegv
, ozv
;
27670 /* Find the glyph under X/Y. */
27671 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27673 #ifdef HAVE_WINDOW_SYSTEM
27674 /* Look for :pointer property on image. */
27675 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27677 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27678 if (img
!= NULL
&& IMAGEP (img
->spec
))
27680 Lisp_Object image_map
, hotspot
;
27681 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27683 && (hotspot
= find_hot_spot (image_map
,
27684 glyph
->slice
.img
.x
+ dx
,
27685 glyph
->slice
.img
.y
+ dy
),
27687 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27691 /* Could check XCAR (hotspot) to see if we enter/leave
27693 If so, we could look for mouse-enter, mouse-leave
27694 properties in PLIST (and do something...). */
27695 hotspot
= XCDR (hotspot
);
27696 if (CONSP (hotspot
)
27697 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27699 pointer
= Fplist_get (plist
, Qpointer
);
27700 if (NILP (pointer
))
27702 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27703 if (!NILP (help_echo_string
))
27705 help_echo_window
= window
;
27706 help_echo_object
= glyph
->object
;
27707 help_echo_pos
= glyph
->charpos
;
27711 if (NILP (pointer
))
27712 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27715 #endif /* HAVE_WINDOW_SYSTEM */
27717 /* Clear mouse face if X/Y not over text. */
27719 || area
!= TEXT_AREA
27720 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27721 /* Glyph's OBJECT is an integer for glyphs inserted by the
27722 display engine for its internal purposes, like truncation
27723 and continuation glyphs and blanks beyond the end of
27724 line's text on text terminals. If we are over such a
27725 glyph, we are not over any text. */
27726 || INTEGERP (glyph
->object
)
27727 /* R2L rows have a stretch glyph at their front, which
27728 stands for no text, whereas L2R rows have no glyphs at
27729 all beyond the end of text. Treat such stretch glyphs
27730 like we do with NULL glyphs in L2R rows. */
27731 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27732 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27733 && glyph
->type
== STRETCH_GLYPH
27734 && glyph
->avoid_cursor_p
))
27736 if (clear_mouse_face (hlinfo
))
27737 cursor
= No_Cursor
;
27738 #ifdef HAVE_WINDOW_SYSTEM
27739 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27741 if (area
!= TEXT_AREA
)
27742 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27744 pointer
= Vvoid_text_area_pointer
;
27750 pos
= glyph
->charpos
;
27751 object
= glyph
->object
;
27752 if (!STRINGP (object
) && !BUFFERP (object
))
27755 /* If we get an out-of-range value, return now; avoid an error. */
27756 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27759 /* Make the window's buffer temporarily current for
27760 overlays_at and compute_char_face. */
27761 obuf
= current_buffer
;
27762 current_buffer
= b
;
27768 /* Is this char mouse-active or does it have help-echo? */
27769 position
= make_number (pos
);
27771 if (BUFFERP (object
))
27773 /* Put all the overlays we want in a vector in overlay_vec. */
27774 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27775 /* Sort overlays into increasing priority order. */
27776 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27781 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27784 cursor
= No_Cursor
;
27786 /* Check mouse-face highlighting. */
27788 /* If there exists an overlay with mouse-face overlapping
27789 the one we are currently highlighting, we have to
27790 check if we enter the overlapping overlay, and then
27791 highlight only that. */
27792 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27793 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27795 /* Find the highest priority overlay with a mouse-face. */
27796 Lisp_Object overlay
= Qnil
;
27797 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27799 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27800 if (!NILP (mouse_face
))
27801 overlay
= overlay_vec
[i
];
27804 /* If we're highlighting the same overlay as before, there's
27805 no need to do that again. */
27806 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27807 goto check_help_echo
;
27808 hlinfo
->mouse_face_overlay
= overlay
;
27810 /* Clear the display of the old active region, if any. */
27811 if (clear_mouse_face (hlinfo
))
27812 cursor
= No_Cursor
;
27814 /* If no overlay applies, get a text property. */
27815 if (NILP (overlay
))
27816 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27818 /* Next, compute the bounds of the mouse highlighting and
27820 if (!NILP (mouse_face
) && STRINGP (object
))
27822 /* The mouse-highlighting comes from a display string
27823 with a mouse-face. */
27827 s
= Fprevious_single_property_change
27828 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27829 e
= Fnext_single_property_change
27830 (position
, Qmouse_face
, object
, Qnil
);
27832 s
= make_number (0);
27834 e
= make_number (SCHARS (object
) - 1);
27835 mouse_face_from_string_pos (w
, hlinfo
, object
,
27836 XINT (s
), XINT (e
));
27837 hlinfo
->mouse_face_past_end
= 0;
27838 hlinfo
->mouse_face_window
= window
;
27839 hlinfo
->mouse_face_face_id
27840 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27841 glyph
->face_id
, 1);
27842 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27843 cursor
= No_Cursor
;
27847 /* The mouse-highlighting, if any, comes from an overlay
27848 or text property in the buffer. */
27849 Lisp_Object buffer
IF_LINT (= Qnil
);
27850 Lisp_Object disp_string
IF_LINT (= Qnil
);
27852 if (STRINGP (object
))
27854 /* If we are on a display string with no mouse-face,
27855 check if the text under it has one. */
27856 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27857 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27858 pos
= string_buffer_position (object
, start
);
27861 mouse_face
= get_char_property_and_overlay
27862 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27863 buffer
= w
->buffer
;
27864 disp_string
= object
;
27870 disp_string
= Qnil
;
27873 if (!NILP (mouse_face
))
27875 Lisp_Object before
, after
;
27876 Lisp_Object before_string
, after_string
;
27877 /* To correctly find the limits of mouse highlight
27878 in a bidi-reordered buffer, we must not use the
27879 optimization of limiting the search in
27880 previous-single-property-change and
27881 next-single-property-change, because
27882 rows_from_pos_range needs the real start and end
27883 positions to DTRT in this case. That's because
27884 the first row visible in a window does not
27885 necessarily display the character whose position
27886 is the smallest. */
27888 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27889 ? Fmarker_position (w
->start
)
27892 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27893 ? make_number (BUF_Z (XBUFFER (buffer
))
27894 - XFASTINT (w
->window_end_pos
))
27897 if (NILP (overlay
))
27899 /* Handle the text property case. */
27900 before
= Fprevious_single_property_change
27901 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27902 after
= Fnext_single_property_change
27903 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27904 before_string
= after_string
= Qnil
;
27908 /* Handle the overlay case. */
27909 before
= Foverlay_start (overlay
);
27910 after
= Foverlay_end (overlay
);
27911 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27912 after_string
= Foverlay_get (overlay
, Qafter_string
);
27914 if (!STRINGP (before_string
)) before_string
= Qnil
;
27915 if (!STRINGP (after_string
)) after_string
= Qnil
;
27918 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27921 : XFASTINT (before
),
27923 ? BUF_Z (XBUFFER (buffer
))
27924 : XFASTINT (after
),
27925 before_string
, after_string
,
27927 cursor
= No_Cursor
;
27934 /* Look for a `help-echo' property. */
27935 if (NILP (help_echo_string
)) {
27936 Lisp_Object help
, overlay
;
27938 /* Check overlays first. */
27939 help
= overlay
= Qnil
;
27940 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27942 overlay
= overlay_vec
[i
];
27943 help
= Foverlay_get (overlay
, Qhelp_echo
);
27948 help_echo_string
= help
;
27949 help_echo_window
= window
;
27950 help_echo_object
= overlay
;
27951 help_echo_pos
= pos
;
27955 Lisp_Object obj
= glyph
->object
;
27956 ptrdiff_t charpos
= glyph
->charpos
;
27958 /* Try text properties. */
27961 && charpos
< SCHARS (obj
))
27963 help
= Fget_text_property (make_number (charpos
),
27967 /* If the string itself doesn't specify a help-echo,
27968 see if the buffer text ``under'' it does. */
27969 struct glyph_row
*r
27970 = MATRIX_ROW (w
->current_matrix
, vpos
);
27971 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27972 ptrdiff_t p
= string_buffer_position (obj
, start
);
27975 help
= Fget_char_property (make_number (p
),
27976 Qhelp_echo
, w
->buffer
);
27985 else if (BUFFERP (obj
)
27988 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27993 help_echo_string
= help
;
27994 help_echo_window
= window
;
27995 help_echo_object
= obj
;
27996 help_echo_pos
= charpos
;
28001 #ifdef HAVE_WINDOW_SYSTEM
28002 /* Look for a `pointer' property. */
28003 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28005 /* Check overlays first. */
28006 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28007 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28009 if (NILP (pointer
))
28011 Lisp_Object obj
= glyph
->object
;
28012 ptrdiff_t charpos
= glyph
->charpos
;
28014 /* Try text properties. */
28017 && charpos
< SCHARS (obj
))
28019 pointer
= Fget_text_property (make_number (charpos
),
28021 if (NILP (pointer
))
28023 /* If the string itself doesn't specify a pointer,
28024 see if the buffer text ``under'' it does. */
28025 struct glyph_row
*r
28026 = MATRIX_ROW (w
->current_matrix
, vpos
);
28027 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28028 ptrdiff_t p
= string_buffer_position (obj
, start
);
28030 pointer
= Fget_char_property (make_number (p
),
28031 Qpointer
, w
->buffer
);
28034 else if (BUFFERP (obj
)
28037 pointer
= Fget_text_property (make_number (charpos
),
28041 #endif /* HAVE_WINDOW_SYSTEM */
28045 current_buffer
= obuf
;
28050 #ifdef HAVE_WINDOW_SYSTEM
28051 if (FRAME_WINDOW_P (f
))
28052 define_frame_cursor1 (f
, cursor
, pointer
);
28054 /* This is here to prevent a compiler error, about "label at end of
28055 compound statement". */
28062 Clear any mouse-face on window W. This function is part of the
28063 redisplay interface, and is called from try_window_id and similar
28064 functions to ensure the mouse-highlight is off. */
28067 x_clear_window_mouse_face (struct window
*w
)
28069 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28070 Lisp_Object window
;
28073 XSETWINDOW (window
, w
);
28074 if (EQ (window
, hlinfo
->mouse_face_window
))
28075 clear_mouse_face (hlinfo
);
28081 Just discard the mouse face information for frame F, if any.
28082 This is used when the size of F is changed. */
28085 cancel_mouse_face (struct frame
*f
)
28087 Lisp_Object window
;
28088 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28090 window
= hlinfo
->mouse_face_window
;
28091 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28093 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28094 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28095 hlinfo
->mouse_face_window
= Qnil
;
28101 /***********************************************************************
28103 ***********************************************************************/
28105 #ifdef HAVE_WINDOW_SYSTEM
28107 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28108 which intersects rectangle R. R is in window-relative coordinates. */
28111 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28112 enum glyph_row_area area
)
28114 struct glyph
*first
= row
->glyphs
[area
];
28115 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28116 struct glyph
*last
;
28117 int first_x
, start_x
, x
;
28119 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28120 /* If row extends face to end of line write the whole line. */
28121 draw_glyphs (w
, 0, row
, area
,
28122 0, row
->used
[area
],
28123 DRAW_NORMAL_TEXT
, 0);
28126 /* Set START_X to the window-relative start position for drawing glyphs of
28127 AREA. The first glyph of the text area can be partially visible.
28128 The first glyphs of other areas cannot. */
28129 start_x
= window_box_left_offset (w
, area
);
28131 if (area
== TEXT_AREA
)
28134 /* Find the first glyph that must be redrawn. */
28136 && x
+ first
->pixel_width
< r
->x
)
28138 x
+= first
->pixel_width
;
28142 /* Find the last one. */
28146 && x
< r
->x
+ r
->width
)
28148 x
+= last
->pixel_width
;
28154 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28155 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28156 DRAW_NORMAL_TEXT
, 0);
28161 /* Redraw the parts of the glyph row ROW on window W intersecting
28162 rectangle R. R is in window-relative coordinates. Value is
28163 non-zero if mouse-face was overwritten. */
28166 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28168 eassert (row
->enabled_p
);
28170 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28171 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28172 0, row
->used
[TEXT_AREA
],
28173 DRAW_NORMAL_TEXT
, 0);
28176 if (row
->used
[LEFT_MARGIN_AREA
])
28177 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28178 if (row
->used
[TEXT_AREA
])
28179 expose_area (w
, row
, r
, TEXT_AREA
);
28180 if (row
->used
[RIGHT_MARGIN_AREA
])
28181 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28182 draw_row_fringe_bitmaps (w
, row
);
28185 return row
->mouse_face_p
;
28189 /* Redraw those parts of glyphs rows during expose event handling that
28190 overlap other rows. Redrawing of an exposed line writes over parts
28191 of lines overlapping that exposed line; this function fixes that.
28193 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28194 row in W's current matrix that is exposed and overlaps other rows.
28195 LAST_OVERLAPPING_ROW is the last such row. */
28198 expose_overlaps (struct window
*w
,
28199 struct glyph_row
*first_overlapping_row
,
28200 struct glyph_row
*last_overlapping_row
,
28203 struct glyph_row
*row
;
28205 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28206 if (row
->overlapping_p
)
28208 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28211 if (row
->used
[LEFT_MARGIN_AREA
])
28212 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28214 if (row
->used
[TEXT_AREA
])
28215 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28217 if (row
->used
[RIGHT_MARGIN_AREA
])
28218 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28224 /* Return non-zero if W's cursor intersects rectangle R. */
28227 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28229 XRectangle cr
, result
;
28230 struct glyph
*cursor_glyph
;
28231 struct glyph_row
*row
;
28233 if (w
->phys_cursor
.vpos
>= 0
28234 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28235 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28237 && row
->cursor_in_fringe_p
)
28239 /* Cursor is in the fringe. */
28240 cr
.x
= window_box_right_offset (w
,
28241 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28242 ? RIGHT_MARGIN_AREA
28245 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28246 cr
.height
= row
->height
;
28247 return x_intersect_rectangles (&cr
, r
, &result
);
28250 cursor_glyph
= get_phys_cursor_glyph (w
);
28253 /* r is relative to W's box, but w->phys_cursor.x is relative
28254 to left edge of W's TEXT area. Adjust it. */
28255 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28256 cr
.y
= w
->phys_cursor
.y
;
28257 cr
.width
= cursor_glyph
->pixel_width
;
28258 cr
.height
= w
->phys_cursor_height
;
28259 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28260 I assume the effect is the same -- and this is portable. */
28261 return x_intersect_rectangles (&cr
, r
, &result
);
28263 /* If we don't understand the format, pretend we're not in the hot-spot. */
28269 Draw a vertical window border to the right of window W if W doesn't
28270 have vertical scroll bars. */
28273 x_draw_vertical_border (struct window
*w
)
28275 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28277 /* We could do better, if we knew what type of scroll-bar the adjacent
28278 windows (on either side) have... But we don't :-(
28279 However, I think this works ok. ++KFS 2003-04-25 */
28281 /* Redraw borders between horizontally adjacent windows. Don't
28282 do it for frames with vertical scroll bars because either the
28283 right scroll bar of a window, or the left scroll bar of its
28284 neighbor will suffice as a border. */
28285 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28288 if (!WINDOW_RIGHTMOST_P (w
)
28289 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28291 int x0
, x1
, y0
, y1
;
28293 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28296 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28299 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28301 else if (!WINDOW_LEFTMOST_P (w
)
28302 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28304 int x0
, x1
, y0
, y1
;
28306 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28309 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28312 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28317 /* Redraw the part of window W intersection rectangle FR. Pixel
28318 coordinates in FR are frame-relative. Call this function with
28319 input blocked. Value is non-zero if the exposure overwrites
28323 expose_window (struct window
*w
, XRectangle
*fr
)
28325 struct frame
*f
= XFRAME (w
->frame
);
28327 int mouse_face_overwritten_p
= 0;
28329 /* If window is not yet fully initialized, do nothing. This can
28330 happen when toolkit scroll bars are used and a window is split.
28331 Reconfiguring the scroll bar will generate an expose for a newly
28333 if (w
->current_matrix
== NULL
)
28336 /* When we're currently updating the window, display and current
28337 matrix usually don't agree. Arrange for a thorough display
28339 if (w
== updated_window
)
28341 SET_FRAME_GARBAGED (f
);
28345 /* Frame-relative pixel rectangle of W. */
28346 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28347 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28348 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28349 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28351 if (x_intersect_rectangles (fr
, &wr
, &r
))
28353 int yb
= window_text_bottom_y (w
);
28354 struct glyph_row
*row
;
28355 int cursor_cleared_p
, phys_cursor_on_p
;
28356 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28358 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28359 r
.x
, r
.y
, r
.width
, r
.height
));
28361 /* Convert to window coordinates. */
28362 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28363 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28365 /* Turn off the cursor. */
28366 if (!w
->pseudo_window_p
28367 && phys_cursor_in_rect_p (w
, &r
))
28369 x_clear_cursor (w
);
28370 cursor_cleared_p
= 1;
28373 cursor_cleared_p
= 0;
28375 /* If the row containing the cursor extends face to end of line,
28376 then expose_area might overwrite the cursor outside the
28377 rectangle and thus notice_overwritten_cursor might clear
28378 w->phys_cursor_on_p. We remember the original value and
28379 check later if it is changed. */
28380 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28382 /* Update lines intersecting rectangle R. */
28383 first_overlapping_row
= last_overlapping_row
= NULL
;
28384 for (row
= w
->current_matrix
->rows
;
28389 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28391 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28392 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28393 || (r
.y
>= y0
&& r
.y
< y1
)
28394 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28396 /* A header line may be overlapping, but there is no need
28397 to fix overlapping areas for them. KFS 2005-02-12 */
28398 if (row
->overlapping_p
&& !row
->mode_line_p
)
28400 if (first_overlapping_row
== NULL
)
28401 first_overlapping_row
= row
;
28402 last_overlapping_row
= row
;
28406 if (expose_line (w
, row
, &r
))
28407 mouse_face_overwritten_p
= 1;
28410 else if (row
->overlapping_p
)
28412 /* We must redraw a row overlapping the exposed area. */
28414 ? y0
+ row
->phys_height
> r
.y
28415 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28417 if (first_overlapping_row
== NULL
)
28418 first_overlapping_row
= row
;
28419 last_overlapping_row
= row
;
28427 /* Display the mode line if there is one. */
28428 if (WINDOW_WANTS_MODELINE_P (w
)
28429 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28431 && row
->y
< r
.y
+ r
.height
)
28433 if (expose_line (w
, row
, &r
))
28434 mouse_face_overwritten_p
= 1;
28437 if (!w
->pseudo_window_p
)
28439 /* Fix the display of overlapping rows. */
28440 if (first_overlapping_row
)
28441 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28444 /* Draw border between windows. */
28445 x_draw_vertical_border (w
);
28447 /* Turn the cursor on again. */
28448 if (cursor_cleared_p
28449 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28450 update_window_cursor (w
, 1);
28454 return mouse_face_overwritten_p
;
28459 /* Redraw (parts) of all windows in the window tree rooted at W that
28460 intersect R. R contains frame pixel coordinates. Value is
28461 non-zero if the exposure overwrites mouse-face. */
28464 expose_window_tree (struct window
*w
, XRectangle
*r
)
28466 struct frame
*f
= XFRAME (w
->frame
);
28467 int mouse_face_overwritten_p
= 0;
28469 while (w
&& !FRAME_GARBAGED_P (f
))
28471 if (!NILP (w
->hchild
))
28472 mouse_face_overwritten_p
28473 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28474 else if (!NILP (w
->vchild
))
28475 mouse_face_overwritten_p
28476 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28478 mouse_face_overwritten_p
|= expose_window (w
, r
);
28480 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28483 return mouse_face_overwritten_p
;
28488 Redisplay an exposed area of frame F. X and Y are the upper-left
28489 corner of the exposed rectangle. W and H are width and height of
28490 the exposed area. All are pixel values. W or H zero means redraw
28491 the entire frame. */
28494 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28497 int mouse_face_overwritten_p
= 0;
28499 TRACE ((stderr
, "expose_frame "));
28501 /* No need to redraw if frame will be redrawn soon. */
28502 if (FRAME_GARBAGED_P (f
))
28504 TRACE ((stderr
, " garbaged\n"));
28508 /* If basic faces haven't been realized yet, there is no point in
28509 trying to redraw anything. This can happen when we get an expose
28510 event while Emacs is starting, e.g. by moving another window. */
28511 if (FRAME_FACE_CACHE (f
) == NULL
28512 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28514 TRACE ((stderr
, " no faces\n"));
28518 if (w
== 0 || h
== 0)
28521 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28522 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28532 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28533 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28535 if (WINDOWP (f
->tool_bar_window
))
28536 mouse_face_overwritten_p
28537 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28539 #ifdef HAVE_X_WINDOWS
28541 #ifndef USE_X_TOOLKIT
28542 if (WINDOWP (f
->menu_bar_window
))
28543 mouse_face_overwritten_p
28544 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28545 #endif /* not USE_X_TOOLKIT */
28549 /* Some window managers support a focus-follows-mouse style with
28550 delayed raising of frames. Imagine a partially obscured frame,
28551 and moving the mouse into partially obscured mouse-face on that
28552 frame. The visible part of the mouse-face will be highlighted,
28553 then the WM raises the obscured frame. With at least one WM, KDE
28554 2.1, Emacs is not getting any event for the raising of the frame
28555 (even tried with SubstructureRedirectMask), only Expose events.
28556 These expose events will draw text normally, i.e. not
28557 highlighted. Which means we must redo the highlight here.
28558 Subsume it under ``we love X''. --gerd 2001-08-15 */
28559 /* Included in Windows version because Windows most likely does not
28560 do the right thing if any third party tool offers
28561 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28562 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28564 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28565 if (f
== hlinfo
->mouse_face_mouse_frame
)
28567 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28568 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28569 clear_mouse_face (hlinfo
);
28570 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28577 Determine the intersection of two rectangles R1 and R2. Return
28578 the intersection in *RESULT. Value is non-zero if RESULT is not
28582 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28584 XRectangle
*left
, *right
;
28585 XRectangle
*upper
, *lower
;
28586 int intersection_p
= 0;
28588 /* Rearrange so that R1 is the left-most rectangle. */
28590 left
= r1
, right
= r2
;
28592 left
= r2
, right
= r1
;
28594 /* X0 of the intersection is right.x0, if this is inside R1,
28595 otherwise there is no intersection. */
28596 if (right
->x
<= left
->x
+ left
->width
)
28598 result
->x
= right
->x
;
28600 /* The right end of the intersection is the minimum of
28601 the right ends of left and right. */
28602 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28605 /* Same game for Y. */
28607 upper
= r1
, lower
= r2
;
28609 upper
= r2
, lower
= r1
;
28611 /* The upper end of the intersection is lower.y0, if this is inside
28612 of upper. Otherwise, there is no intersection. */
28613 if (lower
->y
<= upper
->y
+ upper
->height
)
28615 result
->y
= lower
->y
;
28617 /* The lower end of the intersection is the minimum of the lower
28618 ends of upper and lower. */
28619 result
->height
= (min (lower
->y
+ lower
->height
,
28620 upper
->y
+ upper
->height
)
28622 intersection_p
= 1;
28626 return intersection_p
;
28629 #endif /* HAVE_WINDOW_SYSTEM */
28632 /***********************************************************************
28634 ***********************************************************************/
28637 syms_of_xdisp (void)
28639 Vwith_echo_area_save_vector
= Qnil
;
28640 staticpro (&Vwith_echo_area_save_vector
);
28642 Vmessage_stack
= Qnil
;
28643 staticpro (&Vmessage_stack
);
28645 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28647 message_dolog_marker1
= Fmake_marker ();
28648 staticpro (&message_dolog_marker1
);
28649 message_dolog_marker2
= Fmake_marker ();
28650 staticpro (&message_dolog_marker2
);
28651 message_dolog_marker3
= Fmake_marker ();
28652 staticpro (&message_dolog_marker3
);
28655 defsubr (&Sdump_frame_glyph_matrix
);
28656 defsubr (&Sdump_glyph_matrix
);
28657 defsubr (&Sdump_glyph_row
);
28658 defsubr (&Sdump_tool_bar_row
);
28659 defsubr (&Strace_redisplay
);
28660 defsubr (&Strace_to_stderr
);
28662 #ifdef HAVE_WINDOW_SYSTEM
28663 defsubr (&Stool_bar_lines_needed
);
28664 defsubr (&Slookup_image_map
);
28666 defsubr (&Sformat_mode_line
);
28667 defsubr (&Sinvisible_p
);
28668 defsubr (&Scurrent_bidi_paragraph_direction
);
28670 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28671 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28672 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28673 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28674 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28675 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28676 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28677 DEFSYM (Qeval
, "eval");
28678 DEFSYM (QCdata
, ":data");
28679 DEFSYM (Qdisplay
, "display");
28680 DEFSYM (Qspace_width
, "space-width");
28681 DEFSYM (Qraise
, "raise");
28682 DEFSYM (Qslice
, "slice");
28683 DEFSYM (Qspace
, "space");
28684 DEFSYM (Qmargin
, "margin");
28685 DEFSYM (Qpointer
, "pointer");
28686 DEFSYM (Qleft_margin
, "left-margin");
28687 DEFSYM (Qright_margin
, "right-margin");
28688 DEFSYM (Qcenter
, "center");
28689 DEFSYM (Qline_height
, "line-height");
28690 DEFSYM (QCalign_to
, ":align-to");
28691 DEFSYM (QCrelative_width
, ":relative-width");
28692 DEFSYM (QCrelative_height
, ":relative-height");
28693 DEFSYM (QCeval
, ":eval");
28694 DEFSYM (QCpropertize
, ":propertize");
28695 DEFSYM (QCfile
, ":file");
28696 DEFSYM (Qfontified
, "fontified");
28697 DEFSYM (Qfontification_functions
, "fontification-functions");
28698 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28699 DEFSYM (Qescape_glyph
, "escape-glyph");
28700 DEFSYM (Qnobreak_space
, "nobreak-space");
28701 DEFSYM (Qimage
, "image");
28702 DEFSYM (Qtext
, "text");
28703 DEFSYM (Qboth
, "both");
28704 DEFSYM (Qboth_horiz
, "both-horiz");
28705 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28706 DEFSYM (QCmap
, ":map");
28707 DEFSYM (QCpointer
, ":pointer");
28708 DEFSYM (Qrect
, "rect");
28709 DEFSYM (Qcircle
, "circle");
28710 DEFSYM (Qpoly
, "poly");
28711 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28712 DEFSYM (Qgrow_only
, "grow-only");
28713 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28714 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28715 DEFSYM (Qposition
, "position");
28716 DEFSYM (Qbuffer_position
, "buffer-position");
28717 DEFSYM (Qobject
, "object");
28718 DEFSYM (Qbar
, "bar");
28719 DEFSYM (Qhbar
, "hbar");
28720 DEFSYM (Qbox
, "box");
28721 DEFSYM (Qhollow
, "hollow");
28722 DEFSYM (Qhand
, "hand");
28723 DEFSYM (Qarrow
, "arrow");
28724 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28726 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28727 Fcons (intern_c_string ("void-variable"), Qnil
)),
28729 staticpro (&list_of_error
);
28731 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28732 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28733 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28734 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28736 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28737 staticpro (&echo_buffer
[0]);
28738 staticpro (&echo_buffer
[1]);
28740 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28741 staticpro (&echo_area_buffer
[0]);
28742 staticpro (&echo_area_buffer
[1]);
28744 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28745 staticpro (&Vmessages_buffer_name
);
28747 mode_line_proptrans_alist
= Qnil
;
28748 staticpro (&mode_line_proptrans_alist
);
28749 mode_line_string_list
= Qnil
;
28750 staticpro (&mode_line_string_list
);
28751 mode_line_string_face
= Qnil
;
28752 staticpro (&mode_line_string_face
);
28753 mode_line_string_face_prop
= Qnil
;
28754 staticpro (&mode_line_string_face_prop
);
28755 Vmode_line_unwind_vector
= Qnil
;
28756 staticpro (&Vmode_line_unwind_vector
);
28758 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28760 help_echo_string
= Qnil
;
28761 staticpro (&help_echo_string
);
28762 help_echo_object
= Qnil
;
28763 staticpro (&help_echo_object
);
28764 help_echo_window
= Qnil
;
28765 staticpro (&help_echo_window
);
28766 previous_help_echo_string
= Qnil
;
28767 staticpro (&previous_help_echo_string
);
28768 help_echo_pos
= -1;
28770 DEFSYM (Qright_to_left
, "right-to-left");
28771 DEFSYM (Qleft_to_right
, "left-to-right");
28773 #ifdef HAVE_WINDOW_SYSTEM
28774 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28775 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28776 For example, if a block cursor is over a tab, it will be drawn as
28777 wide as that tab on the display. */);
28778 x_stretch_cursor_p
= 0;
28781 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28782 doc
: /* Non-nil means highlight trailing whitespace.
28783 The face used for trailing whitespace is `trailing-whitespace'. */);
28784 Vshow_trailing_whitespace
= Qnil
;
28786 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28787 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28788 If the value is t, Emacs highlights non-ASCII chars which have the
28789 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28790 or `escape-glyph' face respectively.
28792 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28793 U+2011 (non-breaking hyphen) are affected.
28795 Any other non-nil value means to display these characters as a escape
28796 glyph followed by an ordinary space or hyphen.
28798 A value of nil means no special handling of these characters. */);
28799 Vnobreak_char_display
= Qt
;
28801 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28802 doc
: /* The pointer shape to show in void text areas.
28803 A value of nil means to show the text pointer. Other options are `arrow',
28804 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28805 Vvoid_text_area_pointer
= Qarrow
;
28807 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28808 doc
: /* Non-nil means don't actually do any redisplay.
28809 This is used for internal purposes. */);
28810 Vinhibit_redisplay
= Qnil
;
28812 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28813 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28814 Vglobal_mode_string
= Qnil
;
28816 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28817 doc
: /* Marker for where to display an arrow on top of the buffer text.
28818 This must be the beginning of a line in order to work.
28819 See also `overlay-arrow-string'. */);
28820 Voverlay_arrow_position
= Qnil
;
28822 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28823 doc
: /* String to display as an arrow in non-window frames.
28824 See also `overlay-arrow-position'. */);
28825 Voverlay_arrow_string
= build_pure_c_string ("=>");
28827 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28828 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28829 The symbols on this list are examined during redisplay to determine
28830 where to display overlay arrows. */);
28831 Voverlay_arrow_variable_list
28832 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28834 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28835 doc
: /* The number of lines to try scrolling a window by when point moves out.
28836 If that fails to bring point back on frame, point is centered instead.
28837 If this is zero, point is always centered after it moves off frame.
28838 If you want scrolling to always be a line at a time, you should set
28839 `scroll-conservatively' to a large value rather than set this to 1. */);
28841 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28842 doc
: /* Scroll up to this many lines, to bring point back on screen.
28843 If point moves off-screen, redisplay will scroll by up to
28844 `scroll-conservatively' lines in order to bring point just barely
28845 onto the screen again. If that cannot be done, then redisplay
28846 recenters point as usual.
28848 If the value is greater than 100, redisplay will never recenter point,
28849 but will always scroll just enough text to bring point into view, even
28850 if you move far away.
28852 A value of zero means always recenter point if it moves off screen. */);
28853 scroll_conservatively
= 0;
28855 DEFVAR_INT ("scroll-margin", scroll_margin
,
28856 doc
: /* Number of lines of margin at the top and bottom of a window.
28857 Recenter the window whenever point gets within this many lines
28858 of the top or bottom of the window. */);
28861 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28862 doc
: /* Pixels per inch value for non-window system displays.
28863 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28864 Vdisplay_pixels_per_inch
= make_float (72.0);
28867 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28870 DEFVAR_LISP ("truncate-partial-width-windows",
28871 Vtruncate_partial_width_windows
,
28872 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28873 For an integer value, truncate lines in each window narrower than the
28874 full frame width, provided the window width is less than that integer;
28875 otherwise, respect the value of `truncate-lines'.
28877 For any other non-nil value, truncate lines in all windows that do
28878 not span the full frame width.
28880 A value of nil means to respect the value of `truncate-lines'.
28882 If `word-wrap' is enabled, you might want to reduce this. */);
28883 Vtruncate_partial_width_windows
= make_number (50);
28885 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28886 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28887 Any other value means to use the appropriate face, `mode-line',
28888 `header-line', or `menu' respectively. */);
28889 mode_line_inverse_video
= 1;
28891 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28892 doc
: /* Maximum buffer size for which line number should be displayed.
28893 If the buffer is bigger than this, the line number does not appear
28894 in the mode line. A value of nil means no limit. */);
28895 Vline_number_display_limit
= Qnil
;
28897 DEFVAR_INT ("line-number-display-limit-width",
28898 line_number_display_limit_width
,
28899 doc
: /* Maximum line width (in characters) for line number display.
28900 If the average length of the lines near point is bigger than this, then the
28901 line number may be omitted from the mode line. */);
28902 line_number_display_limit_width
= 200;
28904 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28905 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28906 highlight_nonselected_windows
= 0;
28908 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28909 doc
: /* Non-nil if more than one frame is visible on this display.
28910 Minibuffer-only frames don't count, but iconified frames do.
28911 This variable is not guaranteed to be accurate except while processing
28912 `frame-title-format' and `icon-title-format'. */);
28914 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28915 doc
: /* Template for displaying the title bar of visible frames.
28916 \(Assuming the window manager supports this feature.)
28918 This variable has the same structure as `mode-line-format', except that
28919 the %c and %l constructs are ignored. It is used only on frames for
28920 which no explicit name has been set \(see `modify-frame-parameters'). */);
28922 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28923 doc
: /* Template for displaying the title bar of an iconified frame.
28924 \(Assuming the window manager supports this feature.)
28925 This variable has the same structure as `mode-line-format' (which see),
28926 and is used only on frames for which no explicit name has been set
28927 \(see `modify-frame-parameters'). */);
28929 = Vframe_title_format
28930 = pure_cons (intern_c_string ("multiple-frames"),
28931 pure_cons (build_pure_c_string ("%b"),
28932 pure_cons (pure_cons (empty_unibyte_string
,
28933 pure_cons (intern_c_string ("invocation-name"),
28934 pure_cons (build_pure_c_string ("@"),
28935 pure_cons (intern_c_string ("system-name"),
28939 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28940 doc
: /* Maximum number of lines to keep in the message log buffer.
28941 If nil, disable message logging. If t, log messages but don't truncate
28942 the buffer when it becomes large. */);
28943 Vmessage_log_max
= make_number (100);
28945 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28946 doc
: /* Functions called before redisplay, if window sizes have changed.
28947 The value should be a list of functions that take one argument.
28948 Just before redisplay, for each frame, if any of its windows have changed
28949 size since the last redisplay, or have been split or deleted,
28950 all the functions in the list are called, with the frame as argument. */);
28951 Vwindow_size_change_functions
= Qnil
;
28953 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28954 doc
: /* List of functions to call before redisplaying a window with scrolling.
28955 Each function is called with two arguments, the window and its new
28956 display-start position. Note that these functions are also called by
28957 `set-window-buffer'. Also note that the value of `window-end' is not
28958 valid when these functions are called.
28960 Warning: Do not use this feature to alter the way the window
28961 is scrolled. It is not designed for that, and such use probably won't
28963 Vwindow_scroll_functions
= Qnil
;
28965 DEFVAR_LISP ("window-text-change-functions",
28966 Vwindow_text_change_functions
,
28967 doc
: /* Functions to call in redisplay when text in the window might change. */);
28968 Vwindow_text_change_functions
= Qnil
;
28970 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28971 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28972 Each function is called with two arguments, the window and the end trigger value.
28973 See `set-window-redisplay-end-trigger'. */);
28974 Vredisplay_end_trigger_functions
= Qnil
;
28976 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28977 doc
: /* Non-nil means autoselect window with mouse pointer.
28978 If nil, do not autoselect windows.
28979 A positive number means delay autoselection by that many seconds: a
28980 window is autoselected only after the mouse has remained in that
28981 window for the duration of the delay.
28982 A negative number has a similar effect, but causes windows to be
28983 autoselected only after the mouse has stopped moving. \(Because of
28984 the way Emacs compares mouse events, you will occasionally wait twice
28985 that time before the window gets selected.\)
28986 Any other value means to autoselect window instantaneously when the
28987 mouse pointer enters it.
28989 Autoselection selects the minibuffer only if it is active, and never
28990 unselects the minibuffer if it is active.
28992 When customizing this variable make sure that the actual value of
28993 `focus-follows-mouse' matches the behavior of your window manager. */);
28994 Vmouse_autoselect_window
= Qnil
;
28996 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28997 doc
: /* Non-nil means automatically resize tool-bars.
28998 This dynamically changes the tool-bar's height to the minimum height
28999 that is needed to make all tool-bar items visible.
29000 If value is `grow-only', the tool-bar's height is only increased
29001 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29002 Vauto_resize_tool_bars
= Qt
;
29004 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29005 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29006 auto_raise_tool_bar_buttons_p
= 1;
29008 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29009 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29010 make_cursor_line_fully_visible_p
= 1;
29012 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29013 doc
: /* Border below tool-bar in pixels.
29014 If an integer, use it as the height of the border.
29015 If it is one of `internal-border-width' or `border-width', use the
29016 value of the corresponding frame parameter.
29017 Otherwise, no border is added below the tool-bar. */);
29018 Vtool_bar_border
= Qinternal_border_width
;
29020 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29021 doc
: /* Margin around tool-bar buttons in pixels.
29022 If an integer, use that for both horizontal and vertical margins.
29023 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29024 HORZ specifying the horizontal margin, and VERT specifying the
29025 vertical margin. */);
29026 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29028 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29029 doc
: /* Relief thickness of tool-bar buttons. */);
29030 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29032 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29033 doc
: /* Tool bar style to use.
29035 image - show images only
29036 text - show text only
29037 both - show both, text below image
29038 both-horiz - show text to the right of the image
29039 text-image-horiz - show text to the left of the image
29040 any other - use system default or image if no system default.
29042 This variable only affects the GTK+ toolkit version of Emacs. */);
29043 Vtool_bar_style
= Qnil
;
29045 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29046 doc
: /* Maximum number of characters a label can have to be shown.
29047 The tool bar style must also show labels for this to have any effect, see
29048 `tool-bar-style'. */);
29049 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29051 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29052 doc
: /* List of functions to call to fontify regions of text.
29053 Each function is called with one argument POS. Functions must
29054 fontify a region starting at POS in the current buffer, and give
29055 fontified regions the property `fontified'. */);
29056 Vfontification_functions
= Qnil
;
29057 Fmake_variable_buffer_local (Qfontification_functions
);
29059 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29060 unibyte_display_via_language_environment
,
29061 doc
: /* Non-nil means display unibyte text according to language environment.
29062 Specifically, this means that raw bytes in the range 160-255 decimal
29063 are displayed by converting them to the equivalent multibyte characters
29064 according to the current language environment. As a result, they are
29065 displayed according to the current fontset.
29067 Note that this variable affects only how these bytes are displayed,
29068 but does not change the fact they are interpreted as raw bytes. */);
29069 unibyte_display_via_language_environment
= 0;
29071 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29072 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29073 If a float, it specifies a fraction of the mini-window frame's height.
29074 If an integer, it specifies a number of lines. */);
29075 Vmax_mini_window_height
= make_float (0.25);
29077 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29078 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29079 A value of nil means don't automatically resize mini-windows.
29080 A value of t means resize them to fit the text displayed in them.
29081 A value of `grow-only', the default, means let mini-windows grow only;
29082 they return to their normal size when the minibuffer is closed, or the
29083 echo area becomes empty. */);
29084 Vresize_mini_windows
= Qgrow_only
;
29086 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29087 doc
: /* Alist specifying how to blink the cursor off.
29088 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29089 `cursor-type' frame-parameter or variable equals ON-STATE,
29090 comparing using `equal', Emacs uses OFF-STATE to specify
29091 how to blink it off. ON-STATE and OFF-STATE are values for
29092 the `cursor-type' frame parameter.
29094 If a frame's ON-STATE has no entry in this list,
29095 the frame's other specifications determine how to blink the cursor off. */);
29096 Vblink_cursor_alist
= Qnil
;
29098 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29099 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29100 If non-nil, windows are automatically scrolled horizontally to make
29101 point visible. */);
29102 automatic_hscrolling_p
= 1;
29103 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29105 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29106 doc
: /* How many columns away from the window edge point is allowed to get
29107 before automatic hscrolling will horizontally scroll the window. */);
29108 hscroll_margin
= 5;
29110 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29111 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29112 When point is less than `hscroll-margin' columns from the window
29113 edge, automatic hscrolling will scroll the window by the amount of columns
29114 determined by this variable. If its value is a positive integer, scroll that
29115 many columns. If it's a positive floating-point number, it specifies the
29116 fraction of the window's width to scroll. If it's nil or zero, point will be
29117 centered horizontally after the scroll. Any other value, including negative
29118 numbers, are treated as if the value were zero.
29120 Automatic hscrolling always moves point outside the scroll margin, so if
29121 point was more than scroll step columns inside the margin, the window will
29122 scroll more than the value given by the scroll step.
29124 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29125 and `scroll-right' overrides this variable's effect. */);
29126 Vhscroll_step
= make_number (0);
29128 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29129 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29130 Bind this around calls to `message' to let it take effect. */);
29131 message_truncate_lines
= 0;
29133 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29134 doc
: /* Normal hook run to update the menu bar definitions.
29135 Redisplay runs this hook before it redisplays the menu bar.
29136 This is used to update submenus such as Buffers,
29137 whose contents depend on various data. */);
29138 Vmenu_bar_update_hook
= Qnil
;
29140 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29141 doc
: /* Frame for which we are updating a menu.
29142 The enable predicate for a menu binding should check this variable. */);
29143 Vmenu_updating_frame
= Qnil
;
29145 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29146 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29147 inhibit_menubar_update
= 0;
29149 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29150 doc
: /* Prefix prepended to all continuation lines at display time.
29151 The value may be a string, an image, or a stretch-glyph; it is
29152 interpreted in the same way as the value of a `display' text property.
29154 This variable is overridden by any `wrap-prefix' text or overlay
29157 To add a prefix to non-continuation lines, use `line-prefix'. */);
29158 Vwrap_prefix
= Qnil
;
29159 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29160 Fmake_variable_buffer_local (Qwrap_prefix
);
29162 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29163 doc
: /* Prefix prepended to all non-continuation lines at display time.
29164 The value may be a string, an image, or a stretch-glyph; it is
29165 interpreted in the same way as the value of a `display' text property.
29167 This variable is overridden by any `line-prefix' text or overlay
29170 To add a prefix to continuation lines, use `wrap-prefix'. */);
29171 Vline_prefix
= Qnil
;
29172 DEFSYM (Qline_prefix
, "line-prefix");
29173 Fmake_variable_buffer_local (Qline_prefix
);
29175 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29176 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29177 inhibit_eval_during_redisplay
= 0;
29179 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29180 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29181 inhibit_free_realized_faces
= 0;
29184 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29185 doc
: /* Inhibit try_window_id display optimization. */);
29186 inhibit_try_window_id
= 0;
29188 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29189 doc
: /* Inhibit try_window_reusing display optimization. */);
29190 inhibit_try_window_reusing
= 0;
29192 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29193 doc
: /* Inhibit try_cursor_movement display optimization. */);
29194 inhibit_try_cursor_movement
= 0;
29195 #endif /* GLYPH_DEBUG */
29197 DEFVAR_INT ("overline-margin", overline_margin
,
29198 doc
: /* Space between overline and text, in pixels.
29199 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29200 margin to the character height. */);
29201 overline_margin
= 2;
29203 DEFVAR_INT ("underline-minimum-offset",
29204 underline_minimum_offset
,
29205 doc
: /* Minimum distance between baseline and underline.
29206 This can improve legibility of underlined text at small font sizes,
29207 particularly when using variable `x-use-underline-position-properties'
29208 with fonts that specify an UNDERLINE_POSITION relatively close to the
29209 baseline. The default value is 1. */);
29210 underline_minimum_offset
= 1;
29212 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29213 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29214 This feature only works when on a window system that can change
29215 cursor shapes. */);
29216 display_hourglass_p
= 1;
29218 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29219 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29220 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29222 hourglass_atimer
= NULL
;
29223 hourglass_shown_p
= 0;
29225 DEFSYM (Qglyphless_char
, "glyphless-char");
29226 DEFSYM (Qhex_code
, "hex-code");
29227 DEFSYM (Qempty_box
, "empty-box");
29228 DEFSYM (Qthin_space
, "thin-space");
29229 DEFSYM (Qzero_width
, "zero-width");
29231 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29232 /* Intern this now in case it isn't already done.
29233 Setting this variable twice is harmless.
29234 But don't staticpro it here--that is done in alloc.c. */
29235 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29236 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29238 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29239 doc
: /* Char-table defining glyphless characters.
29240 Each element, if non-nil, should be one of the following:
29241 an ASCII acronym string: display this string in a box
29242 `hex-code': display the hexadecimal code of a character in a box
29243 `empty-box': display as an empty box
29244 `thin-space': display as 1-pixel width space
29245 `zero-width': don't display
29246 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29247 display method for graphical terminals and text terminals respectively.
29248 GRAPHICAL and TEXT should each have one of the values listed above.
29250 The char-table has one extra slot to control the display of a character for
29251 which no font is found. This slot only takes effect on graphical terminals.
29252 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29253 `thin-space'. The default is `empty-box'. */);
29254 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29255 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29260 /* Initialize this module when Emacs starts. */
29265 current_header_line_height
= current_mode_line_height
= -1;
29267 CHARPOS (this_line_start_pos
) = 0;
29269 if (!noninteractive
)
29271 struct window
*m
= XWINDOW (minibuf_window
);
29272 Lisp_Object frame
= m
->frame
;
29273 struct frame
*f
= XFRAME (frame
);
29274 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29275 struct window
*r
= XWINDOW (root
);
29278 echo_area_window
= minibuf_window
;
29280 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
29281 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
29282 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
29283 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
29284 XSETFASTINT (m
->total_lines
, 1);
29285 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
29287 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29288 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29289 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29291 /* The default ellipsis glyphs `...'. */
29292 for (i
= 0; i
< 3; ++i
)
29293 default_invis_vector
[i
] = make_number ('.');
29297 /* Allocate the buffer for frame titles.
29298 Also used for `format-mode-line'. */
29300 mode_line_noprop_buf
= xmalloc (size
);
29301 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29302 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29303 mode_line_target
= MODE_LINE_DISPLAY
;
29306 help_echo_showing_p
= 0;
29309 /* Since w32 does not support atimers, it defines its own implementation of
29310 the following three functions in w32fns.c. */
29313 /* Platform-independent portion of hourglass implementation. */
29315 /* Cancel a currently active hourglass timer, and start a new one. */
29317 start_hourglass (void)
29319 #if defined (HAVE_WINDOW_SYSTEM)
29322 cancel_hourglass ();
29324 if (INTEGERP (Vhourglass_delay
)
29325 && XINT (Vhourglass_delay
) > 0)
29326 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29327 TYPE_MAXIMUM (time_t)),
29329 else if (FLOATP (Vhourglass_delay
)
29330 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29331 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29333 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29335 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29336 show_hourglass
, NULL
);
29341 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29344 cancel_hourglass (void)
29346 #if defined (HAVE_WINDOW_SYSTEM)
29347 if (hourglass_atimer
)
29349 cancel_atimer (hourglass_atimer
);
29350 hourglass_atimer
= NULL
;
29353 if (hourglass_shown_p
)
29357 #endif /* ! WINDOWSNT */