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"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT, 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
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 show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
955 static int coords_in_mouse_face_p (struct window
*, int, int);
959 /***********************************************************************
960 Window display dimensions
961 ***********************************************************************/
963 /* Return the bottom boundary y-position for text lines in window W.
964 This is the first y position at which a line cannot start.
965 It is relative to the top of the window.
967 This is the height of W minus the height of a mode line, if any. */
970 window_text_bottom_y (struct window
*w
)
972 int height
= WINDOW_TOTAL_HEIGHT (w
);
974 if (WINDOW_WANTS_MODELINE_P (w
))
975 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
979 /* Return the pixel width of display area AREA of window W. AREA < 0
980 means return the total width of W, not including fringes to
981 the left and right of the window. */
984 window_box_width (struct window
*w
, int area
)
986 int cols
= XFASTINT (w
->total_cols
);
989 if (!w
->pseudo_window_p
)
991 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
993 if (area
== TEXT_AREA
)
995 if (INTEGERP (w
->left_margin_cols
))
996 cols
-= XFASTINT (w
->left_margin_cols
);
997 if (INTEGERP (w
->right_margin_cols
))
998 cols
-= XFASTINT (w
->right_margin_cols
);
999 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1001 else if (area
== LEFT_MARGIN_AREA
)
1003 cols
= (INTEGERP (w
->left_margin_cols
)
1004 ? XFASTINT (w
->left_margin_cols
) : 0);
1007 else if (area
== RIGHT_MARGIN_AREA
)
1009 cols
= (INTEGERP (w
->right_margin_cols
)
1010 ? XFASTINT (w
->right_margin_cols
) : 0);
1015 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1019 /* Return the pixel height of the display area of window W, not
1020 including mode lines of W, if any. */
1023 window_box_height (struct window
*w
)
1025 struct frame
*f
= XFRAME (w
->frame
);
1026 int height
= WINDOW_TOTAL_HEIGHT (w
);
1028 xassert (height
>= 0);
1030 /* Note: the code below that determines the mode-line/header-line
1031 height is essentially the same as that contained in the macro
1032 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1033 the appropriate glyph row has its `mode_line_p' flag set,
1034 and if it doesn't, uses estimate_mode_line_height instead. */
1036 if (WINDOW_WANTS_MODELINE_P (w
))
1038 struct glyph_row
*ml_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1042 if (ml_row
&& ml_row
->mode_line_p
)
1043 height
-= ml_row
->height
;
1045 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1048 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1050 struct glyph_row
*hl_row
1051 = (w
->current_matrix
&& w
->current_matrix
->rows
1052 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1054 if (hl_row
&& hl_row
->mode_line_p
)
1055 height
-= hl_row
->height
;
1057 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1060 /* With a very small font and a mode-line that's taller than
1061 default, we might end up with a negative height. */
1062 return max (0, height
);
1065 /* Return the window-relative coordinate of the left edge of display
1066 area AREA of window W. AREA < 0 means return the left edge of the
1067 whole window, to the right of the left fringe of W. */
1070 window_box_left_offset (struct window
*w
, int area
)
1074 if (w
->pseudo_window_p
)
1077 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1079 if (area
== TEXT_AREA
)
1080 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1081 + window_box_width (w
, LEFT_MARGIN_AREA
));
1082 else if (area
== RIGHT_MARGIN_AREA
)
1083 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1084 + window_box_width (w
, LEFT_MARGIN_AREA
)
1085 + window_box_width (w
, TEXT_AREA
)
1086 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1088 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1089 else if (area
== LEFT_MARGIN_AREA
1090 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1091 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1097 /* Return the window-relative coordinate of the right edge of display
1098 area AREA of window W. AREA < 0 means return the right edge of the
1099 whole window, to the left of the right fringe of W. */
1102 window_box_right_offset (struct window
*w
, int area
)
1104 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1107 /* Return the frame-relative coordinate of the left edge of display
1108 area AREA of window W. AREA < 0 means return the left edge of the
1109 whole window, to the right of the left fringe of W. */
1112 window_box_left (struct window
*w
, int area
)
1114 struct frame
*f
= XFRAME (w
->frame
);
1117 if (w
->pseudo_window_p
)
1118 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1120 x
= (WINDOW_LEFT_EDGE_X (w
)
1121 + window_box_left_offset (w
, area
));
1127 /* Return the frame-relative coordinate of the right edge of display
1128 area AREA of window W. AREA < 0 means return the right edge of the
1129 whole window, to the left of the right fringe of W. */
1132 window_box_right (struct window
*w
, int area
)
1134 return window_box_left (w
, area
) + window_box_width (w
, area
);
1137 /* Get the bounding box of the display area AREA of window W, without
1138 mode lines, in frame-relative coordinates. AREA < 0 means the
1139 whole window, not including the left and right fringes of
1140 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1141 coordinates of the upper-left corner of the box. Return in
1142 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1145 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1146 int *box_width
, int *box_height
)
1149 *box_width
= window_box_width (w
, area
);
1151 *box_height
= window_box_height (w
);
1153 *box_x
= window_box_left (w
, area
);
1156 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1157 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1158 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1163 /* Get the bounding box of the display area AREA of window W, without
1164 mode lines. AREA < 0 means the whole window, not including the
1165 left and right fringe of the window. Return in *TOP_LEFT_X
1166 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1167 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1168 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1172 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1173 int *bottom_right_x
, int *bottom_right_y
)
1175 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1177 *bottom_right_x
+= *top_left_x
;
1178 *bottom_right_y
+= *top_left_y
;
1183 /***********************************************************************
1185 ***********************************************************************/
1187 /* Return the bottom y-position of the line the iterator IT is in.
1188 This can modify IT's settings. */
1191 line_bottom_y (struct it
*it
)
1193 int line_height
= it
->max_ascent
+ it
->max_descent
;
1194 int line_top_y
= it
->current_y
;
1196 if (line_height
== 0)
1199 line_height
= last_height
;
1200 else if (IT_CHARPOS (*it
) < ZV
)
1202 move_it_by_lines (it
, 1);
1203 line_height
= (it
->max_ascent
|| it
->max_descent
1204 ? it
->max_ascent
+ it
->max_descent
1209 struct glyph_row
*row
= it
->glyph_row
;
1211 /* Use the default character height. */
1212 it
->glyph_row
= NULL
;
1213 it
->what
= IT_CHARACTER
;
1216 PRODUCE_GLYPHS (it
);
1217 line_height
= it
->ascent
+ it
->descent
;
1218 it
->glyph_row
= row
;
1222 return line_top_y
+ line_height
;
1225 /* Subroutine of pos_visible_p below. Extracts a display string, if
1226 any, from the display spec given as its argument. */
1228 string_from_display_spec (Lisp_Object spec
)
1232 while (CONSP (spec
))
1234 if (STRINGP (XCAR (spec
)))
1239 else if (VECTORP (spec
))
1243 for (i
= 0; i
< ASIZE (spec
); i
++)
1245 if (STRINGP (AREF (spec
, i
)))
1246 return AREF (spec
, i
);
1254 /* Return 1 if position CHARPOS is visible in window W.
1255 CHARPOS < 0 means return info about WINDOW_END position.
1256 If visible, set *X and *Y to pixel coordinates of top left corner.
1257 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1258 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1261 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1262 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1265 void *itdata
= bidi_shelve_cache ();
1266 struct text_pos top
;
1268 struct buffer
*old_buffer
= NULL
;
1270 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1273 if (XBUFFER (w
->buffer
) != current_buffer
)
1275 old_buffer
= current_buffer
;
1276 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1279 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1280 /* Scrolling a minibuffer window via scroll bar when the echo area
1281 shows long text sometimes resets the minibuffer contents behind
1283 if (CHARPOS (top
) > ZV
)
1284 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1286 /* Compute exact mode line heights. */
1287 if (WINDOW_WANTS_MODELINE_P (w
))
1288 current_mode_line_height
1289 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1290 BVAR (current_buffer
, mode_line_format
));
1292 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1293 current_header_line_height
1294 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1295 BVAR (current_buffer
, header_line_format
));
1297 start_display (&it
, w
, top
);
1298 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1299 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1302 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1303 && IT_CHARPOS (it
) >= charpos
)
1304 /* When scanning backwards under bidi iteration, move_it_to
1305 stops at or _before_ CHARPOS, because it stops at or to
1306 the _right_ of the character at CHARPOS. */
1307 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1308 && IT_CHARPOS (it
) <= charpos
)))
1310 /* We have reached CHARPOS, or passed it. How the call to
1311 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1312 or covered by a display property, move_it_to stops at the end
1313 of the invisible text, to the right of CHARPOS. (ii) If
1314 CHARPOS is in a display vector, move_it_to stops on its last
1316 int top_x
= it
.current_x
;
1317 int top_y
= it
.current_y
;
1318 /* Calling line_bottom_y may change it.method, it.position, etc. */
1319 enum it_method it_method
= it
.method
;
1320 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1321 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1323 if (top_y
< window_top_y
)
1324 visible_p
= bottom_y
> window_top_y
;
1325 else if (top_y
< it
.last_visible_y
)
1327 if (bottom_y
>= it
.last_visible_y
1328 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1329 && IT_CHARPOS (it
) < charpos
)
1331 /* When the last line of the window is scanned backwards
1332 under bidi iteration, we could be duped into thinking
1333 that we have passed CHARPOS, when in fact move_it_to
1334 simply stopped short of CHARPOS because it reached
1335 last_visible_y. To see if that's what happened, we call
1336 move_it_to again with a slightly larger vertical limit,
1337 and see if it actually moved vertically; if it did, we
1338 didn't really reach CHARPOS, which is beyond window end. */
1339 struct it save_it
= it
;
1340 /* Why 10? because we don't know how many canonical lines
1341 will the height of the next line(s) be. So we guess. */
1342 int ten_more_lines
=
1343 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1345 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1346 MOVE_TO_POS
| MOVE_TO_Y
);
1347 if (it
.current_y
> top_y
)
1354 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1356 /* We stopped on the last glyph of a display vector.
1357 Try and recompute. Hack alert! */
1358 if (charpos
< 2 || top
.charpos
>= charpos
)
1359 top_x
= it
.glyph_row
->x
;
1363 start_display (&it2
, w
, top
);
1364 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1365 get_next_display_element (&it2
);
1366 PRODUCE_GLYPHS (&it2
);
1367 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1368 || it2
.current_x
> it2
.last_visible_x
)
1369 top_x
= it
.glyph_row
->x
;
1372 top_x
= it2
.current_x
;
1373 top_y
= it2
.current_y
;
1377 else if (IT_CHARPOS (it
) != charpos
)
1379 Lisp_Object cpos
= make_number (charpos
);
1380 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1381 Lisp_Object string
= string_from_display_spec (spec
);
1382 int newline_in_string
= 0;
1384 if (STRINGP (string
))
1386 const char *s
= SSDATA (string
);
1387 const char *e
= s
+ SBYTES (string
);
1392 newline_in_string
= 1;
1397 /* The tricky code below is needed because there's a
1398 discrepancy between move_it_to and how we set cursor
1399 when the display line ends in a newline from a
1400 display string. move_it_to will stop _after_ such
1401 display strings, whereas set_cursor_from_row
1402 conspires with cursor_row_p to place the cursor on
1403 the first glyph produced from the display string. */
1405 /* We have overshoot PT because it is covered by a
1406 display property whose value is a string. If the
1407 string includes embedded newlines, we are also in the
1408 wrong display line. Backtrack to the correct line,
1409 where the display string begins. */
1410 if (newline_in_string
)
1412 Lisp_Object startpos
, endpos
;
1413 EMACS_INT start
, end
;
1417 /* Find the first and the last buffer positions
1418 covered by the display string. */
1420 Fnext_single_char_property_change (cpos
, Qdisplay
,
1423 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1425 start
= XFASTINT (startpos
);
1426 end
= XFASTINT (endpos
);
1427 /* Move to the last buffer position before the
1428 display property. */
1429 start_display (&it3
, w
, top
);
1430 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1431 /* Move forward one more line if the position before
1432 the display string is a newline or if it is the
1433 rightmost character on a line that is
1434 continued or word-wrapped. */
1435 if (it3
.method
== GET_FROM_BUFFER
1437 move_it_by_lines (&it3
, 1);
1438 else if (move_it_in_display_line_to (&it3
, -1,
1442 == MOVE_LINE_CONTINUED
)
1444 move_it_by_lines (&it3
, 1);
1445 /* When we are under word-wrap, the #$@%!
1446 move_it_by_lines moves 2 lines, so we need to
1448 if (it3
.line_wrap
== WORD_WRAP
)
1449 move_it_by_lines (&it3
, -1);
1452 /* Record the vertical coordinate of the display
1453 line where we wound up. */
1454 top_y
= it3
.current_y
;
1457 /* When characters are reordered for display,
1458 the character displayed to the left of the
1459 display string could be _after_ the display
1460 property in the logical order. Use the
1461 smallest vertical position of these two. */
1462 start_display (&it3
, w
, top
);
1463 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1464 if (it3
.current_y
< top_y
)
1465 top_y
= it3
.current_y
;
1467 /* Move from the top of the window to the beginning
1468 of the display line where the display string
1470 start_display (&it3
, w
, top
);
1471 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1472 /* If it3_moved stays zero after the 'while' loop
1473 below, that means we already were at a newline
1474 before the loop (e.g., the display string begins
1475 with a newline), so we don't need to (and cannot)
1476 inspect the glyphs of it3.glyph_row, because
1477 PRODUCE_GLYPHS will not produce anything for a
1478 newline, and thus it3.glyph_row stays at its
1479 stale content it got at top of the window. */
1481 /* Finally, advance the iterator until we hit the
1482 first display element whose character position is
1483 CHARPOS, or until the first newline from the
1484 display string, which signals the end of the
1486 while (get_next_display_element (&it3
))
1488 PRODUCE_GLYPHS (&it3
);
1489 if (IT_CHARPOS (it3
) == charpos
1490 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1493 set_iterator_to_next (&it3
, 0);
1495 top_x
= it3
.current_x
- it3
.pixel_width
;
1496 /* Normally, we would exit the above loop because we
1497 found the display element whose character
1498 position is CHARPOS. For the contingency that we
1499 didn't, and stopped at the first newline from the
1500 display string, move back over the glyphs
1501 produced from the string, until we find the
1502 rightmost glyph not from the string. */
1504 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1506 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1507 + it3
.glyph_row
->used
[TEXT_AREA
];
1509 while (EQ ((g
- 1)->object
, string
))
1512 top_x
-= g
->pixel_width
;
1514 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1515 + it3
.glyph_row
->used
[TEXT_AREA
]);
1521 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1522 *rtop
= max (0, window_top_y
- top_y
);
1523 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1524 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1525 - max (top_y
, window_top_y
)));
1531 /* We were asked to provide info about WINDOW_END. */
1533 void *it2data
= NULL
;
1535 SAVE_IT (it2
, it
, it2data
);
1536 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1537 move_it_by_lines (&it
, 1);
1538 if (charpos
< IT_CHARPOS (it
)
1539 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1542 RESTORE_IT (&it2
, &it2
, it2data
);
1543 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1545 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1546 *rtop
= max (0, -it2
.current_y
);
1547 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1548 - it
.last_visible_y
));
1549 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1551 - max (it2
.current_y
,
1552 WINDOW_HEADER_LINE_HEIGHT (w
))));
1556 bidi_unshelve_cache (it2data
, 1);
1558 bidi_unshelve_cache (itdata
, 0);
1561 set_buffer_internal_1 (old_buffer
);
1563 current_header_line_height
= current_mode_line_height
= -1;
1565 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1566 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1569 /* Debugging code. */
1571 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1572 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1574 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1581 /* Return the next character from STR. Return in *LEN the length of
1582 the character. This is like STRING_CHAR_AND_LENGTH but never
1583 returns an invalid character. If we find one, we return a `?', but
1584 with the length of the invalid character. */
1587 string_char_and_length (const unsigned char *str
, int *len
)
1591 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1592 if (!CHAR_VALID_P (c
))
1593 /* We may not change the length here because other places in Emacs
1594 don't use this function, i.e. they silently accept invalid
1603 /* Given a position POS containing a valid character and byte position
1604 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1606 static struct text_pos
1607 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1609 xassert (STRINGP (string
) && nchars
>= 0);
1611 if (STRING_MULTIBYTE (string
))
1613 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1618 string_char_and_length (p
, &len
);
1621 BYTEPOS (pos
) += len
;
1625 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1631 /* Value is the text position, i.e. character and byte position,
1632 for character position CHARPOS in STRING. */
1634 static inline struct text_pos
1635 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1637 struct text_pos pos
;
1638 xassert (STRINGP (string
));
1639 xassert (charpos
>= 0);
1640 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1645 /* Value is a text position, i.e. character and byte position, for
1646 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1647 means recognize multibyte characters. */
1649 static struct text_pos
1650 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1652 struct text_pos pos
;
1654 xassert (s
!= NULL
);
1655 xassert (charpos
>= 0);
1661 SET_TEXT_POS (pos
, 0, 0);
1664 string_char_and_length ((const unsigned char *) s
, &len
);
1667 BYTEPOS (pos
) += len
;
1671 SET_TEXT_POS (pos
, charpos
, charpos
);
1677 /* Value is the number of characters in C string S. MULTIBYTE_P
1678 non-zero means recognize multibyte characters. */
1681 number_of_chars (const char *s
, int multibyte_p
)
1687 ptrdiff_t rest
= strlen (s
);
1689 const unsigned char *p
= (const unsigned char *) s
;
1691 for (nchars
= 0; rest
> 0; ++nchars
)
1693 string_char_and_length (p
, &len
);
1694 rest
-= len
, p
+= len
;
1698 nchars
= strlen (s
);
1704 /* Compute byte position NEWPOS->bytepos corresponding to
1705 NEWPOS->charpos. POS is a known position in string STRING.
1706 NEWPOS->charpos must be >= POS.charpos. */
1709 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1711 xassert (STRINGP (string
));
1712 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1714 if (STRING_MULTIBYTE (string
))
1715 *newpos
= string_pos_nchars_ahead (pos
, string
,
1716 CHARPOS (*newpos
) - CHARPOS (pos
));
1718 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1722 Return an estimation of the pixel height of mode or header lines on
1723 frame F. FACE_ID specifies what line's height to estimate. */
1726 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1728 #ifdef HAVE_WINDOW_SYSTEM
1729 if (FRAME_WINDOW_P (f
))
1731 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1733 /* This function is called so early when Emacs starts that the face
1734 cache and mode line face are not yet initialized. */
1735 if (FRAME_FACE_CACHE (f
))
1737 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1741 height
= FONT_HEIGHT (face
->font
);
1742 if (face
->box_line_width
> 0)
1743 height
+= 2 * face
->box_line_width
;
1754 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1755 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1756 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1757 not force the value into range. */
1760 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1761 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1764 #ifdef HAVE_WINDOW_SYSTEM
1765 if (FRAME_WINDOW_P (f
))
1767 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1768 even for negative values. */
1770 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1772 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1774 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1775 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1778 STORE_NATIVE_RECT (*bounds
,
1779 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1780 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1781 FRAME_COLUMN_WIDTH (f
) - 1,
1782 FRAME_LINE_HEIGHT (f
) - 1);
1788 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1789 pix_x
= FRAME_TOTAL_COLS (f
);
1793 else if (pix_y
> FRAME_LINES (f
))
1794 pix_y
= FRAME_LINES (f
);
1804 /* Find the glyph under window-relative coordinates X/Y in window W.
1805 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1806 strings. Return in *HPOS and *VPOS the row and column number of
1807 the glyph found. Return in *AREA the glyph area containing X.
1808 Value is a pointer to the glyph found or null if X/Y is not on
1809 text, or we can't tell because W's current matrix is not up to
1814 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1815 int *dx
, int *dy
, int *area
)
1817 struct glyph
*glyph
, *end
;
1818 struct glyph_row
*row
= NULL
;
1821 /* Find row containing Y. Give up if some row is not enabled. */
1822 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1824 row
= MATRIX_ROW (w
->current_matrix
, i
);
1825 if (!row
->enabled_p
)
1827 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1834 /* Give up if Y is not in the window. */
1835 if (i
== w
->current_matrix
->nrows
)
1838 /* Get the glyph area containing X. */
1839 if (w
->pseudo_window_p
)
1846 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1848 *area
= LEFT_MARGIN_AREA
;
1849 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1851 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1854 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1858 *area
= RIGHT_MARGIN_AREA
;
1859 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1863 /* Find glyph containing X. */
1864 glyph
= row
->glyphs
[*area
];
1865 end
= glyph
+ row
->used
[*area
];
1867 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1869 x
-= glyph
->pixel_width
;
1879 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1882 *hpos
= glyph
- row
->glyphs
[*area
];
1886 /* Convert frame-relative x/y to coordinates relative to window W.
1887 Takes pseudo-windows into account. */
1890 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1892 if (w
->pseudo_window_p
)
1894 /* A pseudo-window is always full-width, and starts at the
1895 left edge of the frame, plus a frame border. */
1896 struct frame
*f
= XFRAME (w
->frame
);
1897 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1898 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1902 *x
-= WINDOW_LEFT_EDGE_X (w
);
1903 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1907 #ifdef HAVE_WINDOW_SYSTEM
1910 Return in RECTS[] at most N clipping rectangles for glyph string S.
1911 Return the number of stored rectangles. */
1914 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1921 if (s
->row
->full_width_p
)
1923 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1924 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1925 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1927 /* Unless displaying a mode or menu bar line, which are always
1928 fully visible, clip to the visible part of the row. */
1929 if (s
->w
->pseudo_window_p
)
1930 r
.height
= s
->row
->visible_height
;
1932 r
.height
= s
->height
;
1936 /* This is a text line that may be partially visible. */
1937 r
.x
= window_box_left (s
->w
, s
->area
);
1938 r
.width
= window_box_width (s
->w
, s
->area
);
1939 r
.height
= s
->row
->visible_height
;
1943 if (r
.x
< s
->clip_head
->x
)
1945 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1946 r
.width
-= s
->clip_head
->x
- r
.x
;
1949 r
.x
= s
->clip_head
->x
;
1952 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1954 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1955 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1960 /* If S draws overlapping rows, it's sufficient to use the top and
1961 bottom of the window for clipping because this glyph string
1962 intentionally draws over other lines. */
1963 if (s
->for_overlaps
)
1965 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1966 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1968 /* Alas, the above simple strategy does not work for the
1969 environments with anti-aliased text: if the same text is
1970 drawn onto the same place multiple times, it gets thicker.
1971 If the overlap we are processing is for the erased cursor, we
1972 take the intersection with the rectangle of the cursor. */
1973 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1975 XRectangle rc
, r_save
= r
;
1977 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1978 rc
.y
= s
->w
->phys_cursor
.y
;
1979 rc
.width
= s
->w
->phys_cursor_width
;
1980 rc
.height
= s
->w
->phys_cursor_height
;
1982 x_intersect_rectangles (&r_save
, &rc
, &r
);
1987 /* Don't use S->y for clipping because it doesn't take partially
1988 visible lines into account. For example, it can be negative for
1989 partially visible lines at the top of a window. */
1990 if (!s
->row
->full_width_p
1991 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1992 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1994 r
.y
= max (0, s
->row
->y
);
1997 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1999 /* If drawing the cursor, don't let glyph draw outside its
2000 advertised boundaries. Cleartype does this under some circumstances. */
2001 if (s
->hl
== DRAW_CURSOR
)
2003 struct glyph
*glyph
= s
->first_glyph
;
2008 r
.width
-= s
->x
- r
.x
;
2011 r
.width
= min (r
.width
, glyph
->pixel_width
);
2013 /* If r.y is below window bottom, ensure that we still see a cursor. */
2014 height
= min (glyph
->ascent
+ glyph
->descent
,
2015 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2016 max_y
= window_text_bottom_y (s
->w
) - height
;
2017 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2018 if (s
->ybase
- glyph
->ascent
> max_y
)
2025 /* Don't draw cursor glyph taller than our actual glyph. */
2026 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2027 if (height
< r
.height
)
2029 max_y
= r
.y
+ r
.height
;
2030 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2031 r
.height
= min (max_y
- r
.y
, height
);
2038 XRectangle r_save
= r
;
2040 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2044 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2045 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2047 #ifdef CONVERT_FROM_XRECT
2048 CONVERT_FROM_XRECT (r
, *rects
);
2056 /* If we are processing overlapping and allowed to return
2057 multiple clipping rectangles, we exclude the row of the glyph
2058 string from the clipping rectangle. This is to avoid drawing
2059 the same text on the environment with anti-aliasing. */
2060 #ifdef CONVERT_FROM_XRECT
2063 XRectangle
*rs
= rects
;
2065 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2067 if (s
->for_overlaps
& OVERLAPS_PRED
)
2070 if (r
.y
+ r
.height
> row_y
)
2073 rs
[i
].height
= row_y
- r
.y
;
2079 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2082 if (r
.y
< row_y
+ s
->row
->visible_height
)
2084 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2086 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2087 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2096 #ifdef CONVERT_FROM_XRECT
2097 for (i
= 0; i
< n
; i
++)
2098 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2105 Return in *NR the clipping rectangle for glyph string S. */
2108 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2110 get_glyph_string_clip_rects (s
, nr
, 1);
2115 Return the position and height of the phys cursor in window W.
2116 Set w->phys_cursor_width to width of phys cursor.
2120 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2121 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2123 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2124 int x
, y
, wd
, h
, h0
, y0
;
2126 /* Compute the width of the rectangle to draw. If on a stretch
2127 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2128 rectangle as wide as the glyph, but use a canonical character
2130 wd
= glyph
->pixel_width
- 1;
2131 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2135 x
= w
->phys_cursor
.x
;
2142 if (glyph
->type
== STRETCH_GLYPH
2143 && !x_stretch_cursor_p
)
2144 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2145 w
->phys_cursor_width
= wd
;
2147 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2149 /* If y is below window bottom, ensure that we still see a cursor. */
2150 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2152 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2153 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2155 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2158 h
= max (h
- (y0
- y
) + 1, h0
);
2163 y0
= window_text_bottom_y (w
) - h0
;
2171 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2172 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2177 * Remember which glyph the mouse is over.
2181 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2185 struct glyph_row
*r
, *gr
, *end_row
;
2186 enum window_part part
;
2187 enum glyph_row_area area
;
2188 int x
, y
, width
, height
;
2190 /* Try to determine frame pixel position and size of the glyph under
2191 frame pixel coordinates X/Y on frame F. */
2193 if (!f
->glyphs_initialized_p
2194 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2197 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2198 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2202 w
= XWINDOW (window
);
2203 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2204 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2206 x
= window_relative_x_coord (w
, part
, gx
);
2207 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2209 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2210 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2212 if (w
->pseudo_window_p
)
2215 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2221 case ON_LEFT_MARGIN
:
2222 area
= LEFT_MARGIN_AREA
;
2225 case ON_RIGHT_MARGIN
:
2226 area
= RIGHT_MARGIN_AREA
;
2229 case ON_HEADER_LINE
:
2231 gr
= (part
== ON_HEADER_LINE
2232 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2233 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2236 goto text_glyph_row_found
;
2243 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2244 if (r
->y
+ r
->height
> y
)
2250 text_glyph_row_found
:
2253 struct glyph
*g
= gr
->glyphs
[area
];
2254 struct glyph
*end
= g
+ gr
->used
[area
];
2256 height
= gr
->height
;
2257 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2258 if (gx
+ g
->pixel_width
> x
)
2263 if (g
->type
== IMAGE_GLYPH
)
2265 /* Don't remember when mouse is over image, as
2266 image may have hot-spots. */
2267 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2270 width
= g
->pixel_width
;
2274 /* Use nominal char spacing at end of line. */
2276 gx
+= (x
/ width
) * width
;
2279 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2280 gx
+= window_box_left_offset (w
, area
);
2284 /* Use nominal line height at end of window. */
2285 gx
= (x
/ width
) * width
;
2287 gy
+= (y
/ height
) * height
;
2291 case ON_LEFT_FRINGE
:
2292 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2293 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2294 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2295 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2298 case ON_RIGHT_FRINGE
:
2299 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2300 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2301 : window_box_right_offset (w
, TEXT_AREA
));
2302 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2306 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2308 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2309 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2310 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2312 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2316 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2317 if (r
->y
+ r
->height
> y
)
2324 height
= gr
->height
;
2327 /* Use nominal line height at end of window. */
2329 gy
+= (y
/ height
) * height
;
2336 /* If there is no glyph under the mouse, then we divide the screen
2337 into a grid of the smallest glyph in the frame, and use that
2340 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2341 round down even for negative values. */
2347 gx
= (gx
/ width
) * width
;
2348 gy
= (gy
/ height
) * height
;
2353 gx
+= WINDOW_LEFT_EDGE_X (w
);
2354 gy
+= WINDOW_TOP_EDGE_Y (w
);
2357 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2359 /* Visible feedback for debugging. */
2362 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2363 f
->output_data
.x
->normal_gc
,
2364 gx
, gy
, width
, height
);
2370 #endif /* HAVE_WINDOW_SYSTEM */
2373 /***********************************************************************
2374 Lisp form evaluation
2375 ***********************************************************************/
2377 /* Error handler for safe_eval and safe_call. */
2380 safe_eval_handler (Lisp_Object arg
)
2382 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2387 /* Evaluate SEXPR and return the result, or nil if something went
2388 wrong. Prevent redisplay during the evaluation. */
2390 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2391 Return the result, or nil if something went wrong. Prevent
2392 redisplay during the evaluation. */
2395 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2399 if (inhibit_eval_during_redisplay
)
2403 ptrdiff_t count
= SPECPDL_INDEX ();
2404 struct gcpro gcpro1
;
2407 gcpro1
.nvars
= nargs
;
2408 specbind (Qinhibit_redisplay
, Qt
);
2409 /* Use Qt to ensure debugger does not run,
2410 so there is no possibility of wanting to redisplay. */
2411 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2414 val
= unbind_to (count
, val
);
2421 /* Call function FN with one argument ARG.
2422 Return the result, or nil if something went wrong. */
2425 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2427 Lisp_Object args
[2];
2430 return safe_call (2, args
);
2433 static Lisp_Object Qeval
;
2436 safe_eval (Lisp_Object sexpr
)
2438 return safe_call1 (Qeval
, sexpr
);
2441 /* Call function FN with one argument ARG.
2442 Return the result, or nil if something went wrong. */
2445 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2447 Lisp_Object args
[3];
2451 return safe_call (3, args
);
2456 /***********************************************************************
2458 ***********************************************************************/
2462 /* Define CHECK_IT to perform sanity checks on iterators.
2463 This is for debugging. It is too slow to do unconditionally. */
2466 check_it (struct it
*it
)
2468 if (it
->method
== GET_FROM_STRING
)
2470 xassert (STRINGP (it
->string
));
2471 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2475 xassert (IT_STRING_CHARPOS (*it
) < 0);
2476 if (it
->method
== GET_FROM_BUFFER
)
2478 /* Check that character and byte positions agree. */
2479 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2484 xassert (it
->current
.dpvec_index
>= 0);
2486 xassert (it
->current
.dpvec_index
< 0);
2489 #define CHECK_IT(IT) check_it ((IT))
2493 #define CHECK_IT(IT) (void) 0
2498 #if GLYPH_DEBUG && XASSERTS
2500 /* Check that the window end of window W is what we expect it
2501 to be---the last row in the current matrix displaying text. */
2504 check_window_end (struct window
*w
)
2506 if (!MINI_WINDOW_P (w
)
2507 && !NILP (w
->window_end_valid
))
2509 struct glyph_row
*row
;
2510 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2511 XFASTINT (w
->window_end_vpos
)),
2513 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2514 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2518 #define CHECK_WINDOW_END(W) check_window_end ((W))
2522 #define CHECK_WINDOW_END(W) (void) 0
2528 /***********************************************************************
2529 Iterator initialization
2530 ***********************************************************************/
2532 /* Initialize IT for displaying current_buffer in window W, starting
2533 at character position CHARPOS. CHARPOS < 0 means that no buffer
2534 position is specified which is useful when the iterator is assigned
2535 a position later. BYTEPOS is the byte position corresponding to
2536 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2538 If ROW is not null, calls to produce_glyphs with IT as parameter
2539 will produce glyphs in that row.
2541 BASE_FACE_ID is the id of a base face to use. It must be one of
2542 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2543 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2544 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2546 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2547 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2548 will be initialized to use the corresponding mode line glyph row of
2549 the desired matrix of W. */
2552 init_iterator (struct it
*it
, struct window
*w
,
2553 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2554 struct glyph_row
*row
, enum face_id base_face_id
)
2556 int highlight_region_p
;
2557 enum face_id remapped_base_face_id
= base_face_id
;
2559 /* Some precondition checks. */
2560 xassert (w
!= NULL
&& it
!= NULL
);
2561 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2564 /* If face attributes have been changed since the last redisplay,
2565 free realized faces now because they depend on face definitions
2566 that might have changed. Don't free faces while there might be
2567 desired matrices pending which reference these faces. */
2568 if (face_change_count
&& !inhibit_free_realized_faces
)
2570 face_change_count
= 0;
2571 free_all_realized_faces (Qnil
);
2574 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2575 if (! NILP (Vface_remapping_alist
))
2576 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2578 /* Use one of the mode line rows of W's desired matrix if
2582 if (base_face_id
== MODE_LINE_FACE_ID
2583 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2584 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2585 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2586 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2590 memset (it
, 0, sizeof *it
);
2591 it
->current
.overlay_string_index
= -1;
2592 it
->current
.dpvec_index
= -1;
2593 it
->base_face_id
= remapped_base_face_id
;
2595 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2596 it
->paragraph_embedding
= L2R
;
2597 it
->bidi_it
.string
.lstring
= Qnil
;
2598 it
->bidi_it
.string
.s
= NULL
;
2599 it
->bidi_it
.string
.bufpos
= 0;
2601 /* The window in which we iterate over current_buffer: */
2602 XSETWINDOW (it
->window
, w
);
2604 it
->f
= XFRAME (w
->frame
);
2608 /* Extra space between lines (on window systems only). */
2609 if (base_face_id
== DEFAULT_FACE_ID
2610 && FRAME_WINDOW_P (it
->f
))
2612 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2613 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2614 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2615 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2616 * FRAME_LINE_HEIGHT (it
->f
));
2617 else if (it
->f
->extra_line_spacing
> 0)
2618 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2619 it
->max_extra_line_spacing
= 0;
2622 /* If realized faces have been removed, e.g. because of face
2623 attribute changes of named faces, recompute them. When running
2624 in batch mode, the face cache of the initial frame is null. If
2625 we happen to get called, make a dummy face cache. */
2626 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2627 init_frame_faces (it
->f
);
2628 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2629 recompute_basic_faces (it
->f
);
2631 /* Current value of the `slice', `space-width', and 'height' properties. */
2632 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2633 it
->space_width
= Qnil
;
2634 it
->font_height
= Qnil
;
2635 it
->override_ascent
= -1;
2637 /* Are control characters displayed as `^C'? */
2638 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2640 /* -1 means everything between a CR and the following line end
2641 is invisible. >0 means lines indented more than this value are
2643 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2644 ? clip_to_bounds (-1, XINT (BVAR (current_buffer
,
2645 selective_display
)),
2647 : (!NILP (BVAR (current_buffer
, selective_display
))
2649 it
->selective_display_ellipsis_p
2650 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2652 /* Display table to use. */
2653 it
->dp
= window_display_table (w
);
2655 /* Are multibyte characters enabled in current_buffer? */
2656 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2658 /* Non-zero if we should highlight the region. */
2660 = (!NILP (Vtransient_mark_mode
)
2661 && !NILP (BVAR (current_buffer
, mark_active
))
2662 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2664 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2665 start and end of a visible region in window IT->w. Set both to
2666 -1 to indicate no region. */
2667 if (highlight_region_p
2668 /* Maybe highlight only in selected window. */
2669 && (/* Either show region everywhere. */
2670 highlight_nonselected_windows
2671 /* Or show region in the selected window. */
2672 || w
== XWINDOW (selected_window
)
2673 /* Or show the region if we are in the mini-buffer and W is
2674 the window the mini-buffer refers to. */
2675 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2676 && WINDOWP (minibuf_selected_window
)
2677 && w
== XWINDOW (minibuf_selected_window
))))
2679 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2680 it
->region_beg_charpos
= min (PT
, markpos
);
2681 it
->region_end_charpos
= max (PT
, markpos
);
2684 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2686 /* Get the position at which the redisplay_end_trigger hook should
2687 be run, if it is to be run at all. */
2688 if (MARKERP (w
->redisplay_end_trigger
)
2689 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2690 it
->redisplay_end_trigger_charpos
2691 = marker_position (w
->redisplay_end_trigger
);
2692 else if (INTEGERP (w
->redisplay_end_trigger
))
2693 it
->redisplay_end_trigger_charpos
=
2694 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2696 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2698 /* Are lines in the display truncated? */
2699 if (base_face_id
!= DEFAULT_FACE_ID
2700 || XINT (it
->w
->hscroll
)
2701 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2702 && ((!NILP (Vtruncate_partial_width_windows
)
2703 && !INTEGERP (Vtruncate_partial_width_windows
))
2704 || (INTEGERP (Vtruncate_partial_width_windows
)
2705 && (WINDOW_TOTAL_COLS (it
->w
)
2706 < XINT (Vtruncate_partial_width_windows
))))))
2707 it
->line_wrap
= TRUNCATE
;
2708 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2709 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2710 ? WINDOW_WRAP
: WORD_WRAP
;
2712 it
->line_wrap
= TRUNCATE
;
2714 /* Get dimensions of truncation and continuation glyphs. These are
2715 displayed as fringe bitmaps under X, so we don't need them for such
2717 if (!FRAME_WINDOW_P (it
->f
))
2719 if (it
->line_wrap
== TRUNCATE
)
2721 /* We will need the truncation glyph. */
2722 xassert (it
->glyph_row
== NULL
);
2723 produce_special_glyphs (it
, IT_TRUNCATION
);
2724 it
->truncation_pixel_width
= it
->pixel_width
;
2728 /* We will need the continuation glyph. */
2729 xassert (it
->glyph_row
== NULL
);
2730 produce_special_glyphs (it
, IT_CONTINUATION
);
2731 it
->continuation_pixel_width
= it
->pixel_width
;
2734 /* Reset these values to zero because the produce_special_glyphs
2735 above has changed them. */
2736 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2737 it
->phys_ascent
= it
->phys_descent
= 0;
2740 /* Set this after getting the dimensions of truncation and
2741 continuation glyphs, so that we don't produce glyphs when calling
2742 produce_special_glyphs, above. */
2743 it
->glyph_row
= row
;
2744 it
->area
= TEXT_AREA
;
2746 /* Forget any previous info about this row being reversed. */
2748 it
->glyph_row
->reversed_p
= 0;
2750 /* Get the dimensions of the display area. The display area
2751 consists of the visible window area plus a horizontally scrolled
2752 part to the left of the window. All x-values are relative to the
2753 start of this total display area. */
2754 if (base_face_id
!= DEFAULT_FACE_ID
)
2756 /* Mode lines, menu bar in terminal frames. */
2757 it
->first_visible_x
= 0;
2758 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2763 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2764 it
->last_visible_x
= (it
->first_visible_x
2765 + window_box_width (w
, TEXT_AREA
));
2767 /* If we truncate lines, leave room for the truncator glyph(s) at
2768 the right margin. Otherwise, leave room for the continuation
2769 glyph(s). Truncation and continuation glyphs are not inserted
2770 for window-based redisplay. */
2771 if (!FRAME_WINDOW_P (it
->f
))
2773 if (it
->line_wrap
== TRUNCATE
)
2774 it
->last_visible_x
-= it
->truncation_pixel_width
;
2776 it
->last_visible_x
-= it
->continuation_pixel_width
;
2779 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2780 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2783 /* Leave room for a border glyph. */
2784 if (!FRAME_WINDOW_P (it
->f
)
2785 && !WINDOW_RIGHTMOST_P (it
->w
))
2786 it
->last_visible_x
-= 1;
2788 it
->last_visible_y
= window_text_bottom_y (w
);
2790 /* For mode lines and alike, arrange for the first glyph having a
2791 left box line if the face specifies a box. */
2792 if (base_face_id
!= DEFAULT_FACE_ID
)
2796 it
->face_id
= remapped_base_face_id
;
2798 /* If we have a boxed mode line, make the first character appear
2799 with a left box line. */
2800 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2801 if (face
->box
!= FACE_NO_BOX
)
2802 it
->start_of_box_run_p
= 1;
2805 /* If a buffer position was specified, set the iterator there,
2806 getting overlays and face properties from that position. */
2807 if (charpos
>= BUF_BEG (current_buffer
))
2809 it
->end_charpos
= ZV
;
2810 IT_CHARPOS (*it
) = charpos
;
2812 /* We will rely on `reseat' to set this up properly, via
2813 handle_face_prop. */
2814 it
->face_id
= it
->base_face_id
;
2816 /* Compute byte position if not specified. */
2817 if (bytepos
< charpos
)
2818 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2820 IT_BYTEPOS (*it
) = bytepos
;
2822 it
->start
= it
->current
;
2823 /* Do we need to reorder bidirectional text? Not if this is a
2824 unibyte buffer: by definition, none of the single-byte
2825 characters are strong R2L, so no reordering is needed. And
2826 bidi.c doesn't support unibyte buffers anyway. Also, don't
2827 reorder while we are loading loadup.el, since the tables of
2828 character properties needed for reordering are not yet
2832 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2835 /* If we are to reorder bidirectional text, init the bidi
2839 /* Note the paragraph direction that this buffer wants to
2841 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2843 it
->paragraph_embedding
= L2R
;
2844 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2846 it
->paragraph_embedding
= R2L
;
2848 it
->paragraph_embedding
= NEUTRAL_DIR
;
2849 bidi_unshelve_cache (NULL
, 0);
2850 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2854 /* Compute faces etc. */
2855 reseat (it
, it
->current
.pos
, 1);
2862 /* Initialize IT for the display of window W with window start POS. */
2865 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2867 struct glyph_row
*row
;
2868 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2870 row
= w
->desired_matrix
->rows
+ first_vpos
;
2871 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2872 it
->first_vpos
= first_vpos
;
2874 /* Don't reseat to previous visible line start if current start
2875 position is in a string or image. */
2876 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2878 int start_at_line_beg_p
;
2879 int first_y
= it
->current_y
;
2881 /* If window start is not at a line start, skip forward to POS to
2882 get the correct continuation lines width. */
2883 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2884 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2885 if (!start_at_line_beg_p
)
2889 reseat_at_previous_visible_line_start (it
);
2890 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2892 new_x
= it
->current_x
+ it
->pixel_width
;
2894 /* If lines are continued, this line may end in the middle
2895 of a multi-glyph character (e.g. a control character
2896 displayed as \003, or in the middle of an overlay
2897 string). In this case move_it_to above will not have
2898 taken us to the start of the continuation line but to the
2899 end of the continued line. */
2900 if (it
->current_x
> 0
2901 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2902 && (/* And glyph doesn't fit on the line. */
2903 new_x
> it
->last_visible_x
2904 /* Or it fits exactly and we're on a window
2906 || (new_x
== it
->last_visible_x
2907 && FRAME_WINDOW_P (it
->f
))))
2909 if ((it
->current
.dpvec_index
>= 0
2910 || it
->current
.overlay_string_index
>= 0)
2911 /* If we are on a newline from a display vector or
2912 overlay string, then we are already at the end of
2913 a screen line; no need to go to the next line in
2914 that case, as this line is not really continued.
2915 (If we do go to the next line, C-e will not DTRT.) */
2918 set_iterator_to_next (it
, 1);
2919 move_it_in_display_line_to (it
, -1, -1, 0);
2922 it
->continuation_lines_width
+= it
->current_x
;
2924 /* If the character at POS is displayed via a display
2925 vector, move_it_to above stops at the final glyph of
2926 IT->dpvec. To make the caller redisplay that character
2927 again (a.k.a. start at POS), we need to reset the
2928 dpvec_index to the beginning of IT->dpvec. */
2929 else if (it
->current
.dpvec_index
>= 0)
2930 it
->current
.dpvec_index
= 0;
2932 /* We're starting a new display line, not affected by the
2933 height of the continued line, so clear the appropriate
2934 fields in the iterator structure. */
2935 it
->max_ascent
= it
->max_descent
= 0;
2936 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2938 it
->current_y
= first_y
;
2940 it
->current_x
= it
->hpos
= 0;
2946 /* Return 1 if POS is a position in ellipses displayed for invisible
2947 text. W is the window we display, for text property lookup. */
2950 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2952 Lisp_Object prop
, window
;
2954 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
2956 /* If POS specifies a position in a display vector, this might
2957 be for an ellipsis displayed for invisible text. We won't
2958 get the iterator set up for delivering that ellipsis unless
2959 we make sure that it gets aware of the invisible text. */
2960 if (pos
->dpvec_index
>= 0
2961 && pos
->overlay_string_index
< 0
2962 && CHARPOS (pos
->string_pos
) < 0
2964 && (XSETWINDOW (window
, w
),
2965 prop
= Fget_char_property (make_number (charpos
),
2966 Qinvisible
, window
),
2967 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2969 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2971 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2978 /* Initialize IT for stepping through current_buffer in window W,
2979 starting at position POS that includes overlay string and display
2980 vector/ control character translation position information. Value
2981 is zero if there are overlay strings with newlines at POS. */
2984 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2986 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2987 int i
, overlay_strings_with_newlines
= 0;
2989 /* If POS specifies a position in a display vector, this might
2990 be for an ellipsis displayed for invisible text. We won't
2991 get the iterator set up for delivering that ellipsis unless
2992 we make sure that it gets aware of the invisible text. */
2993 if (in_ellipses_for_invisible_text_p (pos
, w
))
2999 /* Keep in mind: the call to reseat in init_iterator skips invisible
3000 text, so we might end up at a position different from POS. This
3001 is only a problem when POS is a row start after a newline and an
3002 overlay starts there with an after-string, and the overlay has an
3003 invisible property. Since we don't skip invisible text in
3004 display_line and elsewhere immediately after consuming the
3005 newline before the row start, such a POS will not be in a string,
3006 but the call to init_iterator below will move us to the
3008 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3010 /* This only scans the current chunk -- it should scan all chunks.
3011 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3012 to 16 in 22.1 to make this a lesser problem. */
3013 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3015 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3016 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3018 while (s
< e
&& *s
!= '\n')
3023 overlay_strings_with_newlines
= 1;
3028 /* If position is within an overlay string, set up IT to the right
3030 if (pos
->overlay_string_index
>= 0)
3034 /* If the first overlay string happens to have a `display'
3035 property for an image, the iterator will be set up for that
3036 image, and we have to undo that setup first before we can
3037 correct the overlay string index. */
3038 if (it
->method
== GET_FROM_IMAGE
)
3041 /* We already have the first chunk of overlay strings in
3042 IT->overlay_strings. Load more until the one for
3043 pos->overlay_string_index is in IT->overlay_strings. */
3044 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3046 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3047 it
->current
.overlay_string_index
= 0;
3050 load_overlay_strings (it
, 0);
3051 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3055 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3056 relative_index
= (it
->current
.overlay_string_index
3057 % OVERLAY_STRING_CHUNK_SIZE
);
3058 it
->string
= it
->overlay_strings
[relative_index
];
3059 xassert (STRINGP (it
->string
));
3060 it
->current
.string_pos
= pos
->string_pos
;
3061 it
->method
= GET_FROM_STRING
;
3064 if (CHARPOS (pos
->string_pos
) >= 0)
3066 /* Recorded position is not in an overlay string, but in another
3067 string. This can only be a string from a `display' property.
3068 IT should already be filled with that string. */
3069 it
->current
.string_pos
= pos
->string_pos
;
3070 xassert (STRINGP (it
->string
));
3073 /* Restore position in display vector translations, control
3074 character translations or ellipses. */
3075 if (pos
->dpvec_index
>= 0)
3077 if (it
->dpvec
== NULL
)
3078 get_next_display_element (it
);
3079 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3080 it
->current
.dpvec_index
= pos
->dpvec_index
;
3084 return !overlay_strings_with_newlines
;
3088 /* Initialize IT for stepping through current_buffer in window W
3089 starting at ROW->start. */
3092 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3094 init_from_display_pos (it
, w
, &row
->start
);
3095 it
->start
= row
->start
;
3096 it
->continuation_lines_width
= row
->continuation_lines_width
;
3101 /* Initialize IT for stepping through current_buffer in window W
3102 starting in the line following ROW, i.e. starting at ROW->end.
3103 Value is zero if there are overlay strings with newlines at ROW's
3107 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3111 if (init_from_display_pos (it
, w
, &row
->end
))
3113 if (row
->continued_p
)
3114 it
->continuation_lines_width
3115 = row
->continuation_lines_width
+ row
->pixel_width
;
3126 /***********************************************************************
3128 ***********************************************************************/
3130 /* Called when IT reaches IT->stop_charpos. Handle text property and
3131 overlay changes. Set IT->stop_charpos to the next position where
3135 handle_stop (struct it
*it
)
3137 enum prop_handled handled
;
3138 int handle_overlay_change_p
;
3142 it
->current
.dpvec_index
= -1;
3143 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3144 it
->ignore_overlay_strings_at_pos_p
= 0;
3147 /* Use face of preceding text for ellipsis (if invisible) */
3148 if (it
->selective_display_ellipsis_p
)
3149 it
->saved_face_id
= it
->face_id
;
3153 handled
= HANDLED_NORMALLY
;
3155 /* Call text property handlers. */
3156 for (p
= it_props
; p
->handler
; ++p
)
3158 handled
= p
->handler (it
);
3160 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3162 else if (handled
== HANDLED_RETURN
)
3164 /* We still want to show before and after strings from
3165 overlays even if the actual buffer text is replaced. */
3166 if (!handle_overlay_change_p
3168 /* Don't call get_overlay_strings_1 if we already
3169 have overlay strings loaded, because doing so
3170 will load them again and push the iterator state
3171 onto the stack one more time, which is not
3172 expected by the rest of the code that processes
3174 || (it
->current
.overlay_string_index
< 0
3175 ? !get_overlay_strings_1 (it
, 0, 0)
3179 setup_for_ellipsis (it
, 0);
3180 /* When handling a display spec, we might load an
3181 empty string. In that case, discard it here. We
3182 used to discard it in handle_single_display_spec,
3183 but that causes get_overlay_strings_1, above, to
3184 ignore overlay strings that we must check. */
3185 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3189 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3193 it
->ignore_overlay_strings_at_pos_p
= 1;
3194 it
->string_from_display_prop_p
= 0;
3195 it
->from_disp_prop_p
= 0;
3196 handle_overlay_change_p
= 0;
3198 handled
= HANDLED_RECOMPUTE_PROPS
;
3201 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3202 handle_overlay_change_p
= 0;
3205 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3207 /* Don't check for overlay strings below when set to deliver
3208 characters from a display vector. */
3209 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3210 handle_overlay_change_p
= 0;
3212 /* Handle overlay changes.
3213 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3214 if it finds overlays. */
3215 if (handle_overlay_change_p
)
3216 handled
= handle_overlay_change (it
);
3221 setup_for_ellipsis (it
, 0);
3225 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3227 /* Determine where to stop next. */
3228 if (handled
== HANDLED_NORMALLY
)
3229 compute_stop_pos (it
);
3233 /* Compute IT->stop_charpos from text property and overlay change
3234 information for IT's current position. */
3237 compute_stop_pos (struct it
*it
)
3239 register INTERVAL iv
, next_iv
;
3240 Lisp_Object object
, limit
, position
;
3241 ptrdiff_t charpos
, bytepos
;
3243 if (STRINGP (it
->string
))
3245 /* Strings are usually short, so don't limit the search for
3247 it
->stop_charpos
= it
->end_charpos
;
3248 object
= it
->string
;
3250 charpos
= IT_STRING_CHARPOS (*it
);
3251 bytepos
= IT_STRING_BYTEPOS (*it
);
3257 /* If end_charpos is out of range for some reason, such as a
3258 misbehaving display function, rationalize it (Bug#5984). */
3259 if (it
->end_charpos
> ZV
)
3260 it
->end_charpos
= ZV
;
3261 it
->stop_charpos
= it
->end_charpos
;
3263 /* If next overlay change is in front of the current stop pos
3264 (which is IT->end_charpos), stop there. Note: value of
3265 next_overlay_change is point-max if no overlay change
3267 charpos
= IT_CHARPOS (*it
);
3268 bytepos
= IT_BYTEPOS (*it
);
3269 pos
= next_overlay_change (charpos
);
3270 if (pos
< it
->stop_charpos
)
3271 it
->stop_charpos
= pos
;
3273 /* If showing the region, we have to stop at the region
3274 start or end because the face might change there. */
3275 if (it
->region_beg_charpos
> 0)
3277 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3278 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3279 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3280 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3283 /* Set up variables for computing the stop position from text
3284 property changes. */
3285 XSETBUFFER (object
, current_buffer
);
3286 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3289 /* Get the interval containing IT's position. Value is a null
3290 interval if there isn't such an interval. */
3291 position
= make_number (charpos
);
3292 iv
= validate_interval_range (object
, &position
, &position
, 0);
3293 if (!NULL_INTERVAL_P (iv
))
3295 Lisp_Object values_here
[LAST_PROP_IDX
];
3298 /* Get properties here. */
3299 for (p
= it_props
; p
->handler
; ++p
)
3300 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3302 /* Look for an interval following iv that has different
3304 for (next_iv
= next_interval (iv
);
3305 (!NULL_INTERVAL_P (next_iv
)
3307 || XFASTINT (limit
) > next_iv
->position
));
3308 next_iv
= next_interval (next_iv
))
3310 for (p
= it_props
; p
->handler
; ++p
)
3312 Lisp_Object new_value
;
3314 new_value
= textget (next_iv
->plist
, *p
->name
);
3315 if (!EQ (values_here
[p
->idx
], new_value
))
3323 if (!NULL_INTERVAL_P (next_iv
))
3325 if (INTEGERP (limit
)
3326 && next_iv
->position
>= XFASTINT (limit
))
3327 /* No text property change up to limit. */
3328 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3330 /* Text properties change in next_iv. */
3331 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3335 if (it
->cmp_it
.id
< 0)
3337 ptrdiff_t stoppos
= it
->end_charpos
;
3339 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3341 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3342 stoppos
, it
->string
);
3345 xassert (STRINGP (it
->string
)
3346 || (it
->stop_charpos
>= BEGV
3347 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3351 /* Return the position of the next overlay change after POS in
3352 current_buffer. Value is point-max if no overlay change
3353 follows. This is like `next-overlay-change' but doesn't use
3357 next_overlay_change (ptrdiff_t pos
)
3359 ptrdiff_t i
, noverlays
;
3361 Lisp_Object
*overlays
;
3363 /* Get all overlays at the given position. */
3364 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3366 /* If any of these overlays ends before endpos,
3367 use its ending point instead. */
3368 for (i
= 0; i
< noverlays
; ++i
)
3373 oend
= OVERLAY_END (overlays
[i
]);
3374 oendpos
= OVERLAY_POSITION (oend
);
3375 endpos
= min (endpos
, oendpos
);
3381 /* How many characters forward to search for a display property or
3382 display string. Searching too far forward makes the bidi display
3383 sluggish, especially in small windows. */
3384 #define MAX_DISP_SCAN 250
3386 /* Return the character position of a display string at or after
3387 position specified by POSITION. If no display string exists at or
3388 after POSITION, return ZV. A display string is either an overlay
3389 with `display' property whose value is a string, or a `display'
3390 text property whose value is a string. STRING is data about the
3391 string to iterate; if STRING->lstring is nil, we are iterating a
3392 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3393 on a GUI frame. DISP_PROP is set to zero if we searched
3394 MAX_DISP_SCAN characters forward without finding any display
3395 strings, non-zero otherwise. It is set to 2 if the display string
3396 uses any kind of `(space ...)' spec that will produce a stretch of
3397 white space in the text area. */
3399 compute_display_string_pos (struct text_pos
*position
,
3400 struct bidi_string_data
*string
,
3401 int frame_window_p
, int *disp_prop
)
3403 /* OBJECT = nil means current buffer. */
3404 Lisp_Object object
=
3405 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3406 Lisp_Object pos
, spec
, limpos
;
3407 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3408 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3409 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3410 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3412 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3413 struct text_pos tpos
;
3419 /* We don't support display properties whose values are strings
3420 that have display string properties. */
3421 || string
->from_disp_str
3422 /* C strings cannot have display properties. */
3423 || (string
->s
&& !STRINGP (object
)))
3429 /* If the character at CHARPOS is where the display string begins,
3431 pos
= make_number (charpos
);
3432 if (STRINGP (object
))
3433 bufpos
= string
->bufpos
;
3437 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3439 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3442 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3450 /* Look forward for the first character with a `display' property
3451 that will replace the underlying text when displayed. */
3452 limpos
= make_number (lim
);
3454 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3455 CHARPOS (tpos
) = XFASTINT (pos
);
3456 if (CHARPOS (tpos
) >= lim
)
3461 if (STRINGP (object
))
3462 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3464 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3465 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3466 if (!STRINGP (object
))
3467 bufpos
= CHARPOS (tpos
);
3468 } while (NILP (spec
)
3469 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3470 bufpos
, frame_window_p
)));
3474 return CHARPOS (tpos
);
3477 /* Return the character position of the end of the display string that
3478 started at CHARPOS. If there's no display string at CHARPOS,
3479 return -1. A display string is either an overlay with `display'
3480 property whose value is a string or a `display' text property whose
3481 value is a string. */
3483 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3485 /* OBJECT = nil means current buffer. */
3486 Lisp_Object object
=
3487 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3488 Lisp_Object pos
= make_number (charpos
);
3490 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3492 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3495 /* It could happen that the display property or overlay was removed
3496 since we found it in compute_display_string_pos above. One way
3497 this can happen is if JIT font-lock was called (through
3498 handle_fontified_prop), and jit-lock-functions remove text
3499 properties or overlays from the portion of buffer that includes
3500 CHARPOS. Muse mode is known to do that, for example. In this
3501 case, we return -1 to the caller, to signal that no display
3502 string is actually present at CHARPOS. See bidi_fetch_char for
3503 how this is handled.
3505 An alternative would be to never look for display properties past
3506 it->stop_charpos. But neither compute_display_string_pos nor
3507 bidi_fetch_char that calls it know or care where the next
3509 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3512 /* Look forward for the first character where the `display' property
3514 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3516 return XFASTINT (pos
);
3521 /***********************************************************************
3523 ***********************************************************************/
3525 /* Handle changes in the `fontified' property of the current buffer by
3526 calling hook functions from Qfontification_functions to fontify
3529 static enum prop_handled
3530 handle_fontified_prop (struct it
*it
)
3532 Lisp_Object prop
, pos
;
3533 enum prop_handled handled
= HANDLED_NORMALLY
;
3535 if (!NILP (Vmemory_full
))
3538 /* Get the value of the `fontified' property at IT's current buffer
3539 position. (The `fontified' property doesn't have a special
3540 meaning in strings.) If the value is nil, call functions from
3541 Qfontification_functions. */
3542 if (!STRINGP (it
->string
)
3544 && !NILP (Vfontification_functions
)
3545 && !NILP (Vrun_hooks
)
3546 && (pos
= make_number (IT_CHARPOS (*it
)),
3547 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3548 /* Ignore the special cased nil value always present at EOB since
3549 no amount of fontifying will be able to change it. */
3550 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3552 ptrdiff_t count
= SPECPDL_INDEX ();
3554 struct buffer
*obuf
= current_buffer
;
3555 int begv
= BEGV
, zv
= ZV
;
3556 int old_clip_changed
= current_buffer
->clip_changed
;
3558 val
= Vfontification_functions
;
3559 specbind (Qfontification_functions
, Qnil
);
3561 xassert (it
->end_charpos
== ZV
);
3563 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3564 safe_call1 (val
, pos
);
3567 Lisp_Object fns
, fn
;
3568 struct gcpro gcpro1
, gcpro2
;
3573 for (; CONSP (val
); val
= XCDR (val
))
3579 /* A value of t indicates this hook has a local
3580 binding; it means to run the global binding too.
3581 In a global value, t should not occur. If it
3582 does, we must ignore it to avoid an endless
3584 for (fns
= Fdefault_value (Qfontification_functions
);
3590 safe_call1 (fn
, pos
);
3594 safe_call1 (fn
, pos
);
3600 unbind_to (count
, Qnil
);
3602 /* Fontification functions routinely call `save-restriction'.
3603 Normally, this tags clip_changed, which can confuse redisplay
3604 (see discussion in Bug#6671). Since we don't perform any
3605 special handling of fontification changes in the case where
3606 `save-restriction' isn't called, there's no point doing so in
3607 this case either. So, if the buffer's restrictions are
3608 actually left unchanged, reset clip_changed. */
3609 if (obuf
== current_buffer
)
3611 if (begv
== BEGV
&& zv
== ZV
)
3612 current_buffer
->clip_changed
= old_clip_changed
;
3614 /* There isn't much we can reasonably do to protect against
3615 misbehaving fontification, but here's a fig leaf. */
3616 else if (!NILP (BVAR (obuf
, name
)))
3617 set_buffer_internal_1 (obuf
);
3619 /* The fontification code may have added/removed text.
3620 It could do even a lot worse, but let's at least protect against
3621 the most obvious case where only the text past `pos' gets changed',
3622 as is/was done in grep.el where some escapes sequences are turned
3623 into face properties (bug#7876). */
3624 it
->end_charpos
= ZV
;
3626 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3627 something. This avoids an endless loop if they failed to
3628 fontify the text for which reason ever. */
3629 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3630 handled
= HANDLED_RECOMPUTE_PROPS
;
3638 /***********************************************************************
3640 ***********************************************************************/
3642 /* Set up iterator IT from face properties at its current position.
3643 Called from handle_stop. */
3645 static enum prop_handled
3646 handle_face_prop (struct it
*it
)
3649 ptrdiff_t next_stop
;
3651 if (!STRINGP (it
->string
))
3654 = face_at_buffer_position (it
->w
,
3656 it
->region_beg_charpos
,
3657 it
->region_end_charpos
,
3660 + TEXT_PROP_DISTANCE_LIMIT
),
3661 0, it
->base_face_id
);
3663 /* Is this a start of a run of characters with box face?
3664 Caveat: this can be called for a freshly initialized
3665 iterator; face_id is -1 in this case. We know that the new
3666 face will not change until limit, i.e. if the new face has a
3667 box, all characters up to limit will have one. But, as
3668 usual, we don't know whether limit is really the end. */
3669 if (new_face_id
!= it
->face_id
)
3671 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3673 /* If new face has a box but old face has not, this is
3674 the start of a run of characters with box, i.e. it has
3675 a shadow on the left side. The value of face_id of the
3676 iterator will be -1 if this is the initial call that gets
3677 the face. In this case, we have to look in front of IT's
3678 position and see whether there is a face != new_face_id. */
3679 it
->start_of_box_run_p
3680 = (new_face
->box
!= FACE_NO_BOX
3681 && (it
->face_id
>= 0
3682 || IT_CHARPOS (*it
) == BEG
3683 || new_face_id
!= face_before_it_pos (it
)));
3684 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3692 Lisp_Object from_overlay
3693 = (it
->current
.overlay_string_index
>= 0
3694 ? it
->string_overlays
[it
->current
.overlay_string_index
3695 % OVERLAY_STRING_CHUNK_SIZE
]
3698 /* See if we got to this string directly or indirectly from
3699 an overlay property. That includes the before-string or
3700 after-string of an overlay, strings in display properties
3701 provided by an overlay, their text properties, etc.
3703 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3704 if (! NILP (from_overlay
))
3705 for (i
= it
->sp
- 1; i
>= 0; i
--)
3707 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3709 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3710 % OVERLAY_STRING_CHUNK_SIZE
];
3711 else if (! NILP (it
->stack
[i
].from_overlay
))
3712 from_overlay
= it
->stack
[i
].from_overlay
;
3714 if (!NILP (from_overlay
))
3718 if (! NILP (from_overlay
))
3720 bufpos
= IT_CHARPOS (*it
);
3721 /* For a string from an overlay, the base face depends
3722 only on text properties and ignores overlays. */
3724 = face_for_overlay_string (it
->w
,
3726 it
->region_beg_charpos
,
3727 it
->region_end_charpos
,
3730 + TEXT_PROP_DISTANCE_LIMIT
),
3738 /* For strings from a `display' property, use the face at
3739 IT's current buffer position as the base face to merge
3740 with, so that overlay strings appear in the same face as
3741 surrounding text, unless they specify their own
3743 base_face_id
= it
->string_from_prefix_prop_p
3745 : underlying_face_id (it
);
3748 new_face_id
= face_at_string_position (it
->w
,
3750 IT_STRING_CHARPOS (*it
),
3752 it
->region_beg_charpos
,
3753 it
->region_end_charpos
,
3757 /* Is this a start of a run of characters with box? Caveat:
3758 this can be called for a freshly allocated iterator; face_id
3759 is -1 is this case. We know that the new face will not
3760 change until the next check pos, i.e. if the new face has a
3761 box, all characters up to that position will have a
3762 box. But, as usual, we don't know whether that position
3763 is really the end. */
3764 if (new_face_id
!= it
->face_id
)
3766 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3767 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3769 /* If new face has a box but old face hasn't, this is the
3770 start of a run of characters with box, i.e. it has a
3771 shadow on the left side. */
3772 it
->start_of_box_run_p
3773 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3774 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3778 it
->face_id
= new_face_id
;
3779 return HANDLED_NORMALLY
;
3783 /* Return the ID of the face ``underlying'' IT's current position,
3784 which is in a string. If the iterator is associated with a
3785 buffer, return the face at IT's current buffer position.
3786 Otherwise, use the iterator's base_face_id. */
3789 underlying_face_id (struct it
*it
)
3791 int face_id
= it
->base_face_id
, i
;
3793 xassert (STRINGP (it
->string
));
3795 for (i
= it
->sp
- 1; i
>= 0; --i
)
3796 if (NILP (it
->stack
[i
].string
))
3797 face_id
= it
->stack
[i
].face_id
;
3803 /* Compute the face one character before or after the current position
3804 of IT, in the visual order. BEFORE_P non-zero means get the face
3805 in front (to the left in L2R paragraphs, to the right in R2L
3806 paragraphs) of IT's screen position. Value is the ID of the face. */
3809 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3812 ptrdiff_t next_check_charpos
;
3814 void *it_copy_data
= NULL
;
3816 xassert (it
->s
== NULL
);
3818 if (STRINGP (it
->string
))
3820 ptrdiff_t bufpos
, charpos
;
3823 /* No face change past the end of the string (for the case
3824 we are padding with spaces). No face change before the
3826 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3827 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3832 /* Set charpos to the position before or after IT's current
3833 position, in the logical order, which in the non-bidi
3834 case is the same as the visual order. */
3836 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3837 else if (it
->what
== IT_COMPOSITION
)
3838 /* For composition, we must check the character after the
3840 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3842 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3848 /* With bidi iteration, the character before the current
3849 in the visual order cannot be found by simple
3850 iteration, because "reverse" reordering is not
3851 supported. Instead, we need to use the move_it_*
3852 family of functions. */
3853 /* Ignore face changes before the first visible
3854 character on this display line. */
3855 if (it
->current_x
<= it
->first_visible_x
)
3857 SAVE_IT (it_copy
, *it
, it_copy_data
);
3858 /* Implementation note: Since move_it_in_display_line
3859 works in the iterator geometry, and thinks the first
3860 character is always the leftmost, even in R2L lines,
3861 we don't need to distinguish between the R2L and L2R
3863 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3864 it_copy
.current_x
- 1, MOVE_TO_X
);
3865 charpos
= IT_STRING_CHARPOS (it_copy
);
3866 RESTORE_IT (it
, it
, it_copy_data
);
3870 /* Set charpos to the string position of the character
3871 that comes after IT's current position in the visual
3873 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3877 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3879 charpos
= it_copy
.bidi_it
.charpos
;
3882 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3884 if (it
->current
.overlay_string_index
>= 0)
3885 bufpos
= IT_CHARPOS (*it
);
3889 base_face_id
= underlying_face_id (it
);
3891 /* Get the face for ASCII, or unibyte. */
3892 face_id
= face_at_string_position (it
->w
,
3896 it
->region_beg_charpos
,
3897 it
->region_end_charpos
,
3898 &next_check_charpos
,
3901 /* Correct the face for charsets different from ASCII. Do it
3902 for the multibyte case only. The face returned above is
3903 suitable for unibyte text if IT->string is unibyte. */
3904 if (STRING_MULTIBYTE (it
->string
))
3906 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3907 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3909 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3911 c
= string_char_and_length (p
, &len
);
3912 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3917 struct text_pos pos
;
3919 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3920 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3923 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3924 pos
= it
->current
.pos
;
3929 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3932 if (it
->what
== IT_COMPOSITION
)
3934 /* For composition, we must check the position after
3936 pos
.charpos
+= it
->cmp_it
.nchars
;
3937 pos
.bytepos
+= it
->len
;
3940 INC_TEXT_POS (pos
, it
->multibyte_p
);
3947 /* With bidi iteration, the character before the current
3948 in the visual order cannot be found by simple
3949 iteration, because "reverse" reordering is not
3950 supported. Instead, we need to use the move_it_*
3951 family of functions. */
3952 /* Ignore face changes before the first visible
3953 character on this display line. */
3954 if (it
->current_x
<= it
->first_visible_x
)
3956 SAVE_IT (it_copy
, *it
, it_copy_data
);
3957 /* Implementation note: Since move_it_in_display_line
3958 works in the iterator geometry, and thinks the first
3959 character is always the leftmost, even in R2L lines,
3960 we don't need to distinguish between the R2L and L2R
3962 move_it_in_display_line (&it_copy
, ZV
,
3963 it_copy
.current_x
- 1, MOVE_TO_X
);
3964 pos
= it_copy
.current
.pos
;
3965 RESTORE_IT (it
, it
, it_copy_data
);
3969 /* Set charpos to the buffer position of the character
3970 that comes after IT's current position in the visual
3972 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3976 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3979 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3982 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3984 /* Determine face for CHARSET_ASCII, or unibyte. */
3985 face_id
= face_at_buffer_position (it
->w
,
3987 it
->region_beg_charpos
,
3988 it
->region_end_charpos
,
3989 &next_check_charpos
,
3992 /* Correct the face for charsets different from ASCII. Do it
3993 for the multibyte case only. The face returned above is
3994 suitable for unibyte text if current_buffer is unibyte. */
3995 if (it
->multibyte_p
)
3997 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3998 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3999 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4008 /***********************************************************************
4010 ***********************************************************************/
4012 /* Set up iterator IT from invisible properties at its current
4013 position. Called from handle_stop. */
4015 static enum prop_handled
4016 handle_invisible_prop (struct it
*it
)
4018 enum prop_handled handled
= HANDLED_NORMALLY
;
4020 if (STRINGP (it
->string
))
4022 Lisp_Object prop
, end_charpos
, limit
, charpos
;
4024 /* Get the value of the invisible text property at the
4025 current position. Value will be nil if there is no such
4027 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4028 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4031 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4035 handled
= HANDLED_RECOMPUTE_PROPS
;
4037 /* Get the position at which the next change of the
4038 invisible text property can be found in IT->string.
4039 Value will be nil if the property value is the same for
4040 all the rest of IT->string. */
4041 XSETINT (limit
, SCHARS (it
->string
));
4042 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4045 /* Text at current position is invisible. The next
4046 change in the property is at position end_charpos.
4047 Move IT's current position to that position. */
4048 if (INTEGERP (end_charpos
)
4049 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
4051 struct text_pos old
;
4054 old
= it
->current
.string_pos
;
4055 oldpos
= CHARPOS (old
);
4058 if (it
->bidi_it
.first_elt
4059 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4060 bidi_paragraph_init (it
->paragraph_embedding
,
4062 /* Bidi-iterate out of the invisible text. */
4065 bidi_move_to_visually_next (&it
->bidi_it
);
4067 while (oldpos
<= it
->bidi_it
.charpos
4068 && it
->bidi_it
.charpos
< endpos
);
4070 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4071 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4072 if (IT_CHARPOS (*it
) >= endpos
)
4073 it
->prev_stop
= endpos
;
4077 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4078 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4083 /* The rest of the string is invisible. If this is an
4084 overlay string, proceed with the next overlay string
4085 or whatever comes and return a character from there. */
4086 if (it
->current
.overlay_string_index
>= 0)
4088 next_overlay_string (it
);
4089 /* Don't check for overlay strings when we just
4090 finished processing them. */
4091 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4095 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4096 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4104 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4105 Lisp_Object pos
, prop
, overlay
;
4107 /* First of all, is there invisible text at this position? */
4108 tem
= start_charpos
= IT_CHARPOS (*it
);
4109 pos
= make_number (tem
);
4110 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4112 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4114 /* If we are on invisible text, skip over it. */
4115 if (invis_p
&& start_charpos
< it
->end_charpos
)
4117 /* Record whether we have to display an ellipsis for the
4119 int display_ellipsis_p
= invis_p
== 2;
4121 handled
= HANDLED_RECOMPUTE_PROPS
;
4123 /* Loop skipping over invisible text. The loop is left at
4124 ZV or with IT on the first char being visible again. */
4127 /* Try to skip some invisible text. Return value is the
4128 position reached which can be equal to where we start
4129 if there is nothing invisible there. This skips both
4130 over invisible text properties and overlays with
4131 invisible property. */
4132 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4134 /* If we skipped nothing at all we weren't at invisible
4135 text in the first place. If everything to the end of
4136 the buffer was skipped, end the loop. */
4137 if (newpos
== tem
|| newpos
>= ZV
)
4141 /* We skipped some characters but not necessarily
4142 all there are. Check if we ended up on visible
4143 text. Fget_char_property returns the property of
4144 the char before the given position, i.e. if we
4145 get invis_p = 0, this means that the char at
4146 newpos is visible. */
4147 pos
= make_number (newpos
);
4148 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4149 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4152 /* If we ended up on invisible text, proceed to
4153 skip starting with next_stop. */
4157 /* If there are adjacent invisible texts, don't lose the
4158 second one's ellipsis. */
4160 display_ellipsis_p
= 1;
4164 /* The position newpos is now either ZV or on visible text. */
4167 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4169 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4171 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4173 /* If the invisible text ends on a newline or on a
4174 character after a newline, we can avoid the costly,
4175 character by character, bidi iteration to NEWPOS, and
4176 instead simply reseat the iterator there. That's
4177 because all bidi reordering information is tossed at
4178 the newline. This is a big win for modes that hide
4179 complete lines, like Outline, Org, etc. */
4180 if (on_newline
|| after_newline
)
4182 struct text_pos tpos
;
4183 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4185 SET_TEXT_POS (tpos
, newpos
, bpos
);
4186 reseat_1 (it
, tpos
, 0);
4187 /* If we reseat on a newline/ZV, we need to prep the
4188 bidi iterator for advancing to the next character
4189 after the newline/EOB, keeping the current paragraph
4190 direction (so that PRODUCE_GLYPHS does TRT wrt
4191 prepending/appending glyphs to a glyph row). */
4194 it
->bidi_it
.first_elt
= 0;
4195 it
->bidi_it
.paragraph_dir
= pdir
;
4196 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4197 it
->bidi_it
.nchars
= 1;
4198 it
->bidi_it
.ch_len
= 1;
4201 else /* Must use the slow method. */
4203 /* With bidi iteration, the region of invisible text
4204 could start and/or end in the middle of a
4205 non-base embedding level. Therefore, we need to
4206 skip invisible text using the bidi iterator,
4207 starting at IT's current position, until we find
4208 ourselves outside of the invisible text.
4209 Skipping invisible text _after_ bidi iteration
4210 avoids affecting the visual order of the
4211 displayed text when invisible properties are
4212 added or removed. */
4213 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4215 /* If we were `reseat'ed to a new paragraph,
4216 determine the paragraph base direction. We
4217 need to do it now because
4218 next_element_from_buffer may not have a
4219 chance to do it, if we are going to skip any
4220 text at the beginning, which resets the
4222 bidi_paragraph_init (it
->paragraph_embedding
,
4227 bidi_move_to_visually_next (&it
->bidi_it
);
4229 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4230 && it
->bidi_it
.charpos
< newpos
);
4231 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4232 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4233 /* If we overstepped NEWPOS, record its position in
4234 the iterator, so that we skip invisible text if
4235 later the bidi iteration lands us in the
4236 invisible region again. */
4237 if (IT_CHARPOS (*it
) >= newpos
)
4238 it
->prev_stop
= newpos
;
4243 IT_CHARPOS (*it
) = newpos
;
4244 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4247 /* If there are before-strings at the start of invisible
4248 text, and the text is invisible because of a text
4249 property, arrange to show before-strings because 20.x did
4250 it that way. (If the text is invisible because of an
4251 overlay property instead of a text property, this is
4252 already handled in the overlay code.) */
4254 && get_overlay_strings (it
, it
->stop_charpos
))
4256 handled
= HANDLED_RECOMPUTE_PROPS
;
4257 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4259 else if (display_ellipsis_p
)
4261 /* Make sure that the glyphs of the ellipsis will get
4262 correct `charpos' values. If we would not update
4263 it->position here, the glyphs would belong to the
4264 last visible character _before_ the invisible
4265 text, which confuses `set_cursor_from_row'.
4267 We use the last invisible position instead of the
4268 first because this way the cursor is always drawn on
4269 the first "." of the ellipsis, whenever PT is inside
4270 the invisible text. Otherwise the cursor would be
4271 placed _after_ the ellipsis when the point is after the
4272 first invisible character. */
4273 if (!STRINGP (it
->object
))
4275 it
->position
.charpos
= newpos
- 1;
4276 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4279 /* Let the ellipsis display before
4280 considering any properties of the following char.
4281 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4282 handled
= HANDLED_RETURN
;
4291 /* Make iterator IT return `...' next.
4292 Replaces LEN characters from buffer. */
4295 setup_for_ellipsis (struct it
*it
, int len
)
4297 /* Use the display table definition for `...'. Invalid glyphs
4298 will be handled by the method returning elements from dpvec. */
4299 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4301 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4302 it
->dpvec
= v
->contents
;
4303 it
->dpend
= v
->contents
+ v
->header
.size
;
4307 /* Default `...'. */
4308 it
->dpvec
= default_invis_vector
;
4309 it
->dpend
= default_invis_vector
+ 3;
4312 it
->dpvec_char_len
= len
;
4313 it
->current
.dpvec_index
= 0;
4314 it
->dpvec_face_id
= -1;
4316 /* Remember the current face id in case glyphs specify faces.
4317 IT's face is restored in set_iterator_to_next.
4318 saved_face_id was set to preceding char's face in handle_stop. */
4319 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4320 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4322 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4328 /***********************************************************************
4330 ***********************************************************************/
4332 /* Set up iterator IT from `display' property at its current position.
4333 Called from handle_stop.
4334 We return HANDLED_RETURN if some part of the display property
4335 overrides the display of the buffer text itself.
4336 Otherwise we return HANDLED_NORMALLY. */
4338 static enum prop_handled
4339 handle_display_prop (struct it
*it
)
4341 Lisp_Object propval
, object
, overlay
;
4342 struct text_pos
*position
;
4344 /* Nonzero if some property replaces the display of the text itself. */
4345 int display_replaced_p
= 0;
4347 if (STRINGP (it
->string
))
4349 object
= it
->string
;
4350 position
= &it
->current
.string_pos
;
4351 bufpos
= CHARPOS (it
->current
.pos
);
4355 XSETWINDOW (object
, it
->w
);
4356 position
= &it
->current
.pos
;
4357 bufpos
= CHARPOS (*position
);
4360 /* Reset those iterator values set from display property values. */
4361 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4362 it
->space_width
= Qnil
;
4363 it
->font_height
= Qnil
;
4366 /* We don't support recursive `display' properties, i.e. string
4367 values that have a string `display' property, that have a string
4368 `display' property etc. */
4369 if (!it
->string_from_display_prop_p
)
4370 it
->area
= TEXT_AREA
;
4372 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4373 Qdisplay
, object
, &overlay
);
4375 return HANDLED_NORMALLY
;
4376 /* Now OVERLAY is the overlay that gave us this property, or nil
4377 if it was a text property. */
4379 if (!STRINGP (it
->string
))
4380 object
= it
->w
->buffer
;
4382 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4384 FRAME_WINDOW_P (it
->f
));
4386 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4389 /* Subroutine of handle_display_prop. Returns non-zero if the display
4390 specification in SPEC is a replacing specification, i.e. it would
4391 replace the text covered by `display' property with something else,
4392 such as an image or a display string. If SPEC includes any kind or
4393 `(space ...) specification, the value is 2; this is used by
4394 compute_display_string_pos, which see.
4396 See handle_single_display_spec for documentation of arguments.
4397 frame_window_p is non-zero if the window being redisplayed is on a
4398 GUI frame; this argument is used only if IT is NULL, see below.
4400 IT can be NULL, if this is called by the bidi reordering code
4401 through compute_display_string_pos, which see. In that case, this
4402 function only examines SPEC, but does not otherwise "handle" it, in
4403 the sense that it doesn't set up members of IT from the display
4406 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4407 Lisp_Object overlay
, struct text_pos
*position
,
4408 ptrdiff_t bufpos
, int frame_window_p
)
4410 int replacing_p
= 0;
4414 /* Simple specifications. */
4415 && !EQ (XCAR (spec
), Qimage
)
4416 && !EQ (XCAR (spec
), Qspace
)
4417 && !EQ (XCAR (spec
), Qwhen
)
4418 && !EQ (XCAR (spec
), Qslice
)
4419 && !EQ (XCAR (spec
), Qspace_width
)
4420 && !EQ (XCAR (spec
), Qheight
)
4421 && !EQ (XCAR (spec
), Qraise
)
4422 /* Marginal area specifications. */
4423 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4424 && !EQ (XCAR (spec
), Qleft_fringe
)
4425 && !EQ (XCAR (spec
), Qright_fringe
)
4426 && !NILP (XCAR (spec
)))
4428 for (; CONSP (spec
); spec
= XCDR (spec
))
4430 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4431 overlay
, position
, bufpos
,
4432 replacing_p
, frame_window_p
)))
4435 /* If some text in a string is replaced, `position' no
4436 longer points to the position of `object'. */
4437 if (!it
|| STRINGP (object
))
4442 else if (VECTORP (spec
))
4445 for (i
= 0; i
< ASIZE (spec
); ++i
)
4446 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4447 overlay
, position
, bufpos
,
4448 replacing_p
, frame_window_p
)))
4451 /* If some text in a string is replaced, `position' no
4452 longer points to the position of `object'. */
4453 if (!it
|| STRINGP (object
))
4459 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4460 position
, bufpos
, 0,
4468 /* Value is the position of the end of the `display' property starting
4469 at START_POS in OBJECT. */
4471 static struct text_pos
4472 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4475 struct text_pos end_pos
;
4477 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4478 Qdisplay
, object
, Qnil
);
4479 CHARPOS (end_pos
) = XFASTINT (end
);
4480 if (STRINGP (object
))
4481 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4483 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4489 /* Set up IT from a single `display' property specification SPEC. OBJECT
4490 is the object in which the `display' property was found. *POSITION
4491 is the position in OBJECT at which the `display' property was found.
4492 BUFPOS is the buffer position of OBJECT (different from POSITION if
4493 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4494 previously saw a display specification which already replaced text
4495 display with something else, for example an image; we ignore such
4496 properties after the first one has been processed.
4498 OVERLAY is the overlay this `display' property came from,
4499 or nil if it was a text property.
4501 If SPEC is a `space' or `image' specification, and in some other
4502 cases too, set *POSITION to the position where the `display'
4505 If IT is NULL, only examine the property specification in SPEC, but
4506 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4507 is intended to be displayed in a window on a GUI frame.
4509 Value is non-zero if something was found which replaces the display
4510 of buffer or string text. */
4513 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4514 Lisp_Object overlay
, struct text_pos
*position
,
4515 ptrdiff_t bufpos
, int display_replaced_p
,
4519 Lisp_Object location
, value
;
4520 struct text_pos start_pos
= *position
;
4523 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4524 If the result is non-nil, use VALUE instead of SPEC. */
4526 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4535 if (!NILP (form
) && !EQ (form
, Qt
))
4537 ptrdiff_t count
= SPECPDL_INDEX ();
4538 struct gcpro gcpro1
;
4540 /* Bind `object' to the object having the `display' property, a
4541 buffer or string. Bind `position' to the position in the
4542 object where the property was found, and `buffer-position'
4543 to the current position in the buffer. */
4546 XSETBUFFER (object
, current_buffer
);
4547 specbind (Qobject
, object
);
4548 specbind (Qposition
, make_number (CHARPOS (*position
)));
4549 specbind (Qbuffer_position
, make_number (bufpos
));
4551 form
= safe_eval (form
);
4553 unbind_to (count
, Qnil
);
4559 /* Handle `(height HEIGHT)' specifications. */
4561 && EQ (XCAR (spec
), Qheight
)
4562 && CONSP (XCDR (spec
)))
4566 if (!FRAME_WINDOW_P (it
->f
))
4569 it
->font_height
= XCAR (XCDR (spec
));
4570 if (!NILP (it
->font_height
))
4572 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4573 int new_height
= -1;
4575 if (CONSP (it
->font_height
)
4576 && (EQ (XCAR (it
->font_height
), Qplus
)
4577 || EQ (XCAR (it
->font_height
), Qminus
))
4578 && CONSP (XCDR (it
->font_height
))
4579 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4581 /* `(+ N)' or `(- N)' where N is an integer. */
4582 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4583 if (EQ (XCAR (it
->font_height
), Qplus
))
4585 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4587 else if (FUNCTIONP (it
->font_height
))
4589 /* Call function with current height as argument.
4590 Value is the new height. */
4592 height
= safe_call1 (it
->font_height
,
4593 face
->lface
[LFACE_HEIGHT_INDEX
]);
4594 if (NUMBERP (height
))
4595 new_height
= XFLOATINT (height
);
4597 else if (NUMBERP (it
->font_height
))
4599 /* Value is a multiple of the canonical char height. */
4602 f
= FACE_FROM_ID (it
->f
,
4603 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4604 new_height
= (XFLOATINT (it
->font_height
)
4605 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4609 /* Evaluate IT->font_height with `height' bound to the
4610 current specified height to get the new height. */
4611 ptrdiff_t count
= SPECPDL_INDEX ();
4613 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4614 value
= safe_eval (it
->font_height
);
4615 unbind_to (count
, Qnil
);
4617 if (NUMBERP (value
))
4618 new_height
= XFLOATINT (value
);
4622 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4629 /* Handle `(space-width WIDTH)'. */
4631 && EQ (XCAR (spec
), Qspace_width
)
4632 && CONSP (XCDR (spec
)))
4636 if (!FRAME_WINDOW_P (it
->f
))
4639 value
= XCAR (XCDR (spec
));
4640 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4641 it
->space_width
= value
;
4647 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4649 && EQ (XCAR (spec
), Qslice
))
4655 if (!FRAME_WINDOW_P (it
->f
))
4658 if (tem
= XCDR (spec
), CONSP (tem
))
4660 it
->slice
.x
= XCAR (tem
);
4661 if (tem
= XCDR (tem
), CONSP (tem
))
4663 it
->slice
.y
= XCAR (tem
);
4664 if (tem
= XCDR (tem
), CONSP (tem
))
4666 it
->slice
.width
= XCAR (tem
);
4667 if (tem
= XCDR (tem
), CONSP (tem
))
4668 it
->slice
.height
= XCAR (tem
);
4677 /* Handle `(raise FACTOR)'. */
4679 && EQ (XCAR (spec
), Qraise
)
4680 && CONSP (XCDR (spec
)))
4684 if (!FRAME_WINDOW_P (it
->f
))
4687 #ifdef HAVE_WINDOW_SYSTEM
4688 value
= XCAR (XCDR (spec
));
4689 if (NUMBERP (value
))
4691 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4692 it
->voffset
= - (XFLOATINT (value
)
4693 * (FONT_HEIGHT (face
->font
)));
4695 #endif /* HAVE_WINDOW_SYSTEM */
4701 /* Don't handle the other kinds of display specifications
4702 inside a string that we got from a `display' property. */
4703 if (it
&& it
->string_from_display_prop_p
)
4706 /* Characters having this form of property are not displayed, so
4707 we have to find the end of the property. */
4710 start_pos
= *position
;
4711 *position
= display_prop_end (it
, object
, start_pos
);
4715 /* Stop the scan at that end position--we assume that all
4716 text properties change there. */
4718 it
->stop_charpos
= position
->charpos
;
4720 /* Handle `(left-fringe BITMAP [FACE])'
4721 and `(right-fringe BITMAP [FACE])'. */
4723 && (EQ (XCAR (spec
), Qleft_fringe
)
4724 || EQ (XCAR (spec
), Qright_fringe
))
4725 && CONSP (XCDR (spec
)))
4731 if (!FRAME_WINDOW_P (it
->f
))
4732 /* If we return here, POSITION has been advanced
4733 across the text with this property. */
4735 /* Synchronize the bidi iterator with POSITION. This is
4736 needed because we are not going to push the iterator
4737 on behalf of this display property, so there will be
4738 no pop_it call to do this synchronization for us. */
4741 it
->position
= *position
;
4742 iterate_out_of_display_property (it
);
4743 *position
= it
->position
;
4748 else if (!frame_window_p
)
4751 #ifdef HAVE_WINDOW_SYSTEM
4752 value
= XCAR (XCDR (spec
));
4753 if (!SYMBOLP (value
)
4754 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4755 /* If we return here, POSITION has been advanced
4756 across the text with this property. */
4758 if (it
&& it
->bidi_p
)
4760 it
->position
= *position
;
4761 iterate_out_of_display_property (it
);
4762 *position
= it
->position
;
4769 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4771 if (CONSP (XCDR (XCDR (spec
))))
4773 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4774 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4780 /* Save current settings of IT so that we can restore them
4781 when we are finished with the glyph property value. */
4782 push_it (it
, position
);
4784 it
->area
= TEXT_AREA
;
4785 it
->what
= IT_IMAGE
;
4786 it
->image_id
= -1; /* no image */
4787 it
->position
= start_pos
;
4788 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4789 it
->method
= GET_FROM_IMAGE
;
4790 it
->from_overlay
= Qnil
;
4791 it
->face_id
= face_id
;
4792 it
->from_disp_prop_p
= 1;
4794 /* Say that we haven't consumed the characters with
4795 `display' property yet. The call to pop_it in
4796 set_iterator_to_next will clean this up. */
4797 *position
= start_pos
;
4799 if (EQ (XCAR (spec
), Qleft_fringe
))
4801 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4802 it
->left_user_fringe_face_id
= face_id
;
4806 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4807 it
->right_user_fringe_face_id
= face_id
;
4810 #endif /* HAVE_WINDOW_SYSTEM */
4814 /* Prepare to handle `((margin left-margin) ...)',
4815 `((margin right-margin) ...)' and `((margin nil) ...)'
4816 prefixes for display specifications. */
4817 location
= Qunbound
;
4818 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4822 value
= XCDR (spec
);
4824 value
= XCAR (value
);
4827 if (EQ (XCAR (tem
), Qmargin
)
4828 && (tem
= XCDR (tem
),
4829 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4831 || EQ (tem
, Qleft_margin
)
4832 || EQ (tem
, Qright_margin
))))
4836 if (EQ (location
, Qunbound
))
4842 /* After this point, VALUE is the property after any
4843 margin prefix has been stripped. It must be a string,
4844 an image specification, or `(space ...)'.
4846 LOCATION specifies where to display: `left-margin',
4847 `right-margin' or nil. */
4849 valid_p
= (STRINGP (value
)
4850 #ifdef HAVE_WINDOW_SYSTEM
4851 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4852 && valid_image_p (value
))
4853 #endif /* not HAVE_WINDOW_SYSTEM */
4854 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4856 if (valid_p
&& !display_replaced_p
)
4862 /* Callers need to know whether the display spec is any kind
4863 of `(space ...)' spec that is about to affect text-area
4865 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4870 /* Save current settings of IT so that we can restore them
4871 when we are finished with the glyph property value. */
4872 push_it (it
, position
);
4873 it
->from_overlay
= overlay
;
4874 it
->from_disp_prop_p
= 1;
4876 if (NILP (location
))
4877 it
->area
= TEXT_AREA
;
4878 else if (EQ (location
, Qleft_margin
))
4879 it
->area
= LEFT_MARGIN_AREA
;
4881 it
->area
= RIGHT_MARGIN_AREA
;
4883 if (STRINGP (value
))
4886 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4887 it
->current
.overlay_string_index
= -1;
4888 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4889 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4890 it
->method
= GET_FROM_STRING
;
4891 it
->stop_charpos
= 0;
4893 it
->base_level_stop
= 0;
4894 it
->string_from_display_prop_p
= 1;
4895 /* Say that we haven't consumed the characters with
4896 `display' property yet. The call to pop_it in
4897 set_iterator_to_next will clean this up. */
4898 if (BUFFERP (object
))
4899 *position
= start_pos
;
4901 /* Force paragraph direction to be that of the parent
4902 object. If the parent object's paragraph direction is
4903 not yet determined, default to L2R. */
4904 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4905 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4907 it
->paragraph_embedding
= L2R
;
4909 /* Set up the bidi iterator for this display string. */
4912 it
->bidi_it
.string
.lstring
= it
->string
;
4913 it
->bidi_it
.string
.s
= NULL
;
4914 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4915 it
->bidi_it
.string
.bufpos
= bufpos
;
4916 it
->bidi_it
.string
.from_disp_str
= 1;
4917 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4918 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4921 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4923 it
->method
= GET_FROM_STRETCH
;
4925 *position
= it
->position
= start_pos
;
4926 retval
= 1 + (it
->area
== TEXT_AREA
);
4928 #ifdef HAVE_WINDOW_SYSTEM
4931 it
->what
= IT_IMAGE
;
4932 it
->image_id
= lookup_image (it
->f
, value
);
4933 it
->position
= start_pos
;
4934 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4935 it
->method
= GET_FROM_IMAGE
;
4937 /* Say that we haven't consumed the characters with
4938 `display' property yet. The call to pop_it in
4939 set_iterator_to_next will clean this up. */
4940 *position
= start_pos
;
4942 #endif /* HAVE_WINDOW_SYSTEM */
4947 /* Invalid property or property not supported. Restore
4948 POSITION to what it was before. */
4949 *position
= start_pos
;
4953 /* Check if PROP is a display property value whose text should be
4954 treated as intangible. OVERLAY is the overlay from which PROP
4955 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4956 specify the buffer position covered by PROP. */
4959 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4960 ptrdiff_t charpos
, ptrdiff_t bytepos
)
4962 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4963 struct text_pos position
;
4965 SET_TEXT_POS (position
, charpos
, bytepos
);
4966 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4967 &position
, charpos
, frame_window_p
);
4971 /* Return 1 if PROP is a display sub-property value containing STRING.
4973 Implementation note: this and the following function are really
4974 special cases of handle_display_spec and
4975 handle_single_display_spec, and should ideally use the same code.
4976 Until they do, these two pairs must be consistent and must be
4977 modified in sync. */
4980 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4982 if (EQ (string
, prop
))
4985 /* Skip over `when FORM'. */
4986 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4991 /* Actually, the condition following `when' should be eval'ed,
4992 like handle_single_display_spec does, and we should return
4993 zero if it evaluates to nil. However, this function is
4994 called only when the buffer was already displayed and some
4995 glyph in the glyph matrix was found to come from a display
4996 string. Therefore, the condition was already evaluated, and
4997 the result was non-nil, otherwise the display string wouldn't
4998 have been displayed and we would have never been called for
4999 this property. Thus, we can skip the evaluation and assume
5000 its result is non-nil. */
5005 /* Skip over `margin LOCATION'. */
5006 if (EQ (XCAR (prop
), Qmargin
))
5017 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5021 /* Return 1 if STRING appears in the `display' property PROP. */
5024 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5027 && !EQ (XCAR (prop
), Qwhen
)
5028 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5030 /* A list of sub-properties. */
5031 while (CONSP (prop
))
5033 if (single_display_spec_string_p (XCAR (prop
), string
))
5038 else if (VECTORP (prop
))
5040 /* A vector of sub-properties. */
5042 for (i
= 0; i
< ASIZE (prop
); ++i
)
5043 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5047 return single_display_spec_string_p (prop
, string
);
5052 /* Look for STRING in overlays and text properties in the current
5053 buffer, between character positions FROM and TO (excluding TO).
5054 BACK_P non-zero means look back (in this case, TO is supposed to be
5056 Value is the first character position where STRING was found, or
5057 zero if it wasn't found before hitting TO.
5059 This function may only use code that doesn't eval because it is
5060 called asynchronously from note_mouse_highlight. */
5063 string_buffer_position_lim (Lisp_Object string
,
5064 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5066 Lisp_Object limit
, prop
, pos
;
5069 pos
= make_number (max (from
, BEGV
));
5071 if (!back_p
) /* looking forward */
5073 limit
= make_number (min (to
, ZV
));
5074 while (!found
&& !EQ (pos
, limit
))
5076 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5077 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5080 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5084 else /* looking back */
5086 limit
= make_number (max (to
, BEGV
));
5087 while (!found
&& !EQ (pos
, limit
))
5089 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5090 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5093 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5098 return found
? XINT (pos
) : 0;
5101 /* Determine which buffer position in current buffer STRING comes from.
5102 AROUND_CHARPOS is an approximate position where it could come from.
5103 Value is the buffer position or 0 if it couldn't be determined.
5105 This function is necessary because we don't record buffer positions
5106 in glyphs generated from strings (to keep struct glyph small).
5107 This function may only use code that doesn't eval because it is
5108 called asynchronously from note_mouse_highlight. */
5111 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5113 const int MAX_DISTANCE
= 1000;
5114 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5115 around_charpos
+ MAX_DISTANCE
,
5119 found
= string_buffer_position_lim (string
, around_charpos
,
5120 around_charpos
- MAX_DISTANCE
, 1);
5126 /***********************************************************************
5127 `composition' property
5128 ***********************************************************************/
5130 /* Set up iterator IT from `composition' property at its current
5131 position. Called from handle_stop. */
5133 static enum prop_handled
5134 handle_composition_prop (struct it
*it
)
5136 Lisp_Object prop
, string
;
5137 ptrdiff_t pos
, pos_byte
, start
, end
;
5139 if (STRINGP (it
->string
))
5143 pos
= IT_STRING_CHARPOS (*it
);
5144 pos_byte
= IT_STRING_BYTEPOS (*it
);
5145 string
= it
->string
;
5146 s
= SDATA (string
) + pos_byte
;
5147 it
->c
= STRING_CHAR (s
);
5151 pos
= IT_CHARPOS (*it
);
5152 pos_byte
= IT_BYTEPOS (*it
);
5154 it
->c
= FETCH_CHAR (pos_byte
);
5157 /* If there's a valid composition and point is not inside of the
5158 composition (in the case that the composition is from the current
5159 buffer), draw a glyph composed from the composition components. */
5160 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5161 && COMPOSITION_VALID_P (start
, end
, prop
)
5162 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5165 /* As we can't handle this situation (perhaps font-lock added
5166 a new composition), we just return here hoping that next
5167 redisplay will detect this composition much earlier. */
5168 return HANDLED_NORMALLY
;
5171 if (STRINGP (it
->string
))
5172 pos_byte
= string_char_to_byte (it
->string
, start
);
5174 pos_byte
= CHAR_TO_BYTE (start
);
5176 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5179 if (it
->cmp_it
.id
>= 0)
5182 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5183 it
->cmp_it
.nglyphs
= -1;
5187 return HANDLED_NORMALLY
;
5192 /***********************************************************************
5194 ***********************************************************************/
5196 /* The following structure is used to record overlay strings for
5197 later sorting in load_overlay_strings. */
5199 struct overlay_entry
5201 Lisp_Object overlay
;
5208 /* Set up iterator IT from overlay strings at its current position.
5209 Called from handle_stop. */
5211 static enum prop_handled
5212 handle_overlay_change (struct it
*it
)
5214 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5215 return HANDLED_RECOMPUTE_PROPS
;
5217 return HANDLED_NORMALLY
;
5221 /* Set up the next overlay string for delivery by IT, if there is an
5222 overlay string to deliver. Called by set_iterator_to_next when the
5223 end of the current overlay string is reached. If there are more
5224 overlay strings to display, IT->string and
5225 IT->current.overlay_string_index are set appropriately here.
5226 Otherwise IT->string is set to nil. */
5229 next_overlay_string (struct it
*it
)
5231 ++it
->current
.overlay_string_index
;
5232 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5234 /* No more overlay strings. Restore IT's settings to what
5235 they were before overlay strings were processed, and
5236 continue to deliver from current_buffer. */
5238 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5241 || (NILP (it
->string
)
5242 && it
->method
== GET_FROM_BUFFER
5243 && it
->stop_charpos
>= BEGV
5244 && it
->stop_charpos
<= it
->end_charpos
));
5245 it
->current
.overlay_string_index
= -1;
5246 it
->n_overlay_strings
= 0;
5247 it
->overlay_strings_charpos
= -1;
5248 /* If there's an empty display string on the stack, pop the
5249 stack, to resync the bidi iterator with IT's position. Such
5250 empty strings are pushed onto the stack in
5251 get_overlay_strings_1. */
5252 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5255 /* If we're at the end of the buffer, record that we have
5256 processed the overlay strings there already, so that
5257 next_element_from_buffer doesn't try it again. */
5258 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5259 it
->overlay_strings_at_end_processed_p
= 1;
5263 /* There are more overlay strings to process. If
5264 IT->current.overlay_string_index has advanced to a position
5265 where we must load IT->overlay_strings with more strings, do
5266 it. We must load at the IT->overlay_strings_charpos where
5267 IT->n_overlay_strings was originally computed; when invisible
5268 text is present, this might not be IT_CHARPOS (Bug#7016). */
5269 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5271 if (it
->current
.overlay_string_index
&& i
== 0)
5272 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5274 /* Initialize IT to deliver display elements from the overlay
5276 it
->string
= it
->overlay_strings
[i
];
5277 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5278 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5279 it
->method
= GET_FROM_STRING
;
5280 it
->stop_charpos
= 0;
5281 if (it
->cmp_it
.stop_pos
>= 0)
5282 it
->cmp_it
.stop_pos
= 0;
5284 it
->base_level_stop
= 0;
5286 /* Set up the bidi iterator for this overlay string. */
5289 it
->bidi_it
.string
.lstring
= it
->string
;
5290 it
->bidi_it
.string
.s
= NULL
;
5291 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5292 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5293 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5294 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5295 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5303 /* Compare two overlay_entry structures E1 and E2. Used as a
5304 comparison function for qsort in load_overlay_strings. Overlay
5305 strings for the same position are sorted so that
5307 1. All after-strings come in front of before-strings, except
5308 when they come from the same overlay.
5310 2. Within after-strings, strings are sorted so that overlay strings
5311 from overlays with higher priorities come first.
5313 2. Within before-strings, strings are sorted so that overlay
5314 strings from overlays with higher priorities come last.
5316 Value is analogous to strcmp. */
5320 compare_overlay_entries (const void *e1
, const void *e2
)
5322 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5323 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5326 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5328 /* Let after-strings appear in front of before-strings if
5329 they come from different overlays. */
5330 if (EQ (entry1
->overlay
, entry2
->overlay
))
5331 result
= entry1
->after_string_p
? 1 : -1;
5333 result
= entry1
->after_string_p
? -1 : 1;
5335 else if (entry1
->priority
!= entry2
->priority
)
5337 if (entry1
->after_string_p
)
5338 /* After-strings sorted in order of decreasing priority. */
5339 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5341 /* Before-strings sorted in order of increasing priority. */
5342 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5351 /* Load the vector IT->overlay_strings with overlay strings from IT's
5352 current buffer position, or from CHARPOS if that is > 0. Set
5353 IT->n_overlays to the total number of overlay strings found.
5355 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5356 a time. On entry into load_overlay_strings,
5357 IT->current.overlay_string_index gives the number of overlay
5358 strings that have already been loaded by previous calls to this
5361 IT->add_overlay_start contains an additional overlay start
5362 position to consider for taking overlay strings from, if non-zero.
5363 This position comes into play when the overlay has an `invisible'
5364 property, and both before and after-strings. When we've skipped to
5365 the end of the overlay, because of its `invisible' property, we
5366 nevertheless want its before-string to appear.
5367 IT->add_overlay_start will contain the overlay start position
5370 Overlay strings are sorted so that after-string strings come in
5371 front of before-string strings. Within before and after-strings,
5372 strings are sorted by overlay priority. See also function
5373 compare_overlay_entries. */
5376 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5378 Lisp_Object overlay
, window
, str
, invisible
;
5379 struct Lisp_Overlay
*ov
;
5380 ptrdiff_t start
, end
;
5381 ptrdiff_t size
= 20;
5382 ptrdiff_t n
= 0, i
, j
;
5384 struct overlay_entry
*entries
5385 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5389 charpos
= IT_CHARPOS (*it
);
5391 /* Append the overlay string STRING of overlay OVERLAY to vector
5392 `entries' which has size `size' and currently contains `n'
5393 elements. AFTER_P non-zero means STRING is an after-string of
5395 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5398 Lisp_Object priority; \
5402 struct overlay_entry *old = entries; \
5403 SAFE_NALLOCA (entries, 2, size); \
5404 memcpy (entries, old, size * sizeof *entries); \
5408 entries[n].string = (STRING); \
5409 entries[n].overlay = (OVERLAY); \
5410 priority = Foverlay_get ((OVERLAY), Qpriority); \
5411 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5412 entries[n].after_string_p = (AFTER_P); \
5417 /* Process overlay before the overlay center. */
5418 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5420 XSETMISC (overlay
, ov
);
5421 xassert (OVERLAYP (overlay
));
5422 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5423 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5428 /* Skip this overlay if it doesn't start or end at IT's current
5430 if (end
!= charpos
&& start
!= charpos
)
5433 /* Skip this overlay if it doesn't apply to IT->w. */
5434 window
= Foverlay_get (overlay
, Qwindow
);
5435 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5438 /* If the text ``under'' the overlay is invisible, both before-
5439 and after-strings from this overlay are visible; start and
5440 end position are indistinguishable. */
5441 invisible
= Foverlay_get (overlay
, Qinvisible
);
5442 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5444 /* If overlay has a non-empty before-string, record it. */
5445 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5446 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5448 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5450 /* If overlay has a non-empty after-string, record it. */
5451 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5452 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5454 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5457 /* Process overlays after the overlay center. */
5458 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5460 XSETMISC (overlay
, ov
);
5461 xassert (OVERLAYP (overlay
));
5462 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5463 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5465 if (start
> charpos
)
5468 /* Skip this overlay if it doesn't start or end at IT's current
5470 if (end
!= charpos
&& start
!= charpos
)
5473 /* Skip this overlay if it doesn't apply to IT->w. */
5474 window
= Foverlay_get (overlay
, Qwindow
);
5475 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5478 /* If the text ``under'' the overlay is invisible, it has a zero
5479 dimension, and both before- and after-strings apply. */
5480 invisible
= Foverlay_get (overlay
, Qinvisible
);
5481 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5483 /* If overlay has a non-empty before-string, record it. */
5484 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5485 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5487 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5489 /* If overlay has a non-empty after-string, record it. */
5490 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5491 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5493 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5496 #undef RECORD_OVERLAY_STRING
5500 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5502 /* Record number of overlay strings, and where we computed it. */
5503 it
->n_overlay_strings
= n
;
5504 it
->overlay_strings_charpos
= charpos
;
5506 /* IT->current.overlay_string_index is the number of overlay strings
5507 that have already been consumed by IT. Copy some of the
5508 remaining overlay strings to IT->overlay_strings. */
5510 j
= it
->current
.overlay_string_index
;
5511 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5513 it
->overlay_strings
[i
] = entries
[j
].string
;
5514 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5522 /* Get the first chunk of overlay strings at IT's current buffer
5523 position, or at CHARPOS if that is > 0. Value is non-zero if at
5524 least one overlay string was found. */
5527 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5529 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5530 process. This fills IT->overlay_strings with strings, and sets
5531 IT->n_overlay_strings to the total number of strings to process.
5532 IT->pos.overlay_string_index has to be set temporarily to zero
5533 because load_overlay_strings needs this; it must be set to -1
5534 when no overlay strings are found because a zero value would
5535 indicate a position in the first overlay string. */
5536 it
->current
.overlay_string_index
= 0;
5537 load_overlay_strings (it
, charpos
);
5539 /* If we found overlay strings, set up IT to deliver display
5540 elements from the first one. Otherwise set up IT to deliver
5541 from current_buffer. */
5542 if (it
->n_overlay_strings
)
5544 /* Make sure we know settings in current_buffer, so that we can
5545 restore meaningful values when we're done with the overlay
5548 compute_stop_pos (it
);
5549 xassert (it
->face_id
>= 0);
5551 /* Save IT's settings. They are restored after all overlay
5552 strings have been processed. */
5553 xassert (!compute_stop_p
|| it
->sp
== 0);
5555 /* When called from handle_stop, there might be an empty display
5556 string loaded. In that case, don't bother saving it. But
5557 don't use this optimization with the bidi iterator, since we
5558 need the corresponding pop_it call to resync the bidi
5559 iterator's position with IT's position, after we are done
5560 with the overlay strings. (The corresponding call to pop_it
5561 in case of an empty display string is in
5562 next_overlay_string.) */
5564 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5567 /* Set up IT to deliver display elements from the first overlay
5569 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5570 it
->string
= it
->overlay_strings
[0];
5571 it
->from_overlay
= Qnil
;
5572 it
->stop_charpos
= 0;
5573 xassert (STRINGP (it
->string
));
5574 it
->end_charpos
= SCHARS (it
->string
);
5576 it
->base_level_stop
= 0;
5577 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5578 it
->method
= GET_FROM_STRING
;
5579 it
->from_disp_prop_p
= 0;
5581 /* Force paragraph direction to be that of the parent
5583 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5584 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5586 it
->paragraph_embedding
= L2R
;
5588 /* Set up the bidi iterator for this overlay string. */
5591 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5593 it
->bidi_it
.string
.lstring
= it
->string
;
5594 it
->bidi_it
.string
.s
= NULL
;
5595 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5596 it
->bidi_it
.string
.bufpos
= pos
;
5597 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5598 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5599 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5604 it
->current
.overlay_string_index
= -1;
5609 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5612 it
->method
= GET_FROM_BUFFER
;
5614 (void) get_overlay_strings_1 (it
, charpos
, 1);
5618 /* Value is non-zero if we found at least one overlay string. */
5619 return STRINGP (it
->string
);
5624 /***********************************************************************
5625 Saving and restoring state
5626 ***********************************************************************/
5628 /* Save current settings of IT on IT->stack. Called, for example,
5629 before setting up IT for an overlay string, to be able to restore
5630 IT's settings to what they were after the overlay string has been
5631 processed. If POSITION is non-NULL, it is the position to save on
5632 the stack instead of IT->position. */
5635 push_it (struct it
*it
, struct text_pos
*position
)
5637 struct iterator_stack_entry
*p
;
5639 xassert (it
->sp
< IT_STACK_SIZE
);
5640 p
= it
->stack
+ it
->sp
;
5642 p
->stop_charpos
= it
->stop_charpos
;
5643 p
->prev_stop
= it
->prev_stop
;
5644 p
->base_level_stop
= it
->base_level_stop
;
5645 p
->cmp_it
= it
->cmp_it
;
5646 xassert (it
->face_id
>= 0);
5647 p
->face_id
= it
->face_id
;
5648 p
->string
= it
->string
;
5649 p
->method
= it
->method
;
5650 p
->from_overlay
= it
->from_overlay
;
5653 case GET_FROM_IMAGE
:
5654 p
->u
.image
.object
= it
->object
;
5655 p
->u
.image
.image_id
= it
->image_id
;
5656 p
->u
.image
.slice
= it
->slice
;
5658 case GET_FROM_STRETCH
:
5659 p
->u
.stretch
.object
= it
->object
;
5662 p
->position
= position
? *position
: it
->position
;
5663 p
->current
= it
->current
;
5664 p
->end_charpos
= it
->end_charpos
;
5665 p
->string_nchars
= it
->string_nchars
;
5667 p
->multibyte_p
= it
->multibyte_p
;
5668 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5669 p
->space_width
= it
->space_width
;
5670 p
->font_height
= it
->font_height
;
5671 p
->voffset
= it
->voffset
;
5672 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5673 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5674 p
->display_ellipsis_p
= 0;
5675 p
->line_wrap
= it
->line_wrap
;
5676 p
->bidi_p
= it
->bidi_p
;
5677 p
->paragraph_embedding
= it
->paragraph_embedding
;
5678 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5681 /* Save the state of the bidi iterator as well. */
5683 bidi_push_it (&it
->bidi_it
);
5687 iterate_out_of_display_property (struct it
*it
)
5689 int buffer_p
= !STRINGP (it
->string
);
5690 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5691 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5693 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5695 /* Maybe initialize paragraph direction. If we are at the beginning
5696 of a new paragraph, next_element_from_buffer may not have a
5697 chance to do that. */
5698 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5699 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5700 /* prev_stop can be zero, so check against BEGV as well. */
5701 while (it
->bidi_it
.charpos
>= bob
5702 && it
->prev_stop
<= it
->bidi_it
.charpos
5703 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5704 && it
->bidi_it
.charpos
< eob
)
5705 bidi_move_to_visually_next (&it
->bidi_it
);
5706 /* Record the stop_pos we just crossed, for when we cross it
5708 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5709 it
->prev_stop
= CHARPOS (it
->position
);
5710 /* If we ended up not where pop_it put us, resync IT's
5711 positional members with the bidi iterator. */
5712 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5713 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5715 it
->current
.pos
= it
->position
;
5717 it
->current
.string_pos
= it
->position
;
5720 /* Restore IT's settings from IT->stack. Called, for example, when no
5721 more overlay strings must be processed, and we return to delivering
5722 display elements from a buffer, or when the end of a string from a
5723 `display' property is reached and we return to delivering display
5724 elements from an overlay string, or from a buffer. */
5727 pop_it (struct it
*it
)
5729 struct iterator_stack_entry
*p
;
5730 int from_display_prop
= it
->from_disp_prop_p
;
5732 xassert (it
->sp
> 0);
5734 p
= it
->stack
+ it
->sp
;
5735 it
->stop_charpos
= p
->stop_charpos
;
5736 it
->prev_stop
= p
->prev_stop
;
5737 it
->base_level_stop
= p
->base_level_stop
;
5738 it
->cmp_it
= p
->cmp_it
;
5739 it
->face_id
= p
->face_id
;
5740 it
->current
= p
->current
;
5741 it
->position
= p
->position
;
5742 it
->string
= p
->string
;
5743 it
->from_overlay
= p
->from_overlay
;
5744 if (NILP (it
->string
))
5745 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5746 it
->method
= p
->method
;
5749 case GET_FROM_IMAGE
:
5750 it
->image_id
= p
->u
.image
.image_id
;
5751 it
->object
= p
->u
.image
.object
;
5752 it
->slice
= p
->u
.image
.slice
;
5754 case GET_FROM_STRETCH
:
5755 it
->object
= p
->u
.stretch
.object
;
5757 case GET_FROM_BUFFER
:
5758 it
->object
= it
->w
->buffer
;
5760 case GET_FROM_STRING
:
5761 it
->object
= it
->string
;
5763 case GET_FROM_DISPLAY_VECTOR
:
5765 it
->method
= GET_FROM_C_STRING
;
5766 else if (STRINGP (it
->string
))
5767 it
->method
= GET_FROM_STRING
;
5770 it
->method
= GET_FROM_BUFFER
;
5771 it
->object
= it
->w
->buffer
;
5774 it
->end_charpos
= p
->end_charpos
;
5775 it
->string_nchars
= p
->string_nchars
;
5777 it
->multibyte_p
= p
->multibyte_p
;
5778 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5779 it
->space_width
= p
->space_width
;
5780 it
->font_height
= p
->font_height
;
5781 it
->voffset
= p
->voffset
;
5782 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5783 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5784 it
->line_wrap
= p
->line_wrap
;
5785 it
->bidi_p
= p
->bidi_p
;
5786 it
->paragraph_embedding
= p
->paragraph_embedding
;
5787 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5790 bidi_pop_it (&it
->bidi_it
);
5791 /* Bidi-iterate until we get out of the portion of text, if any,
5792 covered by a `display' text property or by an overlay with
5793 `display' property. (We cannot just jump there, because the
5794 internal coherency of the bidi iterator state can not be
5795 preserved across such jumps.) We also must determine the
5796 paragraph base direction if the overlay we just processed is
5797 at the beginning of a new paragraph. */
5798 if (from_display_prop
5799 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5800 iterate_out_of_display_property (it
);
5802 xassert ((BUFFERP (it
->object
)
5803 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5804 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5805 || (STRINGP (it
->object
)
5806 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5807 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5808 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5814 /***********************************************************************
5816 ***********************************************************************/
5818 /* Set IT's current position to the previous line start. */
5821 back_to_previous_line_start (struct it
*it
)
5823 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5824 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5828 /* Move IT to the next line start.
5830 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5831 we skipped over part of the text (as opposed to moving the iterator
5832 continuously over the text). Otherwise, don't change the value
5835 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5836 iterator on the newline, if it was found.
5838 Newlines may come from buffer text, overlay strings, or strings
5839 displayed via the `display' property. That's the reason we can't
5840 simply use find_next_newline_no_quit.
5842 Note that this function may not skip over invisible text that is so
5843 because of text properties and immediately follows a newline. If
5844 it would, function reseat_at_next_visible_line_start, when called
5845 from set_iterator_to_next, would effectively make invisible
5846 characters following a newline part of the wrong glyph row, which
5847 leads to wrong cursor motion. */
5850 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5851 struct bidi_it
*bidi_it_prev
)
5853 ptrdiff_t old_selective
;
5854 int newline_found_p
, n
;
5855 const int MAX_NEWLINE_DISTANCE
= 500;
5857 /* If already on a newline, just consume it to avoid unintended
5858 skipping over invisible text below. */
5859 if (it
->what
== IT_CHARACTER
5861 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5863 if (it
->bidi_p
&& bidi_it_prev
)
5864 *bidi_it_prev
= it
->bidi_it
;
5865 set_iterator_to_next (it
, 0);
5870 /* Don't handle selective display in the following. It's (a)
5871 unnecessary because it's done by the caller, and (b) leads to an
5872 infinite recursion because next_element_from_ellipsis indirectly
5873 calls this function. */
5874 old_selective
= it
->selective
;
5877 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5878 from buffer text. */
5879 for (n
= newline_found_p
= 0;
5880 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5881 n
+= STRINGP (it
->string
) ? 0 : 1)
5883 if (!get_next_display_element (it
))
5885 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5886 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5887 *bidi_it_prev
= it
->bidi_it
;
5888 set_iterator_to_next (it
, 0);
5891 /* If we didn't find a newline near enough, see if we can use a
5893 if (!newline_found_p
)
5895 ptrdiff_t start
= IT_CHARPOS (*it
);
5896 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5899 xassert (!STRINGP (it
->string
));
5901 /* If there isn't any `display' property in sight, and no
5902 overlays, we can just use the position of the newline in
5904 if (it
->stop_charpos
>= limit
5905 || ((pos
= Fnext_single_property_change (make_number (start
),
5907 make_number (limit
)),
5909 && next_overlay_change (start
) == ZV
))
5913 IT_CHARPOS (*it
) = limit
;
5914 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5918 struct bidi_it bprev
;
5920 /* Help bidi.c avoid expensive searches for display
5921 properties and overlays, by telling it that there are
5922 none up to `limit'. */
5923 if (it
->bidi_it
.disp_pos
< limit
)
5925 it
->bidi_it
.disp_pos
= limit
;
5926 it
->bidi_it
.disp_prop
= 0;
5929 bprev
= it
->bidi_it
;
5930 bidi_move_to_visually_next (&it
->bidi_it
);
5931 } while (it
->bidi_it
.charpos
!= limit
);
5932 IT_CHARPOS (*it
) = limit
;
5933 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5935 *bidi_it_prev
= bprev
;
5937 *skipped_p
= newline_found_p
= 1;
5941 while (get_next_display_element (it
)
5942 && !newline_found_p
)
5944 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5945 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5946 *bidi_it_prev
= it
->bidi_it
;
5947 set_iterator_to_next (it
, 0);
5952 it
->selective
= old_selective
;
5953 return newline_found_p
;
5957 /* Set IT's current position to the previous visible line start. Skip
5958 invisible text that is so either due to text properties or due to
5959 selective display. Caution: this does not change IT->current_x and
5963 back_to_previous_visible_line_start (struct it
*it
)
5965 while (IT_CHARPOS (*it
) > BEGV
)
5967 back_to_previous_line_start (it
);
5969 if (IT_CHARPOS (*it
) <= BEGV
)
5972 /* If selective > 0, then lines indented more than its value are
5974 if (it
->selective
> 0
5975 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5979 /* Check the newline before point for invisibility. */
5982 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5983 Qinvisible
, it
->window
);
5984 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5988 if (IT_CHARPOS (*it
) <= BEGV
)
5993 void *it2data
= NULL
;
5996 Lisp_Object val
, overlay
;
5998 SAVE_IT (it2
, *it
, it2data
);
6000 /* If newline is part of a composition, continue from start of composition */
6001 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6002 && beg
< IT_CHARPOS (*it
))
6005 /* If newline is replaced by a display property, find start of overlay
6006 or interval and continue search from that point. */
6007 pos
= --IT_CHARPOS (it2
);
6010 bidi_unshelve_cache (NULL
, 0);
6011 it2
.string_from_display_prop_p
= 0;
6012 it2
.from_disp_prop_p
= 0;
6013 if (handle_display_prop (&it2
) == HANDLED_RETURN
6014 && !NILP (val
= get_char_property_and_overlay
6015 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6016 && (OVERLAYP (overlay
)
6017 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6018 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6020 RESTORE_IT (it
, it
, it2data
);
6024 /* Newline is not replaced by anything -- so we are done. */
6025 RESTORE_IT (it
, it
, it2data
);
6031 IT_CHARPOS (*it
) = beg
;
6032 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6036 it
->continuation_lines_width
= 0;
6038 xassert (IT_CHARPOS (*it
) >= BEGV
);
6039 xassert (IT_CHARPOS (*it
) == BEGV
6040 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6045 /* Reseat iterator IT at the previous visible line start. Skip
6046 invisible text that is so either due to text properties or due to
6047 selective display. At the end, update IT's overlay information,
6048 face information etc. */
6051 reseat_at_previous_visible_line_start (struct it
*it
)
6053 back_to_previous_visible_line_start (it
);
6054 reseat (it
, it
->current
.pos
, 1);
6059 /* Reseat iterator IT on the next visible line start in the current
6060 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6061 preceding the line start. Skip over invisible text that is so
6062 because of selective display. Compute faces, overlays etc at the
6063 new position. Note that this function does not skip over text that
6064 is invisible because of text properties. */
6067 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6069 int newline_found_p
, skipped_p
= 0;
6070 struct bidi_it bidi_it_prev
;
6072 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6074 /* Skip over lines that are invisible because they are indented
6075 more than the value of IT->selective. */
6076 if (it
->selective
> 0)
6077 while (IT_CHARPOS (*it
) < ZV
6078 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6081 xassert (IT_BYTEPOS (*it
) == BEGV
6082 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6084 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6087 /* Position on the newline if that's what's requested. */
6088 if (on_newline_p
&& newline_found_p
)
6090 if (STRINGP (it
->string
))
6092 if (IT_STRING_CHARPOS (*it
) > 0)
6096 --IT_STRING_CHARPOS (*it
);
6097 --IT_STRING_BYTEPOS (*it
);
6101 /* We need to restore the bidi iterator to the state
6102 it had on the newline, and resync the IT's
6103 position with that. */
6104 it
->bidi_it
= bidi_it_prev
;
6105 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6106 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6110 else if (IT_CHARPOS (*it
) > BEGV
)
6119 /* We need to restore the bidi iterator to the state it
6120 had on the newline and resync IT with that. */
6121 it
->bidi_it
= bidi_it_prev
;
6122 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6123 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6125 reseat (it
, it
->current
.pos
, 0);
6129 reseat (it
, it
->current
.pos
, 0);
6136 /***********************************************************************
6137 Changing an iterator's position
6138 ***********************************************************************/
6140 /* Change IT's current position to POS in current_buffer. If FORCE_P
6141 is non-zero, always check for text properties at the new position.
6142 Otherwise, text properties are only looked up if POS >=
6143 IT->check_charpos of a property. */
6146 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6148 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6150 reseat_1 (it
, pos
, 0);
6152 /* Determine where to check text properties. Avoid doing it
6153 where possible because text property lookup is very expensive. */
6155 || CHARPOS (pos
) > it
->stop_charpos
6156 || CHARPOS (pos
) < original_pos
)
6160 /* For bidi iteration, we need to prime prev_stop and
6161 base_level_stop with our best estimations. */
6162 /* Implementation note: Of course, POS is not necessarily a
6163 stop position, so assigning prev_pos to it is a lie; we
6164 should have called compute_stop_backwards. However, if
6165 the current buffer does not include any R2L characters,
6166 that call would be a waste of cycles, because the
6167 iterator will never move back, and thus never cross this
6168 "fake" stop position. So we delay that backward search
6169 until the time we really need it, in next_element_from_buffer. */
6170 if (CHARPOS (pos
) != it
->prev_stop
)
6171 it
->prev_stop
= CHARPOS (pos
);
6172 if (CHARPOS (pos
) < it
->base_level_stop
)
6173 it
->base_level_stop
= 0; /* meaning it's unknown */
6179 it
->prev_stop
= it
->base_level_stop
= 0;
6188 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6189 IT->stop_pos to POS, also. */
6192 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6194 /* Don't call this function when scanning a C string. */
6195 xassert (it
->s
== NULL
);
6197 /* POS must be a reasonable value. */
6198 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6200 it
->current
.pos
= it
->position
= pos
;
6201 it
->end_charpos
= ZV
;
6203 it
->current
.dpvec_index
= -1;
6204 it
->current
.overlay_string_index
= -1;
6205 IT_STRING_CHARPOS (*it
) = -1;
6206 IT_STRING_BYTEPOS (*it
) = -1;
6208 it
->method
= GET_FROM_BUFFER
;
6209 it
->object
= it
->w
->buffer
;
6210 it
->area
= TEXT_AREA
;
6211 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6213 it
->string_from_display_prop_p
= 0;
6214 it
->string_from_prefix_prop_p
= 0;
6216 it
->from_disp_prop_p
= 0;
6217 it
->face_before_selective_p
= 0;
6220 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6222 bidi_unshelve_cache (NULL
, 0);
6223 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6224 it
->bidi_it
.string
.s
= NULL
;
6225 it
->bidi_it
.string
.lstring
= Qnil
;
6226 it
->bidi_it
.string
.bufpos
= 0;
6227 it
->bidi_it
.string
.unibyte
= 0;
6232 it
->stop_charpos
= CHARPOS (pos
);
6233 it
->base_level_stop
= CHARPOS (pos
);
6238 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6239 If S is non-null, it is a C string to iterate over. Otherwise,
6240 STRING gives a Lisp string to iterate over.
6242 If PRECISION > 0, don't return more then PRECISION number of
6243 characters from the string.
6245 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6246 characters have been returned. FIELD_WIDTH < 0 means an infinite
6249 MULTIBYTE = 0 means disable processing of multibyte characters,
6250 MULTIBYTE > 0 means enable it,
6251 MULTIBYTE < 0 means use IT->multibyte_p.
6253 IT must be initialized via a prior call to init_iterator before
6254 calling this function. */
6257 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6258 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6261 /* No region in strings. */
6262 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6264 /* No text property checks performed by default, but see below. */
6265 it
->stop_charpos
= -1;
6267 /* Set iterator position and end position. */
6268 memset (&it
->current
, 0, sizeof it
->current
);
6269 it
->current
.overlay_string_index
= -1;
6270 it
->current
.dpvec_index
= -1;
6271 xassert (charpos
>= 0);
6273 /* If STRING is specified, use its multibyteness, otherwise use the
6274 setting of MULTIBYTE, if specified. */
6276 it
->multibyte_p
= multibyte
> 0;
6278 /* Bidirectional reordering of strings is controlled by the default
6279 value of bidi-display-reordering. Don't try to reorder while
6280 loading loadup.el, as the necessary character property tables are
6281 not yet available. */
6284 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6288 xassert (STRINGP (string
));
6289 it
->string
= string
;
6291 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6292 it
->method
= GET_FROM_STRING
;
6293 it
->current
.string_pos
= string_pos (charpos
, string
);
6297 it
->bidi_it
.string
.lstring
= string
;
6298 it
->bidi_it
.string
.s
= NULL
;
6299 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6300 it
->bidi_it
.string
.bufpos
= 0;
6301 it
->bidi_it
.string
.from_disp_str
= 0;
6302 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6303 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6304 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6309 it
->s
= (const unsigned char *) s
;
6312 /* Note that we use IT->current.pos, not it->current.string_pos,
6313 for displaying C strings. */
6314 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6315 if (it
->multibyte_p
)
6317 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6318 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6322 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6323 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6328 it
->bidi_it
.string
.lstring
= Qnil
;
6329 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6330 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6331 it
->bidi_it
.string
.bufpos
= 0;
6332 it
->bidi_it
.string
.from_disp_str
= 0;
6333 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6334 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6337 it
->method
= GET_FROM_C_STRING
;
6340 /* PRECISION > 0 means don't return more than PRECISION characters
6342 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6344 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6346 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6349 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6350 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6351 FIELD_WIDTH < 0 means infinite field width. This is useful for
6352 padding with `-' at the end of a mode line. */
6353 if (field_width
< 0)
6354 field_width
= INFINITY
;
6355 /* Implementation note: We deliberately don't enlarge
6356 it->bidi_it.string.schars here to fit it->end_charpos, because
6357 the bidi iterator cannot produce characters out of thin air. */
6358 if (field_width
> it
->end_charpos
- charpos
)
6359 it
->end_charpos
= charpos
+ field_width
;
6361 /* Use the standard display table for displaying strings. */
6362 if (DISP_TABLE_P (Vstandard_display_table
))
6363 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6365 it
->stop_charpos
= charpos
;
6366 it
->prev_stop
= charpos
;
6367 it
->base_level_stop
= 0;
6370 it
->bidi_it
.first_elt
= 1;
6371 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6372 it
->bidi_it
.disp_pos
= -1;
6374 if (s
== NULL
&& it
->multibyte_p
)
6376 ptrdiff_t endpos
= SCHARS (it
->string
);
6377 if (endpos
> it
->end_charpos
)
6378 endpos
= it
->end_charpos
;
6379 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6387 /***********************************************************************
6389 ***********************************************************************/
6391 /* Map enum it_method value to corresponding next_element_from_* function. */
6393 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6395 next_element_from_buffer
,
6396 next_element_from_display_vector
,
6397 next_element_from_string
,
6398 next_element_from_c_string
,
6399 next_element_from_image
,
6400 next_element_from_stretch
6403 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6406 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6407 (possibly with the following characters). */
6409 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6410 ((IT)->cmp_it.id >= 0 \
6411 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6412 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6413 END_CHARPOS, (IT)->w, \
6414 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6418 /* Lookup the char-table Vglyphless_char_display for character C (-1
6419 if we want information for no-font case), and return the display
6420 method symbol. By side-effect, update it->what and
6421 it->glyphless_method. This function is called from
6422 get_next_display_element for each character element, and from
6423 x_produce_glyphs when no suitable font was found. */
6426 lookup_glyphless_char_display (int c
, struct it
*it
)
6428 Lisp_Object glyphless_method
= Qnil
;
6430 if (CHAR_TABLE_P (Vglyphless_char_display
)
6431 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6435 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6436 if (CONSP (glyphless_method
))
6437 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6438 ? XCAR (glyphless_method
)
6439 : XCDR (glyphless_method
);
6442 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6446 if (NILP (glyphless_method
))
6449 /* The default is to display the character by a proper font. */
6451 /* The default for the no-font case is to display an empty box. */
6452 glyphless_method
= Qempty_box
;
6454 if (EQ (glyphless_method
, Qzero_width
))
6457 return glyphless_method
;
6458 /* This method can't be used for the no-font case. */
6459 glyphless_method
= Qempty_box
;
6461 if (EQ (glyphless_method
, Qthin_space
))
6462 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6463 else if (EQ (glyphless_method
, Qempty_box
))
6464 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6465 else if (EQ (glyphless_method
, Qhex_code
))
6466 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6467 else if (STRINGP (glyphless_method
))
6468 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6471 /* Invalid value. We use the default method. */
6472 glyphless_method
= Qnil
;
6475 it
->what
= IT_GLYPHLESS
;
6476 return glyphless_method
;
6479 /* Load IT's display element fields with information about the next
6480 display element from the current position of IT. Value is zero if
6481 end of buffer (or C string) is reached. */
6483 static struct frame
*last_escape_glyph_frame
= NULL
;
6484 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6485 static int last_escape_glyph_merged_face_id
= 0;
6487 struct frame
*last_glyphless_glyph_frame
= NULL
;
6488 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6489 int last_glyphless_glyph_merged_face_id
= 0;
6492 get_next_display_element (struct it
*it
)
6494 /* Non-zero means that we found a display element. Zero means that
6495 we hit the end of what we iterate over. Performance note: the
6496 function pointer `method' used here turns out to be faster than
6497 using a sequence of if-statements. */
6501 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6503 if (it
->what
== IT_CHARACTER
)
6505 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6506 and only if (a) the resolved directionality of that character
6508 /* FIXME: Do we need an exception for characters from display
6510 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6511 it
->c
= bidi_mirror_char (it
->c
);
6512 /* Map via display table or translate control characters.
6513 IT->c, IT->len etc. have been set to the next character by
6514 the function call above. If we have a display table, and it
6515 contains an entry for IT->c, translate it. Don't do this if
6516 IT->c itself comes from a display table, otherwise we could
6517 end up in an infinite recursion. (An alternative could be to
6518 count the recursion depth of this function and signal an
6519 error when a certain maximum depth is reached.) Is it worth
6521 if (success_p
&& it
->dpvec
== NULL
)
6524 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6525 int nonascii_space_p
= 0;
6526 int nonascii_hyphen_p
= 0;
6527 int c
= it
->c
; /* This is the character to display. */
6529 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6531 xassert (SINGLE_BYTE_CHAR_P (c
));
6532 if (unibyte_display_via_language_environment
)
6534 c
= DECODE_CHAR (unibyte
, c
);
6536 c
= BYTE8_TO_CHAR (it
->c
);
6539 c
= BYTE8_TO_CHAR (it
->c
);
6543 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6546 struct Lisp_Vector
*v
= XVECTOR (dv
);
6548 /* Return the first character from the display table
6549 entry, if not empty. If empty, don't display the
6550 current character. */
6553 it
->dpvec_char_len
= it
->len
;
6554 it
->dpvec
= v
->contents
;
6555 it
->dpend
= v
->contents
+ v
->header
.size
;
6556 it
->current
.dpvec_index
= 0;
6557 it
->dpvec_face_id
= -1;
6558 it
->saved_face_id
= it
->face_id
;
6559 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6564 set_iterator_to_next (it
, 0);
6569 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6571 if (it
->what
== IT_GLYPHLESS
)
6573 /* Don't display this character. */
6574 set_iterator_to_next (it
, 0);
6578 /* If `nobreak-char-display' is non-nil, we display
6579 non-ASCII spaces and hyphens specially. */
6580 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6583 nonascii_space_p
= 1;
6584 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6585 nonascii_hyphen_p
= 1;
6588 /* Translate control characters into `\003' or `^C' form.
6589 Control characters coming from a display table entry are
6590 currently not translated because we use IT->dpvec to hold
6591 the translation. This could easily be changed but I
6592 don't believe that it is worth doing.
6594 The characters handled by `nobreak-char-display' must be
6597 Non-printable characters and raw-byte characters are also
6598 translated to octal form. */
6599 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6600 ? (it
->area
!= TEXT_AREA
6601 /* In mode line, treat \n, \t like other crl chars. */
6604 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6605 || (c
!= '\n' && c
!= '\t'))
6607 || nonascii_hyphen_p
6609 || ! CHAR_PRINTABLE_P (c
))))
6611 /* C is a control character, non-ASCII space/hyphen,
6612 raw-byte, or a non-printable character which must be
6613 displayed either as '\003' or as `^C' where the '\\'
6614 and '^' can be defined in the display table. Fill
6615 IT->ctl_chars with glyphs for what we have to
6616 display. Then, set IT->dpvec to these glyphs. */
6623 /* Handle control characters with ^. */
6625 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6629 g
= '^'; /* default glyph for Control */
6630 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6632 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6634 g
= GLYPH_CODE_CHAR (gc
);
6635 lface_id
= GLYPH_CODE_FACE (gc
);
6639 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6641 else if (it
->f
== last_escape_glyph_frame
6642 && it
->face_id
== last_escape_glyph_face_id
)
6644 face_id
= last_escape_glyph_merged_face_id
;
6648 /* Merge the escape-glyph face into the current face. */
6649 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6651 last_escape_glyph_frame
= it
->f
;
6652 last_escape_glyph_face_id
= it
->face_id
;
6653 last_escape_glyph_merged_face_id
= face_id
;
6656 XSETINT (it
->ctl_chars
[0], g
);
6657 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6659 goto display_control
;
6662 /* Handle non-ascii space in the mode where it only gets
6665 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6667 /* Merge `nobreak-space' into the current face. */
6668 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6670 XSETINT (it
->ctl_chars
[0], ' ');
6672 goto display_control
;
6675 /* Handle sequences that start with the "escape glyph". */
6677 /* the default escape glyph is \. */
6678 escape_glyph
= '\\';
6681 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6683 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6684 lface_id
= GLYPH_CODE_FACE (gc
);
6688 /* The display table specified a face.
6689 Merge it into face_id and also into escape_glyph. */
6690 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6693 else if (it
->f
== last_escape_glyph_frame
6694 && it
->face_id
== last_escape_glyph_face_id
)
6696 face_id
= last_escape_glyph_merged_face_id
;
6700 /* Merge the escape-glyph face into the current face. */
6701 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6703 last_escape_glyph_frame
= it
->f
;
6704 last_escape_glyph_face_id
= it
->face_id
;
6705 last_escape_glyph_merged_face_id
= face_id
;
6708 /* Draw non-ASCII hyphen with just highlighting: */
6710 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6712 XSETINT (it
->ctl_chars
[0], '-');
6714 goto display_control
;
6717 /* Draw non-ASCII space/hyphen with escape glyph: */
6719 if (nonascii_space_p
|| nonascii_hyphen_p
)
6721 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6722 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6724 goto display_control
;
6731 if (CHAR_BYTE8_P (c
))
6732 /* Display \200 instead of \17777600. */
6733 c
= CHAR_TO_BYTE8 (c
);
6734 len
= sprintf (str
, "%03o", c
);
6736 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6737 for (i
= 0; i
< len
; i
++)
6738 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6743 /* Set up IT->dpvec and return first character from it. */
6744 it
->dpvec_char_len
= it
->len
;
6745 it
->dpvec
= it
->ctl_chars
;
6746 it
->dpend
= it
->dpvec
+ ctl_len
;
6747 it
->current
.dpvec_index
= 0;
6748 it
->dpvec_face_id
= face_id
;
6749 it
->saved_face_id
= it
->face_id
;
6750 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6754 it
->char_to_display
= c
;
6758 it
->char_to_display
= it
->c
;
6762 /* Adjust face id for a multibyte character. There are no multibyte
6763 character in unibyte text. */
6764 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6767 && FRAME_WINDOW_P (it
->f
))
6769 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6771 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6773 /* Automatic composition with glyph-string. */
6774 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6776 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6780 ptrdiff_t pos
= (it
->s
? -1
6781 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6782 : IT_CHARPOS (*it
));
6785 if (it
->what
== IT_CHARACTER
)
6786 c
= it
->char_to_display
;
6789 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6793 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6794 /* TAB in a composition means display glyphs with
6795 padding space on the left or right. */
6796 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6799 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6804 /* Is this character the last one of a run of characters with
6805 box? If yes, set IT->end_of_box_run_p to 1. */
6809 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6811 int face_id
= underlying_face_id (it
);
6812 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6816 if (face
->box
== FACE_NO_BOX
)
6818 /* If the box comes from face properties in a
6819 display string, check faces in that string. */
6820 int string_face_id
= face_after_it_pos (it
);
6821 it
->end_of_box_run_p
6822 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6825 /* Otherwise, the box comes from the underlying face.
6826 If this is the last string character displayed, check
6827 the next buffer location. */
6828 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6829 && (it
->current
.overlay_string_index
6830 == it
->n_overlay_strings
- 1))
6834 struct text_pos pos
= it
->current
.pos
;
6835 INC_TEXT_POS (pos
, it
->multibyte_p
);
6837 next_face_id
= face_at_buffer_position
6838 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6839 it
->region_end_charpos
, &ignore
,
6840 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6842 it
->end_of_box_run_p
6843 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6850 int face_id
= face_after_it_pos (it
);
6851 it
->end_of_box_run_p
6852 = (face_id
!= it
->face_id
6853 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6856 /* If we reached the end of the object we've been iterating (e.g., a
6857 display string or an overlay string), and there's something on
6858 IT->stack, proceed with what's on the stack. It doesn't make
6859 sense to return zero if there's unprocessed stuff on the stack,
6860 because otherwise that stuff will never be displayed. */
6861 if (!success_p
&& it
->sp
> 0)
6863 set_iterator_to_next (it
, 0);
6864 success_p
= get_next_display_element (it
);
6867 /* Value is 0 if end of buffer or string reached. */
6872 /* Move IT to the next display element.
6874 RESEAT_P non-zero means if called on a newline in buffer text,
6875 skip to the next visible line start.
6877 Functions get_next_display_element and set_iterator_to_next are
6878 separate because I find this arrangement easier to handle than a
6879 get_next_display_element function that also increments IT's
6880 position. The way it is we can first look at an iterator's current
6881 display element, decide whether it fits on a line, and if it does,
6882 increment the iterator position. The other way around we probably
6883 would either need a flag indicating whether the iterator has to be
6884 incremented the next time, or we would have to implement a
6885 decrement position function which would not be easy to write. */
6888 set_iterator_to_next (struct it
*it
, int reseat_p
)
6890 /* Reset flags indicating start and end of a sequence of characters
6891 with box. Reset them at the start of this function because
6892 moving the iterator to a new position might set them. */
6893 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6897 case GET_FROM_BUFFER
:
6898 /* The current display element of IT is a character from
6899 current_buffer. Advance in the buffer, and maybe skip over
6900 invisible lines that are so because of selective display. */
6901 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6902 reseat_at_next_visible_line_start (it
, 0);
6903 else if (it
->cmp_it
.id
>= 0)
6905 /* We are currently getting glyphs from a composition. */
6910 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6911 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6912 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6914 it
->cmp_it
.from
= it
->cmp_it
.to
;
6919 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6921 it
->end_charpos
, Qnil
);
6924 else if (! it
->cmp_it
.reversed_p
)
6926 /* Composition created while scanning forward. */
6927 /* Update IT's char/byte positions to point to the first
6928 character of the next grapheme cluster, or to the
6929 character visually after the current composition. */
6930 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6931 bidi_move_to_visually_next (&it
->bidi_it
);
6932 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6933 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6935 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6937 /* Proceed to the next grapheme cluster. */
6938 it
->cmp_it
.from
= it
->cmp_it
.to
;
6942 /* No more grapheme clusters in this composition.
6943 Find the next stop position. */
6944 ptrdiff_t stop
= it
->end_charpos
;
6945 if (it
->bidi_it
.scan_dir
< 0)
6946 /* Now we are scanning backward and don't know
6949 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6950 IT_BYTEPOS (*it
), stop
, Qnil
);
6955 /* Composition created while scanning backward. */
6956 /* Update IT's char/byte positions to point to the last
6957 character of the previous grapheme cluster, or the
6958 character visually after the current composition. */
6959 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6960 bidi_move_to_visually_next (&it
->bidi_it
);
6961 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6962 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6963 if (it
->cmp_it
.from
> 0)
6965 /* Proceed to the previous grapheme cluster. */
6966 it
->cmp_it
.to
= it
->cmp_it
.from
;
6970 /* No more grapheme clusters in this composition.
6971 Find the next stop position. */
6972 ptrdiff_t stop
= it
->end_charpos
;
6973 if (it
->bidi_it
.scan_dir
< 0)
6974 /* Now we are scanning backward and don't know
6977 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6978 IT_BYTEPOS (*it
), stop
, Qnil
);
6984 xassert (it
->len
!= 0);
6988 IT_BYTEPOS (*it
) += it
->len
;
6989 IT_CHARPOS (*it
) += 1;
6993 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6994 /* If this is a new paragraph, determine its base
6995 direction (a.k.a. its base embedding level). */
6996 if (it
->bidi_it
.new_paragraph
)
6997 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6998 bidi_move_to_visually_next (&it
->bidi_it
);
6999 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7000 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7001 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7003 /* As the scan direction was changed, we must
7004 re-compute the stop position for composition. */
7005 ptrdiff_t stop
= it
->end_charpos
;
7006 if (it
->bidi_it
.scan_dir
< 0)
7008 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7009 IT_BYTEPOS (*it
), stop
, Qnil
);
7012 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7016 case GET_FROM_C_STRING
:
7017 /* Current display element of IT is from a C string. */
7019 /* If the string position is beyond string's end, it means
7020 next_element_from_c_string is padding the string with
7021 blanks, in which case we bypass the bidi iterator,
7022 because it cannot deal with such virtual characters. */
7023 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7025 IT_BYTEPOS (*it
) += it
->len
;
7026 IT_CHARPOS (*it
) += 1;
7030 bidi_move_to_visually_next (&it
->bidi_it
);
7031 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7032 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7036 case GET_FROM_DISPLAY_VECTOR
:
7037 /* Current display element of IT is from a display table entry.
7038 Advance in the display table definition. Reset it to null if
7039 end reached, and continue with characters from buffers/
7041 ++it
->current
.dpvec_index
;
7043 /* Restore face of the iterator to what they were before the
7044 display vector entry (these entries may contain faces). */
7045 it
->face_id
= it
->saved_face_id
;
7047 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7049 int recheck_faces
= it
->ellipsis_p
;
7052 it
->method
= GET_FROM_C_STRING
;
7053 else if (STRINGP (it
->string
))
7054 it
->method
= GET_FROM_STRING
;
7057 it
->method
= GET_FROM_BUFFER
;
7058 it
->object
= it
->w
->buffer
;
7062 it
->current
.dpvec_index
= -1;
7064 /* Skip over characters which were displayed via IT->dpvec. */
7065 if (it
->dpvec_char_len
< 0)
7066 reseat_at_next_visible_line_start (it
, 1);
7067 else if (it
->dpvec_char_len
> 0)
7069 if (it
->method
== GET_FROM_STRING
7070 && it
->n_overlay_strings
> 0)
7071 it
->ignore_overlay_strings_at_pos_p
= 1;
7072 it
->len
= it
->dpvec_char_len
;
7073 set_iterator_to_next (it
, reseat_p
);
7076 /* Maybe recheck faces after display vector */
7078 it
->stop_charpos
= IT_CHARPOS (*it
);
7082 case GET_FROM_STRING
:
7083 /* Current display element is a character from a Lisp string. */
7084 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
7085 /* Don't advance past string end. These conditions are true
7086 when set_iterator_to_next is called at the end of
7087 get_next_display_element, in which case the Lisp string is
7088 already exhausted, and all we want is pop the iterator
7090 if (it
->current
.overlay_string_index
>= 0)
7092 /* This is an overlay string, so there's no padding with
7093 spaces, and the number of characters in the string is
7094 where the string ends. */
7095 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7096 goto consider_string_end
;
7100 /* Not an overlay string. There could be padding, so test
7101 against it->end_charpos . */
7102 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7103 goto consider_string_end
;
7105 if (it
->cmp_it
.id
>= 0)
7111 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7112 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7113 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7114 it
->cmp_it
.from
= it
->cmp_it
.to
;
7118 composition_compute_stop_pos (&it
->cmp_it
,
7119 IT_STRING_CHARPOS (*it
),
7120 IT_STRING_BYTEPOS (*it
),
7121 it
->end_charpos
, it
->string
);
7124 else if (! it
->cmp_it
.reversed_p
)
7126 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7127 bidi_move_to_visually_next (&it
->bidi_it
);
7128 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7129 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7131 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7132 it
->cmp_it
.from
= it
->cmp_it
.to
;
7135 ptrdiff_t stop
= it
->end_charpos
;
7136 if (it
->bidi_it
.scan_dir
< 0)
7138 composition_compute_stop_pos (&it
->cmp_it
,
7139 IT_STRING_CHARPOS (*it
),
7140 IT_STRING_BYTEPOS (*it
), stop
,
7146 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7147 bidi_move_to_visually_next (&it
->bidi_it
);
7148 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7149 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7150 if (it
->cmp_it
.from
> 0)
7151 it
->cmp_it
.to
= it
->cmp_it
.from
;
7154 ptrdiff_t stop
= it
->end_charpos
;
7155 if (it
->bidi_it
.scan_dir
< 0)
7157 composition_compute_stop_pos (&it
->cmp_it
,
7158 IT_STRING_CHARPOS (*it
),
7159 IT_STRING_BYTEPOS (*it
), stop
,
7167 /* If the string position is beyond string's end, it
7168 means next_element_from_string is padding the string
7169 with blanks, in which case we bypass the bidi
7170 iterator, because it cannot deal with such virtual
7172 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7174 IT_STRING_BYTEPOS (*it
) += it
->len
;
7175 IT_STRING_CHARPOS (*it
) += 1;
7179 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7181 bidi_move_to_visually_next (&it
->bidi_it
);
7182 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7183 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7184 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7186 ptrdiff_t stop
= it
->end_charpos
;
7188 if (it
->bidi_it
.scan_dir
< 0)
7190 composition_compute_stop_pos (&it
->cmp_it
,
7191 IT_STRING_CHARPOS (*it
),
7192 IT_STRING_BYTEPOS (*it
), stop
,
7198 consider_string_end
:
7200 if (it
->current
.overlay_string_index
>= 0)
7202 /* IT->string is an overlay string. Advance to the
7203 next, if there is one. */
7204 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7207 next_overlay_string (it
);
7209 setup_for_ellipsis (it
, 0);
7214 /* IT->string is not an overlay string. If we reached
7215 its end, and there is something on IT->stack, proceed
7216 with what is on the stack. This can be either another
7217 string, this time an overlay string, or a buffer. */
7218 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7222 if (it
->method
== GET_FROM_STRING
)
7223 goto consider_string_end
;
7228 case GET_FROM_IMAGE
:
7229 case GET_FROM_STRETCH
:
7230 /* The position etc with which we have to proceed are on
7231 the stack. The position may be at the end of a string,
7232 if the `display' property takes up the whole string. */
7233 xassert (it
->sp
> 0);
7235 if (it
->method
== GET_FROM_STRING
)
7236 goto consider_string_end
;
7240 /* There are no other methods defined, so this should be a bug. */
7244 xassert (it
->method
!= GET_FROM_STRING
7245 || (STRINGP (it
->string
)
7246 && IT_STRING_CHARPOS (*it
) >= 0));
7249 /* Load IT's display element fields with information about the next
7250 display element which comes from a display table entry or from the
7251 result of translating a control character to one of the forms `^C'
7254 IT->dpvec holds the glyphs to return as characters.
7255 IT->saved_face_id holds the face id before the display vector--it
7256 is restored into IT->face_id in set_iterator_to_next. */
7259 next_element_from_display_vector (struct it
*it
)
7264 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7266 it
->face_id
= it
->saved_face_id
;
7268 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7269 That seemed totally bogus - so I changed it... */
7270 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7272 if (GLYPH_CODE_P (gc
))
7274 it
->c
= GLYPH_CODE_CHAR (gc
);
7275 it
->len
= CHAR_BYTES (it
->c
);
7277 /* The entry may contain a face id to use. Such a face id is
7278 the id of a Lisp face, not a realized face. A face id of
7279 zero means no face is specified. */
7280 if (it
->dpvec_face_id
>= 0)
7281 it
->face_id
= it
->dpvec_face_id
;
7284 int lface_id
= GLYPH_CODE_FACE (gc
);
7286 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7291 /* Display table entry is invalid. Return a space. */
7292 it
->c
= ' ', it
->len
= 1;
7294 /* Don't change position and object of the iterator here. They are
7295 still the values of the character that had this display table
7296 entry or was translated, and that's what we want. */
7297 it
->what
= IT_CHARACTER
;
7301 /* Get the first element of string/buffer in the visual order, after
7302 being reseated to a new position in a string or a buffer. */
7304 get_visually_first_element (struct it
*it
)
7306 int string_p
= STRINGP (it
->string
) || it
->s
;
7307 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7308 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7310 if (STRINGP (it
->string
))
7312 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7313 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7317 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7318 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7321 if (it
->bidi_it
.charpos
== eob
)
7323 /* Nothing to do, but reset the FIRST_ELT flag, like
7324 bidi_paragraph_init does, because we are not going to
7326 it
->bidi_it
.first_elt
= 0;
7328 else if (it
->bidi_it
.charpos
== bob
7330 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7331 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7333 /* If we are at the beginning of a line/string, we can produce
7334 the next element right away. */
7335 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7336 bidi_move_to_visually_next (&it
->bidi_it
);
7340 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7342 /* We need to prime the bidi iterator starting at the line's or
7343 string's beginning, before we will be able to produce the
7346 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7349 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7351 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7353 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7356 /* Now return to buffer/string position where we were asked
7357 to get the next display element, and produce that. */
7358 bidi_move_to_visually_next (&it
->bidi_it
);
7360 while (it
->bidi_it
.bytepos
!= orig_bytepos
7361 && it
->bidi_it
.charpos
< eob
);
7364 /* Adjust IT's position information to where we ended up. */
7365 if (STRINGP (it
->string
))
7367 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7368 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7372 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7373 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7376 if (STRINGP (it
->string
) || !it
->s
)
7378 ptrdiff_t stop
, charpos
, bytepos
;
7380 if (STRINGP (it
->string
))
7383 stop
= SCHARS (it
->string
);
7384 if (stop
> it
->end_charpos
)
7385 stop
= it
->end_charpos
;
7386 charpos
= IT_STRING_CHARPOS (*it
);
7387 bytepos
= IT_STRING_BYTEPOS (*it
);
7391 stop
= it
->end_charpos
;
7392 charpos
= IT_CHARPOS (*it
);
7393 bytepos
= IT_BYTEPOS (*it
);
7395 if (it
->bidi_it
.scan_dir
< 0)
7397 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7402 /* Load IT with the next display element from Lisp string IT->string.
7403 IT->current.string_pos is the current position within the string.
7404 If IT->current.overlay_string_index >= 0, the Lisp string is an
7408 next_element_from_string (struct it
*it
)
7410 struct text_pos position
;
7412 xassert (STRINGP (it
->string
));
7413 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7414 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7415 position
= it
->current
.string_pos
;
7417 /* With bidi reordering, the character to display might not be the
7418 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7419 that we were reseat()ed to a new string, whose paragraph
7420 direction is not known. */
7421 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7423 get_visually_first_element (it
);
7424 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7427 /* Time to check for invisible text? */
7428 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7430 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7433 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7434 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7436 /* With bidi non-linear iteration, we could find
7437 ourselves far beyond the last computed stop_charpos,
7438 with several other stop positions in between that we
7439 missed. Scan them all now, in buffer's logical
7440 order, until we find and handle the last stop_charpos
7441 that precedes our current position. */
7442 handle_stop_backwards (it
, it
->stop_charpos
);
7443 return GET_NEXT_DISPLAY_ELEMENT (it
);
7449 /* Take note of the stop position we just moved
7450 across, for when we will move back across it. */
7451 it
->prev_stop
= it
->stop_charpos
;
7452 /* If we are at base paragraph embedding level, take
7453 note of the last stop position seen at this
7455 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7456 it
->base_level_stop
= it
->stop_charpos
;
7460 /* Since a handler may have changed IT->method, we must
7462 return GET_NEXT_DISPLAY_ELEMENT (it
);
7466 /* If we are before prev_stop, we may have overstepped
7467 on our way backwards a stop_pos, and if so, we need
7468 to handle that stop_pos. */
7469 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7470 /* We can sometimes back up for reasons that have nothing
7471 to do with bidi reordering. E.g., compositions. The
7472 code below is only needed when we are above the base
7473 embedding level, so test for that explicitly. */
7474 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7476 /* If we lost track of base_level_stop, we have no better
7477 place for handle_stop_backwards to start from than string
7478 beginning. This happens, e.g., when we were reseated to
7479 the previous screenful of text by vertical-motion. */
7480 if (it
->base_level_stop
<= 0
7481 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7482 it
->base_level_stop
= 0;
7483 handle_stop_backwards (it
, it
->base_level_stop
);
7484 return GET_NEXT_DISPLAY_ELEMENT (it
);
7488 if (it
->current
.overlay_string_index
>= 0)
7490 /* Get the next character from an overlay string. In overlay
7491 strings, there is no field width or padding with spaces to
7493 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7498 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7499 IT_STRING_BYTEPOS (*it
),
7500 it
->bidi_it
.scan_dir
< 0
7502 : SCHARS (it
->string
))
7503 && next_element_from_composition (it
))
7507 else if (STRING_MULTIBYTE (it
->string
))
7509 const unsigned char *s
= (SDATA (it
->string
)
7510 + IT_STRING_BYTEPOS (*it
));
7511 it
->c
= string_char_and_length (s
, &it
->len
);
7515 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7521 /* Get the next character from a Lisp string that is not an
7522 overlay string. Such strings come from the mode line, for
7523 example. We may have to pad with spaces, or truncate the
7524 string. See also next_element_from_c_string. */
7525 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7530 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7532 /* Pad with spaces. */
7533 it
->c
= ' ', it
->len
= 1;
7534 CHARPOS (position
) = BYTEPOS (position
) = -1;
7536 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7537 IT_STRING_BYTEPOS (*it
),
7538 it
->bidi_it
.scan_dir
< 0
7540 : it
->string_nchars
)
7541 && next_element_from_composition (it
))
7545 else if (STRING_MULTIBYTE (it
->string
))
7547 const unsigned char *s
= (SDATA (it
->string
)
7548 + IT_STRING_BYTEPOS (*it
));
7549 it
->c
= string_char_and_length (s
, &it
->len
);
7553 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7558 /* Record what we have and where it came from. */
7559 it
->what
= IT_CHARACTER
;
7560 it
->object
= it
->string
;
7561 it
->position
= position
;
7566 /* Load IT with next display element from C string IT->s.
7567 IT->string_nchars is the maximum number of characters to return
7568 from the string. IT->end_charpos may be greater than
7569 IT->string_nchars when this function is called, in which case we
7570 may have to return padding spaces. Value is zero if end of string
7571 reached, including padding spaces. */
7574 next_element_from_c_string (struct it
*it
)
7579 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7580 it
->what
= IT_CHARACTER
;
7581 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7584 /* With bidi reordering, the character to display might not be the
7585 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7586 we were reseated to a new string, whose paragraph direction is
7588 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7589 get_visually_first_element (it
);
7591 /* IT's position can be greater than IT->string_nchars in case a
7592 field width or precision has been specified when the iterator was
7594 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7596 /* End of the game. */
7600 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7602 /* Pad with spaces. */
7603 it
->c
= ' ', it
->len
= 1;
7604 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7606 else if (it
->multibyte_p
)
7607 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7609 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7615 /* Set up IT to return characters from an ellipsis, if appropriate.
7616 The definition of the ellipsis glyphs may come from a display table
7617 entry. This function fills IT with the first glyph from the
7618 ellipsis if an ellipsis is to be displayed. */
7621 next_element_from_ellipsis (struct it
*it
)
7623 if (it
->selective_display_ellipsis_p
)
7624 setup_for_ellipsis (it
, it
->len
);
7627 /* The face at the current position may be different from the
7628 face we find after the invisible text. Remember what it
7629 was in IT->saved_face_id, and signal that it's there by
7630 setting face_before_selective_p. */
7631 it
->saved_face_id
= it
->face_id
;
7632 it
->method
= GET_FROM_BUFFER
;
7633 it
->object
= it
->w
->buffer
;
7634 reseat_at_next_visible_line_start (it
, 1);
7635 it
->face_before_selective_p
= 1;
7638 return GET_NEXT_DISPLAY_ELEMENT (it
);
7642 /* Deliver an image display element. The iterator IT is already
7643 filled with image information (done in handle_display_prop). Value
7648 next_element_from_image (struct it
*it
)
7650 it
->what
= IT_IMAGE
;
7651 it
->ignore_overlay_strings_at_pos_p
= 0;
7656 /* Fill iterator IT with next display element from a stretch glyph
7657 property. IT->object is the value of the text property. Value is
7661 next_element_from_stretch (struct it
*it
)
7663 it
->what
= IT_STRETCH
;
7667 /* Scan backwards from IT's current position until we find a stop
7668 position, or until BEGV. This is called when we find ourself
7669 before both the last known prev_stop and base_level_stop while
7670 reordering bidirectional text. */
7673 compute_stop_pos_backwards (struct it
*it
)
7675 const int SCAN_BACK_LIMIT
= 1000;
7676 struct text_pos pos
;
7677 struct display_pos save_current
= it
->current
;
7678 struct text_pos save_position
= it
->position
;
7679 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7680 ptrdiff_t where_we_are
= charpos
;
7681 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7682 ptrdiff_t save_end_pos
= it
->end_charpos
;
7684 xassert (NILP (it
->string
) && !it
->s
);
7685 xassert (it
->bidi_p
);
7689 it
->end_charpos
= min (charpos
+ 1, ZV
);
7690 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7691 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7692 reseat_1 (it
, pos
, 0);
7693 compute_stop_pos (it
);
7694 /* We must advance forward, right? */
7695 if (it
->stop_charpos
<= charpos
)
7698 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7700 if (it
->stop_charpos
<= where_we_are
)
7701 it
->prev_stop
= it
->stop_charpos
;
7703 it
->prev_stop
= BEGV
;
7705 it
->current
= save_current
;
7706 it
->position
= save_position
;
7707 it
->stop_charpos
= save_stop_pos
;
7708 it
->end_charpos
= save_end_pos
;
7711 /* Scan forward from CHARPOS in the current buffer/string, until we
7712 find a stop position > current IT's position. Then handle the stop
7713 position before that. This is called when we bump into a stop
7714 position while reordering bidirectional text. CHARPOS should be
7715 the last previously processed stop_pos (or BEGV/0, if none were
7716 processed yet) whose position is less that IT's current
7720 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7722 int bufp
= !STRINGP (it
->string
);
7723 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7724 struct display_pos save_current
= it
->current
;
7725 struct text_pos save_position
= it
->position
;
7726 struct text_pos pos1
;
7727 ptrdiff_t next_stop
;
7729 /* Scan in strict logical order. */
7730 xassert (it
->bidi_p
);
7734 it
->prev_stop
= charpos
;
7737 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7738 reseat_1 (it
, pos1
, 0);
7741 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7742 compute_stop_pos (it
);
7743 /* We must advance forward, right? */
7744 if (it
->stop_charpos
<= it
->prev_stop
)
7746 charpos
= it
->stop_charpos
;
7748 while (charpos
<= where_we_are
);
7751 it
->current
= save_current
;
7752 it
->position
= save_position
;
7753 next_stop
= it
->stop_charpos
;
7754 it
->stop_charpos
= it
->prev_stop
;
7756 it
->stop_charpos
= next_stop
;
7759 /* Load IT with the next display element from current_buffer. Value
7760 is zero if end of buffer reached. IT->stop_charpos is the next
7761 position at which to stop and check for text properties or buffer
7765 next_element_from_buffer (struct it
*it
)
7769 xassert (IT_CHARPOS (*it
) >= BEGV
);
7770 xassert (NILP (it
->string
) && !it
->s
);
7771 xassert (!it
->bidi_p
7772 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7773 && it
->bidi_it
.string
.s
== NULL
));
7775 /* With bidi reordering, the character to display might not be the
7776 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7777 we were reseat()ed to a new buffer position, which is potentially
7778 a different paragraph. */
7779 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7781 get_visually_first_element (it
);
7782 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7785 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7787 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7789 int overlay_strings_follow_p
;
7791 /* End of the game, except when overlay strings follow that
7792 haven't been returned yet. */
7793 if (it
->overlay_strings_at_end_processed_p
)
7794 overlay_strings_follow_p
= 0;
7797 it
->overlay_strings_at_end_processed_p
= 1;
7798 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7801 if (overlay_strings_follow_p
)
7802 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7806 it
->position
= it
->current
.pos
;
7810 else if (!(!it
->bidi_p
7811 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7812 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7814 /* With bidi non-linear iteration, we could find ourselves
7815 far beyond the last computed stop_charpos, with several
7816 other stop positions in between that we missed. Scan
7817 them all now, in buffer's logical order, until we find
7818 and handle the last stop_charpos that precedes our
7819 current position. */
7820 handle_stop_backwards (it
, it
->stop_charpos
);
7821 return GET_NEXT_DISPLAY_ELEMENT (it
);
7827 /* Take note of the stop position we just moved across,
7828 for when we will move back across it. */
7829 it
->prev_stop
= it
->stop_charpos
;
7830 /* If we are at base paragraph embedding level, take
7831 note of the last stop position seen at this
7833 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7834 it
->base_level_stop
= it
->stop_charpos
;
7837 return GET_NEXT_DISPLAY_ELEMENT (it
);
7841 /* If we are before prev_stop, we may have overstepped on
7842 our way backwards a stop_pos, and if so, we need to
7843 handle that stop_pos. */
7844 && IT_CHARPOS (*it
) < it
->prev_stop
7845 /* We can sometimes back up for reasons that have nothing
7846 to do with bidi reordering. E.g., compositions. The
7847 code below is only needed when we are above the base
7848 embedding level, so test for that explicitly. */
7849 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7851 if (it
->base_level_stop
<= 0
7852 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7854 /* If we lost track of base_level_stop, we need to find
7855 prev_stop by looking backwards. This happens, e.g., when
7856 we were reseated to the previous screenful of text by
7858 it
->base_level_stop
= BEGV
;
7859 compute_stop_pos_backwards (it
);
7860 handle_stop_backwards (it
, it
->prev_stop
);
7863 handle_stop_backwards (it
, it
->base_level_stop
);
7864 return GET_NEXT_DISPLAY_ELEMENT (it
);
7868 /* No face changes, overlays etc. in sight, so just return a
7869 character from current_buffer. */
7873 /* Maybe run the redisplay end trigger hook. Performance note:
7874 This doesn't seem to cost measurable time. */
7875 if (it
->redisplay_end_trigger_charpos
7877 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7878 run_redisplay_end_trigger_hook (it
);
7880 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7881 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7883 && next_element_from_composition (it
))
7888 /* Get the next character, maybe multibyte. */
7889 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7890 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7891 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7893 it
->c
= *p
, it
->len
= 1;
7895 /* Record what we have and where it came from. */
7896 it
->what
= IT_CHARACTER
;
7897 it
->object
= it
->w
->buffer
;
7898 it
->position
= it
->current
.pos
;
7900 /* Normally we return the character found above, except when we
7901 really want to return an ellipsis for selective display. */
7906 /* A value of selective > 0 means hide lines indented more
7907 than that number of columns. */
7908 if (it
->selective
> 0
7909 && IT_CHARPOS (*it
) + 1 < ZV
7910 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7911 IT_BYTEPOS (*it
) + 1,
7914 success_p
= next_element_from_ellipsis (it
);
7915 it
->dpvec_char_len
= -1;
7918 else if (it
->c
== '\r' && it
->selective
== -1)
7920 /* A value of selective == -1 means that everything from the
7921 CR to the end of the line is invisible, with maybe an
7922 ellipsis displayed for it. */
7923 success_p
= next_element_from_ellipsis (it
);
7924 it
->dpvec_char_len
= -1;
7929 /* Value is zero if end of buffer reached. */
7930 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7935 /* Run the redisplay end trigger hook for IT. */
7938 run_redisplay_end_trigger_hook (struct it
*it
)
7940 Lisp_Object args
[3];
7942 /* IT->glyph_row should be non-null, i.e. we should be actually
7943 displaying something, or otherwise we should not run the hook. */
7944 xassert (it
->glyph_row
);
7946 /* Set up hook arguments. */
7947 args
[0] = Qredisplay_end_trigger_functions
;
7948 args
[1] = it
->window
;
7949 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7950 it
->redisplay_end_trigger_charpos
= 0;
7952 /* Since we are *trying* to run these functions, don't try to run
7953 them again, even if they get an error. */
7954 it
->w
->redisplay_end_trigger
= Qnil
;
7955 Frun_hook_with_args (3, args
);
7957 /* Notice if it changed the face of the character we are on. */
7958 handle_face_prop (it
);
7962 /* Deliver a composition display element. Unlike the other
7963 next_element_from_XXX, this function is not registered in the array
7964 get_next_element[]. It is called from next_element_from_buffer and
7965 next_element_from_string when necessary. */
7968 next_element_from_composition (struct it
*it
)
7970 it
->what
= IT_COMPOSITION
;
7971 it
->len
= it
->cmp_it
.nbytes
;
7972 if (STRINGP (it
->string
))
7976 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7977 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7980 it
->position
= it
->current
.string_pos
;
7981 it
->object
= it
->string
;
7982 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7983 IT_STRING_BYTEPOS (*it
), it
->string
);
7989 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7990 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7993 if (it
->bidi_it
.new_paragraph
)
7994 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7995 /* Resync the bidi iterator with IT's new position.
7996 FIXME: this doesn't support bidirectional text. */
7997 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7998 bidi_move_to_visually_next (&it
->bidi_it
);
8002 it
->position
= it
->current
.pos
;
8003 it
->object
= it
->w
->buffer
;
8004 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8005 IT_BYTEPOS (*it
), Qnil
);
8012 /***********************************************************************
8013 Moving an iterator without producing glyphs
8014 ***********************************************************************/
8016 /* Check if iterator is at a position corresponding to a valid buffer
8017 position after some move_it_ call. */
8019 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8020 ((it)->method == GET_FROM_STRING \
8021 ? IT_STRING_CHARPOS (*it) == 0 \
8025 /* Move iterator IT to a specified buffer or X position within one
8026 line on the display without producing glyphs.
8028 OP should be a bit mask including some or all of these bits:
8029 MOVE_TO_X: Stop upon reaching x-position TO_X.
8030 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8031 Regardless of OP's value, stop upon reaching the end of the display line.
8033 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8034 This means, in particular, that TO_X includes window's horizontal
8037 The return value has several possible values that
8038 say what condition caused the scan to stop:
8040 MOVE_POS_MATCH_OR_ZV
8041 - when TO_POS or ZV was reached.
8044 -when TO_X was reached before TO_POS or ZV were reached.
8047 - when we reached the end of the display area and the line must
8051 - when we reached the end of the display area and the line is
8055 - when we stopped at a line end, i.e. a newline or a CR and selective
8058 static enum move_it_result
8059 move_it_in_display_line_to (struct it
*it
,
8060 ptrdiff_t to_charpos
, int to_x
,
8061 enum move_operation_enum op
)
8063 enum move_it_result result
= MOVE_UNDEFINED
;
8064 struct glyph_row
*saved_glyph_row
;
8065 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8066 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8067 void *ppos_data
= NULL
;
8069 enum it_method prev_method
= it
->method
;
8070 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8071 int saw_smaller_pos
= prev_pos
< to_charpos
;
8073 /* Don't produce glyphs in produce_glyphs. */
8074 saved_glyph_row
= it
->glyph_row
;
8075 it
->glyph_row
= NULL
;
8077 /* Use wrap_it to save a copy of IT wherever a word wrap could
8078 occur. Use atpos_it to save a copy of IT at the desired buffer
8079 position, if found, so that we can scan ahead and check if the
8080 word later overshoots the window edge. Use atx_it similarly, for
8086 /* Use ppos_it under bidi reordering to save a copy of IT for the
8087 position > CHARPOS that is the closest to CHARPOS. We restore
8088 that position in IT when we have scanned the entire display line
8089 without finding a match for CHARPOS and all the character
8090 positions are greater than CHARPOS. */
8093 SAVE_IT (ppos_it
, *it
, ppos_data
);
8094 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8095 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8096 SAVE_IT (ppos_it
, *it
, ppos_data
);
8099 #define BUFFER_POS_REACHED_P() \
8100 ((op & MOVE_TO_POS) != 0 \
8101 && BUFFERP (it->object) \
8102 && (IT_CHARPOS (*it) == to_charpos \
8104 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8105 && IT_CHARPOS (*it) > to_charpos) \
8106 || (it->what == IT_COMPOSITION \
8107 && ((IT_CHARPOS (*it) > to_charpos \
8108 && to_charpos >= it->cmp_it.charpos) \
8109 || (IT_CHARPOS (*it) < to_charpos \
8110 && to_charpos <= it->cmp_it.charpos)))) \
8111 && (it->method == GET_FROM_BUFFER \
8112 || (it->method == GET_FROM_DISPLAY_VECTOR \
8113 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8115 /* If there's a line-/wrap-prefix, handle it. */
8116 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8117 && it
->current_y
< it
->last_visible_y
)
8118 handle_line_prefix (it
);
8120 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8121 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8125 int x
, i
, ascent
= 0, descent
= 0;
8127 /* Utility macro to reset an iterator with x, ascent, and descent. */
8128 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8129 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8130 (IT)->max_descent = descent)
8132 /* Stop if we move beyond TO_CHARPOS (after an image or a
8133 display string or stretch glyph). */
8134 if ((op
& MOVE_TO_POS
) != 0
8135 && BUFFERP (it
->object
)
8136 && it
->method
== GET_FROM_BUFFER
8138 /* When the iterator is at base embedding level, we
8139 are guaranteed that characters are delivered for
8140 display in strictly increasing order of their
8141 buffer positions. */
8142 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8143 && IT_CHARPOS (*it
) > to_charpos
)
8145 && (prev_method
== GET_FROM_IMAGE
8146 || prev_method
== GET_FROM_STRETCH
8147 || prev_method
== GET_FROM_STRING
)
8148 /* Passed TO_CHARPOS from left to right. */
8149 && ((prev_pos
< to_charpos
8150 && IT_CHARPOS (*it
) > to_charpos
)
8151 /* Passed TO_CHARPOS from right to left. */
8152 || (prev_pos
> to_charpos
8153 && IT_CHARPOS (*it
) < to_charpos
)))))
8155 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8157 result
= MOVE_POS_MATCH_OR_ZV
;
8160 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8161 /* If wrap_it is valid, the current position might be in a
8162 word that is wrapped. So, save the iterator in
8163 atpos_it and continue to see if wrapping happens. */
8164 SAVE_IT (atpos_it
, *it
, atpos_data
);
8167 /* Stop when ZV reached.
8168 We used to stop here when TO_CHARPOS reached as well, but that is
8169 too soon if this glyph does not fit on this line. So we handle it
8170 explicitly below. */
8171 if (!get_next_display_element (it
))
8173 result
= MOVE_POS_MATCH_OR_ZV
;
8177 if (it
->line_wrap
== TRUNCATE
)
8179 if (BUFFER_POS_REACHED_P ())
8181 result
= MOVE_POS_MATCH_OR_ZV
;
8187 if (it
->line_wrap
== WORD_WRAP
)
8189 if (IT_DISPLAYING_WHITESPACE (it
))
8193 /* We have reached a glyph that follows one or more
8194 whitespace characters. If the position is
8195 already found, we are done. */
8196 if (atpos_it
.sp
>= 0)
8198 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8199 result
= MOVE_POS_MATCH_OR_ZV
;
8204 RESTORE_IT (it
, &atx_it
, atx_data
);
8205 result
= MOVE_X_REACHED
;
8208 /* Otherwise, we can wrap here. */
8209 SAVE_IT (wrap_it
, *it
, wrap_data
);
8215 /* Remember the line height for the current line, in case
8216 the next element doesn't fit on the line. */
8217 ascent
= it
->max_ascent
;
8218 descent
= it
->max_descent
;
8220 /* The call to produce_glyphs will get the metrics of the
8221 display element IT is loaded with. Record the x-position
8222 before this display element, in case it doesn't fit on the
8226 PRODUCE_GLYPHS (it
);
8228 if (it
->area
!= TEXT_AREA
)
8230 prev_method
= it
->method
;
8231 if (it
->method
== GET_FROM_BUFFER
)
8232 prev_pos
= IT_CHARPOS (*it
);
8233 set_iterator_to_next (it
, 1);
8234 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8235 SET_TEXT_POS (this_line_min_pos
,
8236 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8238 && (op
& MOVE_TO_POS
)
8239 && IT_CHARPOS (*it
) > to_charpos
8240 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8241 SAVE_IT (ppos_it
, *it
, ppos_data
);
8245 /* The number of glyphs we get back in IT->nglyphs will normally
8246 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8247 character on a terminal frame, or (iii) a line end. For the
8248 second case, IT->nglyphs - 1 padding glyphs will be present.
8249 (On X frames, there is only one glyph produced for a
8250 composite character.)
8252 The behavior implemented below means, for continuation lines,
8253 that as many spaces of a TAB as fit on the current line are
8254 displayed there. For terminal frames, as many glyphs of a
8255 multi-glyph character are displayed in the current line, too.
8256 This is what the old redisplay code did, and we keep it that
8257 way. Under X, the whole shape of a complex character must
8258 fit on the line or it will be completely displayed in the
8261 Note that both for tabs and padding glyphs, all glyphs have
8265 /* More than one glyph or glyph doesn't fit on line. All
8266 glyphs have the same width. */
8267 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8269 int x_before_this_char
= x
;
8270 int hpos_before_this_char
= it
->hpos
;
8272 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8274 new_x
= x
+ single_glyph_width
;
8276 /* We want to leave anything reaching TO_X to the caller. */
8277 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8279 if (BUFFER_POS_REACHED_P ())
8281 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8282 goto buffer_pos_reached
;
8283 if (atpos_it
.sp
< 0)
8285 SAVE_IT (atpos_it
, *it
, atpos_data
);
8286 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8291 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8294 result
= MOVE_X_REACHED
;
8299 SAVE_IT (atx_it
, *it
, atx_data
);
8300 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8305 if (/* Lines are continued. */
8306 it
->line_wrap
!= TRUNCATE
8307 && (/* And glyph doesn't fit on the line. */
8308 new_x
> it
->last_visible_x
8309 /* Or it fits exactly and we're on a window
8311 || (new_x
== it
->last_visible_x
8312 && FRAME_WINDOW_P (it
->f
))))
8314 if (/* IT->hpos == 0 means the very first glyph
8315 doesn't fit on the line, e.g. a wide image. */
8317 || (new_x
== it
->last_visible_x
8318 && FRAME_WINDOW_P (it
->f
)))
8321 it
->current_x
= new_x
;
8323 /* The character's last glyph just barely fits
8325 if (i
== it
->nglyphs
- 1)
8327 /* If this is the destination position,
8328 return a position *before* it in this row,
8329 now that we know it fits in this row. */
8330 if (BUFFER_POS_REACHED_P ())
8332 if (it
->line_wrap
!= WORD_WRAP
8335 it
->hpos
= hpos_before_this_char
;
8336 it
->current_x
= x_before_this_char
;
8337 result
= MOVE_POS_MATCH_OR_ZV
;
8340 if (it
->line_wrap
== WORD_WRAP
8343 SAVE_IT (atpos_it
, *it
, atpos_data
);
8344 atpos_it
.current_x
= x_before_this_char
;
8345 atpos_it
.hpos
= hpos_before_this_char
;
8349 prev_method
= it
->method
;
8350 if (it
->method
== GET_FROM_BUFFER
)
8351 prev_pos
= IT_CHARPOS (*it
);
8352 set_iterator_to_next (it
, 1);
8353 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8354 SET_TEXT_POS (this_line_min_pos
,
8355 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8356 /* On graphical terminals, newlines may
8357 "overflow" into the fringe if
8358 overflow-newline-into-fringe is non-nil.
8359 On text-only terminals, newlines may
8360 overflow into the last glyph on the
8362 if (!FRAME_WINDOW_P (it
->f
)
8363 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8365 if (!get_next_display_element (it
))
8367 result
= MOVE_POS_MATCH_OR_ZV
;
8370 if (BUFFER_POS_REACHED_P ())
8372 if (ITERATOR_AT_END_OF_LINE_P (it
))
8373 result
= MOVE_POS_MATCH_OR_ZV
;
8375 result
= MOVE_LINE_CONTINUED
;
8378 if (ITERATOR_AT_END_OF_LINE_P (it
))
8380 result
= MOVE_NEWLINE_OR_CR
;
8387 IT_RESET_X_ASCENT_DESCENT (it
);
8389 if (wrap_it
.sp
>= 0)
8391 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8396 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8398 result
= MOVE_LINE_CONTINUED
;
8402 if (BUFFER_POS_REACHED_P ())
8404 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8405 goto buffer_pos_reached
;
8406 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8408 SAVE_IT (atpos_it
, *it
, atpos_data
);
8409 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8413 if (new_x
> it
->first_visible_x
)
8415 /* Glyph is visible. Increment number of glyphs that
8416 would be displayed. */
8421 if (result
!= MOVE_UNDEFINED
)
8424 else if (BUFFER_POS_REACHED_P ())
8427 IT_RESET_X_ASCENT_DESCENT (it
);
8428 result
= MOVE_POS_MATCH_OR_ZV
;
8431 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8433 /* Stop when TO_X specified and reached. This check is
8434 necessary here because of lines consisting of a line end,
8435 only. The line end will not produce any glyphs and we
8436 would never get MOVE_X_REACHED. */
8437 xassert (it
->nglyphs
== 0);
8438 result
= MOVE_X_REACHED
;
8442 /* Is this a line end? If yes, we're done. */
8443 if (ITERATOR_AT_END_OF_LINE_P (it
))
8445 /* If we are past TO_CHARPOS, but never saw any character
8446 positions smaller than TO_CHARPOS, return
8447 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8449 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8451 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8453 if (IT_CHARPOS (ppos_it
) < ZV
)
8455 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8456 result
= MOVE_POS_MATCH_OR_ZV
;
8459 goto buffer_pos_reached
;
8461 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8462 && IT_CHARPOS (*it
) > to_charpos
)
8463 goto buffer_pos_reached
;
8465 result
= MOVE_NEWLINE_OR_CR
;
8468 result
= MOVE_NEWLINE_OR_CR
;
8472 prev_method
= it
->method
;
8473 if (it
->method
== GET_FROM_BUFFER
)
8474 prev_pos
= IT_CHARPOS (*it
);
8475 /* The current display element has been consumed. Advance
8477 set_iterator_to_next (it
, 1);
8478 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8479 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8480 if (IT_CHARPOS (*it
) < to_charpos
)
8481 saw_smaller_pos
= 1;
8483 && (op
& MOVE_TO_POS
)
8484 && IT_CHARPOS (*it
) >= to_charpos
8485 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8486 SAVE_IT (ppos_it
, *it
, ppos_data
);
8488 /* Stop if lines are truncated and IT's current x-position is
8489 past the right edge of the window now. */
8490 if (it
->line_wrap
== TRUNCATE
8491 && it
->current_x
>= it
->last_visible_x
)
8493 if (!FRAME_WINDOW_P (it
->f
)
8494 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8498 if ((at_eob_p
= !get_next_display_element (it
))
8499 || BUFFER_POS_REACHED_P ()
8500 /* If we are past TO_CHARPOS, but never saw any
8501 character positions smaller than TO_CHARPOS,
8502 return MOVE_POS_MATCH_OR_ZV, like the
8503 unidirectional display did. */
8504 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8506 && IT_CHARPOS (*it
) > to_charpos
))
8509 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8510 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8511 result
= MOVE_POS_MATCH_OR_ZV
;
8514 if (ITERATOR_AT_END_OF_LINE_P (it
))
8516 result
= MOVE_NEWLINE_OR_CR
;
8520 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8522 && IT_CHARPOS (*it
) > to_charpos
)
8524 if (IT_CHARPOS (ppos_it
) < ZV
)
8525 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8526 result
= MOVE_POS_MATCH_OR_ZV
;
8529 result
= MOVE_LINE_TRUNCATED
;
8532 #undef IT_RESET_X_ASCENT_DESCENT
8535 #undef BUFFER_POS_REACHED_P
8537 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8538 restore the saved iterator. */
8539 if (atpos_it
.sp
>= 0)
8540 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8541 else if (atx_it
.sp
>= 0)
8542 RESTORE_IT (it
, &atx_it
, atx_data
);
8547 bidi_unshelve_cache (atpos_data
, 1);
8549 bidi_unshelve_cache (atx_data
, 1);
8551 bidi_unshelve_cache (wrap_data
, 1);
8553 bidi_unshelve_cache (ppos_data
, 1);
8555 /* Restore the iterator settings altered at the beginning of this
8557 it
->glyph_row
= saved_glyph_row
;
8561 /* For external use. */
8563 move_it_in_display_line (struct it
*it
,
8564 ptrdiff_t to_charpos
, int to_x
,
8565 enum move_operation_enum op
)
8567 if (it
->line_wrap
== WORD_WRAP
8568 && (op
& MOVE_TO_X
))
8571 void *save_data
= NULL
;
8574 SAVE_IT (save_it
, *it
, save_data
);
8575 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8576 /* When word-wrap is on, TO_X may lie past the end
8577 of a wrapped line. Then it->current is the
8578 character on the next line, so backtrack to the
8579 space before the wrap point. */
8580 if (skip
== MOVE_LINE_CONTINUED
)
8582 int prev_x
= max (it
->current_x
- 1, 0);
8583 RESTORE_IT (it
, &save_it
, save_data
);
8584 move_it_in_display_line_to
8585 (it
, -1, prev_x
, MOVE_TO_X
);
8588 bidi_unshelve_cache (save_data
, 1);
8591 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8595 /* Move IT forward until it satisfies one or more of the criteria in
8596 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8598 OP is a bit-mask that specifies where to stop, and in particular,
8599 which of those four position arguments makes a difference. See the
8600 description of enum move_operation_enum.
8602 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8603 screen line, this function will set IT to the next position that is
8604 displayed to the right of TO_CHARPOS on the screen. */
8607 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8609 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8610 int line_height
, line_start_x
= 0, reached
= 0;
8611 void *backup_data
= NULL
;
8615 if (op
& MOVE_TO_VPOS
)
8617 /* If no TO_CHARPOS and no TO_X specified, stop at the
8618 start of the line TO_VPOS. */
8619 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8621 if (it
->vpos
== to_vpos
)
8627 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8631 /* TO_VPOS >= 0 means stop at TO_X in the line at
8632 TO_VPOS, or at TO_POS, whichever comes first. */
8633 if (it
->vpos
== to_vpos
)
8639 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8641 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8646 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8648 /* We have reached TO_X but not in the line we want. */
8649 skip
= move_it_in_display_line_to (it
, to_charpos
,
8651 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8659 else if (op
& MOVE_TO_Y
)
8661 struct it it_backup
;
8663 if (it
->line_wrap
== WORD_WRAP
)
8664 SAVE_IT (it_backup
, *it
, backup_data
);
8666 /* TO_Y specified means stop at TO_X in the line containing
8667 TO_Y---or at TO_CHARPOS if this is reached first. The
8668 problem is that we can't really tell whether the line
8669 contains TO_Y before we have completely scanned it, and
8670 this may skip past TO_X. What we do is to first scan to
8673 If TO_X is not specified, use a TO_X of zero. The reason
8674 is to make the outcome of this function more predictable.
8675 If we didn't use TO_X == 0, we would stop at the end of
8676 the line which is probably not what a caller would expect
8678 skip
= move_it_in_display_line_to
8679 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8680 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8682 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8683 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8685 else if (skip
== MOVE_X_REACHED
)
8687 /* If TO_X was reached, we want to know whether TO_Y is
8688 in the line. We know this is the case if the already
8689 scanned glyphs make the line tall enough. Otherwise,
8690 we must check by scanning the rest of the line. */
8691 line_height
= it
->max_ascent
+ it
->max_descent
;
8692 if (to_y
>= it
->current_y
8693 && to_y
< it
->current_y
+ line_height
)
8698 SAVE_IT (it_backup
, *it
, backup_data
);
8699 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8700 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8702 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8703 line_height
= it
->max_ascent
+ it
->max_descent
;
8704 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8706 if (to_y
>= it
->current_y
8707 && to_y
< it
->current_y
+ line_height
)
8709 /* If TO_Y is in this line and TO_X was reached
8710 above, we scanned too far. We have to restore
8711 IT's settings to the ones before skipping. But
8712 keep the more accurate values of max_ascent and
8713 max_descent we've found while skipping the rest
8714 of the line, for the sake of callers, such as
8715 pos_visible_p, that need to know the line
8717 int max_ascent
= it
->max_ascent
;
8718 int max_descent
= it
->max_descent
;
8720 RESTORE_IT (it
, &it_backup
, backup_data
);
8721 it
->max_ascent
= max_ascent
;
8722 it
->max_descent
= max_descent
;
8728 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8734 /* Check whether TO_Y is in this line. */
8735 line_height
= it
->max_ascent
+ it
->max_descent
;
8736 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8738 if (to_y
>= it
->current_y
8739 && to_y
< it
->current_y
+ line_height
)
8741 /* When word-wrap is on, TO_X may lie past the end
8742 of a wrapped line. Then it->current is the
8743 character on the next line, so backtrack to the
8744 space before the wrap point. */
8745 if (skip
== MOVE_LINE_CONTINUED
8746 && it
->line_wrap
== WORD_WRAP
)
8748 int prev_x
= max (it
->current_x
- 1, 0);
8749 RESTORE_IT (it
, &it_backup
, backup_data
);
8750 skip
= move_it_in_display_line_to
8751 (it
, -1, prev_x
, MOVE_TO_X
);
8760 else if (BUFFERP (it
->object
)
8761 && (it
->method
== GET_FROM_BUFFER
8762 || it
->method
== GET_FROM_STRETCH
)
8763 && IT_CHARPOS (*it
) >= to_charpos
8764 /* Under bidi iteration, a call to set_iterator_to_next
8765 can scan far beyond to_charpos if the initial
8766 portion of the next line needs to be reordered. In
8767 that case, give move_it_in_display_line_to another
8770 && it
->bidi_it
.scan_dir
== -1))
8771 skip
= MOVE_POS_MATCH_OR_ZV
;
8773 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8777 case MOVE_POS_MATCH_OR_ZV
:
8781 case MOVE_NEWLINE_OR_CR
:
8782 set_iterator_to_next (it
, 1);
8783 it
->continuation_lines_width
= 0;
8786 case MOVE_LINE_TRUNCATED
:
8787 it
->continuation_lines_width
= 0;
8788 reseat_at_next_visible_line_start (it
, 0);
8789 if ((op
& MOVE_TO_POS
) != 0
8790 && IT_CHARPOS (*it
) > to_charpos
)
8797 case MOVE_LINE_CONTINUED
:
8798 /* For continued lines ending in a tab, some of the glyphs
8799 associated with the tab are displayed on the current
8800 line. Since it->current_x does not include these glyphs,
8801 we use it->last_visible_x instead. */
8804 it
->continuation_lines_width
+= it
->last_visible_x
;
8805 /* When moving by vpos, ensure that the iterator really
8806 advances to the next line (bug#847, bug#969). Fixme:
8807 do we need to do this in other circumstances? */
8808 if (it
->current_x
!= it
->last_visible_x
8809 && (op
& MOVE_TO_VPOS
)
8810 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8812 line_start_x
= it
->current_x
+ it
->pixel_width
8813 - it
->last_visible_x
;
8814 set_iterator_to_next (it
, 0);
8818 it
->continuation_lines_width
+= it
->current_x
;
8825 /* Reset/increment for the next run. */
8826 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8827 it
->current_x
= line_start_x
;
8830 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8832 last_height
= it
->max_ascent
+ it
->max_descent
;
8833 last_max_ascent
= it
->max_ascent
;
8834 it
->max_ascent
= it
->max_descent
= 0;
8839 /* On text terminals, we may stop at the end of a line in the middle
8840 of a multi-character glyph. If the glyph itself is continued,
8841 i.e. it is actually displayed on the next line, don't treat this
8842 stopping point as valid; move to the next line instead (unless
8843 that brings us offscreen). */
8844 if (!FRAME_WINDOW_P (it
->f
)
8846 && IT_CHARPOS (*it
) == to_charpos
8847 && it
->what
== IT_CHARACTER
8849 && it
->line_wrap
== WINDOW_WRAP
8850 && it
->current_x
== it
->last_visible_x
- 1
8853 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8855 it
->continuation_lines_width
+= it
->current_x
;
8856 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8857 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8859 last_height
= it
->max_ascent
+ it
->max_descent
;
8860 last_max_ascent
= it
->max_ascent
;
8864 bidi_unshelve_cache (backup_data
, 1);
8866 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8870 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8872 If DY > 0, move IT backward at least that many pixels. DY = 0
8873 means move IT backward to the preceding line start or BEGV. This
8874 function may move over more than DY pixels if IT->current_y - DY
8875 ends up in the middle of a line; in this case IT->current_y will be
8876 set to the top of the line moved to. */
8879 move_it_vertically_backward (struct it
*it
, int dy
)
8883 void *it2data
= NULL
, *it3data
= NULL
;
8884 ptrdiff_t start_pos
;
8889 start_pos
= IT_CHARPOS (*it
);
8891 /* Estimate how many newlines we must move back. */
8892 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8894 /* Set the iterator's position that many lines back. */
8895 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8896 back_to_previous_visible_line_start (it
);
8898 /* Reseat the iterator here. When moving backward, we don't want
8899 reseat to skip forward over invisible text, set up the iterator
8900 to deliver from overlay strings at the new position etc. So,
8901 use reseat_1 here. */
8902 reseat_1 (it
, it
->current
.pos
, 1);
8904 /* We are now surely at a line start. */
8905 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8906 reordering is in effect. */
8907 it
->continuation_lines_width
= 0;
8909 /* Move forward and see what y-distance we moved. First move to the
8910 start of the next line so that we get its height. We need this
8911 height to be able to tell whether we reached the specified
8913 SAVE_IT (it2
, *it
, it2data
);
8914 it2
.max_ascent
= it2
.max_descent
= 0;
8917 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8918 MOVE_TO_POS
| MOVE_TO_VPOS
);
8920 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8921 /* If we are in a display string which starts at START_POS,
8922 and that display string includes a newline, and we are
8923 right after that newline (i.e. at the beginning of a
8924 display line), exit the loop, because otherwise we will
8925 infloop, since move_it_to will see that it is already at
8926 START_POS and will not move. */
8927 || (it2
.method
== GET_FROM_STRING
8928 && IT_CHARPOS (it2
) == start_pos
8929 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8930 xassert (IT_CHARPOS (*it
) >= BEGV
);
8931 SAVE_IT (it3
, it2
, it3data
);
8933 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8934 xassert (IT_CHARPOS (*it
) >= BEGV
);
8935 /* H is the actual vertical distance from the position in *IT
8936 and the starting position. */
8937 h
= it2
.current_y
- it
->current_y
;
8938 /* NLINES is the distance in number of lines. */
8939 nlines
= it2
.vpos
- it
->vpos
;
8941 /* Correct IT's y and vpos position
8942 so that they are relative to the starting point. */
8948 /* DY == 0 means move to the start of the screen line. The
8949 value of nlines is > 0 if continuation lines were involved,
8950 or if the original IT position was at start of a line. */
8951 RESTORE_IT (it
, it
, it2data
);
8953 move_it_by_lines (it
, nlines
);
8954 /* The above code moves us to some position NLINES down,
8955 usually to its first glyph (leftmost in an L2R line), but
8956 that's not necessarily the start of the line, under bidi
8957 reordering. We want to get to the character position
8958 that is immediately after the newline of the previous
8961 && !it
->continuation_lines_width
8962 && !STRINGP (it
->string
)
8963 && IT_CHARPOS (*it
) > BEGV
8964 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8967 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8969 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8971 bidi_unshelve_cache (it3data
, 1);
8975 /* The y-position we try to reach, relative to *IT.
8976 Note that H has been subtracted in front of the if-statement. */
8977 int target_y
= it
->current_y
+ h
- dy
;
8978 int y0
= it3
.current_y
;
8982 RESTORE_IT (&it3
, &it3
, it3data
);
8983 y1
= line_bottom_y (&it3
);
8984 line_height
= y1
- y0
;
8985 RESTORE_IT (it
, it
, it2data
);
8986 /* If we did not reach target_y, try to move further backward if
8987 we can. If we moved too far backward, try to move forward. */
8988 if (target_y
< it
->current_y
8989 /* This is heuristic. In a window that's 3 lines high, with
8990 a line height of 13 pixels each, recentering with point
8991 on the bottom line will try to move -39/2 = 19 pixels
8992 backward. Try to avoid moving into the first line. */
8993 && (it
->current_y
- target_y
8994 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8995 && IT_CHARPOS (*it
) > BEGV
)
8997 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8998 target_y
- it
->current_y
));
8999 dy
= it
->current_y
- target_y
;
9000 goto move_further_back
;
9002 else if (target_y
>= it
->current_y
+ line_height
9003 && IT_CHARPOS (*it
) < ZV
)
9005 /* Should move forward by at least one line, maybe more.
9007 Note: Calling move_it_by_lines can be expensive on
9008 terminal frames, where compute_motion is used (via
9009 vmotion) to do the job, when there are very long lines
9010 and truncate-lines is nil. That's the reason for
9011 treating terminal frames specially here. */
9013 if (!FRAME_WINDOW_P (it
->f
))
9014 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9019 move_it_by_lines (it
, 1);
9021 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9028 /* Move IT by a specified amount of pixel lines DY. DY negative means
9029 move backwards. DY = 0 means move to start of screen line. At the
9030 end, IT will be on the start of a screen line. */
9033 move_it_vertically (struct it
*it
, int dy
)
9036 move_it_vertically_backward (it
, -dy
);
9039 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9040 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9041 MOVE_TO_POS
| MOVE_TO_Y
);
9042 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9044 /* If buffer ends in ZV without a newline, move to the start of
9045 the line to satisfy the post-condition. */
9046 if (IT_CHARPOS (*it
) == ZV
9048 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9049 move_it_by_lines (it
, 0);
9054 /* Move iterator IT past the end of the text line it is in. */
9057 move_it_past_eol (struct it
*it
)
9059 enum move_it_result rc
;
9061 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9062 if (rc
== MOVE_NEWLINE_OR_CR
)
9063 set_iterator_to_next (it
, 0);
9067 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9068 negative means move up. DVPOS == 0 means move to the start of the
9071 Optimization idea: If we would know that IT->f doesn't use
9072 a face with proportional font, we could be faster for
9073 truncate-lines nil. */
9076 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9079 /* The commented-out optimization uses vmotion on terminals. This
9080 gives bad results, because elements like it->what, on which
9081 callers such as pos_visible_p rely, aren't updated. */
9082 /* struct position pos;
9083 if (!FRAME_WINDOW_P (it->f))
9085 struct text_pos textpos;
9087 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9088 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9089 reseat (it, textpos, 1);
9090 it->vpos += pos.vpos;
9091 it->current_y += pos.vpos;
9097 /* DVPOS == 0 means move to the start of the screen line. */
9098 move_it_vertically_backward (it
, 0);
9099 /* Let next call to line_bottom_y calculate real line height */
9104 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9105 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9107 /* Only move to the next buffer position if we ended up in a
9108 string from display property, not in an overlay string
9109 (before-string or after-string). That is because the
9110 latter don't conceal the underlying buffer position, so
9111 we can ask to move the iterator to the exact position we
9112 are interested in. Note that, even if we are already at
9113 IT_CHARPOS (*it), the call below is not a no-op, as it
9114 will detect that we are at the end of the string, pop the
9115 iterator, and compute it->current_x and it->hpos
9117 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9118 -1, -1, -1, MOVE_TO_POS
);
9124 void *it2data
= NULL
;
9125 ptrdiff_t start_charpos
, i
;
9127 /* Start at the beginning of the screen line containing IT's
9128 position. This may actually move vertically backwards,
9129 in case of overlays, so adjust dvpos accordingly. */
9131 move_it_vertically_backward (it
, 0);
9134 /* Go back -DVPOS visible lines and reseat the iterator there. */
9135 start_charpos
= IT_CHARPOS (*it
);
9136 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9137 back_to_previous_visible_line_start (it
);
9138 reseat (it
, it
->current
.pos
, 1);
9140 /* Move further back if we end up in a string or an image. */
9141 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9143 /* First try to move to start of display line. */
9145 move_it_vertically_backward (it
, 0);
9147 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9149 /* If start of line is still in string or image,
9150 move further back. */
9151 back_to_previous_visible_line_start (it
);
9152 reseat (it
, it
->current
.pos
, 1);
9156 it
->current_x
= it
->hpos
= 0;
9158 /* Above call may have moved too far if continuation lines
9159 are involved. Scan forward and see if it did. */
9160 SAVE_IT (it2
, *it
, it2data
);
9161 it2
.vpos
= it2
.current_y
= 0;
9162 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9163 it
->vpos
-= it2
.vpos
;
9164 it
->current_y
-= it2
.current_y
;
9165 it
->current_x
= it
->hpos
= 0;
9167 /* If we moved too far back, move IT some lines forward. */
9168 if (it2
.vpos
> -dvpos
)
9170 int delta
= it2
.vpos
+ dvpos
;
9172 RESTORE_IT (&it2
, &it2
, it2data
);
9173 SAVE_IT (it2
, *it
, it2data
);
9174 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9175 /* Move back again if we got too far ahead. */
9176 if (IT_CHARPOS (*it
) >= start_charpos
)
9177 RESTORE_IT (it
, &it2
, it2data
);
9179 bidi_unshelve_cache (it2data
, 1);
9182 RESTORE_IT (it
, it
, it2data
);
9186 /* Return 1 if IT points into the middle of a display vector. */
9189 in_display_vector_p (struct it
*it
)
9191 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9192 && it
->current
.dpvec_index
> 0
9193 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9197 /***********************************************************************
9199 ***********************************************************************/
9202 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9206 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9208 Lisp_Object args
[3];
9209 Lisp_Object msg
, fmt
;
9212 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9215 /* Do nothing if called asynchronously. Inserting text into
9216 a buffer may call after-change-functions and alike and
9217 that would means running Lisp asynchronously. */
9218 if (handling_signal
)
9222 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9224 args
[0] = fmt
= build_string (format
);
9227 msg
= Fformat (3, args
);
9229 len
= SBYTES (msg
) + 1;
9230 SAFE_ALLOCA (buffer
, char *, len
);
9231 memcpy (buffer
, SDATA (msg
), len
);
9233 message_dolog (buffer
, len
- 1, 1, 0);
9240 /* Output a newline in the *Messages* buffer if "needs" one. */
9243 message_log_maybe_newline (void)
9245 if (message_log_need_newline
)
9246 message_dolog ("", 0, 1, 0);
9250 /* Add a string M of length NBYTES to the message log, optionally
9251 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9252 nonzero, means interpret the contents of M as multibyte. This
9253 function calls low-level routines in order to bypass text property
9254 hooks, etc. which might not be safe to run.
9256 This may GC (insert may run before/after change hooks),
9257 so the buffer M must NOT point to a Lisp string. */
9260 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9262 const unsigned char *msg
= (const unsigned char *) m
;
9264 if (!NILP (Vmemory_full
))
9267 if (!NILP (Vmessage_log_max
))
9269 struct buffer
*oldbuf
;
9270 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9271 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9272 ptrdiff_t point_at_end
= 0;
9273 ptrdiff_t zv_at_end
= 0;
9274 Lisp_Object old_deactivate_mark
, tem
;
9275 struct gcpro gcpro1
;
9277 old_deactivate_mark
= Vdeactivate_mark
;
9278 oldbuf
= current_buffer
;
9279 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9280 BVAR (current_buffer
, undo_list
) = Qt
;
9282 oldpoint
= message_dolog_marker1
;
9283 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9284 oldbegv
= message_dolog_marker2
;
9285 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9286 oldzv
= message_dolog_marker3
;
9287 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9288 GCPRO1 (old_deactivate_mark
);
9296 BEGV_BYTE
= BEG_BYTE
;
9299 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9301 /* Insert the string--maybe converting multibyte to single byte
9302 or vice versa, so that all the text fits the buffer. */
9304 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9310 /* Convert a multibyte string to single-byte
9311 for the *Message* buffer. */
9312 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9314 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9315 work
[0] = (ASCII_CHAR_P (c
)
9317 : multibyte_char_to_unibyte (c
));
9318 insert_1_both (work
, 1, 1, 1, 0, 0);
9321 else if (! multibyte
9322 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9326 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9327 /* Convert a single-byte string to multibyte
9328 for the *Message* buffer. */
9329 for (i
= 0; i
< nbytes
; i
++)
9332 MAKE_CHAR_MULTIBYTE (c
);
9333 char_bytes
= CHAR_STRING (c
, str
);
9334 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9338 insert_1 (m
, nbytes
, 1, 0, 0);
9342 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9344 insert_1 ("\n", 1, 1, 0, 0);
9346 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9348 this_bol_byte
= PT_BYTE
;
9350 /* See if this line duplicates the previous one.
9351 If so, combine duplicates. */
9354 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9356 prev_bol_byte
= PT_BYTE
;
9358 dups
= message_log_check_duplicate (prev_bol_byte
,
9362 del_range_both (prev_bol
, prev_bol_byte
,
9363 this_bol
, this_bol_byte
, 0);
9366 char dupstr
[sizeof " [ times]"
9367 + INT_STRLEN_BOUND (printmax_t
)];
9370 /* If you change this format, don't forget to also
9371 change message_log_check_duplicate. */
9372 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9373 duplen
= strlen (dupstr
);
9374 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9375 insert_1 (dupstr
, duplen
, 1, 0, 1);
9380 /* If we have more than the desired maximum number of lines
9381 in the *Messages* buffer now, delete the oldest ones.
9382 This is safe because we don't have undo in this buffer. */
9384 if (NATNUMP (Vmessage_log_max
))
9386 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9387 -XFASTINT (Vmessage_log_max
) - 1, 0);
9388 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9391 BEGV
= XMARKER (oldbegv
)->charpos
;
9392 BEGV_BYTE
= marker_byte_position (oldbegv
);
9401 ZV
= XMARKER (oldzv
)->charpos
;
9402 ZV_BYTE
= marker_byte_position (oldzv
);
9406 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9408 /* We can't do Fgoto_char (oldpoint) because it will run some
9410 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9411 XMARKER (oldpoint
)->bytepos
);
9414 unchain_marker (XMARKER (oldpoint
));
9415 unchain_marker (XMARKER (oldbegv
));
9416 unchain_marker (XMARKER (oldzv
));
9418 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9419 set_buffer_internal (oldbuf
);
9421 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9422 message_log_need_newline
= !nlflag
;
9423 Vdeactivate_mark
= old_deactivate_mark
;
9428 /* We are at the end of the buffer after just having inserted a newline.
9429 (Note: We depend on the fact we won't be crossing the gap.)
9430 Check to see if the most recent message looks a lot like the previous one.
9431 Return 0 if different, 1 if the new one should just replace it, or a
9432 value N > 1 if we should also append " [N times]". */
9435 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9438 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9440 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9441 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9443 for (i
= 0; i
< len
; i
++)
9445 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9453 if (*p1
++ == ' ' && *p1
++ == '[')
9456 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9457 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9464 /* Display an echo area message M with a specified length of NBYTES
9465 bytes. The string may include null characters. If M is 0, clear
9466 out any existing message, and let the mini-buffer text show
9469 This may GC, so the buffer M must NOT point to a Lisp string. */
9472 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9474 /* First flush out any partial line written with print. */
9475 message_log_maybe_newline ();
9477 message_dolog (m
, nbytes
, 1, multibyte
);
9478 message2_nolog (m
, nbytes
, multibyte
);
9482 /* The non-logging counterpart of message2. */
9485 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9487 struct frame
*sf
= SELECTED_FRAME ();
9488 message_enable_multibyte
= multibyte
;
9490 if (FRAME_INITIAL_P (sf
))
9492 if (noninteractive_need_newline
)
9493 putc ('\n', stderr
);
9494 noninteractive_need_newline
= 0;
9496 fwrite (m
, nbytes
, 1, stderr
);
9497 if (cursor_in_echo_area
== 0)
9498 fprintf (stderr
, "\n");
9501 /* A null message buffer means that the frame hasn't really been
9502 initialized yet. Error messages get reported properly by
9503 cmd_error, so this must be just an informative message; toss it. */
9504 else if (INTERACTIVE
9505 && sf
->glyphs_initialized_p
9506 && FRAME_MESSAGE_BUF (sf
))
9508 Lisp_Object mini_window
;
9511 /* Get the frame containing the mini-buffer
9512 that the selected frame is using. */
9513 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9514 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9516 FRAME_SAMPLE_VISIBILITY (f
);
9517 if (FRAME_VISIBLE_P (sf
)
9518 && ! FRAME_VISIBLE_P (f
))
9519 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9523 set_message (m
, Qnil
, nbytes
, multibyte
);
9524 if (minibuffer_auto_raise
)
9525 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9528 clear_message (1, 1);
9530 do_pending_window_change (0);
9531 echo_area_display (1);
9532 do_pending_window_change (0);
9533 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9534 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9539 /* Display an echo area message M with a specified length of NBYTES
9540 bytes. The string may include null characters. If M is not a
9541 string, clear out any existing message, and let the mini-buffer
9544 This function cancels echoing. */
9547 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9549 struct gcpro gcpro1
;
9552 clear_message (1,1);
9555 /* First flush out any partial line written with print. */
9556 message_log_maybe_newline ();
9562 SAFE_ALLOCA (buffer
, char *, nbytes
);
9563 memcpy (buffer
, SDATA (m
), nbytes
);
9564 message_dolog (buffer
, nbytes
, 1, multibyte
);
9567 message3_nolog (m
, nbytes
, multibyte
);
9573 /* The non-logging version of message3.
9574 This does not cancel echoing, because it is used for echoing.
9575 Perhaps we need to make a separate function for echoing
9576 and make this cancel echoing. */
9579 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9581 struct frame
*sf
= SELECTED_FRAME ();
9582 message_enable_multibyte
= multibyte
;
9584 if (FRAME_INITIAL_P (sf
))
9586 if (noninteractive_need_newline
)
9587 putc ('\n', stderr
);
9588 noninteractive_need_newline
= 0;
9590 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9591 if (cursor_in_echo_area
== 0)
9592 fprintf (stderr
, "\n");
9595 /* A null message buffer means that the frame hasn't really been
9596 initialized yet. Error messages get reported properly by
9597 cmd_error, so this must be just an informative message; toss it. */
9598 else if (INTERACTIVE
9599 && sf
->glyphs_initialized_p
9600 && FRAME_MESSAGE_BUF (sf
))
9602 Lisp_Object mini_window
;
9606 /* Get the frame containing the mini-buffer
9607 that the selected frame is using. */
9608 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9609 frame
= XWINDOW (mini_window
)->frame
;
9612 FRAME_SAMPLE_VISIBILITY (f
);
9613 if (FRAME_VISIBLE_P (sf
)
9614 && !FRAME_VISIBLE_P (f
))
9615 Fmake_frame_visible (frame
);
9617 if (STRINGP (m
) && SCHARS (m
) > 0)
9619 set_message (NULL
, m
, nbytes
, multibyte
);
9620 if (minibuffer_auto_raise
)
9621 Fraise_frame (frame
);
9622 /* Assume we are not echoing.
9623 (If we are, echo_now will override this.) */
9624 echo_message_buffer
= Qnil
;
9627 clear_message (1, 1);
9629 do_pending_window_change (0);
9630 echo_area_display (1);
9631 do_pending_window_change (0);
9632 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9633 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9638 /* Display a null-terminated echo area message M. If M is 0, clear
9639 out any existing message, and let the mini-buffer text show through.
9641 The buffer M must continue to exist until after the echo area gets
9642 cleared or some other message gets displayed there. Do not pass
9643 text that is stored in a Lisp string. Do not pass text in a buffer
9644 that was alloca'd. */
9647 message1 (const char *m
)
9649 message2 (m
, (m
? strlen (m
) : 0), 0);
9653 /* The non-logging counterpart of message1. */
9656 message1_nolog (const char *m
)
9658 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9661 /* Display a message M which contains a single %s
9662 which gets replaced with STRING. */
9665 message_with_string (const char *m
, Lisp_Object string
, int log
)
9667 CHECK_STRING (string
);
9673 if (noninteractive_need_newline
)
9674 putc ('\n', stderr
);
9675 noninteractive_need_newline
= 0;
9676 fprintf (stderr
, m
, SDATA (string
));
9677 if (!cursor_in_echo_area
)
9678 fprintf (stderr
, "\n");
9682 else if (INTERACTIVE
)
9684 /* The frame whose minibuffer we're going to display the message on.
9685 It may be larger than the selected frame, so we need
9686 to use its buffer, not the selected frame's buffer. */
9687 Lisp_Object mini_window
;
9688 struct frame
*f
, *sf
= SELECTED_FRAME ();
9690 /* Get the frame containing the minibuffer
9691 that the selected frame is using. */
9692 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9693 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9695 /* A null message buffer means that the frame hasn't really been
9696 initialized yet. Error messages get reported properly by
9697 cmd_error, so this must be just an informative message; toss it. */
9698 if (FRAME_MESSAGE_BUF (f
))
9700 Lisp_Object args
[2], msg
;
9701 struct gcpro gcpro1
, gcpro2
;
9703 args
[0] = build_string (m
);
9704 args
[1] = msg
= string
;
9705 GCPRO2 (args
[0], msg
);
9708 msg
= Fformat (2, args
);
9711 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9713 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9717 /* Print should start at the beginning of the message
9718 buffer next time. */
9719 message_buf_print
= 0;
9725 /* Dump an informative message to the minibuf. If M is 0, clear out
9726 any existing message, and let the mini-buffer text show through. */
9729 vmessage (const char *m
, va_list ap
)
9735 if (noninteractive_need_newline
)
9736 putc ('\n', stderr
);
9737 noninteractive_need_newline
= 0;
9738 vfprintf (stderr
, m
, ap
);
9739 if (cursor_in_echo_area
== 0)
9740 fprintf (stderr
, "\n");
9744 else if (INTERACTIVE
)
9746 /* The frame whose mini-buffer we're going to display the message
9747 on. It may be larger than the selected frame, so we need to
9748 use its buffer, not the selected frame's buffer. */
9749 Lisp_Object mini_window
;
9750 struct frame
*f
, *sf
= SELECTED_FRAME ();
9752 /* Get the frame containing the mini-buffer
9753 that the selected frame is using. */
9754 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9755 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9757 /* A null message buffer means that the frame hasn't really been
9758 initialized yet. Error messages get reported properly by
9759 cmd_error, so this must be just an informative message; toss
9761 if (FRAME_MESSAGE_BUF (f
))
9767 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9768 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9770 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9775 /* Print should start at the beginning of the message
9776 buffer next time. */
9777 message_buf_print
= 0;
9783 message (const char *m
, ...)
9793 /* The non-logging version of message. */
9796 message_nolog (const char *m
, ...)
9798 Lisp_Object old_log_max
;
9801 old_log_max
= Vmessage_log_max
;
9802 Vmessage_log_max
= Qnil
;
9804 Vmessage_log_max
= old_log_max
;
9810 /* Display the current message in the current mini-buffer. This is
9811 only called from error handlers in process.c, and is not time
9815 update_echo_area (void)
9817 if (!NILP (echo_area_buffer
[0]))
9820 string
= Fcurrent_message ();
9821 message3 (string
, SBYTES (string
),
9822 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9827 /* Make sure echo area buffers in `echo_buffers' are live.
9828 If they aren't, make new ones. */
9831 ensure_echo_area_buffers (void)
9835 for (i
= 0; i
< 2; ++i
)
9836 if (!BUFFERP (echo_buffer
[i
])
9837 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9840 Lisp_Object old_buffer
;
9843 old_buffer
= echo_buffer
[i
];
9844 sprintf (name
, " *Echo Area %d*", i
);
9845 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9846 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9847 /* to force word wrap in echo area -
9848 it was decided to postpone this*/
9849 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9851 for (j
= 0; j
< 2; ++j
)
9852 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9853 echo_area_buffer
[j
] = echo_buffer
[i
];
9858 /* Call FN with args A1..A4 with either the current or last displayed
9859 echo_area_buffer as current buffer.
9861 WHICH zero means use the current message buffer
9862 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9863 from echo_buffer[] and clear it.
9865 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9866 suitable buffer from echo_buffer[] and clear it.
9868 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9869 that the current message becomes the last displayed one, make
9870 choose a suitable buffer for echo_area_buffer[0], and clear it.
9872 Value is what FN returns. */
9875 with_echo_area_buffer (struct window
*w
, int which
,
9876 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9877 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9880 int this_one
, the_other
, clear_buffer_p
, rc
;
9881 ptrdiff_t count
= SPECPDL_INDEX ();
9883 /* If buffers aren't live, make new ones. */
9884 ensure_echo_area_buffers ();
9889 this_one
= 0, the_other
= 1;
9891 this_one
= 1, the_other
= 0;
9894 this_one
= 0, the_other
= 1;
9897 /* We need a fresh one in case the current echo buffer equals
9898 the one containing the last displayed echo area message. */
9899 if (!NILP (echo_area_buffer
[this_one
])
9900 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9901 echo_area_buffer
[this_one
] = Qnil
;
9904 /* Choose a suitable buffer from echo_buffer[] is we don't
9906 if (NILP (echo_area_buffer
[this_one
]))
9908 echo_area_buffer
[this_one
]
9909 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9910 ? echo_buffer
[the_other
]
9911 : echo_buffer
[this_one
]);
9915 buffer
= echo_area_buffer
[this_one
];
9917 /* Don't get confused by reusing the buffer used for echoing
9918 for a different purpose. */
9919 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9922 record_unwind_protect (unwind_with_echo_area_buffer
,
9923 with_echo_area_buffer_unwind_data (w
));
9925 /* Make the echo area buffer current. Note that for display
9926 purposes, it is not necessary that the displayed window's buffer
9927 == current_buffer, except for text property lookup. So, let's
9928 only set that buffer temporarily here without doing a full
9929 Fset_window_buffer. We must also change w->pointm, though,
9930 because otherwise an assertions in unshow_buffer fails, and Emacs
9932 set_buffer_internal_1 (XBUFFER (buffer
));
9936 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9939 BVAR (current_buffer
, undo_list
) = Qt
;
9940 BVAR (current_buffer
, read_only
) = Qnil
;
9941 specbind (Qinhibit_read_only
, Qt
);
9942 specbind (Qinhibit_modification_hooks
, Qt
);
9944 if (clear_buffer_p
&& Z
> BEG
)
9947 xassert (BEGV
>= BEG
);
9948 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9950 rc
= fn (a1
, a2
, a3
, a4
);
9952 xassert (BEGV
>= BEG
);
9953 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9955 unbind_to (count
, Qnil
);
9960 /* Save state that should be preserved around the call to the function
9961 FN called in with_echo_area_buffer. */
9964 with_echo_area_buffer_unwind_data (struct window
*w
)
9967 Lisp_Object vector
, tmp
;
9969 /* Reduce consing by keeping one vector in
9970 Vwith_echo_area_save_vector. */
9971 vector
= Vwith_echo_area_save_vector
;
9972 Vwith_echo_area_save_vector
= Qnil
;
9975 vector
= Fmake_vector (make_number (7), Qnil
);
9977 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9978 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9979 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9983 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9984 ASET (vector
, i
, w
->buffer
); ++i
;
9985 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9986 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9991 for (; i
< end
; ++i
)
9992 ASET (vector
, i
, Qnil
);
9995 xassert (i
== ASIZE (vector
));
10000 /* Restore global state from VECTOR which was created by
10001 with_echo_area_buffer_unwind_data. */
10004 unwind_with_echo_area_buffer (Lisp_Object vector
)
10006 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10007 Vdeactivate_mark
= AREF (vector
, 1);
10008 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10010 if (WINDOWP (AREF (vector
, 3)))
10013 Lisp_Object buffer
, charpos
, bytepos
;
10015 w
= XWINDOW (AREF (vector
, 3));
10016 buffer
= AREF (vector
, 4);
10017 charpos
= AREF (vector
, 5);
10018 bytepos
= AREF (vector
, 6);
10020 w
->buffer
= buffer
;
10021 set_marker_both (w
->pointm
, buffer
,
10022 XFASTINT (charpos
), XFASTINT (bytepos
));
10025 Vwith_echo_area_save_vector
= vector
;
10030 /* Set up the echo area for use by print functions. MULTIBYTE_P
10031 non-zero means we will print multibyte. */
10034 setup_echo_area_for_printing (int multibyte_p
)
10036 /* If we can't find an echo area any more, exit. */
10037 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10038 Fkill_emacs (Qnil
);
10040 ensure_echo_area_buffers ();
10042 if (!message_buf_print
)
10044 /* A message has been output since the last time we printed.
10045 Choose a fresh echo area buffer. */
10046 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10047 echo_area_buffer
[0] = echo_buffer
[1];
10049 echo_area_buffer
[0] = echo_buffer
[0];
10051 /* Switch to that buffer and clear it. */
10052 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10053 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10057 ptrdiff_t count
= SPECPDL_INDEX ();
10058 specbind (Qinhibit_read_only
, Qt
);
10059 /* Note that undo recording is always disabled. */
10060 del_range (BEG
, Z
);
10061 unbind_to (count
, Qnil
);
10063 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10065 /* Set up the buffer for the multibyteness we need. */
10067 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10068 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10070 /* Raise the frame containing the echo area. */
10071 if (minibuffer_auto_raise
)
10073 struct frame
*sf
= SELECTED_FRAME ();
10074 Lisp_Object mini_window
;
10075 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10076 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10079 message_log_maybe_newline ();
10080 message_buf_print
= 1;
10084 if (NILP (echo_area_buffer
[0]))
10086 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10087 echo_area_buffer
[0] = echo_buffer
[1];
10089 echo_area_buffer
[0] = echo_buffer
[0];
10092 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10094 /* Someone switched buffers between print requests. */
10095 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10096 BVAR (current_buffer
, truncate_lines
) = Qnil
;
10102 /* Display an echo area message in window W. Value is non-zero if W's
10103 height is changed. If display_last_displayed_message_p is
10104 non-zero, display the message that was last displayed, otherwise
10105 display the current message. */
10108 display_echo_area (struct window
*w
)
10110 int i
, no_message_p
, window_height_changed_p
;
10112 /* Temporarily disable garbage collections while displaying the echo
10113 area. This is done because a GC can print a message itself.
10114 That message would modify the echo area buffer's contents while a
10115 redisplay of the buffer is going on, and seriously confuse
10117 ptrdiff_t count
= inhibit_garbage_collection ();
10119 /* If there is no message, we must call display_echo_area_1
10120 nevertheless because it resizes the window. But we will have to
10121 reset the echo_area_buffer in question to nil at the end because
10122 with_echo_area_buffer will sets it to an empty buffer. */
10123 i
= display_last_displayed_message_p
? 1 : 0;
10124 no_message_p
= NILP (echo_area_buffer
[i
]);
10126 window_height_changed_p
10127 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10128 display_echo_area_1
,
10129 (intptr_t) w
, Qnil
, 0, 0);
10132 echo_area_buffer
[i
] = Qnil
;
10134 unbind_to (count
, Qnil
);
10135 return window_height_changed_p
;
10139 /* Helper for display_echo_area. Display the current buffer which
10140 contains the current echo area message in window W, a mini-window,
10141 a pointer to which is passed in A1. A2..A4 are currently not used.
10142 Change the height of W so that all of the message is displayed.
10143 Value is non-zero if height of W was changed. */
10146 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10149 struct window
*w
= (struct window
*) i1
;
10150 Lisp_Object window
;
10151 struct text_pos start
;
10152 int window_height_changed_p
= 0;
10154 /* Do this before displaying, so that we have a large enough glyph
10155 matrix for the display. If we can't get enough space for the
10156 whole text, display the last N lines. That works by setting w->start. */
10157 window_height_changed_p
= resize_mini_window (w
, 0);
10159 /* Use the starting position chosen by resize_mini_window. */
10160 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10163 clear_glyph_matrix (w
->desired_matrix
);
10164 XSETWINDOW (window
, w
);
10165 try_window (window
, start
, 0);
10167 return window_height_changed_p
;
10171 /* Resize the echo area window to exactly the size needed for the
10172 currently displayed message, if there is one. If a mini-buffer
10173 is active, don't shrink it. */
10176 resize_echo_area_exactly (void)
10178 if (BUFFERP (echo_area_buffer
[0])
10179 && WINDOWP (echo_area_window
))
10181 struct window
*w
= XWINDOW (echo_area_window
);
10183 Lisp_Object resize_exactly
;
10185 if (minibuf_level
== 0)
10186 resize_exactly
= Qt
;
10188 resize_exactly
= Qnil
;
10190 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10191 (intptr_t) w
, resize_exactly
,
10195 ++windows_or_buffers_changed
;
10196 ++update_mode_lines
;
10197 redisplay_internal ();
10203 /* Callback function for with_echo_area_buffer, when used from
10204 resize_echo_area_exactly. A1 contains a pointer to the window to
10205 resize, EXACTLY non-nil means resize the mini-window exactly to the
10206 size of the text displayed. A3 and A4 are not used. Value is what
10207 resize_mini_window returns. */
10210 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10213 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10217 /* Resize mini-window W to fit the size of its contents. EXACT_P
10218 means size the window exactly to the size needed. Otherwise, it's
10219 only enlarged until W's buffer is empty.
10221 Set W->start to the right place to begin display. If the whole
10222 contents fit, start at the beginning. Otherwise, start so as
10223 to make the end of the contents appear. This is particularly
10224 important for y-or-n-p, but seems desirable generally.
10226 Value is non-zero if the window height has been changed. */
10229 resize_mini_window (struct window
*w
, int exact_p
)
10231 struct frame
*f
= XFRAME (w
->frame
);
10232 int window_height_changed_p
= 0;
10234 xassert (MINI_WINDOW_P (w
));
10236 /* By default, start display at the beginning. */
10237 set_marker_both (w
->start
, w
->buffer
,
10238 BUF_BEGV (XBUFFER (w
->buffer
)),
10239 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10241 /* Don't resize windows while redisplaying a window; it would
10242 confuse redisplay functions when the size of the window they are
10243 displaying changes from under them. Such a resizing can happen,
10244 for instance, when which-func prints a long message while
10245 we are running fontification-functions. We're running these
10246 functions with safe_call which binds inhibit-redisplay to t. */
10247 if (!NILP (Vinhibit_redisplay
))
10250 /* Nil means don't try to resize. */
10251 if (NILP (Vresize_mini_windows
)
10252 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10255 if (!FRAME_MINIBUF_ONLY_P (f
))
10258 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10259 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10261 EMACS_INT max_height
;
10262 int unit
= FRAME_LINE_HEIGHT (f
);
10263 struct text_pos start
;
10264 struct buffer
*old_current_buffer
= NULL
;
10266 if (current_buffer
!= XBUFFER (w
->buffer
))
10268 old_current_buffer
= current_buffer
;
10269 set_buffer_internal (XBUFFER (w
->buffer
));
10272 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10274 /* Compute the max. number of lines specified by the user. */
10275 if (FLOATP (Vmax_mini_window_height
))
10276 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10277 else if (INTEGERP (Vmax_mini_window_height
))
10278 max_height
= XINT (Vmax_mini_window_height
);
10280 max_height
= total_height
/ 4;
10282 /* Correct that max. height if it's bogus. */
10283 max_height
= max (1, max_height
);
10284 max_height
= min (total_height
, max_height
);
10286 /* Find out the height of the text in the window. */
10287 if (it
.line_wrap
== TRUNCATE
)
10292 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10293 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10294 height
= it
.current_y
+ last_height
;
10296 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10297 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10298 height
= (height
+ unit
- 1) / unit
;
10301 /* Compute a suitable window start. */
10302 if (height
> max_height
)
10304 height
= max_height
;
10305 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10306 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10307 start
= it
.current
.pos
;
10310 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10311 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10313 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10315 /* Let it grow only, until we display an empty message, in which
10316 case the window shrinks again. */
10317 if (height
> WINDOW_TOTAL_LINES (w
))
10319 int old_height
= WINDOW_TOTAL_LINES (w
);
10320 freeze_window_starts (f
, 1);
10321 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10322 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10324 else if (height
< WINDOW_TOTAL_LINES (w
)
10325 && (exact_p
|| BEGV
== ZV
))
10327 int old_height
= WINDOW_TOTAL_LINES (w
);
10328 freeze_window_starts (f
, 0);
10329 shrink_mini_window (w
);
10330 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10335 /* Always resize to exact size needed. */
10336 if (height
> WINDOW_TOTAL_LINES (w
))
10338 int old_height
= WINDOW_TOTAL_LINES (w
);
10339 freeze_window_starts (f
, 1);
10340 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10341 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10343 else if (height
< WINDOW_TOTAL_LINES (w
))
10345 int old_height
= WINDOW_TOTAL_LINES (w
);
10346 freeze_window_starts (f
, 0);
10347 shrink_mini_window (w
);
10351 freeze_window_starts (f
, 1);
10352 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10355 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10359 if (old_current_buffer
)
10360 set_buffer_internal (old_current_buffer
);
10363 return window_height_changed_p
;
10367 /* Value is the current message, a string, or nil if there is no
10368 current message. */
10371 current_message (void)
10375 if (!BUFFERP (echo_area_buffer
[0]))
10379 with_echo_area_buffer (0, 0, current_message_1
,
10380 (intptr_t) &msg
, Qnil
, 0, 0);
10382 echo_area_buffer
[0] = Qnil
;
10390 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10393 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10396 *msg
= make_buffer_string (BEG
, Z
, 1);
10403 /* Push the current message on Vmessage_stack for later restoration
10404 by restore_message. Value is non-zero if the current message isn't
10405 empty. This is a relatively infrequent operation, so it's not
10406 worth optimizing. */
10409 push_message (void)
10412 msg
= current_message ();
10413 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10414 return STRINGP (msg
);
10418 /* Restore message display from the top of Vmessage_stack. */
10421 restore_message (void)
10425 xassert (CONSP (Vmessage_stack
));
10426 msg
= XCAR (Vmessage_stack
);
10428 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10430 message3_nolog (msg
, 0, 0);
10434 /* Handler for record_unwind_protect calling pop_message. */
10437 pop_message_unwind (Lisp_Object dummy
)
10443 /* Pop the top-most entry off Vmessage_stack. */
10448 xassert (CONSP (Vmessage_stack
));
10449 Vmessage_stack
= XCDR (Vmessage_stack
);
10453 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10454 exits. If the stack is not empty, we have a missing pop_message
10458 check_message_stack (void)
10460 if (!NILP (Vmessage_stack
))
10465 /* Truncate to NCHARS what will be displayed in the echo area the next
10466 time we display it---but don't redisplay it now. */
10469 truncate_echo_area (ptrdiff_t nchars
)
10472 echo_area_buffer
[0] = Qnil
;
10473 /* A null message buffer means that the frame hasn't really been
10474 initialized yet. Error messages get reported properly by
10475 cmd_error, so this must be just an informative message; toss it. */
10476 else if (!noninteractive
10478 && !NILP (echo_area_buffer
[0]))
10480 struct frame
*sf
= SELECTED_FRAME ();
10481 if (FRAME_MESSAGE_BUF (sf
))
10482 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10487 /* Helper function for truncate_echo_area. Truncate the current
10488 message to at most NCHARS characters. */
10491 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10493 if (BEG
+ nchars
< Z
)
10494 del_range (BEG
+ nchars
, Z
);
10496 echo_area_buffer
[0] = Qnil
;
10501 /* Set the current message to a substring of S or STRING.
10503 If STRING is a Lisp string, set the message to the first NBYTES
10504 bytes from STRING. NBYTES zero means use the whole string. If
10505 STRING is multibyte, the message will be displayed multibyte.
10507 If S is not null, set the message to the first LEN bytes of S. LEN
10508 zero means use the whole string. MULTIBYTE_P non-zero means S is
10509 multibyte. Display the message multibyte in that case.
10511 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10512 to t before calling set_message_1 (which calls insert).
10516 set_message (const char *s
, Lisp_Object string
,
10517 ptrdiff_t nbytes
, int multibyte_p
)
10519 message_enable_multibyte
10520 = ((s
&& multibyte_p
)
10521 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10523 with_echo_area_buffer (0, -1, set_message_1
,
10524 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10525 message_buf_print
= 0;
10526 help_echo_showing_p
= 0;
10530 /* Helper function for set_message. Arguments have the same meaning
10531 as there, with A1 corresponding to S and A2 corresponding to STRING
10532 This function is called with the echo area buffer being
10536 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10539 const char *s
= (const char *) i1
;
10540 const unsigned char *msg
= (const unsigned char *) s
;
10541 Lisp_Object string
= a2
;
10543 /* Change multibyteness of the echo buffer appropriately. */
10544 if (message_enable_multibyte
10545 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10546 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10548 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10549 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10550 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10552 /* Insert new message at BEG. */
10553 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10555 if (STRINGP (string
))
10560 nbytes
= SBYTES (string
);
10561 nchars
= string_byte_to_char (string
, nbytes
);
10563 /* This function takes care of single/multibyte conversion. We
10564 just have to ensure that the echo area buffer has the right
10565 setting of enable_multibyte_characters. */
10566 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10571 nbytes
= strlen (s
);
10573 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10575 /* Convert from multi-byte to single-byte. */
10580 /* Convert a multibyte string to single-byte. */
10581 for (i
= 0; i
< nbytes
; i
+= n
)
10583 c
= string_char_and_length (msg
+ i
, &n
);
10584 work
[0] = (ASCII_CHAR_P (c
)
10586 : multibyte_char_to_unibyte (c
));
10587 insert_1_both (work
, 1, 1, 1, 0, 0);
10590 else if (!multibyte_p
10591 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10593 /* Convert from single-byte to multi-byte. */
10596 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10598 /* Convert a single-byte string to multibyte. */
10599 for (i
= 0; i
< nbytes
; i
++)
10602 MAKE_CHAR_MULTIBYTE (c
);
10603 n
= CHAR_STRING (c
, str
);
10604 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10608 insert_1 (s
, nbytes
, 1, 0, 0);
10615 /* Clear messages. CURRENT_P non-zero means clear the current
10616 message. LAST_DISPLAYED_P non-zero means clear the message
10620 clear_message (int current_p
, int last_displayed_p
)
10624 echo_area_buffer
[0] = Qnil
;
10625 message_cleared_p
= 1;
10628 if (last_displayed_p
)
10629 echo_area_buffer
[1] = Qnil
;
10631 message_buf_print
= 0;
10634 /* Clear garbaged frames.
10636 This function is used where the old redisplay called
10637 redraw_garbaged_frames which in turn called redraw_frame which in
10638 turn called clear_frame. The call to clear_frame was a source of
10639 flickering. I believe a clear_frame is not necessary. It should
10640 suffice in the new redisplay to invalidate all current matrices,
10641 and ensure a complete redisplay of all windows. */
10644 clear_garbaged_frames (void)
10646 if (frame_garbaged
)
10648 Lisp_Object tail
, frame
;
10649 int changed_count
= 0;
10651 FOR_EACH_FRAME (tail
, frame
)
10653 struct frame
*f
= XFRAME (frame
);
10655 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10659 Fredraw_frame (frame
);
10660 f
->force_flush_display_p
= 1;
10662 clear_current_matrices (f
);
10669 frame_garbaged
= 0;
10671 ++windows_or_buffers_changed
;
10676 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10677 is non-zero update selected_frame. Value is non-zero if the
10678 mini-windows height has been changed. */
10681 echo_area_display (int update_frame_p
)
10683 Lisp_Object mini_window
;
10686 int window_height_changed_p
= 0;
10687 struct frame
*sf
= SELECTED_FRAME ();
10689 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10690 w
= XWINDOW (mini_window
);
10691 f
= XFRAME (WINDOW_FRAME (w
));
10693 /* Don't display if frame is invisible or not yet initialized. */
10694 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10697 #ifdef HAVE_WINDOW_SYSTEM
10698 /* When Emacs starts, selected_frame may be the initial terminal
10699 frame. If we let this through, a message would be displayed on
10701 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10703 #endif /* HAVE_WINDOW_SYSTEM */
10705 /* Redraw garbaged frames. */
10706 if (frame_garbaged
)
10707 clear_garbaged_frames ();
10709 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10711 echo_area_window
= mini_window
;
10712 window_height_changed_p
= display_echo_area (w
);
10713 w
->must_be_updated_p
= 1;
10715 /* Update the display, unless called from redisplay_internal.
10716 Also don't update the screen during redisplay itself. The
10717 update will happen at the end of redisplay, and an update
10718 here could cause confusion. */
10719 if (update_frame_p
&& !redisplaying_p
)
10723 /* If the display update has been interrupted by pending
10724 input, update mode lines in the frame. Due to the
10725 pending input, it might have been that redisplay hasn't
10726 been called, so that mode lines above the echo area are
10727 garbaged. This looks odd, so we prevent it here. */
10728 if (!display_completed
)
10729 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10731 if (window_height_changed_p
10732 /* Don't do this if Emacs is shutting down. Redisplay
10733 needs to run hooks. */
10734 && !NILP (Vrun_hooks
))
10736 /* Must update other windows. Likewise as in other
10737 cases, don't let this update be interrupted by
10739 ptrdiff_t count
= SPECPDL_INDEX ();
10740 specbind (Qredisplay_dont_pause
, Qt
);
10741 windows_or_buffers_changed
= 1;
10742 redisplay_internal ();
10743 unbind_to (count
, Qnil
);
10745 else if (FRAME_WINDOW_P (f
) && n
== 0)
10747 /* Window configuration is the same as before.
10748 Can do with a display update of the echo area,
10749 unless we displayed some mode lines. */
10750 update_single_window (w
, 1);
10751 FRAME_RIF (f
)->flush_display (f
);
10754 update_frame (f
, 1, 1);
10756 /* If cursor is in the echo area, make sure that the next
10757 redisplay displays the minibuffer, so that the cursor will
10758 be replaced with what the minibuffer wants. */
10759 if (cursor_in_echo_area
)
10760 ++windows_or_buffers_changed
;
10763 else if (!EQ (mini_window
, selected_window
))
10764 windows_or_buffers_changed
++;
10766 /* Last displayed message is now the current message. */
10767 echo_area_buffer
[1] = echo_area_buffer
[0];
10768 /* Inform read_char that we're not echoing. */
10769 echo_message_buffer
= Qnil
;
10771 /* Prevent redisplay optimization in redisplay_internal by resetting
10772 this_line_start_pos. This is done because the mini-buffer now
10773 displays the message instead of its buffer text. */
10774 if (EQ (mini_window
, selected_window
))
10775 CHARPOS (this_line_start_pos
) = 0;
10777 return window_height_changed_p
;
10782 /***********************************************************************
10783 Mode Lines and Frame Titles
10784 ***********************************************************************/
10786 /* A buffer for constructing non-propertized mode-line strings and
10787 frame titles in it; allocated from the heap in init_xdisp and
10788 resized as needed in store_mode_line_noprop_char. */
10790 static char *mode_line_noprop_buf
;
10792 /* The buffer's end, and a current output position in it. */
10794 static char *mode_line_noprop_buf_end
;
10795 static char *mode_line_noprop_ptr
;
10797 #define MODE_LINE_NOPROP_LEN(start) \
10798 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10801 MODE_LINE_DISPLAY
= 0,
10805 } mode_line_target
;
10807 /* Alist that caches the results of :propertize.
10808 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10809 static Lisp_Object mode_line_proptrans_alist
;
10811 /* List of strings making up the mode-line. */
10812 static Lisp_Object mode_line_string_list
;
10814 /* Base face property when building propertized mode line string. */
10815 static Lisp_Object mode_line_string_face
;
10816 static Lisp_Object mode_line_string_face_prop
;
10819 /* Unwind data for mode line strings */
10821 static Lisp_Object Vmode_line_unwind_vector
;
10824 format_mode_line_unwind_data (struct buffer
*obuf
,
10826 int save_proptrans
)
10828 Lisp_Object vector
, tmp
;
10830 /* Reduce consing by keeping one vector in
10831 Vwith_echo_area_save_vector. */
10832 vector
= Vmode_line_unwind_vector
;
10833 Vmode_line_unwind_vector
= Qnil
;
10836 vector
= Fmake_vector (make_number (8), Qnil
);
10838 ASET (vector
, 0, make_number (mode_line_target
));
10839 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10840 ASET (vector
, 2, mode_line_string_list
);
10841 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10842 ASET (vector
, 4, mode_line_string_face
);
10843 ASET (vector
, 5, mode_line_string_face_prop
);
10846 XSETBUFFER (tmp
, obuf
);
10849 ASET (vector
, 6, tmp
);
10850 ASET (vector
, 7, owin
);
10856 unwind_format_mode_line (Lisp_Object vector
)
10858 mode_line_target
= XINT (AREF (vector
, 0));
10859 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10860 mode_line_string_list
= AREF (vector
, 2);
10861 if (! EQ (AREF (vector
, 3), Qt
))
10862 mode_line_proptrans_alist
= AREF (vector
, 3);
10863 mode_line_string_face
= AREF (vector
, 4);
10864 mode_line_string_face_prop
= AREF (vector
, 5);
10866 if (!NILP (AREF (vector
, 7)))
10867 /* Select window before buffer, since it may change the buffer. */
10868 Fselect_window (AREF (vector
, 7), Qt
);
10870 if (!NILP (AREF (vector
, 6)))
10872 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10873 ASET (vector
, 6, Qnil
);
10876 Vmode_line_unwind_vector
= vector
;
10881 /* Store a single character C for the frame title in mode_line_noprop_buf.
10882 Re-allocate mode_line_noprop_buf if necessary. */
10885 store_mode_line_noprop_char (char c
)
10887 /* If output position has reached the end of the allocated buffer,
10888 increase the buffer's size. */
10889 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10891 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10892 ptrdiff_t size
= len
;
10893 mode_line_noprop_buf
=
10894 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10895 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10896 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10899 *mode_line_noprop_ptr
++ = c
;
10903 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10904 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10905 characters that yield more columns than PRECISION; PRECISION <= 0
10906 means copy the whole string. Pad with spaces until FIELD_WIDTH
10907 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10908 pad. Called from display_mode_element when it is used to build a
10912 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10914 const unsigned char *str
= (const unsigned char *) string
;
10916 ptrdiff_t dummy
, nbytes
;
10918 /* Copy at most PRECISION chars from STR. */
10919 nbytes
= strlen (string
);
10920 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10922 store_mode_line_noprop_char (*str
++);
10924 /* Fill up with spaces until FIELD_WIDTH reached. */
10925 while (field_width
> 0
10926 && n
< field_width
)
10928 store_mode_line_noprop_char (' ');
10935 /***********************************************************************
10937 ***********************************************************************/
10939 #ifdef HAVE_WINDOW_SYSTEM
10941 /* Set the title of FRAME, if it has changed. The title format is
10942 Vicon_title_format if FRAME is iconified, otherwise it is
10943 frame_title_format. */
10946 x_consider_frame_title (Lisp_Object frame
)
10948 struct frame
*f
= XFRAME (frame
);
10950 if (FRAME_WINDOW_P (f
)
10951 || FRAME_MINIBUF_ONLY_P (f
)
10952 || f
->explicit_name
)
10954 /* Do we have more than one visible frame on this X display? */
10957 ptrdiff_t title_start
;
10961 ptrdiff_t count
= SPECPDL_INDEX ();
10963 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10965 Lisp_Object other_frame
= XCAR (tail
);
10966 struct frame
*tf
= XFRAME (other_frame
);
10969 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10970 && !FRAME_MINIBUF_ONLY_P (tf
)
10971 && !EQ (other_frame
, tip_frame
)
10972 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10976 /* Set global variable indicating that multiple frames exist. */
10977 multiple_frames
= CONSP (tail
);
10979 /* Switch to the buffer of selected window of the frame. Set up
10980 mode_line_target so that display_mode_element will output into
10981 mode_line_noprop_buf; then display the title. */
10982 record_unwind_protect (unwind_format_mode_line
,
10983 format_mode_line_unwind_data
10984 (current_buffer
, selected_window
, 0));
10986 Fselect_window (f
->selected_window
, Qt
);
10987 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10988 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10990 mode_line_target
= MODE_LINE_TITLE
;
10991 title_start
= MODE_LINE_NOPROP_LEN (0);
10992 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10993 NULL
, DEFAULT_FACE_ID
);
10994 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10995 len
= MODE_LINE_NOPROP_LEN (title_start
);
10996 title
= mode_line_noprop_buf
+ title_start
;
10997 unbind_to (count
, Qnil
);
10999 /* Set the title only if it's changed. This avoids consing in
11000 the common case where it hasn't. (If it turns out that we've
11001 already wasted too much time by walking through the list with
11002 display_mode_element, then we might need to optimize at a
11003 higher level than this.) */
11004 if (! STRINGP (f
->name
)
11005 || SBYTES (f
->name
) != len
11006 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11007 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11011 #endif /* not HAVE_WINDOW_SYSTEM */
11016 /***********************************************************************
11018 ***********************************************************************/
11021 /* Prepare for redisplay by updating menu-bar item lists when
11022 appropriate. This can call eval. */
11025 prepare_menu_bars (void)
11028 struct gcpro gcpro1
, gcpro2
;
11030 Lisp_Object tooltip_frame
;
11032 #ifdef HAVE_WINDOW_SYSTEM
11033 tooltip_frame
= tip_frame
;
11035 tooltip_frame
= Qnil
;
11038 /* Update all frame titles based on their buffer names, etc. We do
11039 this before the menu bars so that the buffer-menu will show the
11040 up-to-date frame titles. */
11041 #ifdef HAVE_WINDOW_SYSTEM
11042 if (windows_or_buffers_changed
|| update_mode_lines
)
11044 Lisp_Object tail
, frame
;
11046 FOR_EACH_FRAME (tail
, frame
)
11048 f
= XFRAME (frame
);
11049 if (!EQ (frame
, tooltip_frame
)
11050 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11051 x_consider_frame_title (frame
);
11054 #endif /* HAVE_WINDOW_SYSTEM */
11056 /* Update the menu bar item lists, if appropriate. This has to be
11057 done before any actual redisplay or generation of display lines. */
11058 all_windows
= (update_mode_lines
11059 || buffer_shared
> 1
11060 || windows_or_buffers_changed
);
11063 Lisp_Object tail
, frame
;
11064 ptrdiff_t count
= SPECPDL_INDEX ();
11065 /* 1 means that update_menu_bar has run its hooks
11066 so any further calls to update_menu_bar shouldn't do so again. */
11067 int menu_bar_hooks_run
= 0;
11069 record_unwind_save_match_data ();
11071 FOR_EACH_FRAME (tail
, frame
)
11073 f
= XFRAME (frame
);
11075 /* Ignore tooltip frame. */
11076 if (EQ (frame
, tooltip_frame
))
11079 /* If a window on this frame changed size, report that to
11080 the user and clear the size-change flag. */
11081 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11083 Lisp_Object functions
;
11085 /* Clear flag first in case we get an error below. */
11086 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11087 functions
= Vwindow_size_change_functions
;
11088 GCPRO2 (tail
, functions
);
11090 while (CONSP (functions
))
11092 if (!EQ (XCAR (functions
), Qt
))
11093 call1 (XCAR (functions
), frame
);
11094 functions
= XCDR (functions
);
11100 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11101 #ifdef HAVE_WINDOW_SYSTEM
11102 update_tool_bar (f
, 0);
11105 if (windows_or_buffers_changed
11107 ns_set_doc_edited (f
, Fbuffer_modified_p
11108 (XWINDOW (f
->selected_window
)->buffer
));
11113 unbind_to (count
, Qnil
);
11117 struct frame
*sf
= SELECTED_FRAME ();
11118 update_menu_bar (sf
, 1, 0);
11119 #ifdef HAVE_WINDOW_SYSTEM
11120 update_tool_bar (sf
, 1);
11126 /* Update the menu bar item list for frame F. This has to be done
11127 before we start to fill in any display lines, because it can call
11130 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11132 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11133 already ran the menu bar hooks for this redisplay, so there
11134 is no need to run them again. The return value is the
11135 updated value of this flag, to pass to the next call. */
11138 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11140 Lisp_Object window
;
11141 register struct window
*w
;
11143 /* If called recursively during a menu update, do nothing. This can
11144 happen when, for instance, an activate-menubar-hook causes a
11146 if (inhibit_menubar_update
)
11149 window
= FRAME_SELECTED_WINDOW (f
);
11150 w
= XWINDOW (window
);
11152 if (FRAME_WINDOW_P (f
)
11154 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11155 || defined (HAVE_NS) || defined (USE_GTK)
11156 FRAME_EXTERNAL_MENU_BAR (f
)
11158 FRAME_MENU_BAR_LINES (f
) > 0
11160 : FRAME_MENU_BAR_LINES (f
) > 0)
11162 /* If the user has switched buffers or windows, we need to
11163 recompute to reflect the new bindings. But we'll
11164 recompute when update_mode_lines is set too; that means
11165 that people can use force-mode-line-update to request
11166 that the menu bar be recomputed. The adverse effect on
11167 the rest of the redisplay algorithm is about the same as
11168 windows_or_buffers_changed anyway. */
11169 if (windows_or_buffers_changed
11170 /* This used to test w->update_mode_line, but we believe
11171 there is no need to recompute the menu in that case. */
11172 || update_mode_lines
11173 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11174 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11175 != w
->last_had_star
)
11176 || ((!NILP (Vtransient_mark_mode
)
11177 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11178 != !NILP (w
->region_showing
)))
11180 struct buffer
*prev
= current_buffer
;
11181 ptrdiff_t count
= SPECPDL_INDEX ();
11183 specbind (Qinhibit_menubar_update
, Qt
);
11185 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11186 if (save_match_data
)
11187 record_unwind_save_match_data ();
11188 if (NILP (Voverriding_local_map_menu_flag
))
11190 specbind (Qoverriding_terminal_local_map
, Qnil
);
11191 specbind (Qoverriding_local_map
, Qnil
);
11196 /* Run the Lucid hook. */
11197 safe_run_hooks (Qactivate_menubar_hook
);
11199 /* If it has changed current-menubar from previous value,
11200 really recompute the menu-bar from the value. */
11201 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11202 call0 (Qrecompute_lucid_menubar
);
11204 safe_run_hooks (Qmenu_bar_update_hook
);
11209 XSETFRAME (Vmenu_updating_frame
, f
);
11210 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11212 /* Redisplay the menu bar in case we changed it. */
11213 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11214 || defined (HAVE_NS) || defined (USE_GTK)
11215 if (FRAME_WINDOW_P (f
))
11217 #if defined (HAVE_NS)
11218 /* All frames on Mac OS share the same menubar. So only
11219 the selected frame should be allowed to set it. */
11220 if (f
== SELECTED_FRAME ())
11222 set_frame_menubar (f
, 0, 0);
11225 /* On a terminal screen, the menu bar is an ordinary screen
11226 line, and this makes it get updated. */
11227 w
->update_mode_line
= 1;
11228 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11229 /* In the non-toolkit version, the menu bar is an ordinary screen
11230 line, and this makes it get updated. */
11231 w
->update_mode_line
= 1;
11232 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11234 unbind_to (count
, Qnil
);
11235 set_buffer_internal_1 (prev
);
11244 /***********************************************************************
11246 ***********************************************************************/
11248 #ifdef HAVE_WINDOW_SYSTEM
11251 Nominal cursor position -- where to draw output.
11252 HPOS and VPOS are window relative glyph matrix coordinates.
11253 X and Y are window relative pixel coordinates. */
11255 struct cursor_pos output_cursor
;
11259 Set the global variable output_cursor to CURSOR. All cursor
11260 positions are relative to updated_window. */
11263 set_output_cursor (struct cursor_pos
*cursor
)
11265 output_cursor
.hpos
= cursor
->hpos
;
11266 output_cursor
.vpos
= cursor
->vpos
;
11267 output_cursor
.x
= cursor
->x
;
11268 output_cursor
.y
= cursor
->y
;
11273 Set a nominal cursor position.
11275 HPOS and VPOS are column/row positions in a window glyph matrix. X
11276 and Y are window text area relative pixel positions.
11278 If this is done during an update, updated_window will contain the
11279 window that is being updated and the position is the future output
11280 cursor position for that window. If updated_window is null, use
11281 selected_window and display the cursor at the given position. */
11284 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11288 /* If updated_window is not set, work on selected_window. */
11289 if (updated_window
)
11290 w
= updated_window
;
11292 w
= XWINDOW (selected_window
);
11294 /* Set the output cursor. */
11295 output_cursor
.hpos
= hpos
;
11296 output_cursor
.vpos
= vpos
;
11297 output_cursor
.x
= x
;
11298 output_cursor
.y
= y
;
11300 /* If not called as part of an update, really display the cursor.
11301 This will also set the cursor position of W. */
11302 if (updated_window
== NULL
)
11305 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11306 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11307 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11312 #endif /* HAVE_WINDOW_SYSTEM */
11315 /***********************************************************************
11317 ***********************************************************************/
11319 #ifdef HAVE_WINDOW_SYSTEM
11321 /* Where the mouse was last time we reported a mouse event. */
11323 FRAME_PTR last_mouse_frame
;
11325 /* Tool-bar item index of the item on which a mouse button was pressed
11328 int last_tool_bar_item
;
11332 update_tool_bar_unwind (Lisp_Object frame
)
11334 selected_frame
= frame
;
11338 /* Update the tool-bar item list for frame F. This has to be done
11339 before we start to fill in any display lines. Called from
11340 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11341 and restore it here. */
11344 update_tool_bar (struct frame
*f
, int save_match_data
)
11346 #if defined (USE_GTK) || defined (HAVE_NS)
11347 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11349 int do_update
= WINDOWP (f
->tool_bar_window
)
11350 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11355 Lisp_Object window
;
11358 window
= FRAME_SELECTED_WINDOW (f
);
11359 w
= XWINDOW (window
);
11361 /* If the user has switched buffers or windows, we need to
11362 recompute to reflect the new bindings. But we'll
11363 recompute when update_mode_lines is set too; that means
11364 that people can use force-mode-line-update to request
11365 that the menu bar be recomputed. The adverse effect on
11366 the rest of the redisplay algorithm is about the same as
11367 windows_or_buffers_changed anyway. */
11368 if (windows_or_buffers_changed
11369 || w
->update_mode_line
11370 || update_mode_lines
11371 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11372 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11373 != w
->last_had_star
)
11374 || ((!NILP (Vtransient_mark_mode
)
11375 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11376 != !NILP (w
->region_showing
)))
11378 struct buffer
*prev
= current_buffer
;
11379 ptrdiff_t count
= SPECPDL_INDEX ();
11380 Lisp_Object frame
, new_tool_bar
;
11381 int new_n_tool_bar
;
11382 struct gcpro gcpro1
;
11384 /* Set current_buffer to the buffer of the selected
11385 window of the frame, so that we get the right local
11387 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11389 /* Save match data, if we must. */
11390 if (save_match_data
)
11391 record_unwind_save_match_data ();
11393 /* Make sure that we don't accidentally use bogus keymaps. */
11394 if (NILP (Voverriding_local_map_menu_flag
))
11396 specbind (Qoverriding_terminal_local_map
, Qnil
);
11397 specbind (Qoverriding_local_map
, Qnil
);
11400 GCPRO1 (new_tool_bar
);
11402 /* We must temporarily set the selected frame to this frame
11403 before calling tool_bar_items, because the calculation of
11404 the tool-bar keymap uses the selected frame (see
11405 `tool-bar-make-keymap' in tool-bar.el). */
11406 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11407 XSETFRAME (frame
, f
);
11408 selected_frame
= frame
;
11410 /* Build desired tool-bar items from keymaps. */
11411 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11414 /* Redisplay the tool-bar if we changed it. */
11415 if (new_n_tool_bar
!= f
->n_tool_bar_items
11416 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11418 /* Redisplay that happens asynchronously due to an expose event
11419 may access f->tool_bar_items. Make sure we update both
11420 variables within BLOCK_INPUT so no such event interrupts. */
11422 f
->tool_bar_items
= new_tool_bar
;
11423 f
->n_tool_bar_items
= new_n_tool_bar
;
11424 w
->update_mode_line
= 1;
11430 unbind_to (count
, Qnil
);
11431 set_buffer_internal_1 (prev
);
11437 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11438 F's desired tool-bar contents. F->tool_bar_items must have
11439 been set up previously by calling prepare_menu_bars. */
11442 build_desired_tool_bar_string (struct frame
*f
)
11444 int i
, size
, size_needed
;
11445 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11446 Lisp_Object image
, plist
, props
;
11448 image
= plist
= props
= Qnil
;
11449 GCPRO3 (image
, plist
, props
);
11451 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11452 Otherwise, make a new string. */
11454 /* The size of the string we might be able to reuse. */
11455 size
= (STRINGP (f
->desired_tool_bar_string
)
11456 ? SCHARS (f
->desired_tool_bar_string
)
11459 /* We need one space in the string for each image. */
11460 size_needed
= f
->n_tool_bar_items
;
11462 /* Reuse f->desired_tool_bar_string, if possible. */
11463 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11464 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11465 make_number (' '));
11468 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11469 Fremove_text_properties (make_number (0), make_number (size
),
11470 props
, f
->desired_tool_bar_string
);
11473 /* Put a `display' property on the string for the images to display,
11474 put a `menu_item' property on tool-bar items with a value that
11475 is the index of the item in F's tool-bar item vector. */
11476 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11478 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11480 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11481 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11482 int hmargin
, vmargin
, relief
, idx
, end
;
11484 /* If image is a vector, choose the image according to the
11486 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11487 if (VECTORP (image
))
11491 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11492 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11495 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11496 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11498 xassert (ASIZE (image
) >= idx
);
11499 image
= AREF (image
, idx
);
11504 /* Ignore invalid image specifications. */
11505 if (!valid_image_p (image
))
11508 /* Display the tool-bar button pressed, or depressed. */
11509 plist
= Fcopy_sequence (XCDR (image
));
11511 /* Compute margin and relief to draw. */
11512 relief
= (tool_bar_button_relief
>= 0
11513 ? tool_bar_button_relief
11514 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11515 hmargin
= vmargin
= relief
;
11517 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11518 INT_MAX
- max (hmargin
, vmargin
)))
11520 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11521 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11523 else if (CONSP (Vtool_bar_button_margin
))
11525 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11526 INT_MAX
- hmargin
))
11527 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11529 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11530 INT_MAX
- vmargin
))
11531 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11534 if (auto_raise_tool_bar_buttons_p
)
11536 /* Add a `:relief' property to the image spec if the item is
11540 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11547 /* If image is selected, display it pressed, i.e. with a
11548 negative relief. If it's not selected, display it with a
11550 plist
= Fplist_put (plist
, QCrelief
,
11552 ? make_number (-relief
)
11553 : make_number (relief
)));
11558 /* Put a margin around the image. */
11559 if (hmargin
|| vmargin
)
11561 if (hmargin
== vmargin
)
11562 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11564 plist
= Fplist_put (plist
, QCmargin
,
11565 Fcons (make_number (hmargin
),
11566 make_number (vmargin
)));
11569 /* If button is not enabled, and we don't have special images
11570 for the disabled state, make the image appear disabled by
11571 applying an appropriate algorithm to it. */
11572 if (!enabled_p
&& idx
< 0)
11573 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11575 /* Put a `display' text property on the string for the image to
11576 display. Put a `menu-item' property on the string that gives
11577 the start of this item's properties in the tool-bar items
11579 image
= Fcons (Qimage
, plist
);
11580 props
= list4 (Qdisplay
, image
,
11581 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11583 /* Let the last image hide all remaining spaces in the tool bar
11584 string. The string can be longer than needed when we reuse a
11585 previous string. */
11586 if (i
+ 1 == f
->n_tool_bar_items
)
11587 end
= SCHARS (f
->desired_tool_bar_string
);
11590 Fadd_text_properties (make_number (i
), make_number (end
),
11591 props
, f
->desired_tool_bar_string
);
11599 /* Display one line of the tool-bar of frame IT->f.
11601 HEIGHT specifies the desired height of the tool-bar line.
11602 If the actual height of the glyph row is less than HEIGHT, the
11603 row's height is increased to HEIGHT, and the icons are centered
11604 vertically in the new height.
11606 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11607 count a final empty row in case the tool-bar width exactly matches
11612 display_tool_bar_line (struct it
*it
, int height
)
11614 struct glyph_row
*row
= it
->glyph_row
;
11615 int max_x
= it
->last_visible_x
;
11616 struct glyph
*last
;
11618 prepare_desired_row (row
);
11619 row
->y
= it
->current_y
;
11621 /* Note that this isn't made use of if the face hasn't a box,
11622 so there's no need to check the face here. */
11623 it
->start_of_box_run_p
= 1;
11625 while (it
->current_x
< max_x
)
11627 int x
, n_glyphs_before
, i
, nglyphs
;
11628 struct it it_before
;
11630 /* Get the next display element. */
11631 if (!get_next_display_element (it
))
11633 /* Don't count empty row if we are counting needed tool-bar lines. */
11634 if (height
< 0 && !it
->hpos
)
11639 /* Produce glyphs. */
11640 n_glyphs_before
= row
->used
[TEXT_AREA
];
11643 PRODUCE_GLYPHS (it
);
11645 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11647 x
= it_before
.current_x
;
11648 while (i
< nglyphs
)
11650 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11652 if (x
+ glyph
->pixel_width
> max_x
)
11654 /* Glyph doesn't fit on line. Backtrack. */
11655 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11657 /* If this is the only glyph on this line, it will never fit on the
11658 tool-bar, so skip it. But ensure there is at least one glyph,
11659 so we don't accidentally disable the tool-bar. */
11660 if (n_glyphs_before
== 0
11661 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11667 x
+= glyph
->pixel_width
;
11671 /* Stop at line end. */
11672 if (ITERATOR_AT_END_OF_LINE_P (it
))
11675 set_iterator_to_next (it
, 1);
11680 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11682 /* Use default face for the border below the tool bar.
11684 FIXME: When auto-resize-tool-bars is grow-only, there is
11685 no additional border below the possibly empty tool-bar lines.
11686 So to make the extra empty lines look "normal", we have to
11687 use the tool-bar face for the border too. */
11688 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11689 it
->face_id
= DEFAULT_FACE_ID
;
11691 extend_face_to_end_of_line (it
);
11692 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11693 last
->right_box_line_p
= 1;
11694 if (last
== row
->glyphs
[TEXT_AREA
])
11695 last
->left_box_line_p
= 1;
11697 /* Make line the desired height and center it vertically. */
11698 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11700 /* Don't add more than one line height. */
11701 height
%= FRAME_LINE_HEIGHT (it
->f
);
11702 it
->max_ascent
+= height
/ 2;
11703 it
->max_descent
+= (height
+ 1) / 2;
11706 compute_line_metrics (it
);
11708 /* If line is empty, make it occupy the rest of the tool-bar. */
11709 if (!row
->displays_text_p
)
11711 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11712 row
->visible_height
= row
->height
;
11713 row
->ascent
= row
->phys_ascent
= 0;
11714 row
->extra_line_spacing
= 0;
11717 row
->full_width_p
= 1;
11718 row
->continued_p
= 0;
11719 row
->truncated_on_left_p
= 0;
11720 row
->truncated_on_right_p
= 0;
11722 it
->current_x
= it
->hpos
= 0;
11723 it
->current_y
+= row
->height
;
11729 /* Max tool-bar height. */
11731 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11732 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11734 /* Value is the number of screen lines needed to make all tool-bar
11735 items of frame F visible. The number of actual rows needed is
11736 returned in *N_ROWS if non-NULL. */
11739 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11741 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11743 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11744 the desired matrix, so use (unused) mode-line row as temporary row to
11745 avoid destroying the first tool-bar row. */
11746 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11748 /* Initialize an iterator for iteration over
11749 F->desired_tool_bar_string in the tool-bar window of frame F. */
11750 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11751 it
.first_visible_x
= 0;
11752 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11753 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11754 it
.paragraph_embedding
= L2R
;
11756 while (!ITERATOR_AT_END_P (&it
))
11758 clear_glyph_row (temp_row
);
11759 it
.glyph_row
= temp_row
;
11760 display_tool_bar_line (&it
, -1);
11762 clear_glyph_row (temp_row
);
11764 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11766 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11768 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11772 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11774 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11775 (Lisp_Object frame
)
11782 frame
= selected_frame
;
11784 CHECK_FRAME (frame
);
11785 f
= XFRAME (frame
);
11787 if (WINDOWP (f
->tool_bar_window
)
11788 && (w
= XWINDOW (f
->tool_bar_window
),
11789 WINDOW_TOTAL_LINES (w
) > 0))
11791 update_tool_bar (f
, 1);
11792 if (f
->n_tool_bar_items
)
11794 build_desired_tool_bar_string (f
);
11795 nlines
= tool_bar_lines_needed (f
, NULL
);
11799 return make_number (nlines
);
11803 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11804 height should be changed. */
11807 redisplay_tool_bar (struct frame
*f
)
11811 struct glyph_row
*row
;
11813 #if defined (USE_GTK) || defined (HAVE_NS)
11814 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11815 update_frame_tool_bar (f
);
11819 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11820 do anything. This means you must start with tool-bar-lines
11821 non-zero to get the auto-sizing effect. Or in other words, you
11822 can turn off tool-bars by specifying tool-bar-lines zero. */
11823 if (!WINDOWP (f
->tool_bar_window
)
11824 || (w
= XWINDOW (f
->tool_bar_window
),
11825 WINDOW_TOTAL_LINES (w
) == 0))
11828 /* Set up an iterator for the tool-bar window. */
11829 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11830 it
.first_visible_x
= 0;
11831 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11832 row
= it
.glyph_row
;
11834 /* Build a string that represents the contents of the tool-bar. */
11835 build_desired_tool_bar_string (f
);
11836 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11837 /* FIXME: This should be controlled by a user option. But it
11838 doesn't make sense to have an R2L tool bar if the menu bar cannot
11839 be drawn also R2L, and making the menu bar R2L is tricky due
11840 toolkit-specific code that implements it. If an R2L tool bar is
11841 ever supported, display_tool_bar_line should also be augmented to
11842 call unproduce_glyphs like display_line and display_string
11844 it
.paragraph_embedding
= L2R
;
11846 if (f
->n_tool_bar_rows
== 0)
11850 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11851 nlines
!= WINDOW_TOTAL_LINES (w
)))
11854 int old_height
= WINDOW_TOTAL_LINES (w
);
11856 XSETFRAME (frame
, f
);
11857 Fmodify_frame_parameters (frame
,
11858 Fcons (Fcons (Qtool_bar_lines
,
11859 make_number (nlines
)),
11861 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11863 clear_glyph_matrix (w
->desired_matrix
);
11864 fonts_changed_p
= 1;
11870 /* Display as many lines as needed to display all tool-bar items. */
11872 if (f
->n_tool_bar_rows
> 0)
11874 int border
, rows
, height
, extra
;
11876 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11877 border
= XINT (Vtool_bar_border
);
11878 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11879 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11880 else if (EQ (Vtool_bar_border
, Qborder_width
))
11881 border
= f
->border_width
;
11887 rows
= f
->n_tool_bar_rows
;
11888 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11889 extra
= it
.last_visible_y
- border
- height
* rows
;
11891 while (it
.current_y
< it
.last_visible_y
)
11894 if (extra
> 0 && rows
-- > 0)
11896 h
= (extra
+ rows
- 1) / rows
;
11899 display_tool_bar_line (&it
, height
+ h
);
11904 while (it
.current_y
< it
.last_visible_y
)
11905 display_tool_bar_line (&it
, 0);
11908 /* It doesn't make much sense to try scrolling in the tool-bar
11909 window, so don't do it. */
11910 w
->desired_matrix
->no_scrolling_p
= 1;
11911 w
->must_be_updated_p
= 1;
11913 if (!NILP (Vauto_resize_tool_bars
))
11915 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11916 int change_height_p
= 0;
11918 /* If we couldn't display everything, change the tool-bar's
11919 height if there is room for more. */
11920 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11921 && it
.current_y
< max_tool_bar_height
)
11922 change_height_p
= 1;
11924 row
= it
.glyph_row
- 1;
11926 /* If there are blank lines at the end, except for a partially
11927 visible blank line at the end that is smaller than
11928 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11929 if (!row
->displays_text_p
11930 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11931 change_height_p
= 1;
11933 /* If row displays tool-bar items, but is partially visible,
11934 change the tool-bar's height. */
11935 if (row
->displays_text_p
11936 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11937 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11938 change_height_p
= 1;
11940 /* Resize windows as needed by changing the `tool-bar-lines'
11941 frame parameter. */
11942 if (change_height_p
)
11945 int old_height
= WINDOW_TOTAL_LINES (w
);
11947 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11949 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11950 && !f
->minimize_tool_bar_window_p
)
11951 ? (nlines
> old_height
)
11952 : (nlines
!= old_height
));
11953 f
->minimize_tool_bar_window_p
= 0;
11955 if (change_height_p
)
11957 XSETFRAME (frame
, f
);
11958 Fmodify_frame_parameters (frame
,
11959 Fcons (Fcons (Qtool_bar_lines
,
11960 make_number (nlines
)),
11962 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11964 clear_glyph_matrix (w
->desired_matrix
);
11965 f
->n_tool_bar_rows
= nrows
;
11966 fonts_changed_p
= 1;
11973 f
->minimize_tool_bar_window_p
= 0;
11978 /* Get information about the tool-bar item which is displayed in GLYPH
11979 on frame F. Return in *PROP_IDX the index where tool-bar item
11980 properties start in F->tool_bar_items. Value is zero if
11981 GLYPH doesn't display a tool-bar item. */
11984 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11990 /* This function can be called asynchronously, which means we must
11991 exclude any possibility that Fget_text_property signals an
11993 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11994 charpos
= max (0, charpos
);
11996 /* Get the text property `menu-item' at pos. The value of that
11997 property is the start index of this item's properties in
11998 F->tool_bar_items. */
11999 prop
= Fget_text_property (make_number (charpos
),
12000 Qmenu_item
, f
->current_tool_bar_string
);
12001 if (INTEGERP (prop
))
12003 *prop_idx
= XINT (prop
);
12013 /* Get information about the tool-bar item at position X/Y on frame F.
12014 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12015 the current matrix of the tool-bar window of F, or NULL if not
12016 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12017 item in F->tool_bar_items. Value is
12019 -1 if X/Y is not on a tool-bar item
12020 0 if X/Y is on the same item that was highlighted before.
12024 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12025 int *hpos
, int *vpos
, int *prop_idx
)
12027 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12028 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12031 /* Find the glyph under X/Y. */
12032 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12033 if (*glyph
== NULL
)
12036 /* Get the start of this tool-bar item's properties in
12037 f->tool_bar_items. */
12038 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12041 /* Is mouse on the highlighted item? */
12042 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12043 && *vpos
>= hlinfo
->mouse_face_beg_row
12044 && *vpos
<= hlinfo
->mouse_face_end_row
12045 && (*vpos
> hlinfo
->mouse_face_beg_row
12046 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12047 && (*vpos
< hlinfo
->mouse_face_end_row
12048 || *hpos
< hlinfo
->mouse_face_end_col
12049 || hlinfo
->mouse_face_past_end
))
12057 Handle mouse button event on the tool-bar of frame F, at
12058 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12059 0 for button release. MODIFIERS is event modifiers for button
12063 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12066 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12067 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12068 int hpos
, vpos
, prop_idx
;
12069 struct glyph
*glyph
;
12070 Lisp_Object enabled_p
;
12072 /* If not on the highlighted tool-bar item, return. */
12073 frame_to_window_pixel_xy (w
, &x
, &y
);
12074 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12077 /* If item is disabled, do nothing. */
12078 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12079 if (NILP (enabled_p
))
12084 /* Show item in pressed state. */
12085 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12086 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12087 last_tool_bar_item
= prop_idx
;
12091 Lisp_Object key
, frame
;
12092 struct input_event event
;
12093 EVENT_INIT (event
);
12095 /* Show item in released state. */
12096 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12097 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12099 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12101 XSETFRAME (frame
, f
);
12102 event
.kind
= TOOL_BAR_EVENT
;
12103 event
.frame_or_window
= frame
;
12105 kbd_buffer_store_event (&event
);
12107 event
.kind
= TOOL_BAR_EVENT
;
12108 event
.frame_or_window
= frame
;
12110 event
.modifiers
= modifiers
;
12111 kbd_buffer_store_event (&event
);
12112 last_tool_bar_item
= -1;
12117 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12118 tool-bar window-relative coordinates X/Y. Called from
12119 note_mouse_highlight. */
12122 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12124 Lisp_Object window
= f
->tool_bar_window
;
12125 struct window
*w
= XWINDOW (window
);
12126 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12127 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12129 struct glyph
*glyph
;
12130 struct glyph_row
*row
;
12132 Lisp_Object enabled_p
;
12134 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12135 int mouse_down_p
, rc
;
12137 /* Function note_mouse_highlight is called with negative X/Y
12138 values when mouse moves outside of the frame. */
12139 if (x
<= 0 || y
<= 0)
12141 clear_mouse_face (hlinfo
);
12145 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12148 /* Not on tool-bar item. */
12149 clear_mouse_face (hlinfo
);
12153 /* On same tool-bar item as before. */
12154 goto set_help_echo
;
12156 clear_mouse_face (hlinfo
);
12158 /* Mouse is down, but on different tool-bar item? */
12159 mouse_down_p
= (dpyinfo
->grabbed
12160 && f
== last_mouse_frame
12161 && FRAME_LIVE_P (f
));
12163 && last_tool_bar_item
!= prop_idx
)
12166 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12167 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12169 /* If tool-bar item is not enabled, don't highlight it. */
12170 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12171 if (!NILP (enabled_p
))
12173 /* Compute the x-position of the glyph. In front and past the
12174 image is a space. We include this in the highlighted area. */
12175 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12176 for (i
= x
= 0; i
< hpos
; ++i
)
12177 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12179 /* Record this as the current active region. */
12180 hlinfo
->mouse_face_beg_col
= hpos
;
12181 hlinfo
->mouse_face_beg_row
= vpos
;
12182 hlinfo
->mouse_face_beg_x
= x
;
12183 hlinfo
->mouse_face_beg_y
= row
->y
;
12184 hlinfo
->mouse_face_past_end
= 0;
12186 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12187 hlinfo
->mouse_face_end_row
= vpos
;
12188 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12189 hlinfo
->mouse_face_end_y
= row
->y
;
12190 hlinfo
->mouse_face_window
= window
;
12191 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12193 /* Display it as active. */
12194 show_mouse_face (hlinfo
, draw
);
12195 hlinfo
->mouse_face_image_state
= draw
;
12200 /* Set help_echo_string to a help string to display for this tool-bar item.
12201 XTread_socket does the rest. */
12202 help_echo_object
= help_echo_window
= Qnil
;
12203 help_echo_pos
= -1;
12204 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12205 if (NILP (help_echo_string
))
12206 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12209 #endif /* HAVE_WINDOW_SYSTEM */
12213 /************************************************************************
12214 Horizontal scrolling
12215 ************************************************************************/
12217 static int hscroll_window_tree (Lisp_Object
);
12218 static int hscroll_windows (Lisp_Object
);
12220 /* For all leaf windows in the window tree rooted at WINDOW, set their
12221 hscroll value so that PT is (i) visible in the window, and (ii) so
12222 that it is not within a certain margin at the window's left and
12223 right border. Value is non-zero if any window's hscroll has been
12227 hscroll_window_tree (Lisp_Object window
)
12229 int hscrolled_p
= 0;
12230 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12231 int hscroll_step_abs
= 0;
12232 double hscroll_step_rel
= 0;
12234 if (hscroll_relative_p
)
12236 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12237 if (hscroll_step_rel
< 0)
12239 hscroll_relative_p
= 0;
12240 hscroll_step_abs
= 0;
12243 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12245 hscroll_step_abs
= XINT (Vhscroll_step
);
12246 if (hscroll_step_abs
< 0)
12247 hscroll_step_abs
= 0;
12250 hscroll_step_abs
= 0;
12252 while (WINDOWP (window
))
12254 struct window
*w
= XWINDOW (window
);
12256 if (WINDOWP (w
->hchild
))
12257 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12258 else if (WINDOWP (w
->vchild
))
12259 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12260 else if (w
->cursor
.vpos
>= 0)
12263 int text_area_width
;
12264 struct glyph_row
*current_cursor_row
12265 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12266 struct glyph_row
*desired_cursor_row
12267 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12268 struct glyph_row
*cursor_row
12269 = (desired_cursor_row
->enabled_p
12270 ? desired_cursor_row
12271 : current_cursor_row
);
12272 int row_r2l_p
= cursor_row
->reversed_p
;
12274 text_area_width
= window_box_width (w
, TEXT_AREA
);
12276 /* Scroll when cursor is inside this scroll margin. */
12277 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12279 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12280 /* For left-to-right rows, hscroll when cursor is either
12281 (i) inside the right hscroll margin, or (ii) if it is
12282 inside the left margin and the window is already
12285 && ((XFASTINT (w
->hscroll
)
12286 && w
->cursor
.x
<= h_margin
)
12287 || (cursor_row
->enabled_p
12288 && cursor_row
->truncated_on_right_p
12289 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12290 /* For right-to-left rows, the logic is similar,
12291 except that rules for scrolling to left and right
12292 are reversed. E.g., if cursor.x <= h_margin, we
12293 need to hscroll "to the right" unconditionally,
12294 and that will scroll the screen to the left so as
12295 to reveal the next portion of the row. */
12297 && ((cursor_row
->enabled_p
12298 /* FIXME: It is confusing to set the
12299 truncated_on_right_p flag when R2L rows
12300 are actually truncated on the left. */
12301 && cursor_row
->truncated_on_right_p
12302 && w
->cursor
.x
<= h_margin
)
12303 || (XFASTINT (w
->hscroll
)
12304 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12308 struct buffer
*saved_current_buffer
;
12312 /* Find point in a display of infinite width. */
12313 saved_current_buffer
= current_buffer
;
12314 current_buffer
= XBUFFER (w
->buffer
);
12316 if (w
== XWINDOW (selected_window
))
12320 pt
= marker_position (w
->pointm
);
12321 pt
= max (BEGV
, pt
);
12325 /* Move iterator to pt starting at cursor_row->start in
12326 a line with infinite width. */
12327 init_to_row_start (&it
, w
, cursor_row
);
12328 it
.last_visible_x
= INFINITY
;
12329 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12330 current_buffer
= saved_current_buffer
;
12332 /* Position cursor in window. */
12333 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12334 hscroll
= max (0, (it
.current_x
12335 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12336 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12337 : (text_area_width
/ 2))))
12338 / FRAME_COLUMN_WIDTH (it
.f
);
12339 else if ((!row_r2l_p
12340 && w
->cursor
.x
>= text_area_width
- h_margin
)
12341 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12343 if (hscroll_relative_p
)
12344 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12347 wanted_x
= text_area_width
12348 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12351 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12355 if (hscroll_relative_p
)
12356 wanted_x
= text_area_width
* hscroll_step_rel
12359 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12362 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12364 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12366 /* Don't prevent redisplay optimizations if hscroll
12367 hasn't changed, as it will unnecessarily slow down
12369 if (XFASTINT (w
->hscroll
) != hscroll
)
12371 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12372 w
->hscroll
= make_number (hscroll
);
12381 /* Value is non-zero if hscroll of any leaf window has been changed. */
12382 return hscrolled_p
;
12386 /* Set hscroll so that cursor is visible and not inside horizontal
12387 scroll margins for all windows in the tree rooted at WINDOW. See
12388 also hscroll_window_tree above. Value is non-zero if any window's
12389 hscroll has been changed. If it has, desired matrices on the frame
12390 of WINDOW are cleared. */
12393 hscroll_windows (Lisp_Object window
)
12395 int hscrolled_p
= hscroll_window_tree (window
);
12397 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12398 return hscrolled_p
;
12403 /************************************************************************
12405 ************************************************************************/
12407 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12408 to a non-zero value. This is sometimes handy to have in a debugger
12413 /* First and last unchanged row for try_window_id. */
12415 static int debug_first_unchanged_at_end_vpos
;
12416 static int debug_last_unchanged_at_beg_vpos
;
12418 /* Delta vpos and y. */
12420 static int debug_dvpos
, debug_dy
;
12422 /* Delta in characters and bytes for try_window_id. */
12424 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12426 /* Values of window_end_pos and window_end_vpos at the end of
12429 static ptrdiff_t debug_end_vpos
;
12431 /* Append a string to W->desired_matrix->method. FMT is a printf
12432 format string. If trace_redisplay_p is non-zero also printf the
12433 resulting string to stderr. */
12435 static void debug_method_add (struct window
*, char const *, ...)
12436 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12439 debug_method_add (struct window
*w
, char const *fmt
, ...)
12442 char *method
= w
->desired_matrix
->method
;
12443 int len
= strlen (method
);
12444 int size
= sizeof w
->desired_matrix
->method
;
12445 int remaining
= size
- len
- 1;
12448 va_start (ap
, fmt
);
12449 vsprintf (buffer
, fmt
, ap
);
12451 if (len
&& remaining
)
12454 --remaining
, ++len
;
12457 strncpy (method
+ len
, buffer
, remaining
);
12459 if (trace_redisplay_p
)
12460 fprintf (stderr
, "%p (%s): %s\n",
12462 ((BUFFERP (w
->buffer
)
12463 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12464 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12469 #endif /* GLYPH_DEBUG */
12472 /* Value is non-zero if all changes in window W, which displays
12473 current_buffer, are in the text between START and END. START is a
12474 buffer position, END is given as a distance from Z. Used in
12475 redisplay_internal for display optimization. */
12478 text_outside_line_unchanged_p (struct window
*w
,
12479 ptrdiff_t start
, ptrdiff_t end
)
12481 int unchanged_p
= 1;
12483 /* If text or overlays have changed, see where. */
12484 if (XFASTINT (w
->last_modified
) < MODIFF
12485 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12487 /* Gap in the line? */
12488 if (GPT
< start
|| Z
- GPT
< end
)
12491 /* Changes start in front of the line, or end after it? */
12493 && (BEG_UNCHANGED
< start
- 1
12494 || END_UNCHANGED
< end
))
12497 /* If selective display, can't optimize if changes start at the
12498 beginning of the line. */
12500 && INTEGERP (BVAR (current_buffer
, selective_display
))
12501 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12502 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12505 /* If there are overlays at the start or end of the line, these
12506 may have overlay strings with newlines in them. A change at
12507 START, for instance, may actually concern the display of such
12508 overlay strings as well, and they are displayed on different
12509 lines. So, quickly rule out this case. (For the future, it
12510 might be desirable to implement something more telling than
12511 just BEG/END_UNCHANGED.) */
12514 if (BEG
+ BEG_UNCHANGED
== start
12515 && overlay_touches_p (start
))
12517 if (END_UNCHANGED
== end
12518 && overlay_touches_p (Z
- end
))
12522 /* Under bidi reordering, adding or deleting a character in the
12523 beginning of a paragraph, before the first strong directional
12524 character, can change the base direction of the paragraph (unless
12525 the buffer specifies a fixed paragraph direction), which will
12526 require to redisplay the whole paragraph. It might be worthwhile
12527 to find the paragraph limits and widen the range of redisplayed
12528 lines to that, but for now just give up this optimization. */
12529 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12530 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12534 return unchanged_p
;
12538 /* Do a frame update, taking possible shortcuts into account. This is
12539 the main external entry point for redisplay.
12541 If the last redisplay displayed an echo area message and that message
12542 is no longer requested, we clear the echo area or bring back the
12543 mini-buffer if that is in use. */
12548 redisplay_internal ();
12553 overlay_arrow_string_or_property (Lisp_Object var
)
12557 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12560 return Voverlay_arrow_string
;
12563 /* Return 1 if there are any overlay-arrows in current_buffer. */
12565 overlay_arrow_in_current_buffer_p (void)
12569 for (vlist
= Voverlay_arrow_variable_list
;
12571 vlist
= XCDR (vlist
))
12573 Lisp_Object var
= XCAR (vlist
);
12576 if (!SYMBOLP (var
))
12578 val
= find_symbol_value (var
);
12580 && current_buffer
== XMARKER (val
)->buffer
)
12587 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12591 overlay_arrows_changed_p (void)
12595 for (vlist
= Voverlay_arrow_variable_list
;
12597 vlist
= XCDR (vlist
))
12599 Lisp_Object var
= XCAR (vlist
);
12600 Lisp_Object val
, pstr
;
12602 if (!SYMBOLP (var
))
12604 val
= find_symbol_value (var
);
12605 if (!MARKERP (val
))
12607 if (! EQ (COERCE_MARKER (val
),
12608 Fget (var
, Qlast_arrow_position
))
12609 || ! (pstr
= overlay_arrow_string_or_property (var
),
12610 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12616 /* Mark overlay arrows to be updated on next redisplay. */
12619 update_overlay_arrows (int up_to_date
)
12623 for (vlist
= Voverlay_arrow_variable_list
;
12625 vlist
= XCDR (vlist
))
12627 Lisp_Object var
= XCAR (vlist
);
12629 if (!SYMBOLP (var
))
12632 if (up_to_date
> 0)
12634 Lisp_Object val
= find_symbol_value (var
);
12635 Fput (var
, Qlast_arrow_position
,
12636 COERCE_MARKER (val
));
12637 Fput (var
, Qlast_arrow_string
,
12638 overlay_arrow_string_or_property (var
));
12640 else if (up_to_date
< 0
12641 || !NILP (Fget (var
, Qlast_arrow_position
)))
12643 Fput (var
, Qlast_arrow_position
, Qt
);
12644 Fput (var
, Qlast_arrow_string
, Qt
);
12650 /* Return overlay arrow string to display at row.
12651 Return integer (bitmap number) for arrow bitmap in left fringe.
12652 Return nil if no overlay arrow. */
12655 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12659 for (vlist
= Voverlay_arrow_variable_list
;
12661 vlist
= XCDR (vlist
))
12663 Lisp_Object var
= XCAR (vlist
);
12666 if (!SYMBOLP (var
))
12669 val
= find_symbol_value (var
);
12672 && current_buffer
== XMARKER (val
)->buffer
12673 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12675 if (FRAME_WINDOW_P (it
->f
)
12676 /* FIXME: if ROW->reversed_p is set, this should test
12677 the right fringe, not the left one. */
12678 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12680 #ifdef HAVE_WINDOW_SYSTEM
12681 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12684 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12685 return make_number (fringe_bitmap
);
12688 return make_number (-1); /* Use default arrow bitmap */
12690 return overlay_arrow_string_or_property (var
);
12697 /* Return 1 if point moved out of or into a composition. Otherwise
12698 return 0. PREV_BUF and PREV_PT are the last point buffer and
12699 position. BUF and PT are the current point buffer and position. */
12702 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12703 struct buffer
*buf
, ptrdiff_t pt
)
12705 ptrdiff_t start
, end
;
12707 Lisp_Object buffer
;
12709 XSETBUFFER (buffer
, buf
);
12710 /* Check a composition at the last point if point moved within the
12712 if (prev_buf
== buf
)
12715 /* Point didn't move. */
12718 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12719 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12720 && COMPOSITION_VALID_P (start
, end
, prop
)
12721 && start
< prev_pt
&& end
> prev_pt
)
12722 /* The last point was within the composition. Return 1 iff
12723 point moved out of the composition. */
12724 return (pt
<= start
|| pt
>= end
);
12727 /* Check a composition at the current point. */
12728 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12729 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12730 && COMPOSITION_VALID_P (start
, end
, prop
)
12731 && start
< pt
&& end
> pt
);
12735 /* Reconsider the setting of B->clip_changed which is displayed
12739 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12741 if (b
->clip_changed
12742 && !NILP (w
->window_end_valid
)
12743 && w
->current_matrix
->buffer
== b
12744 && w
->current_matrix
->zv
== BUF_ZV (b
)
12745 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12746 b
->clip_changed
= 0;
12748 /* If display wasn't paused, and W is not a tool bar window, see if
12749 point has been moved into or out of a composition. In that case,
12750 we set b->clip_changed to 1 to force updating the screen. If
12751 b->clip_changed has already been set to 1, we can skip this
12753 if (!b
->clip_changed
12754 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12758 if (w
== XWINDOW (selected_window
))
12761 pt
= marker_position (w
->pointm
);
12763 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12764 || pt
!= XINT (w
->last_point
))
12765 && check_point_in_composition (w
->current_matrix
->buffer
,
12766 XINT (w
->last_point
),
12767 XBUFFER (w
->buffer
), pt
))
12768 b
->clip_changed
= 1;
12773 /* Select FRAME to forward the values of frame-local variables into C
12774 variables so that the redisplay routines can access those values
12778 select_frame_for_redisplay (Lisp_Object frame
)
12780 Lisp_Object tail
, tem
;
12781 Lisp_Object old
= selected_frame
;
12782 struct Lisp_Symbol
*sym
;
12784 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12786 selected_frame
= frame
;
12789 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12790 if (CONSP (XCAR (tail
))
12791 && (tem
= XCAR (XCAR (tail
)),
12793 && (sym
= indirect_variable (XSYMBOL (tem
)),
12794 sym
->redirect
== SYMBOL_LOCALIZED
)
12795 && sym
->val
.blv
->frame_local
)
12796 /* Use find_symbol_value rather than Fsymbol_value
12797 to avoid an error if it is void. */
12798 find_symbol_value (tem
);
12799 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12803 #define STOP_POLLING \
12804 do { if (! polling_stopped_here) stop_polling (); \
12805 polling_stopped_here = 1; } while (0)
12807 #define RESUME_POLLING \
12808 do { if (polling_stopped_here) start_polling (); \
12809 polling_stopped_here = 0; } while (0)
12812 /* Perhaps in the future avoid recentering windows if it
12813 is not necessary; currently that causes some problems. */
12816 redisplay_internal (void)
12818 struct window
*w
= XWINDOW (selected_window
);
12822 int must_finish
= 0;
12823 struct text_pos tlbufpos
, tlendpos
;
12824 int number_of_visible_frames
;
12825 ptrdiff_t count
, count1
;
12827 int polling_stopped_here
= 0;
12828 Lisp_Object old_frame
= selected_frame
;
12830 /* Non-zero means redisplay has to consider all windows on all
12831 frames. Zero means, only selected_window is considered. */
12832 int consider_all_windows_p
;
12834 /* Non-zero means redisplay has to redisplay the miniwindow */
12835 int update_miniwindow_p
= 0;
12837 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12839 /* No redisplay if running in batch mode or frame is not yet fully
12840 initialized, or redisplay is explicitly turned off by setting
12841 Vinhibit_redisplay. */
12842 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12843 || !NILP (Vinhibit_redisplay
))
12846 /* Don't examine these until after testing Vinhibit_redisplay.
12847 When Emacs is shutting down, perhaps because its connection to
12848 X has dropped, we should not look at them at all. */
12849 fr
= XFRAME (w
->frame
);
12850 sf
= SELECTED_FRAME ();
12852 if (!fr
->glyphs_initialized_p
)
12855 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12856 if (popup_activated ())
12860 /* I don't think this happens but let's be paranoid. */
12861 if (redisplaying_p
)
12864 /* Record a function that resets redisplaying_p to its old value
12865 when we leave this function. */
12866 count
= SPECPDL_INDEX ();
12867 record_unwind_protect (unwind_redisplay
,
12868 Fcons (make_number (redisplaying_p
), selected_frame
));
12870 specbind (Qinhibit_free_realized_faces
, Qnil
);
12873 Lisp_Object tail
, frame
;
12875 FOR_EACH_FRAME (tail
, frame
)
12877 struct frame
*f
= XFRAME (frame
);
12878 f
->already_hscrolled_p
= 0;
12883 /* Remember the currently selected window. */
12886 if (!EQ (old_frame
, selected_frame
)
12887 && FRAME_LIVE_P (XFRAME (old_frame
)))
12888 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12889 selected_frame and selected_window to be temporarily out-of-sync so
12890 when we come back here via `goto retry', we need to resync because we
12891 may need to run Elisp code (via prepare_menu_bars). */
12892 select_frame_for_redisplay (old_frame
);
12895 reconsider_clip_changes (w
, current_buffer
);
12896 last_escape_glyph_frame
= NULL
;
12897 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12898 last_glyphless_glyph_frame
= NULL
;
12899 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12901 /* If new fonts have been loaded that make a glyph matrix adjustment
12902 necessary, do it. */
12903 if (fonts_changed_p
)
12905 adjust_glyphs (NULL
);
12906 ++windows_or_buffers_changed
;
12907 fonts_changed_p
= 0;
12910 /* If face_change_count is non-zero, init_iterator will free all
12911 realized faces, which includes the faces referenced from current
12912 matrices. So, we can't reuse current matrices in this case. */
12913 if (face_change_count
)
12914 ++windows_or_buffers_changed
;
12916 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12917 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12919 /* Since frames on a single ASCII terminal share the same
12920 display area, displaying a different frame means redisplay
12921 the whole thing. */
12922 windows_or_buffers_changed
++;
12923 SET_FRAME_GARBAGED (sf
);
12925 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12927 FRAME_TTY (sf
)->previous_frame
= sf
;
12930 /* Set the visible flags for all frames. Do this before checking
12931 for resized or garbaged frames; they want to know if their frames
12932 are visible. See the comment in frame.h for
12933 FRAME_SAMPLE_VISIBILITY. */
12935 Lisp_Object tail
, frame
;
12937 number_of_visible_frames
= 0;
12939 FOR_EACH_FRAME (tail
, frame
)
12941 struct frame
*f
= XFRAME (frame
);
12943 FRAME_SAMPLE_VISIBILITY (f
);
12944 if (FRAME_VISIBLE_P (f
))
12945 ++number_of_visible_frames
;
12946 clear_desired_matrices (f
);
12950 /* Notice any pending interrupt request to change frame size. */
12951 do_pending_window_change (1);
12953 /* do_pending_window_change could change the selected_window due to
12954 frame resizing which makes the selected window too small. */
12955 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12958 reconsider_clip_changes (w
, current_buffer
);
12961 /* Clear frames marked as garbaged. */
12962 if (frame_garbaged
)
12963 clear_garbaged_frames ();
12965 /* Build menubar and tool-bar items. */
12966 if (NILP (Vmemory_full
))
12967 prepare_menu_bars ();
12969 if (windows_or_buffers_changed
)
12970 update_mode_lines
++;
12972 /* Detect case that we need to write or remove a star in the mode line. */
12973 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
12975 w
->update_mode_line
= 1;
12976 if (buffer_shared
> 1)
12977 update_mode_lines
++;
12980 /* Avoid invocation of point motion hooks by `current_column' below. */
12981 count1
= SPECPDL_INDEX ();
12982 specbind (Qinhibit_point_motion_hooks
, Qt
);
12984 /* If %c is in the mode line, update it if needed. */
12985 if (!NILP (w
->column_number_displayed
)
12986 /* This alternative quickly identifies a common case
12987 where no change is needed. */
12988 && !(PT
== XFASTINT (w
->last_point
)
12989 && XFASTINT (w
->last_modified
) >= MODIFF
12990 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12991 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12992 w
->update_mode_line
= 1;
12994 unbind_to (count1
, Qnil
);
12996 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12998 /* The variable buffer_shared is set in redisplay_window and
12999 indicates that we redisplay a buffer in different windows. See
13001 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13002 || cursor_type_changed
);
13004 /* If specs for an arrow have changed, do thorough redisplay
13005 to ensure we remove any arrow that should no longer exist. */
13006 if (overlay_arrows_changed_p ())
13007 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13009 /* Normally the message* functions will have already displayed and
13010 updated the echo area, but the frame may have been trashed, or
13011 the update may have been preempted, so display the echo area
13012 again here. Checking message_cleared_p captures the case that
13013 the echo area should be cleared. */
13014 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13015 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13016 || (message_cleared_p
13017 && minibuf_level
== 0
13018 /* If the mini-window is currently selected, this means the
13019 echo-area doesn't show through. */
13020 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13022 int window_height_changed_p
= echo_area_display (0);
13024 if (message_cleared_p
)
13025 update_miniwindow_p
= 1;
13029 /* If we don't display the current message, don't clear the
13030 message_cleared_p flag, because, if we did, we wouldn't clear
13031 the echo area in the next redisplay which doesn't preserve
13033 if (!display_last_displayed_message_p
)
13034 message_cleared_p
= 0;
13036 if (fonts_changed_p
)
13038 else if (window_height_changed_p
)
13040 consider_all_windows_p
= 1;
13041 ++update_mode_lines
;
13042 ++windows_or_buffers_changed
;
13044 /* If window configuration was changed, frames may have been
13045 marked garbaged. Clear them or we will experience
13046 surprises wrt scrolling. */
13047 if (frame_garbaged
)
13048 clear_garbaged_frames ();
13051 else if (EQ (selected_window
, minibuf_window
)
13052 && (current_buffer
->clip_changed
13053 || XFASTINT (w
->last_modified
) < MODIFF
13054 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
13055 && resize_mini_window (w
, 0))
13057 /* Resized active mini-window to fit the size of what it is
13058 showing if its contents might have changed. */
13060 /* FIXME: this causes all frames to be updated, which seems unnecessary
13061 since only the current frame needs to be considered. This function needs
13062 to be rewritten with two variables, consider_all_windows and
13063 consider_all_frames. */
13064 consider_all_windows_p
= 1;
13065 ++windows_or_buffers_changed
;
13066 ++update_mode_lines
;
13068 /* If window configuration was changed, frames may have been
13069 marked garbaged. Clear them or we will experience
13070 surprises wrt scrolling. */
13071 if (frame_garbaged
)
13072 clear_garbaged_frames ();
13076 /* If showing the region, and mark has changed, we must redisplay
13077 the whole window. The assignment to this_line_start_pos prevents
13078 the optimization directly below this if-statement. */
13079 if (((!NILP (Vtransient_mark_mode
)
13080 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13081 != !NILP (w
->region_showing
))
13082 || (!NILP (w
->region_showing
)
13083 && !EQ (w
->region_showing
,
13084 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13085 CHARPOS (this_line_start_pos
) = 0;
13087 /* Optimize the case that only the line containing the cursor in the
13088 selected window has changed. Variables starting with this_ are
13089 set in display_line and record information about the line
13090 containing the cursor. */
13091 tlbufpos
= this_line_start_pos
;
13092 tlendpos
= this_line_end_pos
;
13093 if (!consider_all_windows_p
13094 && CHARPOS (tlbufpos
) > 0
13095 && !w
->update_mode_line
13096 && !current_buffer
->clip_changed
13097 && !current_buffer
->prevent_redisplay_optimizations_p
13098 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13099 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13100 /* Make sure recorded data applies to current buffer, etc. */
13101 && this_line_buffer
== current_buffer
13102 && current_buffer
== XBUFFER (w
->buffer
)
13104 && !w
->optional_new_start
13105 /* Point must be on the line that we have info recorded about. */
13106 && PT
>= CHARPOS (tlbufpos
)
13107 && PT
<= Z
- CHARPOS (tlendpos
)
13108 /* All text outside that line, including its final newline,
13109 must be unchanged. */
13110 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13111 CHARPOS (tlendpos
)))
13113 if (CHARPOS (tlbufpos
) > BEGV
13114 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13115 && (CHARPOS (tlbufpos
) == ZV
13116 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13117 /* Former continuation line has disappeared by becoming empty. */
13119 else if (XFASTINT (w
->last_modified
) < MODIFF
13120 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
13121 || MINI_WINDOW_P (w
))
13123 /* We have to handle the case of continuation around a
13124 wide-column character (see the comment in indent.c around
13127 For instance, in the following case:
13129 -------- Insert --------
13130 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13131 J_I_ ==> J_I_ `^^' are cursors.
13135 As we have to redraw the line above, we cannot use this
13139 int line_height_before
= this_line_pixel_height
;
13141 /* Note that start_display will handle the case that the
13142 line starting at tlbufpos is a continuation line. */
13143 start_display (&it
, w
, tlbufpos
);
13145 /* Implementation note: It this still necessary? */
13146 if (it
.current_x
!= this_line_start_x
)
13149 TRACE ((stderr
, "trying display optimization 1\n"));
13150 w
->cursor
.vpos
= -1;
13151 overlay_arrow_seen
= 0;
13152 it
.vpos
= this_line_vpos
;
13153 it
.current_y
= this_line_y
;
13154 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13155 display_line (&it
);
13157 /* If line contains point, is not continued,
13158 and ends at same distance from eob as before, we win. */
13159 if (w
->cursor
.vpos
>= 0
13160 /* Line is not continued, otherwise this_line_start_pos
13161 would have been set to 0 in display_line. */
13162 && CHARPOS (this_line_start_pos
)
13163 /* Line ends as before. */
13164 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13165 /* Line has same height as before. Otherwise other lines
13166 would have to be shifted up or down. */
13167 && this_line_pixel_height
== line_height_before
)
13169 /* If this is not the window's last line, we must adjust
13170 the charstarts of the lines below. */
13171 if (it
.current_y
< it
.last_visible_y
)
13173 struct glyph_row
*row
13174 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13175 ptrdiff_t delta
, delta_bytes
;
13177 /* We used to distinguish between two cases here,
13178 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13179 when the line ends in a newline or the end of the
13180 buffer's accessible portion. But both cases did
13181 the same, so they were collapsed. */
13183 - CHARPOS (tlendpos
)
13184 - MATRIX_ROW_START_CHARPOS (row
));
13185 delta_bytes
= (Z_BYTE
13186 - BYTEPOS (tlendpos
)
13187 - MATRIX_ROW_START_BYTEPOS (row
));
13189 increment_matrix_positions (w
->current_matrix
,
13190 this_line_vpos
+ 1,
13191 w
->current_matrix
->nrows
,
13192 delta
, delta_bytes
);
13195 /* If this row displays text now but previously didn't,
13196 or vice versa, w->window_end_vpos may have to be
13198 if ((it
.glyph_row
- 1)->displays_text_p
)
13200 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13201 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13203 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13204 && this_line_vpos
> 0)
13205 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13206 w
->window_end_valid
= Qnil
;
13208 /* Update hint: No need to try to scroll in update_window. */
13209 w
->desired_matrix
->no_scrolling_p
= 1;
13212 *w
->desired_matrix
->method
= 0;
13213 debug_method_add (w
, "optimization 1");
13215 #ifdef HAVE_WINDOW_SYSTEM
13216 update_window_fringes (w
, 0);
13223 else if (/* Cursor position hasn't changed. */
13224 PT
== XFASTINT (w
->last_point
)
13225 /* Make sure the cursor was last displayed
13226 in this window. Otherwise we have to reposition it. */
13227 && 0 <= w
->cursor
.vpos
13228 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13232 do_pending_window_change (1);
13233 /* If selected_window changed, redisplay again. */
13234 if (WINDOWP (selected_window
)
13235 && (w
= XWINDOW (selected_window
)) != sw
)
13238 /* We used to always goto end_of_redisplay here, but this
13239 isn't enough if we have a blinking cursor. */
13240 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13241 goto end_of_redisplay
;
13245 /* If highlighting the region, or if the cursor is in the echo area,
13246 then we can't just move the cursor. */
13247 else if (! (!NILP (Vtransient_mark_mode
)
13248 && !NILP (BVAR (current_buffer
, mark_active
)))
13249 && (EQ (selected_window
,
13250 BVAR (current_buffer
, last_selected_window
))
13251 || highlight_nonselected_windows
)
13252 && NILP (w
->region_showing
)
13253 && NILP (Vshow_trailing_whitespace
)
13254 && !cursor_in_echo_area
)
13257 struct glyph_row
*row
;
13259 /* Skip from tlbufpos to PT and see where it is. Note that
13260 PT may be in invisible text. If so, we will end at the
13261 next visible position. */
13262 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13263 NULL
, DEFAULT_FACE_ID
);
13264 it
.current_x
= this_line_start_x
;
13265 it
.current_y
= this_line_y
;
13266 it
.vpos
= this_line_vpos
;
13268 /* The call to move_it_to stops in front of PT, but
13269 moves over before-strings. */
13270 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13272 if (it
.vpos
== this_line_vpos
13273 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13276 xassert (this_line_vpos
== it
.vpos
);
13277 xassert (this_line_y
== it
.current_y
);
13278 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13280 *w
->desired_matrix
->method
= 0;
13281 debug_method_add (w
, "optimization 3");
13290 /* Text changed drastically or point moved off of line. */
13291 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13294 CHARPOS (this_line_start_pos
) = 0;
13295 consider_all_windows_p
|= buffer_shared
> 1;
13296 ++clear_face_cache_count
;
13297 #ifdef HAVE_WINDOW_SYSTEM
13298 ++clear_image_cache_count
;
13301 /* Build desired matrices, and update the display. If
13302 consider_all_windows_p is non-zero, do it for all windows on all
13303 frames. Otherwise do it for selected_window, only. */
13305 if (consider_all_windows_p
)
13307 Lisp_Object tail
, frame
;
13309 FOR_EACH_FRAME (tail
, frame
)
13310 XFRAME (frame
)->updated_p
= 0;
13312 /* Recompute # windows showing selected buffer. This will be
13313 incremented each time such a window is displayed. */
13316 FOR_EACH_FRAME (tail
, frame
)
13318 struct frame
*f
= XFRAME (frame
);
13320 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13322 if (! EQ (frame
, selected_frame
))
13323 /* Select the frame, for the sake of frame-local
13325 select_frame_for_redisplay (frame
);
13327 /* Mark all the scroll bars to be removed; we'll redeem
13328 the ones we want when we redisplay their windows. */
13329 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13330 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13332 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13333 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13335 /* The X error handler may have deleted that frame. */
13336 if (!FRAME_LIVE_P (f
))
13339 /* Any scroll bars which redisplay_windows should have
13340 nuked should now go away. */
13341 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13342 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13344 /* If fonts changed, display again. */
13345 /* ??? rms: I suspect it is a mistake to jump all the way
13346 back to retry here. It should just retry this frame. */
13347 if (fonts_changed_p
)
13350 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13352 /* See if we have to hscroll. */
13353 if (!f
->already_hscrolled_p
)
13355 f
->already_hscrolled_p
= 1;
13356 if (hscroll_windows (f
->root_window
))
13360 /* Prevent various kinds of signals during display
13361 update. stdio is not robust about handling
13362 signals, which can cause an apparent I/O
13364 if (interrupt_input
)
13365 unrequest_sigio ();
13368 /* Update the display. */
13369 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13370 pending
|= update_frame (f
, 0, 0);
13376 if (!EQ (old_frame
, selected_frame
)
13377 && FRAME_LIVE_P (XFRAME (old_frame
)))
13378 /* We played a bit fast-and-loose above and allowed selected_frame
13379 and selected_window to be temporarily out-of-sync but let's make
13380 sure this stays contained. */
13381 select_frame_for_redisplay (old_frame
);
13382 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13386 /* Do the mark_window_display_accurate after all windows have
13387 been redisplayed because this call resets flags in buffers
13388 which are needed for proper redisplay. */
13389 FOR_EACH_FRAME (tail
, frame
)
13391 struct frame
*f
= XFRAME (frame
);
13394 mark_window_display_accurate (f
->root_window
, 1);
13395 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13396 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13401 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13403 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13404 struct frame
*mini_frame
;
13406 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13407 /* Use list_of_error, not Qerror, so that
13408 we catch only errors and don't run the debugger. */
13409 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13411 redisplay_window_error
);
13412 if (update_miniwindow_p
)
13413 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13415 redisplay_window_error
);
13417 /* Compare desired and current matrices, perform output. */
13420 /* If fonts changed, display again. */
13421 if (fonts_changed_p
)
13424 /* Prevent various kinds of signals during display update.
13425 stdio is not robust about handling signals,
13426 which can cause an apparent I/O error. */
13427 if (interrupt_input
)
13428 unrequest_sigio ();
13431 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13433 if (hscroll_windows (selected_window
))
13436 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13437 pending
= update_frame (sf
, 0, 0);
13440 /* We may have called echo_area_display at the top of this
13441 function. If the echo area is on another frame, that may
13442 have put text on a frame other than the selected one, so the
13443 above call to update_frame would not have caught it. Catch
13445 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13446 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13448 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13450 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13451 pending
|= update_frame (mini_frame
, 0, 0);
13452 if (!pending
&& hscroll_windows (mini_window
))
13457 /* If display was paused because of pending input, make sure we do a
13458 thorough update the next time. */
13461 /* Prevent the optimization at the beginning of
13462 redisplay_internal that tries a single-line update of the
13463 line containing the cursor in the selected window. */
13464 CHARPOS (this_line_start_pos
) = 0;
13466 /* Let the overlay arrow be updated the next time. */
13467 update_overlay_arrows (0);
13469 /* If we pause after scrolling, some rows in the current
13470 matrices of some windows are not valid. */
13471 if (!WINDOW_FULL_WIDTH_P (w
)
13472 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13473 update_mode_lines
= 1;
13477 if (!consider_all_windows_p
)
13479 /* This has already been done above if
13480 consider_all_windows_p is set. */
13481 mark_window_display_accurate_1 (w
, 1);
13483 /* Say overlay arrows are up to date. */
13484 update_overlay_arrows (1);
13486 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13487 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13490 update_mode_lines
= 0;
13491 windows_or_buffers_changed
= 0;
13492 cursor_type_changed
= 0;
13495 /* Start SIGIO interrupts coming again. Having them off during the
13496 code above makes it less likely one will discard output, but not
13497 impossible, since there might be stuff in the system buffer here.
13498 But it is much hairier to try to do anything about that. */
13499 if (interrupt_input
)
13503 /* If a frame has become visible which was not before, redisplay
13504 again, so that we display it. Expose events for such a frame
13505 (which it gets when becoming visible) don't call the parts of
13506 redisplay constructing glyphs, so simply exposing a frame won't
13507 display anything in this case. So, we have to display these
13508 frames here explicitly. */
13511 Lisp_Object tail
, frame
;
13514 FOR_EACH_FRAME (tail
, frame
)
13516 int this_is_visible
= 0;
13518 if (XFRAME (frame
)->visible
)
13519 this_is_visible
= 1;
13520 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13521 if (XFRAME (frame
)->visible
)
13522 this_is_visible
= 1;
13524 if (this_is_visible
)
13528 if (new_count
!= number_of_visible_frames
)
13529 windows_or_buffers_changed
++;
13532 /* Change frame size now if a change is pending. */
13533 do_pending_window_change (1);
13535 /* If we just did a pending size change, or have additional
13536 visible frames, or selected_window changed, redisplay again. */
13537 if ((windows_or_buffers_changed
&& !pending
)
13538 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13541 /* Clear the face and image caches.
13543 We used to do this only if consider_all_windows_p. But the cache
13544 needs to be cleared if a timer creates images in the current
13545 buffer (e.g. the test case in Bug#6230). */
13547 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13549 clear_face_cache (0);
13550 clear_face_cache_count
= 0;
13553 #ifdef HAVE_WINDOW_SYSTEM
13554 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13556 clear_image_caches (Qnil
);
13557 clear_image_cache_count
= 0;
13559 #endif /* HAVE_WINDOW_SYSTEM */
13562 unbind_to (count
, Qnil
);
13567 /* Redisplay, but leave alone any recent echo area message unless
13568 another message has been requested in its place.
13570 This is useful in situations where you need to redisplay but no
13571 user action has occurred, making it inappropriate for the message
13572 area to be cleared. See tracking_off and
13573 wait_reading_process_output for examples of these situations.
13575 FROM_WHERE is an integer saying from where this function was
13576 called. This is useful for debugging. */
13579 redisplay_preserve_echo_area (int from_where
)
13581 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13583 if (!NILP (echo_area_buffer
[1]))
13585 /* We have a previously displayed message, but no current
13586 message. Redisplay the previous message. */
13587 display_last_displayed_message_p
= 1;
13588 redisplay_internal ();
13589 display_last_displayed_message_p
= 0;
13592 redisplay_internal ();
13594 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13595 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13596 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13600 /* Function registered with record_unwind_protect in
13601 redisplay_internal. Reset redisplaying_p to the value it had
13602 before redisplay_internal was called, and clear
13603 prevent_freeing_realized_faces_p. It also selects the previously
13604 selected frame, unless it has been deleted (by an X connection
13605 failure during redisplay, for example). */
13608 unwind_redisplay (Lisp_Object val
)
13610 Lisp_Object old_redisplaying_p
, old_frame
;
13612 old_redisplaying_p
= XCAR (val
);
13613 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13614 old_frame
= XCDR (val
);
13615 if (! EQ (old_frame
, selected_frame
)
13616 && FRAME_LIVE_P (XFRAME (old_frame
)))
13617 select_frame_for_redisplay (old_frame
);
13622 /* Mark the display of window W as accurate or inaccurate. If
13623 ACCURATE_P is non-zero mark display of W as accurate. If
13624 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13625 redisplay_internal is called. */
13628 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13630 if (BUFFERP (w
->buffer
))
13632 struct buffer
*b
= XBUFFER (w
->buffer
);
13635 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13636 w
->last_overlay_modified
13637 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13639 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13643 b
->clip_changed
= 0;
13644 b
->prevent_redisplay_optimizations_p
= 0;
13646 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13647 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13648 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13649 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13651 w
->current_matrix
->buffer
= b
;
13652 w
->current_matrix
->begv
= BUF_BEGV (b
);
13653 w
->current_matrix
->zv
= BUF_ZV (b
);
13655 w
->last_cursor
= w
->cursor
;
13656 w
->last_cursor_off_p
= w
->cursor_off_p
;
13658 if (w
== XWINDOW (selected_window
))
13659 w
->last_point
= make_number (BUF_PT (b
));
13661 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13667 w
->window_end_valid
= w
->buffer
;
13668 w
->update_mode_line
= 0;
13673 /* Mark the display of windows in the window tree rooted at WINDOW as
13674 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13675 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13676 be redisplayed the next time redisplay_internal is called. */
13679 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13683 for (; !NILP (window
); window
= w
->next
)
13685 w
= XWINDOW (window
);
13686 mark_window_display_accurate_1 (w
, accurate_p
);
13688 if (!NILP (w
->vchild
))
13689 mark_window_display_accurate (w
->vchild
, accurate_p
);
13690 if (!NILP (w
->hchild
))
13691 mark_window_display_accurate (w
->hchild
, accurate_p
);
13696 update_overlay_arrows (1);
13700 /* Force a thorough redisplay the next time by setting
13701 last_arrow_position and last_arrow_string to t, which is
13702 unequal to any useful value of Voverlay_arrow_... */
13703 update_overlay_arrows (-1);
13708 /* Return value in display table DP (Lisp_Char_Table *) for character
13709 C. Since a display table doesn't have any parent, we don't have to
13710 follow parent. Do not call this function directly but use the
13711 macro DISP_CHAR_VECTOR. */
13714 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13718 if (ASCII_CHAR_P (c
))
13721 if (SUB_CHAR_TABLE_P (val
))
13722 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13728 XSETCHAR_TABLE (table
, dp
);
13729 val
= char_table_ref (table
, c
);
13738 /***********************************************************************
13740 ***********************************************************************/
13742 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13745 redisplay_windows (Lisp_Object window
)
13747 while (!NILP (window
))
13749 struct window
*w
= XWINDOW (window
);
13751 if (!NILP (w
->hchild
))
13752 redisplay_windows (w
->hchild
);
13753 else if (!NILP (w
->vchild
))
13754 redisplay_windows (w
->vchild
);
13755 else if (!NILP (w
->buffer
))
13757 displayed_buffer
= XBUFFER (w
->buffer
);
13758 /* Use list_of_error, not Qerror, so that
13759 we catch only errors and don't run the debugger. */
13760 internal_condition_case_1 (redisplay_window_0
, window
,
13762 redisplay_window_error
);
13770 redisplay_window_error (Lisp_Object ignore
)
13772 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13777 redisplay_window_0 (Lisp_Object window
)
13779 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13780 redisplay_window (window
, 0);
13785 redisplay_window_1 (Lisp_Object window
)
13787 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13788 redisplay_window (window
, 1);
13793 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13794 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13795 which positions recorded in ROW differ from current buffer
13798 Return 0 if cursor is not on this row, 1 otherwise. */
13801 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13802 struct glyph_matrix
*matrix
,
13803 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13806 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13807 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13808 struct glyph
*cursor
= NULL
;
13809 /* The last known character position in row. */
13810 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13812 ptrdiff_t pt_old
= PT
- delta
;
13813 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13814 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13815 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13816 /* A glyph beyond the edge of TEXT_AREA which we should never
13818 struct glyph
*glyphs_end
= end
;
13819 /* Non-zero means we've found a match for cursor position, but that
13820 glyph has the avoid_cursor_p flag set. */
13821 int match_with_avoid_cursor
= 0;
13822 /* Non-zero means we've seen at least one glyph that came from a
13824 int string_seen
= 0;
13825 /* Largest and smallest buffer positions seen so far during scan of
13827 ptrdiff_t bpos_max
= pos_before
;
13828 ptrdiff_t bpos_min
= pos_after
;
13829 /* Last buffer position covered by an overlay string with an integer
13830 `cursor' property. */
13831 ptrdiff_t bpos_covered
= 0;
13832 /* Non-zero means the display string on which to display the cursor
13833 comes from a text property, not from an overlay. */
13834 int string_from_text_prop
= 0;
13836 /* Don't even try doing anything if called for a mode-line or
13837 header-line row, since the rest of the code isn't prepared to
13838 deal with such calamities. */
13839 xassert (!row
->mode_line_p
);
13840 if (row
->mode_line_p
)
13843 /* Skip over glyphs not having an object at the start and the end of
13844 the row. These are special glyphs like truncation marks on
13845 terminal frames. */
13846 if (row
->displays_text_p
)
13848 if (!row
->reversed_p
)
13851 && INTEGERP (glyph
->object
)
13852 && glyph
->charpos
< 0)
13854 x
+= glyph
->pixel_width
;
13858 && INTEGERP ((end
- 1)->object
)
13859 /* CHARPOS is zero for blanks and stretch glyphs
13860 inserted by extend_face_to_end_of_line. */
13861 && (end
- 1)->charpos
<= 0)
13863 glyph_before
= glyph
- 1;
13870 /* If the glyph row is reversed, we need to process it from back
13871 to front, so swap the edge pointers. */
13872 glyphs_end
= end
= glyph
- 1;
13873 glyph
+= row
->used
[TEXT_AREA
] - 1;
13875 while (glyph
> end
+ 1
13876 && INTEGERP (glyph
->object
)
13877 && glyph
->charpos
< 0)
13880 x
-= glyph
->pixel_width
;
13882 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13884 /* By default, in reversed rows we put the cursor on the
13885 rightmost (first in the reading order) glyph. */
13886 for (g
= end
+ 1; g
< glyph
; g
++)
13887 x
+= g
->pixel_width
;
13889 && INTEGERP ((end
+ 1)->object
)
13890 && (end
+ 1)->charpos
<= 0)
13892 glyph_before
= glyph
+ 1;
13896 else if (row
->reversed_p
)
13898 /* In R2L rows that don't display text, put the cursor on the
13899 rightmost glyph. Case in point: an empty last line that is
13900 part of an R2L paragraph. */
13902 /* Avoid placing the cursor on the last glyph of the row, where
13903 on terminal frames we hold the vertical border between
13904 adjacent windows. */
13905 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13906 && !WINDOW_RIGHTMOST_P (w
)
13907 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13909 x
= -1; /* will be computed below, at label compute_x */
13912 /* Step 1: Try to find the glyph whose character position
13913 corresponds to point. If that's not possible, find 2 glyphs
13914 whose character positions are the closest to point, one before
13915 point, the other after it. */
13916 if (!row
->reversed_p
)
13917 while (/* not marched to end of glyph row */
13919 /* glyph was not inserted by redisplay for internal purposes */
13920 && !INTEGERP (glyph
->object
))
13922 if (BUFFERP (glyph
->object
))
13924 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
13926 if (glyph
->charpos
> bpos_max
)
13927 bpos_max
= glyph
->charpos
;
13928 if (glyph
->charpos
< bpos_min
)
13929 bpos_min
= glyph
->charpos
;
13930 if (!glyph
->avoid_cursor_p
)
13932 /* If we hit point, we've found the glyph on which to
13933 display the cursor. */
13936 match_with_avoid_cursor
= 0;
13939 /* See if we've found a better approximation to
13940 POS_BEFORE or to POS_AFTER. Note that we want the
13941 first (leftmost) glyph of all those that are the
13942 closest from below, and the last (rightmost) of all
13943 those from above. */
13944 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13946 pos_before
= glyph
->charpos
;
13947 glyph_before
= glyph
;
13949 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13951 pos_after
= glyph
->charpos
;
13952 glyph_after
= glyph
;
13955 else if (dpos
== 0)
13956 match_with_avoid_cursor
= 1;
13958 else if (STRINGP (glyph
->object
))
13960 Lisp_Object chprop
;
13961 ptrdiff_t glyph_pos
= glyph
->charpos
;
13963 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13965 if (!NILP (chprop
))
13967 /* If the string came from a `display' text property,
13968 look up the buffer position of that property and
13969 use that position to update bpos_max, as if we
13970 actually saw such a position in one of the row's
13971 glyphs. This helps with supporting integer values
13972 of `cursor' property on the display string in
13973 situations where most or all of the row's buffer
13974 text is completely covered by display properties,
13975 so that no glyph with valid buffer positions is
13976 ever seen in the row. */
13977 ptrdiff_t prop_pos
=
13978 string_buffer_position_lim (glyph
->object
, pos_before
,
13981 if (prop_pos
>= pos_before
)
13982 bpos_max
= prop_pos
- 1;
13984 if (INTEGERP (chprop
))
13986 bpos_covered
= bpos_max
+ XINT (chprop
);
13987 /* If the `cursor' property covers buffer positions up
13988 to and including point, we should display cursor on
13989 this glyph. Note that, if a `cursor' property on one
13990 of the string's characters has an integer value, we
13991 will break out of the loop below _before_ we get to
13992 the position match above. IOW, integer values of
13993 the `cursor' property override the "exact match for
13994 point" strategy of positioning the cursor. */
13995 /* Implementation note: bpos_max == pt_old when, e.g.,
13996 we are in an empty line, where bpos_max is set to
13997 MATRIX_ROW_START_CHARPOS, see above. */
13998 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14007 x
+= glyph
->pixel_width
;
14010 else if (glyph
> end
) /* row is reversed */
14011 while (!INTEGERP (glyph
->object
))
14013 if (BUFFERP (glyph
->object
))
14015 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14017 if (glyph
->charpos
> bpos_max
)
14018 bpos_max
= glyph
->charpos
;
14019 if (glyph
->charpos
< bpos_min
)
14020 bpos_min
= glyph
->charpos
;
14021 if (!glyph
->avoid_cursor_p
)
14025 match_with_avoid_cursor
= 0;
14028 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14030 pos_before
= glyph
->charpos
;
14031 glyph_before
= glyph
;
14033 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
14035 pos_after
= glyph
->charpos
;
14036 glyph_after
= glyph
;
14039 else if (dpos
== 0)
14040 match_with_avoid_cursor
= 1;
14042 else if (STRINGP (glyph
->object
))
14044 Lisp_Object chprop
;
14045 ptrdiff_t glyph_pos
= glyph
->charpos
;
14047 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14049 if (!NILP (chprop
))
14051 ptrdiff_t prop_pos
=
14052 string_buffer_position_lim (glyph
->object
, pos_before
,
14055 if (prop_pos
>= pos_before
)
14056 bpos_max
= prop_pos
- 1;
14058 if (INTEGERP (chprop
))
14060 bpos_covered
= bpos_max
+ XINT (chprop
);
14061 /* If the `cursor' property covers buffer positions up
14062 to and including point, we should display cursor on
14064 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14073 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14075 x
--; /* can't use any pixel_width */
14078 x
-= glyph
->pixel_width
;
14081 /* Step 2: If we didn't find an exact match for point, we need to
14082 look for a proper place to put the cursor among glyphs between
14083 GLYPH_BEFORE and GLYPH_AFTER. */
14084 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14085 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14086 && bpos_covered
< pt_old
)
14088 /* An empty line has a single glyph whose OBJECT is zero and
14089 whose CHARPOS is the position of a newline on that line.
14090 Note that on a TTY, there are more glyphs after that, which
14091 were produced by extend_face_to_end_of_line, but their
14092 CHARPOS is zero or negative. */
14094 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14095 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14097 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14099 ptrdiff_t ellipsis_pos
;
14101 /* Scan back over the ellipsis glyphs. */
14102 if (!row
->reversed_p
)
14104 ellipsis_pos
= (glyph
- 1)->charpos
;
14105 while (glyph
> row
->glyphs
[TEXT_AREA
]
14106 && (glyph
- 1)->charpos
== ellipsis_pos
)
14107 glyph
--, x
-= glyph
->pixel_width
;
14108 /* That loop always goes one position too far, including
14109 the glyph before the ellipsis. So scan forward over
14111 x
+= glyph
->pixel_width
;
14114 else /* row is reversed */
14116 ellipsis_pos
= (glyph
+ 1)->charpos
;
14117 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14118 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14119 glyph
++, x
+= glyph
->pixel_width
;
14120 x
-= glyph
->pixel_width
;
14124 else if (match_with_avoid_cursor
)
14126 cursor
= glyph_after
;
14129 else if (string_seen
)
14131 int incr
= row
->reversed_p
? -1 : +1;
14133 /* Need to find the glyph that came out of a string which is
14134 present at point. That glyph is somewhere between
14135 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14136 positioned between POS_BEFORE and POS_AFTER in the
14138 struct glyph
*start
, *stop
;
14139 ptrdiff_t pos
= pos_before
;
14143 /* If the row ends in a newline from a display string,
14144 reordering could have moved the glyphs belonging to the
14145 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14146 in this case we extend the search to the last glyph in
14147 the row that was not inserted by redisplay. */
14148 if (row
->ends_in_newline_from_string_p
)
14151 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14154 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14155 correspond to POS_BEFORE and POS_AFTER, respectively. We
14156 need START and STOP in the order that corresponds to the
14157 row's direction as given by its reversed_p flag. If the
14158 directionality of characters between POS_BEFORE and
14159 POS_AFTER is the opposite of the row's base direction,
14160 these characters will have been reordered for display,
14161 and we need to reverse START and STOP. */
14162 if (!row
->reversed_p
)
14164 start
= min (glyph_before
, glyph_after
);
14165 stop
= max (glyph_before
, glyph_after
);
14169 start
= max (glyph_before
, glyph_after
);
14170 stop
= min (glyph_before
, glyph_after
);
14172 for (glyph
= start
+ incr
;
14173 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14176 /* Any glyphs that come from the buffer are here because
14177 of bidi reordering. Skip them, and only pay
14178 attention to glyphs that came from some string. */
14179 if (STRINGP (glyph
->object
))
14183 /* If the display property covers the newline, we
14184 need to search for it one position farther. */
14185 ptrdiff_t lim
= pos_after
14186 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14188 string_from_text_prop
= 0;
14189 str
= glyph
->object
;
14190 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14191 if (tem
== 0 /* from overlay */
14194 /* If the string from which this glyph came is
14195 found in the buffer at point, or at position
14196 that is closer to point than pos_after, then
14197 we've found the glyph we've been looking for.
14198 If it comes from an overlay (tem == 0), and
14199 it has the `cursor' property on one of its
14200 glyphs, record that glyph as a candidate for
14201 displaying the cursor. (As in the
14202 unidirectional version, we will display the
14203 cursor on the last candidate we find.) */
14206 || (tem
- pt_old
> 0 && tem
< pos_after
))
14208 /* The glyphs from this string could have
14209 been reordered. Find the one with the
14210 smallest string position. Or there could
14211 be a character in the string with the
14212 `cursor' property, which means display
14213 cursor on that character's glyph. */
14214 ptrdiff_t strpos
= glyph
->charpos
;
14219 string_from_text_prop
= 1;
14222 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14223 && EQ (glyph
->object
, str
);
14227 ptrdiff_t gpos
= glyph
->charpos
;
14229 cprop
= Fget_char_property (make_number (gpos
),
14237 if (tem
&& glyph
->charpos
< strpos
)
14239 strpos
= glyph
->charpos
;
14245 || (tem
- pt_old
> 0 && tem
< pos_after
))
14249 pos
= tem
+ 1; /* don't find previous instances */
14251 /* This string is not what we want; skip all of the
14252 glyphs that came from it. */
14253 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14254 && EQ (glyph
->object
, str
))
14261 /* If we reached the end of the line, and END was from a string,
14262 the cursor is not on this line. */
14264 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14265 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14266 && STRINGP (end
->object
)
14267 && row
->continued_p
)
14270 /* A truncated row may not include PT among its character positions.
14271 Setting the cursor inside the scroll margin will trigger
14272 recalculation of hscroll in hscroll_window_tree. But if a
14273 display string covers point, defer to the string-handling
14274 code below to figure this out. */
14275 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14277 cursor
= glyph_before
;
14280 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14281 /* Zero-width characters produce no glyphs. */
14283 && (row
->reversed_p
14284 ? glyph_after
> glyphs_end
14285 : glyph_after
< glyphs_end
)))
14287 cursor
= glyph_after
;
14293 if (cursor
!= NULL
)
14295 else if (glyph
== glyphs_end
14296 && pos_before
== pos_after
14297 && STRINGP ((row
->reversed_p
14298 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14299 : row
->glyphs
[TEXT_AREA
])->object
))
14301 /* If all the glyphs of this row came from strings, put the
14302 cursor on the first glyph of the row. This avoids having the
14303 cursor outside of the text area in this very rare and hard
14307 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14308 : row
->glyphs
[TEXT_AREA
];
14314 /* Need to compute x that corresponds to GLYPH. */
14315 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14317 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14319 x
+= g
->pixel_width
;
14323 /* ROW could be part of a continued line, which, under bidi
14324 reordering, might have other rows whose start and end charpos
14325 occlude point. Only set w->cursor if we found a better
14326 approximation to the cursor position than we have from previously
14327 examined candidate rows belonging to the same continued line. */
14328 if (/* we already have a candidate row */
14329 w
->cursor
.vpos
>= 0
14330 /* that candidate is not the row we are processing */
14331 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14332 /* Make sure cursor.vpos specifies a row whose start and end
14333 charpos occlude point, and it is valid candidate for being a
14334 cursor-row. This is because some callers of this function
14335 leave cursor.vpos at the row where the cursor was displayed
14336 during the last redisplay cycle. */
14337 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14338 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14339 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14342 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14344 /* Don't consider glyphs that are outside TEXT_AREA. */
14345 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14347 /* Keep the candidate whose buffer position is the closest to
14348 point or has the `cursor' property. */
14349 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14350 w
->cursor
.hpos
>= 0
14351 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14352 && ((BUFFERP (g1
->object
)
14353 && (g1
->charpos
== pt_old
/* an exact match always wins */
14354 || (BUFFERP (glyph
->object
)
14355 && eabs (g1
->charpos
- pt_old
)
14356 < eabs (glyph
->charpos
- pt_old
))))
14357 /* previous candidate is a glyph from a string that has
14358 a non-nil `cursor' property */
14359 || (STRINGP (g1
->object
)
14360 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14361 Qcursor
, g1
->object
))
14362 /* previous candidate is from the same display
14363 string as this one, and the display string
14364 came from a text property */
14365 || (EQ (g1
->object
, glyph
->object
)
14366 && string_from_text_prop
)
14367 /* this candidate is from newline and its
14368 position is not an exact match */
14369 || (INTEGERP (glyph
->object
)
14370 && glyph
->charpos
!= pt_old
)))))
14372 /* If this candidate gives an exact match, use that. */
14373 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14374 /* If this candidate is a glyph created for the
14375 terminating newline of a line, and point is on that
14376 newline, it wins because it's an exact match. */
14377 || (!row
->continued_p
14378 && INTEGERP (glyph
->object
)
14379 && glyph
->charpos
== 0
14380 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14381 /* Otherwise, keep the candidate that comes from a row
14382 spanning less buffer positions. This may win when one or
14383 both candidate positions are on glyphs that came from
14384 display strings, for which we cannot compare buffer
14386 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14387 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14388 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14391 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14393 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14394 w
->cursor
.y
= row
->y
+ dy
;
14396 if (w
== XWINDOW (selected_window
))
14398 if (!row
->continued_p
14399 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14402 this_line_buffer
= XBUFFER (w
->buffer
);
14404 CHARPOS (this_line_start_pos
)
14405 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14406 BYTEPOS (this_line_start_pos
)
14407 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14409 CHARPOS (this_line_end_pos
)
14410 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14411 BYTEPOS (this_line_end_pos
)
14412 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14414 this_line_y
= w
->cursor
.y
;
14415 this_line_pixel_height
= row
->height
;
14416 this_line_vpos
= w
->cursor
.vpos
;
14417 this_line_start_x
= row
->x
;
14420 CHARPOS (this_line_start_pos
) = 0;
14427 /* Run window scroll functions, if any, for WINDOW with new window
14428 start STARTP. Sets the window start of WINDOW to that position.
14430 We assume that the window's buffer is really current. */
14432 static inline struct text_pos
14433 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14435 struct window
*w
= XWINDOW (window
);
14436 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14438 if (current_buffer
!= XBUFFER (w
->buffer
))
14441 if (!NILP (Vwindow_scroll_functions
))
14443 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14444 make_number (CHARPOS (startp
)));
14445 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14446 /* In case the hook functions switch buffers. */
14447 if (current_buffer
!= XBUFFER (w
->buffer
))
14448 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14455 /* Make sure the line containing the cursor is fully visible.
14456 A value of 1 means there is nothing to be done.
14457 (Either the line is fully visible, or it cannot be made so,
14458 or we cannot tell.)
14460 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14461 is higher than window.
14463 A value of 0 means the caller should do scrolling
14464 as if point had gone off the screen. */
14467 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14469 struct glyph_matrix
*matrix
;
14470 struct glyph_row
*row
;
14473 if (!make_cursor_line_fully_visible_p
)
14476 /* It's not always possible to find the cursor, e.g, when a window
14477 is full of overlay strings. Don't do anything in that case. */
14478 if (w
->cursor
.vpos
< 0)
14481 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14482 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14484 /* If the cursor row is not partially visible, there's nothing to do. */
14485 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14488 /* If the row the cursor is in is taller than the window's height,
14489 it's not clear what to do, so do nothing. */
14490 window_height
= window_box_height (w
);
14491 if (row
->height
>= window_height
)
14493 if (!force_p
|| MINI_WINDOW_P (w
)
14494 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14501 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14502 non-zero means only WINDOW is redisplayed in redisplay_internal.
14503 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14504 in redisplay_window to bring a partially visible line into view in
14505 the case that only the cursor has moved.
14507 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14508 last screen line's vertical height extends past the end of the screen.
14512 1 if scrolling succeeded
14514 0 if scrolling didn't find point.
14516 -1 if new fonts have been loaded so that we must interrupt
14517 redisplay, adjust glyph matrices, and try again. */
14523 SCROLLING_NEED_LARGER_MATRICES
14526 /* If scroll-conservatively is more than this, never recenter.
14528 If you change this, don't forget to update the doc string of
14529 `scroll-conservatively' and the Emacs manual. */
14530 #define SCROLL_LIMIT 100
14533 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14534 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14535 int temp_scroll_step
, int last_line_misfit
)
14537 struct window
*w
= XWINDOW (window
);
14538 struct frame
*f
= XFRAME (w
->frame
);
14539 struct text_pos pos
, startp
;
14541 int this_scroll_margin
, scroll_max
, rc
, height
;
14542 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14543 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14544 Lisp_Object aggressive
;
14545 /* We will never try scrolling more than this number of lines. */
14546 int scroll_limit
= SCROLL_LIMIT
;
14549 debug_method_add (w
, "try_scrolling");
14552 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14554 /* Compute scroll margin height in pixels. We scroll when point is
14555 within this distance from the top or bottom of the window. */
14556 if (scroll_margin
> 0)
14557 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14558 * FRAME_LINE_HEIGHT (f
);
14560 this_scroll_margin
= 0;
14562 /* Force arg_scroll_conservatively to have a reasonable value, to
14563 avoid scrolling too far away with slow move_it_* functions. Note
14564 that the user can supply scroll-conservatively equal to
14565 `most-positive-fixnum', which can be larger than INT_MAX. */
14566 if (arg_scroll_conservatively
> scroll_limit
)
14568 arg_scroll_conservatively
= scroll_limit
+ 1;
14569 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14571 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14572 /* Compute how much we should try to scroll maximally to bring
14573 point into view. */
14574 scroll_max
= (max (scroll_step
,
14575 max (arg_scroll_conservatively
, temp_scroll_step
))
14576 * FRAME_LINE_HEIGHT (f
));
14577 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14578 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14579 /* We're trying to scroll because of aggressive scrolling but no
14580 scroll_step is set. Choose an arbitrary one. */
14581 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14587 /* Decide whether to scroll down. */
14588 if (PT
> CHARPOS (startp
))
14590 int scroll_margin_y
;
14592 /* Compute the pixel ypos of the scroll margin, then move IT to
14593 either that ypos or PT, whichever comes first. */
14594 start_display (&it
, w
, startp
);
14595 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14596 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14597 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14598 (MOVE_TO_POS
| MOVE_TO_Y
));
14600 if (PT
> CHARPOS (it
.current
.pos
))
14602 int y0
= line_bottom_y (&it
);
14603 /* Compute how many pixels below window bottom to stop searching
14604 for PT. This avoids costly search for PT that is far away if
14605 the user limited scrolling by a small number of lines, but
14606 always finds PT if scroll_conservatively is set to a large
14607 number, such as most-positive-fixnum. */
14608 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14609 int y_to_move
= it
.last_visible_y
+ slack
;
14611 /* Compute the distance from the scroll margin to PT or to
14612 the scroll limit, whichever comes first. This should
14613 include the height of the cursor line, to make that line
14615 move_it_to (&it
, PT
, -1, y_to_move
,
14616 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14617 dy
= line_bottom_y (&it
) - y0
;
14619 if (dy
> scroll_max
)
14620 return SCROLLING_FAILED
;
14629 /* Point is in or below the bottom scroll margin, so move the
14630 window start down. If scrolling conservatively, move it just
14631 enough down to make point visible. If scroll_step is set,
14632 move it down by scroll_step. */
14633 if (arg_scroll_conservatively
)
14635 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14636 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14637 else if (scroll_step
|| temp_scroll_step
)
14638 amount_to_scroll
= scroll_max
;
14641 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14642 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14643 if (NUMBERP (aggressive
))
14645 double float_amount
= XFLOATINT (aggressive
) * height
;
14646 amount_to_scroll
= float_amount
;
14647 if (amount_to_scroll
== 0 && float_amount
> 0)
14648 amount_to_scroll
= 1;
14649 /* Don't let point enter the scroll margin near top of
14651 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14652 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14656 if (amount_to_scroll
<= 0)
14657 return SCROLLING_FAILED
;
14659 start_display (&it
, w
, startp
);
14660 if (arg_scroll_conservatively
<= scroll_limit
)
14661 move_it_vertically (&it
, amount_to_scroll
);
14664 /* Extra precision for users who set scroll-conservatively
14665 to a large number: make sure the amount we scroll
14666 the window start is never less than amount_to_scroll,
14667 which was computed as distance from window bottom to
14668 point. This matters when lines at window top and lines
14669 below window bottom have different height. */
14671 void *it1data
= NULL
;
14672 /* We use a temporary it1 because line_bottom_y can modify
14673 its argument, if it moves one line down; see there. */
14676 SAVE_IT (it1
, it
, it1data
);
14677 start_y
= line_bottom_y (&it1
);
14679 RESTORE_IT (&it
, &it
, it1data
);
14680 move_it_by_lines (&it
, 1);
14681 SAVE_IT (it1
, it
, it1data
);
14682 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14685 /* If STARTP is unchanged, move it down another screen line. */
14686 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14687 move_it_by_lines (&it
, 1);
14688 startp
= it
.current
.pos
;
14692 struct text_pos scroll_margin_pos
= startp
;
14694 /* See if point is inside the scroll margin at the top of the
14696 if (this_scroll_margin
)
14698 start_display (&it
, w
, startp
);
14699 move_it_vertically (&it
, this_scroll_margin
);
14700 scroll_margin_pos
= it
.current
.pos
;
14703 if (PT
< CHARPOS (scroll_margin_pos
))
14705 /* Point is in the scroll margin at the top of the window or
14706 above what is displayed in the window. */
14709 /* Compute the vertical distance from PT to the scroll
14710 margin position. Move as far as scroll_max allows, or
14711 one screenful, or 10 screen lines, whichever is largest.
14712 Give up if distance is greater than scroll_max. */
14713 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14714 start_display (&it
, w
, pos
);
14716 y_to_move
= max (it
.last_visible_y
,
14717 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14718 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14720 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14721 dy
= it
.current_y
- y0
;
14722 if (dy
> scroll_max
)
14723 return SCROLLING_FAILED
;
14725 /* Compute new window start. */
14726 start_display (&it
, w
, startp
);
14728 if (arg_scroll_conservatively
)
14729 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14730 max (scroll_step
, temp_scroll_step
));
14731 else if (scroll_step
|| temp_scroll_step
)
14732 amount_to_scroll
= scroll_max
;
14735 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14736 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14737 if (NUMBERP (aggressive
))
14739 double float_amount
= XFLOATINT (aggressive
) * height
;
14740 amount_to_scroll
= float_amount
;
14741 if (amount_to_scroll
== 0 && float_amount
> 0)
14742 amount_to_scroll
= 1;
14743 amount_to_scroll
-=
14744 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14745 /* Don't let point enter the scroll margin near
14746 bottom of the window. */
14747 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14748 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14752 if (amount_to_scroll
<= 0)
14753 return SCROLLING_FAILED
;
14755 move_it_vertically_backward (&it
, amount_to_scroll
);
14756 startp
= it
.current
.pos
;
14760 /* Run window scroll functions. */
14761 startp
= run_window_scroll_functions (window
, startp
);
14763 /* Display the window. Give up if new fonts are loaded, or if point
14765 if (!try_window (window
, startp
, 0))
14766 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14767 else if (w
->cursor
.vpos
< 0)
14769 clear_glyph_matrix (w
->desired_matrix
);
14770 rc
= SCROLLING_FAILED
;
14774 /* Maybe forget recorded base line for line number display. */
14775 if (!just_this_one_p
14776 || current_buffer
->clip_changed
14777 || BEG_UNCHANGED
< CHARPOS (startp
))
14778 w
->base_line_number
= Qnil
;
14780 /* If cursor ends up on a partially visible line,
14781 treat that as being off the bottom of the screen. */
14782 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14783 /* It's possible that the cursor is on the first line of the
14784 buffer, which is partially obscured due to a vscroll
14785 (Bug#7537). In that case, avoid looping forever . */
14786 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14788 clear_glyph_matrix (w
->desired_matrix
);
14789 ++extra_scroll_margin_lines
;
14792 rc
= SCROLLING_SUCCESS
;
14799 /* Compute a suitable window start for window W if display of W starts
14800 on a continuation line. Value is non-zero if a new window start
14803 The new window start will be computed, based on W's width, starting
14804 from the start of the continued line. It is the start of the
14805 screen line with the minimum distance from the old start W->start. */
14808 compute_window_start_on_continuation_line (struct window
*w
)
14810 struct text_pos pos
, start_pos
;
14811 int window_start_changed_p
= 0;
14813 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14815 /* If window start is on a continuation line... Window start may be
14816 < BEGV in case there's invisible text at the start of the
14817 buffer (M-x rmail, for example). */
14818 if (CHARPOS (start_pos
) > BEGV
14819 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14822 struct glyph_row
*row
;
14824 /* Handle the case that the window start is out of range. */
14825 if (CHARPOS (start_pos
) < BEGV
)
14826 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14827 else if (CHARPOS (start_pos
) > ZV
)
14828 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14830 /* Find the start of the continued line. This should be fast
14831 because scan_buffer is fast (newline cache). */
14832 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14833 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14834 row
, DEFAULT_FACE_ID
);
14835 reseat_at_previous_visible_line_start (&it
);
14837 /* If the line start is "too far" away from the window start,
14838 say it takes too much time to compute a new window start. */
14839 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14840 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14842 int min_distance
, distance
;
14844 /* Move forward by display lines to find the new window
14845 start. If window width was enlarged, the new start can
14846 be expected to be > the old start. If window width was
14847 decreased, the new window start will be < the old start.
14848 So, we're looking for the display line start with the
14849 minimum distance from the old window start. */
14850 pos
= it
.current
.pos
;
14851 min_distance
= INFINITY
;
14852 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14853 distance
< min_distance
)
14855 min_distance
= distance
;
14856 pos
= it
.current
.pos
;
14857 move_it_by_lines (&it
, 1);
14860 /* Set the window start there. */
14861 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14862 window_start_changed_p
= 1;
14866 return window_start_changed_p
;
14870 /* Try cursor movement in case text has not changed in window WINDOW,
14871 with window start STARTP. Value is
14873 CURSOR_MOVEMENT_SUCCESS if successful
14875 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14877 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14878 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14879 we want to scroll as if scroll-step were set to 1. See the code.
14881 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14882 which case we have to abort this redisplay, and adjust matrices
14887 CURSOR_MOVEMENT_SUCCESS
,
14888 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14889 CURSOR_MOVEMENT_MUST_SCROLL
,
14890 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14894 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14896 struct window
*w
= XWINDOW (window
);
14897 struct frame
*f
= XFRAME (w
->frame
);
14898 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14901 if (inhibit_try_cursor_movement
)
14905 /* Handle case where text has not changed, only point, and it has
14906 not moved off the frame. */
14907 if (/* Point may be in this window. */
14908 PT
>= CHARPOS (startp
)
14909 /* Selective display hasn't changed. */
14910 && !current_buffer
->clip_changed
14911 /* Function force-mode-line-update is used to force a thorough
14912 redisplay. It sets either windows_or_buffers_changed or
14913 update_mode_lines. So don't take a shortcut here for these
14915 && !update_mode_lines
14916 && !windows_or_buffers_changed
14917 && !cursor_type_changed
14918 /* Can't use this case if highlighting a region. When a
14919 region exists, cursor movement has to do more than just
14921 && !(!NILP (Vtransient_mark_mode
)
14922 && !NILP (BVAR (current_buffer
, mark_active
)))
14923 && NILP (w
->region_showing
)
14924 && NILP (Vshow_trailing_whitespace
)
14925 /* Right after splitting windows, last_point may be nil. */
14926 && INTEGERP (w
->last_point
)
14927 /* This code is not used for mini-buffer for the sake of the case
14928 of redisplaying to replace an echo area message; since in
14929 that case the mini-buffer contents per se are usually
14930 unchanged. This code is of no real use in the mini-buffer
14931 since the handling of this_line_start_pos, etc., in redisplay
14932 handles the same cases. */
14933 && !EQ (window
, minibuf_window
)
14934 /* When splitting windows or for new windows, it happens that
14935 redisplay is called with a nil window_end_vpos or one being
14936 larger than the window. This should really be fixed in
14937 window.c. I don't have this on my list, now, so we do
14938 approximately the same as the old redisplay code. --gerd. */
14939 && INTEGERP (w
->window_end_vpos
)
14940 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14941 && (FRAME_WINDOW_P (f
)
14942 || !overlay_arrow_in_current_buffer_p ()))
14944 int this_scroll_margin
, top_scroll_margin
;
14945 struct glyph_row
*row
= NULL
;
14948 debug_method_add (w
, "cursor movement");
14951 /* Scroll if point within this distance from the top or bottom
14952 of the window. This is a pixel value. */
14953 if (scroll_margin
> 0)
14955 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14956 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14959 this_scroll_margin
= 0;
14961 top_scroll_margin
= this_scroll_margin
;
14962 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14963 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14965 /* Start with the row the cursor was displayed during the last
14966 not paused redisplay. Give up if that row is not valid. */
14967 if (w
->last_cursor
.vpos
< 0
14968 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14969 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14972 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14973 if (row
->mode_line_p
)
14975 if (!row
->enabled_p
)
14976 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14979 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14981 int scroll_p
= 0, must_scroll
= 0;
14982 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14984 if (PT
> XFASTINT (w
->last_point
))
14986 /* Point has moved forward. */
14987 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14988 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14990 xassert (row
->enabled_p
);
14994 /* If the end position of a row equals the start
14995 position of the next row, and PT is at that position,
14996 we would rather display cursor in the next line. */
14997 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14998 && MATRIX_ROW_END_CHARPOS (row
) == PT
14999 && row
< w
->current_matrix
->rows
15000 + w
->current_matrix
->nrows
- 1
15001 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15002 && !cursor_row_p (row
))
15005 /* If within the scroll margin, scroll. Note that
15006 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15007 the next line would be drawn, and that
15008 this_scroll_margin can be zero. */
15009 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15010 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15011 /* Line is completely visible last line in window
15012 and PT is to be set in the next line. */
15013 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15014 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15015 && !row
->ends_at_zv_p
15016 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15019 else if (PT
< XFASTINT (w
->last_point
))
15021 /* Cursor has to be moved backward. Note that PT >=
15022 CHARPOS (startp) because of the outer if-statement. */
15023 while (!row
->mode_line_p
15024 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15025 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15026 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15027 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15028 row
> w
->current_matrix
->rows
15029 && (row
-1)->ends_in_newline_from_string_p
))))
15030 && (row
->y
> top_scroll_margin
15031 || CHARPOS (startp
) == BEGV
))
15033 xassert (row
->enabled_p
);
15037 /* Consider the following case: Window starts at BEGV,
15038 there is invisible, intangible text at BEGV, so that
15039 display starts at some point START > BEGV. It can
15040 happen that we are called with PT somewhere between
15041 BEGV and START. Try to handle that case. */
15042 if (row
< w
->current_matrix
->rows
15043 || row
->mode_line_p
)
15045 row
= w
->current_matrix
->rows
;
15046 if (row
->mode_line_p
)
15050 /* Due to newlines in overlay strings, we may have to
15051 skip forward over overlay strings. */
15052 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15053 && MATRIX_ROW_END_CHARPOS (row
) == PT
15054 && !cursor_row_p (row
))
15057 /* If within the scroll margin, scroll. */
15058 if (row
->y
< top_scroll_margin
15059 && CHARPOS (startp
) != BEGV
)
15064 /* Cursor did not move. So don't scroll even if cursor line
15065 is partially visible, as it was so before. */
15066 rc
= CURSOR_MOVEMENT_SUCCESS
;
15069 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15070 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15072 /* if PT is not in the glyph row, give up. */
15073 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15076 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15077 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15079 struct glyph_row
*row1
;
15081 /* If rows are bidi-reordered and point moved, back up
15082 until we find a row that does not belong to a
15083 continuation line. This is because we must consider
15084 all rows of a continued line as candidates for the
15085 new cursor positioning, since row start and end
15086 positions change non-linearly with vertical position
15088 /* FIXME: Revisit this when glyph ``spilling'' in
15089 continuation lines' rows is implemented for
15090 bidi-reordered rows. */
15091 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15092 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15095 /* If we hit the beginning of the displayed portion
15096 without finding the first row of a continued
15100 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15103 xassert (row
->enabled_p
);
15108 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15109 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15110 /* Make sure this isn't a header line by any chance, since
15111 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15112 && !row
->mode_line_p
15113 && make_cursor_line_fully_visible_p
)
15115 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15116 && !row
->ends_at_zv_p
15117 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15118 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15119 else if (row
->height
> window_box_height (w
))
15121 /* If we end up in a partially visible line, let's
15122 make it fully visible, except when it's taller
15123 than the window, in which case we can't do much
15126 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15130 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15131 if (!cursor_row_fully_visible_p (w
, 0, 1))
15132 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15134 rc
= CURSOR_MOVEMENT_SUCCESS
;
15138 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15139 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15140 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15142 /* With bidi-reordered rows, there could be more than
15143 one candidate row whose start and end positions
15144 occlude point. We need to let set_cursor_from_row
15145 find the best candidate. */
15146 /* FIXME: Revisit this when glyph ``spilling'' in
15147 continuation lines' rows is implemented for
15148 bidi-reordered rows. */
15153 int at_zv_p
= 0, exact_match_p
= 0;
15155 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15156 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15157 && cursor_row_p (row
))
15158 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15160 /* As soon as we've found the exact match for point,
15161 or the first suitable row whose ends_at_zv_p flag
15162 is set, we are done. */
15164 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15166 && w
->cursor
.hpos
>= 0
15167 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15170 struct glyph_row
*candidate
=
15171 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15173 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15174 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15177 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15178 || (INTEGERP (g
->object
)
15179 && (g
->charpos
== PT
15180 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15182 if (rv
&& (at_zv_p
|| exact_match_p
))
15184 rc
= CURSOR_MOVEMENT_SUCCESS
;
15187 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15191 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15192 || row
->continued_p
)
15193 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15194 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15195 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15196 /* If we didn't find any candidate rows, or exited the
15197 loop before all the candidates were examined, signal
15198 to the caller that this method failed. */
15199 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15201 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15202 && !row
->continued_p
))
15203 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15205 rc
= CURSOR_MOVEMENT_SUCCESS
;
15211 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15213 rc
= CURSOR_MOVEMENT_SUCCESS
;
15218 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15219 && MATRIX_ROW_START_CHARPOS (row
) == PT
15220 && cursor_row_p (row
));
15228 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15232 set_vertical_scroll_bar (struct window
*w
)
15234 ptrdiff_t start
, end
, whole
;
15236 /* Calculate the start and end positions for the current window.
15237 At some point, it would be nice to choose between scrollbars
15238 which reflect the whole buffer size, with special markers
15239 indicating narrowing, and scrollbars which reflect only the
15242 Note that mini-buffers sometimes aren't displaying any text. */
15243 if (!MINI_WINDOW_P (w
)
15244 || (w
== XWINDOW (minibuf_window
)
15245 && NILP (echo_area_buffer
[0])))
15247 struct buffer
*buf
= XBUFFER (w
->buffer
);
15248 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15249 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15250 /* I don't think this is guaranteed to be right. For the
15251 moment, we'll pretend it is. */
15252 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15256 if (whole
< (end
- start
))
15257 whole
= end
- start
;
15260 start
= end
= whole
= 0;
15262 /* Indicate what this scroll bar ought to be displaying now. */
15263 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15264 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15265 (w
, end
- start
, whole
, start
);
15269 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15270 selected_window is redisplayed.
15272 We can return without actually redisplaying the window if
15273 fonts_changed_p is nonzero. In that case, redisplay_internal will
15277 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15279 struct window
*w
= XWINDOW (window
);
15280 struct frame
*f
= XFRAME (w
->frame
);
15281 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15282 struct buffer
*old
= current_buffer
;
15283 struct text_pos lpoint
, opoint
, startp
;
15284 int update_mode_line
;
15287 /* Record it now because it's overwritten. */
15288 int current_matrix_up_to_date_p
= 0;
15289 int used_current_matrix_p
= 0;
15290 /* This is less strict than current_matrix_up_to_date_p.
15291 It indicates that the buffer contents and narrowing are unchanged. */
15292 int buffer_unchanged_p
= 0;
15293 int temp_scroll_step
= 0;
15294 ptrdiff_t count
= SPECPDL_INDEX ();
15296 int centering_position
= -1;
15297 int last_line_misfit
= 0;
15298 ptrdiff_t beg_unchanged
, end_unchanged
;
15300 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15303 /* W must be a leaf window here. */
15304 xassert (!NILP (w
->buffer
));
15306 *w
->desired_matrix
->method
= 0;
15310 reconsider_clip_changes (w
, buffer
);
15312 /* Has the mode line to be updated? */
15313 update_mode_line
= (w
->update_mode_line
15314 || update_mode_lines
15315 || buffer
->clip_changed
15316 || buffer
->prevent_redisplay_optimizations_p
);
15318 if (MINI_WINDOW_P (w
))
15320 if (w
== XWINDOW (echo_area_window
)
15321 && !NILP (echo_area_buffer
[0]))
15323 if (update_mode_line
)
15324 /* We may have to update a tty frame's menu bar or a
15325 tool-bar. Example `M-x C-h C-h C-g'. */
15326 goto finish_menu_bars
;
15328 /* We've already displayed the echo area glyphs in this window. */
15329 goto finish_scroll_bars
;
15331 else if ((w
!= XWINDOW (minibuf_window
)
15332 || minibuf_level
== 0)
15333 /* When buffer is nonempty, redisplay window normally. */
15334 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15335 /* Quail displays non-mini buffers in minibuffer window.
15336 In that case, redisplay the window normally. */
15337 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15339 /* W is a mini-buffer window, but it's not active, so clear
15341 int yb
= window_text_bottom_y (w
);
15342 struct glyph_row
*row
;
15345 for (y
= 0, row
= w
->desired_matrix
->rows
;
15347 y
+= row
->height
, ++row
)
15348 blank_row (w
, row
, y
);
15349 goto finish_scroll_bars
;
15352 clear_glyph_matrix (w
->desired_matrix
);
15355 /* Otherwise set up data on this window; select its buffer and point
15357 /* Really select the buffer, for the sake of buffer-local
15359 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15361 current_matrix_up_to_date_p
15362 = (!NILP (w
->window_end_valid
)
15363 && !current_buffer
->clip_changed
15364 && !current_buffer
->prevent_redisplay_optimizations_p
15365 && XFASTINT (w
->last_modified
) >= MODIFF
15366 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15368 /* Run the window-bottom-change-functions
15369 if it is possible that the text on the screen has changed
15370 (either due to modification of the text, or any other reason). */
15371 if (!current_matrix_up_to_date_p
15372 && !NILP (Vwindow_text_change_functions
))
15374 safe_run_hooks (Qwindow_text_change_functions
);
15378 beg_unchanged
= BEG_UNCHANGED
;
15379 end_unchanged
= END_UNCHANGED
;
15381 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15383 specbind (Qinhibit_point_motion_hooks
, Qt
);
15386 = (!NILP (w
->window_end_valid
)
15387 && !current_buffer
->clip_changed
15388 && XFASTINT (w
->last_modified
) >= MODIFF
15389 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15391 /* When windows_or_buffers_changed is non-zero, we can't rely on
15392 the window end being valid, so set it to nil there. */
15393 if (windows_or_buffers_changed
)
15395 /* If window starts on a continuation line, maybe adjust the
15396 window start in case the window's width changed. */
15397 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15398 compute_window_start_on_continuation_line (w
);
15400 w
->window_end_valid
= Qnil
;
15403 /* Some sanity checks. */
15404 CHECK_WINDOW_END (w
);
15405 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15407 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15410 /* If %c is in mode line, update it if needed. */
15411 if (!NILP (w
->column_number_displayed
)
15412 /* This alternative quickly identifies a common case
15413 where no change is needed. */
15414 && !(PT
== XFASTINT (w
->last_point
)
15415 && XFASTINT (w
->last_modified
) >= MODIFF
15416 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15417 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15418 update_mode_line
= 1;
15420 /* Count number of windows showing the selected buffer. An indirect
15421 buffer counts as its base buffer. */
15422 if (!just_this_one_p
)
15424 struct buffer
*current_base
, *window_base
;
15425 current_base
= current_buffer
;
15426 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15427 if (current_base
->base_buffer
)
15428 current_base
= current_base
->base_buffer
;
15429 if (window_base
->base_buffer
)
15430 window_base
= window_base
->base_buffer
;
15431 if (current_base
== window_base
)
15435 /* Point refers normally to the selected window. For any other
15436 window, set up appropriate value. */
15437 if (!EQ (window
, selected_window
))
15439 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15440 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15444 new_pt_byte
= BEGV_BYTE
;
15445 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15447 else if (new_pt
> (ZV
- 1))
15450 new_pt_byte
= ZV_BYTE
;
15451 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15454 /* We don't use SET_PT so that the point-motion hooks don't run. */
15455 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15458 /* If any of the character widths specified in the display table
15459 have changed, invalidate the width run cache. It's true that
15460 this may be a bit late to catch such changes, but the rest of
15461 redisplay goes (non-fatally) haywire when the display table is
15462 changed, so why should we worry about doing any better? */
15463 if (current_buffer
->width_run_cache
)
15465 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15467 if (! disptab_matches_widthtab (disptab
,
15468 XVECTOR (BVAR (current_buffer
, width_table
))))
15470 invalidate_region_cache (current_buffer
,
15471 current_buffer
->width_run_cache
,
15473 recompute_width_table (current_buffer
, disptab
);
15477 /* If window-start is screwed up, choose a new one. */
15478 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15481 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15483 /* If someone specified a new starting point but did not insist,
15484 check whether it can be used. */
15485 if (w
->optional_new_start
15486 && CHARPOS (startp
) >= BEGV
15487 && CHARPOS (startp
) <= ZV
)
15489 w
->optional_new_start
= 0;
15490 start_display (&it
, w
, startp
);
15491 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15492 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15493 if (IT_CHARPOS (it
) == PT
)
15494 w
->force_start
= 1;
15495 /* IT may overshoot PT if text at PT is invisible. */
15496 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15497 w
->force_start
= 1;
15502 /* Handle case where place to start displaying has been specified,
15503 unless the specified location is outside the accessible range. */
15504 if (w
->force_start
|| w
->frozen_window_start_p
)
15506 /* We set this later on if we have to adjust point. */
15509 w
->force_start
= 0;
15511 w
->window_end_valid
= Qnil
;
15513 /* Forget any recorded base line for line number display. */
15514 if (!buffer_unchanged_p
)
15515 w
->base_line_number
= Qnil
;
15517 /* Redisplay the mode line. Select the buffer properly for that.
15518 Also, run the hook window-scroll-functions
15519 because we have scrolled. */
15520 /* Note, we do this after clearing force_start because
15521 if there's an error, it is better to forget about force_start
15522 than to get into an infinite loop calling the hook functions
15523 and having them get more errors. */
15524 if (!update_mode_line
15525 || ! NILP (Vwindow_scroll_functions
))
15527 update_mode_line
= 1;
15528 w
->update_mode_line
= 1;
15529 startp
= run_window_scroll_functions (window
, startp
);
15532 w
->last_modified
= make_number (0);
15533 w
->last_overlay_modified
= make_number (0);
15534 if (CHARPOS (startp
) < BEGV
)
15535 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15536 else if (CHARPOS (startp
) > ZV
)
15537 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15539 /* Redisplay, then check if cursor has been set during the
15540 redisplay. Give up if new fonts were loaded. */
15541 /* We used to issue a CHECK_MARGINS argument to try_window here,
15542 but this causes scrolling to fail when point begins inside
15543 the scroll margin (bug#148) -- cyd */
15544 if (!try_window (window
, startp
, 0))
15546 w
->force_start
= 1;
15547 clear_glyph_matrix (w
->desired_matrix
);
15548 goto need_larger_matrices
;
15551 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15553 /* If point does not appear, try to move point so it does
15554 appear. The desired matrix has been built above, so we
15555 can use it here. */
15556 new_vpos
= window_box_height (w
) / 2;
15559 if (!cursor_row_fully_visible_p (w
, 0, 0))
15561 /* Point does appear, but on a line partly visible at end of window.
15562 Move it back to a fully-visible line. */
15563 new_vpos
= window_box_height (w
);
15566 /* If we need to move point for either of the above reasons,
15567 now actually do it. */
15570 struct glyph_row
*row
;
15572 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15573 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15576 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15577 MATRIX_ROW_START_BYTEPOS (row
));
15579 if (w
!= XWINDOW (selected_window
))
15580 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15581 else if (current_buffer
== old
)
15582 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15584 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15586 /* If we are highlighting the region, then we just changed
15587 the region, so redisplay to show it. */
15588 if (!NILP (Vtransient_mark_mode
)
15589 && !NILP (BVAR (current_buffer
, mark_active
)))
15591 clear_glyph_matrix (w
->desired_matrix
);
15592 if (!try_window (window
, startp
, 0))
15593 goto need_larger_matrices
;
15598 debug_method_add (w
, "forced window start");
15603 /* Handle case where text has not changed, only point, and it has
15604 not moved off the frame, and we are not retrying after hscroll.
15605 (current_matrix_up_to_date_p is nonzero when retrying.) */
15606 if (current_matrix_up_to_date_p
15607 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15608 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15612 case CURSOR_MOVEMENT_SUCCESS
:
15613 used_current_matrix_p
= 1;
15616 case CURSOR_MOVEMENT_MUST_SCROLL
:
15617 goto try_to_scroll
;
15623 /* If current starting point was originally the beginning of a line
15624 but no longer is, find a new starting point. */
15625 else if (w
->start_at_line_beg
15626 && !(CHARPOS (startp
) <= BEGV
15627 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15630 debug_method_add (w
, "recenter 1");
15635 /* Try scrolling with try_window_id. Value is > 0 if update has
15636 been done, it is -1 if we know that the same window start will
15637 not work. It is 0 if unsuccessful for some other reason. */
15638 else if ((tem
= try_window_id (w
)) != 0)
15641 debug_method_add (w
, "try_window_id %d", tem
);
15644 if (fonts_changed_p
)
15645 goto need_larger_matrices
;
15649 /* Otherwise try_window_id has returned -1 which means that we
15650 don't want the alternative below this comment to execute. */
15652 else if (CHARPOS (startp
) >= BEGV
15653 && CHARPOS (startp
) <= ZV
15654 && PT
>= CHARPOS (startp
)
15655 && (CHARPOS (startp
) < ZV
15656 /* Avoid starting at end of buffer. */
15657 || CHARPOS (startp
) == BEGV
15658 || (XFASTINT (w
->last_modified
) >= MODIFF
15659 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15661 int d1
, d2
, d3
, d4
, d5
, d6
;
15663 /* If first window line is a continuation line, and window start
15664 is inside the modified region, but the first change is before
15665 current window start, we must select a new window start.
15667 However, if this is the result of a down-mouse event (e.g. by
15668 extending the mouse-drag-overlay), we don't want to select a
15669 new window start, since that would change the position under
15670 the mouse, resulting in an unwanted mouse-movement rather
15671 than a simple mouse-click. */
15672 if (!w
->start_at_line_beg
15673 && NILP (do_mouse_tracking
)
15674 && CHARPOS (startp
) > BEGV
15675 && CHARPOS (startp
) > BEG
+ beg_unchanged
15676 && CHARPOS (startp
) <= Z
- end_unchanged
15677 /* Even if w->start_at_line_beg is nil, a new window may
15678 start at a line_beg, since that's how set_buffer_window
15679 sets it. So, we need to check the return value of
15680 compute_window_start_on_continuation_line. (See also
15682 && XMARKER (w
->start
)->buffer
== current_buffer
15683 && compute_window_start_on_continuation_line (w
)
15684 /* It doesn't make sense to force the window start like we
15685 do at label force_start if it is already known that point
15686 will not be visible in the resulting window, because
15687 doing so will move point from its correct position
15688 instead of scrolling the window to bring point into view.
15690 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15692 w
->force_start
= 1;
15693 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15698 debug_method_add (w
, "same window start");
15701 /* Try to redisplay starting at same place as before.
15702 If point has not moved off frame, accept the results. */
15703 if (!current_matrix_up_to_date_p
15704 /* Don't use try_window_reusing_current_matrix in this case
15705 because a window scroll function can have changed the
15707 || !NILP (Vwindow_scroll_functions
)
15708 || MINI_WINDOW_P (w
)
15709 || !(used_current_matrix_p
15710 = try_window_reusing_current_matrix (w
)))
15712 IF_DEBUG (debug_method_add (w
, "1"));
15713 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15714 /* -1 means we need to scroll.
15715 0 means we need new matrices, but fonts_changed_p
15716 is set in that case, so we will detect it below. */
15717 goto try_to_scroll
;
15720 if (fonts_changed_p
)
15721 goto need_larger_matrices
;
15723 if (w
->cursor
.vpos
>= 0)
15725 if (!just_this_one_p
15726 || current_buffer
->clip_changed
15727 || BEG_UNCHANGED
< CHARPOS (startp
))
15728 /* Forget any recorded base line for line number display. */
15729 w
->base_line_number
= Qnil
;
15731 if (!cursor_row_fully_visible_p (w
, 1, 0))
15733 clear_glyph_matrix (w
->desired_matrix
);
15734 last_line_misfit
= 1;
15736 /* Drop through and scroll. */
15741 clear_glyph_matrix (w
->desired_matrix
);
15746 w
->last_modified
= make_number (0);
15747 w
->last_overlay_modified
= make_number (0);
15749 /* Redisplay the mode line. Select the buffer properly for that. */
15750 if (!update_mode_line
)
15752 update_mode_line
= 1;
15753 w
->update_mode_line
= 1;
15756 /* Try to scroll by specified few lines. */
15757 if ((scroll_conservatively
15758 || emacs_scroll_step
15759 || temp_scroll_step
15760 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15761 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15762 && CHARPOS (startp
) >= BEGV
15763 && CHARPOS (startp
) <= ZV
)
15765 /* The function returns -1 if new fonts were loaded, 1 if
15766 successful, 0 if not successful. */
15767 int ss
= try_scrolling (window
, just_this_one_p
,
15768 scroll_conservatively
,
15770 temp_scroll_step
, last_line_misfit
);
15773 case SCROLLING_SUCCESS
:
15776 case SCROLLING_NEED_LARGER_MATRICES
:
15777 goto need_larger_matrices
;
15779 case SCROLLING_FAILED
:
15787 /* Finally, just choose a place to start which positions point
15788 according to user preferences. */
15793 debug_method_add (w
, "recenter");
15796 /* w->vscroll = 0; */
15798 /* Forget any previously recorded base line for line number display. */
15799 if (!buffer_unchanged_p
)
15800 w
->base_line_number
= Qnil
;
15802 /* Determine the window start relative to point. */
15803 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15804 it
.current_y
= it
.last_visible_y
;
15805 if (centering_position
< 0)
15809 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15811 ptrdiff_t margin_pos
= CHARPOS (startp
);
15812 Lisp_Object aggressive
;
15815 /* If there is a scroll margin at the top of the window, find
15816 its character position. */
15818 /* Cannot call start_display if startp is not in the
15819 accessible region of the buffer. This can happen when we
15820 have just switched to a different buffer and/or changed
15821 its restriction. In that case, startp is initialized to
15822 the character position 1 (BEGV) because we did not yet
15823 have chance to display the buffer even once. */
15824 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15827 void *it1data
= NULL
;
15829 SAVE_IT (it1
, it
, it1data
);
15830 start_display (&it1
, w
, startp
);
15831 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15832 margin_pos
= IT_CHARPOS (it1
);
15833 RESTORE_IT (&it
, &it
, it1data
);
15835 scrolling_up
= PT
> margin_pos
;
15838 ? BVAR (current_buffer
, scroll_up_aggressively
)
15839 : BVAR (current_buffer
, scroll_down_aggressively
);
15841 if (!MINI_WINDOW_P (w
)
15842 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15846 /* Setting scroll-conservatively overrides
15847 scroll-*-aggressively. */
15848 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15850 double float_amount
= XFLOATINT (aggressive
);
15852 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15853 if (pt_offset
== 0 && float_amount
> 0)
15855 if (pt_offset
&& margin
> 0)
15858 /* Compute how much to move the window start backward from
15859 point so that point will be displayed where the user
15863 centering_position
= it
.last_visible_y
;
15865 centering_position
-= pt_offset
;
15866 centering_position
-=
15867 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15868 + WINDOW_HEADER_LINE_HEIGHT (w
);
15869 /* Don't let point enter the scroll margin near top of
15871 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15872 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15875 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15878 /* Set the window start half the height of the window backward
15880 centering_position
= window_box_height (w
) / 2;
15882 move_it_vertically_backward (&it
, centering_position
);
15884 xassert (IT_CHARPOS (it
) >= BEGV
);
15886 /* The function move_it_vertically_backward may move over more
15887 than the specified y-distance. If it->w is small, e.g. a
15888 mini-buffer window, we may end up in front of the window's
15889 display area. Start displaying at the start of the line
15890 containing PT in this case. */
15891 if (it
.current_y
<= 0)
15893 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15894 move_it_vertically_backward (&it
, 0);
15898 it
.current_x
= it
.hpos
= 0;
15900 /* Set the window start position here explicitly, to avoid an
15901 infinite loop in case the functions in window-scroll-functions
15903 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15905 /* Run scroll hooks. */
15906 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15908 /* Redisplay the window. */
15909 if (!current_matrix_up_to_date_p
15910 || windows_or_buffers_changed
15911 || cursor_type_changed
15912 /* Don't use try_window_reusing_current_matrix in this case
15913 because it can have changed the buffer. */
15914 || !NILP (Vwindow_scroll_functions
)
15915 || !just_this_one_p
15916 || MINI_WINDOW_P (w
)
15917 || !(used_current_matrix_p
15918 = try_window_reusing_current_matrix (w
)))
15919 try_window (window
, startp
, 0);
15921 /* If new fonts have been loaded (due to fontsets), give up. We
15922 have to start a new redisplay since we need to re-adjust glyph
15924 if (fonts_changed_p
)
15925 goto need_larger_matrices
;
15927 /* If cursor did not appear assume that the middle of the window is
15928 in the first line of the window. Do it again with the next line.
15929 (Imagine a window of height 100, displaying two lines of height
15930 60. Moving back 50 from it->last_visible_y will end in the first
15932 if (w
->cursor
.vpos
< 0)
15934 if (!NILP (w
->window_end_valid
)
15935 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15937 clear_glyph_matrix (w
->desired_matrix
);
15938 move_it_by_lines (&it
, 1);
15939 try_window (window
, it
.current
.pos
, 0);
15941 else if (PT
< IT_CHARPOS (it
))
15943 clear_glyph_matrix (w
->desired_matrix
);
15944 move_it_by_lines (&it
, -1);
15945 try_window (window
, it
.current
.pos
, 0);
15949 /* Not much we can do about it. */
15953 /* Consider the following case: Window starts at BEGV, there is
15954 invisible, intangible text at BEGV, so that display starts at
15955 some point START > BEGV. It can happen that we are called with
15956 PT somewhere between BEGV and START. Try to handle that case. */
15957 if (w
->cursor
.vpos
< 0)
15959 struct glyph_row
*row
= w
->current_matrix
->rows
;
15960 if (row
->mode_line_p
)
15962 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15965 if (!cursor_row_fully_visible_p (w
, 0, 0))
15967 /* If vscroll is enabled, disable it and try again. */
15971 clear_glyph_matrix (w
->desired_matrix
);
15975 /* Users who set scroll-conservatively to a large number want
15976 point just above/below the scroll margin. If we ended up
15977 with point's row partially visible, move the window start to
15978 make that row fully visible and out of the margin. */
15979 if (scroll_conservatively
> SCROLL_LIMIT
)
15983 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15985 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15987 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15988 clear_glyph_matrix (w
->desired_matrix
);
15989 if (1 == try_window (window
, it
.current
.pos
,
15990 TRY_WINDOW_CHECK_MARGINS
))
15994 /* If centering point failed to make the whole line visible,
15995 put point at the top instead. That has to make the whole line
15996 visible, if it can be done. */
15997 if (centering_position
== 0)
16000 clear_glyph_matrix (w
->desired_matrix
);
16001 centering_position
= 0;
16007 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16008 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16009 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16011 /* Display the mode line, if we must. */
16012 if ((update_mode_line
16013 /* If window not full width, must redo its mode line
16014 if (a) the window to its side is being redone and
16015 (b) we do a frame-based redisplay. This is a consequence
16016 of how inverted lines are drawn in frame-based redisplay. */
16017 || (!just_this_one_p
16018 && !FRAME_WINDOW_P (f
)
16019 && !WINDOW_FULL_WIDTH_P (w
))
16020 /* Line number to display. */
16021 || INTEGERP (w
->base_line_pos
)
16022 /* Column number is displayed and different from the one displayed. */
16023 || (!NILP (w
->column_number_displayed
)
16024 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16025 /* This means that the window has a mode line. */
16026 && (WINDOW_WANTS_MODELINE_P (w
)
16027 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16029 display_mode_lines (w
);
16031 /* If mode line height has changed, arrange for a thorough
16032 immediate redisplay using the correct mode line height. */
16033 if (WINDOW_WANTS_MODELINE_P (w
)
16034 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16036 fonts_changed_p
= 1;
16037 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16038 = DESIRED_MODE_LINE_HEIGHT (w
);
16041 /* If header line height has changed, arrange for a thorough
16042 immediate redisplay using the correct header line height. */
16043 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16044 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16046 fonts_changed_p
= 1;
16047 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16048 = DESIRED_HEADER_LINE_HEIGHT (w
);
16051 if (fonts_changed_p
)
16052 goto need_larger_matrices
;
16055 if (!line_number_displayed
16056 && !BUFFERP (w
->base_line_pos
))
16058 w
->base_line_pos
= Qnil
;
16059 w
->base_line_number
= Qnil
;
16064 /* When we reach a frame's selected window, redo the frame's menu bar. */
16065 if (update_mode_line
16066 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16068 int redisplay_menu_p
= 0;
16070 if (FRAME_WINDOW_P (f
))
16072 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16073 || defined (HAVE_NS) || defined (USE_GTK)
16074 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16076 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16080 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16082 if (redisplay_menu_p
)
16083 display_menu_bar (w
);
16085 #ifdef HAVE_WINDOW_SYSTEM
16086 if (FRAME_WINDOW_P (f
))
16088 #if defined (USE_GTK) || defined (HAVE_NS)
16089 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16090 redisplay_tool_bar (f
);
16092 if (WINDOWP (f
->tool_bar_window
)
16093 && (FRAME_TOOL_BAR_LINES (f
) > 0
16094 || !NILP (Vauto_resize_tool_bars
))
16095 && redisplay_tool_bar (f
))
16096 ignore_mouse_drag_p
= 1;
16102 #ifdef HAVE_WINDOW_SYSTEM
16103 if (FRAME_WINDOW_P (f
)
16104 && update_window_fringes (w
, (just_this_one_p
16105 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16106 || w
->pseudo_window_p
)))
16110 if (draw_window_fringes (w
, 1))
16111 x_draw_vertical_border (w
);
16115 #endif /* HAVE_WINDOW_SYSTEM */
16117 /* We go to this label, with fonts_changed_p nonzero,
16118 if it is necessary to try again using larger glyph matrices.
16119 We have to redeem the scroll bar even in this case,
16120 because the loop in redisplay_internal expects that. */
16121 need_larger_matrices
:
16123 finish_scroll_bars
:
16125 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16127 /* Set the thumb's position and size. */
16128 set_vertical_scroll_bar (w
);
16130 /* Note that we actually used the scroll bar attached to this
16131 window, so it shouldn't be deleted at the end of redisplay. */
16132 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16133 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16136 /* Restore current_buffer and value of point in it. The window
16137 update may have changed the buffer, so first make sure `opoint'
16138 is still valid (Bug#6177). */
16139 if (CHARPOS (opoint
) < BEGV
)
16140 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16141 else if (CHARPOS (opoint
) > ZV
)
16142 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16144 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16146 set_buffer_internal_1 (old
);
16147 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16148 shorter. This can be caused by log truncation in *Messages*. */
16149 if (CHARPOS (lpoint
) <= ZV
)
16150 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16152 unbind_to (count
, Qnil
);
16156 /* Build the complete desired matrix of WINDOW with a window start
16157 buffer position POS.
16159 Value is 1 if successful. It is zero if fonts were loaded during
16160 redisplay which makes re-adjusting glyph matrices necessary, and -1
16161 if point would appear in the scroll margins.
16162 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16163 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16167 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16169 struct window
*w
= XWINDOW (window
);
16171 struct glyph_row
*last_text_row
= NULL
;
16172 struct frame
*f
= XFRAME (w
->frame
);
16174 /* Make POS the new window start. */
16175 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16177 /* Mark cursor position as unknown. No overlay arrow seen. */
16178 w
->cursor
.vpos
= -1;
16179 overlay_arrow_seen
= 0;
16181 /* Initialize iterator and info to start at POS. */
16182 start_display (&it
, w
, pos
);
16184 /* Display all lines of W. */
16185 while (it
.current_y
< it
.last_visible_y
)
16187 if (display_line (&it
))
16188 last_text_row
= it
.glyph_row
- 1;
16189 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16193 /* Don't let the cursor end in the scroll margins. */
16194 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16195 && !MINI_WINDOW_P (w
))
16197 int this_scroll_margin
;
16199 if (scroll_margin
> 0)
16201 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16202 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16205 this_scroll_margin
= 0;
16207 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16208 && w
->cursor
.y
< this_scroll_margin
16209 && CHARPOS (pos
) > BEGV
16210 && IT_CHARPOS (it
) < ZV
)
16211 /* rms: considering make_cursor_line_fully_visible_p here
16212 seems to give wrong results. We don't want to recenter
16213 when the last line is partly visible, we want to allow
16214 that case to be handled in the usual way. */
16215 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16217 w
->cursor
.vpos
= -1;
16218 clear_glyph_matrix (w
->desired_matrix
);
16223 /* If bottom moved off end of frame, change mode line percentage. */
16224 if (XFASTINT (w
->window_end_pos
) <= 0
16225 && Z
!= IT_CHARPOS (it
))
16226 w
->update_mode_line
= 1;
16228 /* Set window_end_pos to the offset of the last character displayed
16229 on the window from the end of current_buffer. Set
16230 window_end_vpos to its row number. */
16233 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16234 w
->window_end_bytepos
16235 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16237 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16239 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16240 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16241 ->displays_text_p
);
16245 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16246 w
->window_end_pos
= make_number (Z
- ZV
);
16247 w
->window_end_vpos
= make_number (0);
16250 /* But that is not valid info until redisplay finishes. */
16251 w
->window_end_valid
= Qnil
;
16257 /************************************************************************
16258 Window redisplay reusing current matrix when buffer has not changed
16259 ************************************************************************/
16261 /* Try redisplay of window W showing an unchanged buffer with a
16262 different window start than the last time it was displayed by
16263 reusing its current matrix. Value is non-zero if successful.
16264 W->start is the new window start. */
16267 try_window_reusing_current_matrix (struct window
*w
)
16269 struct frame
*f
= XFRAME (w
->frame
);
16270 struct glyph_row
*bottom_row
;
16273 struct text_pos start
, new_start
;
16274 int nrows_scrolled
, i
;
16275 struct glyph_row
*last_text_row
;
16276 struct glyph_row
*last_reused_text_row
;
16277 struct glyph_row
*start_row
;
16278 int start_vpos
, min_y
, max_y
;
16281 if (inhibit_try_window_reusing
)
16285 if (/* This function doesn't handle terminal frames. */
16286 !FRAME_WINDOW_P (f
)
16287 /* Don't try to reuse the display if windows have been split
16289 || windows_or_buffers_changed
16290 || cursor_type_changed
)
16293 /* Can't do this if region may have changed. */
16294 if ((!NILP (Vtransient_mark_mode
)
16295 && !NILP (BVAR (current_buffer
, mark_active
)))
16296 || !NILP (w
->region_showing
)
16297 || !NILP (Vshow_trailing_whitespace
))
16300 /* If top-line visibility has changed, give up. */
16301 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16302 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16305 /* Give up if old or new display is scrolled vertically. We could
16306 make this function handle this, but right now it doesn't. */
16307 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16308 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16311 /* The variable new_start now holds the new window start. The old
16312 start `start' can be determined from the current matrix. */
16313 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16314 start
= start_row
->minpos
;
16315 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16317 /* Clear the desired matrix for the display below. */
16318 clear_glyph_matrix (w
->desired_matrix
);
16320 if (CHARPOS (new_start
) <= CHARPOS (start
))
16322 /* Don't use this method if the display starts with an ellipsis
16323 displayed for invisible text. It's not easy to handle that case
16324 below, and it's certainly not worth the effort since this is
16325 not a frequent case. */
16326 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16329 IF_DEBUG (debug_method_add (w
, "twu1"));
16331 /* Display up to a row that can be reused. The variable
16332 last_text_row is set to the last row displayed that displays
16333 text. Note that it.vpos == 0 if or if not there is a
16334 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16335 start_display (&it
, w
, new_start
);
16336 w
->cursor
.vpos
= -1;
16337 last_text_row
= last_reused_text_row
= NULL
;
16339 while (it
.current_y
< it
.last_visible_y
16340 && !fonts_changed_p
)
16342 /* If we have reached into the characters in the START row,
16343 that means the line boundaries have changed. So we
16344 can't start copying with the row START. Maybe it will
16345 work to start copying with the following row. */
16346 while (IT_CHARPOS (it
) > CHARPOS (start
))
16348 /* Advance to the next row as the "start". */
16350 start
= start_row
->minpos
;
16351 /* If there are no more rows to try, or just one, give up. */
16352 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16353 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16354 || CHARPOS (start
) == ZV
)
16356 clear_glyph_matrix (w
->desired_matrix
);
16360 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16362 /* If we have reached alignment, we can copy the rest of the
16364 if (IT_CHARPOS (it
) == CHARPOS (start
)
16365 /* Don't accept "alignment" inside a display vector,
16366 since start_row could have started in the middle of
16367 that same display vector (thus their character
16368 positions match), and we have no way of telling if
16369 that is the case. */
16370 && it
.current
.dpvec_index
< 0)
16373 if (display_line (&it
))
16374 last_text_row
= it
.glyph_row
- 1;
16378 /* A value of current_y < last_visible_y means that we stopped
16379 at the previous window start, which in turn means that we
16380 have at least one reusable row. */
16381 if (it
.current_y
< it
.last_visible_y
)
16383 struct glyph_row
*row
;
16385 /* IT.vpos always starts from 0; it counts text lines. */
16386 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16388 /* Find PT if not already found in the lines displayed. */
16389 if (w
->cursor
.vpos
< 0)
16391 int dy
= it
.current_y
- start_row
->y
;
16393 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16394 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16396 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16397 dy
, nrows_scrolled
);
16400 clear_glyph_matrix (w
->desired_matrix
);
16405 /* Scroll the display. Do it before the current matrix is
16406 changed. The problem here is that update has not yet
16407 run, i.e. part of the current matrix is not up to date.
16408 scroll_run_hook will clear the cursor, and use the
16409 current matrix to get the height of the row the cursor is
16411 run
.current_y
= start_row
->y
;
16412 run
.desired_y
= it
.current_y
;
16413 run
.height
= it
.last_visible_y
- it
.current_y
;
16415 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16418 FRAME_RIF (f
)->update_window_begin_hook (w
);
16419 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16420 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16421 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16425 /* Shift current matrix down by nrows_scrolled lines. */
16426 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16427 rotate_matrix (w
->current_matrix
,
16429 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16432 /* Disable lines that must be updated. */
16433 for (i
= 0; i
< nrows_scrolled
; ++i
)
16434 (start_row
+ i
)->enabled_p
= 0;
16436 /* Re-compute Y positions. */
16437 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16438 max_y
= it
.last_visible_y
;
16439 for (row
= start_row
+ nrows_scrolled
;
16443 row
->y
= it
.current_y
;
16444 row
->visible_height
= row
->height
;
16446 if (row
->y
< min_y
)
16447 row
->visible_height
-= min_y
- row
->y
;
16448 if (row
->y
+ row
->height
> max_y
)
16449 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16450 if (row
->fringe_bitmap_periodic_p
)
16451 row
->redraw_fringe_bitmaps_p
= 1;
16453 it
.current_y
+= row
->height
;
16455 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16456 last_reused_text_row
= row
;
16457 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16461 /* Disable lines in the current matrix which are now
16462 below the window. */
16463 for (++row
; row
< bottom_row
; ++row
)
16464 row
->enabled_p
= row
->mode_line_p
= 0;
16467 /* Update window_end_pos etc.; last_reused_text_row is the last
16468 reused row from the current matrix containing text, if any.
16469 The value of last_text_row is the last displayed line
16470 containing text. */
16471 if (last_reused_text_row
)
16473 w
->window_end_bytepos
16474 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16476 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16478 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16479 w
->current_matrix
));
16481 else if (last_text_row
)
16483 w
->window_end_bytepos
16484 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16486 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16488 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16492 /* This window must be completely empty. */
16493 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16494 w
->window_end_pos
= make_number (Z
- ZV
);
16495 w
->window_end_vpos
= make_number (0);
16497 w
->window_end_valid
= Qnil
;
16499 /* Update hint: don't try scrolling again in update_window. */
16500 w
->desired_matrix
->no_scrolling_p
= 1;
16503 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16507 else if (CHARPOS (new_start
) > CHARPOS (start
))
16509 struct glyph_row
*pt_row
, *row
;
16510 struct glyph_row
*first_reusable_row
;
16511 struct glyph_row
*first_row_to_display
;
16513 int yb
= window_text_bottom_y (w
);
16515 /* Find the row starting at new_start, if there is one. Don't
16516 reuse a partially visible line at the end. */
16517 first_reusable_row
= start_row
;
16518 while (first_reusable_row
->enabled_p
16519 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16520 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16521 < CHARPOS (new_start
)))
16522 ++first_reusable_row
;
16524 /* Give up if there is no row to reuse. */
16525 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16526 || !first_reusable_row
->enabled_p
16527 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16528 != CHARPOS (new_start
)))
16531 /* We can reuse fully visible rows beginning with
16532 first_reusable_row to the end of the window. Set
16533 first_row_to_display to the first row that cannot be reused.
16534 Set pt_row to the row containing point, if there is any. */
16536 for (first_row_to_display
= first_reusable_row
;
16537 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16538 ++first_row_to_display
)
16540 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16541 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16542 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16543 && first_row_to_display
->ends_at_zv_p
16544 && pt_row
== NULL
)))
16545 pt_row
= first_row_to_display
;
16548 /* Start displaying at the start of first_row_to_display. */
16549 xassert (first_row_to_display
->y
< yb
);
16550 init_to_row_start (&it
, w
, first_row_to_display
);
16552 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16554 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16556 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16557 + WINDOW_HEADER_LINE_HEIGHT (w
));
16559 /* Display lines beginning with first_row_to_display in the
16560 desired matrix. Set last_text_row to the last row displayed
16561 that displays text. */
16562 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16563 if (pt_row
== NULL
)
16564 w
->cursor
.vpos
= -1;
16565 last_text_row
= NULL
;
16566 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16567 if (display_line (&it
))
16568 last_text_row
= it
.glyph_row
- 1;
16570 /* If point is in a reused row, adjust y and vpos of the cursor
16574 w
->cursor
.vpos
-= nrows_scrolled
;
16575 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16578 /* Give up if point isn't in a row displayed or reused. (This
16579 also handles the case where w->cursor.vpos < nrows_scrolled
16580 after the calls to display_line, which can happen with scroll
16581 margins. See bug#1295.) */
16582 if (w
->cursor
.vpos
< 0)
16584 clear_glyph_matrix (w
->desired_matrix
);
16588 /* Scroll the display. */
16589 run
.current_y
= first_reusable_row
->y
;
16590 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16591 run
.height
= it
.last_visible_y
- run
.current_y
;
16592 dy
= run
.current_y
- run
.desired_y
;
16597 FRAME_RIF (f
)->update_window_begin_hook (w
);
16598 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16599 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16600 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16604 /* Adjust Y positions of reused rows. */
16605 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16606 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16607 max_y
= it
.last_visible_y
;
16608 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16611 row
->visible_height
= row
->height
;
16612 if (row
->y
< min_y
)
16613 row
->visible_height
-= min_y
- row
->y
;
16614 if (row
->y
+ row
->height
> max_y
)
16615 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16616 if (row
->fringe_bitmap_periodic_p
)
16617 row
->redraw_fringe_bitmaps_p
= 1;
16620 /* Scroll the current matrix. */
16621 xassert (nrows_scrolled
> 0);
16622 rotate_matrix (w
->current_matrix
,
16624 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16627 /* Disable rows not reused. */
16628 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16629 row
->enabled_p
= 0;
16631 /* Point may have moved to a different line, so we cannot assume that
16632 the previous cursor position is valid; locate the correct row. */
16635 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16637 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16638 && !row
->ends_at_zv_p
;
16642 w
->cursor
.y
= row
->y
;
16644 if (row
< bottom_row
)
16646 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16647 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16649 /* Can't use this optimization with bidi-reordered glyph
16650 rows, unless cursor is already at point. */
16651 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16653 if (!(w
->cursor
.hpos
>= 0
16654 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16655 && BUFFERP (glyph
->object
)
16656 && glyph
->charpos
== PT
))
16661 && (!BUFFERP (glyph
->object
)
16662 || glyph
->charpos
< PT
);
16666 w
->cursor
.x
+= glyph
->pixel_width
;
16671 /* Adjust window end. A null value of last_text_row means that
16672 the window end is in reused rows which in turn means that
16673 only its vpos can have changed. */
16676 w
->window_end_bytepos
16677 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16679 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16681 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16686 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16689 w
->window_end_valid
= Qnil
;
16690 w
->desired_matrix
->no_scrolling_p
= 1;
16693 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16703 /************************************************************************
16704 Window redisplay reusing current matrix when buffer has changed
16705 ************************************************************************/
16707 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16708 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16709 ptrdiff_t *, ptrdiff_t *);
16710 static struct glyph_row
*
16711 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16712 struct glyph_row
*);
16715 /* Return the last row in MATRIX displaying text. If row START is
16716 non-null, start searching with that row. IT gives the dimensions
16717 of the display. Value is null if matrix is empty; otherwise it is
16718 a pointer to the row found. */
16720 static struct glyph_row
*
16721 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16722 struct glyph_row
*start
)
16724 struct glyph_row
*row
, *row_found
;
16726 /* Set row_found to the last row in IT->w's current matrix
16727 displaying text. The loop looks funny but think of partially
16730 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16731 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16733 xassert (row
->enabled_p
);
16735 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16744 /* Return the last row in the current matrix of W that is not affected
16745 by changes at the start of current_buffer that occurred since W's
16746 current matrix was built. Value is null if no such row exists.
16748 BEG_UNCHANGED us the number of characters unchanged at the start of
16749 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16750 first changed character in current_buffer. Characters at positions <
16751 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16752 when the current matrix was built. */
16754 static struct glyph_row
*
16755 find_last_unchanged_at_beg_row (struct window
*w
)
16757 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16758 struct glyph_row
*row
;
16759 struct glyph_row
*row_found
= NULL
;
16760 int yb
= window_text_bottom_y (w
);
16762 /* Find the last row displaying unchanged text. */
16763 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16764 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16765 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16768 if (/* If row ends before first_changed_pos, it is unchanged,
16769 except in some case. */
16770 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16771 /* When row ends in ZV and we write at ZV it is not
16773 && !row
->ends_at_zv_p
16774 /* When first_changed_pos is the end of a continued line,
16775 row is not unchanged because it may be no longer
16777 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16778 && (row
->continued_p
16779 || row
->exact_window_width_line_p
))
16780 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16781 needs to be recomputed, so don't consider this row as
16782 unchanged. This happens when the last line was
16783 bidi-reordered and was killed immediately before this
16784 redisplay cycle. In that case, ROW->end stores the
16785 buffer position of the first visual-order character of
16786 the killed text, which is now beyond ZV. */
16787 && CHARPOS (row
->end
.pos
) <= ZV
)
16790 /* Stop if last visible row. */
16791 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16799 /* Find the first glyph row in the current matrix of W that is not
16800 affected by changes at the end of current_buffer since the
16801 time W's current matrix was built.
16803 Return in *DELTA the number of chars by which buffer positions in
16804 unchanged text at the end of current_buffer must be adjusted.
16806 Return in *DELTA_BYTES the corresponding number of bytes.
16808 Value is null if no such row exists, i.e. all rows are affected by
16811 static struct glyph_row
*
16812 find_first_unchanged_at_end_row (struct window
*w
,
16813 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16815 struct glyph_row
*row
;
16816 struct glyph_row
*row_found
= NULL
;
16818 *delta
= *delta_bytes
= 0;
16820 /* Display must not have been paused, otherwise the current matrix
16821 is not up to date. */
16822 eassert (!NILP (w
->window_end_valid
));
16824 /* A value of window_end_pos >= END_UNCHANGED means that the window
16825 end is in the range of changed text. If so, there is no
16826 unchanged row at the end of W's current matrix. */
16827 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16830 /* Set row to the last row in W's current matrix displaying text. */
16831 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16833 /* If matrix is entirely empty, no unchanged row exists. */
16834 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16836 /* The value of row is the last glyph row in the matrix having a
16837 meaningful buffer position in it. The end position of row
16838 corresponds to window_end_pos. This allows us to translate
16839 buffer positions in the current matrix to current buffer
16840 positions for characters not in changed text. */
16842 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16843 ptrdiff_t Z_BYTE_old
=
16844 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16845 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16846 struct glyph_row
*first_text_row
16847 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16849 *delta
= Z
- Z_old
;
16850 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16852 /* Set last_unchanged_pos to the buffer position of the last
16853 character in the buffer that has not been changed. Z is the
16854 index + 1 of the last character in current_buffer, i.e. by
16855 subtracting END_UNCHANGED we get the index of the last
16856 unchanged character, and we have to add BEG to get its buffer
16858 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16859 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16861 /* Search backward from ROW for a row displaying a line that
16862 starts at a minimum position >= last_unchanged_pos_old. */
16863 for (; row
> first_text_row
; --row
)
16865 /* This used to abort, but it can happen.
16866 It is ok to just stop the search instead here. KFS. */
16867 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16870 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16875 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16881 /* Make sure that glyph rows in the current matrix of window W
16882 reference the same glyph memory as corresponding rows in the
16883 frame's frame matrix. This function is called after scrolling W's
16884 current matrix on a terminal frame in try_window_id and
16885 try_window_reusing_current_matrix. */
16888 sync_frame_with_window_matrix_rows (struct window
*w
)
16890 struct frame
*f
= XFRAME (w
->frame
);
16891 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16893 /* Preconditions: W must be a leaf window and full-width. Its frame
16894 must have a frame matrix. */
16895 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16896 xassert (WINDOW_FULL_WIDTH_P (w
));
16897 xassert (!FRAME_WINDOW_P (f
));
16899 /* If W is a full-width window, glyph pointers in W's current matrix
16900 have, by definition, to be the same as glyph pointers in the
16901 corresponding frame matrix. Note that frame matrices have no
16902 marginal areas (see build_frame_matrix). */
16903 window_row
= w
->current_matrix
->rows
;
16904 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16905 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16906 while (window_row
< window_row_end
)
16908 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16909 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16911 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16912 frame_row
->glyphs
[TEXT_AREA
] = start
;
16913 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16914 frame_row
->glyphs
[LAST_AREA
] = end
;
16916 /* Disable frame rows whose corresponding window rows have
16917 been disabled in try_window_id. */
16918 if (!window_row
->enabled_p
)
16919 frame_row
->enabled_p
= 0;
16921 ++window_row
, ++frame_row
;
16926 /* Find the glyph row in window W containing CHARPOS. Consider all
16927 rows between START and END (not inclusive). END null means search
16928 all rows to the end of the display area of W. Value is the row
16929 containing CHARPOS or null. */
16932 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
16933 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16935 struct glyph_row
*row
= start
;
16936 struct glyph_row
*best_row
= NULL
;
16937 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16940 /* If we happen to start on a header-line, skip that. */
16941 if (row
->mode_line_p
)
16944 if ((end
&& row
>= end
) || !row
->enabled_p
)
16947 last_y
= window_text_bottom_y (w
) - dy
;
16951 /* Give up if we have gone too far. */
16952 if (end
&& row
>= end
)
16954 /* This formerly returned if they were equal.
16955 I think that both quantities are of a "last plus one" type;
16956 if so, when they are equal, the row is within the screen. -- rms. */
16957 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16960 /* If it is in this row, return this row. */
16961 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16962 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16963 /* The end position of a row equals the start
16964 position of the next row. If CHARPOS is there, we
16965 would rather display it in the next line, except
16966 when this line ends in ZV. */
16967 && !row
->ends_at_zv_p
16968 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16969 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16973 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16974 || (!best_row
&& !row
->continued_p
))
16976 /* In bidi-reordered rows, there could be several rows
16977 occluding point, all of them belonging to the same
16978 continued line. We need to find the row which fits
16979 CHARPOS the best. */
16980 for (g
= row
->glyphs
[TEXT_AREA
];
16981 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16984 if (!STRINGP (g
->object
))
16986 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16988 mindif
= eabs (g
->charpos
- charpos
);
16990 /* Exact match always wins. */
16997 else if (best_row
&& !row
->continued_p
)
17004 /* Try to redisplay window W by reusing its existing display. W's
17005 current matrix must be up to date when this function is called,
17006 i.e. window_end_valid must not be nil.
17010 1 if display has been updated
17011 0 if otherwise unsuccessful
17012 -1 if redisplay with same window start is known not to succeed
17014 The following steps are performed:
17016 1. Find the last row in the current matrix of W that is not
17017 affected by changes at the start of current_buffer. If no such row
17020 2. Find the first row in W's current matrix that is not affected by
17021 changes at the end of current_buffer. Maybe there is no such row.
17023 3. Display lines beginning with the row + 1 found in step 1 to the
17024 row found in step 2 or, if step 2 didn't find a row, to the end of
17027 4. If cursor is not known to appear on the window, give up.
17029 5. If display stopped at the row found in step 2, scroll the
17030 display and current matrix as needed.
17032 6. Maybe display some lines at the end of W, if we must. This can
17033 happen under various circumstances, like a partially visible line
17034 becoming fully visible, or because newly displayed lines are displayed
17035 in smaller font sizes.
17037 7. Update W's window end information. */
17040 try_window_id (struct window
*w
)
17042 struct frame
*f
= XFRAME (w
->frame
);
17043 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17044 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17045 struct glyph_row
*last_unchanged_at_beg_row
;
17046 struct glyph_row
*first_unchanged_at_end_row
;
17047 struct glyph_row
*row
;
17048 struct glyph_row
*bottom_row
;
17051 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17053 struct text_pos start_pos
;
17055 int first_unchanged_at_end_vpos
= 0;
17056 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17057 struct text_pos start
;
17058 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17061 if (inhibit_try_window_id
)
17065 /* This is handy for debugging. */
17067 #define GIVE_UP(X) \
17069 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17073 #define GIVE_UP(X) return 0
17076 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17078 /* Don't use this for mini-windows because these can show
17079 messages and mini-buffers, and we don't handle that here. */
17080 if (MINI_WINDOW_P (w
))
17083 /* This flag is used to prevent redisplay optimizations. */
17084 if (windows_or_buffers_changed
|| cursor_type_changed
)
17087 /* Verify that narrowing has not changed.
17088 Also verify that we were not told to prevent redisplay optimizations.
17089 It would be nice to further
17090 reduce the number of cases where this prevents try_window_id. */
17091 if (current_buffer
->clip_changed
17092 || current_buffer
->prevent_redisplay_optimizations_p
)
17095 /* Window must either use window-based redisplay or be full width. */
17096 if (!FRAME_WINDOW_P (f
)
17097 && (!FRAME_LINE_INS_DEL_OK (f
)
17098 || !WINDOW_FULL_WIDTH_P (w
)))
17101 /* Give up if point is known NOT to appear in W. */
17102 if (PT
< CHARPOS (start
))
17105 /* Another way to prevent redisplay optimizations. */
17106 if (XFASTINT (w
->last_modified
) == 0)
17109 /* Verify that window is not hscrolled. */
17110 if (XFASTINT (w
->hscroll
) != 0)
17113 /* Verify that display wasn't paused. */
17114 if (NILP (w
->window_end_valid
))
17117 /* Can't use this if highlighting a region because a cursor movement
17118 will do more than just set the cursor. */
17119 if (!NILP (Vtransient_mark_mode
)
17120 && !NILP (BVAR (current_buffer
, mark_active
)))
17123 /* Likewise if highlighting trailing whitespace. */
17124 if (!NILP (Vshow_trailing_whitespace
))
17127 /* Likewise if showing a region. */
17128 if (!NILP (w
->region_showing
))
17131 /* Can't use this if overlay arrow position and/or string have
17133 if (overlay_arrows_changed_p ())
17136 /* When word-wrap is on, adding a space to the first word of a
17137 wrapped line can change the wrap position, altering the line
17138 above it. It might be worthwhile to handle this more
17139 intelligently, but for now just redisplay from scratch. */
17140 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17143 /* Under bidi reordering, adding or deleting a character in the
17144 beginning of a paragraph, before the first strong directional
17145 character, can change the base direction of the paragraph (unless
17146 the buffer specifies a fixed paragraph direction), which will
17147 require to redisplay the whole paragraph. It might be worthwhile
17148 to find the paragraph limits and widen the range of redisplayed
17149 lines to that, but for now just give up this optimization and
17150 redisplay from scratch. */
17151 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17152 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17155 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17156 only if buffer has really changed. The reason is that the gap is
17157 initially at Z for freshly visited files. The code below would
17158 set end_unchanged to 0 in that case. */
17159 if (MODIFF
> SAVE_MODIFF
17160 /* This seems to happen sometimes after saving a buffer. */
17161 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17163 if (GPT
- BEG
< BEG_UNCHANGED
)
17164 BEG_UNCHANGED
= GPT
- BEG
;
17165 if (Z
- GPT
< END_UNCHANGED
)
17166 END_UNCHANGED
= Z
- GPT
;
17169 /* The position of the first and last character that has been changed. */
17170 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17171 last_changed_charpos
= Z
- END_UNCHANGED
;
17173 /* If window starts after a line end, and the last change is in
17174 front of that newline, then changes don't affect the display.
17175 This case happens with stealth-fontification. Note that although
17176 the display is unchanged, glyph positions in the matrix have to
17177 be adjusted, of course. */
17178 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17179 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17180 && ((last_changed_charpos
< CHARPOS (start
)
17181 && CHARPOS (start
) == BEGV
)
17182 || (last_changed_charpos
< CHARPOS (start
) - 1
17183 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17185 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17186 struct glyph_row
*r0
;
17188 /* Compute how many chars/bytes have been added to or removed
17189 from the buffer. */
17190 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17191 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17192 Z_delta
= Z
- Z_old
;
17193 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17195 /* Give up if PT is not in the window. Note that it already has
17196 been checked at the start of try_window_id that PT is not in
17197 front of the window start. */
17198 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17201 /* If window start is unchanged, we can reuse the whole matrix
17202 as is, after adjusting glyph positions. No need to compute
17203 the window end again, since its offset from Z hasn't changed. */
17204 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17205 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17206 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17207 /* PT must not be in a partially visible line. */
17208 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17209 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17211 /* Adjust positions in the glyph matrix. */
17212 if (Z_delta
|| Z_delta_bytes
)
17214 struct glyph_row
*r1
17215 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17216 increment_matrix_positions (w
->current_matrix
,
17217 MATRIX_ROW_VPOS (r0
, current_matrix
),
17218 MATRIX_ROW_VPOS (r1
, current_matrix
),
17219 Z_delta
, Z_delta_bytes
);
17222 /* Set the cursor. */
17223 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17225 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17232 /* Handle the case that changes are all below what is displayed in
17233 the window, and that PT is in the window. This shortcut cannot
17234 be taken if ZV is visible in the window, and text has been added
17235 there that is visible in the window. */
17236 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17237 /* ZV is not visible in the window, or there are no
17238 changes at ZV, actually. */
17239 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17240 || first_changed_charpos
== last_changed_charpos
))
17242 struct glyph_row
*r0
;
17244 /* Give up if PT is not in the window. Note that it already has
17245 been checked at the start of try_window_id that PT is not in
17246 front of the window start. */
17247 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17250 /* If window start is unchanged, we can reuse the whole matrix
17251 as is, without changing glyph positions since no text has
17252 been added/removed in front of the window end. */
17253 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17254 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17255 /* PT must not be in a partially visible line. */
17256 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17257 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17259 /* We have to compute the window end anew since text
17260 could have been added/removed after it. */
17262 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17263 w
->window_end_bytepos
17264 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17266 /* Set the cursor. */
17267 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17269 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17276 /* Give up if window start is in the changed area.
17278 The condition used to read
17280 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17282 but why that was tested escapes me at the moment. */
17283 if (CHARPOS (start
) >= first_changed_charpos
17284 && CHARPOS (start
) <= last_changed_charpos
)
17287 /* Check that window start agrees with the start of the first glyph
17288 row in its current matrix. Check this after we know the window
17289 start is not in changed text, otherwise positions would not be
17291 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17292 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17295 /* Give up if the window ends in strings. Overlay strings
17296 at the end are difficult to handle, so don't try. */
17297 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17298 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17301 /* Compute the position at which we have to start displaying new
17302 lines. Some of the lines at the top of the window might be
17303 reusable because they are not displaying changed text. Find the
17304 last row in W's current matrix not affected by changes at the
17305 start of current_buffer. Value is null if changes start in the
17306 first line of window. */
17307 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17308 if (last_unchanged_at_beg_row
)
17310 /* Avoid starting to display in the middle of a character, a TAB
17311 for instance. This is easier than to set up the iterator
17312 exactly, and it's not a frequent case, so the additional
17313 effort wouldn't really pay off. */
17314 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17315 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17316 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17317 --last_unchanged_at_beg_row
;
17319 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17322 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17324 start_pos
= it
.current
.pos
;
17326 /* Start displaying new lines in the desired matrix at the same
17327 vpos we would use in the current matrix, i.e. below
17328 last_unchanged_at_beg_row. */
17329 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17331 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17332 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17334 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17338 /* There are no reusable lines at the start of the window.
17339 Start displaying in the first text line. */
17340 start_display (&it
, w
, start
);
17341 it
.vpos
= it
.first_vpos
;
17342 start_pos
= it
.current
.pos
;
17345 /* Find the first row that is not affected by changes at the end of
17346 the buffer. Value will be null if there is no unchanged row, in
17347 which case we must redisplay to the end of the window. delta
17348 will be set to the value by which buffer positions beginning with
17349 first_unchanged_at_end_row have to be adjusted due to text
17351 first_unchanged_at_end_row
17352 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17353 IF_DEBUG (debug_delta
= delta
);
17354 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17356 /* Set stop_pos to the buffer position up to which we will have to
17357 display new lines. If first_unchanged_at_end_row != NULL, this
17358 is the buffer position of the start of the line displayed in that
17359 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17360 that we don't stop at a buffer position. */
17362 if (first_unchanged_at_end_row
)
17364 xassert (last_unchanged_at_beg_row
== NULL
17365 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17367 /* If this is a continuation line, move forward to the next one
17368 that isn't. Changes in lines above affect this line.
17369 Caution: this may move first_unchanged_at_end_row to a row
17370 not displaying text. */
17371 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17372 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17373 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17374 < it
.last_visible_y
))
17375 ++first_unchanged_at_end_row
;
17377 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17378 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17379 >= it
.last_visible_y
))
17380 first_unchanged_at_end_row
= NULL
;
17383 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17385 first_unchanged_at_end_vpos
17386 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17387 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17390 else if (last_unchanged_at_beg_row
== NULL
)
17396 /* Either there is no unchanged row at the end, or the one we have
17397 now displays text. This is a necessary condition for the window
17398 end pos calculation at the end of this function. */
17399 xassert (first_unchanged_at_end_row
== NULL
17400 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17402 debug_last_unchanged_at_beg_vpos
17403 = (last_unchanged_at_beg_row
17404 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17406 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17408 #endif /* GLYPH_DEBUG != 0 */
17411 /* Display new lines. Set last_text_row to the last new line
17412 displayed which has text on it, i.e. might end up as being the
17413 line where the window_end_vpos is. */
17414 w
->cursor
.vpos
= -1;
17415 last_text_row
= NULL
;
17416 overlay_arrow_seen
= 0;
17417 while (it
.current_y
< it
.last_visible_y
17418 && !fonts_changed_p
17419 && (first_unchanged_at_end_row
== NULL
17420 || IT_CHARPOS (it
) < stop_pos
))
17422 if (display_line (&it
))
17423 last_text_row
= it
.glyph_row
- 1;
17426 if (fonts_changed_p
)
17430 /* Compute differences in buffer positions, y-positions etc. for
17431 lines reused at the bottom of the window. Compute what we can
17433 if (first_unchanged_at_end_row
17434 /* No lines reused because we displayed everything up to the
17435 bottom of the window. */
17436 && it
.current_y
< it
.last_visible_y
)
17439 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17441 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17442 run
.current_y
= first_unchanged_at_end_row
->y
;
17443 run
.desired_y
= run
.current_y
+ dy
;
17444 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17448 delta
= delta_bytes
= dvpos
= dy
17449 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17450 first_unchanged_at_end_row
= NULL
;
17452 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17455 /* Find the cursor if not already found. We have to decide whether
17456 PT will appear on this window (it sometimes doesn't, but this is
17457 not a very frequent case.) This decision has to be made before
17458 the current matrix is altered. A value of cursor.vpos < 0 means
17459 that PT is either in one of the lines beginning at
17460 first_unchanged_at_end_row or below the window. Don't care for
17461 lines that might be displayed later at the window end; as
17462 mentioned, this is not a frequent case. */
17463 if (w
->cursor
.vpos
< 0)
17465 /* Cursor in unchanged rows at the top? */
17466 if (PT
< CHARPOS (start_pos
)
17467 && last_unchanged_at_beg_row
)
17469 row
= row_containing_pos (w
, PT
,
17470 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17471 last_unchanged_at_beg_row
+ 1, 0);
17473 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17476 /* Start from first_unchanged_at_end_row looking for PT. */
17477 else if (first_unchanged_at_end_row
)
17479 row
= row_containing_pos (w
, PT
- delta
,
17480 first_unchanged_at_end_row
, NULL
, 0);
17482 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17483 delta_bytes
, dy
, dvpos
);
17486 /* Give up if cursor was not found. */
17487 if (w
->cursor
.vpos
< 0)
17489 clear_glyph_matrix (w
->desired_matrix
);
17494 /* Don't let the cursor end in the scroll margins. */
17496 int this_scroll_margin
, cursor_height
;
17498 this_scroll_margin
=
17499 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17500 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17501 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17503 if ((w
->cursor
.y
< this_scroll_margin
17504 && CHARPOS (start
) > BEGV
)
17505 /* Old redisplay didn't take scroll margin into account at the bottom,
17506 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17507 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17508 ? cursor_height
+ this_scroll_margin
17509 : 1)) > it
.last_visible_y
)
17511 w
->cursor
.vpos
= -1;
17512 clear_glyph_matrix (w
->desired_matrix
);
17517 /* Scroll the display. Do it before changing the current matrix so
17518 that xterm.c doesn't get confused about where the cursor glyph is
17520 if (dy
&& run
.height
)
17524 if (FRAME_WINDOW_P (f
))
17526 FRAME_RIF (f
)->update_window_begin_hook (w
);
17527 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17528 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17529 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17533 /* Terminal frame. In this case, dvpos gives the number of
17534 lines to scroll by; dvpos < 0 means scroll up. */
17536 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17537 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17538 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17539 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17540 + window_internal_height (w
));
17542 #if defined (HAVE_GPM) || defined (MSDOS)
17543 x_clear_window_mouse_face (w
);
17545 /* Perform the operation on the screen. */
17548 /* Scroll last_unchanged_at_beg_row to the end of the
17549 window down dvpos lines. */
17550 set_terminal_window (f
, end
);
17552 /* On dumb terminals delete dvpos lines at the end
17553 before inserting dvpos empty lines. */
17554 if (!FRAME_SCROLL_REGION_OK (f
))
17555 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17557 /* Insert dvpos empty lines in front of
17558 last_unchanged_at_beg_row. */
17559 ins_del_lines (f
, from
, dvpos
);
17561 else if (dvpos
< 0)
17563 /* Scroll up last_unchanged_at_beg_vpos to the end of
17564 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17565 set_terminal_window (f
, end
);
17567 /* Delete dvpos lines in front of
17568 last_unchanged_at_beg_vpos. ins_del_lines will set
17569 the cursor to the given vpos and emit |dvpos| delete
17571 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17573 /* On a dumb terminal insert dvpos empty lines at the
17575 if (!FRAME_SCROLL_REGION_OK (f
))
17576 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17579 set_terminal_window (f
, 0);
17585 /* Shift reused rows of the current matrix to the right position.
17586 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17588 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17589 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17592 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17593 bottom_vpos
, dvpos
);
17594 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17597 else if (dvpos
> 0)
17599 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17600 bottom_vpos
, dvpos
);
17601 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17602 first_unchanged_at_end_vpos
+ dvpos
, 0);
17605 /* For frame-based redisplay, make sure that current frame and window
17606 matrix are in sync with respect to glyph memory. */
17607 if (!FRAME_WINDOW_P (f
))
17608 sync_frame_with_window_matrix_rows (w
);
17610 /* Adjust buffer positions in reused rows. */
17611 if (delta
|| delta_bytes
)
17612 increment_matrix_positions (current_matrix
,
17613 first_unchanged_at_end_vpos
+ dvpos
,
17614 bottom_vpos
, delta
, delta_bytes
);
17616 /* Adjust Y positions. */
17618 shift_glyph_matrix (w
, current_matrix
,
17619 first_unchanged_at_end_vpos
+ dvpos
,
17622 if (first_unchanged_at_end_row
)
17624 first_unchanged_at_end_row
+= dvpos
;
17625 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17626 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17627 first_unchanged_at_end_row
= NULL
;
17630 /* If scrolling up, there may be some lines to display at the end of
17632 last_text_row_at_end
= NULL
;
17635 /* Scrolling up can leave for example a partially visible line
17636 at the end of the window to be redisplayed. */
17637 /* Set last_row to the glyph row in the current matrix where the
17638 window end line is found. It has been moved up or down in
17639 the matrix by dvpos. */
17640 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17641 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17643 /* If last_row is the window end line, it should display text. */
17644 xassert (last_row
->displays_text_p
);
17646 /* If window end line was partially visible before, begin
17647 displaying at that line. Otherwise begin displaying with the
17648 line following it. */
17649 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17651 init_to_row_start (&it
, w
, last_row
);
17652 it
.vpos
= last_vpos
;
17653 it
.current_y
= last_row
->y
;
17657 init_to_row_end (&it
, w
, last_row
);
17658 it
.vpos
= 1 + last_vpos
;
17659 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17663 /* We may start in a continuation line. If so, we have to
17664 get the right continuation_lines_width and current_x. */
17665 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17666 it
.hpos
= it
.current_x
= 0;
17668 /* Display the rest of the lines at the window end. */
17669 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17670 while (it
.current_y
< it
.last_visible_y
17671 && !fonts_changed_p
)
17673 /* Is it always sure that the display agrees with lines in
17674 the current matrix? I don't think so, so we mark rows
17675 displayed invalid in the current matrix by setting their
17676 enabled_p flag to zero. */
17677 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17678 if (display_line (&it
))
17679 last_text_row_at_end
= it
.glyph_row
- 1;
17683 /* Update window_end_pos and window_end_vpos. */
17684 if (first_unchanged_at_end_row
17685 && !last_text_row_at_end
)
17687 /* Window end line if one of the preserved rows from the current
17688 matrix. Set row to the last row displaying text in current
17689 matrix starting at first_unchanged_at_end_row, after
17691 xassert (first_unchanged_at_end_row
->displays_text_p
);
17692 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17693 first_unchanged_at_end_row
);
17694 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17696 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17697 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17699 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17700 xassert (w
->window_end_bytepos
>= 0);
17701 IF_DEBUG (debug_method_add (w
, "A"));
17703 else if (last_text_row_at_end
)
17706 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17707 w
->window_end_bytepos
17708 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17710 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17711 xassert (w
->window_end_bytepos
>= 0);
17712 IF_DEBUG (debug_method_add (w
, "B"));
17714 else if (last_text_row
)
17716 /* We have displayed either to the end of the window or at the
17717 end of the window, i.e. the last row with text is to be found
17718 in the desired matrix. */
17720 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17721 w
->window_end_bytepos
17722 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17724 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17725 xassert (w
->window_end_bytepos
>= 0);
17727 else if (first_unchanged_at_end_row
== NULL
17728 && last_text_row
== NULL
17729 && last_text_row_at_end
== NULL
)
17731 /* Displayed to end of window, but no line containing text was
17732 displayed. Lines were deleted at the end of the window. */
17733 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17734 int vpos
= XFASTINT (w
->window_end_vpos
);
17735 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17736 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17739 row
== NULL
&& vpos
>= first_vpos
;
17740 --vpos
, --current_row
, --desired_row
)
17742 if (desired_row
->enabled_p
)
17744 if (desired_row
->displays_text_p
)
17747 else if (current_row
->displays_text_p
)
17751 xassert (row
!= NULL
);
17752 w
->window_end_vpos
= make_number (vpos
+ 1);
17753 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17754 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17755 xassert (w
->window_end_bytepos
>= 0);
17756 IF_DEBUG (debug_method_add (w
, "C"));
17761 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17762 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17764 /* Record that display has not been completed. */
17765 w
->window_end_valid
= Qnil
;
17766 w
->desired_matrix
->no_scrolling_p
= 1;
17774 /***********************************************************************
17775 More debugging support
17776 ***********************************************************************/
17780 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17781 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17782 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17785 /* Dump the contents of glyph matrix MATRIX on stderr.
17787 GLYPHS 0 means don't show glyph contents.
17788 GLYPHS 1 means show glyphs in short form
17789 GLYPHS > 1 means show glyphs in long form. */
17792 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17795 for (i
= 0; i
< matrix
->nrows
; ++i
)
17796 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17800 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17801 the glyph row and area where the glyph comes from. */
17804 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17806 if (glyph
->type
== CHAR_GLYPH
)
17809 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17810 glyph
- row
->glyphs
[TEXT_AREA
],
17813 (BUFFERP (glyph
->object
)
17815 : (STRINGP (glyph
->object
)
17818 glyph
->pixel_width
,
17820 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17824 glyph
->left_box_line_p
,
17825 glyph
->right_box_line_p
);
17827 else if (glyph
->type
== STRETCH_GLYPH
)
17830 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17831 glyph
- row
->glyphs
[TEXT_AREA
],
17834 (BUFFERP (glyph
->object
)
17836 : (STRINGP (glyph
->object
)
17839 glyph
->pixel_width
,
17843 glyph
->left_box_line_p
,
17844 glyph
->right_box_line_p
);
17846 else if (glyph
->type
== IMAGE_GLYPH
)
17849 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17850 glyph
- row
->glyphs
[TEXT_AREA
],
17853 (BUFFERP (glyph
->object
)
17855 : (STRINGP (glyph
->object
)
17858 glyph
->pixel_width
,
17862 glyph
->left_box_line_p
,
17863 glyph
->right_box_line_p
);
17865 else if (glyph
->type
== COMPOSITE_GLYPH
)
17868 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17869 glyph
- row
->glyphs
[TEXT_AREA
],
17872 (BUFFERP (glyph
->object
)
17874 : (STRINGP (glyph
->object
)
17877 glyph
->pixel_width
,
17879 if (glyph
->u
.cmp
.automatic
)
17882 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17883 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17885 glyph
->left_box_line_p
,
17886 glyph
->right_box_line_p
);
17891 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17892 GLYPHS 0 means don't show glyph contents.
17893 GLYPHS 1 means show glyphs in short form
17894 GLYPHS > 1 means show glyphs in long form. */
17897 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17901 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17902 fprintf (stderr
, "======================================================================\n");
17904 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17905 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17907 MATRIX_ROW_START_CHARPOS (row
),
17908 MATRIX_ROW_END_CHARPOS (row
),
17909 row
->used
[TEXT_AREA
],
17910 row
->contains_overlapping_glyphs_p
,
17912 row
->truncated_on_left_p
,
17913 row
->truncated_on_right_p
,
17915 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17916 row
->displays_text_p
,
17919 row
->ends_in_middle_of_char_p
,
17920 row
->starts_in_middle_of_char_p
,
17926 row
->visible_height
,
17929 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
17930 row
->end
.overlay_string_index
,
17931 row
->continuation_lines_width
);
17932 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17933 CHARPOS (row
->start
.string_pos
),
17934 CHARPOS (row
->end
.string_pos
));
17935 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17936 row
->end
.dpvec_index
);
17943 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17945 struct glyph
*glyph
= row
->glyphs
[area
];
17946 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17948 /* Glyph for a line end in text. */
17949 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17952 if (glyph
< glyph_end
)
17953 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17955 for (; glyph
< glyph_end
; ++glyph
)
17956 dump_glyph (row
, glyph
, area
);
17959 else if (glyphs
== 1)
17963 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17965 char *s
= (char *) alloca (row
->used
[area
] + 1);
17968 for (i
= 0; i
< row
->used
[area
]; ++i
)
17970 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17971 if (glyph
->type
== CHAR_GLYPH
17972 && glyph
->u
.ch
< 0x80
17973 && glyph
->u
.ch
>= ' ')
17974 s
[i
] = glyph
->u
.ch
;
17980 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17986 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17987 Sdump_glyph_matrix
, 0, 1, "p",
17988 doc
: /* Dump the current matrix of the selected window to stderr.
17989 Shows contents of glyph row structures. With non-nil
17990 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17991 glyphs in short form, otherwise show glyphs in long form. */)
17992 (Lisp_Object glyphs
)
17994 struct window
*w
= XWINDOW (selected_window
);
17995 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17997 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17998 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17999 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18000 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18001 fprintf (stderr
, "=============================================\n");
18002 dump_glyph_matrix (w
->current_matrix
,
18003 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18008 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18009 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18012 struct frame
*f
= XFRAME (selected_frame
);
18013 dump_glyph_matrix (f
->current_matrix
, 1);
18018 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18019 doc
: /* Dump glyph row ROW to stderr.
18020 GLYPH 0 means don't dump glyphs.
18021 GLYPH 1 means dump glyphs in short form.
18022 GLYPH > 1 or omitted means dump glyphs in long form. */)
18023 (Lisp_Object row
, Lisp_Object glyphs
)
18025 struct glyph_matrix
*matrix
;
18028 CHECK_NUMBER (row
);
18029 matrix
= XWINDOW (selected_window
)->current_matrix
;
18031 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18032 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18034 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18039 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18040 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18041 GLYPH 0 means don't dump glyphs.
18042 GLYPH 1 means dump glyphs in short form.
18043 GLYPH > 1 or omitted means dump glyphs in long form. */)
18044 (Lisp_Object row
, Lisp_Object glyphs
)
18046 struct frame
*sf
= SELECTED_FRAME ();
18047 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18050 CHECK_NUMBER (row
);
18052 if (vpos
>= 0 && vpos
< m
->nrows
)
18053 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18054 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18059 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18060 doc
: /* Toggle tracing of redisplay.
18061 With ARG, turn tracing on if and only if ARG is positive. */)
18065 trace_redisplay_p
= !trace_redisplay_p
;
18068 arg
= Fprefix_numeric_value (arg
);
18069 trace_redisplay_p
= XINT (arg
) > 0;
18076 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18077 doc
: /* Like `format', but print result to stderr.
18078 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18079 (ptrdiff_t nargs
, Lisp_Object
*args
)
18081 Lisp_Object s
= Fformat (nargs
, args
);
18082 fprintf (stderr
, "%s", SDATA (s
));
18086 #endif /* GLYPH_DEBUG */
18090 /***********************************************************************
18091 Building Desired Matrix Rows
18092 ***********************************************************************/
18094 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18095 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18097 static struct glyph_row
*
18098 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18100 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18101 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18102 struct buffer
*old
= current_buffer
;
18103 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18104 int arrow_len
= SCHARS (overlay_arrow_string
);
18105 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18106 const unsigned char *p
;
18109 int n_glyphs_before
;
18111 set_buffer_temp (buffer
);
18112 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18113 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18114 SET_TEXT_POS (it
.position
, 0, 0);
18116 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18118 while (p
< arrow_end
)
18120 Lisp_Object face
, ilisp
;
18122 /* Get the next character. */
18124 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18127 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18128 if (! ASCII_CHAR_P (it
.c
))
18129 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18133 /* Get its face. */
18134 ilisp
= make_number (p
- arrow_string
);
18135 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18136 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18138 /* Compute its width, get its glyphs. */
18139 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18140 SET_TEXT_POS (it
.position
, -1, -1);
18141 PRODUCE_GLYPHS (&it
);
18143 /* If this character doesn't fit any more in the line, we have
18144 to remove some glyphs. */
18145 if (it
.current_x
> it
.last_visible_x
)
18147 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18152 set_buffer_temp (old
);
18153 return it
.glyph_row
;
18157 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
18158 glyphs are only inserted for terminal frames since we can't really
18159 win with truncation glyphs when partially visible glyphs are
18160 involved. Which glyphs to insert is determined by
18161 produce_special_glyphs. */
18164 insert_left_trunc_glyphs (struct it
*it
)
18166 struct it truncate_it
;
18167 struct glyph
*from
, *end
, *to
, *toend
;
18169 xassert (!FRAME_WINDOW_P (it
->f
));
18171 /* Get the truncation glyphs. */
18173 truncate_it
.current_x
= 0;
18174 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18175 truncate_it
.glyph_row
= &scratch_glyph_row
;
18176 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18177 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18178 truncate_it
.object
= make_number (0);
18179 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18181 /* Overwrite glyphs from IT with truncation glyphs. */
18182 if (!it
->glyph_row
->reversed_p
)
18184 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18185 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
18186 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18187 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18192 /* There may be padding glyphs left over. Overwrite them too. */
18193 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18195 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18201 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18205 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18206 that back to front. */
18207 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18208 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18209 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18210 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18212 while (from
>= end
&& to
>= toend
)
18214 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18217 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18218 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18219 while (from
>= end
&& to
>= toend
)
18224 /* Need to free some room before prepending additional
18226 int move_by
= from
- end
+ 1;
18227 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18228 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18230 for ( ; g
>= g0
; g
--)
18232 while (from
>= end
)
18234 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18239 /* Compute the hash code for ROW. */
18241 row_hash (struct glyph_row
*row
)
18244 unsigned hashval
= 0;
18246 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18247 for (k
= 0; k
< row
->used
[area
]; ++k
)
18248 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18249 + row
->glyphs
[area
][k
].u
.val
18250 + row
->glyphs
[area
][k
].face_id
18251 + row
->glyphs
[area
][k
].padding_p
18252 + (row
->glyphs
[area
][k
].type
<< 2));
18257 /* Compute the pixel height and width of IT->glyph_row.
18259 Most of the time, ascent and height of a display line will be equal
18260 to the max_ascent and max_height values of the display iterator
18261 structure. This is not the case if
18263 1. We hit ZV without displaying anything. In this case, max_ascent
18264 and max_height will be zero.
18266 2. We have some glyphs that don't contribute to the line height.
18267 (The glyph row flag contributes_to_line_height_p is for future
18268 pixmap extensions).
18270 The first case is easily covered by using default values because in
18271 these cases, the line height does not really matter, except that it
18272 must not be zero. */
18275 compute_line_metrics (struct it
*it
)
18277 struct glyph_row
*row
= it
->glyph_row
;
18279 if (FRAME_WINDOW_P (it
->f
))
18281 int i
, min_y
, max_y
;
18283 /* The line may consist of one space only, that was added to
18284 place the cursor on it. If so, the row's height hasn't been
18286 if (row
->height
== 0)
18288 if (it
->max_ascent
+ it
->max_descent
== 0)
18289 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18290 row
->ascent
= it
->max_ascent
;
18291 row
->height
= it
->max_ascent
+ it
->max_descent
;
18292 row
->phys_ascent
= it
->max_phys_ascent
;
18293 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18294 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18297 /* Compute the width of this line. */
18298 row
->pixel_width
= row
->x
;
18299 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18300 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18302 xassert (row
->pixel_width
>= 0);
18303 xassert (row
->ascent
>= 0 && row
->height
> 0);
18305 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18306 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18308 /* If first line's physical ascent is larger than its logical
18309 ascent, use the physical ascent, and make the row taller.
18310 This makes accented characters fully visible. */
18311 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18312 && row
->phys_ascent
> row
->ascent
)
18314 row
->height
+= row
->phys_ascent
- row
->ascent
;
18315 row
->ascent
= row
->phys_ascent
;
18318 /* Compute how much of the line is visible. */
18319 row
->visible_height
= row
->height
;
18321 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18322 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18324 if (row
->y
< min_y
)
18325 row
->visible_height
-= min_y
- row
->y
;
18326 if (row
->y
+ row
->height
> max_y
)
18327 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18331 row
->pixel_width
= row
->used
[TEXT_AREA
];
18332 if (row
->continued_p
)
18333 row
->pixel_width
-= it
->continuation_pixel_width
;
18334 else if (row
->truncated_on_right_p
)
18335 row
->pixel_width
-= it
->truncation_pixel_width
;
18336 row
->ascent
= row
->phys_ascent
= 0;
18337 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18338 row
->extra_line_spacing
= 0;
18341 /* Compute a hash code for this row. */
18342 row
->hash
= row_hash (row
);
18344 it
->max_ascent
= it
->max_descent
= 0;
18345 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18349 /* Append one space to the glyph row of iterator IT if doing a
18350 window-based redisplay. The space has the same face as
18351 IT->face_id. Value is non-zero if a space was added.
18353 This function is called to make sure that there is always one glyph
18354 at the end of a glyph row that the cursor can be set on under
18355 window-systems. (If there weren't such a glyph we would not know
18356 how wide and tall a box cursor should be displayed).
18358 At the same time this space let's a nicely handle clearing to the
18359 end of the line if the row ends in italic text. */
18362 append_space_for_newline (struct it
*it
, int default_face_p
)
18364 if (FRAME_WINDOW_P (it
->f
))
18366 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18368 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18369 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18371 /* Save some values that must not be changed.
18372 Must save IT->c and IT->len because otherwise
18373 ITERATOR_AT_END_P wouldn't work anymore after
18374 append_space_for_newline has been called. */
18375 enum display_element_type saved_what
= it
->what
;
18376 int saved_c
= it
->c
, saved_len
= it
->len
;
18377 int saved_char_to_display
= it
->char_to_display
;
18378 int saved_x
= it
->current_x
;
18379 int saved_face_id
= it
->face_id
;
18380 struct text_pos saved_pos
;
18381 Lisp_Object saved_object
;
18384 saved_object
= it
->object
;
18385 saved_pos
= it
->position
;
18387 it
->what
= IT_CHARACTER
;
18388 memset (&it
->position
, 0, sizeof it
->position
);
18389 it
->object
= make_number (0);
18390 it
->c
= it
->char_to_display
= ' ';
18393 /* If the default face was remapped, be sure to use the
18394 remapped face for the appended newline. */
18395 if (default_face_p
)
18396 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18397 else if (it
->face_before_selective_p
)
18398 it
->face_id
= it
->saved_face_id
;
18399 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18400 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18402 PRODUCE_GLYPHS (it
);
18404 it
->override_ascent
= -1;
18405 it
->constrain_row_ascent_descent_p
= 0;
18406 it
->current_x
= saved_x
;
18407 it
->object
= saved_object
;
18408 it
->position
= saved_pos
;
18409 it
->what
= saved_what
;
18410 it
->face_id
= saved_face_id
;
18411 it
->len
= saved_len
;
18413 it
->char_to_display
= saved_char_to_display
;
18422 /* Extend the face of the last glyph in the text area of IT->glyph_row
18423 to the end of the display line. Called from display_line. If the
18424 glyph row is empty, add a space glyph to it so that we know the
18425 face to draw. Set the glyph row flag fill_line_p. If the glyph
18426 row is R2L, prepend a stretch glyph to cover the empty space to the
18427 left of the leftmost glyph. */
18430 extend_face_to_end_of_line (struct it
*it
)
18432 struct face
*face
, *default_face
;
18433 struct frame
*f
= it
->f
;
18435 /* If line is already filled, do nothing. Non window-system frames
18436 get a grace of one more ``pixel'' because their characters are
18437 1-``pixel'' wide, so they hit the equality too early. This grace
18438 is needed only for R2L rows that are not continued, to produce
18439 one extra blank where we could display the cursor. */
18440 if (it
->current_x
>= it
->last_visible_x
18441 + (!FRAME_WINDOW_P (f
)
18442 && it
->glyph_row
->reversed_p
18443 && !it
->glyph_row
->continued_p
))
18446 /* The default face, possibly remapped. */
18447 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18449 /* Face extension extends the background and box of IT->face_id
18450 to the end of the line. If the background equals the background
18451 of the frame, we don't have to do anything. */
18452 if (it
->face_before_selective_p
)
18453 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18455 face
= FACE_FROM_ID (f
, it
->face_id
);
18457 if (FRAME_WINDOW_P (f
)
18458 && it
->glyph_row
->displays_text_p
18459 && face
->box
== FACE_NO_BOX
18460 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18462 && !it
->glyph_row
->reversed_p
)
18465 /* Set the glyph row flag indicating that the face of the last glyph
18466 in the text area has to be drawn to the end of the text area. */
18467 it
->glyph_row
->fill_line_p
= 1;
18469 /* If current character of IT is not ASCII, make sure we have the
18470 ASCII face. This will be automatically undone the next time
18471 get_next_display_element returns a multibyte character. Note
18472 that the character will always be single byte in unibyte
18474 if (!ASCII_CHAR_P (it
->c
))
18476 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18479 if (FRAME_WINDOW_P (f
))
18481 /* If the row is empty, add a space with the current face of IT,
18482 so that we know which face to draw. */
18483 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18485 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18486 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18487 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18489 #ifdef HAVE_WINDOW_SYSTEM
18490 if (it
->glyph_row
->reversed_p
)
18492 /* Prepend a stretch glyph to the row, such that the
18493 rightmost glyph will be drawn flushed all the way to the
18494 right margin of the window. The stretch glyph that will
18495 occupy the empty space, if any, to the left of the
18497 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18498 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18499 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18501 int row_width
, stretch_ascent
, stretch_width
;
18502 struct text_pos saved_pos
;
18503 int saved_face_id
, saved_avoid_cursor
;
18505 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18506 row_width
+= g
->pixel_width
;
18507 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18508 if (stretch_width
> 0)
18511 (((it
->ascent
+ it
->descent
)
18512 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18513 saved_pos
= it
->position
;
18514 memset (&it
->position
, 0, sizeof it
->position
);
18515 saved_avoid_cursor
= it
->avoid_cursor_p
;
18516 it
->avoid_cursor_p
= 1;
18517 saved_face_id
= it
->face_id
;
18518 /* The last row's stretch glyph should get the default
18519 face, to avoid painting the rest of the window with
18520 the region face, if the region ends at ZV. */
18521 if (it
->glyph_row
->ends_at_zv_p
)
18522 it
->face_id
= default_face
->id
;
18524 it
->face_id
= face
->id
;
18525 append_stretch_glyph (it
, make_number (0), stretch_width
,
18526 it
->ascent
+ it
->descent
, stretch_ascent
);
18527 it
->position
= saved_pos
;
18528 it
->avoid_cursor_p
= saved_avoid_cursor
;
18529 it
->face_id
= saved_face_id
;
18532 #endif /* HAVE_WINDOW_SYSTEM */
18536 /* Save some values that must not be changed. */
18537 int saved_x
= it
->current_x
;
18538 struct text_pos saved_pos
;
18539 Lisp_Object saved_object
;
18540 enum display_element_type saved_what
= it
->what
;
18541 int saved_face_id
= it
->face_id
;
18543 saved_object
= it
->object
;
18544 saved_pos
= it
->position
;
18546 it
->what
= IT_CHARACTER
;
18547 memset (&it
->position
, 0, sizeof it
->position
);
18548 it
->object
= make_number (0);
18549 it
->c
= it
->char_to_display
= ' ';
18551 /* The last row's blank glyphs should get the default face, to
18552 avoid painting the rest of the window with the region face,
18553 if the region ends at ZV. */
18554 if (it
->glyph_row
->ends_at_zv_p
)
18555 it
->face_id
= default_face
->id
;
18557 it
->face_id
= face
->id
;
18559 PRODUCE_GLYPHS (it
);
18561 while (it
->current_x
<= it
->last_visible_x
)
18562 PRODUCE_GLYPHS (it
);
18564 /* Don't count these blanks really. It would let us insert a left
18565 truncation glyph below and make us set the cursor on them, maybe. */
18566 it
->current_x
= saved_x
;
18567 it
->object
= saved_object
;
18568 it
->position
= saved_pos
;
18569 it
->what
= saved_what
;
18570 it
->face_id
= saved_face_id
;
18575 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18576 trailing whitespace. */
18579 trailing_whitespace_p (ptrdiff_t charpos
)
18581 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18584 while (bytepos
< ZV_BYTE
18585 && (c
= FETCH_CHAR (bytepos
),
18586 c
== ' ' || c
== '\t'))
18589 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18591 if (bytepos
!= PT_BYTE
)
18598 /* Highlight trailing whitespace, if any, in ROW. */
18601 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18603 int used
= row
->used
[TEXT_AREA
];
18607 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18608 struct glyph
*glyph
= start
+ used
- 1;
18610 if (row
->reversed_p
)
18612 /* Right-to-left rows need to be processed in the opposite
18613 direction, so swap the edge pointers. */
18615 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18618 /* Skip over glyphs inserted to display the cursor at the
18619 end of a line, for extending the face of the last glyph
18620 to the end of the line on terminals, and for truncation
18621 and continuation glyphs. */
18622 if (!row
->reversed_p
)
18624 while (glyph
>= start
18625 && glyph
->type
== CHAR_GLYPH
18626 && INTEGERP (glyph
->object
))
18631 while (glyph
<= start
18632 && glyph
->type
== CHAR_GLYPH
18633 && INTEGERP (glyph
->object
))
18637 /* If last glyph is a space or stretch, and it's trailing
18638 whitespace, set the face of all trailing whitespace glyphs in
18639 IT->glyph_row to `trailing-whitespace'. */
18640 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18641 && BUFFERP (glyph
->object
)
18642 && (glyph
->type
== STRETCH_GLYPH
18643 || (glyph
->type
== CHAR_GLYPH
18644 && glyph
->u
.ch
== ' '))
18645 && trailing_whitespace_p (glyph
->charpos
))
18647 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18651 if (!row
->reversed_p
)
18653 while (glyph
>= start
18654 && BUFFERP (glyph
->object
)
18655 && (glyph
->type
== STRETCH_GLYPH
18656 || (glyph
->type
== CHAR_GLYPH
18657 && glyph
->u
.ch
== ' ')))
18658 (glyph
--)->face_id
= face_id
;
18662 while (glyph
<= start
18663 && BUFFERP (glyph
->object
)
18664 && (glyph
->type
== STRETCH_GLYPH
18665 || (glyph
->type
== CHAR_GLYPH
18666 && glyph
->u
.ch
== ' ')))
18667 (glyph
++)->face_id
= face_id
;
18674 /* Value is non-zero if glyph row ROW should be
18675 used to hold the cursor. */
18678 cursor_row_p (struct glyph_row
*row
)
18682 if (PT
== CHARPOS (row
->end
.pos
)
18683 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18685 /* Suppose the row ends on a string.
18686 Unless the row is continued, that means it ends on a newline
18687 in the string. If it's anything other than a display string
18688 (e.g., a before-string from an overlay), we don't want the
18689 cursor there. (This heuristic seems to give the optimal
18690 behavior for the various types of multi-line strings.)
18691 One exception: if the string has `cursor' property on one of
18692 its characters, we _do_ want the cursor there. */
18693 if (CHARPOS (row
->end
.string_pos
) >= 0)
18695 if (row
->continued_p
)
18699 /* Check for `display' property. */
18700 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18701 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18702 struct glyph
*glyph
;
18705 for (glyph
= end
; glyph
>= beg
; --glyph
)
18706 if (STRINGP (glyph
->object
))
18709 = Fget_char_property (make_number (PT
),
18713 && display_prop_string_p (prop
, glyph
->object
));
18714 /* If there's a `cursor' property on one of the
18715 string's characters, this row is a cursor row,
18716 even though this is not a display string. */
18719 Lisp_Object s
= glyph
->object
;
18721 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18723 ptrdiff_t gpos
= glyph
->charpos
;
18725 if (!NILP (Fget_char_property (make_number (gpos
),
18737 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18739 /* If the row ends in middle of a real character,
18740 and the line is continued, we want the cursor here.
18741 That's because CHARPOS (ROW->end.pos) would equal
18742 PT if PT is before the character. */
18743 if (!row
->ends_in_ellipsis_p
)
18744 result
= row
->continued_p
;
18746 /* If the row ends in an ellipsis, then
18747 CHARPOS (ROW->end.pos) will equal point after the
18748 invisible text. We want that position to be displayed
18749 after the ellipsis. */
18752 /* If the row ends at ZV, display the cursor at the end of that
18753 row instead of at the start of the row below. */
18754 else if (row
->ends_at_zv_p
)
18765 /* Push the property PROP so that it will be rendered at the current
18766 position in IT. Return 1 if PROP was successfully pushed, 0
18767 otherwise. Called from handle_line_prefix to handle the
18768 `line-prefix' and `wrap-prefix' properties. */
18771 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18773 struct text_pos pos
=
18774 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18776 xassert (it
->method
== GET_FROM_BUFFER
18777 || it
->method
== GET_FROM_DISPLAY_VECTOR
18778 || it
->method
== GET_FROM_STRING
);
18780 /* We need to save the current buffer/string position, so it will be
18781 restored by pop_it, because iterate_out_of_display_property
18782 depends on that being set correctly, but some situations leave
18783 it->position not yet set when this function is called. */
18784 push_it (it
, &pos
);
18786 if (STRINGP (prop
))
18788 if (SCHARS (prop
) == 0)
18795 it
->string_from_prefix_prop_p
= 1;
18796 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18797 it
->current
.overlay_string_index
= -1;
18798 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18799 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18800 it
->method
= GET_FROM_STRING
;
18801 it
->stop_charpos
= 0;
18803 it
->base_level_stop
= 0;
18805 /* Force paragraph direction to be that of the parent
18807 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18808 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18810 it
->paragraph_embedding
= L2R
;
18812 /* Set up the bidi iterator for this display string. */
18815 it
->bidi_it
.string
.lstring
= it
->string
;
18816 it
->bidi_it
.string
.s
= NULL
;
18817 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18818 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18819 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18820 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18821 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18824 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18826 it
->method
= GET_FROM_STRETCH
;
18829 #ifdef HAVE_WINDOW_SYSTEM
18830 else if (IMAGEP (prop
))
18832 it
->what
= IT_IMAGE
;
18833 it
->image_id
= lookup_image (it
->f
, prop
);
18834 it
->method
= GET_FROM_IMAGE
;
18836 #endif /* HAVE_WINDOW_SYSTEM */
18839 pop_it (it
); /* bogus display property, give up */
18846 /* Return the character-property PROP at the current position in IT. */
18849 get_it_property (struct it
*it
, Lisp_Object prop
)
18851 Lisp_Object position
;
18853 if (STRINGP (it
->object
))
18854 position
= make_number (IT_STRING_CHARPOS (*it
));
18855 else if (BUFFERP (it
->object
))
18856 position
= make_number (IT_CHARPOS (*it
));
18860 return Fget_char_property (position
, prop
, it
->object
);
18863 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18866 handle_line_prefix (struct it
*it
)
18868 Lisp_Object prefix
;
18870 if (it
->continuation_lines_width
> 0)
18872 prefix
= get_it_property (it
, Qwrap_prefix
);
18874 prefix
= Vwrap_prefix
;
18878 prefix
= get_it_property (it
, Qline_prefix
);
18880 prefix
= Vline_prefix
;
18882 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18884 /* If the prefix is wider than the window, and we try to wrap
18885 it, it would acquire its own wrap prefix, and so on till the
18886 iterator stack overflows. So, don't wrap the prefix. */
18887 it
->line_wrap
= TRUNCATE
;
18888 it
->avoid_cursor_p
= 1;
18894 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18895 only for R2L lines from display_line and display_string, when they
18896 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18897 the line/string needs to be continued on the next glyph row. */
18899 unproduce_glyphs (struct it
*it
, int n
)
18901 struct glyph
*glyph
, *end
;
18903 xassert (it
->glyph_row
);
18904 xassert (it
->glyph_row
->reversed_p
);
18905 xassert (it
->area
== TEXT_AREA
);
18906 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18908 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18909 n
= it
->glyph_row
->used
[TEXT_AREA
];
18910 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18911 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18912 for ( ; glyph
< end
; glyph
++)
18913 glyph
[-n
] = *glyph
;
18916 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18917 and ROW->maxpos. */
18919 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18920 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
18921 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
18923 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18924 lines' rows is implemented for bidi-reordered rows. */
18926 /* ROW->minpos is the value of min_pos, the minimal buffer position
18927 we have in ROW, or ROW->start.pos if that is smaller. */
18928 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18929 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18931 /* We didn't find buffer positions smaller than ROW->start, or
18932 didn't find _any_ valid buffer positions in any of the glyphs,
18933 so we must trust the iterator's computed positions. */
18934 row
->minpos
= row
->start
.pos
;
18937 max_pos
= CHARPOS (it
->current
.pos
);
18938 max_bpos
= BYTEPOS (it
->current
.pos
);
18941 /* Here are the various use-cases for ending the row, and the
18942 corresponding values for ROW->maxpos:
18944 Line ends in a newline from buffer eol_pos + 1
18945 Line is continued from buffer max_pos + 1
18946 Line is truncated on right it->current.pos
18947 Line ends in a newline from string max_pos + 1(*)
18948 (*) + 1 only when line ends in a forward scan
18949 Line is continued from string max_pos
18950 Line is continued from display vector max_pos
18951 Line is entirely from a string min_pos == max_pos
18952 Line is entirely from a display vector min_pos == max_pos
18953 Line that ends at ZV ZV
18955 If you discover other use-cases, please add them here as
18957 if (row
->ends_at_zv_p
)
18958 row
->maxpos
= it
->current
.pos
;
18959 else if (row
->used
[TEXT_AREA
])
18961 int seen_this_string
= 0;
18962 struct glyph_row
*r1
= row
- 1;
18964 /* Did we see the same display string on the previous row? */
18965 if (STRINGP (it
->object
)
18966 /* this is not the first row */
18967 && row
> it
->w
->desired_matrix
->rows
18968 /* previous row is not the header line */
18969 && !r1
->mode_line_p
18970 /* previous row also ends in a newline from a string */
18971 && r1
->ends_in_newline_from_string_p
)
18973 struct glyph
*start
, *end
;
18975 /* Search for the last glyph of the previous row that came
18976 from buffer or string. Depending on whether the row is
18977 L2R or R2L, we need to process it front to back or the
18978 other way round. */
18979 if (!r1
->reversed_p
)
18981 start
= r1
->glyphs
[TEXT_AREA
];
18982 end
= start
+ r1
->used
[TEXT_AREA
];
18983 /* Glyphs inserted by redisplay have an integer (zero)
18984 as their object. */
18986 && INTEGERP ((end
- 1)->object
)
18987 && (end
- 1)->charpos
<= 0)
18991 if (EQ ((end
- 1)->object
, it
->object
))
18992 seen_this_string
= 1;
18995 /* If all the glyphs of the previous row were inserted
18996 by redisplay, it means the previous row was
18997 produced from a single newline, which is only
18998 possible if that newline came from the same string
18999 as the one which produced this ROW. */
19000 seen_this_string
= 1;
19004 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19005 start
= end
+ r1
->used
[TEXT_AREA
];
19007 && INTEGERP ((end
+ 1)->object
)
19008 && (end
+ 1)->charpos
<= 0)
19012 if (EQ ((end
+ 1)->object
, it
->object
))
19013 seen_this_string
= 1;
19016 seen_this_string
= 1;
19019 /* Take note of each display string that covers a newline only
19020 once, the first time we see it. This is for when a display
19021 string includes more than one newline in it. */
19022 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19024 /* If we were scanning the buffer forward when we displayed
19025 the string, we want to account for at least one buffer
19026 position that belongs to this row (position covered by
19027 the display string), so that cursor positioning will
19028 consider this row as a candidate when point is at the end
19029 of the visual line represented by this row. This is not
19030 required when scanning back, because max_pos will already
19031 have a much larger value. */
19032 if (CHARPOS (row
->end
.pos
) > max_pos
)
19033 INC_BOTH (max_pos
, max_bpos
);
19034 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19036 else if (CHARPOS (it
->eol_pos
) > 0)
19037 SET_TEXT_POS (row
->maxpos
,
19038 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19039 else if (row
->continued_p
)
19041 /* If max_pos is different from IT's current position, it
19042 means IT->method does not belong to the display element
19043 at max_pos. However, it also means that the display
19044 element at max_pos was displayed in its entirety on this
19045 line, which is equivalent to saying that the next line
19046 starts at the next buffer position. */
19047 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19048 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19051 INC_BOTH (max_pos
, max_bpos
);
19052 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19055 else if (row
->truncated_on_right_p
)
19056 /* display_line already called reseat_at_next_visible_line_start,
19057 which puts the iterator at the beginning of the next line, in
19058 the logical order. */
19059 row
->maxpos
= it
->current
.pos
;
19060 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19061 /* A line that is entirely from a string/image/stretch... */
19062 row
->maxpos
= row
->minpos
;
19067 row
->maxpos
= it
->current
.pos
;
19070 /* Construct the glyph row IT->glyph_row in the desired matrix of
19071 IT->w from text at the current position of IT. See dispextern.h
19072 for an overview of struct it. Value is non-zero if
19073 IT->glyph_row displays text, as opposed to a line displaying ZV
19077 display_line (struct it
*it
)
19079 struct glyph_row
*row
= it
->glyph_row
;
19080 Lisp_Object overlay_arrow_string
;
19082 void *wrap_data
= NULL
;
19083 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19084 int wrap_row_used
= -1;
19085 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19086 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19087 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19088 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19089 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19091 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19092 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19094 /* We always start displaying at hpos zero even if hscrolled. */
19095 xassert (it
->hpos
== 0 && it
->current_x
== 0);
19097 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19098 >= it
->w
->desired_matrix
->nrows
)
19100 it
->w
->nrows_scale_factor
++;
19101 fonts_changed_p
= 1;
19105 /* Is IT->w showing the region? */
19106 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
19108 /* Clear the result glyph row and enable it. */
19109 prepare_desired_row (row
);
19111 row
->y
= it
->current_y
;
19112 row
->start
= it
->start
;
19113 row
->continuation_lines_width
= it
->continuation_lines_width
;
19114 row
->displays_text_p
= 1;
19115 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19116 it
->starts_in_middle_of_char_p
= 0;
19118 /* Arrange the overlays nicely for our purposes. Usually, we call
19119 display_line on only one line at a time, in which case this
19120 can't really hurt too much, or we call it on lines which appear
19121 one after another in the buffer, in which case all calls to
19122 recenter_overlay_lists but the first will be pretty cheap. */
19123 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19125 /* Move over display elements that are not visible because we are
19126 hscrolled. This may stop at an x-position < IT->first_visible_x
19127 if the first glyph is partially visible or if we hit a line end. */
19128 if (it
->current_x
< it
->first_visible_x
)
19130 this_line_min_pos
= row
->start
.pos
;
19131 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19132 MOVE_TO_POS
| MOVE_TO_X
);
19133 /* Record the smallest positions seen while we moved over
19134 display elements that are not visible. This is needed by
19135 redisplay_internal for optimizing the case where the cursor
19136 stays inside the same line. The rest of this function only
19137 considers positions that are actually displayed, so
19138 RECORD_MAX_MIN_POS will not otherwise record positions that
19139 are hscrolled to the left of the left edge of the window. */
19140 min_pos
= CHARPOS (this_line_min_pos
);
19141 min_bpos
= BYTEPOS (this_line_min_pos
);
19145 /* We only do this when not calling `move_it_in_display_line_to'
19146 above, because move_it_in_display_line_to calls
19147 handle_line_prefix itself. */
19148 handle_line_prefix (it
);
19151 /* Get the initial row height. This is either the height of the
19152 text hscrolled, if there is any, or zero. */
19153 row
->ascent
= it
->max_ascent
;
19154 row
->height
= it
->max_ascent
+ it
->max_descent
;
19155 row
->phys_ascent
= it
->max_phys_ascent
;
19156 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19157 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19159 /* Utility macro to record max and min buffer positions seen until now. */
19160 #define RECORD_MAX_MIN_POS(IT) \
19163 int composition_p = !STRINGP ((IT)->string) \
19164 && ((IT)->what == IT_COMPOSITION); \
19165 ptrdiff_t current_pos = \
19166 composition_p ? (IT)->cmp_it.charpos \
19167 : IT_CHARPOS (*(IT)); \
19168 ptrdiff_t current_bpos = \
19169 composition_p ? CHAR_TO_BYTE (current_pos) \
19170 : IT_BYTEPOS (*(IT)); \
19171 if (current_pos < min_pos) \
19173 min_pos = current_pos; \
19174 min_bpos = current_bpos; \
19176 if (IT_CHARPOS (*it) > max_pos) \
19178 max_pos = IT_CHARPOS (*it); \
19179 max_bpos = IT_BYTEPOS (*it); \
19184 /* Loop generating characters. The loop is left with IT on the next
19185 character to display. */
19188 int n_glyphs_before
, hpos_before
, x_before
;
19190 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19192 /* Retrieve the next thing to display. Value is zero if end of
19194 if (!get_next_display_element (it
))
19196 /* Maybe add a space at the end of this line that is used to
19197 display the cursor there under X. Set the charpos of the
19198 first glyph of blank lines not corresponding to any text
19200 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19201 row
->exact_window_width_line_p
= 1;
19202 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19203 || row
->used
[TEXT_AREA
] == 0)
19205 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19206 row
->displays_text_p
= 0;
19208 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19209 && (!MINI_WINDOW_P (it
->w
)
19210 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19211 row
->indicate_empty_line_p
= 1;
19214 it
->continuation_lines_width
= 0;
19215 row
->ends_at_zv_p
= 1;
19216 /* A row that displays right-to-left text must always have
19217 its last face extended all the way to the end of line,
19218 even if this row ends in ZV, because we still write to
19219 the screen left to right. We also need to extend the
19220 last face if the default face is remapped to some
19221 different face, otherwise the functions that clear
19222 portions of the screen will clear with the default face's
19223 background color. */
19224 if (row
->reversed_p
19225 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19226 extend_face_to_end_of_line (it
);
19230 /* Now, get the metrics of what we want to display. This also
19231 generates glyphs in `row' (which is IT->glyph_row). */
19232 n_glyphs_before
= row
->used
[TEXT_AREA
];
19235 /* Remember the line height so far in case the next element doesn't
19236 fit on the line. */
19237 if (it
->line_wrap
!= TRUNCATE
)
19239 ascent
= it
->max_ascent
;
19240 descent
= it
->max_descent
;
19241 phys_ascent
= it
->max_phys_ascent
;
19242 phys_descent
= it
->max_phys_descent
;
19244 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19246 if (IT_DISPLAYING_WHITESPACE (it
))
19250 SAVE_IT (wrap_it
, *it
, wrap_data
);
19252 wrap_row_used
= row
->used
[TEXT_AREA
];
19253 wrap_row_ascent
= row
->ascent
;
19254 wrap_row_height
= row
->height
;
19255 wrap_row_phys_ascent
= row
->phys_ascent
;
19256 wrap_row_phys_height
= row
->phys_height
;
19257 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19258 wrap_row_min_pos
= min_pos
;
19259 wrap_row_min_bpos
= min_bpos
;
19260 wrap_row_max_pos
= max_pos
;
19261 wrap_row_max_bpos
= max_bpos
;
19267 PRODUCE_GLYPHS (it
);
19269 /* If this display element was in marginal areas, continue with
19271 if (it
->area
!= TEXT_AREA
)
19273 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19274 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19275 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19276 row
->phys_height
= max (row
->phys_height
,
19277 it
->max_phys_ascent
+ it
->max_phys_descent
);
19278 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19279 it
->max_extra_line_spacing
);
19280 set_iterator_to_next (it
, 1);
19284 /* Does the display element fit on the line? If we truncate
19285 lines, we should draw past the right edge of the window. If
19286 we don't truncate, we want to stop so that we can display the
19287 continuation glyph before the right margin. If lines are
19288 continued, there are two possible strategies for characters
19289 resulting in more than 1 glyph (e.g. tabs): Display as many
19290 glyphs as possible in this line and leave the rest for the
19291 continuation line, or display the whole element in the next
19292 line. Original redisplay did the former, so we do it also. */
19293 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19294 hpos_before
= it
->hpos
;
19297 if (/* Not a newline. */
19299 /* Glyphs produced fit entirely in the line. */
19300 && it
->current_x
< it
->last_visible_x
)
19302 it
->hpos
+= nglyphs
;
19303 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19304 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19305 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19306 row
->phys_height
= max (row
->phys_height
,
19307 it
->max_phys_ascent
+ it
->max_phys_descent
);
19308 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19309 it
->max_extra_line_spacing
);
19310 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19311 row
->x
= x
- it
->first_visible_x
;
19312 /* Record the maximum and minimum buffer positions seen so
19313 far in glyphs that will be displayed by this row. */
19315 RECORD_MAX_MIN_POS (it
);
19320 struct glyph
*glyph
;
19322 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19324 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19325 new_x
= x
+ glyph
->pixel_width
;
19327 if (/* Lines are continued. */
19328 it
->line_wrap
!= TRUNCATE
19329 && (/* Glyph doesn't fit on the line. */
19330 new_x
> it
->last_visible_x
19331 /* Or it fits exactly on a window system frame. */
19332 || (new_x
== it
->last_visible_x
19333 && FRAME_WINDOW_P (it
->f
))))
19335 /* End of a continued line. */
19338 || (new_x
== it
->last_visible_x
19339 && FRAME_WINDOW_P (it
->f
)))
19341 /* Current glyph is the only one on the line or
19342 fits exactly on the line. We must continue
19343 the line because we can't draw the cursor
19344 after the glyph. */
19345 row
->continued_p
= 1;
19346 it
->current_x
= new_x
;
19347 it
->continuation_lines_width
+= new_x
;
19349 if (i
== nglyphs
- 1)
19351 /* If line-wrap is on, check if a previous
19352 wrap point was found. */
19353 if (wrap_row_used
> 0
19354 /* Even if there is a previous wrap
19355 point, continue the line here as
19356 usual, if (i) the previous character
19357 was a space or tab AND (ii) the
19358 current character is not. */
19360 || IT_DISPLAYING_WHITESPACE (it
)))
19363 /* Record the maximum and minimum buffer
19364 positions seen so far in glyphs that will be
19365 displayed by this row. */
19367 RECORD_MAX_MIN_POS (it
);
19368 set_iterator_to_next (it
, 1);
19369 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19371 if (!get_next_display_element (it
))
19373 row
->exact_window_width_line_p
= 1;
19374 it
->continuation_lines_width
= 0;
19375 row
->continued_p
= 0;
19376 row
->ends_at_zv_p
= 1;
19378 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19380 row
->continued_p
= 0;
19381 row
->exact_window_width_line_p
= 1;
19385 else if (it
->bidi_p
)
19386 RECORD_MAX_MIN_POS (it
);
19388 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19389 && !FRAME_WINDOW_P (it
->f
))
19391 /* A padding glyph that doesn't fit on this line.
19392 This means the whole character doesn't fit
19394 if (row
->reversed_p
)
19395 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19396 - n_glyphs_before
);
19397 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19399 /* Fill the rest of the row with continuation
19400 glyphs like in 20.x. */
19401 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19402 < row
->glyphs
[1 + TEXT_AREA
])
19403 produce_special_glyphs (it
, IT_CONTINUATION
);
19405 row
->continued_p
= 1;
19406 it
->current_x
= x_before
;
19407 it
->continuation_lines_width
+= x_before
;
19409 /* Restore the height to what it was before the
19410 element not fitting on the line. */
19411 it
->max_ascent
= ascent
;
19412 it
->max_descent
= descent
;
19413 it
->max_phys_ascent
= phys_ascent
;
19414 it
->max_phys_descent
= phys_descent
;
19416 else if (wrap_row_used
> 0)
19419 if (row
->reversed_p
)
19420 unproduce_glyphs (it
,
19421 row
->used
[TEXT_AREA
] - wrap_row_used
);
19422 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19423 it
->continuation_lines_width
+= wrap_x
;
19424 row
->used
[TEXT_AREA
] = wrap_row_used
;
19425 row
->ascent
= wrap_row_ascent
;
19426 row
->height
= wrap_row_height
;
19427 row
->phys_ascent
= wrap_row_phys_ascent
;
19428 row
->phys_height
= wrap_row_phys_height
;
19429 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19430 min_pos
= wrap_row_min_pos
;
19431 min_bpos
= wrap_row_min_bpos
;
19432 max_pos
= wrap_row_max_pos
;
19433 max_bpos
= wrap_row_max_bpos
;
19434 row
->continued_p
= 1;
19435 row
->ends_at_zv_p
= 0;
19436 row
->exact_window_width_line_p
= 0;
19437 it
->continuation_lines_width
+= x
;
19439 /* Make sure that a non-default face is extended
19440 up to the right margin of the window. */
19441 extend_face_to_end_of_line (it
);
19443 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19445 /* A TAB that extends past the right edge of the
19446 window. This produces a single glyph on
19447 window system frames. We leave the glyph in
19448 this row and let it fill the row, but don't
19449 consume the TAB. */
19450 it
->continuation_lines_width
+= it
->last_visible_x
;
19451 row
->ends_in_middle_of_char_p
= 1;
19452 row
->continued_p
= 1;
19453 glyph
->pixel_width
= it
->last_visible_x
- x
;
19454 it
->starts_in_middle_of_char_p
= 1;
19458 /* Something other than a TAB that draws past
19459 the right edge of the window. Restore
19460 positions to values before the element. */
19461 if (row
->reversed_p
)
19462 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19463 - (n_glyphs_before
+ i
));
19464 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19466 /* Display continuation glyphs. */
19467 if (!FRAME_WINDOW_P (it
->f
))
19468 produce_special_glyphs (it
, IT_CONTINUATION
);
19469 row
->continued_p
= 1;
19471 it
->current_x
= x_before
;
19472 it
->continuation_lines_width
+= x
;
19473 extend_face_to_end_of_line (it
);
19475 if (nglyphs
> 1 && i
> 0)
19477 row
->ends_in_middle_of_char_p
= 1;
19478 it
->starts_in_middle_of_char_p
= 1;
19481 /* Restore the height to what it was before the
19482 element not fitting on the line. */
19483 it
->max_ascent
= ascent
;
19484 it
->max_descent
= descent
;
19485 it
->max_phys_ascent
= phys_ascent
;
19486 it
->max_phys_descent
= phys_descent
;
19491 else if (new_x
> it
->first_visible_x
)
19493 /* Increment number of glyphs actually displayed. */
19496 /* Record the maximum and minimum buffer positions
19497 seen so far in glyphs that will be displayed by
19500 RECORD_MAX_MIN_POS (it
);
19502 if (x
< it
->first_visible_x
)
19503 /* Glyph is partially visible, i.e. row starts at
19504 negative X position. */
19505 row
->x
= x
- it
->first_visible_x
;
19509 /* Glyph is completely off the left margin of the
19510 window. This should not happen because of the
19511 move_it_in_display_line at the start of this
19512 function, unless the text display area of the
19513 window is empty. */
19514 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19517 /* Even if this display element produced no glyphs at all,
19518 we want to record its position. */
19519 if (it
->bidi_p
&& nglyphs
== 0)
19520 RECORD_MAX_MIN_POS (it
);
19522 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19523 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19524 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19525 row
->phys_height
= max (row
->phys_height
,
19526 it
->max_phys_ascent
+ it
->max_phys_descent
);
19527 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19528 it
->max_extra_line_spacing
);
19530 /* End of this display line if row is continued. */
19531 if (row
->continued_p
|| row
->ends_at_zv_p
)
19536 /* Is this a line end? If yes, we're also done, after making
19537 sure that a non-default face is extended up to the right
19538 margin of the window. */
19539 if (ITERATOR_AT_END_OF_LINE_P (it
))
19541 int used_before
= row
->used
[TEXT_AREA
];
19543 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19545 /* Add a space at the end of the line that is used to
19546 display the cursor there. */
19547 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19548 append_space_for_newline (it
, 0);
19550 /* Extend the face to the end of the line. */
19551 extend_face_to_end_of_line (it
);
19553 /* Make sure we have the position. */
19554 if (used_before
== 0)
19555 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19557 /* Record the position of the newline, for use in
19559 it
->eol_pos
= it
->current
.pos
;
19561 /* Consume the line end. This skips over invisible lines. */
19562 set_iterator_to_next (it
, 1);
19563 it
->continuation_lines_width
= 0;
19567 /* Proceed with next display element. Note that this skips
19568 over lines invisible because of selective display. */
19569 set_iterator_to_next (it
, 1);
19571 /* If we truncate lines, we are done when the last displayed
19572 glyphs reach past the right margin of the window. */
19573 if (it
->line_wrap
== TRUNCATE
19574 && (FRAME_WINDOW_P (it
->f
)
19575 ? (it
->current_x
>= it
->last_visible_x
)
19576 : (it
->current_x
> it
->last_visible_x
)))
19578 /* Maybe add truncation glyphs. */
19579 if (!FRAME_WINDOW_P (it
->f
))
19583 if (!row
->reversed_p
)
19585 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19586 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19591 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19592 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19594 /* Remove any padding glyphs at the front of ROW, to
19595 make room for the truncation glyphs we will be
19596 adding below. The loop below always inserts at
19597 least one truncation glyph, so also remove the
19598 last glyph added to ROW. */
19599 unproduce_glyphs (it
, i
+ 1);
19600 /* Adjust i for the loop below. */
19601 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19604 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19606 row
->used
[TEXT_AREA
] = i
;
19607 produce_special_glyphs (it
, IT_TRUNCATION
);
19610 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19612 /* Don't truncate if we can overflow newline into fringe. */
19613 if (!get_next_display_element (it
))
19615 it
->continuation_lines_width
= 0;
19616 row
->ends_at_zv_p
= 1;
19617 row
->exact_window_width_line_p
= 1;
19620 if (ITERATOR_AT_END_OF_LINE_P (it
))
19622 row
->exact_window_width_line_p
= 1;
19623 goto at_end_of_line
;
19627 row
->truncated_on_right_p
= 1;
19628 it
->continuation_lines_width
= 0;
19629 reseat_at_next_visible_line_start (it
, 0);
19630 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19631 it
->hpos
= hpos_before
;
19632 it
->current_x
= x_before
;
19638 bidi_unshelve_cache (wrap_data
, 1);
19640 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19641 at the left window margin. */
19642 if (it
->first_visible_x
19643 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19645 if (!FRAME_WINDOW_P (it
->f
))
19646 insert_left_trunc_glyphs (it
);
19647 row
->truncated_on_left_p
= 1;
19650 /* Remember the position at which this line ends.
19652 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19653 cannot be before the call to find_row_edges below, since that is
19654 where these positions are determined. */
19655 row
->end
= it
->current
;
19658 row
->minpos
= row
->start
.pos
;
19659 row
->maxpos
= row
->end
.pos
;
19663 /* ROW->minpos and ROW->maxpos must be the smallest and
19664 `1 + the largest' buffer positions in ROW. But if ROW was
19665 bidi-reordered, these two positions can be anywhere in the
19666 row, so we must determine them now. */
19667 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19670 /* If the start of this line is the overlay arrow-position, then
19671 mark this glyph row as the one containing the overlay arrow.
19672 This is clearly a mess with variable size fonts. It would be
19673 better to let it be displayed like cursors under X. */
19674 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19675 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19676 !NILP (overlay_arrow_string
)))
19678 /* Overlay arrow in window redisplay is a fringe bitmap. */
19679 if (STRINGP (overlay_arrow_string
))
19681 struct glyph_row
*arrow_row
19682 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19683 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19684 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19685 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19686 struct glyph
*p2
, *end
;
19688 /* Copy the arrow glyphs. */
19689 while (glyph
< arrow_end
)
19692 /* Throw away padding glyphs. */
19694 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19695 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19701 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19706 xassert (INTEGERP (overlay_arrow_string
));
19707 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19709 overlay_arrow_seen
= 1;
19712 /* Highlight trailing whitespace. */
19713 if (!NILP (Vshow_trailing_whitespace
))
19714 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19716 /* Compute pixel dimensions of this line. */
19717 compute_line_metrics (it
);
19719 /* Implementation note: No changes in the glyphs of ROW or in their
19720 faces can be done past this point, because compute_line_metrics
19721 computes ROW's hash value and stores it within the glyph_row
19724 /* Record whether this row ends inside an ellipsis. */
19725 row
->ends_in_ellipsis_p
19726 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19727 && it
->ellipsis_p
);
19729 /* Save fringe bitmaps in this row. */
19730 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19731 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19732 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19733 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19735 it
->left_user_fringe_bitmap
= 0;
19736 it
->left_user_fringe_face_id
= 0;
19737 it
->right_user_fringe_bitmap
= 0;
19738 it
->right_user_fringe_face_id
= 0;
19740 /* Maybe set the cursor. */
19741 cvpos
= it
->w
->cursor
.vpos
;
19743 /* In bidi-reordered rows, keep checking for proper cursor
19744 position even if one has been found already, because buffer
19745 positions in such rows change non-linearly with ROW->VPOS,
19746 when a line is continued. One exception: when we are at ZV,
19747 display cursor on the first suitable glyph row, since all
19748 the empty rows after that also have their position set to ZV. */
19749 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19750 lines' rows is implemented for bidi-reordered rows. */
19752 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19753 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19754 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19755 && cursor_row_p (row
))
19756 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19758 /* Prepare for the next line. This line starts horizontally at (X
19759 HPOS) = (0 0). Vertical positions are incremented. As a
19760 convenience for the caller, IT->glyph_row is set to the next
19762 it
->current_x
= it
->hpos
= 0;
19763 it
->current_y
+= row
->height
;
19764 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19767 /* The next row should by default use the same value of the
19768 reversed_p flag as this one. set_iterator_to_next decides when
19769 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19770 the flag accordingly. */
19771 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19772 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19773 it
->start
= row
->end
;
19774 return row
->displays_text_p
;
19776 #undef RECORD_MAX_MIN_POS
19779 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19780 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19781 doc
: /* Return paragraph direction at point in BUFFER.
19782 Value is either `left-to-right' or `right-to-left'.
19783 If BUFFER is omitted or nil, it defaults to the current buffer.
19785 Paragraph direction determines how the text in the paragraph is displayed.
19786 In left-to-right paragraphs, text begins at the left margin of the window
19787 and the reading direction is generally left to right. In right-to-left
19788 paragraphs, text begins at the right margin and is read from right to left.
19790 See also `bidi-paragraph-direction'. */)
19791 (Lisp_Object buffer
)
19793 struct buffer
*buf
= current_buffer
;
19794 struct buffer
*old
= buf
;
19796 if (! NILP (buffer
))
19798 CHECK_BUFFER (buffer
);
19799 buf
= XBUFFER (buffer
);
19802 if (NILP (BVAR (buf
, bidi_display_reordering
))
19803 || NILP (BVAR (buf
, enable_multibyte_characters
))
19804 /* When we are loading loadup.el, the character property tables
19805 needed for bidi iteration are not yet available. */
19806 || !NILP (Vpurify_flag
))
19807 return Qleft_to_right
;
19808 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19809 return BVAR (buf
, bidi_paragraph_direction
);
19812 /* Determine the direction from buffer text. We could try to
19813 use current_matrix if it is up to date, but this seems fast
19814 enough as it is. */
19815 struct bidi_it itb
;
19816 ptrdiff_t pos
= BUF_PT (buf
);
19817 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
19819 void *itb_data
= bidi_shelve_cache ();
19821 set_buffer_temp (buf
);
19822 /* bidi_paragraph_init finds the base direction of the paragraph
19823 by searching forward from paragraph start. We need the base
19824 direction of the current or _previous_ paragraph, so we need
19825 to make sure we are within that paragraph. To that end, find
19826 the previous non-empty line. */
19827 if (pos
>= ZV
&& pos
> BEGV
)
19830 bytepos
= CHAR_TO_BYTE (pos
);
19832 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19833 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19835 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19836 || c
== ' ' || c
== '\t' || c
== '\f')
19838 if (bytepos
<= BEGV_BYTE
)
19843 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19846 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19847 itb
.paragraph_dir
= NEUTRAL_DIR
;
19848 itb
.string
.s
= NULL
;
19849 itb
.string
.lstring
= Qnil
;
19850 itb
.string
.bufpos
= 0;
19851 itb
.string
.unibyte
= 0;
19852 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19853 bidi_unshelve_cache (itb_data
, 0);
19854 set_buffer_temp (old
);
19855 switch (itb
.paragraph_dir
)
19858 return Qleft_to_right
;
19861 return Qright_to_left
;
19871 /***********************************************************************
19873 ***********************************************************************/
19875 /* Redisplay the menu bar in the frame for window W.
19877 The menu bar of X frames that don't have X toolkit support is
19878 displayed in a special window W->frame->menu_bar_window.
19880 The menu bar of terminal frames is treated specially as far as
19881 glyph matrices are concerned. Menu bar lines are not part of
19882 windows, so the update is done directly on the frame matrix rows
19883 for the menu bar. */
19886 display_menu_bar (struct window
*w
)
19888 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19893 /* Don't do all this for graphical frames. */
19895 if (FRAME_W32_P (f
))
19898 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19904 if (FRAME_NS_P (f
))
19906 #endif /* HAVE_NS */
19908 #ifdef USE_X_TOOLKIT
19909 xassert (!FRAME_WINDOW_P (f
));
19910 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19911 it
.first_visible_x
= 0;
19912 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19913 #else /* not USE_X_TOOLKIT */
19914 if (FRAME_WINDOW_P (f
))
19916 /* Menu bar lines are displayed in the desired matrix of the
19917 dummy window menu_bar_window. */
19918 struct window
*menu_w
;
19919 xassert (WINDOWP (f
->menu_bar_window
));
19920 menu_w
= XWINDOW (f
->menu_bar_window
);
19921 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19923 it
.first_visible_x
= 0;
19924 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19928 /* This is a TTY frame, i.e. character hpos/vpos are used as
19930 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19932 it
.first_visible_x
= 0;
19933 it
.last_visible_x
= FRAME_COLS (f
);
19935 #endif /* not USE_X_TOOLKIT */
19937 /* FIXME: This should be controlled by a user option. See the
19938 comments in redisplay_tool_bar and display_mode_line about
19940 it
.paragraph_embedding
= L2R
;
19942 if (! mode_line_inverse_video
)
19943 /* Force the menu-bar to be displayed in the default face. */
19944 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19946 /* Clear all rows of the menu bar. */
19947 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19949 struct glyph_row
*row
= it
.glyph_row
+ i
;
19950 clear_glyph_row (row
);
19951 row
->enabled_p
= 1;
19952 row
->full_width_p
= 1;
19955 /* Display all items of the menu bar. */
19956 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19957 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19959 Lisp_Object string
;
19961 /* Stop at nil string. */
19962 string
= AREF (items
, i
+ 1);
19966 /* Remember where item was displayed. */
19967 ASET (items
, i
+ 3, make_number (it
.hpos
));
19969 /* Display the item, pad with one space. */
19970 if (it
.current_x
< it
.last_visible_x
)
19971 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19972 SCHARS (string
) + 1, 0, 0, -1);
19975 /* Fill out the line with spaces. */
19976 if (it
.current_x
< it
.last_visible_x
)
19977 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19979 /* Compute the total height of the lines. */
19980 compute_line_metrics (&it
);
19985 /***********************************************************************
19987 ***********************************************************************/
19989 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19990 FORCE is non-zero, redisplay mode lines unconditionally.
19991 Otherwise, redisplay only mode lines that are garbaged. Value is
19992 the number of windows whose mode lines were redisplayed. */
19995 redisplay_mode_lines (Lisp_Object window
, int force
)
19999 while (!NILP (window
))
20001 struct window
*w
= XWINDOW (window
);
20003 if (WINDOWP (w
->hchild
))
20004 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20005 else if (WINDOWP (w
->vchild
))
20006 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20008 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20009 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20011 struct text_pos lpoint
;
20012 struct buffer
*old
= current_buffer
;
20014 /* Set the window's buffer for the mode line display. */
20015 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20016 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20018 /* Point refers normally to the selected window. For any
20019 other window, set up appropriate value. */
20020 if (!EQ (window
, selected_window
))
20022 struct text_pos pt
;
20024 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20025 if (CHARPOS (pt
) < BEGV
)
20026 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20027 else if (CHARPOS (pt
) > (ZV
- 1))
20028 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20030 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20033 /* Display mode lines. */
20034 clear_glyph_matrix (w
->desired_matrix
);
20035 if (display_mode_lines (w
))
20038 w
->must_be_updated_p
= 1;
20041 /* Restore old settings. */
20042 set_buffer_internal_1 (old
);
20043 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20053 /* Display the mode and/or header line of window W. Value is the
20054 sum number of mode lines and header lines displayed. */
20057 display_mode_lines (struct window
*w
)
20059 Lisp_Object old_selected_window
, old_selected_frame
;
20062 old_selected_frame
= selected_frame
;
20063 selected_frame
= w
->frame
;
20064 old_selected_window
= selected_window
;
20065 XSETWINDOW (selected_window
, w
);
20067 /* These will be set while the mode line specs are processed. */
20068 line_number_displayed
= 0;
20069 w
->column_number_displayed
= Qnil
;
20071 if (WINDOW_WANTS_MODELINE_P (w
))
20073 struct window
*sel_w
= XWINDOW (old_selected_window
);
20075 /* Select mode line face based on the real selected window. */
20076 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20077 BVAR (current_buffer
, mode_line_format
));
20081 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20083 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20084 BVAR (current_buffer
, header_line_format
));
20088 selected_frame
= old_selected_frame
;
20089 selected_window
= old_selected_window
;
20094 /* Display mode or header line of window W. FACE_ID specifies which
20095 line to display; it is either MODE_LINE_FACE_ID or
20096 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20097 display. Value is the pixel height of the mode/header line
20101 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20105 ptrdiff_t count
= SPECPDL_INDEX ();
20107 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20108 /* Don't extend on a previously drawn mode-line.
20109 This may happen if called from pos_visible_p. */
20110 it
.glyph_row
->enabled_p
= 0;
20111 prepare_desired_row (it
.glyph_row
);
20113 it
.glyph_row
->mode_line_p
= 1;
20115 if (! mode_line_inverse_video
)
20116 /* Force the mode-line to be displayed in the default face. */
20117 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
20119 /* FIXME: This should be controlled by a user option. But
20120 supporting such an option is not trivial, since the mode line is
20121 made up of many separate strings. */
20122 it
.paragraph_embedding
= L2R
;
20124 record_unwind_protect (unwind_format_mode_line
,
20125 format_mode_line_unwind_data (NULL
, Qnil
, 0));
20127 mode_line_target
= MODE_LINE_DISPLAY
;
20129 /* Temporarily make frame's keyboard the current kboard so that
20130 kboard-local variables in the mode_line_format will get the right
20132 push_kboard (FRAME_KBOARD (it
.f
));
20133 record_unwind_save_match_data ();
20134 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20137 unbind_to (count
, Qnil
);
20139 /* Fill up with spaces. */
20140 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20142 compute_line_metrics (&it
);
20143 it
.glyph_row
->full_width_p
= 1;
20144 it
.glyph_row
->continued_p
= 0;
20145 it
.glyph_row
->truncated_on_left_p
= 0;
20146 it
.glyph_row
->truncated_on_right_p
= 0;
20148 /* Make a 3D mode-line have a shadow at its right end. */
20149 face
= FACE_FROM_ID (it
.f
, face_id
);
20150 extend_face_to_end_of_line (&it
);
20151 if (face
->box
!= FACE_NO_BOX
)
20153 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20154 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20155 last
->right_box_line_p
= 1;
20158 return it
.glyph_row
->height
;
20161 /* Move element ELT in LIST to the front of LIST.
20162 Return the updated list. */
20165 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20167 register Lisp_Object tail
, prev
;
20168 register Lisp_Object tem
;
20172 while (CONSP (tail
))
20178 /* Splice out the link TAIL. */
20180 list
= XCDR (tail
);
20182 Fsetcdr (prev
, XCDR (tail
));
20184 /* Now make it the first. */
20185 Fsetcdr (tail
, list
);
20190 tail
= XCDR (tail
);
20194 /* Not found--return unchanged LIST. */
20198 /* Contribute ELT to the mode line for window IT->w. How it
20199 translates into text depends on its data type.
20201 IT describes the display environment in which we display, as usual.
20203 DEPTH is the depth in recursion. It is used to prevent
20204 infinite recursion here.
20206 FIELD_WIDTH is the number of characters the display of ELT should
20207 occupy in the mode line, and PRECISION is the maximum number of
20208 characters to display from ELT's representation. See
20209 display_string for details.
20211 Returns the hpos of the end of the text generated by ELT.
20213 PROPS is a property list to add to any string we encounter.
20215 If RISKY is nonzero, remove (disregard) any properties in any string
20216 we encounter, and ignore :eval and :propertize.
20218 The global variable `mode_line_target' determines whether the
20219 output is passed to `store_mode_line_noprop',
20220 `store_mode_line_string', or `display_string'. */
20223 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20224 Lisp_Object elt
, Lisp_Object props
, int risky
)
20226 int n
= 0, field
, prec
;
20231 elt
= build_string ("*too-deep*");
20235 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20239 /* A string: output it and check for %-constructs within it. */
20241 ptrdiff_t offset
= 0;
20243 if (SCHARS (elt
) > 0
20244 && (!NILP (props
) || risky
))
20246 Lisp_Object oprops
, aelt
;
20247 oprops
= Ftext_properties_at (make_number (0), elt
);
20249 /* If the starting string's properties are not what
20250 we want, translate the string. Also, if the string
20251 is risky, do that anyway. */
20253 if (NILP (Fequal (props
, oprops
)) || risky
)
20255 /* If the starting string has properties,
20256 merge the specified ones onto the existing ones. */
20257 if (! NILP (oprops
) && !risky
)
20261 oprops
= Fcopy_sequence (oprops
);
20263 while (CONSP (tem
))
20265 oprops
= Fplist_put (oprops
, XCAR (tem
),
20266 XCAR (XCDR (tem
)));
20267 tem
= XCDR (XCDR (tem
));
20272 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20273 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20275 /* AELT is what we want. Move it to the front
20276 without consing. */
20278 mode_line_proptrans_alist
20279 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20285 /* If AELT has the wrong props, it is useless.
20286 so get rid of it. */
20288 mode_line_proptrans_alist
20289 = Fdelq (aelt
, mode_line_proptrans_alist
);
20291 elt
= Fcopy_sequence (elt
);
20292 Fset_text_properties (make_number (0), Flength (elt
),
20294 /* Add this item to mode_line_proptrans_alist. */
20295 mode_line_proptrans_alist
20296 = Fcons (Fcons (elt
, props
),
20297 mode_line_proptrans_alist
);
20298 /* Truncate mode_line_proptrans_alist
20299 to at most 50 elements. */
20300 tem
= Fnthcdr (make_number (50),
20301 mode_line_proptrans_alist
);
20303 XSETCDR (tem
, Qnil
);
20312 prec
= precision
- n
;
20313 switch (mode_line_target
)
20315 case MODE_LINE_NOPROP
:
20316 case MODE_LINE_TITLE
:
20317 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20319 case MODE_LINE_STRING
:
20320 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20322 case MODE_LINE_DISPLAY
:
20323 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20324 0, prec
, 0, STRING_MULTIBYTE (elt
));
20331 /* Handle the non-literal case. */
20333 while ((precision
<= 0 || n
< precision
)
20334 && SREF (elt
, offset
) != 0
20335 && (mode_line_target
!= MODE_LINE_DISPLAY
20336 || it
->current_x
< it
->last_visible_x
))
20338 ptrdiff_t last_offset
= offset
;
20340 /* Advance to end of string or next format specifier. */
20341 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20344 if (offset
- 1 != last_offset
)
20346 ptrdiff_t nchars
, nbytes
;
20348 /* Output to end of string or up to '%'. Field width
20349 is length of string. Don't output more than
20350 PRECISION allows us. */
20353 prec
= c_string_width (SDATA (elt
) + last_offset
,
20354 offset
- last_offset
, precision
- n
,
20357 switch (mode_line_target
)
20359 case MODE_LINE_NOPROP
:
20360 case MODE_LINE_TITLE
:
20361 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20363 case MODE_LINE_STRING
:
20365 ptrdiff_t bytepos
= last_offset
;
20366 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20367 ptrdiff_t endpos
= (precision
<= 0
20368 ? string_byte_to_char (elt
, offset
)
20369 : charpos
+ nchars
);
20371 n
+= store_mode_line_string (NULL
,
20372 Fsubstring (elt
, make_number (charpos
),
20373 make_number (endpos
)),
20377 case MODE_LINE_DISPLAY
:
20379 ptrdiff_t bytepos
= last_offset
;
20380 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20382 if (precision
<= 0)
20383 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20384 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20386 STRING_MULTIBYTE (elt
));
20391 else /* c == '%' */
20393 ptrdiff_t percent_position
= offset
;
20395 /* Get the specified minimum width. Zero means
20398 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20399 field
= field
* 10 + c
- '0';
20401 /* Don't pad beyond the total padding allowed. */
20402 if (field_width
- n
> 0 && field
> field_width
- n
)
20403 field
= field_width
- n
;
20405 /* Note that either PRECISION <= 0 or N < PRECISION. */
20406 prec
= precision
- n
;
20409 n
+= display_mode_element (it
, depth
, field
, prec
,
20410 Vglobal_mode_string
, props
,
20415 ptrdiff_t bytepos
, charpos
;
20417 Lisp_Object string
;
20419 bytepos
= percent_position
;
20420 charpos
= (STRING_MULTIBYTE (elt
)
20421 ? string_byte_to_char (elt
, bytepos
)
20423 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20424 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20426 switch (mode_line_target
)
20428 case MODE_LINE_NOPROP
:
20429 case MODE_LINE_TITLE
:
20430 n
+= store_mode_line_noprop (spec
, field
, prec
);
20432 case MODE_LINE_STRING
:
20434 Lisp_Object tem
= build_string (spec
);
20435 props
= Ftext_properties_at (make_number (charpos
), elt
);
20436 /* Should only keep face property in props */
20437 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20440 case MODE_LINE_DISPLAY
:
20442 int nglyphs_before
, nwritten
;
20444 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20445 nwritten
= display_string (spec
, string
, elt
,
20450 /* Assign to the glyphs written above the
20451 string where the `%x' came from, position
20455 struct glyph
*glyph
20456 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20460 for (i
= 0; i
< nwritten
; ++i
)
20462 glyph
[i
].object
= elt
;
20463 glyph
[i
].charpos
= charpos
;
20480 /* A symbol: process the value of the symbol recursively
20481 as if it appeared here directly. Avoid error if symbol void.
20482 Special case: if value of symbol is a string, output the string
20485 register Lisp_Object tem
;
20487 /* If the variable is not marked as risky to set
20488 then its contents are risky to use. */
20489 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20492 tem
= Fboundp (elt
);
20495 tem
= Fsymbol_value (elt
);
20496 /* If value is a string, output that string literally:
20497 don't check for % within it. */
20501 if (!EQ (tem
, elt
))
20503 /* Give up right away for nil or t. */
20513 register Lisp_Object car
, tem
;
20515 /* A cons cell: five distinct cases.
20516 If first element is :eval or :propertize, do something special.
20517 If first element is a string or a cons, process all the elements
20518 and effectively concatenate them.
20519 If first element is a negative number, truncate displaying cdr to
20520 at most that many characters. If positive, pad (with spaces)
20521 to at least that many characters.
20522 If first element is a symbol, process the cadr or caddr recursively
20523 according to whether the symbol's value is non-nil or nil. */
20525 if (EQ (car
, QCeval
))
20527 /* An element of the form (:eval FORM) means evaluate FORM
20528 and use the result as mode line elements. */
20533 if (CONSP (XCDR (elt
)))
20536 spec
= safe_eval (XCAR (XCDR (elt
)));
20537 n
+= display_mode_element (it
, depth
, field_width
- n
,
20538 precision
- n
, spec
, props
,
20542 else if (EQ (car
, QCpropertize
))
20544 /* An element of the form (:propertize ELT PROPS...)
20545 means display ELT but applying properties PROPS. */
20550 if (CONSP (XCDR (elt
)))
20551 n
+= display_mode_element (it
, depth
, field_width
- n
,
20552 precision
- n
, XCAR (XCDR (elt
)),
20553 XCDR (XCDR (elt
)), risky
);
20555 else if (SYMBOLP (car
))
20557 tem
= Fboundp (car
);
20561 /* elt is now the cdr, and we know it is a cons cell.
20562 Use its car if CAR has a non-nil value. */
20565 tem
= Fsymbol_value (car
);
20572 /* Symbol's value is nil (or symbol is unbound)
20573 Get the cddr of the original list
20574 and if possible find the caddr and use that. */
20578 else if (!CONSP (elt
))
20583 else if (INTEGERP (car
))
20585 register int lim
= XINT (car
);
20589 /* Negative int means reduce maximum width. */
20590 if (precision
<= 0)
20593 precision
= min (precision
, -lim
);
20597 /* Padding specified. Don't let it be more than
20598 current maximum. */
20600 lim
= min (precision
, lim
);
20602 /* If that's more padding than already wanted, queue it.
20603 But don't reduce padding already specified even if
20604 that is beyond the current truncation point. */
20605 field_width
= max (lim
, field_width
);
20609 else if (STRINGP (car
) || CONSP (car
))
20611 Lisp_Object halftail
= elt
;
20615 && (precision
<= 0 || n
< precision
))
20617 n
+= display_mode_element (it
, depth
,
20618 /* Do padding only after the last
20619 element in the list. */
20620 (! CONSP (XCDR (elt
))
20623 precision
- n
, XCAR (elt
),
20627 if ((len
& 1) == 0)
20628 halftail
= XCDR (halftail
);
20629 /* Check for cycle. */
20630 if (EQ (halftail
, elt
))
20639 elt
= build_string ("*invalid*");
20643 /* Pad to FIELD_WIDTH. */
20644 if (field_width
> 0 && n
< field_width
)
20646 switch (mode_line_target
)
20648 case MODE_LINE_NOPROP
:
20649 case MODE_LINE_TITLE
:
20650 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20652 case MODE_LINE_STRING
:
20653 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20655 case MODE_LINE_DISPLAY
:
20656 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20665 /* Store a mode-line string element in mode_line_string_list.
20667 If STRING is non-null, display that C string. Otherwise, the Lisp
20668 string LISP_STRING is displayed.
20670 FIELD_WIDTH is the minimum number of output glyphs to produce.
20671 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20672 with spaces. FIELD_WIDTH <= 0 means don't pad.
20674 PRECISION is the maximum number of characters to output from
20675 STRING. PRECISION <= 0 means don't truncate the string.
20677 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20678 properties to the string.
20680 PROPS are the properties to add to the string.
20681 The mode_line_string_face face property is always added to the string.
20685 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20686 int field_width
, int precision
, Lisp_Object props
)
20691 if (string
!= NULL
)
20693 len
= strlen (string
);
20694 if (precision
> 0 && len
> precision
)
20696 lisp_string
= make_string (string
, len
);
20698 props
= mode_line_string_face_prop
;
20699 else if (!NILP (mode_line_string_face
))
20701 Lisp_Object face
= Fplist_get (props
, Qface
);
20702 props
= Fcopy_sequence (props
);
20704 face
= mode_line_string_face
;
20706 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20707 props
= Fplist_put (props
, Qface
, face
);
20709 Fadd_text_properties (make_number (0), make_number (len
),
20710 props
, lisp_string
);
20714 len
= XFASTINT (Flength (lisp_string
));
20715 if (precision
> 0 && len
> precision
)
20718 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20721 if (!NILP (mode_line_string_face
))
20725 props
= Ftext_properties_at (make_number (0), lisp_string
);
20726 face
= Fplist_get (props
, Qface
);
20728 face
= mode_line_string_face
;
20730 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20731 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20733 lisp_string
= Fcopy_sequence (lisp_string
);
20736 Fadd_text_properties (make_number (0), make_number (len
),
20737 props
, lisp_string
);
20742 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20746 if (field_width
> len
)
20748 field_width
-= len
;
20749 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20751 Fadd_text_properties (make_number (0), make_number (field_width
),
20752 props
, lisp_string
);
20753 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20761 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20763 doc
: /* Format a string out of a mode line format specification.
20764 First arg FORMAT specifies the mode line format (see `mode-line-format'
20765 for details) to use.
20767 By default, the format is evaluated for the currently selected window.
20769 Optional second arg FACE specifies the face property to put on all
20770 characters for which no face is specified. The value nil means the
20771 default face. The value t means whatever face the window's mode line
20772 currently uses (either `mode-line' or `mode-line-inactive',
20773 depending on whether the window is the selected window or not).
20774 An integer value means the value string has no text
20777 Optional third and fourth args WINDOW and BUFFER specify the window
20778 and buffer to use as the context for the formatting (defaults
20779 are the selected window and the WINDOW's buffer). */)
20780 (Lisp_Object format
, Lisp_Object face
,
20781 Lisp_Object window
, Lisp_Object buffer
)
20786 struct buffer
*old_buffer
= NULL
;
20788 int no_props
= INTEGERP (face
);
20789 ptrdiff_t count
= SPECPDL_INDEX ();
20791 int string_start
= 0;
20794 window
= selected_window
;
20795 CHECK_WINDOW (window
);
20796 w
= XWINDOW (window
);
20799 buffer
= w
->buffer
;
20800 CHECK_BUFFER (buffer
);
20802 /* Make formatting the modeline a non-op when noninteractive, otherwise
20803 there will be problems later caused by a partially initialized frame. */
20804 if (NILP (format
) || noninteractive
)
20805 return empty_unibyte_string
;
20810 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20811 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20812 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20813 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20814 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20815 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20816 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20819 if (XBUFFER (buffer
) != current_buffer
)
20820 old_buffer
= current_buffer
;
20822 /* Save things including mode_line_proptrans_alist,
20823 and set that to nil so that we don't alter the outer value. */
20824 record_unwind_protect (unwind_format_mode_line
,
20825 format_mode_line_unwind_data
20826 (old_buffer
, selected_window
, 1));
20827 mode_line_proptrans_alist
= Qnil
;
20829 Fselect_window (window
, Qt
);
20831 set_buffer_internal_1 (XBUFFER (buffer
));
20833 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20837 mode_line_target
= MODE_LINE_NOPROP
;
20838 mode_line_string_face_prop
= Qnil
;
20839 mode_line_string_list
= Qnil
;
20840 string_start
= MODE_LINE_NOPROP_LEN (0);
20844 mode_line_target
= MODE_LINE_STRING
;
20845 mode_line_string_list
= Qnil
;
20846 mode_line_string_face
= face
;
20847 mode_line_string_face_prop
20848 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20851 push_kboard (FRAME_KBOARD (it
.f
));
20852 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20857 len
= MODE_LINE_NOPROP_LEN (string_start
);
20858 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20862 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20863 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20864 empty_unibyte_string
);
20867 unbind_to (count
, Qnil
);
20871 /* Write a null-terminated, right justified decimal representation of
20872 the positive integer D to BUF using a minimal field width WIDTH. */
20875 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
20877 register char *p
= buf
;
20885 *p
++ = d
% 10 + '0';
20890 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20901 /* Write a null-terminated, right justified decimal and "human
20902 readable" representation of the nonnegative integer D to BUF using
20903 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20905 static const char power_letter
[] =
20919 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
20921 /* We aim to represent the nonnegative integer D as
20922 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20923 ptrdiff_t quotient
= d
;
20925 /* -1 means: do not use TENTHS. */
20929 /* Length of QUOTIENT.TENTHS as a string. */
20935 if (1000 <= quotient
)
20937 /* Scale to the appropriate EXPONENT. */
20940 remainder
= quotient
% 1000;
20944 while (1000 <= quotient
);
20946 /* Round to nearest and decide whether to use TENTHS or not. */
20949 tenths
= remainder
/ 100;
20950 if (50 <= remainder
% 100)
20957 if (quotient
== 10)
20965 if (500 <= remainder
)
20967 if (quotient
< 999)
20978 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20979 if (tenths
== -1 && quotient
<= 99)
20986 p
= psuffix
= buf
+ max (width
, length
);
20988 /* Print EXPONENT. */
20989 *psuffix
++ = power_letter
[exponent
];
20992 /* Print TENTHS. */
20995 *--p
= '0' + tenths
;
20999 /* Print QUOTIENT. */
21002 int digit
= quotient
% 10;
21003 *--p
= '0' + digit
;
21005 while ((quotient
/= 10) != 0);
21007 /* Print leading spaces. */
21012 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21013 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21014 type of CODING_SYSTEM. Return updated pointer into BUF. */
21016 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21019 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21022 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21023 const unsigned char *eol_str
;
21025 /* The EOL conversion we are using. */
21026 Lisp_Object eoltype
;
21028 val
= CODING_SYSTEM_SPEC (coding_system
);
21031 if (!VECTORP (val
)) /* Not yet decided. */
21033 *buf
++ = multibyte
? '-' : ' ';
21035 eoltype
= eol_mnemonic_undecided
;
21036 /* Don't mention EOL conversion if it isn't decided. */
21041 Lisp_Object eolvalue
;
21043 attrs
= AREF (val
, 0);
21044 eolvalue
= AREF (val
, 2);
21047 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21052 /* The EOL conversion that is normal on this system. */
21054 if (NILP (eolvalue
)) /* Not yet decided. */
21055 eoltype
= eol_mnemonic_undecided
;
21056 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21057 eoltype
= eol_mnemonic_undecided
;
21058 else /* eolvalue is Qunix, Qdos, or Qmac. */
21059 eoltype
= (EQ (eolvalue
, Qunix
)
21060 ? eol_mnemonic_unix
21061 : (EQ (eolvalue
, Qdos
) == 1
21062 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21068 /* Mention the EOL conversion if it is not the usual one. */
21069 if (STRINGP (eoltype
))
21071 eol_str
= SDATA (eoltype
);
21072 eol_str_len
= SBYTES (eoltype
);
21074 else if (CHARACTERP (eoltype
))
21076 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
21077 int c
= XFASTINT (eoltype
);
21078 eol_str_len
= CHAR_STRING (c
, tmp
);
21083 eol_str
= invalid_eol_type
;
21084 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21086 memcpy (buf
, eol_str
, eol_str_len
);
21087 buf
+= eol_str_len
;
21093 /* Return a string for the output of a mode line %-spec for window W,
21094 generated by character C. FIELD_WIDTH > 0 means pad the string
21095 returned with spaces to that value. Return a Lisp string in
21096 *STRING if the resulting string is taken from that Lisp string.
21098 Note we operate on the current buffer for most purposes,
21099 the exception being w->base_line_pos. */
21101 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21103 static const char *
21104 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21105 Lisp_Object
*string
)
21108 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21109 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21110 struct buffer
*b
= current_buffer
;
21118 if (!NILP (BVAR (b
, read_only
)))
21120 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21125 /* This differs from %* only for a modified read-only buffer. */
21126 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21128 if (!NILP (BVAR (b
, read_only
)))
21133 /* This differs from %* in ignoring read-only-ness. */
21134 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21146 if (command_loop_level
> 5)
21148 p
= decode_mode_spec_buf
;
21149 for (i
= 0; i
< command_loop_level
; i
++)
21152 return decode_mode_spec_buf
;
21160 if (command_loop_level
> 5)
21162 p
= decode_mode_spec_buf
;
21163 for (i
= 0; i
< command_loop_level
; i
++)
21166 return decode_mode_spec_buf
;
21173 /* Let lots_of_dashes be a string of infinite length. */
21174 if (mode_line_target
== MODE_LINE_NOPROP
||
21175 mode_line_target
== MODE_LINE_STRING
)
21177 if (field_width
<= 0
21178 || field_width
> sizeof (lots_of_dashes
))
21180 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21181 decode_mode_spec_buf
[i
] = '-';
21182 decode_mode_spec_buf
[i
] = '\0';
21183 return decode_mode_spec_buf
;
21186 return lots_of_dashes
;
21190 obj
= BVAR (b
, name
);
21194 /* %c and %l are ignored in `frame-title-format'.
21195 (In redisplay_internal, the frame title is drawn _before_ the
21196 windows are updated, so the stuff which depends on actual
21197 window contents (such as %l) may fail to render properly, or
21198 even crash emacs.) */
21199 if (mode_line_target
== MODE_LINE_TITLE
)
21203 ptrdiff_t col
= current_column ();
21204 w
->column_number_displayed
= make_number (col
);
21205 pint2str (decode_mode_spec_buf
, field_width
, col
);
21206 return decode_mode_spec_buf
;
21210 #ifndef SYSTEM_MALLOC
21212 if (NILP (Vmemory_full
))
21215 return "!MEM FULL! ";
21222 /* %F displays the frame name. */
21223 if (!NILP (f
->title
))
21224 return SSDATA (f
->title
);
21225 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21226 return SSDATA (f
->name
);
21230 obj
= BVAR (b
, filename
);
21235 ptrdiff_t size
= ZV
- BEGV
;
21236 pint2str (decode_mode_spec_buf
, field_width
, size
);
21237 return decode_mode_spec_buf
;
21242 ptrdiff_t size
= ZV
- BEGV
;
21243 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21244 return decode_mode_spec_buf
;
21249 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21250 ptrdiff_t topline
, nlines
, height
;
21253 /* %c and %l are ignored in `frame-title-format'. */
21254 if (mode_line_target
== MODE_LINE_TITLE
)
21257 startpos
= XMARKER (w
->start
)->charpos
;
21258 startpos_byte
= marker_byte_position (w
->start
);
21259 height
= WINDOW_TOTAL_LINES (w
);
21261 /* If we decided that this buffer isn't suitable for line numbers,
21262 don't forget that too fast. */
21263 if (EQ (w
->base_line_pos
, w
->buffer
))
21265 /* But do forget it, if the window shows a different buffer now. */
21266 else if (BUFFERP (w
->base_line_pos
))
21267 w
->base_line_pos
= Qnil
;
21269 /* If the buffer is very big, don't waste time. */
21270 if (INTEGERP (Vline_number_display_limit
)
21271 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21273 w
->base_line_pos
= Qnil
;
21274 w
->base_line_number
= Qnil
;
21278 if (INTEGERP (w
->base_line_number
)
21279 && INTEGERP (w
->base_line_pos
)
21280 && XFASTINT (w
->base_line_pos
) <= startpos
)
21282 line
= XFASTINT (w
->base_line_number
);
21283 linepos
= XFASTINT (w
->base_line_pos
);
21284 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21289 linepos
= BUF_BEGV (b
);
21290 linepos_byte
= BUF_BEGV_BYTE (b
);
21293 /* Count lines from base line to window start position. */
21294 nlines
= display_count_lines (linepos_byte
,
21298 topline
= nlines
+ line
;
21300 /* Determine a new base line, if the old one is too close
21301 or too far away, or if we did not have one.
21302 "Too close" means it's plausible a scroll-down would
21303 go back past it. */
21304 if (startpos
== BUF_BEGV (b
))
21306 w
->base_line_number
= make_number (topline
);
21307 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21309 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21310 || linepos
== BUF_BEGV (b
))
21312 ptrdiff_t limit
= BUF_BEGV (b
);
21313 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21314 ptrdiff_t position
;
21315 ptrdiff_t distance
=
21316 (height
* 2 + 30) * line_number_display_limit_width
;
21318 if (startpos
- distance
> limit
)
21320 limit
= startpos
- distance
;
21321 limit_byte
= CHAR_TO_BYTE (limit
);
21324 nlines
= display_count_lines (startpos_byte
,
21326 - (height
* 2 + 30),
21328 /* If we couldn't find the lines we wanted within
21329 line_number_display_limit_width chars per line,
21330 give up on line numbers for this window. */
21331 if (position
== limit_byte
&& limit
== startpos
- distance
)
21333 w
->base_line_pos
= w
->buffer
;
21334 w
->base_line_number
= Qnil
;
21338 w
->base_line_number
= make_number (topline
- nlines
);
21339 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21342 /* Now count lines from the start pos to point. */
21343 nlines
= display_count_lines (startpos_byte
,
21344 PT_BYTE
, PT
, &junk
);
21346 /* Record that we did display the line number. */
21347 line_number_displayed
= 1;
21349 /* Make the string to show. */
21350 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21351 return decode_mode_spec_buf
;
21354 char* p
= decode_mode_spec_buf
;
21355 int pad
= field_width
- 2;
21361 return decode_mode_spec_buf
;
21367 obj
= BVAR (b
, mode_name
);
21371 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21377 ptrdiff_t pos
= marker_position (w
->start
);
21378 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21380 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21382 if (pos
<= BUF_BEGV (b
))
21387 else if (pos
<= BUF_BEGV (b
))
21391 if (total
> 1000000)
21392 /* Do it differently for a large value, to avoid overflow. */
21393 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21395 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21396 /* We can't normally display a 3-digit number,
21397 so get us a 2-digit number that is close. */
21400 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21401 return decode_mode_spec_buf
;
21405 /* Display percentage of size above the bottom of the screen. */
21408 ptrdiff_t toppos
= marker_position (w
->start
);
21409 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21410 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21412 if (botpos
>= BUF_ZV (b
))
21414 if (toppos
<= BUF_BEGV (b
))
21421 if (total
> 1000000)
21422 /* Do it differently for a large value, to avoid overflow. */
21423 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21425 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21426 /* We can't normally display a 3-digit number,
21427 so get us a 2-digit number that is close. */
21430 if (toppos
<= BUF_BEGV (b
))
21431 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21433 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21434 return decode_mode_spec_buf
;
21439 /* status of process */
21440 obj
= Fget_buffer_process (Fcurrent_buffer ());
21442 return "no process";
21444 obj
= Fsymbol_name (Fprocess_status (obj
));
21450 ptrdiff_t count
= inhibit_garbage_collection ();
21451 Lisp_Object val
= call1 (intern ("file-remote-p"),
21452 BVAR (current_buffer
, directory
));
21453 unbind_to (count
, Qnil
);
21461 case 't': /* indicate TEXT or BINARY */
21465 /* coding-system (not including end-of-line format) */
21467 /* coding-system (including end-of-line type) */
21469 int eol_flag
= (c
== 'Z');
21470 char *p
= decode_mode_spec_buf
;
21472 if (! FRAME_WINDOW_P (f
))
21474 /* No need to mention EOL here--the terminal never needs
21475 to do EOL conversion. */
21476 p
= decode_mode_spec_coding (CODING_ID_NAME
21477 (FRAME_KEYBOARD_CODING (f
)->id
),
21479 p
= decode_mode_spec_coding (CODING_ID_NAME
21480 (FRAME_TERMINAL_CODING (f
)->id
),
21483 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21486 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21487 #ifdef subprocesses
21488 obj
= Fget_buffer_process (Fcurrent_buffer ());
21489 if (PROCESSP (obj
))
21491 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21493 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21496 #endif /* subprocesses */
21499 return decode_mode_spec_buf
;
21506 return SSDATA (obj
);
21513 /* Count up to COUNT lines starting from START_BYTE.
21514 But don't go beyond LIMIT_BYTE.
21515 Return the number of lines thus found (always nonnegative).
21517 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21520 display_count_lines (ptrdiff_t start_byte
,
21521 ptrdiff_t limit_byte
, ptrdiff_t count
,
21522 ptrdiff_t *byte_pos_ptr
)
21524 register unsigned char *cursor
;
21525 unsigned char *base
;
21527 register ptrdiff_t ceiling
;
21528 register unsigned char *ceiling_addr
;
21529 ptrdiff_t orig_count
= count
;
21531 /* If we are not in selective display mode,
21532 check only for newlines. */
21533 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21534 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21538 while (start_byte
< limit_byte
)
21540 ceiling
= BUFFER_CEILING_OF (start_byte
);
21541 ceiling
= min (limit_byte
- 1, ceiling
);
21542 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21543 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21546 if (selective_display
)
21547 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21550 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21553 if (cursor
!= ceiling_addr
)
21557 start_byte
+= cursor
- base
+ 1;
21558 *byte_pos_ptr
= start_byte
;
21562 if (++cursor
== ceiling_addr
)
21568 start_byte
+= cursor
- base
;
21573 while (start_byte
> limit_byte
)
21575 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21576 ceiling
= max (limit_byte
, ceiling
);
21577 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21578 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21581 if (selective_display
)
21582 while (--cursor
!= ceiling_addr
21583 && *cursor
!= '\n' && *cursor
!= 015)
21586 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21589 if (cursor
!= ceiling_addr
)
21593 start_byte
+= cursor
- base
+ 1;
21594 *byte_pos_ptr
= start_byte
;
21595 /* When scanning backwards, we should
21596 not count the newline posterior to which we stop. */
21597 return - orig_count
- 1;
21603 /* Here we add 1 to compensate for the last decrement
21604 of CURSOR, which took it past the valid range. */
21605 start_byte
+= cursor
- base
+ 1;
21609 *byte_pos_ptr
= limit_byte
;
21612 return - orig_count
+ count
;
21613 return orig_count
- count
;
21619 /***********************************************************************
21621 ***********************************************************************/
21623 /* Display a NUL-terminated string, starting with index START.
21625 If STRING is non-null, display that C string. Otherwise, the Lisp
21626 string LISP_STRING is displayed. There's a case that STRING is
21627 non-null and LISP_STRING is not nil. It means STRING is a string
21628 data of LISP_STRING. In that case, we display LISP_STRING while
21629 ignoring its text properties.
21631 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21632 FACE_STRING. Display STRING or LISP_STRING with the face at
21633 FACE_STRING_POS in FACE_STRING:
21635 Display the string in the environment given by IT, but use the
21636 standard display table, temporarily.
21638 FIELD_WIDTH is the minimum number of output glyphs to produce.
21639 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21640 with spaces. If STRING has more characters, more than FIELD_WIDTH
21641 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21643 PRECISION is the maximum number of characters to output from
21644 STRING. PRECISION < 0 means don't truncate the string.
21646 This is roughly equivalent to printf format specifiers:
21648 FIELD_WIDTH PRECISION PRINTF
21649 ----------------------------------------
21655 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21656 display them, and < 0 means obey the current buffer's value of
21657 enable_multibyte_characters.
21659 Value is the number of columns displayed. */
21662 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21663 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21664 int field_width
, int precision
, int max_x
, int multibyte
)
21666 int hpos_at_start
= it
->hpos
;
21667 int saved_face_id
= it
->face_id
;
21668 struct glyph_row
*row
= it
->glyph_row
;
21669 ptrdiff_t it_charpos
;
21671 /* Initialize the iterator IT for iteration over STRING beginning
21672 with index START. */
21673 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21674 precision
, field_width
, multibyte
);
21675 if (string
&& STRINGP (lisp_string
))
21676 /* LISP_STRING is the one returned by decode_mode_spec. We should
21677 ignore its text properties. */
21678 it
->stop_charpos
= it
->end_charpos
;
21680 /* If displaying STRING, set up the face of the iterator from
21681 FACE_STRING, if that's given. */
21682 if (STRINGP (face_string
))
21688 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21689 0, it
->region_beg_charpos
,
21690 it
->region_end_charpos
,
21691 &endptr
, it
->base_face_id
, 0);
21692 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21693 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21696 /* Set max_x to the maximum allowed X position. Don't let it go
21697 beyond the right edge of the window. */
21699 max_x
= it
->last_visible_x
;
21701 max_x
= min (max_x
, it
->last_visible_x
);
21703 /* Skip over display elements that are not visible. because IT->w is
21705 if (it
->current_x
< it
->first_visible_x
)
21706 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21707 MOVE_TO_POS
| MOVE_TO_X
);
21709 row
->ascent
= it
->max_ascent
;
21710 row
->height
= it
->max_ascent
+ it
->max_descent
;
21711 row
->phys_ascent
= it
->max_phys_ascent
;
21712 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21713 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21715 if (STRINGP (it
->string
))
21716 it_charpos
= IT_STRING_CHARPOS (*it
);
21718 it_charpos
= IT_CHARPOS (*it
);
21720 /* This condition is for the case that we are called with current_x
21721 past last_visible_x. */
21722 while (it
->current_x
< max_x
)
21724 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21726 /* Get the next display element. */
21727 if (!get_next_display_element (it
))
21730 /* Produce glyphs. */
21731 x_before
= it
->current_x
;
21732 n_glyphs_before
= row
->used
[TEXT_AREA
];
21733 PRODUCE_GLYPHS (it
);
21735 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21738 while (i
< nglyphs
)
21740 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21742 if (it
->line_wrap
!= TRUNCATE
21743 && x
+ glyph
->pixel_width
> max_x
)
21745 /* End of continued line or max_x reached. */
21746 if (CHAR_GLYPH_PADDING_P (*glyph
))
21748 /* A wide character is unbreakable. */
21749 if (row
->reversed_p
)
21750 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21751 - n_glyphs_before
);
21752 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21753 it
->current_x
= x_before
;
21757 if (row
->reversed_p
)
21758 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21759 - (n_glyphs_before
+ i
));
21760 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21765 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21767 /* Glyph is at least partially visible. */
21769 if (x
< it
->first_visible_x
)
21770 row
->x
= x
- it
->first_visible_x
;
21774 /* Glyph is off the left margin of the display area.
21775 Should not happen. */
21779 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21780 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21781 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21782 row
->phys_height
= max (row
->phys_height
,
21783 it
->max_phys_ascent
+ it
->max_phys_descent
);
21784 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21785 it
->max_extra_line_spacing
);
21786 x
+= glyph
->pixel_width
;
21790 /* Stop if max_x reached. */
21794 /* Stop at line ends. */
21795 if (ITERATOR_AT_END_OF_LINE_P (it
))
21797 it
->continuation_lines_width
= 0;
21801 set_iterator_to_next (it
, 1);
21802 if (STRINGP (it
->string
))
21803 it_charpos
= IT_STRING_CHARPOS (*it
);
21805 it_charpos
= IT_CHARPOS (*it
);
21807 /* Stop if truncating at the right edge. */
21808 if (it
->line_wrap
== TRUNCATE
21809 && it
->current_x
>= it
->last_visible_x
)
21811 /* Add truncation mark, but don't do it if the line is
21812 truncated at a padding space. */
21813 if (it_charpos
< it
->string_nchars
)
21815 if (!FRAME_WINDOW_P (it
->f
))
21819 if (it
->current_x
> it
->last_visible_x
)
21821 if (!row
->reversed_p
)
21823 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21824 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21829 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21830 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21832 unproduce_glyphs (it
, ii
+ 1);
21833 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21835 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21837 row
->used
[TEXT_AREA
] = ii
;
21838 produce_special_glyphs (it
, IT_TRUNCATION
);
21841 produce_special_glyphs (it
, IT_TRUNCATION
);
21843 row
->truncated_on_right_p
= 1;
21849 /* Maybe insert a truncation at the left. */
21850 if (it
->first_visible_x
21853 if (!FRAME_WINDOW_P (it
->f
))
21854 insert_left_trunc_glyphs (it
);
21855 row
->truncated_on_left_p
= 1;
21858 it
->face_id
= saved_face_id
;
21860 /* Value is number of columns displayed. */
21861 return it
->hpos
- hpos_at_start
;
21866 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21867 appears as an element of LIST or as the car of an element of LIST.
21868 If PROPVAL is a list, compare each element against LIST in that
21869 way, and return 1/2 if any element of PROPVAL is found in LIST.
21870 Otherwise return 0. This function cannot quit.
21871 The return value is 2 if the text is invisible but with an ellipsis
21872 and 1 if it's invisible and without an ellipsis. */
21875 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21877 register Lisp_Object tail
, proptail
;
21879 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21881 register Lisp_Object tem
;
21883 if (EQ (propval
, tem
))
21885 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21886 return NILP (XCDR (tem
)) ? 1 : 2;
21889 if (CONSP (propval
))
21891 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21893 Lisp_Object propelt
;
21894 propelt
= XCAR (proptail
);
21895 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21897 register Lisp_Object tem
;
21899 if (EQ (propelt
, tem
))
21901 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21902 return NILP (XCDR (tem
)) ? 1 : 2;
21910 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21911 doc
: /* Non-nil if the property makes the text invisible.
21912 POS-OR-PROP can be a marker or number, in which case it is taken to be
21913 a position in the current buffer and the value of the `invisible' property
21914 is checked; or it can be some other value, which is then presumed to be the
21915 value of the `invisible' property of the text of interest.
21916 The non-nil value returned can be t for truly invisible text or something
21917 else if the text is replaced by an ellipsis. */)
21918 (Lisp_Object pos_or_prop
)
21921 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21922 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21924 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21925 return (invis
== 0 ? Qnil
21927 : make_number (invis
));
21930 /* Calculate a width or height in pixels from a specification using
21931 the following elements:
21934 NUM - a (fractional) multiple of the default font width/height
21935 (NUM) - specifies exactly NUM pixels
21936 UNIT - a fixed number of pixels, see below.
21937 ELEMENT - size of a display element in pixels, see below.
21938 (NUM . SPEC) - equals NUM * SPEC
21939 (+ SPEC SPEC ...) - add pixel values
21940 (- SPEC SPEC ...) - subtract pixel values
21941 (- SPEC) - negate pixel value
21944 INT or FLOAT - a number constant
21945 SYMBOL - use symbol's (buffer local) variable binding.
21948 in - pixels per inch *)
21949 mm - pixels per 1/1000 meter *)
21950 cm - pixels per 1/100 meter *)
21951 width - width of current font in pixels.
21952 height - height of current font in pixels.
21954 *) using the ratio(s) defined in display-pixels-per-inch.
21958 left-fringe - left fringe width in pixels
21959 right-fringe - right fringe width in pixels
21961 left-margin - left margin width in pixels
21962 right-margin - right margin width in pixels
21964 scroll-bar - scroll-bar area width in pixels
21968 Pixels corresponding to 5 inches:
21971 Total width of non-text areas on left side of window (if scroll-bar is on left):
21972 '(space :width (+ left-fringe left-margin scroll-bar))
21974 Align to first text column (in header line):
21975 '(space :align-to 0)
21977 Align to middle of text area minus half the width of variable `my-image'
21978 containing a loaded image:
21979 '(space :align-to (0.5 . (- text my-image)))
21981 Width of left margin minus width of 1 character in the default font:
21982 '(space :width (- left-margin 1))
21984 Width of left margin minus width of 2 characters in the current font:
21985 '(space :width (- left-margin (2 . width)))
21987 Center 1 character over left-margin (in header line):
21988 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21990 Different ways to express width of left fringe plus left margin minus one pixel:
21991 '(space :width (- (+ left-fringe left-margin) (1)))
21992 '(space :width (+ left-fringe left-margin (- (1))))
21993 '(space :width (+ left-fringe left-margin (-1)))
21997 #define NUMVAL(X) \
21998 ((INTEGERP (X) || FLOATP (X)) \
22003 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22004 struct font
*font
, int width_p
, int *align_to
)
22008 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22009 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22012 return OK_PIXELS (0);
22014 xassert (FRAME_LIVE_P (it
->f
));
22016 if (SYMBOLP (prop
))
22018 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22020 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22022 if (unit
[0] == 'i' && unit
[1] == 'n')
22024 else if (unit
[0] == 'm' && unit
[1] == 'm')
22026 else if (unit
[0] == 'c' && unit
[1] == 'm')
22033 #ifdef HAVE_WINDOW_SYSTEM
22034 if (FRAME_WINDOW_P (it
->f
)
22036 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22037 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22039 return OK_PIXELS (ppi
/ pixels
);
22042 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22043 || (CONSP (Vdisplay_pixels_per_inch
)
22045 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22046 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22048 return OK_PIXELS (ppi
/ pixels
);
22054 #ifdef HAVE_WINDOW_SYSTEM
22055 if (EQ (prop
, Qheight
))
22056 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22057 if (EQ (prop
, Qwidth
))
22058 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22060 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22061 return OK_PIXELS (1);
22064 if (EQ (prop
, Qtext
))
22065 return OK_PIXELS (width_p
22066 ? window_box_width (it
->w
, TEXT_AREA
)
22067 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22069 if (align_to
&& *align_to
< 0)
22072 if (EQ (prop
, Qleft
))
22073 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22074 if (EQ (prop
, Qright
))
22075 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22076 if (EQ (prop
, Qcenter
))
22077 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22078 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22079 if (EQ (prop
, Qleft_fringe
))
22080 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22082 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22083 if (EQ (prop
, Qright_fringe
))
22084 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22085 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22086 : window_box_right_offset (it
->w
, TEXT_AREA
));
22087 if (EQ (prop
, Qleft_margin
))
22088 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22089 if (EQ (prop
, Qright_margin
))
22090 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22091 if (EQ (prop
, Qscroll_bar
))
22092 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22094 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22095 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22096 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22101 if (EQ (prop
, Qleft_fringe
))
22102 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22103 if (EQ (prop
, Qright_fringe
))
22104 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22105 if (EQ (prop
, Qleft_margin
))
22106 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22107 if (EQ (prop
, Qright_margin
))
22108 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22109 if (EQ (prop
, Qscroll_bar
))
22110 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22113 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22114 if (EQ (prop
, Qunbound
))
22118 if (INTEGERP (prop
) || FLOATP (prop
))
22120 int base_unit
= (width_p
22121 ? FRAME_COLUMN_WIDTH (it
->f
)
22122 : FRAME_LINE_HEIGHT (it
->f
));
22123 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22128 Lisp_Object car
= XCAR (prop
);
22129 Lisp_Object cdr
= XCDR (prop
);
22133 #ifdef HAVE_WINDOW_SYSTEM
22134 if (FRAME_WINDOW_P (it
->f
)
22135 && valid_image_p (prop
))
22137 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22138 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22140 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22143 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22149 while (CONSP (cdr
))
22151 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22152 font
, width_p
, align_to
))
22155 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22160 if (EQ (car
, Qminus
))
22162 return OK_PIXELS (pixels
);
22165 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22166 if (EQ (car
, Qunbound
))
22170 if (INTEGERP (car
) || FLOATP (car
))
22173 pixels
= XFLOATINT (car
);
22175 return OK_PIXELS (pixels
);
22176 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22177 font
, width_p
, align_to
))
22178 return OK_PIXELS (pixels
* fact
);
22189 /***********************************************************************
22191 ***********************************************************************/
22193 #ifdef HAVE_WINDOW_SYSTEM
22198 dump_glyph_string (struct glyph_string
*s
)
22200 fprintf (stderr
, "glyph string\n");
22201 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22202 s
->x
, s
->y
, s
->width
, s
->height
);
22203 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22204 fprintf (stderr
, " hl = %d\n", s
->hl
);
22205 fprintf (stderr
, " left overhang = %d, right = %d\n",
22206 s
->left_overhang
, s
->right_overhang
);
22207 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22208 fprintf (stderr
, " extends to end of line = %d\n",
22209 s
->extends_to_end_of_line_p
);
22210 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22211 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22214 #endif /* GLYPH_DEBUG */
22216 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22217 of XChar2b structures for S; it can't be allocated in
22218 init_glyph_string because it must be allocated via `alloca'. W
22219 is the window on which S is drawn. ROW and AREA are the glyph row
22220 and area within the row from which S is constructed. START is the
22221 index of the first glyph structure covered by S. HL is a
22222 face-override for drawing S. */
22225 #define OPTIONAL_HDC(hdc) HDC hdc,
22226 #define DECLARE_HDC(hdc) HDC hdc;
22227 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22228 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22231 #ifndef OPTIONAL_HDC
22232 #define OPTIONAL_HDC(hdc)
22233 #define DECLARE_HDC(hdc)
22234 #define ALLOCATE_HDC(hdc, f)
22235 #define RELEASE_HDC(hdc, f)
22239 init_glyph_string (struct glyph_string
*s
,
22241 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22242 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22244 memset (s
, 0, sizeof *s
);
22246 s
->f
= XFRAME (w
->frame
);
22250 s
->display
= FRAME_X_DISPLAY (s
->f
);
22251 s
->window
= FRAME_X_WINDOW (s
->f
);
22252 s
->char2b
= char2b
;
22256 s
->first_glyph
= row
->glyphs
[area
] + start
;
22257 s
->height
= row
->height
;
22258 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22259 s
->ybase
= s
->y
+ row
->ascent
;
22263 /* Append the list of glyph strings with head H and tail T to the list
22264 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22267 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22268 struct glyph_string
*h
, struct glyph_string
*t
)
22282 /* Prepend the list of glyph strings with head H and tail T to the
22283 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22287 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22288 struct glyph_string
*h
, struct glyph_string
*t
)
22302 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22303 Set *HEAD and *TAIL to the resulting list. */
22306 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22307 struct glyph_string
*s
)
22309 s
->next
= s
->prev
= NULL
;
22310 append_glyph_string_lists (head
, tail
, s
, s
);
22314 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22315 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22316 make sure that X resources for the face returned are allocated.
22317 Value is a pointer to a realized face that is ready for display if
22318 DISPLAY_P is non-zero. */
22320 static inline struct face
*
22321 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22322 XChar2b
*char2b
, int display_p
)
22324 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22328 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22330 if (code
!= FONT_INVALID_CODE
)
22331 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22333 STORE_XCHAR2B (char2b
, 0, 0);
22336 /* Make sure X resources of the face are allocated. */
22337 #ifdef HAVE_X_WINDOWS
22341 xassert (face
!= NULL
);
22342 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22349 /* Get face and two-byte form of character glyph GLYPH on frame F.
22350 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22351 a pointer to a realized face that is ready for display. */
22353 static inline struct face
*
22354 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22355 XChar2b
*char2b
, int *two_byte_p
)
22359 xassert (glyph
->type
== CHAR_GLYPH
);
22360 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22369 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22370 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22372 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22374 if (code
!= FONT_INVALID_CODE
)
22375 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22377 STORE_XCHAR2B (char2b
, 0, 0);
22380 /* Make sure X resources of the face are allocated. */
22381 xassert (face
!= NULL
);
22382 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22387 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22388 Return 1 if FONT has a glyph for C, otherwise return 0. */
22391 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22395 if (CHAR_BYTE8_P (c
))
22396 code
= CHAR_TO_BYTE8 (c
);
22398 code
= font
->driver
->encode_char (font
, c
);
22400 if (code
== FONT_INVALID_CODE
)
22402 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22407 /* Fill glyph string S with composition components specified by S->cmp.
22409 BASE_FACE is the base face of the composition.
22410 S->cmp_from is the index of the first component for S.
22412 OVERLAPS non-zero means S should draw the foreground only, and use
22413 its physical height for clipping. See also draw_glyphs.
22415 Value is the index of a component not in S. */
22418 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22422 /* For all glyphs of this composition, starting at the offset
22423 S->cmp_from, until we reach the end of the definition or encounter a
22424 glyph that requires the different face, add it to S. */
22429 s
->for_overlaps
= overlaps
;
22432 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22434 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22436 /* TAB in a composition means display glyphs with padding space
22437 on the left or right. */
22440 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22443 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22450 s
->font
= s
->face
->font
;
22452 else if (s
->face
!= face
)
22460 if (s
->face
== NULL
)
22462 s
->face
= base_face
->ascii_face
;
22463 s
->font
= s
->face
->font
;
22466 /* All glyph strings for the same composition has the same width,
22467 i.e. the width set for the first component of the composition. */
22468 s
->width
= s
->first_glyph
->pixel_width
;
22470 /* If the specified font could not be loaded, use the frame's
22471 default font, but record the fact that we couldn't load it in
22472 the glyph string so that we can draw rectangles for the
22473 characters of the glyph string. */
22474 if (s
->font
== NULL
)
22476 s
->font_not_found_p
= 1;
22477 s
->font
= FRAME_FONT (s
->f
);
22480 /* Adjust base line for subscript/superscript text. */
22481 s
->ybase
+= s
->first_glyph
->voffset
;
22483 /* This glyph string must always be drawn with 16-bit functions. */
22490 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22491 int start
, int end
, int overlaps
)
22493 struct glyph
*glyph
, *last
;
22494 Lisp_Object lgstring
;
22497 s
->for_overlaps
= overlaps
;
22498 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22499 last
= s
->row
->glyphs
[s
->area
] + end
;
22500 s
->cmp_id
= glyph
->u
.cmp
.id
;
22501 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22502 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22503 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22504 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22505 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22507 while (glyph
< last
22508 && glyph
->u
.cmp
.automatic
22509 && glyph
->u
.cmp
.id
== s
->cmp_id
22510 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22511 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22513 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22515 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22516 unsigned code
= LGLYPH_CODE (lglyph
);
22518 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22520 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22521 return glyph
- s
->row
->glyphs
[s
->area
];
22525 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22526 See the comment of fill_glyph_string for arguments.
22527 Value is the index of the first glyph not in S. */
22531 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22532 int start
, int end
, int overlaps
)
22534 struct glyph
*glyph
, *last
;
22537 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22538 s
->for_overlaps
= overlaps
;
22539 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22540 last
= s
->row
->glyphs
[s
->area
] + end
;
22541 voffset
= glyph
->voffset
;
22542 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22543 s
->font
= s
->face
->font
;
22545 s
->width
= glyph
->pixel_width
;
22547 while (glyph
< last
22548 && glyph
->type
== GLYPHLESS_GLYPH
22549 && glyph
->voffset
== voffset
22550 && glyph
->face_id
== face_id
)
22553 s
->width
+= glyph
->pixel_width
;
22556 s
->ybase
+= voffset
;
22557 return glyph
- s
->row
->glyphs
[s
->area
];
22561 /* Fill glyph string S from a sequence of character glyphs.
22563 FACE_ID is the face id of the string. START is the index of the
22564 first glyph to consider, END is the index of the last + 1.
22565 OVERLAPS non-zero means S should draw the foreground only, and use
22566 its physical height for clipping. See also draw_glyphs.
22568 Value is the index of the first glyph not in S. */
22571 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22572 int start
, int end
, int overlaps
)
22574 struct glyph
*glyph
, *last
;
22576 int glyph_not_available_p
;
22578 xassert (s
->f
== XFRAME (s
->w
->frame
));
22579 xassert (s
->nchars
== 0);
22580 xassert (start
>= 0 && end
> start
);
22582 s
->for_overlaps
= overlaps
;
22583 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22584 last
= s
->row
->glyphs
[s
->area
] + end
;
22585 voffset
= glyph
->voffset
;
22586 s
->padding_p
= glyph
->padding_p
;
22587 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22589 while (glyph
< last
22590 && glyph
->type
== CHAR_GLYPH
22591 && glyph
->voffset
== voffset
22592 /* Same face id implies same font, nowadays. */
22593 && glyph
->face_id
== face_id
22594 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22598 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22599 s
->char2b
+ s
->nchars
,
22601 s
->two_byte_p
= two_byte_p
;
22603 xassert (s
->nchars
<= end
- start
);
22604 s
->width
+= glyph
->pixel_width
;
22605 if (glyph
++->padding_p
!= s
->padding_p
)
22609 s
->font
= s
->face
->font
;
22611 /* If the specified font could not be loaded, use the frame's font,
22612 but record the fact that we couldn't load it in
22613 S->font_not_found_p so that we can draw rectangles for the
22614 characters of the glyph string. */
22615 if (s
->font
== NULL
|| glyph_not_available_p
)
22617 s
->font_not_found_p
= 1;
22618 s
->font
= FRAME_FONT (s
->f
);
22621 /* Adjust base line for subscript/superscript text. */
22622 s
->ybase
+= voffset
;
22624 xassert (s
->face
&& s
->face
->gc
);
22625 return glyph
- s
->row
->glyphs
[s
->area
];
22629 /* Fill glyph string S from image glyph S->first_glyph. */
22632 fill_image_glyph_string (struct glyph_string
*s
)
22634 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22635 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22637 s
->slice
= s
->first_glyph
->slice
.img
;
22638 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22639 s
->font
= s
->face
->font
;
22640 s
->width
= s
->first_glyph
->pixel_width
;
22642 /* Adjust base line for subscript/superscript text. */
22643 s
->ybase
+= s
->first_glyph
->voffset
;
22647 /* Fill glyph string S from a sequence of stretch glyphs.
22649 START is the index of the first glyph to consider,
22650 END is the index of the last + 1.
22652 Value is the index of the first glyph not in S. */
22655 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22657 struct glyph
*glyph
, *last
;
22658 int voffset
, face_id
;
22660 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22662 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22663 last
= s
->row
->glyphs
[s
->area
] + end
;
22664 face_id
= glyph
->face_id
;
22665 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22666 s
->font
= s
->face
->font
;
22667 s
->width
= glyph
->pixel_width
;
22669 voffset
= glyph
->voffset
;
22673 && glyph
->type
== STRETCH_GLYPH
22674 && glyph
->voffset
== voffset
22675 && glyph
->face_id
== face_id
);
22677 s
->width
+= glyph
->pixel_width
;
22679 /* Adjust base line for subscript/superscript text. */
22680 s
->ybase
+= voffset
;
22682 /* The case that face->gc == 0 is handled when drawing the glyph
22683 string by calling PREPARE_FACE_FOR_DISPLAY. */
22685 return glyph
- s
->row
->glyphs
[s
->area
];
22688 static struct font_metrics
*
22689 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22691 static struct font_metrics metrics
;
22692 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22694 if (! font
|| code
== FONT_INVALID_CODE
)
22696 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22701 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22702 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22703 assumed to be zero. */
22706 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22708 *left
= *right
= 0;
22710 if (glyph
->type
== CHAR_GLYPH
)
22714 struct font_metrics
*pcm
;
22716 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22717 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22719 if (pcm
->rbearing
> pcm
->width
)
22720 *right
= pcm
->rbearing
- pcm
->width
;
22721 if (pcm
->lbearing
< 0)
22722 *left
= -pcm
->lbearing
;
22725 else if (glyph
->type
== COMPOSITE_GLYPH
)
22727 if (! glyph
->u
.cmp
.automatic
)
22729 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22731 if (cmp
->rbearing
> cmp
->pixel_width
)
22732 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22733 if (cmp
->lbearing
< 0)
22734 *left
= - cmp
->lbearing
;
22738 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22739 struct font_metrics metrics
;
22741 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22742 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22743 if (metrics
.rbearing
> metrics
.width
)
22744 *right
= metrics
.rbearing
- metrics
.width
;
22745 if (metrics
.lbearing
< 0)
22746 *left
= - metrics
.lbearing
;
22752 /* Return the index of the first glyph preceding glyph string S that
22753 is overwritten by S because of S's left overhang. Value is -1
22754 if no glyphs are overwritten. */
22757 left_overwritten (struct glyph_string
*s
)
22761 if (s
->left_overhang
)
22764 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22765 int first
= s
->first_glyph
- glyphs
;
22767 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22768 x
-= glyphs
[i
].pixel_width
;
22779 /* Return the index of the first glyph preceding glyph string S that
22780 is overwriting S because of its right overhang. Value is -1 if no
22781 glyph in front of S overwrites S. */
22784 left_overwriting (struct glyph_string
*s
)
22787 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22788 int first
= s
->first_glyph
- glyphs
;
22792 for (i
= first
- 1; i
>= 0; --i
)
22795 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22798 x
-= glyphs
[i
].pixel_width
;
22805 /* Return the index of the last glyph following glyph string S that is
22806 overwritten by S because of S's right overhang. Value is -1 if
22807 no such glyph is found. */
22810 right_overwritten (struct glyph_string
*s
)
22814 if (s
->right_overhang
)
22817 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22818 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22819 int end
= s
->row
->used
[s
->area
];
22821 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22822 x
+= glyphs
[i
].pixel_width
;
22831 /* Return the index of the last glyph following glyph string S that
22832 overwrites S because of its left overhang. Value is negative
22833 if no such glyph is found. */
22836 right_overwriting (struct glyph_string
*s
)
22839 int end
= s
->row
->used
[s
->area
];
22840 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22841 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22845 for (i
= first
; i
< end
; ++i
)
22848 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22851 x
+= glyphs
[i
].pixel_width
;
22858 /* Set background width of glyph string S. START is the index of the
22859 first glyph following S. LAST_X is the right-most x-position + 1
22860 in the drawing area. */
22863 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22865 /* If the face of this glyph string has to be drawn to the end of
22866 the drawing area, set S->extends_to_end_of_line_p. */
22868 if (start
== s
->row
->used
[s
->area
]
22869 && s
->area
== TEXT_AREA
22870 && ((s
->row
->fill_line_p
22871 && (s
->hl
== DRAW_NORMAL_TEXT
22872 || s
->hl
== DRAW_IMAGE_RAISED
22873 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22874 || s
->hl
== DRAW_MOUSE_FACE
))
22875 s
->extends_to_end_of_line_p
= 1;
22877 /* If S extends its face to the end of the line, set its
22878 background_width to the distance to the right edge of the drawing
22880 if (s
->extends_to_end_of_line_p
)
22881 s
->background_width
= last_x
- s
->x
+ 1;
22883 s
->background_width
= s
->width
;
22887 /* Compute overhangs and x-positions for glyph string S and its
22888 predecessors, or successors. X is the starting x-position for S.
22889 BACKWARD_P non-zero means process predecessors. */
22892 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22898 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22899 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22909 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22910 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22920 /* The following macros are only called from draw_glyphs below.
22921 They reference the following parameters of that function directly:
22922 `w', `row', `area', and `overlap_p'
22923 as well as the following local variables:
22924 `s', `f', and `hdc' (in W32) */
22927 /* On W32, silently add local `hdc' variable to argument list of
22928 init_glyph_string. */
22929 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22930 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22932 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22933 init_glyph_string (s, char2b, w, row, area, start, hl)
22936 /* Add a glyph string for a stretch glyph to the list of strings
22937 between HEAD and TAIL. START is the index of the stretch glyph in
22938 row area AREA of glyph row ROW. END is the index of the last glyph
22939 in that glyph row area. X is the current output position assigned
22940 to the new glyph string constructed. HL overrides that face of the
22941 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22942 is the right-most x-position of the drawing area. */
22944 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22945 and below -- keep them on one line. */
22946 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22949 s = (struct glyph_string *) alloca (sizeof *s); \
22950 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22951 START = fill_stretch_glyph_string (s, START, END); \
22952 append_glyph_string (&HEAD, &TAIL, s); \
22958 /* Add a glyph string for an image glyph to the list of strings
22959 between HEAD and TAIL. START is the index of the image glyph in
22960 row area AREA of glyph row ROW. END is the index of the last glyph
22961 in that glyph row area. X is the current output position assigned
22962 to the new glyph string constructed. HL overrides that face of the
22963 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22964 is the right-most x-position of the drawing area. */
22966 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22969 s = (struct glyph_string *) alloca (sizeof *s); \
22970 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22971 fill_image_glyph_string (s); \
22972 append_glyph_string (&HEAD, &TAIL, s); \
22979 /* Add a glyph string for a sequence of character glyphs to the list
22980 of strings between HEAD and TAIL. START is the index of the first
22981 glyph in row area AREA of glyph row ROW that is part of the new
22982 glyph string. END is the index of the last glyph in that glyph row
22983 area. X is the current output position assigned to the new glyph
22984 string constructed. HL overrides that face of the glyph; e.g. it
22985 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22986 right-most x-position of the drawing area. */
22988 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22994 face_id = (row)->glyphs[area][START].face_id; \
22996 s = (struct glyph_string *) alloca (sizeof *s); \
22997 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22998 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22999 append_glyph_string (&HEAD, &TAIL, s); \
23001 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23006 /* Add a glyph string for a composite sequence to the list of strings
23007 between HEAD and TAIL. START is the index of the first glyph in
23008 row area AREA of glyph row ROW that is part of the new glyph
23009 string. END is the index of the last glyph in that glyph row area.
23010 X is the current output position assigned to the new glyph string
23011 constructed. HL overrides that face of the glyph; e.g. it is
23012 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23013 x-position of the drawing area. */
23015 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23017 int face_id = (row)->glyphs[area][START].face_id; \
23018 struct face *base_face = FACE_FROM_ID (f, face_id); \
23019 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23020 struct composition *cmp = composition_table[cmp_id]; \
23022 struct glyph_string *first_s = NULL; \
23025 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
23027 /* Make glyph_strings for each glyph sequence that is drawable by \
23028 the same face, and append them to HEAD/TAIL. */ \
23029 for (n = 0; n < cmp->glyph_len;) \
23031 s = (struct glyph_string *) alloca (sizeof *s); \
23032 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23033 append_glyph_string (&(HEAD), &(TAIL), s); \
23039 n = fill_composite_glyph_string (s, base_face, overlaps); \
23047 /* Add a glyph string for a glyph-string sequence to the list of strings
23048 between HEAD and TAIL. */
23050 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23054 Lisp_Object gstring; \
23056 face_id = (row)->glyphs[area][START].face_id; \
23057 gstring = (composition_gstring_from_id \
23058 ((row)->glyphs[area][START].u.cmp.id)); \
23059 s = (struct glyph_string *) alloca (sizeof *s); \
23060 char2b = (XChar2b *) alloca ((sizeof *char2b) \
23061 * LGSTRING_GLYPH_LEN (gstring)); \
23062 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23063 append_glyph_string (&(HEAD), &(TAIL), s); \
23065 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23069 /* Add a glyph string for a sequence of glyphless character's glyphs
23070 to the list of strings between HEAD and TAIL. The meanings of
23071 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23073 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23078 face_id = (row)->glyphs[area][START].face_id; \
23080 s = (struct glyph_string *) alloca (sizeof *s); \
23081 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23082 append_glyph_string (&HEAD, &TAIL, s); \
23084 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23090 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23091 of AREA of glyph row ROW on window W between indices START and END.
23092 HL overrides the face for drawing glyph strings, e.g. it is
23093 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23094 x-positions of the drawing area.
23096 This is an ugly monster macro construct because we must use alloca
23097 to allocate glyph strings (because draw_glyphs can be called
23098 asynchronously). */
23100 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23103 HEAD = TAIL = NULL; \
23104 while (START < END) \
23106 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23107 switch (first_glyph->type) \
23110 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23114 case COMPOSITE_GLYPH: \
23115 if (first_glyph->u.cmp.automatic) \
23116 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23119 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23123 case STRETCH_GLYPH: \
23124 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23128 case IMAGE_GLYPH: \
23129 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23133 case GLYPHLESS_GLYPH: \
23134 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23144 set_glyph_string_background_width (s, START, LAST_X); \
23151 /* Draw glyphs between START and END in AREA of ROW on window W,
23152 starting at x-position X. X is relative to AREA in W. HL is a
23153 face-override with the following meaning:
23155 DRAW_NORMAL_TEXT draw normally
23156 DRAW_CURSOR draw in cursor face
23157 DRAW_MOUSE_FACE draw in mouse face.
23158 DRAW_INVERSE_VIDEO draw in mode line face
23159 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23160 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23162 If OVERLAPS is non-zero, draw only the foreground of characters and
23163 clip to the physical height of ROW. Non-zero value also defines
23164 the overlapping part to be drawn:
23166 OVERLAPS_PRED overlap with preceding rows
23167 OVERLAPS_SUCC overlap with succeeding rows
23168 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23169 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23171 Value is the x-position reached, relative to AREA of W. */
23174 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23175 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23176 enum draw_glyphs_face hl
, int overlaps
)
23178 struct glyph_string
*head
, *tail
;
23179 struct glyph_string
*s
;
23180 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23181 int i
, j
, x_reached
, last_x
, area_left
= 0;
23182 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23185 ALLOCATE_HDC (hdc
, f
);
23187 /* Let's rather be paranoid than getting a SEGV. */
23188 end
= min (end
, row
->used
[area
]);
23189 start
= max (0, start
);
23190 start
= min (end
, start
);
23192 /* Translate X to frame coordinates. Set last_x to the right
23193 end of the drawing area. */
23194 if (row
->full_width_p
)
23196 /* X is relative to the left edge of W, without scroll bars
23198 area_left
= WINDOW_LEFT_EDGE_X (w
);
23199 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23203 area_left
= window_box_left (w
, area
);
23204 last_x
= area_left
+ window_box_width (w
, area
);
23208 /* Build a doubly-linked list of glyph_string structures between
23209 head and tail from what we have to draw. Note that the macro
23210 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23211 the reason we use a separate variable `i'. */
23213 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23215 x_reached
= tail
->x
+ tail
->background_width
;
23219 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23220 the row, redraw some glyphs in front or following the glyph
23221 strings built above. */
23222 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23224 struct glyph_string
*h
, *t
;
23225 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23226 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23227 int check_mouse_face
= 0;
23230 /* If mouse highlighting is on, we may need to draw adjacent
23231 glyphs using mouse-face highlighting. */
23232 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23234 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23236 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23237 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23239 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23241 check_mouse_face
= 1;
23242 mouse_beg_col
= (row
== mouse_beg_row
)
23243 ? hlinfo
->mouse_face_beg_col
: 0;
23244 mouse_end_col
= (row
== mouse_end_row
)
23245 ? hlinfo
->mouse_face_end_col
23246 : row
->used
[TEXT_AREA
];
23250 /* Compute overhangs for all glyph strings. */
23251 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23252 for (s
= head
; s
; s
= s
->next
)
23253 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23255 /* Prepend glyph strings for glyphs in front of the first glyph
23256 string that are overwritten because of the first glyph
23257 string's left overhang. The background of all strings
23258 prepended must be drawn because the first glyph string
23260 i
= left_overwritten (head
);
23263 enum draw_glyphs_face overlap_hl
;
23265 /* If this row contains mouse highlighting, attempt to draw
23266 the overlapped glyphs with the correct highlight. This
23267 code fails if the overlap encompasses more than one glyph
23268 and mouse-highlight spans only some of these glyphs.
23269 However, making it work perfectly involves a lot more
23270 code, and I don't know if the pathological case occurs in
23271 practice, so we'll stick to this for now. --- cyd */
23272 if (check_mouse_face
23273 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23274 overlap_hl
= DRAW_MOUSE_FACE
;
23276 overlap_hl
= DRAW_NORMAL_TEXT
;
23279 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23280 overlap_hl
, dummy_x
, last_x
);
23282 compute_overhangs_and_x (t
, head
->x
, 1);
23283 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23287 /* Prepend glyph strings for glyphs in front of the first glyph
23288 string that overwrite that glyph string because of their
23289 right overhang. For these strings, only the foreground must
23290 be drawn, because it draws over the glyph string at `head'.
23291 The background must not be drawn because this would overwrite
23292 right overhangs of preceding glyphs for which no glyph
23294 i
= left_overwriting (head
);
23297 enum draw_glyphs_face overlap_hl
;
23299 if (check_mouse_face
23300 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23301 overlap_hl
= DRAW_MOUSE_FACE
;
23303 overlap_hl
= DRAW_NORMAL_TEXT
;
23306 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23307 overlap_hl
, dummy_x
, last_x
);
23308 for (s
= h
; s
; s
= s
->next
)
23309 s
->background_filled_p
= 1;
23310 compute_overhangs_and_x (t
, head
->x
, 1);
23311 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23314 /* Append glyphs strings for glyphs following the last glyph
23315 string tail that are overwritten by tail. The background of
23316 these strings has to be drawn because tail's foreground draws
23318 i
= right_overwritten (tail
);
23321 enum draw_glyphs_face overlap_hl
;
23323 if (check_mouse_face
23324 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23325 overlap_hl
= DRAW_MOUSE_FACE
;
23327 overlap_hl
= DRAW_NORMAL_TEXT
;
23329 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23330 overlap_hl
, x
, last_x
);
23331 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23332 we don't have `end = i;' here. */
23333 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23334 append_glyph_string_lists (&head
, &tail
, h
, t
);
23338 /* Append glyph strings for glyphs following the last glyph
23339 string tail that overwrite tail. The foreground of such
23340 glyphs has to be drawn because it writes into the background
23341 of tail. The background must not be drawn because it could
23342 paint over the foreground of following glyphs. */
23343 i
= right_overwriting (tail
);
23346 enum draw_glyphs_face overlap_hl
;
23347 if (check_mouse_face
23348 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23349 overlap_hl
= DRAW_MOUSE_FACE
;
23351 overlap_hl
= DRAW_NORMAL_TEXT
;
23354 i
++; /* We must include the Ith glyph. */
23355 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23356 overlap_hl
, x
, last_x
);
23357 for (s
= h
; s
; s
= s
->next
)
23358 s
->background_filled_p
= 1;
23359 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23360 append_glyph_string_lists (&head
, &tail
, h
, t
);
23362 if (clip_head
|| clip_tail
)
23363 for (s
= head
; s
; s
= s
->next
)
23365 s
->clip_head
= clip_head
;
23366 s
->clip_tail
= clip_tail
;
23370 /* Draw all strings. */
23371 for (s
= head
; s
; s
= s
->next
)
23372 FRAME_RIF (f
)->draw_glyph_string (s
);
23375 /* When focus a sole frame and move horizontally, this sets on_p to 0
23376 causing a failure to erase prev cursor position. */
23377 if (area
== TEXT_AREA
23378 && !row
->full_width_p
23379 /* When drawing overlapping rows, only the glyph strings'
23380 foreground is drawn, which doesn't erase a cursor
23384 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23385 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23386 : (tail
? tail
->x
+ tail
->background_width
: x
));
23390 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23391 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23395 /* Value is the x-position up to which drawn, relative to AREA of W.
23396 This doesn't include parts drawn because of overhangs. */
23397 if (row
->full_width_p
)
23398 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23400 x_reached
-= area_left
;
23402 RELEASE_HDC (hdc
, f
);
23407 /* Expand row matrix if too narrow. Don't expand if area
23410 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23412 if (!fonts_changed_p \
23413 && (it->glyph_row->glyphs[area] \
23414 < it->glyph_row->glyphs[area + 1])) \
23416 it->w->ncols_scale_factor++; \
23417 fonts_changed_p = 1; \
23421 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23422 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23425 append_glyph (struct it
*it
)
23427 struct glyph
*glyph
;
23428 enum glyph_row_area area
= it
->area
;
23430 xassert (it
->glyph_row
);
23431 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23433 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23434 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23436 /* If the glyph row is reversed, we need to prepend the glyph
23437 rather than append it. */
23438 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23442 /* Make room for the additional glyph. */
23443 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23445 glyph
= it
->glyph_row
->glyphs
[area
];
23447 glyph
->charpos
= CHARPOS (it
->position
);
23448 glyph
->object
= it
->object
;
23449 if (it
->pixel_width
> 0)
23451 glyph
->pixel_width
= it
->pixel_width
;
23452 glyph
->padding_p
= 0;
23456 /* Assure at least 1-pixel width. Otherwise, cursor can't
23457 be displayed correctly. */
23458 glyph
->pixel_width
= 1;
23459 glyph
->padding_p
= 1;
23461 glyph
->ascent
= it
->ascent
;
23462 glyph
->descent
= it
->descent
;
23463 glyph
->voffset
= it
->voffset
;
23464 glyph
->type
= CHAR_GLYPH
;
23465 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23466 glyph
->multibyte_p
= it
->multibyte_p
;
23467 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23468 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23469 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23470 || it
->phys_descent
> it
->descent
);
23471 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23472 glyph
->face_id
= it
->face_id
;
23473 glyph
->u
.ch
= it
->char_to_display
;
23474 glyph
->slice
.img
= null_glyph_slice
;
23475 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23478 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23479 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23481 glyph
->bidi_type
= it
->bidi_it
.type
;
23485 glyph
->resolved_level
= 0;
23486 glyph
->bidi_type
= UNKNOWN_BT
;
23488 ++it
->glyph_row
->used
[area
];
23491 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23494 /* Store one glyph for the composition IT->cmp_it.id in
23495 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23499 append_composite_glyph (struct it
*it
)
23501 struct glyph
*glyph
;
23502 enum glyph_row_area area
= it
->area
;
23504 xassert (it
->glyph_row
);
23506 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23507 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23509 /* If the glyph row is reversed, we need to prepend the glyph
23510 rather than append it. */
23511 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23515 /* Make room for the new glyph. */
23516 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23518 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23520 glyph
->charpos
= it
->cmp_it
.charpos
;
23521 glyph
->object
= it
->object
;
23522 glyph
->pixel_width
= it
->pixel_width
;
23523 glyph
->ascent
= it
->ascent
;
23524 glyph
->descent
= it
->descent
;
23525 glyph
->voffset
= it
->voffset
;
23526 glyph
->type
= COMPOSITE_GLYPH
;
23527 if (it
->cmp_it
.ch
< 0)
23529 glyph
->u
.cmp
.automatic
= 0;
23530 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23531 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23535 glyph
->u
.cmp
.automatic
= 1;
23536 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23537 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23538 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23540 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23541 glyph
->multibyte_p
= it
->multibyte_p
;
23542 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23543 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23544 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23545 || it
->phys_descent
> it
->descent
);
23546 glyph
->padding_p
= 0;
23547 glyph
->glyph_not_available_p
= 0;
23548 glyph
->face_id
= it
->face_id
;
23549 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23552 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23553 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23555 glyph
->bidi_type
= it
->bidi_it
.type
;
23557 ++it
->glyph_row
->used
[area
];
23560 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23564 /* Change IT->ascent and IT->height according to the setting of
23568 take_vertical_position_into_account (struct it
*it
)
23572 if (it
->voffset
< 0)
23573 /* Increase the ascent so that we can display the text higher
23575 it
->ascent
-= it
->voffset
;
23577 /* Increase the descent so that we can display the text lower
23579 it
->descent
+= it
->voffset
;
23584 /* Produce glyphs/get display metrics for the image IT is loaded with.
23585 See the description of struct display_iterator in dispextern.h for
23586 an overview of struct display_iterator. */
23589 produce_image_glyph (struct it
*it
)
23593 int glyph_ascent
, crop
;
23594 struct glyph_slice slice
;
23596 xassert (it
->what
== IT_IMAGE
);
23598 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23600 /* Make sure X resources of the face is loaded. */
23601 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23603 if (it
->image_id
< 0)
23605 /* Fringe bitmap. */
23606 it
->ascent
= it
->phys_ascent
= 0;
23607 it
->descent
= it
->phys_descent
= 0;
23608 it
->pixel_width
= 0;
23613 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23615 /* Make sure X resources of the image is loaded. */
23616 prepare_image_for_display (it
->f
, img
);
23618 slice
.x
= slice
.y
= 0;
23619 slice
.width
= img
->width
;
23620 slice
.height
= img
->height
;
23622 if (INTEGERP (it
->slice
.x
))
23623 slice
.x
= XINT (it
->slice
.x
);
23624 else if (FLOATP (it
->slice
.x
))
23625 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23627 if (INTEGERP (it
->slice
.y
))
23628 slice
.y
= XINT (it
->slice
.y
);
23629 else if (FLOATP (it
->slice
.y
))
23630 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23632 if (INTEGERP (it
->slice
.width
))
23633 slice
.width
= XINT (it
->slice
.width
);
23634 else if (FLOATP (it
->slice
.width
))
23635 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23637 if (INTEGERP (it
->slice
.height
))
23638 slice
.height
= XINT (it
->slice
.height
);
23639 else if (FLOATP (it
->slice
.height
))
23640 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23642 if (slice
.x
>= img
->width
)
23643 slice
.x
= img
->width
;
23644 if (slice
.y
>= img
->height
)
23645 slice
.y
= img
->height
;
23646 if (slice
.x
+ slice
.width
>= img
->width
)
23647 slice
.width
= img
->width
- slice
.x
;
23648 if (slice
.y
+ slice
.height
> img
->height
)
23649 slice
.height
= img
->height
- slice
.y
;
23651 if (slice
.width
== 0 || slice
.height
== 0)
23654 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23656 it
->descent
= slice
.height
- glyph_ascent
;
23658 it
->descent
+= img
->vmargin
;
23659 if (slice
.y
+ slice
.height
== img
->height
)
23660 it
->descent
+= img
->vmargin
;
23661 it
->phys_descent
= it
->descent
;
23663 it
->pixel_width
= slice
.width
;
23665 it
->pixel_width
+= img
->hmargin
;
23666 if (slice
.x
+ slice
.width
== img
->width
)
23667 it
->pixel_width
+= img
->hmargin
;
23669 /* It's quite possible for images to have an ascent greater than
23670 their height, so don't get confused in that case. */
23671 if (it
->descent
< 0)
23676 if (face
->box
!= FACE_NO_BOX
)
23678 if (face
->box_line_width
> 0)
23681 it
->ascent
+= face
->box_line_width
;
23682 if (slice
.y
+ slice
.height
== img
->height
)
23683 it
->descent
+= face
->box_line_width
;
23686 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23687 it
->pixel_width
+= eabs (face
->box_line_width
);
23688 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23689 it
->pixel_width
+= eabs (face
->box_line_width
);
23692 take_vertical_position_into_account (it
);
23694 /* Automatically crop wide image glyphs at right edge so we can
23695 draw the cursor on same display row. */
23696 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23697 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23699 it
->pixel_width
-= crop
;
23700 slice
.width
-= crop
;
23705 struct glyph
*glyph
;
23706 enum glyph_row_area area
= it
->area
;
23708 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23709 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23711 glyph
->charpos
= CHARPOS (it
->position
);
23712 glyph
->object
= it
->object
;
23713 glyph
->pixel_width
= it
->pixel_width
;
23714 glyph
->ascent
= glyph_ascent
;
23715 glyph
->descent
= it
->descent
;
23716 glyph
->voffset
= it
->voffset
;
23717 glyph
->type
= IMAGE_GLYPH
;
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
= 0;
23723 glyph
->padding_p
= 0;
23724 glyph
->glyph_not_available_p
= 0;
23725 glyph
->face_id
= it
->face_id
;
23726 glyph
->u
.img_id
= img
->id
;
23727 glyph
->slice
.img
= slice
;
23728 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23731 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23732 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23734 glyph
->bidi_type
= it
->bidi_it
.type
;
23736 ++it
->glyph_row
->used
[area
];
23739 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23744 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23745 of the glyph, WIDTH and HEIGHT are the width and height of the
23746 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23749 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23750 int width
, int height
, int ascent
)
23752 struct glyph
*glyph
;
23753 enum glyph_row_area area
= it
->area
;
23755 xassert (ascent
>= 0 && ascent
<= height
);
23757 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23758 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23760 /* If the glyph row is reversed, we need to prepend the glyph
23761 rather than append it. */
23762 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23766 /* Make room for the additional glyph. */
23767 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23769 glyph
= it
->glyph_row
->glyphs
[area
];
23771 glyph
->charpos
= CHARPOS (it
->position
);
23772 glyph
->object
= object
;
23773 glyph
->pixel_width
= width
;
23774 glyph
->ascent
= ascent
;
23775 glyph
->descent
= height
- ascent
;
23776 glyph
->voffset
= it
->voffset
;
23777 glyph
->type
= STRETCH_GLYPH
;
23778 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23779 glyph
->multibyte_p
= it
->multibyte_p
;
23780 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23781 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23782 glyph
->overlaps_vertically_p
= 0;
23783 glyph
->padding_p
= 0;
23784 glyph
->glyph_not_available_p
= 0;
23785 glyph
->face_id
= it
->face_id
;
23786 glyph
->u
.stretch
.ascent
= ascent
;
23787 glyph
->u
.stretch
.height
= height
;
23788 glyph
->slice
.img
= null_glyph_slice
;
23789 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23792 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23793 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23795 glyph
->bidi_type
= it
->bidi_it
.type
;
23799 glyph
->resolved_level
= 0;
23800 glyph
->bidi_type
= UNKNOWN_BT
;
23802 ++it
->glyph_row
->used
[area
];
23805 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23808 #endif /* HAVE_WINDOW_SYSTEM */
23810 /* Produce a stretch glyph for iterator IT. IT->object is the value
23811 of the glyph property displayed. The value must be a list
23812 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23815 1. `:width WIDTH' specifies that the space should be WIDTH *
23816 canonical char width wide. WIDTH may be an integer or floating
23819 2. `:relative-width FACTOR' specifies that the width of the stretch
23820 should be computed from the width of the first character having the
23821 `glyph' property, and should be FACTOR times that width.
23823 3. `:align-to HPOS' specifies that the space should be wide enough
23824 to reach HPOS, a value in canonical character units.
23826 Exactly one of the above pairs must be present.
23828 4. `:height HEIGHT' specifies that the height of the stretch produced
23829 should be HEIGHT, measured in canonical character units.
23831 5. `:relative-height FACTOR' specifies that the height of the
23832 stretch should be FACTOR times the height of the characters having
23833 the glyph property.
23835 Either none or exactly one of 4 or 5 must be present.
23837 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23838 of the stretch should be used for the ascent of the stretch.
23839 ASCENT must be in the range 0 <= ASCENT <= 100. */
23842 produce_stretch_glyph (struct it
*it
)
23844 /* (space :width WIDTH :height HEIGHT ...) */
23845 Lisp_Object prop
, plist
;
23846 int width
= 0, height
= 0, align_to
= -1;
23847 int zero_width_ok_p
= 0;
23850 struct face
*face
= NULL
;
23851 struct font
*font
= NULL
;
23853 #ifdef HAVE_WINDOW_SYSTEM
23854 int zero_height_ok_p
= 0;
23856 if (FRAME_WINDOW_P (it
->f
))
23858 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23859 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23860 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23864 /* List should start with `space'. */
23865 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23866 plist
= XCDR (it
->object
);
23868 /* Compute the width of the stretch. */
23869 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23870 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23872 /* Absolute width `:width WIDTH' specified and valid. */
23873 zero_width_ok_p
= 1;
23876 #ifdef HAVE_WINDOW_SYSTEM
23877 else if (FRAME_WINDOW_P (it
->f
)
23878 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23880 /* Relative width `:relative-width FACTOR' specified and valid.
23881 Compute the width of the characters having the `glyph'
23884 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23887 if (it
->multibyte_p
)
23888 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23891 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23892 if (! ASCII_CHAR_P (it2
.c
))
23893 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23896 it2
.glyph_row
= NULL
;
23897 it2
.what
= IT_CHARACTER
;
23898 x_produce_glyphs (&it2
);
23899 width
= NUMVAL (prop
) * it2
.pixel_width
;
23901 #endif /* HAVE_WINDOW_SYSTEM */
23902 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23903 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23905 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23906 align_to
= (align_to
< 0
23908 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23909 else if (align_to
< 0)
23910 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23911 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23912 zero_width_ok_p
= 1;
23915 /* Nothing specified -> width defaults to canonical char width. */
23916 width
= FRAME_COLUMN_WIDTH (it
->f
);
23918 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23921 #ifdef HAVE_WINDOW_SYSTEM
23922 /* Compute height. */
23923 if (FRAME_WINDOW_P (it
->f
))
23925 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23926 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23929 zero_height_ok_p
= 1;
23931 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23933 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23935 height
= FONT_HEIGHT (font
);
23937 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23940 /* Compute percentage of height used for ascent. If
23941 `:ascent ASCENT' is present and valid, use that. Otherwise,
23942 derive the ascent from the font in use. */
23943 if (prop
= Fplist_get (plist
, QCascent
),
23944 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23945 ascent
= height
* NUMVAL (prop
) / 100.0;
23946 else if (!NILP (prop
)
23947 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23948 ascent
= min (max (0, (int)tem
), height
);
23950 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23953 #endif /* HAVE_WINDOW_SYSTEM */
23956 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23957 && it
->current_x
+ width
> it
->last_visible_x
)
23959 width
= it
->last_visible_x
- it
->current_x
;
23960 #ifdef HAVE_WINDOW_SYSTEM
23961 /* Subtract one more pixel from the stretch width, but only on
23962 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23963 width
-= FRAME_WINDOW_P (it
->f
);
23967 if (width
> 0 && height
> 0 && it
->glyph_row
)
23969 Lisp_Object o_object
= it
->object
;
23970 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23973 if (!STRINGP (object
))
23974 object
= it
->w
->buffer
;
23975 #ifdef HAVE_WINDOW_SYSTEM
23976 if (FRAME_WINDOW_P (it
->f
))
23977 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23981 it
->object
= object
;
23982 it
->char_to_display
= ' ';
23983 it
->pixel_width
= it
->len
= 1;
23985 tty_append_glyph (it
);
23986 it
->object
= o_object
;
23990 it
->pixel_width
= width
;
23991 #ifdef HAVE_WINDOW_SYSTEM
23992 if (FRAME_WINDOW_P (it
->f
))
23994 it
->ascent
= it
->phys_ascent
= ascent
;
23995 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23996 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23997 take_vertical_position_into_account (it
);
24001 it
->nglyphs
= width
;
24004 #ifdef HAVE_WINDOW_SYSTEM
24006 /* Calculate line-height and line-spacing properties.
24007 An integer value specifies explicit pixel value.
24008 A float value specifies relative value to current face height.
24009 A cons (float . face-name) specifies relative value to
24010 height of specified face font.
24012 Returns height in pixels, or nil. */
24016 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24017 int boff
, int override
)
24019 Lisp_Object face_name
= Qnil
;
24020 int ascent
, descent
, height
;
24022 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24027 face_name
= XCAR (val
);
24029 if (!NUMBERP (val
))
24030 val
= make_number (1);
24031 if (NILP (face_name
))
24033 height
= it
->ascent
+ it
->descent
;
24038 if (NILP (face_name
))
24040 font
= FRAME_FONT (it
->f
);
24041 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24043 else if (EQ (face_name
, Qt
))
24052 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24054 return make_number (-1);
24056 face
= FACE_FROM_ID (it
->f
, face_id
);
24059 return make_number (-1);
24060 boff
= font
->baseline_offset
;
24061 if (font
->vertical_centering
)
24062 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24065 ascent
= FONT_BASE (font
) + boff
;
24066 descent
= FONT_DESCENT (font
) - boff
;
24070 it
->override_ascent
= ascent
;
24071 it
->override_descent
= descent
;
24072 it
->override_boff
= boff
;
24075 height
= ascent
+ descent
;
24079 height
= (int)(XFLOAT_DATA (val
) * height
);
24080 else if (INTEGERP (val
))
24081 height
*= XINT (val
);
24083 return make_number (height
);
24087 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24088 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24089 and only if this is for a character for which no font was found.
24091 If the display method (it->glyphless_method) is
24092 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24093 length of the acronym or the hexadecimal string, UPPER_XOFF and
24094 UPPER_YOFF are pixel offsets for the upper part of the string,
24095 LOWER_XOFF and LOWER_YOFF are for the lower part.
24097 For the other display methods, LEN through LOWER_YOFF are zero. */
24100 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24101 short upper_xoff
, short upper_yoff
,
24102 short lower_xoff
, short lower_yoff
)
24104 struct glyph
*glyph
;
24105 enum glyph_row_area area
= it
->area
;
24107 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24108 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24110 /* If the glyph row is reversed, we need to prepend the glyph
24111 rather than append it. */
24112 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24116 /* Make room for the additional glyph. */
24117 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24119 glyph
= it
->glyph_row
->glyphs
[area
];
24121 glyph
->charpos
= CHARPOS (it
->position
);
24122 glyph
->object
= it
->object
;
24123 glyph
->pixel_width
= it
->pixel_width
;
24124 glyph
->ascent
= it
->ascent
;
24125 glyph
->descent
= it
->descent
;
24126 glyph
->voffset
= it
->voffset
;
24127 glyph
->type
= GLYPHLESS_GLYPH
;
24128 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24129 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24130 glyph
->u
.glyphless
.len
= len
;
24131 glyph
->u
.glyphless
.ch
= it
->c
;
24132 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24133 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24134 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24135 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24136 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24137 glyph
->multibyte_p
= it
->multibyte_p
;
24138 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24139 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24140 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24141 || it
->phys_descent
> it
->descent
);
24142 glyph
->padding_p
= 0;
24143 glyph
->glyph_not_available_p
= 0;
24144 glyph
->face_id
= face_id
;
24145 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24148 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24149 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24151 glyph
->bidi_type
= it
->bidi_it
.type
;
24153 ++it
->glyph_row
->used
[area
];
24156 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24160 /* Produce a glyph for a glyphless character for iterator IT.
24161 IT->glyphless_method specifies which method to use for displaying
24162 the character. See the description of enum
24163 glyphless_display_method in dispextern.h for the detail.
24165 FOR_NO_FONT is nonzero if and only if this is for a character for
24166 which no font was found. ACRONYM, if non-nil, is an acronym string
24167 for the character. */
24170 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24175 int base_width
, base_height
, width
, height
;
24176 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24179 /* Get the metrics of the base font. We always refer to the current
24181 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24182 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24183 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24184 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24185 base_height
= it
->ascent
+ it
->descent
;
24186 base_width
= font
->average_width
;
24188 /* Get a face ID for the glyph by utilizing a cache (the same way as
24189 done for `escape-glyph' in get_next_display_element). */
24190 if (it
->f
== last_glyphless_glyph_frame
24191 && it
->face_id
== last_glyphless_glyph_face_id
)
24193 face_id
= last_glyphless_glyph_merged_face_id
;
24197 /* Merge the `glyphless-char' face into the current face. */
24198 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24199 last_glyphless_glyph_frame
= it
->f
;
24200 last_glyphless_glyph_face_id
= it
->face_id
;
24201 last_glyphless_glyph_merged_face_id
= face_id
;
24204 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24206 it
->pixel_width
= THIN_SPACE_WIDTH
;
24208 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24210 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24212 width
= CHAR_WIDTH (it
->c
);
24215 else if (width
> 4)
24217 it
->pixel_width
= base_width
* width
;
24219 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24225 unsigned int code
[6];
24227 int ascent
, descent
;
24228 struct font_metrics metrics_upper
, metrics_lower
;
24230 face
= FACE_FROM_ID (it
->f
, face_id
);
24231 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24232 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24234 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24236 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24237 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24238 if (CONSP (acronym
))
24239 acronym
= XCAR (acronym
);
24240 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24244 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24245 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24248 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24249 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24250 upper_len
= (len
+ 1) / 2;
24251 font
->driver
->text_extents (font
, code
, upper_len
,
24253 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24258 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24259 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24260 upper_xoff
= upper_yoff
= 2; /* the typical case */
24261 if (base_width
>= width
)
24263 /* Align the upper to the left, the lower to the right. */
24264 it
->pixel_width
= base_width
;
24265 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24269 /* Center the shorter one. */
24270 it
->pixel_width
= width
;
24271 if (metrics_upper
.width
>= metrics_lower
.width
)
24272 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24275 /* FIXME: This code doesn't look right. It formerly was
24276 missing the "lower_xoff = 0;", which couldn't have
24277 been right since it left lower_xoff uninitialized. */
24279 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24283 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24284 top, bottom, and between upper and lower strings. */
24285 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24286 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24287 /* Center vertically.
24288 H:base_height, D:base_descent
24289 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24291 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24292 descent = D - H/2 + h/2;
24293 lower_yoff = descent - 2 - ld;
24294 upper_yoff = lower_yoff - la - 1 - ud; */
24295 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24296 descent
= it
->descent
- (base_height
- height
) / 2;
24297 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24298 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24299 - metrics_upper
.descent
);
24300 /* Don't make the height shorter than the base height. */
24301 if (height
> base_height
)
24303 it
->ascent
= ascent
;
24304 it
->descent
= descent
;
24308 it
->phys_ascent
= it
->ascent
;
24309 it
->phys_descent
= it
->descent
;
24311 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24312 upper_xoff
, upper_yoff
,
24313 lower_xoff
, lower_yoff
);
24315 take_vertical_position_into_account (it
);
24320 Produce glyphs/get display metrics for the display element IT is
24321 loaded with. See the description of struct it in dispextern.h
24322 for an overview of struct it. */
24325 x_produce_glyphs (struct it
*it
)
24327 int extra_line_spacing
= it
->extra_line_spacing
;
24329 it
->glyph_not_available_p
= 0;
24331 if (it
->what
== IT_CHARACTER
)
24334 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24335 struct font
*font
= face
->font
;
24336 struct font_metrics
*pcm
= NULL
;
24337 int boff
; /* baseline offset */
24341 /* When no suitable font is found, display this character by
24342 the method specified in the first extra slot of
24343 Vglyphless_char_display. */
24344 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24346 xassert (it
->what
== IT_GLYPHLESS
);
24347 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24351 boff
= font
->baseline_offset
;
24352 if (font
->vertical_centering
)
24353 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24355 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24361 if (it
->override_ascent
>= 0)
24363 it
->ascent
= it
->override_ascent
;
24364 it
->descent
= it
->override_descent
;
24365 boff
= it
->override_boff
;
24369 it
->ascent
= FONT_BASE (font
) + boff
;
24370 it
->descent
= FONT_DESCENT (font
) - boff
;
24373 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24375 pcm
= get_per_char_metric (font
, &char2b
);
24376 if (pcm
->width
== 0
24377 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24383 it
->phys_ascent
= pcm
->ascent
+ boff
;
24384 it
->phys_descent
= pcm
->descent
- boff
;
24385 it
->pixel_width
= pcm
->width
;
24389 it
->glyph_not_available_p
= 1;
24390 it
->phys_ascent
= it
->ascent
;
24391 it
->phys_descent
= it
->descent
;
24392 it
->pixel_width
= font
->space_width
;
24395 if (it
->constrain_row_ascent_descent_p
)
24397 if (it
->descent
> it
->max_descent
)
24399 it
->ascent
+= it
->descent
- it
->max_descent
;
24400 it
->descent
= it
->max_descent
;
24402 if (it
->ascent
> it
->max_ascent
)
24404 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24405 it
->ascent
= it
->max_ascent
;
24407 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24408 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24409 extra_line_spacing
= 0;
24412 /* If this is a space inside a region of text with
24413 `space-width' property, change its width. */
24414 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24416 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24418 /* If face has a box, add the box thickness to the character
24419 height. If character has a box line to the left and/or
24420 right, add the box line width to the character's width. */
24421 if (face
->box
!= FACE_NO_BOX
)
24423 int thick
= face
->box_line_width
;
24427 it
->ascent
+= thick
;
24428 it
->descent
+= thick
;
24433 if (it
->start_of_box_run_p
)
24434 it
->pixel_width
+= thick
;
24435 if (it
->end_of_box_run_p
)
24436 it
->pixel_width
+= thick
;
24439 /* If face has an overline, add the height of the overline
24440 (1 pixel) and a 1 pixel margin to the character height. */
24441 if (face
->overline_p
)
24442 it
->ascent
+= overline_margin
;
24444 if (it
->constrain_row_ascent_descent_p
)
24446 if (it
->ascent
> it
->max_ascent
)
24447 it
->ascent
= it
->max_ascent
;
24448 if (it
->descent
> it
->max_descent
)
24449 it
->descent
= it
->max_descent
;
24452 take_vertical_position_into_account (it
);
24454 /* If we have to actually produce glyphs, do it. */
24459 /* Translate a space with a `space-width' property
24460 into a stretch glyph. */
24461 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24462 / FONT_HEIGHT (font
));
24463 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24464 it
->ascent
+ it
->descent
, ascent
);
24469 /* If characters with lbearing or rbearing are displayed
24470 in this line, record that fact in a flag of the
24471 glyph row. This is used to optimize X output code. */
24472 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24473 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24475 if (! stretched_p
&& it
->pixel_width
== 0)
24476 /* We assure that all visible glyphs have at least 1-pixel
24478 it
->pixel_width
= 1;
24480 else if (it
->char_to_display
== '\n')
24482 /* A newline has no width, but we need the height of the
24483 line. But if previous part of the line sets a height,
24484 don't increase that height */
24486 Lisp_Object height
;
24487 Lisp_Object total_height
= Qnil
;
24489 it
->override_ascent
= -1;
24490 it
->pixel_width
= 0;
24493 height
= get_it_property (it
, Qline_height
);
24494 /* Split (line-height total-height) list */
24496 && CONSP (XCDR (height
))
24497 && NILP (XCDR (XCDR (height
))))
24499 total_height
= XCAR (XCDR (height
));
24500 height
= XCAR (height
);
24502 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24504 if (it
->override_ascent
>= 0)
24506 it
->ascent
= it
->override_ascent
;
24507 it
->descent
= it
->override_descent
;
24508 boff
= it
->override_boff
;
24512 it
->ascent
= FONT_BASE (font
) + boff
;
24513 it
->descent
= FONT_DESCENT (font
) - boff
;
24516 if (EQ (height
, Qt
))
24518 if (it
->descent
> it
->max_descent
)
24520 it
->ascent
+= it
->descent
- it
->max_descent
;
24521 it
->descent
= it
->max_descent
;
24523 if (it
->ascent
> it
->max_ascent
)
24525 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24526 it
->ascent
= it
->max_ascent
;
24528 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24529 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24530 it
->constrain_row_ascent_descent_p
= 1;
24531 extra_line_spacing
= 0;
24535 Lisp_Object spacing
;
24537 it
->phys_ascent
= it
->ascent
;
24538 it
->phys_descent
= it
->descent
;
24540 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24541 && face
->box
!= FACE_NO_BOX
24542 && face
->box_line_width
> 0)
24544 it
->ascent
+= face
->box_line_width
;
24545 it
->descent
+= face
->box_line_width
;
24548 && XINT (height
) > it
->ascent
+ it
->descent
)
24549 it
->ascent
= XINT (height
) - it
->descent
;
24551 if (!NILP (total_height
))
24552 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24555 spacing
= get_it_property (it
, Qline_spacing
);
24556 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24558 if (INTEGERP (spacing
))
24560 extra_line_spacing
= XINT (spacing
);
24561 if (!NILP (total_height
))
24562 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24566 else /* i.e. (it->char_to_display == '\t') */
24568 if (font
->space_width
> 0)
24570 int tab_width
= it
->tab_width
* font
->space_width
;
24571 int x
= it
->current_x
+ it
->continuation_lines_width
;
24572 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24574 /* If the distance from the current position to the next tab
24575 stop is less than a space character width, use the
24576 tab stop after that. */
24577 if (next_tab_x
- x
< font
->space_width
)
24578 next_tab_x
+= tab_width
;
24580 it
->pixel_width
= next_tab_x
- x
;
24582 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24583 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24587 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24588 it
->ascent
+ it
->descent
, it
->ascent
);
24593 it
->pixel_width
= 0;
24598 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24600 /* A static composition.
24602 Note: A composition is represented as one glyph in the
24603 glyph matrix. There are no padding glyphs.
24605 Important note: pixel_width, ascent, and descent are the
24606 values of what is drawn by draw_glyphs (i.e. the values of
24607 the overall glyphs composed). */
24608 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24609 int boff
; /* baseline offset */
24610 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24611 int glyph_len
= cmp
->glyph_len
;
24612 struct font
*font
= face
->font
;
24616 /* If we have not yet calculated pixel size data of glyphs of
24617 the composition for the current face font, calculate them
24618 now. Theoretically, we have to check all fonts for the
24619 glyphs, but that requires much time and memory space. So,
24620 here we check only the font of the first glyph. This may
24621 lead to incorrect display, but it's very rare, and C-l
24622 (recenter-top-bottom) can correct the display anyway. */
24623 if (! cmp
->font
|| cmp
->font
!= font
)
24625 /* Ascent and descent of the font of the first character
24626 of this composition (adjusted by baseline offset).
24627 Ascent and descent of overall glyphs should not be less
24628 than these, respectively. */
24629 int font_ascent
, font_descent
, font_height
;
24630 /* Bounding box of the overall glyphs. */
24631 int leftmost
, rightmost
, lowest
, highest
;
24632 int lbearing
, rbearing
;
24633 int i
, width
, ascent
, descent
;
24634 int left_padded
= 0, right_padded
= 0;
24635 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24637 struct font_metrics
*pcm
;
24638 int font_not_found_p
;
24641 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24642 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24644 if (glyph_len
< cmp
->glyph_len
)
24646 for (i
= 0; i
< glyph_len
; i
++)
24648 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24650 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24655 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24656 : IT_CHARPOS (*it
));
24657 /* If no suitable font is found, use the default font. */
24658 font_not_found_p
= font
== NULL
;
24659 if (font_not_found_p
)
24661 face
= face
->ascii_face
;
24664 boff
= font
->baseline_offset
;
24665 if (font
->vertical_centering
)
24666 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24667 font_ascent
= FONT_BASE (font
) + boff
;
24668 font_descent
= FONT_DESCENT (font
) - boff
;
24669 font_height
= FONT_HEIGHT (font
);
24671 cmp
->font
= (void *) font
;
24674 if (! font_not_found_p
)
24676 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24678 pcm
= get_per_char_metric (font
, &char2b
);
24681 /* Initialize the bounding box. */
24684 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24685 ascent
= pcm
->ascent
;
24686 descent
= pcm
->descent
;
24687 lbearing
= pcm
->lbearing
;
24688 rbearing
= pcm
->rbearing
;
24692 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24693 ascent
= FONT_BASE (font
);
24694 descent
= FONT_DESCENT (font
);
24701 lowest
= - descent
+ boff
;
24702 highest
= ascent
+ boff
;
24704 if (! font_not_found_p
24705 && font
->default_ascent
24706 && CHAR_TABLE_P (Vuse_default_ascent
)
24707 && !NILP (Faref (Vuse_default_ascent
,
24708 make_number (it
->char_to_display
))))
24709 highest
= font
->default_ascent
+ boff
;
24711 /* Draw the first glyph at the normal position. It may be
24712 shifted to right later if some other glyphs are drawn
24714 cmp
->offsets
[i
* 2] = 0;
24715 cmp
->offsets
[i
* 2 + 1] = boff
;
24716 cmp
->lbearing
= lbearing
;
24717 cmp
->rbearing
= rbearing
;
24719 /* Set cmp->offsets for the remaining glyphs. */
24720 for (i
++; i
< glyph_len
; i
++)
24722 int left
, right
, btm
, top
;
24723 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24725 struct face
*this_face
;
24729 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24730 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24731 font
= this_face
->font
;
24737 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24739 pcm
= get_per_char_metric (font
, &char2b
);
24742 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24745 width
= pcm
->width
;
24746 ascent
= pcm
->ascent
;
24747 descent
= pcm
->descent
;
24748 lbearing
= pcm
->lbearing
;
24749 rbearing
= pcm
->rbearing
;
24750 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24752 /* Relative composition with or without
24753 alternate chars. */
24754 left
= (leftmost
+ rightmost
- width
) / 2;
24755 btm
= - descent
+ boff
;
24756 if (font
->relative_compose
24757 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24758 || NILP (Faref (Vignore_relative_composition
,
24759 make_number (ch
)))))
24762 if (- descent
>= font
->relative_compose
)
24763 /* One extra pixel between two glyphs. */
24765 else if (ascent
<= 0)
24766 /* One extra pixel between two glyphs. */
24767 btm
= lowest
- 1 - ascent
- descent
;
24772 /* A composition rule is specified by an integer
24773 value that encodes global and new reference
24774 points (GREF and NREF). GREF and NREF are
24775 specified by numbers as below:
24777 0---1---2 -- ascent
24781 9--10--11 -- center
24783 ---3---4---5--- baseline
24785 6---7---8 -- descent
24787 int rule
= COMPOSITION_RULE (cmp
, i
);
24788 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24790 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24791 grefx
= gref
% 3, nrefx
= nref
% 3;
24792 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24794 xoff
= font_height
* (xoff
- 128) / 256;
24796 yoff
= font_height
* (yoff
- 128) / 256;
24799 + grefx
* (rightmost
- leftmost
) / 2
24800 - nrefx
* width
/ 2
24803 btm
= ((grefy
== 0 ? highest
24805 : grefy
== 2 ? lowest
24806 : (highest
+ lowest
) / 2)
24807 - (nrefy
== 0 ? ascent
+ descent
24808 : nrefy
== 1 ? descent
- boff
24810 : (ascent
+ descent
) / 2)
24814 cmp
->offsets
[i
* 2] = left
;
24815 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24817 /* Update the bounding box of the overall glyphs. */
24820 right
= left
+ width
;
24821 if (left
< leftmost
)
24823 if (right
> rightmost
)
24826 top
= btm
+ descent
+ ascent
;
24832 if (cmp
->lbearing
> left
+ lbearing
)
24833 cmp
->lbearing
= left
+ lbearing
;
24834 if (cmp
->rbearing
< left
+ rbearing
)
24835 cmp
->rbearing
= left
+ rbearing
;
24839 /* If there are glyphs whose x-offsets are negative,
24840 shift all glyphs to the right and make all x-offsets
24844 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24845 cmp
->offsets
[i
* 2] -= leftmost
;
24846 rightmost
-= leftmost
;
24847 cmp
->lbearing
-= leftmost
;
24848 cmp
->rbearing
-= leftmost
;
24851 if (left_padded
&& cmp
->lbearing
< 0)
24853 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24854 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24855 rightmost
-= cmp
->lbearing
;
24856 cmp
->rbearing
-= cmp
->lbearing
;
24859 if (right_padded
&& rightmost
< cmp
->rbearing
)
24861 rightmost
= cmp
->rbearing
;
24864 cmp
->pixel_width
= rightmost
;
24865 cmp
->ascent
= highest
;
24866 cmp
->descent
= - lowest
;
24867 if (cmp
->ascent
< font_ascent
)
24868 cmp
->ascent
= font_ascent
;
24869 if (cmp
->descent
< font_descent
)
24870 cmp
->descent
= font_descent
;
24874 && (cmp
->lbearing
< 0
24875 || cmp
->rbearing
> cmp
->pixel_width
))
24876 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24878 it
->pixel_width
= cmp
->pixel_width
;
24879 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24880 it
->descent
= it
->phys_descent
= cmp
->descent
;
24881 if (face
->box
!= FACE_NO_BOX
)
24883 int thick
= face
->box_line_width
;
24887 it
->ascent
+= thick
;
24888 it
->descent
+= thick
;
24893 if (it
->start_of_box_run_p
)
24894 it
->pixel_width
+= thick
;
24895 if (it
->end_of_box_run_p
)
24896 it
->pixel_width
+= thick
;
24899 /* If face has an overline, add the height of the overline
24900 (1 pixel) and a 1 pixel margin to the character height. */
24901 if (face
->overline_p
)
24902 it
->ascent
+= overline_margin
;
24904 take_vertical_position_into_account (it
);
24905 if (it
->ascent
< 0)
24907 if (it
->descent
< 0)
24910 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
24911 append_composite_glyph (it
);
24913 else if (it
->what
== IT_COMPOSITION
)
24915 /* A dynamic (automatic) composition. */
24916 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24917 Lisp_Object gstring
;
24918 struct font_metrics metrics
;
24922 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24924 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24927 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24928 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24929 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24930 it
->descent
= it
->phys_descent
= metrics
.descent
;
24931 if (face
->box
!= FACE_NO_BOX
)
24933 int thick
= face
->box_line_width
;
24937 it
->ascent
+= thick
;
24938 it
->descent
+= thick
;
24943 if (it
->start_of_box_run_p
)
24944 it
->pixel_width
+= thick
;
24945 if (it
->end_of_box_run_p
)
24946 it
->pixel_width
+= thick
;
24948 /* If face has an overline, add the height of the overline
24949 (1 pixel) and a 1 pixel margin to the character height. */
24950 if (face
->overline_p
)
24951 it
->ascent
+= overline_margin
;
24952 take_vertical_position_into_account (it
);
24953 if (it
->ascent
< 0)
24955 if (it
->descent
< 0)
24959 append_composite_glyph (it
);
24961 else if (it
->what
== IT_GLYPHLESS
)
24962 produce_glyphless_glyph (it
, 0, Qnil
);
24963 else if (it
->what
== IT_IMAGE
)
24964 produce_image_glyph (it
);
24965 else if (it
->what
== IT_STRETCH
)
24966 produce_stretch_glyph (it
);
24969 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24970 because this isn't true for images with `:ascent 100'. */
24971 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24972 if (it
->area
== TEXT_AREA
)
24973 it
->current_x
+= it
->pixel_width
;
24975 if (extra_line_spacing
> 0)
24977 it
->descent
+= extra_line_spacing
;
24978 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24979 it
->max_extra_line_spacing
= extra_line_spacing
;
24982 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24983 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24984 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24985 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24989 Output LEN glyphs starting at START at the nominal cursor position.
24990 Advance the nominal cursor over the text. The global variable
24991 updated_window contains the window being updated, updated_row is
24992 the glyph row being updated, and updated_area is the area of that
24993 row being updated. */
24996 x_write_glyphs (struct glyph
*start
, int len
)
24998 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25000 xassert (updated_window
&& updated_row
);
25001 /* When the window is hscrolled, cursor hpos can legitimately be out
25002 of bounds, but we draw the cursor at the corresponding window
25003 margin in that case. */
25004 if (!updated_row
->reversed_p
&& chpos
< 0)
25006 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25007 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25011 /* Write glyphs. */
25013 hpos
= start
- updated_row
->glyphs
[updated_area
];
25014 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25015 updated_row
, updated_area
,
25017 DRAW_NORMAL_TEXT
, 0);
25019 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25020 if (updated_area
== TEXT_AREA
25021 && updated_window
->phys_cursor_on_p
25022 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25024 && chpos
< hpos
+ len
)
25025 updated_window
->phys_cursor_on_p
= 0;
25029 /* Advance the output cursor. */
25030 output_cursor
.hpos
+= len
;
25031 output_cursor
.x
= x
;
25036 Insert LEN glyphs from START at the nominal cursor position. */
25039 x_insert_glyphs (struct glyph
*start
, int len
)
25043 int line_height
, shift_by_width
, shifted_region_width
;
25044 struct glyph_row
*row
;
25045 struct glyph
*glyph
;
25046 int frame_x
, frame_y
;
25049 xassert (updated_window
&& updated_row
);
25051 w
= updated_window
;
25052 f
= XFRAME (WINDOW_FRAME (w
));
25054 /* Get the height of the line we are in. */
25056 line_height
= row
->height
;
25058 /* Get the width of the glyphs to insert. */
25059 shift_by_width
= 0;
25060 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25061 shift_by_width
+= glyph
->pixel_width
;
25063 /* Get the width of the region to shift right. */
25064 shifted_region_width
= (window_box_width (w
, updated_area
)
25069 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25070 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25072 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25073 line_height
, shift_by_width
);
25075 /* Write the glyphs. */
25076 hpos
= start
- row
->glyphs
[updated_area
];
25077 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25079 DRAW_NORMAL_TEXT
, 0);
25081 /* Advance the output cursor. */
25082 output_cursor
.hpos
+= len
;
25083 output_cursor
.x
+= shift_by_width
;
25089 Erase the current text line from the nominal cursor position
25090 (inclusive) to pixel column TO_X (exclusive). The idea is that
25091 everything from TO_X onward is already erased.
25093 TO_X is a pixel position relative to updated_area of
25094 updated_window. TO_X == -1 means clear to the end of this area. */
25097 x_clear_end_of_line (int to_x
)
25100 struct window
*w
= updated_window
;
25101 int max_x
, min_y
, max_y
;
25102 int from_x
, from_y
, to_y
;
25104 xassert (updated_window
&& updated_row
);
25105 f
= XFRAME (w
->frame
);
25107 if (updated_row
->full_width_p
)
25108 max_x
= WINDOW_TOTAL_WIDTH (w
);
25110 max_x
= window_box_width (w
, updated_area
);
25111 max_y
= window_text_bottom_y (w
);
25113 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25114 of window. For TO_X > 0, truncate to end of drawing area. */
25120 to_x
= min (to_x
, max_x
);
25122 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25124 /* Notice if the cursor will be cleared by this operation. */
25125 if (!updated_row
->full_width_p
)
25126 notice_overwritten_cursor (w
, updated_area
,
25127 output_cursor
.x
, -1,
25129 MATRIX_ROW_BOTTOM_Y (updated_row
));
25131 from_x
= output_cursor
.x
;
25133 /* Translate to frame coordinates. */
25134 if (updated_row
->full_width_p
)
25136 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25137 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25141 int area_left
= window_box_left (w
, updated_area
);
25142 from_x
+= area_left
;
25146 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25147 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25148 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25150 /* Prevent inadvertently clearing to end of the X window. */
25151 if (to_x
> from_x
&& to_y
> from_y
)
25154 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25155 to_x
- from_x
, to_y
- from_y
);
25160 #endif /* HAVE_WINDOW_SYSTEM */
25164 /***********************************************************************
25166 ***********************************************************************/
25168 /* Value is the internal representation of the specified cursor type
25169 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25170 of the bar cursor. */
25172 static enum text_cursor_kinds
25173 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25175 enum text_cursor_kinds type
;
25180 if (EQ (arg
, Qbox
))
25181 return FILLED_BOX_CURSOR
;
25183 if (EQ (arg
, Qhollow
))
25184 return HOLLOW_BOX_CURSOR
;
25186 if (EQ (arg
, Qbar
))
25193 && EQ (XCAR (arg
), Qbar
)
25194 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25196 *width
= XINT (XCDR (arg
));
25200 if (EQ (arg
, Qhbar
))
25203 return HBAR_CURSOR
;
25207 && EQ (XCAR (arg
), Qhbar
)
25208 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25210 *width
= XINT (XCDR (arg
));
25211 return HBAR_CURSOR
;
25214 /* Treat anything unknown as "hollow box cursor".
25215 It was bad to signal an error; people have trouble fixing
25216 .Xdefaults with Emacs, when it has something bad in it. */
25217 type
= HOLLOW_BOX_CURSOR
;
25222 /* Set the default cursor types for specified frame. */
25224 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25229 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25230 FRAME_CURSOR_WIDTH (f
) = width
;
25232 /* By default, set up the blink-off state depending on the on-state. */
25234 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25237 FRAME_BLINK_OFF_CURSOR (f
)
25238 = get_specified_cursor_type (XCDR (tem
), &width
);
25239 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25242 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25246 #ifdef HAVE_WINDOW_SYSTEM
25248 /* Return the cursor we want to be displayed in window W. Return
25249 width of bar/hbar cursor through WIDTH arg. Return with
25250 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25251 (i.e. if the `system caret' should track this cursor).
25253 In a mini-buffer window, we want the cursor only to appear if we
25254 are reading input from this window. For the selected window, we
25255 want the cursor type given by the frame parameter or buffer local
25256 setting of cursor-type. If explicitly marked off, draw no cursor.
25257 In all other cases, we want a hollow box cursor. */
25259 static enum text_cursor_kinds
25260 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25261 int *active_cursor
)
25263 struct frame
*f
= XFRAME (w
->frame
);
25264 struct buffer
*b
= XBUFFER (w
->buffer
);
25265 int cursor_type
= DEFAULT_CURSOR
;
25266 Lisp_Object alt_cursor
;
25267 int non_selected
= 0;
25269 *active_cursor
= 1;
25272 if (cursor_in_echo_area
25273 && FRAME_HAS_MINIBUF_P (f
)
25274 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25276 if (w
== XWINDOW (echo_area_window
))
25278 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25280 *width
= FRAME_CURSOR_WIDTH (f
);
25281 return FRAME_DESIRED_CURSOR (f
);
25284 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25287 *active_cursor
= 0;
25291 /* Detect a nonselected window or nonselected frame. */
25292 else if (w
!= XWINDOW (f
->selected_window
)
25293 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25295 *active_cursor
= 0;
25297 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25303 /* Never display a cursor in a window in which cursor-type is nil. */
25304 if (NILP (BVAR (b
, cursor_type
)))
25307 /* Get the normal cursor type for this window. */
25308 if (EQ (BVAR (b
, cursor_type
), Qt
))
25310 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25311 *width
= FRAME_CURSOR_WIDTH (f
);
25314 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25316 /* Use cursor-in-non-selected-windows instead
25317 for non-selected window or frame. */
25320 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25321 if (!EQ (Qt
, alt_cursor
))
25322 return get_specified_cursor_type (alt_cursor
, width
);
25323 /* t means modify the normal cursor type. */
25324 if (cursor_type
== FILLED_BOX_CURSOR
)
25325 cursor_type
= HOLLOW_BOX_CURSOR
;
25326 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25328 return cursor_type
;
25331 /* Use normal cursor if not blinked off. */
25332 if (!w
->cursor_off_p
)
25334 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25336 if (cursor_type
== FILLED_BOX_CURSOR
)
25338 /* Using a block cursor on large images can be very annoying.
25339 So use a hollow cursor for "large" images.
25340 If image is not transparent (no mask), also use hollow cursor. */
25341 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25342 if (img
!= NULL
&& IMAGEP (img
->spec
))
25344 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25345 where N = size of default frame font size.
25346 This should cover most of the "tiny" icons people may use. */
25348 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25349 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25350 cursor_type
= HOLLOW_BOX_CURSOR
;
25353 else if (cursor_type
!= NO_CURSOR
)
25355 /* Display current only supports BOX and HOLLOW cursors for images.
25356 So for now, unconditionally use a HOLLOW cursor when cursor is
25357 not a solid box cursor. */
25358 cursor_type
= HOLLOW_BOX_CURSOR
;
25361 return cursor_type
;
25364 /* Cursor is blinked off, so determine how to "toggle" it. */
25366 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25367 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25368 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25370 /* Then see if frame has specified a specific blink off cursor type. */
25371 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25373 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25374 return FRAME_BLINK_OFF_CURSOR (f
);
25378 /* Some people liked having a permanently visible blinking cursor,
25379 while others had very strong opinions against it. So it was
25380 decided to remove it. KFS 2003-09-03 */
25382 /* Finally perform built-in cursor blinking:
25383 filled box <-> hollow box
25384 wide [h]bar <-> narrow [h]bar
25385 narrow [h]bar <-> no cursor
25386 other type <-> no cursor */
25388 if (cursor_type
== FILLED_BOX_CURSOR
)
25389 return HOLLOW_BOX_CURSOR
;
25391 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25394 return cursor_type
;
25402 /* Notice when the text cursor of window W has been completely
25403 overwritten by a drawing operation that outputs glyphs in AREA
25404 starting at X0 and ending at X1 in the line starting at Y0 and
25405 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25406 the rest of the line after X0 has been written. Y coordinates
25407 are window-relative. */
25410 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25411 int x0
, int x1
, int y0
, int y1
)
25413 int cx0
, cx1
, cy0
, cy1
;
25414 struct glyph_row
*row
;
25416 if (!w
->phys_cursor_on_p
)
25418 if (area
!= TEXT_AREA
)
25421 if (w
->phys_cursor
.vpos
< 0
25422 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25423 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25424 !(row
->enabled_p
&& row
->displays_text_p
)))
25427 if (row
->cursor_in_fringe_p
)
25429 row
->cursor_in_fringe_p
= 0;
25430 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25431 w
->phys_cursor_on_p
= 0;
25435 cx0
= w
->phys_cursor
.x
;
25436 cx1
= cx0
+ w
->phys_cursor_width
;
25437 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25440 /* The cursor image will be completely removed from the
25441 screen if the output area intersects the cursor area in
25442 y-direction. When we draw in [y0 y1[, and some part of
25443 the cursor is at y < y0, that part must have been drawn
25444 before. When scrolling, the cursor is erased before
25445 actually scrolling, so we don't come here. When not
25446 scrolling, the rows above the old cursor row must have
25447 changed, and in this case these rows must have written
25448 over the cursor image.
25450 Likewise if part of the cursor is below y1, with the
25451 exception of the cursor being in the first blank row at
25452 the buffer and window end because update_text_area
25453 doesn't draw that row. (Except when it does, but
25454 that's handled in update_text_area.) */
25456 cy0
= w
->phys_cursor
.y
;
25457 cy1
= cy0
+ w
->phys_cursor_height
;
25458 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25461 w
->phys_cursor_on_p
= 0;
25464 #endif /* HAVE_WINDOW_SYSTEM */
25467 /************************************************************************
25469 ************************************************************************/
25471 #ifdef HAVE_WINDOW_SYSTEM
25474 Fix the display of area AREA of overlapping row ROW in window W
25475 with respect to the overlapping part OVERLAPS. */
25478 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25479 enum glyph_row_area area
, int overlaps
)
25486 for (i
= 0; i
< row
->used
[area
];)
25488 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25490 int start
= i
, start_x
= x
;
25494 x
+= row
->glyphs
[area
][i
].pixel_width
;
25497 while (i
< row
->used
[area
]
25498 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25500 draw_glyphs (w
, start_x
, row
, area
,
25502 DRAW_NORMAL_TEXT
, overlaps
);
25506 x
+= row
->glyphs
[area
][i
].pixel_width
;
25516 Draw the cursor glyph of window W in glyph row ROW. See the
25517 comment of draw_glyphs for the meaning of HL. */
25520 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25521 enum draw_glyphs_face hl
)
25523 /* If cursor hpos is out of bounds, don't draw garbage. This can
25524 happen in mini-buffer windows when switching between echo area
25525 glyphs and mini-buffer. */
25526 if ((row
->reversed_p
25527 ? (w
->phys_cursor
.hpos
>= 0)
25528 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25530 int on_p
= w
->phys_cursor_on_p
;
25532 int hpos
= w
->phys_cursor
.hpos
;
25534 /* When the window is hscrolled, cursor hpos can legitimately be
25535 out of bounds, but we draw the cursor at the corresponding
25536 window margin in that case. */
25537 if (!row
->reversed_p
&& hpos
< 0)
25539 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25540 hpos
= row
->used
[TEXT_AREA
] - 1;
25542 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25544 w
->phys_cursor_on_p
= on_p
;
25546 if (hl
== DRAW_CURSOR
)
25547 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25548 /* When we erase the cursor, and ROW is overlapped by other
25549 rows, make sure that these overlapping parts of other rows
25551 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25553 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25555 if (row
> w
->current_matrix
->rows
25556 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25557 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25558 OVERLAPS_ERASED_CURSOR
);
25560 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25561 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25562 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25563 OVERLAPS_ERASED_CURSOR
);
25570 Erase the image of a cursor of window W from the screen. */
25573 erase_phys_cursor (struct window
*w
)
25575 struct frame
*f
= XFRAME (w
->frame
);
25576 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25577 int hpos
= w
->phys_cursor
.hpos
;
25578 int vpos
= w
->phys_cursor
.vpos
;
25579 int mouse_face_here_p
= 0;
25580 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25581 struct glyph_row
*cursor_row
;
25582 struct glyph
*cursor_glyph
;
25583 enum draw_glyphs_face hl
;
25585 /* No cursor displayed or row invalidated => nothing to do on the
25587 if (w
->phys_cursor_type
== NO_CURSOR
)
25588 goto mark_cursor_off
;
25590 /* VPOS >= active_glyphs->nrows means that window has been resized.
25591 Don't bother to erase the cursor. */
25592 if (vpos
>= active_glyphs
->nrows
)
25593 goto mark_cursor_off
;
25595 /* If row containing cursor is marked invalid, there is nothing we
25597 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25598 if (!cursor_row
->enabled_p
)
25599 goto mark_cursor_off
;
25601 /* If line spacing is > 0, old cursor may only be partially visible in
25602 window after split-window. So adjust visible height. */
25603 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25604 window_text_bottom_y (w
) - cursor_row
->y
);
25606 /* If row is completely invisible, don't attempt to delete a cursor which
25607 isn't there. This can happen if cursor is at top of a window, and
25608 we switch to a buffer with a header line in that window. */
25609 if (cursor_row
->visible_height
<= 0)
25610 goto mark_cursor_off
;
25612 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25613 if (cursor_row
->cursor_in_fringe_p
)
25615 cursor_row
->cursor_in_fringe_p
= 0;
25616 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25617 goto mark_cursor_off
;
25620 /* This can happen when the new row is shorter than the old one.
25621 In this case, either draw_glyphs or clear_end_of_line
25622 should have cleared the cursor. Note that we wouldn't be
25623 able to erase the cursor in this case because we don't have a
25624 cursor glyph at hand. */
25625 if ((cursor_row
->reversed_p
25626 ? (w
->phys_cursor
.hpos
< 0)
25627 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25628 goto mark_cursor_off
;
25630 /* When the window is hscrolled, cursor hpos can legitimately be out
25631 of bounds, but we draw the cursor at the corresponding window
25632 margin in that case. */
25633 if (!cursor_row
->reversed_p
&& hpos
< 0)
25635 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25636 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25638 /* If the cursor is in the mouse face area, redisplay that when
25639 we clear the cursor. */
25640 if (! NILP (hlinfo
->mouse_face_window
)
25641 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25642 /* Don't redraw the cursor's spot in mouse face if it is at the
25643 end of a line (on a newline). The cursor appears there, but
25644 mouse highlighting does not. */
25645 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25646 mouse_face_here_p
= 1;
25648 /* Maybe clear the display under the cursor. */
25649 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25652 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25655 cursor_glyph
= get_phys_cursor_glyph (w
);
25656 if (cursor_glyph
== NULL
)
25657 goto mark_cursor_off
;
25659 width
= cursor_glyph
->pixel_width
;
25660 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25661 x
= w
->phys_cursor
.x
;
25663 width
-= left_x
- x
;
25664 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25665 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25666 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25669 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25672 /* Erase the cursor by redrawing the character underneath it. */
25673 if (mouse_face_here_p
)
25674 hl
= DRAW_MOUSE_FACE
;
25676 hl
= DRAW_NORMAL_TEXT
;
25677 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25680 w
->phys_cursor_on_p
= 0;
25681 w
->phys_cursor_type
= NO_CURSOR
;
25686 Display or clear cursor of window W. If ON is zero, clear the
25687 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25688 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25691 display_and_set_cursor (struct window
*w
, int on
,
25692 int hpos
, int vpos
, int x
, int y
)
25694 struct frame
*f
= XFRAME (w
->frame
);
25695 int new_cursor_type
;
25696 int new_cursor_width
;
25698 struct glyph_row
*glyph_row
;
25699 struct glyph
*glyph
;
25701 /* This is pointless on invisible frames, and dangerous on garbaged
25702 windows and frames; in the latter case, the frame or window may
25703 be in the midst of changing its size, and x and y may be off the
25705 if (! FRAME_VISIBLE_P (f
)
25706 || FRAME_GARBAGED_P (f
)
25707 || vpos
>= w
->current_matrix
->nrows
25708 || hpos
>= w
->current_matrix
->matrix_w
)
25711 /* If cursor is off and we want it off, return quickly. */
25712 if (!on
&& !w
->phys_cursor_on_p
)
25715 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25716 /* If cursor row is not enabled, we don't really know where to
25717 display the cursor. */
25718 if (!glyph_row
->enabled_p
)
25720 w
->phys_cursor_on_p
= 0;
25725 if (!glyph_row
->exact_window_width_line_p
25726 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25727 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25729 xassert (interrupt_input_blocked
);
25731 /* Set new_cursor_type to the cursor we want to be displayed. */
25732 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25733 &new_cursor_width
, &active_cursor
);
25735 /* If cursor is currently being shown and we don't want it to be or
25736 it is in the wrong place, or the cursor type is not what we want,
25738 if (w
->phys_cursor_on_p
25740 || w
->phys_cursor
.x
!= x
25741 || w
->phys_cursor
.y
!= y
25742 || new_cursor_type
!= w
->phys_cursor_type
25743 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25744 && new_cursor_width
!= w
->phys_cursor_width
)))
25745 erase_phys_cursor (w
);
25747 /* Don't check phys_cursor_on_p here because that flag is only set
25748 to zero in some cases where we know that the cursor has been
25749 completely erased, to avoid the extra work of erasing the cursor
25750 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25751 still not be visible, or it has only been partly erased. */
25754 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25755 w
->phys_cursor_height
= glyph_row
->height
;
25757 /* Set phys_cursor_.* before x_draw_.* is called because some
25758 of them may need the information. */
25759 w
->phys_cursor
.x
= x
;
25760 w
->phys_cursor
.y
= glyph_row
->y
;
25761 w
->phys_cursor
.hpos
= hpos
;
25762 w
->phys_cursor
.vpos
= vpos
;
25765 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25766 new_cursor_type
, new_cursor_width
,
25767 on
, active_cursor
);
25771 /* Switch the display of W's cursor on or off, according to the value
25775 update_window_cursor (struct window
*w
, int on
)
25777 /* Don't update cursor in windows whose frame is in the process
25778 of being deleted. */
25779 if (w
->current_matrix
)
25781 int hpos
= w
->phys_cursor
.hpos
;
25782 int vpos
= w
->phys_cursor
.vpos
;
25783 struct glyph_row
*row
;
25785 if (vpos
>= w
->current_matrix
->nrows
25786 || hpos
>= w
->current_matrix
->matrix_w
)
25789 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25791 /* When the window is hscrolled, cursor hpos can legitimately be
25792 out of bounds, but we draw the cursor at the corresponding
25793 window margin in that case. */
25794 if (!row
->reversed_p
&& hpos
< 0)
25796 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25797 hpos
= row
->used
[TEXT_AREA
] - 1;
25800 display_and_set_cursor (w
, on
, hpos
, vpos
,
25801 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25807 /* Call update_window_cursor with parameter ON_P on all leaf windows
25808 in the window tree rooted at W. */
25811 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25815 if (!NILP (w
->hchild
))
25816 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25817 else if (!NILP (w
->vchild
))
25818 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25820 update_window_cursor (w
, on_p
);
25822 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25828 Display the cursor on window W, or clear it, according to ON_P.
25829 Don't change the cursor's position. */
25832 x_update_cursor (struct frame
*f
, int on_p
)
25834 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25839 Clear the cursor of window W to background color, and mark the
25840 cursor as not shown. This is used when the text where the cursor
25841 is about to be rewritten. */
25844 x_clear_cursor (struct window
*w
)
25846 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25847 update_window_cursor (w
, 0);
25850 #endif /* HAVE_WINDOW_SYSTEM */
25852 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25855 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25856 int start_hpos
, int end_hpos
,
25857 enum draw_glyphs_face draw
)
25859 #ifdef HAVE_WINDOW_SYSTEM
25860 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25862 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25866 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
25867 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25871 /* Display the active region described by mouse_face_* according to DRAW. */
25874 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25876 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25877 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25879 if (/* If window is in the process of being destroyed, don't bother
25881 w
->current_matrix
!= NULL
25882 /* Don't update mouse highlight if hidden */
25883 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25884 /* Recognize when we are called to operate on rows that don't exist
25885 anymore. This can happen when a window is split. */
25886 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25888 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25889 struct glyph_row
*row
, *first
, *last
;
25891 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25892 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25894 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25896 int start_hpos
, end_hpos
, start_x
;
25898 /* For all but the first row, the highlight starts at column 0. */
25901 /* R2L rows have BEG and END in reversed order, but the
25902 screen drawing geometry is always left to right. So
25903 we need to mirror the beginning and end of the
25904 highlighted area in R2L rows. */
25905 if (!row
->reversed_p
)
25907 start_hpos
= hlinfo
->mouse_face_beg_col
;
25908 start_x
= hlinfo
->mouse_face_beg_x
;
25910 else if (row
== last
)
25912 start_hpos
= hlinfo
->mouse_face_end_col
;
25913 start_x
= hlinfo
->mouse_face_end_x
;
25921 else if (row
->reversed_p
&& row
== last
)
25923 start_hpos
= hlinfo
->mouse_face_end_col
;
25924 start_x
= hlinfo
->mouse_face_end_x
;
25934 if (!row
->reversed_p
)
25935 end_hpos
= hlinfo
->mouse_face_end_col
;
25936 else if (row
== first
)
25937 end_hpos
= hlinfo
->mouse_face_beg_col
;
25940 end_hpos
= row
->used
[TEXT_AREA
];
25941 if (draw
== DRAW_NORMAL_TEXT
)
25942 row
->fill_line_p
= 1; /* Clear to end of line */
25945 else if (row
->reversed_p
&& row
== first
)
25946 end_hpos
= hlinfo
->mouse_face_beg_col
;
25949 end_hpos
= row
->used
[TEXT_AREA
];
25950 if (draw
== DRAW_NORMAL_TEXT
)
25951 row
->fill_line_p
= 1; /* Clear to end of line */
25954 if (end_hpos
> start_hpos
)
25956 draw_row_with_mouse_face (w
, start_x
, row
,
25957 start_hpos
, end_hpos
, draw
);
25960 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25964 #ifdef HAVE_WINDOW_SYSTEM
25965 /* When we've written over the cursor, arrange for it to
25966 be displayed again. */
25967 if (FRAME_WINDOW_P (f
)
25968 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25970 int hpos
= w
->phys_cursor
.hpos
;
25972 /* When the window is hscrolled, cursor hpos can legitimately be
25973 out of bounds, but we draw the cursor at the corresponding
25974 window margin in that case. */
25975 if (!row
->reversed_p
&& hpos
< 0)
25977 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25978 hpos
= row
->used
[TEXT_AREA
] - 1;
25981 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25982 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25985 #endif /* HAVE_WINDOW_SYSTEM */
25988 #ifdef HAVE_WINDOW_SYSTEM
25989 /* Change the mouse cursor. */
25990 if (FRAME_WINDOW_P (f
))
25992 if (draw
== DRAW_NORMAL_TEXT
25993 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25994 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25995 else if (draw
== DRAW_MOUSE_FACE
)
25996 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25998 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26000 #endif /* HAVE_WINDOW_SYSTEM */
26004 Clear out the mouse-highlighted active region.
26005 Redraw it un-highlighted first. Value is non-zero if mouse
26006 face was actually drawn unhighlighted. */
26009 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26013 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26015 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26019 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26020 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26021 hlinfo
->mouse_face_window
= Qnil
;
26022 hlinfo
->mouse_face_overlay
= Qnil
;
26026 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26027 within the mouse face on that window. */
26029 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26031 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26033 /* Quickly resolve the easy cases. */
26034 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26035 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26037 if (vpos
< hlinfo
->mouse_face_beg_row
26038 || vpos
> hlinfo
->mouse_face_end_row
)
26040 if (vpos
> hlinfo
->mouse_face_beg_row
26041 && vpos
< hlinfo
->mouse_face_end_row
)
26044 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26046 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26048 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26051 else if ((vpos
== hlinfo
->mouse_face_beg_row
26052 && hpos
>= hlinfo
->mouse_face_beg_col
)
26053 || (vpos
== hlinfo
->mouse_face_end_row
26054 && hpos
< hlinfo
->mouse_face_end_col
))
26059 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26061 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26064 else if ((vpos
== hlinfo
->mouse_face_beg_row
26065 && hpos
<= hlinfo
->mouse_face_beg_col
)
26066 || (vpos
== hlinfo
->mouse_face_end_row
26067 && hpos
> hlinfo
->mouse_face_end_col
))
26075 Non-zero if physical cursor of window W is within mouse face. */
26078 cursor_in_mouse_face_p (struct window
*w
)
26080 int hpos
= w
->phys_cursor
.hpos
;
26081 int vpos
= w
->phys_cursor
.vpos
;
26082 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26084 /* When the window is hscrolled, cursor hpos can legitimately be out
26085 of bounds, but we draw the cursor at the corresponding window
26086 margin in that case. */
26087 if (!row
->reversed_p
&& hpos
< 0)
26089 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26090 hpos
= row
->used
[TEXT_AREA
] - 1;
26092 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26097 /* Find the glyph rows START_ROW and END_ROW of window W that display
26098 characters between buffer positions START_CHARPOS and END_CHARPOS
26099 (excluding END_CHARPOS). DISP_STRING is a display string that
26100 covers these buffer positions. This is similar to
26101 row_containing_pos, but is more accurate when bidi reordering makes
26102 buffer positions change non-linearly with glyph rows. */
26104 rows_from_pos_range (struct window
*w
,
26105 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26106 Lisp_Object disp_string
,
26107 struct glyph_row
**start
, struct glyph_row
**end
)
26109 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26110 int last_y
= window_text_bottom_y (w
);
26111 struct glyph_row
*row
;
26116 while (!first
->enabled_p
26117 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26120 /* Find the START row. */
26122 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26125 /* A row can potentially be the START row if the range of the
26126 characters it displays intersects the range
26127 [START_CHARPOS..END_CHARPOS). */
26128 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26129 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26130 /* See the commentary in row_containing_pos, for the
26131 explanation of the complicated way to check whether
26132 some position is beyond the end of the characters
26133 displayed by a row. */
26134 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26135 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26136 && !row
->ends_at_zv_p
26137 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26138 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26139 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26140 && !row
->ends_at_zv_p
26141 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26143 /* Found a candidate row. Now make sure at least one of the
26144 glyphs it displays has a charpos from the range
26145 [START_CHARPOS..END_CHARPOS).
26147 This is not obvious because bidi reordering could make
26148 buffer positions of a row be 1,2,3,102,101,100, and if we
26149 want to highlight characters in [50..60), we don't want
26150 this row, even though [50..60) does intersect [1..103),
26151 the range of character positions given by the row's start
26152 and end positions. */
26153 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26154 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26158 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26159 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26160 /* A glyph that comes from DISP_STRING is by
26161 definition to be highlighted. */
26162 || EQ (g
->object
, disp_string
))
26171 /* Find the END row. */
26173 /* If the last row is partially visible, start looking for END
26174 from that row, instead of starting from FIRST. */
26175 && !(row
->enabled_p
26176 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26178 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26180 struct glyph_row
*next
= row
+ 1;
26181 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26183 if (!next
->enabled_p
26184 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26185 /* The first row >= START whose range of displayed characters
26186 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26187 is the row END + 1. */
26188 || (start_charpos
< next_start
26189 && end_charpos
< next_start
)
26190 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26191 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26192 && !next
->ends_at_zv_p
26193 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26194 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26195 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26196 && !next
->ends_at_zv_p
26197 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26204 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26205 but none of the characters it displays are in the range, it is
26207 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26208 struct glyph
*s
= g
;
26209 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26213 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26214 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26215 /* If the buffer position of the first glyph in
26216 the row is equal to END_CHARPOS, it means
26217 the last character to be highlighted is the
26218 newline of ROW, and we must consider NEXT as
26220 || (((!next
->reversed_p
&& g
== s
)
26221 || (next
->reversed_p
&& g
== e
- 1))
26222 && (g
->charpos
== end_charpos
26223 /* Special case for when NEXT is an
26224 empty line at ZV. */
26225 || (g
->charpos
== -1
26226 && !row
->ends_at_zv_p
26227 && next_start
== end_charpos
)))))
26228 /* A glyph that comes from DISP_STRING is by
26229 definition to be highlighted. */
26230 || EQ (g
->object
, disp_string
))
26239 /* The first row that ends at ZV must be the last to be
26241 else if (next
->ends_at_zv_p
)
26250 /* This function sets the mouse_face_* elements of HLINFO, assuming
26251 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26252 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26253 for the overlay or run of text properties specifying the mouse
26254 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26255 before-string and after-string that must also be highlighted.
26256 DISP_STRING, if non-nil, is a display string that may cover some
26257 or all of the highlighted text. */
26260 mouse_face_from_buffer_pos (Lisp_Object window
,
26261 Mouse_HLInfo
*hlinfo
,
26262 ptrdiff_t mouse_charpos
,
26263 ptrdiff_t start_charpos
,
26264 ptrdiff_t end_charpos
,
26265 Lisp_Object before_string
,
26266 Lisp_Object after_string
,
26267 Lisp_Object disp_string
)
26269 struct window
*w
= XWINDOW (window
);
26270 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26271 struct glyph_row
*r1
, *r2
;
26272 struct glyph
*glyph
, *end
;
26273 ptrdiff_t ignore
, pos
;
26276 xassert (NILP (disp_string
) || STRINGP (disp_string
));
26277 xassert (NILP (before_string
) || STRINGP (before_string
));
26278 xassert (NILP (after_string
) || STRINGP (after_string
));
26280 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26281 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26283 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26284 /* If the before-string or display-string contains newlines,
26285 rows_from_pos_range skips to its last row. Move back. */
26286 if (!NILP (before_string
) || !NILP (disp_string
))
26288 struct glyph_row
*prev
;
26289 while ((prev
= r1
- 1, prev
>= first
)
26290 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26291 && prev
->used
[TEXT_AREA
] > 0)
26293 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26294 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26295 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26297 || !(EQ (glyph
->object
, before_string
)
26298 || EQ (glyph
->object
, disp_string
)))
26305 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26306 hlinfo
->mouse_face_past_end
= 1;
26308 else if (!NILP (after_string
))
26310 /* If the after-string has newlines, advance to its last row. */
26311 struct glyph_row
*next
;
26312 struct glyph_row
*last
26313 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26315 for (next
= r2
+ 1;
26317 && next
->used
[TEXT_AREA
] > 0
26318 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26322 /* The rest of the display engine assumes that mouse_face_beg_row is
26323 either above mouse_face_end_row or identical to it. But with
26324 bidi-reordered continued lines, the row for START_CHARPOS could
26325 be below the row for END_CHARPOS. If so, swap the rows and store
26326 them in correct order. */
26329 struct glyph_row
*tem
= r2
;
26335 hlinfo
->mouse_face_beg_y
= r1
->y
;
26336 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26337 hlinfo
->mouse_face_end_y
= r2
->y
;
26338 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26340 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26341 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26342 could be anywhere in the row and in any order. The strategy
26343 below is to find the leftmost and the rightmost glyph that
26344 belongs to either of these 3 strings, or whose position is
26345 between START_CHARPOS and END_CHARPOS, and highlight all the
26346 glyphs between those two. This may cover more than just the text
26347 between START_CHARPOS and END_CHARPOS if the range of characters
26348 strides the bidi level boundary, e.g. if the beginning is in R2L
26349 text while the end is in L2R text or vice versa. */
26350 if (!r1
->reversed_p
)
26352 /* This row is in a left to right paragraph. Scan it left to
26354 glyph
= r1
->glyphs
[TEXT_AREA
];
26355 end
= glyph
+ r1
->used
[TEXT_AREA
];
26358 /* Skip truncation glyphs at the start of the glyph row. */
26359 if (r1
->displays_text_p
)
26361 && INTEGERP (glyph
->object
)
26362 && glyph
->charpos
< 0;
26364 x
+= glyph
->pixel_width
;
26366 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26367 or DISP_STRING, and the first glyph from buffer whose
26368 position is between START_CHARPOS and END_CHARPOS. */
26370 && !INTEGERP (glyph
->object
)
26371 && !EQ (glyph
->object
, disp_string
)
26372 && !(BUFFERP (glyph
->object
)
26373 && (glyph
->charpos
>= start_charpos
26374 && glyph
->charpos
< end_charpos
));
26377 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26378 are present at buffer positions between START_CHARPOS and
26379 END_CHARPOS, or if they come from an overlay. */
26380 if (EQ (glyph
->object
, before_string
))
26382 pos
= string_buffer_position (before_string
,
26384 /* If pos == 0, it means before_string came from an
26385 overlay, not from a buffer position. */
26386 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26389 else if (EQ (glyph
->object
, after_string
))
26391 pos
= string_buffer_position (after_string
, end_charpos
);
26392 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26395 x
+= glyph
->pixel_width
;
26397 hlinfo
->mouse_face_beg_x
= x
;
26398 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26402 /* This row is in a right to left paragraph. Scan it right to
26406 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26407 glyph
= end
+ r1
->used
[TEXT_AREA
];
26409 /* Skip truncation glyphs at the start of the glyph row. */
26410 if (r1
->displays_text_p
)
26412 && INTEGERP (glyph
->object
)
26413 && glyph
->charpos
< 0;
26417 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26418 or DISP_STRING, and the first glyph from buffer whose
26419 position is between START_CHARPOS and END_CHARPOS. */
26421 && !INTEGERP (glyph
->object
)
26422 && !EQ (glyph
->object
, disp_string
)
26423 && !(BUFFERP (glyph
->object
)
26424 && (glyph
->charpos
>= start_charpos
26425 && glyph
->charpos
< end_charpos
));
26428 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26429 are present at buffer positions between START_CHARPOS and
26430 END_CHARPOS, or if they come from an overlay. */
26431 if (EQ (glyph
->object
, before_string
))
26433 pos
= string_buffer_position (before_string
, start_charpos
);
26434 /* If pos == 0, it means before_string came from an
26435 overlay, not from a buffer position. */
26436 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26439 else if (EQ (glyph
->object
, after_string
))
26441 pos
= string_buffer_position (after_string
, end_charpos
);
26442 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26447 glyph
++; /* first glyph to the right of the highlighted area */
26448 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26449 x
+= g
->pixel_width
;
26450 hlinfo
->mouse_face_beg_x
= x
;
26451 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26454 /* If the highlight ends in a different row, compute GLYPH and END
26455 for the end row. Otherwise, reuse the values computed above for
26456 the row where the highlight begins. */
26459 if (!r2
->reversed_p
)
26461 glyph
= r2
->glyphs
[TEXT_AREA
];
26462 end
= glyph
+ r2
->used
[TEXT_AREA
];
26467 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26468 glyph
= end
+ r2
->used
[TEXT_AREA
];
26472 if (!r2
->reversed_p
)
26474 /* Skip truncation and continuation glyphs near the end of the
26475 row, and also blanks and stretch glyphs inserted by
26476 extend_face_to_end_of_line. */
26478 && INTEGERP ((end
- 1)->object
))
26480 /* Scan the rest of the glyph row from the end, looking for the
26481 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26482 DISP_STRING, or whose position is between START_CHARPOS
26486 && !INTEGERP (end
->object
)
26487 && !EQ (end
->object
, disp_string
)
26488 && !(BUFFERP (end
->object
)
26489 && (end
->charpos
>= start_charpos
26490 && end
->charpos
< end_charpos
));
26493 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26494 are present at buffer positions between START_CHARPOS and
26495 END_CHARPOS, or if they come from an overlay. */
26496 if (EQ (end
->object
, before_string
))
26498 pos
= string_buffer_position (before_string
, start_charpos
);
26499 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26502 else if (EQ (end
->object
, after_string
))
26504 pos
= string_buffer_position (after_string
, end_charpos
);
26505 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26509 /* Find the X coordinate of the last glyph to be highlighted. */
26510 for (; glyph
<= end
; ++glyph
)
26511 x
+= glyph
->pixel_width
;
26513 hlinfo
->mouse_face_end_x
= x
;
26514 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26518 /* Skip truncation and continuation glyphs near the end of the
26519 row, and also blanks and stretch glyphs inserted by
26520 extend_face_to_end_of_line. */
26524 && INTEGERP (end
->object
))
26526 x
+= end
->pixel_width
;
26529 /* Scan the rest of the glyph row from the end, looking for the
26530 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26531 DISP_STRING, or whose position is between START_CHARPOS
26535 && !INTEGERP (end
->object
)
26536 && !EQ (end
->object
, disp_string
)
26537 && !(BUFFERP (end
->object
)
26538 && (end
->charpos
>= start_charpos
26539 && end
->charpos
< end_charpos
));
26542 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26543 are present at buffer positions between START_CHARPOS and
26544 END_CHARPOS, or if they come from an overlay. */
26545 if (EQ (end
->object
, before_string
))
26547 pos
= string_buffer_position (before_string
, start_charpos
);
26548 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26551 else if (EQ (end
->object
, after_string
))
26553 pos
= string_buffer_position (after_string
, end_charpos
);
26554 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26557 x
+= end
->pixel_width
;
26559 /* If we exited the above loop because we arrived at the last
26560 glyph of the row, and its buffer position is still not in
26561 range, it means the last character in range is the preceding
26562 newline. Bump the end column and x values to get past the
26565 && BUFFERP (end
->object
)
26566 && (end
->charpos
< start_charpos
26567 || end
->charpos
>= end_charpos
))
26569 x
+= end
->pixel_width
;
26572 hlinfo
->mouse_face_end_x
= x
;
26573 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26576 hlinfo
->mouse_face_window
= window
;
26577 hlinfo
->mouse_face_face_id
26578 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26580 !hlinfo
->mouse_face_hidden
, -1);
26581 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26584 /* The following function is not used anymore (replaced with
26585 mouse_face_from_string_pos), but I leave it here for the time
26586 being, in case someone would. */
26588 #if 0 /* not used */
26590 /* Find the position of the glyph for position POS in OBJECT in
26591 window W's current matrix, and return in *X, *Y the pixel
26592 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26594 RIGHT_P non-zero means return the position of the right edge of the
26595 glyph, RIGHT_P zero means return the left edge position.
26597 If no glyph for POS exists in the matrix, return the position of
26598 the glyph with the next smaller position that is in the matrix, if
26599 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26600 exists in the matrix, return the position of the glyph with the
26601 next larger position in OBJECT.
26603 Value is non-zero if a glyph was found. */
26606 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26607 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26609 int yb
= window_text_bottom_y (w
);
26610 struct glyph_row
*r
;
26611 struct glyph
*best_glyph
= NULL
;
26612 struct glyph_row
*best_row
= NULL
;
26615 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26616 r
->enabled_p
&& r
->y
< yb
;
26619 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26620 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26623 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26624 if (EQ (g
->object
, object
))
26626 if (g
->charpos
== pos
)
26633 else if (best_glyph
== NULL
26634 || ((eabs (g
->charpos
- pos
)
26635 < eabs (best_glyph
->charpos
- pos
))
26638 : g
->charpos
> pos
)))
26652 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26656 *x
+= best_glyph
->pixel_width
;
26661 *vpos
= best_row
- w
->current_matrix
->rows
;
26664 return best_glyph
!= NULL
;
26666 #endif /* not used */
26668 /* Find the positions of the first and the last glyphs in window W's
26669 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26670 (assumed to be a string), and return in HLINFO's mouse_face_*
26671 members the pixel and column/row coordinates of those glyphs. */
26674 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26675 Lisp_Object object
,
26676 ptrdiff_t startpos
, ptrdiff_t endpos
)
26678 int yb
= window_text_bottom_y (w
);
26679 struct glyph_row
*r
;
26680 struct glyph
*g
, *e
;
26684 /* Find the glyph row with at least one position in the range
26685 [STARTPOS..ENDPOS], and the first glyph in that row whose
26686 position belongs to that range. */
26687 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26688 r
->enabled_p
&& r
->y
< yb
;
26691 if (!r
->reversed_p
)
26693 g
= r
->glyphs
[TEXT_AREA
];
26694 e
= g
+ r
->used
[TEXT_AREA
];
26695 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26696 if (EQ (g
->object
, object
)
26697 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26699 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26700 hlinfo
->mouse_face_beg_y
= r
->y
;
26701 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26702 hlinfo
->mouse_face_beg_x
= gx
;
26711 e
= r
->glyphs
[TEXT_AREA
];
26712 g
= e
+ r
->used
[TEXT_AREA
];
26713 for ( ; g
> e
; --g
)
26714 if (EQ ((g
-1)->object
, object
)
26715 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26717 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26718 hlinfo
->mouse_face_beg_y
= r
->y
;
26719 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26720 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26721 gx
+= g1
->pixel_width
;
26722 hlinfo
->mouse_face_beg_x
= gx
;
26734 /* Starting with the next row, look for the first row which does NOT
26735 include any glyphs whose positions are in the range. */
26736 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26738 g
= r
->glyphs
[TEXT_AREA
];
26739 e
= g
+ r
->used
[TEXT_AREA
];
26741 for ( ; g
< e
; ++g
)
26742 if (EQ (g
->object
, object
)
26743 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26752 /* The highlighted region ends on the previous row. */
26755 /* Set the end row and its vertical pixel coordinate. */
26756 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26757 hlinfo
->mouse_face_end_y
= r
->y
;
26759 /* Compute and set the end column and the end column's horizontal
26760 pixel coordinate. */
26761 if (!r
->reversed_p
)
26763 g
= r
->glyphs
[TEXT_AREA
];
26764 e
= g
+ r
->used
[TEXT_AREA
];
26765 for ( ; e
> g
; --e
)
26766 if (EQ ((e
-1)->object
, object
)
26767 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26769 hlinfo
->mouse_face_end_col
= e
- g
;
26771 for (gx
= r
->x
; g
< e
; ++g
)
26772 gx
+= g
->pixel_width
;
26773 hlinfo
->mouse_face_end_x
= gx
;
26777 e
= r
->glyphs
[TEXT_AREA
];
26778 g
= e
+ r
->used
[TEXT_AREA
];
26779 for (gx
= r
->x
; e
< g
; ++e
)
26781 if (EQ (e
->object
, object
)
26782 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26784 gx
+= e
->pixel_width
;
26786 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26787 hlinfo
->mouse_face_end_x
= gx
;
26791 #ifdef HAVE_WINDOW_SYSTEM
26793 /* See if position X, Y is within a hot-spot of an image. */
26796 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26798 if (!CONSP (hot_spot
))
26801 if (EQ (XCAR (hot_spot
), Qrect
))
26803 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26804 Lisp_Object rect
= XCDR (hot_spot
);
26808 if (!CONSP (XCAR (rect
)))
26810 if (!CONSP (XCDR (rect
)))
26812 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26814 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26816 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26818 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26822 else if (EQ (XCAR (hot_spot
), Qcircle
))
26824 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26825 Lisp_Object circ
= XCDR (hot_spot
);
26826 Lisp_Object lr
, lx0
, ly0
;
26828 && CONSP (XCAR (circ
))
26829 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26830 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26831 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26833 double r
= XFLOATINT (lr
);
26834 double dx
= XINT (lx0
) - x
;
26835 double dy
= XINT (ly0
) - y
;
26836 return (dx
* dx
+ dy
* dy
<= r
* r
);
26839 else if (EQ (XCAR (hot_spot
), Qpoly
))
26841 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26842 if (VECTORP (XCDR (hot_spot
)))
26844 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26845 Lisp_Object
*poly
= v
->contents
;
26846 ptrdiff_t n
= v
->header
.size
;
26849 Lisp_Object lx
, ly
;
26852 /* Need an even number of coordinates, and at least 3 edges. */
26853 if (n
< 6 || n
& 1)
26856 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26857 If count is odd, we are inside polygon. Pixels on edges
26858 may or may not be included depending on actual geometry of the
26860 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26861 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26863 x0
= XINT (lx
), y0
= XINT (ly
);
26864 for (i
= 0; i
< n
; i
+= 2)
26866 int x1
= x0
, y1
= y0
;
26867 if ((lx
= poly
[i
], !INTEGERP (lx
))
26868 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26870 x0
= XINT (lx
), y0
= XINT (ly
);
26872 /* Does this segment cross the X line? */
26880 if (y
> y0
&& y
> y1
)
26882 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26892 find_hot_spot (Lisp_Object map
, int x
, int y
)
26894 while (CONSP (map
))
26896 if (CONSP (XCAR (map
))
26897 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26905 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26907 doc
: /* Lookup in image map MAP coordinates X and Y.
26908 An image map is an alist where each element has the format (AREA ID PLIST).
26909 An AREA is specified as either a rectangle, a circle, or a polygon:
26910 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26911 pixel coordinates of the upper left and bottom right corners.
26912 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26913 and the radius of the circle; r may be a float or integer.
26914 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26915 vector describes one corner in the polygon.
26916 Returns the alist element for the first matching AREA in MAP. */)
26917 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26925 return find_hot_spot (map
,
26926 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
26927 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
26931 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26933 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26935 /* Do not change cursor shape while dragging mouse. */
26936 if (!NILP (do_mouse_tracking
))
26939 if (!NILP (pointer
))
26941 if (EQ (pointer
, Qarrow
))
26942 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26943 else if (EQ (pointer
, Qhand
))
26944 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26945 else if (EQ (pointer
, Qtext
))
26946 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26947 else if (EQ (pointer
, intern ("hdrag")))
26948 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26949 #ifdef HAVE_X_WINDOWS
26950 else if (EQ (pointer
, intern ("vdrag")))
26951 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26953 else if (EQ (pointer
, intern ("hourglass")))
26954 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26955 else if (EQ (pointer
, Qmodeline
))
26956 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26958 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26961 if (cursor
!= No_Cursor
)
26962 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26965 #endif /* HAVE_WINDOW_SYSTEM */
26967 /* Take proper action when mouse has moved to the mode or header line
26968 or marginal area AREA of window W, x-position X and y-position Y.
26969 X is relative to the start of the text display area of W, so the
26970 width of bitmap areas and scroll bars must be subtracted to get a
26971 position relative to the start of the mode line. */
26974 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26975 enum window_part area
)
26977 struct window
*w
= XWINDOW (window
);
26978 struct frame
*f
= XFRAME (w
->frame
);
26979 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26980 #ifdef HAVE_WINDOW_SYSTEM
26981 Display_Info
*dpyinfo
;
26983 Cursor cursor
= No_Cursor
;
26984 Lisp_Object pointer
= Qnil
;
26985 int dx
, dy
, width
, height
;
26987 Lisp_Object string
, object
= Qnil
;
26988 Lisp_Object pos
IF_LINT (= Qnil
), help
;
26990 Lisp_Object mouse_face
;
26991 int original_x_pixel
= x
;
26992 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26993 struct glyph_row
*row
IF_LINT (= 0);
26995 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27000 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27001 returns them in row/column units! */
27002 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27003 &object
, &dx
, &dy
, &width
, &height
);
27005 row
= (area
== ON_MODE_LINE
27006 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27007 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27009 /* Find the glyph under the mouse pointer. */
27010 if (row
->mode_line_p
&& row
->enabled_p
)
27012 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27013 end
= glyph
+ row
->used
[TEXT_AREA
];
27015 for (x0
= original_x_pixel
;
27016 glyph
< end
&& x0
>= glyph
->pixel_width
;
27018 x0
-= glyph
->pixel_width
;
27026 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27027 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27028 returns them in row/column units! */
27029 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27030 &object
, &dx
, &dy
, &width
, &height
);
27035 #ifdef HAVE_WINDOW_SYSTEM
27036 if (IMAGEP (object
))
27038 Lisp_Object image_map
, hotspot
;
27039 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27041 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27043 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27047 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27048 If so, we could look for mouse-enter, mouse-leave
27049 properties in PLIST (and do something...). */
27050 hotspot
= XCDR (hotspot
);
27051 if (CONSP (hotspot
)
27052 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27054 pointer
= Fplist_get (plist
, Qpointer
);
27055 if (NILP (pointer
))
27057 help
= Fplist_get (plist
, Qhelp_echo
);
27060 help_echo_string
= help
;
27061 XSETWINDOW (help_echo_window
, w
);
27062 help_echo_object
= w
->buffer
;
27063 help_echo_pos
= charpos
;
27067 if (NILP (pointer
))
27068 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27070 #endif /* HAVE_WINDOW_SYSTEM */
27072 if (STRINGP (string
))
27073 pos
= make_number (charpos
);
27075 /* Set the help text and mouse pointer. If the mouse is on a part
27076 of the mode line without any text (e.g. past the right edge of
27077 the mode line text), use the default help text and pointer. */
27078 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27080 /* Arrange to display the help by setting the global variables
27081 help_echo_string, help_echo_object, and help_echo_pos. */
27084 if (STRINGP (string
))
27085 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27089 help_echo_string
= help
;
27090 XSETWINDOW (help_echo_window
, w
);
27091 help_echo_object
= string
;
27092 help_echo_pos
= charpos
;
27094 else if (area
== ON_MODE_LINE
)
27096 Lisp_Object default_help
27097 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27100 if (STRINGP (default_help
))
27102 help_echo_string
= default_help
;
27103 XSETWINDOW (help_echo_window
, w
);
27104 help_echo_object
= Qnil
;
27105 help_echo_pos
= -1;
27110 #ifdef HAVE_WINDOW_SYSTEM
27111 /* Change the mouse pointer according to what is under it. */
27112 if (FRAME_WINDOW_P (f
))
27114 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27115 if (STRINGP (string
))
27117 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27119 if (NILP (pointer
))
27120 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27122 /* Change the mouse pointer according to what is under X/Y. */
27124 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27127 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27128 if (!KEYMAPP (map
))
27129 map
= Fget_text_property (pos
, Qkeymap
, string
);
27130 if (!KEYMAPP (map
))
27131 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27135 /* Default mode-line pointer. */
27136 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27141 /* Change the mouse face according to what is under X/Y. */
27142 if (STRINGP (string
))
27144 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27145 if (!NILP (mouse_face
)
27146 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27151 struct glyph
* tmp_glyph
;
27155 int total_pixel_width
;
27156 ptrdiff_t begpos
, endpos
, ignore
;
27160 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27161 Qmouse_face
, string
, Qnil
);
27167 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27169 endpos
= SCHARS (string
);
27173 /* Calculate the glyph position GPOS of GLYPH in the
27174 displayed string, relative to the beginning of the
27175 highlighted part of the string.
27177 Note: GPOS is different from CHARPOS. CHARPOS is the
27178 position of GLYPH in the internal string object. A mode
27179 line string format has structures which are converted to
27180 a flattened string by the Emacs Lisp interpreter. The
27181 internal string is an element of those structures. The
27182 displayed string is the flattened string. */
27183 tmp_glyph
= row_start_glyph
;
27184 while (tmp_glyph
< glyph
27185 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27186 && begpos
<= tmp_glyph
->charpos
27187 && tmp_glyph
->charpos
< endpos
)))
27189 gpos
= glyph
- tmp_glyph
;
27191 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27192 the highlighted part of the displayed string to which
27193 GLYPH belongs. Note: GSEQ_LENGTH is different from
27194 SCHARS (STRING), because the latter returns the length of
27195 the internal string. */
27196 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27198 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27199 && begpos
<= tmp_glyph
->charpos
27200 && tmp_glyph
->charpos
< endpos
));
27203 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27205 /* Calculate the total pixel width of all the glyphs between
27206 the beginning of the highlighted area and GLYPH. */
27207 total_pixel_width
= 0;
27208 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27209 total_pixel_width
+= tmp_glyph
->pixel_width
;
27211 /* Pre calculation of re-rendering position. Note: X is in
27212 column units here, after the call to mode_line_string or
27213 marginal_area_string. */
27215 vpos
= (area
== ON_MODE_LINE
27216 ? (w
->current_matrix
)->nrows
- 1
27219 /* If GLYPH's position is included in the region that is
27220 already drawn in mouse face, we have nothing to do. */
27221 if ( EQ (window
, hlinfo
->mouse_face_window
)
27222 && (!row
->reversed_p
27223 ? (hlinfo
->mouse_face_beg_col
<= hpos
27224 && hpos
< hlinfo
->mouse_face_end_col
)
27225 /* In R2L rows we swap BEG and END, see below. */
27226 : (hlinfo
->mouse_face_end_col
<= hpos
27227 && hpos
< hlinfo
->mouse_face_beg_col
))
27228 && hlinfo
->mouse_face_beg_row
== vpos
)
27231 if (clear_mouse_face (hlinfo
))
27232 cursor
= No_Cursor
;
27234 if (!row
->reversed_p
)
27236 hlinfo
->mouse_face_beg_col
= hpos
;
27237 hlinfo
->mouse_face_beg_x
= original_x_pixel
27238 - (total_pixel_width
+ dx
);
27239 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27240 hlinfo
->mouse_face_end_x
= 0;
27244 /* In R2L rows, show_mouse_face expects BEG and END
27245 coordinates to be swapped. */
27246 hlinfo
->mouse_face_end_col
= hpos
;
27247 hlinfo
->mouse_face_end_x
= original_x_pixel
27248 - (total_pixel_width
+ dx
);
27249 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27250 hlinfo
->mouse_face_beg_x
= 0;
27253 hlinfo
->mouse_face_beg_row
= vpos
;
27254 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27255 hlinfo
->mouse_face_beg_y
= 0;
27256 hlinfo
->mouse_face_end_y
= 0;
27257 hlinfo
->mouse_face_past_end
= 0;
27258 hlinfo
->mouse_face_window
= window
;
27260 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27266 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27268 if (NILP (pointer
))
27271 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27272 clear_mouse_face (hlinfo
);
27274 #ifdef HAVE_WINDOW_SYSTEM
27275 if (FRAME_WINDOW_P (f
))
27276 define_frame_cursor1 (f
, cursor
, pointer
);
27282 Take proper action when the mouse has moved to position X, Y on
27283 frame F as regards highlighting characters that have mouse-face
27284 properties. Also de-highlighting chars where the mouse was before.
27285 X and Y can be negative or out of range. */
27288 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27290 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27291 enum window_part part
= ON_NOTHING
;
27292 Lisp_Object window
;
27294 Cursor cursor
= No_Cursor
;
27295 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27298 /* When a menu is active, don't highlight because this looks odd. */
27299 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27300 if (popup_activated ())
27304 if (NILP (Vmouse_highlight
)
27305 || !f
->glyphs_initialized_p
27306 || f
->pointer_invisible
)
27309 hlinfo
->mouse_face_mouse_x
= x
;
27310 hlinfo
->mouse_face_mouse_y
= y
;
27311 hlinfo
->mouse_face_mouse_frame
= f
;
27313 if (hlinfo
->mouse_face_defer
)
27316 if (gc_in_progress
)
27318 hlinfo
->mouse_face_deferred_gc
= 1;
27322 /* Which window is that in? */
27323 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27325 /* If displaying active text in another window, clear that. */
27326 if (! EQ (window
, hlinfo
->mouse_face_window
)
27327 /* Also clear if we move out of text area in same window. */
27328 || (!NILP (hlinfo
->mouse_face_window
)
27331 && part
!= ON_MODE_LINE
27332 && part
!= ON_HEADER_LINE
))
27333 clear_mouse_face (hlinfo
);
27335 /* Not on a window -> return. */
27336 if (!WINDOWP (window
))
27339 /* Reset help_echo_string. It will get recomputed below. */
27340 help_echo_string
= Qnil
;
27342 /* Convert to window-relative pixel coordinates. */
27343 w
= XWINDOW (window
);
27344 frame_to_window_pixel_xy (w
, &x
, &y
);
27346 #ifdef HAVE_WINDOW_SYSTEM
27347 /* Handle tool-bar window differently since it doesn't display a
27349 if (EQ (window
, f
->tool_bar_window
))
27351 note_tool_bar_highlight (f
, x
, y
);
27356 /* Mouse is on the mode, header line or margin? */
27357 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27358 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27360 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27364 #ifdef HAVE_WINDOW_SYSTEM
27365 if (part
== ON_VERTICAL_BORDER
)
27367 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27368 help_echo_string
= build_string ("drag-mouse-1: resize");
27370 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27371 || part
== ON_SCROLL_BAR
)
27372 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27374 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27377 /* Are we in a window whose display is up to date?
27378 And verify the buffer's text has not changed. */
27379 b
= XBUFFER (w
->buffer
);
27380 if (part
== ON_TEXT
27381 && EQ (w
->window_end_valid
, w
->buffer
)
27382 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27383 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27385 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27387 struct glyph
*glyph
;
27388 Lisp_Object object
;
27389 Lisp_Object mouse_face
= Qnil
, position
;
27390 Lisp_Object
*overlay_vec
= NULL
;
27391 ptrdiff_t i
, noverlays
;
27392 struct buffer
*obuf
;
27393 ptrdiff_t obegv
, ozv
;
27396 /* Find the glyph under X/Y. */
27397 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27399 #ifdef HAVE_WINDOW_SYSTEM
27400 /* Look for :pointer property on image. */
27401 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27403 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27404 if (img
!= NULL
&& IMAGEP (img
->spec
))
27406 Lisp_Object image_map
, hotspot
;
27407 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27409 && (hotspot
= find_hot_spot (image_map
,
27410 glyph
->slice
.img
.x
+ dx
,
27411 glyph
->slice
.img
.y
+ dy
),
27413 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27417 /* Could check XCAR (hotspot) to see if we enter/leave
27419 If so, we could look for mouse-enter, mouse-leave
27420 properties in PLIST (and do something...). */
27421 hotspot
= XCDR (hotspot
);
27422 if (CONSP (hotspot
)
27423 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27425 pointer
= Fplist_get (plist
, Qpointer
);
27426 if (NILP (pointer
))
27428 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27429 if (!NILP (help_echo_string
))
27431 help_echo_window
= window
;
27432 help_echo_object
= glyph
->object
;
27433 help_echo_pos
= glyph
->charpos
;
27437 if (NILP (pointer
))
27438 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27441 #endif /* HAVE_WINDOW_SYSTEM */
27443 /* Clear mouse face if X/Y not over text. */
27445 || area
!= TEXT_AREA
27446 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27447 /* Glyph's OBJECT is an integer for glyphs inserted by the
27448 display engine for its internal purposes, like truncation
27449 and continuation glyphs and blanks beyond the end of
27450 line's text on text terminals. If we are over such a
27451 glyph, we are not over any text. */
27452 || INTEGERP (glyph
->object
)
27453 /* R2L rows have a stretch glyph at their front, which
27454 stands for no text, whereas L2R rows have no glyphs at
27455 all beyond the end of text. Treat such stretch glyphs
27456 like we do with NULL glyphs in L2R rows. */
27457 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27458 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27459 && glyph
->type
== STRETCH_GLYPH
27460 && glyph
->avoid_cursor_p
))
27462 if (clear_mouse_face (hlinfo
))
27463 cursor
= No_Cursor
;
27464 #ifdef HAVE_WINDOW_SYSTEM
27465 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27467 if (area
!= TEXT_AREA
)
27468 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27470 pointer
= Vvoid_text_area_pointer
;
27476 pos
= glyph
->charpos
;
27477 object
= glyph
->object
;
27478 if (!STRINGP (object
) && !BUFFERP (object
))
27481 /* If we get an out-of-range value, return now; avoid an error. */
27482 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27485 /* Make the window's buffer temporarily current for
27486 overlays_at and compute_char_face. */
27487 obuf
= current_buffer
;
27488 current_buffer
= b
;
27494 /* Is this char mouse-active or does it have help-echo? */
27495 position
= make_number (pos
);
27497 if (BUFFERP (object
))
27499 /* Put all the overlays we want in a vector in overlay_vec. */
27500 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27501 /* Sort overlays into increasing priority order. */
27502 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27507 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27510 cursor
= No_Cursor
;
27512 /* Check mouse-face highlighting. */
27514 /* If there exists an overlay with mouse-face overlapping
27515 the one we are currently highlighting, we have to
27516 check if we enter the overlapping overlay, and then
27517 highlight only that. */
27518 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27519 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27521 /* Find the highest priority overlay with a mouse-face. */
27522 Lisp_Object overlay
= Qnil
;
27523 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27525 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27526 if (!NILP (mouse_face
))
27527 overlay
= overlay_vec
[i
];
27530 /* If we're highlighting the same overlay as before, there's
27531 no need to do that again. */
27532 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27533 goto check_help_echo
;
27534 hlinfo
->mouse_face_overlay
= overlay
;
27536 /* Clear the display of the old active region, if any. */
27537 if (clear_mouse_face (hlinfo
))
27538 cursor
= No_Cursor
;
27540 /* If no overlay applies, get a text property. */
27541 if (NILP (overlay
))
27542 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27544 /* Next, compute the bounds of the mouse highlighting and
27546 if (!NILP (mouse_face
) && STRINGP (object
))
27548 /* The mouse-highlighting comes from a display string
27549 with a mouse-face. */
27553 s
= Fprevious_single_property_change
27554 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27555 e
= Fnext_single_property_change
27556 (position
, Qmouse_face
, object
, Qnil
);
27558 s
= make_number (0);
27560 e
= make_number (SCHARS (object
) - 1);
27561 mouse_face_from_string_pos (w
, hlinfo
, object
,
27562 XINT (s
), XINT (e
));
27563 hlinfo
->mouse_face_past_end
= 0;
27564 hlinfo
->mouse_face_window
= window
;
27565 hlinfo
->mouse_face_face_id
27566 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27567 glyph
->face_id
, 1);
27568 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27569 cursor
= No_Cursor
;
27573 /* The mouse-highlighting, if any, comes from an overlay
27574 or text property in the buffer. */
27575 Lisp_Object buffer
IF_LINT (= Qnil
);
27576 Lisp_Object disp_string
IF_LINT (= Qnil
);
27578 if (STRINGP (object
))
27580 /* If we are on a display string with no mouse-face,
27581 check if the text under it has one. */
27582 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27583 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27584 pos
= string_buffer_position (object
, start
);
27587 mouse_face
= get_char_property_and_overlay
27588 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27589 buffer
= w
->buffer
;
27590 disp_string
= object
;
27596 disp_string
= Qnil
;
27599 if (!NILP (mouse_face
))
27601 Lisp_Object before
, after
;
27602 Lisp_Object before_string
, after_string
;
27603 /* To correctly find the limits of mouse highlight
27604 in a bidi-reordered buffer, we must not use the
27605 optimization of limiting the search in
27606 previous-single-property-change and
27607 next-single-property-change, because
27608 rows_from_pos_range needs the real start and end
27609 positions to DTRT in this case. That's because
27610 the first row visible in a window does not
27611 necessarily display the character whose position
27612 is the smallest. */
27614 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27615 ? Fmarker_position (w
->start
)
27618 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27619 ? make_number (BUF_Z (XBUFFER (buffer
))
27620 - XFASTINT (w
->window_end_pos
))
27623 if (NILP (overlay
))
27625 /* Handle the text property case. */
27626 before
= Fprevious_single_property_change
27627 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27628 after
= Fnext_single_property_change
27629 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27630 before_string
= after_string
= Qnil
;
27634 /* Handle the overlay case. */
27635 before
= Foverlay_start (overlay
);
27636 after
= Foverlay_end (overlay
);
27637 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27638 after_string
= Foverlay_get (overlay
, Qafter_string
);
27640 if (!STRINGP (before_string
)) before_string
= Qnil
;
27641 if (!STRINGP (after_string
)) after_string
= Qnil
;
27644 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27647 : XFASTINT (before
),
27649 ? BUF_Z (XBUFFER (buffer
))
27650 : XFASTINT (after
),
27651 before_string
, after_string
,
27653 cursor
= No_Cursor
;
27660 /* Look for a `help-echo' property. */
27661 if (NILP (help_echo_string
)) {
27662 Lisp_Object help
, overlay
;
27664 /* Check overlays first. */
27665 help
= overlay
= Qnil
;
27666 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27668 overlay
= overlay_vec
[i
];
27669 help
= Foverlay_get (overlay
, Qhelp_echo
);
27674 help_echo_string
= help
;
27675 help_echo_window
= window
;
27676 help_echo_object
= overlay
;
27677 help_echo_pos
= pos
;
27681 Lisp_Object obj
= glyph
->object
;
27682 ptrdiff_t charpos
= glyph
->charpos
;
27684 /* Try text properties. */
27687 && charpos
< SCHARS (obj
))
27689 help
= Fget_text_property (make_number (charpos
),
27693 /* If the string itself doesn't specify a help-echo,
27694 see if the buffer text ``under'' it does. */
27695 struct glyph_row
*r
27696 = MATRIX_ROW (w
->current_matrix
, vpos
);
27697 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27698 ptrdiff_t p
= string_buffer_position (obj
, start
);
27701 help
= Fget_char_property (make_number (p
),
27702 Qhelp_echo
, w
->buffer
);
27711 else if (BUFFERP (obj
)
27714 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27719 help_echo_string
= help
;
27720 help_echo_window
= window
;
27721 help_echo_object
= obj
;
27722 help_echo_pos
= charpos
;
27727 #ifdef HAVE_WINDOW_SYSTEM
27728 /* Look for a `pointer' property. */
27729 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27731 /* Check overlays first. */
27732 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27733 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27735 if (NILP (pointer
))
27737 Lisp_Object obj
= glyph
->object
;
27738 ptrdiff_t charpos
= glyph
->charpos
;
27740 /* Try text properties. */
27743 && charpos
< SCHARS (obj
))
27745 pointer
= Fget_text_property (make_number (charpos
),
27747 if (NILP (pointer
))
27749 /* If the string itself doesn't specify a pointer,
27750 see if the buffer text ``under'' it does. */
27751 struct glyph_row
*r
27752 = MATRIX_ROW (w
->current_matrix
, vpos
);
27753 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27754 ptrdiff_t p
= string_buffer_position (obj
, start
);
27756 pointer
= Fget_char_property (make_number (p
),
27757 Qpointer
, w
->buffer
);
27760 else if (BUFFERP (obj
)
27763 pointer
= Fget_text_property (make_number (charpos
),
27767 #endif /* HAVE_WINDOW_SYSTEM */
27771 current_buffer
= obuf
;
27776 #ifdef HAVE_WINDOW_SYSTEM
27777 if (FRAME_WINDOW_P (f
))
27778 define_frame_cursor1 (f
, cursor
, pointer
);
27780 /* This is here to prevent a compiler error, about "label at end of
27781 compound statement". */
27788 Clear any mouse-face on window W. This function is part of the
27789 redisplay interface, and is called from try_window_id and similar
27790 functions to ensure the mouse-highlight is off. */
27793 x_clear_window_mouse_face (struct window
*w
)
27795 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27796 Lisp_Object window
;
27799 XSETWINDOW (window
, w
);
27800 if (EQ (window
, hlinfo
->mouse_face_window
))
27801 clear_mouse_face (hlinfo
);
27807 Just discard the mouse face information for frame F, if any.
27808 This is used when the size of F is changed. */
27811 cancel_mouse_face (struct frame
*f
)
27813 Lisp_Object window
;
27814 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27816 window
= hlinfo
->mouse_face_window
;
27817 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27819 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27820 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27821 hlinfo
->mouse_face_window
= Qnil
;
27827 /***********************************************************************
27829 ***********************************************************************/
27831 #ifdef HAVE_WINDOW_SYSTEM
27833 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27834 which intersects rectangle R. R is in window-relative coordinates. */
27837 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27838 enum glyph_row_area area
)
27840 struct glyph
*first
= row
->glyphs
[area
];
27841 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27842 struct glyph
*last
;
27843 int first_x
, start_x
, x
;
27845 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27846 /* If row extends face to end of line write the whole line. */
27847 draw_glyphs (w
, 0, row
, area
,
27848 0, row
->used
[area
],
27849 DRAW_NORMAL_TEXT
, 0);
27852 /* Set START_X to the window-relative start position for drawing glyphs of
27853 AREA. The first glyph of the text area can be partially visible.
27854 The first glyphs of other areas cannot. */
27855 start_x
= window_box_left_offset (w
, area
);
27857 if (area
== TEXT_AREA
)
27860 /* Find the first glyph that must be redrawn. */
27862 && x
+ first
->pixel_width
< r
->x
)
27864 x
+= first
->pixel_width
;
27868 /* Find the last one. */
27872 && x
< r
->x
+ r
->width
)
27874 x
+= last
->pixel_width
;
27880 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27881 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27882 DRAW_NORMAL_TEXT
, 0);
27887 /* Redraw the parts of the glyph row ROW on window W intersecting
27888 rectangle R. R is in window-relative coordinates. Value is
27889 non-zero if mouse-face was overwritten. */
27892 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27894 xassert (row
->enabled_p
);
27896 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27897 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27898 0, row
->used
[TEXT_AREA
],
27899 DRAW_NORMAL_TEXT
, 0);
27902 if (row
->used
[LEFT_MARGIN_AREA
])
27903 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27904 if (row
->used
[TEXT_AREA
])
27905 expose_area (w
, row
, r
, TEXT_AREA
);
27906 if (row
->used
[RIGHT_MARGIN_AREA
])
27907 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27908 draw_row_fringe_bitmaps (w
, row
);
27911 return row
->mouse_face_p
;
27915 /* Redraw those parts of glyphs rows during expose event handling that
27916 overlap other rows. Redrawing of an exposed line writes over parts
27917 of lines overlapping that exposed line; this function fixes that.
27919 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27920 row in W's current matrix that is exposed and overlaps other rows.
27921 LAST_OVERLAPPING_ROW is the last such row. */
27924 expose_overlaps (struct window
*w
,
27925 struct glyph_row
*first_overlapping_row
,
27926 struct glyph_row
*last_overlapping_row
,
27929 struct glyph_row
*row
;
27931 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27932 if (row
->overlapping_p
)
27934 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27937 if (row
->used
[LEFT_MARGIN_AREA
])
27938 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27940 if (row
->used
[TEXT_AREA
])
27941 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27943 if (row
->used
[RIGHT_MARGIN_AREA
])
27944 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27950 /* Return non-zero if W's cursor intersects rectangle R. */
27953 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27955 XRectangle cr
, result
;
27956 struct glyph
*cursor_glyph
;
27957 struct glyph_row
*row
;
27959 if (w
->phys_cursor
.vpos
>= 0
27960 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27961 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27963 && row
->cursor_in_fringe_p
)
27965 /* Cursor is in the fringe. */
27966 cr
.x
= window_box_right_offset (w
,
27967 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27968 ? RIGHT_MARGIN_AREA
27971 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27972 cr
.height
= row
->height
;
27973 return x_intersect_rectangles (&cr
, r
, &result
);
27976 cursor_glyph
= get_phys_cursor_glyph (w
);
27979 /* r is relative to W's box, but w->phys_cursor.x is relative
27980 to left edge of W's TEXT area. Adjust it. */
27981 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27982 cr
.y
= w
->phys_cursor
.y
;
27983 cr
.width
= cursor_glyph
->pixel_width
;
27984 cr
.height
= w
->phys_cursor_height
;
27985 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27986 I assume the effect is the same -- and this is portable. */
27987 return x_intersect_rectangles (&cr
, r
, &result
);
27989 /* If we don't understand the format, pretend we're not in the hot-spot. */
27995 Draw a vertical window border to the right of window W if W doesn't
27996 have vertical scroll bars. */
27999 x_draw_vertical_border (struct window
*w
)
28001 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28003 /* We could do better, if we knew what type of scroll-bar the adjacent
28004 windows (on either side) have... But we don't :-(
28005 However, I think this works ok. ++KFS 2003-04-25 */
28007 /* Redraw borders between horizontally adjacent windows. Don't
28008 do it for frames with vertical scroll bars because either the
28009 right scroll bar of a window, or the left scroll bar of its
28010 neighbor will suffice as a border. */
28011 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28014 if (!WINDOW_RIGHTMOST_P (w
)
28015 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28017 int x0
, x1
, y0
, y1
;
28019 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28022 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28025 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28027 else if (!WINDOW_LEFTMOST_P (w
)
28028 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28030 int x0
, x1
, y0
, y1
;
28032 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28035 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28038 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28043 /* Redraw the part of window W intersection rectangle FR. Pixel
28044 coordinates in FR are frame-relative. Call this function with
28045 input blocked. Value is non-zero if the exposure overwrites
28049 expose_window (struct window
*w
, XRectangle
*fr
)
28051 struct frame
*f
= XFRAME (w
->frame
);
28053 int mouse_face_overwritten_p
= 0;
28055 /* If window is not yet fully initialized, do nothing. This can
28056 happen when toolkit scroll bars are used and a window is split.
28057 Reconfiguring the scroll bar will generate an expose for a newly
28059 if (w
->current_matrix
== NULL
)
28062 /* When we're currently updating the window, display and current
28063 matrix usually don't agree. Arrange for a thorough display
28065 if (w
== updated_window
)
28067 SET_FRAME_GARBAGED (f
);
28071 /* Frame-relative pixel rectangle of W. */
28072 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28073 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28074 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28075 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28077 if (x_intersect_rectangles (fr
, &wr
, &r
))
28079 int yb
= window_text_bottom_y (w
);
28080 struct glyph_row
*row
;
28081 int cursor_cleared_p
, phys_cursor_on_p
;
28082 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28084 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28085 r
.x
, r
.y
, r
.width
, r
.height
));
28087 /* Convert to window coordinates. */
28088 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28089 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28091 /* Turn off the cursor. */
28092 if (!w
->pseudo_window_p
28093 && phys_cursor_in_rect_p (w
, &r
))
28095 x_clear_cursor (w
);
28096 cursor_cleared_p
= 1;
28099 cursor_cleared_p
= 0;
28101 /* If the row containing the cursor extends face to end of line,
28102 then expose_area might overwrite the cursor outside the
28103 rectangle and thus notice_overwritten_cursor might clear
28104 w->phys_cursor_on_p. We remember the original value and
28105 check later if it is changed. */
28106 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28108 /* Update lines intersecting rectangle R. */
28109 first_overlapping_row
= last_overlapping_row
= NULL
;
28110 for (row
= w
->current_matrix
->rows
;
28115 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28117 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28118 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28119 || (r
.y
>= y0
&& r
.y
< y1
)
28120 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28122 /* A header line may be overlapping, but there is no need
28123 to fix overlapping areas for them. KFS 2005-02-12 */
28124 if (row
->overlapping_p
&& !row
->mode_line_p
)
28126 if (first_overlapping_row
== NULL
)
28127 first_overlapping_row
= row
;
28128 last_overlapping_row
= row
;
28132 if (expose_line (w
, row
, &r
))
28133 mouse_face_overwritten_p
= 1;
28136 else if (row
->overlapping_p
)
28138 /* We must redraw a row overlapping the exposed area. */
28140 ? y0
+ row
->phys_height
> r
.y
28141 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28143 if (first_overlapping_row
== NULL
)
28144 first_overlapping_row
= row
;
28145 last_overlapping_row
= row
;
28153 /* Display the mode line if there is one. */
28154 if (WINDOW_WANTS_MODELINE_P (w
)
28155 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28157 && row
->y
< r
.y
+ r
.height
)
28159 if (expose_line (w
, row
, &r
))
28160 mouse_face_overwritten_p
= 1;
28163 if (!w
->pseudo_window_p
)
28165 /* Fix the display of overlapping rows. */
28166 if (first_overlapping_row
)
28167 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28170 /* Draw border between windows. */
28171 x_draw_vertical_border (w
);
28173 /* Turn the cursor on again. */
28174 if (cursor_cleared_p
28175 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28176 update_window_cursor (w
, 1);
28180 return mouse_face_overwritten_p
;
28185 /* Redraw (parts) of all windows in the window tree rooted at W that
28186 intersect R. R contains frame pixel coordinates. Value is
28187 non-zero if the exposure overwrites mouse-face. */
28190 expose_window_tree (struct window
*w
, XRectangle
*r
)
28192 struct frame
*f
= XFRAME (w
->frame
);
28193 int mouse_face_overwritten_p
= 0;
28195 while (w
&& !FRAME_GARBAGED_P (f
))
28197 if (!NILP (w
->hchild
))
28198 mouse_face_overwritten_p
28199 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28200 else if (!NILP (w
->vchild
))
28201 mouse_face_overwritten_p
28202 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28204 mouse_face_overwritten_p
|= expose_window (w
, r
);
28206 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28209 return mouse_face_overwritten_p
;
28214 Redisplay an exposed area of frame F. X and Y are the upper-left
28215 corner of the exposed rectangle. W and H are width and height of
28216 the exposed area. All are pixel values. W or H zero means redraw
28217 the entire frame. */
28220 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28223 int mouse_face_overwritten_p
= 0;
28225 TRACE ((stderr
, "expose_frame "));
28227 /* No need to redraw if frame will be redrawn soon. */
28228 if (FRAME_GARBAGED_P (f
))
28230 TRACE ((stderr
, " garbaged\n"));
28234 /* If basic faces haven't been realized yet, there is no point in
28235 trying to redraw anything. This can happen when we get an expose
28236 event while Emacs is starting, e.g. by moving another window. */
28237 if (FRAME_FACE_CACHE (f
) == NULL
28238 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28240 TRACE ((stderr
, " no faces\n"));
28244 if (w
== 0 || h
== 0)
28247 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28248 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28258 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28259 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28261 if (WINDOWP (f
->tool_bar_window
))
28262 mouse_face_overwritten_p
28263 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28265 #ifdef HAVE_X_WINDOWS
28267 #ifndef USE_X_TOOLKIT
28268 if (WINDOWP (f
->menu_bar_window
))
28269 mouse_face_overwritten_p
28270 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28271 #endif /* not USE_X_TOOLKIT */
28275 /* Some window managers support a focus-follows-mouse style with
28276 delayed raising of frames. Imagine a partially obscured frame,
28277 and moving the mouse into partially obscured mouse-face on that
28278 frame. The visible part of the mouse-face will be highlighted,
28279 then the WM raises the obscured frame. With at least one WM, KDE
28280 2.1, Emacs is not getting any event for the raising of the frame
28281 (even tried with SubstructureRedirectMask), only Expose events.
28282 These expose events will draw text normally, i.e. not
28283 highlighted. Which means we must redo the highlight here.
28284 Subsume it under ``we love X''. --gerd 2001-08-15 */
28285 /* Included in Windows version because Windows most likely does not
28286 do the right thing if any third party tool offers
28287 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28288 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28290 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28291 if (f
== hlinfo
->mouse_face_mouse_frame
)
28293 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28294 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28295 clear_mouse_face (hlinfo
);
28296 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28303 Determine the intersection of two rectangles R1 and R2. Return
28304 the intersection in *RESULT. Value is non-zero if RESULT is not
28308 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28310 XRectangle
*left
, *right
;
28311 XRectangle
*upper
, *lower
;
28312 int intersection_p
= 0;
28314 /* Rearrange so that R1 is the left-most rectangle. */
28316 left
= r1
, right
= r2
;
28318 left
= r2
, right
= r1
;
28320 /* X0 of the intersection is right.x0, if this is inside R1,
28321 otherwise there is no intersection. */
28322 if (right
->x
<= left
->x
+ left
->width
)
28324 result
->x
= right
->x
;
28326 /* The right end of the intersection is the minimum of
28327 the right ends of left and right. */
28328 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28331 /* Same game for Y. */
28333 upper
= r1
, lower
= r2
;
28335 upper
= r2
, lower
= r1
;
28337 /* The upper end of the intersection is lower.y0, if this is inside
28338 of upper. Otherwise, there is no intersection. */
28339 if (lower
->y
<= upper
->y
+ upper
->height
)
28341 result
->y
= lower
->y
;
28343 /* The lower end of the intersection is the minimum of the lower
28344 ends of upper and lower. */
28345 result
->height
= (min (lower
->y
+ lower
->height
,
28346 upper
->y
+ upper
->height
)
28348 intersection_p
= 1;
28352 return intersection_p
;
28355 #endif /* HAVE_WINDOW_SYSTEM */
28358 /***********************************************************************
28360 ***********************************************************************/
28363 syms_of_xdisp (void)
28365 Vwith_echo_area_save_vector
= Qnil
;
28366 staticpro (&Vwith_echo_area_save_vector
);
28368 Vmessage_stack
= Qnil
;
28369 staticpro (&Vmessage_stack
);
28371 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28373 message_dolog_marker1
= Fmake_marker ();
28374 staticpro (&message_dolog_marker1
);
28375 message_dolog_marker2
= Fmake_marker ();
28376 staticpro (&message_dolog_marker2
);
28377 message_dolog_marker3
= Fmake_marker ();
28378 staticpro (&message_dolog_marker3
);
28381 defsubr (&Sdump_frame_glyph_matrix
);
28382 defsubr (&Sdump_glyph_matrix
);
28383 defsubr (&Sdump_glyph_row
);
28384 defsubr (&Sdump_tool_bar_row
);
28385 defsubr (&Strace_redisplay
);
28386 defsubr (&Strace_to_stderr
);
28388 #ifdef HAVE_WINDOW_SYSTEM
28389 defsubr (&Stool_bar_lines_needed
);
28390 defsubr (&Slookup_image_map
);
28392 defsubr (&Sformat_mode_line
);
28393 defsubr (&Sinvisible_p
);
28394 defsubr (&Scurrent_bidi_paragraph_direction
);
28396 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28397 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28398 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28399 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28400 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28401 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28402 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28403 DEFSYM (Qeval
, "eval");
28404 DEFSYM (QCdata
, ":data");
28405 DEFSYM (Qdisplay
, "display");
28406 DEFSYM (Qspace_width
, "space-width");
28407 DEFSYM (Qraise
, "raise");
28408 DEFSYM (Qslice
, "slice");
28409 DEFSYM (Qspace
, "space");
28410 DEFSYM (Qmargin
, "margin");
28411 DEFSYM (Qpointer
, "pointer");
28412 DEFSYM (Qleft_margin
, "left-margin");
28413 DEFSYM (Qright_margin
, "right-margin");
28414 DEFSYM (Qcenter
, "center");
28415 DEFSYM (Qline_height
, "line-height");
28416 DEFSYM (QCalign_to
, ":align-to");
28417 DEFSYM (QCrelative_width
, ":relative-width");
28418 DEFSYM (QCrelative_height
, ":relative-height");
28419 DEFSYM (QCeval
, ":eval");
28420 DEFSYM (QCpropertize
, ":propertize");
28421 DEFSYM (QCfile
, ":file");
28422 DEFSYM (Qfontified
, "fontified");
28423 DEFSYM (Qfontification_functions
, "fontification-functions");
28424 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28425 DEFSYM (Qescape_glyph
, "escape-glyph");
28426 DEFSYM (Qnobreak_space
, "nobreak-space");
28427 DEFSYM (Qimage
, "image");
28428 DEFSYM (Qtext
, "text");
28429 DEFSYM (Qboth
, "both");
28430 DEFSYM (Qboth_horiz
, "both-horiz");
28431 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28432 DEFSYM (QCmap
, ":map");
28433 DEFSYM (QCpointer
, ":pointer");
28434 DEFSYM (Qrect
, "rect");
28435 DEFSYM (Qcircle
, "circle");
28436 DEFSYM (Qpoly
, "poly");
28437 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28438 DEFSYM (Qgrow_only
, "grow-only");
28439 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28440 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28441 DEFSYM (Qposition
, "position");
28442 DEFSYM (Qbuffer_position
, "buffer-position");
28443 DEFSYM (Qobject
, "object");
28444 DEFSYM (Qbar
, "bar");
28445 DEFSYM (Qhbar
, "hbar");
28446 DEFSYM (Qbox
, "box");
28447 DEFSYM (Qhollow
, "hollow");
28448 DEFSYM (Qhand
, "hand");
28449 DEFSYM (Qarrow
, "arrow");
28450 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28452 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28453 Fcons (intern_c_string ("void-variable"), Qnil
)),
28455 staticpro (&list_of_error
);
28457 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28458 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28459 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28460 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28462 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28463 staticpro (&echo_buffer
[0]);
28464 staticpro (&echo_buffer
[1]);
28466 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28467 staticpro (&echo_area_buffer
[0]);
28468 staticpro (&echo_area_buffer
[1]);
28470 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28471 staticpro (&Vmessages_buffer_name
);
28473 mode_line_proptrans_alist
= Qnil
;
28474 staticpro (&mode_line_proptrans_alist
);
28475 mode_line_string_list
= Qnil
;
28476 staticpro (&mode_line_string_list
);
28477 mode_line_string_face
= Qnil
;
28478 staticpro (&mode_line_string_face
);
28479 mode_line_string_face_prop
= Qnil
;
28480 staticpro (&mode_line_string_face_prop
);
28481 Vmode_line_unwind_vector
= Qnil
;
28482 staticpro (&Vmode_line_unwind_vector
);
28484 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28486 help_echo_string
= Qnil
;
28487 staticpro (&help_echo_string
);
28488 help_echo_object
= Qnil
;
28489 staticpro (&help_echo_object
);
28490 help_echo_window
= Qnil
;
28491 staticpro (&help_echo_window
);
28492 previous_help_echo_string
= Qnil
;
28493 staticpro (&previous_help_echo_string
);
28494 help_echo_pos
= -1;
28496 DEFSYM (Qright_to_left
, "right-to-left");
28497 DEFSYM (Qleft_to_right
, "left-to-right");
28499 #ifdef HAVE_WINDOW_SYSTEM
28500 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28501 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28502 For example, if a block cursor is over a tab, it will be drawn as
28503 wide as that tab on the display. */);
28504 x_stretch_cursor_p
= 0;
28507 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28508 doc
: /* Non-nil means highlight trailing whitespace.
28509 The face used for trailing whitespace is `trailing-whitespace'. */);
28510 Vshow_trailing_whitespace
= Qnil
;
28512 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28513 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28514 If the value is t, Emacs highlights non-ASCII chars which have the
28515 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28516 or `escape-glyph' face respectively.
28518 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28519 U+2011 (non-breaking hyphen) are affected.
28521 Any other non-nil value means to display these characters as a escape
28522 glyph followed by an ordinary space or hyphen.
28524 A value of nil means no special handling of these characters. */);
28525 Vnobreak_char_display
= Qt
;
28527 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28528 doc
: /* The pointer shape to show in void text areas.
28529 A value of nil means to show the text pointer. Other options are `arrow',
28530 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28531 Vvoid_text_area_pointer
= Qarrow
;
28533 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28534 doc
: /* Non-nil means don't actually do any redisplay.
28535 This is used for internal purposes. */);
28536 Vinhibit_redisplay
= Qnil
;
28538 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28539 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28540 Vglobal_mode_string
= Qnil
;
28542 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28543 doc
: /* Marker for where to display an arrow on top of the buffer text.
28544 This must be the beginning of a line in order to work.
28545 See also `overlay-arrow-string'. */);
28546 Voverlay_arrow_position
= Qnil
;
28548 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28549 doc
: /* String to display as an arrow in non-window frames.
28550 See also `overlay-arrow-position'. */);
28551 Voverlay_arrow_string
= make_pure_c_string ("=>");
28553 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28554 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28555 The symbols on this list are examined during redisplay to determine
28556 where to display overlay arrows. */);
28557 Voverlay_arrow_variable_list
28558 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28560 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28561 doc
: /* The number of lines to try scrolling a window by when point moves out.
28562 If that fails to bring point back on frame, point is centered instead.
28563 If this is zero, point is always centered after it moves off frame.
28564 If you want scrolling to always be a line at a time, you should set
28565 `scroll-conservatively' to a large value rather than set this to 1. */);
28567 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28568 doc
: /* Scroll up to this many lines, to bring point back on screen.
28569 If point moves off-screen, redisplay will scroll by up to
28570 `scroll-conservatively' lines in order to bring point just barely
28571 onto the screen again. If that cannot be done, then redisplay
28572 recenters point as usual.
28574 If the value is greater than 100, redisplay will never recenter point,
28575 but will always scroll just enough text to bring point into view, even
28576 if you move far away.
28578 A value of zero means always recenter point if it moves off screen. */);
28579 scroll_conservatively
= 0;
28581 DEFVAR_INT ("scroll-margin", scroll_margin
,
28582 doc
: /* Number of lines of margin at the top and bottom of a window.
28583 Recenter the window whenever point gets within this many lines
28584 of the top or bottom of the window. */);
28587 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28588 doc
: /* Pixels per inch value for non-window system displays.
28589 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28590 Vdisplay_pixels_per_inch
= make_float (72.0);
28593 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28596 DEFVAR_LISP ("truncate-partial-width-windows",
28597 Vtruncate_partial_width_windows
,
28598 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28599 For an integer value, truncate lines in each window narrower than the
28600 full frame width, provided the window width is less than that integer;
28601 otherwise, respect the value of `truncate-lines'.
28603 For any other non-nil value, truncate lines in all windows that do
28604 not span the full frame width.
28606 A value of nil means to respect the value of `truncate-lines'.
28608 If `word-wrap' is enabled, you might want to reduce this. */);
28609 Vtruncate_partial_width_windows
= make_number (50);
28611 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28612 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28613 Any other value means to use the appropriate face, `mode-line',
28614 `header-line', or `menu' respectively. */);
28615 mode_line_inverse_video
= 1;
28617 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28618 doc
: /* Maximum buffer size for which line number should be displayed.
28619 If the buffer is bigger than this, the line number does not appear
28620 in the mode line. A value of nil means no limit. */);
28621 Vline_number_display_limit
= Qnil
;
28623 DEFVAR_INT ("line-number-display-limit-width",
28624 line_number_display_limit_width
,
28625 doc
: /* Maximum line width (in characters) for line number display.
28626 If the average length of the lines near point is bigger than this, then the
28627 line number may be omitted from the mode line. */);
28628 line_number_display_limit_width
= 200;
28630 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28631 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28632 highlight_nonselected_windows
= 0;
28634 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28635 doc
: /* Non-nil if more than one frame is visible on this display.
28636 Minibuffer-only frames don't count, but iconified frames do.
28637 This variable is not guaranteed to be accurate except while processing
28638 `frame-title-format' and `icon-title-format'. */);
28640 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28641 doc
: /* Template for displaying the title bar of visible frames.
28642 \(Assuming the window manager supports this feature.)
28644 This variable has the same structure as `mode-line-format', except that
28645 the %c and %l constructs are ignored. It is used only on frames for
28646 which no explicit name has been set \(see `modify-frame-parameters'). */);
28648 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28649 doc
: /* Template for displaying the title bar of an iconified frame.
28650 \(Assuming the window manager supports this feature.)
28651 This variable has the same structure as `mode-line-format' (which see),
28652 and is used only on frames for which no explicit name has been set
28653 \(see `modify-frame-parameters'). */);
28655 = Vframe_title_format
28656 = pure_cons (intern_c_string ("multiple-frames"),
28657 pure_cons (make_pure_c_string ("%b"),
28658 pure_cons (pure_cons (empty_unibyte_string
,
28659 pure_cons (intern_c_string ("invocation-name"),
28660 pure_cons (make_pure_c_string ("@"),
28661 pure_cons (intern_c_string ("system-name"),
28665 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28666 doc
: /* Maximum number of lines to keep in the message log buffer.
28667 If nil, disable message logging. If t, log messages but don't truncate
28668 the buffer when it becomes large. */);
28669 Vmessage_log_max
= make_number (100);
28671 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28672 doc
: /* Functions called before redisplay, if window sizes have changed.
28673 The value should be a list of functions that take one argument.
28674 Just before redisplay, for each frame, if any of its windows have changed
28675 size since the last redisplay, or have been split or deleted,
28676 all the functions in the list are called, with the frame as argument. */);
28677 Vwindow_size_change_functions
= Qnil
;
28679 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28680 doc
: /* List of functions to call before redisplaying a window with scrolling.
28681 Each function is called with two arguments, the window and its new
28682 display-start position. Note that these functions are also called by
28683 `set-window-buffer'. Also note that the value of `window-end' is not
28684 valid when these functions are called.
28686 Warning: Do not use this feature to alter the way the window
28687 is scrolled. It is not designed for that, and such use probably won't
28689 Vwindow_scroll_functions
= Qnil
;
28691 DEFVAR_LISP ("window-text-change-functions",
28692 Vwindow_text_change_functions
,
28693 doc
: /* Functions to call in redisplay when text in the window might change. */);
28694 Vwindow_text_change_functions
= Qnil
;
28696 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28697 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28698 Each function is called with two arguments, the window and the end trigger value.
28699 See `set-window-redisplay-end-trigger'. */);
28700 Vredisplay_end_trigger_functions
= Qnil
;
28702 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28703 doc
: /* Non-nil means autoselect window with mouse pointer.
28704 If nil, do not autoselect windows.
28705 A positive number means delay autoselection by that many seconds: a
28706 window is autoselected only after the mouse has remained in that
28707 window for the duration of the delay.
28708 A negative number has a similar effect, but causes windows to be
28709 autoselected only after the mouse has stopped moving. \(Because of
28710 the way Emacs compares mouse events, you will occasionally wait twice
28711 that time before the window gets selected.\)
28712 Any other value means to autoselect window instantaneously when the
28713 mouse pointer enters it.
28715 Autoselection selects the minibuffer only if it is active, and never
28716 unselects the minibuffer if it is active.
28718 When customizing this variable make sure that the actual value of
28719 `focus-follows-mouse' matches the behavior of your window manager. */);
28720 Vmouse_autoselect_window
= Qnil
;
28722 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28723 doc
: /* Non-nil means automatically resize tool-bars.
28724 This dynamically changes the tool-bar's height to the minimum height
28725 that is needed to make all tool-bar items visible.
28726 If value is `grow-only', the tool-bar's height is only increased
28727 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28728 Vauto_resize_tool_bars
= Qt
;
28730 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28731 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28732 auto_raise_tool_bar_buttons_p
= 1;
28734 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28735 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28736 make_cursor_line_fully_visible_p
= 1;
28738 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28739 doc
: /* Border below tool-bar in pixels.
28740 If an integer, use it as the height of the border.
28741 If it is one of `internal-border-width' or `border-width', use the
28742 value of the corresponding frame parameter.
28743 Otherwise, no border is added below the tool-bar. */);
28744 Vtool_bar_border
= Qinternal_border_width
;
28746 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28747 doc
: /* Margin around tool-bar buttons in pixels.
28748 If an integer, use that for both horizontal and vertical margins.
28749 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28750 HORZ specifying the horizontal margin, and VERT specifying the
28751 vertical margin. */);
28752 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28754 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28755 doc
: /* Relief thickness of tool-bar buttons. */);
28756 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28758 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28759 doc
: /* Tool bar style to use.
28761 image - show images only
28762 text - show text only
28763 both - show both, text below image
28764 both-horiz - show text to the right of the image
28765 text-image-horiz - show text to the left of the image
28766 any other - use system default or image if no system default.
28768 This variable only affects the GTK+ toolkit version of Emacs. */);
28769 Vtool_bar_style
= Qnil
;
28771 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28772 doc
: /* Maximum number of characters a label can have to be shown.
28773 The tool bar style must also show labels for this to have any effect, see
28774 `tool-bar-style'. */);
28775 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28777 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28778 doc
: /* List of functions to call to fontify regions of text.
28779 Each function is called with one argument POS. Functions must
28780 fontify a region starting at POS in the current buffer, and give
28781 fontified regions the property `fontified'. */);
28782 Vfontification_functions
= Qnil
;
28783 Fmake_variable_buffer_local (Qfontification_functions
);
28785 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28786 unibyte_display_via_language_environment
,
28787 doc
: /* Non-nil means display unibyte text according to language environment.
28788 Specifically, this means that raw bytes in the range 160-255 decimal
28789 are displayed by converting them to the equivalent multibyte characters
28790 according to the current language environment. As a result, they are
28791 displayed according to the current fontset.
28793 Note that this variable affects only how these bytes are displayed,
28794 but does not change the fact they are interpreted as raw bytes. */);
28795 unibyte_display_via_language_environment
= 0;
28797 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28798 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
28799 If a float, it specifies a fraction of the mini-window frame's height.
28800 If an integer, it specifies a number of lines. */);
28801 Vmax_mini_window_height
= make_float (0.25);
28803 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28804 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28805 A value of nil means don't automatically resize mini-windows.
28806 A value of t means resize them to fit the text displayed in them.
28807 A value of `grow-only', the default, means let mini-windows grow only;
28808 they return to their normal size when the minibuffer is closed, or the
28809 echo area becomes empty. */);
28810 Vresize_mini_windows
= Qgrow_only
;
28812 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28813 doc
: /* Alist specifying how to blink the cursor off.
28814 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28815 `cursor-type' frame-parameter or variable equals ON-STATE,
28816 comparing using `equal', Emacs uses OFF-STATE to specify
28817 how to blink it off. ON-STATE and OFF-STATE are values for
28818 the `cursor-type' frame parameter.
28820 If a frame's ON-STATE has no entry in this list,
28821 the frame's other specifications determine how to blink the cursor off. */);
28822 Vblink_cursor_alist
= Qnil
;
28824 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28825 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28826 If non-nil, windows are automatically scrolled horizontally to make
28827 point visible. */);
28828 automatic_hscrolling_p
= 1;
28829 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28831 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28832 doc
: /* How many columns away from the window edge point is allowed to get
28833 before automatic hscrolling will horizontally scroll the window. */);
28834 hscroll_margin
= 5;
28836 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28837 doc
: /* How many columns to scroll the window when point gets too close to the edge.
28838 When point is less than `hscroll-margin' columns from the window
28839 edge, automatic hscrolling will scroll the window by the amount of columns
28840 determined by this variable. If its value is a positive integer, scroll that
28841 many columns. If it's a positive floating-point number, it specifies the
28842 fraction of the window's width to scroll. If it's nil or zero, point will be
28843 centered horizontally after the scroll. Any other value, including negative
28844 numbers, are treated as if the value were zero.
28846 Automatic hscrolling always moves point outside the scroll margin, so if
28847 point was more than scroll step columns inside the margin, the window will
28848 scroll more than the value given by the scroll step.
28850 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28851 and `scroll-right' overrides this variable's effect. */);
28852 Vhscroll_step
= make_number (0);
28854 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28855 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28856 Bind this around calls to `message' to let it take effect. */);
28857 message_truncate_lines
= 0;
28859 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28860 doc
: /* Normal hook run to update the menu bar definitions.
28861 Redisplay runs this hook before it redisplays the menu bar.
28862 This is used to update submenus such as Buffers,
28863 whose contents depend on various data. */);
28864 Vmenu_bar_update_hook
= Qnil
;
28866 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28867 doc
: /* Frame for which we are updating a menu.
28868 The enable predicate for a menu binding should check this variable. */);
28869 Vmenu_updating_frame
= Qnil
;
28871 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28872 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28873 inhibit_menubar_update
= 0;
28875 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28876 doc
: /* Prefix prepended to all continuation lines at display time.
28877 The value may be a string, an image, or a stretch-glyph; it is
28878 interpreted in the same way as the value of a `display' text property.
28880 This variable is overridden by any `wrap-prefix' text or overlay
28883 To add a prefix to non-continuation lines, use `line-prefix'. */);
28884 Vwrap_prefix
= Qnil
;
28885 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28886 Fmake_variable_buffer_local (Qwrap_prefix
);
28888 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28889 doc
: /* Prefix prepended to all non-continuation lines at display time.
28890 The value may be a string, an image, or a stretch-glyph; it is
28891 interpreted in the same way as the value of a `display' text property.
28893 This variable is overridden by any `line-prefix' text or overlay
28896 To add a prefix to continuation lines, use `wrap-prefix'. */);
28897 Vline_prefix
= Qnil
;
28898 DEFSYM (Qline_prefix
, "line-prefix");
28899 Fmake_variable_buffer_local (Qline_prefix
);
28901 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28902 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28903 inhibit_eval_during_redisplay
= 0;
28905 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28906 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28907 inhibit_free_realized_faces
= 0;
28910 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28911 doc
: /* Inhibit try_window_id display optimization. */);
28912 inhibit_try_window_id
= 0;
28914 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28915 doc
: /* Inhibit try_window_reusing display optimization. */);
28916 inhibit_try_window_reusing
= 0;
28918 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28919 doc
: /* Inhibit try_cursor_movement display optimization. */);
28920 inhibit_try_cursor_movement
= 0;
28921 #endif /* GLYPH_DEBUG */
28923 DEFVAR_INT ("overline-margin", overline_margin
,
28924 doc
: /* Space between overline and text, in pixels.
28925 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28926 margin to the character height. */);
28927 overline_margin
= 2;
28929 DEFVAR_INT ("underline-minimum-offset",
28930 underline_minimum_offset
,
28931 doc
: /* Minimum distance between baseline and underline.
28932 This can improve legibility of underlined text at small font sizes,
28933 particularly when using variable `x-use-underline-position-properties'
28934 with fonts that specify an UNDERLINE_POSITION relatively close to the
28935 baseline. The default value is 1. */);
28936 underline_minimum_offset
= 1;
28938 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28939 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28940 This feature only works when on a window system that can change
28941 cursor shapes. */);
28942 display_hourglass_p
= 1;
28944 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28945 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28946 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28948 hourglass_atimer
= NULL
;
28949 hourglass_shown_p
= 0;
28951 DEFSYM (Qglyphless_char
, "glyphless-char");
28952 DEFSYM (Qhex_code
, "hex-code");
28953 DEFSYM (Qempty_box
, "empty-box");
28954 DEFSYM (Qthin_space
, "thin-space");
28955 DEFSYM (Qzero_width
, "zero-width");
28957 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28958 /* Intern this now in case it isn't already done.
28959 Setting this variable twice is harmless.
28960 But don't staticpro it here--that is done in alloc.c. */
28961 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28962 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28964 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28965 doc
: /* Char-table defining glyphless characters.
28966 Each element, if non-nil, should be one of the following:
28967 an ASCII acronym string: display this string in a box
28968 `hex-code': display the hexadecimal code of a character in a box
28969 `empty-box': display as an empty box
28970 `thin-space': display as 1-pixel width space
28971 `zero-width': don't display
28972 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28973 display method for graphical terminals and text terminals respectively.
28974 GRAPHICAL and TEXT should each have one of the values listed above.
28976 The char-table has one extra slot to control the display of a character for
28977 which no font is found. This slot only takes effect on graphical terminals.
28978 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28979 `thin-space'. The default is `empty-box'. */);
28980 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28981 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28986 /* Initialize this module when Emacs starts. */
28991 current_header_line_height
= current_mode_line_height
= -1;
28993 CHARPOS (this_line_start_pos
) = 0;
28995 if (!noninteractive
)
28997 struct window
*m
= XWINDOW (minibuf_window
);
28998 Lisp_Object frame
= m
->frame
;
28999 struct frame
*f
= XFRAME (frame
);
29000 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29001 struct window
*r
= XWINDOW (root
);
29004 echo_area_window
= minibuf_window
;
29006 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
29007 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
29008 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
29009 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
29010 XSETFASTINT (m
->total_lines
, 1);
29011 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
29013 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29014 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29015 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29017 /* The default ellipsis glyphs `...'. */
29018 for (i
= 0; i
< 3; ++i
)
29019 default_invis_vector
[i
] = make_number ('.');
29023 /* Allocate the buffer for frame titles.
29024 Also used for `format-mode-line'. */
29026 mode_line_noprop_buf
= (char *) xmalloc (size
);
29027 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29028 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29029 mode_line_target
= MODE_LINE_DISPLAY
;
29032 help_echo_showing_p
= 0;
29035 /* Since w32 does not support atimers, it defines its own implementation of
29036 the following three functions in w32fns.c. */
29039 /* Platform-independent portion of hourglass implementation. */
29041 /* Cancel a currently active hourglass timer, and start a new one. */
29043 start_hourglass (void)
29045 #if defined (HAVE_WINDOW_SYSTEM)
29047 int secs
= DEFAULT_HOURGLASS_DELAY
, usecs
= 0;
29049 cancel_hourglass ();
29051 if (NUMBERP (Vhourglass_delay
))
29053 double duration
= extract_float (Vhourglass_delay
);
29055 duration_to_sec_usec (duration
, &secs
, &usecs
);
29058 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
29059 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29060 show_hourglass
, NULL
);
29065 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29068 cancel_hourglass (void)
29070 #if defined (HAVE_WINDOW_SYSTEM)
29071 if (hourglass_atimer
)
29073 cancel_atimer (hourglass_atimer
);
29074 hourglass_atimer
= NULL
;
29077 if (hourglass_shown_p
)
29081 #endif /* ! WINDOWSNT */